@maxim_mazurok/gapi.client.acceleratedmobilepageurl-v1 0.0.20220809

package/index.d.ts

@@ -0,0 +1,114 @@
+/* Type definitions for non-npm package Accelerated Mobile Pages (AMP) URL API v1 0.0 */
+// Project: https://developers.google.com/amp/cache/
+// 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://acceleratedmobilepageurl.googleapis.com/$discovery/rest?version=v1
+// Revision: 20220809
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+    /** Load Accelerated Mobile Pages (AMP) URL API v1 */
+    function load(urlOrObject: "https://acceleratedmobilepageurl.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "acceleratedmobilepageurl", version: "v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "acceleratedmobilepageurl", version: "v1", callback: () => any): void;
+
+    namespace acceleratedmobilepageurl {
+        interface AmpUrl {
+            /** The AMP URL pointing to the publisher's web server. */
+            ampUrl?: string;
+            /** The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to the cached document in the Google AMP Cache. */
+            cdnAmpUrl?: string;
+            /** The original non-AMP URL. */
+            originalUrl?: string;
+        }
+        interface AmpUrlError {
+            /** The error code of an API call. */
+            errorCode?: string;
+            /** An optional descriptive error message. */
+            errorMessage?: string;
+            /** The original non-AMP URL. */
+            originalUrl?: string;
+        }
+        interface BatchGetAmpUrlsRequest {
+            /** The lookup_strategy being requested. */
+            lookupStrategy?: string;
+            /** List of URLs to look up for the paired AMP URLs. The URLs are case-sensitive. Up to 50 URLs per lookup (see [Usage Limits](/amp/cache/reference/limits)). */
+            urls?: string[];
+        }
+        interface BatchGetAmpUrlsResponse {
+            /**
+             * For each URL in BatchAmpUrlsRequest, the URL response. The response might not be in the same order as URLs in the batch request. If BatchAmpUrlsRequest contains duplicate URLs,
+             * AmpUrl is generated only once.
+             */
+            ampUrls?: AmpUrl[];
+            /** The errors for requested URLs that have no AMP URL. */
+            urlErrors?: AmpUrlError[];
+        }
+        interface AmpUrlsResource {
+            /** Returns AMP URL(s) and equivalent [AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format). */
+            batchGet(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: BatchGetAmpUrlsRequest;
+            }): Request<BatchGetAmpUrlsResponse>;
+            batchGet(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: BatchGetAmpUrlsRequest): Request<BatchGetAmpUrlsResponse>;
+        }
+
+        const ampUrls: AmpUrlsResource;
+    }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.acceleratedmobilepageurl-v1",
+  "version": "0.0.20220809",
+  "description": "TypeScript typings for Accelerated Mobile Pages (AMP) URL 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 Accelerated Mobile Pages (AMP) URL API v1
+
+Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s). 
+For detailed description please check [documentation](https://developers.google.com/amp/cache/).
+
+## Installing
+
+Install typings for Accelerated Mobile Pages (AMP) URL API:
+
+```
+npm install @types/gapi.client.acceleratedmobilepageurl-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://acceleratedmobilepageurl.googleapis.com/$discovery/rest?version=v1', () => {
+  // now we can use:
+  // gapi.client.acceleratedmobilepageurl
+});
+```
+
+```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('acceleratedmobilepageurl', 'v1', () => {
+  // now we can use:
+  // gapi.client.acceleratedmobilepageurl
+});
+```
+
+
+
+After that you can use Accelerated Mobile Pages (AMP) URL API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+/*
+Returns AMP URL(s) and equivalent [AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).
+*/
+await gapi.client.acceleratedmobilepageurl.ampUrls.batchGet({  });
+```

package/tests.ts

@@ -0,0 +1,26 @@
+/* This is stub file for gapi.client.acceleratedmobilepageurl-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://acceleratedmobilepageurl.googleapis.com/$discovery/rest?version=v1');
+    /** now we can use gapi.client.acceleratedmobilepageurl */
+
+    run();
+
+    async function run() {
+        /** Returns AMP URL(s) and equivalent [AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format). */
+        await gapi.client.acceleratedmobilepageurl.ampUrls.batchGet({
+        }, {
+            lookupStrategy: "Test string",
+            urls: [
+                "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
+    }
+}