v1.d.ts
60.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace reseller_v1 {
interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Data format for the response.
*/
alt?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API
* access, quota, and reports. Required unless you provide an OAuth 2.0
* token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* An opaque string that represents a user for quota purposes. Must not
* exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* Enterprise Apps Reseller API
*
* Creates and manages your customers and their subscriptions.
*
* @example
* const {google} = require('googleapis');
* const reseller = google.reseller('v1');
*
* @namespace reseller
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Reseller
*/
class Reseller {
context: APIRequestContext;
customers: Resource$Customers;
resellernotify: Resource$Resellernotify;
subscriptions: Resource$Subscriptions;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* JSON template for address of a customer.
*/
interface Schema$Address {
/**
* A customer's physical address. An address can be composed of one to
* three lines. The addressline2 and addressLine3 are optional.
*/
addressLine1?: string;
/**
* Line 2 of the address.
*/
addressLine2?: string;
/**
* Line 3 of the address.
*/
addressLine3?: string;
/**
* The customer contact's name. This is required.
*/
contactName?: string;
/**
* For countryCode information, see the ISO 3166 country code elements.
* Verify that country is approved for resale of Google products. This
* property is required when creating a new customer.
*/
countryCode?: string;
/**
* Identifies the resource as a customer address. Value: customers#address
*/
kind?: string;
/**
* An example of a locality value is the city of San Francisco.
*/
locality?: string;
/**
* The company or company division name. This is required.
*/
organizationName?: string;
/**
* A postalCode example is a postal zip code such as 94043. This property is
* required when creating a new customer.
*/
postalCode?: string;
/**
* An example of a region value is CA for the state of California.
*/
region?: string;
}
/**
* JSON template for the ChangePlan rpc request.
*/
interface Schema$ChangePlanRequest {
/**
* Google-issued code (100 char max) for discounted pricing on subscription
* plans. Deal code must be included in changePlan request in order to
* receive discounted rate. This property is optional. If a deal code has
* already been added to a subscription, this property may be left empty and
* the existing discounted rate will still apply (if not empty, only provide
* the deal code that is already present on the subscription). If a deal
* code has never been added to a subscription and this property is left
* blank, regular pricing will apply.
*/
dealCode?: string;
/**
* Identifies the resource as a subscription change plan request. Value:
* subscriptions#changePlanRequest
*/
kind?: string;
/**
* The planName property is required. This is the name of the
* subscription's payment plan. For more information about the Google
* payment plans, see API concepts. Possible values are: -
* ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments
* Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
* - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments -
* FLEXIBLE - The flexible plan - TRIAL - The 30-day free trial plan
*/
planName?: string;
/**
* This is an optional property. This purchase order (PO) information is for
* resellers to use for their company tracking usage. If a purchaseOrderId
* value is given it appears in the API responses and shows up in the
* invoice. The property accepts up to 80 plain text characters.
*/
purchaseOrderId?: string;
/**
* This is a required property. The seats property is the number of user
* seat licenses.
*/
seats?: Schema$Seats;
}
/**
* JSON template for a customer.
*/
interface Schema$Customer {
/**
* Like the "Customer email" in the reseller tools, this email is
* the secondary contact used if something happens to the customer's
* service such as service outage or a security issue. This property is
* required when creating a new customer and should not use the same domain
* as customerDomain.
*/
alternateEmail?: string;
/**
* The customer's primary domain name string. customerDomain is required
* when creating a new customer. Do not include the www prefix in the domain
* when adding a customer.
*/
customerDomain?: string;
/**
* Whether the customer's primary domain has been verified.
*/
customerDomainVerified?: boolean;
/**
* This property will always be returned in a response as the unique
* identifier generated by Google. In a request, this property can be either
* the primary domain or the unique identifier generated by Google.
*/
customerId?: string;
/**
* Identifies the resource as a customer. Value: reseller#customer
*/
kind?: string;
/**
* Customer contact phone number. Must start with "+" followed by
* the country code. The rest of the number can be contiguous numbers or
* respect the phone local format conventions, but it must be a real phone
* number and not, for example, "123". This field is silently
* ignored if invalid.
*/
phoneNumber?: string;
/**
* A customer's address information. Each field has a limit of 255
* charcters.
*/
postalAddress?: Schema$Address;
/**
* URL to customer's Admin console dashboard. The read-only URL is
* generated by the API service. This is used if your client application
* requires the customer to complete a task in the Admin console.
*/
resourceUiUrl?: string;
}
/**
* JSON template for a subscription renewal settings.
*/
interface Schema$RenewalSettings {
/**
* Identifies the resource as a subscription renewal setting. Value:
* subscriptions#renewalSettings
*/
kind?: string;
/**
* Renewal settings for the annual commitment plan. For more detailed
* information, see renewal options in the administrator help center. When
* renewing a subscription, the renewalType is a required property.
*/
renewalType?: string;
}
/**
* JSON template for resellernotify getwatchdetails response.
*/
interface Schema$ResellernotifyGetwatchdetailsResponse {
/**
* List of registered service accounts.
*/
serviceAccountEmailAddresses?: string[];
/**
* Topic name of the PubSub
*/
topicName?: string;
}
/**
* JSON template for resellernotify response.
*/
interface Schema$ResellernotifyResource {
/**
* Topic name of the PubSub
*/
topicName?: string;
}
/**
* JSON template for subscription seats.
*/
interface Schema$Seats {
/**
* Identifies the resource as a subscription seat setting. Value:
* subscriptions#seats
*/
kind?: string;
/**
* Read-only field containing the current number of users that are assigned
* a license for the product defined in skuId. This field's value is
* equivalent to the numerical count of users returned by the Enterprise
* License Manager API method: listForProductAndSku
*/
licensedNumberOfSeats?: number;
/**
* This is a required property and is exclusive to subscriptions with
* FLEXIBLE or TRIAL plans. This property sets the maximum number of
* licensed users allowed on a subscription. This quantity can be increased
* up to the maximum limit defined in the reseller's contract. The
* minimum quantity is the current number of users in the customer account.
* Note: G Suite subscriptions automatically assign a license to every user.
*/
maximumNumberOfSeats?: number;
/**
* This is a required property and is exclusive to subscriptions with
* ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the
* maximum number of licenses assignable to users on a subscription. The
* reseller can add more licenses, but once set, the numberOfSeats cannot be
* reduced until renewal. The reseller is invoiced based on the
* numberOfSeats value regardless of how many of these user licenses are
* assigned. Note: G Suite subscriptions automatically assign a license to
* every user.
*/
numberOfSeats?: number;
}
/**
* JSON template for a subscription.
*/
interface Schema$Subscription {
/**
* Read-only field that returns the current billing method for a
* subscription.
*/
billingMethod?: string;
/**
* The creationTime property is the date when subscription was created. It
* is in milliseconds using the Epoch format. See an example Epoch
* converter.
*/
creationTime?: string;
/**
* Primary domain name of the customer
*/
customerDomain?: string;
/**
* This property will always be returned in a response as the unique
* identifier generated by Google. In a request, this property can be either
* the primary domain or the unique identifier generated by Google.
*/
customerId?: string;
/**
* Google-issued code (100 char max) for discounted pricing on subscription
* plans. Deal code must be included in insert requests in order to receive
* discounted rate. This property is optional, regular pricing applies if
* left empty.
*/
dealCode?: string;
/**
* Identifies the resource as a Subscription. Value: reseller#subscription
*/
kind?: string;
/**
* The plan property is required. In this version of the API, the G Suite
* plans are the flexible plan, annual commitment plan, and the 30-day free
* trial plan. For more information about the API"s payment plans, see
* the API concepts.
*/
plan?: {
commitmentInterval?: {
endTime?: string;
startTime?: string;
};
isCommitmentPlan?: boolean;
planName?: string;
};
/**
* This is an optional property. This purchase order (PO) information is for
* resellers to use for their company tracking usage. If a purchaseOrderId
* value is given it appears in the API responses and shows up in the
* invoice. The property accepts up to 80 plain text characters.
*/
purchaseOrderId?: string;
/**
* Renewal settings for the annual commitment plan. For more detailed
* information, see renewal options in the administrator help center.
*/
renewalSettings?: Schema$RenewalSettings;
/**
* URL to customer's Subscriptions page in the Admin console. The
* read-only URL is generated by the API service. This is used if your
* client application requires the customer to complete a task using the
* Subscriptions page in the Admin console.
*/
resourceUiUrl?: string;
/**
* This is a required property. The number and limit of user seat licenses
* in the plan.
*/
seats?: Schema$Seats;
/**
* A required property. The skuId is a unique system identifier for a
* product's SKU assigned to a customer in the subscription. For
* products and SKUs available in this version of the API, see Product and
* SKU IDs.
*/
skuId?: string;
/**
* Read-only external display name for a product's SKU assigned to a
* customer in the subscription. SKU names are subject to change at
* Google's discretion. For products and SKUs available in this version
* of the API, see Product and SKU IDs.
*/
skuName?: string;
/**
* This is an optional property.
*/
status?: string;
/**
* The subscriptionId is the subscription identifier and is unique for each
* customer. This is a required property. Since a subscriptionId changes
* when a subscription is updated, we recommend not using this ID as a key
* for persistent data. Use the subscriptionId as described in retrieve all
* reseller subscriptions.
*/
subscriptionId?: string;
/**
* Read-only field containing an enumerable of all the current suspension
* reasons for a subscription. It is possible for a subscription to have
* many concurrent, overlapping suspension reasons. A subscription's
* STATUS is SUSPENDED until all pending suspensions are removed. Possible
* options include: - PENDING_TOS_ACCEPTANCE - The customer has not logged
* in and accepted the G Suite Resold Terms of Services. -
* RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their
* service was cancelled at the end of their term. - RESELLER_INITIATED -
* A manual suspension invoked by a Reseller. - TRIAL_ENDED - The
* customer's trial expired without a plan selected. - OTHER - The
* customer is suspended for an internal Google reason (e.g. abuse or
* otherwise).
*/
suspensionReasons?: string[];
/**
* Read-only transfer related information for the subscription. For more
* information, see retrieve transferable subscriptions for a customer.
*/
transferInfo?: {
minimumTransferableSeats?: number;
transferabilityExpirationTime?: string;
};
/**
* The G Suite annual commitment and flexible payment plans can be in a
* 30-day free trial. For more information, see the API concepts.
*/
trialSettings?: {
isInTrial?: boolean;
trialEndTime?: string;
};
}
/**
* JSON template for a subscription list.
*/
interface Schema$Subscriptions {
/**
* Identifies the resource as a collection of subscriptions. Value:
* reseller#subscriptions
*/
kind?: string;
/**
* The continuation token, used to page through large result sets. Provide
* this value in a subsequent request to return the next page of results.
*/
nextPageToken?: string;
/**
* The subscriptions in this page of results.
*/
subscriptions?: Schema$Subscription[];
}
class Resource$Customers {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* reseller.customers.get
* @desc Get a customer account.
* @alias reseller.customers.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Customers$Get, options?: MethodOptions): GaxiosPromise<Schema$Customer>;
get(params: Params$Resource$Customers$Get, options: MethodOptions | BodyResponseCallback<Schema$Customer>, callback: BodyResponseCallback<Schema$Customer>): void;
get(params: Params$Resource$Customers$Get, callback: BodyResponseCallback<Schema$Customer>): void;
get(callback: BodyResponseCallback<Schema$Customer>): void;
/**
* reseller.customers.insert
* @desc Order a new customer's account.
* @alias reseller.customers.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.customerAuthToken The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.
* @param {().Customer} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Customers$Insert, options?: MethodOptions): GaxiosPromise<Schema$Customer>;
insert(params: Params$Resource$Customers$Insert, options: MethodOptions | BodyResponseCallback<Schema$Customer>, callback: BodyResponseCallback<Schema$Customer>): void;
insert(params: Params$Resource$Customers$Insert, callback: BodyResponseCallback<Schema$Customer>): void;
insert(callback: BodyResponseCallback<Schema$Customer>): void;
/**
* reseller.customers.patch
* @desc Update a customer account's settings. This method supports patch
* semantics.
* @alias reseller.customers.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
* @param {().Customer} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Customers$Patch, options?: MethodOptions): GaxiosPromise<Schema$Customer>;
patch(params: Params$Resource$Customers$Patch, options: MethodOptions | BodyResponseCallback<Schema$Customer>, callback: BodyResponseCallback<Schema$Customer>): void;
patch(params: Params$Resource$Customers$Patch, callback: BodyResponseCallback<Schema$Customer>): void;
patch(callback: BodyResponseCallback<Schema$Customer>): void;
/**
* reseller.customers.update
* @desc Update a customer account's settings.
* @alias reseller.customers.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
* @param {().Customer} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Customers$Update, options?: MethodOptions): GaxiosPromise<Schema$Customer>;
update(params: Params$Resource$Customers$Update, options: MethodOptions | BodyResponseCallback<Schema$Customer>, callback: BodyResponseCallback<Schema$Customer>): void;
update(params: Params$Resource$Customers$Update, callback: BodyResponseCallback<Schema$Customer>): void;
update(callback: BodyResponseCallback<Schema$Customer>): void;
}
interface Params$Resource$Customers$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Either the customer's primary domain name or the customer's unique
* identifier. If using the domain name, we do not recommend using a
* customerId as a key for persistent data. If the domain name for a
* customerId is changed, the Google system automatically updates.
*/
customerId?: string;
}
interface Params$Resource$Customers$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The customerAuthToken query string is required when creating a resold
* account that transfers a direct customer's subscription or transfers
* another reseller customer's subscription to your reseller management.
* This is a hexadecimal authentication token needed to complete the
* subscription transfer. For more information, see the administrator help
* center.
*/
customerAuthToken?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Customer;
}
interface Params$Resource$Customers$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Either the customer's primary domain name or the customer's unique
* identifier. If using the domain name, we do not recommend using a
* customerId as a key for persistent data. If the domain name for a
* customerId is changed, the Google system automatically updates.
*/
customerId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Customer;
}
interface Params$Resource$Customers$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Either the customer's primary domain name or the customer's unique
* identifier. If using the domain name, we do not recommend using a
* customerId as a key for persistent data. If the domain name for a
* customerId is changed, the Google system automatically updates.
*/
customerId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Customer;
}
class Resource$Resellernotify {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* reseller.resellernotify.getwatchdetails
* @desc Returns all the details of the watch corresponding to the reseller.
* @alias reseller.resellernotify.getwatchdetails
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getwatchdetails(params?: Params$Resource$Resellernotify$Getwatchdetails, options?: MethodOptions): GaxiosPromise<Schema$ResellernotifyGetwatchdetailsResponse>;
getwatchdetails(params: Params$Resource$Resellernotify$Getwatchdetails, options: MethodOptions | BodyResponseCallback<Schema$ResellernotifyGetwatchdetailsResponse>, callback: BodyResponseCallback<Schema$ResellernotifyGetwatchdetailsResponse>): void;
getwatchdetails(params: Params$Resource$Resellernotify$Getwatchdetails, callback: BodyResponseCallback<Schema$ResellernotifyGetwatchdetailsResponse>): void;
getwatchdetails(callback: BodyResponseCallback<Schema$ResellernotifyGetwatchdetailsResponse>): void;
/**
* reseller.resellernotify.register
* @desc Registers a Reseller for receiving notifications.
* @alias reseller.resellernotify.register
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.serviceAccountEmailAddress The service account which will own the created Cloud-PubSub topic.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
register(params?: Params$Resource$Resellernotify$Register, options?: MethodOptions): GaxiosPromise<Schema$ResellernotifyResource>;
register(params: Params$Resource$Resellernotify$Register, options: MethodOptions | BodyResponseCallback<Schema$ResellernotifyResource>, callback: BodyResponseCallback<Schema$ResellernotifyResource>): void;
register(params: Params$Resource$Resellernotify$Register, callback: BodyResponseCallback<Schema$ResellernotifyResource>): void;
register(callback: BodyResponseCallback<Schema$ResellernotifyResource>): void;
/**
* reseller.resellernotify.unregister
* @desc Unregisters a Reseller for receiving notifications.
* @alias reseller.resellernotify.unregister
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.serviceAccountEmailAddress The service account which owns the Cloud-PubSub topic.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
unregister(params?: Params$Resource$Resellernotify$Unregister, options?: MethodOptions): GaxiosPromise<Schema$ResellernotifyResource>;
unregister(params: Params$Resource$Resellernotify$Unregister, options: MethodOptions | BodyResponseCallback<Schema$ResellernotifyResource>, callback: BodyResponseCallback<Schema$ResellernotifyResource>): void;
unregister(params: Params$Resource$Resellernotify$Unregister, callback: BodyResponseCallback<Schema$ResellernotifyResource>): void;
unregister(callback: BodyResponseCallback<Schema$ResellernotifyResource>): void;
}
interface Params$Resource$Resellernotify$Getwatchdetails extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
interface Params$Resource$Resellernotify$Register extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The service account which will own the created Cloud-PubSub topic.
*/
serviceAccountEmailAddress?: string;
}
interface Params$Resource$Resellernotify$Unregister extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The service account which owns the Cloud-PubSub topic.
*/
serviceAccountEmailAddress?: string;
}
class Resource$Subscriptions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* reseller.subscriptions.activate
* @desc Activates a subscription previously suspended by the reseller
* @alias reseller.subscriptions.activate
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
* @param {string} params.subscriptionId This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
activate(params?: Params$Resource$Subscriptions$Activate, options?: MethodOptions): GaxiosPromise<Schema$Subscription>;
activate(params: Params$Resource$Subscriptions$Activate, options: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback: BodyResponseCallback<Schema$Subscription>): void;
activate(params: Params$Resource$Subscriptions$Activate, callback: BodyResponseCallback<Schema$Subscription>): void;
activate(callback: BodyResponseCallback<Schema$Subscription>): void;
/**
* reseller.subscriptions.changePlan
* @desc Update a subscription plan. Use this method to update a plan for a
* 30-day trial or a flexible plan subscription to an annual commitment plan
* with monthly or yearly payments.
* @alias reseller.subscriptions.changePlan
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
* @param {string} params.subscriptionId This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.
* @param {().ChangePlanRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
changePlan(params?: Params$Resource$Subscriptions$Changeplan, options?: MethodOptions): GaxiosPromise<Schema$Subscription>;
changePlan(params: Params$Resource$Subscriptions$Changeplan, options: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback: BodyResponseCallback<Schema$Subscription>): void;
changePlan(params: Params$Resource$Subscriptions$Changeplan, callback: BodyResponseCallback<Schema$Subscription>): void;
changePlan(callback: BodyResponseCallback<Schema$Subscription>): void;
/**
* reseller.subscriptions.changeRenewalSettings
* @desc Update a user license's renewal settings. This is applicable for
* accounts with annual commitment plans only.
* @alias reseller.subscriptions.changeRenewalSettings
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
* @param {string} params.subscriptionId This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.
* @param {().RenewalSettings} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
changeRenewalSettings(params?: Params$Resource$Subscriptions$Changerenewalsettings, options?: MethodOptions): GaxiosPromise<Schema$Subscription>;
changeRenewalSettings(params: Params$Resource$Subscriptions$Changerenewalsettings, options: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback: BodyResponseCallback<Schema$Subscription>): void;
changeRenewalSettings(params: Params$Resource$Subscriptions$Changerenewalsettings, callback: BodyResponseCallback<Schema$Subscription>): void;
changeRenewalSettings(callback: BodyResponseCallback<Schema$Subscription>): void;
/**
* reseller.subscriptions.changeSeats
* @desc Update a subscription's user license settings.
* @alias reseller.subscriptions.changeSeats
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
* @param {string} params.subscriptionId This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.
* @param {().Seats} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
changeSeats(params?: Params$Resource$Subscriptions$Changeseats, options?: MethodOptions): GaxiosPromise<Schema$Subscription>;
changeSeats(params: Params$Resource$Subscriptions$Changeseats, options: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback: BodyResponseCallback<Schema$Subscription>): void;
changeSeats(params: Params$Resource$Subscriptions$Changeseats, callback: BodyResponseCallback<Schema$Subscription>): void;
changeSeats(callback: BodyResponseCallback<Schema$Subscription>): void;
/**
* reseller.subscriptions.delete
* @desc Cancel or transfer a subscription to direct.
* @alias reseller.subscriptions.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
* @param {string} params.deletionType The deletionType query string enables the cancellation, downgrade, or suspension of a subscription.
* @param {string} params.subscriptionId This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Subscriptions$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Subscriptions$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Subscriptions$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* reseller.subscriptions.get
* @desc Get a specific subscription.
* @alias reseller.subscriptions.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
* @param {string} params.subscriptionId This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Subscriptions$Get, options?: MethodOptions): GaxiosPromise<Schema$Subscription>;
get(params: Params$Resource$Subscriptions$Get, options: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback: BodyResponseCallback<Schema$Subscription>): void;
get(params: Params$Resource$Subscriptions$Get, callback: BodyResponseCallback<Schema$Subscription>): void;
get(callback: BodyResponseCallback<Schema$Subscription>): void;
/**
* reseller.subscriptions.insert
* @desc Create or transfer a subscription.
* @alias reseller.subscriptions.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.customerAuthToken The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.
* @param {string} params.customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
* @param {().Subscription} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Subscriptions$Insert, options?: MethodOptions): GaxiosPromise<Schema$Subscription>;
insert(params: Params$Resource$Subscriptions$Insert, options: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback: BodyResponseCallback<Schema$Subscription>): void;
insert(params: Params$Resource$Subscriptions$Insert, callback: BodyResponseCallback<Schema$Subscription>): void;
insert(callback: BodyResponseCallback<Schema$Subscription>): void;
/**
* reseller.subscriptions.list
* @desc List of subscriptions managed by the reseller. The list can be all
* subscriptions, all of a customer's subscriptions, or all of a customer's
* transferable subscriptions.
* @alias reseller.subscriptions.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.customerAuthToken The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.
* @param {string=} params.customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
* @param {string=} params.customerNamePrefix When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes exam.com, example20.com and example.com: - exa -- Returns all customer names that start with 'exa' which could include exam.com, example20.com, and example.com. A name prefix is similar to using a regular expression's asterisk, exa*. - example -- Returns example20.com and example.com.
* @param {integer=} params.maxResults When retrieving a large list, the maxResults is the maximum number of results per page. The nextPageToken value takes you to the next page. The default is 20.
* @param {string=} params.pageToken Token to specify next page in the list
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Subscriptions$List, options?: MethodOptions): GaxiosPromise<Schema$Subscriptions>;
list(params: Params$Resource$Subscriptions$List, options: MethodOptions | BodyResponseCallback<Schema$Subscriptions>, callback: BodyResponseCallback<Schema$Subscriptions>): void;
list(params: Params$Resource$Subscriptions$List, callback: BodyResponseCallback<Schema$Subscriptions>): void;
list(callback: BodyResponseCallback<Schema$Subscriptions>): void;
/**
* reseller.subscriptions.startPaidService
* @desc Immediately move a 30-day free trial subscription to a paid service
* subscription.
* @alias reseller.subscriptions.startPaidService
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
* @param {string} params.subscriptionId This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
startPaidService(params?: Params$Resource$Subscriptions$Startpaidservice, options?: MethodOptions): GaxiosPromise<Schema$Subscription>;
startPaidService(params: Params$Resource$Subscriptions$Startpaidservice, options: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback: BodyResponseCallback<Schema$Subscription>): void;
startPaidService(params: Params$Resource$Subscriptions$Startpaidservice, callback: BodyResponseCallback<Schema$Subscription>): void;
startPaidService(callback: BodyResponseCallback<Schema$Subscription>): void;
/**
* reseller.subscriptions.suspend
* @desc Suspends an active subscription.
* @alias reseller.subscriptions.suspend
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
* @param {string} params.subscriptionId This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
suspend(params?: Params$Resource$Subscriptions$Suspend, options?: MethodOptions): GaxiosPromise<Schema$Subscription>;
suspend(params: Params$Resource$Subscriptions$Suspend, options: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback: BodyResponseCallback<Schema$Subscription>): void;
suspend(params: Params$Resource$Subscriptions$Suspend, callback: BodyResponseCallback<Schema$Subscription>): void;
suspend(callback: BodyResponseCallback<Schema$Subscription>): void;
}
interface Params$Resource$Subscriptions$Activate extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Either the customer's primary domain name or the customer's unique
* identifier. If using the domain name, we do not recommend using a
* customerId as a key for persistent data. If the domain name for a
* customerId is changed, the Google system automatically updates.
*/
customerId?: string;
/**
* This is a required property. The subscriptionId is the subscription
* identifier and is unique for each customer. Since a subscriptionId
* changes when a subscription is updated, we recommend to not use this ID
* as a key for persistent data. And the subscriptionId can be found using
* the retrieve all reseller subscriptions method.
*/
subscriptionId?: string;
}
interface Params$Resource$Subscriptions$Changeplan extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Either the customer's primary domain name or the customer's unique
* identifier. If using the domain name, we do not recommend using a
* customerId as a key for persistent data. If the domain name for a
* customerId is changed, the Google system automatically updates.
*/
customerId?: string;
/**
* This is a required property. The subscriptionId is the subscription
* identifier and is unique for each customer. Since a subscriptionId
* changes when a subscription is updated, we recommend to not use this ID
* as a key for persistent data. And the subscriptionId can be found using
* the retrieve all reseller subscriptions method.
*/
subscriptionId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ChangePlanRequest;
}
interface Params$Resource$Subscriptions$Changerenewalsettings extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Either the customer's primary domain name or the customer's unique
* identifier. If using the domain name, we do not recommend using a
* customerId as a key for persistent data. If the domain name for a
* customerId is changed, the Google system automatically updates.
*/
customerId?: string;
/**
* This is a required property. The subscriptionId is the subscription
* identifier and is unique for each customer. Since a subscriptionId
* changes when a subscription is updated, we recommend to not use this ID
* as a key for persistent data. And the subscriptionId can be found using
* the retrieve all reseller subscriptions method.
*/
subscriptionId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RenewalSettings;
}
interface Params$Resource$Subscriptions$Changeseats extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Either the customer's primary domain name or the customer's unique
* identifier. If using the domain name, we do not recommend using a
* customerId as a key for persistent data. If the domain name for a
* customerId is changed, the Google system automatically updates.
*/
customerId?: string;
/**
* This is a required property. The subscriptionId is the subscription
* identifier and is unique for each customer. Since a subscriptionId
* changes when a subscription is updated, we recommend to not use this ID
* as a key for persistent data. And the subscriptionId can be found using
* the retrieve all reseller subscriptions method.
*/
subscriptionId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Seats;
}
interface Params$Resource$Subscriptions$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Either the customer's primary domain name or the customer's unique
* identifier. If using the domain name, we do not recommend using a
* customerId as a key for persistent data. If the domain name for a
* customerId is changed, the Google system automatically updates.
*/
customerId?: string;
/**
* The deletionType query string enables the cancellation, downgrade, or
* suspension of a subscription.
*/
deletionType?: string;
/**
* This is a required property. The subscriptionId is the subscription
* identifier and is unique for each customer. Since a subscriptionId
* changes when a subscription is updated, we recommend to not use this ID
* as a key for persistent data. And the subscriptionId can be found using
* the retrieve all reseller subscriptions method.
*/
subscriptionId?: string;
}
interface Params$Resource$Subscriptions$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Either the customer's primary domain name or the customer's unique
* identifier. If using the domain name, we do not recommend using a
* customerId as a key for persistent data. If the domain name for a
* customerId is changed, the Google system automatically updates.
*/
customerId?: string;
/**
* This is a required property. The subscriptionId is the subscription
* identifier and is unique for each customer. Since a subscriptionId
* changes when a subscription is updated, we recommend to not use this ID
* as a key for persistent data. And the subscriptionId can be found using
* the retrieve all reseller subscriptions method.
*/
subscriptionId?: string;
}
interface Params$Resource$Subscriptions$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The customerAuthToken query string is required when creating a resold
* account that transfers a direct customer's subscription or transfers
* another reseller customer's subscription to your reseller management.
* This is a hexadecimal authentication token needed to complete the
* subscription transfer. For more information, see the administrator help
* center.
*/
customerAuthToken?: string;
/**
* Either the customer's primary domain name or the customer's unique
* identifier. If using the domain name, we do not recommend using a
* customerId as a key for persistent data. If the domain name for a
* customerId is changed, the Google system automatically updates.
*/
customerId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Subscription;
}
interface Params$Resource$Subscriptions$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The customerAuthToken query string is required when creating a resold
* account that transfers a direct customer's subscription or transfers
* another reseller customer's subscription to your reseller management.
* This is a hexadecimal authentication token needed to complete the
* subscription transfer. For more information, see the administrator help
* center.
*/
customerAuthToken?: string;
/**
* Either the customer's primary domain name or the customer's unique
* identifier. If using the domain name, we do not recommend using a
* customerId as a key for persistent data. If the domain name for a
* customerId is changed, the Google system automatically updates.
*/
customerId?: string;
/**
* When retrieving all of your subscriptions and filtering for specific
* customers, you can enter a prefix for a customer name. Using an example
* customer group that includes exam.com, example20.com and example.com: -
* exa -- Returns all customer names that start with 'exa' which could
* include exam.com, example20.com, and example.com. A name prefix is
* similar to using a regular expression's asterisk, exa*. - example --
* Returns example20.com and example.com.
*/
customerNamePrefix?: string;
/**
* When retrieving a large list, the maxResults is the maximum number of
* results per page. The nextPageToken value takes you to the next page. The
* default is 20.
*/
maxResults?: number;
/**
* Token to specify next page in the list
*/
pageToken?: string;
}
interface Params$Resource$Subscriptions$Startpaidservice extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Either the customer's primary domain name or the customer's unique
* identifier. If using the domain name, we do not recommend using a
* customerId as a key for persistent data. If the domain name for a
* customerId is changed, the Google system automatically updates.
*/
customerId?: string;
/**
* This is a required property. The subscriptionId is the subscription
* identifier and is unique for each customer. Since a subscriptionId
* changes when a subscription is updated, we recommend to not use this ID
* as a key for persistent data. And the subscriptionId can be found using
* the retrieve all reseller subscriptions method.
*/
subscriptionId?: string;
}
interface Params$Resource$Subscriptions$Suspend extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Either the customer's primary domain name or the customer's unique
* identifier. If using the domain name, we do not recommend using a
* customerId as a key for persistent data. If the domain name for a
* customerId is changed, the Google system automatically updates.
*/
customerId?: string;
/**
* This is a required property. The subscriptionId is the subscription
* identifier and is unique for each customer. Since a subscriptionId
* changes when a subscription is updated, we recommend to not use this ID
* as a key for persistent data. And the subscriptionId can be found using
* the retrieve all reseller subscriptions method.
*/
subscriptionId?: string;
}
}