@wix/auto_sdk_payments_payment-acceptance-configurations 1.0.38 → 1.0.40

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.
@@ -1 +1,1198 @@
1
- export { ActionEvent, AddPaymentAcceptanceConfigurationRulesOptions, AddPaymentAcceptanceConfigurationRulesRequest, AddPaymentAcceptanceConfigurationRulesResponse, ApplicationError, Asset, BulkActionMetadata, BulkUpdatePaymentAcceptanceConfigurationTagsByFilterOptions, BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest, BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse, BulkUpdatePaymentAcceptanceConfigurationTagsOptions, BulkUpdatePaymentAcceptanceConfigurationTagsRequest, BulkUpdatePaymentAcceptanceConfigurationTagsResponse, BulkUpdatePaymentAcceptanceConfigurationTagsResult, Countries, CreatePaymentAcceptanceConfigurationRequest, CreatePaymentAcceptanceConfigurationResponse, Currencies, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteContext, DeletePaymentAcceptanceConfigurationRequest, DeletePaymentAcceptanceConfigurationResponse, DeleteStatus, DeleteStatusWithLiterals, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, GetPaymentAcceptanceConfigurationRequest, GetPaymentAcceptanceConfigurationResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, PaymentAcceptanceConfiguration, PaymentAcceptanceConfigurationsQueryBuilder, PaymentAcceptanceConfigurationsQueryResult, PaymentAcceptanceRule, PaymentBrands, PicassoAssigned, PicassoUnassigned, QueryPaymentAcceptanceConfigurationsRequest, QueryPaymentAcceptanceConfigurationsResponse, RemovePaymentAcceptanceConfigurationRulesOptions, RemovePaymentAcceptanceConfigurationRulesRequest, RemovePaymentAcceptanceConfigurationRulesResponse, RestoreInfo, Restrictions, RestrictionsCountriesOneOf, RestrictionsCurrenciesOneOf, RestrictionsPaymentBrandsOneOf, ServiceProvisioned, ServiceRemoved, SiteCreated, SiteCreatedContext, SiteCreatedContextWithLiterals, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, StudioAssigned, StudioTwoAssigned, StudioTwoUnassigned, StudioUnassigned, TagList, Tags, UpdatePaymentAcceptanceConfiguration, UpdatePaymentAcceptanceConfigurationRequest, UpdatePaymentAcceptanceConfigurationResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixelAssigned, WixelUnassigned } from './index.js';
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
3
+ /** PaymentAcceptanceConfiguration */
4
+ interface PaymentAcceptanceConfiguration {
5
+ /**
6
+ * Id
7
+ * @format GUID
8
+ * @readonly
9
+ * @immutable
10
+ */
11
+ _id?: string | null;
12
+ /**
13
+ * App id
14
+ * @format GUID
15
+ * @immutable
16
+ */
17
+ appId?: string | null;
18
+ /**
19
+ * Rules
20
+ * @maxSize 1000
21
+ */
22
+ rules?: PaymentAcceptanceRule[];
23
+ /**
24
+ * Revision
25
+ * @readonly
26
+ */
27
+ revision?: string | null;
28
+ /**
29
+ * Date when PaymentAcceptanceConfiguration was created
30
+ * @readonly
31
+ * @immutable
32
+ */
33
+ _createdDate?: Date | null;
34
+ /**
35
+ * Date when PaymentAcceptanceConfiguration was updated
36
+ * @readonly
37
+ */
38
+ _updatedDate?: Date | null;
39
+ /** Data Extensions */
40
+ extendedFields?: ExtendedFields;
41
+ /** Tags */
42
+ tags?: Tags;
43
+ }
44
+ interface PaymentAcceptanceRule {
45
+ /**
46
+ * Rule Id
47
+ * @format GUID
48
+ * @readonly
49
+ * @immutable
50
+ */
51
+ _id?: string | null;
52
+ /**
53
+ * Payment method type id
54
+ * @format GUID
55
+ */
56
+ paymentMethodTypeId?: string;
57
+ /**
58
+ * Account connection id
59
+ * @format GUID
60
+ */
61
+ accountConnectionId?: string;
62
+ /** Merchant enabled */
63
+ merchantEnabled?: boolean;
64
+ }
65
+ interface PaymentBrands {
66
+ /**
67
+ * Payment brand ids
68
+ * @maxSize 200
69
+ * @format GUID
70
+ */
71
+ paymentBrandIds?: string[];
72
+ }
73
+ interface Countries {
74
+ /**
75
+ * Country codes
76
+ * @maxSize 200
77
+ * @format COUNTRY
78
+ */
79
+ countryCodes?: string[];
80
+ }
81
+ interface Currencies {
82
+ /**
83
+ * Currency codes
84
+ * @maxSize 200
85
+ * @format CURRENCY
86
+ */
87
+ currencyCodes?: string[];
88
+ }
89
+ interface Restrictions extends RestrictionsPaymentBrandsOneOf, RestrictionsCountriesOneOf, RestrictionsCurrenciesOneOf {
90
+ /** Allowed payment brands */
91
+ allowedPaymentBrands?: PaymentBrands;
92
+ /** Prohibited payment brands */
93
+ prohibitedPaymentBrands?: PaymentBrands;
94
+ /** Allowed countries */
95
+ allowedCountries?: Countries;
96
+ /** Prohibited countries */
97
+ prohibitedCountries?: Countries;
98
+ /** Allowed currencies */
99
+ allowedCurrencies?: Currencies;
100
+ /** Prohibited currencies */
101
+ prohibitedCurrencies?: Currencies;
102
+ }
103
+ /** @oneof */
104
+ interface RestrictionsPaymentBrandsOneOf {
105
+ /** Allowed payment brands */
106
+ allowedPaymentBrands?: PaymentBrands;
107
+ /** Prohibited payment brands */
108
+ prohibitedPaymentBrands?: PaymentBrands;
109
+ }
110
+ /** @oneof */
111
+ interface RestrictionsCountriesOneOf {
112
+ /** Allowed countries */
113
+ allowedCountries?: Countries;
114
+ /** Prohibited countries */
115
+ prohibitedCountries?: Countries;
116
+ }
117
+ /** @oneof */
118
+ interface RestrictionsCurrenciesOneOf {
119
+ /** Allowed currencies */
120
+ allowedCurrencies?: Currencies;
121
+ /** Prohibited currencies */
122
+ prohibitedCurrencies?: Currencies;
123
+ }
124
+ interface ExtendedFields {
125
+ /**
126
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
127
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
128
+ *
129
+ * You can only access fields for which you have the appropriate permissions.
130
+ *
131
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
132
+ */
133
+ namespaces?: Record<string, Record<string, any>>;
134
+ }
135
+ /**
136
+ * Common object for tags.
137
+ * Should be use as in this example:
138
+ * message Foo {
139
+ * string id = 1;
140
+ * ...
141
+ * Tags tags = 5
142
+ * }
143
+ *
144
+ * example of taggable entity
145
+ * {
146
+ * id: "123"
147
+ * tags: {
148
+ * tags: {
149
+ * tag_ids:["11","22"]
150
+ * },
151
+ * private_tags: {
152
+ * tag_ids: ["33", "44"]
153
+ * }
154
+ * }
155
+ * }
156
+ */
157
+ interface Tags {
158
+ /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
159
+ tags?: TagList;
160
+ }
161
+ interface TagList {
162
+ /**
163
+ * List of tag IDs
164
+ * @maxSize 100
165
+ * @maxLength 5
166
+ */
167
+ tagIds?: string[];
168
+ }
169
+ interface CreatePaymentAcceptanceConfigurationRequest {
170
+ /** PaymentAcceptanceConfiguration to be created. */
171
+ paymentAcceptanceConfiguration: PaymentAcceptanceConfiguration;
172
+ }
173
+ interface CreatePaymentAcceptanceConfigurationResponse {
174
+ /** The created PaymentAcceptanceConfiguration. */
175
+ paymentAcceptanceConfiguration?: PaymentAcceptanceConfiguration;
176
+ }
177
+ interface GetPaymentAcceptanceConfigurationRequest {
178
+ /**
179
+ * ID of the PaymentAcceptanceConfiguration to retrieve.
180
+ * @format GUID
181
+ */
182
+ paymentAcceptanceConfigurationId: string;
183
+ }
184
+ interface GetPaymentAcceptanceConfigurationResponse {
185
+ /** The requested PaymentAcceptanceConfiguration. */
186
+ paymentAcceptanceConfiguration?: PaymentAcceptanceConfiguration;
187
+ }
188
+ interface UpdatePaymentAcceptanceConfigurationRequest {
189
+ /** PaymentAcceptanceConfiguration to be updated, may be partial. */
190
+ paymentAcceptanceConfiguration: PaymentAcceptanceConfiguration;
191
+ }
192
+ interface UpdatePaymentAcceptanceConfigurationResponse {
193
+ /** Updated PaymentAcceptanceConfiguration. */
194
+ paymentAcceptanceConfiguration?: PaymentAcceptanceConfiguration;
195
+ }
196
+ interface AddPaymentAcceptanceConfigurationRulesRequest {
197
+ /**
198
+ * Id of payment acceptance configuration to update
199
+ * @format GUID
200
+ */
201
+ paymentAcceptanceConfigurationId: string;
202
+ /**
203
+ * Payment acceptance configuration revision
204
+ * @readonly
205
+ */
206
+ paymentAcceptanceConfigurationRevision?: string | null;
207
+ /**
208
+ * Rules to add
209
+ * @minSize 1
210
+ * @maxSize 1000
211
+ */
212
+ rules: PaymentAcceptanceRule[];
213
+ }
214
+ interface AddPaymentAcceptanceConfigurationRulesResponse {
215
+ /** Updated PaymentAcceptanceConfiguration */
216
+ paymentAcceptanceConfiguration?: PaymentAcceptanceConfiguration;
217
+ }
218
+ interface RemovePaymentAcceptanceConfigurationRulesRequest {
219
+ /**
220
+ * Id of payment acceptance configuration to update
221
+ * @format GUID
222
+ */
223
+ paymentAcceptanceConfigurationId: string;
224
+ /**
225
+ * Payment acceptance configuration revision
226
+ * @readonly
227
+ */
228
+ paymentAcceptanceConfigurationRevision?: string | null;
229
+ /**
230
+ * IDs of the rules to remove
231
+ * @format GUID
232
+ * @minSize 1
233
+ * @maxSize 1000
234
+ */
235
+ ruleIds: string[];
236
+ }
237
+ interface RemovePaymentAcceptanceConfigurationRulesResponse {
238
+ /** Updated PaymentAcceptanceConfiguration */
239
+ paymentAcceptanceConfiguration?: PaymentAcceptanceConfiguration;
240
+ }
241
+ interface DeletePaymentAcceptanceConfigurationRequest {
242
+ /**
243
+ * Id of payment acceptance configuration to delete
244
+ * @format GUID
245
+ */
246
+ paymentAcceptanceConfigurationId: string;
247
+ }
248
+ interface DeletePaymentAcceptanceConfigurationResponse {
249
+ }
250
+ interface QueryPaymentAcceptanceConfigurationsRequest {
251
+ /** WQL expression. */
252
+ query?: CursorQuery;
253
+ }
254
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
255
+ /** 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`. */
256
+ cursorPaging?: CursorPaging;
257
+ /**
258
+ * Filter object in the following format:
259
+ * `"filter" : {
260
+ * "fieldName1": "value1",
261
+ * "fieldName2":{"$operator":"value2"}
262
+ * }`
263
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
264
+ */
265
+ filter?: Record<string, any> | null;
266
+ /**
267
+ * Sort object in the following format:
268
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
269
+ * @maxSize 5
270
+ */
271
+ sort?: Sorting[];
272
+ }
273
+ /** @oneof */
274
+ interface CursorQueryPagingMethodOneOf {
275
+ /** 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`. */
276
+ cursorPaging?: CursorPaging;
277
+ }
278
+ interface Sorting {
279
+ /**
280
+ * Name of the field to sort by.
281
+ * @maxLength 512
282
+ */
283
+ fieldName?: string;
284
+ /** Sort order. */
285
+ order?: SortOrderWithLiterals;
286
+ }
287
+ declare enum SortOrder {
288
+ ASC = "ASC",
289
+ DESC = "DESC"
290
+ }
291
+ /** @enumType */
292
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
293
+ interface CursorPaging {
294
+ /**
295
+ * Maximum number of items to return in the results.
296
+ * @max 100
297
+ */
298
+ limit?: number | null;
299
+ /**
300
+ * Pointer to the next or previous page in the list of results.
301
+ *
302
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
303
+ * Not relevant for the first request.
304
+ * @maxLength 16000
305
+ */
306
+ cursor?: string | null;
307
+ }
308
+ interface QueryPaymentAcceptanceConfigurationsResponse {
309
+ /** List of PaymentAcceptanceConfigurations. */
310
+ paymentAcceptanceConfigurations?: PaymentAcceptanceConfiguration[];
311
+ /** Paging metadata */
312
+ pagingMetadata?: CursorPagingMetadata;
313
+ }
314
+ interface CursorPagingMetadata {
315
+ /** Number of items returned in the response. */
316
+ count?: number | null;
317
+ /** Cursor strings that point to the next page, previous page, or both. */
318
+ cursors?: Cursors;
319
+ /**
320
+ * Whether there are more pages to retrieve following the current page.
321
+ *
322
+ * + `true`: Another page of results can be retrieved.
323
+ * + `false`: This is the last page.
324
+ */
325
+ hasNext?: boolean | null;
326
+ }
327
+ interface Cursors {
328
+ /**
329
+ * Cursor string pointing to the next page in the list of results.
330
+ * @maxLength 16000
331
+ */
332
+ next?: string | null;
333
+ /**
334
+ * Cursor pointing to the previous page in the list of results.
335
+ * @maxLength 16000
336
+ */
337
+ prev?: string | null;
338
+ }
339
+ interface BulkUpdatePaymentAcceptanceConfigurationTagsRequest {
340
+ /**
341
+ * List of NileProtoTagsEntities that their tags will update.
342
+ * @minSize 1
343
+ * @maxSize 100
344
+ * @format GUID
345
+ */
346
+ ids: string[];
347
+ /** List of Tags to assign */
348
+ assignTags?: Tags;
349
+ /** List of Tags to unAssign */
350
+ unassignTags?: Tags;
351
+ }
352
+ interface BulkUpdatePaymentAcceptanceConfigurationTagsResponse {
353
+ /**
354
+ * Results
355
+ * @minSize 1
356
+ * @maxSize 100
357
+ */
358
+ results?: BulkUpdatePaymentAcceptanceConfigurationTagsResult[];
359
+ /** Metadata regarding the bulk update operation */
360
+ bulkActionMetadata?: BulkActionMetadata;
361
+ }
362
+ interface ItemMetadata {
363
+ /**
364
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
365
+ * @format GUID
366
+ */
367
+ _id?: string | null;
368
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
369
+ originalIndex?: number;
370
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
371
+ success?: boolean;
372
+ /** Details about the error in case of failure. */
373
+ error?: ApplicationError;
374
+ }
375
+ interface ApplicationError {
376
+ /** Error code. */
377
+ code?: string;
378
+ /** Description of the error. */
379
+ description?: string;
380
+ /** Data related to the error. */
381
+ data?: Record<string, any> | null;
382
+ }
383
+ interface BulkUpdatePaymentAcceptanceConfigurationTagsResult {
384
+ /** Metadata regarding the specific single update operation */
385
+ itemMetadata?: ItemMetadata;
386
+ }
387
+ interface BulkActionMetadata {
388
+ /** Number of items that were successfully processed. */
389
+ totalSuccesses?: number;
390
+ /** Number of items that couldn't be processed. */
391
+ totalFailures?: number;
392
+ /** Number of failures without details because detailed failure threshold was exceeded. */
393
+ undetailedFailures?: number;
394
+ }
395
+ interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest {
396
+ /** Filter */
397
+ filter: Record<string, any> | null;
398
+ /** List of Tags to assign */
399
+ assignTags?: Tags;
400
+ /** List of Tags to unAssign */
401
+ unassignTags?: Tags;
402
+ }
403
+ interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse {
404
+ /**
405
+ * Job ID
406
+ * @format GUID
407
+ */
408
+ jobId?: string;
409
+ }
410
+ interface Empty {
411
+ }
412
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
413
+ /** Emitted on a meta site creation. */
414
+ siteCreated?: SiteCreated;
415
+ /** Emitted on a meta site transfer completion. */
416
+ siteTransferred?: SiteTransferred;
417
+ /** Emitted on a meta site deletion. */
418
+ siteDeleted?: SiteDeleted;
419
+ /** Emitted on a meta site restoration. */
420
+ siteUndeleted?: SiteUndeleted;
421
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
422
+ sitePublished?: SitePublished;
423
+ /** Emitted on a meta site unpublish. */
424
+ siteUnpublished?: SiteUnpublished;
425
+ /** Emitted when meta site is marked as template. */
426
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
427
+ /** Emitted when meta site is marked as a WixSite. */
428
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
429
+ /** Emitted when an application is provisioned (installed). */
430
+ serviceProvisioned?: ServiceProvisioned;
431
+ /** Emitted when an application is removed (uninstalled). */
432
+ serviceRemoved?: ServiceRemoved;
433
+ /** Emitted when meta site name (URL slug) is changed. */
434
+ siteRenamedPayload?: SiteRenamed;
435
+ /** Emitted when meta site was permanently deleted. */
436
+ hardDeleted?: SiteHardDeleted;
437
+ /** Emitted on a namespace change. */
438
+ namespaceChanged?: NamespaceChanged;
439
+ /** Emitted when Studio is attached. */
440
+ studioAssigned?: StudioAssigned;
441
+ /** Emitted when Studio is detached. */
442
+ studioUnassigned?: StudioUnassigned;
443
+ /**
444
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
445
+ * the actual URL.
446
+ *
447
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
448
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
449
+ */
450
+ urlChanged?: SiteUrlChanged;
451
+ /** Site is marked as PurgedExternally */
452
+ sitePurgedExternally?: SitePurgedExternally;
453
+ /** Emitted when Odeditor is attached. */
454
+ odeditorAssigned?: OdeditorAssigned;
455
+ /** Emitted when Odeditor is detached. */
456
+ odeditorUnassigned?: OdeditorUnassigned;
457
+ /** Emitted when Picasso is attached. */
458
+ picassoAssigned?: PicassoAssigned;
459
+ /** Emitted when Picasso is detached. */
460
+ picassoUnassigned?: PicassoUnassigned;
461
+ /** Emitted when Wixel is attached. */
462
+ wixelAssigned?: WixelAssigned;
463
+ /** Emitted when Wixel is detached. */
464
+ wixelUnassigned?: WixelUnassigned;
465
+ /** Emitted when StudioTwo is attached. */
466
+ studioTwoAssigned?: StudioTwoAssigned;
467
+ /** Emitted when StudioTwo is detached. */
468
+ studioTwoUnassigned?: StudioTwoUnassigned;
469
+ /**
470
+ * A meta site id.
471
+ * @format GUID
472
+ */
473
+ metaSiteId?: string;
474
+ /** A meta site version. Monotonically increasing. */
475
+ version?: string;
476
+ /** A timestamp of the event. */
477
+ timestamp?: string;
478
+ /**
479
+ * TODO(meta-site): Change validation once validations are disabled for consumers
480
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
481
+ * @maxSize 4000
482
+ */
483
+ assets?: Asset[];
484
+ }
485
+ /** @oneof */
486
+ interface MetaSiteSpecialEventPayloadOneOf {
487
+ /** Emitted on a meta site creation. */
488
+ siteCreated?: SiteCreated;
489
+ /** Emitted on a meta site transfer completion. */
490
+ siteTransferred?: SiteTransferred;
491
+ /** Emitted on a meta site deletion. */
492
+ siteDeleted?: SiteDeleted;
493
+ /** Emitted on a meta site restoration. */
494
+ siteUndeleted?: SiteUndeleted;
495
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
496
+ sitePublished?: SitePublished;
497
+ /** Emitted on a meta site unpublish. */
498
+ siteUnpublished?: SiteUnpublished;
499
+ /** Emitted when meta site is marked as template. */
500
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
501
+ /** Emitted when meta site is marked as a WixSite. */
502
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
503
+ /** Emitted when an application is provisioned (installed). */
504
+ serviceProvisioned?: ServiceProvisioned;
505
+ /** Emitted when an application is removed (uninstalled). */
506
+ serviceRemoved?: ServiceRemoved;
507
+ /** Emitted when meta site name (URL slug) is changed. */
508
+ siteRenamedPayload?: SiteRenamed;
509
+ /** Emitted when meta site was permanently deleted. */
510
+ hardDeleted?: SiteHardDeleted;
511
+ /** Emitted on a namespace change. */
512
+ namespaceChanged?: NamespaceChanged;
513
+ /** Emitted when Studio is attached. */
514
+ studioAssigned?: StudioAssigned;
515
+ /** Emitted when Studio is detached. */
516
+ studioUnassigned?: StudioUnassigned;
517
+ /**
518
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
519
+ * the actual URL.
520
+ *
521
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
522
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
523
+ */
524
+ urlChanged?: SiteUrlChanged;
525
+ /** Site is marked as PurgedExternally */
526
+ sitePurgedExternally?: SitePurgedExternally;
527
+ /** Emitted when Odeditor is attached. */
528
+ odeditorAssigned?: OdeditorAssigned;
529
+ /** Emitted when Odeditor is detached. */
530
+ odeditorUnassigned?: OdeditorUnassigned;
531
+ /** Emitted when Picasso is attached. */
532
+ picassoAssigned?: PicassoAssigned;
533
+ /** Emitted when Picasso is detached. */
534
+ picassoUnassigned?: PicassoUnassigned;
535
+ /** Emitted when Wixel is attached. */
536
+ wixelAssigned?: WixelAssigned;
537
+ /** Emitted when Wixel is detached. */
538
+ wixelUnassigned?: WixelUnassigned;
539
+ /** Emitted when StudioTwo is attached. */
540
+ studioTwoAssigned?: StudioTwoAssigned;
541
+ /** Emitted when StudioTwo is detached. */
542
+ studioTwoUnassigned?: StudioTwoUnassigned;
543
+ }
544
+ interface Asset {
545
+ /**
546
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
547
+ * @maxLength 36
548
+ */
549
+ appDefId?: string;
550
+ /**
551
+ * An instance id. For legacy reasons may be UUID or a string.
552
+ * @maxLength 200
553
+ */
554
+ instanceId?: string;
555
+ /** An application state. */
556
+ state?: StateWithLiterals;
557
+ }
558
+ declare enum State {
559
+ UNKNOWN = "UNKNOWN",
560
+ ENABLED = "ENABLED",
561
+ DISABLED = "DISABLED",
562
+ PENDING = "PENDING",
563
+ DEMO = "DEMO"
564
+ }
565
+ /** @enumType */
566
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
567
+ interface SiteCreated {
568
+ /**
569
+ * A template identifier (empty if not created from a template).
570
+ * @maxLength 36
571
+ */
572
+ originTemplateId?: string;
573
+ /**
574
+ * An account id of the owner.
575
+ * @format GUID
576
+ */
577
+ ownerId?: string;
578
+ /** A context in which meta site was created. */
579
+ context?: SiteCreatedContextWithLiterals;
580
+ /**
581
+ * A meta site id from which this site was created.
582
+ *
583
+ * In case of a creation from a template it's a template id.
584
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
585
+ * @format GUID
586
+ */
587
+ originMetaSiteId?: string | null;
588
+ /**
589
+ * A meta site name (URL slug).
590
+ * @maxLength 20
591
+ */
592
+ siteName?: string;
593
+ /** A namespace. */
594
+ namespace?: NamespaceWithLiterals;
595
+ }
596
+ declare enum SiteCreatedContext {
597
+ /** A valid option, we don't expose all reasons why site might be created. */
598
+ OTHER = "OTHER",
599
+ /** A meta site was created from template. */
600
+ FROM_TEMPLATE = "FROM_TEMPLATE",
601
+ /** A meta site was created by copying of the transfferred meta site. */
602
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
603
+ /** A copy of existing meta site. */
604
+ DUPLICATE = "DUPLICATE",
605
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
606
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
607
+ /** deprecated A meta site was created for Flash editor. */
608
+ FLASH = "FLASH"
609
+ }
610
+ /** @enumType */
611
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
612
+ declare enum Namespace {
613
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
614
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
615
+ WIX = "WIX",
616
+ /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
617
+ SHOUT_OUT = "SHOUT_OUT",
618
+ /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
619
+ ALBUMS = "ALBUMS",
620
+ /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
621
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
622
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
623
+ HOTELS = "HOTELS",
624
+ /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
625
+ CLUBS = "CLUBS",
626
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
627
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
628
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
629
+ DEV_SITE = "DEV_SITE",
630
+ /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
631
+ LOGOS = "LOGOS",
632
+ /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
633
+ VIDEO_MAKER = "VIDEO_MAKER",
634
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
635
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
636
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
637
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
638
+ /**
639
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
640
+ *
641
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
642
+ */
643
+ HTML_DRAFT = "HTML_DRAFT",
644
+ /**
645
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
646
+ * Will be accessible from Site List and will not have a website app.
647
+ * Once the user attaches a site, the site will become a regular wixsite.
648
+ */
649
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
650
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
651
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
652
+ /** It is to be used in the Business First efforts. */
653
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
654
+ /** Bookings business flow with no site. */
655
+ ANYWHERE = "ANYWHERE",
656
+ /** Namespace for Headless Backoffice with no editor */
657
+ HEADLESS = "HEADLESS",
658
+ /**
659
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
660
+ * The site will be used for account level CSM feature for enterprise
661
+ */
662
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
663
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
664
+ RISE = "RISE",
665
+ /**
666
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
667
+ * There's a blank site behind the scene but it's blank).
668
+ * The Mobile company will be the owner of this namespace.
669
+ */
670
+ BRANDED_FIRST = "BRANDED_FIRST",
671
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
672
+ NOWNIA = "NOWNIA",
673
+ /**
674
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
675
+ * The Partners company owns this namespace.
676
+ */
677
+ UGC_TEMPLATE = "UGC_TEMPLATE",
678
+ /** Codux Headless Sites */
679
+ CODUX = "CODUX",
680
+ /** Bobb - AI Design Creator. */
681
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
682
+ /**
683
+ * Shared Blog Site is a unique single site across Enterprise account,
684
+ * This site will hold all Blog posts related to the Marketing product.
685
+ */
686
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
687
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
688
+ STANDALONE_FORMS = "STANDALONE_FORMS",
689
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
690
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
691
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
692
+ MIMIR = "MIMIR",
693
+ /** Wix Twins platform. */
694
+ TWINS = "TWINS",
695
+ /** Wix Nano. */
696
+ NANO = "NANO"
697
+ }
698
+ /** @enumType */
699
+ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO';
700
+ /** Site transferred to another user. */
701
+ interface SiteTransferred {
702
+ /**
703
+ * A previous owner id (user that transfers meta site).
704
+ * @format GUID
705
+ */
706
+ oldOwnerId?: string;
707
+ /**
708
+ * A new owner id (user that accepts meta site).
709
+ * @format GUID
710
+ */
711
+ newOwnerId?: string;
712
+ }
713
+ /** Soft deletion of the meta site. Could be restored. */
714
+ interface SiteDeleted {
715
+ /** A deletion context. */
716
+ deleteContext?: DeleteContext;
717
+ }
718
+ interface DeleteContext {
719
+ /** When the meta site was deleted. */
720
+ dateDeleted?: Date | null;
721
+ /** A status. */
722
+ deleteStatus?: DeleteStatusWithLiterals;
723
+ /**
724
+ * A reason (flow).
725
+ * @maxLength 255
726
+ */
727
+ deleteOrigin?: string;
728
+ /**
729
+ * A service that deleted it.
730
+ * @maxLength 255
731
+ */
732
+ initiatorId?: string | null;
733
+ }
734
+ declare enum DeleteStatus {
735
+ UNKNOWN = "UNKNOWN",
736
+ TRASH = "TRASH",
737
+ DELETED = "DELETED",
738
+ PENDING_PURGE = "PENDING_PURGE",
739
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
740
+ }
741
+ /** @enumType */
742
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
743
+ /** Restoration of the meta site. */
744
+ interface SiteUndeleted {
745
+ }
746
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
747
+ interface SitePublished {
748
+ }
749
+ interface SiteUnpublished {
750
+ /**
751
+ * A list of URLs previously associated with the meta site.
752
+ * @maxLength 4000
753
+ * @maxSize 10000
754
+ */
755
+ urls?: string[];
756
+ }
757
+ interface SiteMarkedAsTemplate {
758
+ }
759
+ interface SiteMarkedAsWixSite {
760
+ }
761
+ /**
762
+ * Represents a service provisioned a site.
763
+ *
764
+ * Note on `origin_instance_id`:
765
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
766
+ * This is because of the following scenario:
767
+ *
768
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
769
+ * such as a product catalog. When you create a site from this template, you inherit this
770
+ * default product catalog. However, if the template's product catalog is modified,
771
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
772
+ * your site remains consistent with what you initially received and does not include any
773
+ * changes made to the original template afterward.
774
+ * To ensure this, the TPA on the template gets a new instance_id.
775
+ */
776
+ interface ServiceProvisioned {
777
+ /**
778
+ * Either UUID or EmbeddedServiceType.
779
+ * @maxLength 36
780
+ */
781
+ appDefId?: string;
782
+ /**
783
+ * Not only UUID. Something here could be something weird.
784
+ * @maxLength 36
785
+ */
786
+ instanceId?: string;
787
+ /**
788
+ * An instance id from which this instance is originated.
789
+ * @maxLength 36
790
+ */
791
+ originInstanceId?: string;
792
+ /**
793
+ * A version.
794
+ * @maxLength 500
795
+ */
796
+ version?: string | null;
797
+ /**
798
+ * The origin meta site id
799
+ * @format GUID
800
+ */
801
+ originMetaSiteId?: string | null;
802
+ }
803
+ interface ServiceRemoved {
804
+ /**
805
+ * Either UUID or EmbeddedServiceType.
806
+ * @maxLength 36
807
+ */
808
+ appDefId?: string;
809
+ /**
810
+ * Not only UUID. Something here could be something weird.
811
+ * @maxLength 36
812
+ */
813
+ instanceId?: string;
814
+ /**
815
+ * A version.
816
+ * @maxLength 500
817
+ */
818
+ version?: string | null;
819
+ }
820
+ /** Rename of the site. Meaning, free public url has been changed as well. */
821
+ interface SiteRenamed {
822
+ /**
823
+ * A new meta site name (URL slug).
824
+ * @maxLength 20
825
+ */
826
+ newSiteName?: string;
827
+ /**
828
+ * A previous meta site name (URL slug).
829
+ * @maxLength 255
830
+ */
831
+ oldSiteName?: string;
832
+ }
833
+ /**
834
+ * Hard deletion of the meta site.
835
+ *
836
+ * Could not be restored. Therefore it's desirable to cleanup data.
837
+ */
838
+ interface SiteHardDeleted {
839
+ /** A deletion context. */
840
+ deleteContext?: DeleteContext;
841
+ }
842
+ interface NamespaceChanged {
843
+ /** A previous namespace. */
844
+ oldNamespace?: NamespaceWithLiterals;
845
+ /** A new namespace. */
846
+ newNamespace?: NamespaceWithLiterals;
847
+ }
848
+ /** Assigned Studio editor */
849
+ interface StudioAssigned {
850
+ }
851
+ /** Unassigned Studio editor */
852
+ interface StudioUnassigned {
853
+ }
854
+ /**
855
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
856
+ *
857
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
858
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
859
+ *
860
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
861
+ */
862
+ interface SiteUrlChanged {
863
+ }
864
+ /**
865
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
866
+ * Consumed by other teams to remove relevant data.
867
+ */
868
+ interface SitePurgedExternally {
869
+ /**
870
+ * @maxLength 2048
871
+ * @maxSize 100
872
+ * @deprecated
873
+ * @targetRemovalDate 2025-04-15
874
+ */
875
+ appDefId?: string[];
876
+ }
877
+ /** Assigned Odeditor */
878
+ interface OdeditorAssigned {
879
+ }
880
+ /** Unassigned Odeditor */
881
+ interface OdeditorUnassigned {
882
+ }
883
+ /** Assigned Picasso editor */
884
+ interface PicassoAssigned {
885
+ }
886
+ /** Unassigned Picasso */
887
+ interface PicassoUnassigned {
888
+ }
889
+ /** Assigned Wixel */
890
+ interface WixelAssigned {
891
+ }
892
+ /** Unassigned Wixel */
893
+ interface WixelUnassigned {
894
+ }
895
+ /** Assigned StudioTwo */
896
+ interface StudioTwoAssigned {
897
+ }
898
+ /** Unassigned StudioTwo */
899
+ interface StudioTwoUnassigned {
900
+ }
901
+ interface DomainEvent extends DomainEventBodyOneOf {
902
+ createdEvent?: EntityCreatedEvent;
903
+ updatedEvent?: EntityUpdatedEvent;
904
+ deletedEvent?: EntityDeletedEvent;
905
+ actionEvent?: ActionEvent;
906
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
907
+ _id?: string;
908
+ /**
909
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
910
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
911
+ */
912
+ entityFqdn?: string;
913
+ /**
914
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
915
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
916
+ */
917
+ slug?: string;
918
+ /** ID of the entity associated with the event. */
919
+ entityId?: string;
920
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
921
+ eventTime?: Date | null;
922
+ /**
923
+ * Whether the event was triggered as a result of a privacy regulation application
924
+ * (for example, GDPR).
925
+ */
926
+ triggeredByAnonymizeRequest?: boolean | null;
927
+ /** If present, indicates the action that triggered the event. */
928
+ originatedFrom?: string | null;
929
+ /**
930
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
931
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
932
+ */
933
+ entityEventSequence?: string | null;
934
+ }
935
+ /** @oneof */
936
+ interface DomainEventBodyOneOf {
937
+ createdEvent?: EntityCreatedEvent;
938
+ updatedEvent?: EntityUpdatedEvent;
939
+ deletedEvent?: EntityDeletedEvent;
940
+ actionEvent?: ActionEvent;
941
+ }
942
+ interface EntityCreatedEvent {
943
+ entity?: string;
944
+ }
945
+ interface RestoreInfo {
946
+ deletedDate?: Date | null;
947
+ }
948
+ interface EntityUpdatedEvent {
949
+ /**
950
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
951
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
952
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
953
+ */
954
+ currentEntity?: string;
955
+ }
956
+ interface EntityDeletedEvent {
957
+ /** Entity that was deleted. */
958
+ deletedEntity?: string | null;
959
+ }
960
+ interface ActionEvent {
961
+ body?: string;
962
+ }
963
+ interface MessageEnvelope {
964
+ /**
965
+ * App instance ID.
966
+ * @format GUID
967
+ */
968
+ instanceId?: string | null;
969
+ /**
970
+ * Event type.
971
+ * @maxLength 150
972
+ */
973
+ eventType?: string;
974
+ /** The identification type and identity data. */
975
+ identity?: IdentificationData;
976
+ /** Stringify payload. */
977
+ data?: string;
978
+ }
979
+ interface IdentificationData extends IdentificationDataIdOneOf {
980
+ /**
981
+ * ID of a site visitor that has not logged in to the site.
982
+ * @format GUID
983
+ */
984
+ anonymousVisitorId?: string;
985
+ /**
986
+ * ID of a site visitor that has logged in to the site.
987
+ * @format GUID
988
+ */
989
+ memberId?: string;
990
+ /**
991
+ * ID of a Wix user (site owner, contributor, etc.).
992
+ * @format GUID
993
+ */
994
+ wixUserId?: string;
995
+ /**
996
+ * ID of an app.
997
+ * @format GUID
998
+ */
999
+ appId?: string;
1000
+ /** @readonly */
1001
+ identityType?: WebhookIdentityTypeWithLiterals;
1002
+ }
1003
+ /** @oneof */
1004
+ interface IdentificationDataIdOneOf {
1005
+ /**
1006
+ * ID of a site visitor that has not logged in to the site.
1007
+ * @format GUID
1008
+ */
1009
+ anonymousVisitorId?: string;
1010
+ /**
1011
+ * ID of a site visitor that has logged in to the site.
1012
+ * @format GUID
1013
+ */
1014
+ memberId?: string;
1015
+ /**
1016
+ * ID of a Wix user (site owner, contributor, etc.).
1017
+ * @format GUID
1018
+ */
1019
+ wixUserId?: string;
1020
+ /**
1021
+ * ID of an app.
1022
+ * @format GUID
1023
+ */
1024
+ appId?: string;
1025
+ }
1026
+ declare enum WebhookIdentityType {
1027
+ UNKNOWN = "UNKNOWN",
1028
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1029
+ MEMBER = "MEMBER",
1030
+ WIX_USER = "WIX_USER",
1031
+ APP = "APP"
1032
+ }
1033
+ /** @enumType */
1034
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1035
+ interface UpdatePaymentAcceptanceConfiguration {
1036
+ /**
1037
+ * Id
1038
+ * @format GUID
1039
+ * @readonly
1040
+ * @immutable
1041
+ */
1042
+ _id?: string | null;
1043
+ /**
1044
+ * App id
1045
+ * @format GUID
1046
+ * @immutable
1047
+ */
1048
+ appId?: string | null;
1049
+ /**
1050
+ * Rules
1051
+ * @maxSize 1000
1052
+ */
1053
+ rules?: PaymentAcceptanceRule[];
1054
+ /**
1055
+ * Revision
1056
+ * @readonly
1057
+ */
1058
+ revision?: string | null;
1059
+ /**
1060
+ * Date when PaymentAcceptanceConfiguration was created
1061
+ * @readonly
1062
+ * @immutable
1063
+ */
1064
+ _createdDate?: Date | null;
1065
+ /**
1066
+ * Date when PaymentAcceptanceConfiguration was updated
1067
+ * @readonly
1068
+ */
1069
+ _updatedDate?: Date | null;
1070
+ /** Data Extensions */
1071
+ extendedFields?: ExtendedFields;
1072
+ /** Tags */
1073
+ tags?: Tags;
1074
+ }
1075
+ interface AddPaymentAcceptanceConfigurationRulesOptions {
1076
+ /**
1077
+ * Payment acceptance configuration revision
1078
+ * @readonly
1079
+ */
1080
+ paymentAcceptanceConfigurationRevision?: string | null;
1081
+ /**
1082
+ * Rules to add
1083
+ * @minSize 1
1084
+ * @maxSize 1000
1085
+ */
1086
+ rules: PaymentAcceptanceRule[];
1087
+ }
1088
+ interface RemovePaymentAcceptanceConfigurationRulesOptions {
1089
+ /**
1090
+ * Payment acceptance configuration revision
1091
+ * @readonly
1092
+ */
1093
+ paymentAcceptanceConfigurationRevision?: string | null;
1094
+ /**
1095
+ * IDs of the rules to remove
1096
+ * @format GUID
1097
+ * @minSize 1
1098
+ * @maxSize 1000
1099
+ */
1100
+ ruleIds: string[];
1101
+ }
1102
+ interface QueryCursorResult {
1103
+ cursors: Cursors;
1104
+ hasNext: () => boolean;
1105
+ hasPrev: () => boolean;
1106
+ length: number;
1107
+ pageSize: number;
1108
+ }
1109
+ interface PaymentAcceptanceConfigurationsQueryResult extends QueryCursorResult {
1110
+ items: PaymentAcceptanceConfiguration[];
1111
+ query: PaymentAcceptanceConfigurationsQueryBuilder;
1112
+ next: () => Promise<PaymentAcceptanceConfigurationsQueryResult>;
1113
+ prev: () => Promise<PaymentAcceptanceConfigurationsQueryResult>;
1114
+ }
1115
+ interface PaymentAcceptanceConfigurationsQueryBuilder {
1116
+ /** @param propertyName - Property whose value is compared with `value`.
1117
+ * @param value - Value to compare against.
1118
+ * @documentationMaturity preview
1119
+ */
1120
+ eq: (propertyName: '_id' | 'appId' | 'rules.paymentMethodTypeId' | 'rules.accountConnectionId' | 'rules.merchantEnabled' | '_createdDate' | '_updatedDate', value: any) => PaymentAcceptanceConfigurationsQueryBuilder;
1121
+ /** @param propertyName - Property whose value is compared with `value`.
1122
+ * @param value - Value to compare against.
1123
+ * @documentationMaturity preview
1124
+ */
1125
+ ne: (propertyName: '_id' | 'appId' | 'rules.paymentMethodTypeId' | 'rules.accountConnectionId' | 'rules.merchantEnabled' | '_createdDate' | '_updatedDate', value: any) => PaymentAcceptanceConfigurationsQueryBuilder;
1126
+ /** @param propertyName - Property whose value is compared with `value`.
1127
+ * @param value - Value to compare against.
1128
+ * @documentationMaturity preview
1129
+ */
1130
+ ge: (propertyName: '_id' | 'appId' | 'rules.paymentMethodTypeId' | 'rules.accountConnectionId' | '_createdDate' | '_updatedDate', value: any) => PaymentAcceptanceConfigurationsQueryBuilder;
1131
+ /** @param propertyName - Property whose value is compared with `value`.
1132
+ * @param value - Value to compare against.
1133
+ * @documentationMaturity preview
1134
+ */
1135
+ gt: (propertyName: '_id' | 'appId' | 'rules.paymentMethodTypeId' | 'rules.accountConnectionId' | '_createdDate' | '_updatedDate', value: any) => PaymentAcceptanceConfigurationsQueryBuilder;
1136
+ /** @param propertyName - Property whose value is compared with `value`.
1137
+ * @param value - Value to compare against.
1138
+ * @documentationMaturity preview
1139
+ */
1140
+ le: (propertyName: '_id' | 'appId' | 'rules.paymentMethodTypeId' | 'rules.accountConnectionId' | '_createdDate' | '_updatedDate', value: any) => PaymentAcceptanceConfigurationsQueryBuilder;
1141
+ /** @param propertyName - Property whose value is compared with `value`.
1142
+ * @param value - Value to compare against.
1143
+ * @documentationMaturity preview
1144
+ */
1145
+ lt: (propertyName: '_id' | 'appId' | 'rules.paymentMethodTypeId' | 'rules.accountConnectionId' | '_createdDate' | '_updatedDate', value: any) => PaymentAcceptanceConfigurationsQueryBuilder;
1146
+ /** @param propertyName - Property whose value is compared with `string`.
1147
+ * @param string - String to compare against. Case-insensitive.
1148
+ * @documentationMaturity preview
1149
+ */
1150
+ startsWith: (propertyName: '_id' | 'appId' | 'rules.paymentMethodTypeId' | 'rules.accountConnectionId', value: string) => PaymentAcceptanceConfigurationsQueryBuilder;
1151
+ /** @param propertyName - Property whose value is compared with `values`.
1152
+ * @param values - List of values to compare against.
1153
+ * @documentationMaturity preview
1154
+ */
1155
+ hasSome: (propertyName: '_id' | 'appId' | 'rules.paymentMethodTypeId' | 'rules.accountConnectionId' | 'rules.merchantEnabled' | '_createdDate' | '_updatedDate', value: any[]) => PaymentAcceptanceConfigurationsQueryBuilder;
1156
+ /** @documentationMaturity preview */
1157
+ in: (propertyName: '_id' | 'appId' | 'rules.paymentMethodTypeId' | 'rules.accountConnectionId' | 'rules.merchantEnabled' | '_createdDate' | '_updatedDate', value: any) => PaymentAcceptanceConfigurationsQueryBuilder;
1158
+ /** @documentationMaturity preview */
1159
+ exists: (propertyName: '_id' | 'appId' | 'rules.paymentMethodTypeId' | 'rules.accountConnectionId' | 'rules.merchantEnabled' | '_createdDate' | '_updatedDate', value: boolean) => PaymentAcceptanceConfigurationsQueryBuilder;
1160
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1161
+ * @documentationMaturity preview
1162
+ */
1163
+ ascending: (...propertyNames: Array<'_id' | 'appId' | 'rules.paymentMethodTypeId' | 'rules.accountConnectionId' | 'rules.merchantEnabled' | '_createdDate' | '_updatedDate'>) => PaymentAcceptanceConfigurationsQueryBuilder;
1164
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1165
+ * @documentationMaturity preview
1166
+ */
1167
+ descending: (...propertyNames: Array<'_id' | 'appId' | 'rules.paymentMethodTypeId' | 'rules.accountConnectionId' | 'rules.merchantEnabled' | '_createdDate' | '_updatedDate'>) => PaymentAcceptanceConfigurationsQueryBuilder;
1168
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
1169
+ * @documentationMaturity preview
1170
+ */
1171
+ limit: (limit: number) => PaymentAcceptanceConfigurationsQueryBuilder;
1172
+ /** @param cursor - A pointer to specific record
1173
+ * @documentationMaturity preview
1174
+ */
1175
+ skipTo: (cursor: string) => PaymentAcceptanceConfigurationsQueryBuilder;
1176
+ /** @documentationMaturity preview */
1177
+ find: () => Promise<PaymentAcceptanceConfigurationsQueryResult>;
1178
+ }
1179
+ /**
1180
+ * @hidden
1181
+ * @fqn wix.payments.payment_acceptance_configurations.v1.PaymentAcceptanceConfigurationService.QueryPaymentAcceptanceConfigurations
1182
+ * @requiredField query
1183
+ */
1184
+ declare function typedQueryPaymentAcceptanceConfigurations(query: CursorQuery): Promise<NonNullablePaths<QueryPaymentAcceptanceConfigurationsResponse, `paymentAcceptanceConfigurations`, 2>>;
1185
+ interface BulkUpdatePaymentAcceptanceConfigurationTagsOptions {
1186
+ /** List of Tags to assign */
1187
+ assignTags?: Tags;
1188
+ /** List of Tags to unAssign */
1189
+ unassignTags?: Tags;
1190
+ }
1191
+ interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterOptions {
1192
+ /** List of Tags to assign */
1193
+ assignTags?: Tags;
1194
+ /** List of Tags to unAssign */
1195
+ unassignTags?: Tags;
1196
+ }
1197
+
1198
+ export { type ActionEvent, type AddPaymentAcceptanceConfigurationRulesOptions, type AddPaymentAcceptanceConfigurationRulesRequest, type AddPaymentAcceptanceConfigurationRulesResponse, type ApplicationError, type Asset, type BulkActionMetadata, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterOptions, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse, type BulkUpdatePaymentAcceptanceConfigurationTagsOptions, type BulkUpdatePaymentAcceptanceConfigurationTagsRequest, type BulkUpdatePaymentAcceptanceConfigurationTagsResponse, type BulkUpdatePaymentAcceptanceConfigurationTagsResult, type Countries, type CreatePaymentAcceptanceConfigurationRequest, type CreatePaymentAcceptanceConfigurationResponse, type Currencies, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteContext, type DeletePaymentAcceptanceConfigurationRequest, type DeletePaymentAcceptanceConfigurationResponse, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetPaymentAcceptanceConfigurationRequest, type GetPaymentAcceptanceConfigurationResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type PaymentAcceptanceConfiguration, type PaymentAcceptanceConfigurationsQueryBuilder, type PaymentAcceptanceConfigurationsQueryResult, type PaymentAcceptanceRule, type PaymentBrands, type PicassoAssigned, type PicassoUnassigned, type QueryPaymentAcceptanceConfigurationsRequest, type QueryPaymentAcceptanceConfigurationsResponse, type RemovePaymentAcceptanceConfigurationRulesOptions, type RemovePaymentAcceptanceConfigurationRulesRequest, type RemovePaymentAcceptanceConfigurationRulesResponse, type RestoreInfo, type Restrictions, type RestrictionsCountriesOneOf, type RestrictionsCurrenciesOneOf, type RestrictionsPaymentBrandsOneOf, type ServiceProvisioned, type ServiceRemoved, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type TagList, type Tags, type UpdatePaymentAcceptanceConfiguration, type UpdatePaymentAcceptanceConfigurationRequest, type UpdatePaymentAcceptanceConfigurationResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, typedQueryPaymentAcceptanceConfigurations };