google-apis-androiddeviceprovisioning_v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-androiddeviceprovisioning_v1.rb +15 -0
- data/lib/google/apis/androiddeviceprovisioning_v1.rb +34 -0
- data/lib/google/apis/androiddeviceprovisioning_v1/classes.rb +1414 -0
- data/lib/google/apis/androiddeviceprovisioning_v1/gem_version.rb +28 -0
- data/lib/google/apis/androiddeviceprovisioning_v1/representations.rb +661 -0
- data/lib/google/apis/androiddeviceprovisioning_v1/service.rb +961 -0
- metadata +76 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: c88130666f6613af2c3ae989203956eeca3f9ca052007272fbc5740cfa8b9e02
|
4
|
+
data.tar.gz: 1ce322646e2d1426dd2349a9589ed931dce9e7ab2a55f5a5fd5dd589904282af
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 4df74ef51cc5c8f0a850eddadf8ec85fef097af78d3d7e984d6ea85cb692433fe6c6b345dacf9d9efb4fd85947a8ef19f44cd70e79f241c05668f8af85392a2b
|
7
|
+
data.tar.gz: 4bb45b956a18dbe76a0204e9fd39e94f2d09b91bfed1f7e871c65765ba2c218d62b0118e839b7dc135f5d76129408e6c9e7d518597148330bb2758e8c3d6e413
|
data/.yardopts
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
--hide-void-return
|
2
|
+
--no-private
|
3
|
+
--verbose
|
4
|
+
--title=google-apis-androiddeviceprovisioning_v1
|
5
|
+
--markup-provider=redcarpet
|
6
|
+
--markup=markdown
|
7
|
+
--main OVERVIEW.md
|
8
|
+
lib/google/apis/androiddeviceprovisioning_v1/*.rb
|
9
|
+
lib/google/apis/androiddeviceprovisioning_v1.rb
|
10
|
+
-
|
11
|
+
OVERVIEW.md
|
12
|
+
CHANGELOG.md
|
13
|
+
LICENSE.md
|
data/CHANGELOG.md
ADDED
data/LICENSE.md
ADDED
@@ -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.
|
data/OVERVIEW.md
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
# Simple REST client for version V1 of the Android Device Provisioning Partner API
|
2
|
+
|
3
|
+
This is a simple client library for version V1 of the Android Device Provisioning Partner 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/androiddeviceprovisioning.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-androiddeviceprovisioning_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-androiddeviceprovisioning_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/androiddeviceprovisioning_v1"
|
49
|
+
|
50
|
+
# Create a client object
|
51
|
+
client = Google::Apis::AndroiddeviceprovisioningV1::AndroidProvisioningPartnerService.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 Androiddeviceprovisioning service in particular.)
|
67
|
+
|
68
|
+
For reference information on specific calls in the Android Device Provisioning Partner API, see the {Google::Apis::AndroiddeviceprovisioningV1::AndroidProvisioningPartnerService 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-androiddeviceprovisioning_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/zero-touch/) 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/androiddeviceprovisioning_v1"
|
@@ -0,0 +1,34 @@
|
|
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/androiddeviceprovisioning_v1/service.rb'
|
16
|
+
require 'google/apis/androiddeviceprovisioning_v1/classes.rb'
|
17
|
+
require 'google/apis/androiddeviceprovisioning_v1/representations.rb'
|
18
|
+
require 'google/apis/androiddeviceprovisioning_v1/gem_version.rb'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
# Android Device Provisioning Partner API
|
23
|
+
#
|
24
|
+
# Automates Android zero-touch enrollment for device resellers, customers, and
|
25
|
+
# EMMs.
|
26
|
+
#
|
27
|
+
# @see https://developers.google.com/zero-touch/
|
28
|
+
module AndroiddeviceprovisioningV1
|
29
|
+
# Version of the Android Device Provisioning Partner API this client connects to.
|
30
|
+
# This is NOT the gem version.
|
31
|
+
VERSION = 'V1'
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
@@ -0,0 +1,1414 @@
|
|
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 AndroiddeviceprovisioningV1
|
24
|
+
|
25
|
+
# Request message to claim a device on behalf of a customer.
|
26
|
+
class ClaimDeviceRequest
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
# Required. The ID of the customer for whom the device is being claimed.
|
30
|
+
# Corresponds to the JSON property `customerId`
|
31
|
+
# @return [Fixnum]
|
32
|
+
attr_accessor :customer_id
|
33
|
+
|
34
|
+
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
35
|
+
# understand requirements on identifier sets, read [Identifiers](https://
|
36
|
+
# developers.google.com/zero-touch/guides/identifiers).
|
37
|
+
# Corresponds to the JSON property `deviceIdentifier`
|
38
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
39
|
+
attr_accessor :device_identifier
|
40
|
+
|
41
|
+
# Metadata entries that can be attached to a `Device`. To learn more, read [
|
42
|
+
# Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
43
|
+
# Corresponds to the JSON property `deviceMetadata`
|
44
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
45
|
+
attr_accessor :device_metadata
|
46
|
+
|
47
|
+
# Required. The section type of the device's provisioning record.
|
48
|
+
# Corresponds to the JSON property `sectionType`
|
49
|
+
# @return [String]
|
50
|
+
attr_accessor :section_type
|
51
|
+
|
52
|
+
def initialize(**args)
|
53
|
+
update!(**args)
|
54
|
+
end
|
55
|
+
|
56
|
+
# Update properties of this object
|
57
|
+
def update!(**args)
|
58
|
+
@customer_id = args[:customer_id] if args.key?(:customer_id)
|
59
|
+
@device_identifier = args[:device_identifier] if args.key?(:device_identifier)
|
60
|
+
@device_metadata = args[:device_metadata] if args.key?(:device_metadata)
|
61
|
+
@section_type = args[:section_type] if args.key?(:section_type)
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
# Response message containing device id of the claim.
|
66
|
+
class ClaimDeviceResponse
|
67
|
+
include Google::Apis::Core::Hashable
|
68
|
+
|
69
|
+
# The device ID of the claimed device.
|
70
|
+
# Corresponds to the JSON property `deviceId`
|
71
|
+
# @return [Fixnum]
|
72
|
+
attr_accessor :device_id
|
73
|
+
|
74
|
+
# The resource name of the device in the format `partners/[PARTNER_ID]/devices/[
|
75
|
+
# DEVICE_ID]`.
|
76
|
+
# Corresponds to the JSON property `deviceName`
|
77
|
+
# @return [String]
|
78
|
+
attr_accessor :device_name
|
79
|
+
|
80
|
+
def initialize(**args)
|
81
|
+
update!(**args)
|
82
|
+
end
|
83
|
+
|
84
|
+
# Update properties of this object
|
85
|
+
def update!(**args)
|
86
|
+
@device_id = args[:device_id] if args.key?(:device_id)
|
87
|
+
@device_name = args[:device_name] if args.key?(:device_name)
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
# Request to claim devices asynchronously in batch. Claiming a device adds the
|
92
|
+
# device to zero-touch enrollment and shows the device in the customer's view of
|
93
|
+
# the portal.
|
94
|
+
class ClaimDevicesRequest
|
95
|
+
include Google::Apis::Core::Hashable
|
96
|
+
|
97
|
+
# Required. A list of device claims.
|
98
|
+
# Corresponds to the JSON property `claims`
|
99
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::PartnerClaim>]
|
100
|
+
attr_accessor :claims
|
101
|
+
|
102
|
+
def initialize(**args)
|
103
|
+
update!(**args)
|
104
|
+
end
|
105
|
+
|
106
|
+
# Update properties of this object
|
107
|
+
def update!(**args)
|
108
|
+
@claims = args[:claims] if args.key?(:claims)
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
# A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
|
113
|
+
class Company
|
114
|
+
include Google::Apis::Core::Hashable
|
115
|
+
|
116
|
+
# Optional. Email address of customer's users in the admin role. Each email
|
117
|
+
# address must be associated with a Google Account.
|
118
|
+
# Corresponds to the JSON property `adminEmails`
|
119
|
+
# @return [Array<String>]
|
120
|
+
attr_accessor :admin_emails
|
121
|
+
|
122
|
+
# Output only. The ID of the company. Assigned by the server.
|
123
|
+
# Corresponds to the JSON property `companyId`
|
124
|
+
# @return [Fixnum]
|
125
|
+
attr_accessor :company_id
|
126
|
+
|
127
|
+
# Required. The name of the company. For example _XYZ Corp_. Displayed to the
|
128
|
+
# company's employees in the zero-touch enrollment portal.
|
129
|
+
# Corresponds to the JSON property `companyName`
|
130
|
+
# @return [String]
|
131
|
+
attr_accessor :company_name
|
132
|
+
|
133
|
+
# Output only. The API resource name of the company. The resource name is one of
|
134
|
+
# the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `
|
135
|
+
# partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[
|
136
|
+
# VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server.
|
137
|
+
# Corresponds to the JSON property `name`
|
138
|
+
# @return [String]
|
139
|
+
attr_accessor :name
|
140
|
+
|
141
|
+
# Required. Input only. Email address of customer's users in the owner role. At
|
142
|
+
# least one `owner_email` is required. Each email address must be associated
|
143
|
+
# with a Google Account. Owners share the same access as admins but can also add,
|
144
|
+
# delete, and edit your organization's portal users.
|
145
|
+
# Corresponds to the JSON property `ownerEmails`
|
146
|
+
# @return [Array<String>]
|
147
|
+
attr_accessor :owner_emails
|
148
|
+
|
149
|
+
# Output only. Whether any user from the company has accepted the latest Terms
|
150
|
+
# of Service (ToS). See TermsStatus.
|
151
|
+
# Corresponds to the JSON property `termsStatus`
|
152
|
+
# @return [String]
|
153
|
+
attr_accessor :terms_status
|
154
|
+
|
155
|
+
def initialize(**args)
|
156
|
+
update!(**args)
|
157
|
+
end
|
158
|
+
|
159
|
+
# Update properties of this object
|
160
|
+
def update!(**args)
|
161
|
+
@admin_emails = args[:admin_emails] if args.key?(:admin_emails)
|
162
|
+
@company_id = args[:company_id] if args.key?(:company_id)
|
163
|
+
@company_name = args[:company_name] if args.key?(:company_name)
|
164
|
+
@name = args[:name] if args.key?(:name)
|
165
|
+
@owner_emails = args[:owner_emails] if args.key?(:owner_emails)
|
166
|
+
@terms_status = args[:terms_status] if args.key?(:terms_status)
|
167
|
+
end
|
168
|
+
end
|
169
|
+
|
170
|
+
# A configuration collects the provisioning options for Android devices. Each
|
171
|
+
# configuration combines the following: * The EMM device policy controller (DPC)
|
172
|
+
# installed on the devices. * EMM policies enforced on the devices. * Metadata
|
173
|
+
# displayed on the device to help users during setup. Customers can add as many
|
174
|
+
# configurations as they need. However, zero-touch enrollment works best when a
|
175
|
+
# customer sets a default configuration that's applied to any new devices the
|
176
|
+
# organization purchases.
|
177
|
+
class Configuration
|
178
|
+
include Google::Apis::Core::Hashable
|
179
|
+
|
180
|
+
# Required. The name of the organization. Zero-touch enrollment shows this
|
181
|
+
# organization name to device users during device provisioning.
|
182
|
+
# Corresponds to the JSON property `companyName`
|
183
|
+
# @return [String]
|
184
|
+
attr_accessor :company_name
|
185
|
+
|
186
|
+
# Output only. The ID of the configuration. Assigned by the server.
|
187
|
+
# Corresponds to the JSON property `configurationId`
|
188
|
+
# @return [Fixnum]
|
189
|
+
attr_accessor :configuration_id
|
190
|
+
|
191
|
+
# Required. A short name that describes the configuration's purpose. For example,
|
192
|
+
# _Sales team_ or _Temporary employees_. The zero-touch enrollment portal
|
193
|
+
# displays this name to IT admins.
|
194
|
+
# Corresponds to the JSON property `configurationName`
|
195
|
+
# @return [String]
|
196
|
+
attr_accessor :configuration_name
|
197
|
+
|
198
|
+
# Required. The email address that device users can contact to get help. Zero-
|
199
|
+
# touch enrollment shows this email address to device users before device
|
200
|
+
# provisioning. The value is validated on input.
|
201
|
+
# Corresponds to the JSON property `contactEmail`
|
202
|
+
# @return [String]
|
203
|
+
attr_accessor :contact_email
|
204
|
+
|
205
|
+
# Required. The telephone number that device users can call, using another
|
206
|
+
# device, to get help. Zero-touch enrollment shows this number to device users
|
207
|
+
# before device provisioning. Accepts numerals, spaces, the plus sign, hyphens,
|
208
|
+
# and parentheses.
|
209
|
+
# Corresponds to the JSON property `contactPhone`
|
210
|
+
# @return [String]
|
211
|
+
attr_accessor :contact_phone
|
212
|
+
|
213
|
+
# A message, containing one or two sentences, to help device users get help or
|
214
|
+
# give them more details about what’s happening to their device. Zero-touch
|
215
|
+
# enrollment shows this message before the device is provisioned.
|
216
|
+
# Corresponds to the JSON property `customMessage`
|
217
|
+
# @return [String]
|
218
|
+
attr_accessor :custom_message
|
219
|
+
|
220
|
+
# The JSON-formatted EMM provisioning extras that are passed to the DPC.
|
221
|
+
# Corresponds to the JSON property `dpcExtras`
|
222
|
+
# @return [String]
|
223
|
+
attr_accessor :dpc_extras
|
224
|
+
|
225
|
+
# Required. The resource name of the selected DPC (device policy controller) in
|
226
|
+
# the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, call `
|
227
|
+
# customers.dpcs.list`.
|
228
|
+
# Corresponds to the JSON property `dpcResourcePath`
|
229
|
+
# @return [String]
|
230
|
+
attr_accessor :dpc_resource_path
|
231
|
+
|
232
|
+
# Required. Whether this is the default configuration that zero-touch enrollment
|
233
|
+
# applies to any new devices the organization purchases in the future. Only one
|
234
|
+
# customer configuration can be the default. Setting this value to `true`,
|
235
|
+
# changes the previous default configuration's `isDefault` value to `false`.
|
236
|
+
# Corresponds to the JSON property `isDefault`
|
237
|
+
# @return [Boolean]
|
238
|
+
attr_accessor :is_default
|
239
|
+
alias_method :is_default?, :is_default
|
240
|
+
|
241
|
+
# Output only. The API resource name in the format `customers/[CUSTOMER_ID]/
|
242
|
+
# configurations/[CONFIGURATION_ID]`. Assigned by the server.
|
243
|
+
# Corresponds to the JSON property `name`
|
244
|
+
# @return [String]
|
245
|
+
attr_accessor :name
|
246
|
+
|
247
|
+
def initialize(**args)
|
248
|
+
update!(**args)
|
249
|
+
end
|
250
|
+
|
251
|
+
# Update properties of this object
|
252
|
+
def update!(**args)
|
253
|
+
@company_name = args[:company_name] if args.key?(:company_name)
|
254
|
+
@configuration_id = args[:configuration_id] if args.key?(:configuration_id)
|
255
|
+
@configuration_name = args[:configuration_name] if args.key?(:configuration_name)
|
256
|
+
@contact_email = args[:contact_email] if args.key?(:contact_email)
|
257
|
+
@contact_phone = args[:contact_phone] if args.key?(:contact_phone)
|
258
|
+
@custom_message = args[:custom_message] if args.key?(:custom_message)
|
259
|
+
@dpc_extras = args[:dpc_extras] if args.key?(:dpc_extras)
|
260
|
+
@dpc_resource_path = args[:dpc_resource_path] if args.key?(:dpc_resource_path)
|
261
|
+
@is_default = args[:is_default] if args.key?(:is_default)
|
262
|
+
@name = args[:name] if args.key?(:name)
|
263
|
+
end
|
264
|
+
end
|
265
|
+
|
266
|
+
# Request message to create a customer.
|
267
|
+
class CreateCustomerRequest
|
268
|
+
include Google::Apis::Core::Hashable
|
269
|
+
|
270
|
+
# A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
|
271
|
+
# Corresponds to the JSON property `customer`
|
272
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::Company]
|
273
|
+
attr_accessor :customer
|
274
|
+
|
275
|
+
def initialize(**args)
|
276
|
+
update!(**args)
|
277
|
+
end
|
278
|
+
|
279
|
+
# Update properties of this object
|
280
|
+
def update!(**args)
|
281
|
+
@customer = args[:customer] if args.key?(:customer)
|
282
|
+
end
|
283
|
+
end
|
284
|
+
|
285
|
+
# Request message for customer to assign a configuration to device.
|
286
|
+
class CustomerApplyConfigurationRequest
|
287
|
+
include Google::Apis::Core::Hashable
|
288
|
+
|
289
|
+
# Required. The configuration applied to the device in the format `customers/[
|
290
|
+
# CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
|
291
|
+
# Corresponds to the JSON property `configuration`
|
292
|
+
# @return [String]
|
293
|
+
attr_accessor :configuration
|
294
|
+
|
295
|
+
# A `DeviceReference` is an API abstraction that lets you supply a _device_
|
296
|
+
# argument to a method using one of the following identifier types: * A numeric
|
297
|
+
# API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to
|
298
|
+
# the manufactured device. Methods that operate on devices take a `
|
299
|
+
# DeviceReference` as a parameter type because it's more flexible for the caller.
|
300
|
+
# To learn more about device identifiers, read [Identifiers](https://developers.
|
301
|
+
# google.com/zero-touch/guides/identifiers).
|
302
|
+
# Corresponds to the JSON property `device`
|
303
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceReference]
|
304
|
+
attr_accessor :device
|
305
|
+
|
306
|
+
def initialize(**args)
|
307
|
+
update!(**args)
|
308
|
+
end
|
309
|
+
|
310
|
+
# Update properties of this object
|
311
|
+
def update!(**args)
|
312
|
+
@configuration = args[:configuration] if args.key?(:configuration)
|
313
|
+
@device = args[:device] if args.key?(:device)
|
314
|
+
end
|
315
|
+
end
|
316
|
+
|
317
|
+
# Response message of customer's listing configuration.
|
318
|
+
class CustomerListConfigurationsResponse
|
319
|
+
include Google::Apis::Core::Hashable
|
320
|
+
|
321
|
+
# The configurations.
|
322
|
+
# Corresponds to the JSON property `configurations`
|
323
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Configuration>]
|
324
|
+
attr_accessor :configurations
|
325
|
+
|
326
|
+
def initialize(**args)
|
327
|
+
update!(**args)
|
328
|
+
end
|
329
|
+
|
330
|
+
# Update properties of this object
|
331
|
+
def update!(**args)
|
332
|
+
@configurations = args[:configurations] if args.key?(:configurations)
|
333
|
+
end
|
334
|
+
end
|
335
|
+
|
336
|
+
# Response message for listing my customers.
|
337
|
+
class CustomerListCustomersResponse
|
338
|
+
include Google::Apis::Core::Hashable
|
339
|
+
|
340
|
+
# The customer accounts the calling user is a member of.
|
341
|
+
# Corresponds to the JSON property `customers`
|
342
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Company>]
|
343
|
+
attr_accessor :customers
|
344
|
+
|
345
|
+
# A token used to access the next page of results. Omitted if no further results
|
346
|
+
# are available.
|
347
|
+
# Corresponds to the JSON property `nextPageToken`
|
348
|
+
# @return [String]
|
349
|
+
attr_accessor :next_page_token
|
350
|
+
|
351
|
+
def initialize(**args)
|
352
|
+
update!(**args)
|
353
|
+
end
|
354
|
+
|
355
|
+
# Update properties of this object
|
356
|
+
def update!(**args)
|
357
|
+
@customers = args[:customers] if args.key?(:customers)
|
358
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
359
|
+
end
|
360
|
+
end
|
361
|
+
|
362
|
+
# Response message of customer's liting devices.
|
363
|
+
class CustomerListDevicesResponse
|
364
|
+
include Google::Apis::Core::Hashable
|
365
|
+
|
366
|
+
# The customer's devices.
|
367
|
+
# Corresponds to the JSON property `devices`
|
368
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Device>]
|
369
|
+
attr_accessor :devices
|
370
|
+
|
371
|
+
# A token used to access the next page of results. Omitted if no further results
|
372
|
+
# are available.
|
373
|
+
# Corresponds to the JSON property `nextPageToken`
|
374
|
+
# @return [String]
|
375
|
+
attr_accessor :next_page_token
|
376
|
+
|
377
|
+
def initialize(**args)
|
378
|
+
update!(**args)
|
379
|
+
end
|
380
|
+
|
381
|
+
# Update properties of this object
|
382
|
+
def update!(**args)
|
383
|
+
@devices = args[:devices] if args.key?(:devices)
|
384
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
385
|
+
end
|
386
|
+
end
|
387
|
+
|
388
|
+
# Response message of customer's listing DPCs.
|
389
|
+
class CustomerListDpcsResponse
|
390
|
+
include Google::Apis::Core::Hashable
|
391
|
+
|
392
|
+
# The list of DPCs available to the customer that support zero-touch enrollment.
|
393
|
+
# Corresponds to the JSON property `dpcs`
|
394
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Dpc>]
|
395
|
+
attr_accessor :dpcs
|
396
|
+
|
397
|
+
def initialize(**args)
|
398
|
+
update!(**args)
|
399
|
+
end
|
400
|
+
|
401
|
+
# Update properties of this object
|
402
|
+
def update!(**args)
|
403
|
+
@dpcs = args[:dpcs] if args.key?(:dpcs)
|
404
|
+
end
|
405
|
+
end
|
406
|
+
|
407
|
+
# Request message for customer to remove the configuration from device.
|
408
|
+
class CustomerRemoveConfigurationRequest
|
409
|
+
include Google::Apis::Core::Hashable
|
410
|
+
|
411
|
+
# A `DeviceReference` is an API abstraction that lets you supply a _device_
|
412
|
+
# argument to a method using one of the following identifier types: * A numeric
|
413
|
+
# API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to
|
414
|
+
# the manufactured device. Methods that operate on devices take a `
|
415
|
+
# DeviceReference` as a parameter type because it's more flexible for the caller.
|
416
|
+
# To learn more about device identifiers, read [Identifiers](https://developers.
|
417
|
+
# google.com/zero-touch/guides/identifiers).
|
418
|
+
# Corresponds to the JSON property `device`
|
419
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceReference]
|
420
|
+
attr_accessor :device
|
421
|
+
|
422
|
+
def initialize(**args)
|
423
|
+
update!(**args)
|
424
|
+
end
|
425
|
+
|
426
|
+
# Update properties of this object
|
427
|
+
def update!(**args)
|
428
|
+
@device = args[:device] if args.key?(:device)
|
429
|
+
end
|
430
|
+
end
|
431
|
+
|
432
|
+
# Request message for customer to unclaim a device.
|
433
|
+
class CustomerUnclaimDeviceRequest
|
434
|
+
include Google::Apis::Core::Hashable
|
435
|
+
|
436
|
+
# A `DeviceReference` is an API abstraction that lets you supply a _device_
|
437
|
+
# argument to a method using one of the following identifier types: * A numeric
|
438
|
+
# API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to
|
439
|
+
# the manufactured device. Methods that operate on devices take a `
|
440
|
+
# DeviceReference` as a parameter type because it's more flexible for the caller.
|
441
|
+
# To learn more about device identifiers, read [Identifiers](https://developers.
|
442
|
+
# google.com/zero-touch/guides/identifiers).
|
443
|
+
# Corresponds to the JSON property `device`
|
444
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceReference]
|
445
|
+
attr_accessor :device
|
446
|
+
|
447
|
+
def initialize(**args)
|
448
|
+
update!(**args)
|
449
|
+
end
|
450
|
+
|
451
|
+
# Update properties of this object
|
452
|
+
def update!(**args)
|
453
|
+
@device = args[:device] if args.key?(:device)
|
454
|
+
end
|
455
|
+
end
|
456
|
+
|
457
|
+
# An Android device registered for zero-touch enrollment.
|
458
|
+
class Device
|
459
|
+
include Google::Apis::Core::Hashable
|
460
|
+
|
461
|
+
# Output only. The provisioning claims for a device. Devices claimed for zero-
|
462
|
+
# touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `
|
463
|
+
# partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the
|
464
|
+
# device from zero-touch enrollment.
|
465
|
+
# Corresponds to the JSON property `claims`
|
466
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::DeviceClaim>]
|
467
|
+
attr_accessor :claims
|
468
|
+
|
469
|
+
# Not available to resellers.
|
470
|
+
# Corresponds to the JSON property `configuration`
|
471
|
+
# @return [String]
|
472
|
+
attr_accessor :configuration
|
473
|
+
|
474
|
+
# Output only. The ID of the device. Assigned by the server.
|
475
|
+
# Corresponds to the JSON property `deviceId`
|
476
|
+
# @return [Fixnum]
|
477
|
+
attr_accessor :device_id
|
478
|
+
|
479
|
+
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
480
|
+
# understand requirements on identifier sets, read [Identifiers](https://
|
481
|
+
# developers.google.com/zero-touch/guides/identifiers).
|
482
|
+
# Corresponds to the JSON property `deviceIdentifier`
|
483
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
484
|
+
attr_accessor :device_identifier
|
485
|
+
|
486
|
+
# Metadata entries that can be attached to a `Device`. To learn more, read [
|
487
|
+
# Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
488
|
+
# Corresponds to the JSON property `deviceMetadata`
|
489
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
490
|
+
attr_accessor :device_metadata
|
491
|
+
|
492
|
+
# Output only. The API resource name in the format `partners/[PARTNER_ID]/
|
493
|
+
# devices/[DEVICE_ID]`. Assigned by the server.
|
494
|
+
# Corresponds to the JSON property `name`
|
495
|
+
# @return [String]
|
496
|
+
attr_accessor :name
|
497
|
+
|
498
|
+
def initialize(**args)
|
499
|
+
update!(**args)
|
500
|
+
end
|
501
|
+
|
502
|
+
# Update properties of this object
|
503
|
+
def update!(**args)
|
504
|
+
@claims = args[:claims] if args.key?(:claims)
|
505
|
+
@configuration = args[:configuration] if args.key?(:configuration)
|
506
|
+
@device_id = args[:device_id] if args.key?(:device_id)
|
507
|
+
@device_identifier = args[:device_identifier] if args.key?(:device_identifier)
|
508
|
+
@device_metadata = args[:device_metadata] if args.key?(:device_metadata)
|
509
|
+
@name = args[:name] if args.key?(:name)
|
510
|
+
end
|
511
|
+
end
|
512
|
+
|
513
|
+
# A record of a device claimed by a reseller for a customer. Devices claimed for
|
514
|
+
# zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To
|
515
|
+
# learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#
|
516
|
+
# claim).
|
517
|
+
class DeviceClaim
|
518
|
+
include Google::Apis::Core::Hashable
|
519
|
+
|
520
|
+
# The ID of the Customer that purchased the device.
|
521
|
+
# Corresponds to the JSON property `ownerCompanyId`
|
522
|
+
# @return [Fixnum]
|
523
|
+
attr_accessor :owner_company_id
|
524
|
+
|
525
|
+
# The ID of the reseller that claimed the device.
|
526
|
+
# Corresponds to the JSON property `resellerId`
|
527
|
+
# @return [Fixnum]
|
528
|
+
attr_accessor :reseller_id
|
529
|
+
|
530
|
+
# Output only. The type of claim made on the device.
|
531
|
+
# Corresponds to the JSON property `sectionType`
|
532
|
+
# @return [String]
|
533
|
+
attr_accessor :section_type
|
534
|
+
|
535
|
+
# The timestamp when the device will exit ‘vacation mode’. This value is present
|
536
|
+
# iff the device is in 'vacation mode'.
|
537
|
+
# Corresponds to the JSON property `vacationModeExpireTime`
|
538
|
+
# @return [String]
|
539
|
+
attr_accessor :vacation_mode_expire_time
|
540
|
+
|
541
|
+
# The timestamp when the device was put into ‘vacation mode’. This value is
|
542
|
+
# present iff the device is in 'vacation mode'.
|
543
|
+
# Corresponds to the JSON property `vacationModeStartTime`
|
544
|
+
# @return [String]
|
545
|
+
attr_accessor :vacation_mode_start_time
|
546
|
+
|
547
|
+
def initialize(**args)
|
548
|
+
update!(**args)
|
549
|
+
end
|
550
|
+
|
551
|
+
# Update properties of this object
|
552
|
+
def update!(**args)
|
553
|
+
@owner_company_id = args[:owner_company_id] if args.key?(:owner_company_id)
|
554
|
+
@reseller_id = args[:reseller_id] if args.key?(:reseller_id)
|
555
|
+
@section_type = args[:section_type] if args.key?(:section_type)
|
556
|
+
@vacation_mode_expire_time = args[:vacation_mode_expire_time] if args.key?(:vacation_mode_expire_time)
|
557
|
+
@vacation_mode_start_time = args[:vacation_mode_start_time] if args.key?(:vacation_mode_start_time)
|
558
|
+
end
|
559
|
+
end
|
560
|
+
|
561
|
+
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
562
|
+
# understand requirements on identifier sets, read [Identifiers](https://
|
563
|
+
# developers.google.com/zero-touch/guides/identifiers).
|
564
|
+
class DeviceIdentifier
|
565
|
+
include Google::Apis::Core::Hashable
|
566
|
+
|
567
|
+
# The device’s IMEI number. Validated on input.
|
568
|
+
# Corresponds to the JSON property `imei`
|
569
|
+
# @return [String]
|
570
|
+
attr_accessor :imei
|
571
|
+
|
572
|
+
# The device manufacturer’s name. Matches the device's built-in value returned
|
573
|
+
# from `android.os.Build.MANUFACTURER`. Allowed values are listed in [
|
574
|
+
# manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
|
575
|
+
# Corresponds to the JSON property `manufacturer`
|
576
|
+
# @return [String]
|
577
|
+
attr_accessor :manufacturer
|
578
|
+
|
579
|
+
# The device’s MEID number.
|
580
|
+
# Corresponds to the JSON property `meid`
|
581
|
+
# @return [String]
|
582
|
+
attr_accessor :meid
|
583
|
+
|
584
|
+
# The device model's name. Matches the device's built-in value returned from `
|
585
|
+
# android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/
|
586
|
+
# resources/manufacturer-names#model-names).
|
587
|
+
# Corresponds to the JSON property `model`
|
588
|
+
# @return [String]
|
589
|
+
attr_accessor :model
|
590
|
+
|
591
|
+
# The manufacturer's serial number for the device. This value might not be
|
592
|
+
# unique across different device models.
|
593
|
+
# Corresponds to the JSON property `serialNumber`
|
594
|
+
# @return [String]
|
595
|
+
attr_accessor :serial_number
|
596
|
+
|
597
|
+
def initialize(**args)
|
598
|
+
update!(**args)
|
599
|
+
end
|
600
|
+
|
601
|
+
# Update properties of this object
|
602
|
+
def update!(**args)
|
603
|
+
@imei = args[:imei] if args.key?(:imei)
|
604
|
+
@manufacturer = args[:manufacturer] if args.key?(:manufacturer)
|
605
|
+
@meid = args[:meid] if args.key?(:meid)
|
606
|
+
@model = args[:model] if args.key?(:model)
|
607
|
+
@serial_number = args[:serial_number] if args.key?(:serial_number)
|
608
|
+
end
|
609
|
+
end
|
610
|
+
|
611
|
+
# Metadata entries that can be attached to a `Device`. To learn more, read [
|
612
|
+
# Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
613
|
+
class DeviceMetadata
|
614
|
+
include Google::Apis::Core::Hashable
|
615
|
+
|
616
|
+
# Metadata entries recorded as key-value pairs.
|
617
|
+
# Corresponds to the JSON property `entries`
|
618
|
+
# @return [Hash<String,String>]
|
619
|
+
attr_accessor :entries
|
620
|
+
|
621
|
+
def initialize(**args)
|
622
|
+
update!(**args)
|
623
|
+
end
|
624
|
+
|
625
|
+
# Update properties of this object
|
626
|
+
def update!(**args)
|
627
|
+
@entries = args[:entries] if args.key?(:entries)
|
628
|
+
end
|
629
|
+
end
|
630
|
+
|
631
|
+
# A `DeviceReference` is an API abstraction that lets you supply a _device_
|
632
|
+
# argument to a method using one of the following identifier types: * A numeric
|
633
|
+
# API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to
|
634
|
+
# the manufactured device. Methods that operate on devices take a `
|
635
|
+
# DeviceReference` as a parameter type because it's more flexible for the caller.
|
636
|
+
# To learn more about device identifiers, read [Identifiers](https://developers.
|
637
|
+
# google.com/zero-touch/guides/identifiers).
|
638
|
+
class DeviceReference
|
639
|
+
include Google::Apis::Core::Hashable
|
640
|
+
|
641
|
+
# The ID of the device.
|
642
|
+
# Corresponds to the JSON property `deviceId`
|
643
|
+
# @return [Fixnum]
|
644
|
+
attr_accessor :device_id
|
645
|
+
|
646
|
+
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
647
|
+
# understand requirements on identifier sets, read [Identifiers](https://
|
648
|
+
# developers.google.com/zero-touch/guides/identifiers).
|
649
|
+
# Corresponds to the JSON property `deviceIdentifier`
|
650
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
651
|
+
attr_accessor :device_identifier
|
652
|
+
|
653
|
+
def initialize(**args)
|
654
|
+
update!(**args)
|
655
|
+
end
|
656
|
+
|
657
|
+
# Update properties of this object
|
658
|
+
def update!(**args)
|
659
|
+
@device_id = args[:device_id] if args.key?(:device_id)
|
660
|
+
@device_identifier = args[:device_identifier] if args.key?(:device_identifier)
|
661
|
+
end
|
662
|
+
end
|
663
|
+
|
664
|
+
# Tracks the status of a long-running operation to asynchronously update a batch
|
665
|
+
# of reseller metadata attached to devices. To learn more, read [Long‑running
|
666
|
+
# batch operations](/zero-touch/guides/how-it-works#operations).
|
667
|
+
class DevicesLongRunningOperationMetadata
|
668
|
+
include Google::Apis::Core::Hashable
|
669
|
+
|
670
|
+
# The number of metadata updates in the operation. This might be different from
|
671
|
+
# the number of updates in the request if the API can't parse some of the
|
672
|
+
# updates.
|
673
|
+
# Corresponds to the JSON property `devicesCount`
|
674
|
+
# @return [Fixnum]
|
675
|
+
attr_accessor :devices_count
|
676
|
+
|
677
|
+
# The processing status of the operation.
|
678
|
+
# Corresponds to the JSON property `processingStatus`
|
679
|
+
# @return [String]
|
680
|
+
attr_accessor :processing_status
|
681
|
+
|
682
|
+
# The processing progress of the operation. Measured as a number from 0 to 100.
|
683
|
+
# A value of 10O doesnt always mean the operation completed—check for the
|
684
|
+
# inclusion of a `done` field.
|
685
|
+
# Corresponds to the JSON property `progress`
|
686
|
+
# @return [Fixnum]
|
687
|
+
attr_accessor :progress
|
688
|
+
|
689
|
+
def initialize(**args)
|
690
|
+
update!(**args)
|
691
|
+
end
|
692
|
+
|
693
|
+
# Update properties of this object
|
694
|
+
def update!(**args)
|
695
|
+
@devices_count = args[:devices_count] if args.key?(:devices_count)
|
696
|
+
@processing_status = args[:processing_status] if args.key?(:processing_status)
|
697
|
+
@progress = args[:progress] if args.key?(:progress)
|
698
|
+
end
|
699
|
+
end
|
700
|
+
|
701
|
+
# Tracks the status of a long-running operation to claim, unclaim, or attach
|
702
|
+
# metadata to devices. To learn more, read [Long‑running batch operations](/zero-
|
703
|
+
# touch/guides/how-it-works#operations).
|
704
|
+
class DevicesLongRunningOperationResponse
|
705
|
+
include Google::Apis::Core::Hashable
|
706
|
+
|
707
|
+
# The processing status for each device in the operation. One `PerDeviceStatus`
|
708
|
+
# per device. The list order matches the items in the original request.
|
709
|
+
# Corresponds to the JSON property `perDeviceStatus`
|
710
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::OperationPerDevice>]
|
711
|
+
attr_accessor :per_device_status
|
712
|
+
|
713
|
+
# A summary of how many items in the operation the server processed successfully.
|
714
|
+
# Updated as the operation progresses.
|
715
|
+
# Corresponds to the JSON property `successCount`
|
716
|
+
# @return [Fixnum]
|
717
|
+
attr_accessor :success_count
|
718
|
+
|
719
|
+
def initialize(**args)
|
720
|
+
update!(**args)
|
721
|
+
end
|
722
|
+
|
723
|
+
# Update properties of this object
|
724
|
+
def update!(**args)
|
725
|
+
@per_device_status = args[:per_device_status] if args.key?(:per_device_status)
|
726
|
+
@success_count = args[:success_count] if args.key?(:success_count)
|
727
|
+
end
|
728
|
+
end
|
729
|
+
|
730
|
+
# An EMM's DPC ([device policy controller](http://developer.android.com/work/dpc/
|
731
|
+
# build-dpc.html)). Zero-touch enrollment installs a DPC (listed in the `
|
732
|
+
# Configuration`) on a device to maintain the customer's mobile policies. All
|
733
|
+
# the DPCs listed by the API support zero-touch enrollment and are available in
|
734
|
+
# Google Play.
|
735
|
+
class Dpc
|
736
|
+
include Google::Apis::Core::Hashable
|
737
|
+
|
738
|
+
# Output only. The title of the DPC app in Google Play. For example, _Google
|
739
|
+
# Apps Device Policy_. Useful in an application's user interface.
|
740
|
+
# Corresponds to the JSON property `dpcName`
|
741
|
+
# @return [String]
|
742
|
+
attr_accessor :dpc_name
|
743
|
+
|
744
|
+
# Output only. The API resource name in the format `customers/[CUSTOMER_ID]/dpcs/
|
745
|
+
# [DPC_ID]`. Assigned by the server. To maintain a reference to a DPC across
|
746
|
+
# customer accounts, persist and match the last path component (`DPC_ID`).
|
747
|
+
# Corresponds to the JSON property `name`
|
748
|
+
# @return [String]
|
749
|
+
attr_accessor :name
|
750
|
+
|
751
|
+
# Output only. The DPC's Android application ID that looks like a Java package
|
752
|
+
# name. Zero-touch enrollment installs the DPC app onto a device using this
|
753
|
+
# identifier.
|
754
|
+
# Corresponds to the JSON property `packageName`
|
755
|
+
# @return [String]
|
756
|
+
attr_accessor :package_name
|
757
|
+
|
758
|
+
def initialize(**args)
|
759
|
+
update!(**args)
|
760
|
+
end
|
761
|
+
|
762
|
+
# Update properties of this object
|
763
|
+
def update!(**args)
|
764
|
+
@dpc_name = args[:dpc_name] if args.key?(:dpc_name)
|
765
|
+
@name = args[:name] if args.key?(:name)
|
766
|
+
@package_name = args[:package_name] if args.key?(:package_name)
|
767
|
+
end
|
768
|
+
end
|
769
|
+
|
770
|
+
# A generic empty message that you can re-use to avoid defining duplicated empty
|
771
|
+
# messages in your APIs. A typical example is to use it as the request or the
|
772
|
+
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
773
|
+
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
774
|
+
# `Empty` is empty JSON object ````.
|
775
|
+
class Empty
|
776
|
+
include Google::Apis::Core::Hashable
|
777
|
+
|
778
|
+
def initialize(**args)
|
779
|
+
update!(**args)
|
780
|
+
end
|
781
|
+
|
782
|
+
# Update properties of this object
|
783
|
+
def update!(**args)
|
784
|
+
end
|
785
|
+
end
|
786
|
+
|
787
|
+
# Request to find devices.
|
788
|
+
class FindDevicesByDeviceIdentifierRequest
|
789
|
+
include Google::Apis::Core::Hashable
|
790
|
+
|
791
|
+
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
792
|
+
# understand requirements on identifier sets, read [Identifiers](https://
|
793
|
+
# developers.google.com/zero-touch/guides/identifiers).
|
794
|
+
# Corresponds to the JSON property `deviceIdentifier`
|
795
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
796
|
+
attr_accessor :device_identifier
|
797
|
+
|
798
|
+
# Required. The maximum number of devices to show in a page of results. Must be
|
799
|
+
# between 1 and 100 inclusive.
|
800
|
+
# Corresponds to the JSON property `limit`
|
801
|
+
# @return [Fixnum]
|
802
|
+
attr_accessor :limit
|
803
|
+
|
804
|
+
# A token specifying which result page to return.
|
805
|
+
# Corresponds to the JSON property `pageToken`
|
806
|
+
# @return [String]
|
807
|
+
attr_accessor :page_token
|
808
|
+
|
809
|
+
def initialize(**args)
|
810
|
+
update!(**args)
|
811
|
+
end
|
812
|
+
|
813
|
+
# Update properties of this object
|
814
|
+
def update!(**args)
|
815
|
+
@device_identifier = args[:device_identifier] if args.key?(:device_identifier)
|
816
|
+
@limit = args[:limit] if args.key?(:limit)
|
817
|
+
@page_token = args[:page_token] if args.key?(:page_token)
|
818
|
+
end
|
819
|
+
end
|
820
|
+
|
821
|
+
# Response containing found devices.
|
822
|
+
class FindDevicesByDeviceIdentifierResponse
|
823
|
+
include Google::Apis::Core::Hashable
|
824
|
+
|
825
|
+
# Found devices.
|
826
|
+
# Corresponds to the JSON property `devices`
|
827
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Device>]
|
828
|
+
attr_accessor :devices
|
829
|
+
|
830
|
+
# A token used to access the next page of results. Omitted if no further results
|
831
|
+
# are available.
|
832
|
+
# Corresponds to the JSON property `nextPageToken`
|
833
|
+
# @return [String]
|
834
|
+
attr_accessor :next_page_token
|
835
|
+
|
836
|
+
# The total count of items in the list irrespective of pagination.
|
837
|
+
# Corresponds to the JSON property `totalSize`
|
838
|
+
# @return [Fixnum]
|
839
|
+
attr_accessor :total_size
|
840
|
+
|
841
|
+
def initialize(**args)
|
842
|
+
update!(**args)
|
843
|
+
end
|
844
|
+
|
845
|
+
# Update properties of this object
|
846
|
+
def update!(**args)
|
847
|
+
@devices = args[:devices] if args.key?(:devices)
|
848
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
849
|
+
@total_size = args[:total_size] if args.key?(:total_size)
|
850
|
+
end
|
851
|
+
end
|
852
|
+
|
853
|
+
# Request to find devices by customers.
|
854
|
+
class FindDevicesByOwnerRequest
|
855
|
+
include Google::Apis::Core::Hashable
|
856
|
+
|
857
|
+
# Required. The list of customer IDs to search for.
|
858
|
+
# Corresponds to the JSON property `customerId`
|
859
|
+
# @return [Array<Fixnum>]
|
860
|
+
attr_accessor :customer_id
|
861
|
+
|
862
|
+
# Required. The maximum number of devices to show in a page of results. Must be
|
863
|
+
# between 1 and 100 inclusive.
|
864
|
+
# Corresponds to the JSON property `limit`
|
865
|
+
# @return [Fixnum]
|
866
|
+
attr_accessor :limit
|
867
|
+
|
868
|
+
# A token specifying which result page to return.
|
869
|
+
# Corresponds to the JSON property `pageToken`
|
870
|
+
# @return [String]
|
871
|
+
attr_accessor :page_token
|
872
|
+
|
873
|
+
# Required. The section type of the device's provisioning record.
|
874
|
+
# Corresponds to the JSON property `sectionType`
|
875
|
+
# @return [String]
|
876
|
+
attr_accessor :section_type
|
877
|
+
|
878
|
+
def initialize(**args)
|
879
|
+
update!(**args)
|
880
|
+
end
|
881
|
+
|
882
|
+
# Update properties of this object
|
883
|
+
def update!(**args)
|
884
|
+
@customer_id = args[:customer_id] if args.key?(:customer_id)
|
885
|
+
@limit = args[:limit] if args.key?(:limit)
|
886
|
+
@page_token = args[:page_token] if args.key?(:page_token)
|
887
|
+
@section_type = args[:section_type] if args.key?(:section_type)
|
888
|
+
end
|
889
|
+
end
|
890
|
+
|
891
|
+
# Response containing found devices.
|
892
|
+
class FindDevicesByOwnerResponse
|
893
|
+
include Google::Apis::Core::Hashable
|
894
|
+
|
895
|
+
# The customer's devices.
|
896
|
+
# Corresponds to the JSON property `devices`
|
897
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Device>]
|
898
|
+
attr_accessor :devices
|
899
|
+
|
900
|
+
# A token used to access the next page of results. Omitted if no further results
|
901
|
+
# are available.
|
902
|
+
# Corresponds to the JSON property `nextPageToken`
|
903
|
+
# @return [String]
|
904
|
+
attr_accessor :next_page_token
|
905
|
+
|
906
|
+
# The total count of items in the list irrespective of pagination.
|
907
|
+
# Corresponds to the JSON property `totalSize`
|
908
|
+
# @return [Fixnum]
|
909
|
+
attr_accessor :total_size
|
910
|
+
|
911
|
+
def initialize(**args)
|
912
|
+
update!(**args)
|
913
|
+
end
|
914
|
+
|
915
|
+
# Update properties of this object
|
916
|
+
def update!(**args)
|
917
|
+
@devices = args[:devices] if args.key?(:devices)
|
918
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
919
|
+
@total_size = args[:total_size] if args.key?(:total_size)
|
920
|
+
end
|
921
|
+
end
|
922
|
+
|
923
|
+
# Response message of all customers related to this partner.
|
924
|
+
class ListCustomersResponse
|
925
|
+
include Google::Apis::Core::Hashable
|
926
|
+
|
927
|
+
# List of customers related to this reseller partner.
|
928
|
+
# Corresponds to the JSON property `customers`
|
929
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Company>]
|
930
|
+
attr_accessor :customers
|
931
|
+
|
932
|
+
# A token to retrieve the next page of results. Omitted if no further results
|
933
|
+
# are available.
|
934
|
+
# Corresponds to the JSON property `nextPageToken`
|
935
|
+
# @return [String]
|
936
|
+
attr_accessor :next_page_token
|
937
|
+
|
938
|
+
# The total count of items in the list irrespective of pagination.
|
939
|
+
# Corresponds to the JSON property `totalSize`
|
940
|
+
# @return [Fixnum]
|
941
|
+
attr_accessor :total_size
|
942
|
+
|
943
|
+
def initialize(**args)
|
944
|
+
update!(**args)
|
945
|
+
end
|
946
|
+
|
947
|
+
# Update properties of this object
|
948
|
+
def update!(**args)
|
949
|
+
@customers = args[:customers] if args.key?(:customers)
|
950
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
951
|
+
@total_size = args[:total_size] if args.key?(:total_size)
|
952
|
+
end
|
953
|
+
end
|
954
|
+
|
955
|
+
# Response message to list customers of the vendor.
|
956
|
+
class ListVendorCustomersResponse
|
957
|
+
include Google::Apis::Core::Hashable
|
958
|
+
|
959
|
+
# List of customers of the vendor.
|
960
|
+
# Corresponds to the JSON property `customers`
|
961
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Company>]
|
962
|
+
attr_accessor :customers
|
963
|
+
|
964
|
+
# A token to retrieve the next page of results. Omitted if no further results
|
965
|
+
# are available.
|
966
|
+
# Corresponds to the JSON property `nextPageToken`
|
967
|
+
# @return [String]
|
968
|
+
attr_accessor :next_page_token
|
969
|
+
|
970
|
+
# The total count of items in the list irrespective of pagination.
|
971
|
+
# Corresponds to the JSON property `totalSize`
|
972
|
+
# @return [Fixnum]
|
973
|
+
attr_accessor :total_size
|
974
|
+
|
975
|
+
def initialize(**args)
|
976
|
+
update!(**args)
|
977
|
+
end
|
978
|
+
|
979
|
+
# Update properties of this object
|
980
|
+
def update!(**args)
|
981
|
+
@customers = args[:customers] if args.key?(:customers)
|
982
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
983
|
+
@total_size = args[:total_size] if args.key?(:total_size)
|
984
|
+
end
|
985
|
+
end
|
986
|
+
|
987
|
+
# Response message to list vendors of the partner.
|
988
|
+
class ListVendorsResponse
|
989
|
+
include Google::Apis::Core::Hashable
|
990
|
+
|
991
|
+
# A token to retrieve the next page of results. Omitted if no further results
|
992
|
+
# are available.
|
993
|
+
# Corresponds to the JSON property `nextPageToken`
|
994
|
+
# @return [String]
|
995
|
+
attr_accessor :next_page_token
|
996
|
+
|
997
|
+
# The total count of items in the list irrespective of pagination.
|
998
|
+
# Corresponds to the JSON property `totalSize`
|
999
|
+
# @return [Fixnum]
|
1000
|
+
attr_accessor :total_size
|
1001
|
+
|
1002
|
+
# List of vendors of the reseller partner. Fields `name`, `companyId` and `
|
1003
|
+
# companyName` are populated to the Company object.
|
1004
|
+
# Corresponds to the JSON property `vendors`
|
1005
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Company>]
|
1006
|
+
attr_accessor :vendors
|
1007
|
+
|
1008
|
+
def initialize(**args)
|
1009
|
+
update!(**args)
|
1010
|
+
end
|
1011
|
+
|
1012
|
+
# Update properties of this object
|
1013
|
+
def update!(**args)
|
1014
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
1015
|
+
@total_size = args[:total_size] if args.key?(:total_size)
|
1016
|
+
@vendors = args[:vendors] if args.key?(:vendors)
|
1017
|
+
end
|
1018
|
+
end
|
1019
|
+
|
1020
|
+
# This resource represents a long-running operation that is the result of a
|
1021
|
+
# network API call.
|
1022
|
+
class Operation
|
1023
|
+
include Google::Apis::Core::Hashable
|
1024
|
+
|
1025
|
+
# If the value is `false`, it means the operation is still in progress. If `true`
|
1026
|
+
# , the operation is completed, and either `error` or `response` is available.
|
1027
|
+
# Corresponds to the JSON property `done`
|
1028
|
+
# @return [Boolean]
|
1029
|
+
attr_accessor :done
|
1030
|
+
alias_method :done?, :done
|
1031
|
+
|
1032
|
+
# The `Status` type defines a logical error model that is suitable for different
|
1033
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
1034
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
1035
|
+
# data: error code, error message, and error details. You can find out more
|
1036
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
1037
|
+
# //cloud.google.com/apis/design/errors).
|
1038
|
+
# Corresponds to the JSON property `error`
|
1039
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::Status]
|
1040
|
+
attr_accessor :error
|
1041
|
+
|
1042
|
+
# This field will contain a `DevicesLongRunningOperationMetadata` object if the
|
1043
|
+
# operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
|
1044
|
+
# Corresponds to the JSON property `metadata`
|
1045
|
+
# @return [Hash<String,Object>]
|
1046
|
+
attr_accessor :metadata
|
1047
|
+
|
1048
|
+
# The server-assigned name, which is only unique within the same service that
|
1049
|
+
# originally returns it. If you use the default HTTP mapping, the `name` should
|
1050
|
+
# be a resource name ending with `operations/`unique_id``.
|
1051
|
+
# Corresponds to the JSON property `name`
|
1052
|
+
# @return [String]
|
1053
|
+
attr_accessor :name
|
1054
|
+
|
1055
|
+
# This field will contain a `DevicesLongRunningOperationResponse` object if the
|
1056
|
+
# operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
|
1057
|
+
# Corresponds to the JSON property `response`
|
1058
|
+
# @return [Hash<String,Object>]
|
1059
|
+
attr_accessor :response
|
1060
|
+
|
1061
|
+
def initialize(**args)
|
1062
|
+
update!(**args)
|
1063
|
+
end
|
1064
|
+
|
1065
|
+
# Update properties of this object
|
1066
|
+
def update!(**args)
|
1067
|
+
@done = args[:done] if args.key?(:done)
|
1068
|
+
@error = args[:error] if args.key?(:error)
|
1069
|
+
@metadata = args[:metadata] if args.key?(:metadata)
|
1070
|
+
@name = args[:name] if args.key?(:name)
|
1071
|
+
@response = args[:response] if args.key?(:response)
|
1072
|
+
end
|
1073
|
+
end
|
1074
|
+
|
1075
|
+
# A task for each device in the operation. Corresponds to each device change in
|
1076
|
+
# the request.
|
1077
|
+
class OperationPerDevice
|
1078
|
+
include Google::Apis::Core::Hashable
|
1079
|
+
|
1080
|
+
# Identifies one claim request.
|
1081
|
+
# Corresponds to the JSON property `claim`
|
1082
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::PartnerClaim]
|
1083
|
+
attr_accessor :claim
|
1084
|
+
|
1085
|
+
# Captures the processing status for each device in the operation.
|
1086
|
+
# Corresponds to the JSON property `result`
|
1087
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::PerDeviceStatusInBatch]
|
1088
|
+
attr_accessor :result
|
1089
|
+
|
1090
|
+
# Identifies one unclaim request.
|
1091
|
+
# Corresponds to the JSON property `unclaim`
|
1092
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::PartnerUnclaim]
|
1093
|
+
attr_accessor :unclaim
|
1094
|
+
|
1095
|
+
# Identifies metadata updates to one device.
|
1096
|
+
# Corresponds to the JSON property `updateMetadata`
|
1097
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::UpdateMetadataArguments]
|
1098
|
+
attr_accessor :update_metadata
|
1099
|
+
|
1100
|
+
def initialize(**args)
|
1101
|
+
update!(**args)
|
1102
|
+
end
|
1103
|
+
|
1104
|
+
# Update properties of this object
|
1105
|
+
def update!(**args)
|
1106
|
+
@claim = args[:claim] if args.key?(:claim)
|
1107
|
+
@result = args[:result] if args.key?(:result)
|
1108
|
+
@unclaim = args[:unclaim] if args.key?(:unclaim)
|
1109
|
+
@update_metadata = args[:update_metadata] if args.key?(:update_metadata)
|
1110
|
+
end
|
1111
|
+
end
|
1112
|
+
|
1113
|
+
# Identifies one claim request.
|
1114
|
+
class PartnerClaim
|
1115
|
+
include Google::Apis::Core::Hashable
|
1116
|
+
|
1117
|
+
# Required. The ID of the customer for whom the device is being claimed.
|
1118
|
+
# Corresponds to the JSON property `customerId`
|
1119
|
+
# @return [Fixnum]
|
1120
|
+
attr_accessor :customer_id
|
1121
|
+
|
1122
|
+
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
1123
|
+
# understand requirements on identifier sets, read [Identifiers](https://
|
1124
|
+
# developers.google.com/zero-touch/guides/identifiers).
|
1125
|
+
# Corresponds to the JSON property `deviceIdentifier`
|
1126
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
1127
|
+
attr_accessor :device_identifier
|
1128
|
+
|
1129
|
+
# Metadata entries that can be attached to a `Device`. To learn more, read [
|
1130
|
+
# Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
1131
|
+
# Corresponds to the JSON property `deviceMetadata`
|
1132
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
1133
|
+
attr_accessor :device_metadata
|
1134
|
+
|
1135
|
+
# Required. The section type of the device's provisioning record.
|
1136
|
+
# Corresponds to the JSON property `sectionType`
|
1137
|
+
# @return [String]
|
1138
|
+
attr_accessor :section_type
|
1139
|
+
|
1140
|
+
def initialize(**args)
|
1141
|
+
update!(**args)
|
1142
|
+
end
|
1143
|
+
|
1144
|
+
# Update properties of this object
|
1145
|
+
def update!(**args)
|
1146
|
+
@customer_id = args[:customer_id] if args.key?(:customer_id)
|
1147
|
+
@device_identifier = args[:device_identifier] if args.key?(:device_identifier)
|
1148
|
+
@device_metadata = args[:device_metadata] if args.key?(:device_metadata)
|
1149
|
+
@section_type = args[:section_type] if args.key?(:section_type)
|
1150
|
+
end
|
1151
|
+
end
|
1152
|
+
|
1153
|
+
# Identifies one unclaim request.
|
1154
|
+
class PartnerUnclaim
|
1155
|
+
include Google::Apis::Core::Hashable
|
1156
|
+
|
1157
|
+
# Required. Device ID of the device.
|
1158
|
+
# Corresponds to the JSON property `deviceId`
|
1159
|
+
# @return [Fixnum]
|
1160
|
+
attr_accessor :device_id
|
1161
|
+
|
1162
|
+
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
1163
|
+
# understand requirements on identifier sets, read [Identifiers](https://
|
1164
|
+
# developers.google.com/zero-touch/guides/identifiers).
|
1165
|
+
# Corresponds to the JSON property `deviceIdentifier`
|
1166
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
1167
|
+
attr_accessor :device_identifier
|
1168
|
+
|
1169
|
+
# Required. The section type of the device's provisioning record.
|
1170
|
+
# Corresponds to the JSON property `sectionType`
|
1171
|
+
# @return [String]
|
1172
|
+
attr_accessor :section_type
|
1173
|
+
|
1174
|
+
# Optional. The duration of the vacation unlock starting from when the request
|
1175
|
+
# is processed. (1 day is treated as 24 hours)
|
1176
|
+
# Corresponds to the JSON property `vacationModeDays`
|
1177
|
+
# @return [Fixnum]
|
1178
|
+
attr_accessor :vacation_mode_days
|
1179
|
+
|
1180
|
+
# Optional. The expiration time of the vacation unlock.
|
1181
|
+
# Corresponds to the JSON property `vacationModeExpireTime`
|
1182
|
+
# @return [String]
|
1183
|
+
attr_accessor :vacation_mode_expire_time
|
1184
|
+
|
1185
|
+
def initialize(**args)
|
1186
|
+
update!(**args)
|
1187
|
+
end
|
1188
|
+
|
1189
|
+
# Update properties of this object
|
1190
|
+
def update!(**args)
|
1191
|
+
@device_id = args[:device_id] if args.key?(:device_id)
|
1192
|
+
@device_identifier = args[:device_identifier] if args.key?(:device_identifier)
|
1193
|
+
@section_type = args[:section_type] if args.key?(:section_type)
|
1194
|
+
@vacation_mode_days = args[:vacation_mode_days] if args.key?(:vacation_mode_days)
|
1195
|
+
@vacation_mode_expire_time = args[:vacation_mode_expire_time] if args.key?(:vacation_mode_expire_time)
|
1196
|
+
end
|
1197
|
+
end
|
1198
|
+
|
1199
|
+
# Captures the processing status for each device in the operation.
|
1200
|
+
class PerDeviceStatusInBatch
|
1201
|
+
include Google::Apis::Core::Hashable
|
1202
|
+
|
1203
|
+
# If processing succeeds, the device ID of the device.
|
1204
|
+
# Corresponds to the JSON property `deviceId`
|
1205
|
+
# @return [Fixnum]
|
1206
|
+
attr_accessor :device_id
|
1207
|
+
|
1208
|
+
# If processing fails, the error type.
|
1209
|
+
# Corresponds to the JSON property `errorIdentifier`
|
1210
|
+
# @return [String]
|
1211
|
+
attr_accessor :error_identifier
|
1212
|
+
|
1213
|
+
# If processing fails, a developer message explaining what went wrong.
|
1214
|
+
# Corresponds to the JSON property `errorMessage`
|
1215
|
+
# @return [String]
|
1216
|
+
attr_accessor :error_message
|
1217
|
+
|
1218
|
+
# The result status of the device after processing.
|
1219
|
+
# Corresponds to the JSON property `status`
|
1220
|
+
# @return [String]
|
1221
|
+
attr_accessor :status
|
1222
|
+
|
1223
|
+
def initialize(**args)
|
1224
|
+
update!(**args)
|
1225
|
+
end
|
1226
|
+
|
1227
|
+
# Update properties of this object
|
1228
|
+
def update!(**args)
|
1229
|
+
@device_id = args[:device_id] if args.key?(:device_id)
|
1230
|
+
@error_identifier = args[:error_identifier] if args.key?(:error_identifier)
|
1231
|
+
@error_message = args[:error_message] if args.key?(:error_message)
|
1232
|
+
@status = args[:status] if args.key?(:status)
|
1233
|
+
end
|
1234
|
+
end
|
1235
|
+
|
1236
|
+
# The `Status` type defines a logical error model that is suitable for different
|
1237
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
1238
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
1239
|
+
# data: error code, error message, and error details. You can find out more
|
1240
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
1241
|
+
# //cloud.google.com/apis/design/errors).
|
1242
|
+
class Status
|
1243
|
+
include Google::Apis::Core::Hashable
|
1244
|
+
|
1245
|
+
# The status code, which should be an enum value of google.rpc.Code.
|
1246
|
+
# Corresponds to the JSON property `code`
|
1247
|
+
# @return [Fixnum]
|
1248
|
+
attr_accessor :code
|
1249
|
+
|
1250
|
+
# A list of messages that carry the error details. There is a common set of
|
1251
|
+
# message types for APIs to use.
|
1252
|
+
# Corresponds to the JSON property `details`
|
1253
|
+
# @return [Array<Hash<String,Object>>]
|
1254
|
+
attr_accessor :details
|
1255
|
+
|
1256
|
+
# A developer-facing error message, which should be in English. Any user-facing
|
1257
|
+
# error message should be localized and sent in the google.rpc.Status.details
|
1258
|
+
# field, or localized by the client.
|
1259
|
+
# Corresponds to the JSON property `message`
|
1260
|
+
# @return [String]
|
1261
|
+
attr_accessor :message
|
1262
|
+
|
1263
|
+
def initialize(**args)
|
1264
|
+
update!(**args)
|
1265
|
+
end
|
1266
|
+
|
1267
|
+
# Update properties of this object
|
1268
|
+
def update!(**args)
|
1269
|
+
@code = args[:code] if args.key?(:code)
|
1270
|
+
@details = args[:details] if args.key?(:details)
|
1271
|
+
@message = args[:message] if args.key?(:message)
|
1272
|
+
end
|
1273
|
+
end
|
1274
|
+
|
1275
|
+
# Request message to unclaim a device.
|
1276
|
+
class UnclaimDeviceRequest
|
1277
|
+
include Google::Apis::Core::Hashable
|
1278
|
+
|
1279
|
+
# Required. The device ID returned by `ClaimDevice`.
|
1280
|
+
# Corresponds to the JSON property `deviceId`
|
1281
|
+
# @return [Fixnum]
|
1282
|
+
attr_accessor :device_id
|
1283
|
+
|
1284
|
+
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
1285
|
+
# understand requirements on identifier sets, read [Identifiers](https://
|
1286
|
+
# developers.google.com/zero-touch/guides/identifiers).
|
1287
|
+
# Corresponds to the JSON property `deviceIdentifier`
|
1288
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
1289
|
+
attr_accessor :device_identifier
|
1290
|
+
|
1291
|
+
# Required. The section type of the device's provisioning record.
|
1292
|
+
# Corresponds to the JSON property `sectionType`
|
1293
|
+
# @return [String]
|
1294
|
+
attr_accessor :section_type
|
1295
|
+
|
1296
|
+
# The duration of the vacation unlock starting from when the request is
|
1297
|
+
# processed. (1 day is treated as 24 hours)
|
1298
|
+
# Corresponds to the JSON property `vacationModeDays`
|
1299
|
+
# @return [Fixnum]
|
1300
|
+
attr_accessor :vacation_mode_days
|
1301
|
+
|
1302
|
+
# The expiration time of the vacation unlock.
|
1303
|
+
# Corresponds to the JSON property `vacationModeExpireTime`
|
1304
|
+
# @return [String]
|
1305
|
+
attr_accessor :vacation_mode_expire_time
|
1306
|
+
|
1307
|
+
def initialize(**args)
|
1308
|
+
update!(**args)
|
1309
|
+
end
|
1310
|
+
|
1311
|
+
# Update properties of this object
|
1312
|
+
def update!(**args)
|
1313
|
+
@device_id = args[:device_id] if args.key?(:device_id)
|
1314
|
+
@device_identifier = args[:device_identifier] if args.key?(:device_identifier)
|
1315
|
+
@section_type = args[:section_type] if args.key?(:section_type)
|
1316
|
+
@vacation_mode_days = args[:vacation_mode_days] if args.key?(:vacation_mode_days)
|
1317
|
+
@vacation_mode_expire_time = args[:vacation_mode_expire_time] if args.key?(:vacation_mode_expire_time)
|
1318
|
+
end
|
1319
|
+
end
|
1320
|
+
|
1321
|
+
# Request to unclaim devices asynchronously in batch.
|
1322
|
+
class UnclaimDevicesRequest
|
1323
|
+
include Google::Apis::Core::Hashable
|
1324
|
+
|
1325
|
+
# Required. The list of devices to unclaim.
|
1326
|
+
# Corresponds to the JSON property `unclaims`
|
1327
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::PartnerUnclaim>]
|
1328
|
+
attr_accessor :unclaims
|
1329
|
+
|
1330
|
+
def initialize(**args)
|
1331
|
+
update!(**args)
|
1332
|
+
end
|
1333
|
+
|
1334
|
+
# Update properties of this object
|
1335
|
+
def update!(**args)
|
1336
|
+
@unclaims = args[:unclaims] if args.key?(:unclaims)
|
1337
|
+
end
|
1338
|
+
end
|
1339
|
+
|
1340
|
+
# Request to update device metadata in batch.
|
1341
|
+
class UpdateDeviceMetadataInBatchRequest
|
1342
|
+
include Google::Apis::Core::Hashable
|
1343
|
+
|
1344
|
+
# Required. The list of metadata updates.
|
1345
|
+
# Corresponds to the JSON property `updates`
|
1346
|
+
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::UpdateMetadataArguments>]
|
1347
|
+
attr_accessor :updates
|
1348
|
+
|
1349
|
+
def initialize(**args)
|
1350
|
+
update!(**args)
|
1351
|
+
end
|
1352
|
+
|
1353
|
+
# Update properties of this object
|
1354
|
+
def update!(**args)
|
1355
|
+
@updates = args[:updates] if args.key?(:updates)
|
1356
|
+
end
|
1357
|
+
end
|
1358
|
+
|
1359
|
+
# Request to set metadata for a device.
|
1360
|
+
class UpdateDeviceMetadataRequest
|
1361
|
+
include Google::Apis::Core::Hashable
|
1362
|
+
|
1363
|
+
# Metadata entries that can be attached to a `Device`. To learn more, read [
|
1364
|
+
# Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
1365
|
+
# Corresponds to the JSON property `deviceMetadata`
|
1366
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
1367
|
+
attr_accessor :device_metadata
|
1368
|
+
|
1369
|
+
def initialize(**args)
|
1370
|
+
update!(**args)
|
1371
|
+
end
|
1372
|
+
|
1373
|
+
# Update properties of this object
|
1374
|
+
def update!(**args)
|
1375
|
+
@device_metadata = args[:device_metadata] if args.key?(:device_metadata)
|
1376
|
+
end
|
1377
|
+
end
|
1378
|
+
|
1379
|
+
# Identifies metadata updates to one device.
|
1380
|
+
class UpdateMetadataArguments
|
1381
|
+
include Google::Apis::Core::Hashable
|
1382
|
+
|
1383
|
+
# Required. Device ID of the device.
|
1384
|
+
# Corresponds to the JSON property `deviceId`
|
1385
|
+
# @return [Fixnum]
|
1386
|
+
attr_accessor :device_id
|
1387
|
+
|
1388
|
+
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
1389
|
+
# understand requirements on identifier sets, read [Identifiers](https://
|
1390
|
+
# developers.google.com/zero-touch/guides/identifiers).
|
1391
|
+
# Corresponds to the JSON property `deviceIdentifier`
|
1392
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
1393
|
+
attr_accessor :device_identifier
|
1394
|
+
|
1395
|
+
# Metadata entries that can be attached to a `Device`. To learn more, read [
|
1396
|
+
# Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
1397
|
+
# Corresponds to the JSON property `deviceMetadata`
|
1398
|
+
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
1399
|
+
attr_accessor :device_metadata
|
1400
|
+
|
1401
|
+
def initialize(**args)
|
1402
|
+
update!(**args)
|
1403
|
+
end
|
1404
|
+
|
1405
|
+
# Update properties of this object
|
1406
|
+
def update!(**args)
|
1407
|
+
@device_id = args[:device_id] if args.key?(:device_id)
|
1408
|
+
@device_identifier = args[:device_identifier] if args.key?(:device_identifier)
|
1409
|
+
@device_metadata = args[:device_metadata] if args.key?(:device_metadata)
|
1410
|
+
end
|
1411
|
+
end
|
1412
|
+
end
|
1413
|
+
end
|
1414
|
+
end
|