google-api-client 0.32.1 → 0.40.0

data/generated/google/apis/healthcare_v1beta1.rb

@@ -25,7 +25,7 @@ module Google
     # @see https://cloud.google.com/healthcare
     module HealthcareV1beta1
       VERSION = 'V1beta1'
-      REVISION = '20190924'
+      REVISION = '20200515'
 
       # View and manage your data across Google Cloud Platform services
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

data/generated/google/apis/homegraph_v1/classes.rb

@@ -22,11 +22,11 @@ module Google
   module Apis
     module HomegraphV1
       
-      # Third-party partner's device ID for one device.
+      # Third-party device ID for one device.
       class AgentDeviceId
         include Google::Apis::Core::Hashable
       
-        # Third-party partner's device ID.
+        # Third-party device ID.
         # Corresponds to the JSON property `id`
         # @return [String]
         attr_accessor :id
@@ -41,16 +41,16 @@ module Google
         end
       end
       
-      # Identifies a device in the third party or first party system.
+      # Alternate third-party device ID.
       class AgentOtherDeviceId
         include Google::Apis::Core::Hashable
       
-        # The agent's ID. Generally it is the agent's AoG project id.
+        # Project ID for your smart home Action.
         # Corresponds to the JSON property `agentId`
         # @return [String]
         attr_accessor :agent_id
       
-        # Device ID defined by the agent. The device_id must be unique.
+        # Unique third-party device ID.
         # Corresponds to the JSON property `deviceId`
         # @return [String]
         attr_accessor :device_id
@@ -66,7 +66,7 @@ module Google
         end
       end
       
-      # Third-party partner's device definition.
+      # Third-party device definition.
       class Device
         include Google::Apis::Core::Hashable
       
@@ -75,10 +75,16 @@ module Google
         # @return [Hash<String,Object>]
         attr_accessor :attributes
       
-        # Custom JSON data provided by the manufacturer and attached to QUERY and
-        # EXECUTE requests in AoG.
+        # Custom device attributes stored in Home Graph and provided to your
+        # smart home Action in each
+        # [QUERY](https://developers.google.com/assistant/smarthome/reference/intent/
+        # query)
+        # and
+        # [EXECUTE](https://developers.google.com/assistant/smarthome/reference/intent/
+        # execute)
+        # intent.
         # Corresponds to the JSON property `customData`
-        # @return [String]
+        # @return [Hash<String,Object>]
         attr_accessor :custom_data
       
         # Device information.
@@ -86,49 +92,63 @@ module Google
         # @return [Google::Apis::HomegraphV1::DeviceInfo]
         attr_accessor :device_info
       
-        # Third-party partner's device ID.
+        # Third-party device ID.
         # Corresponds to the JSON property `id`
         # @return [String]
         attr_accessor :id
       
-        # Different names for the device.
+        # Identifiers used to describe the device.
         # Corresponds to the JSON property `name`
         # @return [Google::Apis::HomegraphV1::DeviceNames]
         attr_accessor :name
       
-        # IDs of other devices associated with this device. This is used to
-        # represent a device group (e.g. bonded zone) or "facets" synced
-        # through different flows (e.g. Google Nest Hub Max with a Nest Camera).
-        # This may also be used to pass in alternate IDs used to identify a cloud
-        # synced device for local execution (i.e. local verification). If used for
-        # local verification, this field is synced from the cloud.
+        # Indicates whether your smart home Action will report notifications
+        # to Google for this device via
+        # ReportStateAndNotification.
+        # If your smart home Action enables users to control device notifications,
+        # you should update this field and call
+        # RequestSyncDevices.
+        # Corresponds to the JSON property `notificationSupportedByAgent`
+        # @return [Boolean]
+        attr_accessor :notification_supported_by_agent
+        alias_method :notification_supported_by_agent?, :notification_supported_by_agent
+      
+        # Alternate IDs associated with this device.
+        # This is used to identify cloud synced devices enabled for [local
+        # fulfillment](https://developers.google.com/assistant/smarthome/concepts/local).
         # Corresponds to the JSON property `otherDeviceIds`
         # @return [Array<Google::Apis::HomegraphV1::AgentOtherDeviceId>]
         attr_accessor :other_device_ids
       
-        # If the third-party partner's cloud configuration includes placing devices
-        # in rooms, the name of the room can be provided here.
+        # Suggested name for the room where this device is installed.
+        # Google attempts to use this value during user setup.
         # Corresponds to the JSON property `roomHint`
         # @return [String]
         attr_accessor :room_hint
       
-        # As in roomHint, for structures that users set up in the partner's system.
+        # Suggested name for the structure where this device is installed.
+        # Google attempts to use this value during user setup.
         # Corresponds to the JSON property `structureHint`
         # @return [String]
         attr_accessor :structure_hint
       
         # Traits supported by the device.
+        # See [device
+        # traits](https://developers.google.com/assistant/smarthome/traits).
         # Corresponds to the JSON property `traits`
         # @return [Array<String>]
         attr_accessor :traits
       
