@wix/auto_sdk_ecom_tip-settings 1.0.8 → 1.0.9

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 (129) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.context.d.ts +9 -0
  11. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.context.js +16 -0
  12. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.context.js.map +1 -0
  13. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.http.d.ts +48 -0
  14. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.http.js +274 -0
  15. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.http.js.map +1 -0
  16. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.meta.d.ts +19 -0
  17. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.meta.js +123 -0
  18. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.meta.js.map +1 -0
  19. package/build/{index.d.ts → cjs/src/tips-settings-v1-tip-settings-tip-settings.public.d.ts} +11 -17
  20. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.public.js +41 -0
  21. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.public.js.map +1 -0
  22. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.d.ts +475 -0
  23. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.js +35 -0
  24. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.js.map +1 -0
  25. package/build/{internal/tips-settings-v1-tip-settings-tip-settings.universal-BvU_OtgN.d.mts → cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts} +146 -39
  26. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.js +300 -0
  27. package/build/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.context.d.ts +9 -0
  38. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.context.js +9 -0
  39. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.context.js.map +1 -0
  40. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.http.d.ts +48 -0
  41. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.http.js +266 -0
  42. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.http.js.map +1 -0
  43. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.meta.d.ts +19 -0
  44. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.meta.js +92 -0
  45. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.meta.js.map +1 -0
  46. package/build/{internal/index.d.ts → es/src/tips-settings-v1-tip-settings-tip-settings.public.d.ts} +11 -17
  47. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.public.js +29 -0
  48. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.public.js.map +1 -0
  49. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.types.d.ts +475 -0
  50. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.types.js +32 -0
  51. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.types.js.map +1 -0
  52. package/build/{tips-settings-v1-tip-settings-tip-settings.universal-BvU_OtgN.d.mts → es/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts} +146 -39
  53. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.universal.js +269 -0
  54. package/build/es/src/tips-settings-v1-tip-settings-tip-settings.universal.js.map +1 -0
  55. package/build/internal/cjs/index.d.ts +1 -0
  56. package/build/internal/cjs/index.js +18 -0
  57. package/build/internal/cjs/index.js.map +1 -0
  58. package/build/internal/cjs/index.typings.d.ts +1 -0
  59. package/build/internal/cjs/index.typings.js +18 -0
  60. package/build/internal/cjs/index.typings.js.map +1 -0
  61. package/build/internal/cjs/meta.d.ts +1 -0
  62. package/build/internal/cjs/meta.js +18 -0
  63. package/build/internal/cjs/meta.js.map +1 -0
  64. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.context.d.ts +9 -0
  65. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.context.js +16 -0
  66. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.context.js.map +1 -0
  67. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.http.d.ts +48 -0
  68. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.http.js +274 -0
  69. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.http.js.map +1 -0
  70. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.meta.d.ts +19 -0
  71. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.meta.js +123 -0
  72. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.meta.js.map +1 -0
  73. package/build/{index.d.mts → internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.public.d.ts} +11 -17
  74. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.public.js +41 -0
  75. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.public.js.map +1 -0
  76. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.d.ts +475 -0
  77. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.js +35 -0
  78. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.types.js.map +1 -0
  79. package/build/{tips-settings-v1-tip-settings-tip-settings.universal-BvU_OtgN.d.ts → internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts} +146 -39
  80. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.js +300 -0
  81. package/build/internal/cjs/src/tips-settings-v1-tip-settings-tip-settings.universal.js.map +1 -0
  82. package/build/internal/es/index.d.ts +1 -0
  83. package/build/internal/es/index.js +2 -0
  84. package/build/internal/es/index.js.map +1 -0
  85. package/build/internal/es/index.typings.d.ts +1 -0
  86. package/build/internal/es/index.typings.js +2 -0
  87. package/build/internal/es/index.typings.js.map +1 -0
  88. package/build/internal/es/meta.d.ts +1 -0
  89. package/build/internal/es/meta.js +2 -0
  90. package/build/internal/es/meta.js.map +1 -0
  91. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.context.d.ts +9 -0
  92. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.context.js +9 -0
  93. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.context.js.map +1 -0
  94. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.http.d.ts +48 -0
  95. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.http.js +266 -0
  96. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.http.js.map +1 -0
  97. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.meta.d.ts +19 -0
  98. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.meta.js +92 -0
  99. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.meta.js.map +1 -0
  100. package/build/internal/{index.d.mts → es/src/tips-settings-v1-tip-settings-tip-settings.public.d.ts} +11 -17
  101. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.public.js +29 -0
  102. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.public.js.map +1 -0
  103. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.types.d.ts +475 -0
  104. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.types.js +32 -0
  105. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.types.js.map +1 -0
  106. package/build/internal/{tips-settings-v1-tip-settings-tip-settings.universal-BvU_OtgN.d.ts → es/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts} +146 -39
  107. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.universal.js +269 -0
  108. package/build/internal/es/src/tips-settings-v1-tip-settings-tip-settings.universal.js.map +1 -0
  109. package/package.json +11 -12
  110. package/build/index.js +0 -487
  111. package/build/index.js.map +0 -1
  112. package/build/index.mjs +0 -455
  113. package/build/index.mjs.map +0 -1
  114. package/build/internal/index.js +0 -487
  115. package/build/internal/index.js.map +0 -1
  116. package/build/internal/index.mjs +0 -455
  117. package/build/internal/index.mjs.map +0 -1
  118. package/build/internal/meta.d.mts +0 -355
  119. package/build/internal/meta.d.ts +0 -355
  120. package/build/internal/meta.js +0 -355
  121. package/build/internal/meta.js.map +0 -1
  122. package/build/internal/meta.mjs +0 -324
  123. package/build/internal/meta.mjs.map +0 -1
  124. package/build/meta.d.mts +0 -355
  125. package/build/meta.d.ts +0 -355
  126. package/build/meta.js +0 -355
  127. package/build/meta.js.map +0 -1
  128. package/build/meta.mjs +0 -324
  129. package/build/meta.mjs.map +0 -1
