gogol-dfareporting-0.2.0: Google DCM/DFA Reporting And Trafficking SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.DFAReporting.OrderDocuments.List

Contents

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

REST Resource

type OrderDocumentsListResource = "dfareporting" :> ("v2.7" :> ("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 #

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 # 
Data OrderDocumentsList Source # 

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 # 
Generic OrderDocumentsList Source # 
GoogleRequest OrderDocumentsList Source # 
type Rep OrderDocumentsList Source # 
type Rep OrderDocumentsList = D1 (MetaData "OrderDocumentsList" "Network.Google.Resource.DFAReporting.OrderDocuments.List" "gogol-dfareporting-0.2.0-3vkytqIdbR4DxGH3Av8E8" False) (C1 (MetaCons "OrderDocumentsList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_odlSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_odlIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) ((:*:) (S1 (MetaSel (Just Symbol "_odlProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64))) ((:*:) (S1 (MetaSel (Just Symbol "_odlSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OrderDocumentsListSortOrder))) (S1 (MetaSel (Just Symbol "_odlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_odlProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64))) ((:*:) (S1 (MetaSel (Just Symbol "_odlSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OrderDocumentsListSortField))) (S1 (MetaSel (Just Symbol "_odlOrderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))))) ((:*:) (S1 (MetaSel (Just Symbol "_odlApproved") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_odlSiteId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) (S1 (MetaSel (Just Symbol "_odlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))))))
type Scopes OrderDocumentsList Source # 
type Scopes OrderDocumentsList = (:) Symbol "https://www.googleapis.com/auth/dfatrafficking" ([] Symbol)
type Rs OrderDocumentsList Source # 

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 (Maybe OrderDocumentsListSortOrder) Source #

Order of sorted results, default is ASCENDING.

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.

odlOrderId :: Lens' OrderDocumentsList [Int64] Source #

Select only order documents for specified orders.

odlApproved :: Lens' OrderDocumentsList (Maybe Bool) Source #

Select only order documents that have been approved by at least one user.

odlSiteId :: Lens' OrderDocumentsList [Int64] Source #

Select only order documents that are associated with these sites.

odlMaxResults :: Lens' OrderDocumentsList (Maybe Int32) Source #

Maximum number of results to return.