@googleapis/merchantapi 6.0.1 → 9.0.0

package/lfp_v1beta.ts

@@ -260,7 +260,7 @@ export namespace merchantapi_lfp_v1beta {
      */
     linkedGbps?: string | null;
     /**
-     * Identifier. The name of the `LfpMerchantState` resource. Format: `accounts/{account\}/lfpMerchantStates/{target_merchant\}`
+     * Identifier. The name of the `LfpMerchantState` resource. Format: `accounts/{account\}/lfpMerchantStates/{target_merchant\}`. For example, `accounts/123456/lfpMerchantStates/567890`.
      */
     name?: string | null;
     /**
@@ -455,7 +455,7 @@ export namespace merchantapi_lfp_v1beta {
      */
     eventTime?: string | null;
     /**
-     * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
+     * Optional. The product expiration time. This field will not be set if the notification is sent for a product deletion event.
      */
     expirationTime?: string | null;
     /**
@@ -501,6 +501,86 @@ export namespace merchantapi_lfp_v1beta {
 
     /**
      * 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.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.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 merchantapi = google.merchantapi('lfp_v1beta');
+     *
+     * 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/content'],
+     *   });
+     *
+     *   // 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 merchantapi.accounts.lfpInventories.insert({
+     *     // Required. The LFP provider account. Format: `accounts/{account\}`
+     *     parent: 'accounts/my-account',
+     *
+     *     // Request body metadata
+     *     requestBody: {
+     *       // request body parameters
+     *       // {
+     *       //   "availability": "my_availability",
+     *       //   "collectionTime": "my_collectionTime",
+     *       //   "contentLanguage": "my_contentLanguage",
+     *       //   "feedLabel": "my_feedLabel",
+     *       //   "gtin": "my_gtin",
+     *       //   "name": "my_name",
+     *       //   "offerId": "my_offerId",
+     *       //   "pickupMethod": "my_pickupMethod",
+     *       //   "pickupSla": "my_pickupSla",
+     *       //   "price": {},
+     *       //   "quantity": "my_quantity",
+     *       //   "regionCode": "my_regionCode",
+     *       //   "storeCode": "my_storeCode",
+     *       //   "targetAccount": "my_targetAccount"
+     *       // }
+     *     },
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "availability": "my_availability",
+     *   //   "collectionTime": "my_collectionTime",
+     *   //   "contentLanguage": "my_contentLanguage",
+     *   //   "feedLabel": "my_feedLabel",
+     *   //   "gtin": "my_gtin",
+     *   //   "name": "my_name",
+     *   //   "offerId": "my_offerId",
+     *   //   "pickupMethod": "my_pickupMethod",
+     *   //   "pickupSla": "my_pickupSla",
+     *   //   "price": {},
+     *   //   "quantity": "my_quantity",
+     *   //   "regionCode": "my_regionCode",
+     *   //   "storeCode": "my_storeCode",
+     *   //   "targetAccount": "my_targetAccount"
+     *   // }
+     * }
+     *
+     * 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`.
@@ -611,6 +691,56 @@ export namespace merchantapi_lfp_v1beta {
 
     /**
      * Gets the LFP state of a merchant
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.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 merchantapi = google.merchantapi('lfp_v1beta');
+     *
+     * 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/content'],
+     *   });
+     *
+     *   // 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 merchantapi.accounts.lfpMerchantStates.get({
+     *     // Required. The name of the state to retrieve. Format: `accounts/{account\}/lfpMerchantStates/{target_merchant\}`. For example, `accounts/123456/lfpMerchantStates/567890`.
+     *     name: 'accounts/my-account/lfpMerchantStates/my-lfpMerchantState',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "countrySettings": [],
+     *   //   "inventoryStats": {},
+     *   //   "linkedGbps": "my_linkedGbps",
+     *   //   "name": "my_name",
+     *   //   "storeStates": []
+     *   // }
+     * }
+     *
+     * 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`.
@@ -704,7 +834,7 @@ export namespace merchantapi_lfp_v1beta {
   export interface Params$Resource$Accounts$Lfpmerchantstates$Get
     extends StandardParameters {
     /**
-     * Required. The name of the state to retrieve. Format: `accounts/{account\}/lfpMerchantStates/{target_merchant\}`
+     * Required. The name of the state to retrieve. Format: `accounts/{account\}/lfpMerchantStates/{target_merchant\}`. For example, `accounts/123456/lfpMerchantStates/567890`.
      */
     name?: string;
   }
