googleapis
Version:
Google APIs Client Library for Node.js
911 lines (910 loc) • 83 kB
TypeScript
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace cloudbilling_v1 {
interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* 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 Billing API
*
* Allows developers to manage billing for their Google Cloud Platform projects programmatically.
*
* @example
* const {google} = require('googleapis');
* const cloudbilling = google.cloudbilling('v1');
*
* @namespace cloudbilling
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Cloudbilling
*/
class Cloudbilling {
context: APIRequestContext;
billingAccounts: Resource$Billingaccounts;
projects: Resource$Projects;
services: Resource$Services;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Represents the aggregation level and interval for pricing of a single SKU.
*/
interface Schema$AggregationInfo {
/**
* The number of intervals to aggregate over. Example: If aggregation_level is "DAILY" and aggregation_count is 14, aggregation will be over 14 days.
*/
aggregationCount?: number;
aggregationInterval?: string;
aggregationLevel?: string;
}
/**
* Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
*/
interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
*/
service?: string;
}
/**
* Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
*/
interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[];
/**
* Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored.
*/
ignoreChildExemptions?: boolean;
/**
* The log type that this config enables.
*/
logType?: string;
}
/**
* A billing account in [GCP Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects.
*/
interface Schema$BillingAccount {
/**
* The display name given to the billing account, such as `My Billing Account`. This name is displayed in the GCP Console.
*/
displayName?: string;
/**
* If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the master billing account that it is being resold through. Otherwise this will be empty.
*/
masterBillingAccount?: string;
/**
* The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
*/
name?: string;
/**
* True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
*/
open?: boolean;
}
/**
* Associates `members` with a `role`.
*/
interface Schema$Binding {
/**
* The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
*/
condition?: Schema$Expr;
/**
* Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
*/
members?: string[];
/**
* Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: string;
}
/**
* Represents the category hierarchy of a SKU.
*/
interface Schema$Category {
/**
* The type of product the SKU refers to. Example: "Compute", "Storage", "Network", "ApplicationServices" etc.
*/
resourceFamily?: string;
/**
* A group classification for related SKUs. Example: "RAM", "GPU", "Prediction", "Ops", "GoogleEgress" etc.
*/
resourceGroup?: string;
/**
* The display name of the service this SKU belongs to.
*/
serviceDisplayName?: string;
/**
* Represents how the SKU is consumed. Example: "OnDemand", "Preemptible", "Commit1Mo", "Commit1Yr" etc.
*/
usageType?: string;
}
/**
* Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
*/
interface Schema$Expr {
/**
* An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string;
/**
* Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.
*/
expression?: string;
/**
* An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string;
/**
* An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string;
}
/**
* Response message for `ListBillingAccounts`.
*/
interface Schema$ListBillingAccountsResponse {
/**
* A list of billing accounts.
*/
billingAccounts?: Schema$BillingAccount[];
/**
* A token to retrieve the next page of results. To retrieve the next page, call `ListBillingAccounts` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve.
*/
nextPageToken?: string;
}
/**
* Request message for `ListProjectBillingInfoResponse`.
*/
interface Schema$ListProjectBillingInfoResponse {
/**
* A token to retrieve the next page of results. To retrieve the next page, call `ListProjectBillingInfo` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve.
*/
nextPageToken?: string;
/**
* A list of `ProjectBillingInfo` resources representing the projects associated with the billing account.
*/
projectBillingInfo?: Schema$ProjectBillingInfo[];
}
/**
* Response message for `ListServices`.
*/
interface Schema$ListServicesResponse {
/**
* A token to retrieve the next page of results. To retrieve the next page, call `ListServices` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve.
*/
nextPageToken?: string;
/**
* A list of services.
*/
services?: Schema$Service[];
}
/**
* Response message for `ListSkus`.
*/
interface Schema$ListSkusResponse {
/**
* A token to retrieve the next page of results. To retrieve the next page, call `ListSkus` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve.
*/
nextPageToken?: string;
/**
* The list of public SKUs of the given service.
*/
skus?: Schema$Sku[];
}
/**
* Represents an amount of money with its currency type.
*/
interface Schema$Money {
/**
* The 3-letter currency code defined in ISO 4217.
*/
currencyCode?: string;
/**
* Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
*/
nanos?: number;
/**
* The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
*/
units?: string;
}
/**
* Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).
*/
interface Schema$Policy {
/**
* Specifies cloud audit logging configuration for this policy.
*/
auditConfigs?: Schema$AuditConfig[];
/**
* Associates a list of `members` to a `role`. `bindings` with no members will result in an error.
*/
bindings?: Schema$Binding[];
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten.
*/
etag?: string;
/**
* Deprecated.
*/
version?: number;
}
/**
* Expresses a mathematical pricing formula. For Example:- `usage_unit: GBy` `tiered_rates:` `[start_usage_amount: 20, unit_price: $10]` `[start_usage_amount: 100, unit_price: $5]` The above expresses a pricing formula where the first 20GB is free, the next 80GB is priced at $10 per GB followed by $5 per GB for additional usage.
*/
interface Schema$PricingExpression {
/**
* The base unit for the SKU which is the unit used in usage exports. Example: "By"
*/
baseUnit?: string;
/**
* Conversion factor for converting from price per usage_unit to price per base_unit, and start_usage_amount to start_usage_amount in base_unit. unit_price / base_unit_conversion_factor = price per base_unit. start_usage_amount * base_unit_conversion_factor = start_usage_amount in base_unit.
*/
baseUnitConversionFactor?: number;
/**
* The base unit in human readable form. Example: "byte".
*/
baseUnitDescription?: string;
/**
* The recommended quantity of units for displaying pricing info. When displaying pricing info it is recommended to display: (unit_price * display_quantity) per display_quantity usage_unit. This field does not affect the pricing formula and is for display purposes only. Example: If the unit_price is "0.0001 USD", the usage_unit is "GB" and the display_quantity is "1000" then the recommended way of displaying the pricing info is "0.10 USD per 1000 GB"
*/
displayQuantity?: number;
/**
* The list of tiered rates for this pricing. The total cost is computed by applying each of the tiered rates on usage. This repeated list is sorted by ascending order of start_usage_amount.
*/
tieredRates?: Schema$TierRate[];
/**
* The short hand for unit of usage this pricing is specified in. Example: usage_unit of "GiBy" means that usage is specified in "Gibi Byte".
*/
usageUnit?: string;
/**
* The unit of usage in human readable form. Example: "gibi byte".
*/
usageUnitDescription?: string;
}
/**
* Represents the pricing information for a SKU at a single point of time.
*/
interface Schema$PricingInfo {
/**
* Aggregation Info. This can be left unspecified if the pricing expression doesn't require aggregation.
*/
aggregationInfo?: Schema$AggregationInfo;
/**
* Conversion rate used for currency conversion, from USD to the currency specified in the request. This includes any surcharge collected for billing in non USD currency. If a currency is not specified in the request this defaults to 1.0. Example: USD * currency_conversion_rate = JPY
*/
currencyConversionRate?: number;
/**
* The timestamp from which this pricing was effective within the requested time range. This is guaranteed to be greater than or equal to the start_time field in the request and less than the end_time field in the request. If a time range was not specified in the request this field will be equivalent to a time within the last 12 hours, indicating the latest pricing info.
*/
effectiveTime?: string;
/**
* Expresses the pricing formula. See `PricingExpression` for an example.
*/
pricingExpression?: Schema$PricingExpression;
/**
* An optional human readable summary of the pricing information, has a maximum length of 256 characters.
*/
summary?: string;
}
/**
* Encapsulation of billing information for a GCP Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).
*/
interface Schema$ProjectBillingInfo {
/**
* The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`.
*/
billingAccountName?: string;
/**
* True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. This field is read-only.
*/
billingEnabled?: boolean;
/**
* The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. This field is read-only.
*/
name?: string;
/**
* The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. This field is read-only.
*/
projectId?: string;
}
/**
* Encapsulates a single service in Google Cloud Platform.
*/
interface Schema$Service {
/**
* The business under which the service is offered. Ex. "businessEntities/GCP", "businessEntities/Maps"
*/
businessEntityName?: string;
/**
* A human readable display name for this service.
*/
displayName?: string;
/**
* The resource name for the service. Example: "services/DA34-426B-A397"
*/
name?: string;
/**
* The identifier for the service. Example: "DA34-426B-A397"
*/
serviceId?: string;
}
/**
* Request message for `SetIamPolicy` method.
*/
interface Schema$SetIamPolicyRequest {
/**
* REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
*/
policy?: Schema$Policy;
/**
* OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM.
*/
updateMask?: string;
}
/**
* Encapsulates a single SKU in Google Cloud Platform
*/
interface Schema$Sku {
/**
* The category hierarchy of this SKU, purely for organizational purpose.
*/
category?: Schema$Category;
/**
* A human readable description of the SKU, has a maximum length of 256 characters.
*/
description?: string;
/**
* The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE"
*/
name?: string;
/**
* A timeline of pricing info for this SKU in chronological order.
*/
pricingInfo?: Schema$PricingInfo[];
/**
* Identifies the service provider. This is 'Google' for first party services in Google Cloud Platform.
*/
serviceProviderName?: string;
/**
* List of service regions this SKU is offered at. Example: "asia-east1" Service regions can be found at https://cloud.google.com/about/locations/
*/
serviceRegions?: string[];
/**
* The identifier for the SKU. Example: "AA95-CD31-42FE"
*/
skuId?: string;
}
/**
* Request message for `TestIamPermissions` method.
*/
interface Schema$TestIamPermissionsRequest {
/**
* The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
permissions?: string[];
}
/**
* Response message for `TestIamPermissions` method.
*/
interface Schema$TestIamPermissionsResponse {
/**
* A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
*/
permissions?: string[];
}
/**
* The price rate indicating starting usage and its corresponding price.
*/
interface Schema$TierRate {
/**
* Usage is priced at this rate only after this amount. Example: start_usage_amount of 10 indicates that the usage will be priced at the unit_price after the first 10 usage_units.
*/
startUsageAmount?: number;
/**
* The price per unit of usage. Example: unit_price of amount $10 indicates that each unit will cost $10.
*/
unitPrice?: Schema$Money;
}
class Resource$Billingaccounts {
context: APIRequestContext;
projects: Resource$Billingaccounts$Projects;
constructor(context: APIRequestContext);
/**
* cloudbilling.billingAccounts.create
* @desc Creates a billing account. This method can only be used to create [billing subaccounts](https://cloud.google.com/billing/docs/concepts) by GCP resellers. When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the master account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). This method will return an error if the master account has not been provisioned as a reseller account.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Cloud Billing API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudbilling
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var cloudbilling = google.cloudbilling('v1');
*
* authorize(function(authClient) {
* var request = {
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* cloudbilling.billingAccounts.create(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias cloudbilling.billingAccounts.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().BillingAccount} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Billingaccounts$Create, options?: MethodOptions): GaxiosPromise<Schema$BillingAccount>;
create(params: Params$Resource$Billingaccounts$Create, options: MethodOptions | BodyResponseCallback<Schema$BillingAccount>, callback: BodyResponseCallback<Schema$BillingAccount>): void;
create(params: Params$Resource$Billingaccounts$Create, callback: BodyResponseCallback<Schema$BillingAccount>): void;
create(callback: BodyResponseCallback<Schema$BillingAccount>): void;
/**
* cloudbilling.billingAccounts.get
* @desc Gets information about a billing account. The current authenticated user must be a [viewer of the billing account](https://cloud.google.com/billing/docs/how-to/billing-access).
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Cloud Billing API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudbilling
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var cloudbilling = google.cloudbilling('v1');
*
* authorize(function(authClient) {
* var request = {
* // The resource name of the billing account to retrieve. For example,
* // `billingAccounts/012345-567890-ABCDEF`.
* name: 'billingAccounts/my-billing-account', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* cloudbilling.billingAccounts.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias cloudbilling.billingAccounts.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Billingaccounts$Get, options?: MethodOptions): GaxiosPromise<Schema$BillingAccount>;
get(params: Params$Resource$Billingaccounts$Get, options: MethodOptions | BodyResponseCallback<Schema$BillingAccount>, callback: BodyResponseCallback<Schema$BillingAccount>): void;
get(params: Params$Resource$Billingaccounts$Get, callback: BodyResponseCallback<Schema$BillingAccount>): void;
get(callback: BodyResponseCallback<Schema$BillingAccount>): void;
/**
* cloudbilling.billingAccounts.getIamPolicy
* @desc Gets the access control policy for a billing account. The caller must have the `billing.accounts.getIamPolicy` permission on the account, which is often given to billing account [viewers](https://cloud.google.com/billing/docs/how-to/billing-access).
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Cloud Billing API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudbilling
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var cloudbilling = google.cloudbilling('v1');
*
* authorize(function(authClient) {
* var request = {
* // REQUIRED: The resource for which the policy is being requested.
* // See the operation documentation for the appropriate value for this field.
* resource_: 'billingAccounts/my-billing-account', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* cloudbilling.billingAccounts.getIamPolicy(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias cloudbilling.billingAccounts.getIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned.
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getIamPolicy(params?: Params$Resource$Billingaccounts$Getiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
getIamPolicy(params: Params$Resource$Billingaccounts$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(params: Params$Resource$Billingaccounts$Getiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* cloudbilling.billingAccounts.list
* @desc Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Cloud Billing API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudbilling
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var cloudbilling = google.cloudbilling('v1');
*
* authorize(function(authClient) {
* var request = {
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var billingAccountsPage = response['billingAccounts'];
* if (!billingAccountsPage) {
* return;
* }
* for (var i = 0; i < billingAccountsPage.length; i++) {
* // TODO: Change code below to process each resource in `billingAccountsPage`:
* console.log(JSON.stringify(billingAccountsPage[i], null, 2));
* }
*
* if (response.nextPageToken) {
* request.pageToken = response.nextPageToken;
* cloudbilling.billingAccounts.list(request, handlePage);
* }
* };
*
* cloudbilling.billingAccounts.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias cloudbilling.billingAccounts.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter Options for how to filter the returned billing accounts. Currently this only supports filtering for [subaccounts](https://cloud.google.com/billing/docs/concepts) under a single provided reseller billing account. (e.g. "master_billing_account=billingAccounts/012345-678901-ABCDEF"). Boolean algebra and other fields are not currently supported.
* @param {integer=} params.pageSize Requested page size. The maximum page size is 100; this is also the default.
* @param {string=} params.pageToken A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Billingaccounts$List, options?: MethodOptions): GaxiosPromise<Schema$ListBillingAccountsResponse>;
list(params: Params$Resource$Billingaccounts$List, options: MethodOptions | BodyResponseCallback<Schema$ListBillingAccountsResponse>, callback: BodyResponseCallback<Schema$ListBillingAccountsResponse>): void;
list(params: Params$Resource$Billingaccounts$List, callback: BodyResponseCallback<Schema$ListBillingAccountsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListBillingAccountsResponse>): void;
/**
* cloudbilling.billingAccounts.patch
* @desc Updates a billing account's fields. Currently the only field that can be edited is `display_name`. The current authenticated user must have the `billing.accounts.update` IAM permission, which is typically given to the [administrator](https://cloud.google.com/billing/docs/how-to/billing-access) of the billing account.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Cloud Billing API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudbilling
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var cloudbilling = google.cloudbilling('v1');
*
* authorize(function(authClient) {
* var request = {
* // The name of the billing account resource to be updated.
* name: 'billingAccounts/my-billing-account', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body. Only these properties
* // will be changed.
* },
*
* auth: authClient,
* };
*
* cloudbilling.billingAccounts.patch(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias cloudbilling.billingAccounts.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the billing account resource to be updated.
* @param {string=} params.updateMask The update mask applied to the resource. Only "display_name" is currently supported.
* @param {().BillingAccount} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Billingaccounts$Patch, options?: MethodOptions): GaxiosPromise<Schema$BillingAccount>;
patch(params: Params$Resource$Billingaccounts$Patch, options: MethodOptions | BodyResponseCallback<Schema$BillingAccount>, callback: BodyResponseCallback<Schema$BillingAccount>): void;
patch(params: Params$Resource$Billingaccounts$Patch, callback: BodyResponseCallback<Schema$BillingAccount>): void;
patch(callback: BodyResponseCallback<Schema$BillingAccount>): void;
/**
* cloudbilling.billingAccounts.setIamPolicy
* @desc Sets the access control policy for a billing account. Replaces any existing policy. The caller must have the `billing.accounts.setIamPolicy` permission on the account, which is often given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access).
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Cloud Billing API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudbilling
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var cloudbilling = google.cloudbilling('v1');
*
* authorize(function(authClient) {
* var request = {
* // REQUIRED: The resource for which the policy is being specified.
* // See the operation documentation for the appropriate value for this field.
* resource_: 'billingAccounts/my-billing-account', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* cloudbilling.billingAccounts.setIamPolicy(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getClient({
* scopes: ['https://www.googleapis.com/auth/cloud-platform']
* }).then(client => {
* callback(client);
* }).catch(err => {
* console.error('authentication failed: ', err);
* });
* }
* @alias cloudbilling.billingAccounts.setIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
* @param {().SetIamPolicyRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
setIamPolicy(params?: Params$Resource$Billingaccounts$Setiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
setIamPolicy(params: Params$Resource$Billingaccounts$Setiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(params: Params$Resource$Billingaccounts$Setiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* cloudbilling.billingAccounts.testIamPermissions
* @desc Tests the access control policy for a billing account. This method takes the resource and a set of permissions as input and returns the subset of the input permissions that the caller is allowed for that resource.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Cloud Billing API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudbilling
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var cloudbilling = google.cloudbilling('v1');
*
* authorize(function(authClient) {
* var request = {
* // REQUIRED: The resource for which the policy detail is being requested.
* // See the operation documentation for the appropriate value for this field.
* resource_: 'billingAccounts/my-billing-account', // TODO: Update placeholder value.
*