googleapis
Version:
Google APIs Client Library for Node.js
1,243 lines (1,242 loc) • 274 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace cloudchannel_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Channel API
*
*
*
* @example
* ```js
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
* ```
*/
export class Cloudchannel {
context: APIRequestContext;
accounts: Resource$Accounts;
operations: Resource$Operations;
products: Resource$Products;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Request message for CloudChannelService.ActivateEntitlement.
*/
export interface Schema$GoogleCloudChannelV1ActivateEntitlementRequest {
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Information needed to create an Admin User for Google Workspace.
*/
export interface Schema$GoogleCloudChannelV1AdminUser {
/**
* Primary email of the admin user.
*/
email?: string | null;
/**
* Family name of the admin user.
*/
familyName?: string | null;
/**
* Given name of the admin user.
*/
givenName?: string | null;
}
/**
* Association links that an entitlement has to other entitlements.
*/
export interface Schema$GoogleCloudChannelV1alpha1AssociationInfo {
/**
* The name of the base entitlement, for which this entitlement is an add-on.
*/
baseEntitlement?: string | null;
}
/**
* Commitment settings for commitment-based offers.
*/
export interface Schema$GoogleCloudChannelV1alpha1CommitmentSettings {
/**
* Output only. Commitment end timestamp.
*/
endTime?: string | null;
/**
* Optional. Renewal settings applicable for a commitment-based Offer.
*/
renewalSettings?: Schema$GoogleCloudChannelV1alpha1RenewalSettings;
/**
* Output only. Commitment start timestamp.
*/
startTime?: string | null;
}
/**
* Represents Pub/Sub message content describing customer update.
*/
export interface Schema$GoogleCloudChannelV1alpha1CustomerEvent {
/**
* Resource name of the customer. Format: accounts/{account_id\}/customers/{customer_id\}
*/
customer?: string | null;
/**
* Type of event which happened on the customer.
*/
eventType?: string | null;
}
/**
* An entitlement is a representation of a customer's ability to use a service.
*/
export interface Schema$GoogleCloudChannelV1alpha1Entitlement {
/**
* The current number of users that are assigned a license for the product defined in provisioned_service.skuId. Read-only. Deprecated: Use `parameters` instead.
*/
assignedUnits?: number | null;
/**
* Association information to other entitlements.
*/
associationInfo?: Schema$GoogleCloudChannelV1alpha1AssociationInfo;
/**
* Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order. This field is generally used in 2-tier ordering, where the order is placed by a top-level distributor on behalf of their channel partner or reseller. Required for distributors. Deprecated: `channel_partner_id` has been moved to the Customer.
*/
channelPartnerId?: string | null;
/**
* Commitment settings for a commitment-based Offer. Required for commitment based offers.
*/
commitmentSettings?: Schema$GoogleCloudChannelV1alpha1CommitmentSettings;
/**
* Output only. The time at which the entitlement is created.
*/
createTime?: string | null;
/**
* Maximum number of units for a non commitment-based Offer, such as Flexible, Trial or Free entitlements. For commitment-based entitlements, this is a read-only field, which only the internal support team can update. Deprecated: Use `parameters` instead.
*/
maxUnits?: number | null;
/**
* Output only. Resource name of an entitlement in the form: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}.
*/
name?: string | null;
/**
* Number of units for a commitment-based Offer. For example, for seat-based Offers, this would be the number of seats; for license-based Offers, this would be the number of licenses. Required for creating commitment-based Offers. Deprecated: Use `parameters` instead.
*/
numUnits?: number | null;
/**
* Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id\}/offers/{offer_id\}.
*/
offer?: string | null;
/**
* Extended entitlement parameters. When creating an entitlement, valid parameters' names and values are defined in the offer's parameter definitions.
*/
parameters?: Schema$GoogleCloudChannelV1alpha1Parameter[];
/**
* Output only. Service provisioning details for the entitlement.
*/
provisionedService?: Schema$GoogleCloudChannelV1alpha1ProvisionedService;
/**
* Output only. Current provisioning state of the entitlement.
*/
provisioningState?: string | null;
/**
* Optional. 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 | null;
/**
* Output only. Enumerable of all current suspension reasons for an entitlement.
*/
suspensionReasons?: string[] | null;
/**
* Output only. Settings for trial offers.
*/
trialSettings?: Schema$GoogleCloudChannelV1alpha1TrialSettings;
/**
* Output only. The time at which the entitlement is updated.
*/
updateTime?: string | null;
}
/**
* Represents Pub/Sub message content describing entitlement update.
*/
export interface Schema$GoogleCloudChannelV1alpha1EntitlementEvent {
/**
* Resource name of an entitlement of the form: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
entitlement?: string | null;
/**
* Type of event which happened on the entitlement.
*/
eventType?: string | null;
}
/**
* Provides contextual information about a google.longrunning.Operation.
*/
export interface Schema$GoogleCloudChannelV1alpha1OperationMetadata {
/**
* The RPC that initiated this Long Running Operation.
*/
operationType?: string | null;
}
/**
* Definition for extended entitlement parameters.
*/
export interface Schema$GoogleCloudChannelV1alpha1Parameter {
/**
* Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active.
*/
editable?: boolean | null;
/**
* Name of the parameter.
*/
name?: string | null;
/**
* Value of the parameter.
*/
value?: Schema$GoogleCloudChannelV1alpha1Value;
}
/**
* Represents period in days/months/years.
*/
export interface Schema$GoogleCloudChannelV1alpha1Period {
/**
* Total duration of Period Type defined.
*/
duration?: number | null;
/**
* Period Type.
*/
periodType?: string | null;
}
/**
* Service provisioned for an entitlement.
*/
export interface Schema$GoogleCloudChannelV1alpha1ProvisionedService {
/**
* Output only. The product pertaining to the provisioning resource as specified in the Offer.
*/
productId?: string | null;
/**
* Output only. Provisioning ID of the entitlement. For Google Workspace, this would be the underlying Subscription ID.
*/
provisioningId?: string | null;
/**
* Output only. The SKU pertaining to the provisioning resource as specified in the Offer.
*/
skuId?: string | null;
}
/**
* Renewal settings for renewable Offers.
*/
export interface Schema$GoogleCloudChannelV1alpha1RenewalSettings {
/**
* If true, disables commitment-based offer on renewal and switches to flexible or pay as you go. Deprecated: Use `payment_plan` instead.
*/
disableCommitment?: boolean | null;
/**
* If false, the plan will be completed at the end date.
*/
enableRenewal?: boolean | null;
/**
* Describes how frequently the reseller will be billed, such as once per month.
*/
paymentCycle?: Schema$GoogleCloudChannelV1alpha1Period;
/**
* Set if enable_renewal=true. Deprecated: Use `payment_cycle` instead.
*/
paymentOption?: string | null;
/**
* Describes how a reseller will be billed.
*/
paymentPlan?: string | null;
/**
* If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.
*/
resizeUnitCount?: boolean | null;
}
/**
* Represents information which resellers will get as part of notification from Cloud Pub/Sub.
*/
export interface Schema$GoogleCloudChannelV1alpha1SubscriberEvent {
/**
* Customer event send as part of Pub/Sub event to partners.
*/
customerEvent?: Schema$GoogleCloudChannelV1alpha1CustomerEvent;
/**
* Entitlement event send as part of Pub/Sub event to partners.
*/
entitlementEvent?: Schema$GoogleCloudChannelV1alpha1EntitlementEvent;
}
/**
* Response message for CloudChannelService.TransferEntitlements. This is put in the response field of google.longrunning.Operation.
*/
export interface Schema$GoogleCloudChannelV1alpha1TransferEntitlementsResponse {
/**
* The transferred entitlements.
*/
entitlements?: Schema$GoogleCloudChannelV1alpha1Entitlement[];
}
/**
* Settings for trial offers.
*/
export interface Schema$GoogleCloudChannelV1alpha1TrialSettings {
/**
* Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example [Epoch converter](https://www.epochconverter.com).
*/
endTime?: string | null;
/**
* Determines if the entitlement is in a trial or not: * `true` - The entitlement is in trial. * `false` - The entitlement is not in trial.
*/
trial?: boolean | null;
}
/**
* Data type and value of a parameter.
*/
export interface Schema$GoogleCloudChannelV1alpha1Value {
/**
* Represents a boolean value.
*/
boolValue?: boolean | null;
/**
* Represents a double value.
*/
doubleValue?: number | null;
/**
* Represents an int64 value.
*/
int64Value?: string | null;
/**
* Represents an 'Any' proto value.
*/
protoValue?: {
[key: string]: any;
} | null;
/**
* Represents a string value.
*/
stringValue?: string | null;
}
/**
* Association links that an entitlement has to other entitlements.
*/
export interface Schema$GoogleCloudChannelV1AssociationInfo {
/**
* The name of the base entitlement, for which this entitlement is an add-on.
*/
baseEntitlement?: string | null;
}
/**
* Request message for CloudChannelService.CancelEntitlement.
*/
export interface Schema$GoogleCloudChannelV1CancelEntitlementRequest {
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Request message for CloudChannelService.ChangeOffer.
*/
export interface Schema$GoogleCloudChannelV1ChangeOfferRequest {
/**
* Required. New Offer. Format: accounts/{account_id\}/offers/{offer_id\}.
*/
offer?: string | null;
/**
* Optional. Parameters needed to purchase the Offer.
*/
parameters?: Schema$GoogleCloudChannelV1Parameter[];
/**
* Optional. Purchase order id provided by the reseller.
*/
purchaseOrderId?: string | null;
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Request message for CloudChannelService.ChangeParametersRequest.
*/
export interface Schema$GoogleCloudChannelV1ChangeParametersRequest {
/**
* Required. Entitlement parameters to update. You can only change editable parameters.
*/
parameters?: Schema$GoogleCloudChannelV1Parameter[];
/**
* Optional. Purchase order ID provided by the reseller.
*/
purchaseOrderId?: string | null;
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Request message for CloudChannelService.ChangeRenewalSettings.
*/
export interface Schema$GoogleCloudChannelV1ChangeRenewalSettingsRequest {
/**
* Required. New renewal settings.
*/
renewalSettings?: Schema$GoogleCloudChannelV1RenewalSettings;
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
*/
export interface Schema$GoogleCloudChannelV1ChannelPartnerLink {
/**
* Output only. Cloud Identity info of the channel partner (IR).
*/
channelPartnerCloudIdentityInfo?: Schema$GoogleCloudChannelV1CloudIdentityInfo;
/**
* Output only. Timestamp of when the channel partner link is created.
*/
createTime?: string | null;
/**
* Output only. URI of the web page where partner accepts the link invitation.
*/
inviteLinkUri?: string | null;
/**
* Required. State of the channel partner link.
*/
linkState?: string | null;
/**
* Output only. Resource name for the channel partner link, in the format accounts/{account_id\}/channelPartnerLinks/{id\}.
*/
name?: string | null;
/**
* Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
*/
publicId?: string | null;
/**
* Required. Cloud Identity ID of the linked reseller.
*/
resellerCloudIdentityId?: string | null;
/**
* Output only. Timestamp of when the channel partner link is updated.
*/
updateTime?: string | null;
}
/**
* Request message for CloudChannelService.CheckCloudIdentityAccountsExist.
*/
export interface Schema$GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest {
/**
* Required. Domain to fetch for Cloud Identity account customer.
*/
domain?: string | null;
}
/**
* Response message for CloudChannelService.CheckCloudIdentityAccountsExist.
*/
export interface Schema$GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse {
/**
* The Cloud Identity accounts associated with the domain.
*/
cloudIdentityAccounts?: Schema$GoogleCloudChannelV1CloudIdentityCustomerAccount[];
}
/**
* Entity representing a Cloud Identity account that may be associated with a Channel Services API partner.
*/
export interface Schema$GoogleCloudChannelV1CloudIdentityCustomerAccount {
/**
* If existing = true, the Cloud Identity ID of the customer.
*/
customerCloudIdentityId?: string | null;
/**
* If owned = true, the name of the customer that owns the Cloud Identity account. Customer_name uses the format: accounts/{account_id\}/customers/{customer_id\}
*/
customerName?: string | null;
/**
* Returns true if a Cloud Identity account exists for a specific domain.
*/
existing?: boolean | null;
/**
* Returns true if the Cloud Identity account is associated with a customer of the Channel Services partner.
*/
owned?: boolean | null;
}
/**
* Cloud Identity information for the Cloud Channel Customer.
*/
export interface Schema$GoogleCloudChannelV1CloudIdentityInfo {
/**
* Output only. URI of Customer's Admin console dashboard.
*/
adminConsoleUri?: string | null;
/**
* The alternate email.
*/
alternateEmail?: string | null;
/**
* CustomerType indicates verification type needed for using services.
*/
customerType?: string | null;
/**
* Edu information about the customer.
*/
eduData?: Schema$GoogleCloudChannelV1EduData;
/**
* Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
*/
isDomainVerified?: boolean | null;
/**
* Language code.
*/
languageCode?: string | null;
/**
* Phone number associated with the Cloud Identity.
*/
phoneNumber?: string | null;
/**
* Output only. The primary domain name.
*/
primaryDomain?: string | null;
}
/**
* Commitment settings for commitment-based offers.
*/
export interface Schema$GoogleCloudChannelV1CommitmentSettings {
/**
* Output only. Commitment end timestamp.
*/
endTime?: string | null;
/**
* Optional. Renewal settings applicable for a commitment-based Offer.
*/
renewalSettings?: Schema$GoogleCloudChannelV1RenewalSettings;
/**
* Output only. Commitment start timestamp.
*/
startTime?: string | null;
}
/**
* Represents the constraints for buying the Offer.
*/
export interface Schema$GoogleCloudChannelV1Constraints {
/**
* Represents constraints required to purchase the Offer for a customer.
*/
customerConstraints?: Schema$GoogleCloudChannelV1CustomerConstraints;
}
/**
* Contact information for a customer account.
*/
export interface Schema$GoogleCloudChannelV1ContactInfo {
/**
* Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name.
*/
displayName?: string | null;
/**
* Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account.
*/
email?: string | null;
/**
* First name of the contact in the customer account.
*/
firstName?: string | null;
/**
* Last name of the contact in the customer account.
*/
lastName?: string | null;
/**
* Phone number of the contact in the customer account.
*/
phone?: string | null;
/**
* Optional. Job title of the contact in the customer account.
*/
title?: string | null;
}
/**
* Request message for CloudChannelService.CreateEntitlement
*/
export interface Schema$GoogleCloudChannelV1CreateEntitlementRequest {
/**
* Required. The entitlement to create.
*/
entitlement?: Schema$GoogleCloudChannelV1Entitlement;
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Entity representing a customer of a reseller or distributor.
*/
export interface Schema$GoogleCloudChannelV1Customer {
/**
* Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email.
*/
alternateEmail?: string | null;
/**
* Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer.
*/
channelPartnerId?: string | null;
/**
* Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer.
*/
cloudIdentityId?: string | null;
/**
* Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer.
*/
cloudIdentityInfo?: Schema$GoogleCloudChannelV1CloudIdentityInfo;
/**
* Output only. The time at which the customer is created.
*/
createTime?: string | null;
/**
* Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain.
*/
domain?: string | null;
/**
* Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
*/
languageCode?: string | null;
/**
* Output only. Resource name of the customer. Format: accounts/{account_id\}/customers/{customer_id\}
*/
name?: string | null;
/**
* Required. Name of the organization that the customer entity represents.
*/
orgDisplayName?: string | null;
/**
* Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language.
*/
orgPostalAddress?: Schema$GoogleTypePostalAddress;
/**
* Primary contact info.
*/
primaryContactInfo?: Schema$GoogleCloudChannelV1ContactInfo;
/**
* Output only. The time at which the customer is updated.
*/
updateTime?: string | null;
}
/**
* Represents constraints required to purchase the Offer for a customer.
*/
export interface Schema$GoogleCloudChannelV1CustomerConstraints {
/**
* Allowed Customer Type.
*/
allowedCustomerTypes?: string[] | null;
/**
* Allowed geographical regions of the customer.
*/
allowedRegions?: string[] | null;
/**
* Allowed Promotional Order Type. Present for Promotional offers.
*/
promotionalOrderTypes?: string[] | null;
}
/**
* Represents Pub/Sub message content describing customer update.
*/
export interface Schema$GoogleCloudChannelV1CustomerEvent {
/**
* Resource name of the customer. Format: accounts/{account_id\}/customers/{customer_id\}
*/
customer?: string | null;
/**
* Type of event which happened on the customer.
*/
eventType?: string | null;
}
/**
* Required Edu Attributes
*/
export interface Schema$GoogleCloudChannelV1EduData {
/**
* Size of the institute.
*/
instituteSize?: string | null;
/**
* Designated institute type of customer.
*/
instituteType?: string | null;
/**
* Web address for the edu customer's institution.
*/
website?: string | null;
}
/**
* An entitlement is a representation of a customer's ability to use a service.
*/
export interface Schema$GoogleCloudChannelV1Entitlement {
/**
* Association information to other entitlements.
*/
associationInfo?: Schema$GoogleCloudChannelV1AssociationInfo;
/**
* Commitment settings for a commitment-based Offer. Required for commitment based offers.
*/
commitmentSettings?: Schema$GoogleCloudChannelV1CommitmentSettings;
/**
* Output only. The time at which the entitlement is created.
*/
createTime?: string | null;
/**
* Output only. Resource name of an entitlement in the form: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}.
*/
name?: string | null;
/**
* Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id\}/offers/{offer_id\}.
*/
offer?: string | null;
/**
* Extended entitlement parameters. When creating an entitlement, valid parameters' names and values are defined in the offer's parameter definitions.
*/
parameters?: Schema$GoogleCloudChannelV1Parameter[];
/**
* Output only. Service provisioning details for the entitlement.
*/
provisionedService?: Schema$GoogleCloudChannelV1ProvisionedService;
/**
* Output only. Current provisioning state of the entitlement.
*/
provisioningState?: string | null;
/**
* Optional. 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 | null;
/**
* Output only. Enumerable of all current suspension reasons for an entitlement.
*/
suspensionReasons?: string[] | null;
/**
* Output only. Settings for trial offers.
*/
trialSettings?: Schema$GoogleCloudChannelV1TrialSettings;
/**
* Output only. The time at which the entitlement is updated.
*/
updateTime?: string | null;
}
/**
* Represents Pub/Sub message content describing entitlement update.
*/
export interface Schema$GoogleCloudChannelV1EntitlementEvent {
/**
* Resource name of an entitlement of the form: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
entitlement?: string | null;
/**
* Type of event which happened on the entitlement.
*/
eventType?: string | null;
}
/**
* Response message for CloudChannelService.ListChannelPartnerLinks.
*/
export interface Schema$GoogleCloudChannelV1ListChannelPartnerLinksResponse {
/**
* The Channel partner links for a reseller.
*/
channelPartnerLinks?: Schema$GoogleCloudChannelV1ChannelPartnerLink[];
/**
* A token to retrieve the next page of results. Pass to ListChannelPartnerLinksRequest.page_token to obtain that page.
*/
nextPageToken?: string | null;
}
/**
* Response message for CloudChannelService.ListCustomers.
*/
export interface Schema$GoogleCloudChannelV1ListCustomersResponse {
/**
* The customers belonging to a reseller or distributor.
*/
customers?: Schema$GoogleCloudChannelV1Customer[];
/**
* A token to retrieve the next page of results. Pass to ListCustomersRequest.page_token to obtain that page.
*/
nextPageToken?: string | null;
}
/**
* Response message for CloudChannelService.ListEntitlements.
*/
export interface Schema$GoogleCloudChannelV1ListEntitlementsResponse {
/**
* The reseller customer's entitlements.
*/
entitlements?: Schema$GoogleCloudChannelV1Entitlement[];
/**
* A token to list the next page of results. Pass to ListEntitlementsRequest.page_token to obtain that page.
*/
nextPageToken?: string | null;
}
/**
* Response message for ListOffers.
*/
export interface Schema$GoogleCloudChannelV1ListOffersResponse {
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of Offers requested.
*/
offers?: Schema$GoogleCloudChannelV1Offer[];
}
/**
* Response message for ListProducts.
*/
export interface Schema$GoogleCloudChannelV1ListProductsResponse {
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* List of Products requested.
*/
products?: Schema$GoogleCloudChannelV1Product[];
}
/**
* Response message for ListPurchasableOffers.
*/
export interface Schema$GoogleCloudChannelV1ListPurchasableOffersResponse {
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of Offers requested.
*/
purchasableOffers?: Schema$GoogleCloudChannelV1PurchasableOffer[];
}
/**
* Response message for ListPurchasableSkus.
*/
export interface Schema$GoogleCloudChannelV1ListPurchasableSkusResponse {
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of SKUs requested.
*/
purchasableSkus?: Schema$GoogleCloudChannelV1PurchasableSku[];
}
/**
* Response message for ListSkus.
*/
export interface Schema$GoogleCloudChannelV1ListSkusResponse {
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of SKUs requested.
*/
skus?: Schema$GoogleCloudChannelV1Sku[];
}
/**
* Response Message for ListSubscribers.
*/
export interface Schema$GoogleCloudChannelV1ListSubscribersResponse {
/**
* A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* List of service accounts which have subscriber access to the topic.
*/
serviceAccounts?: string[] | null;
/**
* Name of the topic registered with the reseller.
*/
topic?: string | null;
}
/**
* Request message for CloudChannelService.ListTransferableOffers
*/
export interface Schema$GoogleCloudChannelV1ListTransferableOffersRequest {
/**
* Customer's Cloud Identity ID
*/
cloudIdentityId?: string | null;
/**
* A reseller should create a customer and use the resource name of that customer here.
*/
customerName?: string | null;
/**
* The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".
*/
languageCode?: string | null;
/**
* Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 offers. The maximum value is 1000; the server will coerce values above 1000.
*/
pageSize?: number | null;
/**
* A token for a page of results other than the first page. Obtained using ListTransferableOffersResponse.next_page_token of the previous CloudChannelService.ListTransferableOffers call.
*/
pageToken?: string | null;
/**
* Required. The SKU to look up Offers for.
*/
sku?: string | null;
}
/**
* Response message for CloudChannelService.ListTransferableOffers.
*/
export interface Schema$GoogleCloudChannelV1ListTransferableOffersResponse {
/**
* A token to retrieve the next page of results. Pass to ListTransferableOffersRequest.page_token to obtain that page.
*/
nextPageToken?: string | null;
/**
* Information about Offers for a customer that can be used for transfer.
*/
transferableOffers?: Schema$GoogleCloudChannelV1TransferableOffer[];
}
/**
* Request message for CloudChannelService.ListTransferableSkus
*/
export interface Schema$GoogleCloudChannelV1ListTransferableSkusRequest {
/**
* The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.
*/
authToken?: string | null;
/**
* Customer's Cloud Identity ID
*/
cloudIdentityId?: string | null;
/**
* A reseller is required to create a customer and use the resource name of the created customer here. Customer_name uses the format: accounts/{account_id\}/customers/{customer_id\}
*/
customerName?: string | null;
/**
* The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US". Optional.
*/
languageCode?: string | null;
/**
* The requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000. Optional.
*/
pageSize?: number | null;
/**
* A token for a page of results other than the first page. Obtained using ListTransferableSkusResponse.next_page_token of the previous CloudChannelService.ListTransferableSkus call. Optional.
*/
pageToken?: string | null;
}
/**
* Response message for CloudChannelService.ListTransferableSkus.
*/
export interface Schema$GoogleCloudChannelV1ListTransferableSkusResponse {
/**
* A token to retrieve the next page of results. Pass to ListTransferableSkusRequest.page_token to obtain that page.
*/
nextPageToken?: string | null;
/**
* Information about existing SKUs for a customer that needs a transfer.
*/
transferableSkus?: Schema$GoogleCloudChannelV1TransferableSku[];
}
/**
* Represents the marketing information for a Product, SKU or Offer.
*/
export interface Schema$GoogleCloudChannelV1MarketingInfo {
/**
* Default logo.
*/
defaultLogo?: Schema$GoogleCloudChannelV1Media;
/**
* Human readable description. Description can contain HTML.
*/
description?: string | null;
/**
* Human readable name.
*/
displayName?: string | null;
}
/**
* Represents media information.
*/
export interface Schema$GoogleCloudChannelV1Media {
/**
* URL of the media.
*/
content?: string | null;
/**
* Title of the media.
*/
title?: string | null;
/**
* Type of the media.
*/
type?: string | null;
}
/**
* Represents an offer made to resellers for purchase. An offer is associated with a Sku, has a plan for payment, a price, and defines the constraints for buying.
*/
export interface Schema$GoogleCloudChannelV1Offer {
/**
* Constraints on transacting the Offer.
*/
constraints?: Schema$GoogleCloudChannelV1Constraints;
/**
* Output only. End of the Offer validity time.
*/
endTime?: string | null;
/**
* Marketing information for the Offer.
*/
marketingInfo?: Schema$GoogleCloudChannelV1MarketingInfo;
/**
* Resource Name of the Offer. Format: accounts/{account_id\}/offers/{offer_id\}
*/
name?: string | null;
/**
* Parameters required to use current Offer to purchase.
*/
parameterDefinitions?: Schema$GoogleCloudChannelV1ParameterDefinition[];
/**
* Describes the payment plan for the Offer.
*/
plan?: Schema$GoogleCloudChannelV1Plan;
/**
* Price for each monetizable resource type.
*/
priceByResources?: Schema$GoogleCloudChannelV1PriceByResource[];
/**
* SKU the offer is associated with.
*/
sku?: Schema$GoogleCloudChannelV1Sku;
/**
* Start of the Offer validity time.
*/
startTime?: string | null;
}
/**
* Provides contextual information about a google.longrunning.Operation.
*/
export interface Schema$GoogleCloudChannelV1OperationMetadata {
/**
* The RPC that initiated this Long Running Operation.
*/
operationType?: string | null;
}
/**
* Definition for extended entitlement parameters.
*/
export interface Schema$GoogleCloudChannelV1Parameter {
/**
* Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active.
*/
editable?: boolean | null;
/**
* Name of the parameter.
*/
name?: string | null;
/**
* Value of the parameter.
*/
value?: Schema$GoogleCloudChannelV1Value;
}
/**
* Parameter's definition. Specifies what parameter is required to use the current Offer to purchase.
*/
export interface Schema$GoogleCloudChannelV1ParameterDefinition {
/**
* If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.
*/
allowedValues?: Schema$GoogleCloudChannelV1Value[];
/**
* Maximum value of the parameter, if applicable. Inclusive. For example, maximum seats when purchasing Google Workspace Business Standard. Applicable to INT64 and DOUBLE parameter types.
*/
maxValue?: Schema$GoogleCloudChannelV1Value;
/**
* Minimal value of the parameter, if applicable. Inclusive. For example, minimal commitment when purchasing Anthos is 0.01. Applicable to INT64 and DOUBLE parameter types.
*/
minValue?: Schema$GoogleCloudChannelV1Value;
/**
* Name of the parameter.
*/
name?: string | null;
/**
* If set to true, parameter is optional to purchase this Offer.
*/
optional?: boolean | null;
/**
* Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here.
*/
parameterType?: string | null;
}
/**
* Represents period in days/months/years.
*/
export interface Schema$GoogleCloudChannelV1Period {
/**
* Total duration of Period Type defined.
*/
duration?: number | null;
/**
* Period Type.
*/
periodType?: string | null;
}
/**
* The payment plan for the Offer. Describes how to make a payment.
*/
export interface Schema$GoogleCloudChannelV1Plan {
/**
* Reseller Billing account to charge after an offer transaction. Only present for Google Cloud Platform offers.
*/
billingAccount?: string | null;
/**
* Describes how frequently the reseller will be billed, such as once per month.
*/
paymentCycle?: Schema$GoogleCloudChannelV1Period;
/**
* Describes how a reseller will be billed.
*/
paymentPlan?: string | null;
/**
* Specifies when the payment needs to happen.
*/
paymentType?: string | null;
/**
* Present for Offers with a trial period. For trial-only Offers, a paid service needs to start before the trial period ends for continued service. For Regular Offers with a trial period, the regular pricing goes into effect when trial period ends, or if paid service is started before the end of the trial period.
*/
trialPeriod?: Schema$GoogleCloudChannelV1Period;
}
/**
* Represents the price of the Offer.
*/
export interface Schema$GoogleCloudChannelV1Price {
/**
* Base price.
*/
basePrice?: Schema$GoogleTypeMoney;
/**
* Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2.
*/
discount?: number | null;
/**
* Effective Price after applying the discounts.
*/
effectivePrice?: Schema$GoogleTypeMoney;
/**
* Link to external price list, such as link to Google Voice rate card.
*/
externalPriceUri?: string | null;
}
/**
* Represents price by resource type.
*/
export interface Schema$GoogleCloudChannelV1PriceByResource {
/**
* Price of the Offer. Present if there are no price phases.
*/
price?: Schema$GoogleCloudChannelV1Price;
/**
* Specifies the price by time range.
*/
pricePhases?: Schema$GoogleCloudChannelV1PricePhase[];
/**
* Resource Type. Example: SEAT
*/
resourceType?: string | null;
}
/**
* Specifies the price by the duration of months. For example, a 20% discount for the first six months, then a 10% discount starting on the seventh month.
*/
export interface Schema$GoogleCloudChannelV1PricePhase {
/**
* Defines first period for the phase.
*/
firstPeriod?: number | null;
/**
* Defines first period for the phase.
*/
lastPeriod?: number | null;
/**
* Defines the phase period type.
*/
periodType?: string | null;
/**
* Price of the phase. Present if there are no price tiers.
*/
price?: Schema$GoogleCloudChannelV1Price;
/**
* Price by the resource tiers.
*/
priceTiers?: Schema$GoogleCloudChannelV1PriceTier[];
}
/**
* Defines price at resource tier level. For example, an offer with following definition : * Tier 1: Provide 25% discount for all seats between 1 and 25. * Tier 2: Provide 10% discount for all seats between 26 and 100. * Tier 3: Provide flat 15% discount for all seats above 100. Each of these tiers is represented as a PriceTier.
*/
export interface Schema$GoogleCloudChannelV1PriceTier {
/**
* First resource for which the tier price applies.
*/
firstResource?: number | null;
/**
* Last resource for which the tier price applies.
*/
lastResource?: number | null;
/**
* Price of the tier.
*/
price?: Schema$GoogleCloudChannelV1Price;
}
/**
* A Product is the entity a customer uses when placing an order. For example, Google Workspace, Google Voice, etc.
*/
export interface Schema$GoogleCloudChannelV1Product {