source: vendor/google/apiclient-services/src/HomeGraphService/Resource/Devices.php@ e3d4e0a

<?php
/*
 * Copyright 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

namespace Google\Service\HomeGraphService\Resource;

use Google\Service\HomeGraphService\QueryRequest;
use Google\Service\HomeGraphService\QueryResponse;
use Google\Service\HomeGraphService\ReportStateAndNotificationRequest;
use Google\Service\HomeGraphService\ReportStateAndNotificationResponse;
use Google\Service\HomeGraphService\RequestSyncDevicesRequest;
use Google\Service\HomeGraphService\RequestSyncDevicesResponse;
use Google\Service\HomeGraphService\SyncRequest;
use Google\Service\HomeGraphService\SyncResponse;

/**
 * The "devices" collection of methods.
 * Typical usage is:
 *  <code>
 *   $homegraphService = new Google\Service\HomeGraphService(...);
 *   $devices = $homegraphService->devices;
 *  </code>
 */
class Devices extends \Google\Service\Resource
{
  /**
   * Gets the current states in Home Graph for the given set of the third-party
   * user's devices. The third-party user's identity is passed in via the
   * `agent_user_id` (see QueryRequest). This request must be authorized using
   * service account credentials from your Actions console project.
   * (devices.query)
   *
   * @param QueryRequest $postBody
   * @param array $optParams Optional parameters.
   * @return QueryResponse
   * @throws \Google\Service\Exception
   */
  public function query(QueryRequest $postBody, $optParams = [])
  {
    $params = ['postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('query', [$params], QueryResponse::class);
  }
  /**
   * Reports device state and optionally sends device notifications. Called by
   * your smart home Action when the state of a third-party device changes or you
   * need to send a notification about the device. See [Implement Report
   * State](https://developers.home.google.com/cloud-to-cloud/integration/report-
   * state) for more information. This method updates the device state according
   * to its declared [traits](https://developers.home.google.com/cloud-to-
   * cloud/primer/device-types-and-traits). Publishing a new state value outside
   * of these traits will result in an `INVALID_ARGUMENT` error response. The
   * third-party user's identity is passed in via the `agent_user_id` (see
   * ReportStateAndNotificationRequest). This request must be authorized using
   * service account credentials from your Actions console project.
   * (devices.reportStateAndNotification)
   *
   * @param ReportStateAndNotificationRequest $postBody
   * @param array $optParams Optional parameters.
   * @return ReportStateAndNotificationResponse
   * @throws \Google\Service\Exception
   */
  public function reportStateAndNotification(ReportStateAndNotificationRequest $postBody, $optParams = [])
  {
    $params = ['postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('reportStateAndNotification', [$params], ReportStateAndNotificationResponse::class);
  }
  /**
   * Requests Google to send an `action.devices.SYNC`
   * [intent](https://developers.home.google.com/cloud-to-cloud/intents/sync) to
   * your smart home Action to update device metadata for the given user. The
   * third-party user's identity is passed via the `agent_user_id` (see
   * RequestSyncDevicesRequest). This request must be authorized using service
   * account credentials from your Actions console project. (devices.requestSync)
   *
   * @param RequestSyncDevicesRequest $postBody
   * @param array $optParams Optional parameters.
   * @return RequestSyncDevicesResponse
   * @throws \Google\Service\Exception
   */
  public function requestSync(RequestSyncDevicesRequest $postBody, $optParams = [])
  {
    $params = ['postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('requestSync', [$params], RequestSyncDevicesResponse::class);
  }
  /**
   * Gets all the devices associated with the given third-party user. The third-
   * party user's identity is passed in via the `agent_user_id` (see SyncRequest).
   * This request must be authorized using service account credentials from your
   * Actions console project. (devices.sync)
   *
   * @param SyncRequest $postBody
   * @param array $optParams Optional parameters.
   * @return SyncResponse
   * @throws \Google\Service\Exception
   */
  public function sync(SyncRequest $postBody, $optParams = [])
  {
    $params = ['postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('sync', [$params], SyncResponse::class);
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Devices::class, 'Google_Service_HomeGraphService_Resource_Devices');