@wix/auto_sdk_ecom_tip-settings 1.0.1 → 1.0.2

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 (25) hide show
  1. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.public.d.ts +1 -1
  2. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.d.ts +20 -25
  3. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.js.map +1 -1
  4. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts +23 -26
  5. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.js +1 -1
  6. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.js.map +1 -1
  7. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.public.d.ts +1 -1
  8. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.types.d.ts +20 -25
  9. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.types.js.map +1 -1
  10. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts +23 -26
  11. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.universal.js +1 -1
  12. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.universal.js.map +1 -1
  13. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.public.d.ts +1 -1
  14. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.d.ts +20 -25
  15. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.js.map +1 -1
  16. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts +23 -26
  17. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.js +1 -1
  18. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.js.map +1 -1
  19. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.public.d.ts +1 -1
  20. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.types.d.ts +20 -25
  21. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.types.js.map +1 -1
  22. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts +23 -26
  23. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.universal.js +1 -1
  24. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.universal.js.map +1 -1
  25. package/package.json +2 -2
@@ -57,7 +57,7 @@ interface CreateDefaultTipSettingsSignature {
57
57
  *
58
58
  *
59
59
  * The call fails if there is already an existing default `tipSettings` object.
60
- * @param - Dafault tip settings to create.
60
+ * @param - Default tip settings to create.
61
61
  */
62
62
  (tipSettings: TipSettings): Promise<CreateDefaultTipSettingsResponse & CreateDefaultTipSettingsResponseNonNullableFields>;
63
63
  }
@@ -2,12 +2,12 @@
2
2
  * Tip settings define how tips are calculated and distributed among staff. When
3
3
  * Wix Tips is installed, default settings are automatically created. You can't
4
4
  * delete these default settings but you can update them. Creating additional
5
- * settings allows business owners to customize tip screens for different payment
5
+ * settings allows Wix users to customize tip screens for different payment
6
6
  * terminals or set specific presets for various products or services.
7
7
  */
