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

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