@teemill/returns 0.1.0

package/README.md

@@ -0,0 +1,84 @@
+## @teemill/returns@0.1.0
+
+This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
+
+Environment
+* Node.js
+* Webpack
+* Browserify
+
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
+
+### Building
+
+To build and compile the typescript sources to javascript use:
+```
+npm install
+npm run build
+```
+
+### Publishing
+
+First build the package then run `npm publish`
+
+### Consuming
+
+navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install @teemill/returns@0.1.0 --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save
+```
+
+### Documentation for API Endpoints
+
+All URIs are relative to *https://api.localhost:8080*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ReturnsApi* | [**getReturnReason**](docs/ReturnsApi.md#getreturnreason) | **GET** /v1/returns/reasons/{id} | Get a return reason
+*ReturnsApi* | [**listReturnReasons**](docs/ReturnsApi.md#listreturnreasons) | **GET** /v1/returns/reasons | List return reasons
+
+
+### Documentation For Models
+
+ - [ApiError](docs/ApiError.md)
+ - [ReturnReason](docs/ReturnReason.md)
+ - [ReturnReasons](docs/ReturnReasons.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="api-key"></a>
+### api-key
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+
+<a id="session-oauth"></a>
+### session-oauth
+
+- **Type**: OAuth
+- **Flow**: password
+- **Authorization URL**: 
+- **Scopes**: N/A
+

package/api.ts

@@ -0,0 +1,383 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Returns API
+ * Manage PodOS Returns
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// 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';
+import type { RequestArgs } from './base';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
+
+/**
+ * 
+ * @export
+ * @interface ApiError
+ */
+export interface ApiError {
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiError
+     */
+    'code'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiError
+     */
+    'message': string;
+}
+/**
+ * 
+ * @export
+ * @interface ReturnReason
+ */
+export interface ReturnReason {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ReturnReason
+     */
+    'id': string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof ReturnReason
+     */
+    'ref': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReturnReason
+     */
+    'name': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReturnReason
+     */
+    'code': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReturnReason
+     */
+    'createdAt': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReturnReason
+     */
+    'updatedAt': string;
+}
+/**
+ * 
+ * @export
+ * @interface ReturnReasons
+ */
+export interface ReturnReasons {
+    /**
+     * 
+     * @type {Array<ReturnReason>}
+     * @memberof ReturnReasons
+     */
+    'returnReasons': Array<ReturnReason>;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReturnReasons
+     */
+    'nextPageToken': number;
+}
+
+/**
+ * ReturnsApi - axios parameter creator
+ * @export
+ */
+export const ReturnsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Get a return reason
+         * @summary Get a return reason
+         * @param {string} project What project it is
+         * @param {string} id The ID of the return reason
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getReturnReason: async (project: string, id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('getReturnReason', 'project', project)
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getReturnReason', 'id', id)
+            const localVarPath = `/v1/returns/reasons/{id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * List return reasons
+         * @summary List return reasons
+         * @param {string} project What project it is
+         * @param {string} [search] Search term to filter results
+         * @param {number} [pageToken] Page reference token
+         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listReturnReasons: async (project: string, search?: string, pageToken?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('listReturnReasons', 'project', project)
+            const localVarPath = `/v1/returns/reasons`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * ReturnsApi - functional programming interface
+ * @export
+ */
+export const ReturnsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = ReturnsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Get a return reason
+         * @summary Get a return reason
+         * @param {string} project What project it is
+         * @param {string} id The ID of the return reason
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getReturnReason(project: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReturnReason>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getReturnReason(project, id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ReturnsApi.getReturnReason']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * List return reasons
+         * @summary List return reasons
+         * @param {string} project What project it is
+         * @param {string} [search] Search term to filter results
+         * @param {number} [pageToken] Page reference token
+         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listReturnReasons(project: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReturnReasons>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listReturnReasons(project, search, pageToken, pageSize, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ReturnsApi.listReturnReasons']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * ReturnsApi - factory interface
+ * @export
+ */
+export const ReturnsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = ReturnsApiFp(configuration)
+    return {
+        /**
+         * Get a return reason
+         * @summary Get a return reason
+         * @param {ReturnsApiGetReturnReasonRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getReturnReason(requestParameters: ReturnsApiGetReturnReasonRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReturnReason> {
+            return localVarFp.getReturnReason(requestParameters.project, requestParameters.id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * List return reasons
+         * @summary List return reasons
+         * @param {ReturnsApiListReturnReasonsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listReturnReasons(requestParameters: ReturnsApiListReturnReasonsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReturnReasons> {
+            return localVarFp.listReturnReasons(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for getReturnReason operation in ReturnsApi.
+ * @export
+ * @interface ReturnsApiGetReturnReasonRequest
+ */
+export interface ReturnsApiGetReturnReasonRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ReturnsApiGetReturnReason
+     */
+    readonly project: string
+
+    /**
+     * The ID of the return reason
+     * @type {string}
+     * @memberof ReturnsApiGetReturnReason
+     */
+    readonly id: string
+}
+
+/**
+ * Request parameters for listReturnReasons operation in ReturnsApi.
+ * @export
+ * @interface ReturnsApiListReturnReasonsRequest
+ */
+export interface ReturnsApiListReturnReasonsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ReturnsApiListReturnReasons
+     */
+    readonly project: string
+
+    /**
+     * Search term to filter results
+     * @type {string}
+     * @memberof ReturnsApiListReturnReasons
+     */
+    readonly search?: string
+
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof ReturnsApiListReturnReasons
+     */
+    readonly pageToken?: number
+
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof ReturnsApiListReturnReasons
+     */
+    readonly pageSize?: number
+}
+
+/**
+ * ReturnsApi - object-oriented interface
+ * @export
+ * @class ReturnsApi
+ * @extends {BaseAPI}
+ */
+export class ReturnsApi extends BaseAPI {
+    /**
+     * Get a return reason
+     * @summary Get a return reason
+     * @param {ReturnsApiGetReturnReasonRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReturnsApi
+     */
+    public getReturnReason(requestParameters: ReturnsApiGetReturnReasonRequest, options?: RawAxiosRequestConfig) {
+        return ReturnsApiFp(this.configuration).getReturnReason(requestParameters.project, requestParameters.id, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * List return reasons
+     * @summary List return reasons
+     * @param {ReturnsApiListReturnReasonsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReturnsApi
+     */
+    public listReturnReasons(requestParameters: ReturnsApiListReturnReasonsRequest, options?: RawAxiosRequestConfig) {
+        return ReturnsApiFp(this.configuration).listReturnReasons(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+
+

package/base.ts

@@ -0,0 +1,86 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Returns API
+ * Manage PodOS Returns
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { Configuration } from './configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+
+export const BASE_PATH = "https://api.localhost:8080".replace(/\/+$/, "");
+
+/**
+ *
+ * @export
+ */
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: RawAxiosRequestConfig;
+}
+
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export class BaseAPI {
+    protected configuration: Configuration | undefined;
+
+    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath ?? basePath;
+        }
+    }
+};
+
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export class RequiredError extends Error {
+    constructor(public field: string, msg?: string) {
+        super(msg);
+        this.name = "RequiredError"
+    }
+}
+
+interface ServerMap {
+    [key: string]: {
+        url: string,
+        description: string,
+    }[];
+}
+
+/**
+ *
+ * @export
+ */
+export const operationServerMap: ServerMap = {
+}

package/common.ts

@@ -0,0 +1,150 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Returns API
+ * Manage PodOS Returns
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+import { RequiredError } from "./base";
+
+/**
+ *
+ * @export
+ */
+export const DUMMY_BASE_URL = 'https://example.com'
+
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const accessToken = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken()
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + accessToken;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken(name, scopes)
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+    }
+}
+
+function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
+    if (parameter == null) return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter)) {
+            (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key !== '' ? `${key}[]` : key));
+        } 
+        else {
+            Object.keys(parameter).forEach(currentKey => 
+                setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
+            );
+        }
+    } 
+    else {
+        if (urlSearchParams.has(key)) {
+            urlSearchParams.append(key, parameter);
+        } 
+        else {
+            urlSearchParams.set(key, parameter);
+        }
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setSearchParams = function (url: URL, ...objects: any[]) {
+    const searchParams = new URLSearchParams(url.search);
+    setFlattenedQueryParams(searchParams, objects);
+    url.search = decodeURIComponent(searchParams.toString());
+}
+
+/**
+ *
+ * @export
+ */
+export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {})
+        : (value || "");
+}
+
+/**
+ *
+ * @export
+ */
+export const toPathString = function (url: URL) {
+    return url.pathname + url.search + url.hash
+}
+
+/**
+ *
+ * @export
+ */
+export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
+    return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
+        return axios.request<T, R>(axiosRequestArgs);
+    };
+}