@teemill/projects 0.3.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/common.ts ADDED
@@ -0,0 +1,150 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Projects API
5
+ * Manage Teemill Projects For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
6
+ *
7
+ * The version of the OpenAPI document: 0.3.0
8
+ * Contact: hello@teemill.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import type { Configuration } from "./configuration";
17
+ import type { RequestArgs } from "./base";
18
+ import type { AxiosInstance, AxiosResponse } from 'axios';
19
+ import { RequiredError } from "./base";
20
+
21
+ /**
22
+ *
23
+ * @export
24
+ */
25
+ export const DUMMY_BASE_URL = 'https://example.com'
26
+
27
+ /**
28
+ *
29
+ * @throws {RequiredError}
30
+ * @export
31
+ */
32
+ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
33
+ if (paramValue === null || paramValue === undefined) {
34
+ throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
35
+ }
36
+ }
37
+
38
+ /**
39
+ *
40
+ * @export
41
+ */
42
+ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
43
+ if (configuration && configuration.apiKey) {
44
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
45
+ ? await configuration.apiKey(keyParamName)
46
+ : await configuration.apiKey;
47
+ object[keyParamName] = localVarApiKeyValue;
48
+ }
49
+ }
50
+
51
+ /**
52
+ *
53
+ * @export
54
+ */
55
+ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
56
+ if (configuration && (configuration.username || configuration.password)) {
57
+ object["auth"] = { username: configuration.username, password: configuration.password };
58
+ }
59
+ }
60
+
61
+ /**
62
+ *
63
+ * @export
64
+ */
65
+ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
66
+ if (configuration && configuration.accessToken) {
67
+ const accessToken = typeof configuration.accessToken === 'function'
68
+ ? await configuration.accessToken()
69
+ : await configuration.accessToken;
70
+ object["Authorization"] = "Bearer " + accessToken;
71
+ }
72
+ }
73
+
74
+ /**
75
+ *
76
+ * @export
77
+ */
78
+ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
79
+ if (configuration && configuration.accessToken) {
80
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
81
+ ? await configuration.accessToken(name, scopes)
82
+ : await configuration.accessToken;
83
+ object["Authorization"] = "Bearer " + localVarAccessTokenValue;
84
+ }
85
+ }
86
+
87
+ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
88
+ if (parameter == null) return;
89
+ if (typeof parameter === "object") {
90
+ if (Array.isArray(parameter)) {
91
+ (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
92
+ }
93
+ else {
94
+ Object.keys(parameter).forEach(currentKey =>
95
+ setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
96
+ );
97
+ }
98
+ }
99
+ else {
100
+ if (urlSearchParams.has(key)) {
101
+ urlSearchParams.append(key, parameter);
102
+ }
103
+ else {
104
+ urlSearchParams.set(key, parameter);
105
+ }
106
+ }
107
+ }
108
+
109
+ /**
110
+ *
111
+ * @export
112
+ */
113
+ export const setSearchParams = function (url: URL, ...objects: any[]) {
114
+ const searchParams = new URLSearchParams(url.search);
115
+ setFlattenedQueryParams(searchParams, objects);
116
+ url.search = searchParams.toString();
117
+ }
118
+
119
+ /**
120
+ *
121
+ * @export
122
+ */
123
+ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
124
+ const nonString = typeof value !== 'string';
125
+ const needsSerialization = nonString && configuration && configuration.isJsonMime
126
+ ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
127
+ : nonString;
128
+ return needsSerialization
129
+ ? JSON.stringify(value !== undefined ? value : {})
130
+ : (value || "");
131
+ }
132
+
133
+ /**
134
+ *
135
+ * @export
136
+ */
137
+ export const toPathString = function (url: URL) {
138
+ return url.pathname + url.search + url.hash
139
+ }
140
+
141
+ /**
142
+ *
143
+ * @export
144
+ */
145
+ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
146
+ return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
147
+ const axiosRequestArgs = {...axiosArgs.options, url: (configuration?.basePath || axios.defaults.baseURL || basePath) + axiosArgs.url};
148
+ return axios.request<T, R>(axiosRequestArgs);
149
+ };
150
+ }
@@ -0,0 +1,101 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Projects API
5
+ * Manage Teemill Projects For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
6
+ *
7
+ * The version of the OpenAPI document: 0.3.0
8
+ * Contact: hello@teemill.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ export interface ConfigurationParameters {
17
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
18
+ username?: string;
19
+ password?: string;
20
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
21
+ basePath?: string;
22
+ baseOptions?: any;
23
+ formDataCtor?: new () => any;
24
+ }
25
+
26
+ export class Configuration {
27
+ /**
28
+ * parameter for apiKey security
29
+ * @param name security name
30
+ * @memberof Configuration
31
+ */
32
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
33
+ /**
34
+ * parameter for basic security
35
+ *
36
+ * @type {string}
37
+ * @memberof Configuration
38
+ */
39
+ username?: string;
40
+ /**
41
+ * parameter for basic security
42
+ *
43
+ * @type {string}
44
+ * @memberof Configuration
45
+ */
46
+ password?: string;
47
+ /**
48
+ * parameter for oauth2 security
49
+ * @param name security name
50
+ * @param scopes oauth2 scope
51
+ * @memberof Configuration
52
+ */
53
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
+ /**
55
+ * override base path
56
+ *
57
+ * @type {string}
58
+ * @memberof Configuration
59
+ */
60
+ basePath?: string;
61
+ /**
62
+ * base options for axios calls
63
+ *
64
+ * @type {any}
65
+ * @memberof Configuration
66
+ */
67
+ baseOptions?: any;
68
+ /**
69
+ * The FormData constructor that will be used to create multipart form data
70
+ * requests. You can inject this here so that execution environments that
71
+ * do not support the FormData class can still run the generated client.
72
+ *
73
+ * @type {new () => FormData}
74
+ */
75
+ formDataCtor?: new () => any;
76
+
77
+ constructor(param: ConfigurationParameters = {}) {
78
+ this.apiKey = param.apiKey;
79
+ this.username = param.username;
80
+ this.password = param.password;
81
+ this.accessToken = param.accessToken;
82
+ this.basePath = param.basePath;
83
+ this.baseOptions = param.baseOptions;
84
+ this.formDataCtor = param.formDataCtor;
85
+ }
86
+
87
+ /**
88
+ * Check if the given MIME is a JSON MIME.
89
+ * JSON MIME examples:
90
+ * application/json
91
+ * application/json; charset=UTF8
92
+ * APPLICATION/JSON
93
+ * application/vnd.company+json
94
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
95
+ * @return True if the given MIME is JSON, false otherwise.
96
+ */
97
+ public isJsonMime(mime: string): boolean {
98
+ const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
99
+ return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
100
+ }
101
+ }
package/dist/api.d.ts ADDED
@@ -0,0 +1,274 @@
1
+ /**
2
+ * Projects API
3
+ * Manage Teemill Projects For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
4
+ *
5
+ * The version of the OpenAPI document: 0.3.0
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, AxiosRequestConfig } from 'axios';
14
+ import type { RequestArgs } from './base';
15
+ import { BaseAPI } from './base';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface List200Response
20
+ */
21
+ export interface List200Response {
22
+ /**
23
+ *
24
+ * @type {Array<Project>}
25
+ * @memberof List200Response
26
+ */
27
+ 'projects': Array<Project>;
28
+ }
29
+ /**
30
+ *
31
+ * @export
32
+ * @interface ModelError
33
+ */
34
+ export interface ModelError {
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof ModelError
39
+ */
40
+ 'code'?: string;
41
+ /**
42
+ *
43
+ * @type {string}
44
+ * @memberof ModelError
45
+ */
46
+ 'message': string;
47
+ }
48
+ /**
49
+ *
50
+ * @export
51
+ * @interface Project
52
+ */
53
+ export interface Project {
54
+ /**
55
+ *
56
+ * @type {string}
57
+ * @memberof Project
58
+ */
59
+ 'id': string;
60
+ /**
61
+ *
62
+ * @type {string}
63
+ * @memberof Project
64
+ */
65
+ 'name': string;
66
+ /**
67
+ *
68
+ * @type {ProjectLogo}
69
+ * @memberof Project
70
+ */
71
+ 'logo': ProjectLogo;
72
+ }
73
+ /**
74
+ *
75
+ * @export
76
+ * @interface ProjectLogo
77
+ */
78
+ export interface ProjectLogo {
79
+ /**
80
+ *
81
+ * @type {string}
82
+ * @memberof ProjectLogo
83
+ */
84
+ 'url'?: string;
85
+ /**
86
+ *
87
+ * @type {string}
88
+ * @memberof ProjectLogo
89
+ */
90
+ 'backgroundColor'?: string;
91
+ }
92
+ /**
93
+ * ProjectsApi - axios parameter creator
94
+ * @export
95
+ */
96
+ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuration) => {
97
+ /**
98
+ * Delete a project
99
+ * @summary Delete project
100
+ * @param {string} projectId Projects unique identifier
101
+ * @param {*} [options] Override http request option.
102
+ * @throws {RequiredError}
103
+ */
104
+ _delete: (projectId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
105
+ /**
106
+ * Create a new projects
107
+ * @summary Create project
108
+ * @param {*} [options] Override http request option.
109
+ * @throws {RequiredError}
110
+ */
111
+ create: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
112
+ /**
113
+ * Get a project
114
+ * @summary Get project
115
+ * @param {string} projectId Projects unique identifier
116
+ * @param {*} [options] Override http request option.
117
+ * @throws {RequiredError}
118
+ */
119
+ get: (projectId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
120
+ /**
121
+ * List all projects available
122
+ * @summary List projects
123
+ * @param {*} [options] Override http request option.
124
+ * @throws {RequiredError}
125
+ */
126
+ list: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
127
+ /**
128
+ * Update a project
129
+ * @summary Update project
130
+ * @param {string} projectId Projects unique identifier
131
+ * @param {*} [options] Override http request option.
132
+ * @throws {RequiredError}
133
+ */
134
+ update: (projectId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
135
+ };
136
+ /**
137
+ * ProjectsApi - functional programming interface
138
+ * @export
139
+ */
140
+ export declare const ProjectsApiFp: (configuration?: Configuration) => {
141
+ /**
142
+ * Delete a project
143
+ * @summary Delete project
144
+ * @param {string} projectId Projects unique identifier
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ _delete(projectId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
149
+ /**
150
+ * Create a new projects
151
+ * @summary Create project
152
+ * @param {*} [options] Override http request option.
153
+ * @throws {RequiredError}
154
+ */
155
+ create(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
156
+ /**
157
+ * Get a project
158
+ * @summary Get project
159
+ * @param {string} projectId Projects unique identifier
160
+ * @param {*} [options] Override http request option.
161
+ * @throws {RequiredError}
162
+ */
163
+ get(projectId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
164
+ /**
165
+ * List all projects available
166
+ * @summary List projects
167
+ * @param {*} [options] Override http request option.
168
+ * @throws {RequiredError}
169
+ */
170
+ list(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<List200Response>>;
171
+ /**
172
+ * Update a project
173
+ * @summary Update project
174
+ * @param {string} projectId Projects unique identifier
175
+ * @param {*} [options] Override http request option.
176
+ * @throws {RequiredError}
177
+ */
178
+ update(projectId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
179
+ };
180
+ /**
181
+ * ProjectsApi - factory interface
182
+ * @export
183
+ */
184
+ export declare const ProjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
185
+ /**
186
+ * Delete a project
187
+ * @summary Delete project
188
+ * @param {string} projectId Projects unique identifier
189
+ * @param {*} [options] Override http request option.
190
+ * @throws {RequiredError}
191
+ */
192
+ _delete(projectId: string, options?: any): AxiosPromise<Project>;
193
+ /**
194
+ * Create a new projects
195
+ * @summary Create project
196
+ * @param {*} [options] Override http request option.
197
+ * @throws {RequiredError}
198
+ */
199
+ create(options?: any): AxiosPromise<Project>;
200
+ /**
201
+ * Get a project
202
+ * @summary Get project
203
+ * @param {string} projectId Projects unique identifier
204
+ * @param {*} [options] Override http request option.
205
+ * @throws {RequiredError}
206
+ */
207
+ get(projectId: string, options?: any): AxiosPromise<Project>;
208
+ /**
209
+ * List all projects available
210
+ * @summary List projects
211
+ * @param {*} [options] Override http request option.
212
+ * @throws {RequiredError}
213
+ */
214
+ list(options?: any): AxiosPromise<List200Response>;
215
+ /**
216
+ * Update a project
217
+ * @summary Update project
218
+ * @param {string} projectId Projects unique identifier
219
+ * @param {*} [options] Override http request option.
220
+ * @throws {RequiredError}
221
+ */
222
+ update(projectId: string, options?: any): AxiosPromise<Project>;
223
+ };
224
+ /**
225
+ * ProjectsApi - object-oriented interface
226
+ * @export
227
+ * @class ProjectsApi
228
+ * @extends {BaseAPI}
229
+ */
230
+ export declare class ProjectsApi extends BaseAPI {
231
+ /**
232
+ * Delete a project
233
+ * @summary Delete project
234
+ * @param {string} projectId Projects unique identifier
235
+ * @param {*} [options] Override http request option.
236
+ * @throws {RequiredError}
237
+ * @memberof ProjectsApi
238
+ */
239
+ _delete(projectId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Project, any>>;
240
+ /**
241
+ * Create a new projects
242
+ * @summary Create project
243
+ * @param {*} [options] Override http request option.
244
+ * @throws {RequiredError}
245
+ * @memberof ProjectsApi
246
+ */
247
+ create(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Project, any>>;
248
+ /**
249
+ * Get a project
250
+ * @summary Get project
251
+ * @param {string} projectId Projects unique identifier
252
+ * @param {*} [options] Override http request option.
253
+ * @throws {RequiredError}
254
+ * @memberof ProjectsApi
255
+ */
256
+ get(projectId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Project, any>>;
257
+ /**
258
+ * List all projects available
259
+ * @summary List projects
260
+ * @param {*} [options] Override http request option.
261
+ * @throws {RequiredError}
262
+ * @memberof ProjectsApi
263
+ */
264
+ list(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<List200Response, any>>;
265
+ /**
266
+ * Update a project
267
+ * @summary Update project
268
+ * @param {string} projectId Projects unique identifier
269
+ * @param {*} [options] Override http request option.
270
+ * @throws {RequiredError}
271
+ * @memberof ProjectsApi
272
+ */
273
+ update(projectId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Project, any>>;
274
+ }