@emilgroup/partner-sdk 1.22.1-beta.9 → 1.23.1-beta.0

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 (146) hide show
  1. package/.openapi-generator/FILES +41 -0
  2. package/README.md +2 -2
  3. package/api/blacklist-api.ts +3 -3
  4. package/api/blacklist-reasons-api.ts +3 -3
  5. package/api/partner-hierarchies-api.ts +1367 -0
  6. package/api/partner-hierarchy-nodes-api.ts +1197 -0
  7. package/api/partner-hierarchy-types-api.ts +679 -0
  8. package/api/partners-api.ts +318 -12
  9. package/api.ts +6 -0
  10. package/base.ts +1 -0
  11. package/dist/api/blacklist-api.d.ts +4 -4
  12. package/dist/api/blacklist-reasons-api.d.ts +4 -4
  13. package/dist/api/partner-hierarchies-api.d.ts +774 -0
  14. package/dist/api/partner-hierarchies-api.js +1171 -0
  15. package/dist/api/partner-hierarchy-nodes-api.d.ts +674 -0
  16. package/dist/api/partner-hierarchy-nodes-api.js +1049 -0
  17. package/dist/api/partner-hierarchy-types-api.d.ts +385 -0
  18. package/dist/api/partner-hierarchy-types-api.js +636 -0
  19. package/dist/api/partners-api.d.ts +187 -12
  20. package/dist/api/partners-api.js +236 -9
  21. package/dist/api.d.ts +3 -0
  22. package/dist/api.js +3 -0
  23. package/dist/base.d.ts +2 -1
  24. package/dist/base.js +1 -0
  25. package/dist/models/batch-create-partner-hierarchy-nodes-request-dto.d.ts +30 -0
  26. package/dist/models/batch-create-partner-hierarchy-nodes-request-dto.js +15 -0
  27. package/dist/models/create-partner-hierarchy-node-request-dto.d.ts +42 -0
  28. package/dist/models/create-partner-hierarchy-node-request-dto.js +15 -0
  29. package/dist/models/create-partner-hierarchy-node-response-class.d.ts +25 -0
  30. package/dist/models/create-partner-hierarchy-node-response-class.js +15 -0
  31. package/dist/models/create-partner-hierarchy-request-dto.d.ts +30 -0
  32. package/dist/models/create-partner-hierarchy-request-dto.js +15 -0
  33. package/dist/models/create-partner-hierarchy-response-class.d.ts +25 -0
  34. package/dist/models/create-partner-hierarchy-response-class.js +15 -0
  35. package/dist/models/create-partner-hierarchy-type-request-dto.d.ts +30 -0
  36. package/dist/models/create-partner-hierarchy-type-request-dto.js +15 -0
  37. package/dist/models/create-partner-hierarchy-type-response-class.d.ts +25 -0
  38. package/dist/models/create-partner-hierarchy-type-response-class.js +15 -0
  39. package/dist/models/delete-by-code-response-class.d.ts +24 -0
  40. package/dist/models/delete-by-code-response-class.js +15 -0
  41. package/dist/models/generate-upload-url-response-class.d.ts +36 -0
  42. package/dist/models/generate-upload-url-response-class.js +15 -0
  43. package/dist/models/get-partner-hierarchy-node-response-class.d.ts +25 -0
  44. package/dist/models/get-partner-hierarchy-node-response-class.js +15 -0
  45. package/dist/models/get-partner-hierarchy-response-class.d.ts +25 -0
  46. package/dist/models/get-partner-hierarchy-response-class.js +15 -0
  47. package/dist/models/get-partner-hierarchy-tree-file-response-class.d.ts +42 -0
  48. package/dist/models/get-partner-hierarchy-tree-file-response-class.js +15 -0
  49. package/dist/models/get-partner-hierarchy-tree-response-class.d.ts +25 -0
  50. package/dist/models/get-partner-hierarchy-tree-response-class.js +15 -0
  51. package/dist/models/get-partner-hierarchy-type-response-class.d.ts +25 -0
  52. package/dist/models/get-partner-hierarchy-type-response-class.js +15 -0
  53. package/dist/models/index.d.ts +38 -0
  54. package/dist/models/index.js +38 -0
  55. package/dist/models/list-partner-hierarchies-response-class.d.ts +43 -0
  56. package/dist/models/list-partner-hierarchies-response-class.js +15 -0
  57. package/dist/models/list-partner-hierarchy-node-history-response-class.d.ts +43 -0
  58. package/dist/models/list-partner-hierarchy-node-history-response-class.js +15 -0
  59. package/dist/models/list-partner-hierarchy-nodes-response-class.d.ts +43 -0
  60. package/dist/models/list-partner-hierarchy-nodes-response-class.js +15 -0
  61. package/dist/models/list-partner-hierarchy-operations-response-class.d.ts +43 -0
  62. package/dist/models/list-partner-hierarchy-operations-response-class.js +15 -0
  63. package/dist/models/list-partner-hierarchy-types-response-class.d.ts +43 -0
  64. package/dist/models/list-partner-hierarchy-types-response-class.js +15 -0
  65. package/dist/models/list-partners-response-class.d.ts +9 -9
  66. package/dist/models/move-partner-hierarchy-node-request-dto.d.ts +30 -0
  67. package/dist/models/move-partner-hierarchy-node-request-dto.js +15 -0
  68. package/dist/models/move-partner-hierarchy-node-response-class.d.ts +25 -0
  69. package/dist/models/move-partner-hierarchy-node-response-class.js +15 -0
  70. package/dist/models/partner-class.d.ts +6 -0
  71. package/dist/models/partner-hierarchy-async-operation-response-class.d.ts +30 -0
  72. package/dist/models/partner-hierarchy-async-operation-response-class.js +15 -0
  73. package/dist/models/partner-hierarchy-class.d.ts +78 -0
  74. package/dist/models/partner-hierarchy-class.js +15 -0
  75. package/dist/models/partner-hierarchy-node-class.d.ts +109 -0
  76. package/dist/models/partner-hierarchy-node-class.js +15 -0
  77. package/dist/models/partner-hierarchy-node-history-class.d.ts +97 -0
  78. package/dist/models/partner-hierarchy-node-history-class.js +15 -0
  79. package/dist/models/partner-hierarchy-node-tree-class.d.ts +96 -0
  80. package/dist/models/partner-hierarchy-node-tree-class.js +15 -0
  81. package/dist/models/partner-hierarchy-operation-class.d.ts +90 -0
  82. package/dist/models/partner-hierarchy-operation-class.js +15 -0
  83. package/dist/models/partner-hierarchy-type-class.d.ts +66 -0
  84. package/dist/models/partner-hierarchy-type-class.js +15 -0
  85. package/dist/models/unassign-partner-hierarchy-node-response-class.d.ts +25 -0
  86. package/dist/models/unassign-partner-hierarchy-node-response-class.js +15 -0
  87. package/dist/models/update-partner-hierarchy-node-request-dto.d.ts +30 -0
  88. package/dist/models/update-partner-hierarchy-node-request-dto.js +15 -0
  89. package/dist/models/update-partner-hierarchy-node-response-class.d.ts +25 -0
  90. package/dist/models/update-partner-hierarchy-node-response-class.js +15 -0
  91. package/dist/models/update-partner-hierarchy-request-dto.d.ts +24 -0
  92. package/dist/models/update-partner-hierarchy-request-dto.js +15 -0
  93. package/dist/models/update-partner-hierarchy-response-class.d.ts +25 -0
  94. package/dist/models/update-partner-hierarchy-response-class.js +15 -0
  95. package/dist/models/update-partner-hierarchy-tree-request-body-dto.d.ts +24 -0
  96. package/dist/models/update-partner-hierarchy-tree-request-body-dto.js +15 -0
  97. package/dist/models/update-partner-hierarchy-type-request-dto.d.ts +30 -0
  98. package/dist/models/update-partner-hierarchy-type-request-dto.js +15 -0
  99. package/dist/models/update-partner-hierarchy-type-response-class.d.ts +25 -0
  100. package/dist/models/update-partner-hierarchy-type-response-class.js +15 -0
  101. package/dist/models/validate-partner-request-dto.d.ts +30 -0
  102. package/dist/models/validate-partner-request-dto.js +15 -0
  103. package/dist/models/validate-partner-response-class.d.ts +30 -0
  104. package/dist/models/validate-partner-response-class.js +15 -0
  105. package/models/batch-create-partner-hierarchy-nodes-request-dto.ts +36 -0
  106. package/models/create-partner-hierarchy-node-request-dto.ts +48 -0
  107. package/models/create-partner-hierarchy-node-response-class.ts +31 -0
  108. package/models/create-partner-hierarchy-request-dto.ts +36 -0
  109. package/models/create-partner-hierarchy-response-class.ts +31 -0
  110. package/models/create-partner-hierarchy-type-request-dto.ts +36 -0
  111. package/models/create-partner-hierarchy-type-response-class.ts +31 -0
  112. package/models/delete-by-code-response-class.ts +30 -0
  113. package/models/generate-upload-url-response-class.ts +42 -0
  114. package/models/get-partner-hierarchy-node-response-class.ts +31 -0
  115. package/models/get-partner-hierarchy-response-class.ts +31 -0
  116. package/models/get-partner-hierarchy-tree-file-response-class.ts +48 -0
  117. package/models/get-partner-hierarchy-tree-response-class.ts +31 -0
  118. package/models/get-partner-hierarchy-type-response-class.ts +31 -0
  119. package/models/index.ts +38 -0
  120. package/models/list-partner-hierarchies-response-class.ts +49 -0
  121. package/models/list-partner-hierarchy-node-history-response-class.ts +49 -0
  122. package/models/list-partner-hierarchy-nodes-response-class.ts +49 -0
  123. package/models/list-partner-hierarchy-operations-response-class.ts +49 -0
  124. package/models/list-partner-hierarchy-types-response-class.ts +49 -0
  125. package/models/list-partners-response-class.ts +9 -9
  126. package/models/move-partner-hierarchy-node-request-dto.ts +36 -0
  127. package/models/move-partner-hierarchy-node-response-class.ts +31 -0
  128. package/models/partner-class.ts +6 -0
  129. package/models/partner-hierarchy-async-operation-response-class.ts +36 -0
  130. package/models/partner-hierarchy-class.ts +84 -0
  131. package/models/partner-hierarchy-node-class.ts +115 -0
  132. package/models/partner-hierarchy-node-history-class.ts +103 -0
  133. package/models/partner-hierarchy-node-tree-class.ts +102 -0
  134. package/models/partner-hierarchy-operation-class.ts +96 -0
  135. package/models/partner-hierarchy-type-class.ts +72 -0
  136. package/models/unassign-partner-hierarchy-node-response-class.ts +31 -0
  137. package/models/update-partner-hierarchy-node-request-dto.ts +36 -0
  138. package/models/update-partner-hierarchy-node-response-class.ts +31 -0
  139. package/models/update-partner-hierarchy-request-dto.ts +30 -0
  140. package/models/update-partner-hierarchy-response-class.ts +31 -0
  141. package/models/update-partner-hierarchy-tree-request-body-dto.ts +30 -0
  142. package/models/update-partner-hierarchy-type-request-dto.ts +36 -0
  143. package/models/update-partner-hierarchy-type-response-class.ts +31 -0
  144. package/models/validate-partner-request-dto.ts +36 -0
  145. package/models/validate-partner-response-class.ts +36 -0
  146. package/package.json +1 -1
@@ -0,0 +1,774 @@
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 { CreatePartnerHierarchyRequestDto } from '../models';
16
+ import { CreatePartnerHierarchyResponseClass } from '../models';
17
+ import { DeleteByCodeResponseClass } from '../models';
18
+ import { GenerateUploadUrlResponseClass } from '../models';
19
+ import { GetPartnerHierarchyResponseClass } from '../models';
20
+ import { GetPartnerHierarchyTreeFileResponseClass } from '../models';
21
+ import { GetPartnerHierarchyTreeResponseClass } from '../models';
22
+ import { ListPartnerHierarchiesResponseClass } from '../models';
23
+ import { ListPartnerHierarchyOperationsResponseClass } from '../models';
24
+ import { PartnerHierarchyAsyncOperationResponseClass } from '../models';
25
+ import { UpdatePartnerHierarchyRequestDto } from '../models';
26
+ import { UpdatePartnerHierarchyResponseClass } from '../models';
27
+ import { UpdatePartnerHierarchyTreeRequestBodyDto } from '../models';
28
+ /**
29
+ * PartnerHierarchiesApi - axios parameter creator
30
+ * @export
31
+ */
32
+ export declare const PartnerHierarchiesApiAxiosParamCreator: (configuration?: Configuration) => {
33
+ /**
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\"
35
+ * @summary Create a partner hierarchy
36
+ * @param {CreatePartnerHierarchyRequestDto} createPartnerHierarchyRequestDto
37
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
38
+ * @param {*} [options] Override http request option.
39
+ * @throws {RequiredError}
40
+ */
41
+ createPartnerHierarchy: (createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
+ /**
43
+ * Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
44
+ * @summary Delete a partner hierarchy
45
+ * @param {string} code Unique identifier for the object.
46
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ deletePartnerHierarchy: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51
+ /**
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
54
+ * @param {string} code Unique identifier for the object.
55
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
56
+ * @param {*} [options] Override http request option.
57
+ * @throws {RequiredError}
58
+ */
59
+ generateUploadUrl: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
60
+ /**
61
+ * Returns the details of one partner hierarchy, including its name and hierarchy type. **Required Permissions** \"partner-management.partners.view\"
62
+ * @summary Get a partner hierarchy
63
+ * @param {string} code Unique identifier for the object.
64
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
65
+ * @param {*} [options] Override http request option.
66
+ * @throws {RequiredError}
67
+ */
68
+ getPartnerHierarchy: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
+ /**
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\"
71
+ * @summary Get part of a partner hierarchy tree
72
+ * @param {string} code Unique identifier for the object.
73
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
74
+ * @param {string} [nodeCode] Node to start from. Omit this to start from the top of the hierarchy.
75
+ * @param {number} [pageSize] Maximum number of direct children to return for the selected node. Default is 30 and the maximum is 50.
76
+ * @param {string} [pageToken] Value returned by the previous response when more children are available.
77
+ * @param {string} [asOf] Shows the hierarchy as it was at this time. Omit this to show the current hierarchy.
78
+ * @param {*} [options] Override http request option.
79
+ * @throws {RequiredError}
80
+ */
81
+ getPartnerHierarchyTree: (code: string, authorization?: string, nodeCode?: string, pageSize?: number, pageToken?: string, asOf?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
82
+ /**
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
85
+ * @param {string} code Unique identifier for the object.
86
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
87
+ * @param {*} [options] Override http request option.
88
+ * @throws {RequiredError}
89
+ */
90
+ getPartnerHierarchyTreeFile: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
91
+ /**
92
+ * Returns a paginated list of partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
93
+ * @summary List partner hierarchies
94
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
95
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
96
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
97
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
98
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
99
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, createdAt, updatedAt&lt;/i&gt;
100
+ * @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.&lt;br/&gt; &lt;br/&gt;
101
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
102
+ * @param {*} [options] Override http request option.
103
+ * @throws {RequiredError}
104
+ */
105
+ listPartnerHierarchies: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
106
+ /**
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
109
+ * @param {any} code Unique identifier for the object.
110
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
111
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
112
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
113
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
114
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
115
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, createdAt, updatedAt&lt;/i&gt;
116
+ * @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.&lt;br/&gt; &lt;br/&gt;
117
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
118
+ * @param {*} [options] Override http request option.
119
+ * @throws {RequiredError}
120
+ */
121
+ listPartnerHierarchyOperations: (code: any, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
122
+ /**
123
+ * Updates the partner hierarchy details without changing any nodes in the tree. **Required Permissions** \"partner-management.partners.update\"
124
+ * @summary Update a partner hierarchy
125
+ * @param {string} code Unique identifier for the object.
126
+ * @param {UpdatePartnerHierarchyRequestDto} updatePartnerHierarchyRequestDto
127
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
128
+ * @param {*} [options] Override http request option.
129
+ * @throws {RequiredError}
130
+ */
131
+ updatePartnerHierarchy: (code: string, updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
132
+ /**
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
135
+ * @param {string} code Unique identifier for the object.
136
+ * @param {UpdatePartnerHierarchyTreeRequestBodyDto} updatePartnerHierarchyTreeRequestBodyDto
137
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
138
+ * @param {*} [options] Override http request option.
139
+ * @throws {RequiredError}
140
+ */
141
+ updatePartnerHierarchyTree: (code: string, updatePartnerHierarchyTreeRequestBodyDto: UpdatePartnerHierarchyTreeRequestBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
142
+ };
143
+ /**
144
+ * PartnerHierarchiesApi - functional programming interface
145
+ * @export
146
+ */
147
+ export declare const PartnerHierarchiesApiFp: (configuration?: Configuration) => {
148
+ /**
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\"
150
+ * @summary Create a partner hierarchy
151
+ * @param {CreatePartnerHierarchyRequestDto} createPartnerHierarchyRequestDto
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
+ createPartnerHierarchy(createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerHierarchyResponseClass>>;
157
+ /**
158
+ * Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
159
+ * @summary Delete a partner hierarchy
160
+ * @param {string} code Unique identifier for the object.
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
+ deletePartnerHierarchy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>>;
166
+ /**
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
169
+ * @param {string} code Unique identifier for the object.
170
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
171
+ * @param {*} [options] Override http request option.
172
+ * @throws {RequiredError}
173
+ */
174
+ generateUploadUrl(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateUploadUrlResponseClass>>;
175
+ /**
176
+ * Returns the details of one partner hierarchy, including its name and hierarchy type. **Required Permissions** \"partner-management.partners.view\"
177
+ * @summary Get a partner hierarchy
178
+ * @param {string} code Unique identifier for the object.
179
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
180
+ * @param {*} [options] Override http request option.
181
+ * @throws {RequiredError}
182
+ */
183
+ getPartnerHierarchy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyResponseClass>>;
184
+ /**
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\"
186
+ * @summary Get part of a partner hierarchy tree
187
+ * @param {string} code Unique identifier for the object.
188
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
189
+ * @param {string} [nodeCode] Node to start from. Omit this to start from the top of the hierarchy.
190
+ * @param {number} [pageSize] Maximum number of direct children to return for the selected node. Default is 30 and the maximum is 50.
191
+ * @param {string} [pageToken] Value returned by the previous response when more children are available.
192
+ * @param {string} [asOf] Shows the hierarchy as it was at this time. Omit this to show the current hierarchy.
193
+ * @param {*} [options] Override http request option.
194
+ * @throws {RequiredError}
195
+ */
196
+ getPartnerHierarchyTree(code: string, authorization?: string, nodeCode?: string, pageSize?: number, pageToken?: string, asOf?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyTreeResponseClass>>;
197
+ /**
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
200
+ * @param {string} code Unique identifier for the object.
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
+ getPartnerHierarchyTreeFile(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyTreeFileResponseClass>>;
206
+ /**
207
+ * Returns a paginated list of partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
208
+ * @summary List partner hierarchies
209
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
210
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
211
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
212
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
213
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
214
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, createdAt, updatedAt&lt;/i&gt;
215
+ * @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.&lt;br/&gt; &lt;br/&gt;
216
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
217
+ * @param {*} [options] Override http request option.
218
+ * @throws {RequiredError}
219
+ */
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>>;
221
+ /**
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
224
+ * @param {any} code Unique identifier for the object.
225
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
226
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
227
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
228
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
229
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
230
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, createdAt, updatedAt&lt;/i&gt;
231
+ * @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.&lt;br/&gt; &lt;br/&gt;
232
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
233
+ * @param {*} [options] Override http request option.
234
+ * @throws {RequiredError}
235
+ */
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>>;
237
+ /**
238
+ * Updates the partner hierarchy details without changing any nodes in the tree. **Required Permissions** \"partner-management.partners.update\"
239
+ * @summary Update a partner hierarchy
240
+ * @param {string} code Unique identifier for the object.
241
+ * @param {UpdatePartnerHierarchyRequestDto} updatePartnerHierarchyRequestDto
242
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
243
+ * @param {*} [options] Override http request option.
244
+ * @throws {RequiredError}
245
+ */
246
+ updatePartnerHierarchy(code: string, updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePartnerHierarchyResponseClass>>;
247
+ /**
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
250
+ * @param {string} code Unique identifier for the object.
251
+ * @param {UpdatePartnerHierarchyTreeRequestBodyDto} updatePartnerHierarchyTreeRequestBodyDto
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
+ updatePartnerHierarchyTree(code: string, updatePartnerHierarchyTreeRequestBodyDto: UpdatePartnerHierarchyTreeRequestBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerHierarchyAsyncOperationResponseClass>>;
257
+ };
258
+ /**
259
+ * PartnerHierarchiesApi - factory interface
260
+ * @export
261
+ */
262
+ export declare const PartnerHierarchiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
263
+ /**
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\"
265
+ * @summary Create a partner hierarchy
266
+ * @param {CreatePartnerHierarchyRequestDto} createPartnerHierarchyRequestDto
267
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
268
+ * @param {*} [options] Override http request option.
269
+ * @throws {RequiredError}
270
+ */
271
+ createPartnerHierarchy(createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePartnerHierarchyResponseClass>;
272
+ /**
273
+ * Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
274
+ * @summary Delete a partner hierarchy
275
+ * @param {string} code Unique identifier for the object.
276
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
277
+ * @param {*} [options] Override http request option.
278
+ * @throws {RequiredError}
279
+ */
280
+ deletePartnerHierarchy(code: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass>;
281
+ /**
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
284
+ * @param {string} code Unique identifier for the object.
285
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
286
+ * @param {*} [options] Override http request option.
287
+ * @throws {RequiredError}
288
+ */
289
+ generateUploadUrl(code: string, authorization?: string, options?: any): AxiosPromise<GenerateUploadUrlResponseClass>;
290
+ /**
291
+ * Returns the details of one partner hierarchy, including its name and hierarchy type. **Required Permissions** \"partner-management.partners.view\"
292
+ * @summary Get a partner hierarchy
293
+ * @param {string} code Unique identifier for the object.
294
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
295
+ * @param {*} [options] Override http request option.
296
+ * @throws {RequiredError}
297
+ */
298
+ getPartnerHierarchy(code: string, authorization?: string, options?: any): AxiosPromise<GetPartnerHierarchyResponseClass>;
299
+ /**
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\"
301
+ * @summary Get part of a partner hierarchy tree
302
+ * @param {string} code Unique identifier for the object.
303
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
304
+ * @param {string} [nodeCode] Node to start from. Omit this to start from the top of the hierarchy.
305
+ * @param {number} [pageSize] Maximum number of direct children to return for the selected node. Default is 30 and the maximum is 50.
306
+ * @param {string} [pageToken] Value returned by the previous response when more children are available.
307
+ * @param {string} [asOf] Shows the hierarchy as it was at this time. Omit this to show the current hierarchy.
308
+ * @param {*} [options] Override http request option.
309
+ * @throws {RequiredError}
310
+ */
311
+ getPartnerHierarchyTree(code: string, authorization?: string, nodeCode?: string, pageSize?: number, pageToken?: string, asOf?: string, options?: any): AxiosPromise<GetPartnerHierarchyTreeResponseClass>;
312
+ /**
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
315
+ * @param {string} code Unique identifier for the object.
316
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
317
+ * @param {*} [options] Override http request option.
318
+ * @throws {RequiredError}
319
+ */
320
+ getPartnerHierarchyTreeFile(code: string, authorization?: string, options?: any): AxiosPromise<GetPartnerHierarchyTreeFileResponseClass>;
321
+ /**
322
+ * Returns a paginated list of partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
323
+ * @summary List partner hierarchies
324
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
325
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
326
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
327
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
328
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
329
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, createdAt, updatedAt&lt;/i&gt;
330
+ * @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.&lt;br/&gt; &lt;br/&gt;
331
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
332
+ * @param {*} [options] Override http request option.
333
+ * @throws {RequiredError}
334
+ */
335
+ listPartnerHierarchies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerHierarchiesResponseClass>;
336
+ /**
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
339
+ * @param {any} code Unique identifier for the object.
340
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
341
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
342
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
343
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
344
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
345
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, createdAt, updatedAt&lt;/i&gt;
346
+ * @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.&lt;br/&gt; &lt;br/&gt;
347
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
348
+ * @param {*} [options] Override http request option.
349
+ * @throws {RequiredError}
350
+ */
351
+ listPartnerHierarchyOperations(code: any, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerHierarchyOperationsResponseClass>;
352
+ /**
353
+ * Updates the partner hierarchy details without changing any nodes in the tree. **Required Permissions** \"partner-management.partners.update\"
354
+ * @summary Update a partner hierarchy
355
+ * @param {string} code Unique identifier for the object.
356
+ * @param {UpdatePartnerHierarchyRequestDto} updatePartnerHierarchyRequestDto
357
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
358
+ * @param {*} [options] Override http request option.
359
+ * @throws {RequiredError}
360
+ */
361
+ updatePartnerHierarchy(code: string, updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePartnerHierarchyResponseClass>;
362
+ /**
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
365
+ * @param {string} code Unique identifier for the object.
366
+ * @param {UpdatePartnerHierarchyTreeRequestBodyDto} updatePartnerHierarchyTreeRequestBodyDto
367
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
368
+ * @param {*} [options] Override http request option.
369
+ * @throws {RequiredError}
370
+ */
371
+ updatePartnerHierarchyTree(code: string, updatePartnerHierarchyTreeRequestBodyDto: UpdatePartnerHierarchyTreeRequestBodyDto, authorization?: string, options?: any): AxiosPromise<PartnerHierarchyAsyncOperationResponseClass>;
372
+ };
373
+ /**
374
+ * Request parameters for createPartnerHierarchy operation in PartnerHierarchiesApi.
375
+ * @export
376
+ * @interface PartnerHierarchiesApiCreatePartnerHierarchyRequest
377
+ */
378
+ export interface PartnerHierarchiesApiCreatePartnerHierarchyRequest {
379
+ /**
380
+ *
381
+ * @type {CreatePartnerHierarchyRequestDto}
382
+ * @memberof PartnerHierarchiesApiCreatePartnerHierarchy
383
+ */
384
+ readonly createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto;
385
+ /**
386
+ * Bearer Token: provided by the login endpoint under the name accessToken.
387
+ * @type {string}
388
+ * @memberof PartnerHierarchiesApiCreatePartnerHierarchy
389
+ */
390
+ readonly authorization?: string;
391
+ }
392
+ /**
393
+ * Request parameters for deletePartnerHierarchy operation in PartnerHierarchiesApi.
394
+ * @export
395
+ * @interface PartnerHierarchiesApiDeletePartnerHierarchyRequest
396
+ */
397
+ export interface PartnerHierarchiesApiDeletePartnerHierarchyRequest {
398
+ /**
399
+ * Unique identifier for the object.
400
+ * @type {string}
401
+ * @memberof PartnerHierarchiesApiDeletePartnerHierarchy
402
+ */
403
+ readonly code: string;
404
+ /**
405
+ * Bearer Token: provided by the login endpoint under the name accessToken.
406
+ * @type {string}
407
+ * @memberof PartnerHierarchiesApiDeletePartnerHierarchy
408
+ */
409
+ readonly authorization?: string;
410
+ }
411
+ /**
412
+ * Request parameters for generateUploadUrl operation in PartnerHierarchiesApi.
413
+ * @export
414
+ * @interface PartnerHierarchiesApiGenerateUploadUrlRequest
415
+ */
416
+ export interface PartnerHierarchiesApiGenerateUploadUrlRequest {
417
+ /**
418
+ * Unique identifier for the object.
419
+ * @type {string}
420
+ * @memberof PartnerHierarchiesApiGenerateUploadUrl
421
+ */
422
+ readonly code: string;
423
+ /**
424
+ * Bearer Token: provided by the login endpoint under the name accessToken.
425
+ * @type {string}
426
+ * @memberof PartnerHierarchiesApiGenerateUploadUrl
427
+ */
428
+ readonly authorization?: string;
429
+ }
430
+ /**
431
+ * Request parameters for getPartnerHierarchy operation in PartnerHierarchiesApi.
432
+ * @export
433
+ * @interface PartnerHierarchiesApiGetPartnerHierarchyRequest
434
+ */
435
+ export interface PartnerHierarchiesApiGetPartnerHierarchyRequest {
436
+ /**
437
+ * Unique identifier for the object.
438
+ * @type {string}
439
+ * @memberof PartnerHierarchiesApiGetPartnerHierarchy
440
+ */
441
+ readonly code: string;
442
+ /**
443
+ * Bearer Token: provided by the login endpoint under the name accessToken.
444
+ * @type {string}
445
+ * @memberof PartnerHierarchiesApiGetPartnerHierarchy
446
+ */
447
+ readonly authorization?: string;
448
+ }
449
+ /**
450
+ * Request parameters for getPartnerHierarchyTree operation in PartnerHierarchiesApi.
451
+ * @export
452
+ * @interface PartnerHierarchiesApiGetPartnerHierarchyTreeRequest
453
+ */
454
+ export interface PartnerHierarchiesApiGetPartnerHierarchyTreeRequest {
455
+ /**
456
+ * Unique identifier for the object.
457
+ * @type {string}
458
+ * @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
459
+ */
460
+ readonly code: string;
461
+ /**
462
+ * Bearer Token: provided by the login endpoint under the name accessToken.
463
+ * @type {string}
464
+ * @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
465
+ */
466
+ readonly authorization?: string;
467
+ /**
468
+ * Node to start from. Omit this to start from the top of the hierarchy.
469
+ * @type {string}
470
+ * @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
471
+ */
472
+ readonly nodeCode?: string;
473
+ /**
474
+ * Maximum number of direct children to return for the selected node. Default is 30 and the maximum is 50.
475
+ * @type {number}
476
+ * @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
477
+ */
478
+ readonly pageSize?: number;
479
+ /**
480
+ * Value returned by the previous response when more children are available.
481
+ * @type {string}
482
+ * @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
483
+ */
484
+ readonly pageToken?: string;
485
+ /**
486
+ * Shows the hierarchy as it was at this time. Omit this to show the current hierarchy.
487
+ * @type {string}
488
+ * @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
489
+ */
490
+ readonly asOf?: string;
491
+ }
492
+ /**
493
+ * Request parameters for getPartnerHierarchyTreeFile operation in PartnerHierarchiesApi.
494
+ * @export
495
+ * @interface PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest
496
+ */
497
+ export interface PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest {
498
+ /**
499
+ * Unique identifier for the object.
500
+ * @type {string}
501
+ * @memberof PartnerHierarchiesApiGetPartnerHierarchyTreeFile
502
+ */
503
+ readonly code: string;
504
+ /**
505
+ * Bearer Token: provided by the login endpoint under the name accessToken.
506
+ * @type {string}
507
+ * @memberof PartnerHierarchiesApiGetPartnerHierarchyTreeFile
508
+ */
509
+ readonly authorization?: string;
510
+ }
511
+ /**
512
+ * Request parameters for listPartnerHierarchies operation in PartnerHierarchiesApi.
513
+ * @export
514
+ * @interface PartnerHierarchiesApiListPartnerHierarchiesRequest
515
+ */
516
+ export interface PartnerHierarchiesApiListPartnerHierarchiesRequest {
517
+ /**
518
+ * Bearer Token: provided by the login endpoint under the name accessToken.
519
+ * @type {string}
520
+ * @memberof PartnerHierarchiesApiListPartnerHierarchies
521
+ */
522
+ readonly authorization?: string;
523
+ /**
524
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
525
+ * @type {number}
526
+ * @memberof PartnerHierarchiesApiListPartnerHierarchies
527
+ */
528
+ readonly pageSize?: number;
529
+ /**
530
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
531
+ * @type {string}
532
+ * @memberof PartnerHierarchiesApiListPartnerHierarchies
533
+ */
534
+ readonly pageToken?: string;
535
+ /**
536
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
537
+ * @type {string}
538
+ * @memberof PartnerHierarchiesApiListPartnerHierarchies
539
+ */
540
+ readonly filter?: string;
541
+ /**
542
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
543
+ * @type {string}
544
+ * @memberof PartnerHierarchiesApiListPartnerHierarchies
545
+ */
546
+ readonly search?: string;
547
+ /**
548
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, createdAt, updatedAt&lt;/i&gt;
549
+ * @type {string}
550
+ * @memberof PartnerHierarchiesApiListPartnerHierarchies
551
+ */
552
+ readonly order?: string;
553
+ /**
554
+ * 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.&lt;br/&gt; &lt;br/&gt;
555
+ * @type {string}
556
+ * @memberof PartnerHierarchiesApiListPartnerHierarchies
557
+ */
558
+ readonly expand?: string;
559
+ /**
560
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
561
+ * @type {string}
562
+ * @memberof PartnerHierarchiesApiListPartnerHierarchies
563
+ */
564
+ readonly filters?: string;
565
+ }
566
+ /**
567
+ * Request parameters for listPartnerHierarchyOperations operation in PartnerHierarchiesApi.
568
+ * @export
569
+ * @interface PartnerHierarchiesApiListPartnerHierarchyOperationsRequest
570
+ */
571
+ export interface PartnerHierarchiesApiListPartnerHierarchyOperationsRequest {
572
+ /**
573
+ * Unique identifier for the object.
574
+ * @type {any}
575
+ * @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
576
+ */
577
+ readonly code: any;
578
+ /**
579
+ * Bearer Token: provided by the login endpoint under the name accessToken.
580
+ * @type {string}
581
+ * @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
582
+ */
583
+ readonly authorization?: string;
584
+ /**
585
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
586
+ * @type {number}
587
+ * @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
588
+ */
589
+ readonly pageSize?: number;
590
+ /**
591
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
592
+ * @type {string}
593
+ * @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
594
+ */
595
+ readonly pageToken?: string;
596
+ /**
597
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
598
+ * @type {string}
599
+ * @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
600
+ */
601
+ readonly filter?: string;
602
+ /**
603
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
604
+ * @type {string}
605
+ * @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
606
+ */
607
+ readonly search?: string;
608
+ /**
609
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, createdAt, updatedAt&lt;/i&gt;
610
+ * @type {string}
611
+ * @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
612
+ */
613
+ readonly order?: string;
614
+ /**
615
+ * 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.&lt;br/&gt; &lt;br/&gt;
616
+ * @type {string}
617
+ * @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
618
+ */
619
+ readonly expand?: string;
620
+ /**
621
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, partnerHierarchyTypeCode, createdAt, updatedAt&lt;/i&gt;
622
+ * @type {string}
623
+ * @memberof PartnerHierarchiesApiListPartnerHierarchyOperations
624
+ */
625
+ readonly filters?: string;
626
+ }
627
+ /**
628
+ * Request parameters for updatePartnerHierarchy operation in PartnerHierarchiesApi.
629
+ * @export
630
+ * @interface PartnerHierarchiesApiUpdatePartnerHierarchyRequest
631
+ */
632
+ export interface PartnerHierarchiesApiUpdatePartnerHierarchyRequest {
633
+ /**
634
+ * Unique identifier for the object.
635
+ * @type {string}
636
+ * @memberof PartnerHierarchiesApiUpdatePartnerHierarchy
637
+ */
638
+ readonly code: string;
639
+ /**
640
+ *
641
+ * @type {UpdatePartnerHierarchyRequestDto}
642
+ * @memberof PartnerHierarchiesApiUpdatePartnerHierarchy
643
+ */
644
+ readonly updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto;
645
+ /**
646
+ * Bearer Token: provided by the login endpoint under the name accessToken.
647
+ * @type {string}
648
+ * @memberof PartnerHierarchiesApiUpdatePartnerHierarchy
649
+ */
650
+ readonly authorization?: string;
651
+ }
652
+ /**
653
+ * Request parameters for updatePartnerHierarchyTree operation in PartnerHierarchiesApi.
654
+ * @export
655
+ * @interface PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest
656
+ */
657
+ export interface PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest {
658
+ /**
659
+ * Unique identifier for the object.
660
+ * @type {string}
661
+ * @memberof PartnerHierarchiesApiUpdatePartnerHierarchyTree
662
+ */
663
+ readonly code: string;
664
+ /**
665
+ *
666
+ * @type {UpdatePartnerHierarchyTreeRequestBodyDto}
667
+ * @memberof PartnerHierarchiesApiUpdatePartnerHierarchyTree
668
+ */
669
+ readonly updatePartnerHierarchyTreeRequestBodyDto: UpdatePartnerHierarchyTreeRequestBodyDto;
670
+ /**
671
+ * Bearer Token: provided by the login endpoint under the name accessToken.
672
+ * @type {string}
673
+ * @memberof PartnerHierarchiesApiUpdatePartnerHierarchyTree
674
+ */
675
+ readonly authorization?: string;
676
+ }
677
+ /**
678
+ * PartnerHierarchiesApi - object-oriented interface
679
+ * @export
680
+ * @class PartnerHierarchiesApi
681
+ * @extends {BaseAPI}
682
+ */
683
+ export declare class PartnerHierarchiesApi extends BaseAPI {
684
+ /**
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\"
686
+ * @summary Create a partner hierarchy
687
+ * @param {PartnerHierarchiesApiCreatePartnerHierarchyRequest} requestParameters Request parameters.
688
+ * @param {*} [options] Override http request option.
689
+ * @throws {RequiredError}
690
+ * @memberof PartnerHierarchiesApi
691
+ */
692
+ createPartnerHierarchy(requestParameters: PartnerHierarchiesApiCreatePartnerHierarchyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerHierarchyResponseClass, any, {}>>;
693
+ /**
694
+ * Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted. **Required Permissions** \"partner-management.partners.delete\"
695
+ * @summary Delete a partner hierarchy
696
+ * @param {PartnerHierarchiesApiDeletePartnerHierarchyRequest} requestParameters Request parameters.
697
+ * @param {*} [options] Override http request option.
698
+ * @throws {RequiredError}
699
+ * @memberof PartnerHierarchiesApi
700
+ */
701
+ deletePartnerHierarchy(requestParameters: PartnerHierarchiesApiDeletePartnerHierarchyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteByCodeResponseClass, any, {}>>;
702
+ /**
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
705
+ * @param {PartnerHierarchiesApiGenerateUploadUrlRequest} requestParameters Request parameters.
706
+ * @param {*} [options] Override http request option.
707
+ * @throws {RequiredError}
708
+ * @memberof PartnerHierarchiesApi
709
+ */
710
+ generateUploadUrl(requestParameters: PartnerHierarchiesApiGenerateUploadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateUploadUrlResponseClass, any, {}>>;
711
+ /**
712
+ * Returns the details of one partner hierarchy, including its name and hierarchy type. **Required Permissions** \"partner-management.partners.view\"
713
+ * @summary Get a partner hierarchy
714
+ * @param {PartnerHierarchiesApiGetPartnerHierarchyRequest} requestParameters Request parameters.
715
+ * @param {*} [options] Override http request option.
716
+ * @throws {RequiredError}
717
+ * @memberof PartnerHierarchiesApi
718
+ */
719
+ getPartnerHierarchy(requestParameters: PartnerHierarchiesApiGetPartnerHierarchyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerHierarchyResponseClass, any, {}>>;
720
+ /**
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\"
722
+ * @summary Get part of a partner hierarchy tree
723
+ * @param {PartnerHierarchiesApiGetPartnerHierarchyTreeRequest} requestParameters Request parameters.
724
+ * @param {*} [options] Override http request option.
725
+ * @throws {RequiredError}
726
+ * @memberof PartnerHierarchiesApi
727
+ */
728
+ getPartnerHierarchyTree(requestParameters: PartnerHierarchiesApiGetPartnerHierarchyTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerHierarchyTreeResponseClass, any, {}>>;
729
+ /**
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
732
+ * @param {PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest} requestParameters Request parameters.
733
+ * @param {*} [options] Override http request option.
734
+ * @throws {RequiredError}
735
+ * @memberof PartnerHierarchiesApi
736
+ */
737
+ getPartnerHierarchyTreeFile(requestParameters: PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerHierarchyTreeFileResponseClass, any, {}>>;
738
+ /**
739
+ * Returns a paginated list of partner hierarchies. **Required Permissions** \"partner-management.partners.view\"
740
+ * @summary List partner hierarchies
741
+ * @param {PartnerHierarchiesApiListPartnerHierarchiesRequest} requestParameters Request parameters.
742
+ * @param {*} [options] Override http request option.
743
+ * @throws {RequiredError}
744
+ * @memberof PartnerHierarchiesApi
745
+ */
746
+ listPartnerHierarchies(requestParameters?: PartnerHierarchiesApiListPartnerHierarchiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerHierarchiesResponseClass, any, {}>>;
747
+ /**
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
750
+ * @param {PartnerHierarchiesApiListPartnerHierarchyOperationsRequest} requestParameters Request parameters.
751
+ * @param {*} [options] Override http request option.
752
+ * @throws {RequiredError}
753
+ * @memberof PartnerHierarchiesApi
754
+ */
755
+ listPartnerHierarchyOperations(requestParameters: PartnerHierarchiesApiListPartnerHierarchyOperationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerHierarchyOperationsResponseClass, any, {}>>;
756
+ /**
757
+ * Updates the partner hierarchy details without changing any nodes in the tree. **Required Permissions** \"partner-management.partners.update\"
758
+ * @summary Update a partner hierarchy
759
+ * @param {PartnerHierarchiesApiUpdatePartnerHierarchyRequest} requestParameters Request parameters.
760
+ * @param {*} [options] Override http request option.
761
+ * @throws {RequiredError}
762
+ * @memberof PartnerHierarchiesApi
763
+ */
764
+ updatePartnerHierarchy(requestParameters: PartnerHierarchiesApiUpdatePartnerHierarchyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePartnerHierarchyResponseClass, any, {}>>;
765
+ /**
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
768
+ * @param {PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest} requestParameters Request parameters.
769
+ * @param {*} [options] Override http request option.
770
+ * @throws {RequiredError}
771
+ * @memberof PartnerHierarchiesApi
772
+ */
773
+ updatePartnerHierarchyTree(requestParameters: PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerHierarchyAsyncOperationResponseClass, any, {}>>;
774
+ }