@wix/auto_sdk_ecom_checkout-settings 1.0.0

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 (111) 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/ecom-v1-checkout-settings-checkout-settings.context.d.ts +12 -0
  11. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.context.js +18 -0
  12. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.context.js.map +1 -0
  13. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.http.d.ts +15 -0
  14. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.http.js +159 -0
  15. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.http.js.map +1 -0
  16. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.meta.d.ts +14 -0
  17. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.meta.js +66 -0
  18. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.meta.js.map +1 -0
  19. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.public.d.ts +30 -0
  20. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.public.js +41 -0
  21. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.public.js.map +1 -0
  22. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.types.d.ts +378 -0
  23. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.types.js +25 -0
  24. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.types.js.map +1 -0
  25. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.universal.d.ts +471 -0
  26. package/build/cjs/src/ecom-v1-checkout-settings-checkout-settings.universal.js +164 -0
  27. package/build/cjs/src/ecom-v1-checkout-settings-checkout-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/package.json +3 -0
  38. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.context.d.ts +12 -0
  39. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.context.js +12 -0
  40. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.context.js.map +1 -0
  41. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.http.d.ts +15 -0
  42. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.http.js +154 -0
  43. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.http.js.map +1 -0
  44. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.meta.d.ts +14 -0
  45. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.meta.js +38 -0
  46. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.meta.js.map +1 -0
  47. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.public.d.ts +30 -0
  48. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.public.js +33 -0
  49. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.public.js.map +1 -0
  50. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.types.d.ts +378 -0
  51. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.types.js +22 -0
  52. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.types.js.map +1 -0
  53. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.universal.d.ts +471 -0
  54. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.universal.js +136 -0
  55. package/build/es/src/ecom-v1-checkout-settings-checkout-settings.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.context.d.ts +12 -0
  66. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.context.js +18 -0
  67. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.context.js.map +1 -0
  68. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.http.d.ts +15 -0
  69. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.http.js +159 -0
  70. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.http.js.map +1 -0
  71. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.meta.d.ts +14 -0
  72. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.meta.js +66 -0
  73. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.meta.js.map +1 -0
  74. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.public.d.ts +30 -0
  75. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.public.js +41 -0
  76. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.public.js.map +1 -0
  77. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.types.d.ts +391 -0
  78. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.types.js +25 -0
  79. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.types.js.map +1 -0
  80. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.universal.d.ts +473 -0
  81. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.universal.js +164 -0
  82. package/build/internal/cjs/src/ecom-v1-checkout-settings-checkout-settings.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.context.d.ts +12 -0
  93. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.context.js +12 -0
  94. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.context.js.map +1 -0
  95. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.http.d.ts +15 -0
  96. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.http.js +154 -0
  97. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.http.js.map +1 -0
  98. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.meta.d.ts +14 -0
  99. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.meta.js +38 -0
  100. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.meta.js.map +1 -0
  101. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.public.d.ts +30 -0
  102. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.public.js +33 -0
  103. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.public.js.map +1 -0
  104. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.types.d.ts +391 -0
  105. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.types.js +22 -0
  106. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.types.js.map +1 -0
  107. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.universal.d.ts +473 -0
  108. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.universal.js +136 -0
  109. package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,471 @@
