@maxim_mazurok/gapi.client.webcontentpublisher-v1 0.0.0 → 0.0.20260602

package/index.d.ts

@@ -1 +1,71 @@
-export {};
+/* Type definitions for non-npm package Web Content Publisher API v1 0.0 */
+// Project: https://developers.google.com/news/subscribe
+// 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://webcontentpublisher.googleapis.com/$discovery/rest?version=v1
+// Revision: 20260602
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+  /** Load Web Content Publisher API v1 */
+  function load(
+    urlOrObject: 'https://webcontentpublisher.googleapis.com/$discovery/rest?version=v1',
+  ): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(name: 'webcontentpublisher', version: 'v1'): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(
+    name: 'webcontentpublisher',
+    version: 'v1',
+    callback: () => any,
+  ): void;
+
+  namespace webcontentpublisher {
+    interface CheckFreeAccessResponse {
+      /** True if free access should be allowed, false otherwise. */
+      isAllowed?: boolean;
+    }
+    interface PublicationsResource {
+      /** Checks if a user is eligible for free article access. */
+      checkFreeAccess(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: '1' | '2';
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: 'json' | 'media' | 'proto';
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** Required. The HTTP referrer. */
+        httpReferrer?: 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 publication. Format: publications/{publication_id} */
+        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;
+        /** Required. The URI of the content. */
+        uri?: string;
+      }): Request<CheckFreeAccessResponse>;
+    }
+
+    const publications: PublicationsResource;
+  }
+}

package/package.json

@@ -1,7 +1,20 @@
 {
   "name": "@maxim_mazurok/gapi.client.webcontentpublisher-v1",
-  "version": "0.0.0",
-  "description": "Initializer package used to configure npm trusted publishing.",
+  "version": "0.0.20260602",
+  "description": "TypeScript typings for Web Content Publisher API v1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
   "license": "MIT",
-  "types": "index.d.ts"
+  "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,97 @@
+# TypeScript typings for Web Content Publisher API v1
+
+webcontentpublisher.googleapis.com API, a service for web content publishers.
+For detailed description please check [documentation](https://developers.google.com/news/subscribe).
+
+## Installing
+
+Install typings for Web Content Publisher API:
+
+```
+npm install @types/gapi.client.webcontentpublisher-v1 --save-dev
+```
+
+## TypeScript 6.0+
+
+TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "types": [
+      "gapi",
+      "gapi.auth2",
+      "gapi.client",
+      "gapi.client.webcontentpublisher-v1"
+    ]
+  }
+}
+```
+
+## 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://webcontentpublisher.googleapis.com/$discovery/rest?version=v1',
+  () => {
+    // now we can use:
+    // gapi.client.webcontentpublisher
+  },
+);
+```
+
+```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('webcontentpublisher', 'v1', () => {
+  // now we can use:
+  // gapi.client.webcontentpublisher
+});
+```
+
+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 = [
+    // See and review your subscription information
+    'https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly',
+  ],
+  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 Web Content Publisher API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+/*
+Checks if a user is eligible for free article access.
+*/
+await gapi.client.webcontentpublisher.publications.checkFreeAccess({
+  name: 'name',
+});
+```
+
+For provenance information see [Provenance section on NPM](https://www.npmjs.com/package/@maxim_mazurok/gapi.client.webcontentpublisher-v1#Provenance:~:text=none-,Provenance,-Built%20and%20signed)

package/README.md

@@ -1,3 +0,0 @@
-# @maxim_mazurok/gapi.client.webcontentpublisher-v1
-
-This temporary initializer version exists so npm trusted publishing can be configured for this package.