@teemill/platform 0.1.1

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.
@@ -0,0 +1,65 @@
1
+ /**
2
+ * Platform API
3
+ * Manage Your podOS platform Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change. For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
4
+ *
5
+ * The version of the OpenAPI document: 0.1.1
6
+ * Contact: hello@teemill.com
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, any>>(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
+ * Platform API
6
+ * Manage Your podOS platform Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change. For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
7
+ *
8
+ * The version of the OpenAPI document: 0.1.1
9
+ * Contact: hello@teemill.com
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
+ * Platform API
3
+ * Manage Your podOS platform Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change. For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
4
+ *
5
+ * The version of the OpenAPI document: 0.1.1
6
+ * Contact: hello@teemill.com
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,43 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Platform API
6
+ * Manage Your podOS platform Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change. For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
7
+ *
8
+ * The version of the OpenAPI document: 0.1.1
9
+ * Contact: hello@teemill.com
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
+ this.apiKey = param.apiKey;
20
+ this.username = param.username;
21
+ this.password = param.password;
22
+ this.accessToken = param.accessToken;
23
+ this.basePath = param.basePath;
24
+ this.serverIndex = param.serverIndex;
25
+ this.baseOptions = param.baseOptions;
26
+ this.formDataCtor = param.formDataCtor;
27
+ }
28
+ /**
29
+ * Check if the given MIME is a JSON MIME.
30
+ * JSON MIME examples:
31
+ * application/json
32
+ * application/json; charset=UTF8
33
+ * APPLICATION/JSON
34
+ * application/vnd.company+json
35
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
36
+ * @return True if the given MIME is JSON, false otherwise.
37
+ */
38
+ isJsonMime(mime) {
39
+ const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
40
+ return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
41
+ }
42
+ }
43
+ exports.Configuration = Configuration;
@@ -0,0 +1,185 @@
1
+ /**
2
+ * Platform API
3
+ * Manage Your podOS platform Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change. For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
4
+ *
5
+ * The version of the OpenAPI document: 0.1.1
6
+ * Contact: hello@teemill.com
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 Platform
39
+ */
40
+ export interface Platform {
41
+ /**
42
+ *
43
+ * @type {Array<PlatformLogo>}
44
+ * @memberof Platform
45
+ */
46
+ 'logos': Array<PlatformLogo>;
47
+ }
48
+ /**
49
+ *
50
+ * @export
51
+ * @interface PlatformLogo
52
+ */
53
+ export interface PlatformLogo {
54
+ /**
55
+ *
56
+ * @type {string}
57
+ * @memberof PlatformLogo
58
+ */
59
+ 'url': string;
60
+ /**
61
+ *
62
+ * @type {{ [key: string]: string; }}
63
+ * @memberof PlatformLogo
64
+ */
65
+ 'meta': {
66
+ [key: string]: string;
67
+ };
68
+ }
69
+ /**
70
+ *
71
+ * @export
72
+ * @interface ValidationError
73
+ */
74
+ export interface ValidationError {
75
+ /**
76
+ *
77
+ * @type {string}
78
+ * @memberof ValidationError
79
+ */
80
+ 'message': string;
81
+ /**
82
+ *
83
+ * @type {{ [key: string]: Array<string>; }}
84
+ * @memberof ValidationError
85
+ */
86
+ 'errors': {
87
+ [key: string]: Array<string>;
88
+ };
89
+ }
90
+ /**
91
+ * PlatformApi - axios parameter creator
92
+ * @export
93
+ */
94
+ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuration) => {
95
+ /**
96
+ *
97
+ * @summary Get platform details
98
+ * @param {string} project Project unique identifier
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ getPlatform: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
103
+ /**
104
+ *
105
+ * @summary Update platform
106
+ * @param {string} project Project unique identifier
107
+ * @param {Platform} platform
108
+ * @param {*} [options] Override http request option.
109
+ * @throws {RequiredError}
110
+ */
111
+ updatePlatform: (project: string, platform: Platform, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
112
+ };
113
+ /**
114
+ * PlatformApi - functional programming interface
115
+ * @export
116
+ */
117
+ export declare const PlatformApiFp: (configuration?: Configuration) => {
118
+ /**
119
+ *
120
+ * @summary Get platform details
121
+ * @param {string} project Project unique identifier
122
+ * @param {*} [options] Override http request option.
123
+ * @throws {RequiredError}
124
+ */
125
+ getPlatform(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
126
+ /**
127
+ *
128
+ * @summary Update platform
129
+ * @param {string} project Project unique identifier
130
+ * @param {Platform} platform
131
+ * @param {*} [options] Override http request option.
132
+ * @throws {RequiredError}
133
+ */
134
+ updatePlatform(project: string, platform: Platform, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
135
+ };
136
+ /**
137
+ * PlatformApi - factory interface
138
+ * @export
139
+ */
140
+ export declare const PlatformApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
141
+ /**
142
+ *
143
+ * @summary Get platform details
144
+ * @param {string} project Project unique identifier
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ getPlatform(project: string, options?: any): AxiosPromise<Platform>;
149
+ /**
150
+ *
151
+ * @summary Update platform
152
+ * @param {string} project Project unique identifier
153
+ * @param {Platform} platform
154
+ * @param {*} [options] Override http request option.
155
+ * @throws {RequiredError}
156
+ */
157
+ updatePlatform(project: string, platform: Platform, options?: any): AxiosPromise<Platform>;
158
+ };
159
+ /**
160
+ * PlatformApi - object-oriented interface
161
+ * @export
162
+ * @class PlatformApi
163
+ * @extends {BaseAPI}
164
+ */
165
+ export declare class PlatformApi extends BaseAPI {
166
+ /**
167
+ *
168
+ * @summary Get platform details
169
+ * @param {string} project Project unique identifier
170
+ * @param {*} [options] Override http request option.
171
+ * @throws {RequiredError}
172
+ * @memberof PlatformApi
173
+ */
174
+ getPlatform(project: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
175
+ /**
176
+ *
177
+ * @summary Update platform
178
+ * @param {string} project Project unique identifier
179
+ * @param {Platform} platform
180
+ * @param {*} [options] Override http request option.
181
+ * @throws {RequiredError}
182
+ * @memberof PlatformApi
183
+ */
184
+ updatePlatform(project: string, platform: Platform, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
185
+ }