@wix/stores 1.0.213 → 1.0.214

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/stores",
3
- "version": "1.0.213",
3
+ "version": "1.0.214",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -20,13 +20,13 @@
20
20
  "dependencies": {
21
21
  "@wix/stores_brands-v-3": "1.0.9",
22
22
  "@wix/stores_catalog-provision": "1.0.10",
23
- "@wix/stores_collections": "1.0.33",
23
+ "@wix/stores_collections": "1.0.34",
24
24
  "@wix/stores_customizations-v-3": "1.0.10",
25
25
  "@wix/stores_info-sections-v-3": "1.0.9",
26
26
  "@wix/stores_inventory": "1.0.38",
27
27
  "@wix/stores_inventory-items-v-3": "1.0.12",
28
28
  "@wix/stores_products": "1.0.48",
29
- "@wix/stores_products-v-3": "1.0.29",
29
+ "@wix/stores_products-v-3": "1.0.30",
30
30
  "@wix/stores_ribbons-v-3": "1.0.10",
31
31
  "@wix/stores_stores-locations-v-3": "1.0.11",
32
32
  "@wix/stores_subscription-options": "1.0.35",
@@ -55,5 +55,5 @@
55
55
  "fqdn": ""
56
56
  }
57
57
  },
58
- "falconPackageHash": "0b1e23e8e695d318cdb6950100f8ec7da8b3d2246a88e87b9b22792b"
58
+ "falconPackageHash": "0b32a4585861f53e8046580bdeb3ec1e2fca47ad1bbe14a3207550e1"
59
59
  }
@@ -135,17 +135,17 @@ interface GetWishlistsResponse {
135
135
  /** List result of requested wishlists */
136
136
  wishlists?: WishlistData[];
137
137
  }
