@emilgroup/discount-sdk 1.7.0 → 1.8.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/README.md +2 -2
- package/api/campaigns-api.ts +16 -16
- package/api/policy-vouchers-api.ts +12 -12
- package/api/vouchers-api.ts +12 -12
- package/dist/api/campaigns-api.d.ts +16 -16
- package/dist/api/campaigns-api.js +12 -12
- package/dist/api/policy-vouchers-api.d.ts +12 -12
- package/dist/api/policy-vouchers-api.js +10 -10
- package/dist/api/vouchers-api.d.ts +12 -12
- package/dist/api/vouchers-api.js +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/discount-sdk@1.
|
|
20
|
+
npm install @emilgroup/discount-sdk@1.8.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/discount-sdk@1.
|
|
24
|
+
yarn add @emilgroup/discount-sdk@1.8.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `CampaignApi`.
|
package/api/campaigns-api.ts
CHANGED
|
@@ -339,11 +339,11 @@ export const CampaignsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
339
339
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
340
340
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
341
341
|
* @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.
|
|
342
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
342
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
343
343
|
* @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: name, slug</i>
|
|
344
344
|
* @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: name, status, startDate, endDate, createdAt</i>
|
|
345
345
|
* @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/>
|
|
346
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
346
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
347
347
|
* @param {*} [options] Override http request option.
|
|
348
348
|
* @throws {RequiredError}
|
|
349
349
|
*/
|
|
@@ -415,11 +415,11 @@ export const CampaignsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
415
415
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
416
416
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
417
417
|
* @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.
|
|
418
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
418
|
+
* @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, createdAt, updatedAt</i>
|
|
419
419
|
* @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, partnerNumber</i>
|
|
420
420
|
* @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: voucherCode, partnerNumber, createdAt</i>
|
|
421
421
|
* @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/>
|
|
422
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
422
|
+
* @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, createdAt, updatedAt</i>
|
|
423
423
|
* @param {*} [options] Override http request option.
|
|
424
424
|
* @throws {RequiredError}
|
|
425
425
|
*/
|
|
@@ -723,11 +723,11 @@ export const CampaignsApiFp = function(configuration?: Configuration) {
|
|
|
723
723
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
724
724
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
725
725
|
* @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.
|
|
726
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
726
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
727
727
|
* @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: name, slug</i>
|
|
728
728
|
* @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: name, status, startDate, endDate, createdAt</i>
|
|
729
729
|
* @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/>
|
|
730
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
730
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
731
731
|
* @param {*} [options] Override http request option.
|
|
732
732
|
* @throws {RequiredError}
|
|
733
733
|
*/
|
|
@@ -741,11 +741,11 @@ export const CampaignsApiFp = function(configuration?: Configuration) {
|
|
|
741
741
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
742
742
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
743
743
|
* @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.
|
|
744
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
744
|
+
* @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, createdAt, updatedAt</i>
|
|
745
745
|
* @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, partnerNumber</i>
|
|
746
746
|
* @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: voucherCode, partnerNumber, createdAt</i>
|
|
747
747
|
* @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/>
|
|
748
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
748
|
+
* @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, createdAt, updatedAt</i>
|
|
749
749
|
* @param {*} [options] Override http request option.
|
|
750
750
|
* @throws {RequiredError}
|
|
751
751
|
*/
|
|
@@ -876,11 +876,11 @@ export const CampaignsApiFactory = function (configuration?: Configuration, base
|
|
|
876
876
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
877
877
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
878
878
|
* @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.
|
|
879
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
879
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
880
880
|
* @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: name, slug</i>
|
|
881
881
|
* @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: name, status, startDate, endDate, createdAt</i>
|
|
882
882
|
* @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/>
|
|
883
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
883
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
884
884
|
* @param {*} [options] Override http request option.
|
|
885
885
|
* @throws {RequiredError}
|
|
886
886
|
*/
|
|
@@ -893,11 +893,11 @@ export const CampaignsApiFactory = function (configuration?: Configuration, base
|
|
|
893
893
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
894
894
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
895
895
|
* @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.
|
|
896
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
896
|
+
* @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, createdAt, updatedAt</i>
|
|
897
897
|
* @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, partnerNumber</i>
|
|
898
898
|
* @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: voucherCode, partnerNumber, createdAt</i>
|
|
899
899
|
* @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/>
|
|
900
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
900
|
+
* @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, createdAt, updatedAt</i>
|
|
901
901
|
* @param {*} [options] Override http request option.
|
|
902
902
|
* @throws {RequiredError}
|
|
903
903
|
*/
|
|
@@ -1117,7 +1117,7 @@ export interface CampaignsApiListCampaignsRequest {
|
|
|
1117
1117
|
readonly pageToken?: string
|
|
1118
1118
|
|
|
1119
1119
|
/**
|
|
1120
|
-
* Filter the response by one or multiple fields.
|
|
1120
|
+
* 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, name, status, slug, startDate, endDate, createdAt</i>
|
|
1121
1121
|
* @type {string}
|
|
1122
1122
|
* @memberof CampaignsApiListCampaigns
|
|
1123
1123
|
*/
|
|
@@ -1145,7 +1145,7 @@ export interface CampaignsApiListCampaignsRequest {
|
|
|
1145
1145
|
readonly expand?: string
|
|
1146
1146
|
|
|
1147
1147
|
/**
|
|
1148
|
-
* Filters the response by one or multiple fields.
|
|
1148
|
+
* 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, name, status, slug, startDate, endDate, createdAt</i>
|
|
1149
1149
|
* @type {string}
|
|
1150
1150
|
* @memberof CampaignsApiListCampaigns
|
|
1151
1151
|
*/
|
|
@@ -1180,7 +1180,7 @@ export interface CampaignsApiListEligibleAccountsRequest {
|
|
|
1180
1180
|
readonly pageToken?: string
|
|
1181
1181
|
|
|
1182
1182
|
/**
|
|
1183
|
-
* Filter the response by one or multiple fields.
|
|
1183
|
+
* 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, createdAt, updatedAt</i>
|
|
1184
1184
|
* @type {string}
|
|
1185
1185
|
* @memberof CampaignsApiListEligibleAccounts
|
|
1186
1186
|
*/
|
|
@@ -1208,7 +1208,7 @@ export interface CampaignsApiListEligibleAccountsRequest {
|
|
|
1208
1208
|
readonly expand?: string
|
|
1209
1209
|
|
|
1210
1210
|
/**
|
|
1211
|
-
* Filters the response by one or multiple fields.
|
|
1211
|
+
* 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, createdAt, updatedAt</i>
|
|
1212
1212
|
* @type {string}
|
|
1213
1213
|
* @memberof CampaignsApiListEligibleAccounts
|
|
1214
1214
|
*/
|
|
@@ -287,16 +287,16 @@ export const PolicyVouchersApiAxiosParamCreator = function (configuration?: Conf
|
|
|
287
287
|
};
|
|
288
288
|
},
|
|
289
289
|
/**
|
|
290
|
-
* Returns a list of policy vouchers you have previously created.
|
|
290
|
+
* 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.
|
|
291
291
|
* @summary List policy vouchers
|
|
292
292
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
293
293
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
294
294
|
* @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.
|
|
295
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
295
|
+
* @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>
|
|
296
296
|
* @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>
|
|
297
297
|
* @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>
|
|
298
298
|
* @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>
|
|
299
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
299
|
+
* @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>
|
|
300
300
|
* @param {*} [options] Override http request option.
|
|
301
301
|
* @throws {RequiredError}
|
|
302
302
|
*/
|
|
@@ -528,16 +528,16 @@ export const PolicyVouchersApiFp = function(configuration?: Configuration) {
|
|
|
528
528
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
529
529
|
},
|
|
530
530
|
/**
|
|
531
|
-
* Returns a list of policy vouchers you have previously created.
|
|
531
|
+
* 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.
|
|
532
532
|
* @summary List policy vouchers
|
|
533
533
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
534
534
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
535
535
|
* @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.
|
|
536
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
536
|
+
* @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>
|
|
537
537
|
* @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>
|
|
538
538
|
* @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>
|
|
539
539
|
* @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>
|
|
540
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
540
|
+
* @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>
|
|
541
541
|
* @param {*} [options] Override http request option.
|
|
542
542
|
* @throws {RequiredError}
|
|
543
543
|
*/
|
|
@@ -636,16 +636,16 @@ export const PolicyVouchersApiFactory = function (configuration?: Configuration,
|
|
|
636
636
|
return localVarFp.getPolicyVoucher(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
637
637
|
},
|
|
638
638
|
/**
|
|
639
|
-
* Returns a list of policy vouchers you have previously created.
|
|
639
|
+
* 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.
|
|
640
640
|
* @summary List policy vouchers
|
|
641
641
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
642
642
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
643
643
|
* @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.
|
|
644
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
644
|
+
* @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>
|
|
645
645
|
* @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>
|
|
646
646
|
* @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>
|
|
647
647
|
* @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>
|
|
648
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
648
|
+
* @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>
|
|
649
649
|
* @param {*} [options] Override http request option.
|
|
650
650
|
* @throws {RequiredError}
|
|
651
651
|
*/
|
|
@@ -817,7 +817,7 @@ export interface PolicyVouchersApiListPolicyVouchersRequest {
|
|
|
817
817
|
readonly pageToken?: string
|
|
818
818
|
|
|
819
819
|
/**
|
|
820
|
-
* Filter the response by one or multiple fields.
|
|
820
|
+
* 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>
|
|
821
821
|
* @type {string}
|
|
822
822
|
* @memberof PolicyVouchersApiListPolicyVouchers
|
|
823
823
|
*/
|
|
@@ -845,7 +845,7 @@ export interface PolicyVouchersApiListPolicyVouchersRequest {
|
|
|
845
845
|
readonly expand?: string
|
|
846
846
|
|
|
847
847
|
/**
|
|
848
|
-
* Filters the response by one or multiple fields.
|
|
848
|
+
* 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>
|
|
849
849
|
* @type {string}
|
|
850
850
|
* @memberof PolicyVouchersApiListPolicyVouchers
|
|
851
851
|
*/
|
|
@@ -962,7 +962,7 @@ export class PolicyVouchersApi extends BaseAPI {
|
|
|
962
962
|
}
|
|
963
963
|
|
|
964
964
|
/**
|
|
965
|
-
* Returns a list of policy vouchers you have previously created.
|
|
965
|
+
* 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.
|
|
966
966
|
* @summary List policy vouchers
|
|
967
967
|
* @param {PolicyVouchersApiListPolicyVouchersRequest} requestParameters Request parameters.
|
|
968
968
|
* @param {*} [options] Override http request option.
|
package/api/vouchers-api.ts
CHANGED
|
@@ -181,16 +181,16 @@ export const VouchersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
181
181
|
};
|
|
182
182
|
},
|
|
183
183
|
/**
|
|
184
|
-
* Returns a list of Vouchers you have previously created.
|
|
184
|
+
* Returns a list of Vouchers you have previously created. The Vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
185
185
|
* @summary List Vouchers
|
|
186
186
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
187
187
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
188
188
|
* @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.
|
|
189
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
189
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
190
190
|
* @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: code, voucherCode, productSlugsList</i>
|
|
191
191
|
* @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: code, voucherCode, campaignId, discountPeriodMonths, discountType, discountValue, createdAt</i>
|
|
192
192
|
* @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: campaign, productDiscounts<i>
|
|
193
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
193
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
194
194
|
* @param {*} [options] Override http request option.
|
|
195
195
|
* @throws {RequiredError}
|
|
196
196
|
*/
|
|
@@ -355,16 +355,16 @@ export const VouchersApiFp = function(configuration?: Configuration) {
|
|
|
355
355
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
356
356
|
},
|
|
357
357
|
/**
|
|
358
|
-
* Returns a list of Vouchers you have previously created.
|
|
358
|
+
* Returns a list of Vouchers you have previously created. The Vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
359
359
|
* @summary List Vouchers
|
|
360
360
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
361
361
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
362
362
|
* @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.
|
|
363
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
363
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
364
364
|
* @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: code, voucherCode, productSlugsList</i>
|
|
365
365
|
* @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: code, voucherCode, campaignId, discountPeriodMonths, discountType, discountValue, createdAt</i>
|
|
366
366
|
* @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: campaign, productDiscounts<i>
|
|
367
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
367
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
368
368
|
* @param {*} [options] Override http request option.
|
|
369
369
|
* @throws {RequiredError}
|
|
370
370
|
*/
|
|
@@ -430,16 +430,16 @@ export const VouchersApiFactory = function (configuration?: Configuration, baseP
|
|
|
430
430
|
return localVarFp.getVoucher(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
431
431
|
},
|
|
432
432
|
/**
|
|
433
|
-
* Returns a list of Vouchers you have previously created.
|
|
433
|
+
* Returns a list of Vouchers you have previously created. The Vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
434
434
|
* @summary List Vouchers
|
|
435
435
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
436
436
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
437
437
|
* @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.
|
|
438
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
438
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
439
439
|
* @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: code, voucherCode, productSlugsList</i>
|
|
440
440
|
* @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: code, voucherCode, campaignId, discountPeriodMonths, discountType, discountValue, createdAt</i>
|
|
441
441
|
* @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: campaign, productDiscounts<i>
|
|
442
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
442
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
443
443
|
* @param {*} [options] Override http request option.
|
|
444
444
|
* @throws {RequiredError}
|
|
445
445
|
*/
|
|
@@ -559,7 +559,7 @@ export interface VouchersApiListVouchersRequest {
|
|
|
559
559
|
readonly pageToken?: string
|
|
560
560
|
|
|
561
561
|
/**
|
|
562
|
-
* Filter the response by one or multiple fields.
|
|
562
|
+
* 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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
563
563
|
* @type {string}
|
|
564
564
|
* @memberof VouchersApiListVouchers
|
|
565
565
|
*/
|
|
@@ -587,7 +587,7 @@ export interface VouchersApiListVouchersRequest {
|
|
|
587
587
|
readonly expand?: string
|
|
588
588
|
|
|
589
589
|
/**
|
|
590
|
-
* Filters the response by one or multiple fields.
|
|
590
|
+
* 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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
591
591
|
* @type {string}
|
|
592
592
|
* @memberof VouchersApiListVouchers
|
|
593
593
|
*/
|
|
@@ -666,7 +666,7 @@ export class VouchersApi extends BaseAPI {
|
|
|
666
666
|
}
|
|
667
667
|
|
|
668
668
|
/**
|
|
669
|
-
* Returns a list of Vouchers you have previously created.
|
|
669
|
+
* Returns a list of Vouchers you have previously created. The Vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
670
670
|
* @summary List Vouchers
|
|
671
671
|
* @param {VouchersApiListVouchersRequest} requestParameters Request parameters.
|
|
672
672
|
* @param {*} [options] Override http request option.
|
|
@@ -90,11 +90,11 @@ export declare const CampaignsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
90
90
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
91
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
92
92
|
* @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.
|
|
93
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
93
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
94
94
|
* @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: name, slug</i>
|
|
95
95
|
* @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: name, status, startDate, endDate, createdAt</i>
|
|
96
96
|
* @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/>
|
|
97
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
97
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
98
98
|
* @param {*} [options] Override http request option.
|
|
99
99
|
* @throws {RequiredError}
|
|
100
100
|
*/
|
|
@@ -105,11 +105,11 @@ export declare const CampaignsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
105
105
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
106
106
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
107
107
|
* @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.
|
|
108
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
108
|
+
* @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, createdAt, updatedAt</i>
|
|
109
109
|
* @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, partnerNumber</i>
|
|
110
110
|
* @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: voucherCode, partnerNumber, createdAt</i>
|
|
111
111
|
* @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/>
|
|
112
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
112
|
+
* @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, createdAt, updatedAt</i>
|
|
113
113
|
* @param {*} [options] Override http request option.
|
|
114
114
|
* @throws {RequiredError}
|
|
115
115
|
*/
|
|
@@ -212,11 +212,11 @@ export declare const CampaignsApiFp: (configuration?: Configuration) => {
|
|
|
212
212
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
213
213
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
214
214
|
* @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.
|
|
215
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
215
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
216
216
|
* @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: name, slug</i>
|
|
217
217
|
* @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: name, status, startDate, endDate, createdAt</i>
|
|
218
218
|
* @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/>
|
|
219
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
219
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
220
220
|
* @param {*} [options] Override http request option.
|
|
221
221
|
* @throws {RequiredError}
|
|
222
222
|
*/
|
|
@@ -227,11 +227,11 @@ export declare const CampaignsApiFp: (configuration?: Configuration) => {
|
|
|
227
227
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
228
228
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
229
229
|
* @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.
|
|
230
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
230
|
+
* @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, createdAt, updatedAt</i>
|
|
231
231
|
* @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, partnerNumber</i>
|
|
232
232
|
* @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: voucherCode, partnerNumber, createdAt</i>
|
|
233
233
|
* @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/>
|
|
234
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
234
|
+
* @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, createdAt, updatedAt</i>
|
|
235
235
|
* @param {*} [options] Override http request option.
|
|
236
236
|
* @throws {RequiredError}
|
|
237
237
|
*/
|
|
@@ -334,11 +334,11 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
334
334
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
335
335
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
336
336
|
* @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.
|
|
337
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
337
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
338
338
|
* @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: name, slug</i>
|
|
339
339
|
* @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: name, status, startDate, endDate, createdAt</i>
|
|
340
340
|
* @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/>
|
|
341
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
341
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
342
342
|
* @param {*} [options] Override http request option.
|
|
343
343
|
* @throws {RequiredError}
|
|
344
344
|
*/
|
|
@@ -349,11 +349,11 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
349
349
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
350
350
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
351
351
|
* @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.
|
|
352
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
352
|
+
* @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, createdAt, updatedAt</i>
|
|
353
353
|
* @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, partnerNumber</i>
|
|
354
354
|
* @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: voucherCode, partnerNumber, createdAt</i>
|
|
355
355
|
* @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/>
|
|
356
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
356
|
+
* @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, createdAt, updatedAt</i>
|
|
357
357
|
* @param {*} [options] Override http request option.
|
|
358
358
|
* @throws {RequiredError}
|
|
359
359
|
*/
|
|
@@ -545,7 +545,7 @@ export interface CampaignsApiListCampaignsRequest {
|
|
|
545
545
|
*/
|
|
546
546
|
readonly pageToken?: string;
|
|
547
547
|
/**
|
|
548
|
-
* Filter the response by one or multiple fields.
|
|
548
|
+
* 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, name, status, slug, startDate, endDate, createdAt</i>
|
|
549
549
|
* @type {string}
|
|
550
550
|
* @memberof CampaignsApiListCampaigns
|
|
551
551
|
*/
|
|
@@ -569,7 +569,7 @@ export interface CampaignsApiListCampaignsRequest {
|
|
|
569
569
|
*/
|
|
570
570
|
readonly expand?: string;
|
|
571
571
|
/**
|
|
572
|
-
* Filters the response by one or multiple fields.
|
|
572
|
+
* 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, name, status, slug, startDate, endDate, createdAt</i>
|
|
573
573
|
* @type {string}
|
|
574
574
|
* @memberof CampaignsApiListCampaigns
|
|
575
575
|
*/
|
|
@@ -600,7 +600,7 @@ export interface CampaignsApiListEligibleAccountsRequest {
|
|
|
600
600
|
*/
|
|
601
601
|
readonly pageToken?: string;
|
|
602
602
|
/**
|
|
603
|
-
* Filter the response by one or multiple fields.
|
|
603
|
+
* 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, createdAt, updatedAt</i>
|
|
604
604
|
* @type {string}
|
|
605
605
|
* @memberof CampaignsApiListEligibleAccounts
|
|
606
606
|
*/
|
|
@@ -624,7 +624,7 @@ export interface CampaignsApiListEligibleAccountsRequest {
|
|
|
624
624
|
*/
|
|
625
625
|
readonly expand?: string;
|
|
626
626
|
/**
|
|
627
|
-
* Filters the response by one or multiple fields.
|
|
627
|
+
* 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, createdAt, updatedAt</i>
|
|
628
628
|
* @type {string}
|
|
629
629
|
* @memberof CampaignsApiListEligibleAccounts
|
|
630
630
|
*/
|
|
@@ -400,11 +400,11 @@ var CampaignsApiAxiosParamCreator = function (configuration) {
|
|
|
400
400
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
401
401
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
402
402
|
* @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.
|
|
403
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
403
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
404
404
|
* @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: name, slug</i>
|
|
405
405
|
* @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: name, status, startDate, endDate, createdAt</i>
|
|
406
406
|
* @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/>
|
|
407
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
407
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
408
408
|
* @param {*} [options] Override http request option.
|
|
409
409
|
* @throws {RequiredError}
|
|
410
410
|
*/
|
|
@@ -472,11 +472,11 @@ var CampaignsApiAxiosParamCreator = function (configuration) {
|
|
|
472
472
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
473
473
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
474
474
|
* @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.
|
|
475
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
475
|
+
* @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, createdAt, updatedAt</i>
|
|
476
476
|
* @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, partnerNumber</i>
|
|
477
477
|
* @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: voucherCode, partnerNumber, createdAt</i>
|
|
478
478
|
* @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/>
|
|
479
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
479
|
+
* @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, createdAt, updatedAt</i>
|
|
480
480
|
* @param {*} [options] Override http request option.
|
|
481
481
|
* @throws {RequiredError}
|
|
482
482
|
*/
|
|
@@ -837,11 +837,11 @@ var CampaignsApiFp = function (configuration) {
|
|
|
837
837
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
838
838
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
839
839
|
* @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.
|
|
840
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
840
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
841
841
|
* @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: name, slug</i>
|
|
842
842
|
* @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: name, status, startDate, endDate, createdAt</i>
|
|
843
843
|
* @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/>
|
|
844
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
844
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
845
845
|
* @param {*} [options] Override http request option.
|
|
846
846
|
* @throws {RequiredError}
|
|
847
847
|
*/
|
|
@@ -864,11 +864,11 @@ var CampaignsApiFp = function (configuration) {
|
|
|
864
864
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
865
865
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
866
866
|
* @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.
|
|
867
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
867
|
+
* @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, createdAt, updatedAt</i>
|
|
868
868
|
* @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, partnerNumber</i>
|
|
869
869
|
* @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: voucherCode, partnerNumber, createdAt</i>
|
|
870
870
|
* @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/>
|
|
871
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
871
|
+
* @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, createdAt, updatedAt</i>
|
|
872
872
|
* @param {*} [options] Override http request option.
|
|
873
873
|
* @throws {RequiredError}
|
|
874
874
|
*/
|
|
@@ -1035,11 +1035,11 @@ var CampaignsApiFactory = function (configuration, basePath, axios) {
|
|
|
1035
1035
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1036
1036
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1037
1037
|
* @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.
|
|
1038
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1038
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
1039
1039
|
* @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: name, slug</i>
|
|
1040
1040
|
* @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: name, status, startDate, endDate, createdAt</i>
|
|
1041
1041
|
* @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/>
|
|
1042
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1042
|
+
* @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, name, status, slug, startDate, endDate, createdAt</i>
|
|
1043
1043
|
* @param {*} [options] Override http request option.
|
|
1044
1044
|
* @throws {RequiredError}
|
|
1045
1045
|
*/
|
|
@@ -1052,11 +1052,11 @@ var CampaignsApiFactory = function (configuration, basePath, axios) {
|
|
|
1052
1052
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1053
1053
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1054
1054
|
* @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.
|
|
1055
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1055
|
+
* @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, createdAt, updatedAt</i>
|
|
1056
1056
|
* @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, partnerNumber</i>
|
|
1057
1057
|
* @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: voucherCode, partnerNumber, createdAt</i>
|
|
1058
1058
|
* @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/>
|
|
1059
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1059
|
+
* @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, createdAt, updatedAt</i>
|
|
1060
1060
|
* @param {*} [options] Override http request option.
|
|
1061
1061
|
* @throws {RequiredError}
|
|
1062
1062
|
*/
|
|
@@ -76,16 +76,16 @@ export declare const PolicyVouchersApiAxiosParamCreator: (configuration?: Config
|
|
|
76
76
|
*/
|
|
77
77
|
getPolicyVoucher: (code: string, authorization?: string, expand?: 'transactions' | 'campaign' | 'voucher', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
78
|
/**
|
|
79
|
-
* Returns a list of policy vouchers you have previously created.
|
|
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
80
|
* @summary List policy vouchers
|
|
81
81
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
82
82
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
83
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.
|
|
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
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
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
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.
|
|
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
89
|
* @param {*} [options] Override http request option.
|
|
90
90
|
* @throws {RequiredError}
|
|
91
91
|
*/
|
|
@@ -161,16 +161,16 @@ export declare const PolicyVouchersApiFp: (configuration?: Configuration) => {
|
|
|
161
161
|
*/
|
|
162
162
|
getPolicyVoucher(code: string, authorization?: string, expand?: 'transactions' | 'campaign' | 'voucher', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPolicyVoucherResponseClass>>;
|
|
163
163
|
/**
|
|
164
|
-
* Returns a list of policy vouchers you have previously created.
|
|
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
165
|
* @summary List policy vouchers
|
|
166
166
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
167
167
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
168
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.
|
|
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
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
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
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.
|
|
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
174
|
* @param {*} [options] Override http request option.
|
|
175
175
|
* @throws {RequiredError}
|
|
176
176
|
*/
|
|
@@ -246,16 +246,16 @@ export declare const PolicyVouchersApiFactory: (configuration?: Configuration, b
|
|
|
246
246
|
*/
|
|
247
247
|
getPolicyVoucher(code: string, authorization?: string, expand?: 'transactions' | 'campaign' | 'voucher', options?: any): AxiosPromise<GetPolicyVoucherResponseClass>;
|
|
248
248
|
/**
|
|
249
|
-
* Returns a list of policy vouchers you have previously created.
|
|
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
250
|
* @summary List policy vouchers
|
|
251
251
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
252
252
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
253
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.
|
|
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
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
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
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.
|
|
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
259
|
* @param {*} [options] Override http request option.
|
|
260
260
|
* @throws {RequiredError}
|
|
261
261
|
*/
|
|
@@ -405,7 +405,7 @@ export interface PolicyVouchersApiListPolicyVouchersRequest {
|
|
|
405
405
|
*/
|
|
406
406
|
readonly pageToken?: string;
|
|
407
407
|
/**
|
|
408
|
-
* Filter the response by one or multiple fields.
|
|
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
409
|
* @type {string}
|
|
410
410
|
* @memberof PolicyVouchersApiListPolicyVouchers
|
|
411
411
|
*/
|
|
@@ -429,7 +429,7 @@ export interface PolicyVouchersApiListPolicyVouchersRequest {
|
|
|
429
429
|
*/
|
|
430
430
|
readonly expand?: string;
|
|
431
431
|
/**
|
|
432
|
-
* Filters the response by one or multiple fields.
|
|
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
433
|
* @type {string}
|
|
434
434
|
* @memberof PolicyVouchersApiListPolicyVouchers
|
|
435
435
|
*/
|
|
@@ -526,7 +526,7 @@ export declare class PolicyVouchersApi extends BaseAPI {
|
|
|
526
526
|
*/
|
|
527
527
|
getPolicyVoucher(requestParameters: PolicyVouchersApiGetPolicyVoucherRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPolicyVoucherResponseClass, any, {}>>;
|
|
528
528
|
/**
|
|
529
|
-
* Returns a list of policy vouchers you have previously created.
|
|
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
530
|
* @summary List policy vouchers
|
|
531
531
|
* @param {PolicyVouchersApiListPolicyVouchersRequest} requestParameters Request parameters.
|
|
532
532
|
* @param {*} [options] Override http request option.
|
|
@@ -340,16 +340,16 @@ var PolicyVouchersApiAxiosParamCreator = function (configuration) {
|
|
|
340
340
|
});
|
|
341
341
|
},
|
|
342
342
|
/**
|
|
343
|
-
* Returns a list of policy vouchers you have previously created.
|
|
343
|
+
* 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.
|
|
344
344
|
* @summary List policy vouchers
|
|
345
345
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
346
346
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
347
347
|
* @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.
|
|
348
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
348
|
+
* @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>
|
|
349
349
|
* @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>
|
|
350
350
|
* @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>
|
|
351
351
|
* @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>
|
|
352
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
352
|
+
* @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>
|
|
353
353
|
* @param {*} [options] Override http request option.
|
|
354
354
|
* @throws {RequiredError}
|
|
355
355
|
*/
|
|
@@ -626,16 +626,16 @@ var PolicyVouchersApiFp = function (configuration) {
|
|
|
626
626
|
});
|
|
627
627
|
},
|
|
628
628
|
/**
|
|
629
|
-
* Returns a list of policy vouchers you have previously created.
|
|
629
|
+
* 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.
|
|
630
630
|
* @summary List policy vouchers
|
|
631
631
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
632
632
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
633
633
|
* @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.
|
|
634
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
634
|
+
* @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>
|
|
635
635
|
* @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>
|
|
636
636
|
* @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>
|
|
637
637
|
* @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>
|
|
638
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
638
|
+
* @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>
|
|
639
639
|
* @param {*} [options] Override http request option.
|
|
640
640
|
* @throws {RequiredError}
|
|
641
641
|
*/
|
|
@@ -761,16 +761,16 @@ var PolicyVouchersApiFactory = function (configuration, basePath, axios) {
|
|
|
761
761
|
return localVarFp.getPolicyVoucher(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
762
762
|
},
|
|
763
763
|
/**
|
|
764
|
-
* Returns a list of policy vouchers you have previously created.
|
|
764
|
+
* 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.
|
|
765
765
|
* @summary List policy vouchers
|
|
766
766
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
767
767
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
768
768
|
* @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.
|
|
769
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
769
|
+
* @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>
|
|
770
770
|
* @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>
|
|
771
771
|
* @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>
|
|
772
772
|
* @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>
|
|
773
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
773
|
+
* @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>
|
|
774
774
|
* @param {*} [options] Override http request option.
|
|
775
775
|
* @throws {RequiredError}
|
|
776
776
|
*/
|
|
@@ -874,7 +874,7 @@ var PolicyVouchersApi = /** @class */ (function (_super) {
|
|
|
874
874
|
return (0, exports.PolicyVouchersApiFp)(this.configuration).getPolicyVoucher(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
875
875
|
};
|
|
876
876
|
/**
|
|
877
|
-
* Returns a list of policy vouchers you have previously created.
|
|
877
|
+
* 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.
|
|
878
878
|
* @summary List policy vouchers
|
|
879
879
|
* @param {PolicyVouchersApiListPolicyVouchersRequest} requestParameters Request parameters.
|
|
880
880
|
* @param {*} [options] Override http request option.
|
|
@@ -52,16 +52,16 @@ export declare const VouchersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
52
52
|
*/
|
|
53
53
|
getVoucher: (code: string, authorization?: string, expand?: 'campaign' | 'productDiscounts', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
54
|
/**
|
|
55
|
-
* Returns a list of Vouchers you have previously created.
|
|
55
|
+
* Returns a list of Vouchers you have previously created. The Vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
56
56
|
* @summary List Vouchers
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
59
|
* @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.
|
|
60
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
60
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
61
61
|
* @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: code, voucherCode, productSlugsList</i>
|
|
62
62
|
* @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: code, voucherCode, campaignId, discountPeriodMonths, discountType, discountValue, createdAt</i>
|
|
63
63
|
* @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: campaign, productDiscounts<i>
|
|
64
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
64
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
*/
|
|
@@ -111,16 +111,16 @@ export declare const VouchersApiFp: (configuration?: Configuration) => {
|
|
|
111
111
|
*/
|
|
112
112
|
getVoucher(code: string, authorization?: string, expand?: 'campaign' | 'productDiscounts', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetVoucherResponseClass>>;
|
|
113
113
|
/**
|
|
114
|
-
* Returns a list of Vouchers you have previously created.
|
|
114
|
+
* Returns a list of Vouchers you have previously created. The Vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
115
115
|
* @summary List Vouchers
|
|
116
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
117
117
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
118
|
* @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.
|
|
119
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
119
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
120
120
|
* @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: code, voucherCode, productSlugsList</i>
|
|
121
121
|
* @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: code, voucherCode, campaignId, discountPeriodMonths, discountType, discountValue, createdAt</i>
|
|
122
122
|
* @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: campaign, productDiscounts<i>
|
|
123
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
123
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
124
124
|
* @param {*} [options] Override http request option.
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
@@ -170,16 +170,16 @@ export declare const VouchersApiFactory: (configuration?: Configuration, basePat
|
|
|
170
170
|
*/
|
|
171
171
|
getVoucher(code: string, authorization?: string, expand?: 'campaign' | 'productDiscounts', options?: any): AxiosPromise<GetVoucherResponseClass>;
|
|
172
172
|
/**
|
|
173
|
-
* Returns a list of Vouchers you have previously created.
|
|
173
|
+
* Returns a list of Vouchers you have previously created. The Vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
174
174
|
* @summary List Vouchers
|
|
175
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
176
176
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
177
|
* @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.
|
|
178
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
178
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
179
179
|
* @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: code, voucherCode, productSlugsList</i>
|
|
180
180
|
* @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: code, voucherCode, campaignId, discountPeriodMonths, discountType, discountValue, createdAt</i>
|
|
181
181
|
* @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: campaign, productDiscounts<i>
|
|
182
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
182
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
@@ -283,7 +283,7 @@ export interface VouchersApiListVouchersRequest {
|
|
|
283
283
|
*/
|
|
284
284
|
readonly pageToken?: string;
|
|
285
285
|
/**
|
|
286
|
-
* Filter the response by one or multiple fields.
|
|
286
|
+
* 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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
287
287
|
* @type {string}
|
|
288
288
|
* @memberof VouchersApiListVouchers
|
|
289
289
|
*/
|
|
@@ -307,7 +307,7 @@ export interface VouchersApiListVouchersRequest {
|
|
|
307
307
|
*/
|
|
308
308
|
readonly expand?: string;
|
|
309
309
|
/**
|
|
310
|
-
* Filters the response by one or multiple fields.
|
|
310
|
+
* 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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
311
311
|
* @type {string}
|
|
312
312
|
* @memberof VouchersApiListVouchers
|
|
313
313
|
*/
|
|
@@ -373,7 +373,7 @@ export declare class VouchersApi extends BaseAPI {
|
|
|
373
373
|
*/
|
|
374
374
|
getVoucher(requestParameters: VouchersApiGetVoucherRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetVoucherResponseClass, any, {}>>;
|
|
375
375
|
/**
|
|
376
|
-
* Returns a list of Vouchers you have previously created.
|
|
376
|
+
* Returns a list of Vouchers you have previously created. The Vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
377
377
|
* @summary List Vouchers
|
|
378
378
|
* @param {VouchersApiListVouchersRequest} requestParameters Request parameters.
|
|
379
379
|
* @param {*} [options] Override http request option.
|
package/dist/api/vouchers-api.js
CHANGED
|
@@ -242,16 +242,16 @@ var VouchersApiAxiosParamCreator = function (configuration) {
|
|
|
242
242
|
});
|
|
243
243
|
},
|
|
244
244
|
/**
|
|
245
|
-
* Returns a list of Vouchers you have previously created.
|
|
245
|
+
* Returns a list of Vouchers you have previously created. The Vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
246
246
|
* @summary List Vouchers
|
|
247
247
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
248
248
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
249
249
|
* @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.
|
|
250
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
250
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
251
251
|
* @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: code, voucherCode, productSlugsList</i>
|
|
252
252
|
* @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: code, voucherCode, campaignId, discountPeriodMonths, discountType, discountValue, createdAt</i>
|
|
253
253
|
* @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: campaign, productDiscounts<i>
|
|
254
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
254
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
255
255
|
* @param {*} [options] Override http request option.
|
|
256
256
|
* @throws {RequiredError}
|
|
257
257
|
*/
|
|
@@ -441,16 +441,16 @@ var VouchersApiFp = function (configuration) {
|
|
|
441
441
|
});
|
|
442
442
|
},
|
|
443
443
|
/**
|
|
444
|
-
* Returns a list of Vouchers you have previously created.
|
|
444
|
+
* Returns a list of Vouchers you have previously created. The Vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
445
445
|
* @summary List Vouchers
|
|
446
446
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
447
447
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
448
448
|
* @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.
|
|
449
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
449
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
450
450
|
* @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: code, voucherCode, productSlugsList</i>
|
|
451
451
|
* @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: code, voucherCode, campaignId, discountPeriodMonths, discountType, discountValue, createdAt</i>
|
|
452
452
|
* @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: campaign, productDiscounts<i>
|
|
453
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
453
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
454
454
|
* @param {*} [options] Override http request option.
|
|
455
455
|
* @throws {RequiredError}
|
|
456
456
|
*/
|
|
@@ -534,16 +534,16 @@ var VouchersApiFactory = function (configuration, basePath, axios) {
|
|
|
534
534
|
return localVarFp.getVoucher(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
535
535
|
},
|
|
536
536
|
/**
|
|
537
|
-
* Returns a list of Vouchers you have previously created.
|
|
537
|
+
* Returns a list of Vouchers you have previously created. The Vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
538
538
|
* @summary List Vouchers
|
|
539
539
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
540
540
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
541
541
|
* @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.
|
|
542
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
542
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
543
543
|
* @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: code, voucherCode, productSlugsList</i>
|
|
544
544
|
* @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: code, voucherCode, campaignId, discountPeriodMonths, discountType, discountValue, createdAt</i>
|
|
545
545
|
* @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: campaign, productDiscounts<i>
|
|
546
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
546
|
+
* @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, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug</i>
|
|
547
547
|
* @param {*} [options] Override http request option.
|
|
548
548
|
* @throws {RequiredError}
|
|
549
549
|
*/
|
|
@@ -613,7 +613,7 @@ var VouchersApi = /** @class */ (function (_super) {
|
|
|
613
613
|
return (0, exports.VouchersApiFp)(this.configuration).getVoucher(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
614
614
|
};
|
|
615
615
|
/**
|
|
616
|
-
* Returns a list of Vouchers you have previously created.
|
|
616
|
+
* Returns a list of Vouchers you have previously created. The Vouchers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
617
617
|
* @summary List Vouchers
|
|
618
618
|
* @param {VouchersApiListVouchersRequest} requestParameters Request parameters.
|
|
619
619
|
* @param {*} [options] Override http request option.
|