@emilgroup/partner-sdk 1.22.1-beta.15 → 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 +23 -0
- package/README.md +2 -2
- package/api/partner-hierarchies-api.ts +1342 -0
- package/api/partner-hierarchy-nodes-api.ts +1178 -0
- package/api/partners-api.ts +12 -12
- package/api.ts +4 -0
- 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/partners-api.d.ts +12 -12
- package/dist/api/partners-api.js +9 -9
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -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/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/index.d.ts +21 -0
- package/dist/models/index.js +21 -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/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/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-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/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/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/index.ts +21 -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/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/unassign-partner-hierarchy-node-response-class.ts +31 -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/package.json +1 -1
|
@@ -0,0 +1,663 @@
|
|
|
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 { CreatePartnerHierarchyNodeRequestDto } from '../models';
|
|
16
|
+
import { CreatePartnerHierarchyNodeResponseClass } from '../models';
|
|
17
|
+
import { DeleteByCodeResponseClass } from '../models';
|
|
18
|
+
import { GetPartnerHierarchyNodeResponseClass } from '../models';
|
|
19
|
+
import { ListPartnerHierarchyNodeHistoryResponseClass } from '../models';
|
|
20
|
+
import { ListPartnerHierarchyNodesResponseClass } from '../models';
|
|
21
|
+
import { MovePartnerHierarchyNodeRequestDto } from '../models';
|
|
22
|
+
import { MovePartnerHierarchyNodeResponseClass } from '../models';
|
|
23
|
+
import { UnassignPartnerHierarchyNodeResponseClass } from '../models';
|
|
24
|
+
import { UpdatePartnerHierarchyNodeRequestDto } from '../models';
|
|
25
|
+
import { UpdatePartnerHierarchyNodeResponseClass } from '../models';
|
|
26
|
+
/**
|
|
27
|
+
* PartnerHierarchyNodesApi - axios parameter creator
|
|
28
|
+
* @export
|
|
29
|
+
*/
|
|
30
|
+
export declare const PartnerHierarchyNodesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
31
|
+
/**
|
|
32
|
+
* Starts batch node creation from an uploaded file and returns the operation status. **Required Permissions** \"partner-management.partners.create\"
|
|
33
|
+
* @summary Create the partner hierarchy nodes batch
|
|
34
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
35
|
+
* @param {*} [options] Override http request option.
|
|
36
|
+
* @throws {RequiredError}
|
|
37
|
+
*/
|
|
38
|
+
batchCreatePartnerHierarchyNodes: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
|
+
/**
|
|
40
|
+
* Creates a node in a partner hierarchy. The node can be placed at the top of the hierarchy or under another node, and it can be created with or without an assigned partner. **Required Permissions** \"partner-management.partners.create\"
|
|
41
|
+
* @summary Create the partner hierarchy node
|
|
42
|
+
* @param {CreatePartnerHierarchyNodeRequestDto} createPartnerHierarchyNodeRequestDto
|
|
43
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
44
|
+
* @param {*} [options] Override http request option.
|
|
45
|
+
* @throws {RequiredError}
|
|
46
|
+
*/
|
|
47
|
+
createPartnerHierarchyNode: (createPartnerHierarchyNodeRequestDto: CreatePartnerHierarchyNodeRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
|
+
/**
|
|
49
|
+
* Deletes a partner hierarchy node. The node must have no children before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
|
|
50
|
+
* @summary Delete the partner hierarchy node
|
|
51
|
+
* @param {string} code
|
|
52
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
53
|
+
* @param {*} [options] Override http request option.
|
|
54
|
+
* @throws {RequiredError}
|
|
55
|
+
*/
|
|
56
|
+
deletePartnerHierarchyNode: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57
|
+
/**
|
|
58
|
+
* Returns the details of one partner hierarchy node. Partner and parent node details can be included when needed. **Required Permissions** \"partner-management.partners.view\"
|
|
59
|
+
* @summary Retrieve the partner hierarchy node
|
|
60
|
+
* @param {string} code
|
|
61
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
62
|
+
* @param {*} [options] Override http request option.
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
*/
|
|
65
|
+
getPartnerHierarchyNode: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
|
+
/**
|
|
67
|
+
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
68
|
+
* @summary List partner hierarchy node histories
|
|
69
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
70
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
71
|
+
* @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.
|
|
72
|
+
* @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, partnerHierarchyCode, validFrom</i>
|
|
73
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
74
|
+
* @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, validFrom, validTo, createdAt</i>
|
|
75
|
+
* @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: partner<i>
|
|
76
|
+
* @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, partnerHierarchyCode, validFrom</i>
|
|
77
|
+
* @param {*} [options] Override http request option.
|
|
78
|
+
* @throws {RequiredError}
|
|
79
|
+
*/
|
|
80
|
+
listPartnerHierarchyNodeHistory: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
81
|
+
/**
|
|
82
|
+
* Returns a paginated list of partner hierarchy nodes. **Required Permissions** \"partner-management.partners.view\"
|
|
83
|
+
* @summary List partner hierarchy nodes
|
|
84
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
85
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
86
|
+
* @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.
|
|
87
|
+
* @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, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
88
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
89
|
+
* @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, depth, createdAt, updatedAt</i>
|
|
90
|
+
* @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: partner, parentNode<i>
|
|
91
|
+
* @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, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
92
|
+
* @param {*} [options] Override http request option.
|
|
93
|
+
* @throws {RequiredError}
|
|
94
|
+
*/
|
|
95
|
+
listPartnerHierarchyNodes: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
96
|
+
/**
|
|
97
|
+
* Moves a node under another parent at the same level in the same hierarchy. Any nodes below it move with it. **Required Permissions** \"partner-management.partners.update\"
|
|
98
|
+
* @summary Create the partner hierarchy node move
|
|
99
|
+
* @param {string} code
|
|
100
|
+
* @param {MovePartnerHierarchyNodeRequestDto} movePartnerHierarchyNodeRequestDto
|
|
101
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
102
|
+
* @param {*} [options] Override http request option.
|
|
103
|
+
* @throws {RequiredError}
|
|
104
|
+
*/
|
|
105
|
+
movePartnerHierarchyNode: (code: string, movePartnerHierarchyNodeRequestDto: MovePartnerHierarchyNodeRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
106
|
+
/**
|
|
107
|
+
* Removes the partner assigned to a partner hierarchy node while keeping the node in the tree. **Required Permissions** \"partner-management.partners.update\"
|
|
108
|
+
* @summary Create the partner hierarchy node unassign
|
|
109
|
+
* @param {string} code
|
|
110
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
111
|
+
* @param {*} [options] Override http request option.
|
|
112
|
+
* @throws {RequiredError}
|
|
113
|
+
*/
|
|
114
|
+
unassignPartnerHierarchyNode: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
115
|
+
/**
|
|
116
|
+
* Updates a node role or changes the partner assigned to the node. It does not move the node in the tree. **Required Permissions** \"partner-management.partners.update\"
|
|
117
|
+
* @summary Update the partner hierarchy node
|
|
118
|
+
* @param {string} code
|
|
119
|
+
* @param {UpdatePartnerHierarchyNodeRequestDto} updatePartnerHierarchyNodeRequestDto
|
|
120
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
121
|
+
* @param {*} [options] Override http request option.
|
|
122
|
+
* @throws {RequiredError}
|
|
123
|
+
*/
|
|
124
|
+
updatePartnerHierarchyNode: (code: string, updatePartnerHierarchyNodeRequestDto: UpdatePartnerHierarchyNodeRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
125
|
+
};
|
|
126
|
+
/**
|
|
127
|
+
* PartnerHierarchyNodesApi - functional programming interface
|
|
128
|
+
* @export
|
|
129
|
+
*/
|
|
130
|
+
export declare const PartnerHierarchyNodesApiFp: (configuration?: Configuration) => {
|
|
131
|
+
/**
|
|
132
|
+
* Starts batch node creation from an uploaded file and returns the operation status. **Required Permissions** \"partner-management.partners.create\"
|
|
133
|
+
* @summary Create the partner hierarchy nodes batch
|
|
134
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
135
|
+
* @param {*} [options] Override http request option.
|
|
136
|
+
* @throws {RequiredError}
|
|
137
|
+
*/
|
|
138
|
+
batchCreatePartnerHierarchyNodes(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
139
|
+
/**
|
|
140
|
+
* Creates a node in a partner hierarchy. The node can be placed at the top of the hierarchy or under another node, and it can be created with or without an assigned partner. **Required Permissions** \"partner-management.partners.create\"
|
|
141
|
+
* @summary Create the partner hierarchy node
|
|
142
|
+
* @param {CreatePartnerHierarchyNodeRequestDto} createPartnerHierarchyNodeRequestDto
|
|
143
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
144
|
+
* @param {*} [options] Override http request option.
|
|
145
|
+
* @throws {RequiredError}
|
|
146
|
+
*/
|
|
147
|
+
createPartnerHierarchyNode(createPartnerHierarchyNodeRequestDto: CreatePartnerHierarchyNodeRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerHierarchyNodeResponseClass>>;
|
|
148
|
+
/**
|
|
149
|
+
* Deletes a partner hierarchy node. The node must have no children before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
|
|
150
|
+
* @summary Delete the partner hierarchy node
|
|
151
|
+
* @param {string} code
|
|
152
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
153
|
+
* @param {*} [options] Override http request option.
|
|
154
|
+
* @throws {RequiredError}
|
|
155
|
+
*/
|
|
156
|
+
deletePartnerHierarchyNode(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>>;
|
|
157
|
+
/**
|
|
158
|
+
* Returns the details of one partner hierarchy node. Partner and parent node details can be included when needed. **Required Permissions** \"partner-management.partners.view\"
|
|
159
|
+
* @summary Retrieve the partner hierarchy node
|
|
160
|
+
* @param {string} code
|
|
161
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
162
|
+
* @param {*} [options] Override http request option.
|
|
163
|
+
* @throws {RequiredError}
|
|
164
|
+
*/
|
|
165
|
+
getPartnerHierarchyNode(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyNodeResponseClass>>;
|
|
166
|
+
/**
|
|
167
|
+
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
168
|
+
* @summary List partner hierarchy node histories
|
|
169
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
170
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
171
|
+
* @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.
|
|
172
|
+
* @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, partnerHierarchyCode, validFrom</i>
|
|
173
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
174
|
+
* @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, validFrom, validTo, createdAt</i>
|
|
175
|
+
* @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: partner<i>
|
|
176
|
+
* @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, partnerHierarchyCode, validFrom</i>
|
|
177
|
+
* @param {*} [options] Override http request option.
|
|
178
|
+
* @throws {RequiredError}
|
|
179
|
+
*/
|
|
180
|
+
listPartnerHierarchyNodeHistory(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerHierarchyNodeHistoryResponseClass>>;
|
|
181
|
+
/**
|
|
182
|
+
* Returns a paginated list of partner hierarchy nodes. **Required Permissions** \"partner-management.partners.view\"
|
|
183
|
+
* @summary List partner hierarchy nodes
|
|
184
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
185
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
186
|
+
* @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.
|
|
187
|
+
* @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, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
188
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
189
|
+
* @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, depth, createdAt, updatedAt</i>
|
|
190
|
+
* @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: partner, parentNode<i>
|
|
191
|
+
* @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, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
192
|
+
* @param {*} [options] Override http request option.
|
|
193
|
+
* @throws {RequiredError}
|
|
194
|
+
*/
|
|
195
|
+
listPartnerHierarchyNodes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerHierarchyNodesResponseClass>>;
|
|
196
|
+
/**
|
|
197
|
+
* Moves a node under another parent at the same level in the same hierarchy. Any nodes below it move with it. **Required Permissions** \"partner-management.partners.update\"
|
|
198
|
+
* @summary Create the partner hierarchy node move
|
|
199
|
+
* @param {string} code
|
|
200
|
+
* @param {MovePartnerHierarchyNodeRequestDto} movePartnerHierarchyNodeRequestDto
|
|
201
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
202
|
+
* @param {*} [options] Override http request option.
|
|
203
|
+
* @throws {RequiredError}
|
|
204
|
+
*/
|
|
205
|
+
movePartnerHierarchyNode(code: string, movePartnerHierarchyNodeRequestDto: MovePartnerHierarchyNodeRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MovePartnerHierarchyNodeResponseClass>>;
|
|
206
|
+
/**
|
|
207
|
+
* Removes the partner assigned to a partner hierarchy node while keeping the node in the tree. **Required Permissions** \"partner-management.partners.update\"
|
|
208
|
+
* @summary Create the partner hierarchy node unassign
|
|
209
|
+
* @param {string} code
|
|
210
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
211
|
+
* @param {*} [options] Override http request option.
|
|
212
|
+
* @throws {RequiredError}
|
|
213
|
+
*/
|
|
214
|
+
unassignPartnerHierarchyNode(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnassignPartnerHierarchyNodeResponseClass>>;
|
|
215
|
+
/**
|
|
216
|
+
* Updates a node role or changes the partner assigned to the node. It does not move the node in the tree. **Required Permissions** \"partner-management.partners.update\"
|
|
217
|
+
* @summary Update the partner hierarchy node
|
|
218
|
+
* @param {string} code
|
|
219
|
+
* @param {UpdatePartnerHierarchyNodeRequestDto} updatePartnerHierarchyNodeRequestDto
|
|
220
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
221
|
+
* @param {*} [options] Override http request option.
|
|
222
|
+
* @throws {RequiredError}
|
|
223
|
+
*/
|
|
224
|
+
updatePartnerHierarchyNode(code: string, updatePartnerHierarchyNodeRequestDto: UpdatePartnerHierarchyNodeRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePartnerHierarchyNodeResponseClass>>;
|
|
225
|
+
};
|
|
226
|
+
/**
|
|
227
|
+
* PartnerHierarchyNodesApi - factory interface
|
|
228
|
+
* @export
|
|
229
|
+
*/
|
|
230
|
+
export declare const PartnerHierarchyNodesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
231
|
+
/**
|
|
232
|
+
* Starts batch node creation from an uploaded file and returns the operation status. **Required Permissions** \"partner-management.partners.create\"
|
|
233
|
+
* @summary Create the partner hierarchy nodes batch
|
|
234
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
235
|
+
* @param {*} [options] Override http request option.
|
|
236
|
+
* @throws {RequiredError}
|
|
237
|
+
*/
|
|
238
|
+
batchCreatePartnerHierarchyNodes(authorization?: string, options?: any): AxiosPromise<void>;
|
|
239
|
+
/**
|
|
240
|
+
* Creates a node in a partner hierarchy. The node can be placed at the top of the hierarchy or under another node, and it can be created with or without an assigned partner. **Required Permissions** \"partner-management.partners.create\"
|
|
241
|
+
* @summary Create the partner hierarchy node
|
|
242
|
+
* @param {CreatePartnerHierarchyNodeRequestDto} createPartnerHierarchyNodeRequestDto
|
|
243
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
|
+
* @param {*} [options] Override http request option.
|
|
245
|
+
* @throws {RequiredError}
|
|
246
|
+
*/
|
|
247
|
+
createPartnerHierarchyNode(createPartnerHierarchyNodeRequestDto: CreatePartnerHierarchyNodeRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePartnerHierarchyNodeResponseClass>;
|
|
248
|
+
/**
|
|
249
|
+
* Deletes a partner hierarchy node. The node must have no children before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
|
|
250
|
+
* @summary Delete the partner hierarchy node
|
|
251
|
+
* @param {string} code
|
|
252
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
253
|
+
* @param {*} [options] Override http request option.
|
|
254
|
+
* @throws {RequiredError}
|
|
255
|
+
*/
|
|
256
|
+
deletePartnerHierarchyNode(code: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass>;
|
|
257
|
+
/**
|
|
258
|
+
* Returns the details of one partner hierarchy node. Partner and parent node details can be included when needed. **Required Permissions** \"partner-management.partners.view\"
|
|
259
|
+
* @summary Retrieve the partner hierarchy node
|
|
260
|
+
* @param {string} code
|
|
261
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
262
|
+
* @param {*} [options] Override http request option.
|
|
263
|
+
* @throws {RequiredError}
|
|
264
|
+
*/
|
|
265
|
+
getPartnerHierarchyNode(code: string, authorization?: string, options?: any): AxiosPromise<GetPartnerHierarchyNodeResponseClass>;
|
|
266
|
+
/**
|
|
267
|
+
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
268
|
+
* @summary List partner hierarchy node histories
|
|
269
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
270
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
271
|
+
* @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.
|
|
272
|
+
* @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, partnerHierarchyCode, validFrom</i>
|
|
273
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
274
|
+
* @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, validFrom, validTo, createdAt</i>
|
|
275
|
+
* @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: partner<i>
|
|
276
|
+
* @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, partnerHierarchyCode, validFrom</i>
|
|
277
|
+
* @param {*} [options] Override http request option.
|
|
278
|
+
* @throws {RequiredError}
|
|
279
|
+
*/
|
|
280
|
+
listPartnerHierarchyNodeHistory(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerHierarchyNodeHistoryResponseClass>;
|
|
281
|
+
/**
|
|
282
|
+
* Returns a paginated list of partner hierarchy nodes. **Required Permissions** \"partner-management.partners.view\"
|
|
283
|
+
* @summary List partner hierarchy nodes
|
|
284
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
285
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
286
|
+
* @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.
|
|
287
|
+
* @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, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
288
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
289
|
+
* @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, depth, createdAt, updatedAt</i>
|
|
290
|
+
* @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: partner, parentNode<i>
|
|
291
|
+
* @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, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
292
|
+
* @param {*} [options] Override http request option.
|
|
293
|
+
* @throws {RequiredError}
|
|
294
|
+
*/
|
|
295
|
+
listPartnerHierarchyNodes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerHierarchyNodesResponseClass>;
|
|
296
|
+
/**
|
|
297
|
+
* Moves a node under another parent at the same level in the same hierarchy. Any nodes below it move with it. **Required Permissions** \"partner-management.partners.update\"
|
|
298
|
+
* @summary Create the partner hierarchy node move
|
|
299
|
+
* @param {string} code
|
|
300
|
+
* @param {MovePartnerHierarchyNodeRequestDto} movePartnerHierarchyNodeRequestDto
|
|
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
|
+
movePartnerHierarchyNode(code: string, movePartnerHierarchyNodeRequestDto: MovePartnerHierarchyNodeRequestDto, authorization?: string, options?: any): AxiosPromise<MovePartnerHierarchyNodeResponseClass>;
|
|
306
|
+
/**
|
|
307
|
+
* Removes the partner assigned to a partner hierarchy node while keeping the node in the tree. **Required Permissions** \"partner-management.partners.update\"
|
|
308
|
+
* @summary Create the partner hierarchy node unassign
|
|
309
|
+
* @param {string} code
|
|
310
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
311
|
+
* @param {*} [options] Override http request option.
|
|
312
|
+
* @throws {RequiredError}
|
|
313
|
+
*/
|
|
314
|
+
unassignPartnerHierarchyNode(code: string, authorization?: string, options?: any): AxiosPromise<UnassignPartnerHierarchyNodeResponseClass>;
|
|
315
|
+
/**
|
|
316
|
+
* Updates a node role or changes the partner assigned to the node. It does not move the node in the tree. **Required Permissions** \"partner-management.partners.update\"
|
|
317
|
+
* @summary Update the partner hierarchy node
|
|
318
|
+
* @param {string} code
|
|
319
|
+
* @param {UpdatePartnerHierarchyNodeRequestDto} updatePartnerHierarchyNodeRequestDto
|
|
320
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
321
|
+
* @param {*} [options] Override http request option.
|
|
322
|
+
* @throws {RequiredError}
|
|
323
|
+
*/
|
|
324
|
+
updatePartnerHierarchyNode(code: string, updatePartnerHierarchyNodeRequestDto: UpdatePartnerHierarchyNodeRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePartnerHierarchyNodeResponseClass>;
|
|
325
|
+
};
|
|
326
|
+
/**
|
|
327
|
+
* Request parameters for batchCreatePartnerHierarchyNodes operation in PartnerHierarchyNodesApi.
|
|
328
|
+
* @export
|
|
329
|
+
* @interface PartnerHierarchyNodesApiBatchCreatePartnerHierarchyNodesRequest
|
|
330
|
+
*/
|
|
331
|
+
export interface PartnerHierarchyNodesApiBatchCreatePartnerHierarchyNodesRequest {
|
|
332
|
+
/**
|
|
333
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
334
|
+
* @type {string}
|
|
335
|
+
* @memberof PartnerHierarchyNodesApiBatchCreatePartnerHierarchyNodes
|
|
336
|
+
*/
|
|
337
|
+
readonly authorization?: string;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* Request parameters for createPartnerHierarchyNode operation in PartnerHierarchyNodesApi.
|
|
341
|
+
* @export
|
|
342
|
+
* @interface PartnerHierarchyNodesApiCreatePartnerHierarchyNodeRequest
|
|
343
|
+
*/
|
|
344
|
+
export interface PartnerHierarchyNodesApiCreatePartnerHierarchyNodeRequest {
|
|
345
|
+
/**
|
|
346
|
+
*
|
|
347
|
+
* @type {CreatePartnerHierarchyNodeRequestDto}
|
|
348
|
+
* @memberof PartnerHierarchyNodesApiCreatePartnerHierarchyNode
|
|
349
|
+
*/
|
|
350
|
+
readonly createPartnerHierarchyNodeRequestDto: CreatePartnerHierarchyNodeRequestDto;
|
|
351
|
+
/**
|
|
352
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
353
|
+
* @type {string}
|
|
354
|
+
* @memberof PartnerHierarchyNodesApiCreatePartnerHierarchyNode
|
|
355
|
+
*/
|
|
356
|
+
readonly authorization?: string;
|
|
357
|
+
}
|
|
358
|
+
/**
|
|
359
|
+
* Request parameters for deletePartnerHierarchyNode operation in PartnerHierarchyNodesApi.
|
|
360
|
+
* @export
|
|
361
|
+
* @interface PartnerHierarchyNodesApiDeletePartnerHierarchyNodeRequest
|
|
362
|
+
*/
|
|
363
|
+
export interface PartnerHierarchyNodesApiDeletePartnerHierarchyNodeRequest {
|
|
364
|
+
/**
|
|
365
|
+
*
|
|
366
|
+
* @type {string}
|
|
367
|
+
* @memberof PartnerHierarchyNodesApiDeletePartnerHierarchyNode
|
|
368
|
+
*/
|
|
369
|
+
readonly code: string;
|
|
370
|
+
/**
|
|
371
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
372
|
+
* @type {string}
|
|
373
|
+
* @memberof PartnerHierarchyNodesApiDeletePartnerHierarchyNode
|
|
374
|
+
*/
|
|
375
|
+
readonly authorization?: string;
|
|
376
|
+
}
|
|
377
|
+
/**
|
|
378
|
+
* Request parameters for getPartnerHierarchyNode operation in PartnerHierarchyNodesApi.
|
|
379
|
+
* @export
|
|
380
|
+
* @interface PartnerHierarchyNodesApiGetPartnerHierarchyNodeRequest
|
|
381
|
+
*/
|
|
382
|
+
export interface PartnerHierarchyNodesApiGetPartnerHierarchyNodeRequest {
|
|
383
|
+
/**
|
|
384
|
+
*
|
|
385
|
+
* @type {string}
|
|
386
|
+
* @memberof PartnerHierarchyNodesApiGetPartnerHierarchyNode
|
|
387
|
+
*/
|
|
388
|
+
readonly code: string;
|
|
389
|
+
/**
|
|
390
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
391
|
+
* @type {string}
|
|
392
|
+
* @memberof PartnerHierarchyNodesApiGetPartnerHierarchyNode
|
|
393
|
+
*/
|
|
394
|
+
readonly authorization?: string;
|
|
395
|
+
}
|
|
396
|
+
/**
|
|
397
|
+
* Request parameters for listPartnerHierarchyNodeHistory operation in PartnerHierarchyNodesApi.
|
|
398
|
+
* @export
|
|
399
|
+
* @interface PartnerHierarchyNodesApiListPartnerHierarchyNodeHistoryRequest
|
|
400
|
+
*/
|
|
401
|
+
export interface PartnerHierarchyNodesApiListPartnerHierarchyNodeHistoryRequest {
|
|
402
|
+
/**
|
|
403
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
404
|
+
* @type {string}
|
|
405
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodeHistory
|
|
406
|
+
*/
|
|
407
|
+
readonly authorization?: string;
|
|
408
|
+
/**
|
|
409
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
410
|
+
* @type {number}
|
|
411
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodeHistory
|
|
412
|
+
*/
|
|
413
|
+
readonly pageSize?: number;
|
|
414
|
+
/**
|
|
415
|
+
* 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.
|
|
416
|
+
* @type {string}
|
|
417
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodeHistory
|
|
418
|
+
*/
|
|
419
|
+
readonly pageToken?: string;
|
|
420
|
+
/**
|
|
421
|
+
* 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, partnerHierarchyCode, validFrom</i>
|
|
422
|
+
* @type {string}
|
|
423
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodeHistory
|
|
424
|
+
*/
|
|
425
|
+
readonly filter?: string;
|
|
426
|
+
/**
|
|
427
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
428
|
+
* @type {string}
|
|
429
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodeHistory
|
|
430
|
+
*/
|
|
431
|
+
readonly search?: string;
|
|
432
|
+
/**
|
|
433
|
+
* 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, validFrom, validTo, createdAt</i>
|
|
434
|
+
* @type {string}
|
|
435
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodeHistory
|
|
436
|
+
*/
|
|
437
|
+
readonly order?: string;
|
|
438
|
+
/**
|
|
439
|
+
* 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: partner<i>
|
|
440
|
+
* @type {string}
|
|
441
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodeHistory
|
|
442
|
+
*/
|
|
443
|
+
readonly expand?: string;
|
|
444
|
+
/**
|
|
445
|
+
* 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, partnerHierarchyCode, validFrom</i>
|
|
446
|
+
* @type {string}
|
|
447
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodeHistory
|
|
448
|
+
*/
|
|
449
|
+
readonly filters?: string;
|
|
450
|
+
}
|
|
451
|
+
/**
|
|
452
|
+
* Request parameters for listPartnerHierarchyNodes operation in PartnerHierarchyNodesApi.
|
|
453
|
+
* @export
|
|
454
|
+
* @interface PartnerHierarchyNodesApiListPartnerHierarchyNodesRequest
|
|
455
|
+
*/
|
|
456
|
+
export interface PartnerHierarchyNodesApiListPartnerHierarchyNodesRequest {
|
|
457
|
+
/**
|
|
458
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
459
|
+
* @type {string}
|
|
460
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodes
|
|
461
|
+
*/
|
|
462
|
+
readonly authorization?: string;
|
|
463
|
+
/**
|
|
464
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
465
|
+
* @type {number}
|
|
466
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodes
|
|
467
|
+
*/
|
|
468
|
+
readonly pageSize?: number;
|
|
469
|
+
/**
|
|
470
|
+
* 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.
|
|
471
|
+
* @type {string}
|
|
472
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodes
|
|
473
|
+
*/
|
|
474
|
+
readonly pageToken?: string;
|
|
475
|
+
/**
|
|
476
|
+
* 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, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
477
|
+
* @type {string}
|
|
478
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodes
|
|
479
|
+
*/
|
|
480
|
+
readonly filter?: string;
|
|
481
|
+
/**
|
|
482
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
483
|
+
* @type {string}
|
|
484
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodes
|
|
485
|
+
*/
|
|
486
|
+
readonly search?: string;
|
|
487
|
+
/**
|
|
488
|
+
* 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, depth, createdAt, updatedAt</i>
|
|
489
|
+
* @type {string}
|
|
490
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodes
|
|
491
|
+
*/
|
|
492
|
+
readonly order?: string;
|
|
493
|
+
/**
|
|
494
|
+
* 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: partner, parentNode<i>
|
|
495
|
+
* @type {string}
|
|
496
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodes
|
|
497
|
+
*/
|
|
498
|
+
readonly expand?: string;
|
|
499
|
+
/**
|
|
500
|
+
* 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, partnerHierarchyCode, partnerCode, parentNodeCode, roleCode, depth, createdAt, updatedAt</i>
|
|
501
|
+
* @type {string}
|
|
502
|
+
* @memberof PartnerHierarchyNodesApiListPartnerHierarchyNodes
|
|
503
|
+
*/
|
|
504
|
+
readonly filters?: string;
|
|
505
|
+
}
|
|
506
|
+
/**
|
|
507
|
+
* Request parameters for movePartnerHierarchyNode operation in PartnerHierarchyNodesApi.
|
|
508
|
+
* @export
|
|
509
|
+
* @interface PartnerHierarchyNodesApiMovePartnerHierarchyNodeRequest
|
|
510
|
+
*/
|
|
511
|
+
export interface PartnerHierarchyNodesApiMovePartnerHierarchyNodeRequest {
|
|
512
|
+
/**
|
|
513
|
+
*
|
|
514
|
+
* @type {string}
|
|
515
|
+
* @memberof PartnerHierarchyNodesApiMovePartnerHierarchyNode
|
|
516
|
+
*/
|
|
517
|
+
readonly code: string;
|
|
518
|
+
/**
|
|
519
|
+
*
|
|
520
|
+
* @type {MovePartnerHierarchyNodeRequestDto}
|
|
521
|
+
* @memberof PartnerHierarchyNodesApiMovePartnerHierarchyNode
|
|
522
|
+
*/
|
|
523
|
+
readonly movePartnerHierarchyNodeRequestDto: MovePartnerHierarchyNodeRequestDto;
|
|
524
|
+
/**
|
|
525
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
526
|
+
* @type {string}
|
|
527
|
+
* @memberof PartnerHierarchyNodesApiMovePartnerHierarchyNode
|
|
528
|
+
*/
|
|
529
|
+
readonly authorization?: string;
|
|
530
|
+
}
|
|
531
|
+
/**
|
|
532
|
+
* Request parameters for unassignPartnerHierarchyNode operation in PartnerHierarchyNodesApi.
|
|
533
|
+
* @export
|
|
534
|
+
* @interface PartnerHierarchyNodesApiUnassignPartnerHierarchyNodeRequest
|
|
535
|
+
*/
|
|
536
|
+
export interface PartnerHierarchyNodesApiUnassignPartnerHierarchyNodeRequest {
|
|
537
|
+
/**
|
|
538
|
+
*
|
|
539
|
+
* @type {string}
|
|
540
|
+
* @memberof PartnerHierarchyNodesApiUnassignPartnerHierarchyNode
|
|
541
|
+
*/
|
|
542
|
+
readonly code: string;
|
|
543
|
+
/**
|
|
544
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
545
|
+
* @type {string}
|
|
546
|
+
* @memberof PartnerHierarchyNodesApiUnassignPartnerHierarchyNode
|
|
547
|
+
*/
|
|
548
|
+
readonly authorization?: string;
|
|
549
|
+
}
|
|
550
|
+
/**
|
|
551
|
+
* Request parameters for updatePartnerHierarchyNode operation in PartnerHierarchyNodesApi.
|
|
552
|
+
* @export
|
|
553
|
+
* @interface PartnerHierarchyNodesApiUpdatePartnerHierarchyNodeRequest
|
|
554
|
+
*/
|
|
555
|
+
export interface PartnerHierarchyNodesApiUpdatePartnerHierarchyNodeRequest {
|
|
556
|
+
/**
|
|
557
|
+
*
|
|
558
|
+
* @type {string}
|
|
559
|
+
* @memberof PartnerHierarchyNodesApiUpdatePartnerHierarchyNode
|
|
560
|
+
*/
|
|
561
|
+
readonly code: string;
|
|
562
|
+
/**
|
|
563
|
+
*
|
|
564
|
+
* @type {UpdatePartnerHierarchyNodeRequestDto}
|
|
565
|
+
* @memberof PartnerHierarchyNodesApiUpdatePartnerHierarchyNode
|
|
566
|
+
*/
|
|
567
|
+
readonly updatePartnerHierarchyNodeRequestDto: UpdatePartnerHierarchyNodeRequestDto;
|
|
568
|
+
/**
|
|
569
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
570
|
+
* @type {string}
|
|
571
|
+
* @memberof PartnerHierarchyNodesApiUpdatePartnerHierarchyNode
|
|
572
|
+
*/
|
|
573
|
+
readonly authorization?: string;
|
|
574
|
+
}
|
|
575
|
+
/**
|
|
576
|
+
* PartnerHierarchyNodesApi - object-oriented interface
|
|
577
|
+
* @export
|
|
578
|
+
* @class PartnerHierarchyNodesApi
|
|
579
|
+
* @extends {BaseAPI}
|
|
580
|
+
*/
|
|
581
|
+
export declare class PartnerHierarchyNodesApi extends BaseAPI {
|
|
582
|
+
/**
|
|
583
|
+
* Starts batch node creation from an uploaded file and returns the operation status. **Required Permissions** \"partner-management.partners.create\"
|
|
584
|
+
* @summary Create the partner hierarchy nodes batch
|
|
585
|
+
* @param {PartnerHierarchyNodesApiBatchCreatePartnerHierarchyNodesRequest} requestParameters Request parameters.
|
|
586
|
+
* @param {*} [options] Override http request option.
|
|
587
|
+
* @throws {RequiredError}
|
|
588
|
+
* @memberof PartnerHierarchyNodesApi
|
|
589
|
+
*/
|
|
590
|
+
batchCreatePartnerHierarchyNodes(requestParameters?: PartnerHierarchyNodesApiBatchCreatePartnerHierarchyNodesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
591
|
+
/**
|
|
592
|
+
* Creates a node in a partner hierarchy. The node can be placed at the top of the hierarchy or under another node, and it can be created with or without an assigned partner. **Required Permissions** \"partner-management.partners.create\"
|
|
593
|
+
* @summary Create the partner hierarchy node
|
|
594
|
+
* @param {PartnerHierarchyNodesApiCreatePartnerHierarchyNodeRequest} requestParameters Request parameters.
|
|
595
|
+
* @param {*} [options] Override http request option.
|
|
596
|
+
* @throws {RequiredError}
|
|
597
|
+
* @memberof PartnerHierarchyNodesApi
|
|
598
|
+
*/
|
|
599
|
+
createPartnerHierarchyNode(requestParameters: PartnerHierarchyNodesApiCreatePartnerHierarchyNodeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerHierarchyNodeResponseClass, any, {}>>;
|
|
600
|
+
/**
|
|
601
|
+
* Deletes a partner hierarchy node. The node must have no children before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
|
|
602
|
+
* @summary Delete the partner hierarchy node
|
|
603
|
+
* @param {PartnerHierarchyNodesApiDeletePartnerHierarchyNodeRequest} requestParameters Request parameters.
|
|
604
|
+
* @param {*} [options] Override http request option.
|
|
605
|
+
* @throws {RequiredError}
|
|
606
|
+
* @memberof PartnerHierarchyNodesApi
|
|
607
|
+
*/
|
|
608
|
+
deletePartnerHierarchyNode(requestParameters: PartnerHierarchyNodesApiDeletePartnerHierarchyNodeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteByCodeResponseClass, any, {}>>;
|
|
609
|
+
/**
|
|
610
|
+
* Returns the details of one partner hierarchy node. Partner and parent node details can be included when needed. **Required Permissions** \"partner-management.partners.view\"
|
|
611
|
+
* @summary Retrieve the partner hierarchy node
|
|
612
|
+
* @param {PartnerHierarchyNodesApiGetPartnerHierarchyNodeRequest} requestParameters Request parameters.
|
|
613
|
+
* @param {*} [options] Override http request option.
|
|
614
|
+
* @throws {RequiredError}
|
|
615
|
+
* @memberof PartnerHierarchyNodesApi
|
|
616
|
+
*/
|
|
617
|
+
getPartnerHierarchyNode(requestParameters: PartnerHierarchyNodesApiGetPartnerHierarchyNodeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerHierarchyNodeResponseClass, any, {}>>;
|
|
618
|
+
/**
|
|
619
|
+
* Returns a paginated list of previous versions of partner hierarchy nodes for history review. **Required Permissions** \"partner-management.partners.view\"
|
|
620
|
+
* @summary List partner hierarchy node histories
|
|
621
|
+
* @param {PartnerHierarchyNodesApiListPartnerHierarchyNodeHistoryRequest} requestParameters Request parameters.
|
|
622
|
+
* @param {*} [options] Override http request option.
|
|
623
|
+
* @throws {RequiredError}
|
|
624
|
+
* @memberof PartnerHierarchyNodesApi
|
|
625
|
+
*/
|
|
626
|
+
listPartnerHierarchyNodeHistory(requestParameters?: PartnerHierarchyNodesApiListPartnerHierarchyNodeHistoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerHierarchyNodeHistoryResponseClass, any, {}>>;
|
|
627
|
+
/**
|
|
628
|
+
* Returns a paginated list of partner hierarchy nodes. **Required Permissions** \"partner-management.partners.view\"
|
|
629
|
+
* @summary List partner hierarchy nodes
|
|
630
|
+
* @param {PartnerHierarchyNodesApiListPartnerHierarchyNodesRequest} requestParameters Request parameters.
|
|
631
|
+
* @param {*} [options] Override http request option.
|
|
632
|
+
* @throws {RequiredError}
|
|
633
|
+
* @memberof PartnerHierarchyNodesApi
|
|
634
|
+
*/
|
|
635
|
+
listPartnerHierarchyNodes(requestParameters?: PartnerHierarchyNodesApiListPartnerHierarchyNodesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerHierarchyNodesResponseClass, any, {}>>;
|
|
636
|
+
/**
|
|
637
|
+
* Moves a node under another parent at the same level in the same hierarchy. Any nodes below it move with it. **Required Permissions** \"partner-management.partners.update\"
|
|
638
|
+
* @summary Create the partner hierarchy node move
|
|
639
|
+
* @param {PartnerHierarchyNodesApiMovePartnerHierarchyNodeRequest} requestParameters Request parameters.
|
|
640
|
+
* @param {*} [options] Override http request option.
|
|
641
|
+
* @throws {RequiredError}
|
|
642
|
+
* @memberof PartnerHierarchyNodesApi
|
|
643
|
+
*/
|
|
644
|
+
movePartnerHierarchyNode(requestParameters: PartnerHierarchyNodesApiMovePartnerHierarchyNodeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MovePartnerHierarchyNodeResponseClass, any, {}>>;
|
|
645
|
+
/**
|
|
646
|
+
* Removes the partner assigned to a partner hierarchy node while keeping the node in the tree. **Required Permissions** \"partner-management.partners.update\"
|
|
647
|
+
* @summary Create the partner hierarchy node unassign
|
|
648
|
+
* @param {PartnerHierarchyNodesApiUnassignPartnerHierarchyNodeRequest} requestParameters Request parameters.
|
|
649
|
+
* @param {*} [options] Override http request option.
|
|
650
|
+
* @throws {RequiredError}
|
|
651
|
+
* @memberof PartnerHierarchyNodesApi
|
|
652
|
+
*/
|
|
653
|
+
unassignPartnerHierarchyNode(requestParameters: PartnerHierarchyNodesApiUnassignPartnerHierarchyNodeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UnassignPartnerHierarchyNodeResponseClass, any, {}>>;
|
|
654
|
+
/**
|
|
655
|
+
* Updates a node role or changes the partner assigned to the node. It does not move the node in the tree. **Required Permissions** \"partner-management.partners.update\"
|
|
656
|
+
* @summary Update the partner hierarchy node
|
|
657
|
+
* @param {PartnerHierarchyNodesApiUpdatePartnerHierarchyNodeRequest} requestParameters Request parameters.
|
|
658
|
+
* @param {*} [options] Override http request option.
|
|
659
|
+
* @throws {RequiredError}
|
|
660
|
+
* @memberof PartnerHierarchyNodesApi
|
|
661
|
+
*/
|
|
662
|
+
updatePartnerHierarchyNode(requestParameters: PartnerHierarchyNodesApiUpdatePartnerHierarchyNodeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePartnerHierarchyNodeResponseClass, any, {}>>;
|
|
663
|
+
}
|