Skip to content

Commit

Permalink
chore(homegraph): update the api
Browse files Browse the repository at this point in the history
#### homegraph:v1

The following keys were added:
- resources.devices.methods.requestLink (Total Keys: 9)
- schemas.RequestLinkRequest (Total Keys: 16)

The following keys were changed:
- revision (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Mar 3, 2021
1 parent bbbcfde commit a867202
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 1 deletion.
33 changes: 33 additions & 0 deletions docs/dyn/homegraph_v1.devices.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,9 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#reportStateAndNotification">reportStateAndNotification(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#requestLink">requestLink(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sends an account linking suggestion to users associated with any potential Cast devices detected by third-party devices. This request must be authorized using service account credentials from your Actions console project.</p>
<p class="toc_element">
<code><a href="#requestSync">requestSync(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
Expand Down Expand Up @@ -177,6 +180,36 @@ <h3>Method Details</h3>
}</pre>
</div>

<div class="method">
<code class="details" id="requestLink">requestLink(body=None, x__xgafv=None)</code>
<pre>Sends an account linking suggestion to users associated with any potential Cast devices detected by third-party devices. This request must be authorized using service account credentials from your Actions console project.

Args:
body: object, The request body.
The object takes the form of:

{ # Request type for the [`RequestLink`](#google.home.graph.v1.HomeGraphApiService.RequestLink) call.
&quot;payload&quot;: { # Payload containing potential devices detected and when they were detected. # Required. ID(s) and detection time of potential Cast devices.
&quot;detectionTime&quot;: &quot;A String&quot;, # Required. Time at which devices represented in `potential_cast_device_ids` were detected.
&quot;potentialCastDeviceIds&quot;: [ # Required. List of device IDs detected that may potentially be for Cast devices.
&quot;A String&quot;,
],
},
&quot;requestId&quot;: &quot;A String&quot;, # Required. Request ID used for debugging.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>

<div class="method">
<code class="details" id="requestSync">requestSync(body=None, x__xgafv=None)</code>
<pre>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&#x27;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.
Expand Down
54 changes: 53 additions & 1 deletion googleapiclient/discovery_cache/documents/homegraph.v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,24 @@
"https://www.googleapis.com/auth/homegraph"
]
},
"requestLink": {
"description": "Sends an account linking suggestion to users associated with any potential Cast devices detected by third-party devices. This request must be authorized using service account credentials from your Actions console project.",
"flatPath": "v1/devices:requestLink",
"httpMethod": "POST",
"id": "homegraph.devices.requestLink",
"parameterOrder": [],
"parameters": {},
"path": "v1/devices:requestLink",
"request": {
"$ref": "RequestLinkRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/homegraph"
]
},
"requestSync": {
"description": "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.",
"flatPath": "v1/devices:requestSync",
Expand Down Expand Up @@ -216,7 +234,7 @@
}
}
},
"revision": "20210122",
"revision": "20210226",
"rootUrl": "https://homegraph.googleapis.com/",
"schemas": {
"AgentDeviceId": {
Expand Down Expand Up @@ -527,6 +545,40 @@
},
"type": "object"
},
"RequestLinkRequest": {
"description": "Request type for the [`RequestLink`](#google.home.graph.v1.HomeGraphApiService.RequestLink) call.",
"id": "RequestLinkRequest",
"properties": {
"payload": {
"$ref": "RequestLinkRequestPayload",
"description": "Required. ID(s) and detection time of potential Cast devices."
},
"requestId": {
"description": "Required. Request ID used for debugging.",
"type": "string"
}
},
"type": "object"
},
"RequestLinkRequestPayload": {
"description": "Payload containing potential devices detected and when they were detected.",
"id": "RequestLinkRequestPayload",
"properties": {
"detectionTime": {
"description": "Required. Time at which devices represented in `potential_cast_device_ids` were detected.",
"format": "google-datetime",
"type": "string"
},
"potentialCastDeviceIds": {
"description": "Required. List of device IDs detected that may potentially be for Cast devices.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RequestSyncDevicesRequest": {
"description": "Request type for the [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService.RequestSyncDevices) call.",
"id": "RequestSyncDevicesRequest",
Expand Down

0 comments on commit a867202

Please sign in to comment.