@@ -717,6 +847,82 @@ export namespace merchantapi_lfp_v1beta {
 
     /**
      * Inserts a `LfpSale` for the given merchant.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.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 merchantapi = google.merchantapi('lfp_v1beta');
+     *
+     * 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/content'],
+     *   });
+     *
+     *   // 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 merchantapi.accounts.lfpSales.insert({
+     *     // Required. The LFP provider account. Format: `accounts/{lfp_partner\}`
+     *     parent: 'accounts/my-account',
+     *
+     *     // Request body metadata
+     *     requestBody: {
+     *       // request body parameters
+     *       // {
+     *       //   "contentLanguage": "my_contentLanguage",
+     *       //   "feedLabel": "my_feedLabel",
+     *       //   "gtin": "my_gtin",
+     *       //   "name": "my_name",
+     *       //   "offerId": "my_offerId",
+     *       //   "price": {},
+     *       //   "quantity": "my_quantity",
+     *       //   "regionCode": "my_regionCode",
+     *       //   "saleTime": "my_saleTime",
+     *       //   "storeCode": "my_storeCode",
+     *       //   "targetAccount": "my_targetAccount",
+     *       //   "uid": "my_uid"
+     *       // }
+     *     },
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "contentLanguage": "my_contentLanguage",
+     *   //   "feedLabel": "my_feedLabel",
+     *   //   "gtin": "my_gtin",
+     *   //   "name": "my_name",
+     *   //   "offerId": "my_offerId",
+     *   //   "price": {},
+     *   //   "quantity": "my_quantity",
+     *   //   "regionCode": "my_regionCode",
+     *   //   "saleTime": "my_saleTime",
+     *   //   "storeCode": "my_storeCode",
+     *   //   "targetAccount": "my_targetAccount",
+     *   //   "uid": "my_uid"
+     *   // }
+     * }
+     *
+     * 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`.
@@ -828,6 +1034,50 @@ export namespace merchantapi_lfp_v1beta {
 
     /**
      * Deletes a store for a target merchant.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.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 merchantapi = google.merchantapi('lfp_v1beta');
+     *
+     * 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/content'],
+     *   });
+     *
+     *   // 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 merchantapi.accounts.lfpStores.delete({
+     *     // Required. The name of the store to delete for the target merchant account. Format: `accounts/{account\}/lfpStores/{target_merchant\}~{store_code\}`
+     *     name: 'accounts/my-account/lfpStores/my-lfpStore',
+     *   });
+     *   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`.
@@ -919,6 +1169,62 @@ export namespace merchantapi_lfp_v1beta {
 
     /**
      * Retrieves information about a store.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.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 merchantapi = google.merchantapi('lfp_v1beta');
+     *
+     * 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/content'],
+     *   });
+     *
+     *   // 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 merchantapi.accounts.lfpStores.get({
+     *     // Required. The name of the store to retrieve. Format: `accounts/{account\}/lfpStores/{target_merchant\}~{store_code\}`
+     *     name: 'accounts/my-account/lfpStores/my-lfpStore',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "gcidCategory": [],
+     *   //   "matchingState": "my_matchingState",
+     *   //   "matchingStateHint": "my_matchingStateHint",
+     *   //   "name": "my_name",
+     *   //   "phoneNumber": "my_phoneNumber",
+     *   //   "placeId": "my_placeId",
+     *   //   "storeAddress": "my_storeAddress",
+     *   //   "storeCode": "my_storeCode",
+     *   //   "storeName": "my_storeName",
+     *   //   "targetAccount": "my_targetAccount",
+     *   //   "websiteUri": "my_websiteUri"
+     *   // }
+     * }
+     *
+     * 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`.
@@ -1010,6 +1316,80 @@ export namespace merchantapi_lfp_v1beta {
 
     /**
      * Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.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 merchantapi = google.merchantapi('lfp_v1beta');
+     *
+     * 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/content'],
+     *   });
+     *
+     *   // 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 merchantapi.accounts.lfpStores.insert({
+     *     // Required. The LFP provider account Format: `accounts/{account\}`
+     *     parent: 'accounts/my-account',
+     *
+     *     // Request body metadata
+     *     requestBody: {
+     *       // request body parameters
+     *       // {
+     *       //   "gcidCategory": [],
+     *       //   "matchingState": "my_matchingState",
+     *       //   "matchingStateHint": "my_matchingStateHint",
+     *       //   "name": "my_name",
+     *       //   "phoneNumber": "my_phoneNumber",
+     *       //   "placeId": "my_placeId",
+     *       //   "storeAddress": "my_storeAddress",
+     *       //   "storeCode": "my_storeCode",
+     *       //   "storeName": "my_storeName",
+     *       //   "targetAccount": "my_targetAccount",
+     *       //   "websiteUri": "my_websiteUri"
+     *       // }
+     *     },
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "gcidCategory": [],
+     *   //   "matchingState": "my_matchingState",
+     *   //   "matchingStateHint": "my_matchingStateHint",
+     *   //   "name": "my_name",
+     *   //   "phoneNumber": "my_phoneNumber",
+     *   //   "placeId": "my_placeId",
+     *   //   "storeAddress": "my_storeAddress",
+     *   //   "storeCode": "my_storeCode",
+     *   //   "storeName": "my_storeName",
+     *   //   "targetAccount": "my_targetAccount",
+     *   //   "websiteUri": "my_websiteUri"
+     *   // }
+     * }
+     *
+     * 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`.
@@ -1101,6 +1481,59 @@ export namespace merchantapi_lfp_v1beta {
 
     /**
      * Lists the stores of the target merchant, specified by the filter in `ListLfpStoresRequest`.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.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 merchantapi = google.merchantapi('lfp_v1beta');
+     *
+     * 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/content'],
+     *   });
+     *
+     *   // 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 merchantapi.accounts.lfpStores.list({
+     *     // 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.
+     *     pageSize: 'placeholder-value',
+     *     // 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 nextPageToken in the response to the previous request.
+     *     pageToken: 'placeholder-value',
+     *     // Required. The LFP partner. Format: `accounts/{account\}`
+     *     parent: 'accounts/my-account',
+     *     // Required. The Merchant Center id of the merchant to list stores for.
+     *     targetAccount: 'placeholder-value',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "lfpStores": [],
+     *   //   "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`.