@@ -1,8 +1,9 @@
1
- import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
2
- import { T as TipSettingsQueryBuilder, a as TipSettings, C as CreateDefaultTipSettingsResponse } from './tips-settings-v1-tip-settings-tip-settings.universal-BvU_OtgN.js';
3
- export { A as ActionEvent, p as CreateDefaultTipSettingsRequest, n as CreateTipSettingsRequest, o as CreateTipSettingsResponse, i as CursorPaging, l as Cursors, D as DeleteTipSettingsRequest, q as DeleteTipSettingsResponse, r as DomainEvent, s as DomainEventBodyOneOf, t as EntityCreatedEvent, v as EntityDeletedEvent, u as EntityUpdatedEvent, E as ExtendedFields, I as IdentificationData, w as IdentificationDataIdOneOf, M as MessageEnvelope, h as Paging, k as PagingMetadataV2, P as Preset, Q as QueryTipSettingsRequest, j as QueryTipSettingsResponse, e as QueryV2, f as QueryV2PagingMethodOneOf, R as RestoreInfo, c as SortOrder, g as Sorting, S as StaffDistributionMethod, d as TipSettingsIdentifierOneOf, x as TipSettingsQueryResult, b as TipType, U as UpdateTipSettingsRequest, m as UpdateTipSettingsResponse, W as WebhookIdentityType } from './tips-settings-v1-tip-settings-tip-settings.universal-BvU_OtgN.js';
4
-
5
- declare function queryTipSettings$1(httpClient: HttpClient): QueryTipSettingsSignature;
1
+ import { HttpClient } from '@wix/sdk-types';
2
+ import { CreateDefaultTipSettingsResponse, TipSettings, TipSettingsQueryBuilder } from './tips-settings-v1-tip-settings-tip-settings.universal.js';
3
+ export declare const __metadata: {
4
+ PACKAGE_NAME: string;
5
+ };
6
+ export declare function queryTipSettings(httpClient: HttpClient): QueryTipSettingsSignature;
6
7
  interface QueryTipSettingsSignature {
7
8
  /**
8
9
  * Creates a query to retrieve a list of tip settings.
@@ -24,7 +25,7 @@ interface QueryTipSettingsSignature {
24
25
  */
25
26
  (): TipSettingsQueryBuilder;
26
27
  }
27
- declare function updateTipSettings$1(httpClient: HttpClient): UpdateTipSettingsSignature;
28
+ export declare function updateTipSettings(httpClient: HttpClient): UpdateTipSettingsSignature;
28
29
  interface UpdateTipSettingsSignature {
29
30
  /**
30
31
  * Updates a `tipSettings` object.
@@ -37,7 +38,7 @@ interface UpdateTipSettingsSignature {
37
38
  */
38
39
  (tipSettings: TipSettings): Promise<TipSettings>;
39
40
  }
