@google-shopping/quota 0.1.1

package/build/src/index.d.ts

@@ -0,0 +1,11 @@
+import * as v1beta from './v1beta';
+declare const QuotaServiceClient: typeof v1beta.QuotaServiceClient;
+type QuotaServiceClient = v1beta.QuotaServiceClient;
+export { v1beta, QuotaServiceClient };
+declare const _default: {
+    v1beta: typeof v1beta;
+    QuotaServiceClient: typeof v1beta.QuotaServiceClient;
+};
+export default _default;
+import * as protos from '../protos/protos';
+export { protos };

package/build/src/index.js

@@ -0,0 +1,28 @@
+"use strict";
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// ** This file is automatically generated by synthtool. **
+// ** https://github.com/googleapis/synthtool **
+// ** All changes to this file may be overwritten. **
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.protos = exports.QuotaServiceClient = exports.v1beta = void 0;
+const v1beta = require("./v1beta");
+exports.v1beta = v1beta;
+const QuotaServiceClient = v1beta.QuotaServiceClient;
+exports.QuotaServiceClient = QuotaServiceClient;
+exports.default = { v1beta, QuotaServiceClient };
+const protos = require("../protos/protos");
+exports.protos = protos;
+//# sourceMappingURL=index.js.map

package/build/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,2DAA2D;AAC3D,gDAAgD;AAChD,qDAAqD;;;AAErD,mCAAmC;AAK3B,wBAAM;AAHd,MAAM,kBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAGrC,gDAAkB;AAClC,kBAAe,EAAC,MAAM,EAAE,kBAAkB,EAAC,CAAC;AAC5C,2CAA2C;AACnC,wBAAM"}

package/build/src/v1beta/index.d.ts

@@ -0,0 +1 @@
+export { QuotaServiceClient } from './quota_service_client';

package/build/src/v1beta/index.js

@@ -0,0 +1,23 @@
+"use strict";
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// ** This file is automatically generated by gapic-generator-typescript. **
+// ** https://github.com/googleapis/gapic-generator-typescript **
+// ** All changes to this file may be overwritten. **
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuotaServiceClient = void 0;
+var quota_service_client_1 = require("./quota_service_client");
+Object.defineProperty(exports, "QuotaServiceClient", { enumerable: true, get: function () { return quota_service_client_1.QuotaServiceClient; } });
+//# sourceMappingURL=index.js.map

package/build/src/v1beta/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v1beta/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,4EAA4E;AAC5E,iEAAiE;AACjE,qDAAqD;;;AAErD,+DAA0D;AAAlD,0HAAA,kBAAkB,OAAA"}

package/build/src/v1beta/quota_service_client.d.ts

