@emilgroup/partner-sdk 1.21.1-beta.2 → 1.21.1-beta.4

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 (33) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +2 -2
  3. package/api/blacklist-reasons-api.ts +780 -0
  4. package/api.ts +2 -0
  5. package/dist/api/blacklist-reasons-api.d.ts +440 -0
  6. package/dist/api/blacklist-reasons-api.js +728 -0
  7. package/dist/api.d.ts +1 -0
  8. package/dist/api.js +1 -0
  9. package/dist/models/blacklist-reason-class.d.ts +78 -0
  10. package/dist/models/blacklist-reason-class.js +15 -0
  11. package/dist/models/create-blacklist-reason-request-dto.d.ts +36 -0
  12. package/dist/models/create-blacklist-reason-request-dto.js +15 -0
  13. package/dist/models/create-blacklist-reason-response-class.d.ts +25 -0
  14. package/dist/models/create-blacklist-reason-response-class.js +15 -0
  15. package/dist/models/get-blacklist-reason-response-class.d.ts +25 -0
  16. package/dist/models/get-blacklist-reason-response-class.js +15 -0
  17. package/dist/models/index.d.ts +7 -0
  18. package/dist/models/index.js +7 -0
  19. package/dist/models/list-blacklist-reasons-response-class.d.ts +43 -0
  20. package/dist/models/list-blacklist-reasons-response-class.js +15 -0
  21. package/dist/models/update-blacklist-reason-request-dto.d.ts +30 -0
  22. package/dist/models/update-blacklist-reason-request-dto.js +15 -0
  23. package/dist/models/update-blacklist-reason-response-class.d.ts +25 -0
  24. package/dist/models/update-blacklist-reason-response-class.js +15 -0
  25. package/models/blacklist-reason-class.ts +84 -0
  26. package/models/create-blacklist-reason-request-dto.ts +42 -0
  27. package/models/create-blacklist-reason-response-class.ts +31 -0
  28. package/models/get-blacklist-reason-response-class.ts +31 -0
  29. package/models/index.ts +7 -0
  30. package/models/list-blacklist-reasons-response-class.ts +49 -0
  31. package/models/update-blacklist-reason-request-dto.ts +36 -0
  32. package/models/update-blacklist-reason-response-class.ts +31 -0
  33. package/package.json +1 -1
package/api.ts CHANGED
@@ -20,6 +20,7 @@ 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 { BlacklistReasonsApi } from './api';
23
24
  import { DefaultApi } from './api';
24
25
  import { PartnerInvitationsApi } from './api';
25
26
  import { PartnerRelationsApi } from './api';
@@ -29,6 +30,7 @@ import { PartnerVersionsApi } from './api';
29
30
  import { PartnersApi } from './api';
30
31
 
31
32
 
33
+ export * from './api/blacklist-reasons-api';
32
34
  export * from './api/default-api';
33
35
  export * from './api/partner-invitations-api';
34
36
  export * from './api/partner-relations-api';
