google-apis-smartdevicemanagement_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: 4fc246c11bce188d4106d311a16e5c3db7ab3dad09d90c3f79620acea2412c78
4
+ data.tar.gz: b3700df1ac73fc3211979aa61900e535a157c77e59ace18c1c608bc58b195572
5
+ SHA512:
6
+ metadata.gz: 0af58afc11a2faf12a436fd8a307a36c1b71910bcb0c386e49c2285f7db75213eb00354db4a827202be8b87dd206fc360f53ea8dcaf4d396711a941ba30e5a71
7
+ data.tar.gz: eddc61b6eccca60341a31fcc33019100144d372731e416fd32f2a31bc0e2c51d9d6bed9a358cc9a6c65e9650db2068793c4d39767f58451738073b6866a6bd54
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-smartdevicemanagement_v1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/smartdevicemanagement_v1/*.rb
9
+ lib/google/apis/smartdevicemanagement_v1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-smartdevicemanagement_v1
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated using generator version 0.1.1
6
+ * Regenerated from discovery document revision 20201022
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 Smart Device Management API
2
+
3
+ This is a simple client library for version V1 of the Smart Device Management 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/smartdevicemanagement.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-smartdevicemanagement_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-smartdevicemanagement_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/smartdevicemanagement_v1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::SmartdevicemanagementV1::SmartDeviceManagementService.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 Smartdevicemanagement service in particular.)
67
+
68
+ For reference information on specific calls in the Smart Device Management API, see the {Google::Apis::SmartdevicemanagementV1::SmartDeviceManagementService 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-smartdevicemanagement_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/nest/device-access) 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/smartdevicemanagement_v1"
@@ -0,0 +1,37 @@
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/smartdevicemanagement_v1/service.rb'
16
+ require 'google/apis/smartdevicemanagement_v1/classes.rb'
17
+ require 'google/apis/smartdevicemanagement_v1/representations.rb'
18
+ require 'google/apis/smartdevicemanagement_v1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Smart Device Management API
23
+ #
24
+ # Allow select enterprise partners to access, control, and manage Google and
25
+ # Nest devices programmatically.
26
+ #
27
+ # @see https://developers.google.com/nest/device-access
28
+ module SmartdevicemanagementV1
29
+ # Version of the Smart Device Management API this client connects to.
30
+ # This is NOT the gem version.
31
+ VERSION = 'V1'
32
+
33
+ # See and/or control the devices that you selected
34
+ AUTH_SDM_SERVICE = 'https://www.googleapis.com/auth/sdm.service'
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,273 @@
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 SmartdevicemanagementV1
24
+
25
+ # Device resource represents an instance of enterprise managed device in the
26
+ # property.
27
+ class GoogleHomeEnterpriseSdmV1Device
28
+ include Google::Apis::Core::Hashable
29
+
30
+ # Required. The resource name of the device. For example: "enterprises/XYZ/
31
+ # devices/123".
32
+ # Corresponds to the JSON property `name`
33
+ # @return [String]
34
+ attr_accessor :name
35
+
36
+ # Assignee details of the device.
37
+ # Corresponds to the JSON property `parentRelations`
38
+ # @return [Array<Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ParentRelation>]
39
+ attr_accessor :parent_relations
40
+
41
+ # Output only. Device traits.
42
+ # Corresponds to the JSON property `traits`
43
+ # @return [Hash<String,Object>]
44
+ attr_accessor :traits
45
+
46
+ # Output only. Type of the device for general display purposes. For example: "
47
+ # THERMOSTAT". The device type should not be used to deduce or infer
48
+ # functionality of the actual device it is assigned to. Instead, use the
49
+ # returned traits for the device.
50
+ # Corresponds to the JSON property `type`
51
+ # @return [String]
52
+ attr_accessor :type
53
+
54
+ def initialize(**args)
55
+ update!(**args)
56
+ end
57
+
58
+ # Update properties of this object
59
+ def update!(**args)
60
+ @name = args[:name] if args.key?(:name)
61
+ @parent_relations = args[:parent_relations] if args.key?(:parent_relations)
62
+ @traits = args[:traits] if args.key?(:traits)
63
+ @type = args[:type] if args.key?(:type)
64
+ end
65
+ end
66
+
67
+ # Request message for SmartDeviceManagementService.ExecuteDeviceCommand
68
+ class GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest
69
+ include Google::Apis::Core::Hashable
70
+
71
+ # The command name to execute, represented by the fully qualified protobuf
72
+ # message name.
73
+ # Corresponds to the JSON property `command`
74
+ # @return [String]
75
+ attr_accessor :command
76
+
77
+ # The command message to execute, represented as a Struct.
78
+ # Corresponds to the JSON property `params`
79
+ # @return [Hash<String,Object>]
80
+ attr_accessor :params
81
+
82
+ def initialize(**args)
83
+ update!(**args)
84
+ end
85
+
86
+ # Update properties of this object
87
+ def update!(**args)
88
+ @command = args[:command] if args.key?(:command)
89
+ @params = args[:params] if args.key?(:params)
90
+ end
91
+ end
92
+
93
+ # Response message for SmartDeviceManagementService.ExecuteDeviceCommand
94
+ class GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse
95
+ include Google::Apis::Core::Hashable
96
+
97
+ # The results of executing the command.
98
+ # Corresponds to the JSON property `results`
99
+ # @return [Hash<String,Object>]
100
+ attr_accessor :results
101
+
102
+ def initialize(**args)
103
+ update!(**args)
104
+ end
105
+
106
+ # Update properties of this object
107
+ def update!(**args)
108
+ @results = args[:results] if args.key?(:results)
109
+ end
110
+ end
111
+
112
+ # Response message for SmartDeviceManagementService.ListDevices
113
+ class GoogleHomeEnterpriseSdmV1ListDevicesResponse
114
+ include Google::Apis::Core::Hashable
115
+
116
+ # The list of devices.
117
+ # Corresponds to the JSON property `devices`
118
+ # @return [Array<Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Device>]
119
+ attr_accessor :devices
120
+
121
+ # The pagination token to retrieve the next page of results.
122
+ # Corresponds to the JSON property `nextPageToken`
123
+ # @return [String]
124
+ attr_accessor :next_page_token
125
+
126
+ def initialize(**args)
127
+ update!(**args)
128
+ end
129
+
130
+ # Update properties of this object
131
+ def update!(**args)
132
+ @devices = args[:devices] if args.key?(:devices)
133
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
134
+ end
135
+ end
136
+
137
+ # Response message for SmartDeviceManagementService.ListRooms
138
+ class GoogleHomeEnterpriseSdmV1ListRoomsResponse
139
+ include Google::Apis::Core::Hashable
140
+
141
+ # The pagination token to retrieve the next page of results. If this field is
142
+ # omitted, there are no subsequent pages.
143
+ # Corresponds to the JSON property `nextPageToken`
144
+ # @return [String]
145
+ attr_accessor :next_page_token
146
+
147
+ # The list of rooms.
148
+ # Corresponds to the JSON property `rooms`
149
+ # @return [Array<Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Room>]
150
+ attr_accessor :rooms
151
+
152
+ def initialize(**args)
153
+ update!(**args)
154
+ end
155
+
156
+ # Update properties of this object
157
+ def update!(**args)
158
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
159
+ @rooms = args[:rooms] if args.key?(:rooms)
160
+ end
161
+ end
162
+
163
+ # Response message for SmartDeviceManagementService.ListStructures
164
+ class GoogleHomeEnterpriseSdmV1ListStructuresResponse
165
+ include Google::Apis::Core::Hashable
166
+
167
+ # The pagination token to retrieve the next page of results. If this field is
168
+ # omitted, there are no subsequent pages.
169
+ # Corresponds to the JSON property `nextPageToken`
170
+ # @return [String]
171
+ attr_accessor :next_page_token
172
+
173
+ # The list of structures.
174
+ # Corresponds to the JSON property `structures`
175
+ # @return [Array<Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Structure>]
176
+ attr_accessor :structures
177
+
178
+ def initialize(**args)
179
+ update!(**args)
180
+ end
181
+
182
+ # Update properties of this object
183
+ def update!(**args)
184
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
185
+ @structures = args[:structures] if args.key?(:structures)
186
+ end
187
+ end
188
+
189
+ # Represents device relationships, for instance, structure/room to which the
190
+ # device is assigned to. For now this is only filled in the enterprise flow.
191
+ class GoogleHomeEnterpriseSdmV1ParentRelation
192
+ include Google::Apis::Core::Hashable
193
+
194
+ # Output only. The custom name of the relation -- e.g., structure/room where the
195
+ # device is assigned to.
196
+ # Corresponds to the JSON property `displayName`
197
+ # @return [String]
198
+ attr_accessor :display_name
199
+
200
+ # Output only. The name of the relation -- e.g., structure/room where the device
201
+ # is assigned to. For example: "enterprises/XYZ/structures/ABC" or "enterprises/
202
+ # XYZ/structures/ABC/rooms/123"
203
+ # Corresponds to the JSON property `parent`
204
+ # @return [String]
205
+ attr_accessor :parent
206
+
207
+ def initialize(**args)
208
+ update!(**args)
209
+ end
210
+
211
+ # Update properties of this object
212
+ def update!(**args)
213
+ @display_name = args[:display_name] if args.key?(:display_name)
214
+ @parent = args[:parent] if args.key?(:parent)
215
+ end
216
+ end
217
+
218
+ # Room resource represents an instance of sub-space within a structure such as
219
+ # rooms in a hotel suite or rental apartment.
220
+ class GoogleHomeEnterpriseSdmV1Room
221
+ include Google::Apis::Core::Hashable
222
+
223
+ # Output only. The resource name of the room. For example: "enterprises/XYZ/
224
+ # structures/ABC/rooms/123".
225
+ # Corresponds to the JSON property `name`
226
+ # @return [String]
227
+ attr_accessor :name
228
+
229
+ # Room traits.
230
+ # Corresponds to the JSON property `traits`
231
+ # @return [Hash<String,Object>]
232
+ attr_accessor :traits
233
+
234
+ def initialize(**args)
235
+ update!(**args)
236
+ end
237
+
238
+ # Update properties of this object
239
+ def update!(**args)
240
+ @name = args[:name] if args.key?(:name)
241
+ @traits = args[:traits] if args.key?(:traits)
242
+ end
243
+ end
244
+
245
+ # Structure resource represents an instance of enterprise managed home or hotel
246
+ # room.
247
+ class GoogleHomeEnterpriseSdmV1Structure
248
+ include Google::Apis::Core::Hashable
249
+
250
+ # Output only. The resource name of the structure. For example: "enterprises/XYZ/
251
+ # structures/ABC".
252
+ # Corresponds to the JSON property `name`
253
+ # @return [String]
254
+ attr_accessor :name
255
+
256
+ # Structure traits.
257
+ # Corresponds to the JSON property `traits`
258
+ # @return [Hash<String,Object>]
259
+ attr_accessor :traits
260
+
261
+ def initialize(**args)
262
+ update!(**args)
263
+ end
264
+
265
+ # Update properties of this object
266
+ def update!(**args)
267
+ @name = args[:name] if args.key?(:name)
268
+ @traits = args[:traits] if args.key?(:traits)
269
+ end
270
+ end
271
+ end
272
+ end
273
+ end
@@ -0,0 +1,28 @@
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
+ module Google
16
+ module Apis
17
+ module SmartdevicemanagementV1
18
+ # Version of the google-apis-smartdevicemanagement_v1 gem
19
+ GEM_VERSION = "0.1.0"
20
+
21
+ # Version of the code generator used to generate this client
22
+ GENERATOR_VERSION = "0.1.1"
23
+
24
+ # Revision of the discovery document this client was generated from
25
+ REVISION = "20201022"
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,157 @@
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 SmartdevicemanagementV1
24
+
25
+ class GoogleHomeEnterpriseSdmV1Device
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+
40
+ include Google::Apis::Core::JsonObjectSupport
41
+ end
42
+
43
+ class GoogleHomeEnterpriseSdmV1ListDevicesResponse
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class GoogleHomeEnterpriseSdmV1ListRoomsResponse
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
55
+ class GoogleHomeEnterpriseSdmV1ListStructuresResponse
56
+ class Representation < Google::Apis::Core::JsonRepresentation; end
57
+
58
+ include Google::Apis::Core::JsonObjectSupport
59
+ end
60
+
61
+ class GoogleHomeEnterpriseSdmV1ParentRelation
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
67
+ class GoogleHomeEnterpriseSdmV1Room
68
+ class Representation < Google::Apis::Core::JsonRepresentation; end
69
+
70
+ include Google::Apis::Core::JsonObjectSupport
71
+ end
72
+
73
+ class GoogleHomeEnterpriseSdmV1Structure
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+
76
+ include Google::Apis::Core::JsonObjectSupport
77
+ end
78
+
79
+ class GoogleHomeEnterpriseSdmV1Device
80
+ # @private
81
+ class Representation < Google::Apis::Core::JsonRepresentation
82
+ property :name, as: 'name'
83
+ collection :parent_relations, as: 'parentRelations', class: Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ParentRelation, decorator: Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ParentRelation::Representation
84
+
85
+ hash :traits, as: 'traits'
86
+ property :type, as: 'type'
87
+ end
88
+ end
89
+
90
+ class GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest
91
+ # @private
92
+ class Representation < Google::Apis::Core::JsonRepresentation
93
+ property :command, as: 'command'
94
+ hash :params, as: 'params'
95
+ end
96
+ end
97
+
98
+ class GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse
99
+ # @private
100
+ class Representation < Google::Apis::Core::JsonRepresentation
101
+ hash :results, as: 'results'
102
+ end
103
+ end
104
+
105
+ class GoogleHomeEnterpriseSdmV1ListDevicesResponse
106
+ # @private
107
+ class Representation < Google::Apis::Core::JsonRepresentation
108
+ collection :devices, as: 'devices', class: Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Device, decorator: Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Device::Representation
109
+
110
+ property :next_page_token, as: 'nextPageToken'
111
+ end
112
+ end
113
+
114
+ class GoogleHomeEnterpriseSdmV1ListRoomsResponse
115
+ # @private
116
+ class Representation < Google::Apis::Core::JsonRepresentation
117
+ property :next_page_token, as: 'nextPageToken'
118
+ collection :rooms, as: 'rooms', class: Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Room, decorator: Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Room::Representation
119
+
120
+ end
121
+ end
122
+
123
+ class GoogleHomeEnterpriseSdmV1ListStructuresResponse
124
+ # @private
125
+ class Representation < Google::Apis::Core::JsonRepresentation
126
+ property :next_page_token, as: 'nextPageToken'
127
+ collection :structures, as: 'structures', class: Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Structure, decorator: Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Structure::Representation
128
+
129
+ end
130
+ end
131
+
132
+ class GoogleHomeEnterpriseSdmV1ParentRelation
133
+ # @private
134
+ class Representation < Google::Apis::Core::JsonRepresentation
135
+ property :display_name, as: 'displayName'
136
+ property :parent, as: 'parent'
137
+ end
138
+ end
139
+
140
+ class GoogleHomeEnterpriseSdmV1Room
141
+ # @private
142
+ class Representation < Google::Apis::Core::JsonRepresentation
143
+ property :name, as: 'name'
144
+ hash :traits, as: 'traits'
145
+ end
146
+ end
147
+
148
+ class GoogleHomeEnterpriseSdmV1Structure
149
+ # @private
150
+ class Representation < Google::Apis::Core::JsonRepresentation
151
+ property :name, as: 'name'
152
+ hash :traits, as: 'traits'
153
+ end
154
+ end
155
+ end
156
+ end
157
+ end
@@ -0,0 +1,306 @@
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/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module SmartdevicemanagementV1
23
+ # Smart Device Management API
24
+ #
25
+ # Allow select enterprise partners to access, control, and manage Google and
26
+ # Nest devices programmatically.
27
+ #
28
+ # @example
29
+ # require 'google/apis/smartdevicemanagement_v1'
30
+ #
31
+ # Smartdevicemanagement = Google::Apis::SmartdevicemanagementV1 # Alias the module
32
+ # service = Smartdevicemanagement::SmartDeviceManagementService.new
33
+ #
34
+ # @see https://developers.google.com/nest/device-access
35
+ class SmartDeviceManagementService < Google::Apis::Core::BaseService
36
+ # @return [String]
37
+ # API key. Your API key identifies your project and provides you with API access,
38
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
39
+ attr_accessor :key
40
+
41
+ # @return [String]
42
+ # Available to use for quota purposes for server-side applications. Can be any
43
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
44
+ attr_accessor :quota_user
45
+
46
+ def initialize
47
+ super('https://smartdevicemanagement.googleapis.com/', '',
48
+ client_name: 'google-apis-smartdevicemanagement_v1',
49
+ client_version: Google::Apis::SmartdevicemanagementV1::GEM_VERSION)
50
+ @batch_path = 'batch'
51
+ end
52
+
53
+ # Executes a command to device managed by the enterprise.
54
+ # @param [String] name
55
+ # The name of the device requested. For example: "enterprises/XYZ/devices/123"
56
+ # @param [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest] google_home_enterprise_sdm_v1_execute_device_command_request_object
57
+ # @param [String] fields
58
+ # Selector specifying which fields to include in a partial response.
59
+ # @param [String] quota_user
60
+ # Available to use for quota purposes for server-side applications. Can be any
61
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
62
+ # @param [Google::Apis::RequestOptions] options
63
+ # Request-specific options
64
+ #
65
+ # @yield [result, err] Result & error if block supplied
66
+ # @yieldparam result [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse] parsed result object
67
+ # @yieldparam err [StandardError] error object if request failed
68
+ #
69
+ # @return [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse]
70
+ #
71
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
72
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
73
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
74
+ def execute_enterprise_device_command(name, google_home_enterprise_sdm_v1_execute_device_command_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
75
+ command = make_simple_command(:post, 'v1/{+name}:executeCommand', options)
76
+ command.request_representation = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest::Representation
77
+ command.request_object = google_home_enterprise_sdm_v1_execute_device_command_request_object
78
+ command.response_representation = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse::Representation
79
+ command.response_class = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse
80
+ command.params['name'] = name unless name.nil?
81
+ command.query['fields'] = fields unless fields.nil?
82
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
83
+ execute_or_queue_command(command, &block)
84
+ end
85
+
86
+ # Gets a device managed by the enterprise.
87
+ # @param [String] name
88
+ # The name of the device requested. For example: "enterprises/XYZ/devices/123"
89
+ # @param [String] fields
90
+ # Selector specifying which fields to include in a partial response.
91
+ # @param [String] quota_user
92
+ # Available to use for quota purposes for server-side applications. Can be any
93
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
94
+ # @param [Google::Apis::RequestOptions] options
95
+ # Request-specific options
96
+ #
97
+ # @yield [result, err] Result & error if block supplied
98
+ # @yieldparam result [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Device] parsed result object
99
+ # @yieldparam err [StandardError] error object if request failed
100
+ #
101
+ # @return [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Device]
102
+ #
103
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
104
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
105
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
106
+ def get_enterprise_device(name, fields: nil, quota_user: nil, options: nil, &block)
107
+ command = make_simple_command(:get, 'v1/{+name}', options)
108
+ command.response_representation = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Device::Representation
109
+ command.response_class = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Device
110
+ command.params['name'] = name unless name.nil?
111
+ command.query['fields'] = fields unless fields.nil?
112
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
113
+ execute_or_queue_command(command, &block)
114
+ end
115
+
116
+ # Lists devices managed by the enterprise.
117
+ # @param [String] parent
118
+ # The parent enterprise to list devices under. E.g. "enterprises/XYZ".
119
+ # @param [String] filter
120
+ # Optional filter to list devices. Filters can be done on: Device custom name (
121
+ # substring match): 'customName=wing'
122
+ # @param [Fixnum] page_size
123
+ # Optional requested page size. Server may return fewer devices than requested.
124
+ # If unspecified, server will pick an appropriate default.
125
+ # @param [String] page_token
126
+ # Optional token of the page to retrieve.
127
+ # @param [String] fields
128
+ # Selector specifying which fields to include in a partial response.
129
+ # @param [String] quota_user
130
+ # Available to use for quota purposes for server-side applications. Can be any
131
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
132
+ # @param [Google::Apis::RequestOptions] options
133
+ # Request-specific options
134
+ #
135
+ # @yield [result, err] Result & error if block supplied
136
+ # @yieldparam result [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ListDevicesResponse] parsed result object
137
+ # @yieldparam err [StandardError] error object if request failed
138
+ #
139
+ # @return [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ListDevicesResponse]
140
+ #
141
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
142
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
143
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
144
+ def list_enterprise_devices(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
145
+ command = make_simple_command(:get, 'v1/{+parent}/devices', options)
146
+ command.response_representation = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ListDevicesResponse::Representation
147
+ command.response_class = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ListDevicesResponse
148
+ command.params['parent'] = parent unless parent.nil?
149
+ command.query['filter'] = filter unless filter.nil?
150
+ command.query['pageSize'] = page_size unless page_size.nil?
151
+ command.query['pageToken'] = page_token unless page_token.nil?
152
+ command.query['fields'] = fields unless fields.nil?
153
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
154
+ execute_or_queue_command(command, &block)
155
+ end
156
+
157
+ # Gets a structure managed by the enterprise.
158
+ # @param [String] name
159
+ # The name of the structure requested. For example: "enterprises/XYZ/structures/
160
+ # ABC".
161
+ # @param [String] fields
162
+ # Selector specifying which fields to include in a partial response.
163
+ # @param [String] quota_user
164
+ # Available to use for quota purposes for server-side applications. Can be any
165
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
166
+ # @param [Google::Apis::RequestOptions] options
167
+ # Request-specific options
168
+ #
169
+ # @yield [result, err] Result & error if block supplied
170
+ # @yieldparam result [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Structure] parsed result object
171
+ # @yieldparam err [StandardError] error object if request failed
172
+ #
173
+ # @return [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Structure]
174
+ #
175
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
176
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
177
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
178
+ def get_enterprise_structure(name, fields: nil, quota_user: nil, options: nil, &block)
179
+ command = make_simple_command(:get, 'v1/{+name}', options)
180
+ command.response_representation = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Structure::Representation
181
+ command.response_class = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Structure
182
+ command.params['name'] = name unless name.nil?
183
+ command.query['fields'] = fields unless fields.nil?
184
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
185
+ execute_or_queue_command(command, &block)
186
+ end
187
+
188
+ # Lists structures managed by the enterprise.
189
+ # @param [String] parent
190
+ # The parent enterprise to list structures under. E.g. "enterprises/XYZ".
191
+ # @param [String] filter
192
+ # Optional filter to list structures.
193
+ # @param [Fixnum] page_size
194
+ # Requested page size. Server may return fewer structures than requested. If
195
+ # unspecified, server will pick an appropriate default.
196
+ # @param [String] page_token
197
+ # The token of the page to retrieve.
198
+ # @param [String] fields
199
+ # Selector specifying which fields to include in a partial response.
200
+ # @param [String] quota_user
201
+ # Available to use for quota purposes for server-side applications. Can be any
202
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
203
+ # @param [Google::Apis::RequestOptions] options
204
+ # Request-specific options
205
+ #
206
+ # @yield [result, err] Result & error if block supplied
207
+ # @yieldparam result [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ListStructuresResponse] parsed result object
208
+ # @yieldparam err [StandardError] error object if request failed
209
+ #
210
+ # @return [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ListStructuresResponse]
211
+ #
212
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
213
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
214
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
215
+ def list_enterprise_structures(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
216
+ command = make_simple_command(:get, 'v1/{+parent}/structures', options)
217
+ command.response_representation = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ListStructuresResponse::Representation
218
+ command.response_class = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ListStructuresResponse
219
+ command.params['parent'] = parent unless parent.nil?
220
+ command.query['filter'] = filter unless filter.nil?
221
+ command.query['pageSize'] = page_size unless page_size.nil?
222
+ command.query['pageToken'] = page_token unless page_token.nil?
223
+ command.query['fields'] = fields unless fields.nil?
224
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
225
+ execute_or_queue_command(command, &block)
226
+ end
227
+
228
+ # Gets a room managed by the enterprise.
229
+ # @param [String] name
230
+ # The name of the room requested. For example: "enterprises/XYZ/structures/ABC/
231
+ # rooms/123".
232
+ # @param [String] fields
233
+ # Selector specifying which fields to include in a partial response.
234
+ # @param [String] quota_user
235
+ # Available to use for quota purposes for server-side applications. Can be any
236
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
237
+ # @param [Google::Apis::RequestOptions] options
238
+ # Request-specific options
239
+ #
240
+ # @yield [result, err] Result & error if block supplied
241
+ # @yieldparam result [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Room] parsed result object
242
+ # @yieldparam err [StandardError] error object if request failed
243
+ #
244
+ # @return [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Room]
245
+ #
246
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
247
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
248
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
249
+ def get_enterprise_structure_room(name, fields: nil, quota_user: nil, options: nil, &block)
250
+ command = make_simple_command(:get, 'v1/{+name}', options)
251
+ command.response_representation = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Room::Representation
252
+ command.response_class = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1Room
253
+ command.params['name'] = name unless name.nil?
254
+ command.query['fields'] = fields unless fields.nil?
255
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
256
+ execute_or_queue_command(command, &block)
257
+ end
258
+
259
+ # Lists rooms managed by the enterprise.
260
+ # @param [String] parent
261
+ # The parent resource name of the rooms requested. For example: "enterprises/XYZ/
262
+ # structures/ABC".
263
+ # @param [Fixnum] page_size
264
+ # Requested page size. Server may return fewer rooms than requested. If
265
+ # unspecified, server will pick an appropriate default.
266
+ # @param [String] page_token
267
+ # The token of the page to retrieve.
268
+ # @param [String] fields
269
+ # Selector specifying which fields to include in a partial response.
270
+ # @param [String] quota_user
271
+ # Available to use for quota purposes for server-side applications. Can be any
272
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
273
+ # @param [Google::Apis::RequestOptions] options
274
+ # Request-specific options
275
+ #
276
+ # @yield [result, err] Result & error if block supplied
277
+ # @yieldparam result [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ListRoomsResponse] parsed result object
278
+ # @yieldparam err [StandardError] error object if request failed
279
+ #
280
+ # @return [Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ListRoomsResponse]
281
+ #
282
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
283
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
284
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
285
+ def list_enterprise_structure_rooms(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
286
+ command = make_simple_command(:get, 'v1/{+parent}/rooms', options)
287
+ command.response_representation = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ListRoomsResponse::Representation
288
+ command.response_class = Google::Apis::SmartdevicemanagementV1::GoogleHomeEnterpriseSdmV1ListRoomsResponse
289
+ command.params['parent'] = parent unless parent.nil?
290
+ command.query['pageSize'] = page_size unless page_size.nil?
291
+ command.query['pageToken'] = page_token unless page_token.nil?
292
+ command.query['fields'] = fields unless fields.nil?
293
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
294
+ execute_or_queue_command(command, &block)
295
+ end
296
+
297
+ protected
298
+
299
+ def apply_command_defaults(command)
300
+ command.query['key'] = key unless key.nil?
301
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
302
+ end
303
+ end
304
+ end
305
+ end
306
+ end
metadata ADDED
@@ -0,0 +1,76 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: google-apis-smartdevicemanagement_v1
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Google LLC
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-01-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: google-apis-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.1'
27
+ description: This is the simple REST client for Smart Device Management API V1. Simple
28
+ REST clients are Ruby client libraries that provide access to Google services via
29
+ their HTTP REST API endpoints. These libraries are generated and updated automatically
30
+ based on the discovery documents published by the service, and they handle most
31
+ concerns such as authentication, pagination, retry, timeouts, and logging. You can
32
+ use this client to access the Smart Device Management API, but note that some services
33
+ may provide a separate modern client that is easier to use.
34
+ email: googleapis-packages@google.com
35
+ executables: []
36
+ extensions: []
37
+ extra_rdoc_files: []
38
+ files:
39
+ - ".yardopts"
40
+ - CHANGELOG.md
41
+ - LICENSE.md
42
+ - OVERVIEW.md
43
+ - lib/google-apis-smartdevicemanagement_v1.rb
44
+ - lib/google/apis/smartdevicemanagement_v1.rb
45
+ - lib/google/apis/smartdevicemanagement_v1/classes.rb
46
+ - lib/google/apis/smartdevicemanagement_v1/gem_version.rb
47
+ - lib/google/apis/smartdevicemanagement_v1/representations.rb
48
+ - lib/google/apis/smartdevicemanagement_v1/service.rb
49
+ homepage: https://github.com/google/google-api-ruby-client
50
+ licenses:
51
+ - Apache-2.0
52
+ metadata:
53
+ bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
54
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-smartdevicemanagement_v1/CHANGELOG.md
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-smartdevicemanagement_v1/v0.1.0
56
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-smartdevicemanagement_v1
57
+ post_install_message:
58
+ rdoc_options: []
59
+ require_paths:
60
+ - lib
61
+ required_ruby_version: !ruby/object:Gem::Requirement
62
+ requirements:
63
+ - - ">="
64
+ - !ruby/object:Gem::Version
65
+ version: '2.4'
66
+ required_rubygems_version: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: '0'
71
+ requirements: []
72
+ rubygems_version: 3.1.4
73
+ signing_key:
74
+ specification_version: 4
75
+ summary: Simple REST client for Smart Device Management API V1
76
+ test_files: []