/** * 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 { GaxiosPromise } from 'gaxios'; import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library'; import { BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common'; export declare namespace admin_datatransfer_v1 { interface Options extends GlobalOptions { version: 'datatransfer_v1'; } interface StandardParameters { /** * Data format for the response. */ alt?: 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; /** * An opaque string that represents a user for quota purposes. Must not * exceed 40 characters. */ quotaUser?: string; /** * Deprecated. Please use quotaUser instead. */ userIp?: string; } /** * Admin Data Transfer API * * Transfers user data from one user to another. * * @example * const {google} = require('googleapis'); * const admin = google.admin('datatransfer_v1'); * * @namespace admin * @type {Function} * @version datatransfer_v1 * @variation datatransfer_v1 * @param {object=} options Options for Admin */ class Admin { applications: Resource$Applications; transfers: Resource$Transfers; constructor(options: GlobalOptions, google?: GoogleConfigurable); } /** * The JSON template for an Application resource. */ interface Schema$Application { /** * Etag of the resource. */ etag?: string; /** * The application's ID. */ id?: string; /** * Identifies the resource as a DataTransfer Application Resource. */ kind?: string; /** * The application's name. */ name?: string; /** * The list of all possible transfer parameters for this application. These * parameters can be used to select the data of the user in this application * to be transfered. */ transferParams?: Schema$ApplicationTransferParam[]; } /** * Template to map fields of ApplicationDataTransfer resource. */ interface Schema$ApplicationDataTransfer { /** * The application's ID. */ applicationId?: string; /** * The transfer parameters for the application. These parameters are used to * select the data which will get transfered in context of this application. */ applicationTransferParams?: Schema$ApplicationTransferParam[]; /** * Current status of transfer for this application. (Read-only) */ applicationTransferStatus?: string; } /** * Template for a collection of Applications. */ interface Schema$ApplicationsListResponse { /** * List of applications that support data transfer and are also installed * for the customer. */ applications?: Schema$Application[]; /** * ETag of the resource. */ etag?: string; /** * Identifies the resource as a collection of Applications. */ kind?: string; /** * Continuation token which will be used to specify next page in list API. */ nextPageToken?: string; } /** * Template for application transfer parameters. */ interface Schema$ApplicationTransferParam { /** * The type of the transfer parameter. eg: 'PRIVACY_LEVEL' */ key?: string; /** * The value of the coressponding transfer parameter. eg: 'PRIVATE' * or 'SHARED' */ value?: string[]; } /** * The JSON template for a DataTransfer resource. */ interface Schema$DataTransfer { /** * List of per application data transfer resources. It contains data * transfer details of the applications associated with this transfer * resource. Note that this list is also used to specify the applications * for which data transfer has to be done at the time of the transfer * resource creation. */ applicationDataTransfers?: Schema$ApplicationDataTransfer[]; /** * ETag of the resource. */ etag?: string; /** * The transfer's ID (Read-only). */ id?: string; /** * Identifies the resource as a DataTransfer request. */ kind?: string; /** * ID of the user to whom the data is being transfered. */ newOwnerUserId?: string; /** * ID of the user whose data is being transfered. */ oldOwnerUserId?: string; /** * Overall transfer status (Read-only). */ overallTransferStatusCode?: string; /** * The time at which the data transfer was requested (Read-only). */ requestTime?: string; } /** * Template for a collection of DataTransfer resources. */ interface Schema$DataTransfersListResponse { /** * List of data transfer requests. */ dataTransfers?: Schema$DataTransfer[]; /** * ETag of the resource. */ etag?: string; /** * Identifies the resource as a collection of data transfer requests. */ kind?: string; /** * Continuation token which will be used to specify next page in list API. */ nextPageToken?: string; } class Resource$Applications { constructor(); /** * datatransfer.applications.get * @desc Retrieves information about an application for the given * application ID. * @alias datatransfer.applications.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.applicationId ID of the application resource to be retrieved. * @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$Applications$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Applications$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Applications$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * datatransfer.applications.list * @desc Lists the applications available for data transfer for a customer. * @alias datatransfer.applications.list * @memberOf! () * * @param {object=} params Parameters for request * @param {string=} params.customerId Immutable ID of the Google Apps account. * @param {integer=} params.maxResults Maximum number of results to return. Default is 100. * @param {string=} params.pageToken Token to specify next page in the list. * @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$Applications$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Applications$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Applications$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Applications$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * ID of the application resource to be retrieved. */ applicationId?: string; } interface Params$Resource$Applications$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Immutable ID of the Google Apps account. */ customerId?: string; /** * Maximum number of results to return. Default is 100. */ maxResults?: number; /** * Token to specify next page in the list. */ pageToken?: string; } class Resource$Transfers { constructor(); /** * datatransfer.transfers.get * @desc Retrieves a data transfer request by its resource ID. * @alias datatransfer.transfers.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.dataTransferId ID of the resource to be retrieved. This is returned in the response from the insert method. * @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$Transfers$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Transfers$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Transfers$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * datatransfer.transfers.insert * @desc Inserts a data transfer request. * @alias datatransfer.transfers.insert * @memberOf! () * * @param {object} params Parameters for request * @param {().DataTransfer} 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 */ insert(params?: Params$Resource$Transfers$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Transfers$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Transfers$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * datatransfer.transfers.list * @desc Lists the transfers for a customer by source user, destination * user, or status. * @alias datatransfer.transfers.list * @memberOf! () * * @param {object=} params Parameters for request * @param {string=} params.customerId Immutable ID of the Google Apps account. * @param {integer=} params.maxResults Maximum number of results to return. Default is 100. * @param {string=} params.newOwnerUserId Destination user's profile ID. * @param {string=} params.oldOwnerUserId Source user's profile ID. * @param {string=} params.pageToken Token to specify the next page in the list. * @param {string=} params.status Status of the transfer. * @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$Transfers$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Transfers$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Transfers$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Transfers$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * ID of the resource to be retrieved. This is returned in the response from * the insert method. */ dataTransferId?: string; } interface Params$Resource$Transfers$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Request body metadata */ requestBody?: Schema$DataTransfer; } interface Params$Resource$Transfers$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Immutable ID of the Google Apps account. */ customerId?: string; /** * Maximum number of results to return. Default is 100. */ maxResults?: number; /** * Destination user's profile ID. */ newOwnerUserId?: string; /** * Source user's profile ID. */ oldOwnerUserId?: string; /** * Token to specify the next page in the list. */ pageToken?: string; /** * Status of the transfer. */ status?: string; } }