@embedworkflow/sdk 1.1.0 → 1.2.0

package/api.ts

@@ -0,0 +1,30 @@
+/* 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.
+ */
+
+
+
+export * from './api/accounts-api';
+export * from './api/action-types-api';
+export * from './api/actions-api';
+export * from './api/app-connections-api';
+export * from './api/available-apps-api';
+export * from './api/data-fields-api';
+export * from './api/events-api';
+export * from './api/executions-api';
+export * from './api/installed-apps-api';
+export * from './api/payments-api';
+export * from './api/triggers-api';
+export * from './api/users-api';
+export * from './api/workflows-api';
+

package/base.ts

@@ -0,0 +1,86 @@
+/* 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';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+
+export const BASE_PATH = "https://www.embedworkflow.com".replace(/\/+$/, "");
+
+/**
+ *
+ * @export
+ */
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: RawAxiosRequestConfig;
+}
+
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export class BaseAPI {
+    protected configuration: Configuration | undefined;
+
+    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath ?? basePath;
+        }
+    }
+};
+
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export class RequiredError extends Error {
+    constructor(public field: string, msg?: string) {
+        super(msg);
+        this.name = "RequiredError"
+    }
+}
+
+interface ServerMap {
+    [key: string]: {
+        url: string,
+        description: string,
+    }[];
+}
+
+/**
+ *
+ * @export
+ */
+export const operationServerMap: ServerMap = {
+}

package/common.ts

@@ -0,0 +1,150 @@
+/* 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 { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+import { RequiredError } from "./base";
+
+/**
+ *
+ * @export
+ */
+export const DUMMY_BASE_URL = 'https://example.com'
+
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const accessToken = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken()
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + accessToken;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken(name, scopes)
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+    }
+}
+
+function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
+    if (parameter == null) return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter)) {
+            (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
+        } 
+        else {
+            Object.keys(parameter).forEach(currentKey => 
+                setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
+            );
+        }
+    } 
+    else {
+        if (urlSearchParams.has(key)) {
+            urlSearchParams.append(key, parameter);
+        } 
+        else {
+            urlSearchParams.set(key, parameter);
+        }
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setSearchParams = function (url: URL, ...objects: any[]) {
+    const searchParams = new URLSearchParams(url.search);
+    setFlattenedQueryParams(searchParams, objects);
+    url.search = searchParams.toString();
+}
+
+/**
+ *
+ * @export
+ */
+export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {})
+        : (value || "");
+}
+
+/**
+ *
+ * @export
+ */
+export const toPathString = function (url: URL) {
+    return url.pathname + url.search + url.hash
+}
+
+/**
+ *
+ * @export
+ */
+export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
+    return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
+        return axios.request<T, R>(axiosRequestArgs);
+    };
+}

package/configuration.ts

@@ -0,0 +1,110 @@
+/* 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.
+ */
+
+
+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;
+        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/accounts-api.d.ts

@@ -12,15 +12,26 @@
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { RequestArgs, BaseAPI } from '../base';
+import { ExportConfiguration200Response } from '../models';
 import { ImportConfiguration201Response } from '../models';
 import { ImportConfigurationRequest } from '../models';
 import { RetrieveAccount200Response } from '../models';
+import { RetrieveAccountUsage200Response } from '../models';
 import { UpdateAccountRequest } from '../models';
 /**
  * AccountsApi - axios parameter creator
  * @export
  */
 export declare const AccountsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Export configuration
