@maxim_mazurok/gapi.client.readerrevenuesubscriptionlinking-v1 0.0.20230409

package/index.d.ts

@@ -0,0 +1,217 @@
+/* Type definitions for non-npm package Reader Revenue Subscription Linking API v1 0.0 */
+// Project: https://developers.google.com/news/subscribe/subscription-linking/overview
+// 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://readerrevenuesubscriptionlinking.googleapis.com/$discovery/rest?version=v1
+// Revision: 20230409
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+    /** Load Reader Revenue Subscription Linking API v1 */
+    function load(urlOrObject: "https://readerrevenuesubscriptionlinking.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "readerrevenuesubscriptionlinking", version: "v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "readerrevenuesubscriptionlinking", version: "v1", callback: () => any): void;
+
+    namespace readerrevenuesubscriptionlinking {
+        // tslint:disable-next-line:no-empty-interface
+        interface DeleteReaderResponse {
+        }
+        interface Entitlement {
+            /**
+             * The detail field can carry a description of the SKU that corresponds to what the user has been granted access to. This description, which is opaque to Google, can be displayed in
+             * the Google user subscription console for users who linked the subscription to a Google Account. Max 80 character limit.
+             */
+            detail?: string;
+            /**
+             * Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. Required. LINT.IfChange(expire_time) The max expire_time is 398 days from
+             * now(). LINT.ThenChange(//depot/google3/java/com/google/subscribewithgoogle/accountlinking/subscriptionlink/service/config/protoconf.pi:max_expiry_age)
+             */
+            expireTime?: string;
+            /**
+             * Required. The publication's product ID that the user has access to. This is the same product ID as can be found in Schema.org markup (http://schema.org/productID). E.g.
+             * "dailybugle.com:basic"
+             */
+            productId?: string;
+            /** A source-specific subscription token. This is an opaque string that the publisher provides to Google. This token is opaque and has no meaning to Google. */
+            subscriptionToken?: string;
+        }
+        interface Reader {
+            /** Output only. Time the publication reader was created and associated with a Google user. */
+            createTime?: string;
+            /** Output only. The resource name of the reader. The last part of ppid in the resource name is the publisher provided id. */
+            name?: string;
+        }
+        interface ReaderEntitlements {
+            /** All of the entitlements for a publication reader. */
+            entitlements?: Entitlement[];
+            /** Output only. The resource name of the singleton. */
+            name?: string;
+        }
+        interface ReadersResource {
+            /**
+             * Removes a publication reader, effectively severing the association with a Google user. If `force` is set to true, any entitlements for this reader will also be deleted. (Otherwise,
+             * the request will only work if the reader has no entitlements.) - If the reader does not exist, return NOT_FOUND. - Return FAILED_PRECONDITION if the force field is false (or unset)
+             * and entitlements are present.
+             */
+            delete(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;
+                /** If set to true, any entitlements under the reader will also be purged. */
+                force?: boolean;
+                /** 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 resource name of the reader. Format: publications/{publication_id}/readers/{ppid} */
+                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<{}>;
+            /** Gets a reader of a publication. Returns NOT_FOUND if the reader does not exist. */
+            get(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 resource name of the reader. Format: publications/{publication_id}/readers/{ppid} */
+                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<Reader>;
+            /** Gets the reader entitlements for a publication reader. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist. */
+            getEntitlements(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 name of the reader entitlements to retrieve. Format: publications/{publication_id}/readers/{reader_id}/entitlements */
+                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<ReaderEntitlements>;
+            /**
+             * Updates the reader entitlements for a publication reader. The entire reader entitlements will be overwritten by the new reader entitlements in the payload, like a PUT. - Returns
+             * PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist.
+             */
+            updateEntitlements(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;
+                /** Output only. The resource name of the singleton. */
+                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;
+                /** Optional. The list of fields to update. Defaults to all fields. */
+                updateMask?: 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: ReaderEntitlements;
+            }): Request<ReaderEntitlements>;
+            updateEntitlements(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;
+                /** Output only. The resource name of the singleton. */
+                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;
+                /** Optional. The list of fields to update. Defaults to all fields. */
+                updateMask?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            },
+            body: ReaderEntitlements): Request<ReaderEntitlements>;
+        }
+        interface PublicationsResource {
+            readers: ReadersResource;
+        }
+
+        const publications: PublicationsResource;
+    }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.readerrevenuesubscriptionlinking-v1",
+  "version": "0.0.20230409",
+  "description": "TypeScript typings for Reader Revenue Subscription Linking 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,47 @@
+# TypeScript typings for Reader Revenue Subscription Linking API v1
+
+readerrevenuesubscriptionlinking.googleapis.com API.
+For detailed description please check [documentation](https://developers.google.com/news/subscribe/subscription-linking/overview).
+
+## Installing
+
+Install typings for Reader Revenue Subscription Linking API:
+
+```
+npm install @types/gapi.client.readerrevenuesubscriptionlinking-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://readerrevenuesubscriptionlinking.googleapis.com/$discovery/rest?version=v1', () => {
+  // now we can use:
+  // gapi.client.readerrevenuesubscriptionlinking
+});
+```
+
+```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('readerrevenuesubscriptionlinking', 'v1', () => {
+  // now we can use:
+  // gapi.client.readerrevenuesubscriptionlinking
+});
+```
+
+
+
+After that you can use Reader Revenue Subscription Linking API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+```

package/tests.ts

@@ -0,0 +1,53 @@
+/* This is stub file for gapi.client.readerrevenuesubscriptionlinking-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: 20230409
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://readerrevenuesubscriptionlinking.googleapis.com/$discovery/rest?version=v1');
+    /** now we can use gapi.client.readerrevenuesubscriptionlinking */
+
+    run();
+
+    async function run() {
+        /**
+         * Removes a publication reader, effectively severing the association with a Google user. If `force` is set to true, any entitlements for this reader will also be deleted. (Otherwise, the
+         * request will only work if the reader has no entitlements.) - If the reader does not exist, return NOT_FOUND. - Return FAILED_PRECONDITION if the force field is false (or unset) and
+         * entitlements are present.
+         */
+        await gapi.client.readerrevenuesubscriptionlinking.publications.readers.delete({
+            force: true,
+            name: "Test string",
+        });
+        /** Gets a reader of a publication. Returns NOT_FOUND if the reader does not exist. */
+        await gapi.client.readerrevenuesubscriptionlinking.publications.readers.get({
+            name: "Test string",
+        });
+        /** Gets the reader entitlements for a publication reader. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist. */
+        await gapi.client.readerrevenuesubscriptionlinking.publications.readers.getEntitlements({
+            name: "Test string",
+        });
+        /**
+         * Updates the reader entitlements for a publication reader. The entire reader entitlements will be overwritten by the new reader entitlements in the payload, like a PUT. - Returns
+         * PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist.
+         */
+        await gapi.client.readerrevenuesubscriptionlinking.publications.readers.updateEntitlements({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            entitlements: [
+                {
+                    detail: "Test string",
+                    expireTime: "Test string",
+                    productId: "Test string",
+                    subscriptionToken: "Test string",
+                }
+            ],
+            name: "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
+    }
+}