Documentation ¶
Overview ¶
Package reseller provides access to the Enterprise Apps Reseller API.
See https://developers.google.com/google-apps/reseller/
Usage example:
import "google.golang.org/api/reseller/v1" ... resellerService, err := reseller.New(oauthHttpClient)
Index ¶
- Constants
- type Address
- type ChangePlanRequest
- type Customer
- type CustomersGetCall
- func (c *CustomersGetCall) Context(ctx context.Context) *CustomersGetCall
- func (c *CustomersGetCall) Do(opts ...googleapi.CallOption) (*Customer, error)
- func (c *CustomersGetCall) Fields(s ...googleapi.Field) *CustomersGetCall
- func (c *CustomersGetCall) IfNoneMatch(entityTag string) *CustomersGetCall
- type CustomersInsertCall
- func (c *CustomersInsertCall) Context(ctx context.Context) *CustomersInsertCall
- func (c *CustomersInsertCall) CustomerAuthToken(customerAuthToken string) *CustomersInsertCall
- func (c *CustomersInsertCall) Do(opts ...googleapi.CallOption) (*Customer, error)
- func (c *CustomersInsertCall) Fields(s ...googleapi.Field) *CustomersInsertCall
- type CustomersPatchCall
- type CustomersService
- func (r *CustomersService) Get(customerId string) *CustomersGetCall
- func (r *CustomersService) Insert(customer *Customer) *CustomersInsertCall
- func (r *CustomersService) Patch(customerId string, customer *Customer) *CustomersPatchCall
- func (r *CustomersService) Update(customerId string, customer *Customer) *CustomersUpdateCall
- type CustomersUpdateCall
- type RenewalSettings
- type Seats
- type Service
- type Subscription
- type SubscriptionPlan
- type SubscriptionPlanCommitmentInterval
- type SubscriptionTransferInfo
- type SubscriptionTrialSettings
- type Subscriptions
- type SubscriptionsActivateCall
- type SubscriptionsChangePlanCall
- type SubscriptionsChangeRenewalSettingsCall
- func (c *SubscriptionsChangeRenewalSettingsCall) Context(ctx context.Context) *SubscriptionsChangeRenewalSettingsCall
- func (c *SubscriptionsChangeRenewalSettingsCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
- func (c *SubscriptionsChangeRenewalSettingsCall) Fields(s ...googleapi.Field) *SubscriptionsChangeRenewalSettingsCall
- type SubscriptionsChangeSeatsCall
- type SubscriptionsDeleteCall
- type SubscriptionsGetCall
- func (c *SubscriptionsGetCall) Context(ctx context.Context) *SubscriptionsGetCall
- func (c *SubscriptionsGetCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
- func (c *SubscriptionsGetCall) Fields(s ...googleapi.Field) *SubscriptionsGetCall
- func (c *SubscriptionsGetCall) IfNoneMatch(entityTag string) *SubscriptionsGetCall
- type SubscriptionsInsertCall
- func (c *SubscriptionsInsertCall) Context(ctx context.Context) *SubscriptionsInsertCall
- func (c *SubscriptionsInsertCall) CustomerAuthToken(customerAuthToken string) *SubscriptionsInsertCall
- func (c *SubscriptionsInsertCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
- func (c *SubscriptionsInsertCall) Fields(s ...googleapi.Field) *SubscriptionsInsertCall
- type SubscriptionsListCall
- func (c *SubscriptionsListCall) Context(ctx context.Context) *SubscriptionsListCall
- func (c *SubscriptionsListCall) CustomerAuthToken(customerAuthToken string) *SubscriptionsListCall
- func (c *SubscriptionsListCall) CustomerId(customerId string) *SubscriptionsListCall
- func (c *SubscriptionsListCall) CustomerNamePrefix(customerNamePrefix string) *SubscriptionsListCall
- func (c *SubscriptionsListCall) Do(opts ...googleapi.CallOption) (*Subscriptions, error)
- func (c *SubscriptionsListCall) Fields(s ...googleapi.Field) *SubscriptionsListCall
- func (c *SubscriptionsListCall) IfNoneMatch(entityTag string) *SubscriptionsListCall
- func (c *SubscriptionsListCall) MaxResults(maxResults int64) *SubscriptionsListCall
- func (c *SubscriptionsListCall) PageToken(pageToken string) *SubscriptionsListCall
- func (c *SubscriptionsListCall) Pages(ctx context.Context, f func(*Subscriptions) error) error
- type SubscriptionsService
- func (r *SubscriptionsService) Activate(customerId string, subscriptionId string) *SubscriptionsActivateCall
- func (r *SubscriptionsService) ChangePlan(customerId string, subscriptionId string, changeplanrequest *ChangePlanRequest) *SubscriptionsChangePlanCall
- func (r *SubscriptionsService) ChangeRenewalSettings(customerId string, subscriptionId string, renewalsettings *RenewalSettings) *SubscriptionsChangeRenewalSettingsCall
- func (r *SubscriptionsService) ChangeSeats(customerId string, subscriptionId string, seats *Seats) *SubscriptionsChangeSeatsCall
- func (r *SubscriptionsService) Delete(customerId string, subscriptionId string, deletionType string) *SubscriptionsDeleteCall
- func (r *SubscriptionsService) Get(customerId string, subscriptionId string) *SubscriptionsGetCall
- func (r *SubscriptionsService) Insert(customerId string, subscription *Subscription) *SubscriptionsInsertCall
- func (r *SubscriptionsService) List() *SubscriptionsListCall
- func (r *SubscriptionsService) StartPaidService(customerId string, subscriptionId string) *SubscriptionsStartPaidServiceCall
- func (r *SubscriptionsService) Suspend(customerId string, subscriptionId string) *SubscriptionsSuspendCall
- type SubscriptionsStartPaidServiceCall
- func (c *SubscriptionsStartPaidServiceCall) Context(ctx context.Context) *SubscriptionsStartPaidServiceCall
- func (c *SubscriptionsStartPaidServiceCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
- func (c *SubscriptionsStartPaidServiceCall) Fields(s ...googleapi.Field) *SubscriptionsStartPaidServiceCall
- type SubscriptionsSuspendCall
Constants ¶
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: Address line 1 of the address. AddressLine1 string `json:"addressLine1,omitempty"` // AddressLine2: Address line 2 of the address. AddressLine2 string `json:"addressLine2,omitempty"` // AddressLine3: Address line 3 of the address. AddressLine3 string `json:"addressLine3,omitempty"` // ContactName: Name of the contact person. ContactName string `json:"contactName,omitempty"` // CountryCode: ISO 3166 country code. CountryCode string `json:"countryCode,omitempty"` // Kind: Identifies the resource as a customer address. Kind string `json:"kind,omitempty"` // Locality: Name of the locality. This is in accordance with - // http://portablecontacts.net/draft-spec.html#address_element. Locality string `json:"locality,omitempty"` // OrganizationName: Name of the organization. OrganizationName string `json:"organizationName,omitempty"` // PostalCode: The postal code. This is in accordance with - // http://portablecontacts.net/draft-spec.html#address_element. PostalCode string `json:"postalCode,omitempty"` // Region: Name of the region. This is in accordance with - // http://portablecontacts.net/draft-spec.html#address_element. 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Address: JSON template for address of a customer.
func (*Address) MarshalJSON ¶
type ChangePlanRequest ¶
type ChangePlanRequest struct { // Kind: Identifies the resource as a subscription change plan request. Kind string `json:"kind,omitempty"` // PlanName: Name of the plan to change to. PlanName string `json:"planName,omitempty"` // PurchaseOrderId: Purchase order id for your order tracking purposes. PurchaseOrderId string `json:"purchaseOrderId,omitempty"` // Seats: Number/Limit of seats in the new plan. Seats *Seats `json:"seats,omitempty"` // ForceSendFields is a list of field names (e.g. "Kind") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []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: The alternate email of the customer. AlternateEmail string `json:"alternateEmail,omitempty"` // CustomerDomain: The domain name of the customer. CustomerDomain string `json:"customerDomain,omitempty"` // CustomerDomainVerified: Whether the customer's primary domain has // been verified. CustomerDomainVerified bool `json:"customerDomainVerified,omitempty"` // CustomerId: The id of the customer. CustomerId string `json:"customerId,omitempty"` // Kind: Identifies the resource as a customer. Kind string `json:"kind,omitempty"` // PhoneNumber: The phone number of the customer. PhoneNumber string `json:"phoneNumber,omitempty"` // PostalAddress: The postal address of the customer. PostalAddress *Address `json:"postalAddress,omitempty"` // ResourceUiUrl: Ui url for customer resource. 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Customer: JSON template for a customer.
func (*Customer) MarshalJSON ¶
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*CustomersGetCall) Do ¶
func (c *CustomersGetCall) Do(opts ...googleapi.CallOption) (*Customer, error)
Do executes the "reseller.customers.get" call. Exactly one of *Customer or error will be non-nil. 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 information.
func (*CustomersGetCall) IfNoneMatch ¶
func (c *CustomersGetCall) IfNoneMatch(entityTag string) *CustomersGetCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*CustomersInsertCall) CustomerAuthToken ¶
func (c *CustomersInsertCall) CustomerAuthToken(customerAuthToken string) *CustomersInsertCall
CustomerAuthToken sets the optional parameter "customerAuthToken": An auth token needed for inserting a customer for which domain already exists. Can be generated at https://admin.google.com/TransferToken.
func (*CustomersInsertCall) Do ¶
func (c *CustomersInsertCall) Do(opts ...googleapi.CallOption) (*Customer, error)
Do executes the "reseller.customers.insert" call. Exactly one of *Customer or error will be non-nil. 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 information.
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*CustomersPatchCall) Do ¶
func (c *CustomersPatchCall) Do(opts ...googleapi.CallOption) (*Customer, error)
Do executes the "reseller.customers.patch" call. Exactly one of *Customer or error will be non-nil. 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 information.
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 resource if one exists and is owned by the reseller.
func (*CustomersService) Insert ¶
func (r *CustomersService) Insert(customer *Customer) *CustomersInsertCall
Insert: Creates a customer resource if one does not already exist.
func (*CustomersService) Patch ¶
func (r *CustomersService) Patch(customerId string, customer *Customer) *CustomersPatchCall
Patch: Update a customer resource if one it exists and is owned by the reseller. This method supports patch semantics.
func (*CustomersService) Update ¶
func (r *CustomersService) Update(customerId string, customer *Customer) *CustomersUpdateCall
Update: Update a customer resource if one it exists and is owned by the reseller.
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*CustomersUpdateCall) Do ¶
func (c *CustomersUpdateCall) Do(opts ...googleapi.CallOption) (*Customer, error)
Do executes the "reseller.customers.update" call. Exactly one of *Customer or error will be non-nil. 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 information.
type RenewalSettings ¶
type RenewalSettings struct { // Kind: Identifies the resource as a subscription renewal setting. Kind string `json:"kind,omitempty"` // RenewalType: Subscription renewal type. 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
RenewalSettings: JSON template for a subscription renewal settings.
func (*RenewalSettings) MarshalJSON ¶
func (s *RenewalSettings) MarshalJSON() ([]byte, error)
type Seats ¶
type Seats struct { // Kind: Identifies the resource as a subscription change plan request. Kind string `json:"kind,omitempty"` // LicensedNumberOfSeats: Read-only field containing the current number // of licensed seats for FLEXIBLE Google-Apps subscriptions and // secondary subscriptions such as Google-Vault and Drive-storage. LicensedNumberOfSeats int64 `json:"licensedNumberOfSeats,omitempty"` // MaximumNumberOfSeats: Maximum number of seats that can be purchased. // This needs to be provided only for a non-commitment plan. For a // commitment plan it is decided by the contract. MaximumNumberOfSeats int64 `json:"maximumNumberOfSeats,omitempty"` // NumberOfSeats: Number of seats to purchase. This is applicable only // for a commitment plan. 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Seats: JSON template for subscription seats.
func (*Seats) MarshalJSON ¶
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Customers *CustomersService Subscriptions *SubscriptionsService // contains filtered or unexported fields }
type Subscription ¶
type Subscription struct { // BillingMethod: Billing method of this subscription. BillingMethod string `json:"billingMethod,omitempty"` // CreationTime: Creation time of this subscription in milliseconds // since Unix epoch. CreationTime int64 `json:"creationTime,omitempty,string"` // CustomerId: The id of the customer to whom the subscription belongs. CustomerId string `json:"customerId,omitempty"` // Kind: Identifies the resource as a Subscription. Kind string `json:"kind,omitempty"` // Plan: Plan details of the subscription Plan *SubscriptionPlan `json:"plan,omitempty"` // PurchaseOrderId: Purchase order id for your order tracking purposes. PurchaseOrderId string `json:"purchaseOrderId,omitempty"` // RenewalSettings: Renewal settings of the subscription. RenewalSettings *RenewalSettings `json:"renewalSettings,omitempty"` // ResourceUiUrl: Ui url for subscription resource. ResourceUiUrl string `json:"resourceUiUrl,omitempty"` // Seats: Number/Limit of seats in the new plan. Seats *Seats `json:"seats,omitempty"` // SkuId: Name of the sku for which this subscription is purchased. SkuId string `json:"skuId,omitempty"` // Status: Status of the subscription. Status string `json:"status,omitempty"` // SubscriptionId: The id of the subscription. SubscriptionId string `json:"subscriptionId,omitempty"` // SuspensionReasons: field listing all current reasons the subscription // is suspended. It is possible for a subscription to have multiple // 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 Google Apps 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: Transfer related information for the subscription. TransferInfo *SubscriptionTransferInfo `json:"transferInfo,omitempty"` // TrialSettings: Trial Settings of the subscription. 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Subscription: JSON template for a subscription.
func (*Subscription) MarshalJSON ¶
func (s *Subscription) MarshalJSON() ([]byte, error)
type SubscriptionPlan ¶
type SubscriptionPlan struct { // CommitmentInterval: Interval of the commitment if it is a commitment // plan. CommitmentInterval *SubscriptionPlanCommitmentInterval `json:"commitmentInterval,omitempty"` // IsCommitmentPlan: Whether the plan is a commitment plan or not. IsCommitmentPlan bool `json:"isCommitmentPlan,omitempty"` // PlanName: The plan name of this subscription's plan. 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SubscriptionPlan: Plan details of the subscription
func (*SubscriptionPlan) MarshalJSON ¶
func (s *SubscriptionPlan) MarshalJSON() ([]byte, error)
type SubscriptionPlanCommitmentInterval ¶
type SubscriptionPlanCommitmentInterval struct { // EndTime: End time of the commitment interval in milliseconds since // Unix epoch. EndTime int64 `json:"endTime,omitempty,string"` // StartTime: Start time of the commitment interval in milliseconds // since Unix epoch. 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SubscriptionPlanCommitmentInterval: Interval of the commitment if it is a commitment plan.
func (*SubscriptionPlanCommitmentInterval) MarshalJSON ¶
func (s *SubscriptionPlanCommitmentInterval) MarshalJSON() ([]byte, error)
type SubscriptionTransferInfo ¶
type SubscriptionTransferInfo struct { MinimumTransferableSeats int64 `json:"minimumTransferableSeats,omitempty"` // TransferabilityExpirationTime: Time when transfer token or intent to // transfer will expire. TransferabilityExpirationTime int64 `json:"transferabilityExpirationTime,omitempty,string"` // ForceSendFields is a list of field names (e.g. // "MinimumTransferableSeats") to unconditionally include in API // requests. By default, fields with empty values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` }
SubscriptionTransferInfo: Transfer related information for the subscription.
func (*SubscriptionTransferInfo) MarshalJSON ¶
func (s *SubscriptionTransferInfo) MarshalJSON() ([]byte, error)
type SubscriptionTrialSettings ¶
type SubscriptionTrialSettings struct { // IsInTrial: Whether the subscription is in trial. IsInTrial bool `json:"isInTrial,omitempty"` // TrialEndTime: End time of the trial in milliseconds since Unix epoch. 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SubscriptionTrialSettings: Trial Settings of the subscription.
func (*SubscriptionTrialSettings) MarshalJSON ¶
func (s *SubscriptionTrialSettings) MarshalJSON() ([]byte, error)
type Subscriptions ¶
type Subscriptions struct { // Kind: Identifies the resource as a collection of 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Subscriptions: JSON template for a subscription list.
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*SubscriptionsActivateCall) Do ¶
func (c *SubscriptionsActivateCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
Do executes the "reseller.subscriptions.activate" call. Exactly one of *Subscription or error will be non-nil. 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 information.
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*SubscriptionsChangePlanCall) Do ¶
func (c *SubscriptionsChangePlanCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
Do executes the "reseller.subscriptions.changePlan" call. Exactly one of *Subscription or error will be non-nil. 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 information.
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*SubscriptionsChangeRenewalSettingsCall) Do ¶
func (c *SubscriptionsChangeRenewalSettingsCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
Do executes the "reseller.subscriptions.changeRenewalSettings" call. Exactly one of *Subscription or error will be non-nil. 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 information.
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*SubscriptionsChangeSeatsCall) Do ¶
func (c *SubscriptionsChangeSeatsCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
Do executes the "reseller.subscriptions.changeSeats" call. Exactly one of *Subscription or error will be non-nil. 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 information.
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. Any pending HTTP request will be aborted if the provided context is canceled.
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 information.
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*SubscriptionsGetCall) Do ¶
func (c *SubscriptionsGetCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
Do executes the "reseller.subscriptions.get" call. Exactly one of *Subscription or error will be non-nil. 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 information.
func (*SubscriptionsGetCall) IfNoneMatch ¶
func (c *SubscriptionsGetCall) IfNoneMatch(entityTag string) *SubscriptionsGetCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type SubscriptionsInsertCall ¶
type SubscriptionsInsertCall struct {
// contains filtered or unexported fields
}
func (*SubscriptionsInsertCall) Context ¶
func (c *SubscriptionsInsertCall) Context(ctx context.Context) *SubscriptionsInsertCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*SubscriptionsInsertCall) CustomerAuthToken ¶
func (c *SubscriptionsInsertCall) CustomerAuthToken(customerAuthToken string) *SubscriptionsInsertCall
CustomerAuthToken sets the optional parameter "customerAuthToken": An auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken.
func (*SubscriptionsInsertCall) Do ¶
func (c *SubscriptionsInsertCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
Do executes the "reseller.subscriptions.insert" call. Exactly one of *Subscription or error will be non-nil. 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 information.
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*SubscriptionsListCall) CustomerAuthToken ¶
func (c *SubscriptionsListCall) CustomerAuthToken(customerAuthToken string) *SubscriptionsListCall
CustomerAuthToken sets the optional parameter "customerAuthToken": An auth token needed if the customer is not a resold customer of this reseller. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken.
func (*SubscriptionsListCall) CustomerId ¶
func (c *SubscriptionsListCall) CustomerId(customerId string) *SubscriptionsListCall
CustomerId sets the optional parameter "customerId": Id of the Customer
func (*SubscriptionsListCall) CustomerNamePrefix ¶
func (c *SubscriptionsListCall) CustomerNamePrefix(customerNamePrefix string) *SubscriptionsListCall
CustomerNamePrefix sets the optional parameter "customerNamePrefix": Prefix of the customer's domain name by which the subscriptions should be filtered. Optional
func (*SubscriptionsListCall) Do ¶
func (c *SubscriptionsListCall) Do(opts ...googleapi.CallOption) (*Subscriptions, error)
Do executes the "reseller.subscriptions.list" call. Exactly one of *Subscriptions or error will be non-nil. 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 information.
func (*SubscriptionsListCall) IfNoneMatch ¶
func (c *SubscriptionsListCall) IfNoneMatch(entityTag string) *SubscriptionsListCall
IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*SubscriptionsListCall) MaxResults ¶
func (c *SubscriptionsListCall) MaxResults(maxResults int64) *SubscriptionsListCall
MaxResults sets the optional parameter "maxResults": Maximum number of results to return
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
func (*SubscriptionsService) ChangePlan ¶
func (r *SubscriptionsService) ChangePlan(customerId string, subscriptionId string, changeplanrequest *ChangePlanRequest) *SubscriptionsChangePlanCall
ChangePlan: Changes the plan of a subscription
func (*SubscriptionsService) ChangeRenewalSettings ¶
func (r *SubscriptionsService) ChangeRenewalSettings(customerId string, subscriptionId string, renewalsettings *RenewalSettings) *SubscriptionsChangeRenewalSettingsCall
ChangeRenewalSettings: Changes the renewal settings of a subscription
func (*SubscriptionsService) ChangeSeats ¶
func (r *SubscriptionsService) ChangeSeats(customerId string, subscriptionId string, seats *Seats) *SubscriptionsChangeSeatsCall
ChangeSeats: Changes the seats configuration of a subscription
func (*SubscriptionsService) Delete ¶
func (r *SubscriptionsService) Delete(customerId string, subscriptionId string, deletionType string) *SubscriptionsDeleteCall
Delete: Cancels/Downgrades a subscription.
func (*SubscriptionsService) Get ¶
func (r *SubscriptionsService) Get(customerId string, subscriptionId string) *SubscriptionsGetCall
Get: Gets a subscription of the customer.
func (*SubscriptionsService) Insert ¶
func (r *SubscriptionsService) Insert(customerId string, subscription *Subscription) *SubscriptionsInsertCall
Insert: Creates/Transfers a subscription for the customer.
func (*SubscriptionsService) List ¶
func (r *SubscriptionsService) List() *SubscriptionsListCall
List: Lists subscriptions of a reseller, optionally filtered by a customer name prefix.
func (*SubscriptionsService) StartPaidService ¶
func (r *SubscriptionsService) StartPaidService(customerId string, subscriptionId string) *SubscriptionsStartPaidServiceCall
StartPaidService: Starts paid service of a trial subscription
func (*SubscriptionsService) Suspend ¶
func (r *SubscriptionsService) Suspend(customerId string, subscriptionId string) *SubscriptionsSuspendCall
Suspend: Suspends an active subscription
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*SubscriptionsStartPaidServiceCall) Do ¶
func (c *SubscriptionsStartPaidServiceCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
Do executes the "reseller.subscriptions.startPaidService" call. Exactly one of *Subscription or error will be non-nil. 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 information.
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*SubscriptionsSuspendCall) Do ¶
func (c *SubscriptionsSuspendCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
Do executes the "reseller.subscriptions.suspend" call. Exactly one of *Subscription or error will be non-nil. 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 information.