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

package/api/partner-hierarchy-operations-api.ts

@@ -0,0 +1,367 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { GetPartnerHierarchyOperationResponseClass } from '../models';
+// @ts-ignore
+import { ListPartnerHierarchyOperationsResponseClass } from '../models';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * PartnerHierarchyOperationsApi - axios parameter creator
+ * @export
+ */
+export const PartnerHierarchyOperationsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Returns one partner hierarchy background operation by code. Use expand=partnerHierarchy to include the hierarchy.  **Required Permissions**  \"partner-management.partners.view\"
+         * @summary Get a partner hierarchy operation
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [expand] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPartnerHierarchyOperation: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('getPartnerHierarchyOperation', 'code', code)
+            const localVarPath = `/partnerservice/v1/partner-hierarchy-operations/{code}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Returns a paginated list of partner hierarchy background operations. Filter by partnerHierarchyCode, type, or status, and use expand=partnerHierarchy to include the hierarchy.  **Required Permissions**  \"partner-management.partners.view\"
+         * @summary List partner hierarchy operations
+         * @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: code, partnerHierarchyCode, type, status, createdAt&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, type, status, 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: code, partnerHierarchyCode, type, status, createdAt&lt;/i&gt;
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPartnerHierarchyOperations: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/partnerservice/v1/partner-hierarchy-operations`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (filter !== undefined) {
+                localVarQueryParameter['filter'] = filter;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (order !== undefined) {
+                localVarQueryParameter['order'] = order;
+            }
+
+            if (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            if (filters !== undefined) {
+                localVarQueryParameter['filters'] = filters;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * PartnerHierarchyOperationsApi - functional programming interface
+ * @export
+ */
+export const PartnerHierarchyOperationsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = PartnerHierarchyOperationsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Returns one partner hierarchy background operation by code. Use expand=partnerHierarchy to include the hierarchy.  **Required Permissions**  \"partner-management.partners.view\"
+         * @summary Get a partner hierarchy operation
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [expand] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getPartnerHierarchyOperation(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerHierarchyOperationResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPartnerHierarchyOperation(code, authorization, expand, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Returns a paginated list of partner hierarchy background operations. Filter by partnerHierarchyCode, type, or status, and use expand=partnerHierarchy to include the hierarchy.  **Required Permissions**  \"partner-management.partners.view\"
+         * @summary List partner hierarchy operations
+         * @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: code, partnerHierarchyCode, type, status, createdAt&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, type, status, 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: code, partnerHierarchyCode, type, status, createdAt&lt;/i&gt;
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listPartnerHierarchyOperations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerHierarchyOperationsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerHierarchyOperations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * PartnerHierarchyOperationsApi - factory interface
+ * @export
+ */
+export const PartnerHierarchyOperationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = PartnerHierarchyOperationsApiFp(configuration)
+    return {
+        /**
+         * Returns one partner hierarchy background operation by code. Use expand=partnerHierarchy to include the hierarchy.  **Required Permissions**  \"partner-management.partners.view\"
+         * @summary Get a partner hierarchy operation
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [expand] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPartnerHierarchyOperation(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPartnerHierarchyOperationResponseClass> {
+            return localVarFp.getPartnerHierarchyOperation(code, authorization, expand, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns a paginated list of partner hierarchy background operations. Filter by partnerHierarchyCode, type, or status, and use expand=partnerHierarchy to include the hierarchy.  **Required Permissions**  \"partner-management.partners.view\"
+         * @summary List partner hierarchy operations
+         * @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: code, partnerHierarchyCode, type, status, createdAt&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, type, status, 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: code, partnerHierarchyCode, type, status, createdAt&lt;/i&gt;
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPartnerHierarchyOperations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerHierarchyOperationsResponseClass> {
+            return localVarFp.listPartnerHierarchyOperations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for getPartnerHierarchyOperation operation in PartnerHierarchyOperationsApi.
+ * @export
+ * @interface PartnerHierarchyOperationsApiGetPartnerHierarchyOperationRequest
+ */
+export interface PartnerHierarchyOperationsApiGetPartnerHierarchyOperationRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof PartnerHierarchyOperationsApiGetPartnerHierarchyOperation
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerHierarchyOperationsApiGetPartnerHierarchyOperation
+     */
+    readonly authorization?: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof PartnerHierarchyOperationsApiGetPartnerHierarchyOperation
+     */
+    readonly expand?: string
+}
+
+/**
+ * Request parameters for listPartnerHierarchyOperations operation in PartnerHierarchyOperationsApi.
+ * @export
+ * @interface PartnerHierarchyOperationsApiListPartnerHierarchyOperationsRequest
+ */
+export interface PartnerHierarchyOperationsApiListPartnerHierarchyOperationsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerHierarchyOperationsApiListPartnerHierarchyOperations
+     */
+    readonly authorization?: string
+
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof PartnerHierarchyOperationsApiListPartnerHierarchyOperations
+     */
+    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 PartnerHierarchyOperationsApiListPartnerHierarchyOperations
+     */
+    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: code, partnerHierarchyCode, type, status, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerHierarchyOperationsApiListPartnerHierarchyOperations
+     */
+    readonly filter?: string
+
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof PartnerHierarchyOperationsApiListPartnerHierarchyOperations
+     */
+    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, type, status, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerHierarchyOperationsApiListPartnerHierarchyOperations
+     */
+    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 PartnerHierarchyOperationsApiListPartnerHierarchyOperations
+     */
+    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: code, partnerHierarchyCode, type, status, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerHierarchyOperationsApiListPartnerHierarchyOperations
+     */
+    readonly filters?: string
+}
+
+/**
+ * PartnerHierarchyOperationsApi - object-oriented interface
+ * @export
+ * @class PartnerHierarchyOperationsApi
+ * @extends {BaseAPI}
+ */
+export class PartnerHierarchyOperationsApi extends BaseAPI {
+    /**
+     * Returns one partner hierarchy background operation by code. Use expand=partnerHierarchy to include the hierarchy.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary Get a partner hierarchy operation
+     * @param {PartnerHierarchyOperationsApiGetPartnerHierarchyOperationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerHierarchyOperationsApi
+     */
+    public getPartnerHierarchyOperation(requestParameters: PartnerHierarchyOperationsApiGetPartnerHierarchyOperationRequest, options?: AxiosRequestConfig) {
+        return PartnerHierarchyOperationsApiFp(this.configuration).getPartnerHierarchyOperation(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Returns a paginated list of partner hierarchy background operations. Filter by partnerHierarchyCode, type, or status, and use expand=partnerHierarchy to include the hierarchy.  **Required Permissions**  \"partner-management.partners.view\"
+     * @summary List partner hierarchy operations
+     * @param {PartnerHierarchyOperationsApiListPartnerHierarchyOperationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerHierarchyOperationsApi
+     */
+    public listPartnerHierarchyOperations(requestParameters: PartnerHierarchyOperationsApiListPartnerHierarchyOperationsRequest = {}, options?: AxiosRequestConfig) {
+        return PartnerHierarchyOperationsApiFp(this.configuration).listPartnerHierarchyOperations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
+    }
+}