@emilgroup/partner-sdk 1.23.0 → 1.23.1-beta.1
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 +42 -1
- package/README.md +2 -2
- package/api/blacklist-api.ts +3 -3
- package/api/blacklist-reasons-api.ts +3 -3
- package/api/{default-api.ts → health-api.ts} +13 -13
- package/api/partner-hierarchies-api.ts +1367 -0
- package/api/partner-hierarchy-nodes-api.ts +1197 -0
- package/api/partner-hierarchy-types-api.ts +679 -0
- package/api/partners-api.ts +318 -12
- package/api.ts +8 -2
- package/dist/api/blacklist-api.d.ts +4 -4
- package/dist/api/blacklist-reasons-api.d.ts +4 -4
- 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 +774 -0
- package/dist/api/partner-hierarchies-api.js +1171 -0
- package/dist/api/partner-hierarchy-nodes-api.d.ts +674 -0
- package/dist/api/partner-hierarchy-nodes-api.js +1049 -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 +187 -12
- package/dist/api/partners-api.js +236 -9
- package/dist/api.d.ts +4 -1
- package/dist/api.js +4 -1
- package/dist/models/batch-create-partner-hierarchy-nodes-request-dto.d.ts +30 -0
- package/dist/models/batch-create-partner-hierarchy-nodes-request-dto.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/generate-upload-url-response-class.d.ts +36 -0
- package/dist/models/generate-upload-url-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-file-response-class.d.ts +42 -0
- package/dist/models/get-partner-hierarchy-tree-file-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 +38 -0
- package/dist/models/index.js +38 -0
- package/dist/models/list-blacklist-items-response-class.d.ts +12 -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-operations-response-class.d.ts +43 -0
- package/dist/models/list-partner-hierarchy-operations-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 +12 -0
- 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-class.d.ts +6 -0
- package/dist/models/partner-hierarchy-async-operation-response-class.d.ts +30 -0
- package/dist/models/partner-hierarchy-async-operation-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-operation-class.d.ts +90 -0
- package/dist/models/partner-hierarchy-operation-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-status-request-dto.d.ts +1 -1
- 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-tree-request-body-dto.d.ts +24 -0
- package/dist/models/update-partner-hierarchy-tree-request-body-dto.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/dist/models/validate-partner-request-dto.d.ts +48 -0
- package/dist/models/validate-partner-request-dto.js +15 -0
- package/dist/models/validate-partner-response-class.d.ts +30 -0
- package/dist/models/validate-partner-response-class.js +15 -0
- package/models/batch-create-partner-hierarchy-nodes-request-dto.ts +36 -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/generate-upload-url-response-class.ts +42 -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-file-response-class.ts +48 -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 +38 -0
- package/models/list-blacklist-items-response-class.ts +12 -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-operations-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 +12 -0
- 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-class.ts +6 -0
- package/models/partner-hierarchy-async-operation-response-class.ts +36 -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-operation-class.ts +96 -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-status-request-dto.ts +1 -1
- 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-tree-request-body-dto.ts +30 -0
- package/models/update-partner-hierarchy-type-request-dto.ts +36 -0
- package/models/update-partner-hierarchy-type-response-class.ts +31 -0
- package/models/validate-partner-request-dto.ts +54 -0
- package/models/validate-partner-response-class.ts +36 -0
- package/package.json +2 -2
|
@@ -26,6 +26,8 @@ import { MergePartnersResponseClass } from '../models';
|
|
|
26
26
|
import { TagPartnerRequestDtoRest } from '../models';
|
|
27
27
|
import { UpdatePartnerRequestDto } from '../models';
|
|
28
28
|
import { UpdatePartnerResponseClass } from '../models';
|
|
29
|
+
import { ValidatePartnerRequestDto } from '../models';
|
|
30
|
+
import { ValidatePartnerResponseClass } from '../models';
|
|
29
31
|
/**
|
|
30
32
|
* PartnersApi - axios parameter creator
|
|
31
33
|
* @export
|
|
@@ -83,11 +85,11 @@ export declare const PartnersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
83
85
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
84
86
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
85
87
|
* @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.
|
|
86
|
-
* @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>
|
|
88
|
+
* @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>
|
|
87
89
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
88
|
-
* @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>
|
|
90
|
+
* @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>
|
|
89
91
|
* @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>
|
|
90
|
-
* @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>
|
|
92
|
+
* @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>
|
|
91
93
|
* @param {*} [options] Override http request option.
|
|
92
94
|
* @throws {RequiredError}
|
|
93
95
|
*/
|
|
@@ -108,6 +110,22 @@ export declare const PartnersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
108
110
|
* @throws {RequiredError}
|
|
109
111
|
*/
|
|
110
112
|
listRelationsForPartner: (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
113
|
+
/**
|
|
114
|
+
* Returns a paginated list of sub-partners assigned under the selected partner across partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
|
|
115
|
+
* @summary List sub-partners
|
|
116
|
+
* @param {string} code Unique identifier for the object.
|
|
117
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
118
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
119
|
+
* @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.
|
|
120
|
+
* @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>
|
|
121
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
122
|
+
* @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>
|
|
123
|
+
* @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>
|
|
124
|
+
* @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>
|
|
125
|
+
* @param {*} [options] Override http request option.
|
|
126
|
+
* @throws {RequiredError}
|
|
127
|
+
*/
|
|
128
|
+
listSubPartners: (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
111
129
|
/**
|
|
112
130
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\", \"partner-management.partners.delete\"
|
|
113
131
|
* @summary Update the partner
|
|
@@ -138,6 +156,15 @@ export declare const PartnersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
138
156
|
* @throws {RequiredError}
|
|
139
157
|
*/
|
|
140
158
|
updatePartner: (code: string, updatePartnerRequestDto: UpdatePartnerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
159
|
+
/**
|
|
160
|
+
* Validates a partner identity by partnerNumber and optional field values. All provided fields must match (AND logic). If no validation fields are provided, the call succeeds as long as the partner exists. Never returns partner data — only isValid and an optional error message. **Required Permissions** none
|
|
161
|
+
* @summary Validate a partner
|
|
162
|
+
* @param {ValidatePartnerRequestDto} validatePartnerRequestDto
|
|
163
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
164
|
+
* @param {*} [options] Override http request option.
|
|
165
|
+
* @throws {RequiredError}
|
|
166
|
+
*/
|
|
167
|
+
validatePartner: (validatePartnerRequestDto: ValidatePartnerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
141
168
|
};
|
|
142
169
|
/**
|
|
143
170
|
* PartnersApi - functional programming interface
|
|
@@ -196,11 +223,11 @@ export declare const PartnersApiFp: (configuration?: Configuration) => {
|
|
|
196
223
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
197
224
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
198
225
|
* @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.
|
|
199
|
-
* @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>
|
|
226
|
+
* @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>
|
|
200
227
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
201
|
-
* @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>
|
|
228
|
+
* @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>
|
|
202
229
|
* @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>
|
|
203
|
-
* @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>
|
|
230
|
+
* @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>
|
|
204
231
|
* @param {*} [options] Override http request option.
|
|
205
232
|
* @throws {RequiredError}
|
|
206
233
|
*/
|
|
@@ -221,6 +248,22 @@ export declare const PartnersApiFp: (configuration?: Configuration) => {
|
|
|
221
248
|
* @throws {RequiredError}
|
|
222
249
|
*/
|
|
223
250
|
listRelationsForPartner(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRelatedPartnersResponseClass>>;
|
|
251
|
+
/**
|
|
252
|
+
* Returns a paginated list of sub-partners assigned under the selected partner across partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
|
|
253
|
+
* @summary List sub-partners
|
|
254
|
+
* @param {string} code Unique identifier for the object.
|
|
255
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
256
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
257
|
+
* @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.
|
|
258
|
+
* @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>
|
|
259
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
260
|
+
* @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>
|
|
261
|
+
* @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>
|
|
262
|
+
* @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>
|
|
263
|
+
* @param {*} [options] Override http request option.
|
|
264
|
+
* @throws {RequiredError}
|
|
265
|
+
*/
|
|
266
|
+
listSubPartners(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnersResponseClass>>;
|
|
224
267
|
/**
|
|
225
268
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\", \"partner-management.partners.delete\"
|
|
226
269
|
* @summary Update the partner
|
|
@@ -251,6 +294,15 @@ export declare const PartnersApiFp: (configuration?: Configuration) => {
|
|
|
251
294
|
* @throws {RequiredError}
|
|
252
295
|
*/
|
|
253
296
|
updatePartner(code: string, updatePartnerRequestDto: UpdatePartnerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePartnerResponseClass>>;
|
|
297
|
+
/**
|
|
298
|
+
* Validates a partner identity by partnerNumber and optional field values. All provided fields must match (AND logic). If no validation fields are provided, the call succeeds as long as the partner exists. Never returns partner data — only isValid and an optional error message. **Required Permissions** none
|
|
299
|
+
* @summary Validate a partner
|
|
300
|
+
* @param {ValidatePartnerRequestDto} validatePartnerRequestDto
|
|
301
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
302
|
+
* @param {*} [options] Override http request option.
|
|
303
|
+
* @throws {RequiredError}
|
|
304
|
+
*/
|
|
305
|
+
validatePartner(validatePartnerRequestDto: ValidatePartnerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValidatePartnerResponseClass>>;
|
|
254
306
|
};
|
|
255
307
|
/**
|
|
256
308
|
* PartnersApi - factory interface
|
|
@@ -309,11 +361,11 @@ export declare const PartnersApiFactory: (configuration?: Configuration, basePat
|
|
|
309
361
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
310
362
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
311
363
|
* @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.
|
|
312
|
-
* @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>
|
|
364
|
+
* @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>
|
|
313
365
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
314
|
-
* @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>
|
|
366
|
+
* @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>
|
|
315
367
|
* @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>
|
|
316
|
-
* @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>
|
|
368
|
+
* @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>
|
|
317
369
|
* @param {*} [options] Override http request option.
|
|
318
370
|
* @throws {RequiredError}
|
|
319
371
|
*/
|
|
@@ -334,6 +386,22 @@ export declare const PartnersApiFactory: (configuration?: Configuration, basePat
|
|
|
334
386
|
* @throws {RequiredError}
|
|
335
387
|
*/
|
|
336
388
|
listRelationsForPartner(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRelatedPartnersResponseClass>;
|
|
389
|
+
/**
|
|
390
|
+
* Returns a paginated list of sub-partners assigned under the selected partner across partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
|
|
391
|
+
* @summary List sub-partners
|
|
392
|
+
* @param {string} code Unique identifier for the object.
|
|
393
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
394
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
395
|
+
* @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.
|
|
396
|
+
* @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>
|
|
397
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
398
|
+
* @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>
|
|
399
|
+
* @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>
|
|
400
|
+
* @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>
|
|
401
|
+
* @param {*} [options] Override http request option.
|
|
402
|
+
* @throws {RequiredError}
|
|
403
|
+
*/
|
|
404
|
+
listSubPartners(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnersResponseClass>;
|
|
337
405
|
/**
|
|
338
406
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\", \"partner-management.partners.delete\"
|
|
339
407
|
* @summary Update the partner
|
|
@@ -364,6 +432,15 @@ export declare const PartnersApiFactory: (configuration?: Configuration, basePat
|
|
|
364
432
|
* @throws {RequiredError}
|
|
365
433
|
*/
|
|
366
434
|
updatePartner(code: string, updatePartnerRequestDto: UpdatePartnerRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePartnerResponseClass>;
|
|
435
|
+
/**
|
|
436
|
+
* Validates a partner identity by partnerNumber and optional field values. All provided fields must match (AND logic). If no validation fields are provided, the call succeeds as long as the partner exists. Never returns partner data — only isValid and an optional error message. **Required Permissions** none
|
|
437
|
+
* @summary Validate a partner
|
|
438
|
+
* @param {ValidatePartnerRequestDto} validatePartnerRequestDto
|
|
439
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
440
|
+
* @param {*} [options] Override http request option.
|
|
441
|
+
* @throws {RequiredError}
|
|
442
|
+
*/
|
|
443
|
+
validatePartner(validatePartnerRequestDto: ValidatePartnerRequestDto, authorization?: string, options?: any): AxiosPromise<ValidatePartnerResponseClass>;
|
|
367
444
|
};
|
|
368
445
|
/**
|
|
369
446
|
* Request parameters for createOrUpdatePartnerFromAccount operation in PartnersApi.
|
|
@@ -491,7 +568,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
491
568
|
*/
|
|
492
569
|
readonly pageToken?: string;
|
|
493
570
|
/**
|
|
494
|
-
* 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>
|
|
571
|
+
* 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>
|
|
495
572
|
* @type {string}
|
|
496
573
|
* @memberof PartnersApiListPartners
|
|
497
574
|
*/
|
|
@@ -503,7 +580,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
503
580
|
*/
|
|
504
581
|
readonly search?: string;
|
|
505
582
|
/**
|
|
506
|
-
* 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>
|
|
583
|
+
* 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>
|
|
507
584
|
* @type {string}
|
|
508
585
|
* @memberof PartnersApiListPartners
|
|
509
586
|
*/
|
|
@@ -515,7 +592,7 @@ export interface PartnersApiListPartnersRequest {
|
|
|
515
592
|
*/
|
|
516
593
|
readonly expand?: string;
|
|
517
594
|
/**
|
|
518
|
-
* 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>
|
|
595
|
+
* 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>
|
|
519
596
|
* @type {string}
|
|
520
597
|
* @memberof PartnersApiListPartners
|
|
521
598
|
*/
|
|
@@ -582,6 +659,67 @@ export interface PartnersApiListRelationsForPartnerRequest {
|
|
|
582
659
|
*/
|
|
583
660
|
readonly filters?: string;
|
|
584
661
|
}
|
|
662
|
+
/**
|
|
663
|
+
* Request parameters for listSubPartners operation in PartnersApi.
|
|
664
|
+
* @export
|
|
665
|
+
* @interface PartnersApiListSubPartnersRequest
|
|
666
|
+
*/
|
|
667
|
+
export interface PartnersApiListSubPartnersRequest {
|
|
668
|
+
/**
|
|
669
|
+
* Unique identifier for the object.
|
|
670
|
+
* @type {string}
|
|
671
|
+
* @memberof PartnersApiListSubPartners
|
|
672
|
+
*/
|
|
673
|
+
readonly code: string;
|
|
674
|
+
/**
|
|
675
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
676
|
+
* @type {string}
|
|
677
|
+
* @memberof PartnersApiListSubPartners
|
|
678
|
+
*/
|
|
679
|
+
readonly authorization?: string;
|
|
680
|
+
/**
|
|
681
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
682
|
+
* @type {number}
|
|
683
|
+
* @memberof PartnersApiListSubPartners
|
|
684
|
+
*/
|
|
685
|
+
readonly pageSize?: number;
|
|
686
|
+
/**
|
|
687
|
+
* 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.
|
|
688
|
+
* @type {string}
|
|
689
|
+
* @memberof PartnersApiListSubPartners
|
|
690
|
+
*/
|
|
691
|
+
readonly pageToken?: string;
|
|
692
|
+
/**
|
|
693
|
+
* 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>
|
|
694
|
+
* @type {string}
|
|
695
|
+
* @memberof PartnersApiListSubPartners
|
|
696
|
+
*/
|
|
697
|
+
readonly filter?: string;
|
|
698
|
+
/**
|
|
699
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
700
|
+
* @type {string}
|
|
701
|
+
* @memberof PartnersApiListSubPartners
|
|
702
|
+
*/
|
|
703
|
+
readonly search?: string;
|
|
704
|
+
/**
|
|
705
|
+
* 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>
|
|
706
|
+
* @type {string}
|
|
707
|
+
* @memberof PartnersApiListSubPartners
|
|
708
|
+
*/
|
|
709
|
+
readonly order?: string;
|
|
710
|
+
/**
|
|
711
|
+
* 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>
|
|
712
|
+
* @type {string}
|
|
713
|
+
* @memberof PartnersApiListSubPartners
|
|
714
|
+
*/
|
|
715
|
+
readonly expand?: string;
|
|
716
|
+
/**
|
|
717
|
+
* 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>
|
|
718
|
+
* @type {string}
|
|
719
|
+
* @memberof PartnersApiListSubPartners
|
|
720
|
+
*/
|
|
721
|
+
readonly filters?: string;
|
|
722
|
+
}
|
|
585
723
|
/**
|
|
586
724
|
* Request parameters for mergePartners operation in PartnersApi.
|
|
587
725
|
* @export
|
|
@@ -657,6 +795,25 @@ export interface PartnersApiUpdatePartnerRequest {
|
|
|
657
795
|
*/
|
|
658
796
|
readonly authorization?: string;
|
|
659
797
|
}
|
|
798
|
+
/**
|
|
799
|
+
* Request parameters for validatePartner operation in PartnersApi.
|
|
800
|
+
* @export
|
|
801
|
+
* @interface PartnersApiValidatePartnerRequest
|
|
802
|
+
*/
|
|
803
|
+
export interface PartnersApiValidatePartnerRequest {
|
|
804
|
+
/**
|
|
805
|
+
*
|
|
806
|
+
* @type {ValidatePartnerRequestDto}
|
|
807
|
+
* @memberof PartnersApiValidatePartner
|
|
808
|
+
*/
|
|
809
|
+
readonly validatePartnerRequestDto: ValidatePartnerRequestDto;
|
|
810
|
+
/**
|
|
811
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
812
|
+
* @type {string}
|
|
813
|
+
* @memberof PartnersApiValidatePartner
|
|
814
|
+
*/
|
|
815
|
+
readonly authorization?: string;
|
|
816
|
+
}
|
|
660
817
|
/**
|
|
661
818
|
* PartnersApi - object-oriented interface
|
|
662
819
|
* @export
|
|
@@ -727,6 +884,15 @@ export declare class PartnersApi extends BaseAPI {
|
|
|
727
884
|
* @memberof PartnersApi
|
|
728
885
|
*/
|
|
729
886
|
listRelationsForPartner(requestParameters: PartnersApiListRelationsForPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRelatedPartnersResponseClass, any, {}>>;
|
|
887
|
+
/**
|
|
888
|
+
* Returns a paginated list of sub-partners assigned under the selected partner across partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
|
|
889
|
+
* @summary List sub-partners
|
|
890
|
+
* @param {PartnersApiListSubPartnersRequest} requestParameters Request parameters.
|
|
891
|
+
* @param {*} [options] Override http request option.
|
|
892
|
+
* @throws {RequiredError}
|
|
893
|
+
* @memberof PartnersApi
|
|
894
|
+
*/
|
|
895
|
+
listSubPartners(requestParameters: PartnersApiListSubPartnersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnersResponseClass, any, {}>>;
|
|
730
896
|
/**
|
|
731
897
|
* Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\", \"partner-management.partners.delete\"
|
|
732
898
|
* @summary Update the partner
|
|
@@ -754,4 +920,13 @@ export declare class PartnersApi extends BaseAPI {
|
|
|
754
920
|
* @memberof PartnersApi
|
|
755
921
|
*/
|
|
756
922
|
updatePartner(requestParameters: PartnersApiUpdatePartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePartnerResponseClass, any, {}>>;
|
|
923
|
+
/**
|
|
924
|
+
* Validates a partner identity by partnerNumber and optional field values. All provided fields must match (AND logic). If no validation fields are provided, the call succeeds as long as the partner exists. Never returns partner data — only isValid and an optional error message. **Required Permissions** none
|
|
925
|
+
* @summary Validate a partner
|
|
926
|
+
* @param {PartnersApiValidatePartnerRequest} requestParameters Request parameters.
|
|
927
|
+
* @param {*} [options] Override http request option.
|
|
928
|
+
* @throws {RequiredError}
|
|
929
|
+
* @memberof PartnersApi
|
|
930
|
+
*/
|
|
931
|
+
validatePartner(requestParameters: PartnersApiValidatePartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ValidatePartnerResponseClass, any, {}>>;
|
|
757
932
|
}
|