google-apis-reseller_v1 0.1.0 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9977eb136ee716d7aa2ae8d9d5758eba4b80bbbdbedb0c02ab5713872a152c9e
4
- data.tar.gz: 29121e3d97065a3b8cbbab53b522588f05c292e8f36f882c40c7a0d8631738ad
3
+ metadata.gz: e7e0e8fd763b3fa9649358509bee7dc41f0fd66bf96ab86afc666380bb22616d
4
+ data.tar.gz: 6d317429bd3da935ea7b061502b02a66cc1609d29debadf8f4ee0f0d588df2c4
5
5
  SHA512:
6
- metadata.gz: 1e254e26f615cbe832d49ab203b6f8b95ffca3e49cd287ba956492d25777075919e5778d3214c9aecddd0e7323f13a0dae21c4ce8c7b6497a80017c54602822a
7
- data.tar.gz: 3407cc51bb178020d5de6644366d88cf73fdcf2e0cd39c413656c21a2a782222a705c7bc78c0bce764f49aeda9659d1f6ac1f8e1112b7d74ed11053a48751229
6
+ metadata.gz: 07fa09e4249b833f8d3c084d5ae677093be8840d64b508d72fadf8a056b0fdf0fbc61013f96ae8918a8ecc46ac5c322371ff9ca8d33656532094c850604804ab
7
+ data.tar.gz: 7a8a253ee4f1086faeffd658fde2bb0c9f5568586a2bdf7867db744d7faeb44d0fef21c71010b19f951da93d422ff331ff7634fb5c2de5e1b48431d88ade7b90
data/CHANGELOG.md CHANGED
@@ -1,5 +1,28 @@
1
1
  # Release history for google-apis-reseller_v1
2
2
 
3
+ ### v0.6.0 (2021-06-24)
4
+
5
+ * Regenerated from discovery document revision 20210623
6
+ * Regenerated using generator version 0.3.0
7
+
8
+ ### v0.5.0 (2021-05-19)
9
+
10
+ * Unspecified changes
11
+
12
+ ### v0.4.0 (2021-03-25)
13
+
14
+ * Regenerated from discovery document revision 20210323
15
+ * Regenerated using generator version 0.2.0
16
+
17
+ ### v0.3.0 (2021-03-04)
18
+
19
+ * Unspecified changes
20
+
21
+ ### v0.2.0 (2021-02-09)
22
+
23
+ * Regenerated from discovery document revision 20210206
24
+ * Regenerated using generator version 0.1.2
25
+
3
26
  ### v0.1.0 (2021-01-07)
4
27
 
5
28
  * Regenerated using generator version 0.1.1
@@ -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. This property is
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: *ANNUAL_MONTHLY_PAY is returned as ANNUAL
128
- # in all API responses. - ANNUAL_YEARLY_PAY - The annual commitment plan with
129
- # yearly payments - FLEXIBLE - The flexible plan - TRIAL - The 30-day free trial
130
- # plan
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 value
137
- # is given it appears in the API responses and shows up in the invoice. The
138
- # property accepts up to 80 plain text characters.
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
- # JSON template for a customer.
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,12 @@ 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
+ # The type of the customer (DOMAIN or TEAM), default is DOMAIN.
197
+ # Corresponds to the JSON property `customerType`
198
+ # @return [String]
199
+ attr_accessor :customer_type
200
+
201
+ # Identifies the resource as a customer. Value: `reseller#customer`
195
202
  # Corresponds to the JSON property `kind`
196
203
  # @return [String]
197
204
  attr_accessor :kind
@@ -209,6 +216,11 @@ module Google
209
216
  # @return [Google::Apis::ResellerV1::Address]
210
217
  attr_accessor :postal_address
211
218
 
219
+ # JSON template for primary admin in case of TEAM customers
220
+ # Corresponds to the JSON property `primaryAdmin`
221
+ # @return [Google::Apis::ResellerV1::PrimaryAdmin]
222
+ attr_accessor :primary_admin
223
+
212
224
  # URL to customer's Admin console dashboard. The read-only URL is generated by
213
225
  # the API service. This is used if your client application requires the customer
214
226
  # to complete a task in the Admin console.