@@ -0,0 +1,251 @@
+/// <reference types="node" />
+import type * as gax from 'google-gax';
+import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
+import { Transform } from 'stream';
+import * as protos from '../../protos/protos';
+/**
+ *  Service to get method call quota information per Merchant API method.
+ * @class
+ * @memberof v1beta
+ */
+export declare class QuotaServiceClient {
+    private _terminated;
+    private _opts;
+    private _providedCustomServicePath;
+    private _gaxModule;
+    private _gaxGrpc;
+    private _protos;
+    private _defaults;
+    private _universeDomain;
+    private _servicePath;
+    auth: gax.GoogleAuth;
+    descriptors: Descriptors;
+    warn: (code: string, message: string, warnType?: string) => void;
+    innerApiCalls: {
+        [name: string]: Function;
+    };
+    pathTemplates: {
+        [name: string]: gax.PathTemplate;
+    };
+    quotaServiceStub?: Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * Construct an instance of QuotaServiceClient.
+     *
+     * @param {object} [options] - The configuration object.
+     * The options accepted by the constructor are described in detail
+     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
+     * The common options are:
+     * @param {object} [options.credentials] - Credentials object.
+     * @param {string} [options.credentials.client_email]
+     * @param {string} [options.credentials.private_key]
+     * @param {string} [options.email] - Account email address. Required when
+     *     using a .pem or .p12 keyFilename.
+     * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
+     *     .p12 key downloaded from the Google Developers Console. If you provide
+     *     a path to a JSON file, the projectId option below is not necessary.
+     *     NOTE: .pem and .p12 require you to specify options.email as well.
+     * @param {number} [options.port] - The port on which to connect to
+     *     the remote host.
+     * @param {string} [options.projectId] - The project ID from the Google
+     *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
+     *     the environment variable GCLOUD_PROJECT for your project ID. If your
+     *     app is running in an environment which supports
+     *     {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
+     *     your project ID will be detected automatically.
+     * @param {string} [options.apiEndpoint] - The domain name of the
+     *     API remote host.
+     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
+     *     Follows the structure of {@link gapicConfig}.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
+     *     For more information, please check the
+     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
+     * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
+     *     need to avoid loading the default gRPC version and want to use the fallback
+     *     HTTP implementation. Load only fallback version and pass it to the constructor:
+     *     ```
+     *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
+     *     const client = new QuotaServiceClient({fallback: true}, gax);
+     *     ```
+     */
+    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
+    /**
+     * Initialize the client.
+     * Performs asynchronous operations (such as authentication) and prepares the client.
+     * This function will be called automatically when any class method is called for the
+     * first time, but if you need to initialize it before calling an actual method,
+     * feel free to call initialize() directly.
+     *
+     * You can await on this method if you want to make sure the client is initialized.
+     *
+     * @returns {Promise} A promise that resolves to an authenticated service stub.
+     */
+    initialize(): Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * The DNS address for this API service.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get servicePath(): string;
+    /**
+     * The DNS address for this API service - same as servicePath.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get apiEndpoint(): string;
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    get apiEndpoint(): string;
+    get universeDomain(): string;
+    /**
+     * The port for this API service.
+     * @returns {number} The default port for this service.
+     */
+    static get port(): number;
+    /**
+     * The scopes needed to make gRPC calls for every method defined
+     * in this service.
+     * @returns {string[]} List of default scopes.
+     */
+    static get scopes(): string[];
+    getProjectId(): Promise<string>;
+    getProjectId(callback: Callback<string, undefined, undefined>): void;
+    /**
+     * Lists the daily call quota and usage per group for your Merchant
+     * Center account.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The merchant account who owns the collection of method quotas
+     *   Format: accounts/{account}
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of quotas to return in the response, used
+     *   for paging. Defaults to 500; values above 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. Token (if provided) to retrieve the subsequent page. All other
+     *   parameters must match the original call that provided the page token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is Array of {@link protos.google.shopping.merchant.quota.v1beta.QuotaGroup|QuotaGroup}.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed and will merge results from all the pages into this array.
+     *   Note that it can affect your quota.
+     *   We recommend using `listQuotaGroupsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    listQuotaGroups(request?: protos.google.shopping.merchant.quota.v1beta.IListQuotaGroupsRequest, options?: CallOptions): Promise<[
+        protos.google.shopping.merchant.quota.v1beta.IQuotaGroup[],
+        protos.google.shopping.merchant.quota.v1beta.IListQuotaGroupsRequest | null,
+        protos.google.shopping.merchant.quota.v1beta.IListQuotaGroupsResponse
+    ]>;
+    listQuotaGroups(request: protos.google.shopping.merchant.quota.v1beta.IListQuotaGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.shopping.merchant.quota.v1beta.IListQuotaGroupsRequest, protos.google.shopping.merchant.quota.v1beta.IListQuotaGroupsResponse | null | undefined, protos.google.shopping.merchant.quota.v1beta.IQuotaGroup>): void;
+    listQuotaGroups(request: protos.google.shopping.merchant.quota.v1beta.IListQuotaGroupsRequest, callback: PaginationCallback<protos.google.shopping.merchant.quota.v1beta.IListQuotaGroupsRequest, protos.google.shopping.merchant.quota.v1beta.IListQuotaGroupsResponse | null | undefined, protos.google.shopping.merchant.quota.v1beta.IQuotaGroup>): void;
+    /**
+     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The merchant account who owns the collection of method quotas
+     *   Format: accounts/{account}
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of quotas to return in the response, used
+     *   for paging. Defaults to 500; values above 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. Token (if provided) to retrieve the subsequent page. All other
+     *   parameters must match the original call that provided the page token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing {@link protos.google.shopping.merchant.quota.v1beta.QuotaGroup|QuotaGroup} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. Note that it can affect your quota.
+     *   We recommend using `listQuotaGroupsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    listQuotaGroupsStream(request?: protos.google.shopping.merchant.quota.v1beta.IListQuotaGroupsRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `listQuotaGroups`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The merchant account who owns the collection of method quotas
+     *   Format: accounts/{account}
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of quotas to return in the response, used
+     *   for paging. Defaults to 500; values above 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. Token (if provided) to retrieve the subsequent page. All other
+     *   parameters must match the original call that provided the page token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link protos.google.shopping.merchant.quota.v1beta.QuotaGroup|QuotaGroup}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/quota_service.list_quota_groups.js</caption>
+     * region_tag:merchantapi_v1beta_generated_QuotaService_ListQuotaGroups_async
+     */
+    listQuotaGroupsAsync(request?: protos.google.shopping.merchant.quota.v1beta.IListQuotaGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.shopping.merchant.quota.v1beta.IQuotaGroup>;
+    /**
+     * Return a fully-qualified account resource name string.
+     *
+     * @param {string} account
+     * @returns {string} Resource name string.
+     */
+    accountPath(account: string): string;
+    /**
+     * Parse the account from Account resource.
+     *
+     * @param {string} accountName
+     *   A fully-qualified path representing Account resource.
+     * @returns {string} A string representing the account.
+     */
+    matchAccountFromAccountName(accountName: string): string | number;
+    /**
+     * Return a fully-qualified quotaGroup resource name string.
+     *
+     * @param {string} account
+     * @param {string} group
+     * @returns {string} Resource name string.
+     */
+    quotaGroupPath(account: string, group: string): string;
+    /**
+     * Parse the account from QuotaGroup resource.
+     *
+     * @param {string} quotaGroupName
+     *   A fully-qualified path representing QuotaGroup resource.
+     * @returns {string} A string representing the account.
+     */
+    matchAccountFromQuotaGroupName(quotaGroupName: string): string | number;
+    /**
+     * Parse the group from QuotaGroup resource.
+     *
+     * @param {string} quotaGroupName
+     *   A fully-qualified path representing QuotaGroup resource.
+     * @returns {string} A string representing the group.
+     */
+    matchGroupFromQuotaGroupName(quotaGroupName: string): string | number;
+    /**
+     * Terminate the gRPC channel and close the client.
+     *
+     * The client will no longer be usable and all future behavior is undefined.
+     * @returns {Promise} A promise that resolves when the client is closed.
+     */
+    close(): Promise<void>;
+}