@emilgroup/partner-sdk 1.22.1-beta.1 → 1.22.1-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +9 -1
- package/README.md +2 -2
- package/api/blacklist-api.ts +662 -0
- package/api/blacklist-reasons-api.ts +23 -6
- package/api/{default-api.ts → health-api.ts} +13 -13
- package/api.ts +4 -2
- package/dist/api/blacklist-api.d.ts +375 -0
- package/dist/api/blacklist-api.js +629 -0
- package/dist/api/blacklist-reasons-api.d.ts +13 -3
- package/dist/api/blacklist-reasons-api.js +13 -6
- package/dist/api/{default-api.d.ts → health-api.d.ts} +10 -10
- package/dist/api/{default-api.js → health-api.js} +22 -22
- package/dist/api.d.ts +2 -1
- package/dist/api.js +2 -1
- package/dist/models/blacklist-item-class.d.ts +78 -0
- package/dist/models/blacklist-item-class.js +15 -0
- package/dist/models/create-blacklist-item-request-dto.d.ts +36 -0
- package/dist/models/create-blacklist-item-request-dto.js +15 -0
- package/dist/models/create-blacklist-item-response-class.d.ts +25 -0
- package/dist/models/create-blacklist-item-response-class.js +15 -0
- package/dist/models/get-blacklist-item-response-class.d.ts +25 -0
- package/dist/models/get-blacklist-item-response-class.js +15 -0
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/models/is-blacklisted-response-class.d.ts +54 -0
- package/dist/models/is-blacklisted-response-class.js +15 -0
- package/dist/models/list-blacklist-items-response-class.d.ts +43 -0
- package/dist/models/list-blacklist-items-response-class.js +15 -0
- package/dist/models/list-partner-relation-class.d.ts +18 -6
- package/dist/models/list-partner-relation-types-class.d.ts +18 -6
- package/dist/models/list-partner-types-response-class.d.ts +18 -6
- package/dist/models/list-partner-versions-response-class.d.ts +18 -6
- package/dist/models/list-partners-response-class.d.ts +18 -6
- package/dist/models/list-related-partners-response-class.d.ts +18 -6
- package/dist/models/list-tags-response-class.d.ts +18 -6
- package/dist/models/update-blacklist-reason-status-request-dto.d.ts +24 -0
- package/dist/models/update-blacklist-reason-status-request-dto.js +15 -0
- package/models/blacklist-item-class.ts +84 -0
- package/models/create-blacklist-item-request-dto.ts +42 -0
- package/models/create-blacklist-item-response-class.ts +31 -0
- package/models/get-blacklist-item-response-class.ts +31 -0
- package/models/index.ts +7 -0
- package/models/is-blacklisted-response-class.ts +60 -0
- package/models/list-blacklist-items-response-class.ts +49 -0
- package/models/list-partner-relation-class.ts +18 -6
- package/models/list-partner-relation-types-class.ts +18 -6
- package/models/list-partner-types-response-class.ts +18 -6
- package/models/list-partner-versions-response-class.ts +18 -6
- package/models/list-partners-response-class.ts +18 -6
- package/models/list-related-partners-response-class.ts +18 -6
- package/models/list-tags-response-class.ts +18 -6
- package/models/update-blacklist-reason-status-request-dto.ts +30 -0
- package/package.json +1 -1
|
@@ -34,6 +34,8 @@ import { ListBlacklistReasonsResponseClass } from '../models';
|
|
|
34
34
|
import { UpdateBlacklistReasonRequestDto } from '../models';
|
|
35
35
|
// @ts-ignore
|
|
36
36
|
import { UpdateBlacklistReasonResponseClass } from '../models';
|
|
37
|
+
// @ts-ignore
|
|
38
|
+
import { UpdateBlacklistReasonStatusRequestDto } from '../models';
|
|
37
39
|
/**
|
|
38
40
|
* BlacklistReasonsApi - axios parameter creator
|
|
39
41
|
* @export
|
|
@@ -308,13 +310,16 @@ export const BlacklistReasonsApiAxiosParamCreator = function (configuration?: Co
|
|
|
308
310
|
* 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\"
|
|
309
311
|
* @summary Update blacklist reason status
|
|
310
312
|
* @param {string} code Unique identifier for the object.
|
|
313
|
+
* @param {UpdateBlacklistReasonStatusRequestDto} updateBlacklistReasonStatusRequestDto
|
|
311
314
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
312
315
|
* @param {*} [options] Override http request option.
|
|
313
316
|
* @throws {RequiredError}
|
|
314
317
|
*/
|
|
315
|
-
updateBlacklistReasonStatus: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
318
|
+
updateBlacklistReasonStatus: async (code: string, updateBlacklistReasonStatusRequestDto: UpdateBlacklistReasonStatusRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
316
319
|
// verify required parameter 'code' is not null or undefined
|
|
317
320
|
assertParamExists('updateBlacklistReasonStatus', 'code', code)
|
|
321
|
+
// verify required parameter 'updateBlacklistReasonStatusRequestDto' is not null or undefined
|
|
322
|
+
assertParamExists('updateBlacklistReasonStatus', 'updateBlacklistReasonStatusRequestDto', updateBlacklistReasonStatusRequestDto)
|
|
318
323
|
const localVarPath = `/partnerservice/v1/blacklist-reasons/{code}/status`
|
|
319
324
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
320
325
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -340,9 +345,12 @@ export const BlacklistReasonsApiAxiosParamCreator = function (configuration?: Co
|
|
|
340
345
|
|
|
341
346
|
|
|
342
347
|
|
|
348
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
349
|
+
|
|
343
350
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
344
351
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
345
352
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
353
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateBlacklistReasonStatusRequestDto, localVarRequestOptions, configuration)
|
|
346
354
|
|
|
347
355
|
return {
|
|
348
356
|
url: toPathString(localVarUrlObj),
|
|
@@ -430,12 +438,13 @@ export const BlacklistReasonsApiFp = function(configuration?: Configuration) {
|
|
|
430
438
|
* 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\"
|
|
431
439
|
* @summary Update blacklist reason status
|
|
432
440
|
* @param {string} code Unique identifier for the object.
|
|
441
|
+
* @param {UpdateBlacklistReasonStatusRequestDto} updateBlacklistReasonStatusRequestDto
|
|
433
442
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
434
443
|
* @param {*} [options] Override http request option.
|
|
435
444
|
* @throws {RequiredError}
|
|
436
445
|
*/
|
|
437
|
-
async updateBlacklistReasonStatus(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateBlacklistReasonResponseClass>> {
|
|
438
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateBlacklistReasonStatus(code, authorization, options);
|
|
446
|
+
async updateBlacklistReasonStatus(code: string, updateBlacklistReasonStatusRequestDto: UpdateBlacklistReasonStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateBlacklistReasonResponseClass>> {
|
|
447
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateBlacklistReasonStatus(code, updateBlacklistReasonStatusRequestDto, authorization, options);
|
|
439
448
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
440
449
|
},
|
|
441
450
|
}
|
|
@@ -514,12 +523,13 @@ export const BlacklistReasonsApiFactory = function (configuration?: Configuratio
|
|
|
514
523
|
* 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\"
|
|
515
524
|
* @summary Update blacklist reason status
|
|
516
525
|
* @param {string} code Unique identifier for the object.
|
|
526
|
+
* @param {UpdateBlacklistReasonStatusRequestDto} updateBlacklistReasonStatusRequestDto
|
|
517
527
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
518
528
|
* @param {*} [options] Override http request option.
|
|
519
529
|
* @throws {RequiredError}
|
|
520
530
|
*/
|
|
521
|
-
updateBlacklistReasonStatus(code: string, authorization?: string, options?: any): AxiosPromise<UpdateBlacklistReasonResponseClass> {
|
|
522
|
-
return localVarFp.updateBlacklistReasonStatus(code, authorization, options).then((request) => request(axios, basePath));
|
|
531
|
+
updateBlacklistReasonStatus(code: string, updateBlacklistReasonStatusRequestDto: UpdateBlacklistReasonStatusRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateBlacklistReasonResponseClass> {
|
|
532
|
+
return localVarFp.updateBlacklistReasonStatus(code, updateBlacklistReasonStatusRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
523
533
|
},
|
|
524
534
|
};
|
|
525
535
|
};
|
|
@@ -691,6 +701,13 @@ export interface BlacklistReasonsApiUpdateBlacklistReasonStatusRequest {
|
|
|
691
701
|
*/
|
|
692
702
|
readonly code: string
|
|
693
703
|
|
|
704
|
+
/**
|
|
705
|
+
*
|
|
706
|
+
* @type {UpdateBlacklistReasonStatusRequestDto}
|
|
707
|
+
* @memberof BlacklistReasonsApiUpdateBlacklistReasonStatus
|
|
708
|
+
*/
|
|
709
|
+
readonly updateBlacklistReasonStatusRequestDto: UpdateBlacklistReasonStatusRequestDto
|
|
710
|
+
|
|
694
711
|
/**
|
|
695
712
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
696
713
|
* @type {string}
|
|
@@ -775,6 +792,6 @@ export class BlacklistReasonsApi extends BaseAPI {
|
|
|
775
792
|
* @memberof BlacklistReasonsApi
|
|
776
793
|
*/
|
|
777
794
|
public updateBlacklistReasonStatus(requestParameters: BlacklistReasonsApiUpdateBlacklistReasonStatusRequest, options?: AxiosRequestConfig) {
|
|
778
|
-
return BlacklistReasonsApiFp(this.configuration).updateBlacklistReasonStatus(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
795
|
+
return BlacklistReasonsApiFp(this.configuration).updateBlacklistReasonStatus(requestParameters.code, requestParameters.updateBlacklistReasonStatusRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
779
796
|
}
|
|
780
797
|
}
|
|
@@ -25,10 +25,10 @@ import { InlineResponse200 } from '../models';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { InlineResponse503 } from '../models';
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* HealthApi - axios parameter creator
|
|
29
29
|
* @export
|
|
30
30
|
*/
|
|
31
|
-
export const
|
|
31
|
+
export const HealthApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
32
|
return {
|
|
33
33
|
/**
|
|
34
34
|
* Returns the health status of the partner service. This endpoint is used to monitor the operational status of the partner service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
@@ -66,11 +66,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
66
66
|
};
|
|
67
67
|
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* HealthApi - functional programming interface
|
|
70
70
|
* @export
|
|
71
71
|
*/
|
|
72
|
-
export const
|
|
73
|
-
const localVarAxiosParamCreator =
|
|
72
|
+
export const HealthApiFp = function(configuration?: Configuration) {
|
|
73
|
+
const localVarAxiosParamCreator = HealthApiAxiosParamCreator(configuration)
|
|
74
74
|
return {
|
|
75
75
|
/**
|
|
76
76
|
* Returns the health status of the partner service. This endpoint is used to monitor the operational status of the partner service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
@@ -86,11 +86,11 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
86
86
|
};
|
|
87
87
|
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* HealthApi - factory interface
|
|
90
90
|
* @export
|
|
91
91
|
*/
|
|
92
|
-
export const
|
|
93
|
-
const localVarFp =
|
|
92
|
+
export const HealthApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
93
|
+
const localVarFp = HealthApiFp(configuration)
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
96
|
* Returns the health status of the partner service. This endpoint is used to monitor the operational status of the partner service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
@@ -105,20 +105,20 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
105
105
|
};
|
|
106
106
|
|
|
107
107
|
/**
|
|
108
|
-
*
|
|
108
|
+
* HealthApi - object-oriented interface
|
|
109
109
|
* @export
|
|
110
|
-
* @class
|
|
110
|
+
* @class HealthApi
|
|
111
111
|
* @extends {BaseAPI}
|
|
112
112
|
*/
|
|
113
|
-
export class
|
|
113
|
+
export class HealthApi extends BaseAPI {
|
|
114
114
|
/**
|
|
115
115
|
* Returns the health status of the partner service. This endpoint is used to monitor the operational status of the partner service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
116
116
|
* @summary Health Check
|
|
117
117
|
* @param {*} [options] Override http request option.
|
|
118
118
|
* @throws {RequiredError}
|
|
119
|
-
* @memberof
|
|
119
|
+
* @memberof HealthApi
|
|
120
120
|
*/
|
|
121
121
|
public check(options?: AxiosRequestConfig) {
|
|
122
|
-
return
|
|
122
|
+
return HealthApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
|
|
123
123
|
}
|
|
124
124
|
}
|
package/api.ts
CHANGED
|
@@ -20,8 +20,9 @@ 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';
|
|
23
24
|
import { BlacklistReasonsApi } from './api';
|
|
24
|
-
import {
|
|
25
|
+
import { HealthApi } from './api';
|
|
25
26
|
import { PartnerInvitationsApi } from './api';
|
|
26
27
|
import { PartnerRelationsApi } from './api';
|
|
27
28
|
import { PartnerTagsApi } from './api';
|
|
@@ -30,8 +31,9 @@ import { PartnerVersionsApi } from './api';
|
|
|
30
31
|
import { PartnersApi } from './api';
|
|
31
32
|
|
|
32
33
|
|
|
34
|
+
export * from './api/blacklist-api';
|
|
33
35
|
export * from './api/blacklist-reasons-api';
|
|
34
|
-
export * from './api/
|
|
36
|
+
export * from './api/health-api';
|
|
35
37
|
export * from './api/partner-invitations-api';
|
|
36
38
|
export * from './api/partner-relations-api';
|
|
37
39
|
export * from './api/partner-tags-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=1, your subsequent call can include pageToken=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.<br/> <br/> <i>Allowed values: code, partnerCode, reasonCode, blockedFrom</i>
|
|
69
|
+
* @param {string} [search] To search the list by any field, pass search=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.<br/> <br/> <i>Allowed values: code, partnerCode, reasonCode, blockedFrom, createdAt, updatedAt</i>
|
|
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.<br/> <br/>
|
|
72
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerCode, reasonCode, blockedFrom</i>
|
|
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=1, your subsequent call can include pageToken=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.<br/> <br/> <i>Allowed values: code, partnerCode, reasonCode, blockedFrom</i>
|
|
126
|
+
* @param {string} [search] To search the list by any field, pass search=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.<br/> <br/> <i>Allowed values: code, partnerCode, reasonCode, blockedFrom, createdAt, updatedAt</i>
|
|
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.<br/> <br/>
|
|
129
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerCode, reasonCode, blockedFrom</i>
|
|
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=1, your subsequent call can include pageToken=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.<br/> <br/> <i>Allowed values: code, partnerCode, reasonCode, blockedFrom</i>
|
|
183
|
+
* @param {string} [search] To search the list by any field, pass search=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.<br/> <br/> <i>Allowed values: code, partnerCode, reasonCode, blockedFrom, createdAt, updatedAt</i>
|
|
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.<br/> <br/>
|
|
186
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, partnerCode, reasonCode, blockedFrom</i>
|
|
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=1, your subsequent call can include pageToken=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.<br/> <br/> <i>Allowed values: code, partnerCode, reasonCode, blockedFrom</i>
|
|
294
|
+
* @type {string}
|
|
295
|
+
* @memberof BlacklistApiListBlacklistItems
|
|
296
|
+
*/
|
|
297
|
+
readonly filter?: string;
|
|
298
|
+
/**
|
|
299
|
+
* To search the list by any field, pass search=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.<br/> <br/> <i>Allowed values: code, partnerCode, reasonCode, blockedFrom, createdAt, updatedAt</i>
|
|
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.<br/> <br/>
|
|
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.<br/> <br/> <i>Allowed values: code, partnerCode, reasonCode, blockedFrom</i>
|
|
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
|
+
}
|