1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\Dfareporting\Resource;
19
20use Google\Service\Dfareporting\OrderDocument;
21use Google\Service\Dfareporting\OrderDocumentsListResponse;
22
23/**
24 * The "orderDocuments" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $dfareportingService = new Google\Service\Dfareporting(...);
28 *   $orderDocuments = $dfareportingService->orderDocuments;
29 *  </code>
30 */
31class OrderDocuments extends \Google\Service\Resource
32{
33  /**
34   * Gets one order document by ID. (orderDocuments.get)
35   *
36   * @param string $profileId User profile ID associated with this request.
37   * @param string $projectId Project ID for order documents.
38   * @param string $id Order document ID.
39   * @param array $optParams Optional parameters.
40   * @return OrderDocument
41   */
42  public function get($profileId, $projectId, $id, $optParams = [])
43  {
44    $params = ['profileId' => $profileId, 'projectId' => $projectId, 'id' => $id];
45    $params = array_merge($params, $optParams);
46    return $this->call('get', [$params], OrderDocument::class);
47  }
48  /**
49   * Retrieves a list of order documents, possibly filtered. This method supports
50   * paging. (orderDocuments.listOrderDocuments)
51   *
52   * @param string $profileId User profile ID associated with this request.
53   * @param string $projectId Project ID for order documents.
54   * @param array $optParams Optional parameters.
55   *
56   * @opt_param bool approved Select only order documents that have been approved
57   * by at least one user.
58   * @opt_param string ids Select only order documents with these IDs.
59   * @opt_param int maxResults Maximum number of results to return.
60   * @opt_param string orderId Select only order documents for specified orders.
61   * @opt_param string pageToken Value of the nextPageToken from the previous
62   * result page.
63   * @opt_param string searchString Allows searching for order documents by name
64   * or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will
65   * return order documents with names like "orderdocument June 2015",
66   * "orderdocument April 2015", or simply "orderdocument 2015". Most of the
67   * searches also add wildcards implicitly at the start and the end of the search
68   * string. For example, a search string of "orderdocument" will match order
69   * documents with name "my orderdocument", "orderdocument 2015", or simply
70   * "orderdocument".
71   * @opt_param string siteId Select only order documents that are associated with
72   * these sites.
73   * @opt_param string sortField Field by which to sort the list.
74   * @opt_param string sortOrder Order of sorted results.
75   * @return OrderDocumentsListResponse
76   */
77  public function listOrderDocuments($profileId, $projectId, $optParams = [])
78  {
79    $params = ['profileId' => $profileId, 'projectId' => $projectId];
80    $params = array_merge($params, $optParams);
81    return $this->call('list', [$params], OrderDocumentsListResponse::class);
82  }
83}
84
85// Adding a class alias for backwards compatibility with the previous class name.
86class_alias(OrderDocuments::class, 'Google_Service_Dfareporting_Resource_OrderDocuments');
87