@googleapis/merchantapi 3.0.0 → 5.0.0
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/CHANGELOG.md +34 -0
- package/accounts_v1beta.ts +1518 -170
- package/build/accounts_v1beta.d.ts +593 -58
- package/build/accounts_v1beta.js +344 -1
- package/build/accounts_v1beta.js.map +1 -1
- package/build/conversions_v1beta.d.ts +25 -18
- package/build/conversions_v1beta.js.map +1 -1
- package/build/datasources_v1beta.d.ts +31 -10
- package/build/datasources_v1beta.js.map +1 -1
- package/build/inventories_v1beta.d.ts +11 -7
- package/build/inventories_v1beta.js.map +1 -1
- package/build/lfp_v1beta.d.ts +131 -6
- package/build/lfp_v1beta.js +39 -0
- package/build/lfp_v1beta.js.map +1 -1
- package/build/notifications_v1beta.d.ts +10 -6
- package/build/notifications_v1beta.js.map +1 -1
- package/build/products_v1beta.d.ts +76 -19
- package/build/products_v1beta.js +32 -0
- package/build/products_v1beta.js.map +1 -1
- package/build/promotions_v1beta.d.ts +10 -6
- package/build/promotions_v1beta.js.map +1 -1
- package/build/quota_v1beta.d.ts +10 -6
- package/build/quota_v1beta.js.map +1 -1
- package/build/reports_v1beta.d.ts +11 -7
- package/build/reports_v1beta.js.map +1 -1
- package/build/reviews_v1beta.d.ts +12 -8
- package/build/reviews_v1beta.js.map +1 -1
- package/conversions_v1beta.ts +25 -18
- package/datasources_v1beta.ts +31 -10
- package/inventories_v1beta.ts +11 -7
- package/lfp_v1beta.ts +213 -6
- package/notifications_v1beta.ts +10 -6
- package/package.json +1 -1
- package/products_v1beta.ts +152 -19
- package/promotions_v1beta.ts +10 -6
- package/quota_v1beta.ts +10 -6
- package/reports_v1beta.ts +11 -7
- package/reviews_v1beta.ts +12 -8
package/accounts_v1beta.ts
CHANGED
|
@@ -135,14 +135,23 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
135
135
|
*/
|
|
136
136
|
acceptedBy?: string | null;
|
|
137
137
|
/**
|
|
138
|
-
* The accepted
|
|
138
|
+
* The accepted termsOfService.
|
|
139
139
|
*/
|
|
140
140
|
termsOfService?: string | null;
|
|
141
141
|
/**
|
|
142
|
-
* When set, it states that the accepted
|
|
142
|
+
* When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message.
|
|
143
143
|
*/
|
|
144
144
|
validUntil?: Schema$Date;
|
|
145
145
|
}
|
|
146
|
+
/**
|
|
147
|
+
* Response message for the `AcceptTermsOfService` method.
|
|
148
|
+
*/
|
|
149
|
+
export interface Schema$AcceptTermsOfServiceResponse {
|
|
150
|
+
/**
|
|
151
|
+
* The agreement state after accepting the ToS.
|
|
152
|
+
*/
|
|
153
|
+
termsOfServiceAgreementState?: Schema$TermsOfServiceAgreementState;
|
|
154
|
+
}
|
|
146
155
|
/**
|
|
147
156
|
* The `Account` message represents a merchant's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a multi-client account (MCA) structure. In an MCA setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on.
|
|
148
157
|
*/
|
|
@@ -156,7 +165,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
156
165
|
*/
|
|
157
166
|
accountName?: string | null;
|
|
158
167
|
/**
|
|
159
|
-
* Whether this account contains adult content.
|
|
168
|
+
* Optional. Whether this account contains adult content.
|
|
160
169
|
*/
|
|
161
170
|
adultContent?: boolean | null;
|
|
162
171
|
/**
|
|
@@ -172,7 +181,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
172
181
|
*/
|
|
173
182
|
testAccount?: boolean | null;
|
|
174
183
|
/**
|
|
175
|
-
* Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty.
|
|
184
|
+
* Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty. The `version` field is not supported, won't be set in responses and will be silently ignored if specified in requests.
|
|
176
185
|
*/
|
|
177
186
|
timeZone?: Schema$TimeZone;
|
|
178
187
|
}
|
|
@@ -209,6 +218,76 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
209
218
|
*/
|
|
210
219
|
title?: string | null;
|
|
211
220
|
}
|
|
221
|
+
/**
|
|
222
|
+
* `AccountManagement` payload.
|
|
223
|
+
*/
|
|
224
|
+
export interface Schema$AccountManagement {}
|
|
225
|
+
/**
|
|
226
|
+
* The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the merchant, such as product management or campaign management. It specifies the access rights and permissions to the merchant's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce).
|
|
227
|
+
*/
|
|
228
|
+
export interface Schema$AccountRelationship {
|
|
229
|
+
/**
|
|
230
|
+
* Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use `account_id_alias` to assign a friendly name to this relationship for easier identification in your systems.
|
|
231
|
+
*/
|
|
232
|
+
accountIdAlias?: string | null;
|
|
233
|
+
/**
|
|
234
|
+
* Identifier. The resource name of the account relationship.
|
|
235
|
+
*/
|
|
236
|
+
name?: string | null;
|
|
237
|
+
/**
|
|
238
|
+
* Immutable. 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`).
|
|
239
|
+
*/
|
|
240
|
+
provider?: string | null;
|
|
241
|
+
/**
|
|
242
|
+
* Output only. The human-readable display name of the provider account.
|
|
243
|
+
*/
|
|
244
|
+
providerDisplayName?: string | null;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* The `AccountService` message represents a specific service that a provider account offers to a merchant account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the merchant and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API.
|
|
248
|
+
*/
|
|
249
|
+
export interface Schema$AccountService {
|
|
250
|
+
/**
|
|
251
|
+
* Service type for account aggregation. This enables the provider, which is a Multi-Client Account (MCA), to manage multiple sub-accounts (client accounts). Through this service, the MCA provider can perform administrative and operational tasks across all linked sub-accounts. This is useful for agencies, aggregators, or large retailers that need centralized control over many merchant accounts.
|
|
252
|
+
*/
|
|
253
|
+
accountAggregation?: Schema$AccountAggregation;
|
|
254
|
+
/**
|
|
255
|
+
* Service type for account management. Enables the provider to perform administrative actions on the merchant's account, such as configuring account settings, managing users, or updating business information.
|
|
256
|
+
*/
|
|
257
|
+
accountManagement?: Schema$AccountManagement;
|
|
258
|
+
/**
|
|
259
|
+
* Service type for managing advertising campaigns. Grants the provider access to create and manage the merchant's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance.
|
|
260
|
+
*/
|
|
261
|
+
campaignsManagement?: Schema$CampaignsManagement;
|
|
262
|
+
/**
|
|
263
|
+
* 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.
|
|
264
|
+
*/
|
|
265
|
+
externalAccountId?: string | null;
|
|
266
|
+
/**
|
|
267
|
+
* Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved).
|
|
268
|
+
*/
|
|
269
|
+
handshake?: Schema$Handshake;
|
|
270
|
+
/**
|
|
271
|
+
* Output only. Whether the service is mutable (e.g. through Approve / Reject RPCs). A service that was created through another system or API might be immutable.
|
|
272
|
+
*/
|
|
273
|
+
mutability?: string | null;
|
|
274
|
+
/**
|
|
275
|
+
* Identifier. The resource name of the account service.
|
|
276
|
+
*/
|
|
277
|
+
name?: string | null;
|
|
278
|
+
/**
|
|
279
|
+
* Service type for managing products. This allows the provider to handle product data on behalf of the merchant, including reading and writing product listings. It's commonly used when the provider offers inventory management or catalog synchronization services to keep the merchant's product information up-to-date across platforms.
|
|
280
|
+
*/
|
|
281
|
+
productsManagement?: Schema$ProductsManagement;
|
|
282
|
+
/**
|
|
283
|
+
* Output only. 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`).
|
|
284
|
+
*/
|
|
285
|
+
provider?: string | null;
|
|
286
|
+
/**
|
|
287
|
+
* Output only. The human-readable display name of the provider account.
|
|
288
|
+
*/
|
|
289
|
+
providerDisplayName?: string | null;
|
|
290
|
+
}
|
|
212
291
|
/**
|
|
213
292
|
* Additional instructions to add account services during creation of the account.
|
|
214
293
|
*/
|
|
@@ -247,6 +326,23 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
247
326
|
*/
|
|
248
327
|
streetAddress?: string | null;
|
|
249
328
|
}
|
|
329
|
+
/**
|
|
330
|
+
* Instruction for adding a user to the account during creation.
|
|
331
|
+
*/
|
|
332
|
+
export interface Schema$AddUser {
|
|
333
|
+
/**
|
|
334
|
+
* Optional. Details about the user to be added. At the moment, only access rights may be specified.
|
|
335
|
+
*/
|
|
336
|
+
user?: Schema$User;
|
|
337
|
+
/**
|
|
338
|
+
* Required. The email address of the user (for example, `john.doe@gmail.com`).
|
|
339
|
+
*/
|
|
340
|
+
userId?: string | null;
|
|
341
|
+
}
|
|
342
|
+
/**
|
|
343
|
+
* Request to approve an account service.
|
|
344
|
+
*/
|
|
345
|
+
export interface Schema$ApproveAccountServiceRequest {}
|
|
250
346
|
/**
|
|
251
347
|
* Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings.
|
|
252
348
|
*/
|
|
@@ -264,6 +360,74 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
264
360
|
*/
|
|
265
361
|
name?: string | null;
|
|
266
362
|
}
|
|
363
|
+
/**
|
|
364
|
+
* This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973)
|
|
365
|
+
*/
|
|
366
|
+
export interface Schema$AutomaticImageImprovements {
|
|
367
|
+
/**
|
|
368
|
+
* Optional. Determines how the images should be automatically updated. If this field is not present and provided in the update mask, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
|
|
369
|
+
*/
|
|
370
|
+
accountImageImprovementsSettings?: Schema$ImageImprovementsAccountLevelSettings;
|
|
371
|
+
/**
|
|
372
|
+
* Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
|
|
373
|
+
*/
|
|
374
|
+
effectiveAllowAutomaticImageImprovements?: boolean | null;
|
|
375
|
+
}
|
|
376
|
+
/**
|
|
377
|
+
* Collection of information related to the [automatic improvements](https://developers.google.com/shopping-content/guides/automatic-improvements) of an account.
|
|
378
|
+
*/
|
|
379
|
+
export interface Schema$AutomaticImprovements {
|
|
380
|
+
/**
|
|
381
|
+
* This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided in the update mask.
|
|
382
|
+
*/
|
|
383
|
+
imageImprovements?: Schema$AutomaticImageImprovements;
|
|
384
|
+
/**
|
|
385
|
+
* Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided in the update mask.
|
|
386
|
+
*/
|
|
387
|
+
itemUpdates?: Schema$AutomaticItemUpdates;
|
|
388
|
+
/**
|
|
389
|
+
* Identifier. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements`.
|
|
390
|
+
*/
|
|
391
|
+
name?: string | null;
|
|
392
|
+
/**
|
|
393
|
+
* Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data This field is only updated (cleared) if provided in the update mask.
|
|
394
|
+
*/
|
|
395
|
+
shippingImprovements?: Schema$AutomaticShippingImprovements;
|
|
396
|
+
}
|
|
397
|
+
/**
|
|
398
|
+
* Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown.
|
|
399
|
+
*/
|
|
400
|
+
export interface Schema$AutomaticItemUpdates {
|
|
401
|
+
/**
|
|
402
|
+
* Optional. Determines which attributes of the items should be automatically updated. If this field is not present and provided in the update mask, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
|
|
403
|
+
*/
|
|
404
|
+
accountItemUpdatesSettings?: Schema$ItemUpdatesAccountLevelSettings;
|
|
405
|
+
/**
|
|
406
|
+
* Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.
|
|
407
|
+
*/
|
|
408
|
+
effectiveAllowAvailabilityUpdates?: boolean | null;
|
|
409
|
+
/**
|
|
410
|
+
* Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.
|
|
411
|
+
*/
|
|
412
|
+
effectiveAllowConditionUpdates?: boolean | null;
|
|
413
|
+
/**
|
|
414
|
+
* Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.
|
|
415
|
+
*/
|
|
416
|
+
effectiveAllowPriceUpdates?: boolean | null;
|
|
417
|
+
/**
|
|
418
|
+
* Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.
|
|
419
|
+
*/
|
|
420
|
+
effectiveAllowStrictAvailabilityUpdates?: boolean | null;
|
|
421
|
+
}
|
|
422
|
+
/**
|
|
423
|
+
* Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data
|
|
424
|
+
*/
|
|
425
|
+
export interface Schema$AutomaticShippingImprovements {
|
|
426
|
+
/**
|
|
427
|
+
* Enables automatic shipping improvements.
|
|
428
|
+
*/
|
|
429
|
+
allowShippingImprovements?: boolean | null;
|
|
430
|
+
}
|
|
267
431
|
/**
|
|
268
432
|
* Business days of the warehouse.
|
|
269
433
|
*/
|
|
@@ -335,6 +499,10 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
335
499
|
*/
|
|
336
500
|
phoneVerificationState?: string | null;
|
|
337
501
|
}
|
|
502
|
+
/**
|
|
503
|
+
* `CampaignManagement` payload.
|
|
504
|
+
*/
|
|
505
|
+
export interface Schema$CampaignsManagement {}
|
|
338
506
|
/**
|
|
339
507
|
* A list of carrier rates that can be referred to by `main_table` or `single_value`. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?ref_topic=12570808&sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.
|
|
340
508
|
*/
|
|
@@ -388,6 +556,10 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
388
556
|
/**
|
|
389
557
|
* Optional. Users to be added to the account.
|
|
390
558
|
*/
|
|
559
|
+
user?: Schema$AddUser[];
|
|
560
|
+
/**
|
|
561
|
+
* Optional. Users to be added to the account. This field is deprecated and will not exist after the API evolves out of beta. Use the `user` field instead.
|
|
562
|
+
*/
|
|
391
563
|
users?: Schema$CreateUserRequest[];
|
|
392
564
|
}
|
|
393
565
|
/**
|
|
@@ -563,6 +735,19 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
563
735
|
*/
|
|
564
736
|
geotargetCriteriaIds?: string[] | null;
|
|
565
737
|
}
|
|
738
|
+
/**
|
|
739
|
+
* The current status of establishing of the service. (for example, pending approval or approved).
|
|
740
|
+
*/
|
|
741
|
+
export interface Schema$Handshake {
|
|
742
|
+
/**
|
|
743
|
+
* Output only. The most recent account to modify the account service's `approval_status`.
|
|
744
|
+
*/
|
|
745
|
+
actor?: string | null;
|
|
746
|
+
/**
|
|
747
|
+
* Output only. The approval state of this handshake.
|
|
748
|
+
*/
|
|
749
|
+
approvalState?: string | null;
|
|
750
|
+
}
|
|
566
751
|
/**
|
|
567
752
|
* A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set.
|
|
568
753
|
*/
|
|
@@ -614,6 +799,15 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
614
799
|
*/
|
|
615
800
|
identityDeclaration?: string | null;
|
|
616
801
|
}
|
|
802
|
+
/**
|
|
803
|
+
* Settings for the Automatic Image Improvements.
|
|
804
|
+
*/
|
|
805
|
+
export interface Schema$ImageImprovementsAccountLevelSettings {
|
|
806
|
+
/**
|
|
807
|
+
* Enables automatic image improvements.
|
|
808
|
+
*/
|
|
809
|
+
allowAutomaticImageImprovements?: boolean | null;
|
|
810
|
+
}
|
|
617
811
|
/**
|
|
618
812
|
* The impact of the issue on a region.
|
|
619
813
|
*/
|
|
@@ -640,6 +834,27 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
640
834
|
*/
|
|
641
835
|
reportingContext?: string | null;
|
|
642
836
|
}
|
|
837
|
+
/**
|
|
838
|
+
* Settings for the Automatic Item Updates.
|
|
839
|
+
*/
|
|
840
|
+
export interface Schema$ItemUpdatesAccountLevelSettings {
|
|
841
|
+
/**
|
|
842
|
+
* If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_strict_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
|
|
843
|
+
*/
|
|
844
|
+
allowAvailabilityUpdates?: boolean | null;
|
|
845
|
+
/**
|
|
846
|
+
* If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
|
|
847
|
+
*/
|
|
848
|
+
allowConditionUpdates?: boolean | null;
|
|
849
|
+
/**
|
|
850
|
+
* If price updates are enabled, Google always updates the active price with the crawled information.
|
|
851
|
+
*/
|
|
852
|
+
allowPriceUpdates?: boolean | null;
|
|
853
|
+
/**
|
|
854
|
+
* If `allow_availability_updates` is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also set `allow_availability_updates`.
|
|
855
|
+
*/
|
|
856
|
+
allowStrictAvailabilityUpdates?: boolean | null;
|
|
857
|
+
}
|
|
643
858
|
/**
|
|
644
859
|
* Response message for the `ListAccountIssues` method.
|
|
645
860
|
*/
|
|
@@ -653,6 +868,32 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
653
868
|
*/
|
|
654
869
|
nextPageToken?: string | null;
|
|
655
870
|
}
|
|
871
|
+
/**
|
|
872
|
+
* Response after trying to list account relationships.
|
|
873
|
+
*/
|
|
874
|
+
export interface Schema$ListAccountRelationshipsResponse {
|
|
875
|
+
/**
|
|
876
|
+
* The account relationships that match your filter.
|
|
877
|
+
*/
|
|
878
|
+
accountRelationships?: Schema$AccountRelationship[];
|
|
879
|
+
/**
|
|
880
|
+
* A page token. You can send the `page_token` to get the next page. Only included in the `list` response if there are more pages.
|
|
881
|
+
*/
|
|
882
|
+
nextPageToken?: string | null;
|
|
883
|
+
}
|
|
884
|
+
/**
|
|
885
|
+
* Response after trying to list account services.
|
|
886
|
+
*/
|
|
887
|
+
export interface Schema$ListAccountServicesResponse {
|
|
888
|
+
/**
|
|
889
|
+
* The account services that match your filter.
|
|
890
|
+
*/
|
|
891
|
+
accountServices?: Schema$AccountService[];
|
|
892
|
+
/**
|
|
893
|
+
* A page token. You can send the `page_token` to get the next page. Only included in the `list` response if there are more pages.
|
|
894
|
+
*/
|
|
895
|
+
nextPageToken?: string | null;
|
|
896
|
+
}
|
|
656
897
|
/**
|
|
657
898
|
* Response message for the `ListAccounts` method.
|
|
658
899
|
*/
|
|
@@ -789,11 +1030,11 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
789
1030
|
*/
|
|
790
1031
|
export interface Schema$OnlineReturnPolicy {
|
|
791
1032
|
/**
|
|
792
|
-
* This field specifies if merchant only accepts defective products for returns
|
|
1033
|
+
* Optional. This field specifies if merchant only accepts defective products for returns.
|
|
793
1034
|
*/
|
|
794
1035
|
acceptDefectiveOnly?: boolean | null;
|
|
795
1036
|
/**
|
|
796
|
-
* This field specifies if merchant allows customers to exchange products
|
|
1037
|
+
* Optional. This field specifies if merchant allows customers to exchange products.
|
|
797
1038
|
*/
|
|
798
1039
|
acceptExchange?: boolean | null;
|
|
799
1040
|
/**
|
|
@@ -801,7 +1042,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
801
1042
|
*/
|
|
802
1043
|
countries?: string[] | null;
|
|
803
1044
|
/**
|
|
804
|
-
* The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.
|
|
1045
|
+
* Optional. The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.
|
|
805
1046
|
*/
|
|
806
1047
|
itemConditions?: string[] | null;
|
|
807
1048
|
/**
|
|
@@ -813,19 +1054,23 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
813
1054
|
*/
|
|
814
1055
|
name?: string | null;
|
|
815
1056
|
/**
|
|
816
|
-
* The return policy.
|
|
1057
|
+
* Optional. The return policy.
|
|
817
1058
|
*/
|
|
818
1059
|
policy?: Schema$Policy;
|
|
819
1060
|
/**
|
|
820
|
-
* The field specifies the number of days it takes for merchants to process refunds
|
|
1061
|
+
* Optional. The field specifies the number of days it takes for merchants to process refunds.
|
|
821
1062
|
*/
|
|
822
1063
|
processRefundDays?: number | null;
|
|
823
1064
|
/**
|
|
824
|
-
* The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.
|
|
1065
|
+
* Optional. The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.
|
|
825
1066
|
*/
|
|
826
1067
|
restockingFee?: Schema$RestockingFee;
|
|
827
1068
|
/**
|
|
828
|
-
*
|
|
1069
|
+
* Optional. The field specifies the return label source.
|
|
1070
|
+
*/
|
|
1071
|
+
returnLabelSource?: string | null;
|
|
1072
|
+
/**
|
|
1073
|
+
* Optional. The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.
|
|
829
1074
|
*/
|
|
830
1075
|
returnMethods?: string[] | null;
|
|
831
1076
|
/**
|
|
@@ -837,7 +1082,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
837
1082
|
*/
|
|
838
1083
|
returnPolicyUri?: string | null;
|
|
839
1084
|
/**
|
|
840
|
-
* The return shipping fee. Should be set only when customer need to download and print the return label.
|
|
1085
|
+
* Optional. The return shipping fee. Should be set only when customer need to download and print the return label.
|
|
841
1086
|
*/
|
|
842
1087
|
returnShippingFee?: Schema$ReturnShippingFee;
|
|
843
1088
|
/**
|
|
@@ -876,15 +1121,15 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
876
1121
|
type?: string | null;
|
|
877
1122
|
}
|
|
878
1123
|
/**
|
|
879
|
-
* Represents a postal address
|
|
1124
|
+
* Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.
|
|
880
1125
|
*/
|
|
881
1126
|
export interface Schema$PostalAddress {
|
|
882
1127
|
/**
|
|
883
|
-
* Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (
|
|
1128
|
+
* Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
|
|
884
1129
|
*/
|
|
885
1130
|
addressLines?: string[] | null;
|
|
886
1131
|
/**
|
|
887
|
-
* Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture.
|
|
1132
|
+
* Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
|
|
888
1133
|
*/
|
|
889
1134
|
administrativeArea?: string | null;
|
|
890
1135
|
/**
|
|
@@ -892,7 +1137,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
892
1137
|
*/
|
|
893
1138
|
languageCode?: string | null;
|
|
894
1139
|
/**
|
|
895
|
-
* Optional. Generally refers to the city
|
|
1140
|
+
* Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
|
|
896
1141
|
*/
|
|
897
1142
|
locality?: string | null;
|
|
898
1143
|
/**
|
|
@@ -900,7 +1145,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
900
1145
|
*/
|
|
901
1146
|
organization?: string | null;
|
|
902
1147
|
/**
|
|
903
|
-
* Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (
|
|
1148
|
+
* Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
|
|
904
1149
|
*/
|
|
905
1150
|
postalCode?: string | null;
|
|
906
1151
|
/**
|
|
@@ -916,11 +1161,11 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
916
1161
|
*/
|
|
917
1162
|
revision?: number | null;
|
|
918
1163
|
/**
|
|
919
|
-
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (
|
|
1164
|
+
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
|
|
920
1165
|
*/
|
|
921
1166
|
sortingCode?: string | null;
|
|
922
1167
|
/**
|
|
923
|
-
* Optional. Sublocality of the address. For example, this can be
|
|
1168
|
+
* Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
|
|
924
1169
|
*/
|
|
925
1170
|
sublocality?: string | null;
|
|
926
1171
|
}
|
|
@@ -968,22 +1213,26 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
968
1213
|
*/
|
|
969
1214
|
export interface Schema$ProductChange {
|
|
970
1215
|
/**
|
|
971
|
-
* The new value of the changed resource or attribute.
|
|
1216
|
+
* The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
|
|
972
1217
|
*/
|
|
973
1218
|
newValue?: string | null;
|
|
974
1219
|
/**
|
|
975
|
-
* The old value of the changed resource or attribute.
|
|
1220
|
+
* The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
|
|
976
1221
|
*/
|
|
977
1222
|
oldValue?: string | null;
|
|
978
1223
|
/**
|
|
979
|
-
* Countries that have the change (if applicable)
|
|
1224
|
+
* Countries that have the change (if applicable). Represented in the ISO 3166 format.
|
|
980
1225
|
*/
|
|
981
1226
|
regionCode?: string | null;
|
|
982
1227
|
/**
|
|
983
|
-
* Reporting contexts that have the change (if applicable)
|
|
1228
|
+
* Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)
|
|
984
1229
|
*/
|
|
985
1230
|
reportingContext?: string | null;
|
|
986
1231
|
}
|
|
1232
|
+
/**
|
|
1233
|
+
* `ProductsManagement` payload.
|
|
1234
|
+
*/
|
|
1235
|
+
export interface Schema$ProductsManagement {}
|
|
987
1236
|
/**
|
|
988
1237
|
* The message that the merchant will receive to notify about product status change event
|
|
989
1238
|
*/
|
|
@@ -1001,7 +1250,11 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1001
1250
|
*/
|
|
1002
1251
|
changes?: Schema$ProductChange[];
|
|
1003
1252
|
/**
|
|
1004
|
-
* The
|
|
1253
|
+
* The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.
|
|
1254
|
+
*/
|
|
1255
|
+
eventTime?: string | null;
|
|
1256
|
+
/**
|
|
1257
|
+
* Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
|
|
1005
1258
|
*/
|
|
1006
1259
|
expirationTime?: string | null;
|
|
1007
1260
|
/**
|
|
@@ -1009,7 +1262,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1009
1262
|
*/
|
|
1010
1263
|
managingAccount?: string | null;
|
|
1011
1264
|
/**
|
|
1012
|
-
* The product name. Format: `
|
|
1265
|
+
* The product name. Format: `accounts/{account\}/products/{product\}`
|
|
1013
1266
|
*/
|
|
1014
1267
|
resource?: string | null;
|
|
1015
1268
|
/**
|
|
@@ -1022,7 +1275,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1022
1275
|
resourceType?: string | null;
|
|
1023
1276
|
}
|
|
1024
1277
|
/**
|
|
1025
|
-
* Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free.
|
|
1278
|
+
* Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`
|
|
1026
1279
|
*/
|
|
1027
1280
|
export interface Schema$Program {
|
|
1028
1281
|
/**
|
|
@@ -1046,6 +1299,19 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1046
1299
|
*/
|
|
1047
1300
|
unmetRequirements?: Schema$Requirement[];
|
|
1048
1301
|
}
|
|
1302
|
+
/**
|
|
1303
|
+
* Request to propose an account service.
|
|
1304
|
+
*/
|
|
1305
|
+
export interface Schema$ProposeAccountServiceRequest {
|
|
1306
|
+
/**
|
|
1307
|
+
* Required. The account service to propose.
|
|
1308
|
+
*/
|
|
1309
|
+
accountService?: Schema$AccountService;
|
|
1310
|
+
/**
|
|
1311
|
+
* 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`).
|
|
1312
|
+
*/
|
|
1313
|
+
provider?: string | null;
|
|
1314
|
+
}
|
|
1049
1315
|
/**
|
|
1050
1316
|
* 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.
|
|
1051
1317
|
*/
|
|
@@ -1104,16 +1370,20 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1104
1370
|
*/
|
|
1105
1371
|
shippingEligible?: boolean | null;
|
|
1106
1372
|
}
|
|
1373
|
+
/**
|
|
1374
|
+
* Request to reject an account service.
|
|
1375
|
+
*/
|
|
1376
|
+
export interface Schema$RejectAccountServiceRequest {}
|
|
1107
1377
|
/**
|
|
1108
1378
|
* Describes the terms of service which are required to be accepted.
|
|
1109
1379
|
*/
|
|
1110
1380
|
export interface Schema$Required {
|
|
1111
1381
|
/**
|
|
1112
|
-
* The
|
|
1382
|
+
* The `TermsOfService` that need to be accepted.
|
|
1113
1383
|
*/
|
|
1114
1384
|
termsOfService?: string | null;
|
|
1115
1385
|
/**
|
|
1116
|
-
* Full URL to the terms of service file. This field is the same as
|
|
1386
|
+
* Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only.
|
|
1117
1387
|
*/
|
|
1118
1388
|
tosFileUri?: string | null;
|
|
1119
1389
|
}
|
|
@@ -1169,26 +1439,27 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1169
1439
|
*/
|
|
1170
1440
|
cells?: Schema$Value[];
|
|
1171
1441
|
}
|
|
1172
|
-
/**
|
|
1173
|
-
* Next: 5
|
|
1174
|
-
*/
|
|
1175
1442
|
export interface Schema$SeasonalOverride {
|
|
1176
|
-
/**
|
|
1177
|
-
* Required. Defines the date range when this seasonal override applies. Both begin and end are inclusive and should be in date decimal format, example 20250115. The dates of the seasonal overrides should not overlap.
|
|
1178
|
-
*/
|
|
1179
|
-
begin?: Schema$Date;
|
|
1180
1443
|
/**
|
|
1181
1444
|
* Required. seasonal override end date (inclusive).
|
|
1182
1445
|
*/
|
|
1183
|
-
|
|
1446
|
+
endDate?: Schema$Date;
|
|
1184
1447
|
/**
|
|
1185
1448
|
* Required. Display name of this seasonal override in Merchant Center.
|
|
1186
1449
|
*/
|
|
1187
1450
|
label?: string | null;
|
|
1188
1451
|
/**
|
|
1189
|
-
*
|
|
1452
|
+
* Number of days (from the delivery date) that the product can be returned.
|
|
1190
1453
|
*/
|
|
1191
|
-
|
|
1454
|
+
returnDays?: number | null;
|
|
1455
|
+
/**
|
|
1456
|
+
* Fixed end date until which the product can be returned.
|
|
1457
|
+
*/
|
|
1458
|
+
returnUntilDate?: Schema$Date;
|
|
1459
|
+
/**
|
|
1460
|
+
* Required. Defines the date range when this seasonal override applies. Both start_date and end_date are inclusive. The dates of the seasonal overrides should not overlap.
|
|
1461
|
+
*/
|
|
1462
|
+
startDate?: Schema$Date;
|
|
1192
1463
|
}
|
|
1193
1464
|
/**
|
|
1194
1465
|
* Shipping service.
|
|
@@ -1199,7 +1470,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1199
1470
|
*/
|
|
1200
1471
|
active?: boolean | null;
|
|
1201
1472
|
/**
|
|
1202
|
-
* The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
|
|
1473
|
+
* Required. The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
|
|
1203
1474
|
*/
|
|
1204
1475
|
currencyCode?: string | null;
|
|
1205
1476
|
/**
|
|
@@ -1240,7 +1511,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1240
1511
|
storeConfig?: Schema$StoreConfig;
|
|
1241
1512
|
}
|
|
1242
1513
|
/**
|
|
1243
|
-
* The merchant account's [shipping
|
|
1514
|
+
* The merchant account's [shipping settings](https://support.google.com/merchants/answer/6069284).
|
|
1244
1515
|
*/
|
|
1245
1516
|
export interface Schema$ShippingSettings {
|
|
1246
1517
|
/**
|
|
@@ -1248,7 +1519,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1248
1519
|
*/
|
|
1249
1520
|
etag?: string | null;
|
|
1250
1521
|
/**
|
|
1251
|
-
* Identifier. The resource name of the shipping
|
|
1522
|
+
* Identifier. The resource name of the shipping settings. Format: `accounts/{account\}/shippingSettings`
|
|
1252
1523
|
*/
|
|
1253
1524
|
name?: string | null;
|
|
1254
1525
|
/**
|
|
@@ -1329,7 +1600,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1329
1600
|
rows?: Schema$Row[];
|
|
1330
1601
|
}
|
|
1331
1602
|
/**
|
|
1332
|
-
* The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services
|
|
1603
|
+
* The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see [Terms of Service](https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`.
|
|
1333
1604
|
*/
|
|
1334
1605
|
export interface Schema$TermsOfService {
|
|
1335
1606
|
/**
|
|
@@ -1354,7 +1625,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1354
1625
|
regionCode?: string | null;
|
|
1355
1626
|
}
|
|
1356
1627
|
/**
|
|
1357
|
-
* This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the merchant has accepted a terms of service
|
|
1628
|
+
* This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the merchant has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the merchant must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect 3Ps to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource.
|
|
1358
1629
|
*/
|
|
1359
1630
|
export interface Schema$TermsOfServiceAgreementState {
|
|
1360
1631
|
/**
|
|
@@ -1439,7 +1710,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1439
1710
|
*/
|
|
1440
1711
|
export interface Schema$User {
|
|
1441
1712
|
/**
|
|
1442
|
-
*
|
|
1713
|
+
* Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
|
|
1443
1714
|
*/
|
|
1444
1715
|
accessRights?: string[] | null;
|
|
1445
1716
|
/**
|
|
@@ -1548,6 +1819,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1548
1819
|
export class Resource$Accounts {
|
|
1549
1820
|
context: APIRequestContext;
|
|
1550
1821
|
autofeedSettings: Resource$Accounts$Autofeedsettings;
|
|
1822
|
+
automaticImprovements: Resource$Accounts$Automaticimprovements;
|
|
1551
1823
|
businessIdentity: Resource$Accounts$Businessidentity;
|
|
1552
1824
|
businessInfo: Resource$Accounts$Businessinfo;
|
|
1553
1825
|
emailPreferences: Resource$Accounts$Emailpreferences;
|
|
@@ -1556,6 +1828,8 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1556
1828
|
onlineReturnPolicies: Resource$Accounts$Onlinereturnpolicies;
|
|
1557
1829
|
programs: Resource$Accounts$Programs;
|
|
1558
1830
|
regions: Resource$Accounts$Regions;
|
|
1831
|
+
relationships: Resource$Accounts$Relationships;
|
|
1832
|
+
services: Resource$Accounts$Services;
|
|
1559
1833
|
shippingSettings: Resource$Accounts$Shippingsettings;
|
|
1560
1834
|
termsOfServiceAgreementStates: Resource$Accounts$Termsofserviceagreementstates;
|
|
1561
1835
|
users: Resource$Accounts$Users;
|
|
@@ -1564,6 +1838,9 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1564
1838
|
this.autofeedSettings = new Resource$Accounts$Autofeedsettings(
|
|
1565
1839
|
this.context
|
|
1566
1840
|
);
|
|
1841
|
+
this.automaticImprovements = new Resource$Accounts$Automaticimprovements(
|
|
1842
|
+
this.context
|
|
1843
|
+
);
|
|
1567
1844
|
this.businessIdentity = new Resource$Accounts$Businessidentity(
|
|
1568
1845
|
this.context
|
|
1569
1846
|
);
|
|
@@ -1578,6 +1855,8 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1578
1855
|
);
|
|
1579
1856
|
this.programs = new Resource$Accounts$Programs(this.context);
|
|
1580
1857
|
this.regions = new Resource$Accounts$Regions(this.context);
|
|
1858
|
+
this.relationships = new Resource$Accounts$Relationships(this.context);
|
|
1859
|
+
this.services = new Resource$Accounts$Services(this.context);
|
|
1581
1860
|
this.shippingSettings = new Resource$Accounts$Shippingsettings(
|
|
1582
1861
|
this.context
|
|
1583
1862
|
);
|
|
@@ -1587,7 +1866,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1587
1866
|
}
|
|
1588
1867
|
|
|
1589
1868
|
/**
|
|
1590
|
-
* Creates a
|
|
1869
|
+
* Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.
|
|
1591
1870
|
*
|
|
1592
1871
|
* @param params - Parameters for request
|
|
1593
1872
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1848,7 +2127,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1848
2127
|
}
|
|
1849
2128
|
|
|
1850
2129
|
/**
|
|
1851
|
-
* Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is
|
|
2130
|
+
* Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns all the accounts the user has access to. This method is eventually consistent, meaning changes such as creating, updating an account or a change of relationships between accounts may not show up in the results immediately. Instead, these changes propagate over a short period, after which the updated information can match the associated predicates. That means, that searching by account name might not return a recently changed account even though it satisfies the predicate.
|
|
1852
2131
|
*
|
|
1853
2132
|
* @param params - Parameters for request
|
|
1854
2133
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2146,7 +2425,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2146
2425
|
}
|
|
2147
2426
|
export interface Params$Resource$Accounts$List extends StandardParameters {
|
|
2148
2427
|
/**
|
|
2149
|
-
* Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax).
|
|
2428
|
+
* 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).
|
|
2150
2429
|
*/
|
|
2151
2430
|
filter?: string;
|
|
2152
2431
|
/**
|
|
@@ -2169,7 +2448,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2169
2448
|
*/
|
|
2170
2449
|
pageToken?: string;
|
|
2171
2450
|
/**
|
|
2172
|
-
* Required. The aggregation service provider. Format: `
|
|
2451
|
+
* Required. The aggregation service provider. Format: `accounts/{accountId\}`
|
|
2173
2452
|
*/
|
|
2174
2453
|
provider?: string;
|
|
2175
2454
|
}
|
|
@@ -2402,67 +2681,72 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2402
2681
|
requestBody?: Schema$AutofeedSettings;
|
|
2403
2682
|
}
|
|
2404
2683
|
|
|
2405
|
-
export class Resource$Accounts$
|
|
2684
|
+
export class Resource$Accounts$Automaticimprovements {
|
|
2406
2685
|
context: APIRequestContext;
|
|
2407
2686
|
constructor(context: APIRequestContext) {
|
|
2408
2687
|
this.context = context;
|
|
2409
2688
|
}
|
|
2410
2689
|
|
|
2411
2690
|
/**
|
|
2412
|
-
* Retrieves the
|
|
2691
|
+
* Retrieves the automatic improvements of an account.
|
|
2413
2692
|
*
|
|
2414
2693
|
* @param params - Parameters for request
|
|
2415
2694
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2416
2695
|
* @param callback - Optional callback that handles the response.
|
|
2417
2696
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2418
2697
|
*/
|
|
2419
|
-
|
|
2420
|
-
params: Params$Resource$Accounts$
|
|
2698
|
+
getAutomaticImprovements(
|
|
2699
|
+
params: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements,
|
|
2421
2700
|
options: StreamMethodOptions
|
|
2422
2701
|
): GaxiosPromise<Readable>;
|
|
2423
|
-
|
|
2424
|
-
params?: Params$Resource$Accounts$
|
|
2702
|
+
getAutomaticImprovements(
|
|
2703
|
+
params?: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements,
|
|
2425
2704
|
options?: MethodOptions
|
|
2426
|
-
): GaxiosPromise<Schema$
|
|
2427
|
-
|
|
2428
|
-
params: Params$Resource$Accounts$
|
|
2705
|
+
): GaxiosPromise<Schema$AutomaticImprovements>;
|
|
2706
|
+
getAutomaticImprovements(
|
|
2707
|
+
params: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements,
|
|
2429
2708
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2430
2709
|
callback: BodyResponseCallback<Readable>
|
|
2431
2710
|
): void;
|
|
2432
|
-
|
|
2433
|
-
params: Params$Resource$Accounts$
|
|
2434
|
-
options:
|
|
2435
|
-
|
|
2711
|
+
getAutomaticImprovements(
|
|
2712
|
+
params: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements,
|
|
2713
|
+
options:
|
|
2714
|
+
| MethodOptions
|
|
2715
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>,
|
|
2716
|
+
callback: BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2436
2717
|
): void;
|
|
2437
|
-
|
|
2438
|
-
params: Params$Resource$Accounts$
|
|
2439
|
-
callback: BodyResponseCallback<Schema$
|
|
2718
|
+
getAutomaticImprovements(
|
|
2719
|
+
params: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements,
|
|
2720
|
+
callback: BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2440
2721
|
): void;
|
|
2441
|
-
|
|
2442
|
-
callback: BodyResponseCallback<Schema$
|
|
2722
|
+
getAutomaticImprovements(
|
|
2723
|
+
callback: BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2443
2724
|
): void;
|
|
2444
|
-
|
|
2725
|
+
getAutomaticImprovements(
|
|
2445
2726
|
paramsOrCallback?:
|
|
2446
|
-
| Params$Resource$Accounts$
|
|
2447
|
-
| BodyResponseCallback<Schema$
|
|
2727
|
+
| Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements
|
|
2728
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2448
2729
|
| BodyResponseCallback<Readable>,
|
|
2449
2730
|
optionsOrCallback?:
|
|
2450
2731
|
| MethodOptions
|
|
2451
2732
|
| StreamMethodOptions
|
|
2452
|
-
| BodyResponseCallback<Schema$
|
|
2733
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2453
2734
|
| BodyResponseCallback<Readable>,
|
|
2454
2735
|
callback?:
|
|
2455
|
-
| BodyResponseCallback<Schema$
|
|
2736
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2456
2737
|
| BodyResponseCallback<Readable>
|
|
2457
|
-
):
|
|
2738
|
+
):
|
|
2739
|
+
| void
|
|
2740
|
+
| GaxiosPromise<Schema$AutomaticImprovements>
|
|
2741
|
+
| GaxiosPromise<Readable> {
|
|
2458
2742
|
let params = (paramsOrCallback ||
|
|
2459
|
-
{}) as Params$Resource$Accounts$
|
|
2743
|
+
{}) as Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements;
|
|
2460
2744
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2461
2745
|
|
|
2462
2746
|
if (typeof paramsOrCallback === 'function') {
|
|
2463
2747
|
callback = paramsOrCallback;
|
|
2464
2748
|
params =
|
|
2465
|
-
{} as Params$Resource$Accounts$
|
|
2749
|
+
{} as Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements;
|
|
2466
2750
|
options = {};
|
|
2467
2751
|
}
|
|
2468
2752
|
|
|
@@ -2490,70 +2774,75 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2490
2774
|
context: this.context,
|
|
2491
2775
|
};
|
|
2492
2776
|
if (callback) {
|
|
2493
|
-
createAPIRequest<Schema$
|
|
2777
|
+
createAPIRequest<Schema$AutomaticImprovements>(
|
|
2494
2778
|
parameters,
|
|
2495
2779
|
callback as BodyResponseCallback<unknown>
|
|
2496
2780
|
);
|
|
2497
2781
|
} else {
|
|
2498
|
-
return createAPIRequest<Schema$
|
|
2782
|
+
return createAPIRequest<Schema$AutomaticImprovements>(parameters);
|
|
2499
2783
|
}
|
|
2500
2784
|
}
|
|
2501
2785
|
|
|
2502
2786
|
/**
|
|
2503
|
-
* Updates the
|
|
2787
|
+
* Updates the automatic improvements of an account.
|
|
2504
2788
|
*
|
|
2505
2789
|
* @param params - Parameters for request
|
|
2506
2790
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2507
2791
|
* @param callback - Optional callback that handles the response.
|
|
2508
2792
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2509
2793
|
*/
|
|
2510
|
-
|
|
2511
|
-
params: Params$Resource$Accounts$
|
|
2794
|
+
updateAutomaticImprovements(
|
|
2795
|
+
params: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements,
|
|
2512
2796
|
options: StreamMethodOptions
|
|
2513
2797
|
): GaxiosPromise<Readable>;
|
|
2514
|
-
|
|
2515
|
-
params?: Params$Resource$Accounts$
|
|
2798
|
+
updateAutomaticImprovements(
|
|
2799
|
+
params?: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements,
|
|
2516
2800
|
options?: MethodOptions
|
|
2517
|
-
): GaxiosPromise<Schema$
|
|
2518
|
-
|
|
2519
|
-
params: Params$Resource$Accounts$
|
|
2801
|
+
): GaxiosPromise<Schema$AutomaticImprovements>;
|
|
2802
|
+
updateAutomaticImprovements(
|
|
2803
|
+
params: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements,
|
|
2520
2804
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2521
2805
|
callback: BodyResponseCallback<Readable>
|
|
2522
2806
|
): void;
|
|
2523
|
-
|
|
2524
|
-
params: Params$Resource$Accounts$
|
|
2525
|
-
options:
|
|
2526
|
-
|
|
2807
|
+
updateAutomaticImprovements(
|
|
2808
|
+
params: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements,
|
|
2809
|
+
options:
|
|
2810
|
+
| MethodOptions
|
|
2811
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>,
|
|
2812
|
+
callback: BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2527
2813
|
): void;
|
|
2528
|
-
|
|
2529
|
-
params: Params$Resource$Accounts$
|
|
2530
|
-
callback: BodyResponseCallback<Schema$
|
|
2814
|
+
updateAutomaticImprovements(
|
|
2815
|
+
params: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements,
|
|
2816
|
+
callback: BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2531
2817
|
): void;
|
|
2532
|
-
|
|
2533
|
-
callback: BodyResponseCallback<Schema$
|
|
2818
|
+
updateAutomaticImprovements(
|
|
2819
|
+
callback: BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2534
2820
|
): void;
|
|
2535
|
-
|
|
2821
|
+
updateAutomaticImprovements(
|
|
2536
2822
|
paramsOrCallback?:
|
|
2537
|
-
| Params$Resource$Accounts$
|
|
2538
|
-
| BodyResponseCallback<Schema$
|
|
2823
|
+
| Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements
|
|
2824
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2539
2825
|
| BodyResponseCallback<Readable>,
|
|
2540
2826
|
optionsOrCallback?:
|
|
2541
2827
|
| MethodOptions
|
|
2542
2828
|
| StreamMethodOptions
|
|
2543
|
-
| BodyResponseCallback<Schema$
|
|
2829
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2544
2830
|
| BodyResponseCallback<Readable>,
|
|
2545
2831
|
callback?:
|
|
2546
|
-
| BodyResponseCallback<Schema$
|
|
2832
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2547
2833
|
| BodyResponseCallback<Readable>
|
|
2548
|
-
):
|
|
2834
|
+
):
|
|
2835
|
+
| void
|
|
2836
|
+
| GaxiosPromise<Schema$AutomaticImprovements>
|
|
2837
|
+
| GaxiosPromise<Readable> {
|
|
2549
2838
|
let params = (paramsOrCallback ||
|
|
2550
|
-
{}) as Params$Resource$Accounts$
|
|
2839
|
+
{}) as Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements;
|
|
2551
2840
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2552
2841
|
|
|
2553
2842
|
if (typeof paramsOrCallback === 'function') {
|
|
2554
2843
|
callback = paramsOrCallback;
|
|
2555
2844
|
params =
|
|
2556
|
-
{} as Params$Resource$Accounts$
|
|
2845
|
+
{} as Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements;
|
|
2557
2846
|
options = {};
|
|
2558
2847
|
}
|
|
2559
2848
|
|
|
@@ -2581,68 +2870,281 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2581
2870
|
context: this.context,
|
|
2582
2871
|
};
|
|
2583
2872
|
if (callback) {
|
|
2584
|
-
createAPIRequest<Schema$
|
|
2873
|
+
createAPIRequest<Schema$AutomaticImprovements>(
|
|
2585
2874
|
parameters,
|
|
2586
2875
|
callback as BodyResponseCallback<unknown>
|
|
2587
2876
|
);
|
|
2588
2877
|
} else {
|
|
2589
|
-
return createAPIRequest<Schema$
|
|
2878
|
+
return createAPIRequest<Schema$AutomaticImprovements>(parameters);
|
|
2590
2879
|
}
|
|
2591
2880
|
}
|
|
2592
2881
|
}
|
|
2593
2882
|
|
|
2594
|
-
export interface Params$Resource$Accounts$
|
|
2883
|
+
export interface Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements
|
|
2595
2884
|
extends StandardParameters {
|
|
2596
2885
|
/**
|
|
2597
|
-
* Required. The resource name of the
|
|
2886
|
+
* Required. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements`
|
|
2598
2887
|
*/
|
|
2599
2888
|
name?: string;
|
|
2600
2889
|
}
|
|
2601
|
-
export interface Params$Resource$Accounts$
|
|
2890
|
+
export interface Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements
|
|
2602
2891
|
extends StandardParameters {
|
|
2603
2892
|
/**
|
|
2604
|
-
* Identifier. The resource name of the
|
|
2893
|
+
* Identifier. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements`.
|
|
2605
2894
|
*/
|
|
2606
2895
|
name?: string;
|
|
2607
2896
|
/**
|
|
2608
|
-
*
|
|
2897
|
+
* Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `item_updates` - `item_updates.account_level_settings` - `image_improvements` - `image_improvements.account_level_settings` - `shipping_improvements` - `shipping_improvements.allow_shipping_improvements`
|
|
2609
2898
|
*/
|
|
2610
2899
|
updateMask?: string;
|
|
2611
2900
|
|
|
2612
2901
|
/**
|
|
2613
2902
|
* Request body metadata
|
|
2614
2903
|
*/
|
|
2615
|
-
requestBody?: Schema$
|
|
2904
|
+
requestBody?: Schema$AutomaticImprovements;
|
|
2616
2905
|
}
|
|
2617
2906
|
|
|
2618
|
-
export class Resource$Accounts$
|
|
2907
|
+
export class Resource$Accounts$Businessidentity {
|
|
2619
2908
|
context: APIRequestContext;
|
|
2620
2909
|
constructor(context: APIRequestContext) {
|
|
2621
2910
|
this.context = context;
|
|
2622
2911
|
}
|
|
2623
2912
|
|
|
2624
2913
|
/**
|
|
2625
|
-
* Retrieves the business
|
|
2914
|
+
* Retrieves the business identity of an account.
|
|
2626
2915
|
*
|
|
2627
2916
|
* @param params - Parameters for request
|
|
2628
2917
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2629
2918
|
* @param callback - Optional callback that handles the response.
|
|
2630
2919
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2631
2920
|
*/
|
|
2632
|
-
|
|
2633
|
-
params: Params$Resource$Accounts$
|
|
2921
|
+
getBusinessIdentity(
|
|
2922
|
+
params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity,
|
|
2634
2923
|
options: StreamMethodOptions
|
|
2635
2924
|
): GaxiosPromise<Readable>;
|
|
2636
|
-
|
|
2637
|
-
params?: Params$Resource$Accounts$
|
|
2925
|
+
getBusinessIdentity(
|
|
2926
|
+
params?: Params$Resource$Accounts$Businessidentity$Getbusinessidentity,
|
|
2638
2927
|
options?: MethodOptions
|
|
2639
|
-
): GaxiosPromise<Schema$
|
|
2640
|
-
|
|
2641
|
-
params: Params$Resource$Accounts$
|
|
2928
|
+
): GaxiosPromise<Schema$BusinessIdentity>;
|
|
2929
|
+
getBusinessIdentity(
|
|
2930
|
+
params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity,
|
|
2642
2931
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2643
2932
|
callback: BodyResponseCallback<Readable>
|
|
2644
2933
|
): void;
|
|
2645
|
-
|
|
2934
|
+
getBusinessIdentity(
|
|
2935
|
+
params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity,
|
|
2936
|
+
options: MethodOptions | BodyResponseCallback<Schema$BusinessIdentity>,
|
|
2937
|
+
callback: BodyResponseCallback<Schema$BusinessIdentity>
|
|
2938
|
+
): void;
|
|
2939
|
+
getBusinessIdentity(
|
|
2940
|
+
params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity,
|
|
2941
|
+
callback: BodyResponseCallback<Schema$BusinessIdentity>
|
|
2942
|
+
): void;
|
|
2943
|
+
getBusinessIdentity(
|
|
2944
|
+
callback: BodyResponseCallback<Schema$BusinessIdentity>
|
|
2945
|
+
): void;
|
|
2946
|
+
getBusinessIdentity(
|
|
2947
|
+
paramsOrCallback?:
|
|
2948
|
+
| Params$Resource$Accounts$Businessidentity$Getbusinessidentity
|
|
2949
|
+
| BodyResponseCallback<Schema$BusinessIdentity>
|
|
2950
|
+
| BodyResponseCallback<Readable>,
|
|
2951
|
+
optionsOrCallback?:
|
|
2952
|
+
| MethodOptions
|
|
2953
|
+
| StreamMethodOptions
|
|
2954
|
+
| BodyResponseCallback<Schema$BusinessIdentity>
|
|
2955
|
+
| BodyResponseCallback<Readable>,
|
|
2956
|
+
callback?:
|
|
2957
|
+
| BodyResponseCallback<Schema$BusinessIdentity>
|
|
2958
|
+
| BodyResponseCallback<Readable>
|
|
2959
|
+
): void | GaxiosPromise<Schema$BusinessIdentity> | GaxiosPromise<Readable> {
|
|
2960
|
+
let params = (paramsOrCallback ||
|
|
2961
|
+
{}) as Params$Resource$Accounts$Businessidentity$Getbusinessidentity;
|
|
2962
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2963
|
+
|
|
2964
|
+
if (typeof paramsOrCallback === 'function') {
|
|
2965
|
+
callback = paramsOrCallback;
|
|
2966
|
+
params =
|
|
2967
|
+
{} as Params$Resource$Accounts$Businessidentity$Getbusinessidentity;
|
|
2968
|
+
options = {};
|
|
2969
|
+
}
|
|
2970
|
+
|
|
2971
|
+
if (typeof optionsOrCallback === 'function') {
|
|
2972
|
+
callback = optionsOrCallback;
|
|
2973
|
+
options = {};
|
|
2974
|
+
}
|
|
2975
|
+
|
|
2976
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
2977
|
+
const parameters = {
|
|
2978
|
+
options: Object.assign(
|
|
2979
|
+
{
|
|
2980
|
+
url: (rootUrl + '/accounts/v1beta/{+name}').replace(
|
|
2981
|
+
/([^:]\/)\/+/g,
|
|
2982
|
+
'$1'
|
|
2983
|
+
),
|
|
2984
|
+
method: 'GET',
|
|
2985
|
+
apiVersion: '',
|
|
2986
|
+
},
|
|
2987
|
+
options
|
|
2988
|
+
),
|
|
2989
|
+
params,
|
|
2990
|
+
requiredParams: ['name'],
|
|
2991
|
+
pathParams: ['name'],
|
|
2992
|
+
context: this.context,
|
|
2993
|
+
};
|
|
2994
|
+
if (callback) {
|
|
2995
|
+
createAPIRequest<Schema$BusinessIdentity>(
|
|
2996
|
+
parameters,
|
|
2997
|
+
callback as BodyResponseCallback<unknown>
|
|
2998
|
+
);
|
|
2999
|
+
} else {
|
|
3000
|
+
return createAPIRequest<Schema$BusinessIdentity>(parameters);
|
|
3001
|
+
}
|
|
3002
|
+
}
|
|
3003
|
+
|
|
3004
|
+
/**
|
|
3005
|
+
* Updates the business identity of an account. Executing this method requires admin access.
|
|
3006
|
+
*
|
|
3007
|
+
* @param params - Parameters for request
|
|
3008
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3009
|
+
* @param callback - Optional callback that handles the response.
|
|
3010
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3011
|
+
*/
|
|
3012
|
+
updateBusinessIdentity(
|
|
3013
|
+
params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity,
|
|
3014
|
+
options: StreamMethodOptions
|
|
3015
|
+
): GaxiosPromise<Readable>;
|
|
3016
|
+
updateBusinessIdentity(
|
|
3017
|
+
params?: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity,
|
|
3018
|
+
options?: MethodOptions
|
|
3019
|
+
): GaxiosPromise<Schema$BusinessIdentity>;
|
|
3020
|
+
updateBusinessIdentity(
|
|
3021
|
+
params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity,
|
|
3022
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
3023
|
+
callback: BodyResponseCallback<Readable>
|
|
3024
|
+
): void;
|
|
3025
|
+
updateBusinessIdentity(
|
|
3026
|
+
params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity,
|
|
3027
|
+
options: MethodOptions | BodyResponseCallback<Schema$BusinessIdentity>,
|
|
3028
|
+
callback: BodyResponseCallback<Schema$BusinessIdentity>
|
|
3029
|
+
): void;
|
|
3030
|
+
updateBusinessIdentity(
|
|
3031
|
+
params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity,
|
|
3032
|
+
callback: BodyResponseCallback<Schema$BusinessIdentity>
|
|
3033
|
+
): void;
|
|
3034
|
+
updateBusinessIdentity(
|
|
3035
|
+
callback: BodyResponseCallback<Schema$BusinessIdentity>
|
|
3036
|
+
): void;
|
|
3037
|
+
updateBusinessIdentity(
|
|
3038
|
+
paramsOrCallback?:
|
|
3039
|
+
| Params$Resource$Accounts$Businessidentity$Updatebusinessidentity
|
|
3040
|
+
| BodyResponseCallback<Schema$BusinessIdentity>
|
|
3041
|
+
| BodyResponseCallback<Readable>,
|
|
3042
|
+
optionsOrCallback?:
|
|
3043
|
+
| MethodOptions
|
|
3044
|
+
| StreamMethodOptions
|
|
3045
|
+
| BodyResponseCallback<Schema$BusinessIdentity>
|
|
3046
|
+
| BodyResponseCallback<Readable>,
|
|
3047
|
+
callback?:
|
|
3048
|
+
| BodyResponseCallback<Schema$BusinessIdentity>
|
|
3049
|
+
| BodyResponseCallback<Readable>
|
|
3050
|
+
): void | GaxiosPromise<Schema$BusinessIdentity> | GaxiosPromise<Readable> {
|
|
3051
|
+
let params = (paramsOrCallback ||
|
|
3052
|
+
{}) as Params$Resource$Accounts$Businessidentity$Updatebusinessidentity;
|
|
3053
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
3054
|
+
|
|
3055
|
+
if (typeof paramsOrCallback === 'function') {
|
|
3056
|
+
callback = paramsOrCallback;
|
|
3057
|
+
params =
|
|
3058
|
+
{} as Params$Resource$Accounts$Businessidentity$Updatebusinessidentity;
|
|
3059
|
+
options = {};
|
|
3060
|
+
}
|
|
3061
|
+
|
|
3062
|
+
if (typeof optionsOrCallback === 'function') {
|
|
3063
|
+
callback = optionsOrCallback;
|
|
3064
|
+
options = {};
|
|
3065
|
+
}
|
|
3066
|
+
|
|
3067
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
3068
|
+
const parameters = {
|
|
3069
|
+
options: Object.assign(
|
|
3070
|
+
{
|
|
3071
|
+
url: (rootUrl + '/accounts/v1beta/{+name}').replace(
|
|
3072
|
+
/([^:]\/)\/+/g,
|
|
3073
|
+
'$1'
|
|
3074
|
+
),
|
|
3075
|
+
method: 'PATCH',
|
|
3076
|
+
apiVersion: '',
|
|
3077
|
+
},
|
|
3078
|
+
options
|
|
3079
|
+
),
|
|
3080
|
+
params,
|
|
3081
|
+
requiredParams: ['name'],
|
|
3082
|
+
pathParams: ['name'],
|
|
3083
|
+
context: this.context,
|
|
3084
|
+
};
|
|
3085
|
+
if (callback) {
|
|
3086
|
+
createAPIRequest<Schema$BusinessIdentity>(
|
|
3087
|
+
parameters,
|
|
3088
|
+
callback as BodyResponseCallback<unknown>
|
|
3089
|
+
);
|
|
3090
|
+
} else {
|
|
3091
|
+
return createAPIRequest<Schema$BusinessIdentity>(parameters);
|
|
3092
|
+
}
|
|
3093
|
+
}
|
|
3094
|
+
}
|
|
3095
|
+
|
|
3096
|
+
export interface Params$Resource$Accounts$Businessidentity$Getbusinessidentity
|
|
3097
|
+
extends StandardParameters {
|
|
3098
|
+
/**
|
|
3099
|
+
* Required. The resource name of the business identity. Format: `accounts/{account\}/businessIdentity`
|
|
3100
|
+
*/
|
|
3101
|
+
name?: string;
|
|
3102
|
+
}
|
|
3103
|
+
export interface Params$Resource$Accounts$Businessidentity$Updatebusinessidentity
|
|
3104
|
+
extends StandardParameters {
|
|
3105
|
+
/**
|
|
3106
|
+
* Identifier. The resource name of the business identity. Format: `accounts/{account\}/businessIdentity`
|
|
3107
|
+
*/
|
|
3108
|
+
name?: string;
|
|
3109
|
+
/**
|
|
3110
|
+
* Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `black_owned` - `latino_owned` - `promotions_consent` - `small_business` - `veteran_owned` - `women_owned`
|
|
3111
|
+
*/
|
|
3112
|
+
updateMask?: string;
|
|
3113
|
+
|
|
3114
|
+
/**
|
|
3115
|
+
* Request body metadata
|
|
3116
|
+
*/
|
|
3117
|
+
requestBody?: Schema$BusinessIdentity;
|
|
3118
|
+
}
|
|
3119
|
+
|
|
3120
|
+
export class Resource$Accounts$Businessinfo {
|
|
3121
|
+
context: APIRequestContext;
|
|
3122
|
+
constructor(context: APIRequestContext) {
|
|
3123
|
+
this.context = context;
|
|
3124
|
+
}
|
|
3125
|
+
|
|
3126
|
+
/**
|
|
3127
|
+
* Retrieves the business info of an account.
|
|
3128
|
+
*
|
|
3129
|
+
* @param params - Parameters for request
|
|
3130
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3131
|
+
* @param callback - Optional callback that handles the response.
|
|
3132
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3133
|
+
*/
|
|
3134
|
+
getBusinessInfo(
|
|
3135
|
+
params: Params$Resource$Accounts$Businessinfo$Getbusinessinfo,
|
|
3136
|
+
options: StreamMethodOptions
|
|
3137
|
+
): GaxiosPromise<Readable>;
|
|
3138
|
+
getBusinessInfo(
|
|
3139
|
+
params?: Params$Resource$Accounts$Businessinfo$Getbusinessinfo,
|
|
3140
|
+
options?: MethodOptions
|
|
3141
|
+
): GaxiosPromise<Schema$BusinessInfo>;
|
|
3142
|
+
getBusinessInfo(
|
|
3143
|
+
params: Params$Resource$Accounts$Businessinfo$Getbusinessinfo,
|
|
3144
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
3145
|
+
callback: BodyResponseCallback<Readable>
|
|
3146
|
+
): void;
|
|
3147
|
+
getBusinessInfo(
|
|
2646
3148
|
params: Params$Resource$Accounts$Businessinfo$Getbusinessinfo,
|
|
2647
3149
|
options: MethodOptions | BodyResponseCallback<Schema$BusinessInfo>,
|
|
2648
3150
|
callback: BodyResponseCallback<Schema$BusinessInfo>
|
|
@@ -3451,7 +3953,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
3451
3953
|
}
|
|
3452
3954
|
|
|
3453
3955
|
/**
|
|
3454
|
-
* Lists all account issues of a Merchant Center account.
|
|
3956
|
+
* Lists all account issues of a Merchant Center account. When called on a multi-client account, this method only returns issues belonging to that account, not its sub-accounts. To retrieve issues for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call `accounts.issues.list` for each sub-account individually.
|
|
3455
3957
|
*
|
|
3456
3958
|
* @param params - Parameters for request
|
|
3457
3959
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3553,7 +4055,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
3553
4055
|
*/
|
|
3554
4056
|
languageCode?: string;
|
|
3555
4057
|
/**
|
|
3556
|
-
* Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50
|
|
4058
|
+
* Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50 issues will be returned. The maximum value is 100; values above 100 will be coerced to 100
|
|
3557
4059
|
*/
|
|
3558
4060
|
pageSize?: number;
|
|
3559
4061
|
/**
|
|
@@ -4710,67 +5212,67 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
4710
5212
|
requestBody?: Schema$Region;
|
|
4711
5213
|
}
|
|
4712
5214
|
|
|
4713
|
-
export class Resource$Accounts$
|
|
5215
|
+
export class Resource$Accounts$Relationships {
|
|
4714
5216
|
context: APIRequestContext;
|
|
4715
5217
|
constructor(context: APIRequestContext) {
|
|
4716
5218
|
this.context = context;
|
|
4717
5219
|
}
|
|
4718
5220
|
|
|
4719
5221
|
/**
|
|
4720
|
-
* Retrieve
|
|
5222
|
+
* Retrieve an account relationship.
|
|
4721
5223
|
*
|
|
4722
5224
|
* @param params - Parameters for request
|
|
4723
5225
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4724
5226
|
* @param callback - Optional callback that handles the response.
|
|
4725
5227
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4726
5228
|
*/
|
|
4727
|
-
|
|
4728
|
-
params: Params$Resource$Accounts$
|
|
5229
|
+
get(
|
|
5230
|
+
params: Params$Resource$Accounts$Relationships$Get,
|
|
4729
5231
|
options: StreamMethodOptions
|
|
4730
5232
|
): GaxiosPromise<Readable>;
|
|
4731
|
-
|
|
4732
|
-
params?: Params$Resource$Accounts$
|
|
5233
|
+
get(
|
|
5234
|
+
params?: Params$Resource$Accounts$Relationships$Get,
|
|
4733
5235
|
options?: MethodOptions
|
|
4734
|
-
): GaxiosPromise<Schema$
|
|
4735
|
-
|
|
4736
|
-
params: Params$Resource$Accounts$
|
|
5236
|
+
): GaxiosPromise<Schema$AccountRelationship>;
|
|
5237
|
+
get(
|
|
5238
|
+
params: Params$Resource$Accounts$Relationships$Get,
|
|
4737
5239
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
4738
5240
|
callback: BodyResponseCallback<Readable>
|
|
4739
5241
|
): void;
|
|
4740
|
-
|
|
4741
|
-
params: Params$Resource$Accounts$
|
|
4742
|
-
options: MethodOptions | BodyResponseCallback<Schema$
|
|
4743
|
-
callback: BodyResponseCallback<Schema$
|
|
4744
|
-
): void;
|
|
4745
|
-
getShippingSettings(
|
|
4746
|
-
params: Params$Resource$Accounts$Shippingsettings$Getshippingsettings,
|
|
4747
|
-
callback: BodyResponseCallback<Schema$ShippingSettings>
|
|
5242
|
+
get(
|
|
5243
|
+
params: Params$Resource$Accounts$Relationships$Get,
|
|
5244
|
+
options: MethodOptions | BodyResponseCallback<Schema$AccountRelationship>,
|
|
5245
|
+
callback: BodyResponseCallback<Schema$AccountRelationship>
|
|
4748
5246
|
): void;
|
|
4749
|
-
|
|
4750
|
-
|
|
5247
|
+
get(
|
|
5248
|
+
params: Params$Resource$Accounts$Relationships$Get,
|
|
5249
|
+
callback: BodyResponseCallback<Schema$AccountRelationship>
|
|
4751
5250
|
): void;
|
|
4752
|
-
|
|
5251
|
+
get(callback: BodyResponseCallback<Schema$AccountRelationship>): void;
|
|
5252
|
+
get(
|
|
4753
5253
|
paramsOrCallback?:
|
|
4754
|
-
| Params$Resource$Accounts$
|
|
4755
|
-
| BodyResponseCallback<Schema$
|
|
5254
|
+
| Params$Resource$Accounts$Relationships$Get
|
|
5255
|
+
| BodyResponseCallback<Schema$AccountRelationship>
|
|
4756
5256
|
| BodyResponseCallback<Readable>,
|
|
4757
5257
|
optionsOrCallback?:
|
|
4758
5258
|
| MethodOptions
|
|
4759
5259
|
| StreamMethodOptions
|
|
4760
|
-
| BodyResponseCallback<Schema$
|
|
5260
|
+
| BodyResponseCallback<Schema$AccountRelationship>
|
|
4761
5261
|
| BodyResponseCallback<Readable>,
|
|
4762
5262
|
callback?:
|
|
4763
|
-
| BodyResponseCallback<Schema$
|
|
5263
|
+
| BodyResponseCallback<Schema$AccountRelationship>
|
|
4764
5264
|
| BodyResponseCallback<Readable>
|
|
4765
|
-
):
|
|
5265
|
+
):
|
|
5266
|
+
| void
|
|
5267
|
+
| GaxiosPromise<Schema$AccountRelationship>
|
|
5268
|
+
| GaxiosPromise<Readable> {
|
|
4766
5269
|
let params = (paramsOrCallback ||
|
|
4767
|
-
{}) as Params$Resource$Accounts$
|
|
5270
|
+
{}) as Params$Resource$Accounts$Relationships$Get;
|
|
4768
5271
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
4769
5272
|
|
|
4770
5273
|
if (typeof paramsOrCallback === 'function') {
|
|
4771
5274
|
callback = paramsOrCallback;
|
|
4772
|
-
params =
|
|
4773
|
-
{} as Params$Resource$Accounts$Shippingsettings$Getshippingsettings;
|
|
5275
|
+
params = {} as Params$Resource$Accounts$Relationships$Get;
|
|
4774
5276
|
options = {};
|
|
4775
5277
|
}
|
|
4776
5278
|
|
|
@@ -4798,25 +5300,862 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
4798
5300
|
context: this.context,
|
|
4799
5301
|
};
|
|
4800
5302
|
if (callback) {
|
|
4801
|
-
createAPIRequest<Schema$
|
|
5303
|
+
createAPIRequest<Schema$AccountRelationship>(
|
|
4802
5304
|
parameters,
|
|
4803
5305
|
callback as BodyResponseCallback<unknown>
|
|
4804
5306
|
);
|
|
4805
5307
|
} else {
|
|
4806
|
-
return createAPIRequest<Schema$
|
|
5308
|
+
return createAPIRequest<Schema$AccountRelationship>(parameters);
|
|
4807
5309
|
}
|
|
4808
5310
|
}
|
|
4809
5311
|
|
|
4810
5312
|
/**
|
|
4811
|
-
*
|
|
5313
|
+
* List account relationships for the specified account.
|
|
4812
5314
|
*
|
|
4813
5315
|
* @param params - Parameters for request
|
|
4814
5316
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4815
5317
|
* @param callback - Optional callback that handles the response.
|
|
4816
5318
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4817
5319
|
*/
|
|
4818
|
-
|
|
4819
|
-
params: Params$Resource$Accounts$
|
|
5320
|
+
list(
|
|
5321
|
+
params: Params$Resource$Accounts$Relationships$List,
|
|
5322
|
+
options: StreamMethodOptions
|
|
5323
|
+
): GaxiosPromise<Readable>;
|
|
5324
|
+
list(
|
|
5325
|
+
params?: Params$Resource$Accounts$Relationships$List,
|
|
5326
|
+
options?: MethodOptions
|
|
5327
|
+
): GaxiosPromise<Schema$ListAccountRelationshipsResponse>;
|
|
5328
|
+
list(
|
|
5329
|
+
params: Params$Resource$Accounts$Relationships$List,
|
|
5330
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5331
|
+
callback: BodyResponseCallback<Readable>
|
|
5332
|
+
): void;
|
|
5333
|
+
list(
|
|
5334
|
+
params: Params$Resource$Accounts$Relationships$List,
|
|
5335
|
+
options:
|
|
5336
|
+
| MethodOptions
|
|
5337
|
+
| BodyResponseCallback<Schema$ListAccountRelationshipsResponse>,
|
|
5338
|
+
callback: BodyResponseCallback<Schema$ListAccountRelationshipsResponse>
|
|
5339
|
+
): void;
|
|
5340
|
+
list(
|
|
5341
|
+
params: Params$Resource$Accounts$Relationships$List,
|
|
5342
|
+
callback: BodyResponseCallback<Schema$ListAccountRelationshipsResponse>
|
|
5343
|
+
): void;
|
|
5344
|
+
list(
|
|
5345
|
+
callback: BodyResponseCallback<Schema$ListAccountRelationshipsResponse>
|
|
5346
|
+
): void;
|
|
5347
|
+
list(
|
|
5348
|
+
paramsOrCallback?:
|
|
5349
|
+
| Params$Resource$Accounts$Relationships$List
|
|
5350
|
+
| BodyResponseCallback<Schema$ListAccountRelationshipsResponse>
|
|
5351
|
+
| BodyResponseCallback<Readable>,
|
|
5352
|
+
optionsOrCallback?:
|
|
5353
|
+
| MethodOptions
|
|
5354
|
+
| StreamMethodOptions
|
|
5355
|
+
| BodyResponseCallback<Schema$ListAccountRelationshipsResponse>
|
|
5356
|
+
| BodyResponseCallback<Readable>,
|
|
5357
|
+
callback?:
|
|
5358
|
+
| BodyResponseCallback<Schema$ListAccountRelationshipsResponse>
|
|
5359
|
+
| BodyResponseCallback<Readable>
|
|
5360
|
+
):
|
|
5361
|
+
| void
|
|
5362
|
+
| GaxiosPromise<Schema$ListAccountRelationshipsResponse>
|
|
5363
|
+
| GaxiosPromise<Readable> {
|
|
5364
|
+
let params = (paramsOrCallback ||
|
|
5365
|
+
{}) as Params$Resource$Accounts$Relationships$List;
|
|
5366
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5367
|
+
|
|
5368
|
+
if (typeof paramsOrCallback === 'function') {
|
|
5369
|
+
callback = paramsOrCallback;
|
|
5370
|
+
params = {} as Params$Resource$Accounts$Relationships$List;
|
|
5371
|
+
options = {};
|
|
5372
|
+
}
|
|
5373
|
+
|
|
5374
|
+
if (typeof optionsOrCallback === 'function') {
|
|
5375
|
+
callback = optionsOrCallback;
|
|
5376
|
+
options = {};
|
|
5377
|
+
}
|
|
5378
|
+
|
|
5379
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
5380
|
+
const parameters = {
|
|
5381
|
+
options: Object.assign(
|
|
5382
|
+
{
|
|
5383
|
+
url: (rootUrl + '/accounts/v1beta/{+parent}/relationships').replace(
|
|
5384
|
+
/([^:]\/)\/+/g,
|
|
5385
|
+
'$1'
|
|
5386
|
+
),
|
|
5387
|
+
method: 'GET',
|
|
5388
|
+
apiVersion: '',
|
|
5389
|
+
},
|
|
5390
|
+
options
|
|
5391
|
+
),
|
|
5392
|
+
params,
|
|
5393
|
+
requiredParams: ['parent'],
|
|
5394
|
+
pathParams: ['parent'],
|
|
5395
|
+
context: this.context,
|
|
5396
|
+
};
|
|
5397
|
+
if (callback) {
|
|
5398
|
+
createAPIRequest<Schema$ListAccountRelationshipsResponse>(
|
|
5399
|
+
parameters,
|
|
5400
|
+
callback as BodyResponseCallback<unknown>
|
|
5401
|
+
);
|
|
5402
|
+
} else {
|
|
5403
|
+
return createAPIRequest<Schema$ListAccountRelationshipsResponse>(
|
|
5404
|
+
parameters
|
|
5405
|
+
);
|
|
5406
|
+
}
|
|
5407
|
+
}
|
|
5408
|
+
|
|
5409
|
+
/**
|
|
5410
|
+
* Updates the account relationship. Executing this method requires admin access.
|
|
5411
|
+
*
|
|
5412
|
+
* @param params - Parameters for request
|
|
5413
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5414
|
+
* @param callback - Optional callback that handles the response.
|
|
5415
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5416
|
+
*/
|
|
5417
|
+
patch(
|
|
5418
|
+
params: Params$Resource$Accounts$Relationships$Patch,
|
|
5419
|
+
options: StreamMethodOptions
|
|
5420
|
+
): GaxiosPromise<Readable>;
|
|
5421
|
+
patch(
|
|
5422
|
+
params?: Params$Resource$Accounts$Relationships$Patch,
|
|
5423
|
+
options?: MethodOptions
|
|
5424
|
+
): GaxiosPromise<Schema$AccountRelationship>;
|
|
5425
|
+
patch(
|
|
5426
|
+
params: Params$Resource$Accounts$Relationships$Patch,
|
|
5427
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5428
|
+
callback: BodyResponseCallback<Readable>
|
|
5429
|
+
): void;
|
|
5430
|
+
patch(
|
|
5431
|
+
params: Params$Resource$Accounts$Relationships$Patch,
|
|
5432
|
+
options: MethodOptions | BodyResponseCallback<Schema$AccountRelationship>,
|
|
5433
|
+
callback: BodyResponseCallback<Schema$AccountRelationship>
|
|
5434
|
+
): void;
|
|
5435
|
+
patch(
|
|
5436
|
+
params: Params$Resource$Accounts$Relationships$Patch,
|
|
5437
|
+
callback: BodyResponseCallback<Schema$AccountRelationship>
|
|
5438
|
+
): void;
|
|
5439
|
+
patch(callback: BodyResponseCallback<Schema$AccountRelationship>): void;
|
|
5440
|
+
patch(
|
|
5441
|
+
paramsOrCallback?:
|
|
5442
|
+
| Params$Resource$Accounts$Relationships$Patch
|
|
5443
|
+
| BodyResponseCallback<Schema$AccountRelationship>
|
|
5444
|
+
| BodyResponseCallback<Readable>,
|
|
5445
|
+
optionsOrCallback?:
|
|
5446
|
+
| MethodOptions
|
|
5447
|
+
| StreamMethodOptions
|
|
5448
|
+
| BodyResponseCallback<Schema$AccountRelationship>
|
|
5449
|
+
| BodyResponseCallback<Readable>,
|
|
5450
|
+
callback?:
|
|
5451
|
+
| BodyResponseCallback<Schema$AccountRelationship>
|
|
5452
|
+
| BodyResponseCallback<Readable>
|
|
5453
|
+
):
|
|
5454
|
+
| void
|
|
5455
|
+
| GaxiosPromise<Schema$AccountRelationship>
|
|
5456
|
+
| GaxiosPromise<Readable> {
|
|
5457
|
+
let params = (paramsOrCallback ||
|
|
5458
|
+
{}) as Params$Resource$Accounts$Relationships$Patch;
|
|
5459
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5460
|
+
|
|
5461
|
+
if (typeof paramsOrCallback === 'function') {
|
|
5462
|
+
callback = paramsOrCallback;
|
|
5463
|
+
params = {} as Params$Resource$Accounts$Relationships$Patch;
|
|
5464
|
+
options = {};
|
|
5465
|
+
}
|
|
5466
|
+
|
|
5467
|
+
if (typeof optionsOrCallback === 'function') {
|
|
5468
|
+
callback = optionsOrCallback;
|
|
5469
|
+
options = {};
|
|
5470
|
+
}
|
|
5471
|
+
|
|
5472
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
5473
|
+
const parameters = {
|
|
5474
|
+
options: Object.assign(
|
|
5475
|
+
{
|
|
5476
|
+
url: (rootUrl + '/accounts/v1beta/{+name}').replace(
|
|
5477
|
+
/([^:]\/)\/+/g,
|
|
5478
|
+
'$1'
|
|
5479
|
+
),
|
|
5480
|
+
method: 'PATCH',
|
|
5481
|
+
apiVersion: '',
|
|
5482
|
+
},
|
|
5483
|
+
options
|
|
5484
|
+
),
|
|
5485
|
+
params,
|
|
5486
|
+
requiredParams: ['name'],
|
|
5487
|
+
pathParams: ['name'],
|
|
5488
|
+
context: this.context,
|
|
5489
|
+
};
|
|
5490
|
+
if (callback) {
|
|
5491
|
+
createAPIRequest<Schema$AccountRelationship>(
|
|
5492
|
+
parameters,
|
|
5493
|
+
callback as BodyResponseCallback<unknown>
|
|
5494
|
+
);
|
|
5495
|
+
} else {
|
|
5496
|
+
return createAPIRequest<Schema$AccountRelationship>(parameters);
|
|
5497
|
+
}
|
|
5498
|
+
}
|
|
5499
|
+
}
|
|
5500
|
+
|
|
5501
|
+
export interface Params$Resource$Accounts$Relationships$Get
|
|
5502
|
+
extends StandardParameters {
|
|
5503
|
+
/**
|
|
5504
|
+
* Required. The resource name of the account relationship to get.
|
|
5505
|
+
*/
|
|
5506
|
+
name?: string;
|
|
5507
|
+
}
|
|
5508
|
+
export interface Params$Resource$Accounts$Relationships$List
|
|
5509
|
+
extends StandardParameters {
|
|
5510
|
+
/**
|
|
5511
|
+
* Optional. The maximum number of elements to return in the response. Use for paging. If no `page_size` is specified, `100` is used as the default value. The maximum allowed value is `1000`.
|
|
5512
|
+
*/
|
|
5513
|
+
pageSize?: number;
|
|
5514
|
+
/**
|
|
5515
|
+
* Optional. The token returned by the previous `list` request.
|
|
5516
|
+
*/
|
|
5517
|
+
pageToken?: string;
|
|
5518
|
+
/**
|
|
5519
|
+
* Required. The parent account of the account relationship to filter by.
|
|
5520
|
+
*/
|
|
5521
|
+
parent?: string;
|
|
5522
|
+
}
|
|
5523
|
+
export interface Params$Resource$Accounts$Relationships$Patch
|
|
5524
|
+
extends StandardParameters {
|
|
5525
|
+
/**
|
|
5526
|
+
* Identifier. The resource name of the account relationship.
|
|
5527
|
+
*/
|
|
5528
|
+
name?: string;
|
|
5529
|
+
/**
|
|
5530
|
+
* Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `account_id_alias`
|
|
5531
|
+
*/
|
|
5532
|
+
updateMask?: string;
|
|
5533
|
+
|
|
5534
|
+
/**
|
|
5535
|
+
* Request body metadata
|
|
5536
|
+
*/
|
|
5537
|
+
requestBody?: Schema$AccountRelationship;
|
|
5538
|
+
}
|
|
5539
|
+
|
|
5540
|
+
export class Resource$Accounts$Services {
|
|
5541
|
+
context: APIRequestContext;
|
|
5542
|
+
constructor(context: APIRequestContext) {
|
|
5543
|
+
this.context = context;
|
|
5544
|
+
}
|
|
5545
|
+
|
|
5546
|
+
/**
|
|
5547
|
+
* Approve an account service proposal.
|
|
5548
|
+
*
|
|
5549
|
+
* @param params - Parameters for request
|
|
5550
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5551
|
+
* @param callback - Optional callback that handles the response.
|
|
5552
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5553
|
+
*/
|
|
5554
|
+
approve(
|
|
5555
|
+
params: Params$Resource$Accounts$Services$Approve,
|
|
5556
|
+
options: StreamMethodOptions
|
|
5557
|
+
): GaxiosPromise<Readable>;
|
|
5558
|
+
approve(
|
|
5559
|
+
params?: Params$Resource$Accounts$Services$Approve,
|
|
5560
|
+
options?: MethodOptions
|
|
5561
|
+
): GaxiosPromise<Schema$AccountService>;
|
|
5562
|
+
approve(
|
|
5563
|
+
params: Params$Resource$Accounts$Services$Approve,
|
|
5564
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5565
|
+
callback: BodyResponseCallback<Readable>
|
|
5566
|
+
): void;
|
|
5567
|
+
approve(
|
|
5568
|
+
params: Params$Resource$Accounts$Services$Approve,
|
|
5569
|
+
options: MethodOptions | BodyResponseCallback<Schema$AccountService>,
|
|
5570
|
+
callback: BodyResponseCallback<Schema$AccountService>
|
|
5571
|
+
): void;
|
|
5572
|
+
approve(
|
|
5573
|
+
params: Params$Resource$Accounts$Services$Approve,
|
|
5574
|
+
callback: BodyResponseCallback<Schema$AccountService>
|
|
5575
|
+
): void;
|
|
5576
|
+
approve(callback: BodyResponseCallback<Schema$AccountService>): void;
|
|
5577
|
+
approve(
|
|
5578
|
+
paramsOrCallback?:
|
|
5579
|
+
| Params$Resource$Accounts$Services$Approve
|
|
5580
|
+
| BodyResponseCallback<Schema$AccountService>
|
|
5581
|
+
| BodyResponseCallback<Readable>,
|
|
5582
|
+
optionsOrCallback?:
|
|
5583
|
+
| MethodOptions
|
|
5584
|
+
| StreamMethodOptions
|
|
5585
|
+
| BodyResponseCallback<Schema$AccountService>
|
|
5586
|
+
| BodyResponseCallback<Readable>,
|
|
5587
|
+
callback?:
|
|
5588
|
+
| BodyResponseCallback<Schema$AccountService>
|
|
5589
|
+
| BodyResponseCallback<Readable>
|
|
5590
|
+
): void | GaxiosPromise<Schema$AccountService> | GaxiosPromise<Readable> {
|
|
5591
|
+
let params = (paramsOrCallback ||
|
|
5592
|
+
{}) as Params$Resource$Accounts$Services$Approve;
|
|
5593
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5594
|
+
|
|
5595
|
+
if (typeof paramsOrCallback === 'function') {
|
|
5596
|
+
callback = paramsOrCallback;
|
|
5597
|
+
params = {} as Params$Resource$Accounts$Services$Approve;
|
|
5598
|
+
options = {};
|
|
5599
|
+
}
|
|
5600
|
+
|
|
5601
|
+
if (typeof optionsOrCallback === 'function') {
|
|
5602
|
+
callback = optionsOrCallback;
|
|
5603
|
+
options = {};
|
|
5604
|
+
}
|
|
5605
|
+
|
|
5606
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
5607
|
+
const parameters = {
|
|
5608
|
+
options: Object.assign(
|
|
5609
|
+
{
|
|
5610
|
+
url: (rootUrl + '/accounts/v1beta/{+name}:approve').replace(
|
|
5611
|
+
/([^:]\/)\/+/g,
|
|
5612
|
+
'$1'
|
|
5613
|
+
),
|
|
5614
|
+
method: 'POST',
|
|
5615
|
+
apiVersion: '',
|
|
5616
|
+
},
|
|
5617
|
+
options
|
|
5618
|
+
),
|
|
5619
|
+
params,
|
|
5620
|
+
requiredParams: ['name'],
|
|
5621
|
+
pathParams: ['name'],
|
|
5622
|
+
context: this.context,
|
|
5623
|
+
};
|
|
5624
|
+
if (callback) {
|
|
5625
|
+
createAPIRequest<Schema$AccountService>(
|
|
5626
|
+
parameters,
|
|
5627
|
+
callback as BodyResponseCallback<unknown>
|
|
5628
|
+
);
|
|
5629
|
+
} else {
|
|
5630
|
+
return createAPIRequest<Schema$AccountService>(parameters);
|
|
5631
|
+
}
|
|
5632
|
+
}
|
|
5633
|
+
|
|
5634
|
+
/**
|
|
5635
|
+
* Retrieve an account service.
|
|
5636
|
+
*
|
|
5637
|
+
* @param params - Parameters for request
|
|
5638
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5639
|
+
* @param callback - Optional callback that handles the response.
|
|
5640
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5641
|
+
*/
|
|
5642
|
+
get(
|
|
5643
|
+
params: Params$Resource$Accounts$Services$Get,
|
|
5644
|
+
options: StreamMethodOptions
|
|
5645
|
+
): GaxiosPromise<Readable>;
|
|
5646
|
+
get(
|
|
5647
|
+
params?: Params$Resource$Accounts$Services$Get,
|
|
5648
|
+
options?: MethodOptions
|
|
5649
|
+
): GaxiosPromise<Schema$AccountService>;
|
|
5650
|
+
get(
|
|
5651
|
+
params: Params$Resource$Accounts$Services$Get,
|
|
5652
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5653
|
+
callback: BodyResponseCallback<Readable>
|
|
5654
|
+
): void;
|
|
5655
|
+
get(
|
|
5656
|
+
params: Params$Resource$Accounts$Services$Get,
|
|
5657
|
+
options: MethodOptions | BodyResponseCallback<Schema$AccountService>,
|
|
5658
|
+
callback: BodyResponseCallback<Schema$AccountService>
|
|
5659
|
+
): void;
|
|
5660
|
+
get(
|
|
5661
|
+
params: Params$Resource$Accounts$Services$Get,
|
|
5662
|
+
callback: BodyResponseCallback<Schema$AccountService>
|
|
5663
|
+
): void;
|
|
5664
|
+
get(callback: BodyResponseCallback<Schema$AccountService>): void;
|
|
5665
|
+
get(
|
|
5666
|
+
paramsOrCallback?:
|
|
5667
|
+
| Params$Resource$Accounts$Services$Get
|
|
5668
|
+
| BodyResponseCallback<Schema$AccountService>
|
|
5669
|
+
| BodyResponseCallback<Readable>,
|
|
5670
|
+
optionsOrCallback?:
|
|
5671
|
+
| MethodOptions
|
|
5672
|
+
| StreamMethodOptions
|
|
5673
|
+
| BodyResponseCallback<Schema$AccountService>
|
|
5674
|
+
| BodyResponseCallback<Readable>,
|
|
5675
|
+
callback?:
|
|
5676
|
+
| BodyResponseCallback<Schema$AccountService>
|
|
5677
|
+
| BodyResponseCallback<Readable>
|
|
5678
|
+
): void | GaxiosPromise<Schema$AccountService> | GaxiosPromise<Readable> {
|
|
5679
|
+
let params = (paramsOrCallback ||
|
|
5680
|
+
{}) as Params$Resource$Accounts$Services$Get;
|
|
5681
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5682
|
+
|
|
5683
|
+
if (typeof paramsOrCallback === 'function') {
|
|
5684
|
+
callback = paramsOrCallback;
|
|
5685
|
+
params = {} as Params$Resource$Accounts$Services$Get;
|
|
5686
|
+
options = {};
|
|
5687
|
+
}
|
|
5688
|
+
|
|
5689
|
+
if (typeof optionsOrCallback === 'function') {
|
|
5690
|
+
callback = optionsOrCallback;
|
|
5691
|
+
options = {};
|
|
5692
|
+
}
|
|
5693
|
+
|
|
5694
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
5695
|
+
const parameters = {
|
|
5696
|
+
options: Object.assign(
|
|
5697
|
+
{
|
|
5698
|
+
url: (rootUrl + '/accounts/v1beta/{+name}').replace(
|
|
5699
|
+
/([^:]\/)\/+/g,
|
|
5700
|
+
'$1'
|
|
5701
|
+
),
|
|
5702
|
+
method: 'GET',
|
|
5703
|
+
apiVersion: '',
|
|
5704
|
+
},
|
|
5705
|
+
options
|
|
5706
|
+
),
|
|
5707
|
+
params,
|
|
5708
|
+
requiredParams: ['name'],
|
|
5709
|
+
pathParams: ['name'],
|
|
5710
|
+
context: this.context,
|
|
5711
|
+
};
|
|
5712
|
+
if (callback) {
|
|
5713
|
+
createAPIRequest<Schema$AccountService>(
|
|
5714
|
+
parameters,
|
|
5715
|
+
callback as BodyResponseCallback<unknown>
|
|
5716
|
+
);
|
|
5717
|
+
} else {
|
|
5718
|
+
return createAPIRequest<Schema$AccountService>(parameters);
|
|
5719
|
+
}
|
|
5720
|
+
}
|
|
5721
|
+
|
|
5722
|
+
/**
|
|
5723
|
+
* List account services for the specified accounts. Supports filtering.
|
|
5724
|
+
*
|
|
5725
|
+
* @param params - Parameters for request
|
|
5726
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5727
|
+
* @param callback - Optional callback that handles the response.
|
|
5728
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5729
|
+
*/
|
|
5730
|
+
list(
|
|
5731
|
+
params: Params$Resource$Accounts$Services$List,
|
|
5732
|
+
options: StreamMethodOptions
|
|
5733
|
+
): GaxiosPromise<Readable>;
|
|
5734
|
+
list(
|
|
5735
|
+
params?: Params$Resource$Accounts$Services$List,
|
|
5736
|
+
options?: MethodOptions
|
|
5737
|
+
): GaxiosPromise<Schema$ListAccountServicesResponse>;
|
|
5738
|
+
list(
|
|
5739
|
+
params: Params$Resource$Accounts$Services$List,
|
|
5740
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5741
|
+
callback: BodyResponseCallback<Readable>
|
|
5742
|
+
): void;
|
|
5743
|
+
list(
|
|
5744
|
+
params: Params$Resource$Accounts$Services$List,
|
|
5745
|
+
options:
|
|
5746
|
+
| MethodOptions
|
|
5747
|
+
| BodyResponseCallback<Schema$ListAccountServicesResponse>,
|
|
5748
|
+
callback: BodyResponseCallback<Schema$ListAccountServicesResponse>
|
|
5749
|
+
): void;
|
|
5750
|
+
list(
|
|
5751
|
+
params: Params$Resource$Accounts$Services$List,
|
|
5752
|
+
callback: BodyResponseCallback<Schema$ListAccountServicesResponse>
|
|
5753
|
+
): void;
|
|
5754
|
+
list(
|
|
5755
|
+
callback: BodyResponseCallback<Schema$ListAccountServicesResponse>
|
|
5756
|
+
): void;
|
|
5757
|
+
list(
|
|
5758
|
+
paramsOrCallback?:
|
|
5759
|
+
| Params$Resource$Accounts$Services$List
|
|
5760
|
+
| BodyResponseCallback<Schema$ListAccountServicesResponse>
|
|
5761
|
+
| BodyResponseCallback<Readable>,
|
|
5762
|
+
optionsOrCallback?:
|
|
5763
|
+
| MethodOptions
|
|
5764
|
+
| StreamMethodOptions
|
|
5765
|
+
| BodyResponseCallback<Schema$ListAccountServicesResponse>
|
|
5766
|
+
| BodyResponseCallback<Readable>,
|
|
5767
|
+
callback?:
|
|
5768
|
+
| BodyResponseCallback<Schema$ListAccountServicesResponse>
|
|
5769
|
+
| BodyResponseCallback<Readable>
|
|
5770
|
+
):
|
|
5771
|
+
| void
|
|
5772
|
+
| GaxiosPromise<Schema$ListAccountServicesResponse>
|
|
5773
|
+
| GaxiosPromise<Readable> {
|
|
5774
|
+
let params = (paramsOrCallback ||
|
|
5775
|
+
{}) as Params$Resource$Accounts$Services$List;
|
|
5776
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5777
|
+
|
|
5778
|
+
if (typeof paramsOrCallback === 'function') {
|
|
5779
|
+
callback = paramsOrCallback;
|
|
5780
|
+
params = {} as Params$Resource$Accounts$Services$List;
|
|
5781
|
+
options = {};
|
|
5782
|
+
}
|
|
5783
|
+
|
|
5784
|
+
if (typeof optionsOrCallback === 'function') {
|
|
5785
|
+
callback = optionsOrCallback;
|
|
5786
|
+
options = {};
|
|
5787
|
+
}
|
|
5788
|
+
|
|
5789
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
5790
|
+
const parameters = {
|
|
5791
|
+
options: Object.assign(
|
|
5792
|
+
{
|
|
5793
|
+
url: (rootUrl + '/accounts/v1beta/{+parent}/services').replace(
|
|
5794
|
+
/([^:]\/)\/+/g,
|
|
5795
|
+
'$1'
|
|
5796
|
+
),
|
|
5797
|
+
method: 'GET',
|
|
5798
|
+
apiVersion: '',
|
|
5799
|
+
},
|
|
5800
|
+
options
|
|
5801
|
+
),
|
|
5802
|
+
params,
|
|
5803
|
+
requiredParams: ['parent'],
|
|
5804
|
+
pathParams: ['parent'],
|
|
5805
|
+
context: this.context,
|
|
5806
|
+
};
|
|
5807
|
+
if (callback) {
|
|
5808
|
+
createAPIRequest<Schema$ListAccountServicesResponse>(
|
|
5809
|
+
parameters,
|
|
5810
|
+
callback as BodyResponseCallback<unknown>
|
|
5811
|
+
);
|
|
5812
|
+
} else {
|
|
5813
|
+
return createAPIRequest<Schema$ListAccountServicesResponse>(parameters);
|
|
5814
|
+
}
|
|
5815
|
+
}
|
|
5816
|
+
|
|
5817
|
+
/**
|
|
5818
|
+
* Propose an account service.
|
|
5819
|
+
*
|
|
5820
|
+
* @param params - Parameters for request
|
|
5821
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5822
|
+
* @param callback - Optional callback that handles the response.
|
|
5823
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5824
|
+
*/
|
|
5825
|
+
propose(
|
|
5826
|
+
params: Params$Resource$Accounts$Services$Propose,
|
|
5827
|
+
options: StreamMethodOptions
|
|
5828
|
+
): GaxiosPromise<Readable>;
|
|
5829
|
+
propose(
|
|
5830
|
+
params?: Params$Resource$Accounts$Services$Propose,
|
|
5831
|
+
options?: MethodOptions
|
|
5832
|
+
): GaxiosPromise<Schema$AccountService>;
|
|
5833
|
+
propose(
|
|
5834
|
+
params: Params$Resource$Accounts$Services$Propose,
|
|
5835
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5836
|
+
callback: BodyResponseCallback<Readable>
|
|
5837
|
+
): void;
|
|
5838
|
+
propose(
|
|
5839
|
+
params: Params$Resource$Accounts$Services$Propose,
|
|
5840
|
+
options: MethodOptions | BodyResponseCallback<Schema$AccountService>,
|
|
5841
|
+
callback: BodyResponseCallback<Schema$AccountService>
|
|
5842
|
+
): void;
|
|
5843
|
+
propose(
|
|
5844
|
+
params: Params$Resource$Accounts$Services$Propose,
|
|
5845
|
+
callback: BodyResponseCallback<Schema$AccountService>
|
|
5846
|
+
): void;
|
|
5847
|
+
propose(callback: BodyResponseCallback<Schema$AccountService>): void;
|
|
5848
|
+
propose(
|
|
5849
|
+
paramsOrCallback?:
|
|
5850
|
+
| Params$Resource$Accounts$Services$Propose
|
|
5851
|
+
| BodyResponseCallback<Schema$AccountService>
|
|
5852
|
+
| BodyResponseCallback<Readable>,
|
|
5853
|
+
optionsOrCallback?:
|
|
5854
|
+
| MethodOptions
|
|
5855
|
+
| StreamMethodOptions
|
|
5856
|
+
| BodyResponseCallback<Schema$AccountService>
|
|
5857
|
+
| BodyResponseCallback<Readable>,
|
|
5858
|
+
callback?:
|
|
5859
|
+
| BodyResponseCallback<Schema$AccountService>
|
|
5860
|
+
| BodyResponseCallback<Readable>
|
|
5861
|
+
): void | GaxiosPromise<Schema$AccountService> | GaxiosPromise<Readable> {
|
|
5862
|
+
let params = (paramsOrCallback ||
|
|
5863
|
+
{}) as Params$Resource$Accounts$Services$Propose;
|
|
5864
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5865
|
+
|
|
5866
|
+
if (typeof paramsOrCallback === 'function') {
|
|
5867
|
+
callback = paramsOrCallback;
|
|
5868
|
+
params = {} as Params$Resource$Accounts$Services$Propose;
|
|
5869
|
+
options = {};
|
|
5870
|
+
}
|
|
5871
|
+
|
|
5872
|
+
if (typeof optionsOrCallback === 'function') {
|
|
5873
|
+
callback = optionsOrCallback;
|
|
5874
|
+
options = {};
|
|
5875
|
+
}
|
|
5876
|
+
|
|
5877
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
5878
|
+
const parameters = {
|
|
5879
|
+
options: Object.assign(
|
|
5880
|
+
{
|
|
5881
|
+
url: (
|
|
5882
|
+
rootUrl + '/accounts/v1beta/{+parent}/services:propose'
|
|
5883
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
5884
|
+
method: 'POST',
|
|
5885
|
+
apiVersion: '',
|
|
5886
|
+
},
|
|
5887
|
+
options
|
|
5888
|
+
),
|
|
5889
|
+
params,
|
|
5890
|
+
requiredParams: ['parent'],
|
|
5891
|
+
pathParams: ['parent'],
|
|
5892
|
+
context: this.context,
|
|
5893
|
+
};
|
|
5894
|
+
if (callback) {
|
|
5895
|
+
createAPIRequest<Schema$AccountService>(
|
|
5896
|
+
parameters,
|
|
5897
|
+
callback as BodyResponseCallback<unknown>
|
|
5898
|
+
);
|
|
5899
|
+
} else {
|
|
5900
|
+
return createAPIRequest<Schema$AccountService>(parameters);
|
|
5901
|
+
}
|
|
5902
|
+
}
|
|
5903
|
+
|
|
5904
|
+
/**
|
|
5905
|
+
* Reject an account service (both proposed and approve services can be rejected).
|
|
5906
|
+
*
|
|
5907
|
+
* @param params - Parameters for request
|
|
5908
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5909
|
+
* @param callback - Optional callback that handles the response.
|
|
5910
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5911
|
+
*/
|
|
5912
|
+
reject(
|
|
5913
|
+
params: Params$Resource$Accounts$Services$Reject,
|
|
5914
|
+
options: StreamMethodOptions
|
|
5915
|
+
): GaxiosPromise<Readable>;
|
|
5916
|
+
reject(
|
|
5917
|
+
params?: Params$Resource$Accounts$Services$Reject,
|
|
5918
|
+
options?: MethodOptions
|
|
5919
|
+
): GaxiosPromise<Schema$Empty>;
|
|
5920
|
+
reject(
|
|
5921
|
+
params: Params$Resource$Accounts$Services$Reject,
|
|
5922
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5923
|
+
callback: BodyResponseCallback<Readable>
|
|
5924
|
+
): void;
|
|
5925
|
+
reject(
|
|
5926
|
+
params: Params$Resource$Accounts$Services$Reject,
|
|
5927
|
+
options: MethodOptions | BodyResponseCallback<Schema$Empty>,
|
|
5928
|
+
callback: BodyResponseCallback<Schema$Empty>
|
|
5929
|
+
): void;
|
|
5930
|
+
reject(
|
|
5931
|
+
params: Params$Resource$Accounts$Services$Reject,
|
|
5932
|
+
callback: BodyResponseCallback<Schema$Empty>
|
|
5933
|
+
): void;
|
|
5934
|
+
reject(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
5935
|
+
reject(
|
|
5936
|
+
paramsOrCallback?:
|
|
5937
|
+
| Params$Resource$Accounts$Services$Reject
|
|
5938
|
+
| BodyResponseCallback<Schema$Empty>
|
|
5939
|
+
| BodyResponseCallback<Readable>,
|
|
5940
|
+
optionsOrCallback?:
|
|
5941
|
+
| MethodOptions
|
|
5942
|
+
| StreamMethodOptions
|
|
5943
|
+
| BodyResponseCallback<Schema$Empty>
|
|
5944
|
+
| BodyResponseCallback<Readable>,
|
|
5945
|
+
callback?:
|
|
5946
|
+
| BodyResponseCallback<Schema$Empty>
|
|
5947
|
+
| BodyResponseCallback<Readable>
|
|
5948
|
+
): void | GaxiosPromise<Schema$Empty> | GaxiosPromise<Readable> {
|
|
5949
|
+
let params = (paramsOrCallback ||
|
|
5950
|
+
{}) as Params$Resource$Accounts$Services$Reject;
|
|
5951
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5952
|
+
|
|
5953
|
+
if (typeof paramsOrCallback === 'function') {
|
|
5954
|
+
callback = paramsOrCallback;
|
|
5955
|
+
params = {} as Params$Resource$Accounts$Services$Reject;
|
|
5956
|
+
options = {};
|
|
5957
|
+
}
|
|
5958
|
+
|
|
5959
|
+
if (typeof optionsOrCallback === 'function') {
|
|
5960
|
+
callback = optionsOrCallback;
|
|
5961
|
+
options = {};
|
|
5962
|
+
}
|
|
5963
|
+
|
|
5964
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
5965
|
+
const parameters = {
|
|
5966
|
+
options: Object.assign(
|
|
5967
|
+
{
|
|
5968
|
+
url: (rootUrl + '/accounts/v1beta/{+name}:reject').replace(
|
|
5969
|
+
/([^:]\/)\/+/g,
|
|
5970
|
+
'$1'
|
|
5971
|
+
),
|
|
5972
|
+
method: 'POST',
|
|
5973
|
+
apiVersion: '',
|
|
5974
|
+
},
|
|
5975
|
+
options
|
|
5976
|
+
),
|
|
5977
|
+
params,
|
|
5978
|
+
requiredParams: ['name'],
|
|
5979
|
+
pathParams: ['name'],
|
|
5980
|
+
context: this.context,
|
|
5981
|
+
};
|
|
5982
|
+
if (callback) {
|
|
5983
|
+
createAPIRequest<Schema$Empty>(
|
|
5984
|
+
parameters,
|
|
5985
|
+
callback as BodyResponseCallback<unknown>
|
|
5986
|
+
);
|
|
5987
|
+
} else {
|
|
5988
|
+
return createAPIRequest<Schema$Empty>(parameters);
|
|
5989
|
+
}
|
|
5990
|
+
}
|
|
5991
|
+
}
|
|
5992
|
+
|
|
5993
|
+
export interface Params$Resource$Accounts$Services$Approve
|
|
5994
|
+
extends StandardParameters {
|
|
5995
|
+
/**
|
|
5996
|
+
* Required. The resource name of the account service to approve.
|
|
5997
|
+
*/
|
|
5998
|
+
name?: string;
|
|
5999
|
+
|
|
6000
|
+
/**
|
|
6001
|
+
* Request body metadata
|
|
6002
|
+
*/
|
|
6003
|
+
requestBody?: Schema$ApproveAccountServiceRequest;
|
|
6004
|
+
}
|
|
6005
|
+
export interface Params$Resource$Accounts$Services$Get
|
|
6006
|
+
extends StandardParameters {
|
|
6007
|
+
/**
|
|
6008
|
+
* Required. The resource name of the account service to get.
|
|
6009
|
+
*/
|
|
6010
|
+
name?: string;
|
|
6011
|
+
}
|
|
6012
|
+
export interface Params$Resource$Accounts$Services$List
|
|
6013
|
+
extends StandardParameters {
|
|
6014
|
+
/**
|
|
6015
|
+
* Optional. The maximum number of elements to return in the response. Use for paging. If no `page_size` is specified, `100` is used as the default value. The maximum allowed value is `1000`.
|
|
6016
|
+
*/
|
|
6017
|
+
pageSize?: number;
|
|
6018
|
+
/**
|
|
6019
|
+
* Optional. The token returned by the previous `list` request.
|
|
6020
|
+
*/
|
|
6021
|
+
pageToken?: string;
|
|
6022
|
+
/**
|
|
6023
|
+
* Required. The parent account of the account service to filter by.
|
|
6024
|
+
*/
|
|
6025
|
+
parent?: string;
|
|
6026
|
+
}
|
|
6027
|
+
export interface Params$Resource$Accounts$Services$Propose
|
|
6028
|
+
extends StandardParameters {
|
|
6029
|
+
/**
|
|
6030
|
+
* Required. The resource name of the parent account for the service.
|
|
6031
|
+
*/
|
|
6032
|
+
parent?: string;
|
|
6033
|
+
|
|
6034
|
+
/**
|
|
6035
|
+
* Request body metadata
|
|
6036
|
+
*/
|
|
6037
|
+
requestBody?: Schema$ProposeAccountServiceRequest;
|
|
6038
|
+
}
|
|
6039
|
+
export interface Params$Resource$Accounts$Services$Reject
|
|
6040
|
+
extends StandardParameters {
|
|
6041
|
+
/**
|
|
6042
|
+
* Required. The resource name of the account service to reject.
|
|
6043
|
+
*/
|
|
6044
|
+
name?: string;
|
|
6045
|
+
|
|
6046
|
+
/**
|
|
6047
|
+
* Request body metadata
|
|
6048
|
+
*/
|
|
6049
|
+
requestBody?: Schema$RejectAccountServiceRequest;
|
|
6050
|
+
}
|
|
6051
|
+
|
|
6052
|
+
export class Resource$Accounts$Shippingsettings {
|
|
6053
|
+
context: APIRequestContext;
|
|
6054
|
+
constructor(context: APIRequestContext) {
|
|
6055
|
+
this.context = context;
|
|
6056
|
+
}
|
|
6057
|
+
|
|
6058
|
+
/**
|
|
6059
|
+
* Retrieve shipping setting information.
|
|
6060
|
+
*
|
|
6061
|
+
* @param params - Parameters for request
|
|
6062
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6063
|
+
* @param callback - Optional callback that handles the response.
|
|
6064
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6065
|
+
*/
|
|
6066
|
+
getShippingSettings(
|
|
6067
|
+
params: Params$Resource$Accounts$Shippingsettings$Getshippingsettings,
|
|
6068
|
+
options: StreamMethodOptions
|
|
6069
|
+
): GaxiosPromise<Readable>;
|
|
6070
|
+
getShippingSettings(
|
|
6071
|
+
params?: Params$Resource$Accounts$Shippingsettings$Getshippingsettings,
|
|
6072
|
+
options?: MethodOptions
|
|
6073
|
+
): GaxiosPromise<Schema$ShippingSettings>;
|
|
6074
|
+
getShippingSettings(
|
|
6075
|
+
params: Params$Resource$Accounts$Shippingsettings$Getshippingsettings,
|
|
6076
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6077
|
+
callback: BodyResponseCallback<Readable>
|
|
6078
|
+
): void;
|
|
6079
|
+
getShippingSettings(
|
|
6080
|
+
params: Params$Resource$Accounts$Shippingsettings$Getshippingsettings,
|
|
6081
|
+
options: MethodOptions | BodyResponseCallback<Schema$ShippingSettings>,
|
|
6082
|
+
callback: BodyResponseCallback<Schema$ShippingSettings>
|
|
6083
|
+
): void;
|
|
6084
|
+
getShippingSettings(
|
|
6085
|
+
params: Params$Resource$Accounts$Shippingsettings$Getshippingsettings,
|
|
6086
|
+
callback: BodyResponseCallback<Schema$ShippingSettings>
|
|
6087
|
+
): void;
|
|
6088
|
+
getShippingSettings(
|
|
6089
|
+
callback: BodyResponseCallback<Schema$ShippingSettings>
|
|
6090
|
+
): void;
|
|
6091
|
+
getShippingSettings(
|
|
6092
|
+
paramsOrCallback?:
|
|
6093
|
+
| Params$Resource$Accounts$Shippingsettings$Getshippingsettings
|
|
6094
|
+
| BodyResponseCallback<Schema$ShippingSettings>
|
|
6095
|
+
| BodyResponseCallback<Readable>,
|
|
6096
|
+
optionsOrCallback?:
|
|
6097
|
+
| MethodOptions
|
|
6098
|
+
| StreamMethodOptions
|
|
6099
|
+
| BodyResponseCallback<Schema$ShippingSettings>
|
|
6100
|
+
| BodyResponseCallback<Readable>,
|
|
6101
|
+
callback?:
|
|
6102
|
+
| BodyResponseCallback<Schema$ShippingSettings>
|
|
6103
|
+
| BodyResponseCallback<Readable>
|
|
6104
|
+
): void | GaxiosPromise<Schema$ShippingSettings> | GaxiosPromise<Readable> {
|
|
6105
|
+
let params = (paramsOrCallback ||
|
|
6106
|
+
{}) as Params$Resource$Accounts$Shippingsettings$Getshippingsettings;
|
|
6107
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6108
|
+
|
|
6109
|
+
if (typeof paramsOrCallback === 'function') {
|
|
6110
|
+
callback = paramsOrCallback;
|
|
6111
|
+
params =
|
|
6112
|
+
{} as Params$Resource$Accounts$Shippingsettings$Getshippingsettings;
|
|
6113
|
+
options = {};
|
|
6114
|
+
}
|
|
6115
|
+
|
|
6116
|
+
if (typeof optionsOrCallback === 'function') {
|
|
6117
|
+
callback = optionsOrCallback;
|
|
6118
|
+
options = {};
|
|
6119
|
+
}
|
|
6120
|
+
|
|
6121
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
6122
|
+
const parameters = {
|
|
6123
|
+
options: Object.assign(
|
|
6124
|
+
{
|
|
6125
|
+
url: (rootUrl + '/accounts/v1beta/{+name}').replace(
|
|
6126
|
+
/([^:]\/)\/+/g,
|
|
6127
|
+
'$1'
|
|
6128
|
+
),
|
|
6129
|
+
method: 'GET',
|
|
6130
|
+
apiVersion: '',
|
|
6131
|
+
},
|
|
6132
|
+
options
|
|
6133
|
+
),
|
|
6134
|
+
params,
|
|
6135
|
+
requiredParams: ['name'],
|
|
6136
|
+
pathParams: ['name'],
|
|
6137
|
+
context: this.context,
|
|
6138
|
+
};
|
|
6139
|
+
if (callback) {
|
|
6140
|
+
createAPIRequest<Schema$ShippingSettings>(
|
|
6141
|
+
parameters,
|
|
6142
|
+
callback as BodyResponseCallback<unknown>
|
|
6143
|
+
);
|
|
6144
|
+
} else {
|
|
6145
|
+
return createAPIRequest<Schema$ShippingSettings>(parameters);
|
|
6146
|
+
}
|
|
6147
|
+
}
|
|
6148
|
+
|
|
6149
|
+
/**
|
|
6150
|
+
* Replace the shipping setting of a merchant with the request shipping setting. Executing this method requires admin access.
|
|
6151
|
+
*
|
|
6152
|
+
* @param params - Parameters for request
|
|
6153
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6154
|
+
* @param callback - Optional callback that handles the response.
|
|
6155
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6156
|
+
*/
|
|
6157
|
+
insert(
|
|
6158
|
+
params: Params$Resource$Accounts$Shippingsettings$Insert,
|
|
4820
6159
|
options: StreamMethodOptions
|
|
4821
6160
|
): GaxiosPromise<Readable>;
|
|
4822
6161
|
insert(
|
|
@@ -4898,14 +6237,14 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
4898
6237
|
export interface Params$Resource$Accounts$Shippingsettings$Getshippingsettings
|
|
4899
6238
|
extends StandardParameters {
|
|
4900
6239
|
/**
|
|
4901
|
-
* Required. The name of the shipping setting to retrieve. Format: `accounts/{account\}/
|
|
6240
|
+
* Required. The name of the shipping setting to retrieve. Format: `accounts/{account\}/shippingsettings`
|
|
4902
6241
|
*/
|
|
4903
6242
|
name?: string;
|
|
4904
6243
|
}
|
|
4905
6244
|
export interface Params$Resource$Accounts$Shippingsettings$Insert
|
|
4906
6245
|
extends StandardParameters {
|
|
4907
6246
|
/**
|
|
4908
|
-
* Required. The account
|
|
6247
|
+
* Required. The account for which this shipping setting will be inserted. If you are using an advanced account, you must specify the unique identifier of the sub-account for which you want to insert the shipping setting. Format: `accounts/{ACCOUNT_ID\}`
|
|
4909
6248
|
*/
|
|
4910
6249
|
parent?: string;
|
|
4911
6250
|
|
|
@@ -5121,7 +6460,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
5121
6460
|
export interface Params$Resource$Accounts$Termsofserviceagreementstates$Get
|
|
5122
6461
|
extends StandardParameters {
|
|
5123
6462
|
/**
|
|
5124
|
-
* Required. The resource name of the terms of service version. Format: `accounts/{account\}/
|
|
6463
|
+
* Required. The resource name of the terms of service version. Format: `accounts/{account\}/termsOfServiceAgreementStates/{identifier\}` The identifier format is: `{TermsOfServiceKind\}-{country\}`
|
|
5125
6464
|
*/
|
|
5126
6465
|
name?: string;
|
|
5127
6466
|
}
|
|
@@ -5666,7 +7005,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
5666
7005
|
accept(
|
|
5667
7006
|
params?: Params$Resource$Termsofservice$Accept,
|
|
5668
7007
|
options?: MethodOptions
|
|
5669
|
-
): GaxiosPromise<Schema$
|
|
7008
|
+
): GaxiosPromise<Schema$AcceptTermsOfServiceResponse>;
|
|
5670
7009
|
accept(
|
|
5671
7010
|
params: Params$Resource$Termsofservice$Accept,
|
|
5672
7011
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
@@ -5674,28 +7013,35 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
5674
7013
|
): void;
|
|
5675
7014
|
accept(
|
|
5676
7015
|
params: Params$Resource$Termsofservice$Accept,
|
|
5677
|
-
options:
|
|
5678
|
-
|
|
7016
|
+
options:
|
|
7017
|
+
| MethodOptions
|
|
7018
|
+
| BodyResponseCallback<Schema$AcceptTermsOfServiceResponse>,
|
|
7019
|
+
callback: BodyResponseCallback<Schema$AcceptTermsOfServiceResponse>
|
|
5679
7020
|
): void;
|
|
5680
7021
|
accept(
|
|
5681
7022
|
params: Params$Resource$Termsofservice$Accept,
|
|
5682
|
-
callback: BodyResponseCallback<Schema$
|
|
7023
|
+
callback: BodyResponseCallback<Schema$AcceptTermsOfServiceResponse>
|
|
7024
|
+
): void;
|
|
7025
|
+
accept(
|
|
7026
|
+
callback: BodyResponseCallback<Schema$AcceptTermsOfServiceResponse>
|
|
5683
7027
|
): void;
|
|
5684
|
-
accept(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
5685
7028
|
accept(
|
|
5686
7029
|
paramsOrCallback?:
|
|
5687
7030
|
| Params$Resource$Termsofservice$Accept
|
|
5688
|
-
| BodyResponseCallback<Schema$
|
|
7031
|
+
| BodyResponseCallback<Schema$AcceptTermsOfServiceResponse>
|
|
5689
7032
|
| BodyResponseCallback<Readable>,
|
|
5690
7033
|
optionsOrCallback?:
|
|
5691
7034
|
| MethodOptions
|
|
5692
7035
|
| StreamMethodOptions
|
|
5693
|
-
| BodyResponseCallback<Schema$
|
|
7036
|
+
| BodyResponseCallback<Schema$AcceptTermsOfServiceResponse>
|
|
5694
7037
|
| BodyResponseCallback<Readable>,
|
|
5695
7038
|
callback?:
|
|
5696
|
-
| BodyResponseCallback<Schema$
|
|
7039
|
+
| BodyResponseCallback<Schema$AcceptTermsOfServiceResponse>
|
|
5697
7040
|
| BodyResponseCallback<Readable>
|
|
5698
|
-
):
|
|
7041
|
+
):
|
|
7042
|
+
| void
|
|
7043
|
+
| GaxiosPromise<Schema$AcceptTermsOfServiceResponse>
|
|
7044
|
+
| GaxiosPromise<Readable> {
|
|
5699
7045
|
let params = (paramsOrCallback ||
|
|
5700
7046
|
{}) as Params$Resource$Termsofservice$Accept;
|
|
5701
7047
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
@@ -5719,7 +7065,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
5719
7065
|
/([^:]\/)\/+/g,
|
|
5720
7066
|
'$1'
|
|
5721
7067
|
),
|
|
5722
|
-
method: '
|
|
7068
|
+
method: 'POST',
|
|
5723
7069
|
apiVersion: '',
|
|
5724
7070
|
},
|
|
5725
7071
|
options
|
|
@@ -5730,12 +7076,14 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
5730
7076
|
context: this.context,
|
|
5731
7077
|
};
|
|
5732
7078
|
if (callback) {
|
|
5733
|
-
createAPIRequest<Schema$
|
|
7079
|
+
createAPIRequest<Schema$AcceptTermsOfServiceResponse>(
|
|
5734
7080
|
parameters,
|
|
5735
7081
|
callback as BodyResponseCallback<unknown>
|
|
5736
7082
|
);
|
|
5737
7083
|
} else {
|
|
5738
|
-
return createAPIRequest<Schema$
|
|
7084
|
+
return createAPIRequest<Schema$AcceptTermsOfServiceResponse>(
|
|
7085
|
+
parameters
|
|
7086
|
+
);
|
|
5739
7087
|
}
|
|
5740
7088
|
}
|
|
5741
7089
|
|
|
@@ -5918,7 +7266,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
5918
7266
|
export interface Params$Resource$Termsofservice$Accept
|
|
5919
7267
|
extends StandardParameters {
|
|
5920
7268
|
/**
|
|
5921
|
-
* Required. The account for which to accept the ToS.
|
|
7269
|
+
* Required. The account for which to accept the ToS. Format: `accounts/{account\}`
|
|
5922
7270
|
*/
|
|
5923
7271
|
account?: string;
|
|
5924
7272
|
/**
|