@maxim_mazurok/gapi.client.dataportability-v1 0.0.20240308

package/index.d.ts

@@ -0,0 +1,260 @@
+/* Type definitions for non-npm package Data Portability API v1 0.0 */
+// Project: https://developers.google.com/data-portability
+// 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
+
+// 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://dataportability.googleapis.com/$discovery/rest?version=v1
+// Revision: 20240308
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+  /** Load Data Portability API v1 */
+  function load(
+    urlOrObject: 'https://dataportability.googleapis.com/$discovery/rest?version=v1'
+  ): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(name: 'dataportability', version: 'v1'): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(
+    name: 'dataportability',
+    version: 'v1',
+    callback: () => any
+  ): void;
+
+  namespace dataportability {
+    interface Empty {}
+    interface InitiatePortabilityArchiveRequest {
+      /** The resources from which you're exporting data. These values have a 1:1 correspondence with the OAuth scopes. */
+      resources?: string[];
+    }
+    interface InitiatePortabilityArchiveResponse {
+      /** The archive job ID that is initiated in the API. This can be used to get the state of the job. */
+      archiveJobId?: string;
+    }
+    interface PortabilityArchiveState {
+      /** The resource name of ArchiveJob's PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID provided in the request. */
+      name?: string;
+      /** Resource that represents the state of the Archive job. */
+      state?: string;
+      /** If the state is complete, this method returns the signed URLs of the objects in the Cloud Storage bucket. */
+      urls?: string[];
+    }
+    interface ResetAuthorizationRequest {}
+    interface RetryPortabilityArchiveRequest {}
+    interface RetryPortabilityArchiveResponse {
+      /** The archive job ID that is initiated by the retry endpoint. This can be used to get the state of the new job. */
+      archiveJobId?: string;
+    }
+    interface ArchiveJobsResource {
+      /** Retrieves the state of an Archive job for the Portability API. */
+      getPortabilityArchiveState(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;
+        /** Required. The archive job ID that is returned when you request the state of the job. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID returned by the InitiatePortabilityArchiveResponse. */
+        name: 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<PortabilityArchiveState>;
+      /** Retries a failed Portability Archive job. */
+      retry(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;
+        /** Required. The Archive job ID you're retrying. This is returned by the InitiatePortabilityArchiveResponse. Retrying is only executed if the initial job failed. */
+        name: 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: RetryPortabilityArchiveRequest;
+      }): Request<RetryPortabilityArchiveResponse>;
+      retry(
+        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;
+          /** Required. The Archive job ID you're retrying. This is returned by the InitiatePortabilityArchiveResponse. Retrying is only executed if the initial job failed. */
+          name: 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: RetryPortabilityArchiveRequest
+      ): Request<RetryPortabilityArchiveResponse>;
+    }
+    interface AuthorizationResource {
+      /** Revokes OAuth tokens and resets exhausted scopes for a user/project pair. This method allows you to initiate a request after a new consent is granted. This method also indicates that previous archives can be garbage collected. You should call this method when all jobs are complete and all archives are downloaded. Do not call it only when you start a new job. */
+      reset(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: ResetAuthorizationRequest;
+      }): Request<{}>;
+      reset(
+        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: ResetAuthorizationRequest
+      ): Request<{}>;
+    }
+    interface PortabilityArchiveResource {
+      /** Initiates a new Archive job for the Portability API. */
+      initiate(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: InitiatePortabilityArchiveRequest;
+      }): Request<InitiatePortabilityArchiveResponse>;
+      initiate(
+        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: InitiatePortabilityArchiveRequest
+      ): Request<InitiatePortabilityArchiveResponse>;
+    }
+
+    const archiveJobs: ArchiveJobsResource;
+
+    const authorization: AuthorizationResource;
+
+    const portabilityArchive: PortabilityArchiveResource;
+  }
+}

package/package.json

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

package/readme.md

