@voucherify/sdk 1.3.1 → 2.0.2
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.
- package/CHANGELOG.md +44 -0
- package/README.md +129 -129
- package/dist/AsyncActions.d.ts +2 -2
- package/dist/Balance.d.ts +1 -1
- package/dist/Campaigns.d.ts +9 -9
- package/dist/ClientSide.d.ts +8 -8
- package/dist/Consents.d.ts +1 -1
- package/dist/Customers.d.ts +6 -6
- package/dist/Distributions.d.ts +2 -2
- package/dist/Events.d.ts +3 -0
- package/dist/Exports.d.ts +3 -3
- package/dist/Loyalties.d.ts +19 -19
- package/dist/Orders.d.ts +4 -4
- package/dist/Products.d.ts +14 -14
- package/dist/PromotionTiers.d.ts +6 -6
- package/dist/Promotions.d.ts +3 -3
- package/dist/Redemptions.d.ts +5 -5
- package/dist/Rewards.d.ts +8 -8
- package/dist/Segments.d.ts +4 -4
- package/dist/ValidationRules.d.ts +8 -8
- package/dist/Validations.d.ts +1 -1
- package/dist/VoucherifyClientSide.d.ts +2 -2
- package/dist/VoucherifyServerSide.d.ts +3 -3
- package/dist/Vouchers.d.ts +14 -13
- package/dist/types/Campaigns.d.ts +3 -0
- package/dist/types/Products.d.ts +7 -9
- package/dist/types/Promotions.d.ts +4 -0
- package/dist/types/Vouchers.d.ts +12 -15
- package/dist/voucherifysdk.esm.js +135 -123
- package/dist/voucherifysdk.esm.js.map +1 -1
- package/dist/voucherifysdk.umd.development.js +135 -123
- package/dist/voucherifysdk.umd.development.js.map +1 -1
- package/dist/voucherifysdk.umd.production.min.js +1 -1
- package/dist/voucherifysdk.umd.production.min.js.map +1 -1
- package/package.json +1 -1
package/dist/AsyncActions.d.ts
CHANGED
|
@@ -4,11 +4,11 @@ declare class AsyncActions {
|
|
|
4
4
|
private client;
|
|
5
5
|
constructor(client: RequestController);
|
|
6
6
|
/**
|
|
7
|
-
* @see https://docs.voucherify.io/reference
|
|
7
|
+
* @see https://docs.voucherify.io/reference/get-async-actions-1
|
|
8
8
|
*/
|
|
9
9
|
get(asyncActionId: string): Promise<T.AsyncActionsResponse>;
|
|
10
10
|
/**
|
|
11
|
-
* @see https://docs.voucherify.io/reference
|
|
11
|
+
* @see https://docs.voucherify.io/reference/list-async-actions
|
|
12
12
|
*/
|
|
13
13
|
list(params: T.AsyncActionsListParams): Promise<T.AsyncActionsListResponse>;
|
|
14
14
|
}
|
package/dist/Balance.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ export declare class Balance {
|
|
|
6
6
|
/**
|
|
7
7
|
* Add Gift Voucher Balance
|
|
8
8
|
* This method gives a possibility to add balance to an existing gift voucher.
|
|
9
|
-
* @see https://docs.voucherify.io/reference
|
|
9
|
+
* @see https://docs.voucherify.io/reference/add-gift-voucher-balance
|
|
10
10
|
*/
|
|
11
11
|
create(code: string, params: T.BalanceCreateParams): Promise<T.BalanceCreateResponse>;
|
|
12
12
|
}
|
package/dist/Campaigns.d.ts
CHANGED
|
@@ -10,35 +10,35 @@ export declare class Campaigns {
|
|
|
10
10
|
qualifications: CampaignsQualifications;
|
|
11
11
|
constructor(client: RequestController);
|
|
12
12
|
/**
|
|
13
|
-
* @see https://docs.voucherify.io/reference
|
|
13
|
+
* @see https://docs.voucherify.io/reference/create-campaign
|
|
14
14
|
*/
|
|
15
15
|
create(campaign: T.CampaignsCreateCampaign): Promise<T.CampaignResponse>;
|
|
16
16
|
/**
|
|
17
|
-
* @see https://docs.voucherify.io/reference
|
|
17
|
+
* @see https://docs.voucherify.io/reference/update-campaign
|
|
18
18
|
*/
|
|
19
19
|
update(nameOrId: string, campaign: T.CampaignsUpdateCampaign): Promise<T.CampaignResponse>;
|
|
20
20
|
/**
|
|
21
|
-
* @see https://docs.voucherify.io/reference
|
|
21
|
+
* @see https://docs.voucherify.io/reference/get-campaign
|
|
22
22
|
*/
|
|
23
23
|
get(name: string): Promise<T.CampaignResponse>;
|
|
24
24
|
/**
|
|
25
|
-
* @see https://docs.voucherify.io/reference
|
|
25
|
+
* @see https://docs.voucherify.io/reference/delete-campaign
|
|
26
26
|
*/
|
|
27
27
|
delete(name: string, params?: T.CampaignsDeleteParams): Promise<unknown>;
|
|
28
28
|
/**
|
|
29
|
-
* @see https://docs.voucherify.io/reference
|
|
29
|
+
* @see https://docs.voucherify.io/reference/add-voucher-to-campaign
|
|
30
30
|
*/
|
|
31
31
|
addVoucher(name: string, body?: T.CampaignsAddVoucherBody, params?: T.CampaignsAddVoucherParams): Promise<{} | Pick<import("./types").VouchersResponse, "object" | "active" | "type" | "category" | "start_date" | "expiration_date" | "metadata" | "redemption" | "additional_info" | "code" | "discount" | "campaign" | "gift" | "publish">>;
|
|
32
32
|
/**
|
|
33
|
-
* @see https://docs.voucherify.io/reference
|
|
33
|
+
* @see https://docs.voucherify.io/reference/add-voucher-with-certain-code-to-campaign
|
|
34
34
|
*/
|
|
35
35
|
addCertainVoucher(name: string, code: string, body?: T.CampaignsAddCertainVoucherParams): Promise<Pick<import("./types").VouchersResponse, "object" | "active" | "type" | "category" | "start_date" | "expiration_date" | "metadata" | "redemption" | "additional_info" | "code" | "discount" | "campaign" | "gift" | "publish">>;
|
|
36
36
|
/**
|
|
37
|
-
* @see https://docs.voucherify.io/reference
|
|
37
|
+
* @see https://docs.voucherify.io/reference/import-vouchers
|
|
38
38
|
*/
|
|
39
|
-
importVouchers(campaignName: string, vouchers: T.CampaignsImportVouchers[]): Promise<
|
|
39
|
+
importVouchers(campaignName: string, vouchers: T.CampaignsImportVouchers[]): Promise<T.CampaignsVouchersImportResponse>;
|
|
40
40
|
/**
|
|
41
|
-
* @see https://docs.voucherify.io/
|
|
41
|
+
* @see https://docs.voucherify.io/reference/list-campaigns
|
|
42
42
|
*/
|
|
43
43
|
list(params?: T.CampaignsListParams): Promise<unknown>;
|
|
44
44
|
}
|
package/dist/ClientSide.d.ts
CHANGED
|
@@ -6,35 +6,35 @@ export declare class ClientSide {
|
|
|
6
6
|
constructor(client: RequestController, trackingId?: string | undefined);
|
|
7
7
|
setIdentity(identity?: string): void;
|
|
8
8
|
/**
|
|
9
|
-
* @see https://docs.voucherify.io/reference
|
|
9
|
+
* @see https://docs.voucherify.io/reference/vouchers-validate
|
|
10
10
|
*/
|
|
11
11
|
validate(params: T.ClientSideValidateParams | string): Promise<T.ClientSideValidateResponse>;
|
|
12
12
|
/**
|
|
13
|
-
* @see https://docs.voucherify.io/reference
|
|
13
|
+
* @see https://docs.voucherify.io/reference/redeem-voucher-client-side
|
|
14
14
|
*/
|
|
15
15
|
redeem(code: string, payload?: T.ClientSideRedeemPayload): Promise<T.ClientSideRedeemResponse>;
|
|
16
16
|
/**
|
|
17
|
-
* @see https://docs.voucherify.io/reference
|
|
17
|
+
* @see https://docs.voucherify.io/reference/create-publication
|
|
18
18
|
*/
|
|
19
19
|
publish(campaign: string, payload?: T.ClientSidePublishPayload, queryParams?: T.ClientSidePublishQueryParams): Promise<T.ClientSidePublishResponse>;
|
|
20
20
|
/**
|
|
21
|
-
* @see https://docs.voucherify.io/reference
|
|
21
|
+
* @see https://docs.voucherify.io/reference/track-custom-event-client-side
|
|
22
22
|
*/
|
|
23
23
|
track(event_name: string, customer: T.ClientSideTrackCustomer, metadata?: Record<string, any>, referral?: T.ClientSideTrackReferral, loyalty?: T.ClientSideTrackLoyalty): Promise<T.ClientSideTrackResponse>;
|
|
24
24
|
/**
|
|
25
|
-
* @see https://docs.voucherify.io/reference
|
|
25
|
+
* @see https://docs.voucherify.io/reference/list-vouchers
|
|
26
26
|
*/
|
|
27
27
|
listVouchers(params?: T.ClientSideListVouchersParams): Promise<T.ClientSideListVouchersResponse>;
|
|
28
28
|
/**
|
|
29
|
-
* @see https://docs.voucherify.io/reference
|
|
29
|
+
* @see https://docs.voucherify.io/reference/create-customer
|
|
30
30
|
*/
|
|
31
31
|
createCustomer(customer: T.ClientSideCustomersCreateParams, enableDoubleOptIn?: boolean): Promise<import("./types").CustomersCreateResponse>;
|
|
32
32
|
/**
|
|
33
|
-
* @see https://docs.voucherify.io/reference
|
|
33
|
+
* @see https://docs.voucherify.io/reference/get-consent-client-side
|
|
34
34
|
*/
|
|
35
35
|
listConsents(): Promise<import("./types").ConsentsListResponse>;
|
|
36
36
|
/**
|
|
37
|
-
* @see https://docs.voucherify.io/reference
|
|
37
|
+
* @see https://docs.voucherify.io/reference/update-customers-consents-client
|
|
38
38
|
*/
|
|
39
39
|
updateConsents(idOrSourceId: string, consents: T.ClientSideCustomersUpdateConsentsBody): Promise<undefined>;
|
|
40
40
|
}
|
package/dist/Consents.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ export declare class Consents {
|
|
|
4
4
|
private client;
|
|
5
5
|
constructor(client: RequestController);
|
|
6
6
|
/**
|
|
7
|
-
* @see https://docs.voucherify.io/reference
|
|
7
|
+
* @see https://docs.voucherify.io/reference/get-consents
|
|
8
8
|
*/
|
|
9
9
|
list(): Promise<T.ConsentsListResponse>;
|
|
10
10
|
}
|
package/dist/Customers.d.ts
CHANGED
|
@@ -4,15 +4,15 @@ declare class Customers {
|
|
|
4
4
|
private client;
|
|
5
5
|
constructor(client: RequestController);
|
|
6
6
|
/**
|
|
7
|
-
* @see https://docs.voucherify.io/reference
|
|
7
|
+
* @see https://docs.voucherify.io/reference/create-customer
|
|
8
8
|
*/
|
|
9
9
|
create(customer: T.CustomersCreateBody): Promise<T.CustomersCreateResponse>;
|
|
10
10
|
/**
|
|
11
|
-
* @see https://docs.voucherify.io/reference
|
|
11
|
+
* @see https://docs.voucherify.io/reference/read-customer
|
|
12
12
|
*/
|
|
13
13
|
get(customerId: string): Promise<T.CustomersCreateResponse>;
|
|
14
14
|
/**
|
|
15
|
-
* @see https://docs.voucherify.io/reference
|
|
15
|
+
* @see https://docs.voucherify.io/reference/list-customers
|
|
16
16
|
*/
|
|
17
17
|
list(params: T.CustomersListParams): Promise<T.CustomersCommonListResponse>;
|
|
18
18
|
/**
|
|
@@ -28,15 +28,15 @@ declare class Customers {
|
|
|
28
28
|
*/
|
|
29
29
|
scroll(params: T.CustomersScrollParams): AsyncGenerator<T.CustomersScrollYield, void, T.CustomersScrollYield>;
|
|
30
30
|
/**
|
|
31
|
-
* @see https://docs.voucherify.io/reference
|
|
31
|
+
* @see https://docs.voucherify.io/reference/update-customer
|
|
32
32
|
*/
|
|
33
33
|
update(customer: T.CustomersUpdateParams): Promise<T.CustomersCreateResponse>;
|
|
34
34
|
/**
|
|
35
|
-
* @see https://docs.voucherify.io/reference
|
|
35
|
+
* @see https://docs.voucherify.io/reference/delete-customer
|
|
36
36
|
*/
|
|
37
37
|
delete(customerId: string): Promise<undefined>;
|
|
38
38
|
/**
|
|
39
|
-
* @see https://docs.voucherify.io/reference
|
|
39
|
+
* @see https://docs.voucherify.io/reference/update-customers-consents
|
|
40
40
|
*/
|
|
41
41
|
updateConsents(idOrSourceId: string, consents: T.CustomersUpdateConsentsBody): Promise<undefined>;
|
|
42
42
|
}
|
package/dist/Distributions.d.ts
CHANGED
|
@@ -5,11 +5,11 @@ declare class DistributionsPublications {
|
|
|
5
5
|
private client;
|
|
6
6
|
constructor(client: RequestController);
|
|
7
7
|
/**
|
|
8
|
-
* @see https://docs.voucherify.io/reference
|
|
8
|
+
* @see https://docs.voucherify.io/reference/list-publications
|
|
9
9
|
*/
|
|
10
10
|
list(params?: T.DistributionsPublicationsListParams): Promise<T.DistributionsPublicationsListResponse>;
|
|
11
11
|
/**
|
|
12
|
-
* @see https://docs.voucherify.io/reference
|
|
12
|
+
* @see https://docs.voucherify.io/reference/create-publication
|
|
13
13
|
*/
|
|
14
14
|
create(params: T.DistributionsPublicationsCreateParams): Promise<T.DistributionsPublicationsCreateResponse>;
|
|
15
15
|
}
|
package/dist/Events.d.ts
CHANGED
|
@@ -3,5 +3,8 @@ import type { RequestController } from './RequestController';
|
|
|
3
3
|
export declare class Events {
|
|
4
4
|
private client;
|
|
5
5
|
constructor(client: RequestController);
|
|
6
|
+
/**
|
|
7
|
+
* @see https://docs.voucherify.io/reference/track-custom-event-client-side
|
|
8
|
+
*/
|
|
6
9
|
create(eventName: string, params: T.EventsParams): Promise<T.EventsResponse>;
|
|
7
10
|
}
|
package/dist/Exports.d.ts
CHANGED
|
@@ -4,15 +4,15 @@ export declare class Exports {
|
|
|
4
4
|
private client;
|
|
5
5
|
constructor(client: RequestController);
|
|
6
6
|
/**
|
|
7
|
-
* @see https://docs.voucherify.io/reference
|
|
7
|
+
* @see https://docs.voucherify.io/reference/create-export
|
|
8
8
|
*/
|
|
9
9
|
create(exportResource: T.ExportResource): Promise<T.ExportsCreateResponse>;
|
|
10
10
|
/**
|
|
11
|
-
* @see https://docs.voucherify.io/reference
|
|
11
|
+
* @see https://docs.voucherify.io/reference/get-export
|
|
12
12
|
*/
|
|
13
13
|
get(exportResourceId: string): Promise<T.ExportsCreateResponse>;
|
|
14
14
|
/**
|
|
15
|
-
* @see https://docs.voucherify.io/reference
|
|
15
|
+
* @see https://docs.voucherify.io/reference/delete-export
|
|
16
16
|
*/
|
|
17
17
|
delete(exportResourceId: string): Promise<unknown>;
|
|
18
18
|
}
|
package/dist/Loyalties.d.ts
CHANGED
|
@@ -4,79 +4,79 @@ export declare class Loyalties {
|
|
|
4
4
|
private client;
|
|
5
5
|
constructor(client: RequestController);
|
|
6
6
|
/**
|
|
7
|
-
* @see https://docs.voucherify.io/reference
|
|
7
|
+
* @see https://docs.voucherify.io/reference/list-loyalty-programs
|
|
8
8
|
*/
|
|
9
9
|
list(params?: T.LoyaltiesListParams): Promise<T.LoyaltiesListResponse>;
|
|
10
10
|
/**
|
|
11
|
-
* @see https://docs.voucherify.io/reference
|
|
11
|
+
* @see https://docs.voucherify.io/reference/create-loyalty-program
|
|
12
12
|
*/
|
|
13
13
|
create(campaign: T.LoyaltiesCreateCampaign): Promise<T.LoyaltiesCreateCampaignResponse>;
|
|
14
14
|
/**
|
|
15
|
-
* @see https://docs.voucherify.io/reference
|
|
15
|
+
* @see https://docs.voucherify.io/reference/get-loyalty-program
|
|
16
16
|
*/
|
|
17
17
|
get(campaignId: string): Promise<T.LoyaltiesCreateCampaignResponse>;
|
|
18
18
|
/**
|
|
19
|
-
* @see https://docs.voucherify.io/reference
|
|
19
|
+
* @see https://docs.voucherify.io/reference/update-loyalty-program
|
|
20
20
|
*/
|
|
21
21
|
update(campaign: T.LoyaltiesUpdateCampaign): Promise<T.LoyaltiesCreateCampaignResponse>;
|
|
22
22
|
/**
|
|
23
|
-
* @see https://docs.voucherify.io/reference
|
|
23
|
+
* @see https://docs.voucherify.io/reference/delete-loyalty-program
|
|
24
24
|
*/
|
|
25
25
|
delete(campaignId: string, params?: T.LoyaltiesDeleteCampaignParams): Promise<unknown>;
|
|
26
26
|
/**
|
|
27
|
-
* @see https://docs.voucherify.io/reference
|
|
27
|
+
* @see https://docs.voucherify.io/reference/list-reward-assignments-1
|
|
28
28
|
*/
|
|
29
29
|
listRewardAssignments(campaignId: string, params?: T.LoyaltiesListRewardAssignmentsParams): Promise<T.LoyaltiesListRewardAssignmentsResponse>;
|
|
30
30
|
/**
|
|
31
|
-
* @see https://docs.voucherify.io/reference
|
|
31
|
+
* @see https://docs.voucherify.io/reference/create-reward-assignment-1
|
|
32
32
|
*/
|
|
33
33
|
createRewardAssignments(campaignId: string, assignment: T.LoyaltiesCreateRewardAssignments[]): Promise<T.LoyaltiesCreateRewardAssignmentResponse[]>;
|
|
34
34
|
/**
|
|
35
|
-
* @see https://docs.voucherify.io/reference
|
|
35
|
+
* @see https://docs.voucherify.io/reference/update-reward-assignment-1
|
|
36
36
|
*/
|
|
37
37
|
updateRewardAssignment(campaignId: string, assignment: T.LoyaltiesUpdateRewardAssignment): Promise<T.LoyaltiesCreateRewardAssignmentResponse>;
|
|
38
38
|
/**
|
|
39
|
-
* @see https://docs.voucherify.io/reference
|
|
39
|
+
* @see https://docs.voucherify.io/reference/delete-reward-assignment-1
|
|
40
40
|
*/
|
|
41
41
|
deleteRewardAssignment(campaignId: string, assignmentId: string): Promise<unknown>;
|
|
42
42
|
/**
|
|
43
|
-
* @see https://docs.voucherify.io/reference
|
|
43
|
+
* @see https://docs.voucherify.io/reference/list-earning-rules
|
|
44
44
|
*/
|
|
45
45
|
listEarningRules(campaignId: string, params?: T.LoyaltiesListEarningRulesParams): Promise<T.LoyaltiesListEarningRulesResponse>;
|
|
46
46
|
/**
|
|
47
|
-
* @see https://docs.voucherify.io/reference
|
|
47
|
+
* @see https://docs.voucherify.io/reference/create-earning-rule
|
|
48
48
|
*/
|
|
49
49
|
createEarningRule(campaignId: string, earningRules: T.LoyaltiesCreateEarningRule[]): Promise<T.LoyaltiesEarningRulesResponse[]>;
|
|
50
50
|
/**
|
|
51
|
-
* @see https://docs.voucherify.io/reference
|
|
51
|
+
* @see https://docs.voucherify.io/reference/update-earning-rule
|
|
52
52
|
*/
|
|
53
53
|
updateEarningRule(campaignId: string, earningRule: T.LoyaltiesUpdateEarningRule): Promise<T.LoyaltiesEarningRulesResponse>;
|
|
54
54
|
/**
|
|
55
|
-
* @see https://docs.voucherify.io/reference
|
|
55
|
+
* @see https://docs.voucherify.io/reference/delete-earning-rule
|
|
56
56
|
*/
|
|
57
57
|
deleteEarningRule(campaignId: string, earningRuleId: string): Promise<unknown>;
|
|
58
58
|
/**
|
|
59
|
-
* @see https://docs.voucherify.io/reference
|
|
59
|
+
* @see https://docs.voucherify.io/reference/list-members
|
|
60
60
|
*/
|
|
61
61
|
listMembers(campaignId: string, params?: T.LoyaltiesListMembersParams): Promise<T.LoyaltiesListMembersResponse>;
|
|
62
62
|
/**
|
|
63
|
-
* @see https://docs.voucherify.io/reference
|
|
63
|
+
* @see https://docs.voucherify.io/reference/create-member
|
|
64
64
|
*/
|
|
65
65
|
createMember(campaignId: string, member: T.LoyaltiesCreateMember): Promise<T.LoyaltiesVoucherResponse>;
|
|
66
66
|
/**
|
|
67
|
-
* @see https://docs.voucherify.io/reference
|
|
67
|
+
* @see https://docs.voucherify.io/reference/get-member
|
|
68
68
|
*/
|
|
69
69
|
getMember(campaignId: string, memberId: string): Promise<T.LoyaltiesVoucherResponse>;
|
|
70
70
|
/**
|
|
71
|
-
* @see https://docs.voucherify.io/reference
|
|
71
|
+
* @see https://docs.voucherify.io/reference/get-member-activities
|
|
72
72
|
*/
|
|
73
73
|
getMemberActivities(campaignId: string, memberId: string): Promise<T.LoyaltiesGetMemberActivitiesResponse>;
|
|
74
74
|
/**
|
|
75
|
-
* @see https://docs.voucherify.io/reference
|
|
75
|
+
* @see https://docs.voucherify.io/reference/add-loyalty-card-balance
|
|
76
76
|
*/
|
|
77
77
|
addPoints(campaignId: string, memberId: string, balance: T.LoyaltiesAddPoints): Promise<T.LoyaltiesAddPointsResponse>;
|
|
78
78
|
/**
|
|
79
|
-
* @see https://docs.voucherify.io/reference
|
|
79
|
+
* @see https://docs.voucherify.io/reference/redeem-loyalty-card
|
|
80
80
|
*/
|
|
81
81
|
redeemReward(campaignId: string, memberId: string, params: T.LoyaltiesRedeemRewardParams): Promise<T.LoyaltiesRedeemRewardResponse>;
|
|
82
82
|
}
|
package/dist/Orders.d.ts
CHANGED
|
@@ -4,19 +4,19 @@ export declare class Orders {
|
|
|
4
4
|
private client;
|
|
5
5
|
constructor(client: RequestController);
|
|
6
6
|
/**
|
|
7
|
-
* @see https://docs.voucherify.io/reference
|
|
7
|
+
* @see https://docs.voucherify.io/reference/create-order
|
|
8
8
|
*/
|
|
9
9
|
create(order: T.OrdersCreate): Promise<T.OrdersCreateResponse>;
|
|
10
10
|
/**
|
|
11
|
-
* @see https://docs.voucherify.io/reference
|
|
11
|
+
* @see https://docs.voucherify.io/reference/get-order
|
|
12
12
|
*/
|
|
13
13
|
get(orderId: string): Promise<T.OrdersCreateResponse>;
|
|
14
14
|
/**
|
|
15
|
-
* @see https://docs.voucherify.io/reference
|
|
15
|
+
* @see https://docs.voucherify.io/reference/update-order
|
|
16
16
|
*/
|
|
17
17
|
update(order: T.OrdersUpdate): Promise<T.OrdersCreateResponse>;
|
|
18
18
|
/**
|
|
19
|
-
* @see https://docs.voucherify.io/reference
|
|
19
|
+
* @see https://docs.voucherify.io/reference/list-orders
|
|
20
20
|
*/
|
|
21
21
|
list(params?: T.OrdersListParams): Promise<T.OrdersListResponse>;
|
|
22
22
|
}
|
package/dist/Products.d.ts
CHANGED
|
@@ -4,51 +4,51 @@ export declare class Products {
|
|
|
4
4
|
private client;
|
|
5
5
|
constructor(client: RequestController);
|
|
6
6
|
/**
|
|
7
|
-
* @see https://docs.voucherify.io/reference
|
|
7
|
+
* @see https://docs.voucherify.io/reference/create-product
|
|
8
8
|
*/
|
|
9
9
|
create(product: T.ProductsCreate): Promise<T.ProductsCreateResponse>;
|
|
10
10
|
/**
|
|
11
|
-
* @see https://docs.voucherify.io/reference
|
|
11
|
+
* @see https://docs.voucherify.io/reference/get-product
|
|
12
12
|
*/
|
|
13
13
|
get(productId: string): Promise<T.ProductsGetResponse>;
|
|
14
14
|
/**
|
|
15
|
-
* @see https://docs.voucherify.io/reference
|
|
15
|
+
* @see https://docs.voucherify.io/reference/update-product
|
|
16
16
|
*/
|
|
17
17
|
update(product: T.ProductsUpdate): Promise<T.ProductsCreateResponse>;
|
|
18
18
|
/**
|
|
19
|
-
* @see https://docs.voucherify.io/reference
|
|
19
|
+
* @see https://docs.voucherify.io/reference/async-update-products-metadata-in-bulk
|
|
20
20
|
*/
|
|
21
|
-
|
|
21
|
+
bulkUpdateMetadata(products: T.ProductsBulkUpdateMetadata): Promise<T.ProductsBulkUpdateMetadataResponse>;
|
|
22
22
|
/**
|
|
23
|
-
* @see https://docs.voucherify.io/reference
|
|
23
|
+
* @see https://docs.voucherify.io/reference/post-products-in-bulk
|
|
24
24
|
*/
|
|
25
25
|
bulkUpdate(products: T.ProductsBulkUpdate): Promise<T.ProductsBulkUpdateResponse>;
|
|
26
26
|
/**
|
|
27
|
-
* @see https://docs.voucherify.io/reference
|
|
27
|
+
* @see https://docs.voucherify.io/reference/delete-product
|
|
28
28
|
*/
|
|
29
29
|
delete(productId: string, params?: T.ProductsDeleteParams): Promise<unknown>;
|
|
30
30
|
/**
|
|
31
|
-
* @see https://docs.voucherify.io/reference
|
|
31
|
+
* @see https://docs.voucherify.io/reference/list-products
|
|
32
32
|
*/
|
|
33
33
|
list(params?: T.ProductsListParams): Promise<T.ProductsListResponse>;
|
|
34
34
|
/**
|
|
35
|
-
* @see https://docs.voucherify.io/reference
|
|
35
|
+
* @see https://docs.voucherify.io/reference/create-sku
|
|
36
36
|
*/
|
|
37
37
|
createSku(productId: string, sku: T.ProductsCreateSku): Promise<T.ProductsCreateSkuResponse>;
|
|
38
38
|
/**
|
|
39
|
-
* @see https://docs.voucherify.io/reference
|
|
39
|
+
* @see https://docs.voucherify.io/reference/get-sku-v20210726
|
|
40
40
|
*/
|
|
41
|
-
getSku(
|
|
41
|
+
getSku(skuId: string): Promise<T.ProductsCreateSkuResponse>;
|
|
42
42
|
/**
|
|
43
|
-
* @see https://docs.voucherify.io/reference
|
|
43
|
+
* @see https://docs.voucherify.io/reference/update-sku
|
|
44
44
|
*/
|
|
45
45
|
updateSku(productId: string, sku: T.ProductsUpdateSku): Promise<T.ProductsCreateSkuResponse>;
|
|
46
46
|
/**
|
|
47
|
-
* @see https://docs.voucherify.io/reference
|
|
47
|
+
* @see https://docs.voucherify.io/reference/delete-sku
|
|
48
48
|
*/
|
|
49
49
|
deleteSku(productId: string, skuId: string, params?: T.ProductsDeleteSkuParams): Promise<unknown>;
|
|
50
50
|
/**
|
|
51
|
-
* @see https://docs.voucherify.io/reference
|
|
51
|
+
* @see https://docs.voucherify.io/reference/list-skus
|
|
52
52
|
*/
|
|
53
53
|
listSkus(productId: string): Promise<T.ProductsListSkus>;
|
|
54
54
|
}
|
package/dist/PromotionTiers.d.ts
CHANGED
|
@@ -4,27 +4,27 @@ export declare class PromotionTiers {
|
|
|
4
4
|
private client;
|
|
5
5
|
constructor(client: RequestController);
|
|
6
6
|
/**
|
|
7
|
-
* @see
|
|
7
|
+
* @see https://docs.voucherify.io/reference/list-promotion-tiers
|
|
8
8
|
*/
|
|
9
9
|
listAll(params?: T.PromotionTiersListAllParams): Promise<T.PromotionTiersListAllResponse>;
|
|
10
10
|
/**
|
|
11
|
-
* @see
|
|
11
|
+
* @see https://docs.voucherify.io/reference/get-promotions
|
|
12
12
|
*/
|
|
13
13
|
list(promotionId: string): Promise<T.PromotionTiersListAllResponse>;
|
|
14
14
|
/**
|
|
15
|
-
* @see
|
|
15
|
+
* @see https://docs.voucherify.io/reference/add-promotion-tier-to-campaign
|
|
16
16
|
*/
|
|
17
17
|
create(promotionId: string, params: T.PromotionTiersCreateParams): Promise<T.PromotionTier>;
|
|
18
18
|
/**
|
|
19
|
-
* @see
|
|
19
|
+
* @see https://docs.voucherify.io/reference/redeem-promotion
|
|
20
20
|
*/
|
|
21
21
|
redeem(promotionsTierId: string, params: T.PromotionTiersRedeemParams): Promise<T.PromotionTiersRedeemResponse>;
|
|
22
22
|
/**
|
|
23
|
-
* @see
|
|
23
|
+
* @see https://docs.voucherify.io/reference/update-promotion
|
|
24
24
|
*/
|
|
25
25
|
update(params: T.PromotionTiersUpdateParams): Promise<T.PromotionTier>;
|
|
26
26
|
/**
|
|
27
|
-
* @see
|
|
27
|
+
* @see https://docs.voucherify.io/reference/delete-promotion
|
|
28
28
|
*/
|
|
29
29
|
delete(promotionsTierId: string): Promise<unknown>;
|
|
30
30
|
}
|
package/dist/Promotions.d.ts
CHANGED
|
@@ -6,11 +6,11 @@ export declare class Promotions {
|
|
|
6
6
|
tiers: PromotionTiers;
|
|
7
7
|
constructor(client: RequestController, tiers: PromotionTiers);
|
|
8
8
|
/**
|
|
9
|
-
* @see
|
|
9
|
+
* @see https://docs.voucherify.io/reference/create-promotion-campaign
|
|
10
10
|
*/
|
|
11
11
|
create(promotionCampaign: T.PromotionsCreate): Promise<T.PromotionsCreateResponse>;
|
|
12
12
|
/**
|
|
13
|
-
* @see
|
|
13
|
+
* @see https://docs.voucherify.io/reference/validate-promotions-1
|
|
14
14
|
*/
|
|
15
|
-
validate(
|
|
15
|
+
validate(body: T.PromotionsValidateParams, params?: T.PromotionsValidateQueryParams): Promise<T.PromotionsValidateResponse>;
|
|
16
16
|
}
|
package/dist/Redemptions.d.ts
CHANGED
|
@@ -4,23 +4,23 @@ export declare class Redemptions {
|
|
|
4
4
|
private client;
|
|
5
5
|
constructor(client: RequestController);
|
|
6
6
|
/**
|
|
7
|
-
* @see https://docs.voucherify.io/reference
|
|
7
|
+
* @see https://docs.voucherify.io/reference/redeem-voucher
|
|
8
8
|
*/
|
|
9
9
|
redeem(code: string, body?: T.RedemptionsRedeemBody): Promise<T.RedemptionsRedeemResponse>;
|
|
10
10
|
/**
|
|
11
|
-
* @see https://docs.voucherify.io/reference
|
|
11
|
+
* @see https://docs.voucherify.io/reference/get-redemption
|
|
12
12
|
*/
|
|
13
13
|
get(redemptionId: string): Promise<T.Redemption>;
|
|
14
14
|
/**
|
|
15
|
-
* @see https://docs.voucherify.io/reference
|
|
15
|
+
* @see https://docs.voucherify.io/reference/list-redemptions
|
|
16
16
|
*/
|
|
17
17
|
list(params?: T.RedemptionsListParams): Promise<T.RedemptionsListResponse>;
|
|
18
18
|
/**
|
|
19
|
-
* @see https://docs.voucherify.io/reference
|
|
19
|
+
* @see https://docs.voucherify.io/reference/vouchers-redemptions
|
|
20
20
|
*/
|
|
21
21
|
getForVoucher(code: string): Promise<T.RedemptionsGetForVoucherResponse>;
|
|
22
22
|
/**
|
|
23
|
-
* @see https://docs.voucherify.io/reference
|
|
23
|
+
* @see https://docs.voucherify.io/reference/rollback-redemption
|
|
24
24
|
*/
|
|
25
25
|
rollback(redemptionId: string, params?: T.RedemptionsRollbackParams): Promise<T.RedemptionsRollbackResponse>;
|
|
26
26
|
}
|
package/dist/Rewards.d.ts
CHANGED
|
@@ -4,35 +4,35 @@ export declare class Rewards {
|
|
|
4
4
|
private client;
|
|
5
5
|
constructor(client: RequestController);
|
|
6
6
|
/**
|
|
7
|
-
* @see https://docs.voucherify.io/reference
|
|
7
|
+
* @see https://docs.voucherify.io/reference/list-rewards
|
|
8
8
|
*/
|
|
9
9
|
list(params?: T.RewardsListParams): Promise<T.RewardsListResponse>;
|
|
10
10
|
/**
|
|
11
|
-
* @see https://docs.voucherify.io/reference
|
|
11
|
+
* @see https://docs.voucherify.io/reference/create-reward
|
|
12
12
|
*/
|
|
13
13
|
create(reward: T.RewardsCreate): Promise<T.RewardsCreateResponse>;
|
|
14
14
|
/**
|
|
15
|
-
* @see https://docs.voucherify.io/reference
|
|
15
|
+
* @see https://docs.voucherify.io/reference/get-reward
|
|
16
16
|
*/
|
|
17
17
|
get(rewardId: string): Promise<T.RewardsCreateResponse>;
|
|
18
18
|
/**
|
|
19
|
-
* @see https://docs.voucherify.io/reference
|
|
19
|
+
* @see https://docs.voucherify.io/reference/update-reward
|
|
20
20
|
*/
|
|
21
21
|
update(reward: T.RewardsUpdate): Promise<T.RewardsCreateResponse>;
|
|
22
22
|
/**
|
|
23
|
-
* @see https://docs.voucherify.io/reference
|
|
23
|
+
* @see https://docs.voucherify.io/reference/delete-reward
|
|
24
24
|
*/
|
|
25
25
|
delete(rewardId: string): Promise<unknown>;
|
|
26
26
|
/**
|
|
27
|
-
* @see https://docs.voucherify.io/reference
|
|
27
|
+
* @see https://docs.voucherify.io/reference/list-reward-assignments
|
|
28
28
|
*/
|
|
29
29
|
listAssignments(rewardId: string, params?: T.RewardsListAssignmentsParams): Promise<T.RewardsListAssignmentsResponse>;
|
|
30
30
|
/**
|
|
31
|
-
* @see https://docs.voucherify.io/reference
|
|
31
|
+
* @see https://docs.voucherify.io/reference/create-reward-assignment
|
|
32
32
|
*/
|
|
33
33
|
createAssignment(rewardId: string, assignment: T.RewardsCreateAssignment): Promise<T.RewardsAssignmentObject>;
|
|
34
34
|
/**
|
|
35
|
-
* @see https://docs.voucherify.io/reference
|
|
35
|
+
* @see https://docs.voucherify.io/reference/update-reward-assignment
|
|
36
36
|
*/
|
|
37
37
|
updateAssignment(rewardId: string, assignment: T.RewardsUpdateAssignment): Promise<T.RewardsAssignmentObject>;
|
|
38
38
|
deleteAssignment(rewardId: string, assignmentId: string): Promise<unknown>;
|
package/dist/Segments.d.ts
CHANGED
|
@@ -4,19 +4,19 @@ export declare class Segments {
|
|
|
4
4
|
private client;
|
|
5
5
|
constructor(client: RequestController);
|
|
6
6
|
/**
|
|
7
|
-
* @see https://docs.voucherify.io/reference
|
|
7
|
+
* @see https://docs.voucherify.io/reference/create-segment
|
|
8
8
|
*/
|
|
9
9
|
create(segment: T.SegmentsCreate): Promise<T.SegmentsCreateResponse>;
|
|
10
10
|
/**
|
|
11
|
-
* @see https://docs.voucherify.io/reference
|
|
11
|
+
* @see https://docs.voucherify.io/reference/get-segment
|
|
12
12
|
*/
|
|
13
13
|
get(segmentId: string): Promise<T.SegmentsCreateResponse>;
|
|
14
14
|
/**
|
|
15
|
-
* @see https://docs.voucherify.io/reference
|
|
15
|
+
* @see https://docs.voucherify.io/reference/delete-segment
|
|
16
16
|
*/
|
|
17
17
|
delete(segmentId: string): Promise<unknown>;
|
|
18
18
|
/**
|
|
19
|
-
* @see https://docs.voucherify.io/reference
|
|
19
|
+
* @see https://docs.voucherify.io/reference/list-segments
|
|
20
20
|
*/
|
|
21
21
|
list(customerId: string): Promise<T.SegmentsListResponse>;
|
|
22
22
|
}
|
|
@@ -4,36 +4,36 @@ export declare class ValidationRules {
|
|
|
4
4
|
private client;
|
|
5
5
|
constructor(client: RequestController);
|
|
6
6
|
/**
|
|
7
|
-
* @see https://docs.voucherify.io/reference
|
|
7
|
+
* @see https://docs.voucherify.io/reference/create-validation-rules
|
|
8
8
|
*/
|
|
9
9
|
create(validationRule: T.ValidationRulesCreate): Promise<T.ValidationRulesCreateResponse>;
|
|
10
10
|
/**
|
|
11
|
-
* @see https://docs.voucherify.io/reference
|
|
11
|
+
* @see https://docs.voucherify.io/reference/get-validation-rules
|
|
12
12
|
*/
|
|
13
13
|
get(validationRuleId: string): Promise<T.ValidationRulesGetResponse>;
|
|
14
14
|
/**
|
|
15
|
-
* @see https://docs.voucherify.io/reference
|
|
15
|
+
* @see https://docs.voucherify.io/reference/update-validation-rules
|
|
16
16
|
*/
|
|
17
17
|
update(validationRule: T.ValidationRulesUpdate): Promise<T.ValidationRulesCreateResponse>;
|
|
18
18
|
/**
|
|
19
|
-
* @see https://docs.voucherify.io/reference
|
|
19
|
+
* @see https://docs.voucherify.io/reference/delete-validation-rules
|
|
20
20
|
*/
|
|
21
21
|
delete(validationRuleId: string): Promise<unknown>;
|
|
22
22
|
/**
|
|
23
|
-
* @see https://docs.voucherify.io/reference
|
|
23
|
+
* @see https://docs.voucherify.io/reference/create-validation-rules-assignment
|
|
24
24
|
*/
|
|
25
25
|
createAssignment(validationRuleId: string, assignment: T.ValidationRulesCreateAssignment): Promise<T.ValidationRulesCreateAssignmentResponse>;
|
|
26
26
|
/**
|
|
27
|
-
* @see https://docs.voucherify.io/reference
|
|
27
|
+
* @see https://docs.voucherify.io/reference/delete-validation-rules-assignment
|
|
28
28
|
*/
|
|
29
29
|
deleteAssignment(validationRuleId: string, assignmentId: string): Promise<unknown>;
|
|
30
30
|
validate(validationRuleId: string, params?: any): Promise<T.ValidationRulesValidateResponse>;
|
|
31
31
|
/**
|
|
32
|
-
* @see https://docs.voucherify.io/reference
|
|
32
|
+
* @see https://docs.voucherify.io/reference/list-validation-rules
|
|
33
33
|
*/
|
|
34
34
|
list(params?: T.ValidationRulesListParams): Promise<T.ValidationRulesListResponse>;
|
|
35
35
|
/**
|
|
36
|
-
* @see https://docs.voucherify.io/reference
|
|
36
|
+
* @see https://docs.voucherify.io/reference/list-validation-rule-assignments
|
|
37
37
|
*/
|
|
38
38
|
listAssignments(validationRuleId: string, params?: T.ValidationRulesListAssignmentsParams): Promise<T.ValidationRulesListAssignmentsResponse>;
|
|
39
39
|
}
|
package/dist/Validations.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ export declare class Validations {
|
|
|
6
6
|
private promotions;
|
|
7
7
|
constructor(client: RequestController, promotions: Promotions);
|
|
8
8
|
/**
|
|
9
|
-
* @see https://docs.voucherify.io/reference
|
|
9
|
+
* @see https://docs.voucherify.io/reference/validate-voucher
|
|
10
10
|
*/
|
|
11
11
|
validateVoucher(code: string, params?: T.ValidationsValidateVoucherParams): Promise<T.ValidationsValidateVoucherResponse>;
|
|
12
12
|
validate(code: string | T.ValidationsValidateCode, context?: T.ValidationsValidateContext): Promise<T.ValidationsValidateVoucherResponse> | Promise<import("./types").PromotionsValidateResponse>;
|