-        # Hardware type of the device (e.g. light, outlet, etc).
+        # Hardware type of the device.
+        # See [device
+        # types](https://developers.google.com/assistant/smarthome/guides).
         # Corresponds to the JSON property `type`
         # @return [String]
         attr_accessor :type
       
-        # Indicates whether the state of this device is being reported to Google
-        # through ReportStateAndNotification call.
+        # Indicates whether your smart home Action will report state of this device
+        # to Google via
+        # ReportStateAndNotification.
         # Corresponds to the JSON property `willReportState`
         # @return [Boolean]
         attr_accessor :will_report_state
@@ -145,6 +165,7 @@ module Google
           @device_info = args[:device_info] if args.key?(:device_info)
           @id = args[:id] if args.key?(:id)
           @name = args[:name] if args.key?(:name)
+          @notification_supported_by_agent = args[:notification_supported_by_agent] if args.key?(:notification_supported_by_agent)
           @other_device_ids = args[:other_device_ids] if args.key?(:other_device_ids)
           @room_hint = args[:room_hint] if args.key?(:room_hint)
           @structure_hint = args[:structure_hint] if args.key?(:structure_hint)
@@ -191,12 +212,12 @@ module Google
         end
       end
       
-      # Different names for the device.
+      # Identifiers used to describe the device.
       class DeviceNames
         include Google::Apis::Core::Hashable
       
-        # List of names provided by the partner rather than the user, often
-        # manufacturer names, SKUs, etc.
+        # List of names provided by the manufacturer rather than the user, such as
+        # serial numbers, SKUs, etc.
         # Corresponds to the JSON property `defaultNames`
         # @return [Array<String>]
         attr_accessor :default_names
@@ -243,11 +264,7 @@ module Google
       end
       
       # Request type for the
-      # [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. This should
-      # be the same format as the Actions on Google `action.devices.QUERY`
-      # [request](/actions/smarthome/create-app#actiondevicesquery) with the
-      # exception of the extra `agent_user_id` and no `intent` and `customData`
-      # fields.
+      # [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call.
       class QueryRequest
         include Google::Apis::Core::Hashable
       
@@ -256,7 +273,7 @@ module Google
         # @return [String]
         attr_accessor :agent_user_id
       
-        # Required. Inputs containing third-party partner's device IDs for which to
+        # Required. Inputs containing third-party device IDs for which to
         # get the device states.
         # Corresponds to the JSON property `inputs`
         # @return [Array<Google::Apis::HomegraphV1::QueryRequestInput>]
@@ -302,7 +319,7 @@ module Google
       class QueryRequestPayload
         include Google::Apis::Core::Hashable
       
-        # Third-party partner's device IDs for which to get the device states.
+        # Third-party device IDs for which to get the device states.
         # Corresponds to the JSON property `devices`
         # @return [Array<Google::Apis::HomegraphV1::AgentDeviceId>]
         attr_accessor :devices
@@ -318,9 +335,11 @@ module Google
       end
       
       # Response type for the
-      # [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. This should
-      # follow the same format as the Actions on Google `action.devices.QUERY`
-      # [response](/actions/smarthome/create-app#actiondevicesquery).
+      # [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call.
+      # This should follow the same format as the Google smart home
+      # `action.devices.QUERY`
+      # [response](https://developers.google.com/assistant/smarthome/reference/intent/
+      # query).
       # # Example
       # ```json
       # `
@@ -392,12 +411,16 @@ module Google
       class ReportStateAndNotificationDevice
         include Google::Apis::Core::Hashable
       
-        # Notifications metadata for devices.
+        # Notifications metadata for devices. See the **Device NOTIFICATIONS**
+        # section of the individual trait [reference
+        # guides](https://developers.google.com/assistant/smarthome/traits).
         # Corresponds to the JSON property `notifications`
         # @return [Hash<String,Object>]
         attr_accessor :notifications
       
-        # States of devices to update.
+        # States of devices to update. See the **Device STATES** section
+        # of the individual trait [reference
+        # guides](https://developers.google.com/assistant/smarthome/traits).
         # Corresponds to the JSON property `states`
         # @return [Hash<String,Object>]
         attr_accessor :states
@@ -416,12 +439,10 @@ module Google
       # Request type for the
       # [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.
       # ReportStateAndNotification)
-      # call. It may include States, Notifications, or both. This request uses
-      # globally unique flattened state names instead of namespaces based on traits
-      # to align with the existing QUERY and EXECUTE APIs implemented by 90+ Smart
-      # Home partners. States and notifications are defined per `device_id` (for
-      # example, "123"
-      # and "456" in the following example). # Example
+      # call. It may include states, notifications, or both. States and notifications
+      # are defined per `device_id` (for example, "123" and "456" in the following
+      # example).
+      # # Example
       # ```json
       # `
       # "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
@@ -455,6 +476,9 @@ module Google
         attr_accessor :event_id
       
         # Token to maintain state in the follow up notification response.
+        # Deprecated. See the [notifications
+        # guide](https://developers.google.com/assistant/smarthome/develop/notifications)
+        # for details on implementing follow up notifications.
         # Corresponds to the JSON property `followUpToken`
         # @return [String]
         attr_accessor :follow_up_token
