@emilgroup/partner-sdk-node 1.24.0 → 1.24.1-beta.0

package/dist/api/partner-hierarchies-api.d.ts

@@ -0,0 +1,655 @@
+/**
+ * EMIL PartnerService
+ * The EMIL PartnerService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreatePartnerHierarchyRequestDto } from '../models';
+import { CreatePartnerHierarchyResponseClass } from '../models';
+import { DeleteByCodeResponseClass } from '../models';
+import { GenerateUploadUrlResponseClass } from '../models';
+import { GetPartnerHierarchyResponseClass } from '../models';
+import { GetPartnerHierarchyTreeFileResponseClass } from '../models';
+import { GetPartnerHierarchyTreeResponseClass } from '../models';
+import { ListPartnerHierarchiesResponseClass } from '../models';
+import { PartnerHierarchyAsyncOperationResponseClass } from '../models';
+import { UpdatePartnerHierarchyRequestDto } from '../models';
+import { UpdatePartnerHierarchyResponseClass } from '../models';
+import { UpdatePartnerHierarchyTreeRequestBodyDto } from '../models';
+/**
+ * PartnerHierarchiesApi - axios parameter creator
+ * @export
+ */
+export declare const PartnerHierarchiesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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\"
+     * @summary Create a partner hierarchy
+     * @param {CreatePartnerHierarchyRequestDto} createPartnerHierarchyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartnerHierarchy: (createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted.  **Required Permissions**  \"partner-management.partners.delete\"
+     * @summary Delete a partner hierarchy
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePartnerHierarchy: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a pre-signed upload URL for a partner hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation.  **Required Permissions**  \"partner-management.partners.update\"
+     * @summary Generate a pre-signed upload URL for a partner hierarchy tree file
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateUploadUrl: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns the details of one partner hierarchy, including its name and hierarchy type.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary Get a partner hierarchy
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerHierarchy: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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\"
+     * @summary Get part of a partner hierarchy tree
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [nodeCode] Node to start from. Omit this to start from the top of the hierarchy.
+     * @param {number} [pageSize] Maximum number of direct children to return for the selected node. Default is 30 and the maximum is 50.
+     * @param {string} [pageToken] Value returned by the previous response when more children are available.
+     * @param {string} [asOf] Shows the hierarchy as it was at this time. Omit this to show the current hierarchy.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerHierarchyTree: (code: string, authorization?: string, nodeCode?: string, pageSize?: number, pageToken?: string, asOf?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a download URL for the full partner hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary Get a partner hierarchy tree file
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerHierarchyTreeFile: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a paginated list of partner hierarchies.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary List partner hierarchies
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @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.
+     * @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;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @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;
+     * @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;
+     * @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;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerHierarchies: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the partner hierarchy details without changing any nodes in the tree.  **Required Permissions**  \"partner-management.partners.update\"
+     * @summary Update a partner hierarchy
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerHierarchyRequestDto} updatePartnerHierarchyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerHierarchy: (code: string, updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Replaces the current partner hierarchy tree using the contents of an uploaded file.  **Required Permissions**  \"partner-management.partners.update\"
+     * @summary Replace the partner hierarchy tree from an uploaded file
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerHierarchyTreeRequestBodyDto} updatePartnerHierarchyTreeRequestBodyDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerHierarchyTree: (code: string, updatePartnerHierarchyTreeRequestBodyDto: UpdatePartnerHierarchyTreeRequestBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PartnerHierarchiesApi - functional programming interface
+ * @export
+ */
+export declare const PartnerHierarchiesApiFp: (configuration?: Configuration) => {
+    /**
+     * 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\"
+     * @summary Create a partner hierarchy
+     * @param {CreatePartnerHierarchyRequestDto} createPartnerHierarchyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartnerHierarchy(createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerHierarchyResponseClass>>;
+    /**
+     * Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted.  **Required Permissions**  \"partner-management.partners.delete\"
+     * @summary Delete a partner hierarchy
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePartnerHierarchy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>>;
+    /**
+     * Returns a pre-signed upload URL for a partner hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation.  **Required Permissions**  \"partner-management.partners.update\"
+     * @summary Generate a pre-signed upload URL for a partner hierarchy tree file
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateUploadUrl(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateUploadUrlResponseClass>>;
+    /**
+     * Returns the details of one partner hierarchy, including its name and hierarchy type.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary Get a partner hierarchy
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerHierarchy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyResponseClass>>;
+    /**
+     * 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\"
+     * @summary Get part of a partner hierarchy tree
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [nodeCode] Node to start from. Omit this to start from the top of the hierarchy.
+     * @param {number} [pageSize] Maximum number of direct children to return for the selected node. Default is 30 and the maximum is 50.
+     * @param {string} [pageToken] Value returned by the previous response when more children are available.
+     * @param {string} [asOf] Shows the hierarchy as it was at this time. Omit this to show the current hierarchy.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerHierarchyTree(code: string, authorization?: string, nodeCode?: string, pageSize?: number, pageToken?: string, asOf?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyTreeResponseClass>>;
+    /**
+     * Returns a download URL for the full partner hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary Get a partner hierarchy tree file
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerHierarchyTreeFile(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyTreeFileResponseClass>>;
+    /**
+     * Returns a paginated list of partner hierarchies.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary List partner hierarchies
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @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.
+     * @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;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @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;
+     * @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;
+     * @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;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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>>;
+    /**
+     * Updates the partner hierarchy details without changing any nodes in the tree.  **Required Permissions**  \"partner-management.partners.update\"
+     * @summary Update a partner hierarchy
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerHierarchyRequestDto} updatePartnerHierarchyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerHierarchy(code: string, updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePartnerHierarchyResponseClass>>;
+    /**
+     * Replaces the current partner hierarchy tree using the contents of an uploaded file.  **Required Permissions**  \"partner-management.partners.update\"
+     * @summary Replace the partner hierarchy tree from an uploaded file
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerHierarchyTreeRequestBodyDto} updatePartnerHierarchyTreeRequestBodyDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerHierarchyTree(code: string, updatePartnerHierarchyTreeRequestBodyDto: UpdatePartnerHierarchyTreeRequestBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerHierarchyAsyncOperationResponseClass>>;
+};
+/**
+ * PartnerHierarchiesApi - factory interface
+ * @export
+ */
+export declare const PartnerHierarchiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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\"
+     * @summary Create a partner hierarchy
+     * @param {CreatePartnerHierarchyRequestDto} createPartnerHierarchyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartnerHierarchy(createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePartnerHierarchyResponseClass>;
+    /**
+     * Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted.  **Required Permissions**  \"partner-management.partners.delete\"
+     * @summary Delete a partner hierarchy
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePartnerHierarchy(code: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass>;
+    /**
+     * Returns a pre-signed upload URL for a partner hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation.  **Required Permissions**  \"partner-management.partners.update\"
+     * @summary Generate a pre-signed upload URL for a partner hierarchy tree file
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateUploadUrl(code: string, authorization?: string, options?: any): AxiosPromise<GenerateUploadUrlResponseClass>;
+    /**
+     * Returns the details of one partner hierarchy, including its name and hierarchy type.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary Get a partner hierarchy
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerHierarchy(code: string, authorization?: string, options?: any): AxiosPromise<GetPartnerHierarchyResponseClass>;
+    /**
+     * 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\"
+     * @summary Get part of a partner hierarchy tree
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [nodeCode] Node to start from. Omit this to start from the top of the hierarchy.
+     * @param {number} [pageSize] Maximum number of direct children to return for the selected node. Default is 30 and the maximum is 50.
+     * @param {string} [pageToken] Value returned by the previous response when more children are available.
+     * @param {string} [asOf] Shows the hierarchy as it was at this time. Omit this to show the current hierarchy.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerHierarchyTree(code: string, authorization?: string, nodeCode?: string, pageSize?: number, pageToken?: string, asOf?: string, options?: any): AxiosPromise<GetPartnerHierarchyTreeResponseClass>;
+    /**
+     * Returns a download URL for the full partner hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary Get a partner hierarchy tree file
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerHierarchyTreeFile(code: string, authorization?: string, options?: any): AxiosPromise<GetPartnerHierarchyTreeFileResponseClass>;
+    /**
+     * Returns a paginated list of partner hierarchies.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary List partner hierarchies
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @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.
+     * @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;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @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;
+     * @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;
+     * @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;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerHierarchies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerHierarchiesResponseClass>;
+    /**
+     * Updates the partner hierarchy details without changing any nodes in the tree.  **Required Permissions**  \"partner-management.partners.update\"
+     * @summary Update a partner hierarchy
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerHierarchyRequestDto} updatePartnerHierarchyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerHierarchy(code: string, updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePartnerHierarchyResponseClass>;
+    /**
+     * Replaces the current partner hierarchy tree using the contents of an uploaded file.  **Required Permissions**  \"partner-management.partners.update\"
+     * @summary Replace the partner hierarchy tree from an uploaded file
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerHierarchyTreeRequestBodyDto} updatePartnerHierarchyTreeRequestBodyDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerHierarchyTree(code: string, updatePartnerHierarchyTreeRequestBodyDto: UpdatePartnerHierarchyTreeRequestBodyDto, authorization?: string, options?: any): AxiosPromise<PartnerHierarchyAsyncOperationResponseClass>;
+};
+/**
+ * Request parameters for createPartnerHierarchy operation in PartnerHierarchiesApi.
+ * @export
+ * @interface PartnerHierarchiesApiCreatePartnerHierarchyRequest
+ */
+export interface PartnerHierarchiesApiCreatePartnerHierarchyRequest {
+    /**
+     *
+     * @type {CreatePartnerHierarchyRequestDto}
+     * @memberof PartnerHierarchiesApiCreatePartnerHierarchy
+     */
+    readonly createPartnerHierarchyRequestDto: CreatePartnerHierarchyRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiCreatePartnerHierarchy
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deletePartnerHierarchy operation in PartnerHierarchiesApi.
+ * @export
+ * @interface PartnerHierarchiesApiDeletePartnerHierarchyRequest
+ */
+export interface PartnerHierarchiesApiDeletePartnerHierarchyRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiDeletePartnerHierarchy
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiDeletePartnerHierarchy
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for generateUploadUrl operation in PartnerHierarchiesApi.
+ * @export
+ * @interface PartnerHierarchiesApiGenerateUploadUrlRequest
+ */
+export interface PartnerHierarchiesApiGenerateUploadUrlRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiGenerateUploadUrl
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiGenerateUploadUrl
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPartnerHierarchy operation in PartnerHierarchiesApi.
+ * @export
+ * @interface PartnerHierarchiesApiGetPartnerHierarchyRequest
+ */
+export interface PartnerHierarchiesApiGetPartnerHierarchyRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiGetPartnerHierarchy
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiGetPartnerHierarchy
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPartnerHierarchyTree operation in PartnerHierarchiesApi.
+ * @export
+ * @interface PartnerHierarchiesApiGetPartnerHierarchyTreeRequest
+ */
+export interface PartnerHierarchiesApiGetPartnerHierarchyTreeRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
+     */
+    readonly authorization?: string;
+    /**
+     * Node to start from. Omit this to start from the top of the hierarchy.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
+     */
+    readonly nodeCode?: string;
+    /**
+     * Maximum number of direct children to return for the selected node. Default is 30 and the maximum is 50.
+     * @type {number}
+     * @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
+     */
+    readonly pageSize?: number;
+    /**
+     * Value returned by the previous response when more children are available.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
+     */
+    readonly pageToken?: string;
+    /**
+     * Shows the hierarchy as it was at this time. Omit this to show the current hierarchy.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiGetPartnerHierarchyTree
+     */
+    readonly asOf?: string;
+}
+/**
+ * Request parameters for getPartnerHierarchyTreeFile operation in PartnerHierarchiesApi.
+ * @export
+ * @interface PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest
+ */
+export interface PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiGetPartnerHierarchyTreeFile
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiGetPartnerHierarchyTreeFile
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listPartnerHierarchies operation in PartnerHierarchiesApi.
+ * @export
+ * @interface PartnerHierarchiesApiListPartnerHierarchiesRequest
+ */
+export interface PartnerHierarchiesApiListPartnerHierarchiesRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiListPartnerHierarchies
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof PartnerHierarchiesApiListPartnerHierarchies
+     */
+    readonly pageSize?: number;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiListPartnerHierarchies
+     */
+    readonly pageToken?: string;
+    /**
+     * 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;
+     * @type {string}
+     * @memberof PartnerHierarchiesApiListPartnerHierarchies
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiListPartnerHierarchies
+     */
+    readonly search?: string;
+    /**
+     * 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;
+     * @type {string}
+     * @memberof PartnerHierarchiesApiListPartnerHierarchies
+     */
+    readonly order?: string;
+    /**
+     * 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;
+     * @type {string}
+     * @memberof PartnerHierarchiesApiListPartnerHierarchies
+     */
+    readonly expand?: string;
+    /**
+     * 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;
+     * @type {string}
+     * @memberof PartnerHierarchiesApiListPartnerHierarchies
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for updatePartnerHierarchy operation in PartnerHierarchiesApi.
+ * @export
+ * @interface PartnerHierarchiesApiUpdatePartnerHierarchyRequest
+ */
+export interface PartnerHierarchiesApiUpdatePartnerHierarchyRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiUpdatePartnerHierarchy
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdatePartnerHierarchyRequestDto}
+     * @memberof PartnerHierarchiesApiUpdatePartnerHierarchy
+     */
+    readonly updatePartnerHierarchyRequestDto: UpdatePartnerHierarchyRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiUpdatePartnerHierarchy
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for updatePartnerHierarchyTree operation in PartnerHierarchiesApi.
+ * @export
+ * @interface PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest
+ */
+export interface PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiUpdatePartnerHierarchyTree
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdatePartnerHierarchyTreeRequestBodyDto}
+     * @memberof PartnerHierarchiesApiUpdatePartnerHierarchyTree
+     */
+    readonly updatePartnerHierarchyTreeRequestBodyDto: UpdatePartnerHierarchyTreeRequestBodyDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerHierarchiesApiUpdatePartnerHierarchyTree
+     */
+    readonly authorization?: string;
+}
+/**
+ * PartnerHierarchiesApi - object-oriented interface
+ * @export
+ * @class PartnerHierarchiesApi
+ * @extends {BaseAPI}
+ */
+export declare class PartnerHierarchiesApi extends BaseAPI {
+    /**
+     * 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\"
+     * @summary Create a partner hierarchy
+     * @param {PartnerHierarchiesApiCreatePartnerHierarchyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerHierarchiesApi
+     */
+    createPartnerHierarchy(requestParameters: PartnerHierarchiesApiCreatePartnerHierarchyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerHierarchyResponseClass, any, {}>>;
+    /**
+     * Deletes a partner hierarchy. The hierarchy must have no nodes before it can be deleted.  **Required Permissions**  \"partner-management.partners.delete\"
+     * @summary Delete a partner hierarchy
+     * @param {PartnerHierarchiesApiDeletePartnerHierarchyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerHierarchiesApi
+     */
+    deletePartnerHierarchy(requestParameters: PartnerHierarchiesApiDeletePartnerHierarchyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteByCodeResponseClass, any, {}>>;
+    /**
+     * Returns a pre-signed upload URL for a partner hierarchy tree file. Use the uploaded file key for tree replacement or batch node creation.  **Required Permissions**  \"partner-management.partners.update\"
+     * @summary Generate a pre-signed upload URL for a partner hierarchy tree file
+     * @param {PartnerHierarchiesApiGenerateUploadUrlRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerHierarchiesApi
+     */
+    generateUploadUrl(requestParameters: PartnerHierarchiesApiGenerateUploadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateUploadUrlResponseClass, any, {}>>;
+    /**
+     * Returns the details of one partner hierarchy, including its name and hierarchy type.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary Get a partner hierarchy
+     * @param {PartnerHierarchiesApiGetPartnerHierarchyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerHierarchiesApi
+     */
+    getPartnerHierarchy(requestParameters: PartnerHierarchiesApiGetPartnerHierarchyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerHierarchyResponseClass, any, {}>>;
+    /**
+     * 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\"
+     * @summary Get part of a partner hierarchy tree
+     * @param {PartnerHierarchiesApiGetPartnerHierarchyTreeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerHierarchiesApi
+     */
+    getPartnerHierarchyTree(requestParameters: PartnerHierarchiesApiGetPartnerHierarchyTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerHierarchyTreeResponseClass, any, {}>>;
+    /**
+     * Returns a download URL for the full partner hierarchy tree file. If the file is not ready, it starts a tree file build operation; check the operation status and call this endpoint again when it is done.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary Get a partner hierarchy tree file
+     * @param {PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerHierarchiesApi
+     */
+    getPartnerHierarchyTreeFile(requestParameters: PartnerHierarchiesApiGetPartnerHierarchyTreeFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerHierarchyTreeFileResponseClass, any, {}>>;
+    /**
+     * Returns a paginated list of partner hierarchies.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary List partner hierarchies
+     * @param {PartnerHierarchiesApiListPartnerHierarchiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerHierarchiesApi
+     */
+    listPartnerHierarchies(requestParameters?: PartnerHierarchiesApiListPartnerHierarchiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerHierarchiesResponseClass, any, {}>>;
+    /**
+     * Updates the partner hierarchy details without changing any nodes in the tree.  **Required Permissions**  \"partner-management.partners.update\"
+     * @summary Update a partner hierarchy
+     * @param {PartnerHierarchiesApiUpdatePartnerHierarchyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerHierarchiesApi
+     */
+    updatePartnerHierarchy(requestParameters: PartnerHierarchiesApiUpdatePartnerHierarchyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePartnerHierarchyResponseClass, any, {}>>;
+    /**
+     * Replaces the current partner hierarchy tree using the contents of an uploaded file.  **Required Permissions**  \"partner-management.partners.update\"
+     * @summary Replace the partner hierarchy tree from an uploaded file
+     * @param {PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerHierarchiesApi
+     */
+    updatePartnerHierarchyTree(requestParameters: PartnerHierarchiesApiUpdatePartnerHierarchyTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerHierarchyAsyncOperationResponseClass, any, {}>>;
+}