@emilgroup/discount-sdk 1.5.1 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (150) hide show
  1. package/.openapi-generator/FILES +54 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +2 -2
  5. package/api/campaigns-api.ts +1433 -0
  6. package/api/default-api.ts +124 -0
  7. package/api/policy-vouchers-api.ts +999 -0
  8. package/api/vouchers-api.ts +691 -0
  9. package/api.ts +33 -0
  10. package/base.ts +331 -0
  11. package/common.ts +198 -0
  12. package/configuration.ts +110 -0
  13. package/dist/api/campaigns-api.d.ts +808 -0
  14. package/dist/api/campaigns-api.js +1251 -0
  15. package/dist/api/default-api.d.ts +70 -0
  16. package/dist/api/default-api.js +200 -0
  17. package/dist/api/policy-vouchers-api.d.ts +555 -0
  18. package/dist/api/policy-vouchers-api.js +915 -0
  19. package/dist/api/vouchers-api.d.ts +393 -0
  20. package/dist/api/vouchers-api.js +642 -0
  21. package/dist/api.d.ts +15 -0
  22. package/dist/api.js +33 -0
  23. package/dist/base.d.ts +86 -0
  24. package/dist/base.js +367 -0
  25. package/dist/common.d.ts +91 -0
  26. package/dist/common.js +276 -0
  27. package/dist/configuration.d.ts +89 -0
  28. package/dist/configuration.js +52 -0
  29. package/dist/index.d.ts +15 -0
  30. package/dist/index.js +36 -0
  31. package/dist/models/campaign-class.d.ts +105 -0
  32. package/dist/models/campaign-class.js +24 -0
  33. package/dist/models/charge-policy-voucher-request-dto.d.ts +48 -0
  34. package/dist/models/charge-policy-voucher-request-dto.js +15 -0
  35. package/dist/models/charge-policy-voucher-response-class.d.ts +96 -0
  36. package/dist/models/charge-policy-voucher-response-class.js +21 -0
  37. package/dist/models/check-account-eligibility-request-dto.d.ts +48 -0
  38. package/dist/models/check-account-eligibility-request-dto.js +15 -0
  39. package/dist/models/check-account-eligibility-response-class.d.ts +57 -0
  40. package/dist/models/check-account-eligibility-response-class.js +24 -0
  41. package/dist/models/create-campaign-request-dto.d.ts +42 -0
  42. package/dist/models/create-campaign-request-dto.js +15 -0
  43. package/dist/models/create-campaign-response-class.d.ts +25 -0
  44. package/dist/models/create-campaign-response-class.js +15 -0
  45. package/dist/models/create-eligible-account-request-dto.d.ts +30 -0
  46. package/dist/models/create-eligible-account-request-dto.js +15 -0
  47. package/dist/models/create-eligible-account-response-class.d.ts +25 -0
  48. package/dist/models/create-eligible-account-response-class.js +15 -0
  49. package/dist/models/create-policy-voucher-request-dto.d.ts +48 -0
  50. package/dist/models/create-policy-voucher-request-dto.js +15 -0
  51. package/dist/models/create-policy-voucher-response-class.d.ts +25 -0
  52. package/dist/models/create-policy-voucher-response-class.js +15 -0
  53. package/dist/models/create-product-discount-dto.d.ts +48 -0
  54. package/dist/models/create-product-discount-dto.js +15 -0
  55. package/dist/models/create-voucher-request-dto.d.ts +66 -0
  56. package/dist/models/create-voucher-request-dto.js +20 -0
  57. package/dist/models/create-voucher-response-class.d.ts +25 -0
  58. package/dist/models/create-voucher-response-class.js +15 -0
  59. package/dist/models/eligible-account-class.d.ts +78 -0
  60. package/dist/models/eligible-account-class.js +15 -0
  61. package/dist/models/get-campaign-response-class.d.ts +25 -0
  62. package/dist/models/get-campaign-response-class.js +15 -0
  63. package/dist/models/get-policy-voucher-response-class.d.ts +25 -0
  64. package/dist/models/get-policy-voucher-response-class.js +15 -0
  65. package/dist/models/get-voucher-response-class.d.ts +25 -0
  66. package/dist/models/get-voucher-response-class.js +15 -0
  67. package/dist/models/index.d.ts +37 -0
  68. package/dist/models/index.js +53 -0
  69. package/dist/models/inline-response200.d.ts +54 -0
  70. package/dist/models/inline-response200.js +15 -0
  71. package/dist/models/inline-response503.d.ts +54 -0
  72. package/dist/models/inline-response503.js +15 -0
  73. package/dist/models/list-campaigns-response-class.d.ts +43 -0
  74. package/dist/models/list-campaigns-response-class.js +15 -0
  75. package/dist/models/list-eligible-accounts-response-class.d.ts +43 -0
  76. package/dist/models/list-eligible-accounts-response-class.js +15 -0
  77. package/dist/models/list-policy-vouchers-response-class.d.ts +43 -0
  78. package/dist/models/list-policy-vouchers-response-class.js +15 -0
  79. package/dist/models/list-vouchers-response-class.d.ts +43 -0
  80. package/dist/models/list-vouchers-response-class.js +15 -0
  81. package/dist/models/policy-voucher-class.d.ts +165 -0
  82. package/dist/models/policy-voucher-class.js +21 -0
  83. package/dist/models/policy-voucher-transaction-class.d.ts +126 -0
  84. package/dist/models/policy-voucher-transaction-class.js +26 -0
  85. package/dist/models/product-discount-class.d.ts +90 -0
  86. package/dist/models/product-discount-class.js +15 -0
  87. package/dist/models/redeem-policy-voucher-request-dto.d.ts +48 -0
  88. package/dist/models/redeem-policy-voucher-request-dto.js +15 -0
  89. package/dist/models/redeem-policy-voucher-response-class.d.ts +84 -0
  90. package/dist/models/redeem-policy-voucher-response-class.js +21 -0
  91. package/dist/models/update-campaign-request-dto.d.ts +42 -0
  92. package/dist/models/update-campaign-request-dto.js +15 -0
  93. package/dist/models/update-campaign-response-class.d.ts +25 -0
  94. package/dist/models/update-campaign-response-class.js +15 -0
  95. package/dist/models/update-campaign-status-request-dto.d.ts +33 -0
  96. package/dist/models/update-campaign-status-request-dto.js +24 -0
  97. package/dist/models/update-voucher-request-dto.d.ts +60 -0
  98. package/dist/models/update-voucher-request-dto.js +20 -0
  99. package/dist/models/update-voucher-response-class.d.ts +25 -0
  100. package/dist/models/update-voucher-response-class.js +15 -0
  101. package/dist/models/voucher-class.d.ts +127 -0
  102. package/dist/models/voucher-class.js +20 -0
  103. package/dist/models/withdraw-policy-voucher-request-dto.d.ts +36 -0
  104. package/dist/models/withdraw-policy-voucher-request-dto.js +15 -0
  105. package/dist/models/withdraw-policy-voucher-response-class.d.ts +78 -0
  106. package/dist/models/withdraw-policy-voucher-response-class.js +21 -0
  107. package/git_push.sh +57 -0
  108. package/index.ts +19 -0
  109. package/models/campaign-class.ts +114 -0
  110. package/models/charge-policy-voucher-request-dto.ts +54 -0
  111. package/models/charge-policy-voucher-response-class.ts +105 -0
  112. package/models/check-account-eligibility-request-dto.ts +54 -0
  113. package/models/check-account-eligibility-response-class.ts +66 -0
  114. package/models/create-campaign-request-dto.ts +48 -0
  115. package/models/create-campaign-response-class.ts +31 -0
  116. package/models/create-eligible-account-request-dto.ts +36 -0
  117. package/models/create-eligible-account-response-class.ts +31 -0
  118. package/models/create-policy-voucher-request-dto.ts +54 -0
  119. package/models/create-policy-voucher-response-class.ts +31 -0
  120. package/models/create-product-discount-dto.ts +54 -0
  121. package/models/create-voucher-request-dto.ts +75 -0
  122. package/models/create-voucher-response-class.ts +31 -0
  123. package/models/eligible-account-class.ts +84 -0
  124. package/models/get-campaign-response-class.ts +31 -0
  125. package/models/get-policy-voucher-response-class.ts +31 -0
  126. package/models/get-voucher-response-class.ts +31 -0
  127. package/models/index.ts +37 -0
  128. package/models/inline-response200.ts +48 -0
  129. package/models/inline-response503.ts +48 -0
  130. package/models/list-campaigns-response-class.ts +49 -0
  131. package/models/list-eligible-accounts-response-class.ts +49 -0
  132. package/models/list-policy-vouchers-response-class.ts +49 -0
  133. package/models/list-vouchers-response-class.ts +49 -0
  134. package/models/policy-voucher-class.ts +174 -0
  135. package/models/policy-voucher-transaction-class.ts +136 -0
  136. package/models/product-discount-class.ts +96 -0
  137. package/models/redeem-policy-voucher-request-dto.ts +54 -0
  138. package/models/redeem-policy-voucher-response-class.ts +93 -0
  139. package/models/update-campaign-request-dto.ts +48 -0
  140. package/models/update-campaign-response-class.ts +31 -0
  141. package/models/update-campaign-status-request-dto.ts +42 -0
  142. package/models/update-voucher-request-dto.ts +69 -0
  143. package/models/update-voucher-response-class.ts +31 -0
  144. package/models/voucher-class.ts +136 -0
  145. package/models/withdraw-policy-voucher-request-dto.ts +42 -0
  146. package/models/withdraw-policy-voucher-response-class.ts +87 -0
  147. package/package.json +22 -8
  148. package/tsconfig.json +23 -0
  149. package/index.js +0 -99
  150. package/scripts/deploy.js +0 -225
@@ -0,0 +1,808 @@
1
+ /**
2
+ * EMIL DiscountService
3
+ * The EMIL DiscountService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateCampaignRequestDto } from '../models';
16
+ import { CreateCampaignResponseClass } from '../models';
17
+ import { CreateEligibleAccountRequestDto } from '../models';
18
+ import { CreateEligibleAccountResponseClass } from '../models';
19
+ import { GetCampaignResponseClass } from '../models';
20
+ import { ListCampaignsResponseClass } from '../models';
21
+ import { ListEligibleAccountsResponseClass } from '../models';
22
+ import { UpdateCampaignRequestDto } from '../models';
23
+ import { UpdateCampaignResponseClass } from '../models';
24
+ import { UpdateCampaignStatusRequestDto } from '../models';
25
+ /**
26
+ * CampaignsApi - axios parameter creator
27
+ * @export
28
+ */
29
+ export declare const CampaignsApiAxiosParamCreator: (configuration?: Configuration) => {
30
+ /**
31
+ * Creates a new campaign that can contain multiple vouchers for eligible accounts to redeem.
32
+ * @summary Create the Campaign
33
+ * @param {CreateCampaignRequestDto} createCampaignRequestDto
34
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ createCampaign: (createCampaignRequestDto: CreateCampaignRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
39
+ /**
40
+ * Creates an account that is eligible to redeem a vouchers from a specific campaign.
41
+ * @summary Create the Eligible Account
42
+ * @param {string} code Unique identifier for the object.
43
+ * @param {CreateEligibleAccountRequestDto} createEligibleAccountRequestDto
44
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
45
+ * @param {*} [options] Override http request option.
46
+ * @throws {RequiredError}
47
+ */
48
+ createEligibleAccount: (code: string, createEligibleAccountRequestDto: CreateEligibleAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
49
+ /**
50
+ * Removes a campaign and its associated vouchers. This will prevent any further voucher redemptions.
51
+ * @summary Delete the Campaign
52
+ * @param {string} code Unique identifier for the object.
53
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
54
+ * @param {*} [options] Override http request option.
55
+ * @throws {RequiredError}
56
+ */
57
+ deleteCampaign: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
58
+ /**
59
+ * Removes an eligible account from a campaign. This will prevent the account from using the assigned voucher code for discounts when the campaign is released.
60
+ * @summary Delete the Eligible Account
61
+ * @param {string} code Unique identifier for the object.
62
+ * @param {string} accountCode The code of the eligible account
63
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
64
+ * @param {*} [options] Override http request option.
65
+ * @throws {RequiredError}
66
+ */
67
+ deleteEligibleAccount: (code: string, accountCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
+ /**
69
+ * Removes all eligible accounts from a campaign. This will prevent these accounts from using their assigned voucher codes for discounts when the campaign is released.
70
+ * @summary Delete the Eligible Accounts
71
+ * @param {string} code Unique identifier for the object.
72
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
73
+ * @param {*} [options] Override http request option.
74
+ * @throws {RequiredError}
75
+ */
76
+ deleteEligibleAccounts: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
77
+ /**
78
+ * Retrieves detailed information about a specific campaign.
79
+ * @summary Retrieve the Campaign
80
+ * @param {string} code Unique identifier for the object.
81
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
82
+ * @param {string} [expand] You can expand campaign in this endpoint.
83
+ * @param {*} [options] Override http request option.
84
+ * @throws {RequiredError}
85
+ */
86
+ getCampaign: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
87
+ /**
88
+ * Retrieves a list of campaigns.
89
+ * @summary List Campaigns
90
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
91
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
93
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, status, slug, startDate, endDate, createdAt&lt;/i&gt;
94
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: name, status, startDate, endDate, createdAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
97
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, status, slug, startDate, endDate, createdAt&lt;/i&gt;
98
+ * @param {*} [options] Override http request option.
99
+ * @throws {RequiredError}
100
+ */
101
+ listCampaigns: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
102
+ /**
103
+ * Retrieves a list of eligible accounts.
104
+ * @summary List Eligible Accounts
105
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
106
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
108
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, voucherCode, partnerNumber, campaignId, createdAt, updatedAt&lt;/i&gt;
109
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: voucherCode, partnerNumber&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: voucherCode, partnerNumber, createdAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
112
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, voucherCode, partnerNumber, campaignId, createdAt, updatedAt&lt;/i&gt;
113
+ * @param {*} [options] Override http request option.
114
+ * @throws {RequiredError}
115
+ */
116
+ listEligibleAccounts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
117
+ /**
118
+ * Updates the data of an existing campaign. Only DRAFT campaigns can be updated.
119
+ * @summary Update the Campaign
120
+ * @param {string} code Unique identifier for the object.
121
+ * @param {UpdateCampaignRequestDto} updateCampaignRequestDto
122
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
123
+ * @param {*} [options] Override http request option.
124
+ * @throws {RequiredError}
125
+ */
126
+ updateCampaign: (code: string, updateCampaignRequestDto: UpdateCampaignRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
127
+ /**
128
+ * Updates the status of a campaign, which affects whether vouchers can be redeemed.
129
+ * @summary Updates the status of a campaign.
130
+ * @param {string} code Unique identifier for the object.
131
+ * @param {UpdateCampaignStatusRequestDto} updateCampaignStatusRequestDto
132
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
133
+ * @param {*} [options] Override http request option.
134
+ * @throws {RequiredError}
135
+ */
136
+ updateCampaignStatus: (code: string, updateCampaignStatusRequestDto: UpdateCampaignStatusRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
137
+ /**
138
+ * Uploads accounts that are eligible to redeem vouchers from a specific campaign using a CSV file. The CSV file must contain a header row with the following columns: partnerNumber, voucherCode. Separate each column with a comma.
139
+ * @summary Uploads the eligible accounts.
140
+ * @param {string} code Unique identifier for the object.
141
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
142
+ * @param {*} [options] Override http request option.
143
+ * @throws {RequiredError}
144
+ */
145
+ uploadEligibleAccounts: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
146
+ };
147
+ /**
148
+ * CampaignsApi - functional programming interface
149
+ * @export
150
+ */
151
+ export declare const CampaignsApiFp: (configuration?: Configuration) => {
152
+ /**
153
+ * Creates a new campaign that can contain multiple vouchers for eligible accounts to redeem.
154
+ * @summary Create the Campaign
155
+ * @param {CreateCampaignRequestDto} createCampaignRequestDto
156
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
157
+ * @param {*} [options] Override http request option.
158
+ * @throws {RequiredError}
159
+ */
160
+ createCampaign(createCampaignRequestDto: CreateCampaignRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCampaignResponseClass>>;
161
+ /**
162
+ * Creates an account that is eligible to redeem a vouchers from a specific campaign.
163
+ * @summary Create the Eligible Account
164
+ * @param {string} code Unique identifier for the object.
165
+ * @param {CreateEligibleAccountRequestDto} createEligibleAccountRequestDto
166
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
167
+ * @param {*} [options] Override http request option.
168
+ * @throws {RequiredError}
169
+ */
170
+ createEligibleAccount(code: string, createEligibleAccountRequestDto: CreateEligibleAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEligibleAccountResponseClass>>;
171
+ /**
172
+ * Removes a campaign and its associated vouchers. This will prevent any further voucher redemptions.
173
+ * @summary Delete the Campaign
174
+ * @param {string} code Unique identifier for the object.
175
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
176
+ * @param {*} [options] Override http request option.
177
+ * @throws {RequiredError}
178
+ */
179
+ deleteCampaign(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
180
+ /**
181
+ * Removes an eligible account from a campaign. This will prevent the account from using the assigned voucher code for discounts when the campaign is released.
182
+ * @summary Delete the Eligible Account
183
+ * @param {string} code Unique identifier for the object.
184
+ * @param {string} accountCode The code of the eligible account
185
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
186
+ * @param {*} [options] Override http request option.
187
+ * @throws {RequiredError}
188
+ */
189
+ deleteEligibleAccount(code: string, accountCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
190
+ /**
191
+ * Removes all eligible accounts from a campaign. This will prevent these accounts from using their assigned voucher codes for discounts when the campaign is released.
192
+ * @summary Delete the Eligible Accounts
193
+ * @param {string} code Unique identifier for the object.
194
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
195
+ * @param {*} [options] Override http request option.
196
+ * @throws {RequiredError}
197
+ */
198
+ deleteEligibleAccounts(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
199
+ /**
200
+ * Retrieves detailed information about a specific campaign.
201
+ * @summary Retrieve the Campaign
202
+ * @param {string} code Unique identifier for the object.
203
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
204
+ * @param {string} [expand] You can expand campaign in this endpoint.
205
+ * @param {*} [options] Override http request option.
206
+ * @throws {RequiredError}
207
+ */
208
+ getCampaign(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCampaignResponseClass>>;
209
+ /**
210
+ * Retrieves a list of campaigns.
211
+ * @summary List Campaigns
212
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
213
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
215
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, status, slug, startDate, endDate, createdAt&lt;/i&gt;
216
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: name, status, startDate, endDate, createdAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
219
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, status, slug, startDate, endDate, createdAt&lt;/i&gt;
220
+ * @param {*} [options] Override http request option.
221
+ * @throws {RequiredError}
222
+ */
223
+ listCampaigns(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCampaignsResponseClass>>;
224
+ /**
225
+ * Retrieves a list of eligible accounts.
226
+ * @summary List Eligible Accounts
227
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
228
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
230
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, voucherCode, partnerNumber, campaignId, createdAt, updatedAt&lt;/i&gt;
231
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: voucherCode, partnerNumber&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: voucherCode, partnerNumber, createdAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
234
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, voucherCode, partnerNumber, campaignId, createdAt, updatedAt&lt;/i&gt;
235
+ * @param {*} [options] Override http request option.
236
+ * @throws {RequiredError}
237
+ */
238
+ listEligibleAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEligibleAccountsResponseClass>>;
239
+ /**
240
+ * Updates the data of an existing campaign. Only DRAFT campaigns can be updated.
241
+ * @summary Update the Campaign
242
+ * @param {string} code Unique identifier for the object.
243
+ * @param {UpdateCampaignRequestDto} updateCampaignRequestDto
244
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
245
+ * @param {*} [options] Override http request option.
246
+ * @throws {RequiredError}
247
+ */
248
+ updateCampaign(code: string, updateCampaignRequestDto: UpdateCampaignRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCampaignResponseClass>>;
249
+ /**
250
+ * Updates the status of a campaign, which affects whether vouchers can be redeemed.
251
+ * @summary Updates the status of a campaign.
252
+ * @param {string} code Unique identifier for the object.
253
+ * @param {UpdateCampaignStatusRequestDto} updateCampaignStatusRequestDto
254
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
255
+ * @param {*} [options] Override http request option.
256
+ * @throws {RequiredError}
257
+ */
258
+ updateCampaignStatus(code: string, updateCampaignStatusRequestDto: UpdateCampaignStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
259
+ /**
260
+ * Uploads accounts that are eligible to redeem vouchers from a specific campaign using a CSV file. The CSV file must contain a header row with the following columns: partnerNumber, voucherCode. Separate each column with a comma.
261
+ * @summary Uploads the eligible accounts.
262
+ * @param {string} code Unique identifier for the object.
263
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
264
+ * @param {*} [options] Override http request option.
265
+ * @throws {RequiredError}
266
+ */
267
+ uploadEligibleAccounts(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
268
+ };
269
+ /**
270
+ * CampaignsApi - factory interface
271
+ * @export
272
+ */
273
+ export declare const CampaignsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
274
+ /**
275
+ * Creates a new campaign that can contain multiple vouchers for eligible accounts to redeem.
276
+ * @summary Create the Campaign
277
+ * @param {CreateCampaignRequestDto} createCampaignRequestDto
278
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
279
+ * @param {*} [options] Override http request option.
280
+ * @throws {RequiredError}
281
+ */
282
+ createCampaign(createCampaignRequestDto: CreateCampaignRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCampaignResponseClass>;
283
+ /**
284
+ * Creates an account that is eligible to redeem a vouchers from a specific campaign.
285
+ * @summary Create the Eligible Account
286
+ * @param {string} code Unique identifier for the object.
287
+ * @param {CreateEligibleAccountRequestDto} createEligibleAccountRequestDto
288
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
289
+ * @param {*} [options] Override http request option.
290
+ * @throws {RequiredError}
291
+ */
292
+ createEligibleAccount(code: string, createEligibleAccountRequestDto: CreateEligibleAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreateEligibleAccountResponseClass>;
293
+ /**
294
+ * Removes a campaign and its associated vouchers. This will prevent any further voucher redemptions.
295
+ * @summary Delete the Campaign
296
+ * @param {string} code Unique identifier for the object.
297
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
298
+ * @param {*} [options] Override http request option.
299
+ * @throws {RequiredError}
300
+ */
301
+ deleteCampaign(code: string, authorization?: string, options?: any): AxiosPromise<void>;
302
+ /**
303
+ * Removes an eligible account from a campaign. This will prevent the account from using the assigned voucher code for discounts when the campaign is released.
304
+ * @summary Delete the Eligible Account
305
+ * @param {string} code Unique identifier for the object.
306
+ * @param {string} accountCode The code of the eligible account
307
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
308
+ * @param {*} [options] Override http request option.
309
+ * @throws {RequiredError}
310
+ */
311
+ deleteEligibleAccount(code: string, accountCode: string, authorization?: string, options?: any): AxiosPromise<void>;
312
+ /**
313
+ * Removes all eligible accounts from a campaign. This will prevent these accounts from using their assigned voucher codes for discounts when the campaign is released.
314
+ * @summary Delete the Eligible Accounts
315
+ * @param {string} code Unique identifier for the object.
316
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
317
+ * @param {*} [options] Override http request option.
318
+ * @throws {RequiredError}
319
+ */
320
+ deleteEligibleAccounts(code: string, authorization?: string, options?: any): AxiosPromise<void>;
321
+ /**
322
+ * Retrieves detailed information about a specific campaign.
323
+ * @summary Retrieve the Campaign
324
+ * @param {string} code Unique identifier for the object.
325
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
326
+ * @param {string} [expand] You can expand campaign in this endpoint.
327
+ * @param {*} [options] Override http request option.
328
+ * @throws {RequiredError}
329
+ */
330
+ getCampaign(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetCampaignResponseClass>;
331
+ /**
332
+ * Retrieves a list of campaigns.
333
+ * @summary List Campaigns
334
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
335
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
337
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, status, slug, startDate, endDate, createdAt&lt;/i&gt;
338
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: name, status, startDate, endDate, createdAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
341
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, status, slug, startDate, endDate, createdAt&lt;/i&gt;
342
+ * @param {*} [options] Override http request option.
343
+ * @throws {RequiredError}
344
+ */
345
+ listCampaigns(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCampaignsResponseClass>;
346
+ /**
347
+ * Retrieves a list of eligible accounts.
348
+ * @summary List Eligible Accounts
349
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
350
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
352
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, voucherCode, partnerNumber, campaignId, createdAt, updatedAt&lt;/i&gt;
353
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: voucherCode, partnerNumber&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: voucherCode, partnerNumber, createdAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
356
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, voucherCode, partnerNumber, campaignId, createdAt, updatedAt&lt;/i&gt;
357
+ * @param {*} [options] Override http request option.
358
+ * @throws {RequiredError}
359
+ */
360
+ listEligibleAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEligibleAccountsResponseClass>;
361
+ /**
362
+ * Updates the data of an existing campaign. Only DRAFT campaigns can be updated.
363
+ * @summary Update the Campaign
364
+ * @param {string} code Unique identifier for the object.
365
+ * @param {UpdateCampaignRequestDto} updateCampaignRequestDto
366
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
367
+ * @param {*} [options] Override http request option.
368
+ * @throws {RequiredError}
369
+ */
370
+ updateCampaign(code: string, updateCampaignRequestDto: UpdateCampaignRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCampaignResponseClass>;
371
+ /**
372
+ * Updates the status of a campaign, which affects whether vouchers can be redeemed.
373
+ * @summary Updates the status of a campaign.
374
+ * @param {string} code Unique identifier for the object.
375
+ * @param {UpdateCampaignStatusRequestDto} updateCampaignStatusRequestDto
376
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
377
+ * @param {*} [options] Override http request option.
378
+ * @throws {RequiredError}
379
+ */
380
+ updateCampaignStatus(code: string, updateCampaignStatusRequestDto: UpdateCampaignStatusRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
381
+ /**
382
+ * Uploads accounts that are eligible to redeem vouchers from a specific campaign using a CSV file. The CSV file must contain a header row with the following columns: partnerNumber, voucherCode. Separate each column with a comma.
383
+ * @summary Uploads the eligible accounts.
384
+ * @param {string} code Unique identifier for the object.
385
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
386
+ * @param {*} [options] Override http request option.
387
+ * @throws {RequiredError}
388
+ */
389
+ uploadEligibleAccounts(code: string, authorization?: string, options?: any): AxiosPromise<void>;
390
+ };
391
+ /**
392
+ * Request parameters for createCampaign operation in CampaignsApi.
393
+ * @export
394
+ * @interface CampaignsApiCreateCampaignRequest
395
+ */
396
+ export interface CampaignsApiCreateCampaignRequest {
397
+ /**
398
+ *
399
+ * @type {CreateCampaignRequestDto}
400
+ * @memberof CampaignsApiCreateCampaign
401
+ */
402
+ readonly createCampaignRequestDto: CreateCampaignRequestDto;
403
+ /**
404
+ * Bearer Token: provided by the login endpoint under the name accessToken.
405
+ * @type {string}
406
+ * @memberof CampaignsApiCreateCampaign
407
+ */
408
+ readonly authorization?: string;
409
+ }
410
+ /**
411
+ * Request parameters for createEligibleAccount operation in CampaignsApi.
412
+ * @export
413
+ * @interface CampaignsApiCreateEligibleAccountRequest
414
+ */
415
+ export interface CampaignsApiCreateEligibleAccountRequest {
416
+ /**
417
+ * Unique identifier for the object.
418
+ * @type {string}
419
+ * @memberof CampaignsApiCreateEligibleAccount
420
+ */
421
+ readonly code: string;
422
+ /**
423
+ *
424
+ * @type {CreateEligibleAccountRequestDto}
425
+ * @memberof CampaignsApiCreateEligibleAccount
426
+ */
427
+ readonly createEligibleAccountRequestDto: CreateEligibleAccountRequestDto;
428
+ /**
429
+ * Bearer Token: provided by the login endpoint under the name accessToken.
430
+ * @type {string}
431
+ * @memberof CampaignsApiCreateEligibleAccount
432
+ */
433
+ readonly authorization?: string;
434
+ }
435
+ /**
436
+ * Request parameters for deleteCampaign operation in CampaignsApi.
437
+ * @export
438
+ * @interface CampaignsApiDeleteCampaignRequest
439
+ */
440
+ export interface CampaignsApiDeleteCampaignRequest {
441
+ /**
442
+ * Unique identifier for the object.
443
+ * @type {string}
444
+ * @memberof CampaignsApiDeleteCampaign
445
+ */
446
+ readonly code: string;
447
+ /**
448
+ * Bearer Token: provided by the login endpoint under the name accessToken.
449
+ * @type {string}
450
+ * @memberof CampaignsApiDeleteCampaign
451
+ */
452
+ readonly authorization?: string;
453
+ }
454
+ /**
455
+ * Request parameters for deleteEligibleAccount operation in CampaignsApi.
456
+ * @export
457
+ * @interface CampaignsApiDeleteEligibleAccountRequest
458
+ */
459
+ export interface CampaignsApiDeleteEligibleAccountRequest {
460
+ /**
461
+ * Unique identifier for the object.
462
+ * @type {string}
463
+ * @memberof CampaignsApiDeleteEligibleAccount
464
+ */
465
+ readonly code: string;
466
+ /**
467
+ * The code of the eligible account
468
+ * @type {string}
469
+ * @memberof CampaignsApiDeleteEligibleAccount
470
+ */
471
+ readonly accountCode: string;
472
+ /**
473
+ * Bearer Token: provided by the login endpoint under the name accessToken.
474
+ * @type {string}
475
+ * @memberof CampaignsApiDeleteEligibleAccount
476
+ */
477
+ readonly authorization?: string;
478
+ }
479
+ /**
480
+ * Request parameters for deleteEligibleAccounts operation in CampaignsApi.
481
+ * @export
482
+ * @interface CampaignsApiDeleteEligibleAccountsRequest
483
+ */
484
+ export interface CampaignsApiDeleteEligibleAccountsRequest {
485
+ /**
486
+ * Unique identifier for the object.
487
+ * @type {string}
488
+ * @memberof CampaignsApiDeleteEligibleAccounts
489
+ */
490
+ readonly code: string;
491
+ /**
492
+ * Bearer Token: provided by the login endpoint under the name accessToken.
493
+ * @type {string}
494
+ * @memberof CampaignsApiDeleteEligibleAccounts
495
+ */
496
+ readonly authorization?: string;
497
+ }
498
+ /**
499
+ * Request parameters for getCampaign operation in CampaignsApi.
500
+ * @export
501
+ * @interface CampaignsApiGetCampaignRequest
502
+ */
503
+ export interface CampaignsApiGetCampaignRequest {
504
+ /**
505
+ * Unique identifier for the object.
506
+ * @type {string}
507
+ * @memberof CampaignsApiGetCampaign
508
+ */
509
+ readonly code: string;
510
+ /**
511
+ * Bearer Token: provided by the login endpoint under the name accessToken.
512
+ * @type {string}
513
+ * @memberof CampaignsApiGetCampaign
514
+ */
515
+ readonly authorization?: string;
516
+ /**
517
+ * You can expand campaign in this endpoint.
518
+ * @type {string}
519
+ * @memberof CampaignsApiGetCampaign
520
+ */
521
+ readonly expand?: string;
522
+ }
523
+ /**
524
+ * Request parameters for listCampaigns operation in CampaignsApi.
525
+ * @export
526
+ * @interface CampaignsApiListCampaignsRequest
527
+ */
528
+ export interface CampaignsApiListCampaignsRequest {
529
+ /**
530
+ * Bearer Token: provided by the login endpoint under the name accessToken.
531
+ * @type {string}
532
+ * @memberof CampaignsApiListCampaigns
533
+ */
534
+ readonly authorization?: string;
535
+ /**
536
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
537
+ * @type {number}
538
+ * @memberof CampaignsApiListCampaigns
539
+ */
540
+ readonly pageSize?: number;
541
+ /**
542
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
543
+ * @type {string}
544
+ * @memberof CampaignsApiListCampaigns
545
+ */
546
+ readonly pageToken?: string;
547
+ /**
548
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, status, slug, startDate, endDate, createdAt&lt;/i&gt;
549
+ * @type {string}
550
+ * @memberof CampaignsApiListCampaigns
551
+ */
552
+ readonly filter?: string;
553
+ /**
554
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
555
+ * @type {string}
556
+ * @memberof CampaignsApiListCampaigns
557
+ */
558
+ readonly search?: string;
559
+ /**
560
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: name, status, startDate, endDate, createdAt&lt;/i&gt;
561
+ * @type {string}
562
+ * @memberof CampaignsApiListCampaigns
563
+ */
564
+ readonly order?: string;
565
+ /**
566
+ * 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.&lt;br/&gt; &lt;br/&gt;
567
+ * @type {string}
568
+ * @memberof CampaignsApiListCampaigns
569
+ */
570
+ readonly expand?: string;
571
+ /**
572
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, status, slug, startDate, endDate, createdAt&lt;/i&gt;
573
+ * @type {string}
574
+ * @memberof CampaignsApiListCampaigns
575
+ */
576
+ readonly filters?: string;
577
+ }
578
+ /**
579
+ * Request parameters for listEligibleAccounts operation in CampaignsApi.
580
+ * @export
581
+ * @interface CampaignsApiListEligibleAccountsRequest
582
+ */
583
+ export interface CampaignsApiListEligibleAccountsRequest {
584
+ /**
585
+ * Bearer Token: provided by the login endpoint under the name accessToken.
586
+ * @type {string}
587
+ * @memberof CampaignsApiListEligibleAccounts
588
+ */
589
+ readonly authorization?: string;
590
+ /**
591
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
592
+ * @type {number}
593
+ * @memberof CampaignsApiListEligibleAccounts
594
+ */
595
+ readonly pageSize?: number;
596
+ /**
597
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
598
+ * @type {string}
599
+ * @memberof CampaignsApiListEligibleAccounts
600
+ */
601
+ readonly pageToken?: string;
602
+ /**
603
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, voucherCode, partnerNumber, campaignId, createdAt, updatedAt&lt;/i&gt;
604
+ * @type {string}
605
+ * @memberof CampaignsApiListEligibleAccounts
606
+ */
607
+ readonly filter?: string;
608
+ /**
609
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: voucherCode, partnerNumber&lt;/i&gt;
610
+ * @type {string}
611
+ * @memberof CampaignsApiListEligibleAccounts
612
+ */
613
+ readonly search?: string;
614
+ /**
615
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: voucherCode, partnerNumber, createdAt&lt;/i&gt;
616
+ * @type {string}
617
+ * @memberof CampaignsApiListEligibleAccounts
618
+ */
619
+ readonly order?: string;
620
+ /**
621
+ * 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.&lt;br/&gt; &lt;br/&gt;
622
+ * @type {string}
623
+ * @memberof CampaignsApiListEligibleAccounts
624
+ */
625
+ readonly expand?: string;
626
+ /**
627
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, voucherCode, partnerNumber, campaignId, createdAt, updatedAt&lt;/i&gt;
628
+ * @type {string}
629
+ * @memberof CampaignsApiListEligibleAccounts
630
+ */
631
+ readonly filters?: string;
632
+ }
633
+ /**
634
+ * Request parameters for updateCampaign operation in CampaignsApi.
635
+ * @export
636
+ * @interface CampaignsApiUpdateCampaignRequest
637
+ */
638
+ export interface CampaignsApiUpdateCampaignRequest {
639
+ /**
640
+ * Unique identifier for the object.
641
+ * @type {string}
642
+ * @memberof CampaignsApiUpdateCampaign
643
+ */
644
+ readonly code: string;
645
+ /**
646
+ *
647
+ * @type {UpdateCampaignRequestDto}
648
+ * @memberof CampaignsApiUpdateCampaign
649
+ */
650
+ readonly updateCampaignRequestDto: UpdateCampaignRequestDto;
651
+ /**
652
+ * Bearer Token: provided by the login endpoint under the name accessToken.
653
+ * @type {string}
654
+ * @memberof CampaignsApiUpdateCampaign
655
+ */
656
+ readonly authorization?: string;
657
+ }
658
+ /**
659
+ * Request parameters for updateCampaignStatus operation in CampaignsApi.
660
+ * @export
661
+ * @interface CampaignsApiUpdateCampaignStatusRequest
662
+ */
663
+ export interface CampaignsApiUpdateCampaignStatusRequest {
664
+ /**
665
+ * Unique identifier for the object.
666
+ * @type {string}
667
+ * @memberof CampaignsApiUpdateCampaignStatus
668
+ */
669
+ readonly code: string;
670
+ /**
671
+ *
672
+ * @type {UpdateCampaignStatusRequestDto}
673
+ * @memberof CampaignsApiUpdateCampaignStatus
674
+ */
675
+ readonly updateCampaignStatusRequestDto: UpdateCampaignStatusRequestDto;
676
+ /**
677
+ * Bearer Token: provided by the login endpoint under the name accessToken.
678
+ * @type {string}
679
+ * @memberof CampaignsApiUpdateCampaignStatus
680
+ */
681
+ readonly authorization?: string;
682
+ }
683
+ /**
684
+ * Request parameters for uploadEligibleAccounts operation in CampaignsApi.
685
+ * @export
686
+ * @interface CampaignsApiUploadEligibleAccountsRequest
687
+ */
688
+ export interface CampaignsApiUploadEligibleAccountsRequest {
689
+ /**
690
+ * Unique identifier for the object.
691
+ * @type {string}
692
+ * @memberof CampaignsApiUploadEligibleAccounts
693
+ */
694
+ readonly code: string;
695
+ /**
696
+ * Bearer Token: provided by the login endpoint under the name accessToken.
697
+ * @type {string}
698
+ * @memberof CampaignsApiUploadEligibleAccounts
699
+ */
700
+ readonly authorization?: string;
701
+ }
702
+ /**
703
+ * CampaignsApi - object-oriented interface
704
+ * @export
705
+ * @class CampaignsApi
706
+ * @extends {BaseAPI}
707
+ */
708
+ export declare class CampaignsApi extends BaseAPI {
709
+ /**
710
+ * Creates a new campaign that can contain multiple vouchers for eligible accounts to redeem.
711
+ * @summary Create the Campaign
712
+ * @param {CampaignsApiCreateCampaignRequest} requestParameters Request parameters.
713
+ * @param {*} [options] Override http request option.
714
+ * @throws {RequiredError}
715
+ * @memberof CampaignsApi
716
+ */
717
+ createCampaign(requestParameters: CampaignsApiCreateCampaignRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCampaignResponseClass, any, {}>>;
718
+ /**
719
+ * Creates an account that is eligible to redeem a vouchers from a specific campaign.
720
+ * @summary Create the Eligible Account
721
+ * @param {CampaignsApiCreateEligibleAccountRequest} requestParameters Request parameters.
722
+ * @param {*} [options] Override http request option.
723
+ * @throws {RequiredError}
724
+ * @memberof CampaignsApi
725
+ */
726
+ createEligibleAccount(requestParameters: CampaignsApiCreateEligibleAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEligibleAccountResponseClass, any, {}>>;
727
+ /**
728
+ * Removes a campaign and its associated vouchers. This will prevent any further voucher redemptions.
729
+ * @summary Delete the Campaign
730
+ * @param {CampaignsApiDeleteCampaignRequest} requestParameters Request parameters.
731
+ * @param {*} [options] Override http request option.
732
+ * @throws {RequiredError}
733
+ * @memberof CampaignsApi
734
+ */
735
+ deleteCampaign(requestParameters: CampaignsApiDeleteCampaignRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
736
+ /**
737
+ * Removes an eligible account from a campaign. This will prevent the account from using the assigned voucher code for discounts when the campaign is released.
738
+ * @summary Delete the Eligible Account
739
+ * @param {CampaignsApiDeleteEligibleAccountRequest} requestParameters Request parameters.
740
+ * @param {*} [options] Override http request option.
741
+ * @throws {RequiredError}
742
+ * @memberof CampaignsApi
743
+ */
744
+ deleteEligibleAccount(requestParameters: CampaignsApiDeleteEligibleAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
745
+ /**
746
+ * Removes all eligible accounts from a campaign. This will prevent these accounts from using their assigned voucher codes for discounts when the campaign is released.
747
+ * @summary Delete the Eligible Accounts
748
+ * @param {CampaignsApiDeleteEligibleAccountsRequest} requestParameters Request parameters.
749
+ * @param {*} [options] Override http request option.
750
+ * @throws {RequiredError}
751
+ * @memberof CampaignsApi
752
+ */
753
+ deleteEligibleAccounts(requestParameters: CampaignsApiDeleteEligibleAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
754
+ /**
755
+ * Retrieves detailed information about a specific campaign.
756
+ * @summary Retrieve the Campaign
757
+ * @param {CampaignsApiGetCampaignRequest} requestParameters Request parameters.
758
+ * @param {*} [options] Override http request option.
759
+ * @throws {RequiredError}
760
+ * @memberof CampaignsApi
761
+ */
762
+ getCampaign(requestParameters: CampaignsApiGetCampaignRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCampaignResponseClass, any, {}>>;
763
+ /**
764
+ * Retrieves a list of campaigns.
765
+ * @summary List Campaigns
766
+ * @param {CampaignsApiListCampaignsRequest} requestParameters Request parameters.
767
+ * @param {*} [options] Override http request option.
768
+ * @throws {RequiredError}
769
+ * @memberof CampaignsApi
770
+ */
771
+ listCampaigns(requestParameters?: CampaignsApiListCampaignsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCampaignsResponseClass, any, {}>>;
772
+ /**
773
+ * Retrieves a list of eligible accounts.
774
+ * @summary List Eligible Accounts
775
+ * @param {CampaignsApiListEligibleAccountsRequest} requestParameters Request parameters.
776
+ * @param {*} [options] Override http request option.
777
+ * @throws {RequiredError}
778
+ * @memberof CampaignsApi
779
+ */
780
+ listEligibleAccounts(requestParameters?: CampaignsApiListEligibleAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEligibleAccountsResponseClass, any, {}>>;
781
+ /**
782
+ * Updates the data of an existing campaign. Only DRAFT campaigns can be updated.
783
+ * @summary Update the Campaign
784
+ * @param {CampaignsApiUpdateCampaignRequest} requestParameters Request parameters.
785
+ * @param {*} [options] Override http request option.
786
+ * @throws {RequiredError}
787
+ * @memberof CampaignsApi
788
+ */
789
+ updateCampaign(requestParameters: CampaignsApiUpdateCampaignRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCampaignResponseClass, any, {}>>;
790
+ /**
791
+ * Updates the status of a campaign, which affects whether vouchers can be redeemed.
792
+ * @summary Updates the status of a campaign.
793
+ * @param {CampaignsApiUpdateCampaignStatusRequest} requestParameters Request parameters.
794
+ * @param {*} [options] Override http request option.
795
+ * @throws {RequiredError}
796
+ * @memberof CampaignsApi
797
+ */
798
+ updateCampaignStatus(requestParameters: CampaignsApiUpdateCampaignStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
799
+ /**
800
+ * Uploads accounts that are eligible to redeem vouchers from a specific campaign using a CSV file. The CSV file must contain a header row with the following columns: partnerNumber, voucherCode. Separate each column with a comma.
801
+ * @summary Uploads the eligible accounts.
802
+ * @param {CampaignsApiUploadEligibleAccountsRequest} requestParameters Request parameters.
803
+ * @param {*} [options] Override http request option.
804
+ * @throws {RequiredError}
805
+ * @memberof CampaignsApi
806
+ */
807
+ uploadEligibleAccounts(requestParameters: CampaignsApiUploadEligibleAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
808
+ }