reseller

package
v0.196.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 3, 2024 License: BSD-3-Clause Imports: 16 Imported by: 1

Documentation

Overview

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.

Index

Constants

View Source 
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"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Address 

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:"-"`
}

Address: JSON template for address of a customer.

func (Address) MarshalJSON 

func (s Address) MarshalJSON() ([]byte, error)

type ChangePlanRequest 

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:"-"`
}

ChangePlanRequest: JSON template for the ChangePlan rpc request.

func (ChangePlanRequest) MarshalJSON 

func (s ChangePlanRequest) MarshalJSON() ([]byte, error)

type Customer 

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:"-"`
}

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.

func (Customer) MarshalJSON 

func (s Customer) MarshalJSON() ([]byte, error)

type CustomersGetCall 

type CustomersGetCall struct {
	// contains filtered or unexported fields
}

func (*CustomersGetCall) Context 

func (c *CustomersGetCall) Context(ctx context.Context) *CustomersGetCall

Context sets the context to be used in this call's Do method.

func (*CustomersGetCall) Do 

func (c *CustomersGetCall) Do(opts ...googleapi.CallOption) (*Customer, error)

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 (*CustomersGetCall) Fields 

func (c *CustomersGetCall) Fields(s ...googleapi.Field) *CustomersGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CustomersGetCall) Header 

func (c *CustomersGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CustomersGetCall) IfNoneMatch 

func (c *CustomersGetCall) IfNoneMatch(entityTag string) *CustomersGetCall

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.

type CustomersInsertCall 

type CustomersInsertCall struct {
	// contains filtered or unexported fields
}

func (*CustomersInsertCall) Context 

func (c *CustomersInsertCall) Context(ctx context.Context) *CustomersInsertCall

Context sets the context to be used in this call's Do method.

func (*CustomersInsertCall) CustomerAuthToken 

func (c *CustomersInsertCall) CustomerAuthToken(customerAuthToken string) *CustomersInsertCall

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 (*CustomersInsertCall) Do 

func (c *CustomersInsertCall) Do(opts ...googleapi.CallOption) (*Customer, error)

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 (*CustomersInsertCall) Fields 

func (c *CustomersInsertCall) Fields(s ...googleapi.Field) *CustomersInsertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CustomersInsertCall) Header 

func (c *CustomersInsertCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CustomersPatchCall 

type CustomersPatchCall struct {
	// contains filtered or unexported fields
}

func (*CustomersPatchCall) Context 

func (c *CustomersPatchCall) Context(ctx context.Context) *CustomersPatchCall

Context sets the context to be used in this call's Do method.

func (*CustomersPatchCall) Do 

func (c *CustomersPatchCall) Do(opts ...googleapi.CallOption) (*Customer, error)

Do executes the "reseller.customers.patch" 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 (*CustomersPatchCall) Fields 

func (c *CustomersPatchCall) Fields(s ...googleapi.Field) *CustomersPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CustomersPatchCall) Header 

func (c *CustomersPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CustomersService 

type CustomersService struct {
	// contains filtered or unexported fields
}

func NewCustomersService 

func NewCustomersService(s *Service) *CustomersService

func (*CustomersService) Get 

func (r *CustomersService) Get(customerId string) *CustomersGetCall

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 (*CustomersService) Insert 

func (r *CustomersService) Insert(customer *Customer) *CustomersInsertCall

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 (*CustomersService) Patch 

func (r *CustomersService) Patch(customerId string, customer *Customer) *CustomersPatchCall

Patch: Updates a customer account's settings. This method supports patch semantics. You cannot update `customerType` via the Reseller API, but a "team" customer can verify their domain and become `customerType = "domain". For more information, see Verify your domain to unlock Essentials features (https://support.google.com/a/answer/9122284).

  • 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 (*CustomersService) Update 

func (r *CustomersService) Update(customerId string, customer *Customer) *CustomersUpdateCall

Update: Updates a customer account's settings. You cannot update `customerType` via the Reseller API, but a "team" customer can verify their domain and become `customerType = "domain". For more information, see update a customer's settings (/admin-sdk/reseller/v1/how-tos/manage_customers#update_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.

type CustomersUpdateCall 

type CustomersUpdateCall struct {
	// contains filtered or unexported fields
}

func (*CustomersUpdateCall) Context 

func (c *CustomersUpdateCall) Context(ctx context.Context) *CustomersUpdateCall

Context sets the context to be used in this call's Do method.

func (*CustomersUpdateCall) Do 

func (c *CustomersUpdateCall) Do(opts ...googleapi.CallOption) (*Customer, error)

Do executes the "reseller.customers.update" 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 (*CustomersUpdateCall) Fields 

func (c *CustomersUpdateCall) Fields(s ...googleapi.Field) *CustomersUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CustomersUpdateCall) Header 

func (c *CustomersUpdateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type PrimaryAdmin added in v0.50.0 

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:"-"`
}

PrimaryAdmin: JSON template for primary admin in case of TEAM customers

func (PrimaryAdmin) MarshalJSON added in v0.50.0 

func (s PrimaryAdmin) MarshalJSON() ([]byte, error)

type RenewalSettings 

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:"-"`
}

RenewalSettings: JSON template for a subscription renewal settings.

func (RenewalSettings) MarshalJSON 

func (s RenewalSettings) MarshalJSON() ([]byte, error)

type ResellernotifyGetwatchdetailsCall 

type ResellernotifyGetwatchdetailsCall struct {
	// contains filtered or unexported fields
}

func (*ResellernotifyGetwatchdetailsCall) Context 

func (c *ResellernotifyGetwatchdetailsCall) Context(ctx context.Context) *ResellernotifyGetwatchdetailsCall

Context sets the context to be used in this call's Do method.

func (*ResellernotifyGetwatchdetailsCall) Do 

func (c *ResellernotifyGetwatchdetailsCall) Do(opts ...googleapi.CallOption) (*ResellernotifyGetwatchdetailsResponse, error)

Do executes the "reseller.resellernotify.getwatchdetails" call. Any non-2xx status code is an error. Response headers are in either *ResellernotifyGetwatchdetailsResponse.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 (*ResellernotifyGetwatchdetailsCall) Fields 

func (c *ResellernotifyGetwatchdetailsCall) Fields(s ...googleapi.Field) *ResellernotifyGetwatchdetailsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ResellernotifyGetwatchdetailsCall) Header 

func (c *ResellernotifyGetwatchdetailsCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ResellernotifyGetwatchdetailsCall) IfNoneMatch 

func (c *ResellernotifyGetwatchdetailsCall) IfNoneMatch(entityTag string) *ResellernotifyGetwatchdetailsCall

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.

type ResellernotifyGetwatchdetailsResponse 

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:"-"`
}

ResellernotifyGetwatchdetailsResponse: JSON template for resellernotify getwatchdetails response.

func (ResellernotifyGetwatchdetailsResponse) MarshalJSON 

func (s ResellernotifyGetwatchdetailsResponse) MarshalJSON() ([]byte, error)

type ResellernotifyRegisterCall 

type ResellernotifyRegisterCall struct {
	// contains filtered or unexported fields
}

func (*ResellernotifyRegisterCall) Context 

func (c *ResellernotifyRegisterCall) Context(ctx context.Context) *ResellernotifyRegisterCall

Context sets the context to be used in this call's Do method.

func (*ResellernotifyRegisterCall) Do 

func (c *ResellernotifyRegisterCall) Do(opts ...googleapi.CallOption) (*ResellernotifyResource, error)

Do executes the "reseller.resellernotify.register" call. Any non-2xx status code is an error. Response headers are in either *ResellernotifyResource.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 (*ResellernotifyRegisterCall) Fields 

func (c *ResellernotifyRegisterCall) Fields(s ...googleapi.Field) *ResellernotifyRegisterCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ResellernotifyRegisterCall) Header 

func (c *ResellernotifyRegisterCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ResellernotifyRegisterCall) ServiceAccountEmailAddress 

func (c *ResellernotifyRegisterCall) ServiceAccountEmailAddress(serviceAccountEmailAddress string) *ResellernotifyRegisterCall

ServiceAccountEmailAddress sets the optional parameter "serviceAccountEmailAddress": The service account which will own the created Cloud-PubSub topic.

type ResellernotifyResource 

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:"-"`
}

