google-apis-reseller_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-reseller_v1.rb +15 -0
- data/lib/google/apis/reseller_v1.rb +40 -0
- data/lib/google/apis/reseller_v1/classes.rb +685 -0
- data/lib/google/apis/reseller_v1/gem_version.rb +28 -0
- data/lib/google/apis/reseller_v1/representations.rb +253 -0
- data/lib/google/apis/reseller_v1/service.rb +727 -0
- metadata +76 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 9977eb136ee716d7aa2ae8d9d5758eba4b80bbbdbedb0c02ab5713872a152c9e
|
4
|
+
data.tar.gz: 29121e3d97065a3b8cbbab53b522588f05c292e8f36f882c40c7a0d8631738ad
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 1e254e26f615cbe832d49ab203b6f8b95ffca3e49cd287ba956492d25777075919e5778d3214c9aecddd0e7323f13a0dae21c4ce8c7b6497a80017c54602822a
|
7
|
+
data.tar.gz: 3407cc51bb178020d5de6644366d88cf73fdcf2e0cd39c413656c21a2a782222a705c7bc78c0bce764f49aeda9659d1f6ac1f8e1112b7d74ed11053a48751229
|
data/.yardopts
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
--hide-void-return
|
2
|
+
--no-private
|
3
|
+
--verbose
|
4
|
+
--title=google-apis-reseller_v1
|
5
|
+
--markup-provider=redcarpet
|
6
|
+
--markup=markdown
|
7
|
+
--main OVERVIEW.md
|
8
|
+
lib/google/apis/reseller_v1/*.rb
|
9
|
+
lib/google/apis/reseller_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 Google Workspace Reseller API
|
2
|
+
|
3
|
+
This is a simple client library for version V1 of the Google Workspace Reseller 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/reseller.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-reseller_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-reseller_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/reseller_v1"
|
49
|
+
|
50
|
+
# Create a client object
|
51
|
+
client = Google::Apis::ResellerV1::ResellerService.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 Reseller service in particular.)
|
67
|
+
|
68
|
+
For reference information on specific calls in the Google Workspace Reseller API, see the {Google::Apis::ResellerV1::ResellerService 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-reseller_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/google-apps/reseller/) 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/reseller_v1"
|
@@ -0,0 +1,40 @@
|
|
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/reseller_v1/service.rb'
|
16
|
+
require 'google/apis/reseller_v1/classes.rb'
|
17
|
+
require 'google/apis/reseller_v1/representations.rb'
|
18
|
+
require 'google/apis/reseller_v1/gem_version.rb'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
# Google Workspace Reseller API
|
23
|
+
#
|
24
|
+
# Perform common functions that are available on the Channel Services console at
|
25
|
+
# scale, like placing orders and viewing customer information
|
26
|
+
#
|
27
|
+
# @see https://developers.google.com/google-apps/reseller/
|
28
|
+
module ResellerV1
|
29
|
+
# Version of the Google Workspace Reseller API this client connects to.
|
30
|
+
# This is NOT the gem version.
|
31
|
+
VERSION = 'V1'
|
32
|
+
|
33
|
+
# Manage users on your domain
|
34
|
+
AUTH_APPS_ORDER = 'https://www.googleapis.com/auth/apps.order'
|
35
|
+
|
36
|
+
# Manage users on your domain
|
37
|
+
AUTH_APPS_ORDER_READONLY = 'https://www.googleapis.com/auth/apps.order.readonly'
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,685 @@
|
|
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 ResellerV1
|
24
|
+
|
25
|
+
# JSON template for address of a customer.
|
26
|
+
class Address
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
# A customer's physical address. An address can be composed of one to three
|
30
|
+
# lines. The addressline2 and addressLine3 are optional.
|
31
|
+
# Corresponds to the JSON property `addressLine1`
|
32
|
+
# @return [String]
|
33
|
+
attr_accessor :address_line1
|
34
|
+
|
35
|
+
# Line 2 of the address.
|
36
|
+
# Corresponds to the JSON property `addressLine2`
|
37
|
+
# @return [String]
|
38
|
+
attr_accessor :address_line2
|
39
|
+
|
40
|
+
# Line 3 of the address.
|
41
|
+
# Corresponds to the JSON property `addressLine3`
|
42
|
+
# @return [String]
|
43
|
+
attr_accessor :address_line3
|
44
|
+
|
45
|
+
# The customer contact's name. This is required.
|
46
|
+
# Corresponds to the JSON property `contactName`
|
47
|
+
# @return [String]
|
48
|
+
attr_accessor :contact_name
|
49
|
+
|
50
|
+
# For countryCode information, see the ISO 3166 country code elements. Verify
|
51
|
+
# that country is approved for resale of Google products. This property is
|
52
|
+
# required when creating a new customer.
|
53
|
+
# Corresponds to the JSON property `countryCode`
|
54
|
+
# @return [String]
|
55
|
+
attr_accessor :country_code
|
56
|
+
|
57
|
+
# Identifies the resource as a customer address. Value: customers#address
|
58
|
+
# Corresponds to the JSON property `kind`
|
59
|
+
# @return [String]
|
60
|
+
attr_accessor :kind
|
61
|
+
|
62
|
+
# An example of a locality value is the city of San Francisco.
|
63
|
+
# Corresponds to the JSON property `locality`
|
64
|
+
# @return [String]
|
65
|
+
attr_accessor :locality
|
66
|
+
|
67
|
+
# The company or company division name. This is required.
|
68
|
+
# Corresponds to the JSON property `organizationName`
|
69
|
+
# @return [String]
|
70
|
+
attr_accessor :organization_name
|
71
|
+
|
72
|
+
# A postalCode example is a postal zip code such as 94043. This property is
|
73
|
+
# required when creating a new customer.
|
74
|
+
# Corresponds to the JSON property `postalCode`
|
75
|
+
# @return [String]
|
76
|
+
attr_accessor :postal_code
|
77
|
+
|
78
|
+
# An example of a region value is CA for the state of California.
|
79
|
+
# Corresponds to the JSON property `region`
|
80
|
+
# @return [String]
|
81
|
+
attr_accessor :region
|
82
|
+
|
83
|
+
def initialize(**args)
|
84
|
+
update!(**args)
|
85
|
+
end
|
86
|
+
|
87
|
+
# Update properties of this object
|
88
|
+
def update!(**args)
|
89
|
+
@address_line1 = args[:address_line1] if args.key?(:address_line1)
|
90
|
+
@address_line2 = args[:address_line2] if args.key?(:address_line2)
|
91
|
+
@address_line3 = args[:address_line3] if args.key?(:address_line3)
|
92
|
+
@contact_name = args[:contact_name] if args.key?(:contact_name)
|
93
|
+
@country_code = args[:country_code] if args.key?(:country_code)
|
94
|
+
@kind = args[:kind] if args.key?(:kind)
|
95
|
+
@locality = args[:locality] if args.key?(:locality)
|
96
|
+
@organization_name = args[:organization_name] if args.key?(:organization_name)
|
97
|
+
@postal_code = args[:postal_code] if args.key?(:postal_code)
|
98
|
+
@region = args[:region] if args.key?(:region)
|
99
|
+
end
|
100
|
+
end
|
101
|
+
|
102
|
+
# JSON template for the ChangePlan rpc request.
|
103
|
+
class ChangePlanRequest
|
104
|
+
include Google::Apis::Core::Hashable
|
105
|
+
|
106
|
+
# Google-issued code (100 char max) for discounted pricing on subscription plans.
|
107
|
+
# Deal code must be included in changePlan request in order to receive
|
108
|
+
# discounted rate. This property is optional. If a deal code has already been
|
109
|
+
# added to a subscription, this property may be left empty and the existing
|
110
|
+
# discounted rate will still apply (if not empty, only provide the deal code
|
111
|
+
# that is already present on the subscription). If a deal code has never been
|
112
|
+
# added to a subscription and this property is left blank, regular pricing will
|
113
|
+
# apply.
|
114
|
+
# Corresponds to the JSON property `dealCode`
|
115
|
+
# @return [String]
|
116
|
+
attr_accessor :deal_code
|
117
|
+
|
118
|
+
# Identifies the resource as a subscription change plan request. Value:
|
119
|
+
# subscriptions#changePlanRequest
|
120
|
+
# Corresponds to the JSON property `kind`
|
121
|
+
# @return [String]
|
122
|
+
attr_accessor :kind
|
123
|
+
|
124
|
+
# The planName property is required. This is the name of the subscription's
|
125
|
+
# payment plan. For more information about the Google payment plans, see API
|
126
|
+
# concepts. Possible values are: - ANNUAL_MONTHLY_PAY - The annual commitment
|
127
|
+
# plan with monthly payments *Caution: *ANNUAL_MONTHLY_PAY is returned as ANNUAL
|
128
|
+
# in all API responses. - ANNUAL_YEARLY_PAY - The annual commitment plan with
|
129
|
+
# yearly payments - FLEXIBLE - The flexible plan - TRIAL - The 30-day free trial
|
130
|
+
# plan
|
131
|
+
# Corresponds to the JSON property `planName`
|
132
|
+
# @return [String]
|
133
|
+
attr_accessor :plan_name
|
134
|
+
|
135
|
+
# This is an optional property. This purchase order (PO) information is for
|
136
|
+
# resellers to use for their company tracking usage. If a purchaseOrderId value
|
137
|
+
# is given it appears in the API responses and shows up in the invoice. The
|
138
|
+
# property accepts up to 80 plain text characters.
|
139
|
+
# Corresponds to the JSON property `purchaseOrderId`
|
140
|
+
# @return [String]
|
141
|
+
attr_accessor :purchase_order_id
|
142
|
+
|
143
|
+
# JSON template for subscription seats.
|
144
|
+
# Corresponds to the JSON property `seats`
|
145
|
+
# @return [Google::Apis::ResellerV1::Seats]
|
146
|
+
attr_accessor :seats
|
147
|
+
|
148
|
+
def initialize(**args)
|
149
|
+
update!(**args)
|
150
|
+
end
|
151
|
+
|
152
|
+
# Update properties of this object
|
153
|
+
def update!(**args)
|
154
|
+
@deal_code = args[:deal_code] if args.key?(:deal_code)
|
155
|
+
@kind = args[:kind] if args.key?(:kind)
|
156
|
+
@plan_name = args[:plan_name] if args.key?(:plan_name)
|
157
|
+
@purchase_order_id = args[:purchase_order_id] if args.key?(:purchase_order_id)
|
158
|
+
@seats = args[:seats] if args.key?(:seats)
|
159
|
+
end
|
160
|
+
end
|
161
|
+
|
162
|
+
# JSON template for a customer.
|
163
|
+
class Customer
|
164
|
+
include Google::Apis::Core::Hashable
|
165
|
+
|
166
|
+
# Like the "Customer email" in the reseller tools, this email is the secondary
|
167
|
+
# contact used if something happens to the customer's service such as service
|
168
|
+
# outage or a security issue. This property is required when creating a new
|
169
|
+
# customer and should not use the same domain as customerDomain .
|
170
|
+
# Corresponds to the JSON property `alternateEmail`
|
171
|
+
# @return [String]
|
172
|
+
attr_accessor :alternate_email
|
173
|
+
|
174
|
+
# The customer's primary domain name string. customerDomain is required when
|
175
|
+
# creating a new customer. Do not include the www prefix in the domain when
|
176
|
+
# adding a customer.
|
177
|
+
# Corresponds to the JSON property `customerDomain`
|
178
|
+
# @return [String]
|
179
|
+
attr_accessor :customer_domain
|
180
|
+
|
181
|
+
# Whether the customer's primary domain has been verified.
|
182
|
+
# Corresponds to the JSON property `customerDomainVerified`
|
183
|
+
# @return [Boolean]
|
184
|
+
attr_accessor :customer_domain_verified
|
185
|
+
alias_method :customer_domain_verified?, :customer_domain_verified
|
186
|
+
|
187
|
+
# This property will always be returned in a response as the unique identifier
|
188
|
+
# generated by Google. In a request, this property can be either the primary
|
189
|
+
# domain or the unique identifier generated by Google.
|
190
|
+
# Corresponds to the JSON property `customerId`
|
191
|
+
# @return [String]
|
192
|
+
attr_accessor :customer_id
|
193
|
+
|
194
|
+
# Identifies the resource as a customer. Value: reseller#customer
|
195
|
+
# Corresponds to the JSON property `kind`
|
196
|
+
# @return [String]
|
197
|
+
attr_accessor :kind
|
198
|
+
|
199
|
+
# Customer contact phone number. Must start with "+" followed by the country
|
200
|
+
# code. The rest of the number can be contiguous numbers or respect the phone
|
201
|
+
# local format conventions, but it must be a real phone number and not, for
|
202
|
+
# example, "123". This field is silently ignored if invalid.
|
203
|
+
# Corresponds to the JSON property `phoneNumber`
|
204
|
+
# @return [String]
|
205
|
+
attr_accessor :phone_number
|
206
|
+
|
207
|
+
# JSON template for address of a customer.
|
208
|
+
# Corresponds to the JSON property `postalAddress`
|
209
|
+
# @return [Google::Apis::ResellerV1::Address]
|
210
|
+
attr_accessor :postal_address
|
211
|
+
|
212
|
+
# URL to customer's Admin console dashboard. The read-only URL is generated by
|
213
|
+
# the API service. This is used if your client application requires the customer
|
214
|
+
# to complete a task in the Admin console.
|
215
|
+
# Corresponds to the JSON property `resourceUiUrl`
|
216
|
+
# @return [String]
|
217
|
+
attr_accessor :resource_ui_url
|
218
|
+
|
219
|
+
def initialize(**args)
|
220
|
+
update!(**args)
|
221
|
+
end
|
222
|
+
|
223
|
+
# Update properties of this object
|
224
|
+
def update!(**args)
|
225
|
+
@alternate_email = args[:alternate_email] if args.key?(:alternate_email)
|
226
|
+
@customer_domain = args[:customer_domain] if args.key?(:customer_domain)
|
227
|
+
@customer_domain_verified = args[:customer_domain_verified] if args.key?(:customer_domain_verified)
|
228
|
+
@customer_id = args[:customer_id] if args.key?(:customer_id)
|
229
|
+
@kind = args[:kind] if args.key?(:kind)
|
230
|
+
@phone_number = args[:phone_number] if args.key?(:phone_number)
|
231
|
+
@postal_address = args[:postal_address] if args.key?(:postal_address)
|
232
|
+
@resource_ui_url = args[:resource_ui_url] if args.key?(:resource_ui_url)
|
233
|
+
end
|
234
|
+
end
|
235
|
+
|
236
|
+
# JSON template for a subscription renewal settings.
|
237
|
+
class RenewalSettings
|
238
|
+
include Google::Apis::Core::Hashable
|
239
|
+
|
240
|
+
# Identifies the resource as a subscription renewal setting. Value:
|
241
|
+
# subscriptions#renewalSettings
|
242
|
+
# Corresponds to the JSON property `kind`
|
243
|
+
# @return [String]
|
244
|
+
attr_accessor :kind
|
245
|
+
|
246
|
+
# Renewal settings for the annual commitment plan. For more detailed information,
|
247
|
+
# see renewal options in the administrator help center. When renewing a
|
248
|
+
# subscription, the renewalType is a required property.
|
249
|
+
# Corresponds to the JSON property `renewalType`
|
250
|
+
# @return [String]
|
251
|
+
attr_accessor :renewal_type
|
252
|
+
|
253
|
+
def initialize(**args)
|
254
|
+
update!(**args)
|
255
|
+
end
|
256
|
+
|
257
|
+
# Update properties of this object
|
258
|
+
def update!(**args)
|
259
|
+
@kind = args[:kind] if args.key?(:kind)
|
260
|
+
@renewal_type = args[:renewal_type] if args.key?(:renewal_type)
|
261
|
+
end
|
262
|
+
end
|
263
|
+
|
264
|
+
# JSON template for resellernotify getwatchdetails response.
|
265
|
+
class ResellernotifyGetwatchdetailsResponse
|
266
|
+
include Google::Apis::Core::Hashable
|
267
|
+
|
268
|
+
# List of registered service accounts.
|
269
|
+
# Corresponds to the JSON property `serviceAccountEmailAddresses`
|
270
|
+
# @return [Array<String>]
|
271
|
+
attr_accessor :service_account_email_addresses
|
272
|
+
|
273
|
+
# Topic name of the PubSub
|
274
|
+
# Corresponds to the JSON property `topicName`
|
275
|
+
# @return [String]
|
276
|
+
attr_accessor :topic_name
|
277
|
+
|
278
|
+
def initialize(**args)
|
279
|
+
update!(**args)
|
280
|
+
end
|
281
|
+
|
282
|
+
# Update properties of this object
|
283
|
+
def update!(**args)
|
284
|
+
@service_account_email_addresses = args[:service_account_email_addresses] if args.key?(:service_account_email_addresses)
|
285
|
+
@topic_name = args[:topic_name] if args.key?(:topic_name)
|
286
|
+
end
|
287
|
+
end
|
288
|
+
|
289
|
+
# JSON template for resellernotify response.
|
290
|
+
class ResellernotifyResource
|
291
|
+
include Google::Apis::Core::Hashable
|
292
|
+
|
293
|
+
# Topic name of the PubSub
|
294
|
+
# Corresponds to the JSON property `topicName`
|
295
|
+
# @return [String]
|
296
|
+
attr_accessor :topic_name
|
297
|
+
|
298
|
+
def initialize(**args)
|
299
|
+
update!(**args)
|
300
|
+
end
|
301
|
+
|
302
|
+
# Update properties of this object
|
303
|
+
def update!(**args)
|
304
|
+
@topic_name = args[:topic_name] if args.key?(:topic_name)
|
305
|
+
end
|
306
|
+
end
|
307
|
+
|
308
|
+
# JSON template for subscription seats.
|
309
|
+
class Seats
|
310
|
+
include Google::Apis::Core::Hashable
|
311
|
+
|
312
|
+
# Identifies the resource as a subscription seat setting. Value: subscriptions#
|
313
|
+
# seats
|
314
|
+
# Corresponds to the JSON property `kind`
|
315
|
+
# @return [String]
|
316
|
+
attr_accessor :kind
|
317
|
+
|
318
|
+
# Read-only field containing the current number of users that are assigned a
|
319
|
+
# license for the product defined in skuId. This field's value is equivalent to
|
320
|
+
# the numerical count of users returned by the Enterprise License Manager API
|
321
|
+
# method: listForProductAndSku
|
322
|
+
# Corresponds to the JSON property `licensedNumberOfSeats`
|
323
|
+
# @return [Fixnum]
|
324
|
+
attr_accessor :licensed_number_of_seats
|
325
|
+
|
326
|
+
# This is a required property and is exclusive to subscriptions with FLEXIBLE or
|
327
|
+
# TRIAL plans. This property sets the maximum number of licensed users allowed
|
328
|
+
# on a subscription. This quantity can be increased up to the maximum limit
|
329
|
+
# defined in the reseller's contract. The minimum quantity is the current number
|
330
|
+
# of users in the customer account. *Note: *G Suite subscriptions automatically
|
331
|
+
# assign a license to every user.
|
332
|
+
# Corresponds to the JSON property `maximumNumberOfSeats`
|
333
|
+
# @return [Fixnum]
|
334
|
+
attr_accessor :maximum_number_of_seats
|
335
|
+
|
336
|
+
# This is a required property and is exclusive to subscriptions with
|
337
|
+
# ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum
|
338
|
+
# number of licenses assignable to users on a subscription. The reseller can add
|
339
|
+
# more licenses, but once set, the numberOfSeats cannot be reduced until renewal.
|
340
|
+
# The reseller is invoiced based on the numberOfSeats value regardless of how
|
341
|
+
# many of these user licenses are assigned. *Note: *G Suite subscriptions
|
342
|
+
# automatically assign a license to every user.
|
343
|
+
# Corresponds to the JSON property `numberOfSeats`
|
344
|
+
# @return [Fixnum]
|
345
|
+
attr_accessor :number_of_seats
|
346
|
+
|
347
|
+
def initialize(**args)
|
348
|
+
update!(**args)
|
349
|
+
end
|
350
|
+
|
351
|
+
# Update properties of this object
|
352
|
+
def update!(**args)
|
353
|
+
@kind = args[:kind] if args.key?(:kind)
|
354
|
+
@licensed_number_of_seats = args[:licensed_number_of_seats] if args.key?(:licensed_number_of_seats)
|
355
|
+
@maximum_number_of_seats = args[:maximum_number_of_seats] if args.key?(:maximum_number_of_seats)
|
356
|
+
@number_of_seats = args[:number_of_seats] if args.key?(:number_of_seats)
|
357
|
+
end
|
358
|
+
end
|
359
|
+
|
360
|
+
# JSON template for a subscription.
|
361
|
+
class Subscription
|
362
|
+
include Google::Apis::Core::Hashable
|
363
|
+
|
364
|
+
# Read-only field that returns the current billing method for a subscription.
|
365
|
+
# Corresponds to the JSON property `billingMethod`
|
366
|
+
# @return [String]
|
367
|
+
attr_accessor :billing_method
|
368
|
+
|
369
|
+
# The creationTime property is the date when subscription was created. It is in
|
370
|
+
# milliseconds using the Epoch format. See an example Epoch converter.
|
371
|
+
# Corresponds to the JSON property `creationTime`
|
372
|
+
# @return [Fixnum]
|
373
|
+
attr_accessor :creation_time
|
374
|
+
|
375
|
+
# Primary domain name of the customer
|
376
|
+
# Corresponds to the JSON property `customerDomain`
|
377
|
+
# @return [String]
|
378
|
+
attr_accessor :customer_domain
|
379
|
+
|
380
|
+
# This property will always be returned in a response as the unique identifier
|
381
|
+
# generated by Google. In a request, this property can be either the primary
|
382
|
+
# domain or the unique identifier generated by Google.
|
383
|
+
# Corresponds to the JSON property `customerId`
|
384
|
+
# @return [String]
|
385
|
+
attr_accessor :customer_id
|
386
|
+
|
387
|
+
# Google-issued code (100 char max) for discounted pricing on subscription plans.
|
388
|
+
# Deal code must be included in insert requests in order to receive discounted
|
389
|
+
# rate. This property is optional, regular pricing applies if left empty.
|
390
|
+
# Corresponds to the JSON property `dealCode`
|
391
|
+
# @return [String]
|
392
|
+
attr_accessor :deal_code
|
393
|
+
|
394
|
+
# Identifies the resource as a Subscription. Value: reseller#subscription
|
395
|
+
# Corresponds to the JSON property `kind`
|
396
|
+
# @return [String]
|
397
|
+
attr_accessor :kind
|
398
|
+
|
399
|
+
# The plan property is required. In this version of the API, the G Suite plans
|
400
|
+
# are the flexible plan, annual commitment plan, and the 30-day free trial plan.
|
401
|
+
# For more information about the API"s payment plans, see the API concepts.
|
402
|
+
# Corresponds to the JSON property `plan`
|
403
|
+
# @return [Google::Apis::ResellerV1::Subscription::Plan]
|
404
|
+
attr_accessor :plan
|
405
|
+
|
406
|
+
# This is an optional property. This purchase order (PO) information is for
|
407
|
+
# resellers to use for their company tracking usage. If a purchaseOrderId value
|
408
|
+
# is given it appears in the API responses and shows up in the invoice. The
|
409
|
+
# property accepts up to 80 plain text characters.
|
410
|
+
# Corresponds to the JSON property `purchaseOrderId`
|
411
|
+
# @return [String]
|
412
|
+
attr_accessor :purchase_order_id
|
413
|
+
|
414
|
+
# JSON template for a subscription renewal settings.
|
415
|
+
# Corresponds to the JSON property `renewalSettings`
|
416
|
+
# @return [Google::Apis::ResellerV1::RenewalSettings]
|
417
|
+
attr_accessor :renewal_settings
|
418
|
+
|
419
|
+
# URL to customer's Subscriptions page in the Admin console. The read-only URL
|
420
|
+
# is generated by the API service. This is used if your client application
|
421
|
+
# requires the customer to complete a task using the Subscriptions page in the
|
422
|
+
# Admin console.
|
423
|
+
# Corresponds to the JSON property `resourceUiUrl`
|
424
|
+
# @return [String]
|
425
|
+
attr_accessor :resource_ui_url
|
426
|
+
|
427
|
+
# JSON template for subscription seats.
|
428
|
+
# Corresponds to the JSON property `seats`
|
429
|
+
# @return [Google::Apis::ResellerV1::Seats]
|
430
|
+
attr_accessor :seats
|
431
|
+
|
432
|
+
# A required property. The skuId is a unique system identifier for a product's
|
433
|
+
# SKU assigned to a customer in the subscription. For products and SKUs
|
434
|
+
# available in this version of the API, see Product and SKU IDs.
|
435
|
+
# Corresponds to the JSON property `skuId`
|
436
|
+
# @return [String]
|
437
|
+
attr_accessor :sku_id
|
438
|
+
|
439
|
+
# Read-only external display name for a product's SKU assigned to a customer in
|
440
|
+
# the subscription. SKU names are subject to change at Google's discretion. For
|
441
|
+
# products and SKUs available in this version of the API, see Product and SKU
|
442
|
+
# IDs.
|
443
|
+
# Corresponds to the JSON property `skuName`
|
444
|
+
# @return [String]
|
445
|
+
attr_accessor :sku_name
|
446
|
+
|
447
|
+
# This is an optional property.
|
448
|
+
# Corresponds to the JSON property `status`
|
449
|
+
# @return [String]
|
450
|
+
attr_accessor :status
|
451
|
+
|
452
|
+
# The subscriptionId is the subscription identifier and is unique for each
|
453
|
+
# customer. This is a required property. Since a subscriptionId changes when a
|
454
|
+
# subscription is updated, we recommend not using this ID as a key for
|
455
|
+
# persistent data. Use the subscriptionId as described in retrieve all reseller
|
456
|
+
# subscriptions.
|
457
|
+
# Corresponds to the JSON property `subscriptionId`
|
458
|
+
# @return [String]
|
459
|
+
attr_accessor :subscription_id
|
460
|
+
|
461
|
+
# Read-only field containing an enumerable of all the current suspension reasons
|
462
|
+
# for a subscription. It is possible for a subscription to have many concurrent,
|
463
|
+
# overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all
|
464
|
+
# pending suspensions are removed. Possible options include: -
|
465
|
+
# PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G
|
466
|
+
# Suite Resold Terms of Services. - RENEWAL_WITH_TYPE_CANCEL - The customer's
|
467
|
+
# commitment ended and their service was cancelled at the end of their term. -
|
468
|
+
# RESELLER_INITIATED - A manual suspension invoked by a Reseller. - TRIAL_ENDED -
|
469
|
+
# The customer's trial expired without a plan selected. - OTHER - The customer
|
470
|
+
# is suspended for an internal Google reason (e.g. abuse or otherwise).
|
471
|
+
# Corresponds to the JSON property `suspensionReasons`
|
472
|
+
# @return [Array<String>]
|
473
|
+
attr_accessor :suspension_reasons
|
474
|
+
|
475
|
+
# Read-only transfer related information for the subscription. For more
|
476
|
+
# information, see retrieve transferable subscriptions for a customer.
|
477
|
+
# Corresponds to the JSON property `transferInfo`
|
478
|
+
# @return [Google::Apis::ResellerV1::Subscription::TransferInfo]
|
479
|
+
attr_accessor :transfer_info
|
480
|
+
|
481
|
+
# The G Suite annual commitment and flexible payment plans can be in a 30-day
|
482
|
+
# free trial. For more information, see the API concepts.
|
483
|
+
# Corresponds to the JSON property `trialSettings`
|
484
|
+
# @return [Google::Apis::ResellerV1::Subscription::TrialSettings]
|
485
|
+
attr_accessor :trial_settings
|
486
|
+
|
487
|
+
def initialize(**args)
|
488
|
+
update!(**args)
|
489
|
+
end
|
490
|
+
|
491
|
+
# Update properties of this object
|
492
|
+
def update!(**args)
|
493
|
+
@billing_method = args[:billing_method] if args.key?(:billing_method)
|
494
|
+
@creation_time = args[:creation_time] if args.key?(:creation_time)
|
495
|
+
@customer_domain = args[:customer_domain] if args.key?(:customer_domain)
|
496
|
+
@customer_id = args[:customer_id] if args.key?(:customer_id)
|
497
|
+
@deal_code = args[:deal_code] if args.key?(:deal_code)
|
498
|
+
@kind = args[:kind] if args.key?(:kind)
|
499
|
+
@plan = args[:plan] if args.key?(:plan)
|
500
|
+
@purchase_order_id = args[:purchase_order_id] if args.key?(:purchase_order_id)
|
501
|
+
@renewal_settings = args[:renewal_settings] if args.key?(:renewal_settings)
|
502
|
+
@resource_ui_url = args[:resource_ui_url] if args.key?(:resource_ui_url)
|
503
|
+
@seats = args[:seats] if args.key?(:seats)
|
504
|
+
@sku_id = args[:sku_id] if args.key?(:sku_id)
|
505
|
+
@sku_name = args[:sku_name] if args.key?(:sku_name)
|
506
|
+
@status = args[:status] if args.key?(:status)
|
507
|
+
@subscription_id = args[:subscription_id] if args.key?(:subscription_id)
|
508
|
+
@suspension_reasons = args[:suspension_reasons] if args.key?(:suspension_reasons)
|
509
|
+
@transfer_info = args[:transfer_info] if args.key?(:transfer_info)
|
510
|
+
@trial_settings = args[:trial_settings] if args.key?(:trial_settings)
|
511
|
+
end
|
512
|
+
|
513
|
+
# The plan property is required. In this version of the API, the G Suite plans
|
514
|
+
# are the flexible plan, annual commitment plan, and the 30-day free trial plan.
|
515
|
+
# For more information about the API"s payment plans, see the API concepts.
|
516
|
+
class Plan
|
517
|
+
include Google::Apis::Core::Hashable
|
518
|
+
|
519
|
+
# In this version of the API, annual commitment plan's interval is one year. *
|
520
|
+
# Note: *When billingMethod value is OFFLINE, the subscription property object
|
521
|
+
# plan.commitmentInterval is omitted in all API responses.
|
522
|
+
# Corresponds to the JSON property `commitmentInterval`
|
523
|
+
# @return [Google::Apis::ResellerV1::Subscription::Plan::CommitmentInterval]
|
524
|
+
attr_accessor :commitment_interval
|
525
|
+
|
526
|
+
# The isCommitmentPlan property's boolean value identifies the plan as an annual
|
527
|
+
# commitment plan: - true — The subscription's plan is an annual commitment plan.
|
528
|
+
# - false — The plan is not an annual commitment plan.
|
529
|
+
# Corresponds to the JSON property `isCommitmentPlan`
|
530
|
+
# @return [Boolean]
|
531
|
+
attr_accessor :is_commitment_plan
|
532
|
+
alias_method :is_commitment_plan?, :is_commitment_plan
|
533
|
+
|
534
|
+
# The planName property is required. This is the name of the subscription's plan.
|
535
|
+
# For more information about the Google payment plans, see the API concepts.
|
536
|
+
# Possible values are: - ANNUAL_MONTHLY_PAY — The annual commitment plan with
|
537
|
+
# monthly payments. *Caution: *ANNUAL_MONTHLY_PAY is returned as ANNUAL in all
|
538
|
+
# API responses. - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly
|
539
|
+
# payments - FLEXIBLE — The flexible plan - TRIAL — The 30-day free trial plan.
|
540
|
+
# A subscription in trial will be suspended after the 30th free day if no
|
541
|
+
# payment plan is assigned. Calling changePlan will assign a payment plan to a
|
542
|
+
# trial but will not activate the plan. A trial will automatically begin its
|
543
|
+
# assigned payment plan after its 30th free day or immediately after calling
|
544
|
+
# startPaidService. - FREE — The free plan is exclusive to the Cloud Identity
|
545
|
+
# SKU and does not incur any billing.
|
546
|
+
# Corresponds to the JSON property `planName`
|
547
|
+
# @return [String]
|
548
|
+
attr_accessor :plan_name
|
549
|
+
|
550
|
+
def initialize(**args)
|
551
|
+
update!(**args)
|
552
|
+
end
|
553
|
+
|
554
|
+
# Update properties of this object
|
555
|
+
def update!(**args)
|
556
|
+
@commitment_interval = args[:commitment_interval] if args.key?(:commitment_interval)
|
557
|
+
@is_commitment_plan = args[:is_commitment_plan] if args.key?(:is_commitment_plan)
|
558
|
+
@plan_name = args[:plan_name] if args.key?(:plan_name)
|
559
|
+
end
|
560
|
+
|
561
|
+
# In this version of the API, annual commitment plan's interval is one year. *
|
562
|
+
# Note: *When billingMethod value is OFFLINE, the subscription property object
|
563
|
+
# plan.commitmentInterval is omitted in all API responses.
|
564
|
+
class CommitmentInterval
|
565
|
+
include Google::Apis::Core::Hashable
|
566
|
+
|
567
|
+
# An annual commitment plan's interval's endTime in milliseconds using the UNIX
|
568
|
+
# Epoch format. See an example Epoch converter.
|
569
|
+
# Corresponds to the JSON property `endTime`
|
570
|
+
# @return [Fixnum]
|
571
|
+
attr_accessor :end_time
|
572
|
+
|
573
|
+
# An annual commitment plan's interval's startTime in milliseconds using UNIX
|
574
|
+
# Epoch format. See an example Epoch converter.
|
575
|
+
# Corresponds to the JSON property `startTime`
|
576
|
+
# @return [Fixnum]
|
577
|
+
attr_accessor :start_time
|
578
|
+
|
579
|
+
def initialize(**args)
|
580
|
+
update!(**args)
|
581
|
+
end
|
582
|
+
|
583
|
+
# Update properties of this object
|
584
|
+
def update!(**args)
|
585
|
+
@end_time = args[:end_time] if args.key?(:end_time)
|
586
|
+
@start_time = args[:start_time] if args.key?(:start_time)
|
587
|
+
end
|
588
|
+
end
|
589
|
+
end
|
590
|
+
|
591
|
+
# Read-only transfer related information for the subscription. For more
|
592
|
+
# information, see retrieve transferable subscriptions for a customer.
|
593
|
+
class TransferInfo
|
594
|
+
include Google::Apis::Core::Hashable
|
595
|
+
|
596
|
+
# When inserting a subscription, this is the minimum number of seats listed in
|
597
|
+
# the transfer order for this product. For example, if the customer has 20 users,
|
598
|
+
# the reseller cannot place a transfer order of 15 seats. The minimum is 20
|
599
|
+
# seats.
|
600
|
+
# Corresponds to the JSON property `minimumTransferableSeats`
|
601
|
+
# @return [Fixnum]
|
602
|
+
attr_accessor :minimum_transferable_seats
|
603
|
+
|
604
|
+
# The time when transfer token or intent to transfer will expire. The time is in
|
605
|
+
# milliseconds using UNIX Epoch format.
|
606
|
+
# Corresponds to the JSON property `transferabilityExpirationTime`
|
607
|
+
# @return [Fixnum]
|
608
|
+
attr_accessor :transferability_expiration_time
|
609
|
+
|
610
|
+
def initialize(**args)
|
611
|
+
update!(**args)
|
612
|
+
end
|
613
|
+
|
614
|
+
# Update properties of this object
|
615
|
+
def update!(**args)
|
616
|
+
@minimum_transferable_seats = args[:minimum_transferable_seats] if args.key?(:minimum_transferable_seats)
|
617
|
+
@transferability_expiration_time = args[:transferability_expiration_time] if args.key?(:transferability_expiration_time)
|
618
|
+
end
|
619
|
+
end
|
620
|
+
|
621
|
+
# The G Suite annual commitment and flexible payment plans can be in a 30-day
|
622
|
+
# free trial. For more information, see the API concepts.
|
623
|
+
class TrialSettings
|
624
|
+
include Google::Apis::Core::Hashable
|
625
|
+
|
626
|
+
# Determines if a subscription's plan is in a 30-day free trial or not: - true —
|
627
|
+
# The plan is in trial. - false — The plan is not in trial.
|
628
|
+
# Corresponds to the JSON property `isInTrial`
|
629
|
+
# @return [Boolean]
|
630
|
+
attr_accessor :is_in_trial
|
631
|
+
alias_method :is_in_trial?, :is_in_trial
|
632
|
+
|
633
|
+
# Date when the trial ends. The value is in milliseconds using the UNIX Epoch
|
634
|
+
# format. See an example Epoch converter.
|
635
|
+
# Corresponds to the JSON property `trialEndTime`
|
636
|
+
# @return [Fixnum]
|
637
|
+
attr_accessor :trial_end_time
|
638
|
+
|
639
|
+
def initialize(**args)
|
640
|
+
update!(**args)
|
641
|
+
end
|
642
|
+
|
643
|
+
# Update properties of this object
|
644
|
+
def update!(**args)
|
645
|
+
@is_in_trial = args[:is_in_trial] if args.key?(:is_in_trial)
|
646
|
+
@trial_end_time = args[:trial_end_time] if args.key?(:trial_end_time)
|
647
|
+
end
|
648
|
+
end
|
649
|
+
end
|
650
|
+
|
651
|
+
# JSON template for a subscription list.
|
652
|
+
class Subscriptions
|
653
|
+
include Google::Apis::Core::Hashable
|
654
|
+
|
655
|
+
# Identifies the resource as a collection of subscriptions. Value: reseller#
|
656
|
+
# subscriptions
|
657
|
+
# Corresponds to the JSON property `kind`
|
658
|
+
# @return [String]
|
659
|
+
attr_accessor :kind
|
660
|
+
|
661
|
+
# The continuation token, used to page through large result sets. Provide this
|
662
|
+
# value in a subsequent request to return the next page of results.
|
663
|
+
# Corresponds to the JSON property `nextPageToken`
|
664
|
+
# @return [String]
|
665
|
+
attr_accessor :next_page_token
|
666
|
+
|
667
|
+
# The subscriptions in this page of results.
|
668
|
+
# Corresponds to the JSON property `subscriptions`
|
669
|
+
# @return [Array<Google::Apis::ResellerV1::Subscription>]
|
670
|
+
attr_accessor :subscriptions
|
671
|
+
|
672
|
+
def initialize(**args)
|
673
|
+
update!(**args)
|
674
|
+
end
|
675
|
+
|
676
|
+
# Update properties of this object
|
677
|
+
def update!(**args)
|
678
|
+
@kind = args[:kind] if args.key?(:kind)
|
679
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
680
|
+
@subscriptions = args[:subscriptions] if args.key?(:subscriptions)
|
681
|
+
end
|
682
|
+
end
|
683
|
+
end
|
684
|
+
end
|
685
|
+
end
|