@googleapis/merchantapi 16.0.0 → 17.0.0

package/quota_v1.ts

@@ -124,6 +124,32 @@ export namespace merchantapi_quota_v1 {
     }
   }
 
+  /**
+   * A limit of a certain type that is applied to an account.
+   */
+  export interface Schema$AccountLimit {
+    /**
+     * Identifier. The limit part of the name will be a combination of the type and the scope. For example: `accounts/123/limits/products~ADS_NON_EEA` Format: `accounts/{account\}/limits/{limit\}`
+     */
+    name?: string | null;
+    /**
+     * The limit for products.
+     */
+    products?: Schema$ProductLimit;
+  }
+  /**
+   * Response message for the `ListAccountLimits` method.
+   */
+  export interface Schema$ListAccountLimitsResponse {
+    /**
+     * The limits for the given account.
+     */
+    accountLimits?: Schema$AccountLimit[];
+    /**
+     * 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 | null;
+  }
   /**
    * Response message for the ListMethodGroups method.
    */
@@ -179,6 +205,19 @@ export namespace merchantapi_quota_v1 {
      */
     reportingContext?: string | null;
   }
+  /**
+   * The limit for products.
+   */
+  export interface Schema$ProductLimit {
+    /**
+     * Required. The maximum number of products that are allowed in the account in the given scope.
+     */
+    limit?: string | null;
+    /**
+     * Required. The scope of the product limit.
+     */
+    scope?: string | null;
+  }
   /**
    * The message that the merchant will receive to notify about product status change event
    */
@@ -248,13 +287,330 @@ export namespace merchantapi_quota_v1 {
 
   export class Resource$Accounts {
     context: APIRequestContext;
+    limits: Resource$Accounts$Limits;
     quotas: Resource$Accounts$Quotas;
     constructor(context: APIRequestContext) {
       this.context = context;
+      this.limits = new Resource$Accounts$Limits(this.context);
       this.quotas = new Resource$Accounts$Quotas(this.context);
     }
   }
 
+  export class Resource$Accounts$Limits {
+    context: APIRequestContext;
+    constructor(context: APIRequestContext) {
+      this.context = context;
+    }
+
+    /**
+     * Retrieves an account limit.
+     * @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('quota_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.limits.get({
+     *     // Required. The name of the limit to retrieve. Format: `accounts/{account\}/limits/{limit\}` For example: `accounts/123/limits/products~ADS_NON_EEA`
+     *     name: 'accounts/my-account/limits/my-limit',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "name": "my_name",
+     *   //   "products": {}
+     *   // }
+     * }
+     *
+     * 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.
+     */
+    get(
+      params: Params$Resource$Accounts$Limits$Get,
+      options: StreamMethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Readable>>;
+    get(
+      params?: Params$Resource$Accounts$Limits$Get,
+      options?: MethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Schema$AccountLimit>>;
+    get(
+      params: Params$Resource$Accounts$Limits$Get,
+      options: StreamMethodOptions | BodyResponseCallback<Readable>,
+      callback: BodyResponseCallback<Readable>
+    ): void;
+    get(
+      params: Params$Resource$Accounts$Limits$Get,
+      options: MethodOptions | BodyResponseCallback<Schema$AccountLimit>,
+      callback: BodyResponseCallback<Schema$AccountLimit>
+    ): void;
+    get(
+      params: Params$Resource$Accounts$Limits$Get,
+      callback: BodyResponseCallback<Schema$AccountLimit>
+    ): void;
+    get(callback: BodyResponseCallback<Schema$AccountLimit>): void;
+    get(
+      paramsOrCallback?:
+        | Params$Resource$Accounts$Limits$Get
+        | BodyResponseCallback<Schema$AccountLimit>
+        | BodyResponseCallback<Readable>,
+      optionsOrCallback?:
+        | MethodOptions
+        | StreamMethodOptions
+        | BodyResponseCallback<Schema$AccountLimit>
+        | BodyResponseCallback<Readable>,
+      callback?:
+        | BodyResponseCallback<Schema$AccountLimit>
+        | BodyResponseCallback<Readable>
+    ):
+      | void
+      | Promise<GaxiosResponseWithHTTP2<Schema$AccountLimit>>
+      | Promise<GaxiosResponseWithHTTP2<Readable>> {
+      let params = (paramsOrCallback ||
+        {}) as Params$Resource$Accounts$Limits$Get;
+      let options = (optionsOrCallback || {}) as MethodOptions;
+
+      if (typeof paramsOrCallback === 'function') {
+        callback = paramsOrCallback;
+        params = {} as Params$Resource$Accounts$Limits$Get;
+        options = {};
+      }
+
+      if (typeof optionsOrCallback === 'function') {
+        callback = optionsOrCallback;
+        options = {};
+      }
+
+      const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
+      const parameters = {
+        options: Object.assign(
+          {
+            url: (rootUrl + '/quota/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
+            method: 'GET',
+            apiVersion: '',
+          },
+          options
+        ),
+        params,
+        requiredParams: ['name'],
+        pathParams: ['name'],
+        context: this.context,
+      };
+      if (callback) {
+        createAPIRequest<Schema$AccountLimit>(
+          parameters,
+          callback as BodyResponseCallback<unknown>
+        );
+      } else {
+        return createAPIRequest<Schema$AccountLimit>(parameters);
+      }
+    }
+
+    /**
+     * Lists the limits of an 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('quota_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.limits.list({
+     *     // Required. A filter on the limit `type` is required, for example, `type = "products"`.
+     *     filter: 'placeholder-value',
+     *     // Optional. The maximum number of limits to return. The service may return fewer than this value. If unspecified, at most 100 limits will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+     *     pageSize: 'placeholder-value',
+     *     // Optional. A page token, received from a previous `ListAccountLimits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLimits` must match the call that provided the page token.
+     *     pageToken: 'placeholder-value',
+     *     // Required. The parent account. Format: `accounts/{account\}`
+     *     parent: 'accounts/my-account',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "accountLimits": [],
+     *   //   "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$Limits$List,
+      options: StreamMethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Readable>>;
+    list(
+      params?: Params$Resource$Accounts$Limits$List,
+      options?: MethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Schema$ListAccountLimitsResponse>>;
+    list(
+      params: Params$Resource$Accounts$Limits$List,
+      options: StreamMethodOptions | BodyResponseCallback<Readable>,
+      callback: BodyResponseCallback<Readable>
+    ): void;
+    list(
+      params: Params$Resource$Accounts$Limits$List,
+      options:
+        | MethodOptions
+        | BodyResponseCallback<Schema$ListAccountLimitsResponse>,
+      callback: BodyResponseCallback<Schema$ListAccountLimitsResponse>
+    ): void;
+    list(
+      params: Params$Resource$Accounts$Limits$List,
+      callback: BodyResponseCallback<Schema$ListAccountLimitsResponse>
+    ): void;
+    list(
+      callback: BodyResponseCallback<Schema$ListAccountLimitsResponse>
+    ): void;
+    list(
+      paramsOrCallback?:
+        | Params$Resource$Accounts$Limits$List
+        | BodyResponseCallback<Schema$ListAccountLimitsResponse>
+        | BodyResponseCallback<Readable>,
+      optionsOrCallback?:
+        | MethodOptions
+        | StreamMethodOptions
+        | BodyResponseCallback<Schema$ListAccountLimitsResponse>
+        | BodyResponseCallback<Readable>,
+      callback?:
+        | BodyResponseCallback<Schema$ListAccountLimitsResponse>
+        | BodyResponseCallback<Readable>
+    ):
+      | void
+      | Promise<GaxiosResponseWithHTTP2<Schema$ListAccountLimitsResponse>>
+      | Promise<GaxiosResponseWithHTTP2<Readable>> {
+      let params = (paramsOrCallback ||
+        {}) as Params$Resource$Accounts$Limits$List;
+      let options = (optionsOrCallback || {}) as MethodOptions;
+
+      if (typeof paramsOrCallback === 'function') {
+        callback = paramsOrCallback;
+        params = {} as Params$Resource$Accounts$Limits$List;
+        options = {};
+      }
+
+      if (typeof optionsOrCallback === 'function') {
+        callback = optionsOrCallback;
+        options = {};
+      }
+
+      const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
+      const parameters = {
+        options: Object.assign(
+          {
+            url: (rootUrl + '/quota/v1/{+parent}/limits').replace(
+              /([^:]\/)\/+/g,
+              '$1'
+            ),
+            method: 'GET',
+            apiVersion: '',
+          },
+          options
+        ),
+        params,
+        requiredParams: ['parent'],
+        pathParams: ['parent'],
+        context: this.context,
+      };
+      if (callback) {
+        createAPIRequest<Schema$ListAccountLimitsResponse>(
+          parameters,
+          callback as BodyResponseCallback<unknown>
+        );
+      } else {
+        return createAPIRequest<Schema$ListAccountLimitsResponse>(parameters);
+      }
+    }
+  }
+
+  export interface Params$Resource$Accounts$Limits$Get extends StandardParameters {
+    /**
+     * Required. The name of the limit to retrieve. Format: `accounts/{account\}/limits/{limit\}` For example: `accounts/123/limits/products~ADS_NON_EEA`
+     */
+    name?: string;
+  }
+  export interface Params$Resource$Accounts$Limits$List extends StandardParameters {
+    /**
+     * Required. A filter on the limit `type` is required, for example, `type = "products"`.
+     */
+    filter?: string;
+    /**
+     * Optional. The maximum number of limits to return. The service may return fewer than this value. If unspecified, at most 100 limits will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+     */
+    pageSize?: number;
+    /**
+     * Optional. A page token, received from a previous `ListAccountLimits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLimits` must match the call that provided the page token.
+     */
+    pageToken?: string;
+    /**
+     * Required. The parent account. Format: `accounts/{account\}`
+     */
+    parent?: string;
+  }
+
   export class Resource$Accounts$Quotas {
     context: APIRequestContext;
     constructor(context: APIRequestContext) {
@@ -406,8 +762,7 @@ export namespace merchantapi_quota_v1 {
     }
   }
 
-  export interface Params$Resource$Accounts$Quotas$List
-    extends StandardParameters {
+  export interface Params$Resource$Accounts$Quotas$List extends StandardParameters {
     /**
      * Optional. The maximum number of quotas to return in the response, used for paging. Defaults to 500; values above 1000 will be coerced to 1000.
      */

package/quota_v1beta.ts

@@ -406,8 +406,7 @@ export namespace merchantapi_quota_v1beta {
     }
   }
 
-  export interface Params$Resource$Accounts$Quotas$List
-    extends StandardParameters {
+  export interface Params$Resource$Accounts$Quotas$List extends StandardParameters {
     /**
      * Optional. The maximum number of quotas to return in the response, used for paging. Defaults to 500; values above 1000 will be coerced to 1000.
      */

package/reports_v1.ts

@@ -1190,8 +1190,7 @@ export namespace merchantapi_reports_v1 {
     }
   }
 
-  export interface Params$Resource$Accounts$Reports$Search
-    extends StandardParameters {
+  export interface Params$Resource$Accounts$Reports$Search extends StandardParameters {
     /**
      * Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account\}
      */

package/reports_v1beta.ts

@@ -1190,8 +1190,7 @@ export namespace merchantapi_reports_v1beta {
     }
   }
 
-  export interface Params$Resource$Accounts$Reports$Search
-    extends StandardParameters {
+  export interface Params$Resource$Accounts$Reports$Search extends StandardParameters {
     /**
      * Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account\}
      */

package/reviews_v1beta.ts

@@ -1235,22 +1235,19 @@ export namespace merchantapi_reviews_v1beta {
     }
   }
 
-  export interface Params$Resource$Accounts$Merchantreviews$Delete
-    extends StandardParameters {
+  export interface Params$Resource$Accounts$Merchantreviews$Delete extends StandardParameters {
     /**
      * Required. The ID of the merchant review. Format: accounts/{account\}/merchantReviews/{merchantReview\}
      */
     name?: string;
   }
-  export interface Params$Resource$Accounts$Merchantreviews$Get
-    extends StandardParameters {
+  export interface Params$Resource$Accounts$Merchantreviews$Get extends StandardParameters {
     /**
      * Required. The ID of the merchant review. Format: accounts/{account\}/merchantReviews/{merchantReview\}
      */
     name?: string;
   }
-  export interface Params$Resource$Accounts$Merchantreviews$Insert
-    extends StandardParameters {
+  export interface Params$Resource$Accounts$Merchantreviews$Insert extends StandardParameters {
     /**
      * Required. The data source of the [merchantreview](https://support.google.com/merchants/answer/7045996?sjid=5253581244217581976-EU) Format: `accounts/{account\}/dataSources/{datasource\}`.
      */
@@ -1265,8 +1262,7 @@ export namespace merchantapi_reviews_v1beta {
      */
     requestBody?: Schema$MerchantReview;
   }
-  export interface Params$Resource$Accounts$Merchantreviews$List
-    extends StandardParameters {
+  export interface Params$Resource$Accounts$Merchantreviews$List extends StandardParameters {
     /**
      * Optional. The maximum number of merchant reviews to return. The service can return fewer than this value. The maximum value is 1000; values above 1000 are coerced to 1000. If unspecified, the maximum number of reviews is returned.
      */
@@ -1867,22 +1863,19 @@ export namespace merchantapi_reviews_v1beta {
     }
   }
 
-  export interface Params$Resource$Accounts$Productreviews$Delete
-    extends StandardParameters {
+  export interface Params$Resource$Accounts$Productreviews$Delete extends StandardParameters {
     /**
      * Required. The ID of the Product review. Format: accounts/{account\}/productReviews/{productReview\}
      */
     name?: string;
   }
-  export interface Params$Resource$Accounts$Productreviews$Get
-    extends StandardParameters {
+  export interface Params$Resource$Accounts$Productreviews$Get extends StandardParameters {
     /**
      * Required. The ID of the merchant review. Format: accounts/{account\}/productReviews/{productReview\}
      */
     name?: string;
   }
-  export interface Params$Resource$Accounts$Productreviews$Insert
-    extends StandardParameters {
+  export interface Params$Resource$Accounts$Productreviews$Insert extends StandardParameters {
     /**
      * Required. Format: `accounts/{account\}/dataSources/{datasource\}`.
      */
@@ -1897,8 +1890,7 @@ export namespace merchantapi_reviews_v1beta {
      */
     requestBody?: Schema$ProductReview;
   }
-  export interface Params$Resource$Accounts$Productreviews$List
-    extends StandardParameters {
+  export interface Params$Resource$Accounts$Productreviews$List extends StandardParameters {
     /**
      * Optional. The maximum number of products to return. The service may return fewer than this value.
      */