@maxim_mazurok/gapi.client.gmailpostmastertools-v2 0.0.20260208

package/index.d.ts

@@ -0,0 +1,404 @@
+/* Type definitions for non-npm package Gmail Postmaster Tools API v2 0.0 */
+// Project: https://developers.google.com/workspace/gmail/postmaster
+// 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://gmailpostmastertools.googleapis.com/$discovery/rest?version=v2
+// Revision: 20260208
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+  /** Load Gmail Postmaster Tools API v2 */
+  function load(
+    urlOrObject: 'https://gmailpostmastertools.googleapis.com/$discovery/rest?version=v2',
+  ): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(name: 'gmailpostmastertools', version: 'v2'): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(
+    name: 'gmailpostmastertools',
+    version: 'v2',
+    callback: () => any,
+  ): void;
+
+  namespace gmailpostmastertools {
+    interface BaseMetric {
+      /** A predefined standard metric. */
+      standardMetric?: string;
+    }
+    interface BatchQueryDomainStatsRequest {
+      /** Required. A list of individual query requests. Each request can be for a different domain. A maximum of 100 requests can be included in a single batch. */
+      requests?: QueryDomainStatsRequest[];
+    }
+    interface BatchQueryDomainStatsResponse {
+      /** A list of responses, one for each query in the BatchQueryDomainStatsRequest. The order of responses will correspond to the order of requests. */
+      results?: BatchQueryDomainStatsResult[];
+    }
+    interface BatchQueryDomainStatsResult {
+      /** The error status if the individual query failed. */
+      error?: Status;
+      /** The successful response for the individual query. */
+      response?: QueryDomainStatsResponse;
+    }
+    interface ComplianceRowData {
+      /** The compliance requirement. */
+      requirement?: string;
+      /** The compliance status for the requirement. */
+      status?: ComplianceStatus;
+    }
+    interface ComplianceStatus {
+      /** Output only. The compliance status. */
+      status?: string;
+    }
+    interface Date {
+      /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
+      day?: number;
+      /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
+      month?: number;
+      /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
+      year?: number;
+    }
+    interface DateList {
+      /** Required. The list of specific dates for which to retrieve data. */
+      dates?: Date[];
+    }
+    interface DateRange {
+      /** Required. The inclusive end date of the date range. */
+      end?: Date;
+      /** Required. The inclusive start date of the date range. */
+      start?: Date;
+    }
+    interface DateRanges {
+      /** Required. The list of date ranges for which to retrieve data. */
+      dateRanges?: DateRange[];
+    }
+    interface Domain {
+      /** Output only. Immutable. The timestamp at which the domain was added to the user's account. */
+      createTime?: string;
+      /** The timestamp at which the domain was last verified by the user. */
+      lastVerifyTime?: string;
+      /** Identifier. The resource name of the domain. Format: `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com). */
+      name?: string;
+      /** Output only. User's permission of this domain. */
+      permission?: string;
+      /** Output only. Information about a user's verification history and properties for the domain. */
+      verificationState?: string;
+    }
+    interface DomainComplianceData {
+      /** Domain that this data is for. */
+      domainId?: string;
+      /** Unsubscribe honoring compliance verdict. */
+      honorUnsubscribeVerdict?: HonorUnsubscribeVerdict;
+      /** One-click unsubscribe compliance verdict. */
+      oneClickUnsubscribeVerdict?: OneClickUnsubscribeVerdict;
+      /** Data for each of the rows of the table. Each message contains all the data that backs a single row. */
+      rowData?: ComplianceRowData[];
+    }
+    interface DomainComplianceStatus {
+      /** Compliance data for the registrable domain part of the domain in `name`. For example, if `name` is `domains/example.com/complianceStatus`, this field contains compliance data for `example.com`. */
+      complianceData?: DomainComplianceData;
+      /** Identifier. The resource name of the domain's compliance status. Format: `domains/{domain_id}/complianceStatus`. */
+      name?: string;
+      /** Compliance data calculated specifically for the subdomain in `name`. This field is only populated if the domain in `name` is a subdomain that differs from its registrable domain (e.g., `sub.example.com`), and if compliance data is available for that specific subdomain. */
+      subdomainComplianceData?: DomainComplianceData;
+    }
+    interface DomainStat {
+      /** Optional. The specific date for these stats, if granularity is DAILY. This field is populated if the QueryDomainStatsRequest specified a DAILY aggregation granularity. */
+      date?: Date;
+      /** The user-defined name from MetricDefinition.name in the request, used to correlate this result with the requested metric. */
+      metric?: string;
+      /** Output only. The resource name of the DomainStat resource. Format: domains/{domain}/domainStats/{domain_stat} The `{domain_stat}` segment is an opaque, server-generated ID. We recommend using the `metric` field to identify queried metrics instead of parsing the name. */
+      name?: string;
+      /** The value of the corresponding metric. */
+      value?: StatisticValue;
+    }
+    interface HonorUnsubscribeVerdict {
+      /** The specific reason for the compliance verdict. Must be empty if the status is compliant. */
+      reason?: string;
+      /** The compliance status. */
+      status?: ComplianceStatus;
+    }
+    interface ListDomainsResponse {
+      /** The domains that have been registered by the user. */
+      domains?: Domain[];
+      /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
+      nextPageToken?: string;
+    }
+    interface MetricDefinition {
+      /** Required. The underlying metric to query. */
+      baseMetric?: BaseMetric;
+      /** Optional. Optional filters to apply to the metric. */
+      filter?: string;
+      /** Required. The user-defined name for this metric. This name will be used as the key for this metric's value in the response. */
+      name?: string;
+    }
+    interface OneClickUnsubscribeVerdict {
+      /** The specific reason for the compliance verdict. Must be empty if the status is compliant. */
+      reason?: string;
+      /** The compliance status. */
+      status?: ComplianceStatus;
+    }
+    interface QueryDomainStatsRequest {
+      /** Optional. The granularity at which to aggregate the statistics. If unspecified, defaults to DAILY. */
+      aggregationGranularity?: string;
+      /** Required. The specific metrics to query. You can define a custom name for each metric, which will be used in the response. */
+      metricDefinitions?: MetricDefinition[];
+      /** Optional. The maximum number of DomainStats resources to return in the response. The server may return fewer than this value. If unspecified, a default value of 10 will be used. The maximum value is 200. */
+      pageSize?: number;
+      /** Optional. The next_page_token value returned from a previous List request, if any. If the aggregation granularity is DAILY, the page token will be the encoded date + "/" + metric name. If the aggregation granularity is OVERALL, the page token will be the encoded metric name. */
+      pageToken?: string;
+      /** Required. The parent resource name where the stats are queried. Format: domains/{domain} */
+      parent?: string;
+      /** Required. The time range or specific dates for which to retrieve the metrics. */
+      timeQuery?: TimeQuery;
+    }
+    interface QueryDomainStatsResponse {
+      /** The list of domain statistics. Each DomainStat object contains the value for a metric requested in the QueryDomainStatsRequest. */
+      domainStats?: DomainStat[];
+      /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
+      nextPageToken?: string;
+    }
+    interface StatisticValue {
+      /** Double value. */
+      doubleValue?: number;
+      /** Float value. */
+      floatValue?: number;
+      /** Integer value. */
+      intValue?: string;
+      /** List of string values. */
+      stringList?: StringList;
+      /** String value. */
+      stringValue?: string;
+    }
+    interface Status {
+      /** The status code, which should be an enum value of google.rpc.Code. */
+      code?: number;
+      /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
+      details?: Array<{[P in string]: any}>;
+      /** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
+      message?: string;
+    }
+    interface StringList {
+      /** The string values. */
+      values?: string[];
+    }
+    interface TimeQuery {
+      /** A list of specific dates. */
+      dateList?: DateList;
+      /** A list of date ranges. */
+      dateRanges?: DateRanges;
+    }
+    interface DomainStatsResource {
+      /** Retrieves a list of domain statistics for a given domain and time period. Returns statistics only for dates where data is available. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for the domain. */
+      query(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;
+        /** Required. The parent resource name where the stats are queried. Format: domains/{domain} */
+        parent: 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: QueryDomainStatsRequest;
+      }): Request<QueryDomainStatsResponse>;
+      query(
+        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;
+          /** Required. The parent resource name where the stats are queried. Format: domains/{domain} */
+          parent: 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: QueryDomainStatsRequest,
+      ): Request<QueryDomainStatsResponse>;
+    }
+    interface DomainsResource {
+      /** Retrieves detailed information about a domain registered by you. Returns NOT_FOUND if the domain is not registered by you. Domain represents the metadata of a domain that has been registered within the system and linked to a user. */
+      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 domain. Format: `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com). */
+        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<Domain>;
+      /** Retrieves the compliance status for a given domain. Returns PERMISSION_DENIED if you don't have permission to access compliance status for the domain. */
+      getComplianceStatus(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 domain's compliance status to retrieve. Format: `domains/{domain_id}/complianceStatus`. */
+        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<DomainComplianceStatus>;
+      /** Retrieves a list of all domains registered by you, along with their corresponding metadata. The order of domains in the response is unspecified and non-deterministic. Newly registered domains will not necessarily be added to the end of this list. */
+      list(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;
+        /** Optional. Requested page size. Server may return fewer domains than requested. If unspecified, the default value for this field is 10. The maximum value for this field is 200. */
+        pageSize?: number;
+        /** Optional. The next_page_token value returned from a previous List request, if any. */
+        pageToken?: 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<ListDomainsResponse>;
+      domainStats: DomainStatsResource;
+    }
+    interface DomainStatsResource {
+      /** Executes a batch of QueryDomainStats requests for multiple domains. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for any of the requested domains. */
+      batchQuery(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: BatchQueryDomainStatsRequest;
+      }): Request<BatchQueryDomainStatsResponse>;
+      batchQuery(
+        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: BatchQueryDomainStatsRequest,
+      ): Request<BatchQueryDomainStatsResponse>;
+    }
+
+    const domainStats: DomainStatsResource;
+
+    const domains: DomainsResource;
+  }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.gmailpostmastertools-v2",
+  "version": "0.0.20260208",
+  "description": "TypeScript typings for Gmail Postmaster Tools 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,101 @@
+# TypeScript typings for Gmail Postmaster Tools API v2
+
+The Postmaster Tools API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently.
+For detailed description please check [documentation](https://developers.google.com/workspace/gmail/postmaster).
+
+## Installing
+
+Install typings for Gmail Postmaster Tools API:
+
+```
+npm install @types/gapi.client.gmailpostmastertools-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://gmailpostmastertools.googleapis.com/$discovery/rest?version=v2',
+  () => {
+    // now we can use:
+    // gapi.client.gmailpostmastertools
+  },
+);
+```
+
+```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('gmailpostmastertools', 'v2', () => {
+  // now we can use:
+  // gapi.client.gmailpostmastertools
+});
+```
+
+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 = [
+    // Get email traffic metrics, manage domains, and manage domain users for the domains you have registered with Postmaster Tools
+    'https://www.googleapis.com/auth/postmaster',
+
+    // View and manage the domains you have registered with Postmaster Tools
+    'https://www.googleapis.com/auth/postmaster.domain',
+
+    // Get email traffic metrics for the domains you have registered with Postmaster Tools
+    'https://www.googleapis.com/auth/postmaster.traffic.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 Gmail Postmaster Tools API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+/*
+Retrieves detailed information about a domain registered by you. Returns NOT_FOUND if the domain is not registered by you. Domain represents the metadata of a domain that has been registered within the system and linked to a user.
+*/
+await gapi.client.gmailpostmastertools.domains.get({name: 'name'});
+
+/*
+Retrieves the compliance status for a given domain. Returns PERMISSION_DENIED if you don't have permission to access compliance status for the domain.
+*/
+await gapi.client.gmailpostmastertools.domains.getComplianceStatus({
+  name: 'name',
+});
+
+/*
+Retrieves a list of all domains registered by you, along with their corresponding metadata. The order of domains in the response is unspecified and non-deterministic. Newly registered domains will not necessarily be added to the end of this list.
+*/
+await gapi.client.gmailpostmastertools.domains.list({});
+
+/*
+Executes a batch of QueryDomainStats requests for multiple domains. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for any of the requested domains.
+*/
+await gapi.client.gmailpostmastertools.domainStats.batchQuery({});
+```
+
+For provenance information see [Provenance section on NPM](https://www.npmjs.com/package/@maxim_mazurok/gapi.client.gmailpostmastertools-v2#Provenance:~:text=none-,Provenance,-Built%20and%20signed)