@compassdigital/sdk.typescript 4.878.0 → 4.880.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 (52) hide show
  1. package/lib/interface/consumer.d.ts +16 -3
  2. package/lib/interface/consumer.d.ts.map +1 -1
  3. package/lib/messages/events/CampaignStatusChangedEvent.d.ts +24 -0
  4. package/lib/messages/events/CampaignStatusChangedEvent.d.ts.map +1 -0
  5. package/lib/messages/events/CampaignStatusChangedEvent.js +4 -0
  6. package/lib/messages/events/CampaignStatusChangedEvent.js.map +1 -0
  7. package/lib/messages/events/RedemptionRolledBackEvent.d.ts +26 -0
  8. package/lib/messages/events/RedemptionRolledBackEvent.d.ts.map +1 -0
  9. package/lib/messages/events/RedemptionRolledBackEvent.js +4 -0
  10. package/lib/messages/events/RedemptionRolledBackEvent.js.map +1 -0
  11. package/lib/messages/events/RewardCardEarnedEvent.d.ts +25 -0
  12. package/lib/messages/events/RewardCardEarnedEvent.d.ts.map +1 -0
  13. package/lib/messages/events/RewardCardEarnedEvent.js +4 -0
  14. package/lib/messages/events/RewardCardEarnedEvent.js.map +1 -0
  15. package/lib/messages/events/RewardCardPointsAdjustedEvent.d.ts +27 -0
  16. package/lib/messages/events/RewardCardPointsAdjustedEvent.d.ts.map +1 -0
  17. package/lib/messages/events/RewardCardPointsAdjustedEvent.js +4 -0
  18. package/lib/messages/events/RewardCardPointsAdjustedEvent.js.map +1 -0
  19. package/lib/messages/events/RewardMilestoneReachedEvent.d.ts +26 -0
  20. package/lib/messages/events/RewardMilestoneReachedEvent.d.ts.map +1 -0
  21. package/lib/messages/events/RewardMilestoneReachedEvent.js +4 -0
  22. package/lib/messages/events/RewardMilestoneReachedEvent.js.map +1 -0
  23. package/lib/messages/events/SegmentMembersAddedEvent.d.ts +19 -0
  24. package/lib/messages/events/SegmentMembersAddedEvent.d.ts.map +1 -0
  25. package/lib/messages/events/SegmentMembersAddedEvent.js +4 -0
  26. package/lib/messages/events/SegmentMembersAddedEvent.js.map +1 -0
  27. package/lib/messages/events/SegmentMembersRemovedEvent.d.ts +19 -0
  28. package/lib/messages/events/SegmentMembersRemovedEvent.d.ts.map +1 -0
  29. package/lib/messages/events/SegmentMembersRemovedEvent.js +4 -0
  30. package/lib/messages/events/SegmentMembersRemovedEvent.js.map +1 -0
  31. package/lib/messages/events/SegmentRuleChangedEvent.d.ts +24 -0
  32. package/lib/messages/events/SegmentRuleChangedEvent.d.ts.map +1 -0
  33. package/lib/messages/events/SegmentRuleChangedEvent.js +4 -0
  34. package/lib/messages/events/SegmentRuleChangedEvent.js.map +1 -0
  35. package/lib/messages/events/VoucherRedeemedEvent.d.ts +25 -0
  36. package/lib/messages/events/VoucherRedeemedEvent.d.ts.map +1 -0
  37. package/lib/messages/events/VoucherRedeemedEvent.js +4 -0
  38. package/lib/messages/events/VoucherRedeemedEvent.js.map +1 -0
  39. package/lib/messages/events/index.d.ts +9 -0
  40. package/lib/messages/events/index.d.ts.map +1 -1
  41. package/package.json +1 -1
  42. package/src/interface/consumer.ts +22 -3
  43. package/src/messages/events/CampaignStatusChangedEvent.ts +37 -0
  44. package/src/messages/events/RedemptionRolledBackEvent.ts +41 -0
  45. package/src/messages/events/RewardCardEarnedEvent.ts +39 -0
  46. package/src/messages/events/RewardCardPointsAdjustedEvent.ts +43 -0
  47. package/src/messages/events/RewardMilestoneReachedEvent.ts +41 -0
  48. package/src/messages/events/SegmentMembersAddedEvent.ts +27 -0
  49. package/src/messages/events/SegmentMembersRemovedEvent.ts +27 -0
  50. package/src/messages/events/SegmentRuleChangedEvent.ts +36 -0
  51. package/src/messages/events/VoucherRedeemedEvent.ts +39 -0
  52. package/src/messages/events/index.ts +18 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RewardCardEarnedEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/RewardCardEarnedEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,qBAAqB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QAEb,WAAW,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAClC,OAAO,EAAE;QAER,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,MAAM,CAAC;QAEjB,UAAU,EAAE,MAAM,CAAC;QAEnB,OAAO,EAAE,MAAM,CAAC;QAEhB,WAAW,EAAE,MAAM,CAAC;QAEpB,aAAa,EAAE,MAAM,CAAC;QAEtB,MAAM,EAAE,MAAM,CAAC;QAEf,OAAO,EAAE,IAAI,GAAG,IAAI,CAAC;QAErB,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,MAAM,CAAC;KACjB,CAAC;CACF"}
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ //# sourceMappingURL=RewardCardEarnedEvent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RewardCardEarnedEvent.js","sourceRoot":"","sources":["../../../src/messages/events/RewardCardEarnedEvent.ts"],"names":[],"mappings":";AAAA,sDAAsD"}
@@ -0,0 +1,27 @@
1
+ export interface RewardCardPointsAdjustedEvent {
2
+ id: string;
3
+ type: 'RewardCardPointsAdjustedEvent';
4
+ version: '0.0.1';
5
+ timestamp: string;
6
+ traceContext: {
7
+ traceparent?: string;
8
+ };
9
+ source: string;
10
+ domain?: string;
11
+ visibility?: 'public' | 'private';
12
+ payload: {
13
+ cardId: string;
14
+ rewardId: string;
15
+ customerId: string;
16
+ pointsDelta: number;
17
+ previousBalance: number;
18
+ pointsBalance: number;
19
+ sector: string;
20
+ country: 'CA' | 'US';
21
+ siteId: string | null;
22
+ description: string;
23
+ adjustedBy: string;
24
+ adjustedAt: string;
25
+ };
26
+ }
27
+ //# sourceMappingURL=RewardCardPointsAdjustedEvent.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RewardCardPointsAdjustedEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/RewardCardPointsAdjustedEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,6BAA6B;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QAEb,WAAW,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAClC,OAAO,EAAE;QAER,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,MAAM,CAAC;QAEjB,UAAU,EAAE,MAAM,CAAC;QAEnB,WAAW,EAAE,MAAM,CAAC;QAEpB,eAAe,EAAE,MAAM,CAAC;QAExB,aAAa,EAAE,MAAM,CAAC;QAEtB,MAAM,EAAE,MAAM,CAAC;QAEf,OAAO,EAAE,IAAI,GAAG,IAAI,CAAC;QAErB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,WAAW,EAAE,MAAM,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB,UAAU,EAAE,MAAM,CAAC;KACnB,CAAC;CACF"}
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ //# sourceMappingURL=RewardCardPointsAdjustedEvent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RewardCardPointsAdjustedEvent.js","sourceRoot":"","sources":["../../../src/messages/events/RewardCardPointsAdjustedEvent.ts"],"names":[],"mappings":";AAAA,sDAAsD"}
@@ -0,0 +1,26 @@
1
+ export interface RewardMilestoneReachedEvent {
2
+ id: string;
3
+ type: 'RewardMilestoneReachedEvent';
4
+ version: '0.0.1';
5
+ timestamp: string;
6
+ traceContext: {
7
+ traceparent?: string;
8
+ };
9
+ source: string;
10
+ domain?: string;
11
+ visibility?: 'public' | 'private';
12
+ payload: {
13
+ cardId: string;
14
+ rewardId: string;
15
+ customerId: string;
16
+ orderId: string;
17
+ campaignId: string;
18
+ voucherId: string;
19
+ voucherCode: string;
20
+ sector: string;
21
+ country: 'CA' | 'US';
22
+ siteId: string;
23
+ pointsRequired: number;
24
+ };
25
+ }
26
+ //# sourceMappingURL=RewardMilestoneReachedEvent.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RewardMilestoneReachedEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/RewardMilestoneReachedEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,2BAA2B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QAEb,WAAW,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAClC,OAAO,EAAE;QAER,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,MAAM,CAAC;QAEjB,UAAU,EAAE,MAAM,CAAC;QAEnB,OAAO,EAAE,MAAM,CAAC;QAEhB,UAAU,EAAE,MAAM,CAAC;QAEnB,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,CAAC;QAEpB,MAAM,EAAE,MAAM,CAAC;QAEf,OAAO,EAAE,IAAI,GAAG,IAAI,CAAC;QAErB,MAAM,EAAE,MAAM,CAAC;QAEf,cAAc,EAAE,MAAM,CAAC;KACvB,CAAC;CACF"}
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ //# sourceMappingURL=RewardMilestoneReachedEvent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RewardMilestoneReachedEvent.js","sourceRoot":"","sources":["../../../src/messages/events/RewardMilestoneReachedEvent.ts"],"names":[],"mappings":";AAAA,sDAAsD"}
@@ -0,0 +1,19 @@
1
+ export interface SegmentMembersAddedEvent {
2
+ id: string;
3
+ type: 'SegmentMembersAddedEvent';
4
+ version: '0.0.1';
5
+ timestamp: string;
6
+ traceContext: {
7
+ traceparent?: string;
8
+ };
9
+ source: string;
10
+ domain?: string;
11
+ visibility?: 'public' | 'private';
12
+ payload: {
13
+ segmentId: string;
14
+ sector: string;
15
+ country: 'CA' | 'US';
16
+ count: number;
17
+ };
18
+ }
19
+ //# sourceMappingURL=SegmentMembersAddedEvent.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SegmentMembersAddedEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/SegmentMembersAddedEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,wBAAwB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,0BAA0B,CAAC;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QAEb,WAAW,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAClC,OAAO,EAAE;QAER,SAAS,EAAE,MAAM,CAAC;QAElB,MAAM,EAAE,MAAM,CAAC;QAEf,OAAO,EAAE,IAAI,GAAG,IAAI,CAAC;QAErB,KAAK,EAAE,MAAM,CAAC;KACd,CAAC;CACF"}
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ //# sourceMappingURL=SegmentMembersAddedEvent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SegmentMembersAddedEvent.js","sourceRoot":"","sources":["../../../src/messages/events/SegmentMembersAddedEvent.ts"],"names":[],"mappings":";AAAA,sDAAsD"}
@@ -0,0 +1,19 @@
1
+ export interface SegmentMembersRemovedEvent {
2
+ id: string;
3
+ type: 'SegmentMembersRemovedEvent';
4
+ version: '0.0.1';
5
+ timestamp: string;
6
+ traceContext: {
7
+ traceparent?: string;
8
+ };
9
+ source: string;
10
+ domain?: string;
11
+ visibility?: 'public' | 'private';
12
+ payload: {
13
+ segmentId: string;
14
+ sector: string;
15
+ country: 'CA' | 'US';
16
+ count: number;
17
+ };
18
+ }
19
+ //# sourceMappingURL=SegmentMembersRemovedEvent.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SegmentMembersRemovedEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/SegmentMembersRemovedEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,0BAA0B;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QAEb,WAAW,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAClC,OAAO,EAAE;QAER,SAAS,EAAE,MAAM,CAAC;QAElB,MAAM,EAAE,MAAM,CAAC;QAEf,OAAO,EAAE,IAAI,GAAG,IAAI,CAAC;QAErB,KAAK,EAAE,MAAM,CAAC;KACd,CAAC;CACF"}
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ //# sourceMappingURL=SegmentMembersRemovedEvent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SegmentMembersRemovedEvent.js","sourceRoot":"","sources":["../../../src/messages/events/SegmentMembersRemovedEvent.ts"],"names":[],"mappings":";AAAA,sDAAsD"}
@@ -0,0 +1,24 @@
1
+ export interface SegmentRuleChangedEvent {
2
+ id: string;
3
+ type: 'SegmentRuleChangedEvent';
4
+ version: '0.0.1';
5
+ timestamp: string;
6
+ traceContext: {
7
+ traceparent?: string;
8
+ };
9
+ source: string;
10
+ domain?: string;
11
+ visibility?: 'public' | 'private';
12
+ payload: {
13
+ segmentId: string;
14
+ ruleJson: {
15
+ attribute: string;
16
+ operator: string;
17
+ value: string;
18
+ };
19
+ sector: string;
20
+ country: 'CA' | 'US';
21
+ updatedAt: string;
22
+ };
23
+ }
24
+ //# sourceMappingURL=SegmentRuleChangedEvent.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SegmentRuleChangedEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/SegmentRuleChangedEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,uBAAuB;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,yBAAyB,CAAC;IAChC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QAEb,WAAW,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAClC,OAAO,EAAE;QAER,SAAS,EAAE,MAAM,CAAC;QAElB,QAAQ,EAAE;YAET,SAAS,EAAE,MAAM,CAAC;YAElB,QAAQ,EAAE,MAAM,CAAC;YAEjB,KAAK,EAAE,MAAM,CAAC;SACd,CAAC;QAEF,MAAM,EAAE,MAAM,CAAC;QAEf,OAAO,EAAE,IAAI,GAAG,IAAI,CAAC;QAErB,SAAS,EAAE,MAAM,CAAC;KAClB,CAAC;CACF"}
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ //# sourceMappingURL=SegmentRuleChangedEvent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SegmentRuleChangedEvent.js","sourceRoot":"","sources":["../../../src/messages/events/SegmentRuleChangedEvent.ts"],"names":[],"mappings":";AAAA,sDAAsD"}
@@ -0,0 +1,25 @@
1
+ export interface VoucherRedeemedEvent {
2
+ id: string;
3
+ type: 'VoucherRedeemedEvent';
4
+ version: '0.0.1';
5
+ timestamp: string;
6
+ traceContext: {
7
+ traceparent?: string;
8
+ };
9
+ source: string;
10
+ domain?: string;
11
+ visibility?: 'public' | 'private';
12
+ payload: {
13
+ redemptionId: string;
14
+ voucherId: string;
15
+ voucherCode: string;
16
+ campaignId: string;
17
+ orderId: string;
18
+ customerId: string;
19
+ siteId: string;
20
+ sector: string;
21
+ country: 'CA' | 'US';
22
+ discountAmountCents: number;
23
+ };
24
+ }
25
+ //# sourceMappingURL=VoucherRedeemedEvent.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"VoucherRedeemedEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/VoucherRedeemedEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,oBAAoB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,sBAAsB,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QAEb,WAAW,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAClC,OAAO,EAAE;QAER,YAAY,EAAE,MAAM,CAAC;QAErB,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB,OAAO,EAAE,MAAM,CAAC;QAEhB,UAAU,EAAE,MAAM,CAAC;QAEnB,MAAM,EAAE,MAAM,CAAC;QAEf,MAAM,EAAE,MAAM,CAAC;QAEf,OAAO,EAAE,IAAI,GAAG,IAAI,CAAC;QAErB,mBAAmB,EAAE,MAAM,CAAC;KAC5B,CAAC;CACF"}
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ //# sourceMappingURL=VoucherRedeemedEvent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"VoucherRedeemedEvent.js","sourceRoot":"","sources":["../../../src/messages/events/VoucherRedeemedEvent.ts"],"names":[],"mappings":";AAAA,sDAAsD"}
@@ -1,5 +1,6 @@
1
1
  export { AuditEvent } from './AuditEvent';
2
2
  export { AvrideOrderStatusUpdatedEvent } from './AvrideOrderStatusUpdatedEvent';
3
+ export { CampaignStatusChangedEvent } from './CampaignStatusChangedEvent';
3
4
  export { DeliveryDropOffLeaveWarningEvent } from './DeliveryDropOffLeaveWarningEvent';
4
5
  export { DiscountCreatedEvent } from './DiscountCreatedEvent';
5
6
  export { DiscountDeactivatedEvent } from './DiscountDeactivatedEvent';
@@ -34,11 +35,18 @@ export { OrderRefundDeniedEvent } from './OrderRefundDeniedEvent';
34
35
  export { OrderUpdatedEvent } from './OrderUpdatedEvent';
35
36
  export { PublishedMenuCreatedEvent } from './PublishedMenuCreatedEvent';
36
37
  export { PublishedMenuUpdatedEvent } from './PublishedMenuUpdatedEvent';
38
+ export { RedemptionRolledBackEvent } from './RedemptionRolledBackEvent';
37
39
  export { ReportConfigUpdatedEvent } from './ReportConfigUpdatedEvent';
38
40
  export { ReviewCreatedEvent } from './ReviewCreatedEvent';
39
41
  export { RewardCampaignPublishedEvent } from './RewardCampaignPublishedEvent';
42
+ export { RewardCardEarnedEvent } from './RewardCardEarnedEvent';
43
+ export { RewardCardPointsAdjustedEvent } from './RewardCardPointsAdjustedEvent';
40
44
  export { RewardCreatedEvent } from './RewardCreatedEvent';
45
+ export { RewardMilestoneReachedEvent } from './RewardMilestoneReachedEvent';
41
46
  export { RewardRedeemedEvent } from './RewardRedeemedEvent';
47
+ export { SegmentMembersAddedEvent } from './SegmentMembersAddedEvent';
48
+ export { SegmentMembersRemovedEvent } from './SegmentMembersRemovedEvent';
49
+ export { SegmentRuleChangedEvent } from './SegmentRuleChangedEvent';
42
50
  export { ShoppingCartCreatedEvent } from './ShoppingCartCreatedEvent';
43
51
  export { ShoppingCartUpdatedEvent } from './ShoppingCartUpdatedEvent';
44
52
  export { TaskCreatedEvent } from './TaskCreatedEvent';
@@ -49,4 +57,5 @@ export { UserEmailVerificationRequestedEvent } from './UserEmailVerificationRequ
49
57
  export { UserPasswordChangedEvent } from './UserPasswordChangedEvent';
50
58
  export { UserPasswordResetRequestedEvent } from './UserPasswordResetRequestedEvent';
51
59
  export { UserUpdatedEvent } from './UserUpdatedEvent';
60
+ export { VoucherRedeemedEvent } from './VoucherRedeemedEvent';
52
61
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/messages/events/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAEhF,OAAO,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAEtF,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAEhF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,uCAAuC,EAAE,MAAM,2CAA2C,CAAC;AAEpG,OAAO,EAAE,uCAAuC,EAAE,MAAM,2CAA2C,CAAC;AAEpG,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAElF,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAElF,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAE9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,mCAAmC,EAAE,MAAM,uCAAuC,CAAC;AAE5F,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,OAAO,EAAE,+BAA+B,EAAE,MAAM,mCAAmC,CAAC;AAEpF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/messages/events/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAEhF,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAEtF,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAEhF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,uCAAuC,EAAE,MAAM,2CAA2C,CAAC;AAEpG,OAAO,EAAE,uCAAuC,EAAE,MAAM,2CAA2C,CAAC;AAEpG,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAElF,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAElF,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAE9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAEhF,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,mCAAmC,EAAE,MAAM,uCAAuC,CAAC;AAE5F,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,OAAO,EAAE,+BAA+B,EAAE,MAAM,mCAAmC,CAAC;AAEpF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "4.878.0",
3
+ "version": "4.880.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
@@ -589,7 +589,7 @@ export interface ConsumerDiscountIs {
589
589
  }
590
590
 
591
591
  export interface ConsumerVoucherifyMetaDataDiscount {
592
- type: 'AMOUNT_OFF' | 'PERCENT_OFF' | 'FIXED_PRICE';
592
+ type: 'AMOUNT_OFF' | 'PERCENT_OFF' | 'FIXED_PRICE' | 'FREE';
593
593
  amountOff?: number;
594
594
  percentOff?: number;
595
595
  fixedPrice?: number;
@@ -1449,11 +1449,28 @@ export interface ConsumerDiscountSchedule {
1449
1449
 
1450
1450
  export interface ConsumerDiscountMethod {
1451
1451
  // discount method name
1452
- name: Record<string, any>;
1452
+ name: 'AMOUNT_OFF' | 'PERCENT_OFF' | 'FIXED_PRICE' | 'FREE';
1453
1453
  // discount method value
1454
1454
  value: number;
1455
1455
  }
1456
1456
 
1457
+ export interface ConsumerItemLevelConfigDetails {
1458
+ // Marks the bundle group that receives the discount for Buy X Get Y.
1459
+ isDiscounted?: boolean;
1460
+ // How many extra items are discounted per qualified set for Buy X Get X. Applies to PERCENT_OFF, AMOUNT_OFF, and FREE.
1461
+ discountedItemQuantity?: number;
1462
+ bundleGroupName?: string;
1463
+ bundleGroupId?: string;
1464
+ minimum: number;
1465
+ }
1466
+
1467
+ export interface ConsumerItemLevelConfig {
1468
+ details: ConsumerItemLevelConfigDetails[];
1469
+ // Lower integer = higher priority when multiple overlapping bundles exist.
1470
+ bundlePriority?: number;
1471
+ sectorName?: string;
1472
+ }
1473
+
1457
1474
  export interface ConsumerDiscountChannelConfig {
1458
1475
  // thrive channel
1459
1476
  thrive: boolean;
@@ -1478,6 +1495,9 @@ export interface ConsumerDiscountDTO {
1478
1495
  schedule?: ConsumerDiscountSchedule;
1479
1496
  // discount method configuration
1480
1497
  method: ConsumerDiscountMethod;
1498
+ type: 'Total Order' | 'Single Items' | 'Bundle' | 'Buy X Get Y' | 'Buy X Get X';
1499
+ // bundle groups of an item level discount
1500
+ itemLevelConfig?: ConsumerItemLevelConfig;
1481
1501
  createdAt: string;
1482
1502
  updatedAt: string;
1483
1503
  name: string;
@@ -1485,7 +1505,6 @@ export interface ConsumerDiscountDTO {
1485
1505
  is?: ConsumerDiscountIs;
1486
1506
  meta?: ConsumerDiscountMeta;
1487
1507
  channelConfig: ConsumerDiscountChannelConfig;
1488
- type: Record<string, any>;
1489
1508
  }
1490
1509
 
1491
1510
  export interface ConsumerMenuHours {
@@ -0,0 +1,37 @@
1
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
+
3
+ export interface CampaignStatusChangedEvent {
4
+ id: string;
5
+ type: 'CampaignStatusChangedEvent';
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 campaign whose status changed
19
+ campaignId: string;
20
+ // Id of the campaign status history row the transition wrote. One per transition, so consumers can drop a redelivered event by it
21
+ transitionId: string;
22
+ // Campaign status before the transition
23
+ previousStatus: 'draft' | 'active' | 'paused' | 'expired' | 'archived';
24
+ // Campaign status after the transition
25
+ status: 'draft' | 'active' | 'paused' | 'expired' | 'archived';
26
+ // Free-text reason the caller gave for the transition, null or absent when none was given
27
+ reason?: string | null;
28
+ // Location-service sector name the campaign is scoped to, e.g. Eurest. A name, not a sector id
29
+ sector: string;
30
+ // Country the campaign is scoped to
31
+ country: 'CA' | 'US';
32
+ // Subject of the authenticated caller that made the transition, typically a user id
33
+ changedBy: string;
34
+ // ISO 8601 time of the transition, the campaign's updatedAt as written by the status update
35
+ changedAt: string;
36
+ };
37
+ }
@@ -0,0 +1,41 @@
1
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
+
3
+ export interface RedemptionRolledBackEvent {
4
+ id: string;
5
+ type: 'RedemptionRolledBackEvent';
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 rolled-back redemption, the same id its VoucherRedeemedEvent carried.
19
+ redemptionId: string;
20
+ // Id of the voucher the redemption used.
21
+ voucherId: string;
22
+ // Id of the campaign the voucher belongs to.
23
+ campaignId: string;
24
+ // Id of the order the redemption applied to, the same value its VoucherRedeemedEvent carried.
25
+ orderId: string;
26
+ // Customer the redemption belongs to, the same identifier its VoucherRedeemedEvent carried: the customer's source id, or their email when the redeem request had none.
27
+ customerId: string;
28
+ // Id of the site the order was placed at, the same value its VoucherRedeemedEvent carried.
29
+ siteId: string;
30
+ // Sector the voucher's campaign is scoped to, as a location-service sector name (e.g. Eurest). Copied onto the redemption when it was written.
31
+ sector: string;
32
+ // Country the voucher's campaign is scoped to. Copied onto the redemption when it was written.
33
+ country: 'CA' | 'US';
34
+ // Discount the redemption had applied to the order, in cents. This is the amount to reverse.
35
+ discountAmountCents: number;
36
+ // Why the redemption was rolled back, as given by the caller of the rollback endpoint. Free text, trimmed, never blank.
37
+ reason: string;
38
+ // When loyalty recorded the rollback.
39
+ rolledBackAt: string;
40
+ };
41
+ }
@@ -0,0 +1,39 @@
1
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
+
3
+ export interface RewardCardEarnedEvent {
4
+ id: string;
5
+ type: 'RewardCardEarnedEvent';
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
+ // Reward card that earned the points
19
+ cardId: string;
20
+ // Reward the card belongs to
21
+ rewardId: string;
22
+ // Customer the card belongs to: the customerId sent on the earn request
23
+ customerId: string;
24
+ // Order that earned the points, as sent on the earn request
25
+ orderId: string;
26
+ // Points credited to the card for this order: the sum of the reward's matched earning rules. Same field as on RewardCardPointsAdjustedEvent, so one ledger handler can fold both events
27
+ pointsDelta: number;
28
+ // Card points balance after the credit
29
+ pointsBalance: number;
30
+ // Sector of the site the order was placed at, as sent on the earn request (location-service sector name, e.g. Eurest)
31
+ sector: string;
32
+ // Country of the site the order was placed at, as sent on the earn request
33
+ country: 'CA' | 'US';
34
+ // Site the order was placed at, as sent on the earn request. This is the order's site, unlike siteId on RewardCardPointsAdjustedEvent, which is the reward's scope
35
+ siteId: string;
36
+ // When the points were credited
37
+ earnedAt: string;
38
+ };
39
+ }
@@ -0,0 +1,43 @@
1
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
+
3
+ export interface RewardCardPointsAdjustedEvent {
4
+ id: string;
5
+ type: 'RewardCardPointsAdjustedEvent';
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
+ // Reward card whose balance was adjusted
19
+ cardId: string;
20
+ // Reward the card belongs to
21
+ rewardId: string;
22
+ // Customer the card belongs to: the customerId the earn request sent when the card was created
23
+ customerId: string;
24
+ // Points the adjustment added (positive) or deducted (negative). Never 0. Same field as on RewardCardEarnedEvent, so one ledger handler can fold both events
25
+ pointsDelta: number;
26
+ // Card points balance before the adjustment
27
+ previousBalance: number;
28
+ // Card points balance after the adjustment: previousBalance plus pointsDelta
29
+ pointsBalance: number;
30
+ // Sector the card's reward is scoped to (location-service sector name, e.g. Eurest)
31
+ sector: string;
32
+ // Country the card's reward is scoped to
33
+ country: 'CA' | 'US';
34
+ // Site the card's reward is scoped to, or null when the reward is sector-wide. This is the reward's scope, unlike siteId on RewardCardEarnedEvent, which is the order's site
35
+ siteId: string | null;
36
+ // Reason the operator gave for the adjustment, trimmed
37
+ description: string;
38
+ // Subject of the authenticated caller that made the adjustment, typically a user id
39
+ adjustedBy: string;
40
+ // When the adjustment was recorded
41
+ adjustedAt: string;
42
+ };
43
+ }
@@ -0,0 +1,41 @@
1
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
+
3
+ export interface RewardMilestoneReachedEvent {
4
+ id: string;
5
+ type: 'RewardMilestoneReachedEvent';
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
+ // Reward card that crossed the milestone
19
+ cardId: string;
20
+ // Reward the card and the milestone belong to
21
+ rewardId: string;
22
+ // Customer the card belongs to and the voucher was issued to: the customerId sent on the earn request
23
+ customerId: string;
24
+ // Order whose points took the card across the milestone, as sent on the earn request
25
+ orderId: string;
26
+ // Campaign the milestone issues its voucher from
27
+ campaignId: string;
28
+ // Personal voucher issued for this milestone crossing
29
+ voucherId: string;
30
+ // Code of the issued voucher: the campaign's consumer-app prefix (boore for Boost, thrre for Thrive) followed by eight lowercase letters
31
+ voucherCode: string;
32
+ // Sector of the site the order was placed at, as sent on the earn request (location-service sector name, e.g. Eurest)
33
+ sector: string;
34
+ // Country of the site the order was placed at, as sent on the earn request
35
+ country: 'CA' | 'US';
36
+ // Site the order was placed at, as sent on the earn request
37
+ siteId: string;
38
+ // Points threshold of the milestone the card crossed
39
+ pointsRequired: number;
40
+ };
41
+ }
@@ -0,0 +1,27 @@
1
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
+
3
+ export interface SegmentMembersAddedEvent {
4
+ id: string;
5
+ type: 'SegmentMembersAddedEvent';
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 static-list segment the customers were added to
19
+ segmentId: string;
20
+ // Location-service sector name the segment is scoped to, e.g. Eurest. A name, not a sector id
21
+ sector: string;
22
+ // Country the segment is scoped to
23
+ country: 'CA' | 'US';
24
+ // Number of customers who became members in this request, including previously removed customers added back. Customers who were already members are not counted, and no event is published when no one became a member.
25
+ count: number;
26
+ };
27
+ }
@@ -0,0 +1,27 @@
1
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
+
3
+ export interface SegmentMembersRemovedEvent {
4
+ id: string;
5
+ type: 'SegmentMembersRemovedEvent';
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 static-list segment the customers were removed from
19
+ segmentId: string;
20
+ // Location-service sector name the segment is scoped to, e.g. Eurest. A name, not a sector id
21
+ sector: string;
22
+ // Country the segment is scoped to
23
+ country: 'CA' | 'US';
24
+ // Number of customers whose membership this request ended. Customers who were not members are not counted, and no event is published when no one was removed.
25
+ count: number;
26
+ };
27
+ }