@emilgroup/partner-sdk 1.22.1-beta.18 → 1.22.1-beta.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/.openapi-generator/FILES +7 -0
  2. package/README.md +2 -2
  3. package/api/partner-hierarchies-api.ts +89 -64
  4. package/api/partner-hierarchy-nodes-api.ts +58 -39
  5. package/api/partner-hierarchy-types-api.ts +20 -20
  6. package/dist/api/partner-hierarchies-api.d.ts +79 -65
  7. package/dist/api/partner-hierarchies-api.js +65 -58
  8. package/dist/api/partner-hierarchy-nodes-api.d.ts +47 -36
  9. package/dist/api/partner-hierarchy-nodes-api.js +45 -39
  10. package/dist/api/partner-hierarchy-types-api.d.ts +20 -20
  11. package/dist/api/partner-hierarchy-types-api.js +20 -20
  12. package/dist/models/batch-create-partner-hierarchy-nodes-request-dto.d.ts +30 -0
  13. package/dist/models/batch-create-partner-hierarchy-nodes-request-dto.js +15 -0
  14. package/dist/models/generate-upload-url-response-class.d.ts +36 -0
  15. package/dist/models/generate-upload-url-response-class.js +15 -0
  16. package/dist/models/get-partner-hierarchy-tree-file-response-class.d.ts +42 -0
  17. package/dist/models/get-partner-hierarchy-tree-file-response-class.js +15 -0
  18. package/dist/models/index.d.ts +7 -0
  19. package/dist/models/index.js +7 -0
  20. package/dist/models/list-partner-hierarchy-operations-response-class.d.ts +43 -0
  21. package/dist/models/list-partner-hierarchy-operations-response-class.js +15 -0
  22. package/dist/models/partner-hierarchy-async-operation-response-class.d.ts +30 -0
  23. package/dist/models/partner-hierarchy-async-operation-response-class.js +15 -0
  24. package/dist/models/partner-hierarchy-class.d.ts +1 -1
  25. package/dist/models/partner-hierarchy-node-class.d.ts +4 -4
  26. package/dist/models/partner-hierarchy-node-history-class.d.ts +3 -3
  27. package/dist/models/partner-hierarchy-node-tree-class.d.ts +6 -6
  28. package/dist/models/partner-hierarchy-operation-class.d.ts +90 -0
  29. package/dist/models/partner-hierarchy-operation-class.js +15 -0
  30. package/dist/models/update-partner-hierarchy-tree-request-body-dto.d.ts +24 -0
  31. package/dist/models/update-partner-hierarchy-tree-request-body-dto.js +15 -0
  32. package/models/batch-create-partner-hierarchy-nodes-request-dto.ts +36 -0
  33. package/models/generate-upload-url-response-class.ts +42 -0
  34. package/models/get-partner-hierarchy-tree-file-response-class.ts +48 -0
  35. package/models/index.ts +7 -0
  36. package/models/list-partner-hierarchy-operations-response-class.ts +49 -0
  37. package/models/partner-hierarchy-async-operation-response-class.ts +36 -0
  38. package/models/partner-hierarchy-class.ts +1 -1
  39. package/models/partner-hierarchy-node-class.ts +4 -4
  40. package/models/partner-hierarchy-node-history-class.ts +3 -3
  41. package/models/partner-hierarchy-node-tree-class.ts +6 -6
  42. package/models/partner-hierarchy-operation-class.ts +96 -0
  43. package/models/update-partner-hierarchy-tree-request-body-dto.ts +30 -0
  44. package/package.json +1 -1
@@ -15,11 +15,16 @@ import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreatePartnerHierarchyRequestDto } from '../models';
16
16
  import { CreatePartnerHierarchyResponseClass } from '../models';
17
17
  import { DeleteByCodeResponseClass } from '../models';
18
+ import { GenerateUploadUrlResponseClass } from '../models';
18
19
  import { GetPartnerHierarchyResponseClass } from '../models';
20
+ import { GetPartnerHierarchyTreeFileResponseClass } from '../models';
19
21
  import { GetPartnerHierarchyTreeResponseClass } from '../models';
20
22
  import { ListPartnerHierarchiesResponseClass } from '../models';
23
+ import { ListPartnerHierarchyOperationsResponseClass } from '../models';
24
+ import { PartnerHierarchyAsyncOperationResponseClass } from '../models';
21
25
  import { UpdatePartnerHierarchyRequestDto } from '../models';
22
26
  import { UpdatePartnerHierarchyResponseClass } from '../models';
27
+ import { UpdatePartnerHierarchyTreeRequestBodyDto } from '../models';
23
28
  /**
24
29
  * PartnerHierarchiesApi - axios parameter creator
25
30
  * @export
@@ -27,7 +32,7 @@ import { UpdatePartnerHierarchyResponseClass } from '../models';
27
32
  export declare const PartnerHierarchiesApiAxiosParamCreator: (configuration?: Configuration) => {
28
33
  /**
29
34
  * Creates a partner hierarchy from an existing hierarchy type. The hierarchy starts empty, so nodes can be added after it is created. **Required Permissions** \"partner-management.partners.create\"
30
- * @summary Create the partner hierarchy
35
+ * @summary Create a partner hierarchy
31
36
  * @param {CreatePartnerHierarchyRequestDto} createPartnerHierarchyRequestDto
32
37
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
33
38
  * @param {*} [options] Override http request option.
@@ -36,7 +41,7 @@ export declare const PartnerHierarchiesApiAxiosParamCreator: (configuration?: Co
36
41
  createPartnerHierarchy: (createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
42
  /**
38
43
  * Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
39
- * @summary Delete the partner hierarchy
44
+ * @summary Delete a partner hierarchy
40
45
  * @param {string} code Unique identifier for the object.
41
46
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
42
47
  * @param {*} [options] Override http request option.
@@ -44,8 +49,8 @@ export declare const PartnerHierarchiesApiAxiosParamCreator: (configuration?: Co
44
49
  */
45
50
  deletePartnerHierarchy: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
51
  /**
47
- * Returns a pre-signed upload URL for a hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.update\"
48
- * @summary Create the partner hierarchy upload url
52
+ * Returns a pre-signed upload URL for a partner hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.update\"
53
+ * @summary Generate a pre-signed upload URL for a partner hierarchy tree file
49
54
  * @param {string} code Unique identifier for the object.
50
55
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
51
56
  * @param {*} [options] Override http request option.
@@ -54,7 +59,7 @@ export declare const PartnerHierarchiesApiAxiosParamCreator: (configuration?: Co
54
59
  generateUploadUrl: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
55
60
  /**
56
61
  * Returns the details of one partner hierarchy, including its name and hierarchy type. **Required Permissions** \"partner-management.partners.view\"
57
- * @summary Retrieve the partner hierarchy
62
+ * @summary Get a partner hierarchy
58
63
  * @param {string} code Unique identifier for the object.
59
64
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
60
65
  * @param {*} [options] Override http request option.
@@ -63,7 +68,7 @@ export declare const PartnerHierarchiesApiAxiosParamCreator: (configuration?: Co
63
68
  getPartnerHierarchy: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
69
  /**
65
70
  * Returns one part of the hierarchy tree: the selected node and its direct children. If no node is selected, it starts from the top of the hierarchy. **Required Permissions** \"partner-management.partners.view\"
66
- * @summary Retrieve the partner hierarchy tree
71
+ * @summary Get part of a partner hierarchy tree
67
72
  * @param {string} code Unique identifier for the object.
68
73
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
69
74
  * @param {string} [nodeCode] Node to start from. Omit this to start from the top of the hierarchy.
@@ -75,8 +80,8 @@ export declare const PartnerHierarchiesApiAxiosParamCreator: (configuration?: Co
75
80
  */
76
81
  getPartnerHierarchyTree: (code: string, authorization?: string, nodeCode?: string, pageSize?: number, pageToken?: string, asOf?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
77
82
  /**
78
- * Returns a download URL for the full hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done. **Required Permissions** \"partner-management.partners.view\"
79
- * @summary Retrieve the partner hierarchy tree file
83
+ * Returns a download URL for the full partner hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done. **Required Permissions** \"partner-management.partners.view\"
84
+ * @summary Get a partner hierarchy tree file
80
85
  * @param {string} code Unique identifier for the object.
81
86
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
82
87
  * @param {*} [options] Override http request option.
@@ -99,8 +104,8 @@ export declare const PartnerHierarchiesApiAxiosParamCreator: (configuration?: Co
99
104
  */
100
105
  listPartnerHierarchies: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
101
106
  /**
102
- * Returns long-running file operations for this hierarchy, such as tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.view\"
103
- * @summary List partner hierarchy operations
107
+ * Returns long-running file operations for this partner hierarchy, such as tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.view\"
108
+ * @summary List partner hierarchy file operations
104
109
  * @param {any} code Unique identifier for the object.
105
110
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
106
111
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -116,7 +121,7 @@ export declare const PartnerHierarchiesApiAxiosParamCreator: (configuration?: Co
116
121
  listPartnerHierarchyOperations: (code: any, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
117
122
  /**
118
123
  * Updates the partner hierarchy details without changing any nodes in the tree. **Required Permissions** \"partner-management.partners.update\"
119
- * @summary Update the partner hierarchy
124
+ * @summary Update a partner hierarchy
120
125
  * @param {string} code Unique identifier for the object.
121
126
  * @param {UpdatePartnerHierarchyRequestDto} updatePartnerHierarchyRequestDto
122
127
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -125,14 +130,15 @@ export declare const PartnerHierarchiesApiAxiosParamCreator: (configuration?: Co
125
130
  */
126
131
  updatePartnerHierarchy: (code: string, updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
127
132
  /**
128
- * Replaces the hierarchy tree with an uploaded file. **Required Permissions** \"partner-management.partners.update\"
129
- * @summary Update the partner hierarchy tree
133
+ * Replaces the current partner hierarchy tree using the contents of an uploaded file. **Required Permissions** \"partner-management.partners.update\"
134
+ * @summary Replace the partner hierarchy tree from an uploaded file
130
135
  * @param {string} code Unique identifier for the object.
136
+ * @param {UpdatePartnerHierarchyTreeRequestBodyDto} updatePartnerHierarchyTreeRequestBodyDto
131
137
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
132
138
  * @param {*} [options] Override http request option.
133
139
  * @throws {RequiredError}
134
140
  */
135
- updatePartnerHierarchyTree: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
141
+ updatePartnerHierarchyTree: (code: string, updatePartnerHierarchyTreeRequestBodyDto: UpdatePartnerHierarchyTreeRequestBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
136
142
  };
137
143
  /**
138
144
  * PartnerHierarchiesApi - functional programming interface
@@ -141,7 +147,7 @@ export declare const PartnerHierarchiesApiAxiosParamCreator: (configuration?: Co
141
147
  export declare const PartnerHierarchiesApiFp: (configuration?: Configuration) => {
142
148
  /**
143
149
  * Creates a partner hierarchy from an existing hierarchy type. The hierarchy starts empty, so nodes can be added after it is created. **Required Permissions** \"partner-management.partners.create\"
144
- * @summary Create the partner hierarchy
150
+ * @summary Create a partner hierarchy
145
151
  * @param {CreatePartnerHierarchyRequestDto} createPartnerHierarchyRequestDto
146
152
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
147
153
  * @param {*} [options] Override http request option.
@@ -150,7 +156,7 @@ export declare const PartnerHierarchiesApiFp: (configuration?: Configuration) =>
150
156
  createPartnerHierarchy(createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerHierarchyResponseClass>>;
151
157
  /**
152
158
  * Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
153
- * @summary Delete the partner hierarchy
159
+ * @summary Delete a partner hierarchy
154
160
  * @param {string} code Unique identifier for the object.
155
161
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
156
162
  * @param {*} [options] Override http request option.
@@ -158,17 +164,17 @@ export declare const PartnerHierarchiesApiFp: (configuration?: Configuration) =>
158
164
  */
159
165
  deletePartnerHierarchy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>>;
160
166
  /**
161
- * Returns a pre-signed upload URL for a hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.update\"
162
- * @summary Create the partner hierarchy upload url
167
+ * Returns a pre-signed upload URL for a partner hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.update\"
168
+ * @summary Generate a pre-signed upload URL for a partner hierarchy tree file
163
169
  * @param {string} code Unique identifier for the object.
164
170
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
165
171
  * @param {*} [options] Override http request option.
166
172
  * @throws {RequiredError}
167
173
  */
168
- generateUploadUrl(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
174
+ generateUploadUrl(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateUploadUrlResponseClass>>;
169
175
  /**
170
176
  * Returns the details of one partner hierarchy, including its name and hierarchy type. **Required Permissions** \"partner-management.partners.view\"
171
- * @summary Retrieve the partner hierarchy
177
+ * @summary Get a partner hierarchy
172
178
  * @param {string} code Unique identifier for the object.
173
179
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
174
180
  * @param {*} [options] Override http request option.
@@ -177,7 +183,7 @@ export declare const PartnerHierarchiesApiFp: (configuration?: Configuration) =>
177
183
  getPartnerHierarchy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyResponseClass>>;
178
184
  /**
179
185
  * Returns one part of the hierarchy tree: the selected node and its direct children. If no node is selected, it starts from the top of the hierarchy. **Required Permissions** \"partner-management.partners.view\"
180
- * @summary Retrieve the partner hierarchy tree
186
+ * @summary Get part of a partner hierarchy tree
181
187
  * @param {string} code Unique identifier for the object.
182
188
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
183
189
  * @param {string} [nodeCode] Node to start from. Omit this to start from the top of the hierarchy.
@@ -189,14 +195,14 @@ export declare const PartnerHierarchiesApiFp: (configuration?: Configuration) =>
189
195
  */
190
196
  getPartnerHierarchyTree(code: string, authorization?: string, nodeCode?: string, pageSize?: number, pageToken?: string, asOf?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyTreeResponseClass>>;
191
197
  /**
192
- * Returns a download URL for the full hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done. **Required Permissions** \"partner-management.partners.view\"
193
- * @summary Retrieve the partner hierarchy tree file
198
+ * Returns a download URL for the full partner hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done. **Required Permissions** \"partner-management.partners.view\"
199
+ * @summary Get a partner hierarchy tree file
194
200
  * @param {string} code Unique identifier for the object.
195
201
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
196
202
  * @param {*} [options] Override http request option.
197
203
  * @throws {RequiredError}
198
204
  */
199
- getPartnerHierarchyTreeFile(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
205
+ getPartnerHierarchyTreeFile(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyTreeFileResponseClass>>;
200
206
  /**
201
207
  * Returns a paginated list of partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
202
208
  * @summary List partner hierarchies
@@ -213,8 +219,8 @@ export declare const PartnerHierarchiesApiFp: (configuration?: Configuration) =>
213
219
  */
214
220
  listPartnerHierarchies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerHierarchiesResponseClass>>;
215
221
  /**
216
- * Returns long-running file operations for this hierarchy, such as tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.view\"
217
- * @summary List partner hierarchy operations
222
+ * Returns long-running file operations for this partner hierarchy, such as tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.view\"
223
+ * @summary List partner hierarchy file operations
218
224
  * @param {any} code Unique identifier for the object.
219
225
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
220
226
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -227,10 +233,10 @@ export declare const PartnerHierarchiesApiFp: (configuration?: Configuration) =>
227
233
  * @param {*} [options] Override http request option.
228
234
  * @throws {RequiredError}
229
235
  */
230
- listPartnerHierarchyOperations(code: any, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
236
+ listPartnerHierarchyOperations(code: any, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerHierarchyOperationsResponseClass>>;
231
237
  /**
232
238
  * Updates the partner hierarchy details without changing any nodes in the tree. **Required Permissions** \"partner-management.partners.update\"
233
- * @summary Update the partner hierarchy
239
+ * @summary Update a partner hierarchy
234
240
  * @param {string} code Unique identifier for the object.
235
241
  * @param {UpdatePartnerHierarchyRequestDto} updatePartnerHierarchyRequestDto
236
242
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -239,14 +245,15 @@ export declare const PartnerHierarchiesApiFp: (configuration?: Configuration) =>
239
245
  */
240
246
  updatePartnerHierarchy(code: string, updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePartnerHierarchyResponseClass>>;
241
247
  /**
242
- * Replaces the hierarchy tree with an uploaded file. **Required Permissions** \"partner-management.partners.update\"
243
- * @summary Update the partner hierarchy tree
248
+ * Replaces the current partner hierarchy tree using the contents of an uploaded file. **Required Permissions** \"partner-management.partners.update\"
249
+ * @summary Replace the partner hierarchy tree from an uploaded file
244
250
  * @param {string} code Unique identifier for the object.
251
+ * @param {UpdatePartnerHierarchyTreeRequestBodyDto} updatePartnerHierarchyTreeRequestBodyDto
245
252
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
246
253
  * @param {*} [options] Override http request option.
247
254
  * @throws {RequiredError}
248
255
  */
249
- updatePartnerHierarchyTree(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
256
+ updatePartnerHierarchyTree(code: string, updatePartnerHierarchyTreeRequestBodyDto: UpdatePartnerHierarchyTreeRequestBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerHierarchyAsyncOperationResponseClass>>;
250
257
  };
251
258
  /**
252
259
  * PartnerHierarchiesApi - factory interface
@@ -255,7 +262,7 @@ export declare const PartnerHierarchiesApiFp: (configuration?: Configuration) =>
255
262
  export declare const PartnerHierarchiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
256
263
  /**
257
264
  * Creates a partner hierarchy from an existing hierarchy type. The hierarchy starts empty, so nodes can be added after it is created. **Required Permissions** \"partner-management.partners.create\"
258
- * @summary Create the partner hierarchy
265
+ * @summary Create a partner hierarchy
259
266
  * @param {CreatePartnerHierarchyRequestDto} createPartnerHierarchyRequestDto
260
267
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
261
268
  * @param {*} [options] Override http request option.
@@ -264,7 +271,7 @@ export declare const PartnerHierarchiesApiFactory: (configuration?: Configuratio
264
271
  createPartnerHierarchy(createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePartnerHierarchyResponseClass>;
265
272
  /**
266
273
  * Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
267
- * @summary Delete the partner hierarchy
274
+ * @summary Delete a partner hierarchy
268
275
  * @param {string} code Unique identifier for the object.
269
276
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
270
277
  * @param {*} [options] Override http request option.
@@ -272,17 +279,17 @@ export declare const PartnerHierarchiesApiFactory: (configuration?: Configuratio
272
279
  */
273
280
  deletePartnerHierarchy(code: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass>;
274
281
  /**
275
- * Returns a pre-signed upload URL for a hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.update\"
276
- * @summary Create the partner hierarchy upload url
282
+ * Returns a pre-signed upload URL for a partner hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.update\"
283
+ * @summary Generate a pre-signed upload URL for a partner hierarchy tree file
277
284
  * @param {string} code Unique identifier for the object.
278
285
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
279
286
  * @param {*} [options] Override http request option.
280
287
  * @throws {RequiredError}
281
288
  */
282
- generateUploadUrl(code: string, authorization?: string, options?: any): AxiosPromise<void>;
289
+ generateUploadUrl(code: string, authorization?: string, options?: any): AxiosPromise<GenerateUploadUrlResponseClass>;
283
290
  /**
284
291
  * Returns the details of one partner hierarchy, including its name and hierarchy type. **Required Permissions** \"partner-management.partners.view\"
285
- * @summary Retrieve the partner hierarchy
292
+ * @summary Get a partner hierarchy
286
293
  * @param {string} code Unique identifier for the object.
287
294
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
288
295
  * @param {*} [options] Override http request option.
@@ -291,7 +298,7 @@ export declare const PartnerHierarchiesApiFactory: (configuration?: Configuratio
291
298
  getPartnerHierarchy(code: string, authorization?: string, options?: any): AxiosPromise<GetPartnerHierarchyResponseClass>;
292
299
  /**
293
300
  * Returns one part of the hierarchy tree: the selected node and its direct children. If no node is selected, it starts from the top of the hierarchy. **Required Permissions** \"partner-management.partners.view\"
294
- * @summary Retrieve the partner hierarchy tree
301
+ * @summary Get part of a partner hierarchy tree
295
302
  * @param {string} code Unique identifier for the object.
296
303
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
297
304
  * @param {string} [nodeCode] Node to start from. Omit this to start from the top of the hierarchy.
@@ -303,14 +310,14 @@ export declare const PartnerHierarchiesApiFactory: (configuration?: Configuratio
303
310
  */
304
311
  getPartnerHierarchyTree(code: string, authorization?: string, nodeCode?: string, pageSize?: number, pageToken?: string, asOf?: string, options?: any): AxiosPromise<GetPartnerHierarchyTreeResponseClass>;
305
312
  /**
306
- * Returns a download URL for the full hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done. **Required Permissions** \"partner-management.partners.view\"
307
- * @summary Retrieve the partner hierarchy tree file
313
+ * Returns a download URL for the full partner hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done. **Required Permissions** \"partner-management.partners.view\"
314
+ * @summary Get a partner hierarchy tree file
308
315
  * @param {string} code Unique identifier for the object.
309
316
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
310
317
  * @param {*} [options] Override http request option.
311
318
  * @throws {RequiredError}
312
319
  */
313
- getPartnerHierarchyTreeFile(code: string, authorization?: string, options?: any): AxiosPromise<void>;
320
+ getPartnerHierarchyTreeFile(code: string, authorization?: string, options?: any): AxiosPromise<GetPartnerHierarchyTreeFileResponseClass>;
314
321
  /**
315
322
  * Returns a paginated list of partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
316
323
  * @summary List partner hierarchies
@@ -327,8 +334,8 @@ export declare const PartnerHierarchiesApiFactory: (configuration?: Configuratio
327
334
  */
328
335
  listPartnerHierarchies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerHierarchiesResponseClass>;
329
336
  /**
330
- * Returns long-running file operations for this hierarchy, such as tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.view\"
331
- * @summary List partner hierarchy operations
337
+ * Returns long-running file operations for this partner hierarchy, such as tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.view\"
338
+ * @summary List partner hierarchy file operations
332
339
  * @param {any} code Unique identifier for the object.
333
340
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
334
341
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -341,10 +348,10 @@ export declare const PartnerHierarchiesApiFactory: (configuration?: Configuratio
341
348
  * @param {*} [options] Override http request option.
342
349
  * @throws {RequiredError}
343
350
  */
344
- listPartnerHierarchyOperations(code: any, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void>;
351
+ listPartnerHierarchyOperations(code: any, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerHierarchyOperationsResponseClass>;
345
352
  /**
346
353
  * Updates the partner hierarchy details without changing any nodes in the tree. **Required Permissions** \"partner-management.partners.update\"
347
- * @summary Update the partner hierarchy
354
+ * @summary Update a partner hierarchy
348
355
  * @param {string} code Unique identifier for the object.
349
356
  * @param {UpdatePartnerHierarchyRequestDto} updatePartnerHierarchyRequestDto
350
357
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -353,14 +360,15 @@ export declare const PartnerHierarchiesApiFactory: (configuration?: Configuratio
353
360
  */
354
361
  updatePartnerHierarchy(code: string, updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePartnerHierarchyResponseClass>;
355
362
  /**
356
- * Replaces the hierarchy tree with an uploaded file. **Required Permissions** \"partner-management.partners.update\"
357
- * @summary Update the partner hierarchy tree
363
+ * Replaces the current partner hierarchy tree using the contents of an uploaded file. **Required Permissions** \"partner-management.partners.update\"
364
+ * @summary Replace the partner hierarchy tree from an uploaded file
358
365
  * @param {string} code Unique identifier for the object.
366
+ * @param {UpdatePartnerHierarchyTreeRequestBodyDto} updatePartnerHierarchyTreeRequestBodyDto
359
367
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
360
368
  * @param {*} [options] Override http request option.
361
369
  * @throws {RequiredError}
362
370
  */
363
- updatePartnerHierarchyTree(code: string, authorization?: string, options?: any): AxiosPromise<void>;
371
+ updatePartnerHierarchyTree(code: string, updatePartnerHierarchyTreeRequestBodyDto: UpdatePartnerHierarchyTreeRequestBodyDto, authorization?: string, options?: any): AxiosPromise<PartnerHierarchyAsyncOperationResponseClass>;
364
372
  };
365
373
  /**
366
374
  * Request parameters for createPartnerHierarchy operation in PartnerHierarchiesApi.
@@ -653,6 +661,12 @@ export interface PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest {
653
661
  * @memberof PartnerHierarchiesApiUpdatePartnerHierarchyTree
654
662
  */
655
663
  readonly code: string;
664
+ /**
665
+ *
666
+ * @type {UpdatePartnerHierarchyTreeRequestBodyDto}
667
+ * @memberof PartnerHierarchiesApiUpdatePartnerHierarchyTree
668
+ */
669
+ readonly updatePartnerHierarchyTreeRequestBodyDto: UpdatePartnerHierarchyTreeRequestBodyDto;
656
670
  /**
657
671
  * Bearer Token: provided by the login endpoint under the name accessToken.
658
672
  * @type {string}
@@ -669,7 +683,7 @@ export interface PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest {
669
683
  export declare class PartnerHierarchiesApi extends BaseAPI {
670
684
  /**
671
685
  * Creates a partner hierarchy from an existing hierarchy type. The hierarchy starts empty, so nodes can be added after it is created. **Required Permissions** \"partner-management.partners.create\"
672
- * @summary Create the partner hierarchy
686
+ * @summary Create a partner hierarchy
673
687
  * @param {PartnerHierarchiesApiCreatePartnerHierarchyRequest} requestParameters Request parameters.
674
688
  * @param {*} [options] Override http request option.
675
689
  * @throws {RequiredError}
@@ -678,7 +692,7 @@ export declare class PartnerHierarchiesApi extends BaseAPI {
678
692
  createPartnerHierarchy(requestParameters: PartnerHierarchiesApiCreatePartnerHierarchyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerHierarchyResponseClass, any, {}>>;
679
693
  /**
680
694
  * Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
681
- * @summary Delete the partner hierarchy
695
+ * @summary Delete a partner hierarchy
682
696
  * @param {PartnerHierarchiesApiDeletePartnerHierarchyRequest} requestParameters Request parameters.
683
697
  * @param {*} [options] Override http request option.
684
698
  * @throws {RequiredError}
@@ -686,17 +700,17 @@ export declare class PartnerHierarchiesApi extends BaseAPI {
686
700
  */
687
701
  deletePartnerHierarchy(requestParameters: PartnerHierarchiesApiDeletePartnerHierarchyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteByCodeResponseClass, any, {}>>;
688
702
  /**
689
- * Returns a pre-signed upload URL for a hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.update\"
690
- * @summary Create the partner hierarchy upload url
703
+ * Returns a pre-signed upload URL for a partner hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.update\"
704
+ * @summary Generate a pre-signed upload URL for a partner hierarchy tree file
691
705
  * @param {PartnerHierarchiesApiGenerateUploadUrlRequest} requestParameters Request parameters.
692
706
  * @param {*} [options] Override http request option.
693
707
  * @throws {RequiredError}
694
708
  * @memberof PartnerHierarchiesApi
695
709
  */
696
- generateUploadUrl(requestParameters: PartnerHierarchiesApiGenerateUploadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
710
+ generateUploadUrl(requestParameters: PartnerHierarchiesApiGenerateUploadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateUploadUrlResponseClass, any, {}>>;
697
711
  /**
698
712
  * Returns the details of one partner hierarchy, including its name and hierarchy type. **Required Permissions** \"partner-management.partners.view\"
699
- * @summary Retrieve the partner hierarchy
713
+ * @summary Get a partner hierarchy
700
714
  * @param {PartnerHierarchiesApiGetPartnerHierarchyRequest} requestParameters Request parameters.
701
715
  * @param {*} [options] Override http request option.
702
716
  * @throws {RequiredError}
@@ -705,7 +719,7 @@ export declare class PartnerHierarchiesApi extends BaseAPI {
705
719
  getPartnerHierarchy(requestParameters: PartnerHierarchiesApiGetPartnerHierarchyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerHierarchyResponseClass, any, {}>>;
706
720
  /**
707
721
  * Returns one part of the hierarchy tree: the selected node and its direct children. If no node is selected, it starts from the top of the hierarchy. **Required Permissions** \"partner-management.partners.view\"
708
- * @summary Retrieve the partner hierarchy tree
722
+ * @summary Get part of a partner hierarchy tree
709
723
  * @param {PartnerHierarchiesApiGetPartnerHierarchyTreeRequest} requestParameters Request parameters.
710
724
  * @param {*} [options] Override http request option.
711
725
  * @throws {RequiredError}
@@ -713,14 +727,14 @@ export declare class PartnerHierarchiesApi extends BaseAPI {
713
727
  */
714
728
  getPartnerHierarchyTree(requestParameters: PartnerHierarchiesApiGetPartnerHierarchyTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerHierarchyTreeResponseClass, any, {}>>;
715
729
  /**
716
- * Returns a download URL for the full hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done. **Required Permissions** \"partner-management.partners.view\"
717
- * @summary Retrieve the partner hierarchy tree file
730
+ * Returns a download URL for the full partner hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done. **Required Permissions** \"partner-management.partners.view\"
731
+ * @summary Get a partner hierarchy tree file
718
732
  * @param {PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest} requestParameters Request parameters.
719
733
  * @param {*} [options] Override http request option.
720
734
  * @throws {RequiredError}
721
735
  * @memberof PartnerHierarchiesApi
722
736
  */
723
- getPartnerHierarchyTreeFile(requestParameters: PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
737
+ getPartnerHierarchyTreeFile(requestParameters: PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerHierarchyTreeFileResponseClass, any, {}>>;
724
738
  /**
725
739
  * Returns a paginated list of partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
726
740
  * @summary List partner hierarchies
@@ -731,17 +745,17 @@ export declare class PartnerHierarchiesApi extends BaseAPI {
731
745
  */
732
746
  listPartnerHierarchies(requestParameters?: PartnerHierarchiesApiListPartnerHierarchiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerHierarchiesResponseClass, any, {}>>;
733
747
  /**
734
- * Returns long-running file operations for this hierarchy, such as tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.view\"
735
- * @summary List partner hierarchy operations
748
+ * Returns long-running file operations for this partner hierarchy, such as tree replacement or batch node creation. **Required Permissions** \"partner-management.partners.view\"
749
+ * @summary List partner hierarchy file operations
736
750
  * @param {PartnerHierarchiesApiListPartnerHierarchyOperationsRequest} requestParameters Request parameters.
737
751
  * @param {*} [options] Override http request option.
738
752
  * @throws {RequiredError}
739
753
  * @memberof PartnerHierarchiesApi
740
754
  */
741
- listPartnerHierarchyOperations(requestParameters: PartnerHierarchiesApiListPartnerHierarchyOperationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
755
+ listPartnerHierarchyOperations(requestParameters: PartnerHierarchiesApiListPartnerHierarchyOperationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerHierarchyOperationsResponseClass, any, {}>>;
742
756
  /**
743
757
  * Updates the partner hierarchy details without changing any nodes in the tree. **Required Permissions** \"partner-management.partners.update\"
744
- * @summary Update the partner hierarchy
758
+ * @summary Update a partner hierarchy
745
759
  * @param {PartnerHierarchiesApiUpdatePartnerHierarchyRequest} requestParameters Request parameters.
746
760
  * @param {*} [options] Override http request option.
747
761
  * @throws {RequiredError}
@@ -749,12 +763,12 @@ export declare class PartnerHierarchiesApi extends BaseAPI {
749
763
  */
750
764
  updatePartnerHierarchy(requestParameters: PartnerHierarchiesApiUpdatePartnerHierarchyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePartnerHierarchyResponseClass, any, {}>>;
751
765
  /**
752
- * Replaces the hierarchy tree with an uploaded file. **Required Permissions** \"partner-management.partners.update\"
753
- * @summary Update the partner hierarchy tree
766
+ * Replaces the current partner hierarchy tree using the contents of an uploaded file. **Required Permissions** \"partner-management.partners.update\"
767
+ * @summary Replace the partner hierarchy tree from an uploaded file
754
768
  * @param {PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest} requestParameters Request parameters.
755
769
  * @param {*} [options] Override http request option.
756
770
  * @throws {RequiredError}
757
771
  * @memberof PartnerHierarchiesApi
758
772
  */
759
- updatePartnerHierarchyTree(requestParameters: PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
773
+ updatePartnerHierarchyTree(requestParameters: PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerHierarchyAsyncOperationResponseClass, any, {}>>;
760
774
  }