OLD | NEW |
1 // This is a generated file (see the discoveryapis_generator project). | 1 // This is a generated file (see the discoveryapis_generator project). |
2 | 2 |
3 library googleapis.reseller.v1; | 3 library googleapis.reseller.v1; |
4 | 4 |
5 import 'dart:core' as core; | 5 import 'dart:core' as core; |
6 import 'dart:async' as async; | 6 import 'dart:async' as async; |
7 import 'dart:convert' as convert; | 7 import 'dart:convert' as convert; |
8 | 8 |
9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; | 9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; |
10 import 'package:http/http.dart' as http; | 10 import 'package:http/http.dart' as http; |
11 | 11 |
12 export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show | 12 export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show |
13 ApiRequestError, DetailedApiRequestError; | 13 ApiRequestError, DetailedApiRequestError; |
14 | 14 |
15 const core.String USER_AGENT = 'dart-api-client reseller/v1'; | 15 const core.String USER_AGENT = 'dart-api-client reseller/v1'; |
16 | 16 |
17 /** Creates and manages your customers and their subscriptions. */ | 17 /** Creates and manages your customers and their subscriptions. */ |
18 class ResellerApi { | 18 class ResellerApi { |
19 /** Manage users on your domain */ | 19 /** Manage users on your domain */ |
20 static const AppsOrderScope = "https://www.googleapis.com/auth/apps.order"; | 20 static const AppsOrderScope = "https://www.googleapis.com/auth/apps.order"; |
21 | 21 |
22 /** Manage users on your domain */ | 22 /** Manage users on your domain */ |
23 static const AppsOrderReadonlyScope = "https://www.googleapis.com/auth/apps.or
der.readonly"; | 23 static const AppsOrderReadonlyScope = "https://www.googleapis.com/auth/apps.or
der.readonly"; |
24 | 24 |
25 | 25 |
26 final commons.ApiRequester _requester; | 26 final commons.ApiRequester _requester; |
27 | 27 |
28 CustomersResourceApi get customers => new CustomersResourceApi(_requester); | 28 CustomersResourceApi get customers => new CustomersResourceApi(_requester); |
| 29 ResellernotifyResourceApi get resellernotify => new ResellernotifyResourceApi(
_requester); |
29 SubscriptionsResourceApi get subscriptions => new SubscriptionsResourceApi(_re
quester); | 30 SubscriptionsResourceApi get subscriptions => new SubscriptionsResourceApi(_re
quester); |
30 | 31 |
31 ResellerApi(http.Client client, {core.String rootUrl: "https://www.googleapis.
com/", core.String servicePath: "apps/reseller/v1/"}) : | 32 ResellerApi(http.Client client, {core.String rootUrl: "https://www.googleapis.
com/", core.String servicePath: "apps/reseller/v1/"}) : |
32 _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_A
GENT); | 33 _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_A
GENT); |
33 } | 34 } |
34 | 35 |
35 | 36 |
36 class CustomersResourceApi { | 37 class CustomersResourceApi { |
37 final commons.ApiRequester _requester; | 38 final commons.ApiRequester _requester; |
38 | 39 |
39 CustomersResourceApi(commons.ApiRequester client) : | 40 CustomersResourceApi(commons.ApiRequester client) : |
40 _requester = client; | 41 _requester = client; |
41 | 42 |
42 /** | 43 /** |
43 * Gets a customer resource if one exists and is owned by the reseller. | 44 * Get a customer account. |
44 * | 45 * |
45 * Request parameters: | 46 * Request parameters: |
46 * | 47 * |
47 * [customerId] - Id of the Customer | 48 * [customerId] - Either the customer's primary domain name or the customer's |
| 49 * unique identifier. If using the domain name, we do not recommend using a |
| 50 * customerId as a key for persistent data. If the domain name for a |
| 51 * customerId is changed, the Google system automatically updates. |
48 * | 52 * |
49 * Completes with a [Customer]. | 53 * Completes with a [Customer]. |
50 * | 54 * |
51 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 55 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
52 * error. | 56 * error. |
53 * | 57 * |
54 * If the used [http.Client] completes with an error when making a REST call, | 58 * If the used [http.Client] completes with an error when making a REST call, |
55 * this method will complete with the same error. | 59 * this method will complete with the same error. |
56 */ | 60 */ |
57 async.Future<Customer> get(core.String customerId) { | 61 async.Future<Customer> get(core.String customerId) { |
(...skipping 14 matching lines...) Expand all Loading... |
72 "GET", | 76 "GET", |
73 body: _body, | 77 body: _body, |
74 queryParams: _queryParams, | 78 queryParams: _queryParams, |
75 uploadOptions: _uploadOptions, | 79 uploadOptions: _uploadOptions, |
76 uploadMedia: _uploadMedia, | 80 uploadMedia: _uploadMedia, |
77 downloadOptions: _downloadOptions); | 81 downloadOptions: _downloadOptions); |
78 return _response.then((data) => new Customer.fromJson(data)); | 82 return _response.then((data) => new Customer.fromJson(data)); |
79 } | 83 } |
80 | 84 |
81 /** | 85 /** |
82 * Creates a customer resource if one does not already exist. | 86 * Order a new customer's account. |
83 * | 87 * |
84 * [request] - The metadata request object. | 88 * [request] - The metadata request object. |
85 * | 89 * |
86 * Request parameters: | 90 * Request parameters: |
87 * | 91 * |
88 * [customerAuthToken] - An auth token needed for inserting a customer for | 92 * [customerAuthToken] - The customerAuthToken query string is required when |
89 * which domain already exists. Can be generated at | 93 * creating a resold account that transfers a direct customer's subscription |
90 * https://admin.google.com/TransferToken. Optional. | 94 * or transfers another reseller customer's subscription to your reseller |
| 95 * management. This is a hexadecimal authentication token needed to complete |
| 96 * the subscription transfer. For more information, see the administrator help |
| 97 * center. |
91 * | 98 * |
92 * Completes with a [Customer]. | 99 * Completes with a [Customer]. |
93 * | 100 * |
94 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 101 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
95 * error. | 102 * error. |
96 * | 103 * |
97 * If the used [http.Client] completes with an error when making a REST call, | 104 * If the used [http.Client] completes with an error when making a REST call, |
98 * this method will complete with the same error. | 105 * this method will complete with the same error. |
99 */ | 106 */ |
100 async.Future<Customer> insert(Customer request, {core.String customerAuthToken
}) { | 107 async.Future<Customer> insert(Customer request, {core.String customerAuthToken
}) { |
(...skipping 17 matching lines...) Expand all Loading... |
118 "POST", | 125 "POST", |
119 body: _body, | 126 body: _body, |
120 queryParams: _queryParams, | 127 queryParams: _queryParams, |
121 uploadOptions: _uploadOptions, | 128 uploadOptions: _uploadOptions, |
122 uploadMedia: _uploadMedia, | 129 uploadMedia: _uploadMedia, |
123 downloadOptions: _downloadOptions); | 130 downloadOptions: _downloadOptions); |
124 return _response.then((data) => new Customer.fromJson(data)); | 131 return _response.then((data) => new Customer.fromJson(data)); |
125 } | 132 } |
126 | 133 |
127 /** | 134 /** |
128 * Update a customer resource if one it exists and is owned by the reseller. | 135 * Update a customer account's settings. This method supports patch semantics. |
129 * This method supports patch semantics. | |
130 * | 136 * |
131 * [request] - The metadata request object. | 137 * [request] - The metadata request object. |
132 * | 138 * |
133 * Request parameters: | 139 * Request parameters: |
134 * | 140 * |
135 * [customerId] - Id of the Customer | 141 * [customerId] - Either the customer's primary domain name or the customer's |
| 142 * unique identifier. If using the domain name, we do not recommend using a |
| 143 * customerId as a key for persistent data. If the domain name for a |
| 144 * customerId is changed, the Google system automatically updates. |
136 * | 145 * |
137 * Completes with a [Customer]. | 146 * Completes with a [Customer]. |
138 * | 147 * |
139 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 148 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
140 * error. | 149 * error. |
141 * | 150 * |
142 * If the used [http.Client] completes with an error when making a REST call, | 151 * If the used [http.Client] completes with an error when making a REST call, |
143 * this method will complete with the same error. | 152 * this method will complete with the same error. |
144 */ | 153 */ |
145 async.Future<Customer> patch(Customer request, core.String customerId) { | 154 async.Future<Customer> patch(Customer request, core.String customerId) { |
(...skipping 17 matching lines...) Expand all Loading... |
163 "PATCH", | 172 "PATCH", |
164 body: _body, | 173 body: _body, |
165 queryParams: _queryParams, | 174 queryParams: _queryParams, |
166 uploadOptions: _uploadOptions, | 175 uploadOptions: _uploadOptions, |
167 uploadMedia: _uploadMedia, | 176 uploadMedia: _uploadMedia, |
168 downloadOptions: _downloadOptions); | 177 downloadOptions: _downloadOptions); |
169 return _response.then((data) => new Customer.fromJson(data)); | 178 return _response.then((data) => new Customer.fromJson(data)); |
170 } | 179 } |
171 | 180 |
172 /** | 181 /** |
173 * Update a customer resource if one it exists and is owned by the reseller. | 182 * Update a customer account's settings. |
174 * | 183 * |
175 * [request] - The metadata request object. | 184 * [request] - The metadata request object. |
176 * | 185 * |
177 * Request parameters: | 186 * Request parameters: |
178 * | 187 * |
179 * [customerId] - Id of the Customer | 188 * [customerId] - Either the customer's primary domain name or the customer's |
| 189 * unique identifier. If using the domain name, we do not recommend using a |
| 190 * customerId as a key for persistent data. If the domain name for a |
| 191 * customerId is changed, the Google system automatically updates. |
180 * | 192 * |
181 * Completes with a [Customer]. | 193 * Completes with a [Customer]. |
182 * | 194 * |
183 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 195 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
184 * error. | 196 * error. |
185 * | 197 * |
186 * If the used [http.Client] completes with an error when making a REST call, | 198 * If the used [http.Client] completes with an error when making a REST call, |
187 * this method will complete with the same error. | 199 * this method will complete with the same error. |
188 */ | 200 */ |
189 async.Future<Customer> update(Customer request, core.String customerId) { | 201 async.Future<Customer> update(Customer request, core.String customerId) { |
(...skipping 19 matching lines...) Expand all Loading... |
209 queryParams: _queryParams, | 221 queryParams: _queryParams, |
210 uploadOptions: _uploadOptions, | 222 uploadOptions: _uploadOptions, |
211 uploadMedia: _uploadMedia, | 223 uploadMedia: _uploadMedia, |
212 downloadOptions: _downloadOptions); | 224 downloadOptions: _downloadOptions); |
213 return _response.then((data) => new Customer.fromJson(data)); | 225 return _response.then((data) => new Customer.fromJson(data)); |
214 } | 226 } |
215 | 227 |
216 } | 228 } |
217 | 229 |
218 | 230 |
| 231 class ResellernotifyResourceApi { |
| 232 final commons.ApiRequester _requester; |
| 233 |
| 234 ResellernotifyResourceApi(commons.ApiRequester client) : |
| 235 _requester = client; |
| 236 |
| 237 /** |
| 238 * Returns all the details of the watch corresponding to the reseller. |
| 239 * |
| 240 * Request parameters: |
| 241 * |
| 242 * Completes with a [ResellernotifyGetwatchdetailsResponse]. |
| 243 * |
| 244 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| 245 * error. |
| 246 * |
| 247 * If the used [http.Client] completes with an error when making a REST call, |
| 248 * this method will complete with the same error. |
| 249 */ |
| 250 async.Future<ResellernotifyGetwatchdetailsResponse> getwatchdetails() { |
| 251 var _url = null; |
| 252 var _queryParams = new core.Map(); |
| 253 var _uploadMedia = null; |
| 254 var _uploadOptions = null; |
| 255 var _downloadOptions = commons.DownloadOptions.Metadata; |
| 256 var _body = null; |
| 257 |
| 258 |
| 259 _url = 'resellernotify/getwatchdetails'; |
| 260 |
| 261 var _response = _requester.request(_url, |
| 262 "GET", |
| 263 body: _body, |
| 264 queryParams: _queryParams, |
| 265 uploadOptions: _uploadOptions, |
| 266 uploadMedia: _uploadMedia, |
| 267 downloadOptions: _downloadOptions); |
| 268 return _response.then((data) => new ResellernotifyGetwatchdetailsResponse.fr
omJson(data)); |
| 269 } |
| 270 |
| 271 /** |
| 272 * Registers a Reseller for receiving notifications. |
| 273 * |
| 274 * Request parameters: |
| 275 * |
| 276 * [serviceAccountEmailAddress] - The service account which will own the |
| 277 * created Cloud-PubSub topic. |
| 278 * |
| 279 * Completes with a [ResellernotifyResource]. |
| 280 * |
| 281 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| 282 * error. |
| 283 * |
| 284 * If the used [http.Client] completes with an error when making a REST call, |
| 285 * this method will complete with the same error. |
| 286 */ |
| 287 async.Future<ResellernotifyResource> register({core.String serviceAccountEmail
Address}) { |
| 288 var _url = null; |
| 289 var _queryParams = new core.Map(); |
| 290 var _uploadMedia = null; |
| 291 var _uploadOptions = null; |
| 292 var _downloadOptions = commons.DownloadOptions.Metadata; |
| 293 var _body = null; |
| 294 |
| 295 if (serviceAccountEmailAddress != null) { |
| 296 _queryParams["serviceAccountEmailAddress"] = [serviceAccountEmailAddress]; |
| 297 } |
| 298 |
| 299 _url = 'resellernotify/register'; |
| 300 |
| 301 var _response = _requester.request(_url, |
| 302 "POST", |
| 303 body: _body, |
| 304 queryParams: _queryParams, |
| 305 uploadOptions: _uploadOptions, |
| 306 uploadMedia: _uploadMedia, |
| 307 downloadOptions: _downloadOptions); |
| 308 return _response.then((data) => new ResellernotifyResource.fromJson(data)); |
| 309 } |
| 310 |
| 311 /** |
| 312 * Unregisters a Reseller for receiving notifications. |
| 313 * |
| 314 * Request parameters: |
| 315 * |
| 316 * [serviceAccountEmailAddress] - The service account which owns the |
| 317 * Cloud-PubSub topic. |
| 318 * |
| 319 * Completes with a [ResellernotifyResource]. |
| 320 * |
| 321 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| 322 * error. |
| 323 * |
| 324 * If the used [http.Client] completes with an error when making a REST call, |
| 325 * this method will complete with the same error. |
| 326 */ |
| 327 async.Future<ResellernotifyResource> unregister({core.String serviceAccountEma
ilAddress}) { |
| 328 var _url = null; |
| 329 var _queryParams = new core.Map(); |
| 330 var _uploadMedia = null; |
| 331 var _uploadOptions = null; |
| 332 var _downloadOptions = commons.DownloadOptions.Metadata; |
| 333 var _body = null; |
| 334 |
| 335 if (serviceAccountEmailAddress != null) { |
| 336 _queryParams["serviceAccountEmailAddress"] = [serviceAccountEmailAddress]; |
| 337 } |
| 338 |
| 339 _url = 'resellernotify/unregister'; |
| 340 |
| 341 var _response = _requester.request(_url, |
| 342 "POST", |
| 343 body: _body, |
| 344 queryParams: _queryParams, |
| 345 uploadOptions: _uploadOptions, |
| 346 uploadMedia: _uploadMedia, |
| 347 downloadOptions: _downloadOptions); |
| 348 return _response.then((data) => new ResellernotifyResource.fromJson(data)); |
| 349 } |
| 350 |
| 351 } |
| 352 |
| 353 |
219 class SubscriptionsResourceApi { | 354 class SubscriptionsResourceApi { |
220 final commons.ApiRequester _requester; | 355 final commons.ApiRequester _requester; |
221 | 356 |
222 SubscriptionsResourceApi(commons.ApiRequester client) : | 357 SubscriptionsResourceApi(commons.ApiRequester client) : |
223 _requester = client; | 358 _requester = client; |
224 | 359 |
225 /** | 360 /** |
226 * Activates a subscription previously suspended by the reseller | 361 * Activates a subscription previously suspended by the reseller |
227 * | 362 * |
228 * Request parameters: | 363 * Request parameters: |
229 * | 364 * |
230 * [customerId] - Id of the Customer | 365 * [customerId] - Either the customer's primary domain name or the customer's |
| 366 * unique identifier. If using the domain name, we do not recommend using a |
| 367 * customerId as a key for persistent data. If the domain name for a |
| 368 * customerId is changed, the Google system automatically updates. |
231 * | 369 * |
232 * [subscriptionId] - Id of the subscription, which is unique for a customer | 370 * [subscriptionId] - This is a required property. The subscriptionId is the |
| 371 * subscription identifier and is unique for each customer. Since a |
| 372 * subscriptionId changes when a subscription is updated, we recommend to not |
| 373 * use this ID as a key for persistent data. And the subscriptionId can be |
| 374 * found using the retrieve all reseller subscriptions method. |
233 * | 375 * |
234 * Completes with a [Subscription]. | 376 * Completes with a [Subscription]. |
235 * | 377 * |
236 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 378 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
237 * error. | 379 * error. |
238 * | 380 * |
239 * If the used [http.Client] completes with an error when making a REST call, | 381 * If the used [http.Client] completes with an error when making a REST call, |
240 * this method will complete with the same error. | 382 * this method will complete with the same error. |
241 */ | 383 */ |
242 async.Future<Subscription> activate(core.String customerId, core.String subscr
iptionId) { | 384 async.Future<Subscription> activate(core.String customerId, core.String subscr
iptionId) { |
(...skipping 17 matching lines...) Expand all Loading... |
260 "POST", | 402 "POST", |
261 body: _body, | 403 body: _body, |
262 queryParams: _queryParams, | 404 queryParams: _queryParams, |
263 uploadOptions: _uploadOptions, | 405 uploadOptions: _uploadOptions, |
264 uploadMedia: _uploadMedia, | 406 uploadMedia: _uploadMedia, |
265 downloadOptions: _downloadOptions); | 407 downloadOptions: _downloadOptions); |
266 return _response.then((data) => new Subscription.fromJson(data)); | 408 return _response.then((data) => new Subscription.fromJson(data)); |
267 } | 409 } |
268 | 410 |
269 /** | 411 /** |
270 * Changes the plan of a subscription | 412 * Update a subscription plan. Use this method to update a plan for a 30-day |
| 413 * trial or a flexible plan subscription to an annual commitment plan with |
| 414 * monthly or yearly payments. |
271 * | 415 * |
272 * [request] - The metadata request object. | 416 * [request] - The metadata request object. |
273 * | 417 * |
274 * Request parameters: | 418 * Request parameters: |
275 * | 419 * |
276 * [customerId] - Id of the Customer | 420 * [customerId] - Either the customer's primary domain name or the customer's |
| 421 * unique identifier. If using the domain name, we do not recommend using a |
| 422 * customerId as a key for persistent data. If the domain name for a |
| 423 * customerId is changed, the Google system automatically updates. |
277 * | 424 * |
278 * [subscriptionId] - Id of the subscription, which is unique for a customer | 425 * [subscriptionId] - This is a required property. The subscriptionId is the |
| 426 * subscription identifier and is unique for each customer. Since a |
| 427 * subscriptionId changes when a subscription is updated, we recommend to not |
| 428 * use this ID as a key for persistent data. And the subscriptionId can be |
| 429 * found using the retrieve all reseller subscriptions method. |
279 * | 430 * |
280 * Completes with a [Subscription]. | 431 * Completes with a [Subscription]. |
281 * | 432 * |
282 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 433 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
283 * error. | 434 * error. |
284 * | 435 * |
285 * If the used [http.Client] completes with an error when making a REST call, | 436 * If the used [http.Client] completes with an error when making a REST call, |
286 * this method will complete with the same error. | 437 * this method will complete with the same error. |
287 */ | 438 */ |
288 async.Future<Subscription> changePlan(ChangePlanRequest request, core.String c
ustomerId, core.String subscriptionId) { | 439 async.Future<Subscription> changePlan(ChangePlanRequest request, core.String c
ustomerId, core.String subscriptionId) { |
(...skipping 20 matching lines...) Expand all Loading... |
309 "POST", | 460 "POST", |
310 body: _body, | 461 body: _body, |
311 queryParams: _queryParams, | 462 queryParams: _queryParams, |
312 uploadOptions: _uploadOptions, | 463 uploadOptions: _uploadOptions, |
313 uploadMedia: _uploadMedia, | 464 uploadMedia: _uploadMedia, |
314 downloadOptions: _downloadOptions); | 465 downloadOptions: _downloadOptions); |
315 return _response.then((data) => new Subscription.fromJson(data)); | 466 return _response.then((data) => new Subscription.fromJson(data)); |
316 } | 467 } |
317 | 468 |
318 /** | 469 /** |
319 * Changes the renewal settings of a subscription | 470 * Update a user license's renewal settings. This is applicable for accounts |
| 471 * with annual commitment plans only. |
320 * | 472 * |
321 * [request] - The metadata request object. | 473 * [request] - The metadata request object. |
322 * | 474 * |
323 * Request parameters: | 475 * Request parameters: |
324 * | 476 * |
325 * [customerId] - Id of the Customer | 477 * [customerId] - Either the customer's primary domain name or the customer's |
| 478 * unique identifier. If using the domain name, we do not recommend using a |
| 479 * customerId as a key for persistent data. If the domain name for a |
| 480 * customerId is changed, the Google system automatically updates. |
326 * | 481 * |
327 * [subscriptionId] - Id of the subscription, which is unique for a customer | 482 * [subscriptionId] - This is a required property. The subscriptionId is the |
| 483 * subscription identifier and is unique for each customer. Since a |
| 484 * subscriptionId changes when a subscription is updated, we recommend to not |
| 485 * use this ID as a key for persistent data. And the subscriptionId can be |
| 486 * found using the retrieve all reseller subscriptions method. |
328 * | 487 * |
329 * Completes with a [Subscription]. | 488 * Completes with a [Subscription]. |
330 * | 489 * |
331 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 490 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
332 * error. | 491 * error. |
333 * | 492 * |
334 * If the used [http.Client] completes with an error when making a REST call, | 493 * If the used [http.Client] completes with an error when making a REST call, |
335 * this method will complete with the same error. | 494 * this method will complete with the same error. |
336 */ | 495 */ |
337 async.Future<Subscription> changeRenewalSettings(RenewalSettings request, core
.String customerId, core.String subscriptionId) { | 496 async.Future<Subscription> changeRenewalSettings(RenewalSettings request, core
.String customerId, core.String subscriptionId) { |
(...skipping 20 matching lines...) Expand all Loading... |
358 "POST", | 517 "POST", |
359 body: _body, | 518 body: _body, |
360 queryParams: _queryParams, | 519 queryParams: _queryParams, |
361 uploadOptions: _uploadOptions, | 520 uploadOptions: _uploadOptions, |
362 uploadMedia: _uploadMedia, | 521 uploadMedia: _uploadMedia, |
363 downloadOptions: _downloadOptions); | 522 downloadOptions: _downloadOptions); |
364 return _response.then((data) => new Subscription.fromJson(data)); | 523 return _response.then((data) => new Subscription.fromJson(data)); |
365 } | 524 } |
366 | 525 |
367 /** | 526 /** |
368 * Changes the seats configuration of a subscription | 527 * Update a subscription's user license settings. |
369 * | 528 * |
370 * [request] - The metadata request object. | 529 * [request] - The metadata request object. |
371 * | 530 * |
372 * Request parameters: | 531 * Request parameters: |
373 * | 532 * |
374 * [customerId] - Id of the Customer | 533 * [customerId] - Either the customer's primary domain name or the customer's |
| 534 * unique identifier. If using the domain name, we do not recommend using a |
| 535 * customerId as a key for persistent data. If the domain name for a |
| 536 * customerId is changed, the Google system automatically updates. |
375 * | 537 * |
376 * [subscriptionId] - Id of the subscription, which is unique for a customer | 538 * [subscriptionId] - This is a required property. The subscriptionId is the |
| 539 * subscription identifier and is unique for each customer. Since a |
| 540 * subscriptionId changes when a subscription is updated, we recommend to not |
| 541 * use this ID as a key for persistent data. And the subscriptionId can be |
| 542 * found using the retrieve all reseller subscriptions method. |
377 * | 543 * |
378 * Completes with a [Subscription]. | 544 * Completes with a [Subscription]. |
379 * | 545 * |
380 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 546 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
381 * error. | 547 * error. |
382 * | 548 * |
383 * If the used [http.Client] completes with an error when making a REST call, | 549 * If the used [http.Client] completes with an error when making a REST call, |
384 * this method will complete with the same error. | 550 * this method will complete with the same error. |
385 */ | 551 */ |
386 async.Future<Subscription> changeSeats(Seats request, core.String customerId,
core.String subscriptionId) { | 552 async.Future<Subscription> changeSeats(Seats request, core.String customerId,
core.String subscriptionId) { |
(...skipping 20 matching lines...) Expand all Loading... |
407 "POST", | 573 "POST", |
408 body: _body, | 574 body: _body, |
409 queryParams: _queryParams, | 575 queryParams: _queryParams, |
410 uploadOptions: _uploadOptions, | 576 uploadOptions: _uploadOptions, |
411 uploadMedia: _uploadMedia, | 577 uploadMedia: _uploadMedia, |
412 downloadOptions: _downloadOptions); | 578 downloadOptions: _downloadOptions); |
413 return _response.then((data) => new Subscription.fromJson(data)); | 579 return _response.then((data) => new Subscription.fromJson(data)); |
414 } | 580 } |
415 | 581 |
416 /** | 582 /** |
417 * Cancels/Downgrades a subscription. | 583 * Cancel, suspend or transfer a subscription to direct. |
418 * | 584 * |
419 * Request parameters: | 585 * Request parameters: |
420 * | 586 * |
421 * [customerId] - Id of the Customer | 587 * [customerId] - Either the customer's primary domain name or the customer's |
| 588 * unique identifier. If using the domain name, we do not recommend using a |
| 589 * customerId as a key for persistent data. If the domain name for a |
| 590 * customerId is changed, the Google system automatically updates. |
422 * | 591 * |
423 * [subscriptionId] - Id of the subscription, which is unique for a customer | 592 * [subscriptionId] - This is a required property. The subscriptionId is the |
| 593 * subscription identifier and is unique for each customer. Since a |
| 594 * subscriptionId changes when a subscription is updated, we recommend to not |
| 595 * use this ID as a key for persistent data. And the subscriptionId can be |
| 596 * found using the retrieve all reseller subscriptions method. |
424 * | 597 * |
425 * [deletionType] - Whether the subscription is to be fully cancelled or | 598 * [deletionType] - The deletionType query string enables the cancellation, |
426 * downgraded | 599 * downgrade, or suspension of a subscription. |
427 * Possible string values are: | 600 * Possible string values are: |
428 * - "cancel" : Cancels the subscription immediately | 601 * - "cancel" : Cancels the subscription immediately. This does not apply to a |
429 * - "downgrade" : Downgrades a Google Apps for Business subscription to | 602 * G Suite subscription. |
430 * Google Apps | 603 * - "downgrade" : Downgrades a G Suite subscription to a Google Apps Free |
431 * - "suspend" : Suspends the subscriptions for 4 days before cancelling it | 604 * edition subscription only if the customer was initially subscribed to a |
432 * - "transfer_to_direct" : Transfers a subscription directly to Google | 605 * Google Apps Free edition (also known as the Standard edition). Once |
| 606 * downgraded, the customer no longer has access to the previous G Suite |
| 607 * subscription and is no longer managed by the reseller. |
| 608 * |
| 609 * A G Suite subscription's downgrade cannot be invoked if an active or |
| 610 * suspended Google Drive or Google Vault subscription is present. The Google |
| 611 * Drive or Google Vault subscription must be cancelled before the G Suite |
| 612 * subscription's downgrade is invoked. |
| 613 * |
| 614 * The downgrade deletionType does not apply to other products or G Suite |
| 615 * SKUs. |
| 616 * - "suspend" : (DEPRECATED) The G Suite account is suspended for four days |
| 617 * and then cancelled. Once suspended, an administrator has access to the |
| 618 * suspended account, but the account users can not access their services. A |
| 619 * suspension can be lifted, using the reseller tools. |
| 620 * |
| 621 * A G Suite subscription's suspension can not be invoked if an active or |
| 622 * suspended Google Drive or Google Vault subscription is present. The Google |
| 623 * Drive or Google Vault subscription must be cancelled before the G Suite |
| 624 * subscription's suspension is invoked. |
| 625 * - "transfer_to_direct" : Transfers a subscription directly to Google. The |
| 626 * customer is immediately transferred to a direct billing relationship with |
| 627 * Google and is given a short amount of time with no service interruption. |
| 628 * The customer can then choose to set up billing directly with Google by |
| 629 * using a credit card, or they can transfer to another reseller. |
433 * | 630 * |
434 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 631 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
435 * error. | 632 * error. |
436 * | 633 * |
437 * If the used [http.Client] completes with an error when making a REST call, | 634 * If the used [http.Client] completes with an error when making a REST call, |
438 * this method will complete with the same error. | 635 * this method will complete with the same error. |
439 */ | 636 */ |
440 async.Future delete(core.String customerId, core.String subscriptionId, core.S
tring deletionType) { | 637 async.Future delete(core.String customerId, core.String subscriptionId, core.S
tring deletionType) { |
441 var _url = null; | 638 var _url = null; |
442 var _queryParams = new core.Map(); | 639 var _queryParams = new core.Map(); |
(...skipping 21 matching lines...) Expand all Loading... |
464 "DELETE", | 661 "DELETE", |
465 body: _body, | 662 body: _body, |
466 queryParams: _queryParams, | 663 queryParams: _queryParams, |
467 uploadOptions: _uploadOptions, | 664 uploadOptions: _uploadOptions, |
468 uploadMedia: _uploadMedia, | 665 uploadMedia: _uploadMedia, |
469 downloadOptions: _downloadOptions); | 666 downloadOptions: _downloadOptions); |
470 return _response.then((data) => null); | 667 return _response.then((data) => null); |
471 } | 668 } |
472 | 669 |
473 /** | 670 /** |
474 * Gets a subscription of the customer. | 671 * Get a specific subscription. |
475 * | 672 * |
476 * Request parameters: | 673 * Request parameters: |
477 * | 674 * |
478 * [customerId] - Id of the Customer | 675 * [customerId] - Either the customer's primary domain name or the customer's |
| 676 * unique identifier. If using the domain name, we do not recommend using a |
| 677 * customerId as a key for persistent data. If the domain name for a |
| 678 * customerId is changed, the Google system automatically updates. |
479 * | 679 * |
480 * [subscriptionId] - Id of the subscription, which is unique for a customer | 680 * [subscriptionId] - This is a required property. The subscriptionId is the |
| 681 * subscription identifier and is unique for each customer. Since a |
| 682 * subscriptionId changes when a subscription is updated, we recommend to not |
| 683 * use this ID as a key for persistent data. And the subscriptionId can be |
| 684 * found using the retrieve all reseller subscriptions method. |
481 * | 685 * |
482 * Completes with a [Subscription]. | 686 * Completes with a [Subscription]. |
483 * | 687 * |
484 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 688 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
485 * error. | 689 * error. |
486 * | 690 * |
487 * If the used [http.Client] completes with an error when making a REST call, | 691 * If the used [http.Client] completes with an error when making a REST call, |
488 * this method will complete with the same error. | 692 * this method will complete with the same error. |
489 */ | 693 */ |
490 async.Future<Subscription> get(core.String customerId, core.String subscriptio
nId) { | 694 async.Future<Subscription> get(core.String customerId, core.String subscriptio
nId) { |
(...skipping 17 matching lines...) Expand all Loading... |
508 "GET", | 712 "GET", |
509 body: _body, | 713 body: _body, |
510 queryParams: _queryParams, | 714 queryParams: _queryParams, |
511 uploadOptions: _uploadOptions, | 715 uploadOptions: _uploadOptions, |
512 uploadMedia: _uploadMedia, | 716 uploadMedia: _uploadMedia, |
513 downloadOptions: _downloadOptions); | 717 downloadOptions: _downloadOptions); |
514 return _response.then((data) => new Subscription.fromJson(data)); | 718 return _response.then((data) => new Subscription.fromJson(data)); |
515 } | 719 } |
516 | 720 |
517 /** | 721 /** |
518 * Creates/Transfers a subscription for the customer. | 722 * Create or transfer a subscription. |
519 * | 723 * |
520 * [request] - The metadata request object. | 724 * [request] - The metadata request object. |
521 * | 725 * |
522 * Request parameters: | 726 * Request parameters: |
523 * | 727 * |
524 * [customerId] - Id of the Customer | 728 * [customerId] - Either the customer's primary domain name or the customer's |
| 729 * unique identifier. If using the domain name, we do not recommend using a |
| 730 * customerId as a key for persistent data. If the domain name for a |
| 731 * customerId is changed, the Google system automatically updates. |
525 * | 732 * |
526 * [customerAuthToken] - An auth token needed for transferring a subscription. | 733 * [customerAuthToken] - The customerAuthToken query string is required when |
527 * Can be generated at | 734 * creating a resold account that transfers a direct customer's subscription |
528 * https://www.google.com/a/cpanel/customer-domain/TransferToken. Optional. | 735 * or transfers another reseller customer's subscription to your reseller |
| 736 * management. This is a hexadecimal authentication token needed to complete |
| 737 * the subscription transfer. For more information, see the administrator help |
| 738 * center. |
529 * | 739 * |
530 * Completes with a [Subscription]. | 740 * Completes with a [Subscription]. |
531 * | 741 * |
532 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 742 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
533 * error. | 743 * error. |
534 * | 744 * |
535 * If the used [http.Client] completes with an error when making a REST call, | 745 * If the used [http.Client] completes with an error when making a REST call, |
536 * this method will complete with the same error. | 746 * this method will complete with the same error. |
537 */ | 747 */ |
538 async.Future<Subscription> insert(Subscription request, core.String customerId
, {core.String customerAuthToken}) { | 748 async.Future<Subscription> insert(Subscription request, core.String customerId
, {core.String customerAuthToken}) { |
(...skipping 20 matching lines...) Expand all Loading... |
559 "POST", | 769 "POST", |
560 body: _body, | 770 body: _body, |
561 queryParams: _queryParams, | 771 queryParams: _queryParams, |
562 uploadOptions: _uploadOptions, | 772 uploadOptions: _uploadOptions, |
563 uploadMedia: _uploadMedia, | 773 uploadMedia: _uploadMedia, |
564 downloadOptions: _downloadOptions); | 774 downloadOptions: _downloadOptions); |
565 return _response.then((data) => new Subscription.fromJson(data)); | 775 return _response.then((data) => new Subscription.fromJson(data)); |
566 } | 776 } |
567 | 777 |
568 /** | 778 /** |
569 * Lists subscriptions of a reseller, optionally filtered by a customer name | 779 * List of subscriptions managed by the reseller. The list can be all |
570 * prefix. | 780 * subscriptions, all of a customer's subscriptions, or all of a customer's |
| 781 * transferable subscriptions. |
571 * | 782 * |
572 * Request parameters: | 783 * Request parameters: |
573 * | 784 * |
574 * [customerAuthToken] - An auth token needed if the customer is not a resold | 785 * [customerAuthToken] - The customerAuthToken query string is required when |
575 * customer of this reseller. Can be generated at | 786 * creating a resold account that transfers a direct customer's subscription |
576 * https://www.google.com/a/cpanel/customer-domain/TransferToken.Optional. | 787 * or transfers another reseller customer's subscription to your reseller |
| 788 * management. This is a hexadecimal authentication token needed to complete |
| 789 * the subscription transfer. For more information, see the administrator help |
| 790 * center. |
577 * | 791 * |
578 * [customerId] - Id of the Customer | 792 * [customerId] - Either the customer's primary domain name or the customer's |
| 793 * unique identifier. If using the domain name, we do not recommend using a |
| 794 * customerId as a key for persistent data. If the domain name for a |
| 795 * customerId is changed, the Google system automatically updates. |
579 * | 796 * |
580 * [customerNamePrefix] - Prefix of the customer's domain name by which the | 797 * [customerNamePrefix] - When retrieving all of your subscriptions and |
581 * subscriptions should be filtered. Optional | 798 * filtering for specific customers, you can enter a prefix for a customer |
| 799 * name. Using an example customer group that includes exam.com, example20.com |
| 800 * and example.com: |
| 801 * - exa -- Returns all customer names that start with 'exa' which could |
| 802 * include exam.com, example20.com, and example.com. A name prefix is similar |
| 803 * to using a regular expression's asterisk, exa*. |
| 804 * - example -- Returns example20.com and example.com. |
582 * | 805 * |
583 * [maxResults] - Maximum number of results to return | 806 * [maxResults] - When retrieving a large list, the maxResults is the maximum |
| 807 * number of results per page. The nextPageToken value takes you to the next |
| 808 * page. The default is 20. |
584 * Value must be between "1" and "100". | 809 * Value must be between "1" and "100". |
585 * | 810 * |
586 * [pageToken] - Token to specify next page in the list | 811 * [pageToken] - Token to specify next page in the list |
587 * | 812 * |
588 * Completes with a [Subscriptions]. | 813 * Completes with a [Subscriptions]. |
589 * | 814 * |
590 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 815 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
591 * error. | 816 * error. |
592 * | 817 * |
593 * If the used [http.Client] completes with an error when making a REST call, | 818 * If the used [http.Client] completes with an error when making a REST call, |
(...skipping 29 matching lines...) Expand all Loading... |
623 "GET", | 848 "GET", |
624 body: _body, | 849 body: _body, |
625 queryParams: _queryParams, | 850 queryParams: _queryParams, |
626 uploadOptions: _uploadOptions, | 851 uploadOptions: _uploadOptions, |
627 uploadMedia: _uploadMedia, | 852 uploadMedia: _uploadMedia, |
628 downloadOptions: _downloadOptions); | 853 downloadOptions: _downloadOptions); |
629 return _response.then((data) => new Subscriptions.fromJson(data)); | 854 return _response.then((data) => new Subscriptions.fromJson(data)); |
630 } | 855 } |
631 | 856 |
632 /** | 857 /** |
633 * Starts paid service of a trial subscription | 858 * Immediately move a 30-day free trial subscription to a paid service |
| 859 * subscription. |
634 * | 860 * |
635 * Request parameters: | 861 * Request parameters: |
636 * | 862 * |
637 * [customerId] - Id of the Customer | 863 * [customerId] - Either the customer's primary domain name or the customer's |
| 864 * unique identifier. If using the domain name, we do not recommend using a |
| 865 * customerId as a key for persistent data. If the domain name for a |
| 866 * customerId is changed, the Google system automatically updates. |
638 * | 867 * |
639 * [subscriptionId] - Id of the subscription, which is unique for a customer | 868 * [subscriptionId] - This is a required property. The subscriptionId is the |
| 869 * subscription identifier and is unique for each customer. Since a |
| 870 * subscriptionId changes when a subscription is updated, we recommend to not |
| 871 * use this ID as a key for persistent data. And the subscriptionId can be |
| 872 * found using the retrieve all reseller subscriptions method. |
640 * | 873 * |
641 * Completes with a [Subscription]. | 874 * Completes with a [Subscription]. |
642 * | 875 * |
643 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 876 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
644 * error. | 877 * error. |
645 * | 878 * |
646 * If the used [http.Client] completes with an error when making a REST call, | 879 * If the used [http.Client] completes with an error when making a REST call, |
647 * this method will complete with the same error. | 880 * this method will complete with the same error. |
648 */ | 881 */ |
649 async.Future<Subscription> startPaidService(core.String customerId, core.Strin
g subscriptionId) { | 882 async.Future<Subscription> startPaidService(core.String customerId, core.Strin
g subscriptionId) { |
(...skipping 17 matching lines...) Expand all Loading... |
667 "POST", | 900 "POST", |
668 body: _body, | 901 body: _body, |
669 queryParams: _queryParams, | 902 queryParams: _queryParams, |
670 uploadOptions: _uploadOptions, | 903 uploadOptions: _uploadOptions, |
671 uploadMedia: _uploadMedia, | 904 uploadMedia: _uploadMedia, |
672 downloadOptions: _downloadOptions); | 905 downloadOptions: _downloadOptions); |
673 return _response.then((data) => new Subscription.fromJson(data)); | 906 return _response.then((data) => new Subscription.fromJson(data)); |
674 } | 907 } |
675 | 908 |
676 /** | 909 /** |
677 * Suspends an active subscription | 910 * Suspends an active subscription. |
678 * | 911 * |
679 * Request parameters: | 912 * Request parameters: |
680 * | 913 * |
681 * [customerId] - Id of the Customer | 914 * [customerId] - Either the customer's primary domain name or the customer's |
| 915 * unique identifier. If using the domain name, we do not recommend using a |
| 916 * customerId as a key for persistent data. If the domain name for a |
| 917 * customerId is changed, the Google system automatically updates. |
682 * | 918 * |
683 * [subscriptionId] - Id of the subscription, which is unique for a customer | 919 * [subscriptionId] - This is a required property. The subscriptionId is the |
| 920 * subscription identifier and is unique for each customer. Since a |
| 921 * subscriptionId changes when a subscription is updated, we recommend to not |
| 922 * use this ID as a key for persistent data. And the subscriptionId can be |
| 923 * found using the retrieve all reseller subscriptions method. |
684 * | 924 * |
685 * Completes with a [Subscription]. | 925 * Completes with a [Subscription]. |
686 * | 926 * |
687 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 927 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
688 * error. | 928 * error. |
689 * | 929 * |
690 * If the used [http.Client] completes with an error when making a REST call, | 930 * If the used [http.Client] completes with an error when making a REST call, |
691 * this method will complete with the same error. | 931 * this method will complete with the same error. |
692 */ | 932 */ |
693 async.Future<Subscription> suspend(core.String customerId, core.String subscri
ptionId) { | 933 async.Future<Subscription> suspend(core.String customerId, core.String subscri
ptionId) { |
(...skipping 22 matching lines...) Expand all Loading... |
716 downloadOptions: _downloadOptions); | 956 downloadOptions: _downloadOptions); |
717 return _response.then((data) => new Subscription.fromJson(data)); | 957 return _response.then((data) => new Subscription.fromJson(data)); |
718 } | 958 } |
719 | 959 |
720 } | 960 } |
721 | 961 |
722 | 962 |
723 | 963 |
724 /** JSON template for address of a customer. */ | 964 /** JSON template for address of a customer. */ |
725 class Address { | 965 class Address { |
726 /** Address line 1 of the address. */ | 966 /** |
| 967 * A customer's physical address. An address can be composed of one to three |
| 968 * lines. The addressline2 and addressLine3 are optional. |
| 969 */ |
727 core.String addressLine1; | 970 core.String addressLine1; |
728 /** Address line 2 of the address. */ | 971 /** Line 2 of the address. */ |
729 core.String addressLine2; | 972 core.String addressLine2; |
730 /** Address line 3 of the address. */ | 973 /** Line 3 of the address. */ |
731 core.String addressLine3; | 974 core.String addressLine3; |
732 /** Name of the contact person. */ | 975 /** The customer contact's name. This is required. */ |
733 core.String contactName; | 976 core.String contactName; |
734 /** ISO 3166 country code. */ | 977 /** |
| 978 * For countryCode information, see the ISO 3166 country code elements. Verify |
| 979 * that country is approved for resale of Google products. This property is |
| 980 * required when creating a new customer. |
| 981 */ |
735 core.String countryCode; | 982 core.String countryCode; |
736 /** Identifies the resource as a customer address. */ | 983 /** |
| 984 * Identifies the resource as a customer address. Value: customers#address |
| 985 */ |
737 core.String kind; | 986 core.String kind; |
738 /** | 987 /** An example of a locality value is the city of San Francisco. */ |
739 * Name of the locality. This is in accordance with - | |
740 * http://portablecontacts.net/draft-spec.html#address_element. | |
741 */ | |
742 core.String locality; | 988 core.String locality; |
743 /** Name of the organization. */ | 989 /** The company or company division name. This is required. */ |
744 core.String organizationName; | 990 core.String organizationName; |
745 /** | 991 /** |
746 * The postal code. This is in accordance with - | 992 * A postalCode example is a postal zip code such as 94043. This property is |
747 * http://portablecontacts.net/draft-spec.html#address_element. | 993 * required when creating a new customer. |
748 */ | 994 */ |
749 core.String postalCode; | 995 core.String postalCode; |
750 /** | 996 /** An example of a region value is CA for the state of California. */ |
751 * Name of the region. This is in accordance with - | |
752 * http://portablecontacts.net/draft-spec.html#address_element. | |
753 */ | |
754 core.String region; | 997 core.String region; |
755 | 998 |
756 Address(); | 999 Address(); |
757 | 1000 |
758 Address.fromJson(core.Map _json) { | 1001 Address.fromJson(core.Map _json) { |
759 if (_json.containsKey("addressLine1")) { | 1002 if (_json.containsKey("addressLine1")) { |
760 addressLine1 = _json["addressLine1"]; | 1003 addressLine1 = _json["addressLine1"]; |
761 } | 1004 } |
762 if (_json.containsKey("addressLine2")) { | 1005 if (_json.containsKey("addressLine2")) { |
763 addressLine2 = _json["addressLine2"]; | 1006 addressLine2 = _json["addressLine2"]; |
(...skipping 56 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
820 if (region != null) { | 1063 if (region != null) { |
821 _json["region"] = region; | 1064 _json["region"] = region; |
822 } | 1065 } |
823 return _json; | 1066 return _json; |
824 } | 1067 } |
825 } | 1068 } |
826 | 1069 |
827 /** JSON template for the ChangePlan rpc request. */ | 1070 /** JSON template for the ChangePlan rpc request. */ |
828 class ChangePlanRequest { | 1071 class ChangePlanRequest { |
829 /** | 1072 /** |
830 * External name of the deal code applicable for the subscription. This field | 1073 * Google-issued code (100 char max) for discounted pricing on subscription |
831 * is optional. If missing, the deal price plan won't be used. | 1074 * plans. Deal code must be included in changePlan request in order to receive |
| 1075 * discounted rate. This property is optional. If a deal code has already been |
| 1076 * added to a subscription, this property may be left empty and the existing |
| 1077 * discounted rate will still apply (if not empty, only provide the deal code |
| 1078 * that is already present on the subscription). If a deal code has never been |
| 1079 * added to a subscription and this property is left blank, regular pricing |
| 1080 * will apply. |
832 */ | 1081 */ |
833 core.String dealCode; | 1082 core.String dealCode; |
834 /** Identifies the resource as a subscription change plan request. */ | 1083 /** |
| 1084 * Identifies the resource as a subscription change plan request. Value: |
| 1085 * subscriptions#changePlanRequest |
| 1086 */ |
835 core.String kind; | 1087 core.String kind; |
836 /** Name of the plan to change to. */ | 1088 /** |
| 1089 * The planName property is required. This is the name of the subscription's |
| 1090 * payment plan. For more information about the Google payment plans, see API |
| 1091 * concepts. |
| 1092 * |
| 1093 * Possible values are: |
| 1094 * - ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments |
| 1095 * - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments |
| 1096 * - FLEXIBLE - The flexible plan |
| 1097 * - TRIAL - The 30-day free trial plan |
| 1098 */ |
837 core.String planName; | 1099 core.String planName; |
838 /** Purchase order id for your order tracking purposes. */ | 1100 /** |
| 1101 * This is an optional property. This purchase order (PO) information is for |
| 1102 * resellers to use for their company tracking usage. If a purchaseOrderId |
| 1103 * value is given it appears in the API responses and shows up in the invoice. |
| 1104 * The property accepts up to 80 plain text characters. |
| 1105 */ |
839 core.String purchaseOrderId; | 1106 core.String purchaseOrderId; |
840 /** Number/Limit of seats in the new plan. */ | 1107 /** |
| 1108 * This is a required property. The seats property is the number of user seat |
| 1109 * licenses. |
| 1110 */ |
841 Seats seats; | 1111 Seats seats; |
842 | 1112 |
843 ChangePlanRequest(); | 1113 ChangePlanRequest(); |
844 | 1114 |
845 ChangePlanRequest.fromJson(core.Map _json) { | 1115 ChangePlanRequest.fromJson(core.Map _json) { |
846 if (_json.containsKey("dealCode")) { | 1116 if (_json.containsKey("dealCode")) { |
847 dealCode = _json["dealCode"]; | 1117 dealCode = _json["dealCode"]; |
848 } | 1118 } |
849 if (_json.containsKey("kind")) { | 1119 if (_json.containsKey("kind")) { |
850 kind = _json["kind"]; | 1120 kind = _json["kind"]; |
(...skipping 25 matching lines...) Expand all Loading... |
876 } | 1146 } |
877 if (seats != null) { | 1147 if (seats != null) { |
878 _json["seats"] = (seats).toJson(); | 1148 _json["seats"] = (seats).toJson(); |
879 } | 1149 } |
880 return _json; | 1150 return _json; |
881 } | 1151 } |
882 } | 1152 } |
883 | 1153 |
884 /** JSON template for a customer. */ | 1154 /** JSON template for a customer. */ |
885 class Customer { | 1155 class Customer { |
886 /** The alternate email of the customer. */ | 1156 /** |
| 1157 * Like the "Customer email" in the reseller tools, this email is the |
| 1158 * secondary contact used if something happens to the customer's service such |
| 1159 * as service outage or a security issue. This property is required when |
| 1160 * creating a new customer and should not use the same domain as |
| 1161 * customerDomain. |
| 1162 */ |
887 core.String alternateEmail; | 1163 core.String alternateEmail; |
888 /** The domain name of the customer. */ | 1164 /** |
| 1165 * The customer's primary domain name string. customerDomain is required when |
| 1166 * creating a new customer. Do not include the www prefix in the domain when |
| 1167 * adding a customer. |
| 1168 */ |
889 core.String customerDomain; | 1169 core.String customerDomain; |
890 /** Whether the customer's primary domain has been verified. */ | 1170 /** Whether the customer's primary domain has been verified. */ |
891 core.bool customerDomainVerified; | 1171 core.bool customerDomainVerified; |
892 /** The id of the customer. */ | 1172 /** |
| 1173 * This property will always be returned in a response as the unique |
| 1174 * identifier generated by Google. In a request, this property can be either |
| 1175 * the primary domain or the unique identifier generated by Google. |
| 1176 */ |
893 core.String customerId; | 1177 core.String customerId; |
894 /** Identifies the resource as a customer. */ | 1178 /** Identifies the resource as a customer. Value: reseller#customer */ |
895 core.String kind; | 1179 core.String kind; |
896 /** The phone number of the customer. */ | 1180 /** |
| 1181 * Customer contact phone number. This can be continuous numbers, with spaces, |
| 1182 * etc. But it must be a real phone number and not, for example, "123". See |
| 1183 * phone local format conventions. |
| 1184 */ |
897 core.String phoneNumber; | 1185 core.String phoneNumber; |
898 /** The postal address of the customer. */ | 1186 /** |
| 1187 * A customer's address information. Each field has a limit of 255 charcters. |
| 1188 */ |
899 Address postalAddress; | 1189 Address postalAddress; |
900 /** Ui url for customer resource. */ | 1190 /** |
| 1191 * URL to customer's Admin console dashboard. The read-only URL is generated |
| 1192 * by the API service. This is used if your client application requires the |
| 1193 * customer to complete a task in the Admin console. |
| 1194 */ |
901 core.String resourceUiUrl; | 1195 core.String resourceUiUrl; |
902 | 1196 |
903 Customer(); | 1197 Customer(); |
904 | 1198 |
905 Customer.fromJson(core.Map _json) { | 1199 Customer.fromJson(core.Map _json) { |
906 if (_json.containsKey("alternateEmail")) { | 1200 if (_json.containsKey("alternateEmail")) { |
907 alternateEmail = _json["alternateEmail"]; | 1201 alternateEmail = _json["alternateEmail"]; |
908 } | 1202 } |
909 if (_json.containsKey("customerDomain")) { | 1203 if (_json.containsKey("customerDomain")) { |
910 customerDomain = _json["customerDomain"]; | 1204 customerDomain = _json["customerDomain"]; |
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
954 } | 1248 } |
955 if (resourceUiUrl != null) { | 1249 if (resourceUiUrl != null) { |
956 _json["resourceUiUrl"] = resourceUiUrl; | 1250 _json["resourceUiUrl"] = resourceUiUrl; |
957 } | 1251 } |
958 return _json; | 1252 return _json; |
959 } | 1253 } |
960 } | 1254 } |
961 | 1255 |
962 /** JSON template for a subscription renewal settings. */ | 1256 /** JSON template for a subscription renewal settings. */ |
963 class RenewalSettings { | 1257 class RenewalSettings { |
964 /** Identifies the resource as a subscription renewal setting. */ | 1258 /** |
| 1259 * Identifies the resource as a subscription renewal setting. Value: |
| 1260 * subscriptions#renewalSettings |
| 1261 */ |
965 core.String kind; | 1262 core.String kind; |
966 /** Subscription renewal type. */ | 1263 /** |
| 1264 * Renewal settings for the annual commitment plan. For more detailed |
| 1265 * information, see renewal options in the administrator help center. When |
| 1266 * renewing a subscription, the renewalType is a required property. |
| 1267 */ |
967 core.String renewalType; | 1268 core.String renewalType; |
968 | 1269 |
969 RenewalSettings(); | 1270 RenewalSettings(); |
970 | 1271 |
971 RenewalSettings.fromJson(core.Map _json) { | 1272 RenewalSettings.fromJson(core.Map _json) { |
972 if (_json.containsKey("kind")) { | 1273 if (_json.containsKey("kind")) { |
973 kind = _json["kind"]; | 1274 kind = _json["kind"]; |
974 } | 1275 } |
975 if (_json.containsKey("renewalType")) { | 1276 if (_json.containsKey("renewalType")) { |
976 renewalType = _json["renewalType"]; | 1277 renewalType = _json["renewalType"]; |
977 } | 1278 } |
978 } | 1279 } |
979 | 1280 |
980 core.Map toJson() { | 1281 core.Map toJson() { |
981 var _json = new core.Map(); | 1282 var _json = new core.Map(); |
982 if (kind != null) { | 1283 if (kind != null) { |
983 _json["kind"] = kind; | 1284 _json["kind"] = kind; |
984 } | 1285 } |
985 if (renewalType != null) { | 1286 if (renewalType != null) { |
986 _json["renewalType"] = renewalType; | 1287 _json["renewalType"] = renewalType; |
987 } | 1288 } |
988 return _json; | 1289 return _json; |
989 } | 1290 } |
990 } | 1291 } |
991 | 1292 |
| 1293 /** JSON template for resellernotify getwatchdetails response. */ |
| 1294 class ResellernotifyGetwatchdetailsResponse { |
| 1295 /** List of registered service accounts. */ |
| 1296 core.List<core.String> serviceAccountEmailAddresses; |
| 1297 /** Topic name of the PubSub */ |
| 1298 core.String topicName; |
| 1299 |
| 1300 ResellernotifyGetwatchdetailsResponse(); |
| 1301 |
| 1302 ResellernotifyGetwatchdetailsResponse.fromJson(core.Map _json) { |
| 1303 if (_json.containsKey("serviceAccountEmailAddresses")) { |
| 1304 serviceAccountEmailAddresses = _json["serviceAccountEmailAddresses"]; |
| 1305 } |
| 1306 if (_json.containsKey("topicName")) { |
| 1307 topicName = _json["topicName"]; |
| 1308 } |
| 1309 } |
| 1310 |
| 1311 core.Map toJson() { |
| 1312 var _json = new core.Map(); |
| 1313 if (serviceAccountEmailAddresses != null) { |
| 1314 _json["serviceAccountEmailAddresses"] = serviceAccountEmailAddresses; |
| 1315 } |
| 1316 if (topicName != null) { |
| 1317 _json["topicName"] = topicName; |
| 1318 } |
| 1319 return _json; |
| 1320 } |
| 1321 } |
| 1322 |
| 1323 /** JSON template for resellernotify response. */ |
| 1324 class ResellernotifyResource { |
| 1325 /** Topic name of the PubSub */ |
| 1326 core.String topicName; |
| 1327 |
| 1328 ResellernotifyResource(); |
| 1329 |
| 1330 ResellernotifyResource.fromJson(core.Map _json) { |
| 1331 if (_json.containsKey("topicName")) { |
| 1332 topicName = _json["topicName"]; |
| 1333 } |
| 1334 } |
| 1335 |
| 1336 core.Map toJson() { |
| 1337 var _json = new core.Map(); |
| 1338 if (topicName != null) { |
| 1339 _json["topicName"] = topicName; |
| 1340 } |
| 1341 return _json; |
| 1342 } |
| 1343 } |
| 1344 |
992 /** JSON template for subscription seats. */ | 1345 /** JSON template for subscription seats. */ |
993 class Seats { | 1346 class Seats { |
994 /** Identifies the resource as a subscription change plan request. */ | 1347 /** |
| 1348 * Identifies the resource as a subscription change plan request. Value: |
| 1349 * subscriptions#seats |
| 1350 */ |
995 core.String kind; | 1351 core.String kind; |
996 /** | 1352 /** |
997 * Read-only field containing the current number of licensed seats for | 1353 * Read-only field containing the current number of licensed seats for |
998 * FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as | 1354 * FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as |
999 * Google-Vault and Drive-storage. | 1355 * Google-Vault and Drive-storage. |
1000 */ | 1356 */ |
1001 core.int licensedNumberOfSeats; | 1357 core.int licensedNumberOfSeats; |
1002 /** | 1358 /** |
1003 * Maximum number of seats that can be purchased. This needs to be provided | 1359 * The maximumNumberOfSeats property is the maximum number of licenses that |
1004 * only for a non-commitment plan. For a commitment plan it is decided by the | 1360 * the customer can purchase. This property applies to plans other than the |
1005 * contract. | 1361 * annual commitment plan. How a user's licenses are managed depends on the |
| 1362 * subscription's payment plan: |
| 1363 * - annual commitment plan (with monthly or yearly payments) — For this plan, |
| 1364 * a reseller is invoiced on the number of user licenses in the numberOfSeats |
| 1365 * property. The maximumNumberOfSeats property is a read-only property in the |
| 1366 * API's response. |
| 1367 * - flexible plan — For this plan, a reseller is invoiced on the actual |
| 1368 * number of users which is capped by the maximumNumberOfSeats. This is the |
| 1369 * maximum number of user licenses a customer has for user license |
| 1370 * provisioning. This quantity can be increased up to the maximum limit |
| 1371 * defined in the reseller's contract. And the minimum quantity is the current |
| 1372 * number of users in the customer account. |
| 1373 * - 30-day free trial plan — A subscription in a 30-day free trial is |
| 1374 * restricted to maximum 10 seats. |
1006 */ | 1375 */ |
1007 core.int maximumNumberOfSeats; | 1376 core.int maximumNumberOfSeats; |
1008 /** | 1377 /** |
1009 * Number of seats to purchase. This is applicable only for a commitment plan. | 1378 * The numberOfSeats property holds the customer's number of user licenses. |
| 1379 * How a user's licenses are managed depends on the subscription's plan: |
| 1380 * - annual commitment plan (with monthly or yearly pay) — For this plan, a |
| 1381 * reseller is invoiced on the number of user licenses in the numberOfSeats |
| 1382 * property. This is the maximum number of user licenses that a reseller's |
| 1383 * customer can create. The reseller can add more licenses, but once set, the |
| 1384 * numberOfSeats can not be reduced until renewal. The reseller is invoiced |
| 1385 * based on the numberOfSeats value regardless of how many of these user |
| 1386 * licenses are provisioned users. |
| 1387 * - flexible plan — For this plan, a reseller is invoiced on the actual |
| 1388 * number of users which is capped by the maximumNumberOfSeats. The |
| 1389 * numberOfSeats property is not used in the request or response for flexible |
| 1390 * plan customers. |
| 1391 * - 30-day free trial plan — The numberOfSeats property is not used in the |
| 1392 * request or response for an account in a 30-day trial. |
1010 */ | 1393 */ |
1011 core.int numberOfSeats; | 1394 core.int numberOfSeats; |
1012 | 1395 |
1013 Seats(); | 1396 Seats(); |
1014 | 1397 |
1015 Seats.fromJson(core.Map _json) { | 1398 Seats.fromJson(core.Map _json) { |
1016 if (_json.containsKey("kind")) { | 1399 if (_json.containsKey("kind")) { |
1017 kind = _json["kind"]; | 1400 kind = _json["kind"]; |
1018 } | 1401 } |
1019 if (_json.containsKey("licensedNumberOfSeats")) { | 1402 if (_json.containsKey("licensedNumberOfSeats")) { |
(...skipping 18 matching lines...) Expand all Loading... |
1038 if (maximumNumberOfSeats != null) { | 1421 if (maximumNumberOfSeats != null) { |
1039 _json["maximumNumberOfSeats"] = maximumNumberOfSeats; | 1422 _json["maximumNumberOfSeats"] = maximumNumberOfSeats; |
1040 } | 1423 } |
1041 if (numberOfSeats != null) { | 1424 if (numberOfSeats != null) { |
1042 _json["numberOfSeats"] = numberOfSeats; | 1425 _json["numberOfSeats"] = numberOfSeats; |
1043 } | 1426 } |
1044 return _json; | 1427 return _json; |
1045 } | 1428 } |
1046 } | 1429 } |
1047 | 1430 |
1048 /** Interval of the commitment if it is a commitment plan. */ | 1431 /** |
| 1432 * In this version of the API, annual commitment plan's interval is one year. |
| 1433 */ |
1049 class SubscriptionPlanCommitmentInterval { | 1434 class SubscriptionPlanCommitmentInterval { |
1050 /** End time of the commitment interval in milliseconds since Unix epoch. */ | 1435 /** |
| 1436 * An annual commitment plan's interval's endTime in milliseconds using the |
| 1437 * UNIX Epoch format. See an example Epoch converter. |
| 1438 */ |
1051 core.String endTime; | 1439 core.String endTime; |
1052 /** | 1440 /** |
1053 * Start time of the commitment interval in milliseconds since Unix epoch. | 1441 * An annual commitment plan's interval's startTime in milliseconds using UNIX |
| 1442 * Epoch format. See an example Epoch converter. |
1054 */ | 1443 */ |
1055 core.String startTime; | 1444 core.String startTime; |
1056 | 1445 |
1057 SubscriptionPlanCommitmentInterval(); | 1446 SubscriptionPlanCommitmentInterval(); |
1058 | 1447 |
1059 SubscriptionPlanCommitmentInterval.fromJson(core.Map _json) { | 1448 SubscriptionPlanCommitmentInterval.fromJson(core.Map _json) { |
1060 if (_json.containsKey("endTime")) { | 1449 if (_json.containsKey("endTime")) { |
1061 endTime = _json["endTime"]; | 1450 endTime = _json["endTime"]; |
1062 } | 1451 } |
1063 if (_json.containsKey("startTime")) { | 1452 if (_json.containsKey("startTime")) { |
1064 startTime = _json["startTime"]; | 1453 startTime = _json["startTime"]; |
1065 } | 1454 } |
1066 } | 1455 } |
1067 | 1456 |
1068 core.Map toJson() { | 1457 core.Map toJson() { |
1069 var _json = new core.Map(); | 1458 var _json = new core.Map(); |
1070 if (endTime != null) { | 1459 if (endTime != null) { |
1071 _json["endTime"] = endTime; | 1460 _json["endTime"] = endTime; |
1072 } | 1461 } |
1073 if (startTime != null) { | 1462 if (startTime != null) { |
1074 _json["startTime"] = startTime; | 1463 _json["startTime"] = startTime; |
1075 } | 1464 } |
1076 return _json; | 1465 return _json; |
1077 } | 1466 } |
1078 } | 1467 } |
1079 | 1468 |
1080 /** Plan details of the subscription */ | 1469 /** |
| 1470 * The plan property is required. In this version of the API, the G Suite plans |
| 1471 * are the flexible plan, annual commitment plan, and the 30-day free trial |
| 1472 * plan. For more information about the API"s payment plans, see the API |
| 1473 * concepts. |
| 1474 */ |
1081 class SubscriptionPlan { | 1475 class SubscriptionPlan { |
1082 /** Interval of the commitment if it is a commitment plan. */ | 1476 /** |
| 1477 * In this version of the API, annual commitment plan's interval is one year. |
| 1478 */ |
1083 SubscriptionPlanCommitmentInterval commitmentInterval; | 1479 SubscriptionPlanCommitmentInterval commitmentInterval; |
1084 /** Whether the plan is a commitment plan or not. */ | 1480 /** |
| 1481 * The isCommitmentPlan property's boolean value identifies the plan as an |
| 1482 * annual commitment plan: |
| 1483 * - true — The subscription's plan is an annual commitment plan. |
| 1484 * - false — The plan is not an annual commitment plan. |
| 1485 */ |
1085 core.bool isCommitmentPlan; | 1486 core.bool isCommitmentPlan; |
1086 /** The plan name of this subscription's plan. */ | 1487 /** |
| 1488 * The planName property is required. This is the name of the subscription's |
| 1489 * plan. For more information about the Google payment plans, see the API |
| 1490 * concepts. |
| 1491 * |
| 1492 * Possible values are: |
| 1493 * - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments |
| 1494 * - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments |
| 1495 * - FLEXIBLE — The flexible plan |
| 1496 * - TRIAL — The 30-day free trial plan. A subscription in trial will be |
| 1497 * suspended after the 30th free day if no payment plan is assigned. Calling |
| 1498 * changePlan will assign a payment plan to a trial but will not activate the |
| 1499 * plan. A trial will automatically begin its assigned payment plan after its |
| 1500 * 30th free day or immediately after calling startPaidService. |
| 1501 */ |
1087 core.String planName; | 1502 core.String planName; |
1088 | 1503 |
1089 SubscriptionPlan(); | 1504 SubscriptionPlan(); |
1090 | 1505 |
1091 SubscriptionPlan.fromJson(core.Map _json) { | 1506 SubscriptionPlan.fromJson(core.Map _json) { |
1092 if (_json.containsKey("commitmentInterval")) { | 1507 if (_json.containsKey("commitmentInterval")) { |
1093 commitmentInterval = new SubscriptionPlanCommitmentInterval.fromJson(_json
["commitmentInterval"]); | 1508 commitmentInterval = new SubscriptionPlanCommitmentInterval.fromJson(_json
["commitmentInterval"]); |
1094 } | 1509 } |
1095 if (_json.containsKey("isCommitmentPlan")) { | 1510 if (_json.containsKey("isCommitmentPlan")) { |
1096 isCommitmentPlan = _json["isCommitmentPlan"]; | 1511 isCommitmentPlan = _json["isCommitmentPlan"]; |
(...skipping 11 matching lines...) Expand all Loading... |
1108 if (isCommitmentPlan != null) { | 1523 if (isCommitmentPlan != null) { |
1109 _json["isCommitmentPlan"] = isCommitmentPlan; | 1524 _json["isCommitmentPlan"] = isCommitmentPlan; |
1110 } | 1525 } |
1111 if (planName != null) { | 1526 if (planName != null) { |
1112 _json["planName"] = planName; | 1527 _json["planName"] = planName; |
1113 } | 1528 } |
1114 return _json; | 1529 return _json; |
1115 } | 1530 } |
1116 } | 1531 } |
1117 | 1532 |
1118 /** Transfer related information for the subscription. */ | 1533 /** |
| 1534 * Read-only transfer related information for the subscription. For more |
| 1535 * information, see retrieve transferable subscriptions for a customer. |
| 1536 */ |
1119 class SubscriptionTransferInfo { | 1537 class SubscriptionTransferInfo { |
| 1538 /** |
| 1539 * When inserting a subscription, this is the minimum number of seats listed |
| 1540 * in the transfer order for this product. For example, if the customer has 20 |
| 1541 * users, the reseller cannot place a transfer order of 15 seats. The minimum |
| 1542 * is 20 seats. |
| 1543 */ |
1120 core.int minimumTransferableSeats; | 1544 core.int minimumTransferableSeats; |
1121 /** Time when transfer token or intent to transfer will expire. */ | 1545 /** |
| 1546 * The time when transfer token or intent to transfer will expire. The time is |
| 1547 * in milliseconds using UNIX Epoch format. |
| 1548 */ |
1122 core.String transferabilityExpirationTime; | 1549 core.String transferabilityExpirationTime; |
1123 | 1550 |
1124 SubscriptionTransferInfo(); | 1551 SubscriptionTransferInfo(); |
1125 | 1552 |
1126 SubscriptionTransferInfo.fromJson(core.Map _json) { | 1553 SubscriptionTransferInfo.fromJson(core.Map _json) { |
1127 if (_json.containsKey("minimumTransferableSeats")) { | 1554 if (_json.containsKey("minimumTransferableSeats")) { |
1128 minimumTransferableSeats = _json["minimumTransferableSeats"]; | 1555 minimumTransferableSeats = _json["minimumTransferableSeats"]; |
1129 } | 1556 } |
1130 if (_json.containsKey("transferabilityExpirationTime")) { | 1557 if (_json.containsKey("transferabilityExpirationTime")) { |
1131 transferabilityExpirationTime = _json["transferabilityExpirationTime"]; | 1558 transferabilityExpirationTime = _json["transferabilityExpirationTime"]; |
1132 } | 1559 } |
1133 } | 1560 } |
1134 | 1561 |
1135 core.Map toJson() { | 1562 core.Map toJson() { |
1136 var _json = new core.Map(); | 1563 var _json = new core.Map(); |
1137 if (minimumTransferableSeats != null) { | 1564 if (minimumTransferableSeats != null) { |
1138 _json["minimumTransferableSeats"] = minimumTransferableSeats; | 1565 _json["minimumTransferableSeats"] = minimumTransferableSeats; |
1139 } | 1566 } |
1140 if (transferabilityExpirationTime != null) { | 1567 if (transferabilityExpirationTime != null) { |
1141 _json["transferabilityExpirationTime"] = transferabilityExpirationTime; | 1568 _json["transferabilityExpirationTime"] = transferabilityExpirationTime; |
1142 } | 1569 } |
1143 return _json; | 1570 return _json; |
1144 } | 1571 } |
1145 } | 1572 } |
1146 | 1573 |
1147 /** Trial Settings of the subscription. */ | 1574 /** |
| 1575 * The G Suite annual commitment and flexible payment plans can be in a 30-day |
| 1576 * free trial. For more information, see the API concepts. |
| 1577 */ |
1148 class SubscriptionTrialSettings { | 1578 class SubscriptionTrialSettings { |
1149 /** Whether the subscription is in trial. */ | 1579 /** |
| 1580 * Determines if a subscription's plan is in a 30-day free trial or not: |
| 1581 * - true — The plan is in trial. |
| 1582 * - false — The plan is not in trial. |
| 1583 */ |
1150 core.bool isInTrial; | 1584 core.bool isInTrial; |
1151 /** End time of the trial in milliseconds since Unix epoch. */ | 1585 /** |
| 1586 * Date when the trial ends. The value is in milliseconds using the UNIX Epoch |
| 1587 * format. See an example Epoch converter. |
| 1588 */ |
1152 core.String trialEndTime; | 1589 core.String trialEndTime; |
1153 | 1590 |
1154 SubscriptionTrialSettings(); | 1591 SubscriptionTrialSettings(); |
1155 | 1592 |
1156 SubscriptionTrialSettings.fromJson(core.Map _json) { | 1593 SubscriptionTrialSettings.fromJson(core.Map _json) { |
1157 if (_json.containsKey("isInTrial")) { | 1594 if (_json.containsKey("isInTrial")) { |
1158 isInTrial = _json["isInTrial"]; | 1595 isInTrial = _json["isInTrial"]; |
1159 } | 1596 } |
1160 if (_json.containsKey("trialEndTime")) { | 1597 if (_json.containsKey("trialEndTime")) { |
1161 trialEndTime = _json["trialEndTime"]; | 1598 trialEndTime = _json["trialEndTime"]; |
1162 } | 1599 } |
1163 } | 1600 } |
1164 | 1601 |
1165 core.Map toJson() { | 1602 core.Map toJson() { |
1166 var _json = new core.Map(); | 1603 var _json = new core.Map(); |
1167 if (isInTrial != null) { | 1604 if (isInTrial != null) { |
1168 _json["isInTrial"] = isInTrial; | 1605 _json["isInTrial"] = isInTrial; |
1169 } | 1606 } |
1170 if (trialEndTime != null) { | 1607 if (trialEndTime != null) { |
1171 _json["trialEndTime"] = trialEndTime; | 1608 _json["trialEndTime"] = trialEndTime; |
1172 } | 1609 } |
1173 return _json; | 1610 return _json; |
1174 } | 1611 } |
1175 } | 1612 } |
1176 | 1613 |
1177 /** JSON template for a subscription. */ | 1614 /** JSON template for a subscription. */ |
1178 class Subscription { | 1615 class Subscription { |
1179 /** Billing method of this subscription. */ | 1616 /** |
| 1617 * Read-only field that returns the current billing method for a subscription. |
| 1618 */ |
1180 core.String billingMethod; | 1619 core.String billingMethod; |
1181 /** Creation time of this subscription in milliseconds since Unix epoch. */ | 1620 /** |
| 1621 * The creationTime property is the date when subscription was created. It is |
| 1622 * in milliseconds using the Epoch format. See an example Epoch converter. |
| 1623 */ |
1182 core.String creationTime; | 1624 core.String creationTime; |
1183 /** Primary domain name of the customer */ | 1625 /** Primary domain name of the customer */ |
1184 core.String customerDomain; | 1626 core.String customerDomain; |
1185 /** The id of the customer to whom the subscription belongs. */ | 1627 /** |
| 1628 * This property will always be returned in a response as the unique |
| 1629 * identifier generated by Google. In a request, this property can be either |
| 1630 * the primary domain or the unique identifier generated by Google. |
| 1631 */ |
1186 core.String customerId; | 1632 core.String customerId; |
1187 /** | 1633 /** |
1188 * External name of the deal, if this subscription was provisioned under one. | 1634 * Google-issued code (100 char max) for discounted pricing on subscription |
1189 * Otherwise this field will be empty. | 1635 * plans. Deal code must be included in insert requests in order to receive |
| 1636 * discounted rate. This property is optional, regular pricing applies if left |
| 1637 * empty. |
1190 */ | 1638 */ |
1191 core.String dealCode; | 1639 core.String dealCode; |
1192 /** Identifies the resource as a Subscription. */ | 1640 /** |
| 1641 * Identifies the resource as a Subscription. Value: reseller#subscription |
| 1642 */ |
1193 core.String kind; | 1643 core.String kind; |
1194 /** Plan details of the subscription */ | 1644 /** |
| 1645 * The plan property is required. In this version of the API, the G Suite |
| 1646 * plans are the flexible plan, annual commitment plan, and the 30-day free |
| 1647 * trial plan. For more information about the API"s payment plans, see the API |
| 1648 * concepts. |
| 1649 */ |
1195 SubscriptionPlan plan; | 1650 SubscriptionPlan plan; |
1196 /** Purchase order id for your order tracking purposes. */ | 1651 /** |
| 1652 * This is an optional property. This purchase order (PO) information is for |
| 1653 * resellers to use for their company tracking usage. If a purchaseOrderId |
| 1654 * value is given it appears in the API responses and shows up in the invoice. |
| 1655 * The property accepts up to 80 plain text characters. |
| 1656 */ |
1197 core.String purchaseOrderId; | 1657 core.String purchaseOrderId; |
1198 /** Renewal settings of the subscription. */ | 1658 /** |
| 1659 * Renewal settings for the annual commitment plan. For more detailed |
| 1660 * information, see renewal options in the administrator help center. |
| 1661 */ |
1199 RenewalSettings renewalSettings; | 1662 RenewalSettings renewalSettings; |
1200 /** Ui url for subscription resource. */ | 1663 /** |
| 1664 * URL to customer's Subscriptions page in the Admin console. The read-only |
| 1665 * URL is generated by the API service. This is used if your client |
| 1666 * application requires the customer to complete a task using the |
| 1667 * Subscriptions page in the Admin console. |
| 1668 */ |
1201 core.String resourceUiUrl; | 1669 core.String resourceUiUrl; |
1202 /** Number/Limit of seats in the new plan. */ | 1670 /** |
| 1671 * This is a required property. The number and limit of user seat licenses in |
| 1672 * the plan. |
| 1673 */ |
1203 Seats seats; | 1674 Seats seats; |
1204 /** Name of the sku for which this subscription is purchased. */ | 1675 /** |
| 1676 * A required property. The skuId is a unique system identifier for a |
| 1677 * product's SKU assigned to a customer in the subscription. For products and |
| 1678 * SKUs available in this version of the API, see Product and SKU IDs. |
| 1679 */ |
1205 core.String skuId; | 1680 core.String skuId; |
1206 /** Status of the subscription. */ | 1681 /** This is an optional property. */ |
1207 core.String status; | 1682 core.String status; |
1208 /** The id of the subscription. */ | 1683 /** |
| 1684 * The subscriptionId is the subscription identifier and is unique for each |
| 1685 * customer. This is a required property. Since a subscriptionId changes when |
| 1686 * a subscription is updated, we recommend not using this ID as a key for |
| 1687 * persistent data. Use the subscriptionId as described in retrieve all |
| 1688 * reseller subscriptions. |
| 1689 */ |
1209 core.String subscriptionId; | 1690 core.String subscriptionId; |
1210 /** | 1691 /** |
1211 * Read-only field containing an enumerable of all the current suspension | 1692 * Read-only field containing an enumerable of all the current suspension |
1212 * reasons for a subscription. It is possible for a subscription to have many | 1693 * reasons for a subscription. It is possible for a subscription to have many |
1213 * concurrent, overlapping suspension reasons. A subscription's STATUS is | 1694 * concurrent, overlapping suspension reasons. A subscription's STATUS is |
1214 * SUSPENDED until all pending suspensions are removed. Possible options | 1695 * SUSPENDED until all pending suspensions are removed. |
1215 * include: | 1696 * |
| 1697 * Possible options include: |
1216 * - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the | 1698 * - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the |
1217 * Google Apps Resold Terms of Services. | 1699 * G Suite Resold Terms of Services. |
1218 * - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their | 1700 * - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their |
1219 * service was cancelled at the end of their term. | 1701 * service was cancelled at the end of their term. |
1220 * - RESELLER_INITIATED - A manual suspension invoked by a Reseller. | 1702 * - RESELLER_INITIATED - A manual suspension invoked by a Reseller. |
1221 * - TRIAL_ENDED - The customer's trial expired without a plan selected. | 1703 * - TRIAL_ENDED - The customer's trial expired without a plan selected. |
1222 * - OTHER - The customer is suspended for an internal Google reason (e.g. | 1704 * - OTHER - The customer is suspended for an internal Google reason (e.g. |
1223 * abuse or otherwise). | 1705 * abuse or otherwise). |
1224 */ | 1706 */ |
1225 core.List<core.String> suspensionReasons; | 1707 core.List<core.String> suspensionReasons; |
1226 /** Transfer related information for the subscription. */ | 1708 /** |
| 1709 * Read-only transfer related information for the subscription. For more |
| 1710 * information, see retrieve transferable subscriptions for a customer. |
| 1711 */ |
1227 SubscriptionTransferInfo transferInfo; | 1712 SubscriptionTransferInfo transferInfo; |
1228 /** Trial Settings of the subscription. */ | 1713 /** |
| 1714 * The G Suite annual commitment and flexible payment plans can be in a 30-day |
| 1715 * free trial. For more information, see the API concepts. |
| 1716 */ |
1229 SubscriptionTrialSettings trialSettings; | 1717 SubscriptionTrialSettings trialSettings; |
1230 | 1718 |
1231 Subscription(); | 1719 Subscription(); |
1232 | 1720 |
1233 Subscription.fromJson(core.Map _json) { | 1721 Subscription.fromJson(core.Map _json) { |
1234 if (_json.containsKey("billingMethod")) { | 1722 if (_json.containsKey("billingMethod")) { |
1235 billingMethod = _json["billingMethod"]; | 1723 billingMethod = _json["billingMethod"]; |
1236 } | 1724 } |
1237 if (_json.containsKey("creationTime")) { | 1725 if (_json.containsKey("creationTime")) { |
1238 creationTime = _json["creationTime"]; | 1726 creationTime = _json["creationTime"]; |
(...skipping 97 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1336 } | 1824 } |
1337 if (trialSettings != null) { | 1825 if (trialSettings != null) { |
1338 _json["trialSettings"] = (trialSettings).toJson(); | 1826 _json["trialSettings"] = (trialSettings).toJson(); |
1339 } | 1827 } |
1340 return _json; | 1828 return _json; |
1341 } | 1829 } |
1342 } | 1830 } |
1343 | 1831 |
1344 /** JSON template for a subscription list. */ | 1832 /** JSON template for a subscription list. */ |
1345 class Subscriptions { | 1833 class Subscriptions { |
1346 /** Identifies the resource as a collection of subscriptions. */ | 1834 /** |
| 1835 * Identifies the resource as a collection of subscriptions. Value: |
| 1836 * reseller#subscriptions |
| 1837 */ |
1347 core.String kind; | 1838 core.String kind; |
1348 /** | 1839 /** |
1349 * The continuation token, used to page through large result sets. Provide | 1840 * The continuation token, used to page through large result sets. Provide |
1350 * this value in a subsequent request to return the next page of results. | 1841 * this value in a subsequent request to return the next page of results. |
1351 */ | 1842 */ |
1352 core.String nextPageToken; | 1843 core.String nextPageToken; |
1353 /** The subscriptions in this page of results. */ | 1844 /** The subscriptions in this page of results. */ |
1354 core.List<Subscription> subscriptions; | 1845 core.List<Subscription> subscriptions; |
1355 | 1846 |
1356 Subscriptions(); | 1847 Subscriptions(); |
(...skipping 17 matching lines...) Expand all Loading... |
1374 } | 1865 } |
1375 if (nextPageToken != null) { | 1866 if (nextPageToken != null) { |
1376 _json["nextPageToken"] = nextPageToken; | 1867 _json["nextPageToken"] = nextPageToken; |
1377 } | 1868 } |
1378 if (subscriptions != null) { | 1869 if (subscriptions != null) { |
1379 _json["subscriptions"] = subscriptions.map((value) => (value).toJson()).to
List(); | 1870 _json["subscriptions"] = subscriptions.map((value) => (value).toJson()).to
List(); |
1380 } | 1871 } |
1381 return _json; | 1872 return _json; |
1382 } | 1873 } |
1383 } | 1874 } |
OLD | NEW |