138
- interface MessageEnvelope$a {
138
+ interface MessageEnvelope$b {
139
139
  /** App instance ID. */
140
140
  instanceId?: string | null;
141
141
  /** Event type. */
142
142
  eventType?: string;
143
143
  /** The identification type and identity data. */
144
- identity?: IdentificationData$a;
144
+ identity?: IdentificationData$b;
145
145
  /** Stringify payload. */
146
146
  data?: string;
147
147
  }
148
- interface IdentificationData$a extends IdentificationDataIdOneOf$a {
148
+ interface IdentificationData$b extends IdentificationDataIdOneOf$b {
149
149
  /** ID of a site visitor that has not logged in to the site. */
150
150
  anonymousVisitorId?: string;
151
151
  /** ID of a site visitor that has logged in to the site. */
@@ -155,10 +155,10 @@ interface IdentificationData$a extends IdentificationDataIdOneOf$a {
155
155
  /** ID of an app. */
156
156
  appId?: string;
157
157
  /** @readonly */
158
- identityType?: WebhookIdentityType$a;
158
+ identityType?: WebhookIdentityType$b;
159
159
  }
160
160
  /** @oneof */
161
- interface IdentificationDataIdOneOf$a {
161
+ interface IdentificationDataIdOneOf$b {
162
162
  /** ID of a site visitor that has not logged in to the site. */
163
163
  anonymousVisitorId?: string;
164
164
  /** ID of a site visitor that has logged in to the site. */
@@ -168,7 +168,7 @@ interface IdentificationDataIdOneOf$a {
168
168
  /** ID of an app. */
169
169
  appId?: string;
170
170
  }
171
- declare enum WebhookIdentityType$a {
171
+ declare enum WebhookIdentityType$b {
172
172
  UNKNOWN = "UNKNOWN",
173
173
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
174
174
  MEMBER = "MEMBER",
@@ -229,7 +229,7 @@ type context$c_WishlistItem = WishlistItem;
229
229
  type context$c_WishlistItemKind = WishlistItemKind;
230
230
  declare const context$c_getWishlistById: typeof getWishlistById;
231
231
  declare namespace context$c {
232
- export { type context$c_AddToWishlistRequest as AddToWishlistRequest, type context$c_AddToWishlistResponse as AddToWishlistResponse, type context$c_GetWishlistByIdOptions as GetWishlistByIdOptions, type context$c_GetWishlistByIdRequest as GetWishlistByIdRequest, type context$c_GetWishlistByIdResponse as GetWishlistByIdResponse, type context$c_GetWishlistByIdResponseNonNullableFields as GetWishlistByIdResponseNonNullableFields, type context$c_GetWishlistRequest as GetWishlistRequest, type context$c_GetWishlistResponse as GetWishlistResponse, type context$c_GetWishlistsRequest as GetWishlistsRequest, type context$c_GetWishlistsResponse as GetWishlistsResponse, type IdentificationData$a as IdentificationData, type IdentificationDataIdOneOf$a as IdentificationDataIdOneOf, type context$c_ItemsAddedToWishlist as ItemsAddedToWishlist, type context$c_ItemsRemovedFromWishlist as ItemsRemovedFromWishlist, type MessageEnvelope$a as MessageEnvelope, type context$c_RemoveFromWishlistRequest as RemoveFromWishlistRequest, type context$c_RemoveFromWishlistResponse as RemoveFromWishlistResponse, WebhookIdentityType$a as WebhookIdentityType, type context$c_WishlistData as WishlistData, type context$c_WishlistDataNonNullableFields as WishlistDataNonNullableFields, type context$c_WishlistItem as WishlistItem, type context$c_WishlistItemKind as WishlistItemKind, context$c_getWishlistById as getWishlistById };
232
+ export { type context$c_AddToWishlistRequest as AddToWishlistRequest, type context$c_AddToWishlistResponse as AddToWishlistResponse, type context$c_GetWishlistByIdOptions as GetWishlistByIdOptions, type context$c_GetWishlistByIdRequest as GetWishlistByIdRequest, type context$c_GetWishlistByIdResponse as GetWishlistByIdResponse, type context$c_GetWishlistByIdResponseNonNullableFields as GetWishlistByIdResponseNonNullableFields, type context$c_GetWishlistRequest as GetWishlistRequest, type context$c_GetWishlistResponse as GetWishlistResponse, type context$c_GetWishlistsRequest as GetWishlistsRequest, type context$c_GetWishlistsResponse as GetWishlistsResponse, type IdentificationData$b as IdentificationData, type IdentificationDataIdOneOf$b as IdentificationDataIdOneOf, type context$c_ItemsAddedToWishlist as ItemsAddedToWishlist, type context$c_ItemsRemovedFromWishlist as ItemsRemovedFromWishlist, type MessageEnvelope$b as MessageEnvelope, type context$c_RemoveFromWishlistRequest as RemoveFromWishlistRequest, type context$c_RemoveFromWishlistResponse as RemoveFromWishlistResponse, WebhookIdentityType$b as WebhookIdentityType, type context$c_WishlistData as WishlistData, type context$c_WishlistDataNonNullableFields as WishlistDataNonNullableFields, type context$c_WishlistItem as WishlistItem, type context$c_WishlistItemKind as WishlistItemKind, context$c_getWishlistById as getWishlistById };
233
233
  }
234
234
 
235
235
  interface Collection$1 {
@@ -444,6 +444,116 @@ interface GetCollectionBySlugResponse$1 {
444
444
  /** The requested collection. */
445
445
  collection?: Collection$1;
446
446
  }
447
+ interface DomainEvent$8 extends DomainEventBodyOneOf$8 {
448
+ createdEvent?: EntityCreatedEvent$8;
449
+ updatedEvent?: EntityUpdatedEvent$8;
450
+ deletedEvent?: EntityDeletedEvent$8;
451
+ actionEvent?: ActionEvent$8;
452
+ /**
453
+ * Unique event ID.
454
+ * Allows clients to ignore duplicate webhooks.
455
+ */
456
+ _id?: string;
457
+ /**
458
+ * Assumes actions are also always typed to an entity_type
459
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
460
+ */
461
+ entityFqdn?: string;
462
+ /**
463
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
464
+ * This is although the created/updated/deleted notion is duplication of the oneof types
465
+ * Example: created/updated/deleted/started/completed/email_opened
466
+ */
467
+ slug?: string;
468
+ /** ID of the entity associated with the event. */
469
+ entityId?: string;
470
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
471
+ eventTime?: Date;
472
+ /**
473
+ * Whether the event was triggered as a result of a privacy regulation application
474
+ * (for example, GDPR).
475
+ */
476
+ triggeredByAnonymizeRequest?: boolean | null;
477
+ /** If present, indicates the action that triggered the event. */
478
+ originatedFrom?: string | null;
479
+ /**
480
+ * A sequence number defining the order of updates to the underlying entity.
481
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
482
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
483
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
484
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
485
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
486
+ */
487
+ entityEventSequence?: string | null;
488
+ }
489
+ /** @oneof */
490
+ interface DomainEventBodyOneOf$8 {
491
+ createdEvent?: EntityCreatedEvent$8;
492
+ updatedEvent?: EntityUpdatedEvent$8;
493
+ deletedEvent?: EntityDeletedEvent$8;
494
+ actionEvent?: ActionEvent$8;
495
+ }
496
+ interface EntityCreatedEvent$8 {
497
+ entity?: string;
498
+ }
499
+ interface RestoreInfo$8 {
500
+ deletedDate?: Date;
501
+ }
502
+ interface EntityUpdatedEvent$8 {
503
+ /**
504
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
505
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
506
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
507
+ */
508
+ currentEntity?: string;
509
+ }
510
+ interface EntityDeletedEvent$8 {
511
+ /** Entity that was deleted */
512
+ deletedEntity?: string | null;
513
+ }
514
+ interface ActionEvent$8 {
515
+ body?: string;
516
+ }
517
+ interface MessageEnvelope$a {
518
+ /** App instance ID. */
519
+ instanceId?: string | null;
520
+ /** Event type. */
521
+ eventType?: string;
522
+ /** The identification type and identity data. */
523
+ identity?: IdentificationData$a;
524
+ /** Stringify payload. */
525
+ data?: string;
526
+ }
527
+ interface IdentificationData$a extends IdentificationDataIdOneOf$a {
528
+ /** ID of a site visitor that has not logged in to the site. */
529
+ anonymousVisitorId?: string;
530
+ /** ID of a site visitor that has logged in to the site. */
531
+ memberId?: string;
532
+ /** ID of a Wix user (site owner, contributor, etc.). */
533
+ wixUserId?: string;
534
+ /** ID of an app. */
535
+ appId?: string;
536
+ /** @readonly */
537
+ identityType?: WebhookIdentityType$a;
538
+ }
539
+ /** @oneof */
540
+ interface IdentificationDataIdOneOf$a {
541
+ /** ID of a site visitor that has not logged in to the site. */
542
+ anonymousVisitorId?: string;
543
+ /** ID of a site visitor that has logged in to the site. */
544
+ memberId?: string;
545
+ /** ID of a Wix user (site owner, contributor, etc.). */
546
+ wixUserId?: string;
547
+ /** ID of an app. */
548
+ appId?: string;
549
+ }
550
+ declare enum WebhookIdentityType$a {
551
+ UNKNOWN = "UNKNOWN",
552
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
553
+ MEMBER = "MEMBER",
554
+ WIX_USER = "WIX_USER",
555
+ APP = "APP"
556
+ }
447
557
  interface MediaItemUrlAndSizeNonNullableFields$1 {
448
558
  url: string;
449
559
  width: number;
@@ -593,7 +703,7 @@ type context$b_QueryCollectionsResponseNonNullableFields = QueryCollectionsRespo
593
703
  declare const context$b_getCollection: typeof getCollection;
594
704
  declare const context$b_queryCollections: typeof queryCollections;
595
705
  declare namespace context$b {
596
- export { type Collection$1 as Collection, type CollectionNonNullableFields$1 as CollectionNonNullableFields, type context$b_CollectionsQueryBuilder as CollectionsQueryBuilder, type context$b_CollectionsQueryResult as CollectionsQueryResult, type CursorPaging$8 as CursorPaging, type Cursors$8 as Cursors, type GetCollectionBySlugRequest$1 as GetCollectionBySlugRequest, type GetCollectionBySlugResponse$1 as GetCollectionBySlugResponse, type GetCollectionBySlugResponseNonNullableFields$1 as GetCollectionBySlugResponseNonNullableFields, type GetCollectionRequest$1 as GetCollectionRequest, type GetCollectionResponse$1 as GetCollectionResponse, type context$b_GetCollectionResponseNonNullableFields as GetCollectionResponseNonNullableFields, type Keyword$2 as Keyword, type Media$3 as Media, type MediaItem$1 as MediaItem, type MediaItemItemOneOf$1 as MediaItemItemOneOf, MediaItemType$1 as MediaItemType, type MediaItemUrlAndSize$1 as MediaItemUrlAndSize, type MediaItemVideo$1 as MediaItemVideo, type PlatformPaging$3 as PlatformPaging, type PlatformPagingMetadata$1 as PlatformPagingMetadata, type PlatformQuery$1 as PlatformQuery, type PlatformQueryPagingMethodOneOf$1 as PlatformQueryPagingMethodOneOf, type QueryCollectionsRequest$1 as QueryCollectionsRequest, type QueryCollectionsResponse$1 as QueryCollectionsResponse, type context$b_QueryCollectionsResponseNonNullableFields as QueryCollectionsResponseNonNullableFields, type SeoSchema$2 as SeoSchema, type Settings$3 as Settings, SortOrder$8 as SortOrder, type Sorting$8 as Sorting, type Tag$2 as Tag, context$b_getCollection as getCollection, getCollectionBySlug$2 as getCollectionBySlug, context$b_queryCollections as queryCollections };
706
+ export { type ActionEvent$8 as ActionEvent, type Collection$1 as Collection, type CollectionNonNullableFields$1 as CollectionNonNullableFields, type context$b_CollectionsQueryBuilder as CollectionsQueryBuilder, type context$b_CollectionsQueryResult as CollectionsQueryResult, type CursorPaging$8 as CursorPaging, type Cursors$8 as Cursors, type DomainEvent$8 as DomainEvent, type DomainEventBodyOneOf$8 as DomainEventBodyOneOf, type EntityCreatedEvent$8 as EntityCreatedEvent, type EntityDeletedEvent$8 as EntityDeletedEvent, type EntityUpdatedEvent$8 as EntityUpdatedEvent, type GetCollectionBySlugRequest$1 as GetCollectionBySlugRequest, type GetCollectionBySlugResponse$1 as GetCollectionBySlugResponse, type GetCollectionBySlugResponseNonNullableFields$1 as GetCollectionBySlugResponseNonNullableFields, type GetCollectionRequest$1 as GetCollectionRequest, type GetCollectionResponse$1 as GetCollectionResponse, type context$b_GetCollectionResponseNonNullableFields as GetCollectionResponseNonNullableFields, type IdentificationData$a as IdentificationData, type IdentificationDataIdOneOf$a as IdentificationDataIdOneOf, type Keyword$2 as Keyword, type Media$3 as Media, type MediaItem$1 as MediaItem, type MediaItemItemOneOf$1 as MediaItemItemOneOf, MediaItemType$1 as MediaItemType, type MediaItemUrlAndSize$1 as MediaItemUrlAndSize, type MediaItemVideo$1 as MediaItemVideo, type MessageEnvelope$a as MessageEnvelope, type PlatformPaging$3 as PlatformPaging, type PlatformPagingMetadata$1 as PlatformPagingMetadata, type PlatformQuery$1 as PlatformQuery, type PlatformQueryPagingMethodOneOf$1 as PlatformQueryPagingMethodOneOf, type QueryCollectionsRequest$1 as QueryCollectionsRequest, type QueryCollectionsResponse$1 as QueryCollectionsResponse, type context$b_QueryCollectionsResponseNonNullableFields as QueryCollectionsResponseNonNullableFields, type RestoreInfo$8 as RestoreInfo, type SeoSchema$2 as SeoSchema, type Settings$3 as Settings, SortOrder$8 as SortOrder, type Sorting$8 as Sorting, type Tag$2 as Tag, WebhookIdentityType$a as WebhookIdentityType, context$b_getCollection as getCollection, getCollectionBySlug$2 as getCollectionBySlug, context$b_queryCollections as queryCollections };
597
707
  }
598
708
 
599
709
  interface Product$2 {
@@ -11667,9 +11777,9 @@ interface Inventory {
11667
11777
  preorderStatus?: PreorderStatus;
11668
11778
  /**
11669
11779
  * Supported values:
11670
- * + ALL_VARIANTS: All the product variants are available for preorder.
11671
- * + NO_VARIANTS: None of the product variants are available for preorder.
11672
- * + SOME_VARIANTS: Some of the product variants are available for preorder.
11780
+ * + `ALL_VARIANTS`: All the product variants are available for preorder.
11781
+ * + `NO_VARIANTS`: None of the product variants are available for preorder.
11782
+ * + `SOME_VARIANTS`: Some of the product variants are available for preorder.
11673
11783
  * @readonly
11674
11784
  */
11675
11785
  preorderAvailability?: ProductPreorderAvailability;
@@ -135,17 +135,17 @@ interface GetWishlistsResponse {
135
135
  /** List result of requested wishlists */
136
136
  wishlists?: WishlistData[];
137
137
  }
138
- interface MessageEnvelope$a {
138
+ interface MessageEnvelope$b {
139
139
  /** App instance ID. */
140
140
  instanceId?: string | null;
141
141
  /** Event type. */
142
142
  eventType?: string;
143
143
  /** The identification type and identity data. */
144
- identity?: IdentificationData$a;
144
+ identity?: IdentificationData$b;
145
145
  /** Stringify payload. */
146
146
  data?: string;
147
147
  }
148
- interface IdentificationData$a extends IdentificationDataIdOneOf$a {
148
+ interface IdentificationData$b extends IdentificationDataIdOneOf$b {
149
149
  /** ID of a site visitor that has not logged in to the site. */
150
150
  anonymousVisitorId?: string;
151
151
  /** ID of a site visitor that has logged in to the site. */
@@ -155,10 +155,10 @@ interface IdentificationData$a extends IdentificationDataIdOneOf$a {
155
155
  /** ID of an app. */
156
156
  appId?: string;
157
157
  /** @readonly */
158
- identityType?: WebhookIdentityType$a;
158
+ identityType?: WebhookIdentityType$b;
159
159
  }
160
160
  /** @oneof */
161
- interface IdentificationDataIdOneOf$a {
161
+ interface IdentificationDataIdOneOf$b {
162
162
  /** ID of a site visitor that has not logged in to the site. */
163
163
  anonymousVisitorId?: string;
164
164
  /** ID of a site visitor that has logged in to the site. */
@@ -168,7 +168,7 @@ interface IdentificationDataIdOneOf$a {
168
168
  /** ID of an app. */
169
169
  appId?: string;
170
170
  }
171
- declare enum WebhookIdentityType$a {
171
+ declare enum WebhookIdentityType$b {
172
172
  UNKNOWN = "UNKNOWN",
173
173
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
174
174
  MEMBER = "MEMBER",
@@ -229,7 +229,7 @@ type index_d$c_WishlistItem = WishlistItem;
229
229
  type index_d$c_WishlistItemKind = WishlistItemKind;
230
230
  declare const index_d$c_getWishlistById: typeof getWishlistById;
231
231
  declare namespace index_d$c {
232
- export { type index_d$c_AddToWishlistRequest as AddToWishlistRequest, type index_d$c_AddToWishlistResponse as AddToWishlistResponse, type index_d$c_GetWishlistByIdOptions as GetWishlistByIdOptions, type index_d$c_GetWishlistByIdRequest as GetWishlistByIdRequest, type index_d$c_GetWishlistByIdResponse as GetWishlistByIdResponse, type index_d$c_GetWishlistByIdResponseNonNullableFields as GetWishlistByIdResponseNonNullableFields, type index_d$c_GetWishlistRequest as GetWishlistRequest, type index_d$c_GetWishlistResponse as GetWishlistResponse, type index_d$c_GetWishlistsRequest as GetWishlistsRequest, type index_d$c_GetWishlistsResponse as GetWishlistsResponse, type IdentificationData$a as IdentificationData, type IdentificationDataIdOneOf$a as IdentificationDataIdOneOf, type index_d$c_ItemsAddedToWishlist as ItemsAddedToWishlist, type index_d$c_ItemsRemovedFromWishlist as ItemsRemovedFromWishlist, type MessageEnvelope$a as MessageEnvelope, type index_d$c_RemoveFromWishlistRequest as RemoveFromWishlistRequest, type index_d$c_RemoveFromWishlistResponse as RemoveFromWishlistResponse, WebhookIdentityType$a as WebhookIdentityType, type index_d$c_WishlistData as WishlistData, type index_d$c_WishlistDataNonNullableFields as WishlistDataNonNullableFields, type index_d$c_WishlistItem as WishlistItem, type index_d$c_WishlistItemKind as WishlistItemKind, index_d$c_getWishlistById as getWishlistById };
232
+ export { type index_d$c_AddToWishlistRequest as AddToWishlistRequest, type index_d$c_AddToWishlistResponse as AddToWishlistResponse, type index_d$c_GetWishlistByIdOptions as GetWishlistByIdOptions, type index_d$c_GetWishlistByIdRequest as GetWishlistByIdRequest, type index_d$c_GetWishlistByIdResponse as GetWishlistByIdResponse, type index_d$c_GetWishlistByIdResponseNonNullableFields as GetWishlistByIdResponseNonNullableFields, type index_d$c_GetWishlistRequest as GetWishlistRequest, type index_d$c_GetWishlistResponse as GetWishlistResponse, type index_d$c_GetWishlistsRequest as GetWishlistsRequest, type index_d$c_GetWishlistsResponse as GetWishlistsResponse, type IdentificationData$b as IdentificationData, type IdentificationDataIdOneOf$b as IdentificationDataIdOneOf, type index_d$c_ItemsAddedToWishlist as ItemsAddedToWishlist, type index_d$c_ItemsRemovedFromWishlist as ItemsRemovedFromWishlist, type MessageEnvelope$b as MessageEnvelope, type index_d$c_RemoveFromWishlistRequest as RemoveFromWishlistRequest, type index_d$c_RemoveFromWishlistResponse as RemoveFromWishlistResponse, WebhookIdentityType$b as WebhookIdentityType, type index_d$c_WishlistData as WishlistData, type index_d$c_WishlistDataNonNullableFields as WishlistDataNonNullableFields, type index_d$c_WishlistItem as WishlistItem, type index_d$c_WishlistItemKind as WishlistItemKind, index_d$c_getWishlistById as getWishlistById };
233
233
  }
234
234
 
235
235
  interface Collection$1 {
@@ -444,6 +444,116 @@ interface GetCollectionBySlugResponse$1 {
444
444
  /** The requested collection. */
445
445
  collection?: Collection$1;
446
446
  }
447
+ interface DomainEvent$8 extends DomainEventBodyOneOf$8 {
448
+ createdEvent?: EntityCreatedEvent$8;
449
+ updatedEvent?: EntityUpdatedEvent$8;
450
+ deletedEvent?: EntityDeletedEvent$8;
451
+ actionEvent?: ActionEvent$8;
452
+ /**
453
+ * Unique event ID.
454
+ * Allows clients to ignore duplicate webhooks.
455
+ */
456
+ _id?: string;
457
+ /**
458
+ * Assumes actions are also always typed to an entity_type
459
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
460
+ */
461
+ entityFqdn?: string;
462
+ /**
463
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
464
+ * This is although the created/updated/deleted notion is duplication of the oneof types
465
+ * Example: created/updated/deleted/started/completed/email_opened
466
+ */
467
+ slug?: string;
468
+ /** ID of the entity associated with the event. */
469
+ entityId?: string;
470
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
471
+ eventTime?: Date;
472
+ /**
473
+ * Whether the event was triggered as a result of a privacy regulation application
474
+ * (for example, GDPR).
475
+ */
476
+ triggeredByAnonymizeRequest?: boolean | null;
477
+ /** If present, indicates the action that triggered the event. */
478
+ originatedFrom?: string | null;
479
+ /**
480
+ * A sequence number defining the order of updates to the underlying entity.
481
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
482
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
483
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
484
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
485
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
486
+ */
487
+ entityEventSequence?: string | null;
488
+ }
489
+ /** @oneof */
490
+ interface DomainEventBodyOneOf$8 {
491
+ createdEvent?: EntityCreatedEvent$8;
492
+ updatedEvent?: EntityUpdatedEvent$8;
493
+ deletedEvent?: EntityDeletedEvent$8;
494
+ actionEvent?: ActionEvent$8;
495
+ }
496
+ interface EntityCreatedEvent$8 {
497
+ entity?: string;
498
+ }
499
+ interface RestoreInfo$8 {
500
+ deletedDate?: Date;
501
+ }
502
+ interface EntityUpdatedEvent$8 {
503
+ /**
504
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
505
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
506
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
507
+ */
508
+ currentEntity?: string;
509
+ }
510
+ interface EntityDeletedEvent$8 {
511
+ /** Entity that was deleted */
512
+ deletedEntity?: string | null;
513
+ }
514
+ interface ActionEvent$8 {
515
+ body?: string;
516
+ }
517
+ interface MessageEnvelope$a {
518
+ /** App instance ID. */
519
+ instanceId?: string | null;
520
+ /** Event type. */
521
+ eventType?: string;
522
+ /** The identification type and identity data. */
523
+ identity?: IdentificationData$a;
524
+ /** Stringify payload. */
525
+ data?: string;
526
+ }
527
+ interface IdentificationData$a extends IdentificationDataIdOneOf$a {
528
+ /** ID of a site visitor that has not logged in to the site. */
529
+ anonymousVisitorId?: string;
530
+ /** ID of a site visitor that has logged in to the site. */
531
+ memberId?: string;
532
+ /** ID of a Wix user (site owner, contributor, etc.). */
533
+ wixUserId?: string;
534
+ /** ID of an app. */
535
+ appId?: string;
536
+ /** @readonly */
537
+ identityType?: WebhookIdentityType$a;
538
+ }
539
+ /** @oneof */
540
+ interface IdentificationDataIdOneOf$a {
541
+ /** ID of a site visitor that has not logged in to the site. */
542
+ anonymousVisitorId?: string;
543
+ /** ID of a site visitor that has logged in to the site. */
544
+ memberId?: string;
545
+ /** ID of a Wix user (site owner, contributor, etc.). */
546
+ wixUserId?: string;
547
+ /** ID of an app. */
548
+ appId?: string;
549
+ }
550
+ declare enum WebhookIdentityType$a {
551
+ UNKNOWN = "UNKNOWN",
552
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
553
+ MEMBER = "MEMBER",
554
+ WIX_USER = "WIX_USER",
555
+ APP = "APP"
556
+ }
447
557
  interface MediaItemUrlAndSizeNonNullableFields$1 {
448
558
  url: string;
449
559
  width: number;
@@ -593,7 +703,7 @@ type index_d$b_QueryCollectionsResponseNonNullableFields = QueryCollectionsRespo
593
703
  declare const index_d$b_getCollection: typeof getCollection;
594
704
  declare const index_d$b_queryCollections: typeof queryCollections;
595
705
  declare namespace index_d$b {
596
- export { type Collection$1 as Collection, type CollectionNonNullableFields$1 as CollectionNonNullableFields, type index_d$b_CollectionsQueryBuilder as CollectionsQueryBuilder, type index_d$b_CollectionsQueryResult as CollectionsQueryResult, type CursorPaging$8 as CursorPaging, type Cursors$8 as Cursors, type GetCollectionBySlugRequest$1 as GetCollectionBySlugRequest, type GetCollectionBySlugResponse$1 as GetCollectionBySlugResponse, type GetCollectionBySlugResponseNonNullableFields$1 as GetCollectionBySlugResponseNonNullableFields, type GetCollectionRequest$1 as GetCollectionRequest, type GetCollectionResponse$1 as GetCollectionResponse, type index_d$b_GetCollectionResponseNonNullableFields as GetCollectionResponseNonNullableFields, type Keyword$2 as Keyword, type Media$3 as Media, type MediaItem$1 as MediaItem, type MediaItemItemOneOf$1 as MediaItemItemOneOf, MediaItemType$1 as MediaItemType, type MediaItemUrlAndSize$1 as MediaItemUrlAndSize, type MediaItemVideo$1 as MediaItemVideo, type PlatformPaging$3 as PlatformPaging, type PlatformPagingMetadata$1 as PlatformPagingMetadata, type PlatformQuery$1 as PlatformQuery, type PlatformQueryPagingMethodOneOf$1 as PlatformQueryPagingMethodOneOf, type QueryCollectionsRequest$1 as QueryCollectionsRequest, type QueryCollectionsResponse$1 as QueryCollectionsResponse, type index_d$b_QueryCollectionsResponseNonNullableFields as QueryCollectionsResponseNonNullableFields, type SeoSchema$2 as SeoSchema, type Settings$3 as Settings, SortOrder$8 as SortOrder, type Sorting$8 as Sorting, type Tag$2 as Tag, index_d$b_getCollection as getCollection, getCollectionBySlug$2 as getCollectionBySlug, index_d$b_queryCollections as queryCollections };
706
+ export { type ActionEvent$8 as ActionEvent, type Collection$1 as Collection, type CollectionNonNullableFields$1 as CollectionNonNullableFields, type index_d$b_CollectionsQueryBuilder as CollectionsQueryBuilder, type index_d$b_CollectionsQueryResult as CollectionsQueryResult, type CursorPaging$8 as CursorPaging, type Cursors$8 as Cursors, type DomainEvent$8 as DomainEvent, type DomainEventBodyOneOf$8 as DomainEventBodyOneOf, type EntityCreatedEvent$8 as EntityCreatedEvent, type EntityDeletedEvent$8 as EntityDeletedEvent, type EntityUpdatedEvent$8 as EntityUpdatedEvent, type GetCollectionBySlugRequest$1 as GetCollectionBySlugRequest, type GetCollectionBySlugResponse$1 as GetCollectionBySlugResponse, type GetCollectionBySlugResponseNonNullableFields$1 as GetCollectionBySlugResponseNonNullableFields, type GetCollectionRequest$1 as GetCollectionRequest, type GetCollectionResponse$1 as GetCollectionResponse, type index_d$b_GetCollectionResponseNonNullableFields as GetCollectionResponseNonNullableFields, type IdentificationData$a as IdentificationData, type IdentificationDataIdOneOf$a as IdentificationDataIdOneOf, type Keyword$2 as Keyword, type Media$3 as Media, type MediaItem$1 as MediaItem, type MediaItemItemOneOf$1 as MediaItemItemOneOf, MediaItemType$1 as MediaItemType, type MediaItemUrlAndSize$1 as MediaItemUrlAndSize, type MediaItemVideo$1 as MediaItemVideo, type MessageEnvelope$a as MessageEnvelope, type PlatformPaging$3 as PlatformPaging, type PlatformPagingMetadata$1 as PlatformPagingMetadata, type PlatformQuery$1 as PlatformQuery, type PlatformQueryPagingMethodOneOf$1 as PlatformQueryPagingMethodOneOf, type QueryCollectionsRequest$1 as QueryCollectionsRequest, type QueryCollectionsResponse$1 as QueryCollectionsResponse, type index_d$b_QueryCollectionsResponseNonNullableFields as QueryCollectionsResponseNonNullableFields, type RestoreInfo$8 as RestoreInfo, type SeoSchema$2 as SeoSchema, type Settings$3 as Settings, SortOrder$8 as SortOrder, type Sorting$8 as Sorting, type Tag$2 as Tag, WebhookIdentityType$a as WebhookIdentityType, index_d$b_getCollection as getCollection, getCollectionBySlug$2 as getCollectionBySlug, index_d$b_queryCollections as queryCollections };
597
707
  }
598
708
 
599
709
  interface Product$2 {
@@ -11667,9 +11777,9 @@ interface Inventory {
11667
11777
  preorderStatus?: PreorderStatus;
11668
11778
  /**
11669
11779
  * Supported values:
11670
- * + ALL_VARIANTS: All the product variants are available for preorder.
11671
- * + NO_VARIANTS: None of the product variants are available for preorder.
11672
- * + SOME_VARIANTS: Some of the product variants are available for preorder.
11780
+ * + `ALL_VARIANTS`: All the product variants are available for preorder.
11781
+ * + `NO_VARIANTS`: None of the product variants are available for preorder.
11782
+ * + `SOME_VARIANTS`: Some of the product variants are available for preorder.
11673
11783
  * @readonly
11674
11784
  */
11675
11785
  preorderAvailability?: ProductPreorderAvailability;
@@ -12979,9 +12979,9 @@ interface Inventory$1 {
12979
12979
  preorderStatus?: PreorderStatus$1;
12980
12980
  /**
12981
12981
  * Supported values:
12982
- * + ALL_VARIANTS: All the product variants are available for preorder.
12983
- * + NO_VARIANTS: None of the product variants are available for preorder.
12984
- * + SOME_VARIANTS: Some of the product variants are available for preorder.
12982
+ * + `ALL_VARIANTS`: All the product variants are available for preorder.
12983
+ * + `NO_VARIANTS`: None of the product variants are available for preorder.
12984
+ * + `SOME_VARIANTS`: Some of the product variants are available for preorder.
12985
12985
  * @readonly
12986
12986
  */
12987
12987
  preorderAvailability?: ProductPreorderAvailability$1;
@@ -17293,9 +17293,9 @@ interface Inventory {
17293
17293
  preorderStatus?: PreorderStatus;
17294
17294
  /**
17295
17295
  * Supported values:
17296
- * + ALL_VARIANTS: All the product variants are available for preorder.
17297
- * + NO_VARIANTS: None of the product variants are available for preorder.
17298
- * + SOME_VARIANTS: Some of the product variants are available for preorder.
17296
+ * + `ALL_VARIANTS`: All the product variants are available for preorder.
17297
+ * + `NO_VARIANTS`: None of the product variants are available for preorder.
17298
+ * + `SOME_VARIANTS`: Some of the product variants are available for preorder.
17299
17299
  * @readonly
17300
17300
  */
17301
17301
  preorderAvailability?: ProductPreorderAvailability;