@@ -0,0 +1,198 @@
+# TypeScript typings for Data Portability API v1
+
+The Data Portability API lets you build applications that request authorization from a user to move a copy of data from Google services into your application. This enables data portability and facilitates switching services.
+For detailed description please check [documentation](https://developers.google.com/data-portability).
+
+## Installing
+
+Install typings for Data Portability API:
+
+```
+npm install @types/gapi.client.dataportability-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://dataportability.googleapis.com/$discovery/rest?version=v1',
+  () => {
+    // now we can use:
+    // gapi.client.dataportability
+  }
+);
+```
+
+```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('dataportability', 'v1', () => {
+  // now we can use:
+  // gapi.client.dataportability
+});
+```
+
+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 = [
+    // Move a copy of messages between you and the businesses you have conversations with across Google services.
+    'https://www.googleapis.com/auth/dataportability.businessmessaging.conversations',
+
+    // Move a copy of the information you entered into online forms in Chrome.
+    'https://www.googleapis.com/auth/dataportability.chrome.autofill',
+
+    // Move a copy of pages you bookmarked in Chrome.
+    'https://www.googleapis.com/auth/dataportability.chrome.bookmarks',
+
+    // Move a copy of words you added to Chrome's dictionary.
+    'https://www.googleapis.com/auth/dataportability.chrome.dictionary',
+
+    // Move a copy of extensions you installed from the Chrome Web Store.
+    'https://www.googleapis.com/auth/dataportability.chrome.extensions',
+
+    // Move a copy of sites you visited in Chrome.
+    'https://www.googleapis.com/auth/dataportability.chrome.history',
+
+    // Move a copy of pages you added to your reading list in Chrome.
+    'https://www.googleapis.com/auth/dataportability.chrome.reading_list',
+
+    // Move a copy of your settings in Chrome.
+    'https://www.googleapis.com/auth/dataportability.chrome.settings',
+
+    // Move a copy of your pinned trips on Maps.
+    'https://www.googleapis.com/auth/dataportability.maps.commute_routes',
+
+    // Move a copy of your commute settings on Maps.
+    'https://www.googleapis.com/auth/dataportability.maps.commute_settings',
+
+    // Move a copy of your electric vehicle profile on Maps.
+    'https://www.googleapis.com/auth/dataportability.maps.ev_profile',
+
+    // Move a copy of your updates to places on Maps.
+    'https://www.googleapis.com/auth/dataportability.maps.offering_contributions',
+
+    // Move a copy of the photos and videos you posted on Maps.
+    'https://www.googleapis.com/auth/dataportability.maps.photos_videos',
+
+    // Move a copy of your reviews and posts on Maps.
+    'https://www.googleapis.com/auth/dataportability.maps.reviews',
+
+    // Move a copy of your Starred places list on Maps.
+    'https://www.googleapis.com/auth/dataportability.maps.starred_places',
+
+    // Move a copy of your Maps activity.
+    'https://www.googleapis.com/auth/dataportability.myactivity.maps',
+
+    // Move a copy of your Google Search activity.
+    'https://www.googleapis.com/auth/dataportability.myactivity.search',
+
+    // Move a copy of your Shopping activity.
+    'https://www.googleapis.com/auth/dataportability.myactivity.shopping',
+
+    // Move a copy of your YouTube activity.
+    'https://www.googleapis.com/auth/dataportability.myactivity.youtube',
+
+    // Move a copy of your saved links, images, places, and collections from your use of Google services.
+    'https://www.googleapis.com/auth/dataportability.saved.collections',
+
+    // Move a copy of your shipping information on Shopping.
+    'https://www.googleapis.com/auth/dataportability.shopping.addresses',
+
+    // Move a copy of reviews you wrote about products or online stores on Google Search.
+    'https://www.googleapis.com/auth/dataportability.shopping.reviews',
+
+    // Move a copy of information about your YouTube channel.
+    'https://www.googleapis.com/auth/dataportability.youtube.channel',
+
+    // Move a copy of your YouTube comments.
+    'https://www.googleapis.com/auth/dataportability.youtube.comments',
+
+    // Move a copy of your YouTube messages in live chat.
+    'https://www.googleapis.com/auth/dataportability.youtube.live_chat',
+
+    // Move a copy of your uploaded YouTube music tracks and your YouTube music library.
+    'https://www.googleapis.com/auth/dataportability.youtube.music',
+
+    // Move a copy of your YouTube playables saved game progress files.
+    'https://www.googleapis.com/auth/dataportability.youtube.playable',
+
+    // Move a copy of your YouTube posts.
+    'https://www.googleapis.com/auth/dataportability.youtube.posts',
+
+    // Move a copy of your YouTube private playlists.
+    'https://www.googleapis.com/auth/dataportability.youtube.private_playlists',
+
+    // Move a copy of your private YouTube videos and information about them.
+    'https://www.googleapis.com/auth/dataportability.youtube.private_videos',
+
+    // Move a copy of your public YouTube playlists.
+    'https://www.googleapis.com/auth/dataportability.youtube.public_playlists',
+
+    // Move a copy of your public YouTube videos and information about them.
+    'https://www.googleapis.com/auth/dataportability.youtube.public_videos',
+
+    // Move a copy of your YouTube shopping wishlists, and wishlist items.
+    'https://www.googleapis.com/auth/dataportability.youtube.shopping',
+
+    // Move a copy of your YouTube channel subscriptions, even if they're private.
+    'https://www.googleapis.com/auth/dataportability.youtube.subscriptions',
+
+    // Move a copy of your unlisted YouTube playlists.
+    'https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists',
+
+    // Move a copy of your unlisted YouTube videos and information about them.
+    'https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos',
+  ],
+  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 Data Portability API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+/*
+Retrieves the state of an Archive job for the Portability API.
+*/
+await gapi.client.dataportability.archiveJobs.getPortabilityArchiveState({
+  name: 'name',
+});
+
+/*
+Retries a failed Portability Archive job.
+*/
+await gapi.client.dataportability.archiveJobs.retry({name: 'name'});
+
+/*
+Revokes OAuth tokens and resets exhausted scopes for a user/project pair. This method allows you to initiate a request after a new consent is granted. This method also indicates that previous archives can be garbage collected. You should call this method when all jobs are complete and all archives are downloaded. Do not call it only when you start a new job.
+*/
+await gapi.client.dataportability.authorization.reset({});
+
+/*
+Initiates a new Archive job for the Portability API.
+*/
+await gapi.client.dataportability.portabilityArchive.initiate({});
+```