@wix/auto_sdk_loyalty_social-media 1.0.6 → 1.0.7

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 (17) hide show
  1. package/build/cjs/src/loyalty-socialmedia-v1-followed-channel-social-media.types.d.ts +9 -17
  2. package/build/cjs/src/loyalty-socialmedia-v1-followed-channel-social-media.types.js.map +1 -1
  3. package/build/cjs/src/loyalty-socialmedia-v1-followed-channel-social-media.universal.d.ts +17 -33
  4. package/build/cjs/src/loyalty-socialmedia-v1-followed-channel-social-media.universal.js.map +1 -1
  5. package/build/es/src/loyalty-socialmedia-v1-followed-channel-social-media.types.d.ts +9 -17
  6. package/build/es/src/loyalty-socialmedia-v1-followed-channel-social-media.types.js.map +1 -1
  7. package/build/es/src/loyalty-socialmedia-v1-followed-channel-social-media.universal.d.ts +17 -33
  8. package/build/es/src/loyalty-socialmedia-v1-followed-channel-social-media.universal.js.map +1 -1
  9. package/build/internal/cjs/src/loyalty-socialmedia-v1-followed-channel-social-media.types.d.ts +9 -17
  10. package/build/internal/cjs/src/loyalty-socialmedia-v1-followed-channel-social-media.types.js.map +1 -1
  11. package/build/internal/cjs/src/loyalty-socialmedia-v1-followed-channel-social-media.universal.d.ts +17 -33
  12. package/build/internal/cjs/src/loyalty-socialmedia-v1-followed-channel-social-media.universal.js.map +1 -1
  13. package/build/internal/es/src/loyalty-socialmedia-v1-followed-channel-social-media.types.d.ts +9 -17
  14. package/build/internal/es/src/loyalty-socialmedia-v1-followed-channel-social-media.types.js.map +1 -1
  15. package/build/internal/es/src/loyalty-socialmedia-v1-followed-channel-social-media.universal.d.ts +17 -33
  16. package/build/internal/es/src/loyalty-socialmedia-v1-followed-channel-social-media.universal.js.map +1 -1
  17. package/package.json +2 -2
@@ -55,25 +55,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
55
55
  updatedEvent?: EntityUpdatedEvent;
56
56
  deletedEvent?: EntityDeletedEvent;
57
57
  actionEvent?: ActionEvent;
58
- /**
59
- * Unique event ID.
60
- * Allows clients to ignore duplicate webhooks.
61
- */
58
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
62
59
  id?: string;
63
60
  /**
64
- * Assumes actions are also always typed to an entity_type
65
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
61
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
62
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
66
63
  */
67
64
  entityFqdn?: string;
68
65
  /**
69
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
70
- * This is although the created/updated/deleted notion is duplication of the oneof types
71
- * Example: created/updated/deleted/started/completed/email_opened
66
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
67
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
72
68
  */
73
69
  slug?: string;
74
70
  /** ID of the entity associated with the event. */
75
71
  entityId?: string;
76
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
72
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
77
73
  eventTime?: Date | null;
78
74
  /**
79
75
  * Whether the event was triggered as a result of a privacy regulation application
@@ -83,12 +79,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
83
79
  /** If present, indicates the action that triggered the event. */
84
80
  originatedFrom?: string | null;
85
81
  /**
86
- * A sequence number defining the order of updates to the underlying entity.
87
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
88
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
89
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
90
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
91
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
82
+ * 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.
83
+ * 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.
92
84
  */
93
85
  entityEventSequence?: string | null;
94
86
  }
@@ -116,7 +108,7 @@ export interface EntityUpdatedEvent {
116
108
  currentEntityAsJson?: string;
117
109
  }
118
110
  export interface EntityDeletedEvent {
119
- /** Entity that was deleted */
111
+ /** Entity that was deleted. */
120
112
  deletedEntityAsJson?: string | null;
121
113
  }