1
+ export interface CheckoutSettings {
2
+ /** Checkout policies. */
3
+ checkoutPolicies?: CheckoutPolicies;
4
+ /** Settings that apply to checkout fields and the checkout process. */
5
+ checkoutFields?: CheckoutFields;
6
+ /** Checkout brand settings. */
7
+ checkoutBrand?: CheckoutBrand;
8
+ /**
9
+ * Date and time the checkout settings were created.
10
+ * @readonly
11
+ */
12
+ _createdDate?: Date | null;
13
+ /**
14
+ * Date and time the checkout settings were updated.
15
+ * @readonly
16
+ */
17
+ _updatedDate?: Date | null;
18
+ }
19
+ export interface CheckoutPolicies {
20
+ /** Terms and conditions. */
21
+ termsAndConditions?: TermsAndConditionsPolicy;
22
+ /** Privacy policy. */
23
+ privacyPolicy?: PrivacyPolicy;
24
+ /** Return policy. */
25
+ returnPolicy?: ReturnPolicy;
26
+ /** Digital item policy. */
27
+ digitalItemPolicy?: DigitalItemPolicy;
28
+ /** "Contact us" information. */
29
+ contactUs?: ContactUsPolicy;
30
+ /** Custom policy. */
31
+ customPolicy?: CustomCheckoutPolicy;
32
+ }
33
+ export interface TermsAndConditionsPolicy {
34
+ /**
35
+ * Whether the terms & conditions policy is visible to the customer in the checkout page. <br><br>
36
+ *
37
+ * Default: `false`
38
+ */
39
+ visible?: boolean | null;
40
+ /** Terms and conditions policy content. */
41
+ content?: string | null;
42
+ }
43
+ export interface PrivacyPolicy {
44
+ /**
45
+ * Whether the privacy policy is visible to the customer in the checkout page. <br><br>
46
+ *
47
+ * Default: `false`
48
+ */
49
+ visible?: boolean | null;
50
+ /** Privacy policy content. */
51
+ content?: string | null;
52
+ }
53
+ export interface ReturnPolicy {
54
+ /**
55
+ * Whether the return policy is visible to the customer in the checkout page. <br><br>
56
+ *
57
+ * Default: `false`
58
+ */
59
+ visible?: boolean | null;
60
+ /** Return policy content. */
61
+ content?: string | null;
62
+ }
63
+ export interface DigitalItemPolicy {
64
+ /**
65
+ * Whether the digital item policy is visible to the customer in the checkout page. <br><br>
66
+ *
67
+ * Default: `false`
68
+ */
69
+ visible?: boolean | null;
70
+ /** Digital item policy content. */
71
+ content?: string | null;
72
+ }
73
+ export interface ContactUsPolicy {
74
+ /**
75
+ * Whether the contact us policy is visible to the customer in the checkout page. <br><br>
76
+ *
77
+ * Default: `false`
78
+ */
79
+ visible?: boolean | null;
80
+ /** Contact us policy content. */
81
+ content?: string | null;
82
+ }
83
+ export interface CustomCheckoutPolicy {
84
+ /**
85
+ * Whether the policy is visible to the customer on the checkout page.
86
+ * Default: `false`.
87
+ */
88
+ visible?: boolean | null;
89
+ /** Policy content. */
90
+ content?: string | null;
91
+ /** Policy title. */
92
+ title?: string | null;
93
+ }
94
+ export interface CheckoutFields {
95
+ /**
96
+ * Subscription checkbox.
97
+ * Default:
98
+ * - `visible`: `false`,
99
+ * - `checkedByDefault`: `false`
100
+ */
101
+ subscriptionCheckbox?: CheckboxField;
102
+ /**
103
+ * Policy agreement checkbox.
104
+ * Default:
105
+ * - `visible`: `true`,
106
+ * - `checkedByDefault`: `true`
107
+ */
108
+ policyAgreementCheckbox?: CheckboxField;
109
+ /**
110
+ * Whether the ability to redeem a gift card is enabled.
111
+ * Default: `false`.
112
+ */
113
+ giftCardRedeemEnabled?: boolean | null;
114
+ /**
115
+ * Whether to allow for MIT transactions.
116
+ * Default: `false`.
117
+ */
118
+ mitEnabled?: boolean | null;
119
+ /**
120
+ * Whether to allow for Auth & Capture transactions. <br><br>
121
+ *
122
+ * Default: `false`
123
+ */
124
+ delayCaptureEnabled?: boolean | null;
125
+ /**
126
+ * Whether to automatically capture the transaction before the authorization expires.
127
+ *
128
+ * Default: `true`
129
+ * >**Note:** this setting is only relevant when `delay_capture_enabled: true`.
130
+ */
131
+ captureBeforeExpiryEnabled?: boolean | null;
132
+ }
133
+ export interface CheckboxField {
134
+ /** Whether the checkbox is visible to the customer. */
135
+ visible?: boolean | null;
136
+ /** Whether the checkbox is checked by default. */
137
+ checkedByDefault?: boolean | null;
138
+ }
139
+ export interface CheckoutBrand {
140
+ /** Checkout header. */
141
+ header?: CheckoutHeader;
142
+ }
143
+ export interface CheckoutHeader {
144
+ /**
145
+ * Textual content to be included in the header (e.g. Business Name)
146
+ * TODO: update maxLength validation once limitation is known
147
+ */
148
+ text?: string | null;
149
+ /** Specifications for when a logo is included in the header. */
150
+ logo?: Logo;
151
+ /**
152
+ * Alignment within the header.
153
+ *
154
+ * >**Note:** `SIDE` alignment is decided depending on the locale's language. For example, scripts like Hebrew and Arabic will automatically align right-to-left.
155
+ */
156
+ alignment?: Alignment;
157
+ /**
158
+ * Whether to display the 'Checkout' label within the header.
159
+ * Depending on the locale, the label may be translated.
160
+ */
161
+ displayCheckoutLabel?: boolean | null;
162
+ }
163
+ export interface Logo {
164
+ /** Size of the logo. */
165
+ size?: LogoSize;
166
+ }
167
+ export interface FocalPoint {
168
+ /** X-coordinate of the focal point. */
169
+ x?: number;
170
+ /** Y-coordinate of the focal point. */
171
+ y?: number;
172
+ /** crop by height */
173
+ height?: number | null;
174
+ /** crop by width */
175
+ width?: number | null;
176
+ }
177
+ export declare enum LogoSize {
178
+ UNKNOWN_LOGO_SIZE = "UNKNOWN_LOGO_SIZE",
179
+ SMALL = "SMALL",
180
+ MEDIUM = "MEDIUM",
181
+ LARGE = "LARGE"
182
+ }
183
+ export declare enum Alignment {
184
+ UNKNOWN_ALIGNMENT = "UNKNOWN_ALIGNMENT",
185
+ SIDE = "SIDE",
186
+ CENTER = "CENTER"
187
+ }
188
+ export interface GetCheckoutSettingsRequest {
189
+ }
190
+ export interface GetCheckoutSettingsResponse {
191
+ /** Checkout settings. */
192
+ checkoutSettings?: CheckoutSettings;
193
+ }
194
+ export interface UpdateCheckoutSettingsRequest {
195
+ /** Checkout settings to update. */
196
+ checkoutSettings: CheckoutSettings;
197
+ }
198
+ export interface UpdateCheckoutSettingsResponse {
199
+ /** The updated checkout settings. */
200
+ checkoutSettings?: CheckoutSettings;
201
+ }
202
+ export interface ListCheckoutSettingsRequest {
203
+ }
204
+ export interface ListCheckoutSettingsResponse {
205
+ /** List of retrieved checkout settings. */
206
+ checkoutSettings?: CheckoutSettings[];
207
+ }
208
+ export interface GiftCardProviderWasProvisioned {
209
+ /** The gift card provider which was installed */
210
+ providerAppDefId?: string;
211
+ providerInstanceId?: string;
212
+ }
213
+ export interface Empty {
214
+ }
215
+ export interface DeleteCheckoutSettingsRequest {
216
+ }
217
+ export interface DeleteCheckoutSettingsResponse {
218
+ }
219
+ export interface DomainEvent extends DomainEventBodyOneOf {
220
+ createdEvent?: EntityCreatedEvent;
221
+ updatedEvent?: EntityUpdatedEvent;
222
+ deletedEvent?: EntityDeletedEvent;
223
+ actionEvent?: ActionEvent;
224
+ /**
225
+ * Unique event ID.
226
+ * Allows clients to ignore duplicate webhooks.
227
+ */
228
+ _id?: string;
229
+ /**
230
+ * Assumes actions are also always typed to an entity_type
231
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
232
+ */
233
+ entityFqdn?: string;
234
+ /**
235
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
236
+ * This is although the created/updated/deleted notion is duplication of the oneof types
237
+ * Example: created/updated/deleted/started/completed/email_opened
238
+ */
239
+ slug?: string;
240
+ /** ID of the entity associated with the event. */
241
+ entityId?: string;
242
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
243
+ eventTime?: Date | null;
244
+ /**
245
+ * Whether the event was triggered as a result of a privacy regulation application
246
+ * (for example, GDPR).
247
+ */
248
+ triggeredByAnonymizeRequest?: boolean | null;
249
+ /** If present, indicates the action that triggered the event. */
250
+ originatedFrom?: string | null;
251
+ /**
252
+ * A sequence number defining the order of updates to the underlying entity.
253
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
254
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
255
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
256
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
257
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
258
+ */
259
+ entityEventSequence?: string | null;
260
+ }
261
+ /** @oneof */
262
+ export interface DomainEventBodyOneOf {
263
+ createdEvent?: EntityCreatedEvent;
264
+ updatedEvent?: EntityUpdatedEvent;
265
+ deletedEvent?: EntityDeletedEvent;
266
+ actionEvent?: ActionEvent;
267
+ }
268
+ export interface EntityCreatedEvent {
269
+ entity?: string;
270
+ }
271
+ export interface RestoreInfo {
272
+ deletedDate?: Date | null;
273
+ }
274
+ export interface EntityUpdatedEvent {
275
+ /**
276
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
277
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
278
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
279
+ */
280
+ currentEntity?: string;
281
+ }
282
+ export interface EntityDeletedEvent {
283
+ /** Entity that was deleted */
284
+ deletedEntity?: string | null;
285
+ }
286
+ export interface ActionEvent {
287
+ body?: string;
288
+ }
289
+ export interface MessageEnvelope {
290
+ /** App instance ID. */
291
+ instanceId?: string | null;
292
+ /** Event type. */
293
+ eventType?: string;
294
+ /** The identification type and identity data. */
295
+ identity?: IdentificationData;
296
+ /** Stringify payload. */
297
+ data?: string;
298
+ }
299
+ export interface IdentificationData extends IdentificationDataIdOneOf {
300
+ /** ID of a site visitor that has not logged in to the site. */
301
+ anonymousVisitorId?: string;
302
+ /** ID of a site visitor that has logged in to the site. */
303
+ memberId?: string;
304
+ /** ID of a Wix user (site owner, contributor, etc.). */
305
+ wixUserId?: string;
306
+ /** ID of an app. */
307
+ appId?: string;
308
+ /** @readonly */
309
+ identityType?: WebhookIdentityType;
310
+ }
311
+ /** @oneof */
312
+ export interface IdentificationDataIdOneOf {
313
+ /** ID of a site visitor that has not logged in to the site. */
314
+ anonymousVisitorId?: string;
315
+ /** ID of a site visitor that has logged in to the site. */
316
+ memberId?: string;
317
+ /** ID of a Wix user (site owner, contributor, etc.). */
318
+ wixUserId?: string;
319
+ /** ID of an app. */
320
+ appId?: string;
321
+ }
322
+ export declare enum WebhookIdentityType {
323
+ UNKNOWN = "UNKNOWN",
324
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
325
+ MEMBER = "MEMBER",
326
+ WIX_USER = "WIX_USER",
327
+ APP = "APP"
328
+ }
329
+ interface LogoNonNullableFields {
330
+ size: LogoSize;
331
+ }
332
+ interface CheckoutHeaderNonNullableFields {
333
+ logo?: LogoNonNullableFields;
334
+ alignment: Alignment;
335
+ }
336
+ interface CheckoutBrandNonNullableFields {
337
+ header?: CheckoutHeaderNonNullableFields;
338
+ }
339
+ interface CheckoutSettingsNonNullableFields {
340
+ checkoutBrand?: CheckoutBrandNonNullableFields;
341
+ }
342
+ export interface GetCheckoutSettingsResponseNonNullableFields {
343
+ checkoutSettings?: CheckoutSettingsNonNullableFields;
344
+ }
345
+ export interface UpdateCheckoutSettingsResponseNonNullableFields {
346
+ checkoutSettings?: CheckoutSettingsNonNullableFields;
347
+ }
348
+ export interface BaseEventMetadata {
349
+ /** App instance ID. */
350
+ instanceId?: string | null;
351
+ /** Event type. */
352
+ eventType?: string;
353
+ /** The identification type and identity data. */
354
+ identity?: IdentificationData;
355
+ }
356
+ export interface EventMetadata extends BaseEventMetadata {
357
+ /**
358
+ * Unique event ID.
359
+ * Allows clients to ignore duplicate webhooks.
360
+ */
361
+ _id?: string;
362
+ /**
363
+ * Assumes actions are also always typed to an entity_type
364
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
365
+ */
366
+ entityFqdn?: string;
367
+ /**
368
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
369
+ * This is although the created/updated/deleted notion is duplication of the oneof types
370
+ * Example: created/updated/deleted/started/completed/email_opened
371
+ */
372
+ slug?: string;
373
+ /** ID of the entity associated with the event. */
374
+ entityId?: string;
375
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
376
+ eventTime?: Date | null;
377
+ /**
378
+ * Whether the event was triggered as a result of a privacy regulation application
379
+ * (for example, GDPR).
380
+ */
381
+ triggeredByAnonymizeRequest?: boolean | null;
382
+ /** If present, indicates the action that triggered the event. */
383
+ originatedFrom?: string | null;
384
+ /**
385
+ * A sequence number defining the order of updates to the underlying entity.
386
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
387
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
388
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
389
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
390
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
391
+ */
392
+ entityEventSequence?: string | null;
393
+ }
394
+ export interface CheckoutSettingsUpdatedEnvelope {
395
+ entity: CheckoutSettings;
396
+ metadata: EventMetadata;
397
+ }
398
+ /**
399
+ * Triggered when checkout settings are updated.
400
+ * @permissionScope Manage Stores - all permissions
401
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
402
+ * @permissionScope Read eCommerce - all read permissions
403
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
404
+ * @permissionScope Read Orders
405
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
406
+ * @permissionScope Read Stores - all read permissions
407
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
408
+ * @permissionScope Manage Restaurants - all permissions
409
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
410
+ * @permissionScope Manage eCommerce - all permissions
411
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
412
+ * @permissionScope Manage Orders
413
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
414
+ * @permissionId ECOM.READ_CHECKOUT_SETTINGS
415
+ * @webhook
416
+ * @eventType wix.ecom.v1.checkout_settings_updated
417
+ * @documentationMaturity preview
418
+ */
419
+ export declare function onCheckoutSettingsUpdated(handler: (event: CheckoutSettingsUpdatedEnvelope) => void | Promise<void>): void;
420
+ /**
421
+ * Retrieves the sites' checkout settings.
422
+ *
423
+ *
424
+ * The `getCheckoutSettings()` function returns a Promise that resolves to checkout settings.
425
+ * @public
426
+ * @documentationMaturity preview
427
+ * @permissionId ECOM.READ_CHECKOUT_SETTINGS
428
+ * @permissionScope Manage Stores - all permissions
429
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
430
+ * @permissionScope Read eCommerce - all read permissions
431
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
432
+ * @permissionScope Read Orders
433
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
434
+ * @permissionScope Read Stores - all read permissions
435
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
436
+ * @permissionScope Manage Restaurants - all permissions
437
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
438
+ * @permissionScope Manage eCommerce - all permissions
439
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
440
+ * @permissionScope Manage Orders
441
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
442
+ * @applicableIdentity APP
443
+ * @applicableIdentity VISITOR
444
+ * @returns The requested checkout settings.
445
+ * @fqn wix.ecom.checkout_settings.api.v1.CheckoutSettingsService.GetCheckoutSettings
446
+ */
447
+ export declare function getCheckoutSettings(): Promise<GetCheckoutSettingsResponse & GetCheckoutSettingsResponseNonNullableFields>;
448
+ /**
449
+ * Updates the sites' checkout settings.
450
+ *
451
+ *
452
+ * The `updateCheckoutSettings()` function returns a Promise that resolves to the newly updated checkout settings.
453
+ * @param checkoutSettings - Checkout settings to update.
454
+ * @public
455
+ * @documentationMaturity preview
456
+ * @requiredField checkoutSettings
457
+ * @permissionId ECOM.UPDATE_CHECKOUT_SETTINGS
458
+ * @permissionScope Manage Stores - all permissions
459
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
460
+ * @permissionScope Manage Restaurants - all permissions
461
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
462
+ * @permissionScope Manage eCommerce - all permissions
463
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
464
+ * @permissionScope Manage Orders
465
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
466
+ * @applicableIdentity APP
467
+ * @returns The updated checkout settings.
468
+ * @fqn wix.ecom.checkout_settings.api.v1.CheckoutSettingsService.UpdateCheckoutSettings
469
+ */
470
+ export declare function updateCheckoutSettings(checkoutSettings: CheckoutSettings): Promise<UpdateCheckoutSettingsResponse & UpdateCheckoutSettingsResponseNonNullableFields>;
471
+ export {};
@@ -0,0 +1,136 @@
1
+ import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
2
+ import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
3
+ import * as ambassadorWixEcomV1CheckoutSettings from './ecom-v1-checkout-settings-checkout-settings.http.js';
4
+ import { transformSDKImageToRESTImage } from '@wix/sdk-runtime/transformations/image';
5
+ import { transformRESTImageToSDKImage } from '@wix/sdk-runtime/transformations/image';
6
+ import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
7
+ export var LogoSize;
8
+ (function (LogoSize) {
9
+ LogoSize["UNKNOWN_LOGO_SIZE"] = "UNKNOWN_LOGO_SIZE";
10
+ LogoSize["SMALL"] = "SMALL";
11
+ LogoSize["MEDIUM"] = "MEDIUM";
12
+ LogoSize["LARGE"] = "LARGE";
13
+ })(LogoSize || (LogoSize = {}));
14
+ export var Alignment;
15
+ (function (Alignment) {
16
+ Alignment["UNKNOWN_ALIGNMENT"] = "UNKNOWN_ALIGNMENT";
17
+ Alignment["SIDE"] = "SIDE";
18
+ Alignment["CENTER"] = "CENTER";
19
+ })(Alignment || (Alignment = {}));
20
+ export var WebhookIdentityType;
21
+ (function (WebhookIdentityType) {
22
+ WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
23
+ WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
24
+ WebhookIdentityType["MEMBER"] = "MEMBER";
25
+ WebhookIdentityType["WIX_USER"] = "WIX_USER";
26
+ WebhookIdentityType["APP"] = "APP";
27
+ })(WebhookIdentityType || (WebhookIdentityType = {}));
28
+ /**
29
+ * Retrieves the sites' checkout settings.
30
+ *
31
+ *
32
+ * The `getCheckoutSettings()` function returns a Promise that resolves to checkout settings.
33
+ * @public
34
+ * @documentationMaturity preview
35
+ * @permissionId ECOM.READ_CHECKOUT_SETTINGS
36
+ * @permissionScope Manage Stores - all permissions
37
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
38
+ * @permissionScope Read eCommerce - all read permissions
39
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
40
+ * @permissionScope Read Orders
41
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
42
+ * @permissionScope Read Stores - all read permissions
43
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
44
+ * @permissionScope Manage Restaurants - all permissions
45
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
46
+ * @permissionScope Manage eCommerce - all permissions
47
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
48
+ * @permissionScope Manage Orders
49
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
50
+ * @applicableIdentity APP
51
+ * @applicableIdentity VISITOR
52
+ * @returns The requested checkout settings.
53
+ * @fqn wix.ecom.checkout_settings.api.v1.CheckoutSettingsService.GetCheckoutSettings
54
+ */
55
+ export async function getCheckoutSettings() {
56
+ // @ts-ignore
57
+ const { httpClient, sideEffects } = arguments[0];
58
+ const payload = renameKeysFromSDKRequestToRESTRequest({});
59
+ const reqOpts = ambassadorWixEcomV1CheckoutSettings.getCheckoutSettings(payload);
60
+ sideEffects?.onSiteCall?.();
61
+ try {
62
+ const result = await httpClient.request(reqOpts);
63
+ sideEffects?.onSuccess?.(result);
64
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
65
+ {
66
+ transformFn: transformRESTImageToSDKImage,
67
+ paths: [{ path: 'checkoutSettings.checkoutBrand.header.logo.image' }],
68
+ },
69
+ ]));
70
+ }
71
+ catch (err) {
72
+ const transformedError = sdkTransformError(err, {
73
+ spreadPathsToArguments: {},
74
+ explicitPathsToArguments: {},
75
+ singleArgumentUnchanged: false,
76
+ }, []);
77
+ sideEffects?.onError?.(err);
78
+ throw transformedError;
79
+ }
80
+ }
81
+ /**
82
+ * Updates the sites' checkout settings.
83
+ *
84
+ *
85
+ * The `updateCheckoutSettings()` function returns a Promise that resolves to the newly updated checkout settings.
86
+ * @param checkoutSettings - Checkout settings to update.
87
+ * @public
88
+ * @documentationMaturity preview
89
+ * @requiredField checkoutSettings
90
+ * @permissionId ECOM.UPDATE_CHECKOUT_SETTINGS
91
+ * @permissionScope Manage Stores - all permissions
92
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
93
+ * @permissionScope Manage Restaurants - all permissions
94
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
95
+ * @permissionScope Manage eCommerce - all permissions
96
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
97
+ * @permissionScope Manage Orders
98
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
99
+ * @applicableIdentity APP
100
+ * @returns The updated checkout settings.
101
+ * @fqn wix.ecom.checkout_settings.api.v1.CheckoutSettingsService.UpdateCheckoutSettings
102
+ */
103
+ export async function updateCheckoutSettings(checkoutSettings) {
104
+ // @ts-ignore
105
+ const { httpClient, sideEffects } = arguments[1];
106
+ const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
107
+ checkoutSettings: checkoutSettings,
108
+ }), [
109
+ {
110
+ transformFn: transformSDKImageToRESTImage,
111
+ paths: [{ path: 'checkoutSettings.checkoutBrand.header.logo.image' }],
112
+ },
113
+ ]);
114
+ const reqOpts = ambassadorWixEcomV1CheckoutSettings.updateCheckoutSettings(payload);
115
+ sideEffects?.onSiteCall?.();
116
+ try {
117
+ const result = await httpClient.request(reqOpts);
118
+ sideEffects?.onSuccess?.(result);
119
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
120
+ {
121
+ transformFn: transformRESTImageToSDKImage,
122
+ paths: [{ path: 'checkoutSettings.checkoutBrand.header.logo.image' }],
123
+ },
124
+ ]));
125
+ }
126
+ catch (err) {
127
+ const transformedError = sdkTransformError(err, {
128
+ spreadPathsToArguments: {},
129
+ explicitPathsToArguments: { checkoutSettings: '$[0]' },
130
+ singleArgumentUnchanged: false,
131
+ }, ['checkoutSettings']);
132
+ sideEffects?.onError?.(err);
133
+ throw transformedError;
134
+ }
135
+ }
136
+ //# sourceMappingURL=ecom-v1-checkout-settings-checkout-settings.universal.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ecom-v1-checkout-settings-checkout-settings.universal.js","sourceRoot":"","sources":["../../../src/ecom-v1-checkout-settings-checkout-settings.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,mCAAmC,MAAM,uDAAuD,CAAC;AAC7G,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAgMlF,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,mDAAuC,CAAA;IACvC,2BAAe,CAAA;IACf,6BAAiB,CAAA;IACjB,2BAAe,CAAA;AACjB,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AAED,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,0BAAa,CAAA;IACb,8BAAiB,CAAA;AACnB,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AAuJD,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;AA2GD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB;IAGvC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,mCAAmC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAEnE,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,uCAAuC,CAC5C,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,4BAA4B;gBACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kDAAkD,EAAE,CAAC;aACtE;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,gBAAkC;IAKlC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,cAAc,CAC5B,qCAAqC,CAAC;QACpC,gBAAgB,EAAE,gBAAgB;KACnC,CAAC,EACF;QACE;YACE,WAAW,EAAE,4BAA4B;YACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kDAAkD,EAAE,CAAC;SACtE;KACF,CACF,CAAC;IAEF,MAAM,OAAO,GACX,mCAAmC,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAEtE,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,uCAAuC,CAC5C,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,4BAA4B;gBACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kDAAkD,EAAE,CAAC;aACtE;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;YACtD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
@@ -0,0 +1 @@
1
+ export * from './src/ecom-v1-checkout-settings-checkout-settings.context.js';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./src/ecom-v1-checkout-settings-checkout-settings.context.js"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+FAA6E"}
@@ -0,0 +1 @@
1
+ export * from './src/ecom-v1-checkout-settings-checkout-settings.universal.js';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./src/ecom-v1-checkout-settings-checkout-settings.universal.js"), exports);
18
+ //# sourceMappingURL=index.typings.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../../index.typings.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iGAA+E"}
@@ -0,0 +1 @@
1
+ export * from './src/ecom-v1-checkout-settings-checkout-settings.meta.js';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./src/ecom-v1-checkout-settings-checkout-settings.meta.js"), exports);
18
+ //# sourceMappingURL=meta.js.map