googleapis/build/src/apis/gmailpostmastertools/v2.d.ts

Google APIs Client Library for Node.js

import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace gmailpostmastertools_v2 {
    export interface Options extends GlobalOptions {
        version: 'v2';
    }
    interface StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
        /**
         * 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;
        /**
         * Legacy upload protocol for media (e.g. "media", "multipart").
         */
        uploadType?: string;
        /**
         * Upload protocol for media (e.g. "raw", "multipart").
         */
        upload_protocol?: string;
    }
    /**
     * Gmail Postmaster Tools API
     *
     * 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.
     *
     * @example
     * ```js
     * const {google} = require('googleapis');
     * const gmailpostmastertools = google.gmailpostmastertools('v2');
     * ```
     */
    export class Gmailpostmastertools {
        context: APIRequestContext;
        domains: Resource$Domains;
        domainStats: Resource$Domainstats;
        constructor(options: GlobalOptions, google?: GoogleConfigurable);
    }
    /**
     * Specifies the base metric to query, which can be a predefined standard metric or a user-defined custom metric (if supported in the future).
     */
    export interface Schema$BaseMetric {
        /**
         * A predefined standard metric.
         */
        standardMetric?: string | null;
    }
    /**
     * Request message for BatchQueryDomainStats.
     */
    export interface Schema$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?: Schema$QueryDomainStatsRequest[];
    }
    /**
     * Response message for BatchQueryDomainStats.
     */
    export interface Schema$BatchQueryDomainStatsResponse {
        /**
         * A list of responses, one for each query in the BatchQueryDomainStatsRequest. The order of responses will correspond to the order of requests.
         */
        results?: Schema$BatchQueryDomainStatsResult[];
    }
    /**
     * Represents the result of a single QueryDomainStatsRequest within a batch.
     */
    export interface Schema$BatchQueryDomainStatsResult {
        /**
         * The error status if the individual query failed.
         */
        error?: Schema$Status;
        /**
         * The successful response for the individual query.
         */
        response?: Schema$QueryDomainStatsResponse;
    }
    /**
     * Data for a single row of the compliance status table.
     */
    export interface Schema$ComplianceRowData {
        /**
         * The compliance requirement.
         */
        requirement?: string | null;
        /**
         * The compliance status for the requirement.
         */
        status?: Schema$ComplianceStatus;
    }
    /**
     * The status of a sender compliance requirement.
     */
    export interface Schema$ComplianceStatus {
        /**
         * Output only. The compliance status.
         */
        status?: string | null;
    }
    /**
     * [Developer Preview](https://developers.google.com/workspace/preview): Request message for CreateDomain.
     */
    export interface Schema$CreateDomainRequest {
        /**
         * Required. The domain to add. e.g., "example.com"
         */
        domainId?: string | null;
    }
    /**
     * [Developer Preview](https://developers.google.com/workspace/preview): Request message for CreateUser.
     */
    export interface Schema$CreateUserRequest {
        /**
         * Optional. Specifies the permission level to give the user for the specified domain. If not specified, the default value for this field is READER.
         */
        permission?: string | null;
        /**
         * Required. The user to create.
         */
        userId?: string | null;
    }
    /**
     * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
     */
    export interface Schema$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 | null;
        /**
         * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
         */
        month?: number | null;
        /**
         * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
         */
        year?: number | null;
    }
    /**
     * A set of specific dates.
     */
    export interface Schema$DateList {
        /**
         * Required. The list of specific dates for which to retrieve data.
         */
        dates?: Schema$Date[];
    }
    /**
     * A single date range defined by a start and end date.
     */
    export interface Schema$DateRange {
        /**
         * Required. The inclusive end date of the date range.
         */
        end?: Schema$Date;
        /**
         * Required. The inclusive start date of the date range.
         */
        start?: Schema$Date;
    }
    /**
     * A set of date ranges.
     */
    export interface Schema$DateRanges {
        /**
         * Required. The list of date ranges for which to retrieve data.
         */
        dateRanges?: Schema$DateRange[];
    }
    /**
     * [Developer Preview](https://developers.google.com/workspace/preview): Verdict of domain deliverability status.
     */
    export interface Schema$DeliverabilityStatusVerdict {
        /**
         * Output only. The specific reason for the compliance verdict.
         */
        reason?: string | null;
        /**
         * Output only. The compliance state.
         */
        state?: Schema$ComplianceStatus;
    }
    /**
     * Information about a domain registered by the user.
     */
    export interface Schema$Domain {
        /**
         * Output only. Immutable. The timestamp at which the domain was added to the user's account.
         */
        createTime?: string | null;
        /**
         * The timestamp at which the domain was last verified by the user.
         */
        lastVerifyTime?: string | null;
        /**
         * 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 | null;
        /**
         * Output only. User's permission of this domain.
         */
        permission?: string | null;
        /**
         * Output only. Information about a user's verification history and properties for the domain.
         */
        verificationState?: string | null;
    }
    /**
     * Compliance data for a given domain.
     */
    export interface Schema$DomainComplianceData {
        /**
         * Output only. Deliverability status verdict.
         */
        deliverabilityStatusVerdict?: Schema$DeliverabilityStatusVerdict;
        /**
         * Domain that this data is for.
         */
        domainId?: string | null;
        /**
         * Unsubscribe honoring compliance verdict.
         */
        honorUnsubscribeVerdict?: Schema$HonorUnsubscribeVerdict;
        /**
         * One-click unsubscribe compliance verdict.
         */
        oneClickUnsubscribeVerdict?: Schema$OneClickUnsubscribeVerdict;
        /**
         * Data for each of the rows of the table. Each message contains all the data that backs a single row.
         */
        rowData?: Schema$ComplianceRowData[];
    }
    /**
     * Compliance status for a domain.
     */
    export interface Schema$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?: Schema$DomainComplianceData;
        /**
         * Identifier. The resource name of the domain's compliance status. Format: `domains/{domain_id\}/complianceStatus`.
         */
        name?: string | null;
        /**
         * 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?: Schema$DomainComplianceData;
    }
    /**
     * Email statistics for a domain for a specified time period or date.
     */
    export interface Schema$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?: Schema$Date;
        /**
         * The user-defined name from MetricDefinition.name in the request, used to correlate this result with the requested metric.
         */
        metric?: string | null;
        /**
         * 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 | null;
        /**
         * The value of the corresponding metric.
         */
        value?: Schema$StatisticValue;
    }
    /**
     * [Developer Preview](https://developers.google.com/workspace/preview): The DNS token a user can use to verify ownership of a domain.
     */
    export interface Schema$DomainVerificationToken {
        /**
         * Identifier. The resource name of the domain verification token. Format: domains/{domain\}/verificationToken
         */
        name?: string | null;
        /**
         * The verification token.
         */
        token?: string | null;
        /**
         * The verification method used.
         */
        verificationMethod?: string | null;
    }
    /**
     * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
     */
    export interface Schema$Empty {
    }
    /**
     * Compliance verdict for whether a sender meets the unsubscribe honoring compliance requirement.
     */
    export interface Schema$HonorUnsubscribeVerdict {
        /**
         * The specific reason for the compliance verdict. Must be empty if the status is compliant.
         */
        reason?: string | null;
        /**
         * The compliance status.
         */
        status?: Schema$ComplianceStatus;
    }
    /**
     * Response message for ListDomains.
     */
    export interface Schema$ListDomainsResponse {
        /**
         * The domains that have been registered by the user.
         */
        domains?: Schema$Domain[];
        /**
         * Token to retrieve the next page of results, or empty if there are no more results in the list.
         */
        nextPageToken?: string | null;
    }
    /**
     * [Developer Preview](https://developers.google.com/workspace/preview): Response message for ListUsers.
     */
    export interface Schema$ListUsersResponse {
        /**
         * Token to retrieve the next page of results, or empty if there are no more results in the list.
         */
        nextPageToken?: string | null;
        /**
         * The users that have access to the domain.
         */
        users?: Schema$User[];
    }
    /**
     * Defines a specific metric to query, including a user-defined name, the base metric type, and optional filters.
     */
    export interface Schema$MetricDefinition {
        /**
         * Required. The underlying metric to query.
         */
        baseMetric?: Schema$BaseMetric;
        /**
         * Optional. Optional filters to apply to the metric.
         */
        filter?: string | null;
        /**
         * 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 | null;
    }
    /**
     * Compliance verdict for whether a sender meets the one-click unsubscribe compliance requirement.
     */
    export interface Schema$OneClickUnsubscribeVerdict {
        /**
         * The specific reason for the compliance verdict. Must be empty if the status is compliant.
         */
        reason?: string | null;
        /**
         * The compliance status.
         */
        status?: Schema$ComplianceStatus;
    }
    /**
     * Request message for QueryDomainStats.
     */
    export interface Schema$QueryDomainStatsRequest {
        /**
         * Optional. The granularity at which to aggregate the statistics. If unspecified, defaults to DAILY.
         */
        aggregationGranularity?: string | null;
        /**
         * Required. The specific metrics to query. You can define a custom name for each metric, which will be used in the response.
         */
        metricDefinitions?: Schema$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 | null;
        /**
         * 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 | null;
        /**
         * Required. The parent resource name where the stats are queried. Format: domains/{domain\}
         */
        parent?: string | null;
        /**
         * Required. The time range or specific dates for which to retrieve the metrics.
         */
        timeQuery?: Schema$TimeQuery;
    }
    /**
     * Response message for QueryDomainStats.
     */
    export interface Schema$QueryDomainStatsResponse {
        /**
         * The list of domain statistics. Each DomainStat object contains the value for a metric requested in the QueryDomainStatsRequest.
         */
        domainStats?: Schema$DomainStat[];
        /**
         * Token to retrieve the next page of results, or empty if there are no more results in the list.
         */
        nextPageToken?: string | null;
    }
    /**
     * The actual value of a statistic.
     */
    export interface Schema$StatisticValue {
        /**
         * Double value.
         */
        doubleValue?: number | null;
        /**
         * Float value.
         */
        floatValue?: number | null;
        /**
         * Integer value.
         */
        intValue?: string | null;
        /**
         * List of string values.
         */
        stringList?: Schema$StringList;
        /**
         * String value.
         */
        stringValue?: string | null;
    }
    /**
     * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
     */
    export interface Schema$Status {
        /**
         * The status code, which should be an enum value of google.rpc.Code.
         */
        code?: number | null;
        /**
         * A list of messages that carry the error details. There is a common set of message types for APIs to use.
         */
        details?: Array<{
            [key: string]: any;
        }> | null;
        /**
         * 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 | null;
    }
    /**
     * Represents a list of strings.
     */
    export interface Schema$StringList {
        /**
         * The string values.
         */
        values?: string[] | null;
    }
    /**
     * The date ranges or specific dates for which you want to retrieve data.
     */
    export interface Schema$TimeQuery {
        /**
         * A list of specific dates.
         */
        dateList?: Schema$DateList;
        /**
         * A list of date ranges.
         */
        dateRanges?: Schema$DateRanges;
    }
    /**
     * [Developer Preview](https://developers.google.com/workspace/preview): Information about a user's access to a domain.
     */
    export interface Schema$User {
        /**
         * Output only. The user that added the current user.
         */
        accessGranter?: string | null;
        /**
         * Output only. The time the user was granted access.
         */
        createTime?: string | null;
        /**
         * Identifier. The resource name of the user. Format: users/{user\} Note: {user\} is the user's email address.
         */
        name?: string | null;
        /**
         * The permission level that the user has for the specified domain.
         */
        permission?: string | null;
        /**
         * The user's email address.
         */
        user?: string | null;
    }
    /**
     * [Developer Preview](https://developers.google.com/workspace/preview): Request message for VerifyDomain.
     */
    export interface Schema$VerifyDomainRequest {
        /**
         * Required. The verification method used. Must be specified, i.e. TXT or CNAME.
         */
        verificationMethod?: string | null;
    }
    /**
     * [Developer Preview](https://developers.google.com/workspace/preview): Response message for VerifyDomain.
     */
    export interface Schema$VerifyDomainResponse {
    }
    export class Resource$Domains {
        context: APIRequestContext;
        domainStats: Resource$Domains$Domainstats;
        users: Resource$Domains$Users;
        constructor(context: APIRequestContext);
        /**
         * [Developer Preview](https://developers.google.com/workspace/preview): Adds a domain to the user's account. Returns INVALID_ARGUMENT if a domain is not provided. Returns ALREADY_EXISTS if the domain is already registered by the user.
         * @example
         * ```js
         * // Before running the sample:
         * // - Enable the API at:
         * //   https://console.developers.google.com/apis/api/gmailpostmastertools.googleapis.com
         * // - Login into gcloud by running:
         * //   ```sh
         * //   $ gcloud auth application-default login
         * //   ```
         * // - Install the npm module by running:
         * //   ```sh
         * //   $ npm install googleapis
         * //   ```
         *
         * const {google} = require('googleapis');
         * const gmailpostmastertools = google.gmailpostmastertools('v2');
         *
         * async function main() {
         *   const auth = new google.auth.GoogleAuth({
         *     // Scopes can be specified either as an array or as a single, space-delimited string.
         *     scopes: [
         *       'https://www.googleapis.com/auth/postmaster',
         *       'https://www.googleapis.com/auth/postmaster.domain',
         *     ],
         *   });
         *
         *   // Acquire an auth client, and bind it to all future calls
         *   const authClient = await auth.getClient();
         *   google.options({auth: authClient});
         *
         *   // Do the magic
         *   const res = await gmailpostmastertools.domains.create({
         *     // Request body metadata
         *     requestBody: {
         *       // request body parameters
         *       // {
         *       //   "domainId": "my_domainId"
         *       // }
         *     },
         *   });
         *   console.log(res.data);
         *
         *   // Example response
         *   // {
         *   //   "createTime": "my_createTime",
         *   //   "lastVerifyTime": "my_lastVerifyTime",
         *   //   "name": "my_name",
         *   //   "permission": "my_permission",
         *   //   "verificationState": "my_verificationState"
         *   // }
         * }
         *
         * main().catch(e => {
         *   console.error(e);
         *   throw e;
         * });
         *
         * ```
         *
         * @param params - Parameters for request
         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param callback - Optional callback that handles the response.
         * @returns A promise if used with async/await, or void if used with a callback.
         */
        create(params: Params$Resource$Domains$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
        create(params?: Params$Resource$Domains$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Domain>>;
        create(params: Params$Resource$Domains$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
        create(params: Params$Resource$Domains$Create, options: MethodOptions | BodyResponseCallback<Schema$Domain>, callback: BodyResponseCallback<Schema$Domain>): void;
        create(params: Params$Resource$Domains$Create, callback: BodyResponseCallback<Schema$Domain>): void;
        create(callback: BodyResponseCallback<Schema$Domain>): void;
        /**
         * [Developer Preview](https://developers.google.com/workspace/preview): Deletes a domain from the user's account. Returns NOT_FOUND if the domain is not registered by the user.
         * @example
         * ```js
         * // Before running the sample:
         * // - Enable the API at:
         * //   https://console.developers.google.com/apis/api/gmailpostmastertools.googleapis.com
         * // - Login into gcloud by running:
         * //   ```sh
         * //   $ gcloud auth application-default login
         * //   ```
         * // - Install the npm module by running:
         * //   ```sh
         * //   $ npm install googleapis
         * //   ```
         *
         * const {google} = require('googleapis');
         * const gmailpostmastertools = google.gmailpostmastertools('v2');
         *
         * async function main() {
         *   const auth = new google.auth.GoogleAuth({
         *     // Scopes can be specified either as an array or as a single, space-delimited string.
         *     scopes: [
         *       'https://www.googleapis.com/auth/postmaster',
         *       'https://www.googleapis.com/auth/postmaster.domain',
         *     ],
         *   });
         *
         *   // Acquire an auth client, and bind it to all future calls
         *   const authClient = await auth.getClient();
         *   google.options({auth: authClient});
         *
         *   // Do the magic
         *   const res = await gmailpostmastertools.domains.delete({
         *     // Required. The domain to delete.
         *     name: 'domains/my-domain',
         *   });
         *   console.log(res.data);
         *
         *   // Example response
         *   // {}
         * }
         *
         * main().catch(e => {
         *   console.error(e);
         *   throw e;
         * });
         *
         * ```
         *
         * @param params - Parameters for request
         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param callback - Optional callback that handles the response.
         * @returns A promise if used with async/await, or void if used with a callback.
         */
        delete(params: Params$Resource$Domains$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
        delete(params?: Params$Resource$Domains$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
        delete(params: Params$Resource$Domains$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
        delete(params: Params$Resource$Domains$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
        delete(params: Params$Resource$Domains$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
        delete(callback: BodyResponseCallback<Schema$Empty>): void;
        /**
         * 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.
         * @example
         * ```js
         * // Before running the sample:
         * // - Enable the API at:
         * //   https://console.developers.google.com/apis/api/gmailpostmastertools.googleapis.com
         * // - Login into gcloud by running:
         * //   ```sh
         * //   $ gcloud auth application-default login
         * //   ```
         * // - Install the npm module by running:
         * //   ```sh
         * //   $ npm install googleapis
         * //   ```
         *
         * const {google} = require('googleapis');
         * const gmailpostmastertools = google.gmailpostmastertools('v2');
         *
         * async function main() {
         *   const auth = new google.auth.GoogleAuth({
         *     // Scopes can be specified either as an array or as a single, space-delimited string.
         *     scopes: [
         *       'https://www.googleapis.com/auth/postmaster',
         *       'https://www.googleapis.com/auth/postmaster.domain',
         *     ],
         *   });
         *
         *   // Acquire an auth client, and bind it to all future calls
         *   const authClient = await auth.getClient();
         *   google.options({auth: authClient});
         *
         *   // Do the magic
         *   const res = await gmailpostmastertools.domains.get({
         *     // 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: 'domains/my-domain',
         *   });
         *   console.log(res.data);
         *
         *   // Example response
         *   // {
         *   //   "createTime": "my_createTime",
         *   //   "lastVerifyTime": "my_lastVerifyTime",
         *   //   "name": "my_name",
         *   //   "permission": "my_permission",
         *   //   "verificationState": "my_verificationState"
         *   // }
         * }
         *
         * main().catch(e => {
         *   console.error(e);
         *   throw e;
         * });
         *
         * ```
         *
         * @param params - Parameters for request
         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param callback - Optional callback that handles the response.
         * @returns A promise if used with async/await, or void if used with a callback.
         */
        get(params: Params$Resource$Domains$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
        get(params?: Params$Resource$Domains$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Domain>>;
        get(params: Params$Resource$Domains$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
        get(params: Params$Resource$Domains$Get, options: MethodOptions | BodyResponseCallback<Schema$Domain>, callback: BodyResponseCallback<Schema$Domain>): void;
        get(params: Params$Resource$Domains$Get, callback: BodyResponseCallback<Schema$Domain>): void;
        get(callback: BodyResponseCallback<Schema$Domain>): void;
        /**
         * Retrieves the compliance status for a given domain. Returns PERMISSION_DENIED if you don't have permission to access compliance status for the domain.
         * @example
         * ```js
         * // Before running the sample:
         * // - Enable the API at:
         * //   https://console.developers.google.com/apis/api/gmailpostmastertools.googleapis.com
         * // - Login into gcloud by running:
         * //   ```sh
         * //   $ gcloud auth application-default login
         * //   ```
         * // - Install the npm module by running:
         * //   ```sh
         * //   $ npm install googleapis
         * //   ```
         *
         * const {google} = require('googleapis');
         * const gmailpostmastertools = google.gmailpostmastertools('v2');
         *
         * async function main() {
         *   const auth = new google.auth.GoogleAuth({
         *     // Scopes can be specified either as an array or as a single, space-delimited string.
         *     scopes: [
         *       'https://www.googleapis.com/auth/postmaster',
         *       'https://www.googleapis.com/auth/postmaster.traffic.readonly',
         *     ],
         *   });
         *
         *   // Acquire an auth client, and bind it to all future calls
         *   const authClient = await auth.getClient();
         *   google.options({auth: authClient});
         *
         *   // Do the magic
         *   const res = await gmailpostmastertools.domains.getComplianceStatus({
         *     // Required. The resource name of the domain's compliance status to retrieve. Format: `domains/{domain_id\}/complianceStatus`.
         *     name: 'domains/my-domain/complianceStatus',
         *   });
         *   console.log(res.data);
         *
         *   // Example response
         *   // {
         *   //   "complianceData": {},
         *   //   "name": "my_name",
         *   //   "subdomainComplianceData": {}
         *   // }
         * }
         *
         * main().catch(e => {
         *   console.error(e);
         *   throw e;
         * });
         *
         * ```
         *
         * @param params - Parameters for request
         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param callback - Optional callback that handles the response.
         * @returns A promise if used with async/await, or void if used with a callback.
         */
        getComplianceStatus(params: Params$Resource$Domains$Getcompliancestatus, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
        getComplianceStatus(params?: Params$Resource$Domains$Getcompliancestatus, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$DomainComplianceStatus>>;
        getComplianceStatus(params: Params$Resource$Domains$Getcompliancestatus, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
        getComplianceStatus(params: Params$Resource$Domains$Getcompliancestatus, options: MethodOptions | BodyResponseCallback<Schema$DomainComplianceStatus>, callback: BodyResponseCallback<Schema$DomainComplianceStatus>): void;
        getComplianceStatus(params: Params$Resource$Domains$Getcompliancestatus, callback: BodyResponseCallback<Schema$DomainComplianceStatus>): void;
        getComplianceStatus(callback: BodyResponseCallback<Schema$DomainComplianceStatus>): void;
        /**
         * [Developer Preview](https://developers.google.com/workspace/preview): Gets a verification token used for verifying a user's ownership over a domain.
         * @example
         * ```js
         * // Before running the sample:
         * // - Enable the API at:
         * //   https://console.developers.google.com/apis/api/gmailpostmastertools.googleapis.com
         * // - Login into gcloud by running:
         * //   ```sh
         * //   $ gcloud auth application-default login
         * //   ```
         * // - Install the npm module by running:
         * //   ```sh
         * //   $ npm install googleapis
         * //   ```
         *
         * const {google} = require('googleapis');
         * const gmailpostmastertools = google.gmailpostmastertools('v2');
         *
         * async function main() {
         *   const auth = new google.auth.GoogleAuth({
         *     // Scopes can be specified either as an array or as a single, space-delimited string.
         *     scopes: [
         *       'https://www.googleapis.com/auth/postmaster',
         *       'https://www.googleapis.com/auth/postmaster.domain',
         *     ],
         *   });
         *
         *   // Acquire an auth client, and bind it to all future calls
         *   const authClient = await auth.getClient();
         *   google.options({auth: authClient});
         *
         *   // Do the magic
         *   const res = await gmailpostmastertools.domains.getVerificationToken({
         *     // Required. The resource name of the verification token to retrieve. Format: `domains/{domain\}/verificationToken`
         *     name: 'domains/my-domain/verificationToken',
         *     // Required. The verification method used. Must be specified, i.e. TXT or CNAME.
         *     verificationMethod: 'placeholder-value',
         *   });
         *   console.log(res.data);
         *
         *   // Example response
         *   // {
         *   //   "name": "my_name",
         *   //   "token": "my_token",
         *   //   "verificationMethod": "my_verificationMethod"
         *   // }
         * }
         *
         * main().catch(e => {
         *   console.error(e);
         *   throw e;
         * });
         *
         * ```
         *
         * @param params - Parameters for request
         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param callback - Optional callback that handles the response.
         * @returns A promise if used with async/await, or void if used with a callback.
         */
        getVerificationToken(params: Params$Resource$Domains$Getverificationtoken, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
        getVerificationToken(params?: Params$Resource$Domains$Getverificationtoken, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$DomainVerificationToken>>;
        getVerificationToken(params: Params$Resource$Domains$Getverificationtoken, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
        getVerificationToken(params: Params$Resource$Domains$Getverificationtoken, options: MethodOptions | BodyResponseCallback<Schema$DomainVerificationToken>, callback: BodyResponseCallback<Schema$DomainVerificationToken>): void;
        getVerificationToken(params: Params$Resource$Domains$Getverificationtoken, callback: BodyResponseCallback<Schema$DomainVerificationToken>): void;
        getVerificationToken(callback: BodyResponseCallback<Schema$DomainVerificationToken>): void;
        /**
         * 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.
         * @example
         * ```js
         * // Before running the sample:
         * // - Enable the API at:
         * //   https://console.developers.google.com/apis/api/gmailpostmastertools.googleapis.com
         * // - Login into gcloud by running:
         * //   ```sh
         * //   $ gcloud auth application-default login
         * //   ```
         * // - Install the npm module by running:
         * //   ```sh
         * //   $ npm install googleapis
         * //   ```
         *
         * const {google} = require('googleapis');
         * const gmailpostmastertools = google.gmailpostmastertools('v2');
         *
         * async function main() {
         *   const auth = new google.auth.GoogleAuth({
         *     // Scopes can be specified either as an array or as a single, space-delimited string.
         *     scopes: [
         *       'https://www.googleapis.com/auth/postmaster',
         *       'https://www.googleapis.com/auth/postmaster.domain',
         *     ],
         *   });
         *
         *   // Acquire an auth client, and bind it to all future calls
         *   const authClient = await auth.getClient();
         *   google.options({auth: authClient});
         *
         *   // Do the magic
         *   const res = await gmailpostmastertools.domains.list({
         *     // 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: 'placeholder-value',
         *     // Optional. The next_page_token value returned from a previous List request, if any.
         *     pageToken: 'placeholder-value',
         *   });
         *   console.log(res.data);
         *
         *   // Example response
         *   // {
         *   //   "domains": [],
         *   //   "nextPageToken": "my_nextPageToken"
         *   // }
         * }
         *
         * main().catch(e => {
         *   console.error(e);
         *   throw e;
         * });
         *
         * ```
         *
         * @param params - Parameters for request
         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param callback - Optional callback that handles the response.
         * @returns A promise if used with async/await, or void if used with a callback.
         */
        list(params: Params$Resource$Domains$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
        list(params?: Params$Resource$Domains$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListDomainsResponse>>;
        list(params: Params$Resource$Domains$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
        list(params: Params$Resource$Domains$List, options: MethodOptions | BodyResponseCallback<Schema$ListDomainsResponse>, callback: BodyResponseCallback<Schema$ListDomainsResponse>): void;
        list(params: Params$Resource$Domains$List, callback: BodyResponseCallback<Schema$ListDomainsResponse>): void;
        list(callback: BodyResponseCallback<Schema$ListDomainsResponse>): void;
        /**
         * [Developer Preview](https://developers.google.com/workspace/preview): Verifies a user's ownership of a domain at the DNS level. Note that this is distinct from checking if the user has OWNER status within IRDB.
         * @example
         * ```js
         * // Before running the sample:
         * // - Enable the API at:
         * //   https://console.developers.google.com/apis/api/gmailpostmastertools.googleapis.com
         * // - Login into gcloud by running:
         * //   ```sh
         * //   $ gcloud auth application-default login
         * //   ```
         * // - Install the npm module by running:
         * //   ```sh
         * //   $ npm install googleapis
         * //   ```
         *
         * const {google} = require('googleapis');
         * const gmailpostmastertools = google.gmailpostmastertools('v2');
         *
         * async function main() {
         *   const auth = new google.auth.GoogleAuth({
         *     // Scopes can be specified either as an array or as a single, space-delimited string.
         *     scopes: [
         *       'https://www.googleapis.com/auth/postmaster',
         *       'https://www.googleapis.com/auth/postmaster.domain',
         *     ],
         *   });
         *
         *   // Acquire an auth client, and bind it to all future calls
         *   const authClient = await auth.getClient();
         *   google.options({auth: authClient});
         *
         *   // Do the magic
         *   const res = await gmailpostmastertools.domains.verify({
         *     // Required. The domain to verify.
         *     name: 'domains/my-domain',
         *
         *     // Request body metadata
         *     requestBody: {
         *       // request body parameters
         *       // {
         *       //   "verificationMethod": "my_verificationMethod"
         *       // }
         *     },
         *   });
         *   console.log(res.data);
         *
         *   // Example response
         *   // {}
         * }
         *
         * main().catch(e => {
         *   console.error(e);
         *   throw e;
         * });
         *
         * ```
         *
         * @param params - Parameters for request
         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param callback - Optional callback that handles the response.
         * @returns A promise if used with async/await, or void if used with a callback.
         */
        verify(params: Params$Resource$Domains$Verify, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
        verify(params?: Params$Resource$Domains$Verify, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$VerifyDomainResponse>>;
        verify(params: Params$Resource$Domains$Verify, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
        verify(params: Params$Resource$Domains$Verify, options: MethodOptions | BodyResponseCallback<Schema$VerifyDomainResponse>, callback: BodyResponseCallback<Schema$VerifyDomainResponse>): void;
        verify(params: Params$Resource$Domains$Verify, callback: BodyResponseCallback<Schema$VerifyDomainResponse>): void;
        verify(callback: BodyResponseCallback<Schema$VerifyDomainResponse>): void;
    }
    export interface Params$Resource$Domains$Create extends StandardParameters {
        /**
         * Request body metadata
         */
        requestBody?: Schema$CreateDomainRequest;
    }
    export interface Params$Resource$Domains$Delete extends StandardParameters {
        /**
         * Required. The domain to delete.
         */
        name?: string;
    }
    export interface Params$Resource$Domains$Get extends StandardParameters {
        /**
         * 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;
    }
    export interface Params$Resource$Domains$Getcompliancestatus extends StandardParameters {
        /**
         * Required. The resource name of the domain's compliance status to retrieve. Format: `domains/{domain_id\}/complianceStatus`.
         */
        name?: string;
    }
    export interface Params$Resource$Domains$Getverificationtoken extends StandardParameters {
        /**
         * Required. The resource name of the verification token to retrieve. Format: `domains/{domain\}/verificationToken`
         */
        name?: string;
        /**
         * Required. The verification method used. Must be specified, i.e. TXT or CNAME.
         */
        verificationMethod?: string;
    }
    export interface Params$Resource$Domains$List extends StandardParameters {
        /**
         * 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;
    }
    export interface Params$Resource$Domains$Verify extends StandardParameters {
        /**
         * Required. The domain to verify.
         */
        name?: string;
        /**
         * Request body metadata
         */
        requestBody?: Schema$VerifyDomainRequest;
    }
    export class Resource$Domains$Domainstats {
        context: APIRequestContext;
        constructor(context: APIRequestContext);
        /**
         * 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.
         * @example
         * ```js
         * // Before running the sample:
         * // - Enable the API at:
         * //   https://console.developers.google.com/apis/api/gmailpostmastertools.googleapis.com
         * // - Login into gcloud by running:
         * //   ```sh
         * //   $ gcloud auth application-default login
         * //   ```
         * // - Install the npm module by running:
         * //   ```sh
         * //   $ npm install googleapis
         * //   ```
         *
         * const {google} = require('googleapis');
         * const gmailpostmastertools = google.gmailpostmastertools('v2');
         *
         * async function main() {
         *   const auth = new google.auth.GoogleAuth({
         *     // Scopes can be specified either as an array or as a single, space-delimited string.
         *     scopes: [
         *       'https://www.googleapis.com/auth/postmaster',
         *       'https://www.googleapis.com/auth/postmaster.traffic.readonly',
         *     ],
         *   });
         *
         *   // Acquire an auth client, and bind it to all future calls
         *   const authClient = await auth.getClient();
         *   google.options({auth: authClient});
         *
         *   // Do the magic
         *   const res = await gmailpostmastertools.domains.domainStats.query({
         *     // Required. The parent resource name where the stats are queried. Format: domains/{domain\}
         *     parent: 'domains/my-domain',
         *
         *     // Request body metadata
         *     requestBody: {
         *       // request body parameters
         *       // {
         *       //   "aggregationGranularity": "my_aggregationGranularity",
         *       //   "metricDefinitions": [],
         *       //   "pageSize": 0,
         *       //   "pageToken": "my_pageToken",
         *       //   "parent": "my_parent",
         *       //   "timeQuery": {}
         *       // }
         *     },
         *   });
         *   console.log(res.data);
         *
         *   // Example response
         *   // {
         *   //   "domainStats": [],
         *   //   "nextPageToken": "my_nextPageToken"
         *   // }
         * }
         *
         * main().catch(e => {
         *   console.error(e);
         *   throw e;
         * });
         *
         * ```
         *
         * @param params - Parameters for request
         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param callback - Optional callback that handles the response.
         * @returns A promise if used with async/await, or void if used with a callback.
         */
        query(params: Params$Resource$Domains$Domainstats$Query, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
        query(params?: Params$Resource$Domains$Domainstats$Query, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$QueryDomainStatsResponse>>;
        query(params: Params$Resource$Domains$Domainstats$Query, options: StreamMethodOptions | Bod