@@ -226,26 +238,48 @@ module Google
226
238
  @customer_domain = args[:customer_domain] if args.key?(:customer_domain)
227
239
  @customer_domain_verified = args[:customer_domain_verified] if args.key?(:customer_domain_verified)
228
240
  @customer_id = args[:customer_id] if args.key?(:customer_id)
241
+ @customer_type = args[:customer_type] if args.key?(:customer_type)
229
242
  @kind = args[:kind] if args.key?(:kind)
230
243
  @phone_number = args[:phone_number] if args.key?(:phone_number)
231
244
  @postal_address = args[:postal_address] if args.key?(:postal_address)
245
+ @primary_admin = args[:primary_admin] if args.key?(:primary_admin)
232
246
  @resource_ui_url = args[:resource_ui_url] if args.key?(:resource_ui_url)
233
247
  end
234
248
  end
235
249
 
250
+ # JSON template for primary admin in case of TEAM customers
251
+ class PrimaryAdmin
252
+ include Google::Apis::Core::Hashable
253
+
254
+ # Primary admin's domained email This email's domain will be used to create TEAM
255
+ # customer
256
+ # Corresponds to the JSON property `primaryEmail`
257
+ # @return [String]
258
+ attr_accessor :primary_email
259
+
260
+ def initialize(**args)
261
+ update!(**args)
262
+ end
263
+
264
+ # Update properties of this object
265
+ def update!(**args)
266
+ @primary_email = args[:primary_email] if args.key?(:primary_email)
267
+ end
268
+ end
269
+
236
270
  # JSON template for a subscription renewal settings.
237
271
  class RenewalSettings
238
272
  include Google::Apis::Core::Hashable
239
273
 
240
- # Identifies the resource as a subscription renewal setting. Value:
241
- # subscriptions#renewalSettings
274
+ # Identifies the resource as a subscription renewal setting. Value: `
275
+ # subscriptions#renewalSettings`
242
276
  # Corresponds to the JSON property `kind`
243
277
  # @return [String]
244
278
  attr_accessor :kind
245
279
 
246
280
  # Renewal settings for the annual commitment plan. For more detailed information,
247
281
  # see renewal options in the administrator help center. When renewing a
248
- # subscription, the renewalType is a required property.
282
+ # subscription, the `renewalType` is a required property.
249
283
  # Corresponds to the JSON property `renewalType`
250
284
  # @return [String]
251
285
  attr_accessor :renewal_type
@@ -309,37 +343,38 @@ module Google
309
343
  class Seats
310
344
  include Google::Apis::Core::Hashable
311
345
 
312
- # Identifies the resource as a subscription seat setting. Value: subscriptions#
313
- # seats
346
+ # Identifies the resource as a subscription seat setting. Value: `subscriptions#
347
+ # seats`
314
348
  # Corresponds to the JSON property `kind`
315
349
  # @return [String]
316
350
  attr_accessor :kind
317
351
 
318
352
  # Read-only field containing the current number of users that are assigned a
319
- # license for the product defined in skuId. This field's value is equivalent to
320
- # the numerical count of users returned by the Enterprise License Manager API
321
- # method: listForProductAndSku
353
+ # license for the product defined in `skuId`. This field's value is equivalent
354
+ # to the numerical count of users returned by the Enterprise License Manager API
355
+ # method: [`listForProductAndSku`](/admin-sdk/licensing/v1/reference/
356
+ # licenseAssignments/listForProductAndSku).
322
357
  # Corresponds to the JSON property `licensedNumberOfSeats`
323
358
  # @return [Fixnum]
324
359
  attr_accessor :licensed_number_of_seats
325
360
 
326
- # This is a required property and is exclusive to subscriptions with FLEXIBLE or
327
- # TRIAL plans. This property sets the maximum number of licensed users allowed
328
- # on a subscription. This quantity can be increased up to the maximum limit
329
- # defined in the reseller's contract. The minimum quantity is the current number
330
- # of users in the customer account. *Note: *G Suite subscriptions automatically
331
- # assign a license to every user.
361
+ # This is a required property and is exclusive to subscriptions with `FLEXIBLE`
362
+ # or `TRIAL` plans. This property sets the maximum number of licensed users
363
+ # allowed on a subscription. This quantity can be increased up to the maximum
364
+ # limit defined in the reseller's contract. The minimum quantity is the current
365
+ # number of users in the customer account. *Note: *G Suite subscriptions
366
+ # automatically assign a license to every user.
332
367
  # Corresponds to the JSON property `maximumNumberOfSeats`
