@maxim_mazurok/gapi.client.merchantapi-accounts_v1beta 0.0.20250605 → 0.0.20250606

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.
Files changed (3) hide show
  1. package/index.d.ts +15 -15
  2. package/package.json +1 -1
  3. package/readme.md +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://merchantapi.googleapis.com/$discovery/rest?version=accounts_v1beta
12
- // Revision: 20250605
12
+ // Revision: 20250606
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -35,11 +35,11 @@ declare namespace gapi.client {
35
35
  uri?: string;
36
36
  }
37
37
  interface Accepted {
38
- /** The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account. */
38
+ /** Required. The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account. */
39
39
  acceptedBy?: string;
40
- /** The accepted termsOfService. */
40
+ /** Required. The accepted termsOfService. */
41
41
  termsOfService?: string;
42
- /** 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. */
42
+ /** Optional. 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. */
43
43
  validUntil?: Date;
44
44
  }
45
45
  interface AcceptTermsOfServiceResponse {
@@ -591,11 +591,11 @@ declare namespace gapi.client {
591
591
  seasonalOverrides?: SeasonalOverride[];
592
592
  }
593
593
  interface PhoneNumber {
594
- /** The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes */
594
+ /** The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123" The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes */
595
595
  e164Number?: string;
596
596
  /** The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future. */
597
597
  extension?: string;
598
- /** A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code */
598
+ /** A short code. Reference(s): - https://wikipedia.org/wiki/Short_code */
599
599
  shortCode?: ShortCode;
600
600
  }
601
601
  interface Pickup {
@@ -736,9 +736,9 @@ declare namespace gapi.client {
736
736
  omnichannelSetting?: OmnichannelSetting;
737
737
  }
738
738
  interface Required {
739
- /** The `TermsOfService` that need to be accepted. */
739
+ /** Required. The `TermsOfService` that need to be accepted. */
740
740
  termsOfService?: string;
741
- /** Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only. */
741
+ /** Required. Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only. */
742
742
  tosFileUri?: string;
743
743
  }
744
744
  interface Requirement {
@@ -802,7 +802,7 @@ declare namespace gapi.client {
802
802
  storeConfig?: StoreConfig;
803
803
  }
804
804
  interface ShippingSettings {
805
- /** Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps 1. Set etag field as empty string for initial shipping setting creation. 2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert. 3. Modify to wanted shipping setting information. 4. Call insert method with the wanted shipping setting information with the etag obtained from step 2. 5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag. */
805
+ /** Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the `get` call and the `insert` call. The user should follow these steps: 1. Set the etag field as an empty string for the initial shipping setting creation. 2. After the initial creation, call the `get` method to obtain an etag and the current shipping setting data before calling `insert`. 3. Modify the shipping setting information. 4. Call the `insert` method with the shipping setting information and the etag obtained in step 2. 5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag. */
806
806
  etag?: string;
807
807
  /** Identifier. The resource name of the shipping settings. Format: `accounts/{account}/shippingSettings`. For example, `accounts/123456/shippingSettings`. */
808
808
  name?: string;
@@ -856,15 +856,15 @@ declare namespace gapi.client {
856
856
  regionCode?: string;
857
857
  }
858
858
  interface TermsOfServiceAgreementState {
859
- /** The accepted terms of service of this kind and for the associated region_code */
859
+ /** Optional. The accepted terms of service of this kind and for the associated region_code */
860
860
  accepted?: Accepted;
861
861
  /** Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-EU` or `MERCHANT_CENTER-US`. */
862
862
  name?: string;
863
- /** Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. */
863
+ /** Required. Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. */
864
864
  regionCode?: string;
865
- /** The required terms of service */
865
+ /** Optional. The required terms of service */
866
866
  required?: Required;
867
- /** Terms of Service kind associated with the particular version. */
867
+ /** Required. Terms of Service kind associated with the particular version. */
868
868
  termsOfServiceKind?: string;
869
869
  }
870
870
  interface TimeZone {
@@ -3129,7 +3129,7 @@ declare namespace gapi.client {
3129
3129
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3130
3130
  uploadType?: string;
3131
3131
  }): Request<TermsOfServiceAgreementState>;
3132
- /** Retrieves the state of the agreement for the application terms of service. */
3132
+ /** Retrieves the state of the agreement for the application terms of service. Application terms of service covers permissions related to the usage of data provided through Merchant Center, CSS Center, Manufacturer Center, and more. */
3133
3133
  retrieveForApplication(request?: {
3134
3134
  /** V1 error format. */
3135
3135
  '$.xgafv'?: string;
@@ -3479,7 +3479,7 @@ declare namespace gapi.client {
3479
3479
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3480
3480
  uploadType?: string;
3481
3481
  }): Request<Account>;
3482
- /** 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 advanced account, but all accounts the calling user has access to including other advanced accounts, 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. */
3482
+ /** Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case. */
3483
3483
  list(request?: {
3484
3484
  /** V1 error format. */
3485
3485
  '$.xgafv'?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.merchantapi-accounts_v1beta",
3
- "version": "0.0.20250605",
3
+ "version": "0.0.20250606",
4
4
  "description": "TypeScript typings for Merchant API accounts_v1beta",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -85,7 +85,7 @@ Retrieves an account from your Merchant Center account. After inserting, updatin
85
85
  await gapi.client.merchantapi.accounts.get({name: 'name'});
86
86
 
87
87
  /*
88
- 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 advanced account, but all accounts the calling user has access to including other advanced accounts, 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.
88
+ Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.
89
89
  */
90
90
  await gapi.client.merchantapi.accounts.list({});
91
91