google-apis-homegraph_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: b1ad42d685bc7e2ef3fc07635d65c8e96a477d0282839f9223ad5d95fdcb049e
4
+ data.tar.gz: ac42238797bed94ed1c5e9bf7864a6d74a92d6c99685d07d314a219baf4375c7
5
+ SHA512:
6
+ metadata.gz: abcbc04ac027356bbedef6da18d6a1a06d66f1c7acc761cae16613c6aa6b2a4fcd3b4f4dac95599f1a2b4cf09efd9de0d089bd44395c1c11904e84eb496b64fa
7
+ data.tar.gz: fc5b80382580ba81c045a6c05d6d3f8d783a57ba400ac80401aa724008132660a52a57aa326376de2c4a697e898f968e44e619506904674c4f0fe435e3737478
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-homegraph_v1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/homegraph_v1/*.rb
9
+ lib/google/apis/homegraph_v1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-homegraph_v1
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated using generator version 0.1.1
6
+ * Regenerated from discovery document revision 20200827
7
+
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V1 of the HomeGraph API
2
+
3
+ This is a simple client library for version V1 of the HomeGraph API. It provides:
4
+
5
+ * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
+ * Ruby objects for data structures related to the service.
7
+ * Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
8
+ * Control of retry, pagination, and timeouts.
9
+
10
+ Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
11
+
12
+ ## Getting started
13
+
14
+ ### Before you begin
15
+
16
+ There are a few setup steps you need to complete before you can use this library:
17
+
18
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
19
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
20
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/homegraph.googleapis.com) in the console.
21
+
22
+ ### Installation
23
+
24
+ Add this line to your application's Gemfile:
25
+
26
+ ```ruby
27
+ gem 'google-apis-homegraph_v1', '~> 0.1'
28
+ ```
29
+
30
+ And then execute:
31
+
32
+ ```
33
+ $ bundle
34
+ ```
35
+
36
+ Or install it yourself as:
37
+
38
+ ```
39
+ $ gem install google-apis-homegraph_v1
40
+ ```
41
+
42
+ ### Creating a client object
43
+
44
+ Once the gem is installed, you can load the client code and instantiate a client.
45
+
46
+ ```ruby
47
+ # Load the client
48
+ require "google/apis/homegraph_v1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::HomegraphV1::HomeGraphServiceService.new
52
+
53
+ # Authenticate calls
54
+ client.authentication = # ... use the googleauth gem to create credentials
55
+ ```
56
+
57
+ See the class reference docs for information on the methods you can call from a client.
58
+
59
+ ## Documentation
60
+
61
+ More detailed descriptions of the Google simple REST clients are available in two documents.
62
+
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
+
66
+ (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Homegraph service in particular.)
67
+
68
+ For reference information on specific calls in the HomeGraph API, see the {Google::Apis::HomegraphV1::HomeGraphServiceService class reference docs}.
69
+
70
+ ## Which client should I use?
71
+
72
+ Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
73
+
74
+ This library, `google-apis-homegraph_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
75
+
76
+ Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
77
+
78
+ Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
79
+
80
+ **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
81
+
82
+ The [product documentation](https://developers.google.com/actions/smarthome/create-app#request-sync) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 2.5+.
87
+
88
+ Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
89
+
90
+ ## License
91
+
92
+ This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
93
+
94
+ ## Support
95
+
96
+ Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
@@ -0,0 +1,15 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require "google/apis/homegraph_v1"
@@ -0,0 +1,36 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/homegraph_v1/service.rb'
16
+ require 'google/apis/homegraph_v1/classes.rb'
17
+ require 'google/apis/homegraph_v1/representations.rb'
18
+ require 'google/apis/homegraph_v1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # HomeGraph API
23
+ #
24
+ #
25
+ #
26
+ # @see https://developers.google.com/actions/smarthome/create-app#request-sync
27
+ module HomegraphV1
28
+ # Version of the HomeGraph API this client connects to.
29
+ # This is NOT the gem version.
30
+ VERSION = 'V1'
31
+
32
+ # New Service: https://www.googleapis.com/auth/homegraph
33
+ AUTH_HOMEGRAPH = 'https://www.googleapis.com/auth/homegraph'
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,627 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module HomegraphV1
24
+
25
+ # Third-party device ID for one device.
26
+ class AgentDeviceId
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # Third-party device ID.
30
+ # Corresponds to the JSON property `id`
31
+ # @return [String]
32
+ attr_accessor :id
33
+
34
+ def initialize(**args)
35
+ update!(**args)
36
+ end
37
+
38
+ # Update properties of this object
39
+ def update!(**args)
40
+ @id = args[:id] if args.key?(:id)
41
+ end
42
+ end
43
+
44
+ # Alternate third-party device ID.
45
+ class AgentOtherDeviceId
46
+ include Google::Apis::Core::Hashable
47
+
48
+ # Project ID for your smart home Action.
49
+ # Corresponds to the JSON property `agentId`
50
+ # @return [String]
51
+ attr_accessor :agent_id
52
+
53
+ # Unique third-party device ID.
54
+ # Corresponds to the JSON property `deviceId`
55
+ # @return [String]
56
+ attr_accessor :device_id
57
+
58
+ def initialize(**args)
59
+ update!(**args)
60
+ end
61
+
62
+ # Update properties of this object
63
+ def update!(**args)
64
+ @agent_id = args[:agent_id] if args.key?(:agent_id)
65
+ @device_id = args[:device_id] if args.key?(:device_id)
66
+ end
67
+ end
68
+
69
+ # Third-party device definition.
70
+ class Device
71
+ include Google::Apis::Core::Hashable
72
+
73
+ # Attributes for the traits supported by the device.
74
+ # Corresponds to the JSON property `attributes`
75
+ # @return [Hash<String,Object>]
76
+ attr_accessor :attributes
77
+
78
+ # Custom device attributes stored in Home Graph and provided to your smart home
79
+ # Action in each [QUERY](https://developers.google.com/assistant/smarthome/
80
+ # reference/intent/query) and [EXECUTE](https://developers.google.com/assistant/
81
+ # smarthome/reference/intent/execute) intent.
82
+ # Corresponds to the JSON property `customData`
83
+ # @return [Hash<String,Object>]
84
+ attr_accessor :custom_data
85
+
86
+ # Device information.
87
+ # Corresponds to the JSON property `deviceInfo`
88
+ # @return [Google::Apis::HomegraphV1::DeviceInfo]
89
+ attr_accessor :device_info
90
+
91
+ # Third-party device ID.
92
+ # Corresponds to the JSON property `id`
93
+ # @return [String]
94
+ attr_accessor :id
95
+
96
+ # Identifiers used to describe the device.
97
+ # Corresponds to the JSON property `name`
98
+ # @return [Google::Apis::HomegraphV1::DeviceNames]
99
+ attr_accessor :name
100
+
101
+ # Indicates whether your smart home Action will report notifications to Google
102
+ # for this device via ReportStateAndNotification. If your smart home Action
103
+ # enables users to control device notifications, you should update this field
104
+ # and call RequestSyncDevices.
105
+ # Corresponds to the JSON property `notificationSupportedByAgent`
106
+ # @return [Boolean]
107
+ attr_accessor :notification_supported_by_agent
108
+ alias_method :notification_supported_by_agent?, :notification_supported_by_agent
109
+
110
+ # Alternate IDs associated with this device. This is used to identify cloud
111
+ # synced devices enabled for [local fulfillment](https://developers.google.com/
112
+ # assistant/smarthome/concepts/local).
113
+ # Corresponds to the JSON property `otherDeviceIds`
114
+ # @return [Array<Google::Apis::HomegraphV1::AgentOtherDeviceId>]
115
+ attr_accessor :other_device_ids
116
+
117
+ # Suggested name for the room where this device is installed. Google attempts to
118
+ # use this value during user setup.
119
+ # Corresponds to the JSON property `roomHint`
120
+ # @return [String]
121
+ attr_accessor :room_hint
122
+
123
+ # Suggested name for the structure where this device is installed. Google
124
+ # attempts to use this value during user setup.
125
+ # Corresponds to the JSON property `structureHint`
126
+ # @return [String]
127
+ attr_accessor :structure_hint
128
+
129
+ # Traits supported by the device. See [device traits](https://developers.google.
130
+ # com/assistant/smarthome/traits).
131
+ # Corresponds to the JSON property `traits`
132
+ # @return [Array<String>]
133
+ attr_accessor :traits
134
+
135
+ # Hardware type of the device. See [device types](https://developers.google.com/
136
+ # assistant/smarthome/guides).
137
+ # Corresponds to the JSON property `type`
138
+ # @return [String]
139
+ attr_accessor :type
140
+
141
+ # Indicates whether your smart home Action will report state of this device to
142
+ # Google via ReportStateAndNotification.
143
+ # Corresponds to the JSON property `willReportState`
144
+ # @return [Boolean]
145
+ attr_accessor :will_report_state
146
+ alias_method :will_report_state?, :will_report_state
147
+
148
+ def initialize(**args)
149
+ update!(**args)
150
+ end
151
+
152
+ # Update properties of this object
153
+ def update!(**args)
154
+ @attributes = args[:attributes] if args.key?(:attributes)
155
+ @custom_data = args[:custom_data] if args.key?(:custom_data)
156
+ @device_info = args[:device_info] if args.key?(:device_info)
157
+ @id = args[:id] if args.key?(:id)
158
+ @name = args[:name] if args.key?(:name)
159
+ @notification_supported_by_agent = args[:notification_supported_by_agent] if args.key?(:notification_supported_by_agent)
160
+ @other_device_ids = args[:other_device_ids] if args.key?(:other_device_ids)
161
+ @room_hint = args[:room_hint] if args.key?(:room_hint)
162
+ @structure_hint = args[:structure_hint] if args.key?(:structure_hint)
163
+ @traits = args[:traits] if args.key?(:traits)
164
+ @type = args[:type] if args.key?(:type)
165
+ @will_report_state = args[:will_report_state] if args.key?(:will_report_state)
166
+ end
167
+ end
168
+
169
+ # Device information.
170
+ class DeviceInfo
171
+ include Google::Apis::Core::Hashable
172
+
173
+ # Device hardware version.
174
+ # Corresponds to the JSON property `hwVersion`
175
+ # @return [String]
176
+ attr_accessor :hw_version
177
+
178
+ # Device manufacturer.
179
+ # Corresponds to the JSON property `manufacturer`
180
+ # @return [String]
181
+ attr_accessor :manufacturer
182
+
183
+ # Device model.
184
+ # Corresponds to the JSON property `model`
185
+ # @return [String]
186
+ attr_accessor :model
187
+
188
+ # Device software version.
189
+ # Corresponds to the JSON property `swVersion`
190
+ # @return [String]
191
+ attr_accessor :sw_version
192
+
193
+ def initialize(**args)
194
+ update!(**args)
195
+ end
196
+
197
+ # Update properties of this object
198
+ def update!(**args)
199
+ @hw_version = args[:hw_version] if args.key?(:hw_version)
200
+ @manufacturer = args[:manufacturer] if args.key?(:manufacturer)
201
+ @model = args[:model] if args.key?(:model)
202
+ @sw_version = args[:sw_version] if args.key?(:sw_version)
203
+ end
204
+ end
205
+
206
+ # Identifiers used to describe the device.
207
+ class DeviceNames
208
+ include Google::Apis::Core::Hashable
209
+
210
+ # List of names provided by the manufacturer rather than the user, such as
211
+ # serial numbers, SKUs, etc.
212
+ # Corresponds to the JSON property `defaultNames`
213
+ # @return [Array<String>]
214
+ attr_accessor :default_names
215
+
216
+ # Primary name of the device, generally provided by the user.
217
+ # Corresponds to the JSON property `name`
218
+ # @return [String]
219
+ attr_accessor :name
220
+
221
+ # Additional names provided by the user for the device.
222
+ # Corresponds to the JSON property `nicknames`
223
+ # @return [Array<String>]
224
+ attr_accessor :nicknames
225
+
226
+ def initialize(**args)
227
+ update!(**args)
228
+ end
229
+
230
+ # Update properties of this object
231
+ def update!(**args)
232
+ @default_names = args[:default_names] if args.key?(:default_names)
233
+ @name = args[:name] if args.key?(:name)
234
+ @nicknames = args[:nicknames] if args.key?(:nicknames)
235
+ end
236
+ end
237
+
238
+ # A generic empty message that you can re-use to avoid defining duplicated empty
239
+ # messages in your APIs. A typical example is to use it as the request or the
240
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
241
+ # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
242
+ # `Empty` is empty JSON object ````.
243
+ class Empty
244
+ include Google::Apis::Core::Hashable
245
+
246
+ def initialize(**args)
247
+ update!(**args)
248
+ end
249
+
250
+ # Update properties of this object
251
+ def update!(**args)
252
+ end
253
+ end
254
+
255
+ # Request type for the [`Query`](#google.home.graph.v1.HomeGraphApiService.Query)
256
+ # call.
257
+ class QueryRequest
258
+ include Google::Apis::Core::Hashable
259
+
260
+ # Required. Third-party user ID.
261
+ # Corresponds to the JSON property `agentUserId`
262
+ # @return [String]
263
+ attr_accessor :agent_user_id
264
+
265
+ # Required. Inputs containing third-party device IDs for which to get the device
266
+ # states.
267
+ # Corresponds to the JSON property `inputs`
268
+ # @return [Array<Google::Apis::HomegraphV1::QueryRequestInput>]
269
+ attr_accessor :inputs
270
+
271
+ # Request ID used for debugging.
272
+ # Corresponds to the JSON property `requestId`
273
+ # @return [String]
274
+ attr_accessor :request_id
275
+
276
+ def initialize(**args)
277
+ update!(**args)
278
+ end
279
+
280
+ # Update properties of this object
281
+ def update!(**args)
282
+ @agent_user_id = args[:agent_user_id] if args.key?(:agent_user_id)
283
+ @inputs = args[:inputs] if args.key?(:inputs)
284
+ @request_id = args[:request_id] if args.key?(:request_id)
285
+ end
286
+ end
287
+
288
+ # Device ID inputs to QueryRequest.
289
+ class QueryRequestInput
290
+ include Google::Apis::Core::Hashable
291
+
292
+ # Payload containing device IDs.
293
+ # Corresponds to the JSON property `payload`
294
+ # @return [Google::Apis::HomegraphV1::QueryRequestPayload]
295
+ attr_accessor :payload
296
+
297
+ def initialize(**args)
298
+ update!(**args)
299
+ end
300
+
301
+ # Update properties of this object
302
+ def update!(**args)
303
+ @payload = args[:payload] if args.key?(:payload)
304
+ end
305
+ end
306
+
307
+ # Payload containing device IDs.
308
+ class QueryRequestPayload
309
+ include Google::Apis::Core::Hashable
310
+
311
+ # Third-party device IDs for which to get the device states.
312
+ # Corresponds to the JSON property `devices`
313
+ # @return [Array<Google::Apis::HomegraphV1::AgentDeviceId>]
314
+ attr_accessor :devices
315
+
316
+ def initialize(**args)
317
+ update!(**args)
318
+ end
319
+
320
+ # Update properties of this object
321
+ def update!(**args)
322
+ @devices = args[:devices] if args.key?(:devices)
323
+ end
324
+ end
325
+
326
+ # Response type for the [`Query`](#google.home.graph.v1.HomeGraphApiService.
327
+ # Query) call. This should follow the same format as the Google smart home `
328
+ # action.devices.QUERY` [response](https://developers.google.com/assistant/
329
+ # smarthome/reference/intent/query). # Example ```json ` "requestId": "ff36a3cc-
330
+ # ec34-11e6-b1a0-64510650abcf", "payload": ` "devices": ` "123": ` "on": true, "
331
+ # online": true `, "456": ` "on": true, "online": true, "brightness": 80, "color"
332
+ # : ` "name": "cerulean", "spectrumRGB": 31655 ` ` ` ` ` ```
333
+ class QueryResponse
334
+ include Google::Apis::Core::Hashable
335
+
336
+ # Payload containing device states information.
337
+ # Corresponds to the JSON property `payload`
338
+ # @return [Google::Apis::HomegraphV1::QueryResponsePayload]
339
+ attr_accessor :payload
340
+
341
+ # Request ID used for debugging. Copied from the request.
342
+ # Corresponds to the JSON property `requestId`
343
+ # @return [String]
344
+ attr_accessor :request_id
345
+
346
+ def initialize(**args)
347
+ update!(**args)
348
+ end
349
+
350
+ # Update properties of this object
351
+ def update!(**args)
352
+ @payload = args[:payload] if args.key?(:payload)
353
+ @request_id = args[:request_id] if args.key?(:request_id)
354
+ end
355
+ end
356
+
357
+ # Payload containing device states information.
358
+ class QueryResponsePayload
359
+ include Google::Apis::Core::Hashable
360
+
361
+ # States of the devices. Map of third-party device ID to struct of device states.
362
+ # Corresponds to the JSON property `devices`
363
+ # @return [Hash<String,Hash<String,Object>>]
364
+ attr_accessor :devices
365
+
366
+ def initialize(**args)
367
+ update!(**args)
368
+ end
369
+
370
+ # Update properties of this object
371
+ def update!(**args)
372
+ @devices = args[:devices] if args.key?(:devices)
373
+ end
374
+ end
375
+
376
+ # The states and notifications specific to a device.
377
+ class ReportStateAndNotificationDevice
378
+ include Google::Apis::Core::Hashable
379
+
380
+ # Notifications metadata for devices. See the **Device NOTIFICATIONS** section
381
+ # of the individual trait [reference guides](https://developers.google.com/
382
+ # assistant/smarthome/traits).
383
+ # Corresponds to the JSON property `notifications`
384
+ # @return [Hash<String,Object>]
385
+ attr_accessor :notifications
386
+
387
+ # States of devices to update. See the **Device STATES** section of the
388
+ # individual trait [reference guides](https://developers.google.com/assistant/
389
+ # smarthome/traits).
390
+ # Corresponds to the JSON property `states`
391
+ # @return [Hash<String,Object>]
392
+ attr_accessor :states
393
+
394
+ def initialize(**args)
395
+ update!(**args)
396
+ end
397
+
398
+ # Update properties of this object
399
+ def update!(**args)
400
+ @notifications = args[:notifications] if args.key?(:notifications)
401
+ @states = args[:states] if args.key?(:states)
402
+ end
403
+ end
404
+
405
+ # Request type for the [`ReportStateAndNotification`](#google.home.graph.v1.
406
+ # HomeGraphApiService.ReportStateAndNotification) call. It may include states,
407
+ # notifications, or both. States and notifications are defined per `device_id` (
408
+ # for example, "123" and "456" in the following example). # Example ```json ` "
409
+ # requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "agentUserId": "1234", "
410
+ # payload": ` "devices": ` "states": ` "123": ` "on": true `, "456": ` "on":
411
+ # true, "brightness": 10 ` `, ` ` ` ```
412
+ class ReportStateAndNotificationRequest
413
+ include Google::Apis::Core::Hashable
414
+
415
+ # Required. Third-party user ID.
416
+ # Corresponds to the JSON property `agentUserId`
417
+ # @return [String]
418
+ attr_accessor :agent_user_id
419
+
420
+ # Unique identifier per event (for example, a doorbell press).
421
+ # Corresponds to the JSON property `eventId`
422
+ # @return [String]
423
+ attr_accessor :event_id
424
+
425
+ # Token to maintain state in the follow up notification response. Deprecated.
426
+ # See the [notifications guide](https://developers.google.com/assistant/
427
+ # smarthome/develop/notifications) for details on implementing follow up
428
+ # notifications.
429
+ # Corresponds to the JSON property `followUpToken`
430
+ # @return [String]
431
+ attr_accessor :follow_up_token
432
+
433
+ # Payload containing the state and notification information for devices.
434
+ # Corresponds to the JSON property `payload`
435
+ # @return [Google::Apis::HomegraphV1::StateAndNotificationPayload]
436
+ attr_accessor :payload
437
+
438
+ # Request ID used for debugging.
439
+ # Corresponds to the JSON property `requestId`
440
+ # @return [String]
441
+ attr_accessor :request_id
442
+
443
+ def initialize(**args)
444
+ update!(**args)
445
+ end
446
+
447
+ # Update properties of this object
448
+ def update!(**args)
449
+ @agent_user_id = args[:agent_user_id] if args.key?(:agent_user_id)
450
+ @event_id = args[:event_id] if args.key?(:event_id)
451
+ @follow_up_token = args[:follow_up_token] if args.key?(:follow_up_token)
452
+ @payload = args[:payload] if args.key?(:payload)
453
+ @request_id = args[:request_id] if args.key?(:request_id)
454
+ end
455
+ end
456
+
457
+ # Response type for the [`ReportStateAndNotification`](#google.home.graph.v1.
458
+ # HomeGraphApiService.ReportStateAndNotification) call.
459
+ class ReportStateAndNotificationResponse
460
+ include Google::Apis::Core::Hashable
461
+
462
+ # Request ID copied from ReportStateAndNotificationRequest.
463
+ # Corresponds to the JSON property `requestId`
464
+ # @return [String]
465
+ attr_accessor :request_id
466
+
467
+ def initialize(**args)
468
+ update!(**args)
469
+ end
470
+
471
+ # Update properties of this object
472
+ def update!(**args)
473
+ @request_id = args[:request_id] if args.key?(:request_id)
474
+ end
475
+ end
476
+
477
+ # Request type for the [`RequestSyncDevices`](#google.home.graph.v1.
478
+ # HomeGraphApiService.RequestSyncDevices) call.
479
+ class RequestSyncDevicesRequest
480
+ include Google::Apis::Core::Hashable
481
+
482
+ # Required. Third-party user ID.
483
+ # Corresponds to the JSON property `agentUserId`
484
+ # @return [String]
485
+ attr_accessor :agent_user_id
486
+
487
+ # Optional. If set, the request will be added to a queue and a response will be
488
+ # returned immediately. This enables concurrent requests for the given `
489
+ # agent_user_id`, but the caller will not receive any error responses.
490
+ # Corresponds to the JSON property `async`
491
+ # @return [Boolean]
492
+ attr_accessor :async
493
+ alias_method :async?, :async
494
+
495
+ def initialize(**args)
496
+ update!(**args)
497
+ end
498
+
499
+ # Update properties of this object
500
+ def update!(**args)
501
+ @agent_user_id = args[:agent_user_id] if args.key?(:agent_user_id)
502
+ @async = args[:async] if args.key?(:async)
503
+ end
504
+ end
505
+
506
+ # Response type for the [`RequestSyncDevices`](#google.home.graph.v1.
507
+ # HomeGraphApiService.RequestSyncDevices) call. Intentionally empty upon success.
508
+ # An HTTP response code is returned with more details upon failure.
509
+ class RequestSyncDevicesResponse
510
+ include Google::Apis::Core::Hashable
511
+
512
+ def initialize(**args)
513
+ update!(**args)
514
+ end
515
+
516
+ # Update properties of this object
517
+ def update!(**args)
518
+ end
519
+ end
520
+
521
+ # Payload containing the state and notification information for devices.
522
+ class StateAndNotificationPayload
523
+ include Google::Apis::Core::Hashable
524
+
525
+ # The states and notifications specific to a device.
526
+ # Corresponds to the JSON property `devices`
527
+ # @return [Google::Apis::HomegraphV1::ReportStateAndNotificationDevice]
528
+ attr_accessor :devices
529
+
530
+ def initialize(**args)
531
+ update!(**args)
532
+ end
533
+
534
+ # Update properties of this object
535
+ def update!(**args)
536
+ @devices = args[:devices] if args.key?(:devices)
537
+ end
538
+ end
539
+
540
+ # Request type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync)
541
+ # call.
542
+ class SyncRequest
543
+ include Google::Apis::Core::Hashable
544
+
545
+ # Required. Third-party user ID.
546
+ # Corresponds to the JSON property `agentUserId`
547
+ # @return [String]
548
+ attr_accessor :agent_user_id
549
+
550
+ # Request ID used for debugging.
551
+ # Corresponds to the JSON property `requestId`
552
+ # @return [String]
553
+ attr_accessor :request_id
554
+
555
+ def initialize(**args)
556
+ update!(**args)
557
+ end
558
+
559
+ # Update properties of this object
560
+ def update!(**args)
561
+ @agent_user_id = args[:agent_user_id] if args.key?(:agent_user_id)
562
+ @request_id = args[:request_id] if args.key?(:request_id)
563
+ end
564
+ end
565
+
566
+ # Response type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync)
567
+ # call. This should follow the same format as the Google smart home `action.
568
+ # devices.SYNC` [response](https://developers.google.com/assistant/smarthome/
569
+ # reference/intent/sync). # Example ```json ` "requestId": "ff36a3cc-ec34-11e6-
570
+ # b1a0-64510650abcf", "payload": ` "agentUserId": "1836.15267389", "devices": [`
571
+ # "id": "123", "type": "action.devices.types.OUTLET", "traits": [ "action.
572
+ # devices.traits.OnOff" ], "name": ` "defaultNames": ["My Outlet 1234"], "name":
573
+ # "Night light", "nicknames": ["wall plug"] `, "willReportState": false, "
574
+ # deviceInfo": ` "manufacturer": "lights-out-inc", "model": "hs1234", "hwVersion"
575
+ # : "3.2", "swVersion": "11.4" `, "customData": ` "fooValue": 74, "barValue":
576
+ # true, "bazValue": "foo" ` `] ` ` ```
577
+ class SyncResponse
578
+ include Google::Apis::Core::Hashable
579
+
580
+ # Payload containing device information.
581
+ # Corresponds to the JSON property `payload`
582
+ # @return [Google::Apis::HomegraphV1::SyncResponsePayload]
583
+ attr_accessor :payload
584
+
585
+ # Request ID used for debugging. Copied from the request.
586
+ # Corresponds to the JSON property `requestId`
587
+ # @return [String]
588
+ attr_accessor :request_id
589
+
590
+ def initialize(**args)
591
+ update!(**args)
592
+ end
593
+
594
+ # Update properties of this object
595
+ def update!(**args)
596
+ @payload = args[:payload] if args.key?(:payload)
597
+ @request_id = args[:request_id] if args.key?(:request_id)
598
+ end
599
+ end
600
+
601
+ # Payload containing device information.
602
+ class SyncResponsePayload
603
+ include Google::Apis::Core::Hashable
604
+
605
+ # Third-party user ID
606
+ # Corresponds to the JSON property `agentUserId`
607
+ # @return [String]
608
+ attr_accessor :agent_user_id
609
+
610
+ # Devices associated with the third-party user.
611
+ # Corresponds to the JSON property `devices`
612
+ # @return [Array<Google::Apis::HomegraphV1::Device>]
613
+ attr_accessor :devices
614
+
615
+ def initialize(**args)
616
+ update!(**args)
617
+ end
618
+
619
+ # Update properties of this object
620
+ def update!(**args)
621
+ @agent_user_id = args[:agent_user_id] if args.key?(:agent_user_id)
622
+ @devices = args[:devices] if args.key?(:devices)
623
+ end
624
+ end
625
+ end
626
+ end
627
+ end