datatransfer_v1.ts

/**
 * Copyright 2015 Google Inc. All Rights Reserved.
 *
 * 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 {AxiosPromise} from 'axios';
import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library';

import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common';

// tslint:disable: no-any
// tslint:disable: class-name
// tslint:disable: variable-name
// tslint:disable: jsdoc-format
// tslint:disable: no-namespace

export namespace admin_datatransfer_v1 {
  export interface Options extends GlobalOptions {
    version: 'datatransfer_v1';
  }

  /**
   * 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
   */
  export class Admin {
    _options: GlobalOptions;
    google?: GoogleConfigurable;
    root = this;

    applications: Resource$Applications;
    transfers: Resource$Transfers;

    constructor(options: GlobalOptions, google?: GoogleConfigurable) {
      this._options = options || {};
      this.google = google;
      this.getRoot.bind(this);

      this.applications = new Resource$Applications(this);
      this.transfers = new Resource$Transfers(this);
    }

    getRoot() {
      return this.root;
    }
  }

  /**
   * The JSON template for an Application resource.
   */
  export 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.
   */
  export 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.
   */
  export 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.
   */
  export 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.
   */
  export 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.
   */
  export 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;
  }


  export class Resource$Applications {
    root: Admin;
    constructor(root: Admin) {
      this.root = root;
      this.getRoot.bind(this);
    }

    getRoot() {
      return this.root;
    }


    /**
     * 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): AxiosPromise<Schema$Application>;
    get(params: Params$Resource$Applications$Get,
        options: MethodOptions|BodyResponseCallback<Schema$Application>,
        callback: BodyResponseCallback<Schema$Application>): void;
    get(params: Params$Resource$Applications$Get,
        callback: BodyResponseCallback<Schema$Application>): void;
    get(callback: BodyResponseCallback<Schema$Application>): void;
    get(paramsOrCallback?: Params$Resource$Applications$Get|
        BodyResponseCallback<Schema$Application>,
        optionsOrCallback?: MethodOptions|
        BodyResponseCallback<Schema$Application>,
        callback?: BodyResponseCallback<Schema$Application>):
        void|AxiosPromise<Schema$Application> {
      let params = (paramsOrCallback || {}) as Params$Resource$Applications$Get;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Applications$Get;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
      const parameters = {
        options: Object.assign(
            {
              url: (rootUrl +
                    '/admin/datatransfer/v1/applications/{applicationId}')
                       .replace(/([^:]\/)\/+/g, '$1'),
              method: 'GET'
            },
            options),
        params,
        requiredParams: ['applicationId'],
        pathParams: ['applicationId'],
        context: this.getRoot()
      };
      if (callback) {
        createAPIRequest<Schema$Application>(parameters, callback);
      } else {
        return createAPIRequest<Schema$Application>(parameters);
      }
    }


    /**
     * 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):
        AxiosPromise<Schema$ApplicationsListResponse>;
    list(
        params: Params$Resource$Applications$List,
        options: MethodOptions|
        BodyResponseCallback<Schema$ApplicationsListResponse>,
        callback: BodyResponseCallback<Schema$ApplicationsListResponse>): void;
    list(
        params: Params$Resource$Applications$List,
        callback: BodyResponseCallback<Schema$ApplicationsListResponse>): void;
    list(callback: BodyResponseCallback<Schema$ApplicationsListResponse>): void;
    list(
        paramsOrCallback?: Params$Resource$Applications$List|
        BodyResponseCallback<Schema$ApplicationsListResponse>,
        optionsOrCallback?: MethodOptions|
        BodyResponseCallback<Schema$ApplicationsListResponse>,
        callback?: BodyResponseCallback<Schema$ApplicationsListResponse>):
        void|AxiosPromise<Schema$ApplicationsListResponse> {
      let params =
          (paramsOrCallback || {}) as Params$Resource$Applications$List;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Applications$List;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
      const parameters = {
        options: Object.assign(
            {
              url: (rootUrl + '/admin/datatransfer/v1/applications')
                       .replace(/([^:]\/)\/+/g, '$1'),
              method: 'GET'
            },
            options),
        params,
        requiredParams: [],
        pathParams: [],
        context: this.getRoot()
      };
      if (callback) {
        createAPIRequest<Schema$ApplicationsListResponse>(parameters, callback);
      } else {
        return createAPIRequest<Schema$ApplicationsListResponse>(parameters);
      }
    }
  }

  export interface Params$Resource$Applications$Get {
    /**
     * Auth client or API Key for the request
     */
    auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient;

    /**
     * ID of the application resource to be retrieved.
     */
    applicationId?: string;
  }
  export interface Params$Resource$Applications$List {
    /**
     * 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;
  }


  export class Resource$Transfers {
    root: Admin;
    constructor(root: Admin) {
      this.root = root;
      this.getRoot.bind(this);
    }

    getRoot() {
      return this.root;
    }


    /**
     * 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): AxiosPromise<Schema$DataTransfer>;
    get(params: Params$Resource$Transfers$Get,
        options: MethodOptions|BodyResponseCallback<Schema$DataTransfer>,
        callback: BodyResponseCallback<Schema$DataTransfer>): void;
    get(params: Params$Resource$Transfers$Get,
        callback: BodyResponseCallback<Schema$DataTransfer>): void;
    get(callback: BodyResponseCallback<Schema$DataTransfer>): void;
    get(paramsOrCallback?: Params$Resource$Transfers$Get|
        BodyResponseCallback<Schema$DataTransfer>,
        optionsOrCallback?: MethodOptions|
        BodyResponseCallback<Schema$DataTransfer>,
        callback?: BodyResponseCallback<Schema$DataTransfer>):
        void|AxiosPromise<Schema$DataTransfer> {
      let params = (paramsOrCallback || {}) as Params$Resource$Transfers$Get;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Transfers$Get;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
      const parameters = {
        options: Object.assign(
            {
              url: (rootUrl +
                    '/admin/datatransfer/v1/transfers/{dataTransferId}')
                       .replace(/([^:]\/)\/+/g, '$1'),
              method: 'GET'
            },
            options),
        params,
        requiredParams: ['dataTransferId'],
        pathParams: ['dataTransferId'],
        context: this.getRoot()
      };
      if (callback) {
        createAPIRequest<Schema$DataTransfer>(parameters, callback);
      } else {
        return createAPIRequest<Schema$DataTransfer>(parameters);
      }
    }


    /**
     * 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):
        AxiosPromise<Schema$DataTransfer>;
    insert(
        params: Params$Resource$Transfers$Insert,
        options: MethodOptions|BodyResponseCallback<Schema$DataTransfer>,
        callback: BodyResponseCallback<Schema$DataTransfer>): void;
    insert(
        params: Params$Resource$Transfers$Insert,
        callback: BodyResponseCallback<Schema$DataTransfer>): void;
    insert(callback: BodyResponseCallback<Schema$DataTransfer>): void;
    insert(
        paramsOrCallback?: Params$Resource$Transfers$Insert|
        BodyResponseCallback<Schema$DataTransfer>,
        optionsOrCallback?: MethodOptions|
        BodyResponseCallback<Schema$DataTransfer>,
        callback?: BodyResponseCallback<Schema$DataTransfer>):
        void|AxiosPromise<Schema$DataTransfer> {
      let params = (paramsOrCallback || {}) as Params$Resource$Transfers$Insert;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Transfers$Insert;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
      const parameters = {
        options: Object.assign(
            {
              url: (rootUrl + '/admin/datatransfer/v1/transfers')
                       .replace(/([^:]\/)\/+/g, '$1'),
              method: 'POST'
            },
            options),
        params,
        requiredParams: [],
        pathParams: [],
        context: this.getRoot()
      };
      if (callback) {
        createAPIRequest<Schema$DataTransfer>(parameters, callback);
      } else {
        return createAPIRequest<Schema$DataTransfer>(parameters);
      }
    }


    /**
     * 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):
        AxiosPromise<Schema$DataTransfersListResponse>;
    list(
        params: Params$Resource$Transfers$List,
        options: MethodOptions|
        BodyResponseCallback<Schema$DataTransfersListResponse>,
        callback: BodyResponseCallback<Schema$DataTransfersListResponse>): void;
    list(
        params: Params$Resource$Transfers$List,
        callback: BodyResponseCallback<Schema$DataTransfersListResponse>): void;
    list(callback: BodyResponseCallback<Schema$DataTransfersListResponse>):
        void;
    list(
        paramsOrCallback?: Params$Resource$Transfers$List|
        BodyResponseCallback<Schema$DataTransfersListResponse>,
        optionsOrCallback?: MethodOptions|
        BodyResponseCallback<Schema$DataTransfersListResponse>,
        callback?: BodyResponseCallback<Schema$DataTransfersListResponse>):
        void|AxiosPromise<Schema$DataTransfersListResponse> {
      let params = (paramsOrCallback || {}) as Params$Resource$Transfers$List;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Transfers$List;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
      const parameters = {
        options: Object.assign(
            {
              url: (rootUrl + '/admin/datatransfer/v1/transfers')
                       .replace(/([^:]\/)\/+/g, '$1'),
              method: 'GET'
            },
            options),
        params,
        requiredParams: [],
        pathParams: [],
        context: this.getRoot()
      };
      if (callback) {
        createAPIRequest<Schema$DataTransfersListResponse>(
            parameters, callback);
      } else {
        return createAPIRequest<Schema$DataTransfersListResponse>(parameters);
      }
    }
  }

  export interface Params$Resource$Transfers$Get {
    /**
     * 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;
  }
  export interface Params$Resource$Transfers$Insert {
    /**
     * Auth client or API Key for the request
     */
    auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient;


    /**
     * Request body metadata
     */
    requestBody?: Schema$DataTransfer;
  }
  export interface Params$Resource$Transfers$List {
    /**
     * 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;
  }
}