-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
reseller-gen.go
2785 lines (2596 loc) · 110 KB
/
reseller-gen.go
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
// Copyright 2024 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package reseller provides access to the Google Workspace Reseller API.
//
// For product documentation, see: https://developers.google.com/google-apps/reseller/
//
// # Library status
//
// These client libraries are officially supported by Google. However, this
// library is considered complete and is in maintenance mode. This means
// that we will address critical bugs and security issues but will not add
// any new features.
//
// When possible, we recommend using our newer
// [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)
// that are still actively being worked and iterated on.
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/reseller/v1"
// ...
// ctx := context.Background()
// resellerService, err := reseller.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for
// authentication. For information on how to create and obtain Application
// Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// # Other authentication options
//
// By default, all available scopes (see "Constants") are used to authenticate.
// To restrict scopes, use [google.golang.org/api/option.WithScopes]:
//
// resellerService, err := reseller.NewService(ctx, option.WithScopes(reseller.AppsOrderReadonlyScope))
//
// To use an API key for authentication (note: some APIs do not support API
// keys), use [google.golang.org/api/option.WithAPIKey]:
//
// resellerService, err := reseller.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth
// flow, use [google.golang.org/api/option.WithTokenSource]:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// resellerService, err := reseller.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See [google.golang.org/api/option.ClientOption] for details on options.
package reseller // import "google.golang.org/api/reseller/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
var _ = internal.Version
const apiId = "reseller:v1"
const apiName = "reseller"
const apiVersion = "v1"
const basePath = "https://reseller.googleapis.com/"
const basePathTemplate = "https://reseller.UNIVERSE_DOMAIN/"
const mtlsBasePath = "https://reseller.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// Manage users on your domain
AppsOrderScope = "https://www.googleapis.com/auth/apps.order"
// Manage users on your domain
AppsOrderReadonlyScope = "https://www.googleapis.com/auth/apps.order.readonly"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/apps.order",
"https://www.googleapis.com/auth/apps.order.readonly",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
opts = append(opts, internaloption.EnableNewAuthLibrary())
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Customers = NewCustomersService(s)
s.Resellernotify = NewResellernotifyService(s)
s.Subscriptions = NewSubscriptionsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Customers *CustomersService
Resellernotify *ResellernotifyService
Subscriptions *SubscriptionsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewCustomersService(s *Service) *CustomersService {
rs := &CustomersService{s: s}
return rs
}
type CustomersService struct {
s *Service
}
func NewResellernotifyService(s *Service) *ResellernotifyService {
rs := &ResellernotifyService{s: s}
return rs
}
type ResellernotifyService struct {
s *Service
}
func NewSubscriptionsService(s *Service) *SubscriptionsService {
rs := &SubscriptionsService{s: s}
return rs
}
type SubscriptionsService struct {
s *Service
}
// Address: JSON template for address of a customer.
type Address struct {
// AddressLine1: A customer's physical address. An address can be composed of
// one to three lines. The `addressline2` and `addressLine3` are optional.
AddressLine1 string `json:"addressLine1,omitempty"`
// AddressLine2: Line 2 of the address.
AddressLine2 string `json:"addressLine2,omitempty"`
// AddressLine3: Line 3 of the address.
AddressLine3 string `json:"addressLine3,omitempty"`
// ContactName: The customer contact's name. This is required.
ContactName string `json:"contactName,omitempty"`
// CountryCode: 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 `json:"countryCode,omitempty"`
// Kind: Identifies the resource as a customer address. Value:
// `customers#address`
Kind string `json:"kind,omitempty"`
// Locality: An example of a `locality` value is the city of `San Francisco`.
Locality string `json:"locality,omitempty"`
// OrganizationName: The company or company division name. This is required.
OrganizationName string `json:"organizationName,omitempty"`
// PostalCode: A `postalCode` example is a postal zip code such as `94043`.
// This property is required when creating a new customer.
PostalCode string `json:"postalCode,omitempty"`
// Region: An example of a `region` value is `CA` for the state of California.
Region string `json:"region,omitempty"`
// ForceSendFields is a list of field names (e.g. "AddressLine1") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AddressLine1") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Address) MarshalJSON() ([]byte, error) {
type NoMethod Address
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// ChangePlanRequest: JSON template for the ChangePlan rpc request.
type ChangePlanRequest struct {
// DealCode: 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 `json:"dealCode,omitempty"`
// Kind: Identifies the resource as a subscription change plan request. Value:
// `subscriptions#changePlanRequest`
Kind string `json:"kind,omitempty"`
// PlanName: 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 `json:"planName,omitempty"`
// PurchaseOrderId: 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 `json:"purchaseOrderId,omitempty"`
// Seats: This is a required property. The seats property is the number of user
// seat licenses.
Seats *Seats `json:"seats,omitempty"`
// ForceSendFields is a list of field names (e.g. "DealCode") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DealCode") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ChangePlanRequest) MarshalJSON() ([]byte, error) {
type NoMethod ChangePlanRequest
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Customer: When a Google customer's account is registered with a reseller,
// the customer's subscriptions for Google services are managed by this
// reseller. A customer is described by a primary domain name and a physical
// address.
type Customer struct {
// AlternateEmail: 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 "domain" customer and should not use the same domain as
// `customerDomain`. The `alternateEmail` field is not necessary to create a
// "team" customer.
AlternateEmail string `json:"alternateEmail,omitempty"`
// CustomerDomain: 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 `json:"customerDomain,omitempty"`
// CustomerDomainVerified: Whether the customer's primary domain has been
// verified.
CustomerDomainVerified bool `json:"customerDomainVerified,omitempty"`
// CustomerId: 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 `json:"customerId,omitempty"`
// CustomerType: Identifies the type of the customer. Acceptable values
// include: * `domain`: Implies a domain-verified customer (default). * `team`:
// Implies an email-verified customer. For more information, see managed teams
// (https://support.google.com/a/users/answer/9939479).
//
// Possible values:
// "customerTypeUnspecified" - Customer type not known
// "domain" - Domained or domain-owning customers
// "team" - Domainless or email-verified customers
CustomerType string `json:"customerType,omitempty"`
// Kind: Identifies the resource as a customer. Value: `reseller#customer`
Kind string `json:"kind,omitempty"`
// PhoneNumber: 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 `json:"phoneNumber,omitempty"`
// PostalAddress: A customer's address information. Each field has a limit of
// 255 charcters.
PostalAddress *Address `json:"postalAddress,omitempty"`
// PrimaryAdmin: The first admin details of the customer, present in case of
// TEAM customer.
PrimaryAdmin *PrimaryAdmin `json:"primaryAdmin,omitempty"`
// ResourceUiUrl: 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:"resourceUiUrl,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AlternateEmail") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AlternateEmail") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Customer) MarshalJSON() ([]byte, error) {
type NoMethod Customer
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// PrimaryAdmin: JSON template for primary admin in case of TEAM customers
type PrimaryAdmin struct {
// PrimaryEmail: The business email of the primary administrator of the
// customer. The email verification link is sent to this email address at the
// time of customer creation. Primary administrators have access to the
// customer's Admin Console, including the ability to invite and evict users
// and manage the administrative needs of the customer.
PrimaryEmail string `json:"primaryEmail,omitempty"`
// ForceSendFields is a list of field names (e.g. "PrimaryEmail") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PrimaryEmail") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PrimaryAdmin) MarshalJSON() ([]byte, error) {
type NoMethod PrimaryAdmin
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// RenewalSettings: JSON template for a subscription renewal settings.
type RenewalSettings struct {
// Kind: Identifies the resource as a subscription renewal setting. Value:
// `subscriptions#renewalSettings`
Kind string `json:"kind,omitempty"`
// RenewalType: 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:"renewalType,omitempty"`
// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Kind") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *RenewalSettings) MarshalJSON() ([]byte, error) {
type NoMethod RenewalSettings
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// ResellernotifyGetwatchdetailsResponse: JSON template for resellernotify
// getwatchdetails response.
type ResellernotifyGetwatchdetailsResponse struct {
// ServiceAccountEmailAddresses: List of registered service accounts.
ServiceAccountEmailAddresses []string `json:"serviceAccountEmailAddresses,omitempty"`
// TopicName: Topic name of the PubSub
TopicName string `json:"topicName,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g.
// "ServiceAccountEmailAddresses") to unconditionally include in API requests.
// By default, fields with empty or default values are omitted from API
// requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
// for more details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ServiceAccountEmailAddresses") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResellernotifyGetwatchdetailsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ResellernotifyGetwatchdetailsResponse
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// ResellernotifyResource: JSON template for resellernotify response.
type ResellernotifyResource struct {
// TopicName: Topic name of the PubSub
TopicName string `json:"topicName,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "TopicName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "TopicName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResellernotifyResource) MarshalJSON() ([]byte, error) {
type NoMethod ResellernotifyResource
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Seats: JSON template for subscription seats.
type Seats struct {
// Kind: Identifies the resource as a subscription seat setting. Value:
// `subscriptions#seats`
Kind string `json:"kind,omitempty"`
// LicensedNumberOfSeats: 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`
// (/admin-sdk/licensing/v1/reference/licenseAssignments/listForProductAndSku).
LicensedNumberOfSeats int64 `json:"licensedNumberOfSeats,omitempty"`
// MaximumNumberOfSeats: 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 int64 `json:"maximumNumberOfSeats,omitempty"`
// NumberOfSeats: 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:
// *Google Workspace subscriptions automatically assign a license to every
// user.
NumberOfSeats int64 `json:"numberOfSeats,omitempty"`
// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Kind") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Seats) MarshalJSON() ([]byte, error) {
type NoMethod Seats
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Subscription: JSON template for a subscription.
type Subscription struct {
// BillingMethod: Read-only field that returns the current billing method for a
// subscription.
BillingMethod string `json:"billingMethod,omitempty"`
// CreationTime: The `creationTime` property is the date when subscription was
// created. It is in milliseconds using the Epoch format. See an example Epoch
// converter.
CreationTime int64 `json:"creationTime,omitempty,string"`
// CustomerDomain: Primary domain name of the customer
CustomerDomain string `json:"customerDomain,omitempty"`
// CustomerId: 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 `json:"customerId,omitempty"`
// DealCode: 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 `json:"dealCode,omitempty"`
// Kind: Identifies the resource as a Subscription. Value:
// `reseller#subscription`
Kind string `json:"kind,omitempty"`
// Plan: 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 *SubscriptionPlan `json:"plan,omitempty"`
// PurchaseOrderId: 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 `json:"purchaseOrderId,omitempty"`
// RenewalSettings: Renewal settings for the annual commitment plan. For more
// detailed information, see renewal options in the administrator help center.
RenewalSettings *RenewalSettings `json:"renewalSettings,omitempty"`
// ResourceUiUrl: 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 `json:"resourceUiUrl,omitempty"`
// Seats: This is a required property. The number and limit of user seat
// licenses in the plan.
Seats *Seats `json:"seats,omitempty"`
// SkuId: 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 `json:"skuId,omitempty"`
// SkuName: 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 `json:"skuName,omitempty"`
// Status: This is an optional property.
Status string `json:"status,omitempty"`
// SubscriptionId: 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 `json:"subscriptionId,omitempty"`
// SuspensionReasons: 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 `json:"suspensionReasons,omitempty"`
// TransferInfo: Read-only transfer related information for the subscription.
// For more information, see retrieve transferable subscriptions for a
// customer.
TransferInfo *SubscriptionTransferInfo `json:"transferInfo,omitempty"`
// TrialSettings: 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 *SubscriptionTrialSettings `json:"trialSettings,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "BillingMethod") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "BillingMethod") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Subscription) MarshalJSON() ([]byte, error) {
type NoMethod Subscription
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// SubscriptionPlan: 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.
type SubscriptionPlan struct {
// CommitmentInterval: In this version of the API, annual commitment plan's
// interval is one year. *Note: *When `billingMethod` value is `OFFLINE`, the
// subscription property object `plan.commitmentInterval` is omitted in all API
// responses.
CommitmentInterval *SubscriptionPlanCommitmentInterval `json:"commitmentInterval,omitempty"`
// IsCommitmentPlan: The `isCommitmentPlan` property's boolean value identifies
// the plan as an annual commitment plan: - `true` — The subscription's plan
// is an annual commitment plan. - `false` — The plan is not an annual
// commitment plan.
IsCommitmentPlan bool `json:"isCommitmentPlan,omitempty"`
// PlanName: The `planName` property is required. This is the name of the
// subscription's plan. For more information about the Google payment plans,
// see the 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. A
// subscription in trial will be suspended after the 30th free day if no
// payment plan is assigned. Calling `changePlan` will assign a payment plan to
// a trial but will not activate the plan. A trial will automatically begin its
// assigned payment plan after its 30th free day or immediately after calling
// `startPaidService`. - `FREE` — The free plan is exclusive to the Cloud
// Identity SKU and does not incur any billing.
PlanName string `json:"planName,omitempty"`
// ForceSendFields is a list of field names (e.g. "CommitmentInterval") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CommitmentInterval") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SubscriptionPlan) MarshalJSON() ([]byte, error) {
type NoMethod SubscriptionPlan
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// SubscriptionPlanCommitmentInterval: In this version of the API, annual
// commitment plan's interval is one year. *Note: *When `billingMethod` value
// is `OFFLINE`, the subscription property object `plan.commitmentInterval` is
// omitted in all API responses.
type SubscriptionPlanCommitmentInterval struct {
// EndTime: An annual commitment plan's interval's `endTime` in milliseconds
// using the UNIX Epoch format. See an example Epoch converter.
EndTime int64 `json:"endTime,omitempty,string"`
// StartTime: An annual commitment plan's interval's `startTime` in
// milliseconds using UNIX Epoch format. See an example Epoch converter.
StartTime int64 `json:"startTime,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EndTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SubscriptionPlanCommitmentInterval) MarshalJSON() ([]byte, error) {
type NoMethod SubscriptionPlanCommitmentInterval
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// SubscriptionTransferInfo: Read-only transfer related information for the
// subscription. For more information, see retrieve transferable subscriptions
// for a customer.
type SubscriptionTransferInfo struct {
// CurrentLegacySkuId: The `skuId` of the current resold subscription. This is
// populated only when the customer has a subscription with a legacy SKU and
// the subscription resource is populated with the `skuId` of the SKU
// recommended for the transfer.
CurrentLegacySkuId string `json:"currentLegacySkuId,omitempty"`
// MinimumTransferableSeats: When inserting a subscription, this is the minimum
// number of seats listed in the transfer order for this product. For example,
// if the customer has 20 users, the reseller cannot place a transfer order of
// 15 seats. The minimum is 20 seats.
MinimumTransferableSeats int64 `json:"minimumTransferableSeats,omitempty"`
// TransferabilityExpirationTime: The time when transfer token or intent to
// transfer will expire. The time is in milliseconds using UNIX Epoch format.
TransferabilityExpirationTime int64 `json:"transferabilityExpirationTime,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "CurrentLegacySkuId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CurrentLegacySkuId") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SubscriptionTransferInfo) MarshalJSON() ([]byte, error) {
type NoMethod SubscriptionTransferInfo
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// SubscriptionTrialSettings: The G Suite annual commitment and flexible
// payment plans can be in a 30-day free trial. For more information, see the
// API concepts.
type SubscriptionTrialSettings struct {
// IsInTrial: Determines if a subscription's plan is in a 30-day free trial or
// not: - `true` — The plan is in trial. - `false` — The plan is not in
// trial.
IsInTrial bool `json:"isInTrial,omitempty"`
// TrialEndTime: Date when the trial ends. The value is in milliseconds using
// the UNIX Epoch format. See an example Epoch converter.
TrialEndTime int64 `json:"trialEndTime,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "IsInTrial") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "IsInTrial") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SubscriptionTrialSettings) MarshalJSON() ([]byte, error) {
type NoMethod SubscriptionTrialSettings
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Subscriptions: A subscription manages the relationship of a Google
// customer's payment plan with a product's SKU, user licenses, 30-day free
// trial status, and renewal options. A primary role of a reseller is to manage
// the Google customer's subscriptions.
type Subscriptions struct {
// Kind: Identifies the resource as a collection of subscriptions. Value:
// reseller#subscriptions
Kind string `json:"kind,omitempty"`
// NextPageToken: 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 `json:"nextPageToken,omitempty"`
// Subscriptions: The subscriptions in this page of results.
Subscriptions []*Subscription `json:"subscriptions,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Kind") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Subscriptions) MarshalJSON() ([]byte, error) {
type NoMethod Subscriptions
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
type CustomersGetCall struct {
s *Service
customerId string
urlParams_ gensupport.URLParams
ifNoneMatch_ string
ctx_ context.Context
header_ http.Header
}
// Get: Gets a customer account. Use this operation to see a customer account
// already in your reseller management, or to see the minimal account
// information for an existing customer that you do not manage. For more
// information about the API response for existing customers, see retrieving a
// customer account
// (/admin-sdk/reseller/v1/how-tos/manage_customers#get_customer).
//
// - customerId: This can be either the customer's primary domain name or the
// customer's unique identifier. If the domain name for a customer changes,
// the old domain name cannot be used to access the customer, but the
// customer's unique identifier (as returned by the API) can always be used.
// We recommend storing the unique identifier in your systems where
// applicable.
func (r *CustomersService) Get(customerId string) *CustomersGetCall {
c := &CustomersGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.customerId = customerId
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
// details.
func (c *CustomersGetCall) Fields(s ...googleapi.Field) *CustomersGetCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// IfNoneMatch sets an optional parameter which makes the operation fail if the
// object's ETag matches the given value. This is useful for getting updates
// only after the object has changed since the last request.
func (c *CustomersGetCall) IfNoneMatch(entityTag string) *CustomersGetCall {
c.ifNoneMatch_ = entityTag
return c
}
// Context sets the context to be used in this call's Do method.
func (c *CustomersGetCall) Context(ctx context.Context) *CustomersGetCall {
c.ctx_ = ctx
return c
}
// Header returns a http.Header that can be modified by the caller to add
// headers to the request.
func (c *CustomersGetCall) Header() http.Header {
if c.header_ == nil {
c.header_ = make(http.Header)
}
return c.header_
}
func (c *CustomersGetCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_)
if c.ifNoneMatch_ != "" {
reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
}
var body io.Reader = nil
c.urlParams_.Set("alt", alt)
c.urlParams_.Set("prettyPrint", "false")
urls := googleapi.ResolveRelative(c.s.BasePath, "apps/reseller/v1/customers/{customerId}")
urls += "?" + c.urlParams_.Encode()
req, err := http.NewRequest("GET", urls, body)
if err != nil {
return nil, err
}
req.Header = reqHeaders
googleapi.Expand(req.URL, map[string]string{
"customerId": c.customerId,
})
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Do executes the "reseller.customers.get" call.
// Any non-2xx status code is an error. Response headers are in either
// *Customer.ServerResponse.Header or (if a response was returned at all) in
// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
// whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersGetCall) Do(opts ...googleapi.CallOption) (*Customer, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("json")
if res != nil && res.StatusCode == http.StatusNotModified {
if res.Body != nil {
res.Body.Close()
}
return nil, gensupport.WrapError(&googleapi.Error{
Code: res.StatusCode,
Header: res.Header,
})
}
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, gensupport.WrapError(err)
}
ret := &Customer{
ServerResponse: googleapi.ServerResponse{
Header: res.Header,
HTTPStatusCode: res.StatusCode,
},
}
target := &ret
if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
}
type CustomersInsertCall struct {
s *Service
customer *Customer
urlParams_ gensupport.URLParams
ctx_ context.Context
header_ http.Header
}
// Insert: Orders a new customer's account. Before ordering a new customer
// account, establish whether the customer account already exists using the
// `customers.get` (/admin-sdk/reseller/v1/reference/customers/get) If the
// customer account exists as a direct Google account or as a resold customer
// account from another reseller, use the `customerAuthToken\` as described in
// order a resold account for an existing customer
// (/admin-sdk/reseller/v1/how-tos/manage_customers#create_existing_customer).
// For more information about ordering a new customer account, see order a new
// customer account
// (/admin-sdk/reseller/v1/how-tos/manage_customers#create_customer). After
// creating a new customer account, you must provision a user as an
// administrator. The customer's administrator is required to sign in to the
// Admin console and sign the G Suite via Reseller agreement to activate the
// account. Resellers are prohibited from signing the G Suite via Reseller
// agreement on the customer's behalf. For more information, see order a new
// customer account (/admin-sdk/reseller/v1/how-tos/manage_customers#tos).
func (r *CustomersService) Insert(customer *Customer) *CustomersInsertCall {
c := &CustomersInsertCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.customer = customer
return c
}
// CustomerAuthToken sets the optional parameter "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.
func (c *CustomersInsertCall) CustomerAuthToken(customerAuthToken string) *CustomersInsertCall {
c.urlParams_.Set("customerAuthToken", customerAuthToken)
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
// details.
func (c *CustomersInsertCall) Fields(s ...googleapi.Field) *CustomersInsertCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// Context sets the context to be used in this call's Do method.
func (c *CustomersInsertCall) Context(ctx context.Context) *CustomersInsertCall {
c.ctx_ = ctx
return c
}
// Header returns a http.Header that can be modified by the caller to add
// headers to the request.
func (c *CustomersInsertCall) Header() http.Header {
if c.header_ == nil {
c.header_ = make(http.Header)
}
return c.header_
}
func (c *CustomersInsertCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_)
var body io.Reader = nil
body, err := googleapi.WithoutDataWrapper.JSONReader(c.customer)
if err != nil {
return nil, err
}
c.urlParams_.Set("alt", alt)
c.urlParams_.Set("prettyPrint", "false")
urls := googleapi.ResolveRelative(c.s.BasePath, "apps/reseller/v1/customers")
urls += "?" + c.urlParams_.Encode()
req, err := http.NewRequest("POST", urls, body)
if err != nil {
return nil, err
}
req.Header = reqHeaders
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Do executes the "reseller.customers.insert" call.
// Any non-2xx status code is an error. Response headers are in either
// *Customer.ServerResponse.Header or (if a response was returned at all) in
// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
// whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersInsertCall) Do(opts ...googleapi.CallOption) (*Customer, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("json")
if res != nil && res.StatusCode == http.StatusNotModified {
if res.Body != nil {
res.Body.Close()