@wix/auto_sdk_ecom_tip-settings 1.0.0 → 1.0.2

package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.public.d.ts

@@ -57,7 +57,7 @@ interface CreateDefaultTipSettingsSignature {
      *
      *
      * The call fails if there is already an existing default `tipSettings` object.
-     * @param - Dafault tip settings to create.
+     * @param - Default tip settings to create.
      */
     (tipSettings: TipSettings): Promise<CreateDefaultTipSettingsResponse & CreateDefaultTipSettingsResponseNonNullableFields>;
 }

package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.d.ts

@@ -2,13 +2,14 @@
  * Tip settings define how tips are calculated and distributed among staff. When
  * Wix Tips is installed, default settings are automatically created. You can't
  * delete these default settings but you can update them. Creating additional
- * settings allows business owners to customize tip screens for different payment
+ * settings allows Wix users to customize tip screens for different payment
  * terminals or set specific presets for various products or services.
  */
 export interface TipSettings extends TipSettingsIdentifierOneOf {
     /**
-     * ID of the [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
+     * ID of the location ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/location-object))
      * for which the tip settings apply.
+     * @format GUID
      */
     locationId?: string | null;
     /**
@@ -16,44 +17,42 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
      * validate the ID you provide.
      *
      * Max: 30 characters
+     * @maxLength 30
      */
     paymentTerminalId?: string | null;
     /**
      * ID of the Wix user for whom the tip settings apply. For example, the site owner or a
      * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
+     * @format GUID
      */
     userId?: string | null;
     /**
      * ID of the tip settings.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
-    /**
-     * Tip type.
-     *
-     * Supported values:
-     * + `UNKNOWN_TIP_TYPE`: There is no information about the tip type.
-     * + `PERCENTAGE`: The tip is calculated as a percentage of the subtotal for all related line items.
-     * + `AMOUNT`: The tip is a fixed amount.
-     */
+    /** Tip type. */
     tipType?: TipType;
     /**
      * Information about the tip choices that Wix Tips displays to customers during the
-     * [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).
+     * eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
      *
      * Min: `1` preset
      * Max: `3` presets
+     * @minSize 1
+     * @maxSize 3
      */
     presets?: Preset[];
     /**
      * Whether customer are allowed to tip during the
-     * [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).
+     * eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
      *
      * Default: `true`
      */
     allowCustomerTip?: boolean | null;
     /**
-     * Whether the business owners are given the option to add a tip during the
+     * Whether the Wix users are given the option to add a tip during the
      * payment collection flow in their dashboard.
      *
      * Default: `true`
@@ -68,8 +67,8 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
      */
     allowCustomAmount?: boolean | null;
     /**
-     * Whether business owners are allowed to edit tip distributions. If set to
-     * `false`, owners can't edit distributions after they were created.
+     * Whether Wix users are allowed to edit tip distributions. If set to
+     * `false`, Wix users can't edit distributions after they were created.
      *
      * Default: `true`
      */
@@ -97,22 +96,25 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
      */
     createdDate?: Date | null;
     /**
-     * Date and time the tip settings were last updated
+     * Date and time the tip settings were last updated in
      * `YYYY-MM-DDThh:mm:ss.sssZ` format.
      * @readonly
      */
     updatedDate?: Date | null;
     /**
-     * Whether these are the default tip settings. Wix Tips automatically creates
-     * the default settings during the app's installation. You can't delete these
-     * default settings but you can update them. Wix Tips uses the default settings
+     * Whether these are the default tip settings.
+     *
+     * Wix Tips automatically creates the default settings during
+     * the app's installation. You can't delete these default settings
+     * but you can update them. Wix Tips uses the default settings
      * to calculate tips, unless you specify other settings.
      * @readonly
      */
     default?: boolean | null;
     /**
      * ID of the app that has created the settings. See the list of app IDs for
-     * [Wix business solutions](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions).
+     * Wix business solutions ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/apps-created-by-wix) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/apps-created-by-wix)).
+     * @format GUID
      */
     appId?: string | null;
     /**
@@ -124,8 +126,9 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
 /** @oneof */
 export interface TipSettingsIdentifierOneOf {
     /**
-     * ID of the [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
+     * ID of the location ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/location-object))
      * for which the tip settings apply.
+     * @format GUID
      */
     locationId?: string | null;
     /**
@@ -133,11 +136,13 @@ export interface TipSettingsIdentifierOneOf {
      * validate the ID you provide.
      *
      * Max: 30 characters
+     * @maxLength 30
      */
     paymentTerminalId?: string | null;
     /**
      * ID of the Wix user for whom the tip settings apply. For example, the site owner or a
      * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
+     * @format GUID
      */
     userId?: string | null;
 }
@@ -152,15 +157,15 @@ export declare enum TipType {
 export interface Preset {
     /**
      * Value of the preset tip choice that's displayed to customers in the
-     * [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).
+     * eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
      * For example, `5`, `10`, and `15` percent or `1`, `3`, and `5` USD.
      *
      * Min: `0`
      */
     value?: number | null;
     /**
-     * Whether this tip choice value is the dafault preset that's highlighted automatically in the
-     * [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).
+     * Whether this tip choice value is the default preset that's highlighted automatically in the
+     * eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
      *
      * Default: `false`
      */
@@ -206,11 +211,20 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 10
      */
     sort?: Sorting[];
-    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    /**
+     * Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.
+     * @maxLength 200
+     * @maxSize 10
+     */
     fields?: string[];
-    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    /**
+     * Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.
+     * @maxLength 200
+     * @maxSize 10
+     */
     fieldsets?: string[];
 }
 /** @oneof */
@@ -221,7 +235,10 @@ export interface QueryV2PagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -237,13 +254,17 @@ export interface Paging {
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -266,9 +287,15 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface UpdateTipSettingsRequest {
@@ -288,7 +315,7 @@ export interface CreateTipSettingsResponse {
     tipSettings?: TipSettings;
 }
 export interface CreateDefaultTipSettingsRequest {
-    /** Dafault tip settings to create. */
+    /** Default tip settings to create. */
     tipSettings: TipSettings;
 }
 export interface CreateDefaultTipSettingsResponse {
@@ -296,7 +323,10 @@ export interface CreateDefaultTipSettingsResponse {
     tipSettings?: TipSettings;
 }
 export interface DeleteTipSettingsRequest {
-    /** ID of the `tipSettings` object to delete. */
+    /**
+     * ID of the `tipSettings` object to delete.
+     * @format GUID
+     */
     tipSettingsId: string | null;
 }
 export interface DeleteTipSettingsResponse {
@@ -374,9 +404,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -384,26 +420,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {

package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"tips-settings-v1-tip-settings-tip-settings.types.js","sourceRoot":"","sources":["../../../src/tips-settings-v1-tip-settings-tip-settings.types.ts"],"names":[],"mappings":";;;AAiJA,IAAY,OAOX;AAPD,WAAY,OAAO;IACjB,kDAAkD;IAClD,gDAAqC,CAAA;IACrC,uFAAuF;IACvF,oCAAyB,CAAA;IACzB,iCAAiC;IACjC,4BAAiB,CAAA;AACnB,CAAC,EAPW,OAAO,uBAAP,OAAO,QAOlB;AAoBD,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,mEAAmE;IACnE,wEAA6C,CAAA;IAC7C,oDAAoD;IACpD,0CAAe,CAAA;IACf,sDAAsD;IACtD,wDAA6B,CAAA;AAC/B,CAAC,EAPW,uBAAuB,uCAAvB,uBAAuB,QAOlC;AA2DD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAwMD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"tips-settings-v1-tip-settings-tip-settings.types.js","sourceRoot":"","sources":["../../../src/tips-settings-v1-tip-settings-tip-settings.types.ts"],"names":[],"mappings":";;;AAsJA,IAAY,OAOX;AAPD,WAAY,OAAO;IACjB,kDAAkD;IAClD,gDAAqC,CAAA;IACrC,uFAAuF;IACvF,oCAAyB,CAAA;IACzB,iCAAiC;IACjC,4BAAiB,CAAA;AACnB,CAAC,EAPW,OAAO,uBAAP,OAAO,QAOlB;AAoBD,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,mEAAmE;IACnE,wEAA6C,CAAA;IAC7C,oDAAoD;IACpD,0CAAe,CAAA;IACf,sDAAsD;IACtD,wDAA6B,CAAA;AAC/B,CAAC,EAPW,uBAAuB,uCAAvB,uBAAuB,QAOlC;AAuED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAmPD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}

package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts

@@ -2,13 +2,14 @@
  * Tip settings define how tips are calculated and distributed among staff. When
  * Wix Tips is installed, default settings are automatically created. You can't
  * delete these default settings but you can update them. Creating additional
- * settings allows business owners to customize tip screens for different payment
+ * settings allows Wix users to customize tip screens for different payment
  * terminals or set specific presets for various products or services.
  */
 export interface TipSettings extends TipSettingsIdentifierOneOf {
     /**
-     * ID of the [location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
+     * ID of the location ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/location-object))
      * for which the tip settings apply.
+     * @format GUID
      */
     locationId?: string | null;
     /**
@@ -16,42 +17,42 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
      * validate the ID you provide.
      *
      * Max: 30 characters
+     * @maxLength 30
      */
     paymentTerminalId?: string | null;
     /**
      * ID of the Wix user for whom the tip settings apply. For example, the site owner or a
      * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
+     * @format GUID
      */
     userId?: string | null;
     /**
      * ID of the tip settings.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /**
-     * Tip type.
-     *
-     * Supported values:
-     * + `UNKNOWN_TIP_TYPE`: There is no information about the tip type.
-     * + `PERCENTAGE`: The tip is calculated as a percentage of the subtotal for all related line items.
-     * + `AMOUNT`: The tip is a fixed amount.
-     */
+    /** Tip type. */
     tipType?: TipType;
     /**
      * Information about the tip choices that Wix Tips displays to customers during the
-     * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).
+     * eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
      *
      * Min: `1` preset
      * Max: `3` presets
+     * @minSize 1
+     * @maxSize 3
      */
     presets?: Preset[];
     /**
      * Whether customer are allowed to tip during the
-     * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).
+     * eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
+     *
+     * Default: `true`
      */
     allowCustomerTip?: boolean | null;
     /**
-     * Whether the business owners are given the option to add a tip during the
+     * Whether the Wix users are given the option to add a tip during the
      * payment collection flow in their dashboard.
      *
      * Default: `true`
@@ -66,8 +67,8 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
      */
     allowCustomAmount?: boolean | null;
     /**
-     * Whether business owners are allowed to edit tip distributions. If set to
-     * `false`, owners can't edit distributions after they were created.
+     * Whether Wix users are allowed to edit tip distributions. If set to
+     * `false`, Wix users can't edit distributions after they were created.
      *
      * Default: `true`
      */
@@ -95,22 +96,25 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
      */
     _createdDate?: Date | null;
     /**
-     * Date and time the tip settings were last updated
+     * Date and time the tip settings were last updated in
      * `YYYY-MM-DDThh:mm:ss.sssZ` format.
      * @readonly
      */
     _updatedDate?: Date | null;
     /**
-     * Whether these are the default tip settings. Wix Tips automatically creates
-     * the default settings during the app's installation. You can't delete these
-     * default settings but you can update them. Wix Tips uses the default settings
+     * Whether these are the default tip settings.
+     *
+     * Wix Tips automatically creates the default settings during
+     * the app's installation. You can't delete these default settings
+     * but you can update them. Wix Tips uses the default settings
      * to calculate tips, unless you specify other settings.
      * @readonly
      */
     default?: boolean | null;
     /**
      * ID of the app that has created the settings. See the list of app IDs for
-     * [Wix business solutions](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions).
+     * Wix business solutions ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/apps-created-by-wix) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/apps-created-by-wix)).
+     * @format GUID
      */
     appId?: string | null;
     /**
@@ -122,8 +126,9 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
 /** @oneof */
 export interface TipSettingsIdentifierOneOf {
     /**
-     * ID of the [location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
+     * ID of the location ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/location-object))
      * for which the tip settings apply.
+     * @format GUID
      */
     locationId?: string | null;
     /**
@@ -131,11 +136,13 @@ export interface TipSettingsIdentifierOneOf {
      * validate the ID you provide.
      *
      * Max: 30 characters
+     * @maxLength 30
      */
     paymentTerminalId?: string | null;
     /**
      * ID of the Wix user for whom the tip settings apply. For example, the site owner or a
      * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
+     * @format GUID
      */
     userId?: string | null;
 }
@@ -150,15 +157,15 @@ export declare enum TipType {
 export interface Preset {
     /**
      * Value of the preset tip choice that's displayed to customers in the
-     * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).
+     * eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
      * For example, `5`, `10`, and `15` percent or `1`, `3`, and `5` USD.
      *
      * Min: `0`
      */
     value?: number | null;
     /**
-     * Whether this tip choice value is the dafault preset that's highlighted automatically in the
-     * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).
+     * Whether this tip choice value is the default preset that's highlighted automatically in the
+     * eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
      *
      * Default: `false`
      */
@@ -204,11 +211,20 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 10
      */
     sort?: Sorting[];
-    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    /**
+     * Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.
+     * @maxLength 200
+     * @maxSize 10
+     */
     fields?: string[];
-    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    /**
+     * Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.
+     * @maxLength 200
+     * @maxSize 10
+     */
     fieldsets?: string[];
 }
 /** @oneof */
@@ -219,7 +235,10 @@ export interface QueryV2PagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -235,13 +254,17 @@ export interface Paging {
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -264,9 +287,15 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface UpdateTipSettingsRequest {
@@ -286,7 +315,7 @@ export interface CreateTipSettingsResponse {
     tipSettings?: TipSettings;
 }
 export interface CreateDefaultTipSettingsRequest {
-    /** Dafault tip settings to create. */
+    /** Default tip settings to create. */
     tipSettings: TipSettings;
 }
 export interface CreateDefaultTipSettingsResponse {
@@ -294,7 +323,10 @@ export interface CreateDefaultTipSettingsResponse {
     tipSettings?: TipSettings;
 }
 export interface DeleteTipSettingsRequest {
-    /** ID of the `tipSettings` object to delete. */
+    /**
+     * ID of the `tipSettings` object to delete.
+     * @format GUID
+     */
     tipSettingsId: string | null;
 }
 export interface DeleteTipSettingsResponse {
@@ -370,9 +402,15 @@ export interface ActionEvent {
     body?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -380,26 +418,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -555,7 +617,7 @@ export declare function createTipSettings(tipSettings: TipSettings): Promise<Tip
  *
  *
  * The call fails if there is already an existing default `tipSettings` object.
- * @param tipSettings - Dafault tip settings to create.
+ * @param tipSettings - Default tip settings to create.
  * @public
  * @documentationMaturity preview
  * @requiredField tipSettings