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\InventoryItem;
21use Google\Service\Dfareporting\InventoryItemsListResponse;
22
23/**
24 * The "inventoryItems" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $dfareportingService = new Google\Service\Dfareporting(...);
28 *   $inventoryItems = $dfareportingService->inventoryItems;
29 *  </code>
30 */
31class InventoryItems extends \Google\Service\Resource
32{
33  /**
34   * Gets one inventory item by ID. (inventoryItems.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 Inventory item ID.
39   * @param array $optParams Optional parameters.
40   * @return InventoryItem
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], InventoryItem::class);
47  }
48  /**
49   * Retrieves a list of inventory items, possibly filtered. This method supports
50   * paging. (inventoryItems.listInventoryItems)
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 string ids Select only inventory items with these IDs.
57   * @opt_param bool inPlan Select only inventory items that are in plan.
58   * @opt_param int maxResults Maximum number of results to return.
59   * @opt_param string orderId Select only inventory items that belong to
60   * specified orders.
61   * @opt_param string pageToken Value of the nextPageToken from the previous
62   * result page.
63   * @opt_param string siteId Select only inventory items that are associated with
64   * these sites.
65   * @opt_param string sortField Field by which to sort the list.
66   * @opt_param string sortOrder Order of sorted results.
67   * @opt_param string type Select only inventory items with this type.
68   * @return InventoryItemsListResponse
69   */
70  public function listInventoryItems($profileId, $projectId, $optParams = [])
71  {
72    $params = ['profileId' => $profileId, 'projectId' => $projectId];
73    $params = array_merge($params, $optParams);
74    return $this->call('list', [$params], InventoryItemsListResponse::class);
75  }
76}
77
78// Adding a class alias for backwards compatibility with the previous class name.
79class_alias(InventoryItems::class, 'Google_Service_Dfareporting_Resource_InventoryItems');
80