@compassdigital/sdk.typescript 4.877.0 → 4.879.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/lib/interface/menu.d.ts +5 -0
  2. package/lib/interface/menu.d.ts.map +1 -1
  3. package/lib/messages/events/RedemptionRolledBackEvent.d.ts +26 -0
  4. package/lib/messages/events/RedemptionRolledBackEvent.d.ts.map +1 -0
  5. package/lib/messages/events/RedemptionRolledBackEvent.js +4 -0
  6. package/lib/messages/events/RedemptionRolledBackEvent.js.map +1 -0
  7. package/lib/messages/events/RewardCardEarnedEvent.d.ts +25 -0
  8. package/lib/messages/events/RewardCardEarnedEvent.d.ts.map +1 -0
  9. package/lib/messages/events/RewardCardEarnedEvent.js +4 -0
  10. package/lib/messages/events/RewardCardEarnedEvent.js.map +1 -0
  11. package/lib/messages/events/RewardCardPointsAdjustedEvent.d.ts +27 -0
  12. package/lib/messages/events/RewardCardPointsAdjustedEvent.d.ts.map +1 -0
  13. package/lib/messages/events/RewardCardPointsAdjustedEvent.js +4 -0
  14. package/lib/messages/events/RewardCardPointsAdjustedEvent.js.map +1 -0
  15. package/lib/messages/events/RewardMilestoneReachedEvent.d.ts +26 -0
  16. package/lib/messages/events/RewardMilestoneReachedEvent.d.ts.map +1 -0
  17. package/lib/messages/events/RewardMilestoneReachedEvent.js +4 -0
  18. package/lib/messages/events/RewardMilestoneReachedEvent.js.map +1 -0
  19. package/lib/messages/events/SegmentMembersAddedEvent.d.ts +19 -0
  20. package/lib/messages/events/SegmentMembersAddedEvent.d.ts.map +1 -0
  21. package/lib/messages/events/SegmentMembersAddedEvent.js +4 -0
  22. package/lib/messages/events/SegmentMembersAddedEvent.js.map +1 -0
  23. package/lib/messages/events/SegmentMembersRemovedEvent.d.ts +19 -0
  24. package/lib/messages/events/SegmentMembersRemovedEvent.d.ts.map +1 -0
  25. package/lib/messages/events/SegmentMembersRemovedEvent.js +4 -0
  26. package/lib/messages/events/SegmentMembersRemovedEvent.js.map +1 -0
  27. package/lib/messages/events/SegmentRuleChangedEvent.d.ts +24 -0
  28. package/lib/messages/events/SegmentRuleChangedEvent.d.ts.map +1 -0
  29. package/lib/messages/events/SegmentRuleChangedEvent.js +4 -0
  30. package/lib/messages/events/SegmentRuleChangedEvent.js.map +1 -0
  31. package/lib/messages/events/VoucherRedeemedEvent.d.ts +25 -0
  32. package/lib/messages/events/VoucherRedeemedEvent.d.ts.map +1 -0
  33. package/lib/messages/events/VoucherRedeemedEvent.js +4 -0
  34. package/lib/messages/events/VoucherRedeemedEvent.js.map +1 -0
  35. package/lib/messages/events/index.d.ts +8 -0
  36. package/lib/messages/events/index.d.ts.map +1 -1
  37. package/package.json +1 -1
  38. package/src/interface/menu.ts +6 -0
  39. package/src/messages/events/RedemptionRolledBackEvent.ts +41 -0
  40. package/src/messages/events/RewardCardEarnedEvent.ts +39 -0
  41. package/src/messages/events/RewardCardPointsAdjustedEvent.ts +43 -0
  42. package/src/messages/events/RewardMilestoneReachedEvent.ts +41 -0
  43. package/src/messages/events/SegmentMembersAddedEvent.ts +27 -0
  44. package/src/messages/events/SegmentMembersRemovedEvent.ts +27 -0
  45. package/src/messages/events/SegmentRuleChangedEvent.ts +36 -0
  46. package/src/messages/events/VoucherRedeemedEvent.ts +39 -0
  47. package/src/messages/events/index.ts +16 -0
@@ -0,0 +1,36 @@
1
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
+
3
+ export interface SegmentRuleChangedEvent {
4
+ id: string;
5
+ type: 'SegmentRuleChangedEvent';
6
+ version: '0.0.1';
7
+ timestamp: string;
8
+ traceContext: {
9
+ // W3C traceparent, injected by MessageBus from the active trace context
10
+ traceparent?: string;
11
+ };
12
+ source: string;
13
+ // Owning domain, optionally dotted for subdomains. Names the Kafka topic; absent keeps the superseded naming.
14
+ domain?: string;
15
+ // Whether other domains may integrate against this message. Absent means private.
16
+ visibility?: 'public' | 'private';
17
+ payload: {
18
+ // Id of the attribute-rule segment whose rule changed
19
+ segmentId: string;
20
+ // The segment's membership rule as stored after the update
21
+ ruleJson: {
22
+ // Attribute key the rule evaluates (e.g. points_balance, enrollment_date)
23
+ attribute: string;
24
+ // Operator key (eq, neq, gt, gte, lt, lte)
25
+ operator: string;
26
+ // Value to compare against
27
+ value: string;
28
+ };
29
+ // Location-service sector name the segment is scoped to, e.g. Eurest. A name, not a sector id
30
+ sector: string;
31
+ // Country the segment is scoped to
32
+ country: 'CA' | 'US';
33
+ // The segment updatedAt written by the update that changed the rule, the same value the segment API returns. Orders rule events for a segment
34
+ updatedAt: string;
35
+ };
36
+ }
@@ -0,0 +1,39 @@
1
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
+
3
+ export interface VoucherRedeemedEvent {
4
+ id: string;
5
+ type: 'VoucherRedeemedEvent';
6
+ version: '0.0.1';
7
+ timestamp: string;
8
+ traceContext: {
9
+ // W3C traceparent, injected by MessageBus from the active trace context
10
+ traceparent?: string;
11
+ };
12
+ source: string;
13
+ // Owning domain, optionally dotted for subdomains. Names the Kafka topic; absent keeps the superseded naming.
14
+ domain?: string;
15
+ // Whether other domains may integrate against this message. Absent means private.
16
+ visibility?: 'public' | 'private';
17
+ payload: {
18
+ // Id of the redemption this event records. A RedemptionRolledBackEvent for the same redemption carries the same id, so consumers pair the two on it.
19
+ redemptionId: string;
20
+ // Id of the redeemed voucher.
21
+ voucherId: string;
22
+ // Code of the redeemed voucher, exactly as loyalty stores it: upper-cased, except reward codes (boore, boorb, thrre and thrrb prefixes), which stay lower-case. Compare it as-is.
23
+ voucherCode: string;
24
+ // Id of the campaign the voucher belongs to.
25
+ campaignId: string;
26
+ // Id of the order the voucher was redeemed against: order.metadata.order_id from the redeem request, or order.source_id when that is absent.
27
+ orderId: string;
28
+ // Customer who redeemed the voucher: customer.source_id from the redeem request, or the customer's email when no source_id was sent. The redemption stores the same value, so the paired RedemptionRolledBackEvent carries the same identifier.
29
+ customerId: string;
30
+ // Id of the site the order was placed at: order.metadata.site_id from the redeem request, or order.metadata.location_group_id when that is absent.
31
+ siteId: string;
32
+ // Sector the voucher's campaign is scoped to, as a location-service sector name (e.g. Eurest). Copied onto the redemption when it is written.
33
+ sector: string;
34
+ // Country the voucher's campaign is scoped to. Copied onto the redemption when it is written.
35
+ country: 'CA' | 'US';
36
+ // Discount this redemption applied to the order, in cents.
37
+ discountAmountCents: number;
38
+ };
39
+ }
@@ -72,16 +72,30 @@ export { PublishedMenuCreatedEvent } from './PublishedMenuCreatedEvent';
72
72
 
73
73
  export { PublishedMenuUpdatedEvent } from './PublishedMenuUpdatedEvent';
74
74
 
75
+ export { RedemptionRolledBackEvent } from './RedemptionRolledBackEvent';
76
+
75
77
  export { ReportConfigUpdatedEvent } from './ReportConfigUpdatedEvent';
76
78
 
77
79
  export { ReviewCreatedEvent } from './ReviewCreatedEvent';
78
80
 
79
81
  export { RewardCampaignPublishedEvent } from './RewardCampaignPublishedEvent';
80
82
 
83
+ export { RewardCardEarnedEvent } from './RewardCardEarnedEvent';
84
+
85
+ export { RewardCardPointsAdjustedEvent } from './RewardCardPointsAdjustedEvent';
86
+
81
87
  export { RewardCreatedEvent } from './RewardCreatedEvent';
82
88
 
89
+ export { RewardMilestoneReachedEvent } from './RewardMilestoneReachedEvent';
90
+
83
91
  export { RewardRedeemedEvent } from './RewardRedeemedEvent';
84
92
 
93
+ export { SegmentMembersAddedEvent } from './SegmentMembersAddedEvent';
94
+
95
+ export { SegmentMembersRemovedEvent } from './SegmentMembersRemovedEvent';
96
+
97
+ export { SegmentRuleChangedEvent } from './SegmentRuleChangedEvent';
98
+
85
99
  export { ShoppingCartCreatedEvent } from './ShoppingCartCreatedEvent';
86
100
 
87
101
  export { ShoppingCartUpdatedEvent } from './ShoppingCartUpdatedEvent';
@@ -101,3 +115,5 @@ export { UserPasswordChangedEvent } from './UserPasswordChangedEvent';
101
115
  export { UserPasswordResetRequestedEvent } from './UserPasswordResetRequestedEvent';
102
116
 
103
117
  export { UserUpdatedEvent } from './UserUpdatedEvent';
118
+
119
+ export { VoucherRedeemedEvent } from './VoucherRedeemedEvent';