googleapis
Version:
Google APIs Client Library for Node.js
812 lines (811 loc) • 48 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 accessapproval_v1beta1 {
interface Options extends GlobalOptions {
version: 'v1beta1';
}
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;
}
/**
* Access Approval API
*
* An API for controlling access to data by Google personnel.
*
* @example
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1beta1');
*
* @namespace accessapproval
* @type {Function}
* @version v1beta1
* @variation v1beta1
* @param {object=} options Options for Accessapproval
*/
class Accessapproval {
context: APIRequestContext;
folders: Resource$Folders;
organizations: Resource$Organizations;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Settings on a Project/Folder/Organization related to Access Approval.
*/
interface Schema$AccessApprovalSettings {
/**
* The resource name of the settings. Format is one of: <ol> <li>"projects/{project_id}/accessApprovalSettings"</li> <li>"folders/{folder_id}/accessApprovalSettings"</li> <li>"organizations/{organization_id}/accessApprovalSettings"</li> <ol>
*/
name?: string;
/**
* A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource.
*/
notificationEmails?: string[];
}
/**
* Home office and physical location of the principal.
*/
interface Schema$AccessLocations {
/**
* The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: <ol> <li>ASI: Asia</li> <li>EUR: Europe</li> <li>OCE: Oceania</li> <li>AFR: Africa</li> <li>NAM: North America</li> <li>SAM: South America</li> <li>ANT: Antarctica</li> <li>ANY: Any location</li> </ol>
*/
principalOfficeCountry?: string;
/**
* Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: <ol> <li>ASI: Asia</li> <li>EUR: Europe</li> <li>OCE: Oceania</li> <li>AFR: Africa</li> <li>NAM: North America</li> <li>SAM: South America</li> <li>ANT: Antarctica</li> <li>ANY: Any location</li> </ol>
*/
principalPhysicalLocationCountry?: string;
}
interface Schema$AccessReason {
/**
* More detail about certain reason types. See comments for each type above.
*/
detail?: string;
/**
* Type of access justification.
*/
type?: string;
}
/**
* A request for the customer to approve access to a resource.
*/
interface Schema$ApprovalRequest {
/**
* Access was approved.
*/
approve?: Schema$ApproveDecision;
/**
* The request was dismissed.
*/
dismiss?: Schema$DismissDecision;
/**
* The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
*/
name?: string;
/**
* The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time.
*/
requestedExpiration?: string;
/**
* The locations for which approval is being requested.
*/
requestedLocations?: Schema$AccessLocations;
/**
* The justification for which approval is being requested.
*/
requestedReason?: Schema$AccessReason;
/**
* The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
*/
requestedResourceName?: string;
/**
* Properties related to the resource represented by requested_resource_name.
*/
requestedResourceProperties?: Schema$ResourceProperties;
/**
* The time at which approval was requested.
*/
requestTime?: string;
}
/**
* Request to approve an ApprovalRequest.
*/
interface Schema$ApproveApprovalRequestMessage {
/**
* The expiration time of this approval.
*/
expireTime?: string;
}
/**
* A decision that has been made to approve access to a resource.
*/
interface Schema$ApproveDecision {
/**
* The time at which approval was granted.
*/
approveTime?: string;
/**
* The time at which the approval expires.
*/
expireTime?: string;
}
/**
* Request to dismiss an approval request.
*/
interface Schema$DismissApprovalRequestMessage {
}
/**
* A decision that has been made to dismiss an approval request.
*/
interface Schema$DismissDecision {
/**
* The time at which the approval request was dismissed.
*/
dismissTime?: string;
}
/**
* Response to listing of ApprovalRequest objects.
*/
interface Schema$ListApprovalRequestsResponse {
/**
* Approval request details.
*/
approvalRequests?: Schema$ApprovalRequest[];
/**
* Token to retrieve the next page of results, or empty if there are no more.
*/
nextPageToken?: string;
}
/**
* The properties associated with the resource of the request.
*/
interface Schema$ResourceProperties {
/**
* Whether an approval will exclude the descendants of the resource being requested.
*/
excludesDescendants?: boolean;
}
class Resource$Folders {
context: APIRequestContext;
approvalRequests: Resource$Folders$Approvalrequests;
constructor(context: APIRequestContext);
/**
* accessapproval.folders.getAccessApprovalSettings
* @desc Gets the settings associated with a project, folder, or organization.
* @alias accessapproval.folders.getAccessApprovalSettings
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the AccessApprovalSettings to retrieve.
* @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
*/
getAccessApprovalSettings(params?: Params$Resource$Folders$Getaccessapprovalsettings, options?: MethodOptions): GaxiosPromise<Schema$AccessApprovalSettings>;
getAccessApprovalSettings(params: Params$Resource$Folders$Getaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalSettings>, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
getAccessApprovalSettings(params: Params$Resource$Folders$Getaccessapprovalsettings, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
getAccessApprovalSettings(callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
/**
* accessapproval.folders.updateAccessApprovalSettings
* @desc Updates the settings associated with a project, folder, or organization. Completely replaces the existing settings.
* @alias accessapproval.folders.updateAccessApprovalSettings
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the settings. Format is one of: <ol> <li>"projects/{project_id}/accessApprovalSettings"</li> <li>"folders/{folder_id}/accessApprovalSettings"</li> <li>"organizations/{organization_id}/accessApprovalSettings"</li> <ol>
* @param {().AccessApprovalSettings} 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
*/
updateAccessApprovalSettings(params?: Params$Resource$Folders$Updateaccessapprovalsettings, options?: MethodOptions): GaxiosPromise<Schema$AccessApprovalSettings>;
updateAccessApprovalSettings(params: Params$Resource$Folders$Updateaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalSettings>, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
updateAccessApprovalSettings(params: Params$Resource$Folders$Updateaccessapprovalsettings, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
updateAccessApprovalSettings(callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
}
interface Params$Resource$Folders$Getaccessapprovalsettings extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the AccessApprovalSettings to retrieve.
*/
name?: string;
}
interface Params$Resource$Folders$Updateaccessapprovalsettings extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the settings. Format is one of: <ol> <li>"projects/{project_id}/accessApprovalSettings"</li> <li>"folders/{folder_id}/accessApprovalSettings"</li> <li>"organizations/{organization_id}/accessApprovalSettings"</li> <ol>
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AccessApprovalSettings;
}
class Resource$Folders$Approvalrequests {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* accessapproval.folders.approvalRequests.approve
* @desc Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @alias accessapproval.folders.approvalRequests.approve
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the approval request to approve.
* @param {().ApproveApprovalRequestMessage} 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
*/
approve(params?: Params$Resource$Folders$Approvalrequests$Approve, options?: MethodOptions): GaxiosPromise<Schema$ApprovalRequest>;
approve(params: Params$Resource$Folders$Approvalrequests$Approve, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
approve(params: Params$Resource$Folders$Approvalrequests$Approve, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
approve(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* accessapproval.folders.approvalRequests.dismiss
* @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @alias accessapproval.folders.approvalRequests.dismiss
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the ApprovalRequest to dismiss.
* @param {().DismissApprovalRequestMessage} 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
*/
dismiss(params?: Params$Resource$Folders$Approvalrequests$Dismiss, options?: MethodOptions): GaxiosPromise<Schema$ApprovalRequest>;
dismiss(params: Params$Resource$Folders$Approvalrequests$Dismiss, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
dismiss(params: Params$Resource$Folders$Approvalrequests$Dismiss, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
dismiss(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* accessapproval.folders.approvalRequests.get
* @desc Gets an approval request. Returns NOT_FOUND if the request does not exist.
* @alias accessapproval.folders.approvalRequests.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the approval request to retrieve.
* @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$Folders$Approvalrequests$Get, options?: MethodOptions): GaxiosPromise<Schema$ApprovalRequest>;
get(params: Params$Resource$Folders$Approvalrequests$Get, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
get(params: Params$Resource$Folders$Approvalrequests$Get, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
get(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* accessapproval.folders.approvalRequests.list
* @desc Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.
* @alias accessapproval.folders.approvalRequests.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter A filter on the type of approval requests to retrieve. Must be one of the following values: <ol> <li>[not set]: Requests that are pending or have active approvals.</li> <li>ALL: All requests.</li> <li>PENDING: Only pending requests.</li> <li>ACTIVE: Only active (i.e. currently approved) requests.</li> <li>DISMISSED: Only dismissed (including expired) requests.</li> </ol>
* @param {integer=} params.pageSize Requested page size.
* @param {string=} params.pageToken A token identifying the page of results to return.
* @param {string} params.parent The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}".
* @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$Folders$Approvalrequests$List, options?: MethodOptions): GaxiosPromise<Schema$ListApprovalRequestsResponse>;
list(params: Params$Resource$Folders$Approvalrequests$List, options: MethodOptions | BodyResponseCallback<Schema$ListApprovalRequestsResponse>, callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
list(params: Params$Resource$Folders$Approvalrequests$List, callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
}
interface Params$Resource$Folders$Approvalrequests$Approve extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the approval request to approve.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ApproveApprovalRequestMessage;
}
interface Params$Resource$Folders$Approvalrequests$Dismiss extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the ApprovalRequest to dismiss.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DismissApprovalRequestMessage;
}
interface Params$Resource$Folders$Approvalrequests$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the approval request to retrieve.
*/
name?: string;
}
interface Params$Resource$Folders$Approvalrequests$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* A filter on the type of approval requests to retrieve. Must be one of the following values: <ol> <li>[not set]: Requests that are pending or have active approvals.</li> <li>ALL: All requests.</li> <li>PENDING: Only pending requests.</li> <li>ACTIVE: Only active (i.e. currently approved) requests.</li> <li>DISMISSED: Only dismissed (including expired) requests.</li> </ol>
*/
filter?: string;
/**
* Requested page size.
*/
pageSize?: number;
/**
* A token identifying the page of results to return.
*/
pageToken?: string;
/**
* The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}".
*/
parent?: string;
}
class Resource$Organizations {
context: APIRequestContext;
approvalRequests: Resource$Organizations$Approvalrequests;
constructor(context: APIRequestContext);
/**
* accessapproval.organizations.getAccessApprovalSettings
* @desc Gets the settings associated with a project, folder, or organization.
* @alias accessapproval.organizations.getAccessApprovalSettings
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the AccessApprovalSettings to retrieve.
* @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
*/
getAccessApprovalSettings(params?: Params$Resource$Organizations$Getaccessapprovalsettings, options?: MethodOptions): GaxiosPromise<Schema$AccessApprovalSettings>;
getAccessApprovalSettings(params: Params$Resource$Organizations$Getaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalSettings>, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
getAccessApprovalSettings(params: Params$Resource$Organizations$Getaccessapprovalsettings, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
getAccessApprovalSettings(callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
/**
* accessapproval.organizations.updateAccessApprovalSettings
* @desc Updates the settings associated with a project, folder, or organization. Completely replaces the existing settings.
* @alias accessapproval.organizations.updateAccessApprovalSettings
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the settings. Format is one of: <ol> <li>"projects/{project_id}/accessApprovalSettings"</li> <li>"folders/{folder_id}/accessApprovalSettings"</li> <li>"organizations/{organization_id}/accessApprovalSettings"</li> <ol>
* @param {().AccessApprovalSettings} 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
*/
updateAccessApprovalSettings(params?: Params$Resource$Organizations$Updateaccessapprovalsettings, options?: MethodOptions): GaxiosPromise<Schema$AccessApprovalSettings>;
updateAccessApprovalSettings(params: Params$Resource$Organizations$Updateaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalSettings>, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
updateAccessApprovalSettings(params: Params$Resource$Organizations$Updateaccessapprovalsettings, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
updateAccessApprovalSettings(callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
}
interface Params$Resource$Organizations$Getaccessapprovalsettings extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the AccessApprovalSettings to retrieve.
*/
name?: string;
}
interface Params$Resource$Organizations$Updateaccessapprovalsettings extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the settings. Format is one of: <ol> <li>"projects/{project_id}/accessApprovalSettings"</li> <li>"folders/{folder_id}/accessApprovalSettings"</li> <li>"organizations/{organization_id}/accessApprovalSettings"</li> <ol>
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AccessApprovalSettings;
}
class Resource$Organizations$Approvalrequests {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* accessapproval.organizations.approvalRequests.approve
* @desc Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @alias accessapproval.organizations.approvalRequests.approve
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the approval request to approve.
* @param {().ApproveApprovalRequestMessage} 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
*/
approve(params?: Params$Resource$Organizations$Approvalrequests$Approve, options?: MethodOptions): GaxiosPromise<Schema$ApprovalRequest>;
approve(params: Params$Resource$Organizations$Approvalrequests$Approve, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
approve(params: Params$Resource$Organizations$Approvalrequests$Approve, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
approve(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* accessapproval.organizations.approvalRequests.dismiss
* @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @alias accessapproval.organizations.approvalRequests.dismiss
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the ApprovalRequest to dismiss.
* @param {().DismissApprovalRequestMessage} 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
*/
dismiss(params?: Params$Resource$Organizations$Approvalrequests$Dismiss, options?: MethodOptions): GaxiosPromise<Schema$ApprovalRequest>;
dismiss(params: Params$Resource$Organizations$Approvalrequests$Dismiss, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
dismiss(params: Params$Resource$Organizations$Approvalrequests$Dismiss, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
dismiss(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* accessapproval.organizations.approvalRequests.get
* @desc Gets an approval request. Returns NOT_FOUND if the request does not exist.
* @alias accessapproval.organizations.approvalRequests.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the approval request to retrieve.
* @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$Organizations$Approvalrequests$Get, options?: MethodOptions): GaxiosPromise<Schema$ApprovalRequest>;
get(params: Params$Resource$Organizations$Approvalrequests$Get, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
get(params: Params$Resource$Organizations$Approvalrequests$Get, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
get(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* accessapproval.organizations.approvalRequests.list
* @desc Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.
* @alias accessapproval.organizations.approvalRequests.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter A filter on the type of approval requests to retrieve. Must be one of the following values: <ol> <li>[not set]: Requests that are pending or have active approvals.</li> <li>ALL: All requests.</li> <li>PENDING: Only pending requests.</li> <li>ACTIVE: Only active (i.e. currently approved) requests.</li> <li>DISMISSED: Only dismissed (including expired) requests.</li> </ol>
* @param {integer=} params.pageSize Requested page size.
* @param {string=} params.pageToken A token identifying the page of results to return.
* @param {string} params.parent The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}".
* @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$Organizations$Approvalrequests$List, options?: MethodOptions): GaxiosPromise<Schema$ListApprovalRequestsResponse>;
list(params: Params$Resource$Organizations$Approvalrequests$List, options: MethodOptions | BodyResponseCallback<Schema$ListApprovalRequestsResponse>, callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
list(params: Params$Resource$Organizations$Approvalrequests$List, callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
}
interface Params$Resource$Organizations$Approvalrequests$Approve extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the approval request to approve.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ApproveApprovalRequestMessage;
}
interface Params$Resource$Organizations$Approvalrequests$Dismiss extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the ApprovalRequest to dismiss.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DismissApprovalRequestMessage;
}
interface Params$Resource$Organizations$Approvalrequests$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the approval request to retrieve.
*/
name?: string;
}
interface Params$Resource$Organizations$Approvalrequests$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* A filter on the type of approval requests to retrieve. Must be one of the following values: <ol> <li>[not set]: Requests that are pending or have active approvals.</li> <li>ALL: All requests.</li> <li>PENDING: Only pending requests.</li> <li>ACTIVE: Only active (i.e. currently approved) requests.</li> <li>DISMISSED: Only dismissed (including expired) requests.</li> </ol>
*/
filter?: string;
/**
* Requested page size.
*/
pageSize?: number;
/**
* A token identifying the page of results to return.
*/
pageToken?: string;
/**
* The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}".
*/
parent?: string;
}
class Resource$Projects {
context: APIRequestContext;
approvalRequests: Resource$Projects$Approvalrequests;
constructor(context: APIRequestContext);
/**
* accessapproval.projects.getAccessApprovalSettings
* @desc Gets the settings associated with a project, folder, or organization.
* @alias accessapproval.projects.getAccessApprovalSettings
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the AccessApprovalSettings to retrieve.
* @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
*/
getAccessApprovalSettings(params?: Params$Resource$Projects$Getaccessapprovalsettings, options?: MethodOptions): GaxiosPromise<Schema$AccessApprovalSettings>;
getAccessApprovalSettings(params: Params$Resource$Projects$Getaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalSettings>, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
getAccessApprovalSettings(params: Params$Resource$Projects$Getaccessapprovalsettings, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
getAccessApprovalSettings(callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
/**
* accessapproval.projects.updateAccessApprovalSettings
* @desc Updates the settings associated with a project, folder, or organization. Completely replaces the existing settings.
* @alias accessapproval.projects.updateAccessApprovalSettings
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the settings. Format is one of: <ol> <li>"projects/{project_id}/accessApprovalSettings"</li> <li>"folders/{folder_id}/accessApprovalSettings"</li> <li>"organizations/{organization_id}/accessApprovalSettings"</li> <ol>
* @param {().AccessApprovalSettings} 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
*/
updateAccessApprovalSettings(params?: Params$Resource$Projects$Updateaccessapprovalsettings, options?: MethodOptions): GaxiosPromise<Schema$AccessApprovalSettings>;
updateAccessApprovalSettings(params: Params$Resource$Projects$Updateaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalSettings>, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
updateAccessApprovalSettings(params: Params$Resource$Projects$Updateaccessapprovalsettings, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
updateAccessApprovalSettings(callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
}
interface Params$Resource$Projects$Getaccessapprovalsettings extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the AccessApprovalSettings to retrieve.
*/
name?: string;
}
interface Params$Resource$Projects$Updateaccessapprovalsettings extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the settings. Format is one of: <ol> <li>"projects/{project_id}/accessApprovalSettings"</li> <li>"folders/{folder_id}/accessApprovalSettings"</li> <li>"organizations/{organization_id}/accessApprovalSettings"</li> <ol>
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AccessApprovalSettings;
}
class Resource$Projects$Approvalrequests {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* accessapproval.projects.approvalRequests.approve
* @desc Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @alias accessapproval.projects.approvalRequests.approve
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the approval request to approve.
* @param {().ApproveApprovalRequestMessage} 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
*/
approve(params?: Params$Resource$Projects$Approvalrequests$Approve, options?: MethodOptions): GaxiosPromise<Schema$ApprovalRequest>;
approve(params: Params$Resource$Projects$Approvalrequests$Approve, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
approve(params: Params$Resource$Projects$Approvalrequests$Approve, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
approve(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* accessapproval.projects.approvalRequests.dismiss
* @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @alias accessapproval.projects.approvalRequests.dismiss
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the ApprovalRequest to dismiss.
* @param {().DismissApprovalRequestMessage} 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
*/
dismiss(params?: Params$Resource$Projects$Approvalrequests$Dismiss, options?: MethodOptions): GaxiosPromise<Schema$ApprovalRequest>;
dismiss(params: Params$Resource$Projects$Approvalrequests$Dismiss, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
dismiss(params: Params$Resource$Projects$Approvalrequests$Dismiss, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
dismiss(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* accessapproval.projects.approvalRequests.get
* @desc Gets an approval request. Returns NOT_FOUND if the request does not exist.
* @alias accessapproval.projects.approvalRequests.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of the approval request to retrieve.
* @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$Projects$Approvalrequests$Get, options?: MethodOptions): GaxiosPromise<Schema$ApprovalRequest>;
get(params: Params$Resource$Projects$Approvalrequests$Get, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
get(params: Params$Resource$Projects$Approvalrequests$Get, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
get(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* accessapproval.projects.approvalRequests.list
* @desc Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.
* @alias accessapproval.projects.approvalRequests.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter A filter on the type of approval requests to retrieve. Must be one of the following values: <ol> <li>[not set]: Requests that are pending or have active approvals.</li> <li>ALL: All requests.</li> <li>PENDING: Only pending requests.</li> <li>ACTIVE: Only active (i.e. currently approved) requests.</li> <li>DISMISSED: Only dismissed (including expired) requests.</li> </ol>
* @param {integer=} params.pageSize Requested page size.
* @param {string=} params.pageToken A token identifying the page of results to return.
* @param {string} params.parent The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}".
* @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$Projects$Approvalrequests$List, options?: MethodOptions): GaxiosPromise<Schema$ListApprovalRequestsResponse>;
list(params: Params$Resource$Projects$Approvalrequests$List, options: MethodOptions | BodyResponseCallback<Schema$ListApprovalRequestsResponse>, callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
list(params: Params$Resource$Projects$Approvalrequests$List, callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
}
interface Params$Resource$Projects$Approvalrequests$Approve extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the approval request to approve.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ApproveApprovalRequestMessage;
}
interface Params$Resource$Projects$Approvalrequests$Dismiss extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the ApprovalRequest to dismiss.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DismissApprovalRequestMessage;
}
interface Params$Resource$Projects$Approvalrequests$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the approval request to retrieve.
*/
name?: string;
}
interface Params$Resource$Projects$Approvalrequests$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* A filter on the type of approval requests to retrieve. Must be one of the following values: <ol> <li>[not set]: Requests that are pending or have active approvals.</li> <li>ALL: All requests.</li> <li>PENDING: Only pending requests.</li> <li>ACTIVE: Only active (i.e. currently approved) requests.</li> <li>DISMISSED: Only dismissed (including expired) requests.</li> </ol>
*/
filter?: string;
/**
* Requested page size.
*/
pageSize?: number;
/**
* A token identifying the page of results to return.
*/
pageToken?: string;
/**
* The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}".
*/
parent?: string;
}
}