@maxim_mazurok/gapi.client.versionhistory-v1 0.0.20220808

package/index.d.ts

@@ -0,0 +1,259 @@
+/* Type definitions for non-npm package Version History API v1 0.0 */
+// Project: https://developers.chrome.com/versionhistory
+// 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://versionhistory.googleapis.com/$discovery/rest?version=v1
+// Revision: 20220808
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+    /** Load Version History API v1 */
+    function load(urlOrObject: "https://versionhistory.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "versionhistory", version: "v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "versionhistory", version: "v1", callback: () => any): void;
+
+    namespace versionhistory {
+        interface Channel {
+            /** Type of channel. */
+            channelType?: string;
+            /** Channel name. Format is "{product}/platforms/{platform}/channels/{channel}" */
+            name?: string;
+        }
+        interface Interval {
+            /** Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. */
+            endTime?: string;
+            /** Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. */
+            startTime?: string;
+        }
+        interface ListChannelsResponse {
+            /** The list of channels. */
+            channels?: Channel[];
+            /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+            nextPageToken?: string;
+        }
+        interface ListPlatformsResponse {
+            /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+            nextPageToken?: string;
+            /** The list of platforms. */
+            platforms?: Platform[];
+        }
+        interface ListReleasesResponse {
+            /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+            nextPageToken?: string;
+            /** The list of releases. */
+            releases?: Release[];
+        }
+        interface ListVersionsResponse {
+            /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+            nextPageToken?: string;
+            /** The list of versions. */
+            versions?: Version[];
+        }
+        interface Platform {
+            /** Platform name. Format is "{product}/platforms/{platform}" */
+            name?: string;
+            /** Type of platform. */
+            platformType?: string;
+        }
+        interface Release {
+            /**
+             * Rollout fraction. This fraction indicates the fraction of people that should receive this version in this release. If the fraction is not specified in ReleaseManager, the API will
+             * assume fraction is 1.
+             */
+            fraction?: number;
+            /** Rollout fraction group. Only fractions with the same fraction_group are statistically comparable: there may be non-fractional differences between different fraction groups. */
+            fractionGroup?: string;
+            /** Release name. Format is "{product}/platforms/{platform}/channels/{channel}/versions/{version}/releases/{release}" */
+            name?: string;
+            /** Timestamp interval of when the release was live. If end_time is unspecified, the release is currently live. */
+            serving?: Interval;
+            /** String containing just the version number. e.g. "84.0.4147.38" */
+            version?: string;
+        }
+        interface Version {
+            /** Version name. Format is "{product}/platforms/{platform}/channels/{channel}/versions/{version}" e.g. "chrome/platforms/win/channels/beta/versions/84.0.4147.38" */
+            name?: string;
+            /** String containing just the version number. e.g. "84.0.4147.38" */
+            version?: string;
+        }
+        interface ReleasesResource {
+            /** Returns list of releases of the given version. */
+            list(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;
+                /**
+                 * Optional. Filter string. Format is a comma separated list of All comma separated filter clauses are conjoined with a logical "and". Valid field_names are "version", "name",
+                 * "platform", "channel", "fraction" "starttime", and "endtime". Valid operators are "<", "<=", "=", ">=", and ">". Channel comparison is done by distance from stable. must be a
+                 * valid channel when filtering by channel. Ex) stable < beta, beta < dev, canary < canary_asan. Version comparison is done numerically. Ex) 1.0.0.8 < 1.0.0.10. If version is not
+                 * entirely written, the version will be appended with 0 for the missing fields. Ex) version > 80 becoms version > 80.0.0.0 When filtering by starttime or endtime, string must be
+                 * in RFC 3339 date string format. Name and platform are filtered by string comparison. Ex) "...?filter=channel<=beta, version >= 80 Ex) "...?filter=version > 80, version < 81 Ex)
+                 * "...?filter=starttime>2020-01-01T00:00:00Z
+                 */
+                filter?: 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;
+                /**
+                 * Optional. Ordering string. Valid order_by strings are "version", "name", "starttime", "endtime", "platform", "channel", and "fraction". Optionally, you can append "desc" or
+                 * "asc" to specify the sorting order. Multiple order_by strings can be used in a comma separated list. Ordering by channel will sort by distance from the stable channel (not
+                 * alphabetically). A list of channels sorted in this order is: stable, beta, dev, canary, and canary_asan. Sorting by name may cause unexpected behaviour as it is a naive string
+                 * sort. For example, 1.0.0.8 will be before 1.0.0.10 in descending order. If order_by is not specified the response will be sorted by starttime in descending order. Ex)
+                 * "...?order_by=starttime asc" Ex) "...?order_by=platform desc, channel, startime desc"
+                 */
+                orderBy?: string;
+                /** Optional. Optional limit on the number of releases to include in the response. If unspecified, the server will pick an appropriate default. */
+                pageSize?: number;
+                /** Optional. A page token, received from a previous `ListReleases` call. Provide this to retrieve the subsequent page. */
+                pageToken?: string;
+                /** Required. The version, which owns this collection of releases. Format: {product}/platforms/{platform}/channels/{channel}/versions/{version} */
+                parent: 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<ListReleasesResponse>;
+        }
+        interface VersionsResource {
+            /** Returns list of version for the given platform/channel. */
+            list(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;
+                /**
+                 * Optional. Filter string. Format is a comma separated list of All comma separated filter clauses are conjoined with a logical "and". Valid field_names are "version", "name",
+                 * "platform", and "channel". Valid operators are "<", "<=", "=", ">=", and ">". Channel comparison is done by distance from stable. Ex) stable < beta, beta < dev, canary <
+                 * canary_asan. Version comparison is done numerically. If version is not entirely written, the version will be appended with 0 in missing fields. Ex) version > 80 becoms version >
+                 * 80.0.0.0 Name and platform are filtered by string comparison. Ex) "...?filter=channel<=beta, version >= 80 Ex) "...?filter=version > 80, version < 81
+                 */
+                filter?: 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;
+                /**
+                 * Optional. Ordering string. Valid order_by strings are "version", "name", "platform", and "channel". Optionally, you can append " desc" or " asc" to specify the sorting order.
+                 * Multiple order_by strings can be used in a comma separated list. Ordering by channel will sort by distance from the stable channel (not alphabetically). A list of channels
+                 * sorted in this order is: stable, beta, dev, canary, and canary_asan. Sorting by name may cause unexpected behaviour as it is a naive string sort. For example, 1.0.0.8 will be
+                 * before 1.0.0.10 in descending order. If order_by is not specified the response will be sorted by version in descending order. Ex) "...?order_by=version asc" Ex)
+                 * "...?order_by=platform desc, channel, version"
+                 */
+                orderBy?: string;
+                /** Optional. Optional limit on the number of versions to include in the response. If unspecified, the server will pick an appropriate default. */
+                pageSize?: number;
+                /** Optional. A page token, received from a previous `ListVersions` call. Provide this to retrieve the subsequent page. */
+                pageToken?: string;
+                /** Required. The channel, which owns this collection of versions. Format: {product}/platforms/{platform}/channels/{channel} */
+                parent: 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<ListVersionsResponse>;
+            releases: ReleasesResource;
+        }
+        interface ChannelsResource {
+            /** Returns list of channels that are available for a given platform. */
+            list(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;
+                /** Optional. Optional limit on the number of channels to include in the response. If unspecified, the server will pick an appropriate default. */
+                pageSize?: number;
+                /** Optional. A page token, received from a previous `ListChannels` call. Provide this to retrieve the subsequent page. */
+                pageToken?: string;
+                /** Required. The platform, which owns this collection of channels. Format: {product}/platforms/{platform} */
+                parent: 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<ListChannelsResponse>;
+            versions: VersionsResource;
+        }
+        interface PlatformsResource {
+            /** Returns list of platforms that are available for a given product. The resource "product" has no resource name in its name. */
+            list(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;
+                /** Optional. Optional limit on the number of channels to include in the response. If unspecified, the server will pick an appropriate default. */
+                pageSize?: number;
+                /** Optional. A page token, received from a previous `ListChannels` call. Provide this to retrieve the subsequent page. */
+                pageToken?: string;
+                /** Required. The product, which owns this collection of platforms. Format: {product} */
+                parent: 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<ListPlatformsResponse>;
+            channels: ChannelsResource;
+        }
+
+        const platforms: PlatformsResource;
+    }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.versionhistory-v1",
+  "version": "0.0.20220808",
+  "description": "TypeScript typings for Version History API 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,52 @@
+# TypeScript typings for Version History API v1
+
+Version History API - Prod
+For detailed description please check [documentation](https://developers.chrome.com/versionhistory).
+
+## Installing
+
+Install typings for Version History API:
+
+```
+npm install @types/gapi.client.versionhistory-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://versionhistory.googleapis.com/$discovery/rest?version=v1', () => {
+  // now we can use:
+  // gapi.client.versionhistory
+});
+```
+
+```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('versionhistory', 'v1', () => {
+  // now we can use:
+  // gapi.client.versionhistory
+});
+```
+
+
+
+After that you can use Version History API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+/*
+Returns list of platforms that are available for a given product. The resource "product" has no resource name in its name.
+*/
+await gapi.client.versionhistory.platforms.list({ parent: "parent",  });
+```

package/tests.ts

@@ -0,0 +1,46 @@
+/* This is stub file for gapi.client.versionhistory-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: 20220808
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://versionhistory.googleapis.com/$discovery/rest?version=v1');
+    /** now we can use gapi.client.versionhistory */
+
+    run();
+
+    async function run() {
+        /** Returns list of platforms that are available for a given product. The resource "product" has no resource name in its name. */
+        await gapi.client.versionhistory.platforms.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Returns list of channels that are available for a given platform. */
+        await gapi.client.versionhistory.platforms.channels.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Returns list of version for the given platform/channel. */
+        await gapi.client.versionhistory.platforms.channels.versions.list({
+            filter: "Test string",
+            orderBy: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Returns list of releases of the given version. */
+        await gapi.client.versionhistory.platforms.channels.versions.releases.list({
+            filter: "Test string",
+            orderBy: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "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
+    }
+}