source: vendor/google/apiclient-services/src/Dfareporting/Resource/InventoryItems.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 6 weeks ago

Upload project files

  • Property mode set to 100644
File size: 3.2 KB
Line 
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 * @throws \Google\Service\Exception
42 */
43 public function get($profileId, $projectId, $id, $optParams = [])
44 {
45 $params = ['profileId' => $profileId, 'projectId' => $projectId, 'id' => $id];
46 $params = array_merge($params, $optParams);
47 return $this->call('get', [$params], InventoryItem::class);
48 }
49 /**
50 * Retrieves a list of inventory items, possibly filtered. This method supports
51 * paging. (inventoryItems.listInventoryItems)
52 *
53 * @param string $profileId User profile ID associated with this request.
54 * @param string $projectId Project ID for order documents.
55 * @param array $optParams Optional parameters.
56 *
57 * @opt_param string ids Select only inventory items with these IDs.
58 * @opt_param bool inPlan Select only inventory items that are in plan.
59 * @opt_param int maxResults Maximum number of results to return.
60 * @opt_param string orderId Select only inventory items that belong to
61 * specified orders.
62 * @opt_param string pageToken Value of the nextPageToken from the previous
63 * result page.
64 * @opt_param string siteId Select only inventory items that are associated with
65 * these sites.
66 * @opt_param string sortField Field by which to sort the list.
67 * @opt_param string sortOrder Order of sorted results.
68 * @opt_param string type Select only inventory items with this type.
69 * @return InventoryItemsListResponse
70 * @throws \Google\Service\Exception
71 */
72 public function listInventoryItems($profileId, $projectId, $optParams = [])
73 {
74 $params = ['profileId' => $profileId, 'projectId' => $projectId];
75 $params = array_merge($params, $optParams);
76 return $this->call('list', [$params], InventoryItemsListResponse::class);
77 }
78}
79
80// Adding a class alias for backwards compatibility with the previous class name.
81class_alias(InventoryItems::class, 'Google_Service_Dfareporting_Resource_InventoryItems');
Note: See TracBrowser for help on using the repository browser.