Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.DFAReporting.OrderDocuments.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Retrieves a list of order documents, possibly filtered. This method supports paging.

See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.orderDocuments.list.

Synopsis

type OrderDocumentsListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("projects" :> (Capture "projectId" (Textual Int64) :> ("orderDocuments" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" OrderDocumentsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" OrderDocumentsListSortField :> (QueryParams "orderId" (Textual Int64) :> (QueryParam "approved" Bool :> (QueryParams "siteId" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] OrderDocumentsListResponse))))))))))))))))
orderDocumentsList :: Int64 -> Int64 -> OrderDocumentsList
data OrderDocumentsList
odlSearchString :: Lens' OrderDocumentsList (Maybe Text)
odlIds :: Lens' OrderDocumentsList [Int64]
odlProFileId :: Lens' OrderDocumentsList Int64
odlSortOrder :: Lens' OrderDocumentsList OrderDocumentsListSortOrder
odlPageToken :: Lens' OrderDocumentsList (Maybe Text)
odlProjectId :: Lens' OrderDocumentsList Int64
odlSortField :: Lens' OrderDocumentsList OrderDocumentsListSortField
odlOrderId :: Lens' OrderDocumentsList [Int64]
odlApproved :: Lens' OrderDocumentsList (Maybe Bool)
odlSiteId :: Lens' OrderDocumentsList [Int64]
odlMaxResults :: Lens' OrderDocumentsList Int32

REST Resource

type OrderDocumentsListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("projects" :> (Capture "projectId" (Textual Int64) :> ("orderDocuments" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" OrderDocumentsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" OrderDocumentsListSortField :> (QueryParams "orderId" (Textual Int64) :> (QueryParam "approved" Bool :> (QueryParams "siteId" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] OrderDocumentsListResponse)))))))))))))))) Source #

A resource alias for dfareporting.orderDocuments.list method which the OrderDocumentsList request conforms to.

Creating a Request

orderDocumentsList Source #

Arguments

:: Int64	`odlProFileId`
-> Int64	`odlProjectId`
-> OrderDocumentsList

Creates a value of OrderDocumentsList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data OrderDocumentsList Source #

Retrieves a list of order documents, possibly filtered. This method supports paging.

See: orderDocumentsList smart constructor.

Instances

Eq OrderDocumentsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.OrderDocuments.List Methods (==) :: OrderDocumentsList -> OrderDocumentsList -> Bool # (/=) :: OrderDocumentsList -> OrderDocumentsList -> Bool #
Data OrderDocumentsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.OrderDocuments.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OrderDocumentsList -> c OrderDocumentsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OrderDocumentsList # toConstr :: OrderDocumentsList -> Constr # dataTypeOf :: OrderDocumentsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OrderDocumentsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OrderDocumentsList) # gmapT :: (forall b. Data b => b -> b) -> OrderDocumentsList -> OrderDocumentsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OrderDocumentsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OrderDocumentsList -> r # gmapQ :: (forall d. Data d => d -> u) -> OrderDocumentsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OrderDocumentsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OrderDocumentsList -> m OrderDocumentsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OrderDocumentsList -> m OrderDocumentsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OrderDocumentsList -> m OrderDocumentsList #
Show OrderDocumentsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.OrderDocuments.List Methods showsPrec :: Int -> OrderDocumentsList -> ShowS # show :: OrderDocumentsList -> String # showList :: [OrderDocumentsList] -> ShowS #
Generic OrderDocumentsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.OrderDocuments.List Associated Types type Rep OrderDocumentsList :: Type -> Type # Methods from :: OrderDocumentsList -> Rep OrderDocumentsList x # to :: Rep OrderDocumentsList x -> OrderDocumentsList #
GoogleRequest OrderDocumentsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.OrderDocuments.List Associated Types type Rs OrderDocumentsList :: Type # type Scopes OrderDocumentsList :: [Symbol] # Methods requestClient :: OrderDocumentsList -> GClient (Rs OrderDocumentsList) #
type Rep OrderDocumentsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.OrderDocuments.List type Rep OrderDocumentsList = D1 (MetaData "OrderDocumentsList" "Network.Google.Resource.DFAReporting.OrderDocuments.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "OrderDocumentsList'" PrefixI True) (((S1 (MetaSel (Just "_odlSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_odlIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :: (S1 (MetaSel (Just "_odlProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :: (S1 (MetaSel (Just "_odlSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 OrderDocumentsListSortOrder) :: S1 (MetaSel (Just "_odlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 (MetaSel (Just "_odlProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :: (S1 (MetaSel (Just "_odlSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 OrderDocumentsListSortField) :: S1 (MetaSel (Just "_odlOrderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) :: (S1 (MetaSel (Just "_odlApproved") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 (MetaSel (Just "_odlSiteId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :: S1 (MetaSel (Just "_odlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)))))))
type Scopes OrderDocumentsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.OrderDocuments.List type Scopes OrderDocumentsList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])
type Rs OrderDocumentsList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.OrderDocuments.List type Rs OrderDocumentsList = OrderDocumentsListResponse

Request Lenses

odlSearchString :: Lens' OrderDocumentsList (Maybe Text) Source #

Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".

odlIds :: Lens' OrderDocumentsList [Int64] Source #

Select only order documents with these IDs.

odlProFileId :: Lens' OrderDocumentsList Int64 Source #

User profile ID associated with this request.

odlSortOrder :: Lens' OrderDocumentsList OrderDocumentsListSortOrder Source #

Order of sorted results.

odlPageToken :: Lens' OrderDocumentsList (Maybe Text) Source #

Value of the nextPageToken from the previous result page.

odlProjectId :: Lens' OrderDocumentsList Int64 Source #

Project ID for order documents.

odlSortField :: Lens' OrderDocumentsList OrderDocumentsListSortField Source #

Field by which to sort the list.