40
- declare function createTipSettings$1(httpClient: HttpClient): CreateTipSettingsSignature;
41
+ export declare function createTipSettings(httpClient: HttpClient): CreateTipSettingsSignature;
41
42
  interface CreateTipSettingsSignature {
42
43
  /**
43
44
  * Creates a `tipSettings` object.
@@ -49,7 +50,7 @@ interface CreateTipSettingsSignature {
49
50
  */
50
51
  (tipSettings: TipSettings): Promise<TipSettings>;
51
52
  }
52
- declare function createDefaultTipSettings$1(httpClient: HttpClient): CreateDefaultTipSettingsSignature;
53
+ export declare function createDefaultTipSettings(httpClient: HttpClient): CreateDefaultTipSettingsSignature;
53
54
  interface CreateDefaultTipSettingsSignature {
54
55
  /**
55
56
  * Creates a default `tipSettings` object.
@@ -60,7 +61,7 @@ interface CreateDefaultTipSettingsSignature {
60
61
  */
61
62
  (tipSettings: TipSettings): Promise<CreateDefaultTipSettingsResponse>;
62
63
  }
63
- declare function deleteTipSettings$1(httpClient: HttpClient): DeleteTipSettingsSignature;
64
+ export declare function deleteTipSettings(httpClient: HttpClient): DeleteTipSettingsSignature;
64
65
  interface DeleteTipSettingsSignature {
65
66
  /**
66
67
  * Deletes a `tipSettings` object.
@@ -71,11 +72,4 @@ interface DeleteTipSettingsSignature {
71
72
  */
72
73
  (tipSettingsId: string): Promise<void>;
73
74
  }