122
114
  export interface ActionEvent {
@@ -1 +1 @@
1
- {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.types.js","sourceRoot":"","sources":["../../../src/loyalty-socialmedia-v1-followed-channel-social-media.types.ts"],"names":[],"mappings":";;;AAsBA,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,oBAAJ,IAAI,QAaf;AAyKD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
1
+ {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.types.js","sourceRoot":"","sources":["../../../src/loyalty-socialmedia-v1-followed-channel-social-media.types.ts"],"names":[],"mappings":";;;AAsBA,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,oBAAJ,IAAI,QAaf;AAiKD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
@@ -56,25 +56,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
56
56
  updatedEvent?: EntityUpdatedEvent;
57
57
  deletedEvent?: EntityDeletedEvent;
58
58
  actionEvent?: ActionEvent;
59
- /**
60
- * Unique event ID.
61
- * Allows clients to ignore duplicate webhooks.
62
- */
59
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
63
60
  _id?: string;
64
61
  /**
65
- * Assumes actions are also always typed to an entity_type
66
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
62
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
63
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
67
64
  */
68
65
  entityFqdn?: string;
69
66
  /**
70
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
71
- * This is although the created/updated/deleted notion is duplication of the oneof types
72
- * Example: created/updated/deleted/started/completed/email_opened
67
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
68
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
73
69
  */
74
70
  slug?: string;
75
71
  /** ID of the entity associated with the event. */
76
72
  entityId?: string;
77
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
73
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
78
74
  eventTime?: Date | null;
79
75
  /**
80
76
  * Whether the event was triggered as a result of a privacy regulation application
@@ -84,12 +80,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
84
80
  /** If present, indicates the action that triggered the event. */
85
81
  originatedFrom?: string | null;
86
82
  /**
87
- * A sequence number defining the order of updates to the underlying entity.
88
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
89
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
90
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
91
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
92
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
83
+ * 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.
84
+ * 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.
93
85
  */
94
86
  entityEventSequence?: string | null;
95
87
  }
@@ -115,7 +107,7 @@ export interface EntityUpdatedEvent {
115
107
  currentEntity?: string;
116
108
  }
117
109
  export interface EntityDeletedEvent {
118
- /** Entity that was deleted */
110
+ /** Entity that was deleted. */
119
111
  deletedEntity?: string | null;
120
112
  }
121
113
  export interface ActionEvent {
@@ -208,25 +200,21 @@ export interface BaseEventMetadata {
208
200
  identity?: IdentificationData;
209
201
  }
210
202
  export interface EventMetadata extends BaseEventMetadata {
211
- /**
212
- * Unique event ID.
213
- * Allows clients to ignore duplicate webhooks.
214
- */
203
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
215
204
  _id?: string;
216
205
  /**
217
- * Assumes actions are also always typed to an entity_type
218
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
206
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
207
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
219
208
  */
220
209
  entityFqdn?: string;
221
210
  /**
222
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
223
- * This is although the created/updated/deleted notion is duplication of the oneof types
224
- * Example: created/updated/deleted/started/completed/email_opened
211
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
212
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
225
213
  */
226
214
  slug?: string;
227
215
  /** ID of the entity associated with the event. */
228
216
  entityId?: string;
229
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
217
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
230
218
  eventTime?: Date | null;
231
219
  /**
232
220
  * Whether the event was triggered as a result of a privacy regulation application
@@ -236,12 +224,8 @@ export interface EventMetadata extends BaseEventMetadata {
236
224
  /** If present, indicates the action that triggered the event. */
237
225
  originatedFrom?: string | null;
238
226
  /**
239
- * A sequence number defining the order of updates to the underlying entity.
240
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
241
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
242
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
243
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
244
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
227
+ * 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.
228
+ * 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.
245
229
  */
246
230
  entityEventSequence?: string | null;
247
231
  }
@@ -1 +1 @@
1
- {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.universal.js","sourceRoot":"","sources":["../../../src/loyalty-socialmedia-v1-followed-channel-social-media.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,iJAAmI;AAwBnI,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,oBAAJ,IAAI,QAaf;AAuKD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAiFD;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,qBAAqB,CACzC,eAA6D;IAE7D,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,eAAe,EAAE,eAAe;KACjC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,gDAAgD,CAAC,qBAAqB,CACpE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,eAAgB,CAAC;IACvB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE;YACrD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,iBAAiB,CAAC,CACpB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAvCD,sDAuCC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,oBAAoB;IAQxC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,gDAAgD,CAAC,oBAAoB,CACnE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;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;AAzCD,oDAyCC"}
1
+ {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.universal.js","sourceRoot":"","sources":["../../../src/loyalty-socialmedia-v1-followed-channel-social-media.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,iJAAmI;AAwBnI,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,oBAAJ,IAAI,QAaf;AA+JD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAyED;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,qBAAqB,CACzC,eAA6D;IAE7D,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,eAAe,EAAE,eAAe;KACjC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,gDAAgD,CAAC,qBAAqB,CACpE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,eAAgB,CAAC;IACvB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE;YACrD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,iBAAiB,CAAC,CACpB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAvCD,sDAuCC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,oBAAoB;IAQxC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,gDAAgD,CAAC,oBAAoB,CACnE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;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;AAzCD,oDAyCC"}
@@ -55,25 +55,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
55
55
  updatedEvent?: EntityUpdatedEvent;
56
56
  deletedEvent?: EntityDeletedEvent;
57
57
  actionEvent?: ActionEvent;
58
- /**
59
- * Unique event ID.
60
- * Allows clients to ignore duplicate webhooks.
61
- */
58
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
62
59
  id?: string;
63
60
  /**
64
- * Assumes actions are also always typed to an entity_type
65
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
61
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
62
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
66
63
  */
67
64
  entityFqdn?: string;
68
65
  /**
69
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
70
- * This is although the created/updated/deleted notion is duplication of the oneof types
71
- * Example: created/updated/deleted/started/completed/email_opened
66
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
67
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
72
68
  */
73
69
  slug?: string;
74
70
  /** ID of the entity associated with the event. */
75
71
  entityId?: string;
76
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
72
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
77
73
  eventTime?: Date | null;
78
74
  /**
79
75
  * Whether the event was triggered as a result of a privacy regulation application
@@ -83,12 +79,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
83
79
  /** If present, indicates the action that triggered the event. */
84
80
  originatedFrom?: string | null;
85
81
  /**
86
- * A sequence number defining the order of updates to the underlying entity.
87
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
88
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
89
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
90
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
91
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
82
+ * 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.
83
+ * 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.
92
84
  */
93
85
  entityEventSequence?: string | null;
94
86
  }
@@ -116,7 +108,7 @@ export interface EntityUpdatedEvent {
116
108
  currentEntityAsJson?: string;
117
109
  }
118
110
  export interface EntityDeletedEvent {
119
- /** Entity that was deleted */
111
+ /** Entity that was deleted. */
120
112
  deletedEntityAsJson?: string | null;
121
113
  }
122
114
  export interface ActionEvent {
@@ -1 +1 @@
1
- {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.types.js","sourceRoot":"","sources":["../../../src/loyalty-socialmedia-v1-followed-channel-social-media.types.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAN,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,KAAJ,IAAI,QAaf;AAyKD,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"}
1
+ {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.types.js","sourceRoot":"","sources":["../../../src/loyalty-socialmedia-v1-followed-channel-social-media.types.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAN,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,KAAJ,IAAI,QAaf;AAiKD,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"}
@@ -56,25 +56,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
56
56
  updatedEvent?: EntityUpdatedEvent;
57
57
  deletedEvent?: EntityDeletedEvent;
58
58
  actionEvent?: ActionEvent;
59
- /**
60
- * Unique event ID.
61
- * Allows clients to ignore duplicate webhooks.
62
- */
59
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
63
60
  _id?: string;
64
61
  /**
65
- * Assumes actions are also always typed to an entity_type
66
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
62
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
63
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
67
64
  */
68
65
  entityFqdn?: string;
69
66
  /**
70
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
71
- * This is although the created/updated/deleted notion is duplication of the oneof types
72
- * Example: created/updated/deleted/started/completed/email_opened
67
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
68
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
73
69
  */
74
70
  slug?: string;
75
71
  /** ID of the entity associated with the event. */
76
72
  entityId?: string;
77
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
73
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
78
74
  eventTime?: Date | null;
79
75
  /**
80
76
  * Whether the event was triggered as a result of a privacy regulation application
@@ -84,12 +80,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
84
80
  /** If present, indicates the action that triggered the event. */
85
81
  originatedFrom?: string | null;
86
82
  /**
87
- * A sequence number defining the order of updates to the underlying entity.
88
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
89
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
90
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
91
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
92
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
83
+ * 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.
84
+ * 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.
93
85
  */
94
86
  entityEventSequence?: string | null;
95
87
  }
@@ -115,7 +107,7 @@ export interface EntityUpdatedEvent {
115
107
  currentEntity?: string;
116
108
  }
117
109
  export interface EntityDeletedEvent {
118
- /** Entity that was deleted */
110
+ /** Entity that was deleted. */
119
111
  deletedEntity?: string | null;
120
112
  }
121
113
  export interface ActionEvent {
@@ -208,25 +200,21 @@ export interface BaseEventMetadata {
208
200
  identity?: IdentificationData;
209
201
  }
210
202
  export interface EventMetadata extends BaseEventMetadata {
211
- /**
212
- * Unique event ID.
213
- * Allows clients to ignore duplicate webhooks.
214
- */
203
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
215
204
  _id?: string;
216
205
  /**
217
- * Assumes actions are also always typed to an entity_type
218
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
206
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
207
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
219
208
  */
220
209
  entityFqdn?: string;
221
210
  /**
222
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
223
- * This is although the created/updated/deleted notion is duplication of the oneof types
224
- * Example: created/updated/deleted/started/completed/email_opened
211
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
212
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
225
213
  */
226
214
  slug?: string;
227
215
  /** ID of the entity associated with the event. */
228
216
  entityId?: string;
229
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
217
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
230
218
  eventTime?: Date | null;
231
219
  /**
232
220
  * Whether the event was triggered as a result of a privacy regulation application
@@ -236,12 +224,8 @@ export interface EventMetadata extends BaseEventMetadata {
236
224
  /** If present, indicates the action that triggered the event. */
237
225
  originatedFrom?: string | null;
238
226
  /**
239
- * A sequence number defining the order of updates to the underlying entity.
240
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
241
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
242
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
243
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
244
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
227
+ * 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.
228
+ * 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.
245
229
  */
246
230
  entityEventSequence?: string | null;
247
231
  }
@@ -1 +1 @@
1
- {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.universal.js","sourceRoot":"","sources":["../../../src/loyalty-socialmedia-v1-followed-channel-social-media.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,gDAAgD,MAAM,gEAAgE,CAAC;AAwBnI,MAAM,CAAN,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,KAAJ,IAAI,QAaf;AAuKD,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;AAiFD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,eAA6D;IAE7D,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,eAAe,EAAE,eAAe;KACjC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,gDAAgD,CAAC,qBAAqB,CACpE,OAAO,CACR,CAAC;IAEJ,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,CAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,eAAgB,CAAC;IACvB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE;YACrD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,iBAAiB,CAAC,CACpB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB;IAQxC,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,gDAAgD,CAAC,oBAAoB,CACnE,OAAO,CACR,CAAC;IAEJ,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,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,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"}
1
+ {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.universal.js","sourceRoot":"","sources":["../../../src/loyalty-socialmedia-v1-followed-channel-social-media.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,gDAAgD,MAAM,gEAAgE,CAAC;AAwBnI,MAAM,CAAN,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,KAAJ,IAAI,QAaf;AA+JD,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;AAyED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,eAA6D;IAE7D,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,eAAe,EAAE,eAAe;KACjC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,gDAAgD,CAAC,qBAAqB,CACpE,OAAO,CACR,CAAC;IAEJ,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,CAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,eAAgB,CAAC;IACvB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE;YACrD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,iBAAiB,CAAC,CACpB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB;IAQxC,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,gDAAgD,CAAC,oBAAoB,CACnE,OAAO,CACR,CAAC;IAEJ,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,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,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"}
@@ -55,25 +55,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
55
55
  updatedEvent?: EntityUpdatedEvent;
56
56
  deletedEvent?: EntityDeletedEvent;
57
57
  actionEvent?: ActionEvent;
58
- /**
59
- * Unique event ID.
60
- * Allows clients to ignore duplicate webhooks.
61
- */
58
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
62
59
  id?: string;
63
60
  /**
64
- * Assumes actions are also always typed to an entity_type
65
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
61
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
62
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
66
63
  */
67
64
  entityFqdn?: string;
68
65
  /**
69
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
70
- * This is although the created/updated/deleted notion is duplication of the oneof types
71
- * Example: created/updated/deleted/started/completed/email_opened
66
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
67
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
72
68
  */
73
69
  slug?: string;
74
70
  /** ID of the entity associated with the event. */
75
71
  entityId?: string;
76
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
72
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
77
73
  eventTime?: Date | null;
78
74
  /**
79
75
  * Whether the event was triggered as a result of a privacy regulation application
@@ -83,12 +79,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
83
79
  /** If present, indicates the action that triggered the event. */
84
80
  originatedFrom?: string | null;
85
81
  /**
86
- * A sequence number defining the order of updates to the underlying entity.
87
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
88
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
89
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
90
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
91
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
82
+ * 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.
83
+ * 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.
92
84
  */
93
85
  entityEventSequence?: string | null;
94
86
  }
@@ -116,7 +108,7 @@ export interface EntityUpdatedEvent {
116
108
  currentEntityAsJson?: string;
117
109
  }
118
110
  export interface EntityDeletedEvent {
119
- /** Entity that was deleted */
111
+ /** Entity that was deleted. */
120
112
  deletedEntityAsJson?: string | null;
121
113
  }
122
114
  export interface ActionEvent {
@@ -1 +1 @@
1
- {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.types.js","sourceRoot":"","sources":["../../../../src/loyalty-socialmedia-v1-followed-channel-social-media.types.ts"],"names":[],"mappings":";;;AAsBA,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,oBAAJ,IAAI,QAaf;AAyKD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
1
+ {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.types.js","sourceRoot":"","sources":["../../../../src/loyalty-socialmedia-v1-followed-channel-social-media.types.ts"],"names":[],"mappings":";;;AAsBA,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,oBAAJ,IAAI,QAaf;AAiKD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
@@ -56,25 +56,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
56
56
  updatedEvent?: EntityUpdatedEvent;
57
57
  deletedEvent?: EntityDeletedEvent;
58
58
  actionEvent?: ActionEvent;
59
- /**
60
- * Unique event ID.
61
- * Allows clients to ignore duplicate webhooks.
62
- */
59
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
63
60
  _id?: string;
64
61
  /**
65
- * Assumes actions are also always typed to an entity_type
66
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
62
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
63
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
67
64
  */
68
65
  entityFqdn?: string;
69
66
  /**
70
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
71
- * This is although the created/updated/deleted notion is duplication of the oneof types
72
- * Example: created/updated/deleted/started/completed/email_opened
67
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
68
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
73
69
  */
74
70
  slug?: string;
75
71
  /** ID of the entity associated with the event. */
76
72
  entityId?: string;
77
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
73
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
78
74
  eventTime?: Date | null;
79
75
  /**
80
76
  * Whether the event was triggered as a result of a privacy regulation application
@@ -84,12 +80,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
84
80
  /** If present, indicates the action that triggered the event. */
85
81
  originatedFrom?: string | null;
86
82
  /**
87
- * A sequence number defining the order of updates to the underlying entity.
88
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
89
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
90
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
91
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
92
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
83
+ * 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.
84
+ * 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.
93
85
  */
94
86
  entityEventSequence?: string | null;
95
87
  }
@@ -115,7 +107,7 @@ export interface EntityUpdatedEvent {
115
107
  currentEntity?: string;
116
108
  }
117
109
  export interface EntityDeletedEvent {
118
- /** Entity that was deleted */
110
+ /** Entity that was deleted. */
119
111
  deletedEntity?: string | null;
120
112
  }
121
113
  export interface ActionEvent {
@@ -208,25 +200,21 @@ export interface BaseEventMetadata {
208
200
  identity?: IdentificationData;
209
201
  }
210
202
  export interface EventMetadata extends BaseEventMetadata {
211
- /**
212
- * Unique event ID.
213
- * Allows clients to ignore duplicate webhooks.
214
- */
203
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
215
204
  _id?: string;
216
205
  /**
217
- * Assumes actions are also always typed to an entity_type
218
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
206
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
207
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
219
208
  */
220
209
  entityFqdn?: string;
221
210
  /**
222
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
223
- * This is although the created/updated/deleted notion is duplication of the oneof types
224
- * Example: created/updated/deleted/started/completed/email_opened
211
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
212
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
225
213
  */
226
214
  slug?: string;
227
215
  /** ID of the entity associated with the event. */
228
216
  entityId?: string;
229
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
217
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
230
218
  eventTime?: Date | null;
231
219
  /**
232
220
  * Whether the event was triggered as a result of a privacy regulation application
@@ -236,12 +224,8 @@ export interface EventMetadata extends BaseEventMetadata {
236
224
  /** If present, indicates the action that triggered the event. */
237
225
  originatedFrom?: string | null;
238
226
  /**
239
- * A sequence number defining the order of updates to the underlying entity.
240
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
241
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
242
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
243
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
244
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
227
+ * 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.
228
+ * 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.
245
229
  */
246
230
  entityEventSequence?: string | null;
247
231
  }
@@ -1 +1 @@
1
- {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.universal.js","sourceRoot":"","sources":["../../../../src/loyalty-socialmedia-v1-followed-channel-social-media.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,iJAAmI;AAwBnI,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,oBAAJ,IAAI,QAaf;AAuKD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAiFD;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,qBAAqB,CACzC,eAA6D;IAE7D,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,eAAe,EAAE,eAAe;KACjC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,gDAAgD,CAAC,qBAAqB,CACpE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,eAAgB,CAAC;IACvB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE;YACrD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,iBAAiB,CAAC,CACpB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAvCD,sDAuCC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,oBAAoB;IAQxC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,gDAAgD,CAAC,oBAAoB,CACnE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;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;AAzCD,oDAyCC"}
1
+ {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.universal.js","sourceRoot":"","sources":["../../../../src/loyalty-socialmedia-v1-followed-channel-social-media.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,iJAAmI;AAwBnI,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,oBAAJ,IAAI,QAaf;AA+JD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAyED;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,qBAAqB,CACzC,eAA6D;IAE7D,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,eAAe,EAAE,eAAe;KACjC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,gDAAgD,CAAC,qBAAqB,CACpE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,eAAgB,CAAC;IACvB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE;YACrD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,iBAAiB,CAAC,CACpB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAvCD,sDAuCC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,oBAAoB;IAQxC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,gDAAgD,CAAC,oBAAoB,CACnE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;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;AAzCD,oDAyCC"}
@@ -55,25 +55,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
55
55
  updatedEvent?: EntityUpdatedEvent;
56
56
  deletedEvent?: EntityDeletedEvent;
57
57
  actionEvent?: ActionEvent;
58
- /**
59
- * Unique event ID.
60
- * Allows clients to ignore duplicate webhooks.
61
- */
58
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
62
59
  id?: string;
63
60
  /**
64
- * Assumes actions are also always typed to an entity_type
65
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
61
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
62
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
66
63
  */
67
64
  entityFqdn?: string;
68
65
  /**
69
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
70
- * This is although the created/updated/deleted notion is duplication of the oneof types
71
- * Example: created/updated/deleted/started/completed/email_opened
66
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
67
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
72
68
  */
73
69
  slug?: string;
74
70
  /** ID of the entity associated with the event. */
75
71
  entityId?: string;
76
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
72
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
77
73
  eventTime?: Date | null;
78
74
  /**
79
75
  * Whether the event was triggered as a result of a privacy regulation application
@@ -83,12 +79,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
83
79
  /** If present, indicates the action that triggered the event. */
84
80
  originatedFrom?: string | null;
85
81
  /**
86
- * A sequence number defining the order of updates to the underlying entity.
87
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
88
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
89
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
90
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
91
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
82
+ * 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.
83
+ * 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.
92
84
  */
93
85
  entityEventSequence?: string | null;
94
86
  }
@@ -116,7 +108,7 @@ export interface EntityUpdatedEvent {
116
108
  currentEntityAsJson?: string;
117
109
  }
118
110
  export interface EntityDeletedEvent {
119
- /** Entity that was deleted */
111
+ /** Entity that was deleted. */
120
112
  deletedEntityAsJson?: string | null;
121
113
  }
122
114
  export interface ActionEvent {
@@ -1 +1 @@
1
- {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.types.js","sourceRoot":"","sources":["../../../../src/loyalty-socialmedia-v1-followed-channel-social-media.types.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAN,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,KAAJ,IAAI,QAaf;AAyKD,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"}
1
+ {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.types.js","sourceRoot":"","sources":["../../../../src/loyalty-socialmedia-v1-followed-channel-social-media.types.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAN,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,KAAJ,IAAI,QAaf;AAiKD,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"}
@@ -56,25 +56,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
56
56
  updatedEvent?: EntityUpdatedEvent;
57
57
  deletedEvent?: EntityDeletedEvent;
58
58
  actionEvent?: ActionEvent;
59
- /**
60
- * Unique event ID.
61
- * Allows clients to ignore duplicate webhooks.
62
- */
59
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
63
60
  _id?: string;
64
61
  /**
65
- * Assumes actions are also always typed to an entity_type
66
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
62
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
63
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
67
64
  */
68
65
  entityFqdn?: string;
69
66
  /**
70
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
71
- * This is although the created/updated/deleted notion is duplication of the oneof types
72
- * Example: created/updated/deleted/started/completed/email_opened
67
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
68
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
73
69
  */
74
70
  slug?: string;
75
71
  /** ID of the entity associated with the event. */
76
72
  entityId?: string;
77
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
73
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
78
74
  eventTime?: Date | null;
79
75
  /**
80
76
  * Whether the event was triggered as a result of a privacy regulation application
@@ -84,12 +80,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
84
80
  /** If present, indicates the action that triggered the event. */
85
81
  originatedFrom?: string | null;
86
82
  /**
87
- * A sequence number defining the order of updates to the underlying entity.
88
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
89
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
90
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
91
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
92
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
83
+ * 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.
84
+ * 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.
93
85
  */
94
86
  entityEventSequence?: string | null;
95
87
  }
@@ -115,7 +107,7 @@ export interface EntityUpdatedEvent {
115
107
  currentEntity?: string;
116
108
  }
117
109
  export interface EntityDeletedEvent {
118
- /** Entity that was deleted */
110
+ /** Entity that was deleted. */
119
111
  deletedEntity?: string | null;
120
112
  }
121
113
  export interface ActionEvent {
@@ -208,25 +200,21 @@ export interface BaseEventMetadata {
208
200
  identity?: IdentificationData;
209
201
  }
210
202
  export interface EventMetadata extends BaseEventMetadata {
211
- /**
212
- * Unique event ID.
213
- * Allows clients to ignore duplicate webhooks.
214
- */
203
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
215
204
  _id?: string;
216
205
  /**
217
- * Assumes actions are also always typed to an entity_type
218
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
206
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
207
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
219
208
  */
220
209
  entityFqdn?: string;
221
210
  /**
222
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
223
- * This is although the created/updated/deleted notion is duplication of the oneof types
224
- * Example: created/updated/deleted/started/completed/email_opened
211
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
212
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
225
213
  */
226
214
  slug?: string;
227
215
  /** ID of the entity associated with the event. */
228
216
  entityId?: string;
229
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
217
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
230
218
  eventTime?: Date | null;
231
219
  /**
232
220
  * Whether the event was triggered as a result of a privacy regulation application
@@ -236,12 +224,8 @@ export interface EventMetadata extends BaseEventMetadata {
236
224
  /** If present, indicates the action that triggered the event. */
237
225
  originatedFrom?: string | null;
238
226
  /**
239
- * A sequence number defining the order of updates to the underlying entity.
240
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
241
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
242
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
243
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
244
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
227
+ * 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.
228
+ * 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.
245
229
  */
246
230
  entityEventSequence?: string | null;
247
231
  }
@@ -1 +1 @@
1
- {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.universal.js","sourceRoot":"","sources":["../../../../src/loyalty-socialmedia-v1-followed-channel-social-media.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,gDAAgD,MAAM,gEAAgE,CAAC;AAwBnI,MAAM,CAAN,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,KAAJ,IAAI,QAaf;AAuKD,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;AAiFD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,eAA6D;IAE7D,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,eAAe,EAAE,eAAe;KACjC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,gDAAgD,CAAC,qBAAqB,CACpE,OAAO,CACR,CAAC;IAEJ,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,CAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,eAAgB,CAAC;IACvB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE;YACrD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,iBAAiB,CAAC,CACpB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB;IAQxC,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,gDAAgD,CAAC,oBAAoB,CACnE,OAAO,CACR,CAAC;IAEJ,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,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,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"}
1
+ {"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.universal.js","sourceRoot":"","sources":["../../../../src/loyalty-socialmedia-v1-followed-channel-social-media.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,gDAAgD,MAAM,gEAAgE,CAAC;AAwBnI,MAAM,CAAN,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,KAAJ,IAAI,QAaf;AA+JD,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;AAyED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,eAA6D;IAE7D,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,eAAe,EAAE,eAAe;KACjC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,gDAAgD,CAAC,qBAAqB,CACpE,OAAO,CACR,CAAC;IAEJ,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,CAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,eAAgB,CAAC;IACvB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE;YACrD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,iBAAiB,CAAC,CACpB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB;IAQxC,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,gDAAgD,CAAC,oBAAoB,CACnE,OAAO,CACR,CAAC;IAEJ,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,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_loyalty_social-media",
3
- "version": "1.0.6",
3
+ "version": "1.0.7",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -48,5 +48,5 @@
48
48
  "fqdn": "wix.loyalty.socialmedia.v1.followed_channel"
49
49
  }
50
50
  },
51
- "falconPackageHash": "8a96bfb651748c1b0ecda242745d75080bcd4915b78fb1436eb5c4b0"
51
+ "falconPackageHash": "aac233abc1f04c0c2b5b7b01f18a47dfaf446abdc17a7817f11925d3"
52
52
  }