googleapis
Version:
Google APIs Client Library for Node.js
1,133 lines • 282 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
*
* The Cloud Channel API enables Google Cloud partners to have a single unified resale platform and APIs across all of Google Cloud including GCP, Workspace, Maps and Chrome.
*
* @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;
}
/**
* Represents Pub/Sub messages about updates to a Channel Partner. You can retrieve updated values through the ChannelPartnerLinks API.
*/
export interface Schema$GoogleCloudChannelV1alpha1ChannelPartnerEvent {
/**
* Resource name for the Channel Partner Link. Channel_partner uses the format: accounts/{account_id\}/channelPartnerLinks/{channel_partner_id\}
*/
channelPartner?: string | null;
/**
* Type of event performed on the Channel Partner.
*/
eventType?: string | null;
}
/**
* The definition of a report column. Specifies the data properties in the corresponding position of the report rows.
*/
export interface Schema$GoogleCloudChannelV1alpha1Column {
/**
* The unique name of the column (for example, customer_domain, channel_partner, customer_cost). You can use column IDs in RunReportJobRequest.filter. To see all reports and their columns, call CloudChannelReportsService.ListReports.
*/
columnId?: string | null;
/**
* The type of the values for this column.
*/
dataType?: string | null;
/**
* The column's display name.
*/
displayName?: 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;
}
/**
* A representation of usage or invoice date ranges.
*/
export interface Schema$GoogleCloudChannelV1alpha1DateRange {
/**
* The latest invoice date (inclusive). If this value is not the last day of a month, this will move it forward to the last day of the given month.
*/
invoiceEndDate?: Schema$GoogleTypeDate;
/**
* The earliest invoice date (inclusive). If this value is not the first day of a month, this will move it back to the first day of the given month.
*/
invoiceStartDate?: Schema$GoogleTypeDate;
/**
* The latest usage date time (exclusive). If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage end date is rounded down to include all usage from the specified date. We recommend that clients pass `usage_start_date_time` in Pacific time.
*/
usageEndDateTime?: Schema$GoogleTypeDateTime;
/**
* The earliest usage date time (inclusive). If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage start date is rounded down to include all usage from the specified date. We recommend that clients pass `usage_start_date_time` in Pacific time.
*/
usageStartDateTime?: Schema$GoogleTypeDateTime;
}
/**
* 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;
/**
* Optional. The billing account resource name that is used to pay for this entitlement.
*/
billingAccount?: string | null;
/**
* 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 parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For Google Cloud billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount.
*/
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. This is only supported for Google Workspace entitlements.
*/
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 is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.
*/
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;
/**
* Output only. The offer resource name that the entitlement will renew on at the end date. Takes the form: accounts/{account_id\}/offers/{offer_id\}.
*/
scheduledRenewalOffer?: string | null;
}
/**
* The ID and description of a report that was used to generate report data. For example, "Google Cloud Daily Spend", "Google Workspace License Activity", etc.
*/
export interface Schema$GoogleCloudChannelV1alpha1Report {
/**
* The list of columns included in the report. This defines the schema of the report results.
*/
columns?: Schema$GoogleCloudChannelV1alpha1Column[];
/**
* A description of other aspects of the report, such as the products it supports.
*/
description?: string | null;
/**
* A human-readable name for this report.
*/
displayName?: string | null;
/**
* Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, `613bf59q`). Name uses the format: accounts/{account_id\}/reports/{report_id\}
*/
name?: string | null;
}
/**
* The result of a RunReportJob operation. Contains the name to use in FetchReportResultsRequest.report_job and the status of the operation.
*/
export interface Schema$GoogleCloudChannelV1alpha1ReportJob {
/**
* Required. The resource name of a report job. Name uses the format: `accounts/{account_id\}/reportJobs/{report_job_id\}`
*/
name?: string | null;
/**
* The current status of report generation.
*/
reportStatus?: Schema$GoogleCloudChannelV1alpha1ReportStatus;
}
/**
* The features describing the data. Returned by CloudChannelReportsService.RunReportJob and CloudChannelReportsService.FetchReportResults.
*/
export interface Schema$GoogleCloudChannelV1alpha1ReportResultsMetadata {
/**
* The date range of reported usage.
*/
dateRange?: Schema$GoogleCloudChannelV1alpha1DateRange;
/**
* The usage dates immediately preceding `date_range` with the same duration. Use this to calculate trending usage and costs. This is only populated if you request trending data. For example, if `date_range` is July 1-15, `preceding_date_range` will be June 16-30.
*/
precedingDateRange?: Schema$GoogleCloudChannelV1alpha1DateRange;
/**
* Details of the completed report.
*/
report?: Schema$GoogleCloudChannelV1alpha1Report;
/**
* The total number of rows of data in the final report.
*/
rowCount?: string | null;
}
/**
* Status of a report generation process.
*/
export interface Schema$GoogleCloudChannelV1alpha1ReportStatus {
/**
* The report generation's completion time.
*/
endTime?: string | null;
/**
* The report generation's start time.
*/
startTime?: string | null;
/**
* The current state of the report generation process.
*/
state?: string | null;
}
/**
* Response message for CloudChannelReportsService.RunReportJob.
*/
export interface Schema$GoogleCloudChannelV1alpha1RunReportJobResponse {
/**
* Pass `report_job.name` to FetchReportResultsRequest.report_job to retrieve the report's results.
*/
reportJob?: Schema$GoogleCloudChannelV1alpha1ReportJob;
/**
* The metadata for the report's results (display name, columns, row count, and date range). If you view this before the operation finishes, you may see incomplete data.
*/
reportMetadata?: Schema$GoogleCloudChannelV1alpha1ReportResultsMetadata;
}
/**
* Represents information which resellers will get as part of notification from Pub/Sub.
*/
export interface Schema$GoogleCloudChannelV1alpha1SubscriberEvent {
/**
* Channel Partner event sent as part of Pub/Sub event to partners.
*/
channelPartnerEvent?: Schema$GoogleCloudChannelV1alpha1ChannelPartnerEvent;
/**
* Customer event sent as part of Pub/Sub event to partners.
*/
customerEvent?: Schema$GoogleCloudChannelV1alpha1CustomerEvent;
/**
* Entitlement event sent 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;
}
/**
* Represents the Billable SKU information.
*/
export interface Schema$GoogleCloudChannelV1BillableSku {
/**
* Resource name of Service which contains Repricing SKU. Format: services/{service\}. Example: "services/B7D9-FDCB-15D8".
*/
service?: string | null;
/**
* Unique human readable name for the Service.
*/
serviceDisplayName?: string | null;
/**
* Resource name of Billable SKU. Format: billableSkus/{sku\}. Example: billableSkus/6E1B-6634-470F".
*/
sku?: string | null;
/**
* Unique human readable name for the SKU.
*/
skuDisplayName?: string | null;
}
/**
* Represents a billing account.
*/
export interface Schema$GoogleCloudChannelV1BillingAccount {
/**
* Output only. The time when this billing account was created.
*/
createTime?: string | null;
/**
* Output only. The 3-letter currency code defined in ISO 4217.
*/
currencyCode?: string | null;
/**
* Display name of the billing account.
*/
displayName?: string | null;
/**
* Output only. Resource name of the billing account. Format: accounts/{account_id\}/billingAccounts/{billing_account_id\}.
*/
name?: string | null;
/**
* Output only. The CLDR region code.
*/
regionCode?: string | null;
}
/**
* Represents a billing account that can be used to make a purchase.
*/
export interface Schema$GoogleCloudChannelV1BillingAccountPurchaseInfo {
/**
* The billing account resource.
*/
billingAccount?: Schema$GoogleCloudChannelV1BillingAccount;
}
/**
* 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 {
/**
* Optional. The billing account resource name that is used to pay for this entitlement when setting up billing on a trial subscription. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.
*/
billingAccount?: string | null;
/**
* Required. New Offer. Format: accounts/{account_id\}/offers/{offer_id\}.
*/
offer?: string | null;
/**
* Optional. Parameters needed to purchase the Offer. To view the available Parameters refer to the Offer.parameter_definitions from the desired 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. To view the available Parameters for a request, refer to the Offer.parameter_definitions from the desired 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.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;
}
/**
* Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).
*/
export interface Schema$GoogleCloudChannelV1ChannelPartnerRepricingConfig {
/**
* Output only. Resource name of the ChannelPartnerRepricingConfig. Format: accounts/{account_id\}/channelPartnerLinks/{channel_partner_id\}/channelPartnerRepricingConfigs/{id\}.
*/
name?: string | null;
/**
* Required. The configuration for bill modifications made by a reseller before sending it to ChannelPartner.
*/
repricingConfig?: Schema$GoogleCloudChannelV1RepricingConfig;
/**
* Output only. Timestamp of an update to the repricing rule. If `update_time` is after RepricingConfig.effective_invoice_month then it indicates this was set mid-month.
*/
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;
}
/**
* The definition of a report column. Specifies the data properties in the corresponding position of the report rows.
*/
export interface Schema$GoogleCloudChannelV1Column {
/**
* The unique name of the column (for example, customer_domain, channel_partner, customer_cost). You can use column IDs in RunReportJobRequest.filter. To see all reports and their columns, call CloudChannelReportsService.ListReports.
*/
columnId?: string | null;
/**
* The type of the values for this column.
*/
dataType?: string | null;
/**
* The column's display name.
*/
displayName?: 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;
}
/**
* Specifies the override to conditionally apply.
*/
export interface Schema$GoogleCloudChannelV1ConditionalOverride {
/**
* Required. Information about the applied override's adjustment.
*/
adjustment?: Schema$GoogleCloudChannelV1RepricingAdjustment;
/**
* Required. The RebillingBasis to use for the applied override. Shows the relative cost based on your repricing costs.
*/
rebillingBasis?: string | null;
/**
* Required. Specifies the condition which, if met, will apply the override.
*/
repricingCondition?: Schema$GoogleCloudChannelV1RepricingCondition;
}
/**
* 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. The customer account contact's display name, formatted as a combination of the customer's first and last name.
*/
displayName?: string | null;
/**
* The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. Use this email to invite Team customers.
*/
email?: string | null;
/**
* The customer account contact's first name. Optional for Team customers.
*/
firstName?: string | null;
/**
* The customer account contact's last name. Optional for Team customers.
*/
lastName?: string | null;
/**
* The customer account's contact phone number.
*/
phone?: string | null;
/**
* Optional. The customer account contact's job title.
*/
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. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.
*/
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. The customer's Cloud Identity ID if the customer has a Cloud Identity resource.
*/
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;
/**
* Optional. External CRM ID for the customer. Populated only if a CRM ID exists for this customer.
*/
correlationId?: string | null;
/**
* Output only. Time when the customer was created.
*/
createTime?: string | null;
/**
* Required. The customer's primary domain. Must match the primary contact email's 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. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.
*/
orgPostalAddress?: Schema$GoogleTypePostalAddress;
/**
* Primary contact info.
*/
primaryContactInfo?: Schema$GoogleCloudChannelV1ContactInfo;
/**
* Output only. Time when the customer was 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;
}
/**
* Configuration for how a reseller will reprice a Customer.
*/
export interface Schema$GoogleCloudChannelV1CustomerRepricingConfig {
/**
* Output only. Resource name of the CustomerRepricingConfig. Format: accounts/{account_id\}/customers/{customer_id\}/customerRepricingConfigs/{id\}.
*/
name?: string | null;
/**
* Required. The configuration for bill modifications made by a reseller before sending it to customers.
*/
repricingConfig?: Schema$GoogleCloudChannelV1RepricingConfig;
/**
* Output only. Timestamp of an update to the repricing rule. If `update_time` is after RepricingConfig.effective_invoice_month then it indicates this was set mid-month.
*/
updateTime?: string | null;
}
/**
* A representation of usage or invoice date ranges.
*/
export interface Schema$GoogleCloudChannelV1DateRange {
/**
* The latest invoice date (inclusive). If this value is not the last day of a month, this will move it forward to the last day of the given month.
*/
invoiceEndDate?: Schema$GoogleTypeDate;
/**
* The earliest invoice date (inclusive). If this value is not the first day of a month, this will move it back to the first day of the given month.
*/
invoiceStartDate?: Schema$GoogleTypeDate;
/**
* The latest usage date time (exclusive). If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage end date is rounded down to include all usage from the specified date. We recommend that clients pass `usage_start_date_time` in Pacific time.
*/
usageEndDateTime?: Schema$GoogleTypeDateTime;
/**
* The earliest usage date time (inclusive). If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage start date is rounded down to include all usage from the specified date. We recommend that clients pass `usage_start_date_time` in Pacific time.
*/
usageStartDateTime?: Schema$GoogleTypeDateTime;
}
/**
* 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;
/**
* Optional. The billing account resource name that is used to pay for this entitlement.
*/
billingAccount?: string | null;
/**
* 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 parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For Google Cloud billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount.
*/
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. This is only supported for Google Workspace entitlements.
*/
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;
}
/**
* Change event entry for Entitlement order history
*/
export interface Schema$GoogleCloudChannelV1EntitlementChange {
/**
* The Entitlement's activation reason
*/
activationReason?: string | null;
/**
* Cancellation reason for the Entitlement.
*/
cancellationReason?: string | null;
/**
* The change action type.
*/
changeType?: string | null;
/**
* The submitted time of the change.
*/
createTime?: string | null;
/**
* Required. Resource name of an entitlement in the form: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
entitlement?: string | null;
/**
* Required. Resource name of the Offer at the time of change. Takes the form: accounts/{account_id\}/offers/{offer_id\}.
*/
offer?: string | null;
/**
* Human-readable identifier that shows what operator made a change. When the operator_type is RESELLER, this is the user's email address. For all other operator types, this is empty.
*/
operator?: string | null;
/**
* Operator type responsible for the change.
*/
operatorType?: string | null;
/**
* e.g. purchase_number change reason, entered by CRS.
*/
otherChangeReason?: string | null;
/**
* Extended parameters, such as: purchase_order_number, gcp_details; internal_correlation_id, long_running_operation_id, order_id; etc.
*/
parameters?: Schema$GoogleCloudChannelV1Parameter[];
/**
* Service provisioned for an Entitlement.
*/
provisionedService?: Schema$GoogleCloudChannelV1ProvisionedService;
/**
* Suspension reason for the Entitlement.
*/
suspensionReason?: string | null;
}
/**
* Represents Pub/Sub message content describing entitlement update.
*/
export interface Schema$Googl