@emilgroup/partner-sdk 1.22.1-beta.16 → 1.22.1-beta.17
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 +49 -1
- package/README.md +2 -2
- package/api/blacklist-api.ts +662 -0
- package/api/blacklist-reasons-api.ts +797 -0
- package/api/{default-api.ts → health-api.ts} +13 -13
- package/api/partner-hierarchies-api.ts +1342 -0
- package/api/partner-hierarchy-nodes-api.ts +1178 -0
- package/api/partner-hierarchy-types-api.ts +679 -0
- package/api/partners-api.ts +12 -12
- package/api.ts +12 -2
- package/base.ts +1 -0
- 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 +450 -0
- package/dist/api/blacklist-reasons-api.js +735 -0
- 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/partner-hierarchies-api.d.ts +760 -0
- package/dist/api/partner-hierarchies-api.js +1164 -0
- package/dist/api/partner-hierarchy-nodes-api.d.ts +663 -0
- package/dist/api/partner-hierarchy-nodes-api.js +1043 -0
- package/dist/api/partner-hierarchy-types-api.d.ts +385 -0
- package/dist/api/partner-hierarchy-types-api.js +636 -0
- package/dist/api/partners-api.d.ts +12 -12
- package/dist/api/partners-api.js +9 -9
- package/dist/api.d.ts +6 -1
- package/dist/api.js +6 -1
- package/dist/base.d.ts +2 -1
- package/dist/base.js +1 -0
- package/dist/models/blacklist-item-class.d.ts +78 -0
- package/dist/models/blacklist-item-class.js +15 -0
- package/dist/models/blacklist-reason-class.d.ts +78 -0
- package/dist/models/blacklist-reason-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/create-blacklist-reason-request-dto.d.ts +36 -0
- package/dist/models/create-blacklist-reason-request-dto.js +15 -0
- package/dist/models/create-blacklist-reason-response-class.d.ts +25 -0
- package/dist/models/create-blacklist-reason-response-class.js +15 -0
- package/dist/models/create-partner-hierarchy-node-request-dto.d.ts +42 -0
- package/dist/models/create-partner-hierarchy-node-request-dto.js +15 -0
- package/dist/models/create-partner-hierarchy-node-response-class.d.ts +25 -0
- package/dist/models/create-partner-hierarchy-node-response-class.js +15 -0
- package/dist/models/create-partner-hierarchy-request-dto.d.ts +30 -0
- package/dist/models/create-partner-hierarchy-request-dto.js +15 -0
- package/dist/models/create-partner-hierarchy-response-class.d.ts +25 -0
- package/dist/models/create-partner-hierarchy-response-class.js +15 -0
- package/dist/models/create-partner-hierarchy-type-request-dto.d.ts +30 -0
- package/dist/models/create-partner-hierarchy-type-request-dto.js +15 -0
- package/dist/models/create-partner-hierarchy-type-response-class.d.ts +25 -0
- package/dist/models/create-partner-hierarchy-type-response-class.js +15 -0
- package/dist/models/delete-by-code-response-class.d.ts +24 -0
- package/dist/models/delete-by-code-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/get-blacklist-reason-response-class.d.ts +25 -0
- package/dist/models/get-blacklist-reason-response-class.js +15 -0
- package/dist/models/get-partner-hierarchy-node-response-class.d.ts +25 -0
- package/dist/models/get-partner-hierarchy-node-response-class.js +15 -0
- package/dist/models/get-partner-hierarchy-response-class.d.ts +25 -0
- package/dist/models/get-partner-hierarchy-response-class.js +15 -0
- package/dist/models/get-partner-hierarchy-tree-response-class.d.ts +25 -0
- package/dist/models/get-partner-hierarchy-tree-response-class.js +15 -0
- package/dist/models/get-partner-hierarchy-type-response-class.d.ts +25 -0
- package/dist/models/get-partner-hierarchy-type-response-class.js +15 -0
- package/dist/models/index.d.ts +43 -0
- package/dist/models/index.js +43 -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-blacklist-reasons-response-class.d.ts +43 -0
- package/dist/models/list-blacklist-reasons-response-class.js +15 -0
- package/dist/models/list-partner-hierarchies-response-class.d.ts +43 -0
- package/dist/models/list-partner-hierarchies-response-class.js +15 -0
- package/dist/models/list-partner-hierarchy-node-history-response-class.d.ts +43 -0
- package/dist/models/list-partner-hierarchy-node-history-response-class.js +15 -0
- package/dist/models/list-partner-hierarchy-nodes-response-class.d.ts +43 -0
- package/dist/models/list-partner-hierarchy-nodes-response-class.js +15 -0
- package/dist/models/list-partner-hierarchy-types-response-class.d.ts +43 -0
- package/dist/models/list-partner-hierarchy-types-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/move-partner-hierarchy-node-request-dto.d.ts +30 -0
- package/dist/models/move-partner-hierarchy-node-request-dto.js +15 -0
- package/dist/models/move-partner-hierarchy-node-response-class.d.ts +25 -0
- package/dist/models/move-partner-hierarchy-node-response-class.js +15 -0
- package/dist/models/partner-hierarchy-class.d.ts +78 -0
- package/dist/models/partner-hierarchy-class.js +15 -0
- package/dist/models/partner-hierarchy-node-class.d.ts +109 -0
- package/dist/models/partner-hierarchy-node-class.js +15 -0
- package/dist/models/partner-hierarchy-node-history-class.d.ts +97 -0
- package/dist/models/partner-hierarchy-node-history-class.js +15 -0
- package/dist/models/partner-hierarchy-node-tree-class.d.ts +96 -0
- package/dist/models/partner-hierarchy-node-tree-class.js +15 -0
- package/dist/models/partner-hierarchy-type-class.d.ts +66 -0
- package/dist/models/partner-hierarchy-type-class.js +15 -0
- package/dist/models/unassign-partner-hierarchy-node-response-class.d.ts +25 -0
- package/dist/models/unassign-partner-hierarchy-node-response-class.js +15 -0
- package/dist/models/update-blacklist-reason-request-dto.d.ts +30 -0
- package/dist/models/update-blacklist-reason-request-dto.js +15 -0
- package/dist/models/update-blacklist-reason-response-class.d.ts +25 -0
- package/dist/models/update-blacklist-reason-response-class.js +15 -0
- 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/dist/models/update-partner-hierarchy-node-request-dto.d.ts +30 -0
- package/dist/models/update-partner-hierarchy-node-request-dto.js +15 -0
- package/dist/models/update-partner-hierarchy-node-response-class.d.ts +25 -0
- package/dist/models/update-partner-hierarchy-node-response-class.js +15 -0
- package/dist/models/update-partner-hierarchy-request-dto.d.ts +24 -0
- package/dist/models/update-partner-hierarchy-request-dto.js +15 -0
- package/dist/models/update-partner-hierarchy-response-class.d.ts +25 -0
- package/dist/models/update-partner-hierarchy-response-class.js +15 -0
- package/dist/models/update-partner-hierarchy-type-request-dto.d.ts +30 -0
- package/dist/models/update-partner-hierarchy-type-request-dto.js +15 -0
- package/dist/models/update-partner-hierarchy-type-response-class.d.ts +25 -0
- package/dist/models/update-partner-hierarchy-type-response-class.js +15 -0
- package/models/blacklist-item-class.ts +84 -0
- package/models/blacklist-reason-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/create-blacklist-reason-request-dto.ts +42 -0
- package/models/create-blacklist-reason-response-class.ts +31 -0
- package/models/create-partner-hierarchy-node-request-dto.ts +48 -0
- package/models/create-partner-hierarchy-node-response-class.ts +31 -0
- package/models/create-partner-hierarchy-request-dto.ts +36 -0
- package/models/create-partner-hierarchy-response-class.ts +31 -0
- package/models/create-partner-hierarchy-type-request-dto.ts +36 -0
- package/models/create-partner-hierarchy-type-response-class.ts +31 -0
- package/models/delete-by-code-response-class.ts +30 -0
- package/models/get-blacklist-item-response-class.ts +31 -0
- package/models/get-blacklist-reason-response-class.ts +31 -0
- package/models/get-partner-hierarchy-node-response-class.ts +31 -0
- package/models/get-partner-hierarchy-response-class.ts +31 -0
- package/models/get-partner-hierarchy-tree-response-class.ts +31 -0
- package/models/get-partner-hierarchy-type-response-class.ts +31 -0
- package/models/index.ts +43 -0
- package/models/is-blacklisted-response-class.ts +60 -0
- package/models/list-blacklist-items-response-class.ts +49 -0
- package/models/list-blacklist-reasons-response-class.ts +49 -0
- package/models/list-partner-hierarchies-response-class.ts +49 -0
- package/models/list-partner-hierarchy-node-history-response-class.ts +49 -0
- package/models/list-partner-hierarchy-nodes-response-class.ts +49 -0
- package/models/list-partner-hierarchy-types-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/move-partner-hierarchy-node-request-dto.ts +36 -0
- package/models/move-partner-hierarchy-node-response-class.ts +31 -0
- package/models/partner-hierarchy-class.ts +84 -0
- package/models/partner-hierarchy-node-class.ts +115 -0
- package/models/partner-hierarchy-node-history-class.ts +103 -0
- package/models/partner-hierarchy-node-tree-class.ts +102 -0
- package/models/partner-hierarchy-type-class.ts +72 -0
- package/models/unassign-partner-hierarchy-node-response-class.ts +31 -0
- package/models/update-blacklist-reason-request-dto.ts +36 -0
- package/models/update-blacklist-reason-response-class.ts +31 -0
- package/models/update-blacklist-reason-status-request-dto.ts +30 -0
- package/models/update-partner-hierarchy-node-request-dto.ts +36 -0
- package/models/update-partner-hierarchy-node-response-class.ts +31 -0
- package/models/update-partner-hierarchy-request-dto.ts +30 -0
- package/models/update-partner-hierarchy-response-class.ts +31 -0
- package/models/update-partner-hierarchy-type-request-dto.ts +36 -0
- package/models/update-partner-hierarchy-type-response-class.ts +31 -0
- package/package.json +1 -1
package/api/partners-api.ts
CHANGED
|
@@ -294,11 +294,11 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
294
294
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
295
295
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
296
296
|
* @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.
|
|
297
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
297
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode, subPartnersCount</i>
|
|
298
298
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
299
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs, partnerNumber, partnerType.name, partnerTagLabels.tagLabels</i>
|
|
299
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs, partnerNumber, partnerType.name, partnerTagLabels.tagLabels, subPartnersCount</i>
|
|
300
300
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags, partnerTagLabels<i>
|
|
301
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
301
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode, subPartnersCount</i>
|
|
302
302
|
* @param {*} [options] Override http request option.
|
|
303
303
|
* @throws {RequiredError}
|
|
304
304
|
*/
|
|
@@ -674,11 +674,11 @@ export const PartnersApiFp = function(configuration?: Configuration) {
|
|
|
674
674
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
675
675
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
676
676
|
* @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.
|
|
677
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
677
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode, subPartnersCount</i>
|
|
678
678
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
679
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs, partnerNumber, partnerType.name, partnerTagLabels.tagLabels</i>
|
|
679
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs, partnerNumber, partnerType.name, partnerTagLabels.tagLabels, subPartnersCount</i>
|
|
680
680
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags, partnerTagLabels<i>
|
|
681
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
681
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode, subPartnersCount</i>
|
|
682
682
|
* @param {*} [options] Override http request option.
|
|
683
683
|
* @throws {RequiredError}
|
|
684
684
|
*/
|
|
@@ -816,11 +816,11 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
|
|
|
816
816
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
817
817
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
818
818
|
* @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.
|
|
819
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
819
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode, subPartnersCount</i>
|
|
820
820
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
821
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs, partnerNumber, partnerType.name, partnerTagLabels.tagLabels</i>
|
|
821
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs, partnerNumber, partnerType.name, partnerTagLabels.tagLabels, subPartnersCount</i>
|
|
822
822
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: partnerType, tags, partnerTagLabels<i>
|
|
823
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
823
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode, subPartnersCount</i>
|
|
824
824
|
* @param {*} [options] Override http request option.
|
|
825
825
|
* @throws {RequiredError}
|
|
826
826
|
*/
|
|
@@ -1024,7 +1024,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
1024
1024
|
readonly pageToken?: string
|
|
1025
1025
|
|
|
1026
1026
|
/**
|
|
1027
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
1027
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode, subPartnersCount</i>
|
|
1028
1028
|
* @type {string}
|
|
1029
1029
|
* @memberof PartnersApiListPartners
|
|
1030
1030
|
*/
|
|
@@ -1038,7 +1038,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
1038
1038
|
readonly search?: string
|
|
1039
1039
|
|
|
1040
1040
|
/**
|
|
1041
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs, partnerNumber, partnerType.name, partnerTagLabels.tagLabels</i>
|
|
1041
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, version, tags, tagSlugs, partnerNumber, partnerType.name, partnerTagLabels.tagLabels, subPartnersCount</i>
|
|
1042
1042
|
* @type {string}
|
|
1043
1043
|
* @memberof PartnersApiListPartners
|
|
1044
1044
|
*/
|
|
@@ -1052,7 +1052,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
1052
1052
|
readonly expand?: string
|
|
1053
1053
|
|
|
1054
1054
|
/**
|
|
1055
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode</i>
|
|
1055
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, createdAt, updatedAt, tags, tagSlugs, partnerTypeCodes, partnerTypeId, tenantUserCode, partnerNumber, accountCode, subPartnersCount</i>
|
|
1056
1056
|
* @type {string}
|
|
1057
1057
|
* @memberof PartnersApiListPartners
|
|
1058
1058
|
*/
|
package/api.ts
CHANGED
|
@@ -20,7 +20,12 @@ 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 {
|
|
23
|
+
import { BlacklistApi } from './api';
|
|
24
|
+
import { BlacklistReasonsApi } from './api';
|
|
25
|
+
import { HealthApi } from './api';
|
|
26
|
+
import { PartnerHierarchiesApi } from './api';
|
|
27
|
+
import { PartnerHierarchyNodesApi } from './api';
|
|
28
|
+
import { PartnerHierarchyTypesApi } from './api';
|
|
24
29
|
import { PartnerInvitationsApi } from './api';
|
|
25
30
|
import { PartnerRelationsApi } from './api';
|
|
26
31
|
import { PartnerTagsApi } from './api';
|
|
@@ -29,7 +34,12 @@ import { PartnerVersionsApi } from './api';
|
|
|
29
34
|
import { PartnersApi } from './api';
|
|
30
35
|
|
|
31
36
|
|
|
32
|
-
export * from './api/
|
|
37
|
+
export * from './api/blacklist-api';
|
|
38
|
+
export * from './api/blacklist-reasons-api';
|
|
39
|
+
export * from './api/health-api';
|
|
40
|
+
export * from './api/partner-hierarchies-api';
|
|
41
|
+
export * from './api/partner-hierarchy-nodes-api';
|
|
42
|
+
export * from './api/partner-hierarchy-types-api';
|
|
33
43
|
export * from './api/partner-invitations-api';
|
|
34
44
|
export * from './api/partner-relations-api';
|
|
35
45
|
export * from './api/partner-tags-api';
|
package/base.ts
CHANGED
|
@@ -53,6 +53,7 @@ export enum Environment {
|
|
|
53
53
|
Staging = 'https://apiv2-staging.emil.de',
|
|
54
54
|
Development = 'https://apiv2-dev.emil.de',
|
|
55
55
|
ProductionZurich = 'https://eu-central-2.apiv2.emil.de',
|
|
56
|
+
StagingZurich = 'https://eu-central-2.apiv2-staging.emil.de',
|
|
56
57
|
}
|
|
57
58
|
|
|
58
59
|
let _retry_count = 0
|
|
@@ -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 { DeleteByCodeResponseClass } 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<DeleteByCodeResponseClass>>;
|
|
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<DeleteByCodeResponseClass>;
|
|
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<DeleteByCodeResponseClass, 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
|
+
}
|