@google-shopping/lfp 0.1.0

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

@@ -0,0 +1,430 @@
+/// <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 for a [LFP
+ *  partner](https://support.google.com/merchants/answer/7676652) to submit local
+ *  stores for a merchant.
+ * @class
+ * @memberof v1beta
+ */
+export declare class LfpStoreServiceClient {
+    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;
+    };
+    lfpStoreServiceStub?: Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * Construct an instance of LfpStoreServiceClient.
+     *
+     * @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 LfpStoreServiceClient({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;
+    /**
+     * Retrieves information about a store.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. The name of the store to retrieve.
+     *   Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
+     * @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 an object representing {@link protos.google.shopping.merchant.lfp.v1beta.LfpStore|LfpStore}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/lfp_store_service.get_lfp_store.js</caption>
+     * region_tag:merchantapi_v1beta_generated_LfpStoreService_GetLfpStore_async
+     */
+    getLfpStore(request?: protos.google.shopping.merchant.lfp.v1beta.IGetLfpStoreRequest, options?: CallOptions): Promise<[
+        protos.google.shopping.merchant.lfp.v1beta.ILfpStore,
+        (protos.google.shopping.merchant.lfp.v1beta.IGetLfpStoreRequest | undefined),
+        {} | undefined
+    ]>;
+    getLfpStore(request: protos.google.shopping.merchant.lfp.v1beta.IGetLfpStoreRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.lfp.v1beta.ILfpStore, protos.google.shopping.merchant.lfp.v1beta.IGetLfpStoreRequest | null | undefined, {} | null | undefined>): void;
+    getLfpStore(request: protos.google.shopping.merchant.lfp.v1beta.IGetLfpStoreRequest, callback: Callback<protos.google.shopping.merchant.lfp.v1beta.ILfpStore, protos.google.shopping.merchant.lfp.v1beta.IGetLfpStoreRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Inserts a store for the target merchant. If the store with the same store
+     * code already exists, it will be replaced.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The LFP provider account
+     *   Format: `accounts/{account}`
+     * @param {google.shopping.merchant.lfp.v1beta.LfpStore} request.lfpStore
+     *   Required. The store to insert.
+     * @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 an object representing {@link protos.google.shopping.merchant.lfp.v1beta.LfpStore|LfpStore}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/lfp_store_service.insert_lfp_store.js</caption>
+     * region_tag:merchantapi_v1beta_generated_LfpStoreService_InsertLfpStore_async
+     */
+    insertLfpStore(request?: protos.google.shopping.merchant.lfp.v1beta.IInsertLfpStoreRequest, options?: CallOptions): Promise<[
+        protos.google.shopping.merchant.lfp.v1beta.ILfpStore,
+        (protos.google.shopping.merchant.lfp.v1beta.IInsertLfpStoreRequest | undefined),
+        {} | undefined
+    ]>;
+    insertLfpStore(request: protos.google.shopping.merchant.lfp.v1beta.IInsertLfpStoreRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.lfp.v1beta.ILfpStore, protos.google.shopping.merchant.lfp.v1beta.IInsertLfpStoreRequest | null | undefined, {} | null | undefined>): void;
+    insertLfpStore(request: protos.google.shopping.merchant.lfp.v1beta.IInsertLfpStoreRequest, callback: Callback<protos.google.shopping.merchant.lfp.v1beta.ILfpStore, protos.google.shopping.merchant.lfp.v1beta.IInsertLfpStoreRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Deletes a store for a target merchant.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. The name of the store to delete for the target merchant account.
+     *   Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
+     * @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 an object representing {@link protos.google.protobuf.Empty|Empty}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/lfp_store_service.delete_lfp_store.js</caption>
+     * region_tag:merchantapi_v1beta_generated_LfpStoreService_DeleteLfpStore_async
+     */
+    deleteLfpStore(request?: protos.google.shopping.merchant.lfp.v1beta.IDeleteLfpStoreRequest, options?: CallOptions): Promise<[
+        protos.google.protobuf.IEmpty,
+        (protos.google.shopping.merchant.lfp.v1beta.IDeleteLfpStoreRequest | undefined),
+        {} | undefined
+    ]>;
+    deleteLfpStore(request: protos.google.shopping.merchant.lfp.v1beta.IDeleteLfpStoreRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.shopping.merchant.lfp.v1beta.IDeleteLfpStoreRequest | null | undefined, {} | null | undefined>): void;
+    deleteLfpStore(request: protos.google.shopping.merchant.lfp.v1beta.IDeleteLfpStoreRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.shopping.merchant.lfp.v1beta.IDeleteLfpStoreRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Lists the stores of the target merchant, specified by the filter in
+     * `ListLfpStoresRequest`.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The LFP partner.
+     *   Format: `accounts/{account}`
+     * @param {number} request.targetAccount
+     *   Required. The Merchant Center id of the merchant to list stores for.
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of `LfpStore` resources for the given account
+     *   to return. The service returns fewer than this value if the number of
+     *   stores for the given account is less than the `pageSize`. The default value
+     *   is 250. The maximum value is 1000; If a value higher than the maximum is
+     *   specified, then the `pageSize` will default to the maximum.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListLfpStoresRequest`
+     *   call. Provide the page token to retrieve the subsequent page. When
+     *   paginating, all other parameters provided to `ListLfpStoresRequest` must
+     *   match the call that provided the page token. The token returned as
+     *   {@link protos.google.shopping.merchant.lfp.v1beta.ListLfpStoresResponse.next_page_token|nextPageToken}
+     *   in the response to the previous request.
+     * @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.lfp.v1beta.LfpStore|LfpStore}.
+     *   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 `listLfpStoresAsync()`
+     *   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.
+     */
+    listLfpStores(request?: protos.google.shopping.merchant.lfp.v1beta.IListLfpStoresRequest, options?: CallOptions): Promise<[
+        protos.google.shopping.merchant.lfp.v1beta.ILfpStore[],
+        protos.google.shopping.merchant.lfp.v1beta.IListLfpStoresRequest | null,
+        protos.google.shopping.merchant.lfp.v1beta.IListLfpStoresResponse
+    ]>;
+    listLfpStores(request: protos.google.shopping.merchant.lfp.v1beta.IListLfpStoresRequest, options: CallOptions, callback: PaginationCallback<protos.google.shopping.merchant.lfp.v1beta.IListLfpStoresRequest, protos.google.shopping.merchant.lfp.v1beta.IListLfpStoresResponse | null | undefined, protos.google.shopping.merchant.lfp.v1beta.ILfpStore>): void;
+    listLfpStores(request: protos.google.shopping.merchant.lfp.v1beta.IListLfpStoresRequest, callback: PaginationCallback<protos.google.shopping.merchant.lfp.v1beta.IListLfpStoresRequest, protos.google.shopping.merchant.lfp.v1beta.IListLfpStoresResponse | null | undefined, protos.google.shopping.merchant.lfp.v1beta.ILfpStore>): 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 LFP partner.
+     *   Format: `accounts/{account}`
+     * @param {number} request.targetAccount
+     *   Required. The Merchant Center id of the merchant to list stores for.
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of `LfpStore` resources for the given account
+     *   to return. The service returns fewer than this value if the number of
+     *   stores for the given account is less than the `pageSize`. The default value
+     *   is 250. The maximum value is 1000; If a value higher than the maximum is
+     *   specified, then the `pageSize` will default to the maximum.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListLfpStoresRequest`
+     *   call. Provide the page token to retrieve the subsequent page. When
+     *   paginating, all other parameters provided to `ListLfpStoresRequest` must
+     *   match the call that provided the page token. The token returned as
+     *   {@link protos.google.shopping.merchant.lfp.v1beta.ListLfpStoresResponse.next_page_token|nextPageToken}
+     *   in the response to the previous request.
+     * @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.lfp.v1beta.LfpStore|LfpStore} 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 `listLfpStoresAsync()`
+     *   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.
+     */
+    listLfpStoresStream(request?: protos.google.shopping.merchant.lfp.v1beta.IListLfpStoresRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `listLfpStores`, 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 LFP partner.
+     *   Format: `accounts/{account}`
+     * @param {number} request.targetAccount
+     *   Required. The Merchant Center id of the merchant to list stores for.
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of `LfpStore` resources for the given account
+     *   to return. The service returns fewer than this value if the number of
+     *   stores for the given account is less than the `pageSize`. The default value
+     *   is 250. The maximum value is 1000; If a value higher than the maximum is
+     *   specified, then the `pageSize` will default to the maximum.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListLfpStoresRequest`
+     *   call. Provide the page token to retrieve the subsequent page. When
+     *   paginating, all other parameters provided to `ListLfpStoresRequest` must
+     *   match the call that provided the page token. The token returned as
+     *   {@link protos.google.shopping.merchant.lfp.v1beta.ListLfpStoresResponse.next_page_token|nextPageToken}
+     *   in the response to the previous request.
+     * @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.lfp.v1beta.LfpStore|LfpStore}. 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/lfp_store_service.list_lfp_stores.js</caption>
+     * region_tag:merchantapi_v1beta_generated_LfpStoreService_ListLfpStores_async
+     */
+    listLfpStoresAsync(request?: protos.google.shopping.merchant.lfp.v1beta.IListLfpStoresRequest, options?: CallOptions): AsyncIterable<protos.google.shopping.merchant.lfp.v1beta.ILfpStore>;
+    /**
+     * 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 lfpInventory resource name string.
+     *
+     * @param {string} account
+     * @param {string} target_merchant
+     * @param {string} store_code
+     * @param {string} offer
+     * @returns {string} Resource name string.
+     */
+    lfpInventoryPath(account: string, targetMerchant: string, storeCode: string, offer: string): string;
+    /**
+     * Parse the account from LfpInventory resource.
+     *
+     * @param {string} lfpInventoryName
+     *   A fully-qualified path representing LfpInventory resource.
+     * @returns {string} A string representing the account.
+     */
+    matchAccountFromLfpInventoryName(lfpInventoryName: string): string | number;
+    /**
+     * Parse the target_merchant from LfpInventory resource.
+     *
+     * @param {string} lfpInventoryName
+     *   A fully-qualified path representing LfpInventory resource.
+     * @returns {string} A string representing the target_merchant.
+     */
+    matchTargetMerchantFromLfpInventoryName(lfpInventoryName: string): string | number;
+    /**
+     * Parse the store_code from LfpInventory resource.
+     *
+     * @param {string} lfpInventoryName
+     *   A fully-qualified path representing LfpInventory resource.
+     * @returns {string} A string representing the store_code.
+     */
+    matchStoreCodeFromLfpInventoryName(lfpInventoryName: string): string | number;
+    /**
+     * Parse the offer from LfpInventory resource.
+     *
+     * @param {string} lfpInventoryName
+     *   A fully-qualified path representing LfpInventory resource.
+     * @returns {string} A string representing the offer.
+     */
+    matchOfferFromLfpInventoryName(lfpInventoryName: string): string | number;
+    /**
+     * Return a fully-qualified lfpSale resource name string.
+     *
+     * @param {string} account
+     * @param {string} sale
+     * @returns {string} Resource name string.
+     */
+    lfpSalePath(account: string, sale: string): string;
+    /**
+     * Parse the account from LfpSale resource.
+     *
+     * @param {string} lfpSaleName
+     *   A fully-qualified path representing LfpSale resource.
+     * @returns {string} A string representing the account.
+     */
+    matchAccountFromLfpSaleName(lfpSaleName: string): string | number;
+    /**
+     * Parse the sale from LfpSale resource.
+     *
+     * @param {string} lfpSaleName
+     *   A fully-qualified path representing LfpSale resource.
+     * @returns {string} A string representing the sale.
+     */
+    matchSaleFromLfpSaleName(lfpSaleName: string): string | number;
+    /**
+     * Return a fully-qualified lfpStore resource name string.
+     *
+     * @param {string} account
+     * @param {string} target_merchant
+     * @param {string} store_code
+     * @returns {string} Resource name string.
+     */
+    lfpStorePath(account: string, targetMerchant: string, storeCode: string): string;
+    /**
+     * Parse the account from LfpStore resource.
+     *
+     * @param {string} lfpStoreName
+     *   A fully-qualified path representing LfpStore resource.
+     * @returns {string} A string representing the account.
+     */
+    matchAccountFromLfpStoreName(lfpStoreName: string): string | number;
+    /**
+     * Parse the target_merchant from LfpStore resource.
+     *
+     * @param {string} lfpStoreName
+     *   A fully-qualified path representing LfpStore resource.
+     * @returns {string} A string representing the target_merchant.
+     */
+    matchTargetMerchantFromLfpStoreName(lfpStoreName: string): string | number;
+    /**
+     * Parse the store_code from LfpStore resource.
+     *
+     * @param {string} lfpStoreName
+     *   A fully-qualified path representing LfpStore resource.
+     * @returns {string} A string representing the store_code.
+     */
+    matchStoreCodeFromLfpStoreName(lfpStoreName: 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>;
+}