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

Copyright(c) 2015 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.

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

Synopsis

REST Resource

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

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:

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.