@maxim_mazurok/gapi.client.admin-datatransfer_v1 0.0.20220809

package/index.d.ts

@@ -0,0 +1,276 @@
+/* Type definitions for non-npm package Admin SDK API datatransfer_v1 0.0 */
+// Project: https://developers.google.com/admin-sdk/
+// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
+//                 Nick Amoscato <https://github.com/namoscato>
+//                 Declan Vong <https://github.com/declanvong>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.8
+
+// IMPORTANT
+// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
+// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
+// Generated from: https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1
+// Revision: 20220809
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+    /** Load Admin SDK API datatransfer_v1 */
+    function load(urlOrObject: "https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "admin", version: "datatransfer_v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "admin", version: "datatransfer_v1", callback: () => any): void;
+
+    namespace datatransfer {
+        interface 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 transferred. */
+            transferParams?: ApplicationTransferParam[];
+        }
+        interface ApplicationDataTransfer {
+            /** The application's ID. */
+            applicationId?: string;
+            /** The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. */
+            applicationTransferParams?: ApplicationTransferParam[];
+            /** Current status of transfer for this application. (Read-only) */
+            applicationTransferStatus?: string;
+        }
+        interface ApplicationsListResponse {
+            /** List of applications that support data transfer and are also installed for the customer. */
+            applications?: 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;
+        }
+        interface ApplicationTransferParam {
+            /** The type of the transfer parameter. eg: 'PRIVACY_LEVEL' */
+            key?: string;
+            /** The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED' */
+            value?: string[];
+        }
+        interface 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?: 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 transferred. */
+            newOwnerUserId?: string;
+            /** ID of the user whose data is being transferred. */
+            oldOwnerUserId?: string;
+            /** Overall transfer status (Read-only). */
+            overallTransferStatusCode?: string;
+            /** The time at which the data transfer was requested (Read-only). */
+            requestTime?: string;
+        }
+        interface DataTransfersListResponse {
+            /** List of data transfer requests. */
+            dataTransfers?: 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;
+        }
+        interface ApplicationsResource {
+            /** Retrieves information about an application for the given application ID. */
+            get(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** ID of the application resource to be retrieved. */
+                applicationId: 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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<Application>;
+            /** Lists the applications available for data transfer for a customer. */
+            list(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Immutable ID of the Google Workspace account. */
+                customerId?: 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;
+                /** Maximum number of results to return. Default is 100. */
+                maxResults?: number;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Token to specify next page in the list. */
+                pageToken?: 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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<ApplicationsListResponse>;
+        }
+        interface TransfersResource {
+            /** Retrieves a data transfer request by its resource ID. */
+            get(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** ID of the resource to be retrieved. This is returned in the response from the insert method. */
+                dataTransferId: 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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<DataTransfer>;
+            /** Inserts a data transfer request. */
+            insert(request: {
+                /** 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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+                /** Request body */
+                resource: DataTransfer;
+            }): Request<DataTransfer>;
+            insert(request: {
+                /** 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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            },
+            body: DataTransfer): Request<DataTransfer>;
+            /** Lists the transfers for a customer by source user, destination user, or status. */
+            list(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Immutable ID of the Google Workspace account. */
+                customerId?: 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;
+                /** Maximum number of results to return. Default is 100. */
+                maxResults?: number;
+                /** Destination user's profile ID. */
+                newOwnerUserId?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Source user's profile ID. */
+                oldOwnerUserId?: string;
+                /** Token to specify the next page in the list. */
+                pageToken?: 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;
+                /** Status of the transfer. */
+                status?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<DataTransfersListResponse>;
+        }
+
+        const applications: ApplicationsResource;
+
+        const transfers: TransfersResource;
+    }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.admin-datatransfer_v1",
+  "version": "0.0.20220809",
+  "description": "TypeScript typings for Admin SDK API datatransfer_v1",
+  "license": "MIT",
+  "author": {
+    "email": "maxim@mazurok.com",
+    "name": "Maxim Mazurok",
+    "url": "https://maxim.mazurok.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
+  "types": "index.d.ts",
+  "dependencies": {
+    "@types/gapi.client": "*",
+    "@types/gapi.client.discovery": "*"
+  }
+}

package/readme.md

@@ -0,0 +1,96 @@
+# TypeScript typings for Admin SDK API datatransfer_v1
+
+Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.
+For detailed description please check [documentation](https://developers.google.com/admin-sdk/).
+
+## Installing
+
+Install typings for Admin SDK API:
+
+```
+npm install @types/gapi.client.admin-datatransfer_v1 --save-dev
+```
+
+## Usage
+
+You need to initialize Google API client in your code:
+
+```typescript
+gapi.load('client', () => {
+  // now we can use gapi.client
+  // ...
+});
+```
+
+Then load api client wrapper:
+
+```typescript
+gapi.client.load('https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1', () => {
+  // now we can use:
+  // gapi.client.datatransfer
+});
+```
+
+```typescript
+// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
+gapi.client.load('admin', 'datatransfer_v1', () => {
+  // now we can use:
+  // gapi.client.datatransfer
+});
+```
+
+Don't forget to authenticate your client before sending any request to resources:
+
+```typescript
+// declare client_id registered in Google Developers Console
+var client_id = '',
+  scope = [
+      // View and manage data transfers between users in your organization
+      'https://www.googleapis.com/auth/admin.datatransfer',
+
+      // View data transfers between users in your organization
+      'https://www.googleapis.com/auth/admin.datatransfer.readonly',
+    ],
+    immediate = true;
+// ...
+
+gapi.auth.authorize(
+  { client_id: client_id, scope: scope, immediate: immediate },
+  authResult => {
+    if (authResult && !authResult.error) {
+        /* handle successful authorization */
+    } else {
+        /* handle authorization error */
+    }
+});
+```
+
+After that you can use Admin SDK API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+/*
+Retrieves information about an application for the given application ID.
+*/
+await gapi.client.datatransfer.applications.get({ applicationId: "applicationId",  });
+
+/*
+Lists the applications available for data transfer for a customer.
+*/
+await gapi.client.datatransfer.applications.list({  });
+
+/*
+Retrieves a data transfer request by its resource ID.
+*/
+await gapi.client.datatransfer.transfers.get({ dataTransferId: "dataTransferId",  });
+
+/*
+Inserts a data transfer request.
+*/
+await gapi.client.datatransfer.transfers.insert({  });
+
+/*
+Lists the transfers for a customer by source user, destination user, or status.
+*/
+await gapi.client.datatransfer.transfers.list({  });
+```

package/tests.ts

@@ -0,0 +1,83 @@
+/* This is stub file for gapi.client.admin-datatransfer_v1 definition tests */
+// IMPORTANT
+// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
+// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
+
+// Revision: 20220809
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1');
+    /** now we can use gapi.client.datatransfer */
+
+    /** don't forget to authenticate your client before sending any request to resources: */
+    /** declare client_id registered in Google Developers Console */
+    const client_id = '<<PUT YOUR CLIENT ID HERE>>';
+    const scope = [
+        /** View and manage data transfers between users in your organization */
+        'https://www.googleapis.com/auth/admin.datatransfer',
+        /** View data transfers between users in your organization */
+        'https://www.googleapis.com/auth/admin.datatransfer.readonly',
+    ];
+    const immediate = false;
+    gapi.auth.authorize({ client_id, scope, immediate }, authResult => {
+        if (authResult && !authResult.error) {
+            /** handle successful authorization */
+            run();
+        } else {
+            /** handle authorization error */
+        }
+    });
+
+    async function run() {
+        /** Retrieves information about an application for the given application ID. */
+        await gapi.client.datatransfer.applications.get({
+            applicationId: "Test string",
+        });
+        /** Lists the applications available for data transfer for a customer. */
+        await gapi.client.datatransfer.applications.list({
+            customerId: "Test string",
+            maxResults: 42,
+            pageToken: "Test string",
+        });
+        /** Retrieves a data transfer request by its resource ID. */
+        await gapi.client.datatransfer.transfers.get({
+            dataTransferId: "Test string",
+        });
+        /** Inserts a data transfer request. */
+        await gapi.client.datatransfer.transfers.insert({
+        }, {
+            applicationDataTransfers: [
+                {
+                    applicationId: "Test string",
+                    applicationTransferParams: [
+                        {
+                            key: "Test string",
+                            value: [
+                                "Test string"
+                            ],
+                        }
+                    ],
+                    applicationTransferStatus: "Test string",
+                }
+            ],
+            etag: "Test string",
+            id: "Test string",
+            kind: "Test string",
+            newOwnerUserId: "Test string",
+            oldOwnerUserId: "Test string",
+            overallTransferStatusCode: "Test string",
+            requestTime: "Test string",
+        });
+        /** Lists the transfers for a customer by source user, destination user, or status. */
+        await gapi.client.datatransfer.transfers.list({
+            customerId: "Test string",
+            maxResults: 42,
+            newOwnerUserId: "Test string",
+            oldOwnerUserId: "Test string",
+            pageToken: "Test string",
+            status: "Test string",
+        });
+    }
+});

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": ["es6", "dom"],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true,
+        "strictFunctionTypes": true
+    },
+    "files": ["index.d.ts", "tests.ts"]
+}

package/tslint.json

@@ -0,0 +1,6 @@
+{
+    "extends": "dtslint/dtslint.json",
+    "rules": {
+        "no-redundant-jsdoc": false
+    }
+}