8
8
  export interface TipSettings extends TipSettingsIdentifierOneOf {
9
9
  /**
10
- * ID of the [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
10
+ * 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))
11
11
  * for which the tip settings apply.
12
12
  * @format GUID
13
13
  */
@@ -32,18 +32,11 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
32
32
  * @readonly
33
33
  */
34
34
  id?: string | null;
35
- /**
36
- * Tip type.
37
- *
38
- * Supported values:
39
- * + `UNKNOWN_TIP_TYPE`: There is no information about the tip type.
40
- * + `PERCENTAGE`: The tip is calculated as a percentage of the subtotal for all related line items.
41
- * + `AMOUNT`: The tip is a fixed amount.
42
- */
35
+ /** Tip type. */
43
36
  tipType?: TipType;
44
37
  /**
45
38
  * Information about the tip choices that Wix Tips displays to customers during the
46
- * [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).
39
+ * 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)).
47
40
  *
48
41
  * Min: `1` preset
49
42
  * Max: `3` presets
@@ -53,13 +46,13 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
53
46
  presets?: Preset[];
54
47
  /**
55
48
  * Whether customer are allowed to tip during the
56
- * [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).
49
+ * 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)).
57
50
  *
58
51
  * Default: `true`
59
52
  */
60
53
  allowCustomerTip?: boolean | null;
61
54
  /**
62
- * Whether the business owners are given the option to add a tip during the
55
+ * Whether the Wix users are given the option to add a tip during the
63
56
  * payment collection flow in their dashboard.
64
57
  *
65
58
  * Default: `true`
@@ -74,8 +67,8 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
74
67
  */
75
68
  allowCustomAmount?: boolean | null;
76
69
  /**
77
- * Whether business owners are allowed to edit tip distributions. If set to
78
- * `false`, owners can't edit distributions after they were created.
70
+ * Whether Wix users are allowed to edit tip distributions. If set to
71
+ * `false`, Wix users can't edit distributions after they were created.
79
72
  *
80
73
  * Default: `true`
81
74
  */
@@ -103,22 +96,24 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
103
96
  */
104
97
  createdDate?: Date | null;
105
98
  /**
106
- * Date and time the tip settings were last updated
99
+ * Date and time the tip settings were last updated in
107
100
  * `YYYY-MM-DDThh:mm:ss.sssZ` format.
108
101
  * @readonly
109
102
  */
110
103
  updatedDate?: Date | null;
111
104
  /**
112
- * Whether these are the default tip settings. Wix Tips automatically creates
113
- * the default settings during the app's installation. You can't delete these
114
- * default settings but you can update them. Wix Tips uses the default settings
105
+ * Whether these are the default tip settings.
106
+ *
107
+ * Wix Tips automatically creates the default settings during
108
+ * the app's installation. You can't delete these default settings
109
+ * but you can update them. Wix Tips uses the default settings
115
110
  * to calculate tips, unless you specify other settings.
116
111
  * @readonly
117
112
  */
118
113
  default?: boolean | null;
119
114
  /**
120
115
  * ID of the app that has created the settings. See the list of app IDs for
121
- * [Wix business solutions](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions).
116
+ * 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)).
122
117
  * @format GUID
123
118
  */
124
119
  appId?: string | null;
@@ -131,7 +126,7 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
131
126
  /** @oneof */
132
127
  export interface TipSettingsIdentifierOneOf {
133
128
  /**
134
- * ID of the [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
129
+ * 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))
135
130
  * for which the tip settings apply.
136
131
  * @format GUID
137
132
  */
@@ -162,15 +157,15 @@ export declare enum TipType {
162
157
  export interface Preset {
163
158
  /**
164
159
  * Value of the preset tip choice that's displayed to customers in the
165
- * [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).
160
+ * 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)).
166
161
  * For example, `5`, `10`, and `15` percent or `1`, `3`, and `5` USD.
167
162
  *
168
163
  * Min: `0`
169
164
  */
170
165
  value?: number | null;
171
166
  /**
172
- * Whether this tip choice value is the dafault preset that's highlighted automatically in the
173
- * [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).
167
+ * Whether this tip choice value is the default preset that's highlighted automatically in the
168
+ * 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)).
174
169
  *
175
170
  * Default: `false`
176
171
  */
@@ -320,7 +315,7 @@ export interface CreateTipSettingsResponse {
320
315
  tipSettings?: TipSettings;
321
316
  }
322
317
  export interface CreateDefaultTipSettingsRequest {
323
- /** Dafault tip settings to create. */
318
+ /** Default tip settings to create. */
324
319
  tipSettings: TipSettings;
325
320
  }
326
321
  export interface CreateDefaultTipSettingsResponse {
@@ -1 +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":";;;AA2JA,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"}
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":";;;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"}
@@ -2,12 +2,12 @@
2
2
  * Tip settings define how tips are calculated and distributed among staff. When
3
3
  * Wix Tips is installed, default settings are automatically created. You can't
4
4
  * delete these default settings but you can update them. Creating additional
5
- * settings allows business owners to customize tip screens for different payment
5
+ * settings allows Wix users to customize tip screens for different payment
6
6
  * terminals or set specific presets for various products or services.
7
7
  */
8
8
  export interface TipSettings extends TipSettingsIdentifierOneOf {
9
9
  /**
10
- * ID of the [location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
10
+ * 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))
11
11
  * for which the tip settings apply.
12
12
  * @format GUID
13
13
  */
@@ -32,18 +32,11 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
32
32
  * @readonly
33
33
  */
34
34
  _id?: string | null;
35
- /**
36
- * Tip type.
37
- *
38
- * Supported values:
39
- * + `UNKNOWN_TIP_TYPE`: There is no information about the tip type.
40
- * + `PERCENTAGE`: The tip is calculated as a percentage of the subtotal for all related line items.
41
- * + `AMOUNT`: The tip is a fixed amount.
42
- */
35
+ /** Tip type. */
43
36
  tipType?: TipType;
44
37
  /**
45
38
  * Information about the tip choices that Wix Tips displays to customers during the
46
- * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).
39
+ * 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)).
47
40
  *
48
41
  * Min: `1` preset
49
42
  * Max: `3` presets
@@ -53,11 +46,13 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
53
46
  presets?: Preset[];
54
47
  /**
55
48
  * Whether customer are allowed to tip during the
56
- * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).
49
+ * 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)).
50
+ *
51
+ * Default: `true`
57
52
  */
58
53
  allowCustomerTip?: boolean | null;
59
54
  /**
60
- * Whether the business owners are given the option to add a tip during the
55
+ * Whether the Wix users are given the option to add a tip during the
61
56
  * payment collection flow in their dashboard.
62
57
  *
63
58
  * Default: `true`
@@ -72,8 +67,8 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
72
67
  */
73
68
  allowCustomAmount?: boolean | null;
74
69
  /**
75
- * Whether business owners are allowed to edit tip distributions. If set to
76
- * `false`, owners can't edit distributions after they were created.
70
+ * Whether Wix users are allowed to edit tip distributions. If set to
71
+ * `false`, Wix users can't edit distributions after they were created.
77
72
  *
78
73
  * Default: `true`
79
74
  */
@@ -101,22 +96,24 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
101
96
  */
102
97
  _createdDate?: Date | null;
103
98
  /**
104
- * Date and time the tip settings were last updated
99
+ * Date and time the tip settings were last updated in
105
100
  * `YYYY-MM-DDThh:mm:ss.sssZ` format.
106
101
  * @readonly
107
102
  */
108
103
  _updatedDate?: Date | null;
109
104
  /**
110
- * Whether these are the default tip settings. Wix Tips automatically creates
111
- * the default settings during the app's installation. You can't delete these
112
- * default settings but you can update them. Wix Tips uses the default settings
105
+ * Whether these are the default tip settings.
106
+ *
107
+ * Wix Tips automatically creates the default settings during
108
+ * the app's installation. You can't delete these default settings
109
+ * but you can update them. Wix Tips uses the default settings
113
110
  * to calculate tips, unless you specify other settings.
114
111
  * @readonly
115
112
  */
116
113
  default?: boolean | null;
117
114
  /**
118
115
  * ID of the app that has created the settings. See the list of app IDs for
119
- * [Wix business solutions](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions).
116
+ * 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)).
120
117
  * @format GUID
121
118
  */
122
119
  appId?: string | null;
@@ -129,7 +126,7 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
129
126
  /** @oneof */
130
127
  export interface TipSettingsIdentifierOneOf {
131
128
  /**
132
- * ID of the [location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
129
+ * 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))
133
130
  * for which the tip settings apply.
134
131
  * @format GUID
135
132
  */
@@ -160,15 +157,15 @@ export declare enum TipType {
160
157
  export interface Preset {
161
158
  /**
162
159
  * Value of the preset tip choice that's displayed to customers in the
163
- * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).
160
+ * 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)).
164
161
  * For example, `5`, `10`, and `15` percent or `1`, `3`, and `5` USD.
165
162
  *
166
163
  * Min: `0`
167
164
  */
168
165
  value?: number | null;
169
166
  /**
170
- * Whether this tip choice value is the dafault preset that's highlighted automatically in the
171
- * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).
167
+ * Whether this tip choice value is the default preset that's highlighted automatically in the
168
+ * 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)).
172
169
  *
173
170
  * Default: `false`
174
171
  */
@@ -318,7 +315,7 @@ export interface CreateTipSettingsResponse {
318
315
  tipSettings?: TipSettings;
319
316
  }
320
317
  export interface CreateDefaultTipSettingsRequest {
321
- /** Dafault tip settings to create. */
318
+ /** Default tip settings to create. */
322
319
  tipSettings: TipSettings;
323
320
  }
324
321
  export interface CreateDefaultTipSettingsResponse {
@@ -620,7 +617,7 @@ export declare function createTipSettings(tipSettings: TipSettings): Promise<Tip
620
617
  *
621
618
  *
622
619
  * The call fails if there is already an existing default `tipSettings` object.
623
- * @param tipSettings - Dafault tip settings to create.
620
+ * @param tipSettings - Default tip settings to create.
624
621
  * @public
625
622
  * @documentationMaturity preview
626
623
  * @requiredField tipSettings
@@ -221,7 +221,7 @@ exports.createTipSettings = createTipSettings;
221
221
  *
222
222
  *
223
223
  * The call fails if there is already an existing default `tipSettings` object.
224
- * @param tipSettings - Dafault tip settings to create.
224
+ * @param tipSettings - Default tip settings to create.
225
225
  * @public
226
226
  * @documentationMaturity preview
227
227
  * @requiredField tipSettings
@@ -1 +1 @@
1
- {"version":3,"file":"tips-settings-v1-tip-settings-tip-settings.universal.js","sourceRoot":"","sources":["../../../src/tips-settings-v1-tip-settings-tip-settings.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,kEAA8D;AAC9D,oFAGiD;AAEjD,6HAA+G;AA4J/G,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;AAiPD,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;AAuBD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAgB,gBAAgB;IAC9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,OAAO,IAAA,4BAAY,EAKjB;QACA,IAAI,EAAE,KAAK,EAAE,OAAgC,EAAE,EAAE;YAC/C,MAAM,OAAO,GACX,sCAAsC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEnE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QACD,kBAAkB,EAAE,CAAC,KAAuC,EAAE,EAAE;YAC9D,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,EAAE,CAA2C,CAAC;YACnE,OAAO,IAAA,8DAAqC,EAAC;gBAC3C,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;gBACZ,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;aACjB,CAAC,CAAC;QACL,CAAC;QACD,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAA0C,EAAE,EAAE;YACxE,MAAM,eAAe,GAAG,IAAA,gEAAuC,EAAC,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACL,KAAK,EAAE,eAAe,EAAE,WAAW;gBACnC,cAAc,EAAE,eAAe,EAAE,cAAc;aAChD,CAAC;QACJ,CAAC;QACD,gBAAgB,EAAE,CAAC,GAAY,EAAE,EAAE;YACjC,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EAAC,GAAG,EAAE;gBAC9C,sBAAsB,EAAE,EAAE;gBAC1B,wBAAwB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;gBAC3C,uBAAuB,EAAE,KAAK;aAC/B,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,EAAE;KACxB,CAAC,CAAC;AACL,CAAC;AAtDD,4CAsDC;AAqJD;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,iBAAiB,CACrC,WAAwB;IAExB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,WAAW,EAAE,WAAW;KACzB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,sCAAsC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEpE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,WAAY,CAAC;IAC5E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;YACjD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,aAAa,CAAC,CAChB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AApCD,8CAoCC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,iBAAiB,CACrC,WAAwB;IAExB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,WAAW,EAAE,WAAW;KACzB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,sCAAsC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEpE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,WAAY,CAAC;IAC5E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;YACjD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,aAAa,CAAC,CAChB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AApCD,8CAoCC;AAED;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,wBAAwB,CAC5C,WAAwB;IAKxB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,WAAW,EAAE,WAAW;KACzB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,sCAAsC,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAE3E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;YACjD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,aAAa,CAAC,CAChB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAvCD,4DAuCC;AAED;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,iBAAiB,CACrC,aAA4B;IAE5B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,sCAAsC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEpE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE;YACnD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAlCD,8CAkCC"}
1
+ {"version":3,"file":"tips-settings-v1-tip-settings-tip-settings.universal.js","sourceRoot":"","sources":["../../../src/tips-settings-v1-tip-settings-tip-settings.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,kEAA8D;AAC9D,oFAGiD;AAEjD,6HAA+G;AAyJ/G,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;AAiPD,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;AAuBD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAgB,gBAAgB;IAC9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,OAAO,IAAA,4BAAY,EAKjB;QACA,IAAI,EAAE,KAAK,EAAE,OAAgC,EAAE,EAAE;YAC/C,MAAM,OAAO,GACX,sCAAsC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEnE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QACD,kBAAkB,EAAE,CAAC,KAAuC,EAAE,EAAE;YAC9D,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,EAAE,CAA2C,CAAC;YACnE,OAAO,IAAA,8DAAqC,EAAC;gBAC3C,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;gBACZ,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;aACjB,CAAC,CAAC;QACL,CAAC;QACD,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAA0C,EAAE,EAAE;YACxE,MAAM,eAAe,GAAG,IAAA,gEAAuC,EAAC,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACL,KAAK,EAAE,eAAe,EAAE,WAAW;gBACnC,cAAc,EAAE,eAAe,EAAE,cAAc;aAChD,CAAC;QACJ,CAAC;QACD,gBAAgB,EAAE,CAAC,GAAY,EAAE,EAAE;YACjC,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EAAC,GAAG,EAAE;gBAC9C,sBAAsB,EAAE,EAAE;gBAC1B,wBAAwB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;gBAC3C,uBAAuB,EAAE,KAAK;aAC/B,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,EAAE;KACxB,CAAC,CAAC;AACL,CAAC;AAtDD,4CAsDC;AAqJD;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,iBAAiB,CACrC,WAAwB;IAExB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,WAAW,EAAE,WAAW;KACzB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,sCAAsC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEpE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,WAAY,CAAC;IAC5E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;YACjD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,aAAa,CAAC,CAChB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AApCD,8CAoCC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,iBAAiB,CACrC,WAAwB;IAExB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,WAAW,EAAE,WAAW;KACzB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,sCAAsC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEpE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,WAAY,CAAC;IAC5E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;YACjD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,aAAa,CAAC,CAChB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AApCD,8CAoCC;AAED;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,wBAAwB,CAC5C,WAAwB;IAKxB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,WAAW,EAAE,WAAW;KACzB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,sCAAsC,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAE3E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;YACjD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,aAAa,CAAC,CAChB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAvCD,4DAuCC;AAED;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,iBAAiB,CACrC,aAA4B;IAE5B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,sCAAsC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEpE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE;YACnD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAlCD,8CAkCC"}
@@ -57,7 +57,7 @@ interface CreateDefaultTipSettingsSignature {
57
57
  *
58
58
  *
59
59
  * The call fails if there is already an existing default `tipSettings` object.
60
- * @param - Dafault tip settings to create.
60
+ * @param - Default tip settings to create.
61
61
  */
62
62
  (tipSettings: TipSettings): Promise<CreateDefaultTipSettingsResponse & CreateDefaultTipSettingsResponseNonNullableFields>;
63
63
  }
@@ -2,12 +2,12 @@
2
2
  * Tip settings define how tips are calculated and distributed among staff. When
3
3
  * Wix Tips is installed, default settings are automatically created. You can't
4
4
  * delete these default settings but you can update them. Creating additional
5
- * settings allows business owners to customize tip screens for different payment
5
+ * settings allows Wix users to customize tip screens for different payment
6
6
  * terminals or set specific presets for various products or services.
7
7
  */
8
8
  export interface TipSettings extends TipSettingsIdentifierOneOf {
9
9
  /**
10
- * ID of the [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
10
+ * 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))
11
11
  * for which the tip settings apply.
12
12
  * @format GUID
13
13
  */
@@ -32,18 +32,11 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
32
32
  * @readonly
33
33
  */
34
34
  id?: string | null;
35
- /**
36
- * Tip type.
37
- *
38
- * Supported values:
39
- * + `UNKNOWN_TIP_TYPE`: There is no information about the tip type.
40
- * + `PERCENTAGE`: The tip is calculated as a percentage of the subtotal for all related line items.
41
- * + `AMOUNT`: The tip is a fixed amount.
42
- */
35
+ /** Tip type. */
43
36
  tipType?: TipType;
44
37
  /**
45
38
  * Information about the tip choices that Wix Tips displays to customers during the
46
- * [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).
39
+ * 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)).
47
40
  *
48
41
  * Min: `1` preset
49
42
  * Max: `3` presets
@@ -53,13 +46,13 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
53
46
  presets?: Preset[];
54
47
  /**
55
48
  * Whether customer are allowed to tip during the
56
- * [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).
49
+ * 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)).
57
50
  *
58
51
  * Default: `true`
59
52
  */
60
53
  allowCustomerTip?: boolean | null;
61
54
  /**
62
- * Whether the business owners are given the option to add a tip during the
55
+ * Whether the Wix users are given the option to add a tip during the
63
56
  * payment collection flow in their dashboard.
64
57
  *
65
58
  * Default: `true`
@@ -74,8 +67,8 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
74
67
  */
75
68
  allowCustomAmount?: boolean | null;
76
69
  /**
77
- * Whether business owners are allowed to edit tip distributions. If set to
78
- * `false`, owners can't edit distributions after they were created.
70
+ * Whether Wix users are allowed to edit tip distributions. If set to
71
+ * `false`, Wix users can't edit distributions after they were created.
79
72
  *
80
73
  * Default: `true`
81
74
  */
@@ -103,22 +96,24 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
103
96
  */
104
97
  createdDate?: Date | null;
105
98
  /**
106
- * Date and time the tip settings were last updated
99
+ * Date and time the tip settings were last updated in
107
100
  * `YYYY-MM-DDThh:mm:ss.sssZ` format.
108
101
  * @readonly
109
102
  */
110
103
  updatedDate?: Date | null;
111
104
  /**
112
- * Whether these are the default tip settings. Wix Tips automatically creates
113
- * the default settings during the app's installation. You can't delete these
114
- * default settings but you can update them. Wix Tips uses the default settings
105
+ * Whether these are the default tip settings.
106
+ *
107
+ * Wix Tips automatically creates the default settings during
108
+ * the app's installation. You can't delete these default settings
109
+ * but you can update them. Wix Tips uses the default settings
115
110
  * to calculate tips, unless you specify other settings.
116
111
  * @readonly
117
112
  */
118
113
  default?: boolean | null;
119
114
  /**
120
115
  * ID of the app that has created the settings. See the list of app IDs for
121
- * [Wix business solutions](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions).
116
+ * 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)).
122
117
  * @format GUID
123
118
  */
124
119
  appId?: string | null;
@@ -131,7 +126,7 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
131
126
  /** @oneof */
132
127
  export interface TipSettingsIdentifierOneOf {
133
128
  /**
134
- * ID of the [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
129
+ * 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))
135
130
  * for which the tip settings apply.
136
131
  * @format GUID
137
132
  */
@@ -162,15 +157,15 @@ export declare enum TipType {
162
157
  export interface Preset {
163
158
  /**
164
159
  * Value of the preset tip choice that's displayed to customers in the
165
- * [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).
160
+ * 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)).
166
161
  * For example, `5`, `10`, and `15` percent or `1`, `3`, and `5` USD.
167
162
  *
168
163
  * Min: `0`
169
164
  */
170
165
  value?: number | null;
171
166
  /**
172
- * Whether this tip choice value is the dafault preset that's highlighted automatically in the
173
- * [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).
167
+ * Whether this tip choice value is the default preset that's highlighted automatically in the
168
+ * 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)).
174
169
  *
175
170
  * Default: `false`
176
171
  */
@@ -320,7 +315,7 @@ export interface CreateTipSettingsResponse {
320
315
  tipSettings?: TipSettings;
321
316
  }
322
317
  export interface CreateDefaultTipSettingsRequest {
323
- /** Dafault tip settings to create. */
318
+ /** Default tip settings to create. */
324
319
  tipSettings: TipSettings;
325
320
  }
326
321
  export interface CreateDefaultTipSettingsResponse {
@@ -1 +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":"AA2JA,MAAM,CAAN,IAAY,OAOX;AAPD,WAAY,OAAO;IACjB,kDAAkD;IAClD,gDAAqC,CAAA;IACrC,uFAAuF;IACvF,oCAAyB,CAAA;IACzB,iCAAiC;IACjC,4BAAiB,CAAA;AACnB,CAAC,EAPW,OAAO,KAAP,OAAO,QAOlB;AAoBD,MAAM,CAAN,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,KAAvB,uBAAuB,QAOlC;AAuED,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAmPD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}
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":"AAsJA,MAAM,CAAN,IAAY,OAOX;AAPD,WAAY,OAAO;IACjB,kDAAkD;IAClD,gDAAqC,CAAA;IACrC,uFAAuF;IACvF,oCAAyB,CAAA;IACzB,iCAAiC;IACjC,4BAAiB,CAAA;AACnB,CAAC,EAPW,OAAO,KAAP,OAAO,QAOlB;AAoBD,MAAM,CAAN,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,KAAvB,uBAAuB,QAOlC;AAuED,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAmPD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}
@@ -2,12 +2,12 @@
2
2
  * Tip settings define how tips are calculated and distributed among staff. When
3
3
  * Wix Tips is installed, default settings are automatically created. You can't
4
4
  * delete these default settings but you can update them. Creating additional
5
- * settings allows business owners to customize tip screens for different payment
5
+ * settings allows Wix users to customize tip screens for different payment
6
6
  * terminals or set specific presets for various products or services.
7
7
  */
8
8
  export interface TipSettings extends TipSettingsIdentifierOneOf {
9
9
  /**
10
- * ID of the [location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
10
+ * 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))
11
11
  * for which the tip settings apply.
12
12
  * @format GUID
13
13
  */
@@ -32,18 +32,11 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
32
32
  * @readonly
33
33
  */
34
34
  _id?: string | null;
35
- /**
36
- * Tip type.
37
- *
38
- * Supported values:
39
- * + `UNKNOWN_TIP_TYPE`: There is no information about the tip type.
40
- * + `PERCENTAGE`: The tip is calculated as a percentage of the subtotal for all related line items.
41
- * + `AMOUNT`: The tip is a fixed amount.
42
- */
35
+ /** Tip type. */
43
36
  tipType?: TipType;
44
37
  /**
45
38
  * Information about the tip choices that Wix Tips displays to customers during the
46
- * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).
39
+ * 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)).
47
40
  *
48
41
  * Min: `1` preset
49
42
  * Max: `3` presets
@@ -53,11 +46,13 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
53
46
  presets?: Preset[];
54
47
  /**
55
48
  * Whether customer are allowed to tip during the
56
- * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).
49
+ * 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)).
50
+ *
51
+ * Default: `true`
57
52
  */
58
53
  allowCustomerTip?: boolean | null;
59
54
  /**
60
- * Whether the business owners are given the option to add a tip during the
55
+ * Whether the Wix users are given the option to add a tip during the
61
56
  * payment collection flow in their dashboard.
62
57
  *
63
58
  * Default: `true`
@@ -72,8 +67,8 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
72
67
  */
73
68
  allowCustomAmount?: boolean | null;
74
69
  /**
75
- * Whether business owners are allowed to edit tip distributions. If set to
76
- * `false`, owners can't edit distributions after they were created.
70
+ * Whether Wix users are allowed to edit tip distributions. If set to
71
+ * `false`, Wix users can't edit distributions after they were created.
77
72
  *
78
73
  * Default: `true`
79
74
  */
@@ -101,22 +96,24 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
101
96
  */
102
97
  _createdDate?: Date | null;
103
98
  /**
104
- * Date and time the tip settings were last updated
99
+ * Date and time the tip settings were last updated in
105
100
  * `YYYY-MM-DDThh:mm:ss.sssZ` format.
106
101
  * @readonly
107
102
  */
108
103
  _updatedDate?: Date | null;
109
104
  /**
110
- * Whether these are the default tip settings. Wix Tips automatically creates
111
- * the default settings during the app's installation. You can't delete these
112
- * default settings but you can update them. Wix Tips uses the default settings
105
+ * Whether these are the default tip settings.
106
+ *
107
+ * Wix Tips automatically creates the default settings during
108
+ * the app's installation. You can't delete these default settings
109
+ * but you can update them. Wix Tips uses the default settings
113
110
  * to calculate tips, unless you specify other settings.
114
111
  * @readonly
115
112
  */
116
113
  default?: boolean | null;
117
114
  /**
118
115
  * ID of the app that has created the settings. See the list of app IDs for
119
- * [Wix business solutions](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions).
116
+ * 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)).
120
117
  * @format GUID
121
118
  */
122
119
  appId?: string | null;
@@ -129,7 +126,7 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
129
126
  /** @oneof */
130
127
  export interface TipSettingsIdentifierOneOf {
131
128
  /**
132
- * ID of the [location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
129
+ * 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))
133
130
  * for which the tip settings apply.
134
131
  * @format GUID
135
132
  */
@@ -160,15 +157,15 @@ export declare enum TipType {
160
157
  export interface Preset {
161
158
  /**
162
159
  * Value of the preset tip choice that's displayed to customers in the
163
- * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).
160
+ * 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)).
164
161
  * For example, `5`, `10`, and `15` percent or `1`, `3`, and `5` USD.
165
162
  *
166
163
  * Min: `0`
167
164
  */
168
165
  value?: number | null;
169
166
  /**
170
- * Whether this tip choice value is the dafault preset that's highlighted automatically in the
171
- * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).
167
+ * Whether this tip choice value is the default preset that's highlighted automatically in the
168
+ * 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)).
172
169
  *
173
170
  * Default: `false`
174
171
  */
@@ -318,7 +315,7 @@ export interface CreateTipSettingsResponse {
318
315
  tipSettings?: TipSettings;
319
316
  }
320
317
  export interface CreateDefaultTipSettingsRequest {
321
- /** Dafault tip settings to create. */
318
+ /** Default tip settings to create. */
322
319
  tipSettings: TipSettings;
323
320
  }
324
321
  export interface CreateDefaultTipSettingsResponse {
@@ -620,7 +617,7 @@ export declare function createTipSettings(tipSettings: TipSettings): Promise<Tip
620
617
  *
621
618
  *
622
619
  * The call fails if there is already an existing default `tipSettings` object.
623
- * @param tipSettings - Dafault tip settings to create.
620
+ * @param tipSettings - Default tip settings to create.
624
621
  * @public
625
622
  * @documentationMaturity preview
626
623
  * @requiredField tipSettings
@@ -192,7 +192,7 @@ export async function createTipSettings(tipSettings) {
192
192
  *
193
193
  *
194
194
  * The call fails if there is already an existing default `tipSettings` object.
195
- * @param tipSettings - Dafault tip settings to create.
195
+ * @param tipSettings - Default tip settings to create.
196
196
  * @public
197
197
  * @documentationMaturity preview
198
198
  * @requiredField tipSettings