74
-
75
- declare const queryTipSettings: MaybeContext<BuildRESTFunction<typeof queryTipSettings$1> & typeof queryTipSettings$1>;
76
- declare const updateTipSettings: MaybeContext<BuildRESTFunction<typeof updateTipSettings$1> & typeof updateTipSettings$1>;
77
- declare const createTipSettings: MaybeContext<BuildRESTFunction<typeof createTipSettings$1> & typeof createTipSettings$1>;
78
- declare const createDefaultTipSettings: MaybeContext<BuildRESTFunction<typeof createDefaultTipSettings$1> & typeof createDefaultTipSettings$1>;
79
- declare const deleteTipSettings: MaybeContext<BuildRESTFunction<typeof deleteTipSettings$1> & typeof deleteTipSettings$1>;
80
-
81
- export { CreateDefaultTipSettingsResponse, TipSettings, TipSettingsQueryBuilder, createDefaultTipSettings, createTipSettings, deleteTipSettings, queryTipSettings, updateTipSettings };
75
+ export { ActionEvent, CreateDefaultTipSettingsRequest, CreateDefaultTipSettingsResponse, CreateTipSettingsRequest, CreateTipSettingsResponse, CursorPaging, Cursors, DeleteTipSettingsRequest, DeleteTipSettingsResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, Paging, PagingMetadataV2, Preset, QueryTipSettingsRequest, QueryTipSettingsResponse, QueryV2, QueryV2PagingMethodOneOf, RestoreInfo, SortOrder, Sorting, StaffDistributionMethod, TipSettings, TipSettingsIdentifierOneOf, TipSettingsQueryBuilder, TipSettingsQueryResult, TipType, UpdateTipSettingsRequest, UpdateTipSettingsResponse, WebhookIdentityType, } from './tips-settings-v1-tip-settings-tip-settings.universal.js';
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.WebhookIdentityType = exports.TipType = exports.StaffDistributionMethod = exports.SortOrder = exports.deleteTipSettings = exports.createDefaultTipSettings = exports.createTipSettings = exports.updateTipSettings = exports.queryTipSettings = exports.__metadata = void 0;
4
+ const tips_settings_v1_tip_settings_tip_settings_universal_js_1 = require("./tips-settings-v1-tip-settings-tip-settings.universal.js");
5
+ exports.__metadata = { PACKAGE_NAME: '@wix/ecom' };
6
+ function queryTipSettings(httpClient) {
7
+ return () => (0, tips_settings_v1_tip_settings_tip_settings_universal_js_1.queryTipSettings)(
8
+ // @ts-ignore
9
+ { httpClient });
10
+ }
11
+ exports.queryTipSettings = queryTipSettings;
12
+ function updateTipSettings(httpClient) {
13
+ return (tipSettings) => (0, tips_settings_v1_tip_settings_tip_settings_universal_js_1.updateTipSettings)(tipSettings,
14
+ // @ts-ignore
15
+ { httpClient });
16
+ }
17
+ exports.updateTipSettings = updateTipSettings;
18
+ function createTipSettings(httpClient) {
19
+ return (tipSettings) => (0, tips_settings_v1_tip_settings_tip_settings_universal_js_1.createTipSettings)(tipSettings,
20
+ // @ts-ignore
21
+ { httpClient });
22
+ }
23
+ exports.createTipSettings = createTipSettings;
24
+ function createDefaultTipSettings(httpClient) {
25
+ return (tipSettings) => (0, tips_settings_v1_tip_settings_tip_settings_universal_js_1.createDefaultTipSettings)(tipSettings,
26
+ // @ts-ignore
27
+ { httpClient });
28
+ }
29
+ exports.createDefaultTipSettings = createDefaultTipSettings;
30
+ function deleteTipSettings(httpClient) {
31
+ return (tipSettingsId) => (0, tips_settings_v1_tip_settings_tip_settings_universal_js_1.deleteTipSettings)(tipSettingsId,
32
+ // @ts-ignore
33
+ { httpClient });
34
+ }
35
+ exports.deleteTipSettings = deleteTipSettings;
36
+ var tips_settings_v1_tip_settings_tip_settings_universal_js_2 = require("./tips-settings-v1-tip-settings-tip-settings.universal.js");
37
+ Object.defineProperty(exports, "SortOrder", { enumerable: true, get: function () { return tips_settings_v1_tip_settings_tip_settings_universal_js_2.SortOrder; } });
38
+ Object.defineProperty(exports, "StaffDistributionMethod", { enumerable: true, get: function () { return tips_settings_v1_tip_settings_tip_settings_universal_js_2.StaffDistributionMethod; } });
39
+ Object.defineProperty(exports, "TipType", { enumerable: true, get: function () { return tips_settings_v1_tip_settings_tip_settings_universal_js_2.TipType; } });
40
+ Object.defineProperty(exports, "WebhookIdentityType", { enumerable: true, get: function () { return tips_settings_v1_tip_settings_tip_settings_universal_js_2.WebhookIdentityType; } });
41
+ //# sourceMappingURL=tips-settings-v1-tip-settings-tip-settings.public.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tips-settings-v1-tip-settings-tip-settings.public.js","sourceRoot":"","sources":["../../../src/tips-settings-v1-tip-settings-tip-settings.public.ts"],"names":[],"mappings":";;;AACA,uIASmE;AAEtD,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,SAAgB,gBAAgB,CAC9B,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,IAAA,0EAAyB;IACvB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,4CAQC;AAwBD,SAAgB,iBAAiB,CAC/B,UAAsB;IAEtB,OAAO,CAAC,WAAwB,EAAE,EAAE,CAClC,IAAA,2EAA0B,EACxB,WAAW;IACX,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,8CASC;AAeD,SAAgB,iBAAiB,CAC/B,UAAsB;IAEtB,OAAO,CAAC,WAAwB,EAAE,EAAE,CAClC,IAAA,2EAA0B,EACxB,WAAW;IACX,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,8CASC;AAcD,SAAgB,wBAAwB,CACtC,UAAsB;IAEtB,OAAO,CAAC,WAAwB,EAAE,EAAE,CAClC,IAAA,kFAAiC,EAC/B,WAAW;IACX,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,4DASC;AAaD,SAAgB,iBAAiB,CAC/B,UAAsB;IAEtB,OAAO,CAAC,aAAqB,EAAE,EAAE,CAC/B,IAAA,2EAA0B,EACxB,aAAa;IACb,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,8CASC;AAaD,qIAsCmE;AAXjE,oJAAA,SAAS,OAAA;AAET,kKAAA,uBAAuB,OAAA;AAKvB,kJAAA,OAAO,OAAA;AAGP,8JAAA,mBAAmB,OAAA"}
@@ -0,0 +1,475 @@
1
+ /**
2
+ * Tip settings define how tips are calculated and distributed among staff. When
3
+ * Wix Tips is installed, default settings are automatically created. You can't
4
+ * delete these default settings but you can update them. Creating additional
5
+ * settings allows Wix users to customize tip screens for different payment
6
+ * terminals or set specific presets for various products or services.
7
+ */
8
+ export interface TipSettings extends TipSettingsIdentifierOneOf {
9
+ /**
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
+ * for which the tip settings apply.
12
+ * @format GUID
13
+ */
14
+ locationId?: string | null;
15
+ /**
16
+ * ID of the payment terminal for which the tip settings apply. Wix Tips doesn't
17
+ * validate the ID you provide.
18
+ *
19
+ * Max: 30 characters
20
+ * @maxLength 30
21
+ */
22
+ paymentTerminalId?: string | null;
23
+ /**
24
+ * ID of the Wix user for whom the tip settings apply. For example, the site owner or a
25
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
26
+ * @format GUID
27
+ */
28
+ userId?: string | null;
29
+ /**
30
+ * ID of the tip settings.
31
+ * @format GUID
32
+ * @readonly
33
+ */
34
+ id?: string | null;
35
+ /** Tip type. */
36
+ tipType?: TipType;
37
+ /**
38
+ * Information about the tip choices that Wix Tips displays to customers during the
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)).
40
+ *
41
+ * Min: `1` preset
42
+ * Max: `3` presets
43
+ * @minSize 1
44
+ * @maxSize 3
45
+ */
46
+ presets?: Preset[];
47
+ /**
48
+ * Whether customer are allowed to tip during the
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`
52
+ */
53
+ allowCustomerTip?: boolean | null;
54
+ /**
55
+ * Whether the Wix users are given the option to add a tip during the
56
+ * payment collection flow in their dashboard.
57
+ *
58
+ * Default: `true`
59
+ */
60
+ allowBusinessTipAtPayment?: boolean | null;
61
+ /**
62
+ * Whether customers can enter a custom tip amount. If set to `false`, customers
63
+ * can only select a tip value from the available `presets` and can't enter a
64
+ * custom amount.
65
+ *
66
+ * Default: `true`
67
+ */
68
+ allowCustomAmount?: boolean | null;
69
+ /**
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.
72
+ *
73
+ * Default: `true`
74
+ */
75
+ allowEditDistribution?: boolean | null;
76
+ /**
77
+ * How the tip is distributed among staff.
78
+ *
79
+ * Supported values:
80
+ * `UNKNOWN_SPLIT_METHOD`: There is no information about the staff distribution method.
81
+ * `EQUAL`: The tip is distributed equally among all staff.
82
+ * `PROPORTIONAL`: The tip is distributed proportionally among staff.
83
+ */
84
+ staffDistributionMethod?: StaffDistributionMethod;
85
+ /**
86
+ * Revision number, which increments by 1 each time `tipSettings` object is
87
+ * updated. To prevent conflicting changes, the current revision must be passed
88
+ * when updating `tipSettings`. Ignored when creating a `tipSettings` object.
89
+ * @readonly
90
+ */
91
+ revision?: string | null;
92
+ /**
93
+ * Date and time the tip settings were created in
94
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
95
+ * @readonly
96
+ */
97
+ createdDate?: Date | null;
98
+ /**
99
+ * Date and time the tip settings were last updated in
100
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
101
+ * @readonly
102
+ */
103
+ updatedDate?: Date | null;
104
+ /**
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
110
+ * to calculate tips, unless you specify other settings.
111
+ * @readonly
112
+ */
113
+ default?: boolean | null;
114
+ /**
115
+ * ID of the app that has created the settings. See the list of app IDs for
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
118
+ */
119
+ appId?: string | null;
120
+ /**
121
+ * Custom field data for the `tipSettings` object. Extended fields must be
122
+ * configured in the app dashboard before they can be accessed with API calls.
123
+ */
124
+ extendedFields?: ExtendedFields;
125
+ }
126
+ /** @oneof */
127
+ export interface TipSettingsIdentifierOneOf {
128
+ /**
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))
130
+ * for which the tip settings apply.
131
+ * @format GUID
132
+ */
133
+ locationId?: string | null;
134
+ /**
135
+ * ID of the payment terminal for which the tip settings apply. Wix Tips doesn't
136
+ * validate the ID you provide.
137
+ *
138
+ * Max: 30 characters
139
+ * @maxLength 30
140
+ */
141
+ paymentTerminalId?: string | null;
142
+ /**
143
+ * ID of the Wix user for whom the tip settings apply. For example, the site owner or a
144
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
145
+ * @format GUID
146
+ */
147
+ userId?: string | null;
148
+ }
149
+ export declare enum TipType {
150
+ /** There is no information about the tip type. */
151
+ UNKNOWN_TIP_TYPE = "UNKNOWN_TIP_TYPE",
152
+ /** The tip is calculated as a percentage of the subtotal of all related line items. */
153
+ PERCENTAGE = "PERCENTAGE",
154
+ /** The tip is a fixed amount. */
155
+ AMOUNT = "AMOUNT"
156
+ }
157
+ export interface Preset {
158
+ /**
159
+ * Value of the preset tip choice that's displayed to customers in the
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)).
161
+ * For example, `5`, `10`, and `15` percent or `1`, `3`, and `5` USD.
162
+ *
163
+ * Min: `0`
164
+ */
165
+ value?: number | null;
166
+ /**
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)).
169
+ *
170
+ * Default: `false`
171
+ */
172
+ default?: boolean | null;
173
+ }
174
+ export declare enum StaffDistributionMethod {
175
+ /** There is no information about the staff distribution method. */
176
+ UNKNOWN_SPLIT_METHOD = "UNKNOWN_SPLIT_METHOD",
177
+ /** All staff receive an equal amount of the tip. */
178
+ EQUAL = "EQUAL",
179
+ /** Staff receive a proportional amount of the tip. */
180
+ PROPORTIONAL = "PROPORTIONAL"
181
+ }
182
+ export interface ExtendedFields {
183
+ /**
184
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
185
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
186
+ *
187
+ * You can only access fields for which you have the appropriate permissions.
188
+ *
189
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
190
+ */
191
+ namespaces?: Record<string, Record<string, any>>;
192
+ }
193
+ export interface QueryTipSettingsRequest {
194
+ /** WQL expression */
195
+ query: QueryV2;
196
+ }
197
+ export interface QueryV2 extends QueryV2PagingMethodOneOf {
198
+ /** Paging options to limit and skip the number of items. */
199
+ paging?: Paging;
200
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
201
+ cursorPaging?: CursorPaging;
202
+ /**
203
+ * Filter object in the following format:
204
+ * `"filter" : {
205
+ * "fieldName1": "value1",
206
+ * "fieldName2":{"$operator":"value2"}
207
+ * }`
208
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
209
+ */
210
+ filter?: Record<string, any> | null;
211
+ /**
212
+ * Sort object in the following format:
213
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
214
+ * @maxSize 10
215
+ */
216
+ sort?: Sorting[];
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
+ */
222
+ fields?: string[];
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
+ */
228
+ fieldsets?: string[];
229
+ }
230
+ /** @oneof */
231
+ export interface QueryV2PagingMethodOneOf {
232
+ /** Paging options to limit and skip the number of items. */
233
+ paging?: Paging;
234
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
235
+ cursorPaging?: CursorPaging;
236
+ }
237
+ export interface Sorting {
238
+ /**
239
+ * Name of the field to sort by.
240
+ * @maxLength 512
241
+ */
242
+ fieldName?: string;
243
+ /** Sort order. */
244
+ order?: SortOrder;
245
+ }
246
+ export declare enum SortOrder {
247
+ ASC = "ASC",
248
+ DESC = "DESC"
249
+ }
250
+ export interface Paging {
251
+ /** Number of items to load. */
252
+ limit?: number | null;
253
+ /** Number of items to skip in the current sort order. */
254
+ offset?: number | null;
255
+ }
256
+ export interface CursorPaging {
257
+ /**
258
+ * Maximum number of items to return in the results.
259
+ * @max 100
260
+ */
261
+ limit?: number | null;
262
+ /**
263
+ * Pointer to the next or previous page in the list of results.
264
+ *
265
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
266
+ * Not relevant for the first request.
267
+ * @maxLength 16000
268
+ */
269
+ cursor?: string | null;
270
+ }
271
+ export interface QueryTipSettingsResponse {
272
+ /** Retrieved `tipSettings` objects. */
273
+ tipSettings?: TipSettings[];
274
+ /** Metadate for the paged set of retrieved `tipSettings` objects. */
275
+ pagingMetadata?: PagingMetadataV2;
276
+ }
277
+ export interface PagingMetadataV2 {
278
+ /** Number of items returned in the response. */
279
+ count?: number | null;
280
+ /** Offset that was requested. */
281
+ offset?: number | null;
282
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
283
+ total?: number | null;
284
+ /** Flag that indicates the server failed to calculate the `total` field. */
285
+ tooManyToCount?: boolean | null;
286
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
287
+ cursors?: Cursors;
288
+ }
289
+ export interface Cursors {
290
+ /**
291
+ * Cursor string pointing to the next page in the list of results.
292
+ * @maxLength 16000
293
+ */
294
+ next?: string | null;
295
+ /**
296
+ * Cursor pointing to the previous page in the list of results.
297
+ * @maxLength 16000
298
+ */
299
+ prev?: string | null;
300
+ }
301
+ export interface UpdateTipSettingsRequest {
302
+ /** Tip settings to update. */
303
+ tipSettings: TipSettings;
304
+ }
305
+ export interface UpdateTipSettingsResponse {
306
+ /** Updated tip settings. */
307
+ tipSettings?: TipSettings;
308
+ }
309
+ export interface CreateTipSettingsRequest {
310
+ /** Tip settings to create. */
311
+ tipSettings: TipSettings;
312
+ }
313
+ export interface CreateTipSettingsResponse {
314
+ /** Created tip settings. */
315
+ tipSettings?: TipSettings;
316
+ }
317
+ export interface CreateDefaultTipSettingsRequest {
318
+ /** Default tip settings to create. */
319
+ tipSettings: TipSettings;
320
+ }
321
+ export interface CreateDefaultTipSettingsResponse {
322
+ /** Created default tip settings. */
323
+ tipSettings?: TipSettings;
324
+ }
325
+ export interface DeleteTipSettingsRequest {
326
+ /**
327
+ * ID of the `tipSettings` object to delete.
328
+ * @format GUID
329
+ */
330
+ tipSettingsId: string | null;
331
+ }
332
+ export interface DeleteTipSettingsResponse {
333
+ }
334
+ export interface DomainEvent extends DomainEventBodyOneOf {
335
+ createdEvent?: EntityCreatedEvent;
336
+ updatedEvent?: EntityUpdatedEvent;
337
+ deletedEvent?: EntityDeletedEvent;
338
+ actionEvent?: ActionEvent;
339
+ /**
340
+ * Unique event ID.
341
+ * Allows clients to ignore duplicate webhooks.
342
+ */
343
+ id?: string;
344
+ /**
345
+ * Assumes actions are also always typed to an entity_type
346
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
347
+ */
348
+ entityFqdn?: string;
349
+ /**
350
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
351
+ * This is although the created/updated/deleted notion is duplication of the oneof types
352
+ * Example: created/updated/deleted/started/completed/email_opened
353
+ */
354
+ slug?: string;
355
+ /** ID of the entity associated with the event. */
356
+ entityId?: string;
357
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
358
+ eventTime?: Date | null;
359
+ /**
360
+ * Whether the event was triggered as a result of a privacy regulation application
361
+ * (for example, GDPR).
362
+ */
363
+ triggeredByAnonymizeRequest?: boolean | null;
364
+ /** If present, indicates the action that triggered the event. */
365
+ originatedFrom?: string | null;
366
+ /**
367
+ * A sequence number defining the order of updates to the underlying entity.
368
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
369
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
370
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
371
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
372
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
373
+ */
374
+ entityEventSequence?: string | null;
375
+ }
376
+ /** @oneof */
377
+ export interface DomainEventBodyOneOf {
378
+ createdEvent?: EntityCreatedEvent;
379
+ updatedEvent?: EntityUpdatedEvent;
380
+ deletedEvent?: EntityDeletedEvent;
381
+ actionEvent?: ActionEvent;
382
+ }
383
+ export interface EntityCreatedEvent {
384
+ entityAsJson?: string;
385
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
386
+ restoreInfo?: RestoreInfo;
387
+ }
388
+ export interface RestoreInfo {
389
+ deletedDate?: Date | null;
390
+ }
391
+ export interface EntityUpdatedEvent {
392
+ /**
393
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
394
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
395
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
396
+ */
397
+ currentEntityAsJson?: string;
398
+ }
399
+ export interface EntityDeletedEvent {
400
+ /** Entity that was deleted */
401
+ deletedEntityAsJson?: string | null;
402
+ }
403
+ export interface ActionEvent {
404
+ bodyAsJson?: string;
405
+ }
406
+ export interface MessageEnvelope {
407
+ /**
408
+ * App instance ID.
409
+ * @format GUID
410
+ */
411
+ instanceId?: string | null;
412
+ /**
413
+ * Event type.
414
+ * @maxLength 150
415
+ */
416
+ eventType?: string;
417
+ /** The identification type and identity data. */
418
+ identity?: IdentificationData;
419
+ /** Stringify payload. */
420
+ data?: string;
421
+ }
422
+ export interface IdentificationData extends IdentificationDataIdOneOf {
423
+ /**
424
+ * ID of a site visitor that has not logged in to the site.
425
+ * @format GUID
426
+ */
427
+ anonymousVisitorId?: string;
428
+ /**
429
+ * ID of a site visitor that has logged in to the site.
430
+ * @format GUID
431
+ */
432
+ memberId?: string;
433
+ /**
434
+ * ID of a Wix user (site owner, contributor, etc.).
435
+ * @format GUID
436
+ */
437
+ wixUserId?: string;
438
+ /**
439
+ * ID of an app.
440
+ * @format GUID
441
+ */
442
+ appId?: string;
443
+ /** @readonly */
444
+ identityType?: WebhookIdentityType;
445
+ }
446
+ /** @oneof */
447
+ export interface IdentificationDataIdOneOf {
448
+ /**
449
+ * ID of a site visitor that has not logged in to the site.
450
+ * @format GUID
451
+ */
452
+ anonymousVisitorId?: string;
453
+ /**
454
+ * ID of a site visitor that has logged in to the site.
455
+ * @format GUID
456
+ */
457
+ memberId?: string;
458
+ /**
459
+ * ID of a Wix user (site owner, contributor, etc.).
460
+ * @format GUID
461
+ */
462
+ wixUserId?: string;
463
+ /**
464
+ * ID of an app.
465
+ * @format GUID
466
+ */
467
+ appId?: string;
468
+ }
469
+ export declare enum WebhookIdentityType {
470
+ UNKNOWN = "UNKNOWN",
471
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
472
+ MEMBER = "MEMBER",
473
+ WIX_USER = "WIX_USER",
474
+ APP = "APP"
475
+ }
@@ -0,0 +1,35 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.WebhookIdentityType = exports.SortOrder = exports.StaffDistributionMethod = exports.TipType = void 0;
4
+ var TipType;
5
+ (function (TipType) {
6
+ /** There is no information about the tip type. */
7
+ TipType["UNKNOWN_TIP_TYPE"] = "UNKNOWN_TIP_TYPE";
8
+ /** The tip is calculated as a percentage of the subtotal of all related line items. */
9
+ TipType["PERCENTAGE"] = "PERCENTAGE";
10
+ /** The tip is a fixed amount. */
11
+ TipType["AMOUNT"] = "AMOUNT";
12
+ })(TipType || (exports.TipType = TipType = {}));
13
+ var StaffDistributionMethod;
14
+ (function (StaffDistributionMethod) {
15
+ /** There is no information about the staff distribution method. */
16
+ StaffDistributionMethod["UNKNOWN_SPLIT_METHOD"] = "UNKNOWN_SPLIT_METHOD";
17
+ /** All staff receive an equal amount of the tip. */
18
+ StaffDistributionMethod["EQUAL"] = "EQUAL";
19
+ /** Staff receive a proportional amount of the tip. */
20
+ StaffDistributionMethod["PROPORTIONAL"] = "PROPORTIONAL";
21
+ })(StaffDistributionMethod || (exports.StaffDistributionMethod = StaffDistributionMethod = {}));
22
+ var SortOrder;
23
+ (function (SortOrder) {
24
+ SortOrder["ASC"] = "ASC";
25
+ SortOrder["DESC"] = "DESC";
26
+ })(SortOrder || (exports.SortOrder = SortOrder = {}));
27
+ var WebhookIdentityType;
28
+ (function (WebhookIdentityType) {
29
+ WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
30
+ WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
31
+ WebhookIdentityType["MEMBER"] = "MEMBER";
32
+ WebhookIdentityType["WIX_USER"] = "WIX_USER";
33
+ WebhookIdentityType["APP"] = "APP";
34
+ })(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
35
+ //# sourceMappingURL=tips-settings-v1-tip-settings-tip-settings.types.js.map
@@ -0,0 +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":";;;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"}