@google-shopping/lfp 0.6.0 → 0.8.0

package/build/src/v1/lfp_sale_service_client.d.ts

@@ -0,0 +1,275 @@
+import type * as gax from 'google-gax';
+import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax';
+import * as protos from '../../protos/protos';
+/**
+ *  Service for a [LFP
+ *  partner](https://support.google.com/merchants/answer/7676652) to submit sales
+ *  data for a merchant.
+ * @class
+ * @memberof v1
+ */
+export declare class LfpSaleServiceClient {
+    private _terminated;
+    private _opts;
+    private _providedCustomServicePath;
+    private _gaxModule;
+    private _gaxGrpc;
+    private _protos;
+    private _defaults;
+    private _universeDomain;
+    private _servicePath;
+    private _log;
+    auth: gax.GoogleAuth;
+    descriptors: Descriptors;
+    warn: (code: string, message: string, warnType?: string) => void;
+    innerApiCalls: {
+        [name: string]: Function;
+    };
+    pathTemplates: {
+        [name: string]: gax.PathTemplate;
+    };
+    lfpSaleServiceStub?: Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * Construct an instance of LfpSaleServiceClient.
+     *
+     * @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://cloud.google.com/docs/authentication/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 LfpSaleServiceClient({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;
+    /**
+     * Inserts a `LfpSale` for the given merchant.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The LFP provider account.
+     *   Format: `accounts/{lfp_partner}`
+     * @param {google.shopping.merchant.lfp.v1.LfpSale} request.lfpSale
+     *   Required. The sale 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.v1.LfpSale|LfpSale}.
+     *   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/v1/lfp_sale_service.insert_lfp_sale.js</caption>
+     * region_tag:merchantapi_v1_generated_LfpSaleService_InsertLfpSale_async
+     */
+    insertLfpSale(request?: protos.google.shopping.merchant.lfp.v1.IInsertLfpSaleRequest, options?: CallOptions): Promise<[
+        protos.google.shopping.merchant.lfp.v1.ILfpSale,
+        protos.google.shopping.merchant.lfp.v1.IInsertLfpSaleRequest | undefined,
+        {} | undefined
+    ]>;
+    insertLfpSale(request: protos.google.shopping.merchant.lfp.v1.IInsertLfpSaleRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.lfp.v1.ILfpSale, protos.google.shopping.merchant.lfp.v1.IInsertLfpSaleRequest | null | undefined, {} | null | undefined>): void;
+    insertLfpSale(request: protos.google.shopping.merchant.lfp.v1.IInsertLfpSaleRequest, callback: Callback<protos.google.shopping.merchant.lfp.v1.ILfpSale, protos.google.shopping.merchant.lfp.v1.IInsertLfpSaleRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * 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 lfpMerchantState resource name string.
+     *
+     * @param {string} account
+     * @param {string} lfp_merchant_state
+     * @returns {string} Resource name string.
+     */
+    lfpMerchantStatePath(account: string, lfpMerchantState: string): string;
+    /**
+     * Parse the account from LfpMerchantState resource.
+     *
+     * @param {string} lfpMerchantStateName
+     *   A fully-qualified path representing LfpMerchantState resource.
+     * @returns {string} A string representing the account.
+     */
+    matchAccountFromLfpMerchantStateName(lfpMerchantStateName: string): string | number;
+    /**
+     * Parse the lfp_merchant_state from LfpMerchantState resource.
+     *
+     * @param {string} lfpMerchantStateName
+     *   A fully-qualified path representing LfpMerchantState resource.
+     * @returns {string} A string representing the lfp_merchant_state.
+     */
+    matchLfpMerchantStateFromLfpMerchantStateName(lfpMerchantStateName: 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>;
+}