ResellernotifyResource: JSON template for resellernotify response.

func (ResellernotifyResource) MarshalJSON 

func (s ResellernotifyResource) MarshalJSON() ([]byte, error)

type ResellernotifyService 

type ResellernotifyService struct {
	// contains filtered or unexported fields
}

func NewResellernotifyService 

func NewResellernotifyService(s *Service) *ResellernotifyService

func (*ResellernotifyService) Getwatchdetails 

func (r *ResellernotifyService) Getwatchdetails() *ResellernotifyGetwatchdetailsCall

Getwatchdetails: Returns all the details of the watch corresponding to the reseller.

func (*ResellernotifyService) Register 

func (r *ResellernotifyService) Register() *ResellernotifyRegisterCall

Register: Registers a Reseller for receiving notifications.

func (*ResellernotifyService) Unregister 

func (r *ResellernotifyService) Unregister() *ResellernotifyUnregisterCall

Unregister: Unregisters a Reseller for receiving notifications.

type ResellernotifyUnregisterCall 

type ResellernotifyUnregisterCall struct {
	// contains filtered or unexported fields
}

func (*ResellernotifyUnregisterCall) Context 

func (c *ResellernotifyUnregisterCall) Context(ctx context.Context) *ResellernotifyUnregisterCall

Context sets the context to be used in this call's Do method.

func (*ResellernotifyUnregisterCall) Do 

func (c *ResellernotifyUnregisterCall) Do(opts ...googleapi.CallOption) (*ResellernotifyResource, error)

Do executes the "reseller.resellernotify.unregister" call. Any non-2xx status code is an error. Response headers are in either *ResellernotifyResource.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 (*ResellernotifyUnregisterCall) Fields 

func (c *ResellernotifyUnregisterCall) Fields(s ...googleapi.Field) *ResellernotifyUnregisterCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ResellernotifyUnregisterCall) Header 

func (c *ResellernotifyUnregisterCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ResellernotifyUnregisterCall) ServiceAccountEmailAddress 

func (c *ResellernotifyUnregisterCall) ServiceAccountEmailAddress(serviceAccountEmailAddress string) *ResellernotifyUnregisterCall

ServiceAccountEmailAddress sets the optional parameter "serviceAccountEmailAddress": The service account which owns the Cloud-PubSub topic.

type 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:"-"`
}

Seats: JSON template for subscription seats.

func (Seats) MarshalJSON 

func (s Seats) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Customers *CustomersService

	Resellernotify *ResellernotifyService

	Subscriptions *SubscriptionsService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

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 NewService added in v0.3.0 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type 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:"-"`
}

Subscription: JSON template for a subscription.

func (Subscription) MarshalJSON 

func (s Subscription) MarshalJSON() ([]byte, error)

type SubscriptionPlan 

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:"-"`
}

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.

func (SubscriptionPlan) MarshalJSON 

func (s SubscriptionPlan) MarshalJSON() ([]byte, error)

type SubscriptionPlanCommitmentInterval 

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:"-"`
}

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.

func (SubscriptionPlanCommitmentInterval) MarshalJSON 

func (s SubscriptionPlanCommitmentInterval) MarshalJSON() ([]byte, error)

type SubscriptionTransferInfo 

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:"-"`
}

SubscriptionTransferInfo: Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.

func (SubscriptionTransferInfo) MarshalJSON 

func (s SubscriptionTransferInfo) MarshalJSON() ([]byte, error)

type SubscriptionTrialSettings 

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:"-"`
}

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.

func (SubscriptionTrialSettings) MarshalJSON 

func (s SubscriptionTrialSettings) MarshalJSON() ([]byte, error)