333
368
  # @return [Fixnum]
334
369
  attr_accessor :maximum_number_of_seats
335
370
 
336
- # This is a required property and is exclusive to subscriptions with
337
- # ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum
338
- # number of licenses assignable to users on a subscription. The reseller can add
339
- # more licenses, but once set, the numberOfSeats cannot be reduced until renewal.
340
- # The reseller is invoiced based on the numberOfSeats value regardless of how
341
- # many of these user licenses are assigned. *Note: *G Suite subscriptions
342
- # automatically assign a license to every user.
371
+ # This is a required property and is exclusive to subscriptions with `
372
+ # ANNUAL_MONTHLY_PAY` and `ANNUAL_YEARLY_PAY` plans. This property sets the
373
+ # maximum number of licenses assignable to users on a subscription. The reseller
374
+ # can add more licenses, but once set, the `numberOfSeats` cannot be reduced
375
+ # until renewal. The reseller is invoiced based on the `numberOfSeats` value
376
+ # regardless of how many of these user licenses are assigned. *Note: *G Suite
377
+ # subscriptions automatically assign a license to every user.
343
378
  # Corresponds to the JSON property `numberOfSeats`
344
379
  # @return [Fixnum]
345
380
  attr_accessor :number_of_seats
@@ -366,8 +401,8 @@ module Google
366
401
  # @return [String]
367
402
  attr_accessor :billing_method
368
403
 
369
- # The creationTime property is the date when subscription was created. It is in
370
- # milliseconds using the Epoch format. See an example Epoch converter.
404
+ # The `creationTime` property is the date when subscription was created. It is
405
+ # in milliseconds using the Epoch format. See an example Epoch converter.
371
406
  # Corresponds to the JSON property `creationTime`
372
407
  # @return [Fixnum]
373
408
  attr_accessor :creation_time
@@ -385,18 +420,19 @@ module Google
385
420
  attr_accessor :customer_id
386
421
 
387
422
  # Google-issued code (100 char max) for discounted pricing on subscription plans.
388
- # Deal code must be included in insert requests in order to receive discounted
389
- # rate. This property is optional, regular pricing applies if left empty.
423
+ # Deal code must be included in `insert` requests in order to receive
424
+ # discounted rate. This property is optional, regular pricing applies if left
425
+ # empty.
390
426
  # Corresponds to the JSON property `dealCode`
391
427
  # @return [String]
392
428
  attr_accessor :deal_code
393
429
 
394
- # Identifies the resource as a Subscription. Value: reseller#subscription
430
+ # Identifies the resource as a Subscription. Value: `reseller#subscription`
395
431
  # Corresponds to the JSON property `kind`
396
432
  # @return [String]
397
433
  attr_accessor :kind
398
434
 
399
- # The plan property is required. In this version of the API, the G Suite plans
435
+ # The `plan` property is required. In this version of the API, the G Suite plans
400
436
  # are the flexible plan, annual commitment plan, and the 30-day free trial plan.
401
437
  # For more information about the API"s payment plans, see the API concepts.
402
438
  # Corresponds to the JSON property `plan`
@@ -404,9 +440,9 @@ module Google
404
440
  attr_accessor :plan
405
441
 
406
442
  # This is an optional property. This purchase order (PO) information is for
407
- # resellers to use for their company tracking usage. If a purchaseOrderId value
408
- # is given it appears in the API responses and shows up in the invoice. The
409
- # property accepts up to 80 plain text characters.
443
+ # resellers to use for their company tracking usage. If a `purchaseOrderId`
444
+ # value is given it appears in the API responses and shows up in the invoice.
445
+ # The property accepts up to 80 plain text characters.
410
446
  # Corresponds to the JSON property `purchaseOrderId`
411
447
  # @return [String]
412
448
  attr_accessor :purchase_order_id
@@ -429,7 +465,7 @@ module Google
429
465
  # @return [Google::Apis::ResellerV1::Seats]
