@voucherify/sdk 2.9.3 → 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 (72) hide show
  1. package/dist/ApiLimitsHandler.d.ts +13 -0
  2. package/dist/AsyncActions.d.ts +17 -0
  3. package/dist/Balance.d.ts +15 -0
  4. package/dist/Campaigns.d.ts +66 -0
  5. package/dist/Categories.d.ts +29 -0
  6. package/dist/ClientSide.d.ts +77 -0
  7. package/dist/Consents.d.ts +13 -0
  8. package/dist/Customers.d.ts +75 -0
  9. package/dist/Distributions.d.ts +29 -0
  10. package/dist/Events.d.ts +15 -0
  11. package/dist/Exports.d.ts +25 -0
  12. package/dist/Loyalties.d.ts +171 -0
  13. package/dist/MetadataSchemas.d.ts +17 -0
  14. package/dist/Orders.d.ts +32 -0
  15. package/dist/ProductCollections.d.ts +30 -0
  16. package/dist/Products.d.ts +66 -0
  17. package/dist/PromotionTiers.d.ts +43 -0
  18. package/dist/Promotions.d.ts +30 -0
  19. package/dist/PromotionsStacks.d.ts +34 -0
  20. package/dist/Qualifications.d.ts +24 -0
  21. package/dist/Redemptions.d.ts +53 -0
  22. package/dist/RequestController.d.ts +31 -0
  23. package/dist/Rewards.d.ts +46 -0
  24. package/dist/Segments.d.ts +25 -0
  25. package/dist/ValidationRules.d.ts +47 -0
  26. package/dist/Validations.d.ts +39 -0
  27. package/dist/VoucherifyClientSide.d.ts +112 -0
  28. package/dist/VoucherifyError.d.ts +23 -0
  29. package/dist/VoucherifyServerSide.d.ts +170 -0
  30. package/dist/Vouchers.d.ts +84 -0
  31. package/dist/helpers.d.ts +20 -0
  32. package/dist/index.d.ts +63 -0
  33. package/dist/types/ApplicableTo.d.ts +32 -0
  34. package/dist/types/AsyncActions.d.ts +23 -0
  35. package/dist/types/Balance.d.ts +18 -0
  36. package/dist/types/Campaigns.d.ts +124 -0
  37. package/dist/types/Categories.d.ts +40 -0
  38. package/dist/types/ClientSide.d.ts +145 -0
  39. package/dist/types/Consents.d.ts +34 -0
  40. package/dist/types/Customers.d.ts +363 -0
  41. package/dist/types/DiscountVoucher.d.ts +94 -0
  42. package/dist/types/Distributions.d.ts +148 -0
  43. package/dist/types/Events.d.ts +21 -0
  44. package/dist/types/Exports.d.ts +151 -0
  45. package/dist/types/Gift.d.ts +5 -0
  46. package/dist/types/Loyalties.d.ts +1061 -0
  47. package/dist/types/MetadataSchemas.d.ts +34 -0
  48. package/dist/types/Orders.d.ts +199 -0
  49. package/dist/types/ProductCollections.d.ts +99 -0
  50. package/dist/types/Products.d.ts +108 -0
  51. package/dist/types/PromotionTiers.d.ts +131 -0
  52. package/dist/types/Promotions.d.ts +113 -0
  53. package/dist/types/PromotionsStacks.d.ts +74 -0
  54. package/dist/types/Qualifications.d.ts +92 -0
  55. package/dist/types/Redemptions.d.ts +215 -0
  56. package/dist/types/Rewards.d.ts +220 -0
  57. package/dist/types/Segments.d.ts +34 -0
  58. package/dist/types/Stackable.d.ts +106 -0
  59. package/dist/types/UtilityTypes.d.ts +5 -0
  60. package/dist/types/ValidateSession.d.ts +19 -0
  61. package/dist/types/ValidationError.d.ts +9 -0
  62. package/dist/types/ValidationRules.d.ts +96 -0
  63. package/dist/types/Validations.d.ts +109 -0
  64. package/dist/types/Vouchers.d.ts +452 -0
  65. package/dist/types/index.d.ts +27 -0
  66. package/dist/voucherifysdk.cjs +2022 -1
  67. package/dist/voucherifysdk.cjs.map +1 -1
  68. package/dist/voucherifysdk.esm.js +1985 -1
  69. package/dist/voucherifysdk.esm.js.map +1 -1
  70. package/package.json +2 -2
  71. package/dist/voucherifysdk.d.mts +0 -5252
  72. package/dist/voucherifysdk.d.ts +0 -5252
@@ -0,0 +1,13 @@
1
+ import { RequestController } from './RequestController.js';
2
+
3
+ declare class ApiLimitsHandler {
4
+ private readonly requestController;
5
+ constructor(requestController: RequestController);
6
+ private getLastResponseHeadersFromController;
7
+ areLimitsAvailable(): boolean;
8
+ getRateLimit(): number;
9
+ getRateLimitRemaining(): number;
10
+ getRetryAfter(): number;
11
+ }
12
+
13
+ export { ApiLimitsHandler };
@@ -0,0 +1,17 @@
1
+ import { AsyncActionsResponse, AsyncActionsListParams, AsyncActionsListResponse } from './types/AsyncActions.js';
2
+ import { RequestController } from './RequestController.js';
3
+
4
+ declare class AsyncActions {
5
+ private client;
6
+ constructor(client: RequestController);
7
+ /**
8
+ * @see https://docs.voucherify.io/reference/get-async-actions-1
9
+ */
10
+ get(asyncActionId: string): Promise<AsyncActionsResponse>;
11
+ /**
12
+ * @see https://docs.voucherify.io/reference/list-async-actions
13
+ */
14
+ list(params: AsyncActionsListParams): Promise<AsyncActionsListResponse>;
15
+ }
16
+
17
+ export { AsyncActions };
@@ -0,0 +1,15 @@
1
+ import { BalanceCreateParams, BalanceCreateResponse } from './types/Balance.js';
2
+ import { RequestController } from './RequestController.js';
3
+
4
+ declare class Balance {
5
+ private client;
6
+ constructor(client: RequestController);
7
+ /**
8
+ * Add Gift Voucher Balance
9
+ * This method gives a possibility to add balance to an existing gift voucher.
10
+ * @see https://docs.voucherify.io/reference/add-gift-voucher-balance
11
+ */
12
+ create(code: string, params: BalanceCreateParams): Promise<BalanceCreateResponse>;
13
+ }
14
+
15
+ export { Balance };
@@ -0,0 +1,66 @@
1
+ import { CampaignsQualificationsBody, CampaignsQualificationsParams, CampaignsQualificationsResponse, CampaignsCreateCampaign, CampaignResponse, CampaignsUpdateCampaign, CampaignsDeleteParams, CampaignsAddVoucherBody, CampaignsAddVoucherParams, CampaignsAddVoucherResponse, CampaignsAddCertainVoucherParams, CampaignsImportVouchers, CampaignsVouchersImportResponse, CampaignsListParams, CampaignsListResponse } from './types/Campaigns.js';
2
+ import { AsyncActionCreateResponse } from './types/AsyncActions.js';
3
+ import { RequestController } from './RequestController.js';
4
+ import './types/Vouchers.js';
5
+ import './types/Orders.js';
6
+ import './types/Customers.js';
7
+ import './types/DiscountVoucher.js';
8
+ import './types/ValidationRules.js';
9
+ import './types/ApplicableTo.js';
10
+
11
+ declare class CampaignsQualifications {
12
+ private client;
13
+ constructor(client: RequestController);
14
+ examine(body?: CampaignsQualificationsBody, params?: CampaignsQualificationsParams): Promise<CampaignsQualificationsResponse>;
15
+ }
16
+ declare class Campaigns {
17
+ private client;
18
+ qualifications: CampaignsQualifications;
19
+ constructor(client: RequestController);
20
+ /**
21
+ * @see https://docs.voucherify.io/reference/create-campaign
22
+ */
23
+ create(campaign: CampaignsCreateCampaign): Promise<CampaignResponse>;
24
+ /**
25
+ * @see https://docs.voucherify.io/reference/update-campaign
26
+ */
27
+ update(nameOrId: string, campaign: CampaignsUpdateCampaign): Promise<CampaignResponse>;
28
+ /**
29
+ * @see https://docs.voucherify.io/reference/get-campaign
30
+ */
31
+ get(name: string): Promise<CampaignResponse>;
32
+ /**
33
+ * @see https://docs.voucherify.io/reference/delete-campaign
34
+ */
35
+ delete(name: string, params?: CampaignsDeleteParams): Promise<unknown>;
36
+ /**
37
+ * @see https://docs.voucherify.io/reference/add-voucher-to-campaign
38
+ */
39
+ addVoucher(name: string, body?: CampaignsAddVoucherBody, params?: CampaignsAddVoucherParams): Promise<{} | CampaignsAddVoucherResponse>;
40
+ /**
41
+ * @see https://docs.voucherify.io/reference/add-voucher-with-certain-code-to-campaign
42
+ */
43
+ addCertainVoucher(name: string, code: string, body?: CampaignsAddCertainVoucherParams): Promise<CampaignsAddVoucherResponse>;
44
+ /**
45
+ * @see https://docs.voucherify.io/reference/import-vouchers
46
+ */
47
+ importVouchers(campaignName: string, vouchers: CampaignsImportVouchers[]): Promise<CampaignsVouchersImportResponse>;
48
+ /**
49
+ * @see https://docs.voucherify.io/reference/list-campaigns
50
+ */
51
+ list(params?: CampaignsListParams): Promise<CampaignsListResponse>;
52
+ /**
53
+ * @see https://api.voucherify.io/v1/campaigns/{campaignId}/importCSV
54
+ */
55
+ importVouchersCSV(campaignId: string, filePath: string): Promise<AsyncActionCreateResponse>;
56
+ /**
57
+ * @see https://docs.voucherify.io/reference/enable-campaign
58
+ */
59
+ enable(campaignId: string): Promise<{}>;
60
+ /**
61
+ * @see https://docs.voucherify.io/reference/disable-campaign
62
+ */
63
+ disable(campaignId: string): Promise<{}>;
64
+ }
65
+
66
+ export { Campaigns };
@@ -0,0 +1,29 @@
1
+ import { CategoriesListRequestQuery, ListCategories, CreateCategory, ResponseCreateCategory, CategoryObject, UpdateCategoryRequest, ResponseUpdateCategory } from './types/Categories.js';
2
+ import { RequestController } from './RequestController.js';
3
+
4
+ declare class Categories {
5
+ private client;
6
+ constructor(client: RequestController);
7
+ /**
8
+ * @see https://docs.voucherify.io/reference/list-categories
9
+ */
10
+ list(params?: CategoriesListRequestQuery): Promise<ListCategories>;
11
+ /**
12
+ * @see https://docs.voucherify.io/reference/create-category
13
+ */
14
+ create(createCategory: CreateCategory): Promise<ResponseCreateCategory>;
15
+ /**
16
+ * @see https://docs.voucherify.io/reference/get-category
17
+ */
18
+ get(categoryId: string): Promise<CategoryObject>;
19
+ /**
20
+ * @see https://docs.voucherify.io/reference/delete-category
21
+ */
22
+ delete(categoryId: string): Promise<{}>;
23
+ /**
24
+ * @see https://docs.voucherify.io/reference/update-category
25
+ */
26
+ update(categoryId: string, updateCategory: UpdateCategoryRequest): Promise<ResponseUpdateCategory>;
27
+ }
28
+
29
+ export { Categories };
@@ -0,0 +1,77 @@
1
+ import { CustomersCreateResponse } from './types/Customers.js';
2
+ import { ClientSideValidateParams, ClientSideValidateResponse, ClientSideRedeemPayload, ClientSideRedeemResponse, ClientSidePublishPayload, ClientSidePublishQueryParams, ClientSidePublishResponse, ClientSideTrackCustomer, ClientSideTrackReferral, ClientSideTrackLoyalty, ClientSideTrackResponse, ClientSideListVouchersParams, ClientSideListVouchersResponse, ClientSideCustomersCreateParams, ClientSideCustomersUpdateConsentsBody, ClientSideValidationsValidateStackableParams, ClientSideRedemptionsRedeemStackableParams } from './types/ClientSide.js';
3
+ import { RedemptionsRedeemStackableResponse } from './types/Redemptions.js';
4
+ import { ValidationValidateStackableResponse } from './types/Validations.js';
5
+ import { ConsentsListResponse } from './types/Consents.js';
6
+ import { QualificationsCheckEligibilityRequestBody, QualificationsCheckEligibilityResponseBody } from './types/Qualifications.js';
7
+ import { RequestController } from './RequestController.js';
8
+ import './types/DiscountVoucher.js';
9
+ import './types/Vouchers.js';
10
+ import './types/Orders.js';
11
+ import './types/Distributions.js';
12
+ import './types/PromotionTiers.js';
13
+ import './types/ValidationRules.js';
14
+ import './types/ApplicableTo.js';
15
+ import './types/ValidateSession.js';
16
+ import './types/Rewards.js';
17
+ import './types/Gift.js';
18
+ import './types/Stackable.js';
19
+ import './types/Products.js';
20
+ import './types/Loyalties.js';
21
+ import './types/Categories.js';
22
+ import './types/ValidationError.js';
23
+ import './types/Promotions.js';
24
+ import './types/Exports.js';
25
+
26
+ declare class ClientSide {
27
+ private client;
28
+ private trackingId?;
29
+ constructor(client: RequestController, trackingId?: string | undefined);
30
+ setIdentity(identity?: string): void;
31
+ /**
32
+ * @see https://docs.voucherify.io/reference/vouchers-validate
33
+ */
34
+ validate(params: ClientSideValidateParams | string): Promise<ClientSideValidateResponse>;
35
+ /**
36
+ * @see https://docs.voucherify.io/reference/redeem-voucher-client-side
37
+ */
38
+ redeem(code: string, payload?: ClientSideRedeemPayload): Promise<ClientSideRedeemResponse>;
39
+ /**
40
+ * @see https://docs.voucherify.io/reference/create-publication
41
+ */
42
+ publish(campaign: string, payload?: ClientSidePublishPayload, queryParams?: ClientSidePublishQueryParams): Promise<ClientSidePublishResponse>;
43
+ /**
44
+ * @see https://docs.voucherify.io/reference/track-custom-event-client-side
45
+ */
46
+ track(event_name: string, customer: ClientSideTrackCustomer, metadata?: Record<string, any>, referral?: ClientSideTrackReferral, loyalty?: ClientSideTrackLoyalty): Promise<ClientSideTrackResponse>;
47
+ /**
48
+ * @see https://docs.voucherify.io/reference/list-vouchers
49
+ */
50
+ listVouchers(params?: ClientSideListVouchersParams): Promise<ClientSideListVouchersResponse>;
51
+ /**
52
+ * @see https://docs.voucherify.io/reference/create-customer
53
+ */
54
+ createCustomer(customer: ClientSideCustomersCreateParams, enableDoubleOptIn?: boolean): Promise<CustomersCreateResponse>;
55
+ /**
56
+ * @see https://docs.voucherify.io/reference/get-consent-client-side
57
+ */
58
+ listConsents(): Promise<ConsentsListResponse>;
59
+ /**
60
+ * @see https://docs.voucherify.io/reference/update-customers-consents-client
61
+ */
62
+ updateConsents(idOrSourceId: string, consents: ClientSideCustomersUpdateConsentsBody): Promise<undefined>;
63
+ /**
64
+ * @see https://docs.voucherify.io/reference/validate-stackable-discounts-client-side
65
+ */
66
+ validateStackable(params: ClientSideValidationsValidateStackableParams): Promise<ValidationValidateStackableResponse>;
67
+ /**
68
+ * @see https://docs.voucherify.io/reference/redeem-stackable-discounts-client-side
69
+ */
70
+ redeemStackable(params: ClientSideRedemptionsRedeemStackableParams): Promise<RedemptionsRedeemStackableResponse>;
71
+ /**
72
+ * @see https://docs.voucherify.io/reference/check-eligibility
73
+ */
74
+ qualifications(body: QualificationsCheckEligibilityRequestBody): Promise<QualificationsCheckEligibilityResponseBody>;
75
+ }
76
+
77
+ export { ClientSide };
@@ -0,0 +1,13 @@
1
+ import { ConsentsListResponse } from './types/Consents.js';
2
+ import { RequestController } from './RequestController.js';
3
+
4
+ declare class Consents {
5
+ private client;
6
+ constructor(client: RequestController);
7
+ /**
8
+ * @deprecated This method is deprecated. We’re removing this method in next major version.
9
+ */
10
+ list(): Promise<ConsentsListResponse>;
11
+ }
12
+
13
+ export { Consents };
@@ -0,0 +1,75 @@
1
+ import { CustomersCreateBody, CustomersCreateResponse, CustomersGetResponse, CustomersListParams, CustomersCommonListResponse, CustomersScrollParams, CustomersScrollYield, CustomersUpdateParams, CustomersUpdateResponse, CustomersUpdateInBulkRequestBody, CustomersUpdateMetadataInBulkRequestBody, CustomersDeletePermanentlyResponseBody, CustomerActivityListQueryParams, CustomerActivityListResponse, CustomersUpdateConsentsBody, CustomerActivitiesListQueryParams, CustomerActivitiesListResponse, CustomerRedeemablesListQueryParams, CustomerRedeemablesListResponse } from './types/Customers.js';
2
+ import { AsyncActionCreateResponse } from './types/AsyncActions.js';
3
+ import { RequestController } from './RequestController.js';
4
+ import './types/DiscountVoucher.js';
5
+
6
+ declare class Customers {
7
+ private client;
8
+ constructor(client: RequestController);
9
+ /**
10
+ * @see https://docs.voucherify.io/reference/create-customer
11
+ */
12
+ create(customer: CustomersCreateBody): Promise<CustomersCreateResponse>;
13
+ /**
14
+ * @see https://docs.voucherify.io/reference/read-customer
15
+ */
16
+ get(customerId: string): Promise<CustomersGetResponse>;
17
+ /**
18
+ * @see https://docs.voucherify.io/reference/list-customers
19
+ */
20
+ list(params: CustomersListParams): Promise<CustomersCommonListResponse>;
21
+ /**
22
+ * Standard list customers API has limitation of available pages to be shown equal to 100. To cover cases when you would like to fetch more, you must use scroll capabilities.
23
+ *
24
+ * ```javascript
25
+ * async function () {
26
+ * for await (const customer of voucherify.customers.scroll(params)) {
27
+ * console.log('Customer', customer)
28
+ * }
29
+ * }
30
+ * ```
31
+ */
32
+ scroll(params: CustomersScrollParams): AsyncGenerator<CustomersScrollYield, void, CustomersScrollYield>;
33
+ /**
34
+ * @see https://docs.voucherify.io/reference/update-customer
35
+ */
36
+ update(customer: CustomersUpdateParams): Promise<CustomersUpdateResponse>;
37
+ /**
38
+ * @see https://docs.voucherify.io/reference/update-customers-in-bulk
39
+ */
40
+ updateInBulk(customers: CustomersUpdateInBulkRequestBody): Promise<AsyncActionCreateResponse>;
41
+ /**
42
+ * @see https://docs.voucherify.io/reference/update-customers-metadata-in-bulk
43
+ */
44
+ updateMetadataInBulk(sourceIdsAndMetadata: CustomersUpdateMetadataInBulkRequestBody): Promise<AsyncActionCreateResponse>;
45
+ /**
46
+ * @see https://docs.voucherify.io/reference/delete-customer
47
+ */
48
+ delete(customerId: string): Promise<undefined>;
49
+ /**
50
+ * @see https://docs.voucherify.io/reference/delete-customer-permanently
51
+ */
52
+ deletePermanently(customerId: string): Promise<CustomersDeletePermanentlyResponseBody>;
53
+ /**
54
+ * @see https://docs.voucherify.io/reference/list-customer-activity
55
+ */
56
+ listActivity(customerIdOrSourceId: string, params?: CustomerActivityListQueryParams): Promise<CustomerActivityListResponse>;
57
+ /**
58
+ * @deprecated This method is deprecated. We’re removing this method in next major version.
59
+ */
60
+ updateConsents(idOrSourceId: string, consents: CustomersUpdateConsentsBody): Promise<undefined>;
61
+ /**
62
+ * @deprecated This method is deprecated in favor of the `listActivity` method. We’re removing this method in next major version.
63
+ */
64
+ listActivities(customerId: string, params?: CustomerActivitiesListQueryParams): Promise<CustomerActivitiesListResponse>;
65
+ /**
66
+ * @see https://docs.voucherify.io/reference/import-customers-using-csv
67
+ */
68
+ importCSV(filePath: string): Promise<AsyncActionCreateResponse>;
69
+ /**
70
+ * @see https://docs.voucherify.io/reference/list-customer-redeemables
71
+ */
72
+ listRedeemables(id: string, params?: CustomerRedeemablesListQueryParams): Promise<CustomerRedeemablesListResponse>;
73
+ }
74
+
75
+ export { Customers };
@@ -0,0 +1,29 @@
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 };
@@ -0,0 +1,15 @@
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 };
@@ -0,0 +1,25 @@
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 };
@@ -0,0 +1,171 @@
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 };
@@ -0,0 +1,17 @@
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 };
@@ -0,0 +1,32 @@
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 };
@@ -0,0 +1,30 @@
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 };