@emilgroup/partner-sdk-node 1.0.0

package/api/partner-version-api.ts

@@ -0,0 +1,375 @@
+/* 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 { GetPartnerVersionResponseClass } from '../models';
+// @ts-ignore
+import { ListPartnerVersionsResponseClass } from '../models';
+/**
+ * PartnerVersionApi - axios parameter creator
+ * @export
+ */
+export const PartnerVersionApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Retrieve a partner version by providing partner code and version number
+         * @summary Retrieve the partner version
+         * @param {string} code Unique identifier for the object.
+         * @param {number} version 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPartnerVersion: async (code: string, version: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('getPartnerVersion', 'code', code)
+            // verify required parameter 'version' is not null or undefined
+            assertParamExists('getPartnerVersion', 'version', version)
+            const localVarPath = `/partnerservice/v1/partners/{code}/versions/{version}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)))
+                .replace(`{${"version"}}`, encodeURIComponent(String(version)));
+            // 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 (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,
+            };
+        },
+        /**
+         * List all partner versions by providing partner code
+         * @summary List partner versions
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @param {any} [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 {any} [filter] Filter the response by one or multiple fields&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: code, version, displayName, updatedAt, updatedBy&lt;/i&gt;
+         * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+         * @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.&lt;br/&gt;     &lt;br/&gt;     &lt;i&gt;Allowed values: displayName, createdAt, updatedAt, version&lt;/i&gt;
+         * @param {'partnerType'} [expand] Allowed expands for the partner version
+         * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPartnerVersion: async (code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'partnerType', filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('listPartnerVersion', 'code', code)
+            const localVarPath = `/partnerservice/v1/partners/{code}/versions`
+                .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 (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,
+            };
+        },
+    }
+};
+
+/**
+ * PartnerVersionApi - functional programming interface
+ * @export
+ */
+export const PartnerVersionApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = PartnerVersionApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Retrieve a partner version by providing partner code and version number
+         * @summary Retrieve the partner version
+         * @param {string} code Unique identifier for the object.
+         * @param {number} version 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getPartnerVersion(code: string, version: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerVersionResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPartnerVersion(code, version, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * List all partner versions by providing partner code
+         * @summary List partner versions
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @param {any} [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 {any} [filter] Filter the response by one or multiple fields&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: code, version, displayName, updatedAt, updatedBy&lt;/i&gt;
+         * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+         * @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.&lt;br/&gt;     &lt;br/&gt;     &lt;i&gt;Allowed values: displayName, createdAt, updatedAt, version&lt;/i&gt;
+         * @param {'partnerType'} [expand] Allowed expands for the partner version
+         * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listPartnerVersion(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'partnerType', filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerVersionsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerVersion(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * PartnerVersionApi - factory interface
+ * @export
+ */
+export const PartnerVersionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = PartnerVersionApiFp(configuration)
+    return {
+        /**
+         * Retrieve a partner version by providing partner code and version number
+         * @summary Retrieve the partner version
+         * @param {string} code Unique identifier for the object.
+         * @param {number} version 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPartnerVersion(code: string, version: number, authorization?: string, options?: any): AxiosPromise<GetPartnerVersionResponseClass> {
+            return localVarFp.getPartnerVersion(code, version, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * List all partner versions by providing partner code
+         * @summary List partner versions
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @param {any} [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 {any} [filter] Filter the response by one or multiple fields&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: code, version, displayName, updatedAt, updatedBy&lt;/i&gt;
+         * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+         * @param {any} [order] Order allowing you to specify the desired order of entities retrieved from the server.&lt;br/&gt;     &lt;br/&gt;     &lt;i&gt;Allowed values: displayName, createdAt, updatedAt, version&lt;/i&gt;
+         * @param {'partnerType'} [expand] Allowed expands for the partner version
+         * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPartnerVersion(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'partnerType', filters?: any, options?: any): AxiosPromise<ListPartnerVersionsResponseClass> {
+            return localVarFp.listPartnerVersion(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for getPartnerVersion operation in PartnerVersionApi.
+ * @export
+ * @interface PartnerVersionApiGetPartnerVersionRequest
+ */
+export interface PartnerVersionApiGetPartnerVersionRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerVersionApiGetPartnerVersion
+     */
+    readonly code: string
+
+    /**
+     * 
+     * @type {number}
+     * @memberof PartnerVersionApiGetPartnerVersion
+     */
+    readonly version: number
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerVersionApiGetPartnerVersion
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for listPartnerVersion operation in PartnerVersionApi.
+ * @export
+ * @interface PartnerVersionApiListPartnerVersionRequest
+ */
+export interface PartnerVersionApiListPartnerVersionRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof PartnerVersionApiListPartnerVersion
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerVersionApiListPartnerVersion
+     */
+    readonly authorization?: string
+
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof PartnerVersionApiListPartnerVersion
+     */
+    readonly pageSize?: any
+
+    /**
+     * 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 {any}
+     * @memberof PartnerVersionApiListPartnerVersion
+     */
+    readonly pageToken?: any
+
+    /**
+     * Filter the response by one or multiple fields&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: code, version, displayName, updatedAt, updatedBy&lt;/i&gt;
+     * @type {any}
+     * @memberof PartnerVersionApiListPartnerVersion
+     */
+    readonly filter?: any
+
+    /**
+     * Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @type {any}
+     * @memberof PartnerVersionApiListPartnerVersion
+     */
+    readonly search?: any
+
+    /**
+     * Order allowing you to specify the desired order of entities retrieved from the server.&lt;br/&gt;     &lt;br/&gt;     &lt;i&gt;Allowed values: displayName, createdAt, updatedAt, version&lt;/i&gt;
+     * @type {any}
+     * @memberof PartnerVersionApiListPartnerVersion
+     */
+    readonly order?: any
+
+    /**
+     * Allowed expands for the partner version
+     * @type {'partnerType'}
+     * @memberof PartnerVersionApiListPartnerVersion
+     */
+    readonly expand?: 'partnerType'
+
+    /**
+     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @type {any}
+     * @memberof PartnerVersionApiListPartnerVersion
+     */
+    readonly filters?: any
+}
+
+/**
+ * PartnerVersionApi - object-oriented interface
+ * @export
+ * @class PartnerVersionApi
+ * @extends {BaseAPI}
+ */
+export class PartnerVersionApi extends BaseAPI {
+    /**
+     * Retrieve a partner version by providing partner code and version number
+     * @summary Retrieve the partner version
+     * @param {PartnerVersionApiGetPartnerVersionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerVersionApi
+     */
+    public getPartnerVersion(requestParameters: PartnerVersionApiGetPartnerVersionRequest, options?: AxiosRequestConfig) {
+        return PartnerVersionApiFp(this.configuration).getPartnerVersion(requestParameters.code, requestParameters.version, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * List all partner versions by providing partner code
+     * @summary List partner versions
+     * @param {PartnerVersionApiListPartnerVersionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerVersionApi
+     */
+    public listPartnerVersion(requestParameters: PartnerVersionApiListPartnerVersionRequest, options?: AxiosRequestConfig) {
+        return PartnerVersionApiFp(this.configuration).listPartnerVersion(requestParameters.code, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
+    }
+}