@embedworkflow/sdk 1.0.0 → 1.2.0

package/api/users-api.ts

@@ -0,0 +1,531 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * API V1
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * 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';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import { CreateActionType422Response } from '../models';
+// @ts-ignore
+import { CreateUserToken200Response } from '../models';
+// @ts-ignore
+import { CreateUserTokenRequest } from '../models';
+// @ts-ignore
+import { ListUsers200Response } from '../models';
+// @ts-ignore
+import { ListUsers200ResponseCollectionInner } from '../models';
+// @ts-ignore
+import { UpsertUserRequest } from '../models';
+/**
+ * UsersApi - axios parameter creator
+ * @export
+ */
+export const UsersApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @summary Create user token
+         * @param {CreateUserTokenRequest} [createUserTokenRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createUserToken: async (createUserTokenRequest?: CreateUserTokenRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/user_token`;
+            // 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: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createUserTokenRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Delete user
+         * @param {string} key Client-provided unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteUser: async (key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'key' is not null or undefined
+            assertParamExists('deleteUser', 'key', key)
+            const localVarPath = `/api/v1/users/{key}`
+                .replace(`{${"key"}}`, encodeURIComponent(String(key)));
+            // 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: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary List users
+         * @param {string} [startingAfter] Cursor for pagination - return results after this ID
+         * @param {string} [endingBefore] Cursor for pagination - return results before this ID
+         * @param {number} [limit] Number of items to return (max 100)
+         * @param {string} [search] Search users by key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listUsers: async (startingAfter?: string, endingBefore?: string, limit?: number, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/users`;
+            // 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 bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (startingAfter !== undefined) {
+                localVarQueryParameter['starting_after'] = startingAfter;
+            }
+
+            if (endingBefore !== undefined) {
+                localVarQueryParameter['ending_before'] = endingBefore;
+            }
+
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Retrieve user
+         * @param {string} key Client-provided unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        retrieveUser: async (key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'key' is not null or undefined
+            assertParamExists('retrieveUser', 'key', key)
+            const localVarPath = `/api/v1/users/{key}`
+                .replace(`{${"key"}}`, encodeURIComponent(String(key)));
+            // 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 bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Upsert user
+         * @param {string} key Client-provided unique identifier
+         * @param {UpsertUserRequest} [upsertUserRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        upsertUser: async (key: string, upsertUserRequest?: UpsertUserRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'key' is not null or undefined
+            assertParamExists('upsertUser', 'key', key)
+            const localVarPath = `/api/v1/users/{key}`
+                .replace(`{${"key"}}`, encodeURIComponent(String(key)));
+            // 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: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(upsertUserRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * UsersApi - functional programming interface
+ * @export
+ */
+export const UsersApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = UsersApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @summary Create user token
+         * @param {CreateUserTokenRequest} [createUserTokenRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createUserToken(createUserTokenRequest?: CreateUserTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateUserToken200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createUserToken(createUserTokenRequest, options);
+            const index = configuration?.serverIndex ?? 0;
+            const operationBasePath = operationServerMap['UsersApi.createUserToken']?.[index]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Delete user
+         * @param {string} key Client-provided unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async deleteUser(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsers200ResponseCollectionInner>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUser(key, options);
+            const index = configuration?.serverIndex ?? 0;
+            const operationBasePath = operationServerMap['UsersApi.deleteUser']?.[index]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary List users
+         * @param {string} [startingAfter] Cursor for pagination - return results after this ID
+         * @param {string} [endingBefore] Cursor for pagination - return results before this ID
+         * @param {number} [limit] Number of items to return (max 100)
+         * @param {string} [search] Search users by key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listUsers(startingAfter?: string, endingBefore?: string, limit?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsers200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listUsers(startingAfter, endingBefore, limit, search, options);
+            const index = configuration?.serverIndex ?? 0;
+            const operationBasePath = operationServerMap['UsersApi.listUsers']?.[index]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Retrieve user
+         * @param {string} key Client-provided unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async retrieveUser(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsers200ResponseCollectionInner>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveUser(key, options);
+            const index = configuration?.serverIndex ?? 0;
+            const operationBasePath = operationServerMap['UsersApi.retrieveUser']?.[index]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Upsert user
+         * @param {string} key Client-provided unique identifier
+         * @param {UpsertUserRequest} [upsertUserRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async upsertUser(key: string, upsertUserRequest?: UpsertUserRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsers200ResponseCollectionInner>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.upsertUser(key, upsertUserRequest, options);
+            const index = configuration?.serverIndex ?? 0;
+            const operationBasePath = operationServerMap['UsersApi.upsertUser']?.[index]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * UsersApi - factory interface
+ * @export
+ */
+export const UsersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = UsersApiFp(configuration)
+    return {
+        /**
+         * 
+         * @summary Create user token
+         * @param {CreateUserTokenRequest} [createUserTokenRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createUserToken(createUserTokenRequest?: CreateUserTokenRequest, options?: any): AxiosPromise<CreateUserToken200Response> {
+            return localVarFp.createUserToken(createUserTokenRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Delete user
+         * @param {string} key Client-provided unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteUser(key: string, options?: any): AxiosPromise<ListUsers200ResponseCollectionInner> {
+            return localVarFp.deleteUser(key, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary List users
+         * @param {string} [startingAfter] Cursor for pagination - return results after this ID
+         * @param {string} [endingBefore] Cursor for pagination - return results before this ID
+         * @param {number} [limit] Number of items to return (max 100)
+         * @param {string} [search] Search users by key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listUsers(startingAfter?: string, endingBefore?: string, limit?: number, search?: string, options?: any): AxiosPromise<ListUsers200Response> {
+            return localVarFp.listUsers(startingAfter, endingBefore, limit, search, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Retrieve user
+         * @param {string} key Client-provided unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        retrieveUser(key: string, options?: any): AxiosPromise<ListUsers200ResponseCollectionInner> {
+            return localVarFp.retrieveUser(key, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Upsert user
+         * @param {string} key Client-provided unique identifier
+         * @param {UpsertUserRequest} [upsertUserRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        upsertUser(key: string, upsertUserRequest?: UpsertUserRequest, options?: any): AxiosPromise<ListUsers200ResponseCollectionInner> {
+            return localVarFp.upsertUser(key, upsertUserRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * UsersApi - interface
+ * @export
+ * @interface UsersApi
+ */
+export interface UsersApiInterface {
+    /**
+     * 
+     * @summary Create user token
+     * @param {CreateUserTokenRequest} [createUserTokenRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    createUserToken(createUserTokenRequest?: CreateUserTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateUserToken200Response>;
+
+    /**
+     * 
+     * @summary Delete user
+     * @param {string} key Client-provided unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    deleteUser(key: string, options?: RawAxiosRequestConfig): AxiosPromise<ListUsers200ResponseCollectionInner>;
+
+    /**
+     * 
+     * @summary List users
+     * @param {string} [startingAfter] Cursor for pagination - return results after this ID
+     * @param {string} [endingBefore] Cursor for pagination - return results before this ID
+     * @param {number} [limit] Number of items to return (max 100)
+     * @param {string} [search] Search users by key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    listUsers(startingAfter?: string, endingBefore?: string, limit?: number, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListUsers200Response>;
+
+    /**
+     * 
+     * @summary Retrieve user
+     * @param {string} key Client-provided unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    retrieveUser(key: string, options?: RawAxiosRequestConfig): AxiosPromise<ListUsers200ResponseCollectionInner>;
+
+    /**
+     * 
+     * @summary Upsert user
+     * @param {string} key Client-provided unique identifier
+     * @param {UpsertUserRequest} [upsertUserRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    upsertUser(key: string, upsertUserRequest?: UpsertUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListUsers200ResponseCollectionInner>;
+
+}
+
+/**
+ * UsersApi - object-oriented interface
+ * @export
+ * @class UsersApi
+ * @extends {BaseAPI}
+ */
+export class UsersApi extends BaseAPI implements UsersApiInterface {
+    /**
+     * 
+     * @summary Create user token
+     * @param {CreateUserTokenRequest} [createUserTokenRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    public createUserToken(createUserTokenRequest?: CreateUserTokenRequest, options?: RawAxiosRequestConfig) {
+        return UsersApiFp(this.configuration).createUserToken(createUserTokenRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Delete user
+     * @param {string} key Client-provided unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    public deleteUser(key: string, options?: RawAxiosRequestConfig) {
+        return UsersApiFp(this.configuration).deleteUser(key, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary List users
+     * @param {string} [startingAfter] Cursor for pagination - return results after this ID
+     * @param {string} [endingBefore] Cursor for pagination - return results before this ID
+     * @param {number} [limit] Number of items to return (max 100)
+     * @param {string} [search] Search users by key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    public listUsers(startingAfter?: string, endingBefore?: string, limit?: number, search?: string, options?: RawAxiosRequestConfig) {
+        return UsersApiFp(this.configuration).listUsers(startingAfter, endingBefore, limit, search, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Retrieve user
+     * @param {string} key Client-provided unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    public retrieveUser(key: string, options?: RawAxiosRequestConfig) {
+        return UsersApiFp(this.configuration).retrieveUser(key, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Upsert user
+     * @param {string} key Client-provided unique identifier
+     * @param {UpsertUserRequest} [upsertUserRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    public upsertUser(key: string, upsertUserRequest?: UpsertUserRequest, options?: RawAxiosRequestConfig) {
+        return UsersApiFp(this.configuration).upsertUser(key, upsertUserRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+