@emilgroup/partner-sdk 1.22.1-beta.14 → 1.22.1-beta.15

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 (64) hide show
  1. package/.openapi-generator/FILES +10 -1
  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/{default-api.ts → health-api.ts} +13 -13
  6. package/api/partner-hierarchy-types-api.ts +679 -0
  7. package/api.ts +4 -2
  8. package/base.ts +1 -0
  9. package/dist/api/blacklist-api.d.ts +4 -4
  10. package/dist/api/blacklist-reasons-api.d.ts +4 -4
  11. package/dist/api/{default-api.d.ts → health-api.d.ts} +10 -10
  12. package/dist/api/{default-api.js → health-api.js} +22 -22
  13. package/dist/api/partner-hierarchy-types-api.d.ts +385 -0
  14. package/dist/api/partner-hierarchy-types-api.js +636 -0
  15. package/dist/api.d.ts +2 -1
  16. package/dist/api.js +2 -1
  17. package/dist/base.d.ts +2 -1
  18. package/dist/base.js +1 -0
  19. package/dist/models/create-partner-hierarchy-type-request-dto.d.ts +30 -0
  20. package/dist/models/create-partner-hierarchy-type-request-dto.js +15 -0
  21. package/dist/models/create-partner-hierarchy-type-response-class.d.ts +25 -0
  22. package/dist/models/create-partner-hierarchy-type-response-class.js +15 -0
  23. package/dist/models/delete-by-code-response-class.d.ts +24 -0
  24. package/dist/models/delete-by-code-response-class.js +15 -0
  25. package/dist/models/get-partner-hierarchy-type-response-class.d.ts +25 -0
  26. package/dist/models/get-partner-hierarchy-type-response-class.js +15 -0
  27. package/dist/models/index.d.ts +8 -0
  28. package/dist/models/index.js +8 -0
  29. package/dist/models/list-blacklist-items-response-class.d.ts +12 -0
  30. package/dist/models/list-partner-hierarchy-types-response-class.d.ts +43 -0
  31. package/dist/models/list-partner-hierarchy-types-response-class.js +15 -0
  32. package/dist/models/list-partner-relation-class.d.ts +18 -6
  33. package/dist/models/list-partner-relation-types-class.d.ts +18 -6
  34. package/dist/models/list-partner-types-response-class.d.ts +18 -6
  35. package/dist/models/list-partner-versions-response-class.d.ts +18 -6
  36. package/dist/models/list-partners-response-class.d.ts +18 -6
  37. package/dist/models/list-related-partners-response-class.d.ts +18 -6
  38. package/dist/models/list-tags-response-class.d.ts +18 -6
  39. package/dist/models/partner-hierarchy-type-class.d.ts +66 -0
  40. package/dist/models/partner-hierarchy-type-class.js +15 -0
  41. package/dist/models/update-blacklist-reason-status-request-dto.d.ts +1 -1
  42. package/dist/models/update-partner-hierarchy-type-request-dto.d.ts +30 -0
  43. package/dist/models/update-partner-hierarchy-type-request-dto.js +15 -0
  44. package/dist/models/update-partner-hierarchy-type-response-class.d.ts +25 -0
  45. package/dist/models/update-partner-hierarchy-type-response-class.js +15 -0
  46. package/models/create-partner-hierarchy-type-request-dto.ts +36 -0
  47. package/models/create-partner-hierarchy-type-response-class.ts +31 -0
  48. package/models/delete-by-code-response-class.ts +30 -0
  49. package/models/get-partner-hierarchy-type-response-class.ts +31 -0
  50. package/models/index.ts +8 -0
  51. package/models/list-blacklist-items-response-class.ts +12 -0
  52. package/models/list-partner-hierarchy-types-response-class.ts +49 -0
  53. package/models/list-partner-relation-class.ts +18 -6
  54. package/models/list-partner-relation-types-class.ts +18 -6
  55. package/models/list-partner-types-response-class.ts +18 -6
  56. package/models/list-partner-versions-response-class.ts +18 -6
  57. package/models/list-partners-response-class.ts +18 -6
  58. package/models/list-related-partners-response-class.ts +18 -6
  59. package/models/list-tags-response-class.ts +18 -6
  60. package/models/partner-hierarchy-type-class.ts +72 -0
  61. package/models/update-blacklist-reason-status-request-dto.ts +1 -1
  62. package/models/update-partner-hierarchy-type-request-dto.ts +36 -0
  63. package/models/update-partner-hierarchy-type-response-class.ts +31 -0
  64. package/package.json +1 -1
@@ -0,0 +1,385 @@
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 { CreatePartnerHierarchyTypeRequestDto } from '../models';
16
+ import { CreatePartnerHierarchyTypeResponseClass } from '../models';
17
+ import { DeleteByCodeResponseClass } from '../models';
18
+ import { GetPartnerHierarchyTypeResponseClass } from '../models';
19
+ import { ListPartnerHierarchyTypesResponseClass } from '../models';
20
+ import { UpdatePartnerHierarchyTypeRequestDto } from '../models';
21
+ import { UpdatePartnerHierarchyTypeResponseClass } from '../models';
22
+ /**
23
+ * PartnerHierarchyTypesApi - axios parameter creator
24
+ * @export
25
+ */
26
+ export declare const PartnerHierarchyTypesApiAxiosParamCreator: (configuration?: Configuration) => {
27
+ /**
28
+ * Creates a new partner hierarchy type. The schema defines the level structure and valid role codes for all hierarchies of this type. **Required Permissions** \"partner-management.partners.create\"
29
+ * @summary Create the partner hierarchy type
30
+ * @param {CreatePartnerHierarchyTypeRequestDto} createPartnerHierarchyTypeRequestDto
31
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
32
+ * @param {*} [options] Override http request option.
33
+ * @throws {RequiredError}
34
+ */
35
+ createPartnerHierarchyType: (createPartnerHierarchyTypeRequestDto: CreatePartnerHierarchyTypeRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
+ /**
37
+ * Soft-deletes a partner hierarchy type. Blocked if any partner hierarchy instances reference this type. **Required Permissions** \"partner-management.partners.delete\"
38
+ * @summary Delete the partner hierarchy type
39
+ * @param {string} code Unique identifier for the object.
40
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ deletePartnerHierarchyType: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45
+ /**
46
+ * Returns a partner hierarchy type by its code, including the full schema. **Required Permissions** \"partner-management.partners.view\"
47
+ * @summary Retrieve the partner hierarchy type
48
+ * @param {string} code Unique identifier for the object.
49
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
50
+ * @param {*} [options] Override http request option.
51
+ * @throws {RequiredError}
52
+ */
53
+ getPartnerHierarchyType: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54
+ /**
55
+ * Returns a paginated list of partner hierarchy types. **Required Permissions** \"partner-management.partners.view\"
56
+ * @summary List partner-hierarchy-types
57
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
58
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
59
+ * @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.
60
+ * @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, createdAt, updatedAt&lt;/i&gt;
61
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
62
+ * @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;
63
+ * @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;
64
+ * @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, createdAt, updatedAt&lt;/i&gt;
65
+ * @param {*} [options] Override http request option.
66
+ * @throws {RequiredError}
67
+ */
68
+ listPartnerHierarchyTypes: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
+ /**
70
+ * Updates name or schema of a partner hierarchy type. Removing a depth level is blocked if any partner hierarchy nodes exist at that depth. Removing a role code is blocked if any partner hierarchy nodes use that role. **Required Permissions** \"partner-management.partners.update\"
71
+ * @summary Update the partner hierarchy type
72
+ * @param {string} code Unique identifier for the object.
73
+ * @param {UpdatePartnerHierarchyTypeRequestDto} updatePartnerHierarchyTypeRequestDto
74
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
75
+ * @param {*} [options] Override http request option.
76
+ * @throws {RequiredError}
77
+ */
78
+ updatePartnerHierarchyType: (code: string, updatePartnerHierarchyTypeRequestDto: UpdatePartnerHierarchyTypeRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
79
+ };
80
+ /**
81
+ * PartnerHierarchyTypesApi - functional programming interface
82
+ * @export
83
+ */
84
+ export declare const PartnerHierarchyTypesApiFp: (configuration?: Configuration) => {
85
+ /**
86
+ * Creates a new partner hierarchy type. The schema defines the level structure and valid role codes for all hierarchies of this type. **Required Permissions** \"partner-management.partners.create\"
87
+ * @summary Create the partner hierarchy type
88
+ * @param {CreatePartnerHierarchyTypeRequestDto} createPartnerHierarchyTypeRequestDto
89
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
90
+ * @param {*} [options] Override http request option.
91
+ * @throws {RequiredError}
92
+ */
93
+ createPartnerHierarchyType(createPartnerHierarchyTypeRequestDto: CreatePartnerHierarchyTypeRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerHierarchyTypeResponseClass>>;
94
+ /**
95
+ * Soft-deletes a partner hierarchy type. Blocked if any partner hierarchy instances reference this type. **Required Permissions** \"partner-management.partners.delete\"
96
+ * @summary Delete the partner hierarchy type
97
+ * @param {string} code Unique identifier for the object.
98
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ deletePartnerHierarchyType(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>>;
103
+ /**
104
+ * Returns a partner hierarchy type by its code, including the full schema. **Required Permissions** \"partner-management.partners.view\"
105
+ * @summary Retrieve the partner hierarchy type
106
+ * @param {string} code Unique identifier for the object.
107
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
108
+ * @param {*} [options] Override http request option.
109
+ * @throws {RequiredError}
110
+ */
111
+ getPartnerHierarchyType(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyTypeResponseClass>>;
112
+ /**
113
+ * Returns a paginated list of partner hierarchy types. **Required Permissions** \"partner-management.partners.view\"
114
+ * @summary List partner-hierarchy-types
115
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
116
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
117
+ * @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.
118
+ * @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, createdAt, updatedAt&lt;/i&gt;
119
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
120
+ * @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;
121
+ * @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;
122
+ * @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, createdAt, updatedAt&lt;/i&gt;
123
+ * @param {*} [options] Override http request option.
124
+ * @throws {RequiredError}
125
+ */
126
+ listPartnerHierarchyTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerHierarchyTypesResponseClass>>;
127
+ /**
128
+ * Updates name or schema of a partner hierarchy type. Removing a depth level is blocked if any partner hierarchy nodes exist at that depth. Removing a role code is blocked if any partner hierarchy nodes use that role. **Required Permissions** \"partner-management.partners.update\"
129
+ * @summary Update the partner hierarchy type
130
+ * @param {string} code Unique identifier for the object.
131
+ * @param {UpdatePartnerHierarchyTypeRequestDto} updatePartnerHierarchyTypeRequestDto
132
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
133
+ * @param {*} [options] Override http request option.
134
+ * @throws {RequiredError}
135
+ */
136
+ updatePartnerHierarchyType(code: string, updatePartnerHierarchyTypeRequestDto: UpdatePartnerHierarchyTypeRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePartnerHierarchyTypeResponseClass>>;
137
+ };
138
+ /**
139
+ * PartnerHierarchyTypesApi - factory interface
140
+ * @export
141
+ */
142
+ export declare const PartnerHierarchyTypesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
143
+ /**
144
+ * Creates a new partner hierarchy type. The schema defines the level structure and valid role codes for all hierarchies of this type. **Required Permissions** \"partner-management.partners.create\"
145
+ * @summary Create the partner hierarchy type
146
+ * @param {CreatePartnerHierarchyTypeRequestDto} createPartnerHierarchyTypeRequestDto
147
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
148
+ * @param {*} [options] Override http request option.
149
+ * @throws {RequiredError}
150
+ */
151
+ createPartnerHierarchyType(createPartnerHierarchyTypeRequestDto: CreatePartnerHierarchyTypeRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePartnerHierarchyTypeResponseClass>;
152
+ /**
153
+ * Soft-deletes a partner hierarchy type. Blocked if any partner hierarchy instances reference this type. **Required Permissions** \"partner-management.partners.delete\"
154
+ * @summary Delete the partner hierarchy type
155
+ * @param {string} code Unique identifier for the object.
156
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
157
+ * @param {*} [options] Override http request option.
158
+ * @throws {RequiredError}
159
+ */
160
+ deletePartnerHierarchyType(code: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass>;
161
+ /**
162
+ * Returns a partner hierarchy type by its code, including the full schema. **Required Permissions** \"partner-management.partners.view\"
163
+ * @summary Retrieve the partner hierarchy type
164
+ * @param {string} code Unique identifier for the object.
165
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
166
+ * @param {*} [options] Override http request option.
167
+ * @throws {RequiredError}
168
+ */
169
+ getPartnerHierarchyType(code: string, authorization?: string, options?: any): AxiosPromise<GetPartnerHierarchyTypeResponseClass>;
170
+ /**
171
+ * Returns a paginated list of partner hierarchy types. **Required Permissions** \"partner-management.partners.view\"
172
+ * @summary List partner-hierarchy-types
173
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
174
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
175
+ * @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.
176
+ * @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, createdAt, updatedAt&lt;/i&gt;
177
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
178
+ * @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;
179
+ * @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;
180
+ * @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, createdAt, updatedAt&lt;/i&gt;
181
+ * @param {*} [options] Override http request option.
182
+ * @throws {RequiredError}
183
+ */
184
+ listPartnerHierarchyTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerHierarchyTypesResponseClass>;
185
+ /**
186
+ * Updates name or schema of a partner hierarchy type. Removing a depth level is blocked if any partner hierarchy nodes exist at that depth. Removing a role code is blocked if any partner hierarchy nodes use that role. **Required Permissions** \"partner-management.partners.update\"
187
+ * @summary Update the partner hierarchy type
188
+ * @param {string} code Unique identifier for the object.
189
+ * @param {UpdatePartnerHierarchyTypeRequestDto} updatePartnerHierarchyTypeRequestDto
190
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
191
+ * @param {*} [options] Override http request option.
192
+ * @throws {RequiredError}
193
+ */
194
+ updatePartnerHierarchyType(code: string, updatePartnerHierarchyTypeRequestDto: UpdatePartnerHierarchyTypeRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePartnerHierarchyTypeResponseClass>;
195
+ };
196
+ /**
197
+ * Request parameters for createPartnerHierarchyType operation in PartnerHierarchyTypesApi.
198
+ * @export
199
+ * @interface PartnerHierarchyTypesApiCreatePartnerHierarchyTypeRequest
200
+ */
201
+ export interface PartnerHierarchyTypesApiCreatePartnerHierarchyTypeRequest {
202
+ /**
203
+ *
204
+ * @type {CreatePartnerHierarchyTypeRequestDto}
205
+ * @memberof PartnerHierarchyTypesApiCreatePartnerHierarchyType
206
+ */
207
+ readonly createPartnerHierarchyTypeRequestDto: CreatePartnerHierarchyTypeRequestDto;
208
+ /**
209
+ * Bearer Token: provided by the login endpoint under the name accessToken.
210
+ * @type {string}
211
+ * @memberof PartnerHierarchyTypesApiCreatePartnerHierarchyType
212
+ */
213
+ readonly authorization?: string;
214
+ }
215
+ /**
216
+ * Request parameters for deletePartnerHierarchyType operation in PartnerHierarchyTypesApi.
217
+ * @export
218
+ * @interface PartnerHierarchyTypesApiDeletePartnerHierarchyTypeRequest
219
+ */
220
+ export interface PartnerHierarchyTypesApiDeletePartnerHierarchyTypeRequest {
221
+ /**
222
+ * Unique identifier for the object.
223
+ * @type {string}
224
+ * @memberof PartnerHierarchyTypesApiDeletePartnerHierarchyType
225
+ */
226
+ readonly code: string;
227
+ /**
228
+ * Bearer Token: provided by the login endpoint under the name accessToken.
229
+ * @type {string}
230
+ * @memberof PartnerHierarchyTypesApiDeletePartnerHierarchyType
231
+ */
232
+ readonly authorization?: string;
233
+ }
234
+ /**
235
+ * Request parameters for getPartnerHierarchyType operation in PartnerHierarchyTypesApi.
236
+ * @export
237
+ * @interface PartnerHierarchyTypesApiGetPartnerHierarchyTypeRequest
238
+ */
239
+ export interface PartnerHierarchyTypesApiGetPartnerHierarchyTypeRequest {
240
+ /**
241
+ * Unique identifier for the object.
242
+ * @type {string}
243
+ * @memberof PartnerHierarchyTypesApiGetPartnerHierarchyType
244
+ */
245
+ readonly code: string;
246
+ /**
247
+ * Bearer Token: provided by the login endpoint under the name accessToken.
248
+ * @type {string}
249
+ * @memberof PartnerHierarchyTypesApiGetPartnerHierarchyType
250
+ */
251
+ readonly authorization?: string;
252
+ }
253
+ /**
254
+ * Request parameters for listPartnerHierarchyTypes operation in PartnerHierarchyTypesApi.
255
+ * @export
256
+ * @interface PartnerHierarchyTypesApiListPartnerHierarchyTypesRequest
257
+ */
258
+ export interface PartnerHierarchyTypesApiListPartnerHierarchyTypesRequest {
259
+ /**
260
+ * Bearer Token: provided by the login endpoint under the name accessToken.
261
+ * @type {string}
262
+ * @memberof PartnerHierarchyTypesApiListPartnerHierarchyTypes
263
+ */
264
+ readonly authorization?: string;
265
+ /**
266
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
267
+ * @type {number}
268
+ * @memberof PartnerHierarchyTypesApiListPartnerHierarchyTypes
269
+ */
270
+ readonly pageSize?: number;
271
+ /**
272
+ * 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.
273
+ * @type {string}
274
+ * @memberof PartnerHierarchyTypesApiListPartnerHierarchyTypes
275
+ */
276
+ readonly pageToken?: string;
277
+ /**
278
+ * 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, createdAt, updatedAt&lt;/i&gt;
279
+ * @type {string}
280
+ * @memberof PartnerHierarchyTypesApiListPartnerHierarchyTypes
281
+ */
282
+ readonly filter?: string;
283
+ /**
284
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
285
+ * @type {string}
286
+ * @memberof PartnerHierarchyTypesApiListPartnerHierarchyTypes
287
+ */
288
+ readonly search?: string;
289
+ /**
290
+ * 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;
291
+ * @type {string}
292
+ * @memberof PartnerHierarchyTypesApiListPartnerHierarchyTypes
293
+ */
294
+ readonly order?: string;
295
+ /**
296
+ * 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;
297
+ * @type {string}
298
+ * @memberof PartnerHierarchyTypesApiListPartnerHierarchyTypes
299
+ */
300
+ readonly expand?: string;
301
+ /**
302
+ * 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, createdAt, updatedAt&lt;/i&gt;
303
+ * @type {string}
304
+ * @memberof PartnerHierarchyTypesApiListPartnerHierarchyTypes
305
+ */
306
+ readonly filters?: string;
307
+ }
308
+ /**
309
+ * Request parameters for updatePartnerHierarchyType operation in PartnerHierarchyTypesApi.
310
+ * @export
311
+ * @interface PartnerHierarchyTypesApiUpdatePartnerHierarchyTypeRequest
312
+ */
313
+ export interface PartnerHierarchyTypesApiUpdatePartnerHierarchyTypeRequest {
314
+ /**
315
+ * Unique identifier for the object.
316
+ * @type {string}
317
+ * @memberof PartnerHierarchyTypesApiUpdatePartnerHierarchyType
318
+ */
319
+ readonly code: string;
320
+ /**
321
+ *
322
+ * @type {UpdatePartnerHierarchyTypeRequestDto}
323
+ * @memberof PartnerHierarchyTypesApiUpdatePartnerHierarchyType
324
+ */
325
+ readonly updatePartnerHierarchyTypeRequestDto: UpdatePartnerHierarchyTypeRequestDto;
326
+ /**
327
+ * Bearer Token: provided by the login endpoint under the name accessToken.
328
+ * @type {string}
329
+ * @memberof PartnerHierarchyTypesApiUpdatePartnerHierarchyType
330
+ */
331
+ readonly authorization?: string;
332
+ }
333
+ /**
334
+ * PartnerHierarchyTypesApi - object-oriented interface
335
+ * @export
336
+ * @class PartnerHierarchyTypesApi
337
+ * @extends {BaseAPI}
338
+ */
339
+ export declare class PartnerHierarchyTypesApi extends BaseAPI {
340
+ /**
341
+ * Creates a new partner hierarchy type. The schema defines the level structure and valid role codes for all hierarchies of this type. **Required Permissions** \"partner-management.partners.create\"
342
+ * @summary Create the partner hierarchy type
343
+ * @param {PartnerHierarchyTypesApiCreatePartnerHierarchyTypeRequest} requestParameters Request parameters.
344
+ * @param {*} [options] Override http request option.
345
+ * @throws {RequiredError}
346
+ * @memberof PartnerHierarchyTypesApi
347
+ */
348
+ createPartnerHierarchyType(requestParameters: PartnerHierarchyTypesApiCreatePartnerHierarchyTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerHierarchyTypeResponseClass, any, {}>>;
349
+ /**
350
+ * Soft-deletes a partner hierarchy type. Blocked if any partner hierarchy instances reference this type. **Required Permissions** \"partner-management.partners.delete\"
351
+ * @summary Delete the partner hierarchy type
352
+ * @param {PartnerHierarchyTypesApiDeletePartnerHierarchyTypeRequest} requestParameters Request parameters.
353
+ * @param {*} [options] Override http request option.
354
+ * @throws {RequiredError}
355
+ * @memberof PartnerHierarchyTypesApi
356
+ */
357
+ deletePartnerHierarchyType(requestParameters: PartnerHierarchyTypesApiDeletePartnerHierarchyTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteByCodeResponseClass, any, {}>>;
358
+ /**
359
+ * Returns a partner hierarchy type by its code, including the full schema. **Required Permissions** \"partner-management.partners.view\"
360
+ * @summary Retrieve the partner hierarchy type
361
+ * @param {PartnerHierarchyTypesApiGetPartnerHierarchyTypeRequest} requestParameters Request parameters.
362
+ * @param {*} [options] Override http request option.
363
+ * @throws {RequiredError}
364
+ * @memberof PartnerHierarchyTypesApi
365
+ */
366
+ getPartnerHierarchyType(requestParameters: PartnerHierarchyTypesApiGetPartnerHierarchyTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerHierarchyTypeResponseClass, any, {}>>;
367
+ /**
368
+ * Returns a paginated list of partner hierarchy types. **Required Permissions** \"partner-management.partners.view\"
369
+ * @summary List partner-hierarchy-types
370
+ * @param {PartnerHierarchyTypesApiListPartnerHierarchyTypesRequest} requestParameters Request parameters.
371
+ * @param {*} [options] Override http request option.
372
+ * @throws {RequiredError}
373
+ * @memberof PartnerHierarchyTypesApi
374
+ */
375
+ listPartnerHierarchyTypes(requestParameters?: PartnerHierarchyTypesApiListPartnerHierarchyTypesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerHierarchyTypesResponseClass, any, {}>>;
376
+ /**
377
+ * Updates name or schema of a partner hierarchy type. Removing a depth level is blocked if any partner hierarchy nodes exist at that depth. Removing a role code is blocked if any partner hierarchy nodes use that role. **Required Permissions** \"partner-management.partners.update\"
378
+ * @summary Update the partner hierarchy type
379
+ * @param {PartnerHierarchyTypesApiUpdatePartnerHierarchyTypeRequest} requestParameters Request parameters.
380
+ * @param {*} [options] Override http request option.
381
+ * @throws {RequiredError}
382
+ * @memberof PartnerHierarchyTypesApi
383
+ */
384
+ updatePartnerHierarchyType(requestParameters: PartnerHierarchyTypesApiUpdatePartnerHierarchyTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePartnerHierarchyTypeResponseClass, any, {}>>;
385
+ }