@emilgroup/partner-sdk 1.22.1-beta.13 → 1.22.1-beta.14

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 (57) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/README.md +2 -2
  3. package/api/blacklist-api.ts +662 -0
  4. package/api/blacklist-reasons-api.ts +797 -0
  5. package/api.ts +4 -0
  6. package/dist/api/blacklist-api.d.ts +375 -0
  7. package/dist/api/blacklist-api.js +629 -0
  8. package/dist/api/blacklist-reasons-api.d.ts +450 -0
  9. package/dist/api/blacklist-reasons-api.js +735 -0
  10. package/dist/api.d.ts +2 -0
  11. package/dist/api.js +2 -0
  12. package/dist/models/blacklist-item-class.d.ts +78 -0
  13. package/dist/models/blacklist-item-class.js +15 -0
  14. package/dist/models/blacklist-reason-class.d.ts +78 -0
  15. package/dist/models/blacklist-reason-class.js +15 -0
  16. package/dist/models/create-blacklist-item-request-dto.d.ts +36 -0
  17. package/dist/models/create-blacklist-item-request-dto.js +15 -0
  18. package/dist/models/create-blacklist-item-response-class.d.ts +25 -0
  19. package/dist/models/create-blacklist-item-response-class.js +15 -0
  20. package/dist/models/create-blacklist-reason-request-dto.d.ts +36 -0
  21. package/dist/models/create-blacklist-reason-request-dto.js +15 -0
  22. package/dist/models/create-blacklist-reason-response-class.d.ts +25 -0
  23. package/dist/models/create-blacklist-reason-response-class.js +15 -0
  24. package/dist/models/get-blacklist-item-response-class.d.ts +25 -0
  25. package/dist/models/get-blacklist-item-response-class.js +15 -0
  26. package/dist/models/get-blacklist-reason-response-class.d.ts +25 -0
  27. package/dist/models/get-blacklist-reason-response-class.js +15 -0
  28. package/dist/models/index.d.ts +14 -0
  29. package/dist/models/index.js +14 -0
  30. package/dist/models/is-blacklisted-response-class.d.ts +54 -0
  31. package/dist/models/is-blacklisted-response-class.js +15 -0
  32. package/dist/models/list-blacklist-items-response-class.d.ts +31 -0
  33. package/dist/models/list-blacklist-items-response-class.js +15 -0
  34. package/dist/models/list-blacklist-reasons-response-class.d.ts +43 -0
  35. package/dist/models/list-blacklist-reasons-response-class.js +15 -0
  36. package/dist/models/update-blacklist-reason-request-dto.d.ts +30 -0
  37. package/dist/models/update-blacklist-reason-request-dto.js +15 -0
  38. package/dist/models/update-blacklist-reason-response-class.d.ts +25 -0
  39. package/dist/models/update-blacklist-reason-response-class.js +15 -0
  40. package/dist/models/update-blacklist-reason-status-request-dto.d.ts +24 -0
  41. package/dist/models/update-blacklist-reason-status-request-dto.js +15 -0
  42. package/models/blacklist-item-class.ts +84 -0
  43. package/models/blacklist-reason-class.ts +84 -0
  44. package/models/create-blacklist-item-request-dto.ts +42 -0
  45. package/models/create-blacklist-item-response-class.ts +31 -0
  46. package/models/create-blacklist-reason-request-dto.ts +42 -0
  47. package/models/create-blacklist-reason-response-class.ts +31 -0
  48. package/models/get-blacklist-item-response-class.ts +31 -0
  49. package/models/get-blacklist-reason-response-class.ts +31 -0
  50. package/models/index.ts +14 -0
  51. package/models/is-blacklisted-response-class.ts +60 -0
  52. package/models/list-blacklist-items-response-class.ts +37 -0
  53. package/models/list-blacklist-reasons-response-class.ts +49 -0
  54. package/models/update-blacklist-reason-request-dto.ts +36 -0
  55. package/models/update-blacklist-reason-response-class.ts +31 -0
  56. package/models/update-blacklist-reason-status-request-dto.ts +30 -0
  57. package/package.json +1 -1
package/api.ts CHANGED
@@ -20,6 +20,8 @@ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResp
20
20
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
23
+ import { BlacklistApi } from './api';
24
+ import { BlacklistReasonsApi } from './api';
23
25
  import { DefaultApi } from './api';
24
26
  import { PartnerInvitationsApi } from './api';
25
27
  import { PartnerRelationsApi } from './api';
@@ -29,6 +31,8 @@ import { PartnerVersionsApi } from './api';
29
31
  import { PartnersApi } from './api';
30
32
 
31
33
 
34
+ export * from './api/blacklist-api';
35
+ export * from './api/blacklist-reasons-api';
32
36
  export * from './api/default-api';
33
37
  export * from './api/partner-invitations-api';
34
38
  export * from './api/partner-relations-api';
@@ -0,0 +1,375 @@
1
+ /**
2
+ * EMIL PartnerService
3
+ * The EMIL PartnerService 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 { CreateBlacklistItemRequestDto } from '../models';
16
+ import { CreateBlacklistItemResponseClass } from '../models';
17
+ import { DeleteResponseClass } from '../models';
18
+ import { GetBlacklistItemResponseClass } from '../models';
19
+ import { IsBlacklistedResponseClass } from '../models';
20
+ import { ListBlacklistItemsResponseClass } from '../models';
21
+ /**
22
+ * BlacklistApi - axios parameter creator
23
+ * @export
24
+ */
25
+ export declare const BlacklistApiAxiosParamCreator: (configuration?: Configuration) => {
26
+ /**
27
+ * Add a partner to the blacklist. **Required Permissions** \"partner-management.partners.create\"
28
+ * @summary Create the blacklist item
29
+ * @param {CreateBlacklistItemRequestDto} createBlacklistItemRequestDto
30
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
31
+ * @param {*} [options] Override http request option.
32
+ * @throws {RequiredError}
33
+ */
34
+ createBlacklistItem: (createBlacklistItemRequestDto: CreateBlacklistItemRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
+ /**
36
+ * Permanently deletes the blacklist item. Supply the unique code that was returned when you created the blacklist item and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
37
+ * @summary Delete the blacklist item
38
+ * @param {string} code Unique identifier for the object.
39
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ deleteBlacklistItem: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
+ /**
45
+ * Retrieves the details of the blacklist item that was previously created. Supply the unique blacklist item code that was returned when you created it and Emil Api will return the corresponding blacklist item information. **Required Permissions** \"partner-management.partners.view\"
46
+ * @summary Retrieve the blacklist item
47
+ * @param {string} code Unique identifier for the object.
48
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ getBlacklistItem: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
+ /**
54
+ * Retrieves the details of the blacklist item that was previously created. Supply the unique blacklist item code that was returned when you created it and Emil Api will return the corresponding blacklist item information. **Required Permissions** \"partner-management.partners.view\"
55
+ * @summary Check if a partner is blacklisted
56
+ * @param {string} partnerCode
57
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
58
+ * @param {*} [options] Override http request option.
59
+ * @throws {RequiredError}
60
+ */
61
+ isBlacklisted: (partnerCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
62
+ /**
63
+ * Returns a list of blacklist-items you have previously created. The blacklist-items are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
64
+ * @summary List blacklist-items
65
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
66
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
67
+ * @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.
68
+ * @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: code, partnerCode, reasonCode, blockedFrom&lt;/i&gt;
69
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
70
+ * @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: code, partnerCode, reasonCode, blockedFrom, createdAt, updatedAt&lt;/i&gt;
71
+ * @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;
72
+ * @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: code, partnerCode, reasonCode, blockedFrom&lt;/i&gt;
73
+ * @param {*} [options] Override http request option.
74
+ * @throws {RequiredError}
75
+ */
76
+ listBlacklistItems: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
77
+ };
78
+ /**
79
+ * BlacklistApi - functional programming interface
80
+ * @export
81
+ */
82
+ export declare const BlacklistApiFp: (configuration?: Configuration) => {
83
+ /**
84
+ * Add a partner to the blacklist. **Required Permissions** \"partner-management.partners.create\"
85
+ * @summary Create the blacklist item
86
+ * @param {CreateBlacklistItemRequestDto} createBlacklistItemRequestDto
87
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
88
+ * @param {*} [options] Override http request option.
89
+ * @throws {RequiredError}
90
+ */
91
+ createBlacklistItem(createBlacklistItemRequestDto: CreateBlacklistItemRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBlacklistItemResponseClass>>;
92
+ /**
93
+ * Permanently deletes the blacklist item. Supply the unique code that was returned when you created the blacklist item and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
94
+ * @summary Delete the blacklist item
95
+ * @param {string} code Unique identifier for the object.
96
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ */
100
+ deleteBlacklistItem(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
101
+ /**
102
+ * Retrieves the details of the blacklist item that was previously created. Supply the unique blacklist item code that was returned when you created it and Emil Api will return the corresponding blacklist item information. **Required Permissions** \"partner-management.partners.view\"
103
+ * @summary Retrieve the blacklist item
104
+ * @param {string} code Unique identifier for the object.
105
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
106
+ * @param {*} [options] Override http request option.
107
+ * @throws {RequiredError}
108
+ */
109
+ getBlacklistItem(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBlacklistItemResponseClass>>;
110
+ /**
111
+ * Retrieves the details of the blacklist item that was previously created. Supply the unique blacklist item code that was returned when you created it and Emil Api will return the corresponding blacklist item information. **Required Permissions** \"partner-management.partners.view\"
112
+ * @summary Check if a partner is blacklisted
113
+ * @param {string} partnerCode
114
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
115
+ * @param {*} [options] Override http request option.
116
+ * @throws {RequiredError}
117
+ */
118
+ isBlacklisted(partnerCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IsBlacklistedResponseClass>>;
119
+ /**
120
+ * Returns a list of blacklist-items you have previously created. The blacklist-items are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
121
+ * @summary List blacklist-items
122
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
123
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
124
+ * @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.
125
+ * @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: code, partnerCode, reasonCode, blockedFrom&lt;/i&gt;
126
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
127
+ * @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: code, partnerCode, reasonCode, blockedFrom, createdAt, updatedAt&lt;/i&gt;
128
+ * @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;
129
+ * @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: code, partnerCode, reasonCode, blockedFrom&lt;/i&gt;
130
+ * @param {*} [options] Override http request option.
131
+ * @throws {RequiredError}
132
+ */
133
+ listBlacklistItems(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBlacklistItemsResponseClass>>;
134
+ };
135
+ /**
136
+ * BlacklistApi - factory interface
137
+ * @export
138
+ */
139
+ export declare const BlacklistApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
140
+ /**
141
+ * Add a partner to the blacklist. **Required Permissions** \"partner-management.partners.create\"
142
+ * @summary Create the blacklist item
143
+ * @param {CreateBlacklistItemRequestDto} createBlacklistItemRequestDto
144
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ createBlacklistItem(createBlacklistItemRequestDto: CreateBlacklistItemRequestDto, authorization?: string, options?: any): AxiosPromise<CreateBlacklistItemResponseClass>;
149
+ /**
150
+ * Permanently deletes the blacklist item. Supply the unique code that was returned when you created the blacklist item and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
151
+ * @summary Delete the blacklist item
152
+ * @param {string} code Unique identifier for the object.
153
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
154
+ * @param {*} [options] Override http request option.
155
+ * @throws {RequiredError}
156
+ */
157
+ deleteBlacklistItem(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
158
+ /**
159
+ * Retrieves the details of the blacklist item that was previously created. Supply the unique blacklist item code that was returned when you created it and Emil Api will return the corresponding blacklist item information. **Required Permissions** \"partner-management.partners.view\"
160
+ * @summary Retrieve the blacklist item
161
+ * @param {string} code Unique identifier for the object.
162
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
163
+ * @param {*} [options] Override http request option.
164
+ * @throws {RequiredError}
165
+ */
166
+ getBlacklistItem(code: string, authorization?: string, options?: any): AxiosPromise<GetBlacklistItemResponseClass>;
167
+ /**
168
+ * Retrieves the details of the blacklist item that was previously created. Supply the unique blacklist item code that was returned when you created it and Emil Api will return the corresponding blacklist item information. **Required Permissions** \"partner-management.partners.view\"
169
+ * @summary Check if a partner is blacklisted
170
+ * @param {string} partnerCode
171
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
172
+ * @param {*} [options] Override http request option.
173
+ * @throws {RequiredError}
174
+ */
175
+ isBlacklisted(partnerCode: string, authorization?: string, options?: any): AxiosPromise<IsBlacklistedResponseClass>;
176
+ /**
177
+ * Returns a list of blacklist-items you have previously created. The blacklist-items are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
178
+ * @summary List blacklist-items
179
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
180
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
181
+ * @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.
182
+ * @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: code, partnerCode, reasonCode, blockedFrom&lt;/i&gt;
183
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
184
+ * @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: code, partnerCode, reasonCode, blockedFrom, createdAt, updatedAt&lt;/i&gt;
185
+ * @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;
186
+ * @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: code, partnerCode, reasonCode, blockedFrom&lt;/i&gt;
187
+ * @param {*} [options] Override http request option.
188
+ * @throws {RequiredError}
189
+ */
190
+ listBlacklistItems(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBlacklistItemsResponseClass>;
191
+ };
192
+ /**
193
+ * Request parameters for createBlacklistItem operation in BlacklistApi.
194
+ * @export
195
+ * @interface BlacklistApiCreateBlacklistItemRequest
196
+ */
197
+ export interface BlacklistApiCreateBlacklistItemRequest {
198
+ /**
199
+ *
200
+ * @type {CreateBlacklistItemRequestDto}
201
+ * @memberof BlacklistApiCreateBlacklistItem
202
+ */
203
+ readonly createBlacklistItemRequestDto: CreateBlacklistItemRequestDto;
204
+ /**
205
+ * Bearer Token: provided by the login endpoint under the name accessToken.
206
+ * @type {string}
207
+ * @memberof BlacklistApiCreateBlacklistItem
208
+ */
209
+ readonly authorization?: string;
210
+ }
211
+ /**
212
+ * Request parameters for deleteBlacklistItem operation in BlacklistApi.
213
+ * @export
214
+ * @interface BlacklistApiDeleteBlacklistItemRequest
215
+ */
216
+ export interface BlacklistApiDeleteBlacklistItemRequest {
217
+ /**
218
+ * Unique identifier for the object.
219
+ * @type {string}
220
+ * @memberof BlacklistApiDeleteBlacklistItem
221
+ */
222
+ readonly code: string;
223
+ /**
224
+ * Bearer Token: provided by the login endpoint under the name accessToken.
225
+ * @type {string}
226
+ * @memberof BlacklistApiDeleteBlacklistItem
227
+ */
228
+ readonly authorization?: string;
229
+ }
230
+ /**
231
+ * Request parameters for getBlacklistItem operation in BlacklistApi.
232
+ * @export
233
+ * @interface BlacklistApiGetBlacklistItemRequest
234
+ */
235
+ export interface BlacklistApiGetBlacklistItemRequest {
236
+ /**
237
+ * Unique identifier for the object.
238
+ * @type {string}
239
+ * @memberof BlacklistApiGetBlacklistItem
240
+ */
241
+ readonly code: string;
242
+ /**
243
+ * Bearer Token: provided by the login endpoint under the name accessToken.
244
+ * @type {string}
245
+ * @memberof BlacklistApiGetBlacklistItem
246
+ */
247
+ readonly authorization?: string;
248
+ }
249
+ /**
250
+ * Request parameters for isBlacklisted operation in BlacklistApi.
251
+ * @export
252
+ * @interface BlacklistApiIsBlacklistedRequest
253
+ */
254
+ export interface BlacklistApiIsBlacklistedRequest {
255
+ /**
256
+ *
257
+ * @type {string}
258
+ * @memberof BlacklistApiIsBlacklisted
259
+ */
260
+ readonly partnerCode: string;
261
+ /**
262
+ * Bearer Token: provided by the login endpoint under the name accessToken.
263
+ * @type {string}
264
+ * @memberof BlacklistApiIsBlacklisted
265
+ */
266
+ readonly authorization?: string;
267
+ }
268
+ /**
269
+ * Request parameters for listBlacklistItems operation in BlacklistApi.
270
+ * @export
271
+ * @interface BlacklistApiListBlacklistItemsRequest
272
+ */
273
+ export interface BlacklistApiListBlacklistItemsRequest {
274
+ /**
275
+ * Bearer Token: provided by the login endpoint under the name accessToken.
276
+ * @type {string}
277
+ * @memberof BlacklistApiListBlacklistItems
278
+ */
279
+ readonly authorization?: string;
280
+ /**
281
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
282
+ * @type {number}
283
+ * @memberof BlacklistApiListBlacklistItems
284
+ */
285
+ readonly pageSize?: number;
286
+ /**
287
+ * 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.
288
+ * @type {string}
289
+ * @memberof BlacklistApiListBlacklistItems
290
+ */
291
+ readonly pageToken?: string;
292
+ /**
293
+ * 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: code, partnerCode, reasonCode, blockedFrom&lt;/i&gt;
294
+ * @type {string}
295
+ * @memberof BlacklistApiListBlacklistItems
296
+ */
297
+ readonly filter?: string;
298
+ /**
299
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
300
+ * @type {string}
301
+ * @memberof BlacklistApiListBlacklistItems
302
+ */
303
+ readonly search?: string;
304
+ /**
305
+ * 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: code, partnerCode, reasonCode, blockedFrom, createdAt, updatedAt&lt;/i&gt;
306
+ * @type {string}
307
+ * @memberof BlacklistApiListBlacklistItems
308
+ */
309
+ readonly order?: string;
310
+ /**
311
+ * 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;
312
+ * @type {string}
313
+ * @memberof BlacklistApiListBlacklistItems
314
+ */
315
+ readonly expand?: string;
316
+ /**
317
+ * 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: code, partnerCode, reasonCode, blockedFrom&lt;/i&gt;
318
+ * @type {string}
319
+ * @memberof BlacklistApiListBlacklistItems
320
+ */
321
+ readonly filters?: string;
322
+ }
323
+ /**
324
+ * BlacklistApi - object-oriented interface
325
+ * @export
326
+ * @class BlacklistApi
327
+ * @extends {BaseAPI}
328
+ */
329
+ export declare class BlacklistApi extends BaseAPI {
330
+ /**
331
+ * Add a partner to the blacklist. **Required Permissions** \"partner-management.partners.create\"
332
+ * @summary Create the blacklist item
333
+ * @param {BlacklistApiCreateBlacklistItemRequest} requestParameters Request parameters.
334
+ * @param {*} [options] Override http request option.
335
+ * @throws {RequiredError}
336
+ * @memberof BlacklistApi
337
+ */
338
+ createBlacklistItem(requestParameters: BlacklistApiCreateBlacklistItemRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBlacklistItemResponseClass, any, {}>>;
339
+ /**
340
+ * Permanently deletes the blacklist item. Supply the unique code that was returned when you created the blacklist item and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
341
+ * @summary Delete the blacklist item
342
+ * @param {BlacklistApiDeleteBlacklistItemRequest} requestParameters Request parameters.
343
+ * @param {*} [options] Override http request option.
344
+ * @throws {RequiredError}
345
+ * @memberof BlacklistApi
346
+ */
347
+ deleteBlacklistItem(requestParameters: BlacklistApiDeleteBlacklistItemRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any, {}>>;
348
+ /**
349
+ * Retrieves the details of the blacklist item that was previously created. Supply the unique blacklist item code that was returned when you created it and Emil Api will return the corresponding blacklist item information. **Required Permissions** \"partner-management.partners.view\"
350
+ * @summary Retrieve the blacklist item
351
+ * @param {BlacklistApiGetBlacklistItemRequest} requestParameters Request parameters.
352
+ * @param {*} [options] Override http request option.
353
+ * @throws {RequiredError}
354
+ * @memberof BlacklistApi
355
+ */
356
+ getBlacklistItem(requestParameters: BlacklistApiGetBlacklistItemRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBlacklistItemResponseClass, any, {}>>;
357
+ /**
358
+ * Retrieves the details of the blacklist item that was previously created. Supply the unique blacklist item code that was returned when you created it and Emil Api will return the corresponding blacklist item information. **Required Permissions** \"partner-management.partners.view\"
359
+ * @summary Check if a partner is blacklisted
360
+ * @param {BlacklistApiIsBlacklistedRequest} requestParameters Request parameters.
361
+ * @param {*} [options] Override http request option.
362
+ * @throws {RequiredError}
363
+ * @memberof BlacklistApi
364
+ */
365
+ isBlacklisted(requestParameters: BlacklistApiIsBlacklistedRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IsBlacklistedResponseClass, any, {}>>;
366
+ /**
367
+ * Returns a list of blacklist-items you have previously created. The blacklist-items are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
368
+ * @summary List blacklist-items
369
+ * @param {BlacklistApiListBlacklistItemsRequest} requestParameters Request parameters.
370
+ * @param {*} [options] Override http request option.
371
+ * @throws {RequiredError}
372
+ * @memberof BlacklistApi
373
+ */
374
+ listBlacklistItems(requestParameters?: BlacklistApiListBlacklistItemsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBlacklistItemsResponseClass, any, {}>>;
375
+ }