@maxim_mazurok/gapi.client.indexing-v3 0.0.20220726

package/index.d.ts

@@ -0,0 +1,133 @@
+/* Type definitions for non-npm package Indexing API v3 0.0 */
+// Project: https://developers.google.com/search/apis/indexing-api/
+// 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://indexing.googleapis.com/$discovery/rest?version=v3
+// Revision: 20220726
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+    /** Load Indexing API v3 */
+    function load(urlOrObject: "https://indexing.googleapis.com/$discovery/rest?version=v3"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "indexing", version: "v3"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "indexing", version: "v3", callback: () => any): void;
+
+    namespace indexing {
+        interface PublishUrlNotificationResponse {
+            /** Description of the notification events received for this URL. */
+            urlNotificationMetadata?: UrlNotificationMetadata;
+        }
+        interface UrlNotification {
+            /** Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time. */
+            notifyTime?: string;
+            /** The URL life cycle event that Google is being notified about. */
+            type?: string;
+            /** The object of this notification. The URL must be owned by the publisher of this notification and, in case of `URL_UPDATED` notifications, it _must_ be crawlable by Google. */
+            url?: string;
+        }
+        interface UrlNotificationMetadata {
+            /** Latest notification received with type `URL_REMOVED`. */
+            latestRemove?: UrlNotification;
+            /** Latest notification received with type `URL_UPDATED`. */
+            latestUpdate?: UrlNotification;
+            /** URL to which this metadata refers. */
+            url?: string;
+        }
+        interface UrlNotificationsResource {
+            /**
+             * Gets metadata about a Web Document. This method can _only_ be used to query URLs that were previously seen in successful Indexing API notifications. Includes the latest
+             * `UrlNotification` received via this API.
+             */
+            getMetadata(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;
+                /** URL that is being queried. */
+                url?: string;
+            }): Request<UrlNotificationMetadata>;
+            /** Notifies that a URL has been updated or deleted. */
+            publish(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: UrlNotification;
+            }): Request<PublishUrlNotificationResponse>;
+            publish(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: UrlNotification): Request<PublishUrlNotificationResponse>;
+        }
+
+        const urlNotifications: UrlNotificationsResource;
+    }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.indexing-v3",
+  "version": "0.0.20220726",
+  "description": "TypeScript typings for Indexing API v3",
+  "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,78 @@
+# TypeScript typings for Indexing API v3
+
+Notifies Google when your web pages change.
+For detailed description please check [documentation](https://developers.google.com/search/apis/indexing-api/).
+
+## Installing
+
+Install typings for Indexing API:
+
+```
+npm install @types/gapi.client.indexing-v3 --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://indexing.googleapis.com/$discovery/rest?version=v3', () => {
+  // now we can use:
+  // gapi.client.indexing
+});
+```
+
+```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('indexing', 'v3', () => {
+  // now we can use:
+  // gapi.client.indexing
+});
+```
+
+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 = [
+      // Submit data to Google for indexing
+      'https://www.googleapis.com/auth/indexing',
+    ],
+    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 Indexing API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+/*
+Gets metadata about a Web Document. This method can _only_ be used to query URLs that were previously seen in successful Indexing API notifications. Includes the latest `UrlNotification` received via this API.
+*/
+await gapi.client.indexing.urlNotifications.getMetadata({  });
+
+/*
+Notifies that a URL has been updated or deleted.
+*/
+await gapi.client.indexing.urlNotifications.publish({  });
+```

package/tests.ts

@@ -0,0 +1,47 @@
+/* This is stub file for gapi.client.indexing-v3 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: 20220726
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://indexing.googleapis.com/$discovery/rest?version=v3');
+    /** now we can use gapi.client.indexing */
+
+    /** 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 = [
+        /** Submit data to Google for indexing */
+        'https://www.googleapis.com/auth/indexing',
+    ];
+    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() {
+        /**
+         * Gets metadata about a Web Document. This method can _only_ be used to query URLs that were previously seen in successful Indexing API notifications. Includes the latest
+         * `UrlNotification` received via this API.
+         */
+        await gapi.client.indexing.urlNotifications.getMetadata({
+            url: "Test string",
+        });
+        /** Notifies that a URL has been updated or deleted. */
+        await gapi.client.indexing.urlNotifications.publish({
+        }, {
+            notifyTime: "Test string",
+            type: "Test string",
+            url: "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
+    }
+}