google-apis-reseller_v1 0.1.0 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/lib/google/apis/reseller_v1/classes.rb +100 -92
- data/lib/google/apis/reseller_v1/gem_version.rb +3 -3
- data/lib/google/apis/reseller_v1/service.rb +169 -107
- metadata +4 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9678e87f16b28b66f3d77c9442ac135070c81e2bc33e0fe1f5d1708ea507875a
|
|
4
|
+
data.tar.gz: 8bfd109df155b3196e3febaa569bce20eb8972b368bf70f4f9774eec36230c6a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5a0219f02fcac8d5e5470dce44d59ba626d80f8cef6a7ccfb1c5b21df9afd0801e9990216259353fffb2013828ae2ecbab661f1b7ca7ae5bc5c51a6171dead83
|
|
7
|
+
data.tar.gz: 1fe3014b682585ead46edcb09bb306adfd32b6f1b42698f6c726128fabf1a938f76d2ea100297bb0b66d4a46c18cd39eba0501881c96022b66eac53ea7c33133
|
data/CHANGELOG.md
CHANGED
|
@@ -27,7 +27,7 @@ module Google
|
|
|
27
27
|
include Google::Apis::Core::Hashable
|
|
28
28
|
|
|
29
29
|
# A customer's physical address. An address can be composed of one to three
|
|
30
|
-
# lines. The addressline2 and addressLine3 are optional.
|
|
30
|
+
# lines. The `addressline2` and `addressLine3` are optional.
|
|
31
31
|
# Corresponds to the JSON property `addressLine1`
|
|
32
32
|
# @return [String]
|
|
33
33
|
attr_accessor :address_line1
|
|
@@ -47,19 +47,19 @@ module Google
|
|
|
47
47
|
# @return [String]
|
|
48
48
|
attr_accessor :contact_name
|
|
49
49
|
|
|
50
|
-
# For countryCode information, see the ISO 3166 country code elements. Verify
|
|
50
|
+
# For `countryCode` information, see the ISO 3166 country code elements. Verify
|
|
51
51
|
# that country is approved for resale of Google products. This property is
|
|
52
52
|
# required when creating a new customer.
|
|
53
53
|
# Corresponds to the JSON property `countryCode`
|
|
54
54
|
# @return [String]
|
|
55
55
|
attr_accessor :country_code
|
|
56
56
|
|
|
57
|
-
# Identifies the resource as a customer address. Value: customers#address
|
|
57
|
+
# Identifies the resource as a customer address. Value: `customers#address`
|
|
58
58
|
# Corresponds to the JSON property `kind`
|
|
59
59
|
# @return [String]
|
|
60
60
|
attr_accessor :kind
|
|
61
61
|
|
|
62
|
-
# An example of a locality value is the city of San Francisco
|
|
62
|
+
# An example of a `locality` value is the city of `San Francisco`.
|
|
63
63
|
# Corresponds to the JSON property `locality`
|
|
64
64
|
# @return [String]
|
|
65
65
|
attr_accessor :locality
|
|
@@ -69,13 +69,13 @@ module Google
|
|
|
69
69
|
# @return [String]
|
|
70
70
|
attr_accessor :organization_name
|
|
71
71
|
|
|
72
|
-
# A postalCode example is a postal zip code such as 94043
|
|
72
|
+
# A `postalCode` example is a postal zip code such as `94043`. This property is
|
|
73
73
|
# required when creating a new customer.
|
|
74
74
|
# Corresponds to the JSON property `postalCode`
|
|
75
75
|
# @return [String]
|
|
76
76
|
attr_accessor :postal_code
|
|
77
77
|
|
|
78
|
-
# An example of a region value is CA for the state of California.
|
|
78
|
+
# An example of a `region` value is `CA` for the state of California.
|
|
79
79
|
# Corresponds to the JSON property `region`
|
|
80
80
|
# @return [String]
|
|
81
81
|
attr_accessor :region
|
|
@@ -104,7 +104,7 @@ module Google
|
|
|
104
104
|
include Google::Apis::Core::Hashable
|
|
105
105
|
|
|
106
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
|
|
107
|
+
# Deal code must be included in `changePlan` request in order to receive
|
|
108
108
|
# discounted rate. This property is optional. If a deal code has already been
|
|
109
109
|
# added to a subscription, this property may be left empty and the existing
|
|
110
110
|
# discounted rate will still apply (if not empty, only provide the deal code
|
|
@@ -115,27 +115,27 @@ module Google
|
|
|
115
115
|
# @return [String]
|
|
116
116
|
attr_accessor :deal_code
|
|
117
117
|
|
|
118
|
-
# Identifies the resource as a subscription change plan request. Value:
|
|
119
|
-
# subscriptions#changePlanRequest
|
|
118
|
+
# Identifies the resource as a subscription change plan request. Value: `
|
|
119
|
+
# subscriptions#changePlanRequest`
|
|
120
120
|
# Corresponds to the JSON property `kind`
|
|
121
121
|
# @return [String]
|
|
122
122
|
attr_accessor :kind
|
|
123
123
|
|
|
124
|
-
# The planName property is required. This is the name of the subscription's
|
|
124
|
+
# The `planName` property is required. This is the name of the subscription's
|
|
125
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:
|
|
128
|
-
# in all API responses. - ANNUAL_YEARLY_PAY - The annual commitment
|
|
129
|
-
# yearly payments - FLEXIBLE - The flexible plan - TRIAL - The 30-
|
|
130
|
-
# plan
|
|
126
|
+
# concepts. Possible values are: - `ANNUAL_MONTHLY_PAY` - The annual commitment
|
|
127
|
+
# plan with monthly payments *Caution: *`ANNUAL_MONTHLY_PAY` is returned as `
|
|
128
|
+
# ANNUAL` in all API responses. - `ANNUAL_YEARLY_PAY` - The annual commitment
|
|
129
|
+
# plan with yearly payments - `FLEXIBLE` - The flexible plan - `TRIAL` - The 30-
|
|
130
|
+
# day free trial plan
|
|
131
131
|
# Corresponds to the JSON property `planName`
|
|
132
132
|
# @return [String]
|
|
133
133
|
attr_accessor :plan_name
|
|
134
134
|
|
|
135
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
|
|
137
|
-
# is given it appears in the API responses and shows up in the invoice.
|
|
138
|
-
# property accepts up to 80 plain text characters.
|
|
136
|
+
# resellers to use for their company tracking usage. If a `purchaseOrderId`
|
|
137
|
+
# value is given it appears in the API responses and shows up in the invoice.
|
|
138
|
+
# The property accepts up to 80 plain text characters.
|
|
139
139
|
# Corresponds to the JSON property `purchaseOrderId`
|
|
140
140
|
# @return [String]
|
|
141
141
|
attr_accessor :purchase_order_id
|
|
@@ -159,20 +159,22 @@ module Google
|
|
|
159
159
|
end
|
|
160
160
|
end
|
|
161
161
|
|
|
162
|
-
#
|
|
162
|
+
# When a Google customer's account is registered with a reseller, the customer's
|
|
163
|
+
# subscriptions for Google services are managed by this reseller. A customer is
|
|
164
|
+
# described by a primary domain name and a physical address.
|
|
163
165
|
class Customer
|
|
164
166
|
include Google::Apis::Core::Hashable
|
|
165
167
|
|
|
166
168
|
# Like the "Customer email" in the reseller tools, this email is the secondary
|
|
167
169
|
# contact used if something happens to the customer's service such as service
|
|
168
170
|
# outage or a security issue. This property is required when creating a new
|
|
169
|
-
# customer and should not use the same domain as customerDomain
|
|
171
|
+
# customer and should not use the same domain as `customerDomain`.
|
|
170
172
|
# Corresponds to the JSON property `alternateEmail`
|
|
171
173
|
# @return [String]
|
|
172
174
|
attr_accessor :alternate_email
|
|
173
175
|
|
|
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
|
+
# The customer's primary domain name string. `customerDomain` is required when
|
|
177
|
+
# creating a new customer. Do not include the `www` prefix in the domain when
|
|
176
178
|
# adding a customer.
|
|
177
179
|
# Corresponds to the JSON property `customerDomain`
|
|
178
180
|
# @return [String]
|
|
@@ -191,7 +193,7 @@ module Google
|
|
|
191
193
|
# @return [String]
|
|
192
194
|
attr_accessor :customer_id
|
|
193
195
|
|
|
194
|
-
# Identifies the resource as a customer. Value: reseller#customer
|
|
196
|
+
# Identifies the resource as a customer. Value: `reseller#customer`
|
|
195
197
|
# Corresponds to the JSON property `kind`
|
|
196
198
|
# @return [String]
|
|
197
199
|
attr_accessor :kind
|
|
@@ -237,15 +239,15 @@ module Google
|
|
|
237
239
|
class RenewalSettings
|
|
238
240
|
include Google::Apis::Core::Hashable
|
|
239
241
|
|
|
240
|
-
# Identifies the resource as a subscription renewal setting. Value:
|
|
241
|
-
# subscriptions#renewalSettings
|
|
242
|
+
# Identifies the resource as a subscription renewal setting. Value: `
|
|
243
|
+
# subscriptions#renewalSettings`
|
|
242
244
|
# Corresponds to the JSON property `kind`
|
|
243
245
|
# @return [String]
|
|
244
246
|
attr_accessor :kind
|
|
245
247
|
|
|
246
248
|
# Renewal settings for the annual commitment plan. For more detailed information,
|
|
247
249
|
# see renewal options in the administrator help center. When renewing a
|
|
248
|
-
# subscription, the renewalType is a required property.
|
|
250
|
+
# subscription, the `renewalType` is a required property.
|
|
249
251
|
# Corresponds to the JSON property `renewalType`
|
|
250
252
|
# @return [String]
|
|
251
253
|
attr_accessor :renewal_type
|
|
@@ -309,37 +311,38 @@ module Google
|
|
|
309
311
|
class Seats
|
|
310
312
|
include Google::Apis::Core::Hashable
|
|
311
313
|
|
|
312
|
-
# Identifies the resource as a subscription seat setting. Value: subscriptions#
|
|
313
|
-
# seats
|
|
314
|
+
# Identifies the resource as a subscription seat setting. Value: `subscriptions#
|
|
315
|
+
# seats`
|
|
314
316
|
# Corresponds to the JSON property `kind`
|
|
315
317
|
# @return [String]
|
|
316
318
|
attr_accessor :kind
|
|
317
319
|
|
|
318
320
|
# Read-only field containing the current number of users that are assigned a
|
|
319
|
-
# license for the product defined in skuId
|
|
320
|
-
# the numerical count of users returned by the Enterprise License Manager API
|
|
321
|
-
# method: listForProductAndSku
|
|
321
|
+
# license for the product defined in `skuId`. This field's value is equivalent
|
|
322
|
+
# to the numerical count of users returned by the Enterprise License Manager API
|
|
323
|
+
# method: [`listForProductAndSku`](/admin-sdk/licensing/v1/reference/
|
|
324
|
+
# licenseAssignments/listForProductAndSku).
|
|
322
325
|
# Corresponds to the JSON property `licensedNumberOfSeats`
|
|
323
326
|
# @return [Fixnum]
|
|
324
327
|
attr_accessor :licensed_number_of_seats
|
|
325
328
|
|
|
326
|
-
# This is a required property and is exclusive to subscriptions with FLEXIBLE
|
|
327
|
-
# TRIAL plans. This property sets the maximum number of licensed users
|
|
328
|
-
# on a subscription. This quantity can be increased up to the maximum
|
|
329
|
-
# defined in the reseller's contract. The minimum quantity is the current
|
|
330
|
-
# of users in the customer account. *Note: *G Suite subscriptions
|
|
331
|
-
# assign a license to every user.
|
|
329
|
+
# This is a required property and is exclusive to subscriptions with `FLEXIBLE`
|
|
330
|
+
# or `TRIAL` plans. This property sets the maximum number of licensed users
|
|
331
|
+
# allowed on a subscription. This quantity can be increased up to the maximum
|
|
332
|
+
# limit defined in the reseller's contract. The minimum quantity is the current
|
|
333
|
+
# number of users in the customer account. *Note: *G Suite subscriptions
|
|
334
|
+
# automatically assign a license to every user.
|
|
332
335
|
# Corresponds to the JSON property `maximumNumberOfSeats`
|
|
333
336
|
# @return [Fixnum]
|
|
334
337
|
attr_accessor :maximum_number_of_seats
|
|
335
338
|
|
|
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
|
|
338
|
-
# number of licenses assignable to users on a subscription. The reseller
|
|
339
|
-
# more licenses, but once set, the numberOfSeats cannot be reduced
|
|
340
|
-
# The reseller is invoiced based on the numberOfSeats value
|
|
341
|
-
# many of these user licenses are assigned. *Note: *G Suite
|
|
342
|
-
# automatically assign a license to every user.
|
|
339
|
+
# This is a required property and is exclusive to subscriptions with `
|
|
340
|
+
# ANNUAL_MONTHLY_PAY` and `ANNUAL_YEARLY_PAY` plans. This property sets the
|
|
341
|
+
# maximum number of licenses assignable to users on a subscription. The reseller
|
|
342
|
+
# can add more licenses, but once set, the `numberOfSeats` cannot be reduced
|
|
343
|
+
# until renewal. The reseller is invoiced based on the `numberOfSeats` value
|
|
344
|
+
# regardless of how many of these user licenses are assigned. *Note: *G Suite
|
|
345
|
+
# subscriptions automatically assign a license to every user.
|
|
343
346
|
# Corresponds to the JSON property `numberOfSeats`
|
|
344
347
|
# @return [Fixnum]
|
|
345
348
|
attr_accessor :number_of_seats
|
|
@@ -366,8 +369,8 @@ module Google
|
|
|
366
369
|
# @return [String]
|
|
367
370
|
attr_accessor :billing_method
|
|
368
371
|
|
|
369
|
-
# The creationTime property is the date when subscription was created. It is
|
|
370
|
-
# milliseconds using the Epoch format. See an example Epoch converter.
|
|
372
|
+
# The `creationTime` property is the date when subscription was created. It is
|
|
373
|
+
# in milliseconds using the Epoch format. See an example Epoch converter.
|
|
371
374
|
# Corresponds to the JSON property `creationTime`
|
|
372
375
|
# @return [Fixnum]
|
|
373
376
|
attr_accessor :creation_time
|
|
@@ -385,18 +388,19 @@ module Google
|
|
|
385
388
|
attr_accessor :customer_id
|
|
386
389
|
|
|
387
390
|
# 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
|
|
389
|
-
# rate. This property is optional, regular pricing applies if left
|
|
391
|
+
# Deal code must be included in `insert` requests in order to receive
|
|
392
|
+
# discounted rate. This property is optional, regular pricing applies if left
|
|
393
|
+
# empty.
|
|
390
394
|
# Corresponds to the JSON property `dealCode`
|
|
391
395
|
# @return [String]
|
|
392
396
|
attr_accessor :deal_code
|
|
393
397
|
|
|
394
|
-
# Identifies the resource as a Subscription. Value: reseller#subscription
|
|
398
|
+
# Identifies the resource as a Subscription. Value: `reseller#subscription`
|
|
395
399
|
# Corresponds to the JSON property `kind`
|
|
396
400
|
# @return [String]
|
|
397
401
|
attr_accessor :kind
|
|
398
402
|
|
|
399
|
-
# The plan property is required. In this version of the API, the G Suite plans
|
|
403
|
+
# The `plan` property is required. In this version of the API, the G Suite plans
|
|
400
404
|
# are the flexible plan, annual commitment plan, and the 30-day free trial plan.
|
|
401
405
|
# For more information about the API"s payment plans, see the API concepts.
|
|
402
406
|
# Corresponds to the JSON property `plan`
|
|
@@ -404,9 +408,9 @@ module Google
|
|
|
404
408
|
attr_accessor :plan
|
|
405
409
|
|
|
406
410
|
# This is an optional property. This purchase order (PO) information is for
|
|
407
|
-
# resellers to use for their company tracking usage. If a purchaseOrderId
|
|
408
|
-
# is given it appears in the API responses and shows up in the invoice.
|
|
409
|
-
# property accepts up to 80 plain text characters.
|
|
411
|
+
# resellers to use for their company tracking usage. If a `purchaseOrderId`
|
|
412
|
+
# value is given it appears in the API responses and shows up in the invoice.
|
|
413
|
+
# The property accepts up to 80 plain text characters.
|
|
410
414
|
# Corresponds to the JSON property `purchaseOrderId`
|
|
411
415
|
# @return [String]
|
|
412
416
|
attr_accessor :purchase_order_id
|
|
@@ -429,7 +433,7 @@ module Google
|
|
|
429
433
|
# @return [Google::Apis::ResellerV1::Seats]
|
|
430
434
|
attr_accessor :seats
|
|
431
435
|
|
|
432
|
-
# A required property. The skuId is a unique system identifier for a product's
|
|
436
|
+
# A required property. The `skuId` is a unique system identifier for a product's
|
|
433
437
|
# SKU assigned to a customer in the subscription. For products and SKUs
|
|
434
438
|
# available in this version of the API, see Product and SKU IDs.
|
|
435
439
|
# Corresponds to the JSON property `skuId`
|
|
@@ -449,25 +453,26 @@ module Google
|
|
|
449
453
|
# @return [String]
|
|
450
454
|
attr_accessor :status
|
|
451
455
|
|
|
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
|
|
456
|
+
# The `subscriptionId` is the subscription identifier and is unique for each
|
|
457
|
+
# customer. This is a required property. Since a `subscriptionId` changes when a
|
|
454
458
|
# subscription is updated, we recommend not using this ID as a key for
|
|
455
|
-
# persistent data. Use the subscriptionId as described in retrieve all
|
|
456
|
-
# subscriptions.
|
|
459
|
+
# persistent data. Use the `subscriptionId` as described in retrieve all
|
|
460
|
+
# reseller subscriptions.
|
|
457
461
|
# Corresponds to the JSON property `subscriptionId`
|
|
458
462
|
# @return [String]
|
|
459
463
|
attr_accessor :subscription_id
|
|
460
464
|
|
|
461
465
|
# Read-only field containing an enumerable of all the current suspension reasons
|
|
462
466
|
# for a subscription. It is possible for a subscription to have many concurrent,
|
|
463
|
-
# overlapping suspension reasons. A subscription's STATUS is SUSPENDED until
|
|
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. -
|
|
469
|
-
# The customer's trial expired without a plan selected. - OTHER
|
|
470
|
-
# is suspended for an internal Google reason (e.g. abuse or
|
|
467
|
+
# overlapping suspension reasons. A subscription's `STATUS` is `SUSPENDED` until
|
|
468
|
+
# all pending suspensions are removed. Possible options include: - `
|
|
469
|
+
# PENDING_TOS_ACCEPTANCE` - The customer has not logged in and accepted the G
|
|
470
|
+
# Suite Resold Terms of Services. - `RENEWAL_WITH_TYPE_CANCEL` - The customer's
|
|
471
|
+
# commitment ended and their service was cancelled at the end of their term. - `
|
|
472
|
+
# RESELLER_INITIATED` - A manual suspension invoked by a Reseller. - `
|
|
473
|
+
# TRIAL_ENDED` - The customer's trial expired without a plan selected. - `OTHER`
|
|
474
|
+
# - The customer is suspended for an internal Google reason (e.g. abuse or
|
|
475
|
+
# otherwise).
|
|
471
476
|
# Corresponds to the JSON property `suspensionReasons`
|
|
472
477
|
# @return [Array<String>]
|
|
473
478
|
attr_accessor :suspension_reasons
|
|
@@ -510,39 +515,39 @@ module Google
|
|
|
510
515
|
@trial_settings = args[:trial_settings] if args.key?(:trial_settings)
|
|
511
516
|
end
|
|
512
517
|
|
|
513
|
-
# The plan property is required. In this version of the API, the G Suite plans
|
|
518
|
+
# The `plan` property is required. In this version of the API, the G Suite plans
|
|
514
519
|
# are the flexible plan, annual commitment plan, and the 30-day free trial plan.
|
|
515
520
|
# For more information about the API"s payment plans, see the API concepts.
|
|
516
521
|
class Plan
|
|
517
522
|
include Google::Apis::Core::Hashable
|
|
518
523
|
|
|
519
524
|
# In this version of the API, annual commitment plan's interval is one year. *
|
|
520
|
-
# Note: *When billingMethod value is OFFLINE
|
|
521
|
-
# plan.commitmentInterval is omitted in all API responses.
|
|
525
|
+
# Note: *When `billingMethod` value is `OFFLINE`, the subscription property
|
|
526
|
+
# object `plan.commitmentInterval` is omitted in all API responses.
|
|
522
527
|
# Corresponds to the JSON property `commitmentInterval`
|
|
523
528
|
# @return [Google::Apis::ResellerV1::Subscription::Plan::CommitmentInterval]
|
|
524
529
|
attr_accessor :commitment_interval
|
|
525
530
|
|
|
526
|
-
# The isCommitmentPlan property's boolean value identifies the plan as an
|
|
527
|
-
# commitment plan: - true — The subscription's plan is an annual
|
|
528
|
-
# - false — The plan is not an annual commitment plan.
|
|
531
|
+
# The `isCommitmentPlan` property's boolean value identifies the plan as an
|
|
532
|
+
# annual commitment plan: - `true` — The subscription's plan is an annual
|
|
533
|
+
# commitment plan. - `false` — The plan is not an annual commitment plan.
|
|
529
534
|
# Corresponds to the JSON property `isCommitmentPlan`
|
|
530
535
|
# @return [Boolean]
|
|
531
536
|
attr_accessor :is_commitment_plan
|
|
532
537
|
alias_method :is_commitment_plan?, :is_commitment_plan
|
|
533
538
|
|
|
534
|
-
# The planName property is required. This is the name of the subscription's
|
|
535
|
-
# For more information about the Google payment plans, see the API
|
|
536
|
-
# Possible values are: - ANNUAL_MONTHLY_PAY — The annual commitment
|
|
537
|
-
# monthly payments. *Caution:
|
|
538
|
-
# API responses. - ANNUAL_YEARLY_PAY — The annual commitment
|
|
539
|
-
# payments - FLEXIBLE — The flexible plan - TRIAL — The 30-
|
|
540
|
-
# A subscription in trial will be suspended after the 30th
|
|
541
|
-
# payment plan is assigned. Calling changePlan will assign a
|
|
542
|
-
# trial but will not activate the plan. A trial will
|
|
543
|
-
# assigned payment plan after its 30th free day or
|
|
544
|
-
# startPaidService
|
|
545
|
-
# SKU and does not incur any billing.
|
|
539
|
+
# The `planName` property is required. This is the name of the subscription's
|
|
540
|
+
# plan. For more information about the Google payment plans, see the API
|
|
541
|
+
# concepts. Possible values are: - `ANNUAL_MONTHLY_PAY` — The annual commitment
|
|
542
|
+
# plan with monthly payments. *Caution: *`ANNUAL_MONTHLY_PAY` is returned as `
|
|
543
|
+
# ANNUAL` in all API responses. - `ANNUAL_YEARLY_PAY` — The annual commitment
|
|
544
|
+
# plan with yearly payments - `FLEXIBLE` — The flexible plan - `TRIAL` — The 30-
|
|
545
|
+
# day free trial plan. A subscription in trial will be suspended after the 30th
|
|
546
|
+
# free day if no payment plan is assigned. Calling `changePlan` will assign a
|
|
547
|
+
# payment plan to a trial but will not activate the plan. A trial will
|
|
548
|
+
# automatically begin its assigned payment plan after its 30th free day or
|
|
549
|
+
# immediately after calling `startPaidService`. - `FREE` — The free plan is
|
|
550
|
+
# exclusive to the Cloud Identity SKU and does not incur any billing.
|
|
546
551
|
# Corresponds to the JSON property `planName`
|
|
547
552
|
# @return [String]
|
|
548
553
|
attr_accessor :plan_name
|
|
@@ -559,18 +564,18 @@ module Google
|
|
|
559
564
|
end
|
|
560
565
|
|
|
561
566
|
# In this version of the API, annual commitment plan's interval is one year. *
|
|
562
|
-
# Note: *When billingMethod value is OFFLINE
|
|
563
|
-
# plan.commitmentInterval is omitted in all API responses.
|
|
567
|
+
# Note: *When `billingMethod` value is `OFFLINE`, the subscription property
|
|
568
|
+
# object `plan.commitmentInterval` is omitted in all API responses.
|
|
564
569
|
class CommitmentInterval
|
|
565
570
|
include Google::Apis::Core::Hashable
|
|
566
571
|
|
|
567
|
-
# An annual commitment plan's interval's endTime in milliseconds using the
|
|
568
|
-
# Epoch format. See an example Epoch converter.
|
|
572
|
+
# An annual commitment plan's interval's `endTime` in milliseconds using the
|
|
573
|
+
# UNIX Epoch format. See an example Epoch converter.
|
|
569
574
|
# Corresponds to the JSON property `endTime`
|
|
570
575
|
# @return [Fixnum]
|
|
571
576
|
attr_accessor :end_time
|
|
572
577
|
|
|
573
|
-
# An annual commitment plan's interval's startTime in milliseconds using UNIX
|
|
578
|
+
# An annual commitment plan's interval's `startTime` in milliseconds using UNIX
|
|
574
579
|
# Epoch format. See an example Epoch converter.
|
|
575
580
|
# Corresponds to the JSON property `startTime`
|
|
576
581
|
# @return [Fixnum]
|
|
@@ -623,8 +628,8 @@ module Google
|
|
|
623
628
|
class TrialSettings
|
|
624
629
|
include Google::Apis::Core::Hashable
|
|
625
630
|
|
|
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.
|
|
631
|
+
# Determines if a subscription's plan is in a 30-day free trial or not: - `true`
|
|
632
|
+
# — The plan is in trial. - `false` — The plan is not in trial.
|
|
628
633
|
# Corresponds to the JSON property `isInTrial`
|
|
629
634
|
# @return [Boolean]
|
|
630
635
|
attr_accessor :is_in_trial
|
|
@@ -648,7 +653,10 @@ module Google
|
|
|
648
653
|
end
|
|
649
654
|
end
|
|
650
655
|
|
|
651
|
-
#
|
|
656
|
+
# A subscription manages the relationship of a Google customer's payment plan
|
|
657
|
+
# with a product's SKU, user licenses, 30-day free trial status, and renewal
|
|
658
|
+
# options. A primary role of a reseller is to manage the Google customer's
|
|
659
|
+
# subscriptions.
|
|
652
660
|
class Subscriptions
|
|
653
661
|
include Google::Apis::Core::Hashable
|
|
654
662
|
|
|
@@ -16,13 +16,13 @@ module Google
|
|
|
16
16
|
module Apis
|
|
17
17
|
module ResellerV1
|
|
18
18
|
# Version of the google-apis-reseller_v1 gem
|
|
19
|
-
GEM_VERSION = "0.
|
|
19
|
+
GEM_VERSION = "0.2.0"
|
|
20
20
|
|
|
21
21
|
# Version of the code generator used to generate this client
|
|
22
|
-
GENERATOR_VERSION = "0.1.
|
|
22
|
+
GENERATOR_VERSION = "0.1.2"
|
|
23
23
|
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
|
25
|
-
REVISION = "
|
|
25
|
+
REVISION = "20210206"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -50,12 +50,16 @@ module Google
|
|
|
50
50
|
@batch_path = 'batch'
|
|
51
51
|
end
|
|
52
52
|
|
|
53
|
-
# Get a customer account.
|
|
53
|
+
# Get a customer account. Use this operation to see a customer account already
|
|
54
|
+
# in your reseller management, or to see the minimal account information for an
|
|
55
|
+
# existing customer that you do not manage. For more information about the API
|
|
56
|
+
# response for existing customers, see [retrieving a customer account](/admin-
|
|
57
|
+
# sdk/reseller/v1/how-tos/manage_customers#get_customer).
|
|
54
58
|
# @param [String] customer_id
|
|
55
59
|
# Either the customer's primary domain name or the customer's unique identifier.
|
|
56
|
-
# If using the domain name, we do not recommend using a customerId as a key
|
|
57
|
-
# persistent data. If the domain name for a customerId is changed, the
|
|
58
|
-
# system automatically updates.
|
|
60
|
+
# If using the domain name, we do not recommend using a `customerId` as a key
|
|
61
|
+
# for persistent data. If the domain name for a `customerId` is changed, the
|
|
62
|
+
# Google system automatically updates.
|
|
59
63
|
# @param [String] fields
|
|
60
64
|
# Selector specifying which fields to include in a partial response.
|
|
61
65
|
# @param [String] quota_user
|
|
@@ -83,14 +87,28 @@ module Google
|
|
|
83
87
|
execute_or_queue_command(command, &block)
|
|
84
88
|
end
|
|
85
89
|
|
|
86
|
-
# Order a new customer's account.
|
|
90
|
+
# Order a new customer's account. Before ordering a new customer account,
|
|
91
|
+
# establish whether the customer account already exists using the [`customers.
|
|
92
|
+
# get`](/admin-sdk/reseller/v1/reference/customers/get) If the customer account
|
|
93
|
+
# exists as a direct Google account or as a resold customer account from another
|
|
94
|
+
# reseller, use the `customerAuthToken\` as described in [order a resold account
|
|
95
|
+
# for an existing customer](/admin-sdk/reseller/v1/how-tos/manage_customers#
|
|
96
|
+
# create_existing_customer). For more information about ordering a new customer
|
|
97
|
+
# account, see [order a new customer account](/admin-sdk/reseller/v1/how-tos/
|
|
98
|
+
# manage_customers#create_customer). After creating a new customer account, you
|
|
99
|
+
# must provision a user as an administrator. The customer's administrator is
|
|
100
|
+
# required to sign in to the Admin console and sign the G Suite via Reseller
|
|
101
|
+
# agreement to activate the account. Resellers are prohibited from signing the G
|
|
102
|
+
# Suite via Reseller agreement on the customer's behalf. For more information,
|
|
103
|
+
# see [order a new customer account](/admin-sdk/reseller/v1/how-tos/
|
|
104
|
+
# manage_customers#tos).
|
|
87
105
|
# @param [Google::Apis::ResellerV1::Customer] customer_object
|
|
88
106
|
# @param [String] customer_auth_token
|
|
89
|
-
# The customerAuthToken query string is required when creating a resold
|
|
90
|
-
# that transfers a direct customer's subscription or transfers another
|
|
91
|
-
# customer's subscription to your reseller management. This is a
|
|
92
|
-
# authentication token needed to complete the subscription transfer.
|
|
93
|
-
# information, see the administrator help center.
|
|
107
|
+
# The `customerAuthToken` query string is required when creating a resold
|
|
108
|
+
# account that transfers a direct customer's subscription or transfers another
|
|
109
|
+
# reseller customer's subscription to your reseller management. This is a
|
|
110
|
+
# hexadecimal authentication token needed to complete the subscription transfer.
|
|
111
|
+
# For more information, see the administrator help center.
|
|
94
112
|
# @param [String] fields
|
|
95
113
|
# Selector specifying which fields to include in a partial response.
|
|
96
114
|
# @param [String] quota_user
|
|
@@ -120,12 +138,12 @@ module Google
|
|
|
120
138
|
execute_or_queue_command(command, &block)
|
|
121
139
|
end
|
|
122
140
|
|
|
123
|
-
#
|
|
141
|
+
# Update a customer account's settings. This method supports patch semantics.
|
|
124
142
|
# @param [String] customer_id
|
|
125
143
|
# Either the customer's primary domain name or the customer's unique identifier.
|
|
126
|
-
# If using the domain name, we do not recommend using a customerId as a key
|
|
127
|
-
# persistent data. If the domain name for a customerId is changed, the
|
|
128
|
-
# system automatically updates.
|
|
144
|
+
# If using the domain name, we do not recommend using a `customerId` as a key
|
|
145
|
+
# for persistent data. If the domain name for a `customerId` is changed, the
|
|
146
|
+
# Google system automatically updates.
|
|
129
147
|
# @param [Google::Apis::ResellerV1::Customer] customer_object
|
|
130
148
|
# @param [String] fields
|
|
131
149
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -156,12 +174,14 @@ module Google
|
|
|
156
174
|
execute_or_queue_command(command, &block)
|
|
157
175
|
end
|
|
158
176
|
|
|
159
|
-
# Update a customer account's settings.
|
|
177
|
+
# Update a customer account's settings. For more information, see [update a
|
|
178
|
+
# customer's settings](/admin-sdk/reseller/v1/how-tos/manage_customers#
|
|
179
|
+
# update_customer).
|
|
160
180
|
# @param [String] customer_id
|
|
161
181
|
# Either the customer's primary domain name or the customer's unique identifier.
|
|
162
|
-
# If using the domain name, we do not recommend using a customerId as a key
|
|
163
|
-
# persistent data. If the domain name for a customerId is changed, the
|
|
164
|
-
# system automatically updates.
|
|
182
|
+
# If using the domain name, we do not recommend using a `customerId` as a key
|
|
183
|
+
# for persistent data. If the domain name for a `customerId` is changed, the
|
|
184
|
+
# Google system automatically updates.
|
|
165
185
|
# @param [Google::Apis::ResellerV1::Customer] customer_object
|
|
166
186
|
# @param [String] fields
|
|
167
187
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -279,17 +299,20 @@ module Google
|
|
|
279
299
|
execute_or_queue_command(command, &block)
|
|
280
300
|
end
|
|
281
301
|
|
|
282
|
-
# Activates a subscription previously suspended by the reseller
|
|
302
|
+
# Activates a subscription previously suspended by the reseller. If you did not
|
|
303
|
+
# suspend the customer subscription and it is suspended for any other reason,
|
|
304
|
+
# such as for abuse or a pending ToS acceptance, this call will not reactivate
|
|
305
|
+
# the customer subscription.
|
|
283
306
|
# @param [String] customer_id
|
|
284
307
|
# Either the customer's primary domain name or the customer's unique identifier.
|
|
285
|
-
# If using the domain name, we do not recommend using a customerId as a key
|
|
286
|
-
# persistent data. If the domain name for a customerId is changed, the
|
|
287
|
-
# system automatically updates.
|
|
308
|
+
# If using the domain name, we do not recommend using a `customerId` as a key
|
|
309
|
+
# for persistent data. If the domain name for a `customerId` is changed, the
|
|
310
|
+
# Google system automatically updates.
|
|
288
311
|
# @param [String] subscription_id
|
|
289
|
-
# This is a required property. The subscriptionId is the subscription
|
|
290
|
-
# and is unique for each customer. Since a subscriptionId changes
|
|
291
|
-
# subscription is updated, we recommend to not use this ID as a key for
|
|
292
|
-
# persistent data. And the subscriptionId can be found using the retrieve all
|
|
312
|
+
# This is a required property. The `subscriptionId` is the subscription
|
|
313
|
+
# identifier and is unique for each customer. Since a `subscriptionId` changes
|
|
314
|
+
# when a subscription is updated, we recommend to not use this ID as a key for
|
|
315
|
+
# persistent data. And the `subscriptionId` can be found using the retrieve all
|
|
293
316
|
# reseller subscriptions method.
|
|
294
317
|
# @param [String] fields
|
|
295
318
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -321,17 +344,20 @@ module Google
|
|
|
321
344
|
|
|
322
345
|
# Update a subscription plan. Use this method to update a plan for a 30-day
|
|
323
346
|
# trial or a flexible plan subscription to an annual commitment plan with
|
|
324
|
-
# monthly or yearly payments.
|
|
347
|
+
# monthly or yearly payments. How a plan is updated differs depending on the
|
|
348
|
+
# plan and the products. For more information, see the description in [manage
|
|
349
|
+
# subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#
|
|
350
|
+
# update_subscription_plan).
|
|
325
351
|
# @param [String] customer_id
|
|
326
352
|
# Either the customer's primary domain name or the customer's unique identifier.
|
|
327
|
-
# If using the domain name, we do not recommend using a customerId as a key
|
|
328
|
-
# persistent data. If the domain name for a customerId is changed, the
|
|
329
|
-
# system automatically updates.
|
|
353
|
+
# If using the domain name, we do not recommend using a `customerId` as a key
|
|
354
|
+
# for persistent data. If the domain name for a `customerId` is changed, the
|
|
355
|
+
# Google system automatically updates.
|
|
330
356
|
# @param [String] subscription_id
|
|
331
|
-
# This is a required property. The subscriptionId is the subscription
|
|
332
|
-
# and is unique for each customer. Since a subscriptionId changes
|
|
333
|
-
# subscription is updated, we recommend to not use this ID as a key for
|
|
334
|
-
# persistent data. And the subscriptionId can be found using the retrieve all
|
|
357
|
+
# This is a required property. The `subscriptionId` is the subscription
|
|
358
|
+
# identifier and is unique for each customer. Since a `subscriptionId` changes
|
|
359
|
+
# when a subscription is updated, we recommend to not use this ID as a key for
|
|
360
|
+
# persistent data. And the `subscriptionId` can be found using the retrieve all
|
|
335
361
|
# reseller subscriptions method.
|
|
336
362
|
# @param [Google::Apis::ResellerV1::ChangePlanRequest] change_plan_request_object
|
|
337
363
|
# @param [String] fields
|
|
@@ -365,17 +391,19 @@ module Google
|
|
|
365
391
|
end
|
|
366
392
|
|
|
367
393
|
# Update a user license's renewal settings. This is applicable for accounts with
|
|
368
|
-
# annual commitment plans only.
|
|
394
|
+
# annual commitment plans only. For more information, see the description in [
|
|
395
|
+
# manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#
|
|
396
|
+
# update_renewal).
|
|
369
397
|
# @param [String] customer_id
|
|
370
398
|
# Either the customer's primary domain name or the customer's unique identifier.
|
|
371
|
-
# If using the domain name, we do not recommend using a customerId as a key
|
|
372
|
-
# persistent data. If the domain name for a customerId is changed, the
|
|
373
|
-
# system automatically updates.
|
|
399
|
+
# If using the domain name, we do not recommend using a `customerId` as a key
|
|
400
|
+
# for persistent data. If the domain name for a `customerId` is changed, the
|
|
401
|
+
# Google system automatically updates.
|
|
374
402
|
# @param [String] subscription_id
|
|
375
|
-
# This is a required property. The subscriptionId is the subscription
|
|
376
|
-
# and is unique for each customer. Since a subscriptionId changes
|
|
377
|
-
# subscription is updated, we recommend to not use this ID as a key for
|
|
378
|
-
# persistent data. And the subscriptionId can be found using the retrieve all
|
|
403
|
+
# This is a required property. The `subscriptionId` is the subscription
|
|
404
|
+
# identifier and is unique for each customer. Since a `subscriptionId` changes
|
|
405
|
+
# when a subscription is updated, we recommend to not use this ID as a key for
|
|
406
|
+
# persistent data. And the `subscriptionId` can be found using the retrieve all
|
|
379
407
|
# reseller subscriptions method.
|
|
380
408
|
# @param [Google::Apis::ResellerV1::RenewalSettings] renewal_settings_object
|
|
381
409
|
# @param [String] fields
|
|
@@ -408,17 +436,20 @@ module Google
|
|
|
408
436
|
execute_or_queue_command(command, &block)
|
|
409
437
|
end
|
|
410
438
|
|
|
411
|
-
# Update a subscription's user license settings.
|
|
439
|
+
# Update a subscription's user license settings. For more information about
|
|
440
|
+
# updating an annual commitment plan or a flexible plan subscription’s licenses,
|
|
441
|
+
# see [Manage Subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#
|
|
442
|
+
# update_subscription_seat).
|
|
412
443
|
# @param [String] customer_id
|
|
413
444
|
# Either the customer's primary domain name or the customer's unique identifier.
|
|
414
|
-
# If using the domain name, we do not recommend using a customerId as a key
|
|
415
|
-
# persistent data. If the domain name for a customerId is changed, the
|
|
416
|
-
# system automatically updates.
|
|
445
|
+
# If using the domain name, we do not recommend using a `customerId` as a key
|
|
446
|
+
# for persistent data. If the domain name for a `customerId` is changed, the
|
|
447
|
+
# Google system automatically updates.
|
|
417
448
|
# @param [String] subscription_id
|
|
418
|
-
# This is a required property. The subscriptionId is the subscription
|
|
419
|
-
# and is unique for each customer. Since a subscriptionId changes
|
|
420
|
-
# subscription is updated, we recommend to not use this ID as a key for
|
|
421
|
-
# persistent data. And the subscriptionId can be found using the retrieve all
|
|
449
|
+
# This is a required property. The `subscriptionId` is the subscription
|
|
450
|
+
# identifier and is unique for each customer. Since a `subscriptionId` changes
|
|
451
|
+
# when a subscription is updated, we recommend to not use this ID as a key for
|
|
452
|
+
# persistent data. And the `subscriptionId` can be found using the retrieve all
|
|
422
453
|
# reseller subscriptions method.
|
|
423
454
|
# @param [Google::Apis::ResellerV1::Seats] seats_object
|
|
424
455
|
# @param [String] fields
|
|
@@ -454,17 +485,17 @@ module Google
|
|
|
454
485
|
# Cancel, suspend, or transfer a subscription to direct.
|
|
455
486
|
# @param [String] customer_id
|
|
456
487
|
# Either the customer's primary domain name or the customer's unique identifier.
|
|
457
|
-
# If using the domain name, we do not recommend using a customerId as a key
|
|
458
|
-
# persistent data. If the domain name for a customerId is changed, the
|
|
459
|
-
# system automatically updates.
|
|
488
|
+
# If using the domain name, we do not recommend using a `customerId` as a key
|
|
489
|
+
# for persistent data. If the domain name for a `customerId` is changed, the
|
|
490
|
+
# Google system automatically updates.
|
|
460
491
|
# @param [String] subscription_id
|
|
461
|
-
# This is a required property. The subscriptionId is the subscription
|
|
462
|
-
# and is unique for each customer. Since a subscriptionId changes
|
|
463
|
-
# subscription is updated, we recommend to not use this ID as a key for
|
|
464
|
-
# persistent data. And the subscriptionId can be found using the retrieve all
|
|
492
|
+
# This is a required property. The `subscriptionId` is the subscription
|
|
493
|
+
# identifier and is unique for each customer. Since a `subscriptionId` changes
|
|
494
|
+
# when a subscription is updated, we recommend to not use this ID as a key for
|
|
495
|
+
# persistent data. And the `subscriptionId` can be found using the retrieve all
|
|
465
496
|
# reseller subscriptions method.
|
|
466
497
|
# @param [String] deletion_type
|
|
467
|
-
# The deletionType query string enables the cancellation, downgrade, or
|
|
498
|
+
# The `deletionType` query string enables the cancellation, downgrade, or
|
|
468
499
|
# suspension of a subscription.
|
|
469
500
|
# @param [String] fields
|
|
470
501
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -493,17 +524,22 @@ module Google
|
|
|
493
524
|
execute_or_queue_command(command, &block)
|
|
494
525
|
end
|
|
495
526
|
|
|
496
|
-
# Get a specific subscription.
|
|
527
|
+
# Get a specific subscription. The `subscriptionId` can be found using the [
|
|
528
|
+
# Retrieve all reseller subscriptions](/admin-sdk/reseller/v1/how-tos/
|
|
529
|
+
# manage_subscriptions#get_all_subscriptions) method. For more information about
|
|
530
|
+
# retrieving a specific subscription, see the information descrived in [manage
|
|
531
|
+
# subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#
|
|
532
|
+
# get_subscription).
|
|
497
533
|
# @param [String] customer_id
|
|
498
534
|
# Either the customer's primary domain name or the customer's unique identifier.
|
|
499
|
-
# If using the domain name, we do not recommend using a customerId as a key
|
|
500
|
-
# persistent data. If the domain name for a customerId is changed, the
|
|
501
|
-
# system automatically updates.
|
|
535
|
+
# If using the domain name, we do not recommend using a `customerId` as a key
|
|
536
|
+
# for persistent data. If the domain name for a `customerId` is changed, the
|
|
537
|
+
# Google system automatically updates.
|
|
502
538
|
# @param [String] subscription_id
|
|
503
|
-
# This is a required property. The subscriptionId is the subscription
|
|
504
|
-
# and is unique for each customer. Since a subscriptionId changes
|
|
505
|
-
# subscription is updated, we recommend to not use this ID as a key for
|
|
506
|
-
# persistent data. And the subscriptionId can be found using the retrieve all
|
|
539
|
+
# This is a required property. The `subscriptionId` is the subscription
|
|
540
|
+
# identifier and is unique for each customer. Since a `subscriptionId` changes
|
|
541
|
+
# when a subscription is updated, we recommend to not use this ID as a key for
|
|
542
|
+
# persistent data. And the `subscriptionId` can be found using the retrieve all
|
|
507
543
|
# reseller subscriptions method.
|
|
508
544
|
# @param [String] fields
|
|
509
545
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -533,19 +569,30 @@ module Google
|
|
|
533
569
|
execute_or_queue_command(command, &block)
|
|
534
570
|
end
|
|
535
571
|
|
|
536
|
-
# Create or transfer a subscription.
|
|
572
|
+
# Create or transfer a subscription. Create a subscription for a customer's
|
|
573
|
+
# account that you ordered using the [Order a new customer account](/admin-sdk/
|
|
574
|
+
# reseller/v1/reference/customers/insert.html) method. For more information
|
|
575
|
+
# about creating a subscription for different payment plans, see [manage
|
|
576
|
+
# subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#
|
|
577
|
+
# create_subscription).\ If you did not order the customer's account using the
|
|
578
|
+
# customer insert method, use the customer's `customerAuthToken` when creating a
|
|
579
|
+
# subscription for that customer. If transferring a G Suite subscription with an
|
|
580
|
+
# associated Google Drive or Google Vault subscription, use the [batch operation]
|
|
581
|
+
# (/admin-sdk/reseller/v1/how-tos/batch.html) to transfer all of these
|
|
582
|
+
# subscriptions. For more information, see how to [transfer subscriptions](/
|
|
583
|
+
# admin-sdk/reseller/v1/how-tos/manage_subscriptions#transfer_a_subscription).
|
|
537
584
|
# @param [String] customer_id
|
|
538
585
|
# Either the customer's primary domain name or the customer's unique identifier.
|
|
539
|
-
# If using the domain name, we do not recommend using a customerId as a key
|
|
540
|
-
# persistent data. If the domain name for a customerId is changed, the
|
|
541
|
-
# system automatically updates.
|
|
586
|
+
# If using the domain name, we do not recommend using a `customerId` as a key
|
|
587
|
+
# for persistent data. If the domain name for a `customerId` is changed, the
|
|
588
|
+
# Google system automatically updates.
|
|
542
589
|
# @param [Google::Apis::ResellerV1::Subscription] subscription_object
|
|
543
590
|
# @param [String] customer_auth_token
|
|
544
|
-
# The customerAuthToken query string is required when creating a resold
|
|
545
|
-
# that transfers a direct customer's subscription or transfers another
|
|
546
|
-
# customer's subscription to your reseller management. This is a
|
|
547
|
-
# authentication token needed to complete the subscription transfer.
|
|
548
|
-
# information, see the administrator help center.
|
|
591
|
+
# The `customerAuthToken` query string is required when creating a resold
|
|
592
|
+
# account that transfers a direct customer's subscription or transfers another
|
|
593
|
+
# reseller customer's subscription to your reseller management. This is a
|
|
594
|
+
# hexadecimal authentication token needed to complete the subscription transfer.
|
|
595
|
+
# For more information, see the administrator help center.
|
|
549
596
|
# @param [String] fields
|
|
550
597
|
# Selector specifying which fields to include in a partial response.
|
|
551
598
|
# @param [String] quota_user
|
|
@@ -578,29 +625,32 @@ module Google
|
|
|
578
625
|
|
|
579
626
|
# List of subscriptions managed by the reseller. The list can be all
|
|
580
627
|
# subscriptions, all of a customer's subscriptions, or all of a customer's
|
|
581
|
-
# transferable subscriptions.
|
|
628
|
+
# transferable subscriptions. Optionally, this method can filter the response by
|
|
629
|
+
# a `customerNamePrefix`. For more information, see [manage subscriptions](/
|
|
630
|
+
# admin-sdk/reseller/v1/how-tos/manage_subscriptions).
|
|
582
631
|
# @param [String] customer_auth_token
|
|
583
|
-
# The customerAuthToken query string is required when creating a resold
|
|
584
|
-
# that transfers a direct customer's subscription or transfers another
|
|
585
|
-
# customer's subscription to your reseller management. This is a
|
|
586
|
-
# authentication token needed to complete the subscription transfer.
|
|
587
|
-
# information, see the administrator help center.
|
|
632
|
+
# The `customerAuthToken` query string is required when creating a resold
|
|
633
|
+
# account that transfers a direct customer's subscription or transfers another
|
|
634
|
+
# reseller customer's subscription to your reseller management. This is a
|
|
635
|
+
# hexadecimal authentication token needed to complete the subscription transfer.
|
|
636
|
+
# For more information, see the administrator help center.
|
|
588
637
|
# @param [String] customer_id
|
|
589
638
|
# Either the customer's primary domain name or the customer's unique identifier.
|
|
590
|
-
# If using the domain name, we do not recommend using a customerId as a key
|
|
591
|
-
# persistent data. If the domain name for a customerId is changed, the
|
|
592
|
-
# system automatically updates.
|
|
639
|
+
# If using the domain name, we do not recommend using a `customerId` as a key
|
|
640
|
+
# for persistent data. If the domain name for a `customerId` is changed, the
|
|
641
|
+
# Google system automatically updates.
|
|
593
642
|
# @param [String] customer_name_prefix
|
|
594
643
|
# When retrieving all of your subscriptions and filtering for specific customers,
|
|
595
644
|
# you can enter a prefix for a customer name. Using an example customer group
|
|
596
|
-
# that includes exam.com
|
|
597
|
-
# customer names that start with 'exa' which could include exam.com
|
|
598
|
-
#
|
|
599
|
-
# asterisk, exa*. - example -- Returns example20.com
|
|
645
|
+
# that includes `exam.com`, `example20.com` and `example.com`: - `exa` --
|
|
646
|
+
# Returns all customer names that start with 'exa' which could include `exam.com`
|
|
647
|
+
# , `example20.com`, and `example.com`. A name prefix is similar to using a
|
|
648
|
+
# regular expression's asterisk, exa*. - `example` -- Returns `example20.com`
|
|
649
|
+
# and `example.com`.
|
|
600
650
|
# @param [Fixnum] max_results
|
|
601
|
-
# When retrieving a large list, the maxResults is the maximum number of
|
|
602
|
-
# per page. The nextPageToken value takes you to the next page. The
|
|
603
|
-
# 20.
|
|
651
|
+
# When retrieving a large list, the `maxResults` is the maximum number of
|
|
652
|
+
# results per page. The `nextPageToken` value takes you to the next page. The
|
|
653
|
+
# default is 20.
|
|
604
654
|
# @param [String] page_token
|
|
605
655
|
# Token to specify next page in the list
|
|
606
656
|
# @param [String] fields
|
|
@@ -635,17 +685,20 @@ module Google
|
|
|
635
685
|
end
|
|
636
686
|
|
|
637
687
|
# Immediately move a 30-day free trial subscription to a paid service
|
|
638
|
-
# subscription.
|
|
688
|
+
# subscription. This method is only applicable if a payment plan has already
|
|
689
|
+
# been set up for the 30-day trial subscription. For more information, see [
|
|
690
|
+
# manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#
|
|
691
|
+
# paid_service).
|
|
639
692
|
# @param [String] customer_id
|
|
640
693
|
# Either the customer's primary domain name or the customer's unique identifier.
|
|
641
|
-
# If using the domain name, we do not recommend using a customerId as a key
|
|
642
|
-
# persistent data. If the domain name for a customerId is changed, the
|
|
643
|
-
# system automatically updates.
|
|
694
|
+
# If using the domain name, we do not recommend using a `customerId` as a key
|
|
695
|
+
# for persistent data. If the domain name for a `customerId` is changed, the
|
|
696
|
+
# Google system automatically updates.
|
|
644
697
|
# @param [String] subscription_id
|
|
645
|
-
# This is a required property. The subscriptionId is the subscription
|
|
646
|
-
# and is unique for each customer. Since a subscriptionId changes
|
|
647
|
-
# subscription is updated, we recommend to not use this ID as a key for
|
|
648
|
-
# persistent data. And the subscriptionId can be found using the retrieve all
|
|
698
|
+
# This is a required property. The `subscriptionId` is the subscription
|
|
699
|
+
# identifier and is unique for each customer. Since a `subscriptionId` changes
|
|
700
|
+
# when a subscription is updated, we recommend to not use this ID as a key for
|
|
701
|
+
# persistent data. And the `subscriptionId` can be found using the retrieve all
|
|
649
702
|
# reseller subscriptions method.
|
|
650
703
|
# @param [String] fields
|
|
651
704
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -675,17 +728,26 @@ module Google
|
|
|
675
728
|
execute_or_queue_command(command, &block)
|
|
676
729
|
end
|
|
677
730
|
|
|
678
|
-
# Suspends an active subscription.
|
|
731
|
+
# Suspends an active subscription. You can use this method to suspend a paid
|
|
732
|
+
# subscription that is currently in the `ACTIVE` state. * For `FLEXIBLE`
|
|
733
|
+
# subscriptions, billing is paused. * For `ANNUAL_MONTHLY_PAY` or `
|
|
734
|
+
# ANNUAL_YEARLY_PAY` subscriptions: * Suspending the subscription does not
|
|
735
|
+
# change the renewal date that was originally committed to. * A suspended
|
|
736
|
+
# subscription does not renew. If you activate the subscription after the
|
|
737
|
+
# original renewal date, a new annual subscription will be created, starting on
|
|
738
|
+
# the day of activation. We strongly encourage you to suspend subscriptions only
|
|
739
|
+
# for short periods of time as suspensions over 60 days may result in the
|
|
740
|
+
# subscription being cancelled.
|
|
679
741
|
# @param [String] customer_id
|
|
680
742
|
# Either the customer's primary domain name or the customer's unique identifier.
|
|
681
|
-
# If using the domain name, we do not recommend using a customerId as a key
|
|
682
|
-
# persistent data. If the domain name for a customerId is changed, the
|
|
683
|
-
# system automatically updates.
|
|
743
|
+
# If using the domain name, we do not recommend using a `customerId` as a key
|
|
744
|
+
# for persistent data. If the domain name for a `customerId` is changed, the
|
|
745
|
+
# Google system automatically updates.
|
|
684
746
|
# @param [String] subscription_id
|
|
685
|
-
# This is a required property. The subscriptionId is the subscription
|
|
686
|
-
# and is unique for each customer. Since a subscriptionId changes
|
|
687
|
-
# subscription is updated, we recommend to not use this ID as a key for
|
|
688
|
-
# persistent data. And the subscriptionId can be found using the retrieve all
|
|
747
|
+
# This is a required property. The `subscriptionId` is the subscription
|
|
748
|
+
# identifier and is unique for each customer. Since a `subscriptionId` changes
|
|
749
|
+
# when a subscription is updated, we recommend to not use this ID as a key for
|
|
750
|
+
# persistent data. And the `subscriptionId` can be found using the retrieve all
|
|
689
751
|
# reseller subscriptions method.
|
|
690
752
|
# @param [String] fields
|
|
691
753
|
# Selector specifying which fields to include in a partial response.
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-apis-reseller_v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-
|
|
11
|
+
date: 2021-02-15 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: google-apis-core
|
|
@@ -52,7 +52,7 @@ licenses:
|
|
|
52
52
|
metadata:
|
|
53
53
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
|
54
54
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-reseller_v1/CHANGELOG.md
|
|
55
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-reseller_v1/v0.
|
|
55
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-reseller_v1/v0.2.0
|
|
56
56
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-reseller_v1
|
|
57
57
|
post_install_message:
|
|
58
58
|
rdoc_options: []
|
|
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
69
69
|
- !ruby/object:Gem::Version
|
|
70
70
|
version: '0'
|
|
71
71
|
requirements: []
|
|
72
|
-
rubygems_version: 3.
|
|
72
|
+
rubygems_version: 3.2.6
|
|
73
73
|
signing_key:
|
|
74
74
|
specification_version: 4
|
|
75
75
|
summary: Simple REST client for Google Workspace Reseller API V1
|