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 |
|
---|
18 | namespace Google\Service\AndroidProvisioningPartner\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\AndroidProvisioningPartner\AndroiddeviceprovisioningEmpty;
|
---|
21 | use Google\Service\AndroidProvisioningPartner\CustomerApplyConfigurationRequest;
|
---|
22 | use Google\Service\AndroidProvisioningPartner\CustomerListDevicesResponse;
|
---|
23 | use Google\Service\AndroidProvisioningPartner\CustomerRemoveConfigurationRequest;
|
---|
24 | use Google\Service\AndroidProvisioningPartner\CustomerUnclaimDeviceRequest;
|
---|
25 | use Google\Service\AndroidProvisioningPartner\Device;
|
---|
26 |
|
---|
27 | /**
|
---|
28 | * The "devices" collection of methods.
|
---|
29 | * Typical usage is:
|
---|
30 | * <code>
|
---|
31 | * $androiddeviceprovisioningService = new Google\Service\AndroidProvisioningPartner(...);
|
---|
32 | * $devices = $androiddeviceprovisioningService->customers_devices;
|
---|
33 | * </code>
|
---|
34 | */
|
---|
35 | class CustomersDevices extends \Google\Service\Resource
|
---|
36 | {
|
---|
37 | /**
|
---|
38 | * Applies a Configuration to the device to register the device for zero-touch
|
---|
39 | * enrollment. After applying a configuration to a device, the device
|
---|
40 | * automatically provisions itself on first boot, or next factory reset.
|
---|
41 | * (devices.applyConfiguration)
|
---|
42 | *
|
---|
43 | * @param string $parent Required. The customer managing the device. An API
|
---|
44 | * resource name in the format `customers/[CUSTOMER_ID]`.
|
---|
45 | * @param CustomerApplyConfigurationRequest $postBody
|
---|
46 | * @param array $optParams Optional parameters.
|
---|
47 | * @return AndroiddeviceprovisioningEmpty
|
---|
48 | * @throws \Google\Service\Exception
|
---|
49 | */
|
---|
50 | public function applyConfiguration($parent, CustomerApplyConfigurationRequest $postBody, $optParams = [])
|
---|
51 | {
|
---|
52 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
53 | $params = array_merge($params, $optParams);
|
---|
54 | return $this->call('applyConfiguration', [$params], AndroiddeviceprovisioningEmpty::class);
|
---|
55 | }
|
---|
56 | /**
|
---|
57 | * Gets the details of a device. (devices.get)
|
---|
58 | *
|
---|
59 | * @param string $name Required. The device to get. An API resource name in the
|
---|
60 | * format `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`.
|
---|
61 | * @param array $optParams Optional parameters.
|
---|
62 | * @return Device
|
---|
63 | * @throws \Google\Service\Exception
|
---|
64 | */
|
---|
65 | public function get($name, $optParams = [])
|
---|
66 | {
|
---|
67 | $params = ['name' => $name];
|
---|
68 | $params = array_merge($params, $optParams);
|
---|
69 | return $this->call('get', [$params], Device::class);
|
---|
70 | }
|
---|
71 | /**
|
---|
72 | * Lists a customer's devices. (devices.listCustomersDevices)
|
---|
73 | *
|
---|
74 | * @param string $parent Required. The customer managing the devices. An API
|
---|
75 | * resource name in the format `customers/[CUSTOMER_ID]`.
|
---|
76 | * @param array $optParams Optional parameters.
|
---|
77 | *
|
---|
78 | * @opt_param string pageSize The maximum number of devices to show in a page of
|
---|
79 | * results. Must be between 1 and 100 inclusive.
|
---|
80 | * @opt_param string pageToken A token specifying which result page to return.
|
---|
81 | * @return CustomerListDevicesResponse
|
---|
82 | * @throws \Google\Service\Exception
|
---|
83 | */
|
---|
84 | public function listCustomersDevices($parent, $optParams = [])
|
---|
85 | {
|
---|
86 | $params = ['parent' => $parent];
|
---|
87 | $params = array_merge($params, $optParams);
|
---|
88 | return $this->call('list', [$params], CustomerListDevicesResponse::class);
|
---|
89 | }
|
---|
90 | /**
|
---|
91 | * Removes a configuration from device. (devices.removeConfiguration)
|
---|
92 | *
|
---|
93 | * @param string $parent Required. The customer managing the device in the
|
---|
94 | * format `customers/[CUSTOMER_ID]`.
|
---|
95 | * @param CustomerRemoveConfigurationRequest $postBody
|
---|
96 | * @param array $optParams Optional parameters.
|
---|
97 | * @return AndroiddeviceprovisioningEmpty
|
---|
98 | * @throws \Google\Service\Exception
|
---|
99 | */
|
---|
100 | public function removeConfiguration($parent, CustomerRemoveConfigurationRequest $postBody, $optParams = [])
|
---|
101 | {
|
---|
102 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
103 | $params = array_merge($params, $optParams);
|
---|
104 | return $this->call('removeConfiguration', [$params], AndroiddeviceprovisioningEmpty::class);
|
---|
105 | }
|
---|
106 | /**
|
---|
107 | * Unclaims a device from a customer and removes it from zero-touch enrollment.
|
---|
108 | * After removing a device, a customer must contact their reseller to register
|
---|
109 | * the device into zero-touch enrollment again. (devices.unclaim)
|
---|
110 | *
|
---|
111 | * @param string $parent Required. The customer managing the device. An API
|
---|
112 | * resource name in the format `customers/[CUSTOMER_ID]`.
|
---|
113 | * @param CustomerUnclaimDeviceRequest $postBody
|
---|
114 | * @param array $optParams Optional parameters.
|
---|
115 | * @return AndroiddeviceprovisioningEmpty
|
---|
116 | * @throws \Google\Service\Exception
|
---|
117 | */
|
---|
118 | public function unclaim($parent, CustomerUnclaimDeviceRequest $postBody, $optParams = [])
|
---|
119 | {
|
---|
120 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
121 | $params = array_merge($params, $optParams);
|
---|
122 | return $this->call('unclaim', [$params], AndroiddeviceprovisioningEmpty::class);
|
---|
123 | }
|
---|
124 | }
|
---|
125 |
|
---|
126 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
127 | class_alias(CustomersDevices::class, 'Google_Service_AndroidProvisioningPartner_Resource_CustomersDevices');
|
---|