@googleapis/merchantapi 16.1.0 → 17.1.0

package/build/accounts_v1.d.ts

@@ -177,19 +177,6 @@ export declare namespace merchantapi_accounts_v1 {
          */
         title?: string | null;
     }
-    /**
-     * 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;
-    }
     /**
      * `AccountManagement` payload.
      */
@@ -232,6 +219,10 @@ export declare namespace merchantapi_accounts_v1 {
          * Service type for managing advertising campaigns. Grants the provider access to create and manage the business's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance.
          */
         campaignsManagement?: Schema$CampaignsManagement;
+        /**
+         * Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197
+         */
+        comparisonShopping?: Schema$ComparisonShopping;
         /**
          * Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider.
          */
@@ -273,6 +264,26 @@ export declare namespace merchantapi_accounts_v1 {
          * The provider is an [aggregator](https://support.google.com/merchants/answer/188487) for the account. Payload for service type Account Aggregation.
          */
         accountAggregation?: Schema$AccountAggregation;
+        /**
+         * The provider manages this account. Payload for service type Account Management.
+         */
+        accountManagement?: Schema$AccountManagement;
+        /**
+         * The provider manages campaigns for this account. Payload for service type campaigns management.
+         */
+        campaignsManagement?: Schema$CampaignsManagement;
+        /**
+         * The provider is a CSS (Comparison Shopping Service) of this account. Payload for service type Comparison Shopping.
+         */
+        comparisonShopping?: Schema$ComparisonShopping;
+        /**
+         * Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider. The external account ID must be specified for the campaigns management service type. The external account ID must not be specified for the account aggregation service type. The external account ID is optional / may be specified for all other service types.
+         */
+        externalAccountId?: string | null;
+        /**
+         * The provider manages products for this account. Payload for service type products management.
+         */
+        productsManagement?: Schema$ProductsManagement;
         /**
          * Required. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
          */
@@ -315,6 +326,10 @@ export declare namespace merchantapi_accounts_v1 {
          * Required. The email address of the user (for example, `john.doe@gmail.com`).
          */
         userId?: string | null;
+        /**
+         * Optional. Settings related to configuring the verification email that is sent after adding a user.
+         */
+        verificationMailSettings?: Schema$VerificationMailSettings;
     }
     /**
      * Request to approve an account service.
@@ -602,6 +617,11 @@ export declare namespace merchantapi_accounts_v1 {
          */
         overwrite?: boolean | null;
     }
+    /**
+     * `ComparisonShopping` payload.
+     */
+    export interface Schema$ComparisonShopping {
+    }
     /**
      * Request message for the `CreateAndConfigureAccount` method.
      */
@@ -614,6 +634,10 @@ export declare namespace merchantapi_accounts_v1 {
          * Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation` and `accounts.createAndConfigure` method can be used to create a sub-account under an existing advanced account through this method. Additional `account_management` or `product_management` services may be provided.
          */
         service?: Schema$AddAccountService[];
+        /**
+         * Optional. If a relationship is created with a provider, you can set an alias for it with this field. The calling user must be an admin on the provider to be able to set an alias.
+         */
+        setAlias?: Schema$SetAliasForRelationship[];
         /**
          * Optional. Users to be added to the account.
          */
@@ -1018,6 +1042,19 @@ export declare namespace merchantapi_accounts_v1 {
          */
         allowStrictAvailabilityUpdates?: boolean | null;
     }
+    /**
+     * An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.
+     */
+    export interface Schema$LatLng {
+        /**
+         * The latitude in degrees. It must be in the range [-90.0, +90.0].
+         */
+        latitude?: number | null;
+        /**
+         * The longitude in degrees. It must be in the range [-180.0, +180.0].
+         */
+        longitude?: number | null;
+    }
     /**
      * Collection of information related to the LFP link.
      */
@@ -1101,19 +1138,6 @@ export declare namespace merchantapi_accounts_v1 {
          */
         nextPageToken?: string | null;
     }
-    /**
-     * 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 after trying to list account relationships.
      */
@@ -1573,19 +1597,6 @@ export declare namespace merchantapi_accounts_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;
-    }
     /**
      * `ProductsManagement` payload.
      */
@@ -1670,6 +1681,27 @@ export declare namespace merchantapi_accounts_v1 {
          */
         provider?: string | null;
     }
+    /**
+     * A radius area that defines the region area.
+     */
+    export interface Schema$RadiusArea {
+        /**
+         * Required. The center of the radius area. It represents a latitude/longitude pair in decimal degrees format.
+         */
+        latLng?: Schema$LatLng;
+        /**
+         * Required. The radius distance of the area.
+         */
+        radius?: number | null;
+        /**
+         * Optional. The unit of the radius.
+         */
+        radiusUnits?: string | null;
+        /**
+         * Required. [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) or the country the radius area applies to.
+         */
+        regionCode?: string | null;
+    }
     /**
      * Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
      */
@@ -1719,6 +1751,10 @@ export declare namespace merchantapi_accounts_v1 {
          * Optional. A list of postal codes that defines the region area.
          */
         postalCodeArea?: Schema$PostalCodeArea;
+        /**
+         * Optional. A radius area that defines the region area.
+         */
+        radiusArea?: Schema$RadiusArea;
         /**
          * Output only. Indicates if the region is eligible for use in the Regional Inventory configuration.
          */
@@ -1892,6 +1928,19 @@ export declare namespace merchantapi_accounts_v1 {
          */
         storeConfig?: Schema$StoreConfig;
     }
+    /**
+     * Set an alias for a relationship between a provider and the account to be created.
+     */
+    export interface Schema$SetAliasForRelationship {
+        /**
+         * Required. The unique ID of this account in the provider's system. The value must be unique across all accounts on the platform for this provider.
+         */
+        accountIdAlias?: string | null;
+        /**
+         * Required. The provider of the service. This is a reference to an account such as `providers/123` or `accounts/123`. The same provider must be specified in at least one of the `service` fields.
+         */
+        provider?: string | null;
+    }
     /**
      * The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts.
      */
@@ -2161,6 +2210,20 @@ export declare namespace merchantapi_accounts_v1 {
          */
         subtable?: string | null;
     }
+    /**
+     * Settings related to the verification email that is sent after adding a user.
+     */
+    export interface Schema$VerificationMailSettings {
+        /**
+         * Optional. Mode of the verification mail. If not set, the default is `SEND_VERIFICATION_MAIL`.
+         */
+        verificationMailMode?: string | null;
+    }
+    /**
+     * Request message for the `VerifySelf` method.
+     */
+    export interface Schema$VerifySelfRequest {
+    }
     /**
      * A fulfillment warehouse, which stores and handles inventory.
      */
@@ -2240,7 +2303,6 @@ export declare namespace merchantapi_accounts_v1 {
         gbpAccounts: Resource$Accounts$Gbpaccounts;
         homepage: Resource$Accounts$Homepage;
         issues: Resource$Accounts$Issues;
-        limits: Resource$Accounts$Limits;
         omnichannelSettings: Resource$Accounts$Omnichannelsettings;
         onlineReturnPolicies: Resource$Accounts$Onlinereturnpolicies;
         programs: Resource$Accounts$Programs;
@@ -2288,6 +2350,7 @@ export declare namespace merchantapi_accounts_v1 {
          *       // {
          *       //   "account": {},
          *       //   "service": [],
+         *       //   "setAlias": [],
          *       //   "user": []
          *       // }
          *     },
@@ -4416,162 +4479,6 @@ export declare namespace merchantapi_accounts_v1 {
          */
         timeZone?: string;
     }
-    export class Resource$Accounts$Limits {
-        context: APIRequestContext;
-        constructor(context: APIRequestContext);
-        /**
-         * 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('accounts_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;
-        /**
-         * 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('accounts_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;
-    }
-    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$Omnichannelsettings {
         context: APIRequestContext;
         lfpProviders: Resource$Accounts$Omnichannelsettings$Lfpproviders;
@@ -6401,6 +6308,7 @@ export declare namespace merchantapi_accounts_v1 {
          *       //   "geotargetArea": {},
          *       //   "name": "my_name",
          *       //   "postalCodeArea": {},
+         *       //   "radiusArea": {},
          *       //   "regionalInventoryEligible": false,
          *       //   "shippingEligible": false
          *       // }
@@ -6414,6 +6322,7 @@ export declare namespace merchantapi_accounts_v1 {
          *   //   "geotargetArea": {},
          *   //   "name": "my_name",
          *   //   "postalCodeArea": {},
+         *   //   "radiusArea": {},
          *   //   "regionalInventoryEligible": false,
          *   //   "shippingEligible": false
          *   // }
@@ -6537,6 +6446,7 @@ export declare namespace merchantapi_accounts_v1 {
          *   //   "geotargetArea": {},
          *   //   "name": "my_name",
          *   //   "postalCodeArea": {},
+         *   //   "radiusArea": {},
          *   //   "regionalInventoryEligible": false,
          *   //   "shippingEligible": false
          *   // }
@@ -6669,6 +6579,7 @@ export declare namespace merchantapi_accounts_v1 {
          *       //   "geotargetArea": {},
          *       //   "name": "my_name",
          *       //   "postalCodeArea": {},
+         *       //   "radiusArea": {},
          *       //   "regionalInventoryEligible": false,
          *       //   "shippingEligible": false
          *       // }
@@ -6682,6 +6593,7 @@ export declare namespace merchantapi_accounts_v1 {
          *   //   "geotargetArea": {},
          *   //   "name": "my_name",
          *   //   "postalCodeArea": {},
+         *   //   "radiusArea": {},
          *   //   "regionalInventoryEligible": false,
          *   //   "shippingEligible": false
          *   // }
@@ -7082,6 +6994,7 @@ export declare namespace merchantapi_accounts_v1 {
          *   //   "accountAggregation": {},
          *   //   "accountManagement": {},
          *   //   "campaignsManagement": {},
+         *   //   "comparisonShopping": {},
          *   //   "externalAccountId": "my_externalAccountId",
          *   //   "handshake": {},
          *   //   "localListingManagement": {},
@@ -7152,6 +7065,7 @@ export declare namespace merchantapi_accounts_v1 {
          *   //   "accountAggregation": {},
          *   //   "accountManagement": {},
          *   //   "campaignsManagement": {},
+         *   //   "comparisonShopping": {},
          *   //   "externalAccountId": "my_externalAccountId",
          *   //   "handshake": {},
          *   //   "localListingManagement": {},
@@ -7296,6 +7210,7 @@ export declare namespace merchantapi_accounts_v1 {
          *   //   "accountAggregation": {},
          *   //   "accountManagement": {},
          *   //   "campaignsManagement": {},
+         *   //   "comparisonShopping": {},
          *   //   "externalAccountId": "my_externalAccountId",
          *   //   "handshake": {},
          *   //   "localListingManagement": {},
@@ -7746,6 +7661,7 @@ export declare namespace merchantapi_accounts_v1 {
     }
     export class Resource$Accounts$Users {
         context: APIRequestContext;
+        me: Resource$Accounts$Users$Me;
         constructor(context: APIRequestContext);
         /**
          * Creates a Merchant Center account user. Executing this method requires admin access.
@@ -8135,6 +8051,88 @@ export declare namespace merchantapi_accounts_v1 {
          */
         requestBody?: Schema$User;
     }
+    export class Resource$Accounts$Users$Me {
+        context: APIRequestContext;
+        constructor(context: APIRequestContext);
+        /**
+         * Updates the user that is represented by the caller from pending to verified.
+         * @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_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.users.me.verifySelf({
+         *     // Required. The name of the account under which the caller is a user. Format: `accounts/{account\}`
+         *     account: 'accounts/my-account',
+         *
+         *     // Request body metadata
+         *     requestBody: {
+         *       // request body parameters
+         *       // {}
+         *     },
+         *   });
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {
+         *   //   "accessRights": [],
+         *   //   "name": "my_name",
+         *   //   "state": "my_state"
+         *   // }
+         * }
+         *
+         * 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.
+         */
+        verifySelf(params: Params$Resource$Accounts$Users$Me$Verifyself, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        verifySelf(params?: Params$Resource$Accounts$Users$Me$Verifyself, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$User>>;
+        verifySelf(params: Params$Resource$Accounts$Users$Me$Verifyself, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        verifySelf(params: Params$Resource$Accounts$Users$Me$Verifyself, options: MethodOptions | BodyResponseCallback<Schema$User>, callback: BodyResponseCallback<Schema$User>): void;
+        verifySelf(params: Params$Resource$Accounts$Users$Me$Verifyself, callback: BodyResponseCallback<Schema$User>): void;
+        verifySelf(callback: BodyResponseCallback<Schema$User>): void;
+    }
+    export interface Params$Resource$Accounts$Users$Me$Verifyself extends StandardParameters {
+        /**
+         * Required. The name of the account under which the caller is a user. Format: `accounts/{account\}`
+         */
+        account?: string;
+        /**
+         * Request body metadata
+         */
+        requestBody?: Schema$VerifySelfRequest;
+    }
     export class Resource$Termsofservice {
         context: APIRequestContext;
         constructor(context: APIRequestContext);