@maxim_mazurok/gapi.client.merchantapi-datasources_v1beta 0.0.20240611

package/index.d.ts

@@ -0,0 +1,433 @@
+/* Type definitions for non-npm package Merchant API datasources_v1beta 0.0 */
+// Project: https://developers.devsite.corp.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=datasources_v1beta
+// Revision: 20240611
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+  /** Load Merchant API datasources_v1beta */
+  function load(
+    urlOrObject: 'https://merchantapi.googleapis.com/$discovery/rest?version=datasources_v1beta'
+  ): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(
+    name: 'merchantapi',
+    version: 'datasources_v1beta'
+  ): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(
+    name: 'merchantapi',
+    version: 'datasources_v1beta',
+    callback: () => any
+  ): void;
+
+  namespace merchantapi {
+    interface DataSource {
+      /** Output only. The data source id. */
+      dataSourceId?: string;
+      /** Required. The displayed data source name in the Merchant Center UI. */
+      displayName?: string;
+      /** Optional. The field is used only when data is managed through a file. */
+      fileInput?: FileInput;
+      /** Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. */
+      input?: string;
+      /** Required. The [local inventory](https://support.google.com/merchants/answer/7023001) data source. */
+      localInventoryDataSource?: LocalInventoryDataSource;
+      /** Identifier. The name of the data source. Format: `{datasource.name=accounts/{account}/dataSources/{datasource}}` */
+      name?: string;
+      /** Required. The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products. */
+      primaryProductDataSource?: PrimaryProductDataSource;
+      /** Required. The [promotion](https://support.google.com/merchants/answer/2906014) data source. */
+      promotionDataSource?: PromotionDataSource;
+      /** Required. The [regional inventory](https://support.google.com/merchants/answer/7439058) data source. */
+      regionalInventoryDataSource?: RegionalInventoryDataSource;
+      /** Required. The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. */
+      supplementalProductDataSource?: SupplementalProductDataSource;
+    }
+    interface Empty {}
+    interface FetchDataSourceRequest {}
+    interface FetchSettings {
+      /** Optional. The day of the month when the data source file should be fetched (1-31). This field can only be set for monthly frequency. */
+      dayOfMonth?: number;
+      /** Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency. */
+      dayOfWeek?: string;
+      /** Optional. Enables or pauses the fetch schedule. */
+      enabled?: boolean;
+      /** Optional. The URL where the data source file can be fetched. Google Merchant Center supports automatic scheduled uploads using the HTTP, HTTPS or SFTP protocols, so the value will need to be a valid link using one of those three protocols. Immutable for Google Sheets files. */
+      fetchUri?: string;
+      /** Required. The frequency describing fetch schedule. */
+      frequency?: string;
+      /** Optional. An optional password for fetch url. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117). */
+      password?: string;
+      /** Optional. The hour of the day when the data source file should be fetched. Minutes and seconds are not supported and will be ignored. */
+      timeOfDay?: TimeOfDay;
+      /** Optional. [Time zone](https://cldr.unicode.org) used for schedule. UTC by default. For example, "America/Los_Angeles". */
+      timeZone?: string;
+      /** Optional. An optional user name for fetch url. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117). */
+      username?: string;
+    }
+    interface FileInput {
+      /** Optional. Fetch details to deliver the data source. It contains settings for `FETCH` and `GOOGLE_SHEETS` file input types. The required fields vary based on the frequency of fetching. */
+      fetchSettings?: FetchSettings;
+      /** Output only. The type of file input. */
+      fileInputType?: string;
+      /** Optional. The file name of the data source. Required for `UPLOAD` file input type. */
+      fileName?: string;
+    }
+    interface ListDataSourcesResponse {
+      /** The data sources from the specified account. */
+      dataSources?: DataSource[];
+      /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+      nextPageToken?: string;
+    }
+    interface LocalInventoryDataSource {
+      /** Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. */
+      contentLanguage?: string;
+      /** Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). */
+      feedLabel?: string;
+    }
+    interface PrimaryProductDataSource {
+      /** Required. Immutable. Specifies the type of data source channel. */
+      channel?: string;
+      /** Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. */
+      contentLanguage?: string;
+      /** Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). */
+      countries?: string[];
+      /** Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. */
+      feedLabel?: string;
+    }
+    interface ProductChange {
+      /** The new value of the changed resource or attribute. */
+      newValue?: string;
+      /** The old value of the changed resource or attribute. */
+      oldValue?: string;
+      /** Countries that have the change (if applicable) */
+      regionCode?: string;
+      /** Reporting contexts that have the change (if applicable) */
+      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 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: `{product.name=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 PromotionDataSource {
+      /** Required. Immutable. The two-letter ISO 639-1 language of the items in the data source. */
+      contentLanguage?: string;
+      /** Required. Immutable. The target country used as part of the unique identifier. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). Promotions are only available in selected [countries](https://support.google.com/merchants/answer/4588460). */
+      targetCountry?: string;
+    }
+    interface RegionalInventoryDataSource {
+      /** Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. */
+      contentLanguage?: string;
+      /** Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). */
+      feedLabel?: string;
+    }
+    interface SupplementalProductDataSource {
+      /** Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. */
+      contentLanguage?: string;
+      /** Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. */
+      feedLabel?: string;
+    }
+    interface TimeOfDay {
+      /** Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */
+      hours?: number;
+      /** Minutes of hour of day. Must be from 0 to 59. */
+      minutes?: number;
+      /** Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */
+      nanos?: number;
+      /** Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */
+      seconds?: number;
+    }
+    interface DataSourcesResource {
+      /** Creates the new data source configuration for the given account. */
+      create(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 where this data source will be created. Format: `accounts/{account}` */
+        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: DataSource;
+      }): Request<DataSource>;
+      create(
+        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 where this data source will be created. Format: `accounts/{account}` */
+          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: DataSource
+      ): Request<DataSource>;
+      /** Deletes a data source from your Merchant Center account. */
+      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 data source to delete. Format: `accounts/{account}/dataSources/{datasource}` */
+        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<{}>;
+      /** Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. If you need to call this method more than once per day, you should use the Products service to update your product data instead. This method only works on data sources with a file input set. */
+      fetch(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 data source resource to fetch. Format: `accounts/{account}/dataSources/{datasource}` */
+        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 body */
+        resource: FetchDataSourceRequest;
+      }): Request<{}>;
+      fetch(
+        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 data source resource to fetch. Format: `accounts/{account}/dataSources/{datasource}` */
+          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;
+        },
+        body: FetchDataSourceRequest
+      ): Request<{}>;
+      /** Retrieves the data source configuration for the given account. */
+      get(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 data source to retrieve. Format: `accounts/{account}/dataSources/{datasource}` */
+        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<DataSource>;
+      /** Lists the configurations for data sources for the 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;
+        /** Optional. The maximum number of data sources to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of data sources will be returned. */
+        pageSize?: number;
+        /** Optional. A page token, received from a previous `ListDataSources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSources` must match the call that provided the page token. */
+        pageToken?: string;
+        /** Required. The account to list data sources for. Format: `accounts/{account}` */
+        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<ListDataSourcesResponse>;
+      /** Updates the existing data source configuration. The fields that are set in the update mask but not provided in the resource will be deleted. */
+      patch(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;
+        /** Identifier. The name of the data source. Format: `{datasource.name=accounts/{account}/dataSources/{datasource}}` */
+        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;
+        /** Required. The list of data source fields to be updated. Fields specified in the update mask without a value specified in the body will be deleted from the data source. Providing special "*" value for full data source replacement is not supported. */
+        updateMask?: 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: DataSource;
+      }): Request<DataSource>;
+      patch(
+        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;
+          /** Identifier. The name of the data source. Format: `{datasource.name=accounts/{account}/dataSources/{datasource}}` */
+          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;
+          /** Required. The list of data source fields to be updated. Fields specified in the update mask without a value specified in the body will be deleted from the data source. Providing special "*" value for full data source replacement is not supported. */
+          updateMask?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: DataSource
+      ): Request<DataSource>;
+    }
+    interface AccountsResource {
+      dataSources: DataSourcesResource;
+    }
+
+    const accounts: AccountsResource;
+  }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.merchantapi-datasources_v1beta",
+  "version": "0.0.20240611",
+  "description": "TypeScript typings for Merchant API datasources_v1beta",
+  "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 datasources_v1beta
+
+Programmatically manage your Merchant Center Accounts.
+For detailed description please check [documentation](https://developers.devsite.corp.google.com/merchant/api).
+
+## Installing
+
+Install typings for Merchant API:
+
+```
+npm install @types/gapi.client.merchantapi-datasources_v1beta --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=datasources_v1beta',
+  () => {
+    // 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', 'datasources_v1beta', () => {
+  // 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
+
+```