* $cloudidentityService = new Google\Service\CloudIdentity(...); * $devices = $cloudidentityService->devices; * */ class Devices extends \Google\Service\Resource { /** * Cancels an unfinished device wipe. This operation can be used to cancel * device wipe in the gap between the wipe operation returning success and the * device being wiped. This operation is possible when the device is in a * "pending wipe" state. The device enters the "pending wipe" state when a wipe * device command is issued, but has not yet been sent to the device. The cancel * wipe will fail if the wipe command has already been issued to the device. * (devices.cancelWipe) * * @param string $name Required. [Resource * name](https://cloud.google.com/apis/design/resource_names) of the Device in * format: `devices/{device}`, where device is the unique ID assigned to the * Device. * @param GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest $postBody * @param array $optParams Optional parameters. * @return Operation */ public function cancelWipe($name, GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('cancelWipe', [$params], Operation::class); } /** * Creates a device. Only company-owned device may be created. **Note**: This * method is available only to customers who have one of the following SKUs: * Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud * Identity Premium (devices.create) * * @param GoogleAppsCloudidentityDevicesV1Device $postBody * @param array $optParams Optional parameters. * * @opt_param string customer Optional. [Resource * name](https://cloud.google.com/apis/design/resource_names) of the customer. * If you're using this API for your own organization, use * `customers/my_customer` If you're using this API to manage another * organization, use `customers/{customer}`, where customer is the customer to * whom the device belongs. * @return Operation */ public function create(GoogleAppsCloudidentityDevicesV1Device $postBody, $optParams = []) { $params = ['postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], Operation::class); } /** * Deletes the specified device. (devices.delete) * * @param string $name Required. [Resource * name](https://cloud.google.com/apis/design/resource_names) of the Device in * format: `devices/{device}`, where device is the unique ID assigned to the * Device. * @param array $optParams Optional parameters. * * @opt_param string customer Optional. [Resource * name](https://cloud.google.com/apis/design/resource_names) of the customer. * If you're using this API for your own organization, use * `customers/my_customer` If you're using this API to manage another * organization, use `customers/{customer}`, where customer is the customer to * whom the device belongs. * @return Operation */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], Operation::class); } /** * Retrieves the specified device. (devices.get) * * @param string $name Required. [Resource * name](https://cloud.google.com/apis/design/resource_names) of the Device in * the format: `devices/{device}`, where device is the unique ID assigned to the * Device. * @param array $optParams Optional parameters. * * @opt_param string customer Optional. [Resource * name](https://cloud.google.com/apis/design/resource_names) of the Customer in * the format: `customers/{customer}`, where customer is the customer to whom * the device belongs. If you're using this API for your own organization, use * `customers/my_customer`. If you're using this API to manage another * organization, use `customers/{customer}`, where customer is the customer to * whom the device belongs. * @return GoogleAppsCloudidentityDevicesV1Device */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GoogleAppsCloudidentityDevicesV1Device::class); } /** * Lists/Searches devices. (devices.listDevices) * * @param array $optParams Optional parameters. * * @opt_param string customer Optional. [Resource * name](https://cloud.google.com/apis/design/resource_names) of the customer in * the format: `customers/{customer}`, where customer is the customer to whom * the device belongs. If you're using this API for your own organization, use * `customers/my_customer`. If you're using this API to manage another * organization, use `customers/{customer}`, where customer is the customer to * whom the device belongs. * @opt_param string filter Optional. Additional restrictions when fetching list * of devices. For a list of search fields, refer to [Mobile device search * fields](https://developers.google.com/admin-sdk/directory/v1/search- * operators). Multiple search fields are separated by the space character. * @opt_param string orderBy Optional. Order specification for devices in the * response. Only one of the following field names may be used to specify the * order: `create_time`, `last_sync_time`, `model`, `os_version`, `device_type` * and `serial_number`. `desc` may be specified optionally at the end to specify * results to be sorted in descending order. Default order is ascending. * @opt_param int pageSize Optional. The maximum number of Devices to return. If * unspecified, at most 20 Devices will be returned. The maximum value is 100; * values above 100 will be coerced to 100. * @opt_param string pageToken Optional. A page token, received from a previous * `ListDevices` call. Provide this to retrieve the subsequent page. When * paginating, all other parameters provided to `ListDevices` must match the * call that provided the page token. * @opt_param string view Optional. The view to use for the List request. * @return GoogleAppsCloudidentityDevicesV1ListDevicesResponse */ public function listDevices($optParams = []) { $params = []; $params = array_merge($params, $optParams); return $this->call('list', [$params], GoogleAppsCloudidentityDevicesV1ListDevicesResponse::class); } /** * Wipes all data on the specified device. (devices.wipe) * * @param string $name Required. [Resource * name](https://cloud.google.com/apis/design/resource_names) of the Device in * format: `devices/{device}/deviceUsers/{device_user}`, where device is the * unique ID assigned to the Device, and device_user is the unique ID assigned * to the User. * @param GoogleAppsCloudidentityDevicesV1WipeDeviceRequest $postBody * @param array $optParams Optional parameters. * @return Operation */ public function wipe($name, GoogleAppsCloudidentityDevicesV1WipeDeviceRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('wipe', [$params], Operation::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(Devices::class, 'Google_Service_CloudIdentity_Resource_Devices');