430
466
  attr_accessor :seats
431
467
 
432
- # A required property. The skuId is a unique system identifier for a product's
468
+ # A required property. The `skuId` is a unique system identifier for a product's
433
469
  # SKU assigned to a customer in the subscription. For products and SKUs
434
470
  # available in this version of the API, see Product and SKU IDs.
435
471
  # Corresponds to the JSON property `skuId`
@@ -449,25 +485,26 @@ module Google
449
485
  # @return [String]
450
486
  attr_accessor :status
451
487
 
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
488
+ # The `subscriptionId` is the subscription identifier and is unique for each
489
+ # customer. This is a required property. Since a `subscriptionId` changes when a
454
490
  # subscription is updated, we recommend not using this ID as a key for
455
- # persistent data. Use the subscriptionId as described in retrieve all reseller
456
- # subscriptions.
491
+ # persistent data. Use the `subscriptionId` as described in retrieve all
492
+ # reseller subscriptions.
457
493
  # Corresponds to the JSON property `subscriptionId`
458
494
  # @return [String]
459
495
  attr_accessor :subscription_id
460
496
 
461
497
  # Read-only field containing an enumerable of all the current suspension reasons
462
498
  # for a subscription. It is possible for a subscription to have many concurrent,
463
- # overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all
464
- # pending suspensions are removed. Possible options include: -
465
- # PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G
466
- # Suite Resold Terms of Services. - RENEWAL_WITH_TYPE_CANCEL - The customer's
467
- # commitment ended and their service was cancelled at the end of their term. -
468
- # RESELLER_INITIATED - A manual suspension invoked by a Reseller. - TRIAL_ENDED -
469
- # The customer's trial expired without a plan selected. - OTHER - The customer
470
- # is suspended for an internal Google reason (e.g. abuse or otherwise).
499
+ # overlapping suspension reasons. A subscription's `STATUS` is `SUSPENDED` until
500
+ # all pending suspensions are removed. Possible options include: - `
501
+ # PENDING_TOS_ACCEPTANCE` - The customer has not logged in and accepted the G
502
+ # Suite Resold Terms of Services. - `RENEWAL_WITH_TYPE_CANCEL` - The customer's
503
+ # commitment ended and their service was cancelled at the end of their term. - `
504
+ # RESELLER_INITIATED` - A manual suspension invoked by a Reseller. - `
505
+ # TRIAL_ENDED` - The customer's trial expired without a plan selected. - `OTHER`
506
+ # - The customer is suspended for an internal Google reason (e.g. abuse or
507
+ # otherwise).
471
508
  # Corresponds to the JSON property `suspensionReasons`
472
509
  # @return [Array<String>]
473
510
  attr_accessor :suspension_reasons
@@ -510,39 +547,39 @@ module Google
510
547
  @trial_settings = args[:trial_settings] if args.key?(:trial_settings)
511
548
  end
512
549
 
513
- # The plan property is required. In this version of the API, the G Suite plans
550
+ # The `plan` property is required. In this version of the API, the G Suite plans
514
551
  # are the flexible plan, annual commitment plan, and the 30-day free trial plan.
515
552
  # For more information about the API"s payment plans, see the API concepts.
516
553
  class Plan
517
554
  include Google::Apis::Core::Hashable
518
555
 
519
556
  # In this version of the API, annual commitment plan's interval is one year. *
520
- # Note: *When billingMethod value is OFFLINE, the subscription property object
521
- # plan.commitmentInterval is omitted in all API responses.
557
+ # Note: *When `billingMethod` value is `OFFLINE`, the subscription property
558
+ # object `plan.commitmentInterval` is omitted in all API responses.
522
559
  # Corresponds to the JSON property `commitmentInterval`
523
560
  # @return [Google::Apis::ResellerV1::Subscription::Plan::CommitmentInterval]
524
561
  attr_accessor :commitment_interval
525
562
 
526
- # The isCommitmentPlan property's boolean value identifies the plan as an annual
527
- # commitment plan: - true — The subscription's plan is an annual commitment plan.
528
- # - false — The plan is not an annual commitment plan.
563
+ # The `isCommitmentPlan` property's boolean value identifies the plan as an
564
+ # annual commitment plan: - `true` — The subscription's plan is an annual
565
+ # commitment plan. - `false` — The plan is not an annual commitment plan.
529
566
  # Corresponds to the JSON property `isCommitmentPlan`
