@maxim_mazurok/gapi.client.merchantapi-inventories_v1 0.0.20250804

package/index.d.ts

@@ -0,0 +1,380 @@
+/* Type definitions for non-npm package Merchant API inventories_v1 0.0 */
+// Project: https://developers.google.com/merchant/api
+// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
+//                 Nick Amoscato <https://github.com/namoscato>
+//                 Declan Vong <https://github.com/declanvong>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+// IMPORTANT
+// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
+// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
+// Generated from: https://merchantapi.googleapis.com/$discovery/rest?version=inventories_v1
+// Revision: 20250804
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+  /** Load Merchant API inventories_v1 */
+  function load(
+    urlOrObject: 'https://merchantapi.googleapis.com/$discovery/rest?version=inventories_v1',
+  ): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(name: 'merchantapi', version: 'inventories_v1'): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(
+    name: 'merchantapi',
+    version: 'inventories_v1',
+    callback: () => any,
+  ): void;
+
+  namespace merchantapi {
+    interface Empty {}
+    interface Interval {
+      /** Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. */
+      endTime?: string;
+      /** 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;
+    }
+    interface ListLocalInventoriesResponse {
+      /** The `LocalInventory` resources for the given product from the specified account. */
+      localInventories?: 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;
+    }
+    interface 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;
+      /** The `RegionalInventory` resources for the given product from the specified account. */
+      regionalInventories?: RegionalInventory[];
+    }
+    interface LocalInventory {
+      /** Output only. The account that owns the product. This field will be ignored if set by the client. */
+      account?: string;
+      /** Optional. A list of local inventory attributes. */
+      localInventoryAttributes?: LocalInventoryAttributes;
+      /** Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` */
+      name?: string;
+      /** 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;
+    }
+    interface LocalInventoryAttributes {
+      /** [Availability](https://support.google.com/merchants/answer/3061342) of the product at this store. */
+      availability?: string;
+      /** Optional. Location of the product inside the store. Maximum length is 20 bytes. */
+      instoreProductLocation?: string;
+      /** 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;
+      /** 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;
+      /** Optional. Price of the product at this store. */
+      price?: Price;
+      /** Optional. Quantity of the product available at this store. Must be greater than or equal to zero. */
+      quantity?: string;
+      /** Optional. Sale price of the product at this store. Mandatory if `salePriceEffectiveDate` is defined. */
+      salePrice?: Price;
+      /** Optional. The `TimePeriod` of the sale at this store. */
+      salePriceEffectiveDate?: Interval;
+    }
+    interface 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;
+      /** The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). */
+      currencyCode?: string;
+    }
+    interface 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;
+      /** 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;
+      /** Countries that have the change (if applicable). Represented in the ISO 3166 format. */
+      regionCode?: string;
+      /** 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;
+    }
+    interface ProductStatusChangeMessage {
+      /** The target account that owns the entity that changed. Format : `accounts/{merchant_id}` */
+      account?: string;
+      /** The attribute in the resource that changed, in this case it will be always `Status`. */
+      attribute?: string;
+      /** A message to describe the change that happened to the product */
+      changes?: 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;
+      /** Optional. The product expiration time. This field will not be set if the notification is sent for a product deletion event. */
+      expirationTime?: string;
+      /** 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;
+      /** The product name. Format: `accounts/{account}/products/{product}` */
+      resource?: string;
+      /** The product id. */
+      resourceId?: string;
+      /** The resource that changed, in this case it will always be `Product`. */
+      resourceType?: string;
+    }
+    interface RegionalInventory {
+      /** Output only. The account that owns the product. This field will be ignored if set by the client. */
+      account?: string;
+      /** Output only. The name of the `RegionalInventory` resource. Format: `{regional_inventory.name=accounts/{account}/products/{product}/regionalInventories/{region}` */
+      name?: string;
+      /** 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;
+      /** Optional. A list of regional inventory attributes. */
+      regionalInventoryAttributes?: RegionalInventoryAttributes;
+    }
+    interface RegionalInventoryAttributes {
+      /** Optional. [Availability](https://support.google.com/merchants/answer/14644124) of the product in this region. */
+      availability?: string;
+      /** Optional. Price of the product in this region. */
+      price?: Price;
+      /** Optional. Sale price of the product in this region. Mandatory if `salePriceEffectiveDate` is defined. */
+      salePrice?: Price;
+      /** Optional. The `TimePeriod` of the sale price in this region. */
+      salePriceEffectiveDate?: Interval;
+    }
+    interface LocalInventoriesResource {
+      /** 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. */
+      delete(request?: {
+        /** 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;
+        /** Required. The name of the local inventory for the given product to delete. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` */
+        name: 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;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<{}>;
+      /** 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. */
+      insert(request: {
+        /** 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;
+        /** Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` */
+        parent: 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;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: LocalInventory;
+      }): Request<LocalInventory>;
+      insert(
+        request: {
+          /** 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;
+          /** Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` */
+          parent: 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;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: LocalInventory,
+      ): Request<LocalInventory>;
+      /** 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. */
+      list(request?: {
+        /** 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;
+        /** 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;
+        /** 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;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<ListLocalInventoriesResponse>;
+    }
+    interface RegionalInventoriesResource {
+      /** 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. */
+      delete(request?: {
+        /** 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;
+        /** Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` */
+        name: 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;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<{}>;
+      /** 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. */
+      insert(request: {
+        /** 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;
+        /** Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` */
+        parent: 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;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: RegionalInventory;
+      }): Request<RegionalInventory>;
+      insert(
+        request: {
+          /** 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;
+          /** Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` */
+          parent: 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;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: RegionalInventory,
+      ): Request<RegionalInventory>;
+      /** 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. */
+      list(request?: {
+        /** 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;
+        /** 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;
+        /** 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;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<ListRegionalInventoriesResponse>;
+    }
+    interface ProductsResource {
+      localInventories: LocalInventoriesResource;
+      regionalInventories: RegionalInventoriesResource;
+    }
+    interface AccountsResource {
+      products: ProductsResource;
+    }
+
+    const accounts: AccountsResource;
+  }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.merchantapi-inventories_v1",
+  "version": "0.0.20250804",
+  "description": "TypeScript typings for Merchant API inventories_v1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Maxim Mazurok",
+    "email": "maxim@mazurok.com",
+    "url": "https://maxim.mazurok.com"
+  },
+  "types": "index.d.ts",
+  "dependencies": {
+    "@types/gapi.client": "*",
+    "@types/gapi.client.discovery-v1": "*"
+  }
+}

package/readme.md

@@ -0,0 +1,73 @@
+# TypeScript typings for Merchant API inventories_v1
+
+Programmatically manage your Merchant Center Accounts.
+For detailed description please check [documentation](https://developers.google.com/merchant/api).
+
+## Installing
+
+Install typings for Merchant API:
+
+```
+npm install @types/gapi.client.merchantapi-inventories_v1 --save-dev
+```
+
+## Usage
+
+You need to initialize Google API client in your code:
+
+```typescript
+gapi.load('client', () => {
+  // now we can use gapi.client
+  // ...
+});
+```
+
+Then load api client wrapper:
+
+```typescript
+gapi.client.load(
+  'https://merchantapi.googleapis.com/$discovery/rest?version=inventories_v1',
+  () => {
+    // now we can use:
+    // gapi.client.merchantapi
+  },
+);
+```
+
+```typescript
+// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
+gapi.client.load('merchantapi', 'inventories_v1', () => {
+  // now we can use:
+  // gapi.client.merchantapi
+});
+```
+
+Don't forget to authenticate your client before sending any request to resources:
+
+```typescript
+// declare client_id registered in Google Developers Console
+var client_id = '',
+  scope = [
+    // Manage your product listings and accounts for Google Shopping
+    'https://www.googleapis.com/auth/content',
+  ],
+  immediate = true;
+// ...
+
+gapi.auth.authorize(
+  {client_id: client_id, scope: scope, immediate: immediate},
+  authResult => {
+    if (authResult && !authResult.error) {
+      /* handle successful authorization */
+    } else {
+      /* handle authorization error */
+    }
+  },
+);
+```
+
+After that you can use Merchant API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+```