@maxim_mazurok/gapi.client.appsmarket-v2 0.0.20251217

package/index.d.ts

@@ -0,0 +1,134 @@
+/* Type definitions for non-npm package Google Workspace Marketplace API v2 0.0 */
+// Project: https://developers.google.com/workspace/marketplace
+// 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://appsmarket.googleapis.com/$discovery/rest?version=v2
+// Revision: 20251217
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+  /** Load Google Workspace Marketplace API v2 */
+  function load(
+    urlOrObject: 'https://appsmarket.googleapis.com/$discovery/rest?version=v2',
+  ): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(name: 'appsmarket', version: 'v2'): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(name: 'appsmarket', version: 'v2', callback: () => any): void;
+
+  namespace appsmarket {
+    interface CustomerLicense {
+      /** The ID of the application corresponding to this license query. */
+      applicationId?: string;
+      /** The domain name of the customer. */
+      customerId?: string;
+      /** (Deprecated) */
+      editions?: Editions[];
+      /** The ID of the customer license. */
+      id?: string;
+      /** The type of API resource. This is always appsmarket#customerLicense. */
+      kind?: string;
+      /** The customer's license status. One of: - `ACTIVE`: The customer has a valid license. - `UNLICENSED`: There is no license: either this customer has never installed your application, or else has deleted it. */
+      state?: string;
+    }
+    interface Editions {
+      /** (Deprecated) */
+      assignedSeats?: number;
+      /** (Deprecated) */
+      editionId?: string;
+      /** (Deprecated) */
+      seatCount?: number;
+    }
+    interface UserLicense {
+      /** The ID of the application corresponding to the license query. */
+      applicationId?: string;
+      /** The domain name of the user. */
+      customerId?: string;
+      /** (Deprecated) */
+      editionId?: string;
+      /** The domain administrator has activated the application for this domain. */
+      enabled?: boolean;
+      /** The ID of user license. */
+      id?: string;
+      /** The type of API resource. This is always appsmarket#userLicense. */
+      kind?: string;
+      /** The user's licensing status. One of: - `ACTIVE`: The user has a valid license and should be permitted to use the application. - `UNLICENSED`: The administrator of this user's domain never assigned a seat for the application to this user. - `EXPIRED`: The administrator assigned a seat to this user, but the license is expired. */
+      state?: string;
+      /** The email address of the user. */
+      userId?: string;
+    }
+    interface CustomerLicenseResource {
+      /** Gets the status of a license for a customer to determine if they have access for a given app. */
+      get(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** Application Id */
+        applicationId: string;
+        /** JSONP */
+        callback?: string;
+        /** Customer Id */
+        customerId: 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<CustomerLicense>;
+    }
+    interface UserLicenseResource {
+      /** Gets the user's licensing status for their permission to use a given app. */
+      get(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** Application Id */
+        applicationId: 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;
+        /** User Id */
+        userId: string;
+      }): Request<UserLicense>;
+    }
+
+    const customerLicense: CustomerLicenseResource;
+
+    const userLicense: UserLicenseResource;
+  }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.appsmarket-v2",
+  "version": "0.0.20251217",
+  "description": "TypeScript typings for Google Workspace Marketplace API v2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
+  "license": "MIT",
+  "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,89 @@
+# TypeScript typings for Google Workspace Marketplace API v2
+
+Lets your Google Workspace Marketplace applications integrate with Google's installtion and licensing services.
+For detailed description please check [documentation](https://developers.google.com/workspace/marketplace).
+
+## Installing
+
+Install typings for Google Workspace Marketplace API:
+
+```
+npm install @types/gapi.client.appsmarket-v2 --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://appsmarket.googleapis.com/$discovery/rest?version=v2',
+  () => {
+    // now we can use:
+    // gapi.client.appsmarket
+  },
+);
+```
+
+```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('appsmarket', 'v2', () => {
+  // now we can use:
+  // gapi.client.appsmarket
+});
+```
+
+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 = [
+    // View your installed application's licensing information
+    'https://www.googleapis.com/auth/appsmarketplace.license',
+  ],
+  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 Google Workspace Marketplace API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+/*
+Gets the status of a license for a customer to determine if they have access for a given app.
+*/
+await gapi.client.appsmarket.customerLicense.get({
+  applicationId: 'applicationId',
+  customerId: 'customerId',
+});
+
+/*
+Gets the user's licensing status for their permission to use a given app.
+*/
+await gapi.client.appsmarket.userLicense.get({
+  applicationId: 'applicationId',
+  userId: 'userId',
+});
+```
+
+For provenance information see [Provenance section on NPM](https://www.npmjs.com/package/@maxim_mazurok/gapi.client.appsmarket-v2#Provenance:~:text=none-,Provenance,-Built%20and%20signed)