@wix/auto_sdk_ecom_tip-settings 1.0.0 → 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.
- package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.public.d.ts +1 -1
- package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.d.ts +102 -42
- package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.js.map +1 -1
- package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts +105 -43
- package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.js +1 -1
- package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.js.map +1 -1
- package/build/es/src/tips-settings-v1-tip-settings-tip-settings.public.d.ts +1 -1
- package/build/es/src/tips-settings-v1-tip-settings-tip-settings.types.d.ts +102 -42
- package/build/es/src/tips-settings-v1-tip-settings-tip-settings.types.js.map +1 -1
- package/build/es/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts +105 -43
- package/build/es/src/tips-settings-v1-tip-settings-tip-settings.universal.js +1 -1
- package/build/es/src/tips-settings-v1-tip-settings-tip-settings.universal.js.map +1 -1
- package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.public.d.ts +1 -1
- package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.d.ts +102 -42
- package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.js.map +1 -1
- package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts +105 -43
- package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.js +1 -1
- package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.js.map +1 -1
- package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.public.d.ts +1 -1
- package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.types.d.ts +102 -42
- package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.types.js.map +1 -1
- package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts +105 -43
- package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.universal.js +1 -1
- package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -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 -
|
|
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;
|
|
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 -
|
|
60
|
+
* @param - Default tip settings to create.
|
|
61
61
|
*/
|
|
62
62
|
(tipSettings: TipSettings): Promise<CreateDefaultTipSettingsResponse & CreateDefaultTipSettingsResponseNonNullableFields>;
|
|
63
63
|
}
|
|
@@ -2,13 +2,14 @@
|
|
|
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
|
|
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 [
|
|
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
|
+
* @format GUID
|
|
12
13
|
*/
|
|
13
14
|
locationId?: string | null;
|
|
14
15
|
/**
|
|
@@ -16,44 +17,42 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
|
|
|
16
17
|
* validate the ID you provide.
|
|
17
18
|
*
|
|
18
19
|
* Max: 30 characters
|
|
20
|
+
* @maxLength 30
|
|
19
21
|
*/
|
|
20
22
|
paymentTerminalId?: string | null;
|
|
21
23
|
/**
|
|
22
24
|
* ID of the Wix user for whom the tip settings apply. For example, the site owner or a
|
|
23
25
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
26
|
+
* @format GUID
|
|
24
27
|
*/
|
|
25
28
|
userId?: string | null;
|
|
26
29
|
/**
|
|
27
30
|
* ID of the tip settings.
|
|
31
|
+
* @format GUID
|
|
28
32
|
* @readonly
|
|
29
33
|
*/
|
|
30
34
|
id?: string | null;
|
|
31
|
-
/**
|
|
32
|
-
* Tip type.
|
|
33
|
-
*
|
|
34
|
-
* Supported values:
|
|
35
|
-
* + `UNKNOWN_TIP_TYPE`: There is no information about the tip type.
|
|
36
|
-
* + `PERCENTAGE`: The tip is calculated as a percentage of the subtotal for all related line items.
|
|
37
|
-
* + `AMOUNT`: The tip is a fixed amount.
|
|
38
|
-
*/
|
|
35
|
+
/** Tip type. */
|
|
39
36
|
tipType?: TipType;
|
|
40
37
|
/**
|
|
41
38
|
* Information about the tip choices that Wix Tips displays to customers during the
|
|
42
|
-
*
|
|
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)).
|
|
43
40
|
*
|
|
44
41
|
* Min: `1` preset
|
|
45
42
|
* Max: `3` presets
|
|
43
|
+
* @minSize 1
|
|
44
|
+
* @maxSize 3
|
|
46
45
|
*/
|
|
47
46
|
presets?: Preset[];
|
|
48
47
|
/**
|
|
49
48
|
* Whether customer are allowed to tip during the
|
|
50
|
-
*
|
|
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)).
|
|
51
50
|
*
|
|
52
51
|
* Default: `true`
|
|
53
52
|
*/
|
|
54
53
|
allowCustomerTip?: boolean | null;
|
|
55
54
|
/**
|
|
56
|
-
* Whether the
|
|
55
|
+
* Whether the Wix users are given the option to add a tip during the
|
|
57
56
|
* payment collection flow in their dashboard.
|
|
58
57
|
*
|
|
59
58
|
* Default: `true`
|
|
@@ -68,8 +67,8 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
|
|
|
68
67
|
*/
|
|
69
68
|
allowCustomAmount?: boolean | null;
|
|
70
69
|
/**
|
|
71
|
-
* Whether
|
|
72
|
-
* `false`,
|
|
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.
|
|
73
72
|
*
|
|
74
73
|
* Default: `true`
|
|
75
74
|
*/
|
|
@@ -97,22 +96,25 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
|
|
|
97
96
|
*/
|
|
98
97
|
createdDate?: Date | null;
|
|
99
98
|
/**
|
|
100
|
-
* Date and time the tip settings were last updated
|
|
99
|
+
* Date and time the tip settings were last updated in
|
|
101
100
|
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
102
101
|
* @readonly
|
|
103
102
|
*/
|
|
104
103
|
updatedDate?: Date | null;
|
|
105
104
|
/**
|
|
106
|
-
* Whether these are the default tip settings.
|
|
107
|
-
*
|
|
108
|
-
*
|
|
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
|
|
109
110
|
* to calculate tips, unless you specify other settings.
|
|
110
111
|
* @readonly
|
|
111
112
|
*/
|
|
112
113
|
default?: boolean | null;
|
|
113
114
|
/**
|
|
114
115
|
* ID of the app that has created the settings. See the list of app IDs for
|
|
115
|
-
*
|
|
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)).
|
|
117
|
+
* @format GUID
|
|
116
118
|
*/
|
|
117
119
|
appId?: string | null;
|
|
118
120
|
/**
|
|
@@ -124,8 +126,9 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
|
|
|
124
126
|
/** @oneof */
|
|
125
127
|
export interface TipSettingsIdentifierOneOf {
|
|
126
128
|
/**
|
|
127
|
-
* ID of the [
|
|
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))
|
|
128
130
|
* for which the tip settings apply.
|
|
131
|
+
* @format GUID
|
|
129
132
|
*/
|
|
130
133
|
locationId?: string | null;
|
|
131
134
|
/**
|
|
@@ -133,11 +136,13 @@ export interface TipSettingsIdentifierOneOf {
|
|
|
133
136
|
* validate the ID you provide.
|
|
134
137
|
*
|
|
135
138
|
* Max: 30 characters
|
|
139
|
+
* @maxLength 30
|
|
136
140
|
*/
|
|
137
141
|
paymentTerminalId?: string | null;
|
|
138
142
|
/**
|
|
139
143
|
* ID of the Wix user for whom the tip settings apply. For example, the site owner or a
|
|
140
144
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
145
|
+
* @format GUID
|
|
141
146
|
*/
|
|
142
147
|
userId?: string | null;
|
|
143
148
|
}
|
|
@@ -152,15 +157,15 @@ export declare enum TipType {
|
|
|
152
157
|
export interface Preset {
|
|
153
158
|
/**
|
|
154
159
|
* Value of the preset tip choice that's displayed to customers in the
|
|
155
|
-
*
|
|
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)).
|
|
156
161
|
* For example, `5`, `10`, and `15` percent or `1`, `3`, and `5` USD.
|
|
157
162
|
*
|
|
158
163
|
* Min: `0`
|
|
159
164
|
*/
|
|
160
165
|
value?: number | null;
|
|
161
166
|
/**
|
|
162
|
-
* Whether this tip choice value is the
|
|
163
|
-
*
|
|
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)).
|
|
164
169
|
*
|
|
165
170
|
* Default: `false`
|
|
166
171
|
*/
|
|
@@ -206,11 +211,20 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
206
211
|
/**
|
|
207
212
|
* Sort object in the following format:
|
|
208
213
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
214
|
+
* @maxSize 10
|
|
209
215
|
*/
|
|
210
216
|
sort?: Sorting[];
|
|
211
|
-
/**
|
|
217
|
+
/**
|
|
218
|
+
* 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.
|
|
219
|
+
* @maxLength 200
|
|
220
|
+
* @maxSize 10
|
|
221
|
+
*/
|
|
212
222
|
fields?: string[];
|
|
213
|
-
/**
|
|
223
|
+
/**
|
|
224
|
+
* 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.
|
|
225
|
+
* @maxLength 200
|
|
226
|
+
* @maxSize 10
|
|
227
|
+
*/
|
|
214
228
|
fieldsets?: string[];
|
|
215
229
|
}
|
|
216
230
|
/** @oneof */
|
|
@@ -221,7 +235,10 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
221
235
|
cursorPaging?: CursorPaging;
|
|
222
236
|
}
|
|
223
237
|
export interface Sorting {
|
|
224
|
-
/**
|
|
238
|
+
/**
|
|
239
|
+
* Name of the field to sort by.
|
|
240
|
+
* @maxLength 512
|
|
241
|
+
*/
|
|
225
242
|
fieldName?: string;
|
|
226
243
|
/** Sort order. */
|
|
227
244
|
order?: SortOrder;
|
|
@@ -237,13 +254,17 @@ export interface Paging {
|
|
|
237
254
|
offset?: number | null;
|
|
238
255
|
}
|
|
239
256
|
export interface CursorPaging {
|
|
240
|
-
/**
|
|
257
|
+
/**
|
|
258
|
+
* Maximum number of items to return in the results.
|
|
259
|
+
* @max 100
|
|
260
|
+
*/
|
|
241
261
|
limit?: number | null;
|
|
242
262
|
/**
|
|
243
263
|
* Pointer to the next or previous page in the list of results.
|
|
244
264
|
*
|
|
245
265
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
246
266
|
* Not relevant for the first request.
|
|
267
|
+
* @maxLength 16000
|
|
247
268
|
*/
|
|
248
269
|
cursor?: string | null;
|
|
249
270
|
}
|
|
@@ -266,9 +287,15 @@ export interface PagingMetadataV2 {
|
|
|
266
287
|
cursors?: Cursors;
|
|
267
288
|
}
|
|
268
289
|
export interface Cursors {
|
|
269
|
-
/**
|
|
290
|
+
/**
|
|
291
|
+
* Cursor string pointing to the next page in the list of results.
|
|
292
|
+
* @maxLength 16000
|
|
293
|
+
*/
|
|
270
294
|
next?: string | null;
|
|
271
|
-
/**
|
|
295
|
+
/**
|
|
296
|
+
* Cursor pointing to the previous page in the list of results.
|
|
297
|
+
* @maxLength 16000
|
|
298
|
+
*/
|
|
272
299
|
prev?: string | null;
|
|
273
300
|
}
|
|
274
301
|
export interface UpdateTipSettingsRequest {
|
|
@@ -288,7 +315,7 @@ export interface CreateTipSettingsResponse {
|
|
|
288
315
|
tipSettings?: TipSettings;
|
|
289
316
|
}
|
|
290
317
|
export interface CreateDefaultTipSettingsRequest {
|
|
291
|
-
/**
|
|
318
|
+
/** Default tip settings to create. */
|
|
292
319
|
tipSettings: TipSettings;
|
|
293
320
|
}
|
|
294
321
|
export interface CreateDefaultTipSettingsResponse {
|
|
@@ -296,7 +323,10 @@ export interface CreateDefaultTipSettingsResponse {
|
|
|
296
323
|
tipSettings?: TipSettings;
|
|
297
324
|
}
|
|
298
325
|
export interface DeleteTipSettingsRequest {
|
|
299
|
-
/**
|
|
326
|
+
/**
|
|
327
|
+
* ID of the `tipSettings` object to delete.
|
|
328
|
+
* @format GUID
|
|
329
|
+
*/
|
|
300
330
|
tipSettingsId: string | null;
|
|
301
331
|
}
|
|
302
332
|
export interface DeleteTipSettingsResponse {
|
|
@@ -374,9 +404,15 @@ export interface ActionEvent {
|
|
|
374
404
|
bodyAsJson?: string;
|
|
375
405
|
}
|
|
376
406
|
export interface MessageEnvelope {
|
|
377
|
-
/**
|
|
407
|
+
/**
|
|
408
|
+
* App instance ID.
|
|
409
|
+
* @format GUID
|
|
410
|
+
*/
|
|
378
411
|
instanceId?: string | null;
|
|
379
|
-
/**
|
|
412
|
+
/**
|
|
413
|
+
* Event type.
|
|
414
|
+
* @maxLength 150
|
|
415
|
+
*/
|
|
380
416
|
eventType?: string;
|
|
381
417
|
/** The identification type and identity data. */
|
|
382
418
|
identity?: IdentificationData;
|
|
@@ -384,26 +420,50 @@ export interface MessageEnvelope {
|
|
|
384
420
|
data?: string;
|
|
385
421
|
}
|
|
386
422
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
387
|
-
/**
|
|
423
|
+
/**
|
|
424
|
+
* ID of a site visitor that has not logged in to the site.
|
|
425
|
+
* @format GUID
|
|
426
|
+
*/
|
|
388
427
|
anonymousVisitorId?: string;
|
|
389
|
-
/**
|
|
428
|
+
/**
|
|
429
|
+
* ID of a site visitor that has logged in to the site.
|
|
430
|
+
* @format GUID
|
|
431
|
+
*/
|
|
390
432
|
memberId?: string;
|
|
391
|
-
/**
|
|
433
|
+
/**
|
|
434
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
435
|
+
* @format GUID
|
|
436
|
+
*/
|
|
392
437
|
wixUserId?: string;
|
|
393
|
-
/**
|
|
438
|
+
/**
|
|
439
|
+
* ID of an app.
|
|
440
|
+
* @format GUID
|
|
441
|
+
*/
|
|
394
442
|
appId?: string;
|
|
395
443
|
/** @readonly */
|
|
396
444
|
identityType?: WebhookIdentityType;
|
|
397
445
|
}
|
|
398
446
|
/** @oneof */
|
|
399
447
|
export interface IdentificationDataIdOneOf {
|
|
400
|
-
/**
|
|
448
|
+
/**
|
|
449
|
+
* ID of a site visitor that has not logged in to the site.
|
|
450
|
+
* @format GUID
|
|
451
|
+
*/
|
|
401
452
|
anonymousVisitorId?: string;
|
|
402
|
-
/**
|
|
453
|
+
/**
|
|
454
|
+
* ID of a site visitor that has logged in to the site.
|
|
455
|
+
* @format GUID
|
|
456
|
+
*/
|
|
403
457
|
memberId?: string;
|
|
404
|
-
/**
|
|
458
|
+
/**
|
|
459
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
460
|
+
* @format GUID
|
|
461
|
+
*/
|
|
405
462
|
wixUserId?: string;
|
|
406
|
-
/**
|
|
463
|
+
/**
|
|
464
|
+
* ID of an app.
|
|
465
|
+
* @format GUID
|
|
466
|
+
*/
|
|
407
467
|
appId?: string;
|
|
408
468
|
}
|
|
409
469
|
export declare enum WebhookIdentityType {
|
|
@@ -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":"
|
|
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"}
|