+     * @param {ExportConfigurationSchemaFormatEnum} [schemaFormat]
+     * @param {Array<ExportConfigurationSectionsEnum>} [sections]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportConfiguration: (schemaFormat?: ExportConfigurationSchemaFormatEnum, sections?: Array<ExportConfigurationSectionsEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Import configuration
@@ -36,6 +47,16 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     retrieveAccount: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieve account usage
+     * @param {string} [startTime]
+     * @param {string} [endTime]
+     * @param {string} [userKey] User key to filter usage for a specific user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveAccountUsage: (startTime?: string, endTime?: string, userKey?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Update account
@@ -50,6 +71,15 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
  * @export
  */
 export declare const AccountsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Export configuration
+     * @param {ExportConfigurationSchemaFormatEnum} [schemaFormat]
+     * @param {Array<ExportConfigurationSectionsEnum>} [sections]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportConfiguration(schemaFormat?: ExportConfigurationSchemaFormatEnum, sections?: Array<ExportConfigurationSectionsEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportConfiguration200Response>>;
     /**
      *
      * @summary Import configuration
@@ -65,6 +95,16 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     retrieveAccount(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetrieveAccount200Response>>;
+    /**
+     *
+     * @summary Retrieve account usage
+     * @param {string} [startTime]
+     * @param {string} [endTime]
+     * @param {string} [userKey] User key to filter usage for a specific user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveAccountUsage(startTime?: string, endTime?: string, userKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetrieveAccountUsage200Response>>;
     /**
      *
      * @summary Update account
@@ -79,6 +119,15 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const AccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Export configuration
+     * @param {ExportConfigurationSchemaFormatEnum} [schemaFormat]
+     * @param {Array<ExportConfigurationSectionsEnum>} [sections]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportConfiguration(schemaFormat?: ExportConfigurationSchemaFormatEnum, sections?: Array<ExportConfigurationSectionsEnum>, options?: any): AxiosPromise<ExportConfiguration200Response>;
     /**
      *
      * @summary Import configuration
@@ -94,6 +143,16 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     retrieveAccount(options?: any): AxiosPromise<RetrieveAccount200Response>;
+    /**
+     *
+     * @summary Retrieve account usage
+     * @param {string} [startTime]
+     * @param {string} [endTime]
+     * @param {string} [userKey] User key to filter usage for a specific user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveAccountUsage(startTime?: string, endTime?: string, userKey?: string, options?: any): AxiosPromise<RetrieveAccountUsage200Response>;
     /**
      *
      * @summary Update account
@@ -109,6 +168,16 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
  * @interface AccountsApi
  */
 export interface AccountsApiInterface {
+    /**
+     *
+     * @summary Export configuration
+     * @param {ExportConfigurationSchemaFormatEnum} [schemaFormat]
+     * @param {Array<ExportConfigurationSectionsEnum>} [sections]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    exportConfiguration(schemaFormat?: ExportConfigurationSchemaFormatEnum, sections?: Array<ExportConfigurationSectionsEnum>, options?: RawAxiosRequestConfig): AxiosPromise<ExportConfiguration200Response>;
     /**
      *
      * @summary Import configuration
@@ -126,6 +195,17 @@ export interface AccountsApiInterface {
      * @memberof AccountsApiInterface
      */
     retrieveAccount(options?: RawAxiosRequestConfig): AxiosPromise<RetrieveAccount200Response>;
+    /**
+     *
+     * @summary Retrieve account usage
+     * @param {string} [startTime]
+     * @param {string} [endTime]
+     * @param {string} [userKey] User key to filter usage for a specific user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    retrieveAccountUsage(startTime?: string, endTime?: string, userKey?: string, options?: RawAxiosRequestConfig): AxiosPromise<RetrieveAccountUsage200Response>;
     /**
      *
      * @summary Update account
@@ -143,6 +223,16 @@ export interface AccountsApiInterface {
  * @extends {BaseAPI}
  */
 export declare class AccountsApi extends BaseAPI implements AccountsApiInterface {
+    /**
+     *
+     * @summary Export configuration
+     * @param {ExportConfigurationSchemaFormatEnum} [schemaFormat]
+     * @param {Array<ExportConfigurationSectionsEnum>} [sections]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApi
+     */
+    exportConfiguration(schemaFormat?: ExportConfigurationSchemaFormatEnum, sections?: Array<ExportConfigurationSectionsEnum>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportConfiguration200Response, any, {}>>;
     /**
      *
      * @summary Import configuration
@@ -151,7 +241,7 @@ export declare class AccountsApi extends BaseAPI implements AccountsApiInterface
      * @throws {RequiredError}
      * @memberof AccountsApi
      */
-    importConfiguration(importConfigurationRequest?: ImportConfigurationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportConfiguration201Response, any>>;
+    importConfiguration(importConfigurationRequest?: ImportConfigurationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportConfiguration201Response, any, {}>>;
     /**
      *
      * @summary Retrieve account
@@ -159,7 +249,18 @@ export declare class AccountsApi extends BaseAPI implements AccountsApiInterface
      * @throws {RequiredError}
      * @memberof AccountsApi
      */
-    retrieveAccount(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetrieveAccount200Response, any>>;
+    retrieveAccount(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetrieveAccount200Response, any, {}>>;
+    /**
+     *
+     * @summary Retrieve account usage
+     * @param {string} [startTime]
+     * @param {string} [endTime]
+     * @param {string} [userKey] User key to filter usage for a specific user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApi
+     */
+    retrieveAccountUsage(startTime?: string, endTime?: string, userKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetrieveAccountUsage200Response, any, {}>>;
     /**
      *
      * @summary Update account
@@ -168,5 +269,25 @@ export declare class AccountsApi extends BaseAPI implements AccountsApiInterface
      * @throws {RequiredError}
      * @memberof AccountsApi
      */
-    updateAccount(updateAccountRequest?: UpdateAccountRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetrieveAccount200Response, any>>;
+    updateAccount(updateAccountRequest?: UpdateAccountRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetrieveAccount200Response, any, {}>>;
 }
+/**
+ * @export
+ */
+export declare const ExportConfigurationSchemaFormatEnum: {
+    readonly Yaml: "yaml";
+    readonly Json: "json";
+};
+export type ExportConfigurationSchemaFormatEnum = typeof ExportConfigurationSchemaFormatEnum[keyof typeof ExportConfigurationSchemaFormatEnum];
+/**
+ * @export
+ */
+export declare const ExportConfigurationSectionsEnum: {
+    readonly ActionTypes: "action_types";
+    readonly Triggers: "triggers";
+    readonly Workflows: "workflows";
+    readonly Apps: "apps";
+    readonly UserDataSchema: "user_data_schema";
+    readonly AccountDataSchema: "account_data_schema";
+};
+export type ExportConfigurationSectionsEnum = typeof ExportConfigurationSectionsEnum[keyof typeof ExportConfigurationSectionsEnum];