@@ -512,15 +536,14 @@ module Google
       class RequestSyncDevicesRequest
         include Google::Apis::Core::Hashable
       
-        # Required. Third-party user ID issued by agent's third-party identity
-        # provider.
+        # Required. Third-party user ID.
         # Corresponds to the JSON property `agentUserId`
         # @return [String]
         attr_accessor :agent_user_id
       
         # Optional. If set, the request will be added to a queue and a response will
-        # be returned immediately. The queue allows for de-duplication of
-        # simultaneous requests.
+        # be returned immediately. This enables concurrent requests for the given
+        # `agent_user_id`, but the caller will not receive any error responses.
         # Corresponds to the JSON property `async`
         # @return [Boolean]
         attr_accessor :async
@@ -540,7 +563,8 @@ module Google
       # Response type for the
       # [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService.
       # RequestSyncDevices)
-      # call. Intentionally empty upon success. An HTTP response code is returned
+      # call.
+      # Intentionally empty upon success. An HTTP response code is returned
       # with more details upon failure.
       class RequestSyncDevicesResponse
         include Google::Apis::Core::Hashable
@@ -574,10 +598,7 @@ module Google
       end
       
       # Request type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync)
-      # call. This should follow the same format as the Actions on Google
-      # `action.devices.SYNC`
-      # [request](/actions/smarthome/create-app#actiondevicessync) with the exception
-      # of the extra `agent_user_id` and no `intent` field.
+      # call.
       class SyncRequest
         include Google::Apis::Core::Hashable
       
@@ -603,9 +624,11 @@ module Google
       end
       
       # Response type for the
-      # [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call. This should
-      # follow the same format as the Actions on Google `action.devices.SYNC`
-      # [response](/actions/smarthome/create-app#actiondevicessync).
+      # [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call.
+      # This should follow the same format as the Google smart home
+      # `action.devices.SYNC`
+      # [response](https://developers.google.com/assistant/smarthome/reference/intent/
+      # sync).
       # # Example
       # ```json
       # `

data/generated/google/apis/homegraph_v1/representations.rb

@@ -161,12 +161,13 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           hash :attributes, as: 'attributes'
-          property :custom_data, as: 'customData'
+          hash :custom_data, as: 'customData'
           property :device_info, as: 'deviceInfo', class: Google::Apis::HomegraphV1::DeviceInfo, decorator: Google::Apis::HomegraphV1::DeviceInfo::Representation
       
           property :id, as: 'id'
           property :name, as: 'name', class: Google::Apis::HomegraphV1::DeviceNames, decorator: Google::Apis::HomegraphV1::DeviceNames::Representation
       
+          property :notification_supported_by_agent, as: 'notificationSupportedByAgent'
           collection :other_device_ids, as: 'otherDeviceIds', class: Google::Apis::HomegraphV1::AgentOtherDeviceId, decorator: Google::Apis::HomegraphV1::AgentOtherDeviceId::Representation
       
           property :room_hint, as: 'roomHint'

data/generated/google/apis/homegraph_v1/service.rb

@@ -47,26 +47,16 @@ module Google
           @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.
+        # Unlinks the given third-party user from your smart home Action.
+        # All data related to this user will be deleted.
+        # For more details on how users link their accounts, see
+        # [fulfillment and
+        # authentication](https://developers.google.com/assistant/smarthome/concepts/
+        # fulfillment-authentication).
+        # The third-party user's identity is passed in via the `agent_user_id`
+        # (see DeleteAgentUserRequest).
+        # This request must be authorized using service account credentials from your
+        # Actions console project.
         # @param [String] agent_user_id
         #   Required. Third-party user ID.
         # @param [String] request_id
@@ -99,10 +89,12 @@ module Google
           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.
+        # 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.
         # @param [Google::Apis::HomegraphV1::QueryRequest] query_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -132,20 +124,21 @@ module Google
           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.
+        # 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.google.com/assistant/smarthome/develop/report-state)
+        # for more information.
+        # This method updates the device state according to its declared
+        # [traits](https://developers.google.com/assistant/smarthome/concepts/devices-
+        # 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.
         # @param [Google::Apis::HomegraphV1::ReportStateAndNotificationRequest] report_state_and_notification_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -175,12 +168,14 @@ module Google
           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.
+        # Requests Google to send an `action.devices.SYNC`
+        # [intent](https://developers.google.com/assistant/smarthome/reference/intent/
+        # 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.
         # @param [Google::Apis::HomegraphV1::RequestSyncDevicesRequest] request_sync_devices_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -211,9 +206,10 @@ module Google
         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.
+        # 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.
         # @param [Google::Apis::HomegraphV1::SyncRequest] sync_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.

data/generated/google/apis/homegraph_v1.rb

@@ -25,7 +25,7 @@ module Google
     # @see https://developers.google.com/actions/smarthome/create-app#request-sync
     module HomegraphV1
       VERSION = 'V1'
-      REVISION = '20190827'
+      REVISION = '20200522'
     end
   end
 end