@emilgroup/discount-sdk 1.5.1 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +54 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +2 -2
- package/api/campaigns-api.ts +1433 -0
- package/api/default-api.ts +124 -0
- package/api/policy-vouchers-api.ts +999 -0
- package/api/vouchers-api.ts +691 -0
- package/api.ts +33 -0
- package/base.ts +331 -0
- package/common.ts +198 -0
- package/configuration.ts +110 -0
- package/dist/api/campaigns-api.d.ts +808 -0
- package/dist/api/campaigns-api.js +1251 -0
- package/dist/api/default-api.d.ts +70 -0
- package/dist/api/default-api.js +200 -0
- package/dist/api/policy-vouchers-api.d.ts +555 -0
- package/dist/api/policy-vouchers-api.js +915 -0
- package/dist/api/vouchers-api.d.ts +393 -0
- package/dist/api/vouchers-api.js +642 -0
- package/dist/api.d.ts +15 -0
- package/dist/api.js +33 -0
- package/dist/base.d.ts +86 -0
- package/dist/base.js +367 -0
- package/dist/common.d.ts +91 -0
- package/dist/common.js +276 -0
- package/dist/configuration.d.ts +89 -0
- package/dist/configuration.js +52 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.js +36 -0
- package/dist/models/campaign-class.d.ts +105 -0
- package/dist/models/campaign-class.js +24 -0
- package/dist/models/charge-policy-voucher-request-dto.d.ts +48 -0
- package/dist/models/charge-policy-voucher-request-dto.js +15 -0
- package/dist/models/charge-policy-voucher-response-class.d.ts +96 -0
- package/dist/models/charge-policy-voucher-response-class.js +21 -0
- package/dist/models/check-account-eligibility-request-dto.d.ts +48 -0
- package/dist/models/check-account-eligibility-request-dto.js +15 -0
- package/dist/models/check-account-eligibility-response-class.d.ts +57 -0
- package/dist/models/check-account-eligibility-response-class.js +24 -0
- package/dist/models/create-campaign-request-dto.d.ts +42 -0
- package/dist/models/create-campaign-request-dto.js +15 -0
- package/dist/models/create-campaign-response-class.d.ts +25 -0
- package/dist/models/create-campaign-response-class.js +15 -0
- package/dist/models/create-eligible-account-request-dto.d.ts +30 -0
- package/dist/models/create-eligible-account-request-dto.js +15 -0
- package/dist/models/create-eligible-account-response-class.d.ts +25 -0
- package/dist/models/create-eligible-account-response-class.js +15 -0
- package/dist/models/create-policy-voucher-request-dto.d.ts +48 -0
- package/dist/models/create-policy-voucher-request-dto.js +15 -0
- package/dist/models/create-policy-voucher-response-class.d.ts +25 -0
- package/dist/models/create-policy-voucher-response-class.js +15 -0
- package/dist/models/create-product-discount-dto.d.ts +48 -0
- package/dist/models/create-product-discount-dto.js +15 -0
- package/dist/models/create-voucher-request-dto.d.ts +66 -0
- package/dist/models/create-voucher-request-dto.js +20 -0
- package/dist/models/create-voucher-response-class.d.ts +25 -0
- package/dist/models/create-voucher-response-class.js +15 -0
- package/dist/models/eligible-account-class.d.ts +78 -0
- package/dist/models/eligible-account-class.js +15 -0
- package/dist/models/get-campaign-response-class.d.ts +25 -0
- package/dist/models/get-campaign-response-class.js +15 -0
- package/dist/models/get-policy-voucher-response-class.d.ts +25 -0
- package/dist/models/get-policy-voucher-response-class.js +15 -0
- package/dist/models/get-voucher-response-class.d.ts +25 -0
- package/dist/models/get-voucher-response-class.js +15 -0
- package/dist/models/index.d.ts +37 -0
- package/dist/models/index.js +53 -0
- package/dist/models/inline-response200.d.ts +54 -0
- package/dist/models/inline-response200.js +15 -0
- package/dist/models/inline-response503.d.ts +54 -0
- package/dist/models/inline-response503.js +15 -0
- package/dist/models/list-campaigns-response-class.d.ts +43 -0
- package/dist/models/list-campaigns-response-class.js +15 -0
- package/dist/models/list-eligible-accounts-response-class.d.ts +43 -0
- package/dist/models/list-eligible-accounts-response-class.js +15 -0
- package/dist/models/list-policy-vouchers-response-class.d.ts +43 -0
- package/dist/models/list-policy-vouchers-response-class.js +15 -0
- package/dist/models/list-vouchers-response-class.d.ts +43 -0
- package/dist/models/list-vouchers-response-class.js +15 -0
- package/dist/models/policy-voucher-class.d.ts +165 -0
- package/dist/models/policy-voucher-class.js +21 -0
- package/dist/models/policy-voucher-transaction-class.d.ts +126 -0
- package/dist/models/policy-voucher-transaction-class.js +26 -0
- package/dist/models/product-discount-class.d.ts +90 -0
- package/dist/models/product-discount-class.js +15 -0
- package/dist/models/redeem-policy-voucher-request-dto.d.ts +48 -0
- package/dist/models/redeem-policy-voucher-request-dto.js +15 -0
- package/dist/models/redeem-policy-voucher-response-class.d.ts +84 -0
- package/dist/models/redeem-policy-voucher-response-class.js +21 -0
- package/dist/models/update-campaign-request-dto.d.ts +42 -0
- package/dist/models/update-campaign-request-dto.js +15 -0
- package/dist/models/update-campaign-response-class.d.ts +25 -0
- package/dist/models/update-campaign-response-class.js +15 -0
- package/dist/models/update-campaign-status-request-dto.d.ts +33 -0
- package/dist/models/update-campaign-status-request-dto.js +24 -0
- package/dist/models/update-voucher-request-dto.d.ts +60 -0
- package/dist/models/update-voucher-request-dto.js +20 -0
- package/dist/models/update-voucher-response-class.d.ts +25 -0
- package/dist/models/update-voucher-response-class.js +15 -0
- package/dist/models/voucher-class.d.ts +127 -0
- package/dist/models/voucher-class.js +20 -0
- package/dist/models/withdraw-policy-voucher-request-dto.d.ts +36 -0
- package/dist/models/withdraw-policy-voucher-request-dto.js +15 -0
- package/dist/models/withdraw-policy-voucher-response-class.d.ts +78 -0
- package/dist/models/withdraw-policy-voucher-response-class.js +21 -0
- package/git_push.sh +57 -0
- package/index.ts +19 -0
- package/models/campaign-class.ts +114 -0
- package/models/charge-policy-voucher-request-dto.ts +54 -0
- package/models/charge-policy-voucher-response-class.ts +105 -0
- package/models/check-account-eligibility-request-dto.ts +54 -0
- package/models/check-account-eligibility-response-class.ts +66 -0
- package/models/create-campaign-request-dto.ts +48 -0
- package/models/create-campaign-response-class.ts +31 -0
- package/models/create-eligible-account-request-dto.ts +36 -0
- package/models/create-eligible-account-response-class.ts +31 -0
- package/models/create-policy-voucher-request-dto.ts +54 -0
- package/models/create-policy-voucher-response-class.ts +31 -0
- package/models/create-product-discount-dto.ts +54 -0
- package/models/create-voucher-request-dto.ts +75 -0
- package/models/create-voucher-response-class.ts +31 -0
- package/models/eligible-account-class.ts +84 -0
- package/models/get-campaign-response-class.ts +31 -0
- package/models/get-policy-voucher-response-class.ts +31 -0
- package/models/get-voucher-response-class.ts +31 -0
- package/models/index.ts +37 -0
- package/models/inline-response200.ts +48 -0
- package/models/inline-response503.ts +48 -0
- package/models/list-campaigns-response-class.ts +49 -0
- package/models/list-eligible-accounts-response-class.ts +49 -0
- package/models/list-policy-vouchers-response-class.ts +49 -0
- package/models/list-vouchers-response-class.ts +49 -0
- package/models/policy-voucher-class.ts +174 -0
- package/models/policy-voucher-transaction-class.ts +136 -0
- package/models/product-discount-class.ts +96 -0
- package/models/redeem-policy-voucher-request-dto.ts +54 -0
- package/models/redeem-policy-voucher-response-class.ts +93 -0
- package/models/update-campaign-request-dto.ts +48 -0
- package/models/update-campaign-response-class.ts +31 -0
- package/models/update-campaign-status-request-dto.ts +42 -0
- package/models/update-voucher-request-dto.ts +69 -0
- package/models/update-voucher-response-class.ts +31 -0
- package/models/voucher-class.ts +136 -0
- package/models/withdraw-policy-voucher-request-dto.ts +42 -0
- package/models/withdraw-policy-voucher-response-class.ts +87 -0
- package/package.json +22 -8
- package/tsconfig.json +23 -0
- package/index.js +0 -99
- package/scripts/deploy.js +0 -225
|
@@ -0,0 +1,555 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL DiscountService
|
|
3
|
+
* The EMIL DiscountService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { ChargePolicyVoucherRequestDto } from '../models';
|
|
16
|
+
import { ChargePolicyVoucherResponseClass } from '../models';
|
|
17
|
+
import { CheckAccountEligibilityRequestDto } from '../models';
|
|
18
|
+
import { CheckAccountEligibilityResponseClass } from '../models';
|
|
19
|
+
import { CreatePolicyVoucherRequestDto } from '../models';
|
|
20
|
+
import { CreatePolicyVoucherResponseClass } from '../models';
|
|
21
|
+
import { GetPolicyVoucherResponseClass } from '../models';
|
|
22
|
+
import { ListPolicyVouchersResponseClass } from '../models';
|
|
23
|
+
import { RedeemPolicyVoucherRequestDto } from '../models';
|
|
24
|
+
import { RedeemPolicyVoucherResponseClass } from '../models';
|
|
25
|
+
import { WithdrawPolicyVoucherRequestDto } from '../models';
|
|
26
|
+
import { WithdrawPolicyVoucherResponseClass } from '../models';
|
|
27
|
+
/**
|
|
28
|
+
* PolicyVouchersApi - axios parameter creator
|
|
29
|
+
* @export
|
|
30
|
+
*/
|
|
31
|
+
export declare const PolicyVouchersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
32
|
+
/**
|
|
33
|
+
* This will charge the policy voucher.
|
|
34
|
+
* @summary Charges the policy voucher.
|
|
35
|
+
* @param {ChargePolicyVoucherRequestDto} chargePolicyVoucherRequestDto
|
|
36
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
37
|
+
* @param {*} [options] Override http request option.
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
*/
|
|
40
|
+
chargePolicyVoucher: (chargePolicyVoucherRequestDto: ChargePolicyVoucherRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
|
+
/**
|
|
42
|
+
* This will check if the account is eligible for a specific voucher.
|
|
43
|
+
* @summary Checks the account eligibility.
|
|
44
|
+
* @param {CheckAccountEligibilityRequestDto} checkAccountEligibilityRequestDto
|
|
45
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
46
|
+
* @param {*} [options] Override http request option.
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
*/
|
|
49
|
+
checkAccountEligibility: (checkAccountEligibilityRequestDto: CheckAccountEligibilityRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50
|
+
/**
|
|
51
|
+
* This will create an policy voucher.
|
|
52
|
+
* @summary Create the policy voucher
|
|
53
|
+
* @param {CreatePolicyVoucherRequestDto} createPolicyVoucherRequestDto
|
|
54
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
55
|
+
* @param {*} [options] Override http request option.
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
*/
|
|
58
|
+
createPolicyVoucher: (createPolicyVoucherRequestDto: CreatePolicyVoucherRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
|
+
/**
|
|
60
|
+
* This will delete an policy voucher.
|
|
61
|
+
* @summary Delete the policy voucher
|
|
62
|
+
* @param {string} code Unique identifier for the object.
|
|
63
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
64
|
+
* @param {*} [options] Override http request option.
|
|
65
|
+
* @throws {RequiredError}
|
|
66
|
+
*/
|
|
67
|
+
deletePolicyVoucher: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
|
+
/**
|
|
69
|
+
* This will get an policy voucher.
|
|
70
|
+
* @summary Retrieve the policy voucher
|
|
71
|
+
* @param {string} code Unique identifier for the object.
|
|
72
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
73
|
+
* @param {'transactions' | 'campaign' | 'voucher'} [expand] You can expand policy voucher in this endpoint. By default, campaign and voucher will be expanded fields.
|
|
74
|
+
* @param {*} [options] Override http request option.
|
|
75
|
+
* @throws {RequiredError}
|
|
76
|
+
*/
|
|
77
|
+
getPolicyVoucher: (code: string, authorization?: string, expand?: 'transactions' | 'campaign' | 'voucher', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
|
+
/**
|
|
79
|
+
* Returns a list of policy vouchers you have previously created. The policy vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
80
|
+
* @summary List policy vouchers
|
|
81
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
82
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
83
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
84
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, voucherCode, partnerNumber, campaignId, voucherId, productSlug, version, remainingMonths, remainingCredits, yearlyPremium, redeemedAt, createdAt, campaignSlug</i>
|
|
85
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: voucherCode, productSlug, partnerNumber</i>
|
|
86
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, voucherCode, productSlug, partnerNumber, remainingCredits, remainingMonths, yearlyPremium, redeemedAt, createdAt</i>
|
|
87
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions, campaign, voucher<i>
|
|
88
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, voucherCode, partnerNumber, campaignId, voucherId, productSlug, version, remainingMonths, remainingCredits, yearlyPremium, redeemedAt, createdAt, campaignSlug</i>
|
|
89
|
+
* @param {*} [options] Override http request option.
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
*/
|
|
92
|
+
listPolicyVouchers: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
93
|
+
/**
|
|
94
|
+
* This will redeem the policy voucher.
|
|
95
|
+
* @summary Redeems the policy voucher.
|
|
96
|
+
* @param {RedeemPolicyVoucherRequestDto} redeemPolicyVoucherRequestDto
|
|
97
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
*/
|
|
101
|
+
redeemPolicyVoucher: (redeemPolicyVoucherRequestDto: RedeemPolicyVoucherRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
102
|
+
/**
|
|
103
|
+
* This will withdraw the policy voucher.
|
|
104
|
+
* @summary Withdraws the policy voucher.
|
|
105
|
+
* @param {WithdrawPolicyVoucherRequestDto} withdrawPolicyVoucherRequestDto
|
|
106
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
107
|
+
* @param {*} [options] Override http request option.
|
|
108
|
+
* @throws {RequiredError}
|
|
109
|
+
*/
|
|
110
|
+
withdrawPolicyVoucher: (withdrawPolicyVoucherRequestDto: WithdrawPolicyVoucherRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
111
|
+
};
|
|
112
|
+
/**
|
|
113
|
+
* PolicyVouchersApi - functional programming interface
|
|
114
|
+
* @export
|
|
115
|
+
*/
|
|
116
|
+
export declare const PolicyVouchersApiFp: (configuration?: Configuration) => {
|
|
117
|
+
/**
|
|
118
|
+
* This will charge the policy voucher.
|
|
119
|
+
* @summary Charges the policy voucher.
|
|
120
|
+
* @param {ChargePolicyVoucherRequestDto} chargePolicyVoucherRequestDto
|
|
121
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
122
|
+
* @param {*} [options] Override http request option.
|
|
123
|
+
* @throws {RequiredError}
|
|
124
|
+
*/
|
|
125
|
+
chargePolicyVoucher(chargePolicyVoucherRequestDto: ChargePolicyVoucherRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChargePolicyVoucherResponseClass>>;
|
|
126
|
+
/**
|
|
127
|
+
* This will check if the account is eligible for a specific voucher.
|
|
128
|
+
* @summary Checks the account eligibility.
|
|
129
|
+
* @param {CheckAccountEligibilityRequestDto} checkAccountEligibilityRequestDto
|
|
130
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
131
|
+
* @param {*} [options] Override http request option.
|
|
132
|
+
* @throws {RequiredError}
|
|
133
|
+
*/
|
|
134
|
+
checkAccountEligibility(checkAccountEligibilityRequestDto: CheckAccountEligibilityRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckAccountEligibilityResponseClass>>;
|
|
135
|
+
/**
|
|
136
|
+
* This will create an policy voucher.
|
|
137
|
+
* @summary Create the policy voucher
|
|
138
|
+
* @param {CreatePolicyVoucherRequestDto} createPolicyVoucherRequestDto
|
|
139
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
140
|
+
* @param {*} [options] Override http request option.
|
|
141
|
+
* @throws {RequiredError}
|
|
142
|
+
*/
|
|
143
|
+
createPolicyVoucher(createPolicyVoucherRequestDto: CreatePolicyVoucherRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePolicyVoucherResponseClass>>;
|
|
144
|
+
/**
|
|
145
|
+
* This will delete an policy voucher.
|
|
146
|
+
* @summary Delete the policy voucher
|
|
147
|
+
* @param {string} code Unique identifier for the object.
|
|
148
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
149
|
+
* @param {*} [options] Override http request option.
|
|
150
|
+
* @throws {RequiredError}
|
|
151
|
+
*/
|
|
152
|
+
deletePolicyVoucher(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
153
|
+
/**
|
|
154
|
+
* This will get an policy voucher.
|
|
155
|
+
* @summary Retrieve the policy voucher
|
|
156
|
+
* @param {string} code Unique identifier for the object.
|
|
157
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
158
|
+
* @param {'transactions' | 'campaign' | 'voucher'} [expand] You can expand policy voucher in this endpoint. By default, campaign and voucher will be expanded fields.
|
|
159
|
+
* @param {*} [options] Override http request option.
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
*/
|
|
162
|
+
getPolicyVoucher(code: string, authorization?: string, expand?: 'transactions' | 'campaign' | 'voucher', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPolicyVoucherResponseClass>>;
|
|
163
|
+
/**
|
|
164
|
+
* Returns a list of policy vouchers you have previously created. The policy vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
165
|
+
* @summary List policy vouchers
|
|
166
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
167
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
168
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
169
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, voucherCode, partnerNumber, campaignId, voucherId, productSlug, version, remainingMonths, remainingCredits, yearlyPremium, redeemedAt, createdAt, campaignSlug</i>
|
|
170
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: voucherCode, productSlug, partnerNumber</i>
|
|
171
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, voucherCode, productSlug, partnerNumber, remainingCredits, remainingMonths, yearlyPremium, redeemedAt, createdAt</i>
|
|
172
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions, campaign, voucher<i>
|
|
173
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, voucherCode, partnerNumber, campaignId, voucherId, productSlug, version, remainingMonths, remainingCredits, yearlyPremium, redeemedAt, createdAt, campaignSlug</i>
|
|
174
|
+
* @param {*} [options] Override http request option.
|
|
175
|
+
* @throws {RequiredError}
|
|
176
|
+
*/
|
|
177
|
+
listPolicyVouchers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPolicyVouchersResponseClass>>;
|
|
178
|
+
/**
|
|
179
|
+
* This will redeem the policy voucher.
|
|
180
|
+
* @summary Redeems the policy voucher.
|
|
181
|
+
* @param {RedeemPolicyVoucherRequestDto} redeemPolicyVoucherRequestDto
|
|
182
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
redeemPolicyVoucher(redeemPolicyVoucherRequestDto: RedeemPolicyVoucherRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RedeemPolicyVoucherResponseClass>>;
|
|
187
|
+
/**
|
|
188
|
+
* This will withdraw the policy voucher.
|
|
189
|
+
* @summary Withdraws the policy voucher.
|
|
190
|
+
* @param {WithdrawPolicyVoucherRequestDto} withdrawPolicyVoucherRequestDto
|
|
191
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
192
|
+
* @param {*} [options] Override http request option.
|
|
193
|
+
* @throws {RequiredError}
|
|
194
|
+
*/
|
|
195
|
+
withdrawPolicyVoucher(withdrawPolicyVoucherRequestDto: WithdrawPolicyVoucherRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WithdrawPolicyVoucherResponseClass>>;
|
|
196
|
+
};
|
|
197
|
+
/**
|
|
198
|
+
* PolicyVouchersApi - factory interface
|
|
199
|
+
* @export
|
|
200
|
+
*/
|
|
201
|
+
export declare const PolicyVouchersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
202
|
+
/**
|
|
203
|
+
* This will charge the policy voucher.
|
|
204
|
+
* @summary Charges the policy voucher.
|
|
205
|
+
* @param {ChargePolicyVoucherRequestDto} chargePolicyVoucherRequestDto
|
|
206
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
207
|
+
* @param {*} [options] Override http request option.
|
|
208
|
+
* @throws {RequiredError}
|
|
209
|
+
*/
|
|
210
|
+
chargePolicyVoucher(chargePolicyVoucherRequestDto: ChargePolicyVoucherRequestDto, authorization?: string, options?: any): AxiosPromise<ChargePolicyVoucherResponseClass>;
|
|
211
|
+
/**
|
|
212
|
+
* This will check if the account is eligible for a specific voucher.
|
|
213
|
+
* @summary Checks the account eligibility.
|
|
214
|
+
* @param {CheckAccountEligibilityRequestDto} checkAccountEligibilityRequestDto
|
|
215
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
216
|
+
* @param {*} [options] Override http request option.
|
|
217
|
+
* @throws {RequiredError}
|
|
218
|
+
*/
|
|
219
|
+
checkAccountEligibility(checkAccountEligibilityRequestDto: CheckAccountEligibilityRequestDto, authorization?: string, options?: any): AxiosPromise<CheckAccountEligibilityResponseClass>;
|
|
220
|
+
/**
|
|
221
|
+
* This will create an policy voucher.
|
|
222
|
+
* @summary Create the policy voucher
|
|
223
|
+
* @param {CreatePolicyVoucherRequestDto} createPolicyVoucherRequestDto
|
|
224
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
225
|
+
* @param {*} [options] Override http request option.
|
|
226
|
+
* @throws {RequiredError}
|
|
227
|
+
*/
|
|
228
|
+
createPolicyVoucher(createPolicyVoucherRequestDto: CreatePolicyVoucherRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePolicyVoucherResponseClass>;
|
|
229
|
+
/**
|
|
230
|
+
* This will delete an policy voucher.
|
|
231
|
+
* @summary Delete the policy voucher
|
|
232
|
+
* @param {string} code Unique identifier for the object.
|
|
233
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
234
|
+
* @param {*} [options] Override http request option.
|
|
235
|
+
* @throws {RequiredError}
|
|
236
|
+
*/
|
|
237
|
+
deletePolicyVoucher(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
238
|
+
/**
|
|
239
|
+
* This will get an policy voucher.
|
|
240
|
+
* @summary Retrieve the policy voucher
|
|
241
|
+
* @param {string} code Unique identifier for the object.
|
|
242
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
243
|
+
* @param {'transactions' | 'campaign' | 'voucher'} [expand] You can expand policy voucher in this endpoint. By default, campaign and voucher will be expanded fields.
|
|
244
|
+
* @param {*} [options] Override http request option.
|
|
245
|
+
* @throws {RequiredError}
|
|
246
|
+
*/
|
|
247
|
+
getPolicyVoucher(code: string, authorization?: string, expand?: 'transactions' | 'campaign' | 'voucher', options?: any): AxiosPromise<GetPolicyVoucherResponseClass>;
|
|
248
|
+
/**
|
|
249
|
+
* Returns a list of policy vouchers you have previously created. The policy vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
250
|
+
* @summary List policy vouchers
|
|
251
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
252
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
253
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
254
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, voucherCode, partnerNumber, campaignId, voucherId, productSlug, version, remainingMonths, remainingCredits, yearlyPremium, redeemedAt, createdAt, campaignSlug</i>
|
|
255
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: voucherCode, productSlug, partnerNumber</i>
|
|
256
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, voucherCode, productSlug, partnerNumber, remainingCredits, remainingMonths, yearlyPremium, redeemedAt, createdAt</i>
|
|
257
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions, campaign, voucher<i>
|
|
258
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, voucherCode, partnerNumber, campaignId, voucherId, productSlug, version, remainingMonths, remainingCredits, yearlyPremium, redeemedAt, createdAt, campaignSlug</i>
|
|
259
|
+
* @param {*} [options] Override http request option.
|
|
260
|
+
* @throws {RequiredError}
|
|
261
|
+
*/
|
|
262
|
+
listPolicyVouchers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPolicyVouchersResponseClass>;
|
|
263
|
+
/**
|
|
264
|
+
* This will redeem the policy voucher.
|
|
265
|
+
* @summary Redeems the policy voucher.
|
|
266
|
+
* @param {RedeemPolicyVoucherRequestDto} redeemPolicyVoucherRequestDto
|
|
267
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
268
|
+
* @param {*} [options] Override http request option.
|
|
269
|
+
* @throws {RequiredError}
|
|
270
|
+
*/
|
|
271
|
+
redeemPolicyVoucher(redeemPolicyVoucherRequestDto: RedeemPolicyVoucherRequestDto, authorization?: string, options?: any): AxiosPromise<RedeemPolicyVoucherResponseClass>;
|
|
272
|
+
/**
|
|
273
|
+
* This will withdraw the policy voucher.
|
|
274
|
+
* @summary Withdraws the policy voucher.
|
|
275
|
+
* @param {WithdrawPolicyVoucherRequestDto} withdrawPolicyVoucherRequestDto
|
|
276
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
277
|
+
* @param {*} [options] Override http request option.
|
|
278
|
+
* @throws {RequiredError}
|
|
279
|
+
*/
|
|
280
|
+
withdrawPolicyVoucher(withdrawPolicyVoucherRequestDto: WithdrawPolicyVoucherRequestDto, authorization?: string, options?: any): AxiosPromise<WithdrawPolicyVoucherResponseClass>;
|
|
281
|
+
};
|
|
282
|
+
/**
|
|
283
|
+
* Request parameters for chargePolicyVoucher operation in PolicyVouchersApi.
|
|
284
|
+
* @export
|
|
285
|
+
* @interface PolicyVouchersApiChargePolicyVoucherRequest
|
|
286
|
+
*/
|
|
287
|
+
export interface PolicyVouchersApiChargePolicyVoucherRequest {
|
|
288
|
+
/**
|
|
289
|
+
*
|
|
290
|
+
* @type {ChargePolicyVoucherRequestDto}
|
|
291
|
+
* @memberof PolicyVouchersApiChargePolicyVoucher
|
|
292
|
+
*/
|
|
293
|
+
readonly chargePolicyVoucherRequestDto: ChargePolicyVoucherRequestDto;
|
|
294
|
+
/**
|
|
295
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
296
|
+
* @type {string}
|
|
297
|
+
* @memberof PolicyVouchersApiChargePolicyVoucher
|
|
298
|
+
*/
|
|
299
|
+
readonly authorization?: string;
|
|
300
|
+
}
|
|
301
|
+
/**
|
|
302
|
+
* Request parameters for checkAccountEligibility operation in PolicyVouchersApi.
|
|
303
|
+
* @export
|
|
304
|
+
* @interface PolicyVouchersApiCheckAccountEligibilityRequest
|
|
305
|
+
*/
|
|
306
|
+
export interface PolicyVouchersApiCheckAccountEligibilityRequest {
|
|
307
|
+
/**
|
|
308
|
+
*
|
|
309
|
+
* @type {CheckAccountEligibilityRequestDto}
|
|
310
|
+
* @memberof PolicyVouchersApiCheckAccountEligibility
|
|
311
|
+
*/
|
|
312
|
+
readonly checkAccountEligibilityRequestDto: CheckAccountEligibilityRequestDto;
|
|
313
|
+
/**
|
|
314
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
315
|
+
* @type {string}
|
|
316
|
+
* @memberof PolicyVouchersApiCheckAccountEligibility
|
|
317
|
+
*/
|
|
318
|
+
readonly authorization?: string;
|
|
319
|
+
}
|
|
320
|
+
/**
|
|
321
|
+
* Request parameters for createPolicyVoucher operation in PolicyVouchersApi.
|
|
322
|
+
* @export
|
|
323
|
+
* @interface PolicyVouchersApiCreatePolicyVoucherRequest
|
|
324
|
+
*/
|
|
325
|
+
export interface PolicyVouchersApiCreatePolicyVoucherRequest {
|
|
326
|
+
/**
|
|
327
|
+
*
|
|
328
|
+
* @type {CreatePolicyVoucherRequestDto}
|
|
329
|
+
* @memberof PolicyVouchersApiCreatePolicyVoucher
|
|
330
|
+
*/
|
|
331
|
+
readonly createPolicyVoucherRequestDto: CreatePolicyVoucherRequestDto;
|
|
332
|
+
/**
|
|
333
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
334
|
+
* @type {string}
|
|
335
|
+
* @memberof PolicyVouchersApiCreatePolicyVoucher
|
|
336
|
+
*/
|
|
337
|
+
readonly authorization?: string;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* Request parameters for deletePolicyVoucher operation in PolicyVouchersApi.
|
|
341
|
+
* @export
|
|
342
|
+
* @interface PolicyVouchersApiDeletePolicyVoucherRequest
|
|
343
|
+
*/
|
|
344
|
+
export interface PolicyVouchersApiDeletePolicyVoucherRequest {
|
|
345
|
+
/**
|
|
346
|
+
* Unique identifier for the object.
|
|
347
|
+
* @type {string}
|
|
348
|
+
* @memberof PolicyVouchersApiDeletePolicyVoucher
|
|
349
|
+
*/
|
|
350
|
+
readonly code: string;
|
|
351
|
+
/**
|
|
352
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
353
|
+
* @type {string}
|
|
354
|
+
* @memberof PolicyVouchersApiDeletePolicyVoucher
|
|
355
|
+
*/
|
|
356
|
+
readonly authorization?: string;
|
|
357
|
+
}
|
|
358
|
+
/**
|
|
359
|
+
* Request parameters for getPolicyVoucher operation in PolicyVouchersApi.
|
|
360
|
+
* @export
|
|
361
|
+
* @interface PolicyVouchersApiGetPolicyVoucherRequest
|
|
362
|
+
*/
|
|
363
|
+
export interface PolicyVouchersApiGetPolicyVoucherRequest {
|
|
364
|
+
/**
|
|
365
|
+
* Unique identifier for the object.
|
|
366
|
+
* @type {string}
|
|
367
|
+
* @memberof PolicyVouchersApiGetPolicyVoucher
|
|
368
|
+
*/
|
|
369
|
+
readonly code: string;
|
|
370
|
+
/**
|
|
371
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
372
|
+
* @type {string}
|
|
373
|
+
* @memberof PolicyVouchersApiGetPolicyVoucher
|
|
374
|
+
*/
|
|
375
|
+
readonly authorization?: string;
|
|
376
|
+
/**
|
|
377
|
+
* You can expand policy voucher in this endpoint. By default, campaign and voucher will be expanded fields.
|
|
378
|
+
* @type {'transactions' | 'campaign' | 'voucher'}
|
|
379
|
+
* @memberof PolicyVouchersApiGetPolicyVoucher
|
|
380
|
+
*/
|
|
381
|
+
readonly expand?: 'transactions' | 'campaign' | 'voucher';
|
|
382
|
+
}
|
|
383
|
+
/**
|
|
384
|
+
* Request parameters for listPolicyVouchers operation in PolicyVouchersApi.
|
|
385
|
+
* @export
|
|
386
|
+
* @interface PolicyVouchersApiListPolicyVouchersRequest
|
|
387
|
+
*/
|
|
388
|
+
export interface PolicyVouchersApiListPolicyVouchersRequest {
|
|
389
|
+
/**
|
|
390
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
391
|
+
* @type {string}
|
|
392
|
+
* @memberof PolicyVouchersApiListPolicyVouchers
|
|
393
|
+
*/
|
|
394
|
+
readonly authorization?: string;
|
|
395
|
+
/**
|
|
396
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
397
|
+
* @type {number}
|
|
398
|
+
* @memberof PolicyVouchersApiListPolicyVouchers
|
|
399
|
+
*/
|
|
400
|
+
readonly pageSize?: number;
|
|
401
|
+
/**
|
|
402
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
403
|
+
* @type {string}
|
|
404
|
+
* @memberof PolicyVouchersApiListPolicyVouchers
|
|
405
|
+
*/
|
|
406
|
+
readonly pageToken?: string;
|
|
407
|
+
/**
|
|
408
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, voucherCode, partnerNumber, campaignId, voucherId, productSlug, version, remainingMonths, remainingCredits, yearlyPremium, redeemedAt, createdAt, campaignSlug</i>
|
|
409
|
+
* @type {string}
|
|
410
|
+
* @memberof PolicyVouchersApiListPolicyVouchers
|
|
411
|
+
*/
|
|
412
|
+
readonly filter?: string;
|
|
413
|
+
/**
|
|
414
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: voucherCode, productSlug, partnerNumber</i>
|
|
415
|
+
* @type {string}
|
|
416
|
+
* @memberof PolicyVouchersApiListPolicyVouchers
|
|
417
|
+
*/
|
|
418
|
+
readonly search?: string;
|
|
419
|
+
/**
|
|
420
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, voucherCode, productSlug, partnerNumber, remainingCredits, remainingMonths, yearlyPremium, redeemedAt, createdAt</i>
|
|
421
|
+
* @type {string}
|
|
422
|
+
* @memberof PolicyVouchersApiListPolicyVouchers
|
|
423
|
+
*/
|
|
424
|
+
readonly order?: string;
|
|
425
|
+
/**
|
|
426
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions, campaign, voucher<i>
|
|
427
|
+
* @type {string}
|
|
428
|
+
* @memberof PolicyVouchersApiListPolicyVouchers
|
|
429
|
+
*/
|
|
430
|
+
readonly expand?: string;
|
|
431
|
+
/**
|
|
432
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, voucherCode, partnerNumber, campaignId, voucherId, productSlug, version, remainingMonths, remainingCredits, yearlyPremium, redeemedAt, createdAt, campaignSlug</i>
|
|
433
|
+
* @type {string}
|
|
434
|
+
* @memberof PolicyVouchersApiListPolicyVouchers
|
|
435
|
+
*/
|
|
436
|
+
readonly filters?: string;
|
|
437
|
+
}
|
|
438
|
+
/**
|
|
439
|
+
* Request parameters for redeemPolicyVoucher operation in PolicyVouchersApi.
|
|
440
|
+
* @export
|
|
441
|
+
* @interface PolicyVouchersApiRedeemPolicyVoucherRequest
|
|
442
|
+
*/
|
|
443
|
+
export interface PolicyVouchersApiRedeemPolicyVoucherRequest {
|
|
444
|
+
/**
|
|
445
|
+
*
|
|
446
|
+
* @type {RedeemPolicyVoucherRequestDto}
|
|
447
|
+
* @memberof PolicyVouchersApiRedeemPolicyVoucher
|
|
448
|
+
*/
|
|
449
|
+
readonly redeemPolicyVoucherRequestDto: RedeemPolicyVoucherRequestDto;
|
|
450
|
+
/**
|
|
451
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
452
|
+
* @type {string}
|
|
453
|
+
* @memberof PolicyVouchersApiRedeemPolicyVoucher
|
|
454
|
+
*/
|
|
455
|
+
readonly authorization?: string;
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
* Request parameters for withdrawPolicyVoucher operation in PolicyVouchersApi.
|
|
459
|
+
* @export
|
|
460
|
+
* @interface PolicyVouchersApiWithdrawPolicyVoucherRequest
|
|
461
|
+
*/
|
|
462
|
+
export interface PolicyVouchersApiWithdrawPolicyVoucherRequest {
|
|
463
|
+
/**
|
|
464
|
+
*
|
|
465
|
+
* @type {WithdrawPolicyVoucherRequestDto}
|
|
466
|
+
* @memberof PolicyVouchersApiWithdrawPolicyVoucher
|
|
467
|
+
*/
|
|
468
|
+
readonly withdrawPolicyVoucherRequestDto: WithdrawPolicyVoucherRequestDto;
|
|
469
|
+
/**
|
|
470
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
471
|
+
* @type {string}
|
|
472
|
+
* @memberof PolicyVouchersApiWithdrawPolicyVoucher
|
|
473
|
+
*/
|
|
474
|
+
readonly authorization?: string;
|
|
475
|
+
}
|
|
476
|
+
/**
|
|
477
|
+
* PolicyVouchersApi - object-oriented interface
|
|
478
|
+
* @export
|
|
479
|
+
* @class PolicyVouchersApi
|
|
480
|
+
* @extends {BaseAPI}
|
|
481
|
+
*/
|
|
482
|
+
export declare class PolicyVouchersApi extends BaseAPI {
|
|
483
|
+
/**
|
|
484
|
+
* This will charge the policy voucher.
|
|
485
|
+
* @summary Charges the policy voucher.
|
|
486
|
+
* @param {PolicyVouchersApiChargePolicyVoucherRequest} requestParameters Request parameters.
|
|
487
|
+
* @param {*} [options] Override http request option.
|
|
488
|
+
* @throws {RequiredError}
|
|
489
|
+
* @memberof PolicyVouchersApi
|
|
490
|
+
*/
|
|
491
|
+
chargePolicyVoucher(requestParameters: PolicyVouchersApiChargePolicyVoucherRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChargePolicyVoucherResponseClass, any, {}>>;
|
|
492
|
+
/**
|
|
493
|
+
* This will check if the account is eligible for a specific voucher.
|
|
494
|
+
* @summary Checks the account eligibility.
|
|
495
|
+
* @param {PolicyVouchersApiCheckAccountEligibilityRequest} requestParameters Request parameters.
|
|
496
|
+
* @param {*} [options] Override http request option.
|
|
497
|
+
* @throws {RequiredError}
|
|
498
|
+
* @memberof PolicyVouchersApi
|
|
499
|
+
*/
|
|
500
|
+
checkAccountEligibility(requestParameters: PolicyVouchersApiCheckAccountEligibilityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckAccountEligibilityResponseClass, any, {}>>;
|
|
501
|
+
/**
|
|
502
|
+
* This will create an policy voucher.
|
|
503
|
+
* @summary Create the policy voucher
|
|
504
|
+
* @param {PolicyVouchersApiCreatePolicyVoucherRequest} requestParameters Request parameters.
|
|
505
|
+
* @param {*} [options] Override http request option.
|
|
506
|
+
* @throws {RequiredError}
|
|
507
|
+
* @memberof PolicyVouchersApi
|
|
508
|
+
*/
|
|
509
|
+
createPolicyVoucher(requestParameters: PolicyVouchersApiCreatePolicyVoucherRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePolicyVoucherResponseClass, any, {}>>;
|
|
510
|
+
/**
|
|
511
|
+
* This will delete an policy voucher.
|
|
512
|
+
* @summary Delete the policy voucher
|
|
513
|
+
* @param {PolicyVouchersApiDeletePolicyVoucherRequest} requestParameters Request parameters.
|
|
514
|
+
* @param {*} [options] Override http request option.
|
|
515
|
+
* @throws {RequiredError}
|
|
516
|
+
* @memberof PolicyVouchersApi
|
|
517
|
+
*/
|
|
518
|
+
deletePolicyVoucher(requestParameters: PolicyVouchersApiDeletePolicyVoucherRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
519
|
+
/**
|
|
520
|
+
* This will get an policy voucher.
|
|
521
|
+
* @summary Retrieve the policy voucher
|
|
522
|
+
* @param {PolicyVouchersApiGetPolicyVoucherRequest} requestParameters Request parameters.
|
|
523
|
+
* @param {*} [options] Override http request option.
|
|
524
|
+
* @throws {RequiredError}
|
|
525
|
+
* @memberof PolicyVouchersApi
|
|
526
|
+
*/
|
|
527
|
+
getPolicyVoucher(requestParameters: PolicyVouchersApiGetPolicyVoucherRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPolicyVoucherResponseClass, any, {}>>;
|
|
528
|
+
/**
|
|
529
|
+
* Returns a list of policy vouchers you have previously created. The policy vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
530
|
+
* @summary List policy vouchers
|
|
531
|
+
* @param {PolicyVouchersApiListPolicyVouchersRequest} requestParameters Request parameters.
|
|
532
|
+
* @param {*} [options] Override http request option.
|
|
533
|
+
* @throws {RequiredError}
|
|
534
|
+
* @memberof PolicyVouchersApi
|
|
535
|
+
*/
|
|
536
|
+
listPolicyVouchers(requestParameters?: PolicyVouchersApiListPolicyVouchersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPolicyVouchersResponseClass, any, {}>>;
|
|
537
|
+
/**
|
|
538
|
+
* This will redeem the policy voucher.
|
|
539
|
+
* @summary Redeems the policy voucher.
|
|
540
|
+
* @param {PolicyVouchersApiRedeemPolicyVoucherRequest} requestParameters Request parameters.
|
|
541
|
+
* @param {*} [options] Override http request option.
|
|
542
|
+
* @throws {RequiredError}
|
|
543
|
+
* @memberof PolicyVouchersApi
|
|
544
|
+
*/
|
|
545
|
+
redeemPolicyVoucher(requestParameters: PolicyVouchersApiRedeemPolicyVoucherRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RedeemPolicyVoucherResponseClass, any, {}>>;
|
|
546
|
+
/**
|
|
547
|
+
* This will withdraw the policy voucher.
|
|
548
|
+
* @summary Withdraws the policy voucher.
|
|
549
|
+
* @param {PolicyVouchersApiWithdrawPolicyVoucherRequest} requestParameters Request parameters.
|
|
550
|
+
* @param {*} [options] Override http request option.
|
|
551
|
+
* @throws {RequiredError}
|
|
552
|
+
* @memberof PolicyVouchersApi
|
|
553
|
+
*/
|
|
554
|
+
withdrawPolicyVoucher(requestParameters: PolicyVouchersApiWithdrawPolicyVoucherRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WithdrawPolicyVoucherResponseClass, any, {}>>;
|
|
555
|
+
}
|