type 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:"-"`
}

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.

func (Subscriptions) MarshalJSON 

func (s Subscriptions) MarshalJSON() ([]byte, error)

type SubscriptionsActivateCall 

type SubscriptionsActivateCall struct {
	// contains filtered or unexported fields
}

func (*SubscriptionsActivateCall) Context 

func (c *SubscriptionsActivateCall) Context(ctx context.Context) *SubscriptionsActivateCall

Context sets the context to be used in this call's Do method.

func (*SubscriptionsActivateCall) Do 

func (c *SubscriptionsActivateCall) Do(opts ...googleapi.CallOption) (*Subscription, error)

Do executes the "reseller.subscriptions.activate" call. Any non-2xx status code is an error. Response headers are in either *Subscription.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 (*SubscriptionsActivateCall) Fields 

func (c *SubscriptionsActivateCall) Fields(s ...googleapi.Field) *SubscriptionsActivateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SubscriptionsActivateCall) Header 

func (c *SubscriptionsActivateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type SubscriptionsChangePlanCall 

type SubscriptionsChangePlanCall struct {
	// contains filtered or unexported fields
}

func (*SubscriptionsChangePlanCall) Context 

func (c *SubscriptionsChangePlanCall) Context(ctx context.Context) *SubscriptionsChangePlanCall

Context sets the context to be used in this call's Do method.

func (*SubscriptionsChangePlanCall) Do 

func (c *SubscriptionsChangePlanCall) Do(opts ...googleapi.CallOption) (*Subscription, error)

Do executes the "reseller.subscriptions.changePlan" call. Any non-2xx status code is an error. Response headers are in either *Subscription.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 (*SubscriptionsChangePlanCall) Fields 

func (c *SubscriptionsChangePlanCall) Fields(s ...googleapi.Field) *SubscriptionsChangePlanCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SubscriptionsChangePlanCall) Header 

func (c *SubscriptionsChangePlanCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type SubscriptionsChangeRenewalSettingsCall 

type SubscriptionsChangeRenewalSettingsCall struct {
	// contains filtered or unexported fields
}

func (*SubscriptionsChangeRenewalSettingsCall) Context 

func (c *SubscriptionsChangeRenewalSettingsCall) Context(ctx context.Context) *SubscriptionsChangeRenewalSettingsCall

Context sets the context to be used in this call's Do method.

func (*SubscriptionsChangeRenewalSettingsCall) Do 

func (c *SubscriptionsChangeRenewalSettingsCall) Do(opts ...googleapi.CallOption) (*Subscription, error)

Do executes the "reseller.subscriptions.changeRenewalSettings" call. Any non-2xx status code is an error. Response headers are in either *Subscription.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 (*SubscriptionsChangeRenewalSettingsCall) Fields 

func (c *SubscriptionsChangeRenewalSettingsCall) Fields(s ...googleapi.Field) *SubscriptionsChangeRenewalSettingsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SubscriptionsChangeRenewalSettingsCall) Header 

func (c *SubscriptionsChangeRenewalSettingsCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type SubscriptionsChangeSeatsCall 

type SubscriptionsChangeSeatsCall struct {
	// contains filtered or unexported fields
}

func (*SubscriptionsChangeSeatsCall) Context 

func (c *SubscriptionsChangeSeatsCall) Context(ctx context.Context) *SubscriptionsChangeSeatsCall

Context sets the context to be used in this call's Do method.

func (*SubscriptionsChangeSeatsCall) Do 

func (c *SubscriptionsChangeSeatsCall) Do(opts ...googleapi.CallOption) (*Subscription, error)

Do executes the "reseller.subscriptions.changeSeats" call. Any non-2xx status code is an error. Response headers are in either *Subscription.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 (*SubscriptionsChangeSeatsCall) Fields 

func (c *SubscriptionsChangeSeatsCall) Fields(s ...googleapi.Field) *SubscriptionsChangeSeatsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SubscriptionsChangeSeatsCall) Header 

func (c *SubscriptionsChangeSeatsCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type SubscriptionsDeleteCall 

type SubscriptionsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*SubscriptionsDeleteCall) Context 

func (c *SubscriptionsDeleteCall) Context(ctx context.Context) *SubscriptionsDeleteCall

Context sets the context to be used in this call's Do method.

func (*SubscriptionsDeleteCall) Do 

func (c *SubscriptionsDeleteCall) Do(opts ...googleapi.CallOption) error

Do executes the "reseller.subscriptions.delete" call.

func (*SubscriptionsDeleteCall) Fields 

func (c *SubscriptionsDeleteCall) Fields(s ...googleapi.Field) *SubscriptionsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SubscriptionsDeleteCall) Header 

func (c *SubscriptionsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type SubscriptionsGetCall 

type SubscriptionsGetCall struct {
	// contains filtered or unexported fields
}

func (*SubscriptionsGetCall) Context 

func (c *SubscriptionsGetCall) Context(ctx context.Context) *SubscriptionsGetCall

Context sets the context to be used in this call's Do method.

func (*SubscriptionsGetCall) Do 

func (c *SubscriptionsGetCall) Do(opts ...googleapi.CallOption) (*Subscription, error)

Do executes the "reseller.subscriptions.get" call. Any non-2xx status code is an error. Response headers are in either *Subscription.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 (*SubscriptionsGetCall) Fields 

func (c *SubscriptionsGetCall) Fields(s ...googleapi.Field) *SubscriptionsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SubscriptionsGetCall) Header 

func (c *SubscriptionsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*SubscriptionsGetCall) IfNoneMatch 

func (c *SubscriptionsGetCall) IfNoneMatch(entityTag string) *SubscriptionsGetCall

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.

type SubscriptionsInsertCall 

type SubscriptionsInsertCall struct {
	// contains filtered or unexported fields
}

func (*SubscriptionsInsertCall) Action added in v0.128.0 

func (c *SubscriptionsInsertCall) Action(action string) *SubscriptionsInsertCall

Action sets the optional parameter "action": The intented insert action. The usage of this field is governed by certain policies which are being developed & tested currently. Hence, these might not work as intended. Once this is fully tested & available to consume, we will share more information about its usage, limitations and policy documentation.

Possible values: 

"actionUnspecified" - Auto determines whether to create new subscription,

upgrade or downagrade existing subscription or transfer the existing subscription 

"buy" - Create new subscription
"switch" - Switch existing subscription to another sku (upgrade/downgrade)

func (*SubscriptionsInsertCall) Context 

func (c *SubscriptionsInsertCall) Context(ctx context.Context) *SubscriptionsInsertCall

Context sets the context to be used in this call's Do method.

func (*SubscriptionsInsertCall) CustomerAuthToken 

func (c *SubscriptionsInsertCall) CustomerAuthToken(customerAuthToken string) *SubscriptionsInsertCall

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 (*SubscriptionsInsertCall) Do 

func (c *SubscriptionsInsertCall) Do(opts ...googleapi.CallOption) (*Subscription, error)

Do executes the "reseller.subscriptions.insert" call. Any non-2xx status code is an error. Response headers are in either *Subscription.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 (*SubscriptionsInsertCall) Fields 

func (c *SubscriptionsInsertCall) Fields(s ...googleapi.Field) *SubscriptionsInsertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SubscriptionsInsertCall) Header 

func (c *SubscriptionsInsertCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*SubscriptionsInsertCall) SourceSkuId added in v0.128.0 

func (c *SubscriptionsInsertCall) SourceSkuId(sourceSkuId string) *SubscriptionsInsertCall

SourceSkuId sets the optional parameter "sourceSkuId": The sku_id of the existing subscription to be upgraded or downgraded. This is required when action is SWITCH. The usage of this field is governed by certain policies which are being developed & tested currently. Hence, these might not work as intended. Once this is fully tested & available to consume, we will share more information about its usage, limitations and policy documentation.

type SubscriptionsListCall 

type SubscriptionsListCall struct {
	// contains filtered or unexported fields
}

func (*SubscriptionsListCall) Context 

func (c *SubscriptionsListCall) Context(ctx context.Context) *SubscriptionsListCall

Context sets the context to be used in this call's Do method.

func (*SubscriptionsListCall) CustomerAuthToken 

func (c *SubscriptionsListCall) CustomerAuthToken(customerAuthToken string) *SubscriptionsListCall

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 (*SubscriptionsListCall) CustomerId 

func (c *SubscriptionsListCall) CustomerId(customerId string) *SubscriptionsListCall

CustomerId sets the optional parameter "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 (*SubscriptionsListCall) CustomerNamePrefix 

func (c *SubscriptionsListCall) CustomerNamePrefix(customerNamePrefix string) *SubscriptionsListCall

CustomerNamePrefix sets the optional parameter "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`.

