@googleapis/merchantapi 11.0.0 → 12.0.0

package/build/inventories_v1.d.ts

@@ -0,0 +1,766 @@
+import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
+import { Readable } from 'stream';
+export declare namespace merchantapi_inventories_v1 {
+    export interface Options extends GlobalOptions {
+        version: 'inventories_v1';
+    }
+    interface StandardParameters {
+        /**
+         * Auth client or API Key for the request
+         */
+        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
+        /**
+         * V1 error format.
+         */
+        '$.xgafv'?: string;
+        /**
+         * OAuth access token.
+         */
+        access_token?: string;
+        /**
+         * Data format for response.
+         */
+        alt?: string;
+        /**
+         * JSONP
+         */
+        callback?: string;
+        /**
+         * Selector specifying which fields to include in a partial response.
+         */
+        fields?: string;
+        /**
+         * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
+         */
+        key?: string;
+        /**
+         * OAuth 2.0 token for the current user.
+         */
+        oauth_token?: string;
+        /**
+         * Returns response with indentations and line breaks.
+         */
+        prettyPrint?: boolean;
+        /**
+         * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
+         */
+        quotaUser?: string;
+        /**
+         * Legacy upload protocol for media (e.g. "media", "multipart").
+         */
+        uploadType?: string;
+        /**
+         * Upload protocol for media (e.g. "raw", "multipart").
+         */
+        upload_protocol?: string;
+    }
+    /**
+     * Merchant API
+     *
+     * Programmatically manage your Merchant Center Accounts.
+     *
+     * @example
+     * ```js
+     * const {google} = require('googleapis');
+     * const merchantapi = google.merchantapi('inventories_v1');
+     * ```
+     */
+    export class Merchantapi {
+        context: APIRequestContext;
+        accounts: Resource$Accounts;
+        constructor(options: GlobalOptions, google?: GoogleConfigurable);
+    }
+    /**
+     * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
+     */
+    export interface Schema$Empty {
+    }
+    /**
+     * Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
+     */
+    export interface Schema$Interval {
+        /**
+         * Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+         */
+        endTime?: string | null;
+        /**
+         * Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+         */
+        startTime?: string | null;
+    }
+    /**
+     * Response message for the `ListLocalInventories` method.
+     */
+    export interface Schema$ListLocalInventoriesResponse {
+        /**
+         * The `LocalInventory` resources for the given product from the specified account.
+         */
+        localInventories?: Schema$LocalInventory[];
+        /**
+         * A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+         */
+        nextPageToken?: string | null;
+    }
+    /**
+     * Response message for the `ListRegionalInventories` method.
+     */
+    export interface Schema$ListRegionalInventoriesResponse {
+        /**
+         * A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+         */
+        nextPageToken?: string | null;
+        /**
+         * The `RegionalInventory` resources for the given product from the specified account.
+         */
+        regionalInventories?: Schema$RegionalInventory[];
+    }
+    /**
+     * Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342).
+     */
+    export interface Schema$LocalInventory {
+        /**
+         * Output only. The account that owns the product. This field will be ignored if set by the client.
+         */
+        account?: string | null;
+        /**
+         * Optional. A list of local inventory attributes.
+         */
+        localInventoryAttributes?: Schema$LocalInventoryAttributes;
+        /**
+         * Output only. The name of the `LocalInventory` resource. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}`
+         */
+        name?: string | null;
+        /**
+         * Required. Immutable. Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information.
+         */
+        storeCode?: string | null;
+    }
+    /**
+     * Local inventory attributes.
+     */
+    export interface Schema$LocalInventoryAttributes {
+        /**
+         * [Availability](https://support.google.com/merchants/answer/3061342) of the product at this store.
+         */
+        availability?: string | null;
+        /**
+         * Optional. Location of the product inside the store. Maximum length is 20 bytes.
+         */
+        instoreProductLocation?: string | null;
+        /**
+         * Optional. Supported [pickup method](https://support.google.com/merchants/answer/3061342) for this product. Unless the value is `"not supported"`, this field must be submitted together with `pickupSla`.
+         */
+        pickupMethod?: string | null;
+        /**
+         * Optional. Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with `pickupMethod`. See more details [here](https://support.google.com/merchants/answer/3061342).
+         */
+        pickupSla?: string | null;
+        /**
+         * Optional. Price of the product at this store.
+         */
+        price?: Schema$Price;
+        /**
+         * Optional. Quantity of the product available at this store. Must be greater than or equal to zero.
+         */
+        quantity?: string | null;
+        /**
+         * Optional. Sale price of the product at this store. Mandatory if `salePriceEffectiveDate` is defined.
+         */
+        salePrice?: Schema$Price;
+        /**
+         * Optional. The `TimePeriod` of the sale at this store.
+         */
+        salePriceEffectiveDate?: Schema$Interval;
+    }
+    /**
+     * The price represented as a number and currency.
+     */
+    export interface Schema$Price {
+        /**
+         * The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+         */
+        amountMicros?: string | null;
+        /**
+         * The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+         */
+        currencyCode?: string | null;
+    }
+    /**
+     * The change that happened to the product including old value, new value, country code as the region code and reporting context.
+     */
+    export interface Schema$ProductChange {
+        /**
+         * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
+         */
+        newValue?: string | null;
+        /**
+         * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
+         */
+        oldValue?: string | null;
+        /**
+         * Countries that have the change (if applicable). Represented in the ISO 3166 format.
+         */
+        regionCode?: string | null;
+        /**
+         * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)
+         */
+        reportingContext?: string | null;
+    }
+    /**
+     * The message that the merchant will receive to notify about product status change event
+     */
+    export interface Schema$ProductStatusChangeMessage {
+        /**
+         * The target account that owns the entity that changed. Format : `accounts/{merchant_id\}`
+         */
+        account?: string | null;
+        /**
+         * The attribute in the resource that changed, in this case it will be always `Status`.
+         */
+        attribute?: string | null;
+        /**
+         * A message to describe the change that happened to the product
+         */
+        changes?: Schema$ProductChange[];
+        /**
+         * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.
+         */
+        eventTime?: string | null;
+        /**
+         * Optional. The product expiration time. This field will not be set if the notification is sent for a product deletion event.
+         */
+        expirationTime?: string | null;
+        /**
+         * The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id\}`
+         */
+        managingAccount?: string | null;
+        /**
+         * The product name. Format: `accounts/{account\}/products/{product\}`
+         */
+        resource?: string | null;
+        /**
+         * The product id.
+         */
+        resourceId?: string | null;
+        /**
+         * The resource that changed, in this case it will always be `Product`.
+         */
+        resourceType?: string | null;
+    }
+    /**
+     * Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific `region`. For a list of all accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/9698880).
+     */
+    export interface Schema$RegionalInventory {
+        /**
+         * Output only. The account that owns the product. This field will be ignored if set by the client.
+         */
+        account?: string | null;
+        /**
+         * Output only. The name of the `RegionalInventory` resource. Format: `{regional_inventory.name=accounts/{account\}/products/{product\}/regionalInventories/{region\}`
+         */
+        name?: string | null;
+        /**
+         * Required. Immutable. ID of the region for this `RegionalInventory` resource. See the [Regional availability and pricing](https://support.google.com/merchants/answer/9698880) for more details.
+         */
+        region?: string | null;
+        /**
+         * Optional. A list of regional inventory attributes.
+         */
+        regionalInventoryAttributes?: Schema$RegionalInventoryAttributes;
+    }
+    /**
+     * Regional inventory attributes.
+     */
+    export interface Schema$RegionalInventoryAttributes {
+        /**
+         * Optional. [Availability](https://support.google.com/merchants/answer/14644124) of the product in this region.
+         */
+        availability?: string | null;
+        /**
+         * Optional. Price of the product in this region.
+         */
+        price?: Schema$Price;
+        /**
+         * Optional. Sale price of the product in this region. Mandatory if `salePriceEffectiveDate` is defined.
+         */
+        salePrice?: Schema$Price;
+        /**
+         * Optional. The `TimePeriod` of the sale price in this region.
+         */
+        salePriceEffectiveDate?: Schema$Interval;
+    }
+    export class Resource$Accounts {
+        context: APIRequestContext;
+        products: Resource$Accounts$Products;
+        constructor(context: APIRequestContext);
+    }
+    export class Resource$Accounts$Products {
+        context: APIRequestContext;
+        localInventories: Resource$Accounts$Products$Localinventories;
+        regionalInventories: Resource$Accounts$Products$Regionalinventories;
+        constructor(context: APIRequestContext);
+    }
+    export class Resource$Accounts$Products$Localinventories {
+        context: APIRequestContext;
+        constructor(context: APIRequestContext);
+        /**
+         * Deletes the specified `LocalInventory` from the given product in your merchant account. It might take a up to an hour for the `LocalInventory` to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.
+         * @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('inventories_v1');
+         *
+         * 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.products.localInventories.delete({
+         *     // Required. The name of the local inventory for the given product to delete. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}`
+         *     name: 'accounts/my-account/products/my-product/localInventories/my-localInventorie',
+         *   });
+         *   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`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        delete(params: Params$Resource$Accounts$Products$Localinventories$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        delete(params?: Params$Resource$Accounts$Products$Localinventories$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
+        delete(params: Params$Resource$Accounts$Products$Localinventories$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        delete(params: Params$Resource$Accounts$Products$Localinventories$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
+        delete(params: Params$Resource$Accounts$Products$Localinventories$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
+        delete(callback: BodyResponseCallback<Schema$Empty>): void;
+        /**
+         * Inserts a `LocalInventory` resource to a product in your merchant account. Replaces the full `LocalInventory` resource if an entry with the same `storeCode` already exists for the product. It might take up to 30 minutes for the new or updated `LocalInventory` resource to appear in products.
+         * @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('inventories_v1');
+         *
+         * 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.products.localInventories.insert({
+         *     // Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}`
+         *     parent: 'accounts/my-account/products/my-product',
+         *
+         *     // Request body metadata
+         *     requestBody: {
+         *       // request body parameters
+         *       // {
+         *       //   "account": "my_account",
+         *       //   "localInventoryAttributes": {},
+         *       //   "name": "my_name",
+         *       //   "storeCode": "my_storeCode"
+         *       // }
+         *     },
+         *   });
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {
+         *   //   "account": "my_account",
+         *   //   "localInventoryAttributes": {},
+         *   //   "name": "my_name",
+         *   //   "storeCode": "my_storeCode"
+         *   // }
+         * }
+         *
+         * 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`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        insert(params: Params$Resource$Accounts$Products$Localinventories$Insert, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        insert(params?: Params$Resource$Accounts$Products$Localinventories$Insert, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$LocalInventory>>;
+        insert(params: Params$Resource$Accounts$Products$Localinventories$Insert, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        insert(params: Params$Resource$Accounts$Products$Localinventories$Insert, options: MethodOptions | BodyResponseCallback<Schema$LocalInventory>, callback: BodyResponseCallback<Schema$LocalInventory>): void;
+        insert(params: Params$Resource$Accounts$Products$Localinventories$Insert, callback: BodyResponseCallback<Schema$LocalInventory>): void;
+        insert(callback: BodyResponseCallback<Schema$LocalInventory>): void;
+        /**
+         * Lists the `LocalInventory` resources for the given product in your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. `LocalInventory` resources are listed per product for a given account.
+         * @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('inventories_v1');
+         *
+         * 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.products.localInventories.list({
+         *     // The maximum number of `LocalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 25000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum
+         *     pageSize: 'placeholder-value',
+         *     // A page token, received from a previous `ListLocalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListLocalInventories` 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 `name` of the parent product to list local inventories for. Format: `accounts/{account\}/products/{product\}`
+         *     parent: 'accounts/my-account/products/my-product',
+         *   });
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {
+         *   //   "localInventories": [],
+         *   //   "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`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        list(params: Params$Resource$Accounts$Products$Localinventories$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        list(params?: Params$Resource$Accounts$Products$Localinventories$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListLocalInventoriesResponse>>;
+        list(params: Params$Resource$Accounts$Products$Localinventories$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        list(params: Params$Resource$Accounts$Products$Localinventories$List, options: MethodOptions | BodyResponseCallback<Schema$ListLocalInventoriesResponse>, callback: BodyResponseCallback<Schema$ListLocalInventoriesResponse>): void;
+        list(params: Params$Resource$Accounts$Products$Localinventories$List, callback: BodyResponseCallback<Schema$ListLocalInventoriesResponse>): void;
+        list(callback: BodyResponseCallback<Schema$ListLocalInventoriesResponse>): void;
+    }
+    export interface Params$Resource$Accounts$Products$Localinventories$Delete extends StandardParameters {
+        /**
+         * Required. The name of the local inventory for the given product to delete. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}`
+         */
+        name?: string;
+    }
+    export interface Params$Resource$Accounts$Products$Localinventories$Insert extends StandardParameters {
+        /**
+         * Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}`
+         */
+        parent?: string;
+        /**
+         * Request body metadata
+         */
+        requestBody?: Schema$LocalInventory;
+    }
+    export interface Params$Resource$Accounts$Products$Localinventories$List extends StandardParameters {
+        /**
+         * The maximum number of `LocalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 25000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous `ListLocalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListLocalInventories` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
+         */
+        pageToken?: string;
+        /**
+         * Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account\}/products/{product\}`
+         */
+        parent?: string;
+    }
+    export class Resource$Accounts$Products$Regionalinventories {
+        context: APIRequestContext;
+        constructor(context: APIRequestContext);
+        /**
+         * Deletes the specified `RegionalInventory` resource from the given product in your merchant account. It might take up to an hour for the `RegionalInventory` to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.
+         * @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('inventories_v1');
+         *
+         * 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.products.regionalInventories.delete({
+         *     // Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}`
+         *     name: 'accounts/my-account/products/my-product/regionalInventories/my-regionalInventorie',
+         *   });
+         *   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`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        delete(params: Params$Resource$Accounts$Products$Regionalinventories$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        delete(params?: Params$Resource$Accounts$Products$Regionalinventories$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
+        delete(params: Params$Resource$Accounts$Products$Regionalinventories$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        delete(params: Params$Resource$Accounts$Products$Regionalinventories$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
+        delete(params: Params$Resource$Accounts$Products$Regionalinventories$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
+        delete(callback: BodyResponseCallback<Schema$Empty>): void;
+        /**
+         * Inserts a `RegionalInventory` to a given product in your merchant account. Replaces the full `RegionalInventory` resource if an entry with the same `region` already exists for the product. It might take up to 30 minutes for the new or updated `RegionalInventory` resource to appear in products.
+         * @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('inventories_v1');
+         *
+         * 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.products.regionalInventories.insert({
+         *     // Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}`
+         *     parent: 'accounts/my-account/products/my-product',
+         *
+         *     // Request body metadata
+         *     requestBody: {
+         *       // request body parameters
+         *       // {
+         *       //   "account": "my_account",
+         *       //   "name": "my_name",
+         *       //   "region": "my_region",
+         *       //   "regionalInventoryAttributes": {}
+         *       // }
+         *     },
+         *   });
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {
+         *   //   "account": "my_account",
+         *   //   "name": "my_name",
+         *   //   "region": "my_region",
+         *   //   "regionalInventoryAttributes": {}
+         *   // }
+         * }
+         *
+         * 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`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        insert(params: Params$Resource$Accounts$Products$Regionalinventories$Insert, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        insert(params?: Params$Resource$Accounts$Products$Regionalinventories$Insert, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$RegionalInventory>>;
+        insert(params: Params$Resource$Accounts$Products$Regionalinventories$Insert, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        insert(params: Params$Resource$Accounts$Products$Regionalinventories$Insert, options: MethodOptions | BodyResponseCallback<Schema$RegionalInventory>, callback: BodyResponseCallback<Schema$RegionalInventory>): void;
+        insert(params: Params$Resource$Accounts$Products$Regionalinventories$Insert, callback: BodyResponseCallback<Schema$RegionalInventory>): void;
+        insert(callback: BodyResponseCallback<Schema$RegionalInventory>): void;
+        /**
+         * Lists the `RegionalInventory` resources for the given product in your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. `RegionalInventory` resources are listed per product for a given account.
+         * @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('inventories_v1');
+         *
+         * 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.products.regionalInventories.list({
+         *     // The maximum number of `RegionalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.
+         *     pageSize: 'placeholder-value',
+         *     // A page token, received from a previous `ListRegionalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegionalInventories` 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 `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account\}/products/{product\}`
+         *     parent: 'accounts/my-account/products/my-product',
+         *   });
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {
+         *   //   "nextPageToken": "my_nextPageToken",
+         *   //   "regionalInventories": []
+         *   // }
+         * }
+         *
+         * 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`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        list(params: Params$Resource$Accounts$Products$Regionalinventories$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        list(params?: Params$Resource$Accounts$Products$Regionalinventories$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListRegionalInventoriesResponse>>;
+        list(params: Params$Resource$Accounts$Products$Regionalinventories$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        list(params: Params$Resource$Accounts$Products$Regionalinventories$List, options: MethodOptions | BodyResponseCallback<Schema$ListRegionalInventoriesResponse>, callback: BodyResponseCallback<Schema$ListRegionalInventoriesResponse>): void;
+        list(params: Params$Resource$Accounts$Products$Regionalinventories$List, callback: BodyResponseCallback<Schema$ListRegionalInventoriesResponse>): void;
+        list(callback: BodyResponseCallback<Schema$ListRegionalInventoriesResponse>): void;
+    }
+    export interface Params$Resource$Accounts$Products$Regionalinventories$Delete extends StandardParameters {
+        /**
+         * Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}`
+         */
+        name?: string;
+    }
+    export interface Params$Resource$Accounts$Products$Regionalinventories$Insert extends StandardParameters {
+        /**
+         * Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}`
+         */
+        parent?: string;
+        /**
+         * Request body metadata
+         */
+        requestBody?: Schema$RegionalInventory;
+    }
+    export interface Params$Resource$Accounts$Products$Regionalinventories$List extends StandardParameters {
+        /**
+         * The maximum number of `RegionalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous `ListRegionalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegionalInventories` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
+         */
+        pageToken?: string;
+        /**
+         * Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account\}/products/{product\}`
+         */
+        parent?: string;
+    }
+    export {};
+}