@teemill/returns 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +84 -0
- package/api.ts +383 -0
- package/base.ts +86 -0
- package/common.ts +150 -0
- package/configuration.ts +115 -0
- package/dist/api.d.ts +246 -0
- package/dist/api.js +235 -0
- package/dist/base.d.ts +66 -0
- package/dist/base.js +65 -0
- package/dist/common.d.ts +65 -0
- package/dist/common.js +161 -0
- package/dist/configuration.d.ts +91 -0
- package/dist/configuration.js +44 -0
- package/dist/esm/api.d.ts +246 -0
- package/dist/esm/api.js +228 -0
- package/dist/esm/base.d.ts +66 -0
- package/dist/esm/base.js +60 -0
- package/dist/esm/common.d.ts +65 -0
- package/dist/esm/common.js +149 -0
- package/dist/esm/configuration.d.ts +91 -0
- package/dist/esm/configuration.js +40 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.js +15 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/docs/ApiError.md +22 -0
- package/docs/ReturnReason.md +30 -0
- package/docs/ReturnReasons.md +22 -0
- package/docs/ReturnsApi.md +133 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/package.json +33 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
package/dist/base.js
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Returns API
|
|
6
|
+
* Manage PodOS Returns
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
|
|
17
|
+
const axios_1 = require("axios");
|
|
18
|
+
exports.BASE_PATH = "https://api.localhost:8080".replace(/\/+$/, "");
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @export
|
|
22
|
+
*/
|
|
23
|
+
exports.COLLECTION_FORMATS = {
|
|
24
|
+
csv: ",",
|
|
25
|
+
ssv: " ",
|
|
26
|
+
tsv: "\t",
|
|
27
|
+
pipes: "|",
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @export
|
|
32
|
+
* @class BaseAPI
|
|
33
|
+
*/
|
|
34
|
+
class BaseAPI {
|
|
35
|
+
constructor(configuration, basePath = exports.BASE_PATH, axios = axios_1.default) {
|
|
36
|
+
var _a;
|
|
37
|
+
this.basePath = basePath;
|
|
38
|
+
this.axios = axios;
|
|
39
|
+
if (configuration) {
|
|
40
|
+
this.configuration = configuration;
|
|
41
|
+
this.basePath = (_a = configuration.basePath) !== null && _a !== void 0 ? _a : basePath;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
exports.BaseAPI = BaseAPI;
|
|
46
|
+
;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @export
|
|
50
|
+
* @class RequiredError
|
|
51
|
+
* @extends {Error}
|
|
52
|
+
*/
|
|
53
|
+
class RequiredError extends Error {
|
|
54
|
+
constructor(field, msg) {
|
|
55
|
+
super(msg);
|
|
56
|
+
this.field = field;
|
|
57
|
+
this.name = "RequiredError";
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
exports.RequiredError = RequiredError;
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
exports.operationServerMap = {};
|
package/dist/common.d.ts
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Returns API
|
|
3
|
+
* Manage PodOS Returns
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from "./configuration";
|
|
13
|
+
import type { RequestArgs } from "./base";
|
|
14
|
+
import type { AxiosInstance, AxiosResponse } from 'axios';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const DUMMY_BASE_URL = "https://example.com";
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @throws {RequiredError}
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
*/
|
|
30
|
+
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
*/
|
|
35
|
+
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
*/
|
|
45
|
+
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @export
|
|
49
|
+
*/
|
|
50
|
+
export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @export
|
|
54
|
+
*/
|
|
55
|
+
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @export
|
|
59
|
+
*/
|
|
60
|
+
export declare const toPathString: (url: URL) => string;
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
package/dist/common.js
ADDED
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Returns API
|
|
6
|
+
* Manage PodOS Returns
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
|
|
26
|
+
const base_1 = require("./base");
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @export
|
|
30
|
+
*/
|
|
31
|
+
exports.DUMMY_BASE_URL = 'https://example.com';
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
* @export
|
|
36
|
+
*/
|
|
37
|
+
const assertParamExists = function (functionName, paramName, paramValue) {
|
|
38
|
+
if (paramValue === null || paramValue === undefined) {
|
|
39
|
+
throw new base_1.RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
|
|
40
|
+
}
|
|
41
|
+
};
|
|
42
|
+
exports.assertParamExists = assertParamExists;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @export
|
|
46
|
+
*/
|
|
47
|
+
const setApiKeyToObject = function (object, keyParamName, configuration) {
|
|
48
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
49
|
+
if (configuration && configuration.apiKey) {
|
|
50
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
51
|
+
? yield configuration.apiKey(keyParamName)
|
|
52
|
+
: yield configuration.apiKey;
|
|
53
|
+
object[keyParamName] = localVarApiKeyValue;
|
|
54
|
+
}
|
|
55
|
+
});
|
|
56
|
+
};
|
|
57
|
+
exports.setApiKeyToObject = setApiKeyToObject;
|
|
58
|
+
/**
|
|
59
|
+
*
|
|
60
|
+
* @export
|
|
61
|
+
*/
|
|
62
|
+
const setBasicAuthToObject = function (object, configuration) {
|
|
63
|
+
if (configuration && (configuration.username || configuration.password)) {
|
|
64
|
+
object["auth"] = { username: configuration.username, password: configuration.password };
|
|
65
|
+
}
|
|
66
|
+
};
|
|
67
|
+
exports.setBasicAuthToObject = setBasicAuthToObject;
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
* @export
|
|
71
|
+
*/
|
|
72
|
+
const setBearerAuthToObject = function (object, configuration) {
|
|
73
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
74
|
+
if (configuration && configuration.accessToken) {
|
|
75
|
+
const accessToken = typeof configuration.accessToken === 'function'
|
|
76
|
+
? yield configuration.accessToken()
|
|
77
|
+
: yield configuration.accessToken;
|
|
78
|
+
object["Authorization"] = "Bearer " + accessToken;
|
|
79
|
+
}
|
|
80
|
+
});
|
|
81
|
+
};
|
|
82
|
+
exports.setBearerAuthToObject = setBearerAuthToObject;
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @export
|
|
86
|
+
*/
|
|
87
|
+
const setOAuthToObject = function (object, name, scopes, configuration) {
|
|
88
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
89
|
+
if (configuration && configuration.accessToken) {
|
|
90
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
91
|
+
? yield configuration.accessToken(name, scopes)
|
|
92
|
+
: yield configuration.accessToken;
|
|
93
|
+
object["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
94
|
+
}
|
|
95
|
+
});
|
|
96
|
+
};
|
|
97
|
+
exports.setOAuthToObject = setOAuthToObject;
|
|
98
|
+
function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
|
|
99
|
+
if (parameter == null)
|
|
100
|
+
return;
|
|
101
|
+
if (typeof parameter === "object") {
|
|
102
|
+
if (Array.isArray(parameter)) {
|
|
103
|
+
parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key !== '' ? `${key}[]` : key));
|
|
104
|
+
}
|
|
105
|
+
else {
|
|
106
|
+
Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`));
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
else {
|
|
110
|
+
if (urlSearchParams.has(key)) {
|
|
111
|
+
urlSearchParams.append(key, parameter);
|
|
112
|
+
}
|
|
113
|
+
else {
|
|
114
|
+
urlSearchParams.set(key, parameter);
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
*
|
|
120
|
+
* @export
|
|
121
|
+
*/
|
|
122
|
+
const setSearchParams = function (url, ...objects) {
|
|
123
|
+
const searchParams = new URLSearchParams(url.search);
|
|
124
|
+
setFlattenedQueryParams(searchParams, objects);
|
|
125
|
+
url.search = decodeURIComponent(searchParams.toString());
|
|
126
|
+
};
|
|
127
|
+
exports.setSearchParams = setSearchParams;
|
|
128
|
+
/**
|
|
129
|
+
*
|
|
130
|
+
* @export
|
|
131
|
+
*/
|
|
132
|
+
const serializeDataIfNeeded = function (value, requestOptions, configuration) {
|
|
133
|
+
const nonString = typeof value !== 'string';
|
|
134
|
+
const needsSerialization = nonString && configuration && configuration.isJsonMime
|
|
135
|
+
? configuration.isJsonMime(requestOptions.headers['Content-Type'])
|
|
136
|
+
: nonString;
|
|
137
|
+
return needsSerialization
|
|
138
|
+
? JSON.stringify(value !== undefined ? value : {})
|
|
139
|
+
: (value || "");
|
|
140
|
+
};
|
|
141
|
+
exports.serializeDataIfNeeded = serializeDataIfNeeded;
|
|
142
|
+
/**
|
|
143
|
+
*
|
|
144
|
+
* @export
|
|
145
|
+
*/
|
|
146
|
+
const toPathString = function (url) {
|
|
147
|
+
return url.pathname + url.search + url.hash;
|
|
148
|
+
};
|
|
149
|
+
exports.toPathString = toPathString;
|
|
150
|
+
/**
|
|
151
|
+
*
|
|
152
|
+
* @export
|
|
153
|
+
*/
|
|
154
|
+
const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
|
|
155
|
+
return (axios = globalAxios, basePath = BASE_PATH) => {
|
|
156
|
+
var _a;
|
|
157
|
+
const axiosRequestArgs = Object.assign(Object.assign({}, axiosArgs.options), { url: (axios.defaults.baseURL ? '' : (_a = configuration === null || configuration === void 0 ? void 0 : configuration.basePath) !== null && _a !== void 0 ? _a : basePath) + axiosArgs.url });
|
|
158
|
+
return axios.request(axiosRequestArgs);
|
|
159
|
+
};
|
|
160
|
+
};
|
|
161
|
+
exports.createRequestFunction = createRequestFunction;
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Returns API
|
|
3
|
+
* Manage PodOS Returns
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export interface ConfigurationParameters {
|
|
13
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
14
|
+
username?: string;
|
|
15
|
+
password?: string;
|
|
16
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
17
|
+
basePath?: string;
|
|
18
|
+
serverIndex?: number;
|
|
19
|
+
baseOptions?: any;
|
|
20
|
+
formDataCtor?: new () => any;
|
|
21
|
+
}
|
|
22
|
+
export declare class Configuration {
|
|
23
|
+
/**
|
|
24
|
+
* parameter for apiKey security
|
|
25
|
+
* @param name security name
|
|
26
|
+
* @memberof Configuration
|
|
27
|
+
*/
|
|
28
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
|
+
/**
|
|
30
|
+
* parameter for basic security
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof Configuration
|
|
34
|
+
*/
|
|
35
|
+
username?: string;
|
|
36
|
+
/**
|
|
37
|
+
* parameter for basic security
|
|
38
|
+
*
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof Configuration
|
|
41
|
+
*/
|
|
42
|
+
password?: string;
|
|
43
|
+
/**
|
|
44
|
+
* parameter for oauth2 security
|
|
45
|
+
* @param name security name
|
|
46
|
+
* @param scopes oauth2 scope
|
|
47
|
+
* @memberof Configuration
|
|
48
|
+
*/
|
|
49
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
50
|
+
/**
|
|
51
|
+
* override base path
|
|
52
|
+
*
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof Configuration
|
|
55
|
+
*/
|
|
56
|
+
basePath?: string;
|
|
57
|
+
/**
|
|
58
|
+
* override server index
|
|
59
|
+
*
|
|
60
|
+
* @type {number}
|
|
61
|
+
* @memberof Configuration
|
|
62
|
+
*/
|
|
63
|
+
serverIndex?: number;
|
|
64
|
+
/**
|
|
65
|
+
* base options for axios calls
|
|
66
|
+
*
|
|
67
|
+
* @type {any}
|
|
68
|
+
* @memberof Configuration
|
|
69
|
+
*/
|
|
70
|
+
baseOptions?: any;
|
|
71
|
+
/**
|
|
72
|
+
* The FormData constructor that will be used to create multipart form data
|
|
73
|
+
* requests. You can inject this here so that execution environments that
|
|
74
|
+
* do not support the FormData class can still run the generated client.
|
|
75
|
+
*
|
|
76
|
+
* @type {new () => FormData}
|
|
77
|
+
*/
|
|
78
|
+
formDataCtor?: new () => any;
|
|
79
|
+
constructor(param?: ConfigurationParameters);
|
|
80
|
+
/**
|
|
81
|
+
* Check if the given MIME is a JSON MIME.
|
|
82
|
+
* JSON MIME examples:
|
|
83
|
+
* application/json
|
|
84
|
+
* application/json; charset=UTF8
|
|
85
|
+
* APPLICATION/JSON
|
|
86
|
+
* application/vnd.company+json
|
|
87
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
88
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
89
|
+
*/
|
|
90
|
+
isJsonMime(mime: string): boolean;
|
|
91
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Returns API
|
|
6
|
+
* Manage PodOS Returns
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.Configuration = void 0;
|
|
17
|
+
class Configuration {
|
|
18
|
+
constructor(param = {}) {
|
|
19
|
+
var _a;
|
|
20
|
+
this.apiKey = param.apiKey;
|
|
21
|
+
this.username = param.username;
|
|
22
|
+
this.password = param.password;
|
|
23
|
+
this.accessToken = param.accessToken;
|
|
24
|
+
this.basePath = param.basePath;
|
|
25
|
+
this.serverIndex = param.serverIndex;
|
|
26
|
+
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
27
|
+
this.formDataCtor = param.formDataCtor;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Check if the given MIME is a JSON MIME.
|
|
31
|
+
* JSON MIME examples:
|
|
32
|
+
* application/json
|
|
33
|
+
* application/json; charset=UTF8
|
|
34
|
+
* APPLICATION/JSON
|
|
35
|
+
* application/vnd.company+json
|
|
36
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
37
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
38
|
+
*/
|
|
39
|
+
isJsonMime(mime) {
|
|
40
|
+
const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
|
|
41
|
+
return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.Configuration = Configuration;
|
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Returns API
|
|
3
|
+
* Manage PodOS Returns
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import type { RequestArgs } from './base';
|
|
15
|
+
import { BaseAPI } from './base';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface ApiError
|
|
20
|
+
*/
|
|
21
|
+
export interface ApiError {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof ApiError
|
|
26
|
+
*/
|
|
27
|
+
'code'?: string;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof ApiError
|
|
32
|
+
*/
|
|
33
|
+
'message': string;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @export
|
|
38
|
+
* @interface ReturnReason
|
|
39
|
+
*/
|
|
40
|
+
export interface ReturnReason {
|
|
41
|
+
/**
|
|
42
|
+
* Unique object identifier
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof ReturnReason
|
|
45
|
+
*/
|
|
46
|
+
'id': string;
|
|
47
|
+
/**
|
|
48
|
+
* A reference to the resource location
|
|
49
|
+
* @type {string}
|
|
50
|
+
* @memberof ReturnReason
|
|
51
|
+
*/
|
|
52
|
+
'ref': string;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {string}
|
|
56
|
+
* @memberof ReturnReason
|
|
57
|
+
*/
|
|
58
|
+
'name': string;
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof ReturnReason
|
|
63
|
+
*/
|
|
64
|
+
'code': string;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof ReturnReason
|
|
69
|
+
*/
|
|
70
|
+
'createdAt': string;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {string}
|
|
74
|
+
* @memberof ReturnReason
|
|
75
|
+
*/
|
|
76
|
+
'updatedAt': string;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
*
|
|
80
|
+
* @export
|
|
81
|
+
* @interface ReturnReasons
|
|
82
|
+
*/
|
|
83
|
+
export interface ReturnReasons {
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
* @type {Array<ReturnReason>}
|
|
87
|
+
* @memberof ReturnReasons
|
|
88
|
+
*/
|
|
89
|
+
'returnReasons': Array<ReturnReason>;
|
|
90
|
+
/**
|
|
91
|
+
*
|
|
92
|
+
* @type {number}
|
|
93
|
+
* @memberof ReturnReasons
|
|
94
|
+
*/
|
|
95
|
+
'nextPageToken': number;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* ReturnsApi - axios parameter creator
|
|
99
|
+
* @export
|
|
100
|
+
*/
|
|
101
|
+
export declare const ReturnsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
102
|
+
/**
|
|
103
|
+
* Get a return reason
|
|
104
|
+
* @summary Get a return reason
|
|
105
|
+
* @param {string} project What project it is
|
|
106
|
+
* @param {string} id The ID of the return reason
|
|
107
|
+
* @param {*} [options] Override http request option.
|
|
108
|
+
* @throws {RequiredError}
|
|
109
|
+
*/
|
|
110
|
+
getReturnReason: (project: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
111
|
+
/**
|
|
112
|
+
* List return reasons
|
|
113
|
+
* @summary List return reasons
|
|
114
|
+
* @param {string} project What project it is
|
|
115
|
+
* @param {string} [search] Search term to filter results
|
|
116
|
+
* @param {number} [pageToken] Page reference token
|
|
117
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
118
|
+
* @param {*} [options] Override http request option.
|
|
119
|
+
* @throws {RequiredError}
|
|
120
|
+
*/
|
|
121
|
+
listReturnReasons: (project: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
122
|
+
};
|
|
123
|
+
/**
|
|
124
|
+
* ReturnsApi - functional programming interface
|
|
125
|
+
* @export
|
|
126
|
+
*/
|
|
127
|
+
export declare const ReturnsApiFp: (configuration?: Configuration) => {
|
|
128
|
+
/**
|
|
129
|
+
* Get a return reason
|
|
130
|
+
* @summary Get a return reason
|
|
131
|
+
* @param {string} project What project it is
|
|
132
|
+
* @param {string} id The ID of the return reason
|
|
133
|
+
* @param {*} [options] Override http request option.
|
|
134
|
+
* @throws {RequiredError}
|
|
135
|
+
*/
|
|
136
|
+
getReturnReason(project: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReturnReason>>;
|
|
137
|
+
/**
|
|
138
|
+
* List return reasons
|
|
139
|
+
* @summary List return reasons
|
|
140
|
+
* @param {string} project What project it is
|
|
141
|
+
* @param {string} [search] Search term to filter results
|
|
142
|
+
* @param {number} [pageToken] Page reference token
|
|
143
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
144
|
+
* @param {*} [options] Override http request option.
|
|
145
|
+
* @throws {RequiredError}
|
|
146
|
+
*/
|
|
147
|
+
listReturnReasons(project: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReturnReasons>>;
|
|
148
|
+
};
|
|
149
|
+
/**
|
|
150
|
+
* ReturnsApi - factory interface
|
|
151
|
+
* @export
|
|
152
|
+
*/
|
|
153
|
+
export declare const ReturnsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
154
|
+
/**
|
|
155
|
+
* Get a return reason
|
|
156
|
+
* @summary Get a return reason
|
|
157
|
+
* @param {ReturnsApiGetReturnReasonRequest} requestParameters Request parameters.
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
getReturnReason(requestParameters: ReturnsApiGetReturnReasonRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReturnReason>;
|
|
162
|
+
/**
|
|
163
|
+
* List return reasons
|
|
164
|
+
* @summary List return reasons
|
|
165
|
+
* @param {ReturnsApiListReturnReasonsRequest} requestParameters Request parameters.
|
|
166
|
+
* @param {*} [options] Override http request option.
|
|
167
|
+
* @throws {RequiredError}
|
|
168
|
+
*/
|
|
169
|
+
listReturnReasons(requestParameters: ReturnsApiListReturnReasonsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReturnReasons>;
|
|
170
|
+
};
|
|
171
|
+
/**
|
|
172
|
+
* Request parameters for getReturnReason operation in ReturnsApi.
|
|
173
|
+
* @export
|
|
174
|
+
* @interface ReturnsApiGetReturnReasonRequest
|
|
175
|
+
*/
|
|
176
|
+
export interface ReturnsApiGetReturnReasonRequest {
|
|
177
|
+
/**
|
|
178
|
+
* What project it is
|
|
179
|
+
* @type {string}
|
|
180
|
+
* @memberof ReturnsApiGetReturnReason
|
|
181
|
+
*/
|
|
182
|
+
readonly project: string;
|
|
183
|
+
/**
|
|
184
|
+
* The ID of the return reason
|
|
185
|
+
* @type {string}
|
|
186
|
+
* @memberof ReturnsApiGetReturnReason
|
|
187
|
+
*/
|
|
188
|
+
readonly id: string;
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* Request parameters for listReturnReasons operation in ReturnsApi.
|
|
192
|
+
* @export
|
|
193
|
+
* @interface ReturnsApiListReturnReasonsRequest
|
|
194
|
+
*/
|
|
195
|
+
export interface ReturnsApiListReturnReasonsRequest {
|
|
196
|
+
/**
|
|
197
|
+
* What project it is
|
|
198
|
+
* @type {string}
|
|
199
|
+
* @memberof ReturnsApiListReturnReasons
|
|
200
|
+
*/
|
|
201
|
+
readonly project: string;
|
|
202
|
+
/**
|
|
203
|
+
* Search term to filter results
|
|
204
|
+
* @type {string}
|
|
205
|
+
* @memberof ReturnsApiListReturnReasons
|
|
206
|
+
*/
|
|
207
|
+
readonly search?: string;
|
|
208
|
+
/**
|
|
209
|
+
* Page reference token
|
|
210
|
+
* @type {number}
|
|
211
|
+
* @memberof ReturnsApiListReturnReasons
|
|
212
|
+
*/
|
|
213
|
+
readonly pageToken?: number;
|
|
214
|
+
/**
|
|
215
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
216
|
+
* @type {number}
|
|
217
|
+
* @memberof ReturnsApiListReturnReasons
|
|
218
|
+
*/
|
|
219
|
+
readonly pageSize?: number;
|
|
220
|
+
}
|
|
221
|
+
/**
|
|
222
|
+
* ReturnsApi - object-oriented interface
|
|
223
|
+
* @export
|
|
224
|
+
* @class ReturnsApi
|
|
225
|
+
* @extends {BaseAPI}
|
|
226
|
+
*/
|
|
227
|
+
export declare class ReturnsApi extends BaseAPI {
|
|
228
|
+
/**
|
|
229
|
+
* Get a return reason
|
|
230
|
+
* @summary Get a return reason
|
|
231
|
+
* @param {ReturnsApiGetReturnReasonRequest} requestParameters Request parameters.
|
|
232
|
+
* @param {*} [options] Override http request option.
|
|
233
|
+
* @throws {RequiredError}
|
|
234
|
+
* @memberof ReturnsApi
|
|
235
|
+
*/
|
|
236
|
+
getReturnReason(requestParameters: ReturnsApiGetReturnReasonRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReturnReason, any>>;
|
|
237
|
+
/**
|
|
238
|
+
* List return reasons
|
|
239
|
+
* @summary List return reasons
|
|
240
|
+
* @param {ReturnsApiListReturnReasonsRequest} requestParameters Request parameters.
|
|
241
|
+
* @param {*} [options] Override http request option.
|
|
242
|
+
* @throws {RequiredError}
|
|
243
|
+
* @memberof ReturnsApi
|
|
244
|
+
*/
|
|
245
|
+
listReturnReasons(requestParameters: ReturnsApiListReturnReasonsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReturnReasons, any>>;
|
|
246
|
+
}
|