@googleapis/merchantapi 8.0.0 → 9.0.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [9.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/merchantapi-v8.0.0...merchantapi-v9.0.0) (2025-07-15)
+
+
+### ⚠ BREAKING CHANGES
+
+* **merchantapi:** This release has breaking changes.
+
+### Features
+
+* **merchantapi:** update the API ([b42712e](https://github.com/googleapis/google-api-nodejs-client/commit/b42712eb921872c2b8edb7630c87802b665a1621))
+
 ## [8.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/merchantapi-v7.0.0...merchantapi-v8.0.0) (2025-07-08)
 
 

package/accounts_v1beta.ts

@@ -742,6 +742,19 @@ export namespace merchantapi_accounts_v1beta {
      */
     warehouseBasedDeliveryTimes?: Schema$WarehouseBasedDeliveryTime[];
   }
+  /**
+   * Represents a developer registration owned by a Merchant account.
+   */
+  export interface Schema$DeveloperRegistration {
+    /**
+     * Output only. The GCP ids attached to this developer registration
+     */
+    gcpIds?: string[] | null;
+    /**
+     * Identifier. The `name` (ID) of the developer registration. Generated by the Content API upon creation of a new `DeveloperRegistration`. The `account` represents the merchant ID of the merchant that owns the registration.
+     */
+    name?: string | null;
+  }
   /**
    * Request message for the DisableProgram method.
    */
@@ -1326,7 +1339,7 @@ export namespace merchantapi_accounts_v1beta {
      */
     itemConditions?: string[] | null;
     /**
-     * Required. Immutable. This field represents the unique user-defined label of the return policy. It is important to note that the same label cannot be used in different return policies for the same country. Unless a product specifies a specific label attribute, policies will be automatically labeled as 'default'. To assign a custom return policy to certain product groups, follow the instructions provided in the [Return policy label] (https://support.google.com/merchants/answer/9445425). The label can contain up to 50 characters.
+     * Optional. Immutable. This field represents the unique user-defined label of the return policy for the given country. It is important to note that the same label cannot be used in different return policies for the same country. If not given, policies will be automatically treated as the 'default' for the country. When using label, you are creating an exception policy in that country to assign a custom return policy to certain product groups, follow the instructions provided in the [Return policy label] (https://support.google.com/merchants/answer/9445425). The label can contain up to 50 characters.
      */
     label?: string | null;
     /**
@@ -1663,6 +1676,15 @@ export namespace merchantapi_accounts_v1beta {
      */
     shippingEligible?: boolean | null;
   }
+  /**
+   * Request message for the RegisterGCP method.
+   */
+  export interface Schema$RegisterGCPRequest {
+    /**
+     * Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have "API developer" access type and the email preference corresponding to that user will be updated to have the new "API notifications" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new "API notifications" preference
+     */
+    developerEmail?: string | null;
+  }
   /**
    * Request to reject an account service.
    */
@@ -2011,6 +2033,10 @@ export namespace merchantapi_accounts_v1beta {
    * Request message for the `UnclaimHomepage` method.
    */
   export interface Schema$UnclaimHomepageRequest {}
+  /**
+   * Request message for the UnregisterGCP method.
+   */
+  export interface Schema$UnregisterGCPRequest {}
   /**
    * URL settings for cart or checkout URL.
    */
@@ -2141,6 +2167,7 @@ export namespace merchantapi_accounts_v1beta {
     automaticImprovements: Resource$Accounts$Automaticimprovements;
     businessIdentity: Resource$Accounts$Businessidentity;
     businessInfo: Resource$Accounts$Businessinfo;
+    developerRegistration: Resource$Accounts$Developerregistration;
     emailPreferences: Resource$Accounts$Emailpreferences;
     gbpAccounts: Resource$Accounts$Gbpaccounts;
     homepage: Resource$Accounts$Homepage;
@@ -2166,6 +2193,9 @@ export namespace merchantapi_accounts_v1beta {
         this.context
       );
       this.businessInfo = new Resource$Accounts$Businessinfo(this.context);
+      this.developerRegistration = new Resource$Accounts$Developerregistration(
+        this.context
+      );
       this.emailPreferences = new Resource$Accounts$Emailpreferences(
         this.context
       );
@@ -2618,6 +2648,148 @@ export namespace merchantapi_accounts_v1beta {
       }
     }
 
+    /**
+     * Retrieves a developer registration for a merchant.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/merchantapi.googleapis.com
+     * // - Login into gcloud by running:
+     * //   ```sh
+     * //   $ gcloud auth application-default login
+     * //   ```
+     * // - Install the npm module by running:
+     * //   ```sh
+     * //   $ npm install googleapis
+     * //   ```
+     *
+     * const {google} = require('googleapis');
+     * const merchantapi = google.merchantapi('accounts_v1beta');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: ['https://www.googleapis.com/auth/content'],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await merchantapi.accounts.getDeveloperRegistration({
+     *     // Required. The `name` (ID) of the developer registration.
+     *     name: 'accounts/my-account/developerRegistration',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "gcpIds": [],
+     *   //   "name": "my_name"
+     *   // }
+     * }
+     *
+     * 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.
+     */
+    getDeveloperRegistration(
+      params: Params$Resource$Accounts$Getdeveloperregistration,
+      options: StreamMethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Readable>>;
+    getDeveloperRegistration(
+      params?: Params$Resource$Accounts$Getdeveloperregistration,
+      options?: MethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Schema$DeveloperRegistration>>;
+    getDeveloperRegistration(
+      params: Params$Resource$Accounts$Getdeveloperregistration,
+      options: StreamMethodOptions | BodyResponseCallback<Readable>,
+      callback: BodyResponseCallback<Readable>
+    ): void;
+    getDeveloperRegistration(
+      params: Params$Resource$Accounts$Getdeveloperregistration,
+      options:
+        | MethodOptions
+        | BodyResponseCallback<Schema$DeveloperRegistration>,
+      callback: BodyResponseCallback<Schema$DeveloperRegistration>
+    ): void;
+    getDeveloperRegistration(
+      params: Params$Resource$Accounts$Getdeveloperregistration,
+      callback: BodyResponseCallback<Schema$DeveloperRegistration>
+    ): void;
+    getDeveloperRegistration(
+      callback: BodyResponseCallback<Schema$DeveloperRegistration>
+    ): void;
+    getDeveloperRegistration(
+      paramsOrCallback?:
+        | Params$Resource$Accounts$Getdeveloperregistration
+        | BodyResponseCallback<Schema$DeveloperRegistration>
+        | BodyResponseCallback<Readable>,
+      optionsOrCallback?:
+        | MethodOptions
+        | StreamMethodOptions
+        | BodyResponseCallback<Schema$DeveloperRegistration>
+        | BodyResponseCallback<Readable>,
+      callback?:
+        | BodyResponseCallback<Schema$DeveloperRegistration>
+        | BodyResponseCallback<Readable>
+    ):
+      | void
+      | Promise<GaxiosResponseWithHTTP2<Schema$DeveloperRegistration>>
+      | Promise<GaxiosResponseWithHTTP2<Readable>> {
+      let params = (paramsOrCallback ||
+        {}) as Params$Resource$Accounts$Getdeveloperregistration;
+      let options = (optionsOrCallback || {}) as MethodOptions;
+
+      if (typeof paramsOrCallback === 'function') {
+        callback = paramsOrCallback;
+        params = {} as Params$Resource$Accounts$Getdeveloperregistration;
+        options = {};
+      }
+
+      if (typeof optionsOrCallback === 'function') {
+        callback = optionsOrCallback;
+        options = {};
+      }
+
+      const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
+      const parameters = {
+        options: Object.assign(
+          {
+            url: (rootUrl + '/accounts/v1beta/{+name}').replace(
+              /([^:]\/)\/+/g,
+              '$1'
+            ),
+            method: 'GET',
+            apiVersion: '',
+          },
+          options
+        ),
+        params,
+        requiredParams: ['name'],
+        pathParams: ['name'],
+        context: this.context,
+      };
+      if (callback) {
+        createAPIRequest<Schema$DeveloperRegistration>(
+          parameters,
+          callback as BodyResponseCallback<unknown>
+        );
+      } else {
+        return createAPIRequest<Schema$DeveloperRegistration>(parameters);
+      }
+    }
+
     /**
      * Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.
      * @example
@@ -3088,6 +3260,13 @@ export namespace merchantapi_accounts_v1beta {
      */
     name?: string;
   }
+  export interface Params$Resource$Accounts$Getdeveloperregistration
+    extends StandardParameters {
+    /**
+     * Required. The `name` (ID) of the developer registration.
+     */
+    name?: string;
+  }
   export interface Params$Resource$Accounts$List extends StandardParameters {
     /**
      * Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax).
@@ -4471,6 +4650,331 @@ export namespace merchantapi_accounts_v1beta {
     requestBody?: Schema$BusinessInfo;
   }
 
+  export class Resource$Accounts$Developerregistration {
+    context: APIRequestContext;
+    constructor(context: APIRequestContext) {
+      this.context = context;
+    }
+
+    /**
+     * Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on.
+     * @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('accounts_v1beta');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: ['https://www.googleapis.com/auth/content'],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await merchantapi.accounts.developerRegistration.registerGcp({
+     *     // Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration`
+     *     name: 'accounts/my-account/developerRegistration',
+     *
+     *     // Request body metadata
+     *     requestBody: {
+     *       // request body parameters
+     *       // {
+     *       //   "developerEmail": "my_developerEmail"
+     *       // }
+     *     },
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "gcpIds": [],
+     *   //   "name": "my_name"
+     *   // }
+     * }
+     *
+     * 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.
+     */
+    registerGcp(
+      params: Params$Resource$Accounts$Developerregistration$Registergcp,
+      options: StreamMethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Readable>>;
+    registerGcp(
+      params?: Params$Resource$Accounts$Developerregistration$Registergcp,
+      options?: MethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Schema$DeveloperRegistration>>;
+    registerGcp(
+      params: Params$Resource$Accounts$Developerregistration$Registergcp,
+      options: StreamMethodOptions | BodyResponseCallback<Readable>,
+      callback: BodyResponseCallback<Readable>
+    ): void;
+    registerGcp(
+      params: Params$Resource$Accounts$Developerregistration$Registergcp,
+      options:
+        | MethodOptions
+        | BodyResponseCallback<Schema$DeveloperRegistration>,
+      callback: BodyResponseCallback<Schema$DeveloperRegistration>
+    ): void;
+    registerGcp(
+      params: Params$Resource$Accounts$Developerregistration$Registergcp,
+      callback: BodyResponseCallback<Schema$DeveloperRegistration>
+    ): void;
+    registerGcp(
+      callback: BodyResponseCallback<Schema$DeveloperRegistration>
+    ): void;
+    registerGcp(
+      paramsOrCallback?:
+        | Params$Resource$Accounts$Developerregistration$Registergcp
+        | BodyResponseCallback<Schema$DeveloperRegistration>
+        | BodyResponseCallback<Readable>,
+      optionsOrCallback?:
+        | MethodOptions
+        | StreamMethodOptions
+        | BodyResponseCallback<Schema$DeveloperRegistration>
+        | BodyResponseCallback<Readable>,
+      callback?:
+        | BodyResponseCallback<Schema$DeveloperRegistration>
+        | BodyResponseCallback<Readable>
+    ):
+      | void
+      | Promise<GaxiosResponseWithHTTP2<Schema$DeveloperRegistration>>
+      | Promise<GaxiosResponseWithHTTP2<Readable>> {
+      let params = (paramsOrCallback ||
+        {}) as Params$Resource$Accounts$Developerregistration$Registergcp;
+      let options = (optionsOrCallback || {}) as MethodOptions;
+
+      if (typeof paramsOrCallback === 'function') {
+        callback = paramsOrCallback;
+        params =
+          {} as Params$Resource$Accounts$Developerregistration$Registergcp;
+        options = {};
+      }
+
+      if (typeof optionsOrCallback === 'function') {
+        callback = optionsOrCallback;
+        options = {};
+      }
+
+      const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
+      const parameters = {
+        options: Object.assign(
+          {
+            url: (rootUrl + '/accounts/v1beta/{+name}:registerGcp').replace(
+              /([^:]\/)\/+/g,
+              '$1'
+            ),
+            method: 'POST',
+            apiVersion: '',
+          },
+          options
+        ),
+        params,
+        requiredParams: ['name'],
+        pathParams: ['name'],
+        context: this.context,
+      };
+      if (callback) {
+        createAPIRequest<Schema$DeveloperRegistration>(
+          parameters,
+          callback as BodyResponseCallback<unknown>
+        );
+      } else {
+        return createAPIRequest<Schema$DeveloperRegistration>(parameters);
+      }
+    }
+
+    /**
+     * Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister succussful call.
+     * @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('accounts_v1beta');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: ['https://www.googleapis.com/auth/content'],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await merchantapi.accounts.developerRegistration.unregisterGcp({
+     *     // Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration`
+     *     name: 'accounts/my-account/developerRegistration',
+     *
+     *     // Request body metadata
+     *     requestBody: {
+     *       // request body parameters
+     *       // {}
+     *     },
+     *   });
+     *   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.
+     */
+    unregisterGcp(
+      params: Params$Resource$Accounts$Developerregistration$Unregistergcp,
+      options: StreamMethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Readable>>;
+    unregisterGcp(
+      params?: Params$Resource$Accounts$Developerregistration$Unregistergcp,
+      options?: MethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
+    unregisterGcp(
+      params: Params$Resource$Accounts$Developerregistration$Unregistergcp,
+      options: StreamMethodOptions | BodyResponseCallback<Readable>,
+      callback: BodyResponseCallback<Readable>
+    ): void;
+    unregisterGcp(
+      params: Params$Resource$Accounts$Developerregistration$Unregistergcp,
+      options: MethodOptions | BodyResponseCallback<Schema$Empty>,
+      callback: BodyResponseCallback<Schema$Empty>
+    ): void;
+    unregisterGcp(
+      params: Params$Resource$Accounts$Developerregistration$Unregistergcp,
+      callback: BodyResponseCallback<Schema$Empty>
+    ): void;
+    unregisterGcp(callback: BodyResponseCallback<Schema$Empty>): void;
+    unregisterGcp(
+      paramsOrCallback?:
+        | Params$Resource$Accounts$Developerregistration$Unregistergcp
+        | BodyResponseCallback<Schema$Empty>
+        | BodyResponseCallback<Readable>,
+      optionsOrCallback?:
+        | MethodOptions
+        | StreamMethodOptions
+        | BodyResponseCallback<Schema$Empty>
+        | BodyResponseCallback<Readable>,
+      callback?:
+        | BodyResponseCallback<Schema$Empty>
+        | BodyResponseCallback<Readable>
+    ):
+      | void
+      | Promise<GaxiosResponseWithHTTP2<Schema$Empty>>
+      | Promise<GaxiosResponseWithHTTP2<Readable>> {
+      let params = (paramsOrCallback ||
+        {}) as Params$Resource$Accounts$Developerregistration$Unregistergcp;
+      let options = (optionsOrCallback || {}) as MethodOptions;
+
+      if (typeof paramsOrCallback === 'function') {
+        callback = paramsOrCallback;
+        params =
+          {} as Params$Resource$Accounts$Developerregistration$Unregistergcp;
+        options = {};
+      }
+
+      if (typeof optionsOrCallback === 'function') {
+        callback = optionsOrCallback;
+        options = {};
+      }
+
+      const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
+      const parameters = {
+        options: Object.assign(
+          {
+            url: (rootUrl + '/accounts/v1beta/{+name}:unregisterGcp').replace(
+              /([^:]\/)\/+/g,
+              '$1'
+            ),
+            method: 'POST',
+            apiVersion: '',
+          },
+          options
+        ),
+        params,
+        requiredParams: ['name'],
+        pathParams: ['name'],
+        context: this.context,
+      };
+      if (callback) {
+        createAPIRequest<Schema$Empty>(
+          parameters,
+          callback as BodyResponseCallback<unknown>
+        );
+      } else {
+        return createAPIRequest<Schema$Empty>(parameters);
+      }
+    }
+  }
+
+  export interface Params$Resource$Accounts$Developerregistration$Registergcp
+    extends StandardParameters {
+    /**
+     * Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration`
+     */
+    name?: string;
+
+    /**
+     * Request body metadata
+     */
+    requestBody?: Schema$RegisterGCPRequest;
+  }
+  export interface Params$Resource$Accounts$Developerregistration$Unregistergcp
+    extends StandardParameters {
+    /**
+     * Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration`
+     */
+    name?: string;
+
+    /**
+     * Request body metadata
+     */
+    requestBody?: Schema$UnregisterGCPRequest;
+  }
+
   export class Resource$Accounts$Emailpreferences {
     context: APIRequestContext;
     constructor(context: APIRequestContext) {
@@ -7765,7 +8269,7 @@ export namespace merchantapi_accounts_v1beta {
      *   const res = await merchantapi.accounts.onlineReturnPolicies.patch({
      *     // Identifier. The name of the `OnlineReturnPolicy` resource. Format: `accounts/{account\}/onlineReturnPolicies/{return_policy\}`
      *     name: 'accounts/my-account/onlineReturnPolicies/my-onlineReturnPolicie',
-     *     // Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `accept_defective_only` - `accept_exchange` - `item_conditions` - `policy` - `process_refund_days` - `restocking_fee` - `return_methods` - `return_policy_uri` - `return_shipping_fee`
+     *     // Optional. Only support updating the entire OnlineReturnPolicy message. For update_mask, always use `*`.
      *     updateMask: 'placeholder-value',
      *
      *     // Request body metadata
@@ -7956,7 +8460,7 @@ export namespace merchantapi_accounts_v1beta {
      */
     name?: string;
     /**
-     * Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `accept_defective_only` - `accept_exchange` - `item_conditions` - `policy` - `process_refund_days` - `restocking_fee` - `return_methods` - `return_policy_uri` - `return_shipping_fee`
+     * Optional. Only support updating the entire OnlineReturnPolicy message. For update_mask, always use `*`.
      */
     updateMask?: string;