func (*SubscriptionsListCall) Do 

func (c *SubscriptionsListCall) Do(opts ...googleapi.CallOption) (*Subscriptions, error)

Do executes the "reseller.subscriptions.list" call. Any non-2xx status code is an error. Response headers are in either *Subscriptions.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 (*SubscriptionsListCall) Fields 

func (c *SubscriptionsListCall) Fields(s ...googleapi.Field) *SubscriptionsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SubscriptionsListCall) Header 

func (c *SubscriptionsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*SubscriptionsListCall) IfNoneMatch 

func (c *SubscriptionsListCall) IfNoneMatch(entityTag string) *SubscriptionsListCall

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 (*SubscriptionsListCall) MaxResults 

func (c *SubscriptionsListCall) MaxResults(maxResults int64) *SubscriptionsListCall

MaxResults sets the optional parameter "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.

func (*SubscriptionsListCall) PageToken 

func (c *SubscriptionsListCall) PageToken(pageToken string) *SubscriptionsListCall

PageToken sets the optional parameter "pageToken": Token to specify next page in the list

func (*SubscriptionsListCall) Pages 

func (c *SubscriptionsListCall) Pages(ctx context.Context, f func(*Subscriptions) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type SubscriptionsService 

type SubscriptionsService struct {
	// contains filtered or unexported fields
}

func NewSubscriptionsService 

func NewSubscriptionsService(s *Service) *SubscriptionsService

func (*SubscriptionsService) Activate 

func (r *SubscriptionsService) Activate(customerId string, subscriptionId string) *SubscriptionsActivateCall

Activate: Activates a subscription previously suspended by the reseller. If you did not suspend the customer subscription and it is suspended for any other reason, such as for abuse or a pending ToS acceptance, this call will not reactivate the customer subscription.

  • 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.
  • 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.

func (*SubscriptionsService) ChangePlan 

func (r *SubscriptionsService) ChangePlan(customerId string, subscriptionId string, changeplanrequest *ChangePlanRequest) *SubscriptionsChangePlanCall

ChangePlan: Updates 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. How a plan is updated differs depending on the plan and the products. For more information, see the description in manage subscriptions (/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_subscription_plan ).

  • 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.
  • 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.

func (*SubscriptionsService) ChangeRenewalSettings 

func (r *SubscriptionsService) ChangeRenewalSettings(customerId string, subscriptionId string, renewalsettings *RenewalSettings) *SubscriptionsChangeRenewalSettingsCall

ChangeRenewalSettings: Updates a user license's renewal settings. This is applicable for accounts with annual commitment plans only. For more information, see the description in manage subscriptions (/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_renewal).

  • 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.
  • 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.

func (*SubscriptionsService) ChangeSeats 

func (r *SubscriptionsService) ChangeSeats(customerId string, subscriptionId string, seats *Seats) *SubscriptionsChangeSeatsCall

ChangeSeats: Updates a subscription's user license settings. For more information about updating an annual commitment plan or a flexible plan subscription’s licenses, see Manage Subscriptions (/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_subscription_seat ).

  • 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.
  • 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.

func (*SubscriptionsService) Delete 

func (r *SubscriptionsService) Delete(customerId string, subscriptionId string, deletionType string) *SubscriptionsDeleteCall

Delete: Cancels, suspends, or transfers a subscription to direct.

  • 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.
  • deletionType: The `deletionType` query string enables the cancellation, downgrade, or suspension of a subscription.
  • 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.

func (*SubscriptionsService) Get 

func (r *SubscriptionsService) Get(customerId string, subscriptionId string) *SubscriptionsGetCall

Get: Gets a specific subscription. The `subscriptionId` can be found using the Retrieve all reseller subscriptions (/admin-sdk/reseller/v1/how-tos/manage_subscriptions#get_all_subscriptions) method. For more information about retrieving a specific subscription, see the information descrived in manage subscriptions (/admin-sdk/reseller/v1/how-tos/manage_subscriptions#get_subscription).

  • 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.
  • 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.

func (*SubscriptionsService) Insert 

func (r *SubscriptionsService) Insert(customerId string, subscription *Subscription) *SubscriptionsInsertCall

Insert: Creates or transfer a subscription. Create a subscription for a customer's account that you ordered using the Order a new customer account (/admin-sdk/reseller/v1/reference/customers/insert.html) method. For more information about creating a subscription for different payment plans, see manage subscriptions (/admin-sdk/reseller/v1/how-tos/manage_subscriptions#create_subscription).\ If you did not order the customer's account using the customer insert method, use the customer's `customerAuthToken` when creating a subscription for that customer. If transferring a G Suite subscription with an associated Google Drive or Google Vault subscription, use the batch operation (/admin-sdk/reseller/v1/how-tos/batch.html) to transfer all of these subscriptions. For more information, see how to transfer subscriptions (/admin-sdk/reseller/v1/how-tos/manage_subscriptions#transfer_a_subscription) .

  • 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 (*SubscriptionsService) List 

func (r *SubscriptionsService) List() *SubscriptionsListCall

List: Lists 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. Optionally, this method can filter the response by a `customerNamePrefix`. For more information, see manage subscriptions (/admin-sdk/reseller/v1/how-tos/manage_subscriptions).

func (*SubscriptionsService) StartPaidService 

func (r *SubscriptionsService) StartPaidService(customerId string, subscriptionId string) *SubscriptionsStartPaidServiceCall

StartPaidService: Immediately move a 30-day free trial subscription to a paid service subscription. This method is only applicable if a payment plan has already been set up for the 30-day trial subscription. For more information, see manage subscriptions (/admin-sdk/reseller/v1/how-tos/manage_subscriptions#paid_service).

  • 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.
  • 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.

func (*SubscriptionsService) Suspend 

func (r *SubscriptionsService) Suspend(customerId string, subscriptionId string) *SubscriptionsSuspendCall

Suspend: Suspends an active subscription. You can use this method to suspend a paid subscription that is currently in the `ACTIVE` state. * For `FLEXIBLE` subscriptions, billing is paused. * For `ANNUAL_MONTHLY_PAY` or `ANNUAL_YEARLY_PAY` subscriptions: * Suspending the subscription does not change the renewal date that was originally committed to. * A suspended subscription does not renew. If you activate the subscription after the original renewal date, a new annual subscription will be created, starting on the day of activation. We strongly encourage you to suspend subscriptions only for short periods of time as suspensions over 60 days may result in the subscription being cancelled.

  • 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.
  • 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.

type SubscriptionsStartPaidServiceCall 

type SubscriptionsStartPaidServiceCall struct {
	// contains filtered or unexported fields
}

func (*SubscriptionsStartPaidServiceCall) Context 

func (c *SubscriptionsStartPaidServiceCall) Context(ctx context.Context) *SubscriptionsStartPaidServiceCall

Context sets the context to be used in this call's Do method.

func (*SubscriptionsStartPaidServiceCall) Do 

func (c *SubscriptionsStartPaidServiceCall) Do(opts ...googleapi.CallOption) (*Subscription, error)

Do executes the "reseller.subscriptions.startPaidService" call. Any non-2xx status code is an error. Response headers are in either *Subscription.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 (*SubscriptionsStartPaidServiceCall) Fields 

func (c *SubscriptionsStartPaidServiceCall) Fields(s ...googleapi.Field) *SubscriptionsStartPaidServiceCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SubscriptionsStartPaidServiceCall) Header 

func (c *SubscriptionsStartPaidServiceCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type SubscriptionsSuspendCall 

type SubscriptionsSuspendCall struct {
	// contains filtered or unexported fields
}

func (*SubscriptionsSuspendCall) Context 

func (c *SubscriptionsSuspendCall) Context(ctx context.Context) *SubscriptionsSuspendCall

Context sets the context to be used in this call's Do method.

func (*SubscriptionsSuspendCall) Do 

func (c *SubscriptionsSuspendCall) Do(opts ...googleapi.CallOption) (*Subscription, error)

Do executes the "reseller.subscriptions.suspend" call. Any non-2xx status code is an error. Response headers are in either *Subscription.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 (*SubscriptionsSuspendCall) Fields 

func (c *SubscriptionsSuspendCall) Fields(s ...googleapi.Field) *SubscriptionsSuspendCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SubscriptionsSuspendCall) Header 

func (c *SubscriptionsSuspendCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.