@maxim_mazurok/gapi.client.merchantapi-accounts_v1beta 0.0.20250625 → 0.0.20250630
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +202 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://merchantapi.googleapis.com/$discovery/rest?version=accounts_v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250630
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -226,6 +226,24 @@ declare namespace gapi.client {
|
|
|
226
226
|
/** Optional. Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%. */
|
|
227
227
|
percentageAdjustment?: string;
|
|
228
228
|
}
|
|
229
|
+
interface CheckoutSettings {
|
|
230
|
+
/** Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). */
|
|
231
|
+
effectiveEnrollmentState?: string;
|
|
232
|
+
/** Output only. The effective value of `review_state` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). */
|
|
233
|
+
effectiveReviewState?: string;
|
|
234
|
+
/** Output only. The effective value of `uri_settings` for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). */
|
|
235
|
+
effectiveUriSettings?: UriSettings;
|
|
236
|
+
/** Optional. The destinations to which the checkout program applies, valid destination values are `SHOPPING_ADS`, `FREE_LISTINGS` */
|
|
237
|
+
eligibleDestinations?: string[];
|
|
238
|
+
/** Output only. Reflects the merchant enrollment state in `Checkout` program. */
|
|
239
|
+
enrollmentState?: string;
|
|
240
|
+
/** Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings` */
|
|
241
|
+
name?: string;
|
|
242
|
+
/** Output only. Reflects the merchant review state in `Checkout` program. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an `enrollment_state` of `ENROLLED` before a review can begin for the merchant.For more details, check the help center doc. */
|
|
243
|
+
reviewState?: string;
|
|
244
|
+
/** URI settings for cart or checkout URL. */
|
|
245
|
+
uriSettings?: UriSettings;
|
|
246
|
+
}
|
|
229
247
|
interface ClaimHomepageRequest {
|
|
230
248
|
/** Optional. When set to `true`, this option removes any existing claim on the requested website from any other account to the account making the request, effectively replacing the previous claim. */
|
|
231
249
|
overwrite?: boolean;
|
|
@@ -892,6 +910,12 @@ declare namespace gapi.client {
|
|
|
892
910
|
minTransitDays?: number;
|
|
893
911
|
}
|
|
894
912
|
interface UnclaimHomepageRequest {}
|
|
913
|
+
interface UriSettings {
|
|
914
|
+
/** Cart URL template. When the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting) */
|
|
915
|
+
cartUriTemplate?: string;
|
|
916
|
+
/** Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting) */
|
|
917
|
+
checkoutUriTemplate?: string;
|
|
918
|
+
}
|
|
895
919
|
interface User {
|
|
896
920
|
/** Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. */
|
|
897
921
|
accessRights?: string[];
|
|
@@ -2271,6 +2295,182 @@ declare namespace gapi.client {
|
|
|
2271
2295
|
body: OnlineReturnPolicy,
|
|
2272
2296
|
): Request<OnlineReturnPolicy>;
|
|
2273
2297
|
}
|
|
2298
|
+
interface CheckoutSettingsResource {
|
|
2299
|
+
/** Creates `CheckoutSettings` for the given merchant. */
|
|
2300
|
+
create(request: {
|
|
2301
|
+
/** V1 error format. */
|
|
2302
|
+
'$.xgafv'?: string;
|
|
2303
|
+
/** OAuth access token. */
|
|
2304
|
+
access_token?: string;
|
|
2305
|
+
/** Data format for response. */
|
|
2306
|
+
alt?: string;
|
|
2307
|
+
/** JSONP */
|
|
2308
|
+
callback?: string;
|
|
2309
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2310
|
+
fields?: string;
|
|
2311
|
+
/** 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. */
|
|
2312
|
+
key?: string;
|
|
2313
|
+
/** OAuth 2.0 token for the current user. */
|
|
2314
|
+
oauth_token?: string;
|
|
2315
|
+
/** Required. The merchant account for which the `CheckoutSettings` will be created. */
|
|
2316
|
+
parent: string;
|
|
2317
|
+
/** Returns response with indentations and line breaks. */
|
|
2318
|
+
prettyPrint?: boolean;
|
|
2319
|
+
/** 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. */
|
|
2320
|
+
quotaUser?: string;
|
|
2321
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2322
|
+
upload_protocol?: string;
|
|
2323
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2324
|
+
uploadType?: string;
|
|
2325
|
+
/** Request body */
|
|
2326
|
+
resource: CheckoutSettings;
|
|
2327
|
+
}): Request<CheckoutSettings>;
|
|
2328
|
+
create(
|
|
2329
|
+
request: {
|
|
2330
|
+
/** V1 error format. */
|
|
2331
|
+
'$.xgafv'?: string;
|
|
2332
|
+
/** OAuth access token. */
|
|
2333
|
+
access_token?: string;
|
|
2334
|
+
/** Data format for response. */
|
|
2335
|
+
alt?: string;
|
|
2336
|
+
/** JSONP */
|
|
2337
|
+
callback?: string;
|
|
2338
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2339
|
+
fields?: string;
|
|
2340
|
+
/** 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. */
|
|
2341
|
+
key?: string;
|
|
2342
|
+
/** OAuth 2.0 token for the current user. */
|
|
2343
|
+
oauth_token?: string;
|
|
2344
|
+
/** Required. The merchant account for which the `CheckoutSettings` will be created. */
|
|
2345
|
+
parent: string;
|
|
2346
|
+
/** Returns response with indentations and line breaks. */
|
|
2347
|
+
prettyPrint?: boolean;
|
|
2348
|
+
/** 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. */
|
|
2349
|
+
quotaUser?: string;
|
|
2350
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2351
|
+
upload_protocol?: string;
|
|
2352
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2353
|
+
uploadType?: string;
|
|
2354
|
+
},
|
|
2355
|
+
body: CheckoutSettings,
|
|
2356
|
+
): Request<CheckoutSettings>;
|
|
2357
|
+
/** Deletes `CheckoutSettings` and unenrolls merchant from `Checkout` program. */
|
|
2358
|
+
deleteCheckoutSettings(request?: {
|
|
2359
|
+
/** V1 error format. */
|
|
2360
|
+
'$.xgafv'?: string;
|
|
2361
|
+
/** OAuth access token. */
|
|
2362
|
+
access_token?: string;
|
|
2363
|
+
/** Data format for response. */
|
|
2364
|
+
alt?: string;
|
|
2365
|
+
/** JSONP */
|
|
2366
|
+
callback?: string;
|
|
2367
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2368
|
+
fields?: string;
|
|
2369
|
+
/** 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. */
|
|
2370
|
+
key?: string;
|
|
2371
|
+
/** Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings` */
|
|
2372
|
+
name: string;
|
|
2373
|
+
/** OAuth 2.0 token for the current user. */
|
|
2374
|
+
oauth_token?: string;
|
|
2375
|
+
/** Returns response with indentations and line breaks. */
|
|
2376
|
+
prettyPrint?: boolean;
|
|
2377
|
+
/** 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. */
|
|
2378
|
+
quotaUser?: string;
|
|
2379
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2380
|
+
upload_protocol?: string;
|
|
2381
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2382
|
+
uploadType?: string;
|
|
2383
|
+
}): Request<{}>;
|
|
2384
|
+
/** Gets `CheckoutSettings` for the given merchant. This includes information about review state, enrollment state and URL settings. */
|
|
2385
|
+
getCheckoutSettings(request?: {
|
|
2386
|
+
/** V1 error format. */
|
|
2387
|
+
'$.xgafv'?: string;
|
|
2388
|
+
/** OAuth access token. */
|
|
2389
|
+
access_token?: string;
|
|
2390
|
+
/** Data format for response. */
|
|
2391
|
+
alt?: string;
|
|
2392
|
+
/** JSONP */
|
|
2393
|
+
callback?: string;
|
|
2394
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2395
|
+
fields?: string;
|
|
2396
|
+
/** 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. */
|
|
2397
|
+
key?: string;
|
|
2398
|
+
/** Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings` */
|
|
2399
|
+
name: string;
|
|
2400
|
+
/** OAuth 2.0 token for the current user. */
|
|
2401
|
+
oauth_token?: string;
|
|
2402
|
+
/** Returns response with indentations and line breaks. */
|
|
2403
|
+
prettyPrint?: boolean;
|
|
2404
|
+
/** 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. */
|
|
2405
|
+
quotaUser?: string;
|
|
2406
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2407
|
+
upload_protocol?: string;
|
|
2408
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2409
|
+
uploadType?: string;
|
|
2410
|
+
}): Request<CheckoutSettings>;
|
|
2411
|
+
/** Updates `CheckoutSettings` for the given merchant. */
|
|
2412
|
+
updateCheckoutSettings(request: {
|
|
2413
|
+
/** V1 error format. */
|
|
2414
|
+
'$.xgafv'?: string;
|
|
2415
|
+
/** OAuth access token. */
|
|
2416
|
+
access_token?: string;
|
|
2417
|
+
/** Data format for response. */
|
|
2418
|
+
alt?: string;
|
|
2419
|
+
/** JSONP */
|
|
2420
|
+
callback?: string;
|
|
2421
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2422
|
+
fields?: string;
|
|
2423
|
+
/** 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. */
|
|
2424
|
+
key?: string;
|
|
2425
|
+
/** Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings` */
|
|
2426
|
+
name: string;
|
|
2427
|
+
/** OAuth 2.0 token for the current user. */
|
|
2428
|
+
oauth_token?: string;
|
|
2429
|
+
/** Returns response with indentations and line breaks. */
|
|
2430
|
+
prettyPrint?: boolean;
|
|
2431
|
+
/** 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. */
|
|
2432
|
+
quotaUser?: string;
|
|
2433
|
+
/** Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `eligible_destinations` - `uri_settings` */
|
|
2434
|
+
updateMask?: string;
|
|
2435
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2436
|
+
upload_protocol?: string;
|
|
2437
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2438
|
+
uploadType?: string;
|
|
2439
|
+
/** Request body */
|
|
2440
|
+
resource: CheckoutSettings;
|
|
2441
|
+
}): Request<CheckoutSettings>;
|
|
2442
|
+
updateCheckoutSettings(
|
|
2443
|
+
request: {
|
|
2444
|
+
/** V1 error format. */
|
|
2445
|
+
'$.xgafv'?: string;
|
|
2446
|
+
/** OAuth access token. */
|
|
2447
|
+
access_token?: string;
|
|
2448
|
+
/** Data format for response. */
|
|
2449
|
+
alt?: string;
|
|
2450
|
+
/** JSONP */
|
|
2451
|
+
callback?: string;
|
|
2452
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2453
|
+
fields?: string;
|
|
2454
|
+
/** 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. */
|
|
2455
|
+
key?: string;
|
|
2456
|
+
/** Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings` */
|
|
2457
|
+
name: string;
|
|
2458
|
+
/** OAuth 2.0 token for the current user. */
|
|
2459
|
+
oauth_token?: string;
|
|
2460
|
+
/** Returns response with indentations and line breaks. */
|
|
2461
|
+
prettyPrint?: boolean;
|
|
2462
|
+
/** 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. */
|
|
2463
|
+
quotaUser?: string;
|
|
2464
|
+
/** Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `eligible_destinations` - `uri_settings` */
|
|
2465
|
+
updateMask?: string;
|
|
2466
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2467
|
+
upload_protocol?: string;
|
|
2468
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2469
|
+
uploadType?: string;
|
|
2470
|
+
},
|
|
2471
|
+
body: CheckoutSettings,
|
|
2472
|
+
): Request<CheckoutSettings>;
|
|
2473
|
+
}
|
|
2274
2474
|
interface ProgramsResource {
|
|
2275
2475
|
/** Disable participation in the specified program for the account. */
|
|
2276
2476
|
disable(request: {
|
|
@@ -2446,6 +2646,7 @@ declare namespace gapi.client {
|
|
|
2446
2646
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2447
2647
|
uploadType?: string;
|
|
2448
2648
|
}): Request<ListProgramsResponse>;
|
|
2649
|
+
checkoutSettings: CheckoutSettingsResource;
|
|
2449
2650
|
}
|
|
2450
2651
|
interface RegionsResource {
|
|
2451
2652
|
/** Creates a region definition in your Merchant Center account. Executing this method requires admin access. */
|