530
567
  # @return [Boolean]
531
568
  attr_accessor :is_commitment_plan
532
569
  alias_method :is_commitment_plan?, :is_commitment_plan
533
570
 
534
- # The planName property is required. This is the name of the subscription's plan.
535
- # For more information about the Google payment plans, see the API concepts.
536
- # Possible values are: - ANNUAL_MONTHLY_PAY — The annual commitment plan with
537
- # monthly payments. *Caution: *ANNUAL_MONTHLY_PAY is returned as ANNUAL in all
538
- # API responses. - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly
539
- # payments - FLEXIBLE — The flexible plan - TRIAL — The 30-day free trial plan.
540
- # A subscription in trial will be suspended after the 30th free day if no
541
- # payment plan is assigned. Calling changePlan will assign a payment plan to a
542
- # trial but will not activate the plan. A trial will automatically begin its
543
- # assigned payment plan after its 30th free day or immediately after calling
544
- # startPaidService. - FREE — The free plan is exclusive to the Cloud Identity
545
- # SKU and does not incur any billing.
571
+ # The `planName` property is required. This is the name of the subscription's
572
+ # plan. For more information about the Google payment plans, see the API
573
+ # concepts. Possible values are: - `ANNUAL_MONTHLY_PAY` — The annual commitment
574
+ # plan with monthly payments. *Caution: *`ANNUAL_MONTHLY_PAY` is returned as `
575
+ # ANNUAL` in all API responses. - `ANNUAL_YEARLY_PAY` — The annual commitment
576
+ # plan with yearly payments - `FLEXIBLE` — The flexible plan - `TRIAL` — The 30-
577
+ # day free trial plan. A subscription in trial will be suspended after the 30th
578
+ # free day if no payment plan is assigned. Calling `changePlan` will assign a
579
+ # payment plan to a trial but will not activate the plan. A trial will
580
+ # automatically begin its assigned payment plan after its 30th free day or
581
+ # immediately after calling `startPaidService`. - `FREE` — The free plan is
582
+ # exclusive to the Cloud Identity SKU and does not incur any billing.
546
583
  # Corresponds to the JSON property `planName`
547
584
  # @return [String]
548
585
  attr_accessor :plan_name
@@ -559,18 +596,18 @@ module Google
559
596
  end
560
597
 
561
598
  # In this version of the API, annual commitment plan's interval is one year. *
562
- # Note: *When billingMethod value is OFFLINE, the subscription property object
563
- # plan.commitmentInterval is omitted in all API responses.
599
+ # Note: *When `billingMethod` value is `OFFLINE`, the subscription property
600
+ # object `plan.commitmentInterval` is omitted in all API responses.
564
601
  class CommitmentInterval
565
602
  include Google::Apis::Core::Hashable
566
603
 
567
- # An annual commitment plan's interval's endTime in milliseconds using the UNIX
568
- # Epoch format. See an example Epoch converter.
604
+ # An annual commitment plan's interval's `endTime` in milliseconds using the
605
+ # UNIX Epoch format. See an example Epoch converter.
569
606
  # Corresponds to the JSON property `endTime`
570
607
  # @return [Fixnum]
571
608
  attr_accessor :end_time
572
609
 
573
- # An annual commitment plan's interval's startTime in milliseconds using UNIX
610
+ # An annual commitment plan's interval's `startTime` in milliseconds using UNIX
574
611
  # Epoch format. See an example Epoch converter.
575
612
  # Corresponds to the JSON property `startTime`
576
613
  # @return [Fixnum]
@@ -593,6 +630,13 @@ module Google
593
630
  class TransferInfo
594
631
  include Google::Apis::Core::Hashable
595
632
 
633
+ # Sku id of the current resold subscription. This is populated only when
634
+ # customer has subscription with legacy sku and the subscription resource is
635
+ # populated with recommeded sku for transfer in.
636
+ # Corresponds to the JSON property `currentLegacySkuId`
637
+ # @return [String]
638
+ attr_accessor :current_legacy_sku_id
639
+
596
640
  # When inserting a subscription, this is the minimum number of seats listed in
597
641
  # the transfer order for this product. For example, if the customer has 20 users,
598
642
  # the reseller cannot place a transfer order of 15 seats. The minimum is 20
@@ -613,6 +657,7 @@ module Google
613
657
 
614
658
  # Update properties of this object
615
659
  def update!(**args)
660
+ @current_legacy_sku_id = args[:current_legacy_sku_id] if args.key?(:current_legacy_sku_id)
616
661
  @minimum_transferable_seats = args[:minimum_transferable_seats] if args.key?(:minimum_transferable_seats)
617
662
  @transferability_expiration_time = args[:transferability_expiration_time] if args.key?(:transferability_expiration_time)
618
663
  end
@@ -623,8 +668,8 @@ module Google
623
668
  class TrialSettings
624
669
  include Google::Apis::Core::Hashable
625
670
 
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.
671
+ # Determines if a subscription's plan is in a 30-day free trial or not: - `true`
672
+ # The plan is in trial. - `false` — The plan is not in trial.
628
673
  # Corresponds to the JSON property `isInTrial`
629
674
  # @return [Boolean]
630
675
  attr_accessor :is_in_trial
@@ -648,7 +693,10 @@ module Google
648
693
  end
649
694
  end
650
695
 
651
- # JSON template for a subscription list.
696
+ # A subscription manages the relationship of a Google customer's payment plan
697
+ # with a product's SKU, user licenses, 30-day free trial status, and renewal
698
+ # options. A primary role of a reseller is to manage the Google customer's
699
+ # subscriptions.
652
700
  class Subscriptions
653
701
  include Google::Apis::Core::Hashable
654
702
 
@@ -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.1.0"
19
+ GEM_VERSION = "0.6.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.1.1"
22
+ GENERATOR_VERSION = "0.3.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20201129"
25
+ REVISION = "20210623"
26
26
  end
27
27
  end
28
28
  end
@@ -40,6 +40,12 @@ module Google
40
40
  include Google::Apis::Core::JsonObjectSupport
41
41
  end
42
42
 
43
+ class PrimaryAdmin
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
43
49
  class RenewalSettings
44
50
  class Representation < Google::Apis::Core::JsonRepresentation; end
45
51
 
@@ -135,14 +141,24 @@ module Google
135
141
  property :customer_domain, as: 'customerDomain'
136
142
  property :customer_domain_verified, as: 'customerDomainVerified'
137
143
  property :customer_id, as: 'customerId'
144
+ property :customer_type, as: 'customerType'
138
145
  property :kind, as: 'kind'
139
146
  property :phone_number, as: 'phoneNumber'
140
147
  property :postal_address, as: 'postalAddress', class: Google::Apis::ResellerV1::Address, decorator: Google::Apis::ResellerV1::Address::Representation
141
148
 
149
+ property :primary_admin, as: 'primaryAdmin', class: Google::Apis::ResellerV1::PrimaryAdmin, decorator: Google::Apis::ResellerV1::PrimaryAdmin::Representation
150
+
142
151
  property :resource_ui_url, as: 'resourceUiUrl'
143
152
  end
144
153
  end
145
154
 
155
+ class PrimaryAdmin
156
+ # @private
157
+ class Representation < Google::Apis::Core::JsonRepresentation
158
+ property :primary_email, as: 'primaryEmail'
159
+ end
160
+ end
161
+
146
162
  class RenewalSettings
147
163
  # @private
148
164
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -225,6 +241,7 @@ module Google
225
241
  class TransferInfo
226
242
  # @private
227
243
  class Representation < Google::Apis::Core::JsonRepresentation
244
+ property :current_legacy_sku_id, as: 'currentLegacySkuId'
228
245
  property :minimum_transferable_seats, as: 'minimumTransferableSeats'
229
246
  property :transferability_expiration_time, :numeric_string => true, as: 'transferabilityExpirationTime'
230
247
  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 for
57
- # persistent data. If the domain name for a customerId is changed, the Google
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 account
90
- # that transfers a direct customer's subscription or transfers another reseller
91
- # customer's subscription to your reseller management. This is a hexadecimal
92
- # authentication token needed to complete the subscription transfer. For more
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
- # Patch a customer account's settings via Apiary Patch Orchestration
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 for
127
- # persistent data. If the domain name for a customerId is changed, the Google
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 for
163
- # persistent data. If the domain name for a customerId is changed, the Google
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 for
286
- # persistent data. If the domain name for a customerId is changed, the Google
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 identifier
290
- # and is unique for each customer. Since a subscriptionId changes when a
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 for
328
- # persistent data. If the domain name for a customerId is changed, the Google
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 identifier
332
- # and is unique for each customer. Since a subscriptionId changes when a
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 for
372
- # persistent data. If the domain name for a customerId is changed, the Google
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 identifier
376
- # and is unique for each customer. Since a subscriptionId changes when a
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 for
415
- # persistent data. If the domain name for a customerId is changed, the Google
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 identifier
419
- # and is unique for each customer. Since a subscriptionId changes when a
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 for
458
- # persistent data. If the domain name for a customerId is changed, the Google
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 identifier
462
- # and is unique for each customer. Since a subscriptionId changes when a
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 for
500
- # persistent data. If the domain name for a customerId is changed, the Google
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 identifier
504
- # and is unique for each customer. Since a subscriptionId changes when a
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 for
540
- # persistent data. If the domain name for a customerId is changed, the Google
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 account
545
- # that transfers a direct customer's subscription or transfers another reseller
546
- # customer's subscription to your reseller management. This is a hexadecimal
547
- # authentication token needed to complete the subscription transfer. For more
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 account
584
- # that transfers a direct customer's subscription or transfers another reseller
585
- # customer's subscription to your reseller management. This is a hexadecimal
586
- # authentication token needed to complete the subscription transfer. For more
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 for
591
- # persistent data. If the domain name for a customerId is changed, the Google
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, example20.com and example.com: - exa -- Returns all
597
- # customer names that start with 'exa' which could include exam.com, example20.
598
- # com, and example.com. A name prefix is similar to using a regular expression's
599
- # asterisk, exa*. - example -- Returns example20.com and example.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 results
602
- # per page. The nextPageToken value takes you to the next page. The default is
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 for
642
- # persistent data. If the domain name for a customerId is changed, the Google
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 identifier
646
- # and is unique for each customer. Since a subscriptionId changes when a
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 for
682
- # persistent data. If the domain name for a customerId is changed, the Google
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 identifier
686
- # and is unique for each customer. Since a subscriptionId changes when a
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,29 +1,35 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-reseller_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.6.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-01-08 00:00:00.000000000 Z
11
+ date: 2021-06-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.1'
19
+ version: '0.3'
20
+ - - "<"
21
+ - !ruby/object:Gem::Version
22
+ version: 2.a
20
23
  type: :runtime
21
24
  prerelease: false
22
25
  version_requirements: !ruby/object:Gem::Requirement
23
26
  requirements:
24
- - - "~>"
27
+ - - ">="
28
+ - !ruby/object:Gem::Version
29
+ version: '0.3'
30
+ - - "<"
25
31
  - !ruby/object:Gem::Version
26
- version: '0.1'
32
+ version: 2.a
27
33
  description: This is the simple REST client for Google Workspace Reseller API V1.
28
34
  Simple REST clients are Ruby client libraries that provide access to Google services
29
35
  via their HTTP REST API endpoints. These libraries are generated and updated automatically
@@ -52,7 +58,7 @@ licenses:
52
58
  metadata:
53
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
54
60
  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.1.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-reseller_v1/v0.6.0
56
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-reseller_v1
57
63
  post_install_message:
58
64
  rdoc_options: []
@@ -62,14 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
62
68
  requirements:
63
69
  - - ">="
64
70
  - !ruby/object:Gem::Version
65
- version: '2.4'
71
+ version: '2.5'
66
72
  required_rubygems_version: !ruby/object:Gem::Requirement
67
73
  requirements:
68
74
  - - ">="
69
75
  - !ruby/object:Gem::Version
70
76
  version: '0'
71
77
  requirements: []
72
- rubygems_version: 3.1.4
78
+ rubygems_version: 3.2.17
73
79
  signing_key:
74
80
  specification_version: 4
75
81
  summary: Simple REST client for Google Workspace Reseller API V1