@@ -0,0 +1,440 @@
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 { CreateBlacklistReasonRequestDto } from '../models';
16
+ import { CreateBlacklistReasonResponseClass } from '../models';
17
+ import { DeleteResponseClass } from '../models';
18
+ import { GetBlacklistReasonResponseClass } from '../models';
19
+ import { ListBlacklistReasonsResponseClass } from '../models';
20
+ import { UpdateBlacklistReasonRequestDto } from '../models';
21
+ import { UpdateBlacklistReasonResponseClass } from '../models';
22
+ /**
23
+ * BlacklistReasonsApi - axios parameter creator
24
+ * @export
25
+ */
26
+ export declare const BlacklistReasonsApiAxiosParamCreator: (configuration?: Configuration) => {
27
+ /**
28
+ * Create a new blacklist reason. **Required Permissions** \"partner-management.partners.create\"
29
+ * @summary Create the blacklist reason
30
+ * @param {CreateBlacklistReasonRequestDto} createBlacklistReasonRequestDto
31
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
32
+ * @param {*} [options] Override http request option.
33
+ * @throws {RequiredError}
34
+ */
35
+ createBlacklistReason: (createBlacklistReasonRequestDto: CreateBlacklistReasonRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
+ /**
37
+ * Permanently deletes the blacklist reason. Supply the unique code that was returned when you created the blacklist reason and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
38
+ * @summary Delete the blacklist reason
39
+ * @param {string} code Unique identifier for the object.
40
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ deleteBlacklistReason: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45
+ /**
46
+ * Retrieves the details of the blacklist reason that was previously created. Supply the unique blacklist reason code that was returned when you created it and Emil Api will return the corresponding blacklist reason information. **Required Permissions** \"partner-management.partners.view\"
47
+ * @summary Retrieve the blacklist reason
48
+ * @param {string} code Unique identifier for the object.
49
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
50
+ * @param {*} [options] Override http request option.
51
+ * @throws {RequiredError}
52
+ */
53
+ getBlacklistReason: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54
+ /**
55
+ * Returns a list of blacklist-reasons you have previously created. The blacklist-reasons 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\"
56
+ * @summary List blacklist-reasons
57
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
58
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
59
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
60
+ * @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, key, label, isActive, createdAt, updatedAt&lt;/i&gt;
61
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
62
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, key, label, createdAt, updatedAt&lt;/i&gt;
63
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
64
+ * @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, key, label, isActive, createdAt, updatedAt&lt;/i&gt;
65
+ * @param {*} [options] Override http request option.
66
+ * @throws {RequiredError}
67
+ */
68
+ listBlacklistReasons: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
+ /**
70
+ * Partially updates the specified blacklist reason by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
71
+ * @summary Update the blacklist reason
72
+ * @param {string} code Unique identifier for the object.
73
+ * @param {UpdateBlacklistReasonRequestDto} updateBlacklistReasonRequestDto
74
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
75
+ * @param {*} [options] Override http request option.
76
+ * @throws {RequiredError}
77
+ */
78
+ updateBlacklistReason: (code: string, updateBlacklistReasonRequestDto: UpdateBlacklistReasonRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
79
+ /**
80
+ * Partially updates the specified blacklist reason by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
81
+ * @summary Update blacklist reason status
82
+ * @param {string} code Unique identifier for the object.
83
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
84
+ * @param {*} [options] Override http request option.
85
+ * @throws {RequiredError}
86
+ */
87
+ updateBlacklistReasonStatus: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
88
+ };
89
+ /**
90
+ * BlacklistReasonsApi - functional programming interface
91
+ * @export
92
+ */
93
+ export declare const BlacklistReasonsApiFp: (configuration?: Configuration) => {
94
+ /**
95
+ * Create a new blacklist reason. **Required Permissions** \"partner-management.partners.create\"
96
+ * @summary Create the blacklist reason
97
+ * @param {CreateBlacklistReasonRequestDto} createBlacklistReasonRequestDto
98
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ createBlacklistReason(createBlacklistReasonRequestDto: CreateBlacklistReasonRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBlacklistReasonResponseClass>>;
103
+ /**
104
+ * Permanently deletes the blacklist reason. Supply the unique code that was returned when you created the blacklist reason and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
105
+ * @summary Delete the blacklist reason
106
+ * @param {string} code Unique identifier for the object.
107
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
108
+ * @param {*} [options] Override http request option.
109
+ * @throws {RequiredError}
110
+ */
111
+ deleteBlacklistReason(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
112
+ /**
113
+ * Retrieves the details of the blacklist reason that was previously created. Supply the unique blacklist reason code that was returned when you created it and Emil Api will return the corresponding blacklist reason information. **Required Permissions** \"partner-management.partners.view\"
114
+ * @summary Retrieve the blacklist reason
115
+ * @param {string} code Unique identifier for the object.
116
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
117
+ * @param {*} [options] Override http request option.
118
+ * @throws {RequiredError}
119
+ */
120
+ getBlacklistReason(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBlacklistReasonResponseClass>>;
121
+ /**
122
+ * Returns a list of blacklist-reasons you have previously created. The blacklist-reasons 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\"
123
+ * @summary List blacklist-reasons
124
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
125
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
126
+ * @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.
127
+ * @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, key, label, isActive, createdAt, updatedAt&lt;/i&gt;
128
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
129
+ * @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: id, code, key, label, createdAt, updatedAt&lt;/i&gt;
130
+ * @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;
131
+ * @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, key, label, isActive, createdAt, updatedAt&lt;/i&gt;
132
+ * @param {*} [options] Override http request option.
133
+ * @throws {RequiredError}
134
+ */
135
+ listBlacklistReasons(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBlacklistReasonsResponseClass>>;
136
+ /**
137
+ * Partially updates the specified blacklist reason by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
138
+ * @summary Update the blacklist reason
139
+ * @param {string} code Unique identifier for the object.
140
+ * @param {UpdateBlacklistReasonRequestDto} updateBlacklistReasonRequestDto
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
+ updateBlacklistReason(code: string, updateBlacklistReasonRequestDto: UpdateBlacklistReasonRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateBlacklistReasonResponseClass>>;
146
+ /**
147
+ * Partially updates the specified blacklist reason by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
148
+ * @summary Update blacklist reason status
149
+ * @param {string} code Unique identifier for the object.
150
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
151
+ * @param {*} [options] Override http request option.
152
+ * @throws {RequiredError}
153
+ */
154
+ updateBlacklistReasonStatus(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateBlacklistReasonResponseClass>>;
155
+ };
156
+ /**
157
+ * BlacklistReasonsApi - factory interface
158
+ * @export
159
+ */
160
+ export declare const BlacklistReasonsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
161
+ /**
162
+ * Create a new blacklist reason. **Required Permissions** \"partner-management.partners.create\"
163
+ * @summary Create the blacklist reason
164
+ * @param {CreateBlacklistReasonRequestDto} createBlacklistReasonRequestDto
165
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
166
+ * @param {*} [options] Override http request option.
167
+ * @throws {RequiredError}
168
+ */
169
+ createBlacklistReason(createBlacklistReasonRequestDto: CreateBlacklistReasonRequestDto, authorization?: string, options?: any): AxiosPromise<CreateBlacklistReasonResponseClass>;
170
+ /**
171
+ * Permanently deletes the blacklist reason. Supply the unique code that was returned when you created the blacklist reason and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
172
+ * @summary Delete the blacklist reason
173
+ * @param {string} code Unique identifier for the object.
174
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
175
+ * @param {*} [options] Override http request option.
176
+ * @throws {RequiredError}
177
+ */
178
+ deleteBlacklistReason(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
179
+ /**
180
+ * Retrieves the details of the blacklist reason that was previously created. Supply the unique blacklist reason code that was returned when you created it and Emil Api will return the corresponding blacklist reason information. **Required Permissions** \"partner-management.partners.view\"
181
+ * @summary Retrieve the blacklist reason
182
+ * @param {string} code Unique identifier for the object.
183
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
184
+ * @param {*} [options] Override http request option.
185
+ * @throws {RequiredError}
186
+ */
187
+ getBlacklistReason(code: string, authorization?: string, options?: any): AxiosPromise<GetBlacklistReasonResponseClass>;
188
+ /**
189
+ * Returns a list of blacklist-reasons you have previously created. The blacklist-reasons 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\"
190
+ * @summary List blacklist-reasons
191
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
192
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
193
+ * @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.
194
+ * @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, key, label, isActive, createdAt, updatedAt&lt;/i&gt;
195
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
196
+ * @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: id, code, key, label, createdAt, updatedAt&lt;/i&gt;
197
+ * @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;
198
+ * @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, key, label, isActive, createdAt, updatedAt&lt;/i&gt;
199
+ * @param {*} [options] Override http request option.
200
+ * @throws {RequiredError}
201
+ */
202
+ listBlacklistReasons(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBlacklistReasonsResponseClass>;
203
+ /**
204
+ * Partially updates the specified blacklist reason by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
205
+ * @summary Update the blacklist reason
206
+ * @param {string} code Unique identifier for the object.
207
+ * @param {UpdateBlacklistReasonRequestDto} updateBlacklistReasonRequestDto
208
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
209
+ * @param {*} [options] Override http request option.
210
+ * @throws {RequiredError}
211
+ */
212
+ updateBlacklistReason(code: string, updateBlacklistReasonRequestDto: UpdateBlacklistReasonRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateBlacklistReasonResponseClass>;
213
+ /**
214
+ * Partially updates the specified blacklist reason by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
215
+ * @summary Update blacklist reason status
216
+ * @param {string} code Unique identifier for the object.
217
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
218
+ * @param {*} [options] Override http request option.
219
+ * @throws {RequiredError}
220
+ */
221
+ updateBlacklistReasonStatus(code: string, authorization?: string, options?: any): AxiosPromise<UpdateBlacklistReasonResponseClass>;
222
+ };
223
+ /**
224
+ * Request parameters for createBlacklistReason operation in BlacklistReasonsApi.
225
+ * @export
226
+ * @interface BlacklistReasonsApiCreateBlacklistReasonRequest
227
+ */
228
+ export interface BlacklistReasonsApiCreateBlacklistReasonRequest {
229
+ /**
230
+ *
231
+ * @type {CreateBlacklistReasonRequestDto}
232
+ * @memberof BlacklistReasonsApiCreateBlacklistReason
233
+ */
234
+ readonly createBlacklistReasonRequestDto: CreateBlacklistReasonRequestDto;
235
+ /**
236
+ * Bearer Token: provided by the login endpoint under the name accessToken.
237
+ * @type {string}
238
+ * @memberof BlacklistReasonsApiCreateBlacklistReason
239
+ */
240
+ readonly authorization?: string;
241
+ }
242
+ /**
243
+ * Request parameters for deleteBlacklistReason operation in BlacklistReasonsApi.
244
+ * @export
245
+ * @interface BlacklistReasonsApiDeleteBlacklistReasonRequest
246
+ */
247
+ export interface BlacklistReasonsApiDeleteBlacklistReasonRequest {
248
+ /**
249
+ * Unique identifier for the object.
250
+ * @type {string}
251
+ * @memberof BlacklistReasonsApiDeleteBlacklistReason
252
+ */
253
+ readonly code: string;
254
+ /**
255
+ * Bearer Token: provided by the login endpoint under the name accessToken.
256
+ * @type {string}
257
+ * @memberof BlacklistReasonsApiDeleteBlacklistReason
258
+ */
259
+ readonly authorization?: string;
260
+ }
261
+ /**
262
+ * Request parameters for getBlacklistReason operation in BlacklistReasonsApi.
263
+ * @export
264
+ * @interface BlacklistReasonsApiGetBlacklistReasonRequest
265
+ */
266
+ export interface BlacklistReasonsApiGetBlacklistReasonRequest {
267
+ /**
268
+ * Unique identifier for the object.
269
+ * @type {string}
270
+ * @memberof BlacklistReasonsApiGetBlacklistReason
271
+ */
272
+ readonly code: string;
273
+ /**
274
+ * Bearer Token: provided by the login endpoint under the name accessToken.
275
+ * @type {string}
276
+ * @memberof BlacklistReasonsApiGetBlacklistReason
277
+ */
278
+ readonly authorization?: string;
279
+ }
280
+ /**
281
+ * Request parameters for listBlacklistReasons operation in BlacklistReasonsApi.
282
+ * @export
283
+ * @interface BlacklistReasonsApiListBlacklistReasonsRequest
284
+ */
285
+ export interface BlacklistReasonsApiListBlacklistReasonsRequest {
286
+ /**
287
+ * Bearer Token: provided by the login endpoint under the name accessToken.
288
+ * @type {string}
289
+ * @memberof BlacklistReasonsApiListBlacklistReasons
290
+ */
291
+ readonly authorization?: string;
292
+ /**
293
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
294
+ * @type {number}
295
+ * @memberof BlacklistReasonsApiListBlacklistReasons
296
+ */
297
+ readonly pageSize?: number;
298
+ /**
299
+ * 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.
300
+ * @type {string}
301
+ * @memberof BlacklistReasonsApiListBlacklistReasons
302
+ */
303
+ readonly pageToken?: string;
304
+ /**
305
+ * 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, key, label, isActive, createdAt, updatedAt&lt;/i&gt;
306
+ * @type {string}
307
+ * @memberof BlacklistReasonsApiListBlacklistReasons
308
+ */
309
+ readonly filter?: string;
310
+ /**
311
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
312
+ * @type {string}
313
+ * @memberof BlacklistReasonsApiListBlacklistReasons
314
+ */
315
+ readonly search?: string;
316
+ /**
317
+ * 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: id, code, key, label, createdAt, updatedAt&lt;/i&gt;
318
+ * @type {string}
319
+ * @memberof BlacklistReasonsApiListBlacklistReasons
320
+ */
321
+ readonly order?: string;
322
+ /**
323
+ * 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;
324
+ * @type {string}
325
+ * @memberof BlacklistReasonsApiListBlacklistReasons
326
+ */
327
+ readonly expand?: string;
328
+ /**
329
+ * 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, key, label, isActive, createdAt, updatedAt&lt;/i&gt;
330
+ * @type {string}
331
+ * @memberof BlacklistReasonsApiListBlacklistReasons
332
+ */
333
+ readonly filters?: string;
334
+ }
335
+ /**
336
+ * Request parameters for updateBlacklistReason operation in BlacklistReasonsApi.
337
+ * @export
338
+ * @interface BlacklistReasonsApiUpdateBlacklistReasonRequest
339
+ */
340
+ export interface BlacklistReasonsApiUpdateBlacklistReasonRequest {
341
+ /**
342
+ * Unique identifier for the object.
343
+ * @type {string}
344
+ * @memberof BlacklistReasonsApiUpdateBlacklistReason
345
+ */
346
+ readonly code: string;
347
+ /**
348
+ *
349
+ * @type {UpdateBlacklistReasonRequestDto}
350
+ * @memberof BlacklistReasonsApiUpdateBlacklistReason
351
+ */
352
+ readonly updateBlacklistReasonRequestDto: UpdateBlacklistReasonRequestDto;
353
+ /**
354
+ * Bearer Token: provided by the login endpoint under the name accessToken.
355
+ * @type {string}
356
+ * @memberof BlacklistReasonsApiUpdateBlacklistReason
357
+ */
358
+ readonly authorization?: string;
359
+ }
360
+ /**
361
+ * Request parameters for updateBlacklistReasonStatus operation in BlacklistReasonsApi.
362
+ * @export
363
+ * @interface BlacklistReasonsApiUpdateBlacklistReasonStatusRequest
364
+ */
365
+ export interface BlacklistReasonsApiUpdateBlacklistReasonStatusRequest {
366
+ /**
367
+ * Unique identifier for the object.
368
+ * @type {string}
369
+ * @memberof BlacklistReasonsApiUpdateBlacklistReasonStatus
370
+ */
371
+ readonly code: string;
372
+ /**
373
+ * Bearer Token: provided by the login endpoint under the name accessToken.
374
+ * @type {string}
375
+ * @memberof BlacklistReasonsApiUpdateBlacklistReasonStatus
376
+ */
377
+ readonly authorization?: string;
378
+ }
379
+ /**
380
+ * BlacklistReasonsApi - object-oriented interface
381
+ * @export
382
+ * @class BlacklistReasonsApi
383
+ * @extends {BaseAPI}
384
+ */
385
+ export declare class BlacklistReasonsApi extends BaseAPI {
386
+ /**
387
+ * Create a new blacklist reason. **Required Permissions** \"partner-management.partners.create\"
388
+ * @summary Create the blacklist reason
389
+ * @param {BlacklistReasonsApiCreateBlacklistReasonRequest} requestParameters Request parameters.
390
+ * @param {*} [options] Override http request option.
391
+ * @throws {RequiredError}
392
+ * @memberof BlacklistReasonsApi
393
+ */
394
+ createBlacklistReason(requestParameters: BlacklistReasonsApiCreateBlacklistReasonRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBlacklistReasonResponseClass, any, {}>>;
395
+ /**
396
+ * Permanently deletes the blacklist reason. Supply the unique code that was returned when you created the blacklist reason and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
397
+ * @summary Delete the blacklist reason
398
+ * @param {BlacklistReasonsApiDeleteBlacklistReasonRequest} requestParameters Request parameters.
399
+ * @param {*} [options] Override http request option.
400
+ * @throws {RequiredError}
401
+ * @memberof BlacklistReasonsApi
402
+ */
403
+ deleteBlacklistReason(requestParameters: BlacklistReasonsApiDeleteBlacklistReasonRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any, {}>>;
404
+ /**
405
+ * Retrieves the details of the blacklist reason that was previously created. Supply the unique blacklist reason code that was returned when you created it and Emil Api will return the corresponding blacklist reason information. **Required Permissions** \"partner-management.partners.view\"
406
+ * @summary Retrieve the blacklist reason
407
+ * @param {BlacklistReasonsApiGetBlacklistReasonRequest} requestParameters Request parameters.
408
+ * @param {*} [options] Override http request option.
409
+ * @throws {RequiredError}
410
+ * @memberof BlacklistReasonsApi
411
+ */
412
+ getBlacklistReason(requestParameters: BlacklistReasonsApiGetBlacklistReasonRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBlacklistReasonResponseClass, any, {}>>;
413
+ /**
414
+ * Returns a list of blacklist-reasons you have previously created. The blacklist-reasons 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\"
415
+ * @summary List blacklist-reasons
416
+ * @param {BlacklistReasonsApiListBlacklistReasonsRequest} requestParameters Request parameters.
417
+ * @param {*} [options] Override http request option.
418
+ * @throws {RequiredError}
419
+ * @memberof BlacklistReasonsApi
420
+ */
421
+ listBlacklistReasons(requestParameters?: BlacklistReasonsApiListBlacklistReasonsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBlacklistReasonsResponseClass, any, {}>>;
422
+ /**
423
+ * Partially updates the specified blacklist reason by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
424
+ * @summary Update the blacklist reason
425
+ * @param {BlacklistReasonsApiUpdateBlacklistReasonRequest} requestParameters Request parameters.
426
+ * @param {*} [options] Override http request option.
427
+ * @throws {RequiredError}
428
+ * @memberof BlacklistReasonsApi
429
+ */
430
+ updateBlacklistReason(requestParameters: BlacklistReasonsApiUpdateBlacklistReasonRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateBlacklistReasonResponseClass, any, {}>>;
431
+ /**
432
+ * Partially updates the specified blacklist reason by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
433
+ * @summary Update blacklist reason status
434
+ * @param {BlacklistReasonsApiUpdateBlacklistReasonStatusRequest} requestParameters Request parameters.
435
+ * @param {*} [options] Override http request option.
436
+ * @throws {RequiredError}
437
+ * @memberof BlacklistReasonsApi
438
+ */
439
+ updateBlacklistReasonStatus(requestParameters: BlacklistReasonsApiUpdateBlacklistReasonStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateBlacklistReasonResponseClass, any, {}>>;
440
+ }