@voucherify/sdk 2.9.2 → 2.9.4

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 (75) hide show
  1. package/dist/ApiLimitsHandler.d.ts +13 -10
  2. package/dist/AsyncActions.d.ts +17 -15
  3. package/dist/Balance.d.ts +15 -12
  4. package/dist/Campaigns.d.ts +66 -58
  5. package/dist/Categories.d.ts +29 -26
  6. package/dist/ClientSide.d.ts +77 -53
  7. package/dist/Consents.d.ts +13 -10
  8. package/dist/Customers.d.ts +75 -72
  9. package/dist/Distributions.d.ts +29 -22
  10. package/dist/Events.d.ts +15 -10
  11. package/dist/Exports.d.ts +25 -22
  12. package/dist/Loyalties.d.ts +171 -159
  13. package/dist/MetadataSchemas.d.ts +17 -14
  14. package/dist/Orders.d.ts +32 -27
  15. package/dist/ProductCollections.d.ts +30 -26
  16. package/dist/Products.d.ts +66 -63
  17. package/dist/PromotionTiers.d.ts +43 -34
  18. package/dist/Promotions.d.ts +30 -18
  19. package/dist/PromotionsStacks.d.ts +34 -30
  20. package/dist/Qualifications.d.ts +24 -10
  21. package/dist/Redemptions.d.ts +53 -35
  22. package/dist/RequestController.d.ts +31 -29
  23. package/dist/Rewards.d.ts +46 -43
  24. package/dist/Segments.d.ts +25 -22
  25. package/dist/ValidationRules.d.ts +47 -43
  26. package/dist/Validations.d.ts +39 -17
  27. package/dist/VoucherifyClientSide.d.ts +112 -86
  28. package/dist/VoucherifyError.d.ts +23 -20
  29. package/dist/VoucherifyServerSide.d.ts +170 -131
  30. package/dist/Vouchers.d.ts +84 -78
  31. package/dist/helpers.d.ts +20 -18
  32. package/dist/index.d.ts +63 -25
  33. package/dist/types/ApplicableTo.d.ts +32 -30
  34. package/dist/types/AsyncActions.d.ts +23 -21
  35. package/dist/types/Balance.d.ts +18 -16
  36. package/dist/types/Campaigns.d.ts +124 -120
  37. package/dist/types/Categories.d.ts +40 -38
  38. package/dist/types/ClientSide.d.ts +145 -134
  39. package/dist/types/Consents.d.ts +34 -33
  40. package/dist/types/Customers.d.ts +363 -361
  41. package/dist/types/DiscountVoucher.d.ts +94 -93
  42. package/dist/types/Distributions.d.ts +148 -144
  43. package/dist/types/Events.d.ts +21 -17
  44. package/dist/types/Exports.d.ts +151 -149
  45. package/dist/types/Gift.d.ts +5 -3
  46. package/dist/types/Loyalties.d.ts +1061 -1057
  47. package/dist/types/MetadataSchemas.d.ts +34 -33
  48. package/dist/types/Orders.d.ts +199 -195
  49. package/dist/types/ProductCollections.d.ts +99 -96
  50. package/dist/types/Products.d.ts +108 -106
  51. package/dist/types/PromotionTiers.d.ts +131 -127
  52. package/dist/types/Promotions.d.ts +113 -108
  53. package/dist/types/PromotionsStacks.d.ts +74 -71
  54. package/dist/types/Qualifications.d.ts +92 -86
  55. package/dist/types/Redemptions.d.ts +215 -205
  56. package/dist/types/Rewards.d.ts +220 -219
  57. package/dist/types/Segments.d.ts +34 -32
  58. package/dist/types/Stackable.d.ts +106 -101
  59. package/dist/types/UtilityTypes.d.ts +5 -3
  60. package/dist/types/ValidateSession.d.ts +19 -17
  61. package/dist/types/ValidationError.d.ts +9 -7
  62. package/dist/types/ValidationRules.d.ts +96 -93
  63. package/dist/types/Validations.d.ts +109 -98
  64. package/dist/types/Vouchers.d.ts +452 -364
  65. package/dist/types/index.d.ts +27 -25
  66. package/dist/voucherifysdk.cjs +2023 -0
  67. package/dist/voucherifysdk.cjs.map +1 -0
  68. package/dist/voucherifysdk.esm.js +981 -1256
  69. package/dist/voucherifysdk.esm.js.map +1 -1
  70. package/package.json +13 -9
  71. package/CHANGELOG.md +0 -663
  72. package/dist/voucherifysdk.umd.development.js +0 -2270
  73. package/dist/voucherifysdk.umd.development.js.map +0 -1
  74. package/dist/voucherifysdk.umd.production.min.js +0 -2
  75. package/dist/voucherifysdk.umd.production.min.js.map +0 -1
@@ -1,22 +1,29 @@
1
- import * as T from './types/Distributions';
2
- import type { Exports } from './Exports';
3
- import type { RequestController } from './RequestController';
4
- declare class DistributionsPublications {
5
- private client;
6
- constructor(client: RequestController);
7
- /**
8
- * @see https://docs.voucherify.io/reference/list-publications
9
- */
10
- list(params?: T.DistributionsPublicationsListParams): Promise<T.DistributionsPublicationsListResponse>;
11
- /**
12
- * @see https://docs.voucherify.io/reference/create-publication
13
- */
14
- create(params: T.DistributionsPublicationsCreateParams): Promise<T.DistributionsPublicationsCreateResponse>;
15
- }
16
- export declare class Distributions {
17
- private client;
18
- exports: Exports;
19
- publications: DistributionsPublications;
20
- constructor(client: RequestController, exports: Exports);
21
- }
22
- export {};
1
+ import { DistributionsPublicationsListParams, DistributionsPublicationsListResponse, DistributionsPublicationsCreateParams, DistributionsPublicationsCreateResponse } from './types/Distributions.js';
2
+ import { Exports } from './Exports.js';
3
+ import { RequestController } from './RequestController.js';
4
+ import './types/Customers.js';
5
+ import './types/DiscountVoucher.js';
6
+ import './types/Vouchers.js';
7
+ import './types/Orders.js';
8
+ import './types/Exports.js';
9
+
10
+ declare class DistributionsPublications {
11
+ private client;
12
+ constructor(client: RequestController);
13
+ /**
14
+ * @see https://docs.voucherify.io/reference/list-publications
15
+ */
16
+ list(params?: DistributionsPublicationsListParams): Promise<DistributionsPublicationsListResponse>;
17
+ /**
18
+ * @see https://docs.voucherify.io/reference/create-publication
19
+ */
20
+ create(params: DistributionsPublicationsCreateParams): Promise<DistributionsPublicationsCreateResponse>;
21
+ }
22
+ declare class Distributions {
23
+ private client;
24
+ exports: Exports;
25
+ publications: DistributionsPublications;
26
+ constructor(client: RequestController, exports: Exports);
27
+ }
28
+
29
+ export { Distributions };
package/dist/Events.d.ts CHANGED
@@ -1,10 +1,15 @@
1
- import * as T from './types/Events';
2
- import type { RequestController } from './RequestController';
3
- export declare class Events {
4
- private client;
5
- constructor(client: RequestController);
6
- /**
7
- * @see https://docs.voucherify.io/reference/track-custom-event-client-side
8
- */
9
- create(eventName: string, params: T.EventsParams): Promise<T.EventsResponse>;
10
- }
1
+ import { EventsParams, EventsResponse } from './types/Events.js';
2
+ import { RequestController } from './RequestController.js';
3
+ import './types/Customers.js';
4
+ import './types/DiscountVoucher.js';
5
+
6
+ declare class Events {
7
+ private client;
8
+ constructor(client: RequestController);
9
+ /**
10
+ * @see https://docs.voucherify.io/reference/track-custom-event-client-side
11
+ */
12
+ create(eventName: string, params: EventsParams): Promise<EventsResponse>;
13
+ }
14
+
15
+ export { Events };
package/dist/Exports.d.ts CHANGED
@@ -1,22 +1,25 @@
1
- import * as T from './types/Exports';
2
- import type { RequestController } from './RequestController';
3
- export declare class Exports {
4
- private client;
5
- constructor(client: RequestController);
6
- /**
7
- * @see https://docs.voucherify.io/reference/create-export
8
- */
9
- create(exportResource: T.ExportResource): Promise<T.ExportsCreateResponse>;
10
- /**
11
- * @see https://docs.voucherify.io/reference/list-exports
12
- */
13
- list(query?: T.ExportsListRequestQuery): Promise<T.ExportsListResponseBody>;
14
- /**
15
- * @see https://docs.voucherify.io/reference/get-export
16
- */
17
- get(exportResourceId: string): Promise<T.ExportsCreateResponse>;
18
- /**
19
- * @see https://docs.voucherify.io/reference/delete-export
20
- */
21
- delete(exportResourceId: string): Promise<unknown>;
22
- }
1
+ import { ExportResource, ExportsCreateResponse, ExportsListRequestQuery, ExportsListResponseBody } from './types/Exports.js';
2
+ import { RequestController } from './RequestController.js';
3
+
4
+ declare class Exports {
5
+ private client;
6
+ constructor(client: RequestController);
7
+ /**
8
+ * @see https://docs.voucherify.io/reference/create-export
9
+ */
10
+ create(exportResource: ExportResource): Promise<ExportsCreateResponse>;
11
+ /**
12
+ * @see https://docs.voucherify.io/reference/list-exports
13
+ */
14
+ list(query?: ExportsListRequestQuery): Promise<ExportsListResponseBody>;
15
+ /**
16
+ * @see https://docs.voucherify.io/reference/get-export
17
+ */
18
+ get(exportResourceId: string): Promise<ExportsCreateResponse>;
19
+ /**
20
+ * @see https://docs.voucherify.io/reference/delete-export
21
+ */
22
+ delete(exportResourceId: string): Promise<unknown>;
23
+ }
24
+
25
+ export { Exports };
@@ -1,159 +1,171 @@
1
- import * as T from './types/Loyalties';
2
- import type { RequestController } from './RequestController';
3
- export declare class Loyalties {
4
- private client;
5
- constructor(client: RequestController);
6
- /**
7
- * @see https://docs.voucherify.io/reference/list-loyalty-programs
8
- */
9
- list(params?: T.LoyaltiesListParams): Promise<T.LoyaltiesListResponse>;
10
- /**
11
- * @see https://docs.voucherify.io/reference/create-loyalty-program
12
- */
13
- create(campaign: T.LoyaltiesCreateCampaign): Promise<T.LoyaltiesCreateCampaignResponse>;
14
- /**
15
- * @see https://docs.voucherify.io/reference/get-loyalty-program
16
- */
17
- get(campaignId: string): Promise<T.LoyaltiesCreateCampaignResponse>;
18
- /**
19
- * @see https://docs.voucherify.io/reference/update-loyalty-program
20
- */
21
- update(campaign: T.LoyaltiesUpdateCampaign): Promise<T.LoyaltiesCreateCampaignResponse>;
22
- /**
23
- * @see https://docs.voucherify.io/reference/delete-loyalty-program
24
- */
25
- delete(campaignId: string, params?: T.LoyaltiesDeleteCampaignParams): Promise<unknown>;
26
- /**
27
- * @see https://docs.voucherify.io/reference/list-reward-assignments-1
28
- */
29
- listRewardAssignments(campaignId: string, params?: T.LoyaltiesListRewardAssignmentsParams): Promise<T.LoyaltiesListRewardAssignmentsResponse>;
30
- /**
31
- * @see https://docs.voucherify.io/reference/create-reward-assignment-1
32
- */
33
- createRewardAssignments(campaignId: string, assignment: T.LoyaltiesCreateRewardAssignments[]): Promise<T.LoyaltiesCreateRewardAssignmentResponse[]>;
34
- /**
35
- * @see https://docs.voucherify.io/reference/update-reward-assignment-1
36
- */
37
- updateRewardAssignment(campaignId: string, assignment: T.LoyaltiesUpdateRewardAssignment): Promise<T.LoyaltiesCreateRewardAssignmentResponse>;
38
- /**
39
- * @see https://docs.voucherify.io/reference/delete-reward-assignment-1
40
- */
41
- deleteRewardAssignment(campaignId: string, assignmentId: string): Promise<unknown>;
42
- /**
43
- * @see https://docs.voucherify.io/reference/get-reward-assignment-2
44
- */
45
- getRewardAssignment(campaignId: string, assignmentId: string): Promise<import("./types").RewardAssignment>;
46
- /**
47
- * @see https://docs.voucherify.io/reference/list-earning-rules
48
- */
49
- listEarningRules(campaignId: string, params?: T.LoyaltiesListEarningRulesParams): Promise<T.LoyaltiesListEarningRulesResponse>;
50
- /**
51
- * @see https://docs.voucherify.io/reference/create-earning-rule
52
- */
53
- createEarningRule(campaignId: string, earningRules: T.LoyaltiesCreateEarningRule[]): Promise<T.LoyaltiesEarningRulesResponse[]>;
54
- /**
55
- * @see https://docs.voucherify.io/reference/update-earning-rule
56
- */
57
- updateEarningRule(campaignId: string, earningRule: T.LoyaltiesUpdateEarningRule): Promise<T.LoyaltiesEarningRulesResponse>;
58
- /**
59
- * @see https://docs.voucherify.io/reference/delete-earning-rule
60
- */
61
- deleteEarningRule(campaignId: string, earningRuleId: string): Promise<unknown>;
62
- /**
63
- * @see https://docs.voucherify.io/reference/get-earning-rule
64
- */
65
- getEarningRule(campaignId: string, earningRuleId: string): Promise<T.EarningRule>;
66
- /**
67
- * @see https://docs.voucherify.io/reference/enable-earning-rule
68
- */
69
- enableEarningRule(campaignId: string, earningRuleId: string): Promise<T.LoyaltiesEnableEarningRulesResponseBody>;
70
- /**
71
- * @see https://docs.voucherify.io/reference/disable-earning-rule
72
- */
73
- disableEarningRule(campaignId: string, earningRuleId: string): Promise<T.LoyaltiesDisableEarningRulesResponseBody>;
74
- /**
75
- * @see https://docs.voucherify.io/reference/list-members
76
- */
77
- listMembers(campaignId: string, params?: T.LoyaltiesListMembersParams): Promise<T.LoyaltiesListMembersResponse>;
78
- /**
79
- * @see https://docs.voucherify.io/reference/create-member
80
- */
81
- createMember(campaignId: string, member: T.LoyaltiesCreateMember): Promise<T.LoyaltiesVoucherResponse>;
82
- /**
83
- * @see https://docs.voucherify.io/reference/get-member
84
- * @see https://docs.voucherify.io/reference/get-member-1
85
- */
86
- getMember(campaignId: string | null, memberId: string): Promise<T.LoyaltiesVoucherResponse>;
87
- /**
88
- * @see https://docs.voucherify.io/reference/list-member-activity
89
- * @see https://docs.voucherify.io/reference/list-member-activity-1
90
- */
91
- listMemberActivity(campaignId: string | null, memberId: string, params?: T.LoyaltiesListMemberActivityParams): Promise<T.LoyaltiesListMemberActivityResponse>;
92
- /**
93
- * @deprecated This method is deprecated in favor of the `listMemberActivity` method. We’re removing this method in next major version.
94
- */
95
- getMemberActivities(campaignId: string | null, memberId: string): Promise<T.LoyaltiesGetMemberActivitiesResponse>;
96
- /**
97
- * @see https://docs.voucherify.io/reference/list-member-rewards
98
- */
99
- listMemberRewards(memberId: string, params?: T.LoyaltiesListMemberRewardsRequestQuery): Promise<T.LoyaltiesListMemberRewardsResponseBody>;
100
- /**
101
- * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance
102
- * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
103
- */
104
- addOrRemoveCardBalance(memberId: string, balance: T.LoyaltiesAddOrRemoveCardBalanceRequestBody, campaignId?: string): Promise<T.LoyaltiesAddOrRemoveCardBalanceResponseBody>;
105
- /**
106
- * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
107
- */
108
- addPoints(campaignId: string, memberId: string, balance: T.LoyaltiesAddPoints): Promise<T.LoyaltiesAddPointsResponse>;
109
- /**
110
- * @see https://docs.voucherify.io/reference/transfer-points
111
- */
112
- transferPoints(campaignId: string, memberId: string, loyaltiesTransferPoints: T.LoyaltiesTransferPointsRequestBody): Promise<T.LoyaltiesTransferPointsResponseBody>;
113
- /**
114
- * @see https://docs.voucherify.io/reference/get-points-expiration
115
- */
116
- getPointsExpiration(campaignId: string, memberId: string, params?: T.LoyaltiesGetPointsExpirationRequestQuery): Promise<T.LoyaltiesGetPointsExpirationResponseBody>;
117
- /**
118
- * @see https://docs.voucherify.io/reference/redeem-loyalty-card
119
- */
120
- redeemReward(campaignId: string, memberId: string, params: T.LoyaltiesRedeemRewardParams): Promise<T.LoyaltiesRedeemRewardResponse>;
121
- /**
122
- * @see https://docs.voucherify.io/reference/list-loyalty-tier-rewards
123
- */
124
- listLoyaltyTierRewards(campaignId: string, tierId: string): Promise<T.LoyaltiesListLoyaltyTierRewardsResponseBody>;
125
- /**
126
- * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions
127
- * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions-1
128
- */
129
- listCardTransactions(memberId: string, campaignId: string | null, params?: T.LoyaltiesListCardTransactionsRequestQuery): Promise<T.LoyaltiesListCardTransactionsResponseBody>;
130
- /**
131
- * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions
132
- * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions-1
133
- */
134
- exportCardTransactions(memberId: string, campaignId: string | null, params?: T.LoyaltiesExportCardTransactionsRequestBody): Promise<import("./types").VouchersExportTransactionsResponseBody>;
135
- /**
136
- * @see https://docs.voucherify.io/reference/get-reward-details
137
- */
138
- getRewardDetails(campaignId: string, assignmentId: string): Promise<import("./types").Reward>;
139
- /**
140
- * @see https://docs.voucherify.io/reference/list-loyalty-tiers
141
- */
142
- listTiers(campaignId: string, params?: T.LoyaltiesListTiersRequestQuery): Promise<T.LoyaltiesListTiersResponseBody>;
143
- /**
144
- * @see https://docs.voucherify.io/reference/get-loyalty-tier
145
- */
146
- getTier(campaignId: string, tierId: string): Promise<T.LoyaltyTier>;
147
- /**
148
- * @see https://docs.voucherify.io/reference/create-loyalty-tiers
149
- */
150
- createTiers(campaignId: string, tiers: T.LoyaltiesCreateTiersRequestBody): Promise<T.LoyaltiesCreateTiersResponseBody>;
151
- /**
152
- * @see https://docs.voucherify.io/reference/list-loyalty-tier-earning-rules
153
- */
154
- listLoyaltyTierEarningRules(campaignId: string, tierId: string, params?: T.LoyaltiesListLoyaltyTierEarningRulesRequestQuery): Promise<T.LoyaltiesListLoyaltyTierEarningRulesResponseBody>;
155
- /**
156
- * @see https://docs.voucherify.io/reference/get-member-loyalty-tier
157
- */
158
- listMemberLoyaltyTiers(memberId: string): Promise<T.LoyaltiesListMemberLoyaltyTiersResponseBody>;
159
- }
1
+ import { VouchersExportTransactionsResponseBody } from './types/Vouchers.js';
2
+ import { RewardAssignment, Reward } from './types/Rewards.js';
3
+ import { LoyaltiesListParams, LoyaltiesListResponse, LoyaltiesCreateCampaign, LoyaltiesCreateCampaignResponse, LoyaltiesUpdateCampaign, LoyaltiesDeleteCampaignParams, LoyaltiesListRewardAssignmentsParams, LoyaltiesListRewardAssignmentsResponse, LoyaltiesCreateRewardAssignments, LoyaltiesCreateRewardAssignmentResponse, LoyaltiesUpdateRewardAssignment, LoyaltiesListEarningRulesParams, LoyaltiesListEarningRulesResponse, LoyaltiesCreateEarningRule, LoyaltiesEarningRulesResponse, LoyaltiesUpdateEarningRule, EarningRule, LoyaltiesEnableEarningRulesResponseBody, LoyaltiesDisableEarningRulesResponseBody, LoyaltiesListMembersParams, LoyaltiesListMembersResponse, LoyaltiesCreateMember, LoyaltiesVoucherResponse, LoyaltiesListMemberActivityParams, LoyaltiesListMemberActivityResponse, LoyaltiesGetMemberActivitiesResponse, LoyaltiesListMemberRewardsRequestQuery, LoyaltiesListMemberRewardsResponseBody, LoyaltiesAddOrRemoveCardBalanceRequestBody, LoyaltiesAddOrRemoveCardBalanceResponseBody, LoyaltiesAddPoints, LoyaltiesAddPointsResponse, LoyaltiesTransferPointsRequestBody, LoyaltiesTransferPointsResponseBody, LoyaltiesGetPointsExpirationRequestQuery, LoyaltiesGetPointsExpirationResponseBody, LoyaltiesRedeemRewardParams, LoyaltiesRedeemRewardResponse, LoyaltiesListLoyaltyTierRewardsResponseBody, LoyaltiesListCardTransactionsRequestQuery, LoyaltiesListCardTransactionsResponseBody, LoyaltiesExportCardTransactionsRequestBody, LoyaltiesListTiersRequestQuery, LoyaltiesListTiersResponseBody, LoyaltyTier, LoyaltiesCreateTiersRequestBody, LoyaltiesCreateTiersResponseBody, LoyaltiesListLoyaltyTierEarningRulesRequestQuery, LoyaltiesListLoyaltyTierEarningRulesResponseBody, LoyaltiesListMemberLoyaltyTiersResponseBody } from './types/Loyalties.js';
4
+ import { RequestController } from './RequestController.js';
5
+ import './types/Orders.js';
6
+ import './types/Customers.js';
7
+ import './types/DiscountVoucher.js';
8
+ import './types/Products.js';
9
+ import './types/ValidationRules.js';
10
+ import './types/ApplicableTo.js';
11
+ import './types/Categories.js';
12
+
13
+ declare class Loyalties {
14
+ private client;
15
+ constructor(client: RequestController);
16
+ /**
17
+ * @see https://docs.voucherify.io/reference/list-loyalty-programs
18
+ */
19
+ list(params?: LoyaltiesListParams): Promise<LoyaltiesListResponse>;
20
+ /**
21
+ * @see https://docs.voucherify.io/reference/create-loyalty-program
22
+ */
23
+ create(campaign: LoyaltiesCreateCampaign): Promise<LoyaltiesCreateCampaignResponse>;
24
+ /**
25
+ * @see https://docs.voucherify.io/reference/get-loyalty-program
26
+ */
27
+ get(campaignId: string): Promise<LoyaltiesCreateCampaignResponse>;
28
+ /**
29
+ * @see https://docs.voucherify.io/reference/update-loyalty-program
30
+ */
31
+ update(campaign: LoyaltiesUpdateCampaign): Promise<LoyaltiesCreateCampaignResponse>;
32
+ /**
33
+ * @see https://docs.voucherify.io/reference/delete-loyalty-program
34
+ */
35
+ delete(campaignId: string, params?: LoyaltiesDeleteCampaignParams): Promise<unknown>;
36
+ /**
37
+ * @see https://docs.voucherify.io/reference/list-reward-assignments-1
38
+ */
39
+ listRewardAssignments(campaignId: string, params?: LoyaltiesListRewardAssignmentsParams): Promise<LoyaltiesListRewardAssignmentsResponse>;
40
+ /**
41
+ * @see https://docs.voucherify.io/reference/create-reward-assignment-1
42
+ */
43
+ createRewardAssignments(campaignId: string, assignment: LoyaltiesCreateRewardAssignments[]): Promise<LoyaltiesCreateRewardAssignmentResponse[]>;
44
+ /**
45
+ * @see https://docs.voucherify.io/reference/update-reward-assignment-1
46
+ */
47
+ updateRewardAssignment(campaignId: string, assignment: LoyaltiesUpdateRewardAssignment): Promise<LoyaltiesCreateRewardAssignmentResponse>;
48
+ /**
49
+ * @see https://docs.voucherify.io/reference/delete-reward-assignment-1
50
+ */
51
+ deleteRewardAssignment(campaignId: string, assignmentId: string): Promise<unknown>;
52
+ /**
53
+ * @see https://docs.voucherify.io/reference/get-reward-assignment-2
54
+ */
55
+ getRewardAssignment(campaignId: string, assignmentId: string): Promise<RewardAssignment>;
56
+ /**
57
+ * @see https://docs.voucherify.io/reference/list-earning-rules
58
+ */
59
+ listEarningRules(campaignId: string, params?: LoyaltiesListEarningRulesParams): Promise<LoyaltiesListEarningRulesResponse>;
60
+ /**
61
+ * @see https://docs.voucherify.io/reference/create-earning-rule
62
+ */
63
+ createEarningRule(campaignId: string, earningRules: LoyaltiesCreateEarningRule[]): Promise<LoyaltiesEarningRulesResponse[]>;
64
+ /**
65
+ * @see https://docs.voucherify.io/reference/update-earning-rule
66
+ */
67
+ updateEarningRule(campaignId: string, earningRule: LoyaltiesUpdateEarningRule): Promise<LoyaltiesEarningRulesResponse>;
68
+ /**
69
+ * @see https://docs.voucherify.io/reference/delete-earning-rule
70
+ */
71
+ deleteEarningRule(campaignId: string, earningRuleId: string): Promise<unknown>;
72
+ /**
73
+ * @see https://docs.voucherify.io/reference/get-earning-rule
74
+ */
75
+ getEarningRule(campaignId: string, earningRuleId: string): Promise<EarningRule>;
76
+ /**
77
+ * @see https://docs.voucherify.io/reference/enable-earning-rule
78
+ */
79
+ enableEarningRule(campaignId: string, earningRuleId: string): Promise<LoyaltiesEnableEarningRulesResponseBody>;
80
+ /**
81
+ * @see https://docs.voucherify.io/reference/disable-earning-rule
82
+ */
83
+ disableEarningRule(campaignId: string, earningRuleId: string): Promise<LoyaltiesDisableEarningRulesResponseBody>;
84
+ /**
85
+ * @see https://docs.voucherify.io/reference/list-members
86
+ */
87
+ listMembers(campaignId: string, params?: LoyaltiesListMembersParams): Promise<LoyaltiesListMembersResponse>;
88
+ /**
89
+ * @see https://docs.voucherify.io/reference/create-member
90
+ */
91
+ createMember(campaignId: string, member: LoyaltiesCreateMember): Promise<LoyaltiesVoucherResponse>;
92
+ /**
93
+ * @see https://docs.voucherify.io/reference/get-member
94
+ * @see https://docs.voucherify.io/reference/get-member-1
95
+ */
96
+ getMember(campaignId: string | null, memberId: string): Promise<LoyaltiesVoucherResponse>;
97
+ /**
98
+ * @see https://docs.voucherify.io/reference/list-member-activity
99
+ * @see https://docs.voucherify.io/reference/list-member-activity-1
100
+ */
101
+ listMemberActivity(campaignId: string | null, memberId: string, params?: LoyaltiesListMemberActivityParams): Promise<LoyaltiesListMemberActivityResponse>;
102
+ /**
103
+ * @deprecated This method is deprecated in favor of the `listMemberActivity` method. We’re removing this method in next major version.
104
+ */
105
+ getMemberActivities(campaignId: string | null, memberId: string): Promise<LoyaltiesGetMemberActivitiesResponse>;
106
+ /**
107
+ * @see https://docs.voucherify.io/reference/list-member-rewards
108
+ */
109
+ listMemberRewards(memberId: string, params?: LoyaltiesListMemberRewardsRequestQuery): Promise<LoyaltiesListMemberRewardsResponseBody>;
110
+ /**
111
+ * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance
112
+ * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
113
+ */
114
+ addOrRemoveCardBalance(memberId: string, balance: LoyaltiesAddOrRemoveCardBalanceRequestBody, campaignId?: string): Promise<LoyaltiesAddOrRemoveCardBalanceResponseBody>;
115
+ /**
116
+ * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
117
+ */
118
+ addPoints(campaignId: string, memberId: string, balance: LoyaltiesAddPoints): Promise<LoyaltiesAddPointsResponse>;
119
+ /**
120
+ * @see https://docs.voucherify.io/reference/transfer-points
121
+ */
122
+ transferPoints(campaignId: string, memberId: string, loyaltiesTransferPoints: LoyaltiesTransferPointsRequestBody): Promise<LoyaltiesTransferPointsResponseBody>;
123
+ /**
124
+ * @see https://docs.voucherify.io/reference/get-points-expiration
125
+ */
126
+ getPointsExpiration(campaignId: string, memberId: string, params?: LoyaltiesGetPointsExpirationRequestQuery): Promise<LoyaltiesGetPointsExpirationResponseBody>;
127
+ /**
128
+ * @see https://docs.voucherify.io/reference/redeem-loyalty-card
129
+ */
130
+ redeemReward(campaignId: string, memberId: string, params: LoyaltiesRedeemRewardParams): Promise<LoyaltiesRedeemRewardResponse>;
131
+ /**
132
+ * @see https://docs.voucherify.io/reference/list-loyalty-tier-rewards
133
+ */
134
+ listLoyaltyTierRewards(campaignId: string, tierId: string): Promise<LoyaltiesListLoyaltyTierRewardsResponseBody>;
135
+ /**
136
+ * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions
137
+ * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions-1
138
+ */
139
+ listCardTransactions(memberId: string, campaignId: string | null, params?: LoyaltiesListCardTransactionsRequestQuery): Promise<LoyaltiesListCardTransactionsResponseBody>;
140
+ /**
141
+ * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions
142
+ * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions-1
143
+ */
144
+ exportCardTransactions(memberId: string, campaignId: string | null, params?: LoyaltiesExportCardTransactionsRequestBody): Promise<VouchersExportTransactionsResponseBody>;
145
+ /**
146
+ * @see https://docs.voucherify.io/reference/get-reward-details
147
+ */
148
+ getRewardDetails(campaignId: string, assignmentId: string): Promise<Reward>;
149
+ /**
150
+ * @see https://docs.voucherify.io/reference/list-loyalty-tiers
151
+ */
152
+ listTiers(campaignId: string, params?: LoyaltiesListTiersRequestQuery): Promise<LoyaltiesListTiersResponseBody>;
153
+ /**
154
+ * @see https://docs.voucherify.io/reference/get-loyalty-tier
155
+ */
156
+ getTier(campaignId: string, tierId: string): Promise<LoyaltyTier>;
157
+ /**
158
+ * @see https://docs.voucherify.io/reference/create-loyalty-tiers
159
+ */
160
+ createTiers(campaignId: string, tiers: LoyaltiesCreateTiersRequestBody): Promise<LoyaltiesCreateTiersResponseBody>;
161
+ /**
162
+ * @see https://docs.voucherify.io/reference/list-loyalty-tier-earning-rules
163
+ */
164
+ listLoyaltyTierEarningRules(campaignId: string, tierId: string, params?: LoyaltiesListLoyaltyTierEarningRulesRequestQuery): Promise<LoyaltiesListLoyaltyTierEarningRulesResponseBody>;
165
+ /**
166
+ * @see https://docs.voucherify.io/reference/get-member-loyalty-tier
167
+ */
168
+ listMemberLoyaltyTiers(memberId: string): Promise<LoyaltiesListMemberLoyaltyTiersResponseBody>;
169
+ }
170
+
171
+ export { Loyalties };
@@ -1,14 +1,17 @@
1
- import * as T from './types/MetadataSchemas';
2
- import type { RequestController } from './RequestController';
3
- export declare class MetadataSchemas {
4
- private client;
5
- constructor(client: RequestController);
6
- /**
7
- * @see https://docs.voucherify.io/reference/list-metadata-schemas
8
- */
9
- list(): Promise<T.MetadataSchemasListResponse>;
10
- /**
11
- * @see https://docs.voucherify.io/reference/get-metadata-schema
12
- */
13
- get(schemaName: string): Promise<T.MetadataSchema>;
14
- }
1
+ import { MetadataSchemasListResponse, MetadataSchema } from './types/MetadataSchemas.js';
2
+ import { RequestController } from './RequestController.js';
3
+
4
+ declare class MetadataSchemas {
5
+ private client;
6
+ constructor(client: RequestController);
7
+ /**
8
+ * @see https://docs.voucherify.io/reference/list-metadata-schemas
9
+ */
10
+ list(): Promise<MetadataSchemasListResponse>;
11
+ /**
12
+ * @see https://docs.voucherify.io/reference/get-metadata-schema
13
+ */
14
+ get(schemaName: string): Promise<MetadataSchema>;
15
+ }
16
+
17
+ export { MetadataSchemas };
package/dist/Orders.d.ts CHANGED
@@ -1,27 +1,32 @@
1
- import * as T from './types/Orders';
2
- import * as AAT from './types/AsyncActions';
3
- import type { RequestController } from './RequestController';
4
- export declare class Orders {
5
- private client;
6
- constructor(client: RequestController);
7
- /**
8
- * @see https://docs.voucherify.io/reference/create-order
9
- */
10
- create(order: T.OrdersCreate): Promise<T.OrdersCreateResponse>;
11
- /**
12
- * @see https://docs.voucherify.io/reference/get-order
13
- */
14
- get(orderId: string): Promise<T.OrdersCreateResponse>;
15
- /**
16
- * @see https://docs.voucherify.io/reference/update-order
17
- */
18
- update(order: T.OrdersUpdate): Promise<T.OrdersCreateResponse>;
19
- /**
20
- * @see https://docs.voucherify.io/reference/list-orders
21
- */
22
- list(params?: T.OrdersListParams): Promise<T.OrdersListResponse>;
23
- /**
24
- * @see https://docs.voucherify.io/reference/import-orders
25
- */
26
- import(orders: T.OrdersCreate[]): Promise<AAT.AsyncActionCreateResponse>;
27
- }
1
+ import { OrdersCreate, OrdersCreateResponse, OrdersUpdate, OrdersListParams, OrdersListResponse } from './types/Orders.js';
2
+ import { AsyncActionCreateResponse } from './types/AsyncActions.js';
3
+ import { RequestController } from './RequestController.js';
4
+ import './types/Customers.js';
5
+ import './types/DiscountVoucher.js';
6
+
7
+ declare class Orders {
8
+ private client;
9
+ constructor(client: RequestController);
10
+ /**
11
+ * @see https://docs.voucherify.io/reference/create-order
12
+ */
13
+ create(order: OrdersCreate): Promise<OrdersCreateResponse>;
14
+ /**
15
+ * @see https://docs.voucherify.io/reference/get-order
16
+ */
17
+ get(orderId: string): Promise<OrdersCreateResponse>;
18
+ /**
19
+ * @see https://docs.voucherify.io/reference/update-order
20
+ */
21
+ update(order: OrdersUpdate): Promise<OrdersCreateResponse>;
22
+ /**
23
+ * @see https://docs.voucherify.io/reference/list-orders
24
+ */
25
+ list(params?: OrdersListParams): Promise<OrdersListResponse>;
26
+ /**
27
+ * @see https://docs.voucherify.io/reference/import-orders
28
+ */
29
+ import(orders: OrdersCreate[]): Promise<AsyncActionCreateResponse>;
30
+ }
31
+
32
+ export { Orders };
@@ -1,26 +1,30 @@
1
- import * as T from './types/ProductCollections';
2
- import type { RequestController } from './RequestController';
3
- export declare class ProductCollections {
4
- private client;
5
- constructor(client: RequestController);
6
- /**
7
- * @see https://docs.voucherify.io/reference/create-product-collection
8
- */
9
- create(productCollection: T.ProductCollectionsCreateRequestBody): Promise<T.ProductCollectionsCreateResponseBody>;
10
- /**
11
- * @see https://docs.voucherify.io/reference/list-product-collections
12
- */
13
- list(params?: T.ProductCollectionsListRequestQuery): Promise<T.ProductCollectionsListResponseBody>;
14
- /**
15
- * @see https://docs.voucherify.io/reference/delete-product-collection
16
- */
17
- delete(productCollectionId: string): Promise<{}>;
18
- /**
19
- * @see https://docs.voucherify.io/reference/get-product-collection
20
- */
21
- get(productCollectionId: string): Promise<Required<T.StaticProductCollectionBase & T.ProductCollectionIdentity & T.ProductCollectionSaved> | Required<T.DynamicProductCollectionBase & T.ProductCollectionIdentity & T.ProductCollectionSaved>>;
22
- /**
23
- * @see https://docs.voucherify.io/reference/list-products-in-collection
24
- */
25
- listProducts(productCollectionId: string, params?: T.ProductCollectionsListProductsRequestQuery): Promise<T.ProductCollectionsListProductsResponseBody>;
26
- }
1
+ import { ProductCollectionsCreateRequestBody, ProductCollectionsCreateResponseBody, ProductCollectionsListRequestQuery, ProductCollectionsListResponseBody, ProductCollectionsGetResponseBody, ProductCollectionsListProductsRequestQuery, ProductCollectionsListProductsResponseBody } from './types/ProductCollections.js';
2
+ import { RequestController } from './RequestController.js';
3
+ import './types/UtilityTypes.js';
4
+
5
+ declare class ProductCollections {
6
+ private client;
7
+ constructor(client: RequestController);
8
+ /**
9
+ * @see https://docs.voucherify.io/reference/create-product-collection
10
+ */
11
+ create(productCollection: ProductCollectionsCreateRequestBody): Promise<ProductCollectionsCreateResponseBody>;
12
+ /**
13
+ * @see https://docs.voucherify.io/reference/list-product-collections
14
+ */
15
+ list(params?: ProductCollectionsListRequestQuery): Promise<ProductCollectionsListResponseBody>;
16
+ /**
17
+ * @see https://docs.voucherify.io/reference/delete-product-collection
18
+ */
19
+ delete(productCollectionId: string): Promise<{}>;
20
+ /**
21
+ * @see https://docs.voucherify.io/reference/get-product-collection
22
+ */
23
+ get(productCollectionId: string): Promise<ProductCollectionsGetResponseBody>;
24
+ /**
25
+ * @see https://docs.voucherify.io/reference/list-products-in-collection
26
+ */
27
+ listProducts(productCollectionId: string, params?: ProductCollectionsListProductsRequestQuery): Promise<ProductCollectionsListProductsResponseBody>;
28
+ }
29
+
30
+ export { ProductCollections };