@google-shopping/lfp 0.1.0

package/build/src/index.d.ts

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

package/build/src/index.js

@@ -0,0 +1,37 @@
+"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.LfpStoreServiceClient = exports.LfpSaleServiceClient = exports.LfpInventoryServiceClient = exports.v1beta = void 0;
+const v1beta = require("./v1beta");
+exports.v1beta = v1beta;
+const LfpInventoryServiceClient = v1beta.LfpInventoryServiceClient;
+exports.LfpInventoryServiceClient = LfpInventoryServiceClient;
+const LfpSaleServiceClient = v1beta.LfpSaleServiceClient;
+exports.LfpSaleServiceClient = LfpSaleServiceClient;
+const LfpStoreServiceClient = v1beta.LfpStoreServiceClient;
+exports.LfpStoreServiceClient = LfpStoreServiceClient;
+exports.default = {
+    v1beta,
+    LfpInventoryServiceClient,
+    LfpSaleServiceClient,
+    LfpStoreServiceClient,
+};
+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;AAUjC,wBAAM;AARR,MAAM,yBAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AASjE,8DAAyB;AAP3B,MAAM,oBAAoB,GAAG,MAAM,CAAC,oBAAoB,CAAC;AAQvD,oDAAoB;AANtB,MAAM,qBAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AAOzD,sDAAqB;AAEvB,kBAAe;IACb,MAAM;IACN,yBAAyB;IACzB,oBAAoB;IACpB,qBAAqB;CACtB,CAAC;AACF,2CAA2C;AACnC,wBAAM"}

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

@@ -0,0 +1,3 @@
+export { LfpInventoryServiceClient } from './lfp_inventory_service_client';
+export { LfpSaleServiceClient } from './lfp_sale_service_client';
+export { LfpStoreServiceClient } from './lfp_store_service_client';

package/build/src/v1beta/index.js

@@ -0,0 +1,27 @@
+"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.LfpStoreServiceClient = exports.LfpSaleServiceClient = exports.LfpInventoryServiceClient = void 0;
+var lfp_inventory_service_client_1 = require("./lfp_inventory_service_client");
+Object.defineProperty(exports, "LfpInventoryServiceClient", { enumerable: true, get: function () { return lfp_inventory_service_client_1.LfpInventoryServiceClient; } });
+var lfp_sale_service_client_1 = require("./lfp_sale_service_client");
+Object.defineProperty(exports, "LfpSaleServiceClient", { enumerable: true, get: function () { return lfp_sale_service_client_1.LfpSaleServiceClient; } });
+var lfp_store_service_client_1 = require("./lfp_store_service_client");
+Object.defineProperty(exports, "LfpStoreServiceClient", { enumerable: true, get: function () { return lfp_store_service_client_1.LfpStoreServiceClient; } });
+//# 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,+EAAyE;AAAjE,yIAAA,yBAAyB,OAAA;AACjC,qEAA+D;AAAvD,+HAAA,oBAAoB,OAAA;AAC5B,uEAAiE;AAAzD,iIAAA,qBAAqB,OAAA"}

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

@@ -0,0 +1,267 @@
+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 local
+ *  inventories for a merchant.
+ * @class
+ * @memberof v1beta
+ */
+export declare class LfpInventoryServiceClient {
+    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;
+    };
+    lfpInventoryServiceStub?: Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * Construct an instance of LfpInventoryServiceClient.
+     *
+     * @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 LfpInventoryServiceClient({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 `LfpInventory` resource for the given target merchant account. If
+     * the resource already exists, it will be replaced. The inventory
+     * automatically expires after 30 days.
+     *
+     * @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.LfpInventory} request.lfpInventory
+     *   Required. The inventory 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.LfpInventory|LfpInventory}.
+     *   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_inventory_service.insert_lfp_inventory.js</caption>
+     * region_tag:merchantapi_v1beta_generated_LfpInventoryService_InsertLfpInventory_async
+     */
+    insertLfpInventory(request?: protos.google.shopping.merchant.lfp.v1beta.IInsertLfpInventoryRequest, options?: CallOptions): Promise<[
+        protos.google.shopping.merchant.lfp.v1beta.ILfpInventory,
+        (protos.google.shopping.merchant.lfp.v1beta.IInsertLfpInventoryRequest | undefined),
+        {} | undefined
+    ]>;
+    insertLfpInventory(request: protos.google.shopping.merchant.lfp.v1beta.IInsertLfpInventoryRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.lfp.v1beta.ILfpInventory, protos.google.shopping.merchant.lfp.v1beta.IInsertLfpInventoryRequest | null | undefined, {} | null | undefined>): void;
+    insertLfpInventory(request: protos.google.shopping.merchant.lfp.v1beta.IInsertLfpInventoryRequest, callback: Callback<protos.google.shopping.merchant.lfp.v1beta.ILfpInventory, protos.google.shopping.merchant.lfp.v1beta.IInsertLfpInventoryRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * 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>;
+}