@teemill/returns 0.1.0

package/configuration.ts

@@ -0,0 +1,115 @@
+/* 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.
+ */
+
+
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+
+export class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+
+    constructor(param: ConfigurationParameters = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+        this.serverIndex = param.serverIndex;
+        this.baseOptions = {
+            ...param.baseOptions,
+            headers: {
+                ...param.baseOptions?.headers,
+            },
+        };
+        this.formDataCtor = param.formDataCtor;
+    }
+
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    public isJsonMime(mime: string): boolean {
+        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
+}

package/dist/api.d.ts

@@ -0,0 +1,246 @@
+/**
+ * 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 type { RequestArgs } from './base';
+import { BaseAPI } 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 declare const ReturnsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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: (project: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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: (project: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ReturnsApi - functional programming interface
+ * @export
+ */
+export declare const ReturnsApiFp: (configuration?: Configuration) => {
+    /**
+     * 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(project: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReturnReason>>;
+    /**
+     * 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(project: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReturnReasons>>;
+};
+/**
+ * ReturnsApi - factory interface
+ * @export
+ */
+export declare const ReturnsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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>;
+    /**
+     * 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>;
+};
+/**
+ * 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 declare 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
+     */
+    getReturnReason(requestParameters: ReturnsApiGetReturnReasonRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReturnReason, any>>;
+    /**
+     * List return reasons
+     * @summary List return reasons
+     * @param {ReturnsApiListReturnReasonsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReturnsApi
+     */
+    listReturnReasons(requestParameters: ReturnsApiListReturnReasonsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReturnReasons, any>>;
+}

package/dist/api.js

@@ -0,0 +1,235 @@
+"use strict";
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnsApi = exports.ReturnsApiFactory = exports.ReturnsApiFp = exports.ReturnsApiAxiosParamCreator = void 0;
+const axios_1 = require("axios");
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("./common");
+// @ts-ignore
+const base_1 = require("./base");
+/**
+ * ReturnsApi - axios parameter creator
+ * @export
+ */
+const ReturnsApiAxiosParamCreator = function (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: (project_1, id_1, ...args_1) => __awaiter(this, [project_1, id_1, ...args_1], void 0, function* (project, id, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            (0, common_1.assertParamExists)('getReturnReason', 'project', project);
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.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, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.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: (project_1, search_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, search_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, search, pageToken, pageSize, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            (0, common_1.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, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield (0, common_1.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;
+            }
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.ReturnsApiAxiosParamCreator = ReturnsApiAxiosParamCreator;
+/**
+ * ReturnsApi - functional programming interface
+ * @export
+ */
+const ReturnsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.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}
+         */
+        getReturnReason(project, id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getReturnReason(project, id, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReturnsApi.getReturnReason']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.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}
+         */
+        listReturnReasons(project, search, pageToken, pageSize, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listReturnReasons(project, search, pageToken, pageSize, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReturnsApi.listReturnReasons']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+exports.ReturnsApiFp = ReturnsApiFp;
+/**
+ * ReturnsApi - factory interface
+ * @export
+ */
+const ReturnsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.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, options) {
+            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, options) {
+            return localVarFp.listReturnReasons(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.ReturnsApiFactory = ReturnsApiFactory;
+/**
+ * ReturnsApi - object-oriented interface
+ * @export
+ * @class ReturnsApi
+ * @extends {BaseAPI}
+ */
+class ReturnsApi extends base_1.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
+     */
+    getReturnReason(requestParameters, options) {
+        return (0, exports.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
+     */
+    listReturnReasons(requestParameters, options) {
+        return (0, exports.ReturnsApiFp)(this.configuration).listReturnReasons(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.ReturnsApi = ReturnsApi;

package/dist/base.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 { AxiosInstance, RawAxiosRequestConfig } from 'axios';
+export declare const BASE_PATH: string;
+/**
+ *
+ * @export
+ */
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: RawAxiosRequestConfig;
+}
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export declare class RequiredError extends Error {
+    field: string;
+    constructor(field: string, msg?: string);
+}
+interface ServerMap {
+    [key: string]: {
+        url: string;
+        description: string;
+    }[];
+}
+/**
+ *
+ * @export
+ */
+export declare const operationServerMap: ServerMap;
+export {};