chiu
/
google-api-ruby-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
google-api-ruby-client/generated/google/apis/homegraph_v1/service.rb

256 lines
14 KiB
Ruby
Raw Normal View History

Autogenerated update (2019-09-10) Delete: - appstate_v1 Update: - abusiveexperiencereport_v1 - adexperiencereport_v1 - analyticsreporting_v4 - androidmanagement_v1 - bigquery_v2 - bigtableadmin_v2 - binaryauthorization_v1beta1 - calendar_v3 - cloudasset_v1 - cloudasset_v1beta1 - cloudiot_v1 - cloudkms_v1 - cloudresourcemanager_v1 - cloudresourcemanager_v1beta1 - cloudresourcemanager_v2 - cloudresourcemanager_v2beta1 - cloudsearch_v1 - cloudtasks_v2beta3 - cloudtrace_v2 - commentanalyzer_v1alpha1 - composer_v1 - composer_v1beta1 - compute_alpha - compute_beta - compute_v1 - container_v1 - container_v1beta1 - content_v2 - content_v2_1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - datastore_v1 - datastore_v1beta1 - dfareporting_v3_1 - dialogflow_v2beta1 - dlp_v2 - docs_v1 - drive_v2 - drive_v3 - driveactivity_v2 - firestore_v1 - firestore_v1beta1 - firestore_v1beta2 - healthcare_v1alpha2 - healthcare_v1beta1 - logging_v2 - ml_v1 - monitoring_v3 - pagespeedonline_v5 - pubsub_v1 - pubsub_v1beta2 - run_v1alpha1 - runtimeconfig_v1beta1 - script_v1 - securitycenter_v1 - securitycenter_v1beta1 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - slides_v1 - speech_v1 - speech_v1p1beta1 - speech_v2beta - sqladmin_v1beta4 - storage_v1 - storagetransfer_v1 - testing_v1 - toolresults_v1beta3 - translate_v3beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1 - youtube_partner_v1 - youtube_v3
2019-09-10 21:25:47 +00:00
# Copyright 2015 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.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module HomegraphV1
# HomeGraph API
#
#
#
# @example
# require 'google/apis/homegraph_v1'
#
# Homegraph = Google::Apis::HomegraphV1 # Alias the module
# service = Homegraph::HomeGraphServiceService.new
#
# @see https://developers.google.com/actions/smarthome/create-app#request-sync
class HomeGraphServiceService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://homegraph.googleapis.com/', '')
@batch_path = 'batch'
end
# Unlinks an agent user from Google. As a result, all data related to this
# user will be deleted.
# Here is how the agent user is created in Google:
# 1. When a user opens their Google Home App, they can begin linking a 3p
# partner.
# 2. User is guided through the OAuth process.
# 3. After entering the 3p credentials, Google gets the 3p OAuth token and
# uses it to make a Sync call to the 3p partner and gets back all of the
# user's data, including `agent_user_id` and devices.
# 4. Google creates the agent user and stores a mapping from the
# `agent_user_id` -> Google ID mapping. Google also
# stores all of the user's devices under that Google ID.
# The mapping from `agent_user_id` to Google ID is many to many, since one
# Google user can have multiple 3p accounts, and multiple Google users can
# map to one `agent_user_id` (e.g., a husband and wife share one Nest account
# username/password).
# The third-party user's identity is passed in as `agent_user_id`.
# The agent is identified by the JWT signed by the partner's service account.
# Note: Special characters (except "/") in `agent_user_id` must be
# URL-encoded.
# @param [String] agent_user_id
# Required. Third-party user ID.
# @param [String] request_id
# Request ID used for debugging.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::HomegraphV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::HomegraphV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_agent_user(agent_user_id, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+agentUserId}', options)
command.response_representation = Google::Apis::HomegraphV1::Empty::Representation
command.response_class = Google::Apis::HomegraphV1::Empty
command.params['agentUserId'] = agent_user_id unless agent_user_id.nil?
command.query['requestId'] = request_id unless request_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the device states for the devices in QueryRequest.
# The third-party user's identity is passed in as `agent_user_id`. The agent
# is identified by the JWT signed by the third-party partner's service
# account.
# @param [Google::Apis::HomegraphV1::QueryRequest] query_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::HomegraphV1::QueryResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::HomegraphV1::QueryResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def query_device(query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/devices:query', options)
command.request_representation = Google::Apis::HomegraphV1::QueryRequest::Representation
command.request_object = query_request_object
command.response_representation = Google::Apis::HomegraphV1::QueryResponse::Representation
command.response_class = Google::Apis::HomegraphV1::QueryResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Reports device state and optionally sends device notifications. Called by
# an agent when the device state of a third-party changes or the agent wants
# to send a notification about the device. See
# [Implement Report State](/actions/smarthome/report-state) for more
# information.
# This method updates a predefined set of states for a device, which all
# devices have according to their prescribed traits (for example, a light
# will have the [OnOff](/actions/smarthome/traits/onoff) trait that reports
# the state `on` as a boolean value).
# A new state may not be created and an INVALID_ARGUMENT code will be thrown
# if so. It also optionally takes in a list of Notifications that may be
# created, which are associated to this state change.
# The third-party user's identity is passed in as `agent_user_id`.
# The agent is identified by the JWT signed by the partner's service account.
# @param [Google::Apis::HomegraphV1::ReportStateAndNotificationRequest] report_state_and_notification_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::HomegraphV1::ReportStateAndNotificationResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::HomegraphV1::ReportStateAndNotificationResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def report_device_state_and_notification(report_state_and_notification_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/devices:reportStateAndNotification', options)
command.request_representation = Google::Apis::HomegraphV1::ReportStateAndNotificationRequest::Representation
command.request_object = report_state_and_notification_request_object
command.response_representation = Google::Apis::HomegraphV1::ReportStateAndNotificationResponse::Representation
command.response_class = Google::Apis::HomegraphV1::ReportStateAndNotificationResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Requests a `SYNC` call from Google to a 3p partner's home control agent for
# a user.
# The third-party user's identity is passed in as `agent_user_id`
# (see RequestSyncDevicesRequest) and forwarded back to the agent.
# The agent is identified by the API key or JWT signed by the partner's
# service account.
# @param [Google::Apis::HomegraphV1::RequestSyncDevicesRequest] request_sync_devices_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::HomegraphV1::RequestSyncDevicesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::HomegraphV1::RequestSyncDevicesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def request_sync_devices(request_sync_devices_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/devices:requestSync', options)
command.request_representation = Google::Apis::HomegraphV1::RequestSyncDevicesRequest::Representation
command.request_object = request_sync_devices_request_object
command.response_representation = Google::Apis::HomegraphV1::RequestSyncDevicesResponse::Representation
command.response_class = Google::Apis::HomegraphV1::RequestSyncDevicesResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets all the devices associated with the given third-party user.
# The third-party user's identity is passed in as `agent_user_id`. The agent
# is identified by the JWT signed by the third-party partner's service
# account.
# @param [Google::Apis::HomegraphV1::SyncRequest] sync_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::HomegraphV1::SyncResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::HomegraphV1::SyncResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def sync_device(sync_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/devices:sync', options)
command.request_representation = Google::Apis::HomegraphV1::SyncRequest::Representation
command.request_object = sync_request_object
command.response_representation = Google::Apis::HomegraphV1::SyncResponse::Representation
command.response_class = Google::Apis::HomegraphV1::SyncResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end