@embedworkflow/sdk 1.0.0

package/dist/esm/api/app-connections-api.d.ts

@@ -0,0 +1,295 @@
+/**
+ * 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 { RequestArgs, BaseAPI } from '../base';
+import { ApiV1AppConnectionsPostRequest } from '../models';
+import { ListAppConnections200Response } from '../models';
+import { ListAppConnections200ResponseCollectionInner } from '../models';
+/**
+ * AppConnectionsApi - axios parameter creator
+ * @export
+ */
+export declare const AppConnectionsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create app connection
+     * @param {ApiV1AppConnectionsPostRequest} [apiV1AppConnectionsPostRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1AppConnectionsPost: (apiV1AppConnectionsPostRequest?: ApiV1AppConnectionsPostRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Delete app connection
+     * @param {string} id System-generated unique identifier
+     * @param {string} [userKey] Unique user identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteAppConnection: (id: string, userKey?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List app connections
+     * @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} [userKey] Unique user identifier
+     * @param {string} [appType] Filter results by app type
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAppConnections: (startingAfter?: string, endingBefore?: string, limit?: number, userKey?: string, appType?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieve app connection
+     * @param {string} id System-generated unique identifier
+     * @param {string} [userKey] Unique user identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveAppConnection: (id: string, userKey?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Update app connection
+     * @param {string} id System-generated unique identifier
+     * @param {ApiV1AppConnectionsPostRequest} [apiV1AppConnectionsPostRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateAppConnection: (id: string, apiV1AppConnectionsPostRequest?: ApiV1AppConnectionsPostRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AppConnectionsApi - functional programming interface
+ * @export
+ */
+export declare const AppConnectionsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create app connection
+     * @param {ApiV1AppConnectionsPostRequest} [apiV1AppConnectionsPostRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1AppConnectionsPost(apiV1AppConnectionsPostRequest?: ApiV1AppConnectionsPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Delete app connection
+     * @param {string} id System-generated unique identifier
+     * @param {string} [userKey] Unique user identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteAppConnection(id: string, userKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary List app connections
+     * @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} [userKey] Unique user identifier
+     * @param {string} [appType] Filter results by app type
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAppConnections(startingAfter?: string, endingBefore?: string, limit?: number, userKey?: string, appType?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAppConnections200Response>>;
+    /**
+     *
+     * @summary Retrieve app connection
+     * @param {string} id System-generated unique identifier
+     * @param {string} [userKey] Unique user identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveAppConnection(id: string, userKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAppConnections200ResponseCollectionInner>>;
+    /**
+     *
+     * @summary Update app connection
+     * @param {string} id System-generated unique identifier
+     * @param {ApiV1AppConnectionsPostRequest} [apiV1AppConnectionsPostRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateAppConnection(id: string, apiV1AppConnectionsPostRequest?: ApiV1AppConnectionsPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAppConnections200ResponseCollectionInner>>;
+};
+/**
+ * AppConnectionsApi - factory interface
+ * @export
+ */
+export declare const AppConnectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Create app connection
+     * @param {ApiV1AppConnectionsPostRequest} [apiV1AppConnectionsPostRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1AppConnectionsPost(apiV1AppConnectionsPostRequest?: ApiV1AppConnectionsPostRequest, options?: any): AxiosPromise<void>;
+    /**
+     *
+     * @summary Delete app connection
+     * @param {string} id System-generated unique identifier
+     * @param {string} [userKey] Unique user identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteAppConnection(id: string, userKey?: string, options?: any): AxiosPromise<void>;
+    /**
+     *
+     * @summary List app connections
+     * @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} [userKey] Unique user identifier
+     * @param {string} [appType] Filter results by app type
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAppConnections(startingAfter?: string, endingBefore?: string, limit?: number, userKey?: string, appType?: string, options?: any): AxiosPromise<ListAppConnections200Response>;
+    /**
+     *
+     * @summary Retrieve app connection
+     * @param {string} id System-generated unique identifier
+     * @param {string} [userKey] Unique user identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveAppConnection(id: string, userKey?: string, options?: any): AxiosPromise<ListAppConnections200ResponseCollectionInner>;
+    /**
+     *
+     * @summary Update app connection
+     * @param {string} id System-generated unique identifier
+     * @param {ApiV1AppConnectionsPostRequest} [apiV1AppConnectionsPostRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateAppConnection(id: string, apiV1AppConnectionsPostRequest?: ApiV1AppConnectionsPostRequest, options?: any): AxiosPromise<ListAppConnections200ResponseCollectionInner>;
+};
+/**
+ * AppConnectionsApi - interface
+ * @export
+ * @interface AppConnectionsApi
+ */
+export interface AppConnectionsApiInterface {
+    /**
+     *
+     * @summary Create app connection
+     * @param {ApiV1AppConnectionsPostRequest} [apiV1AppConnectionsPostRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AppConnectionsApiInterface
+     */
+    apiV1AppConnectionsPost(apiV1AppConnectionsPostRequest?: ApiV1AppConnectionsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Delete app connection
+     * @param {string} id System-generated unique identifier
+     * @param {string} [userKey] Unique user identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AppConnectionsApiInterface
+     */
+    deleteAppConnection(id: string, userKey?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary List app connections
+     * @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} [userKey] Unique user identifier
+     * @param {string} [appType] Filter results by app type
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AppConnectionsApiInterface
+     */
+    listAppConnections(startingAfter?: string, endingBefore?: string, limit?: number, userKey?: string, appType?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListAppConnections200Response>;
+    /**
+     *
+     * @summary Retrieve app connection
+     * @param {string} id System-generated unique identifier
+     * @param {string} [userKey] Unique user identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AppConnectionsApiInterface
+     */
+    retrieveAppConnection(id: string, userKey?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListAppConnections200ResponseCollectionInner>;
+    /**
+     *
+     * @summary Update app connection
+     * @param {string} id System-generated unique identifier
+     * @param {ApiV1AppConnectionsPostRequest} [apiV1AppConnectionsPostRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AppConnectionsApiInterface
+     */
+    updateAppConnection(id: string, apiV1AppConnectionsPostRequest?: ApiV1AppConnectionsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListAppConnections200ResponseCollectionInner>;
+}
+/**
+ * AppConnectionsApi - object-oriented interface
+ * @export
+ * @class AppConnectionsApi
+ * @extends {BaseAPI}
+ */
+export declare class AppConnectionsApi extends BaseAPI implements AppConnectionsApiInterface {
+    /**
+     *
+     * @summary Create app connection
+     * @param {ApiV1AppConnectionsPostRequest} [apiV1AppConnectionsPostRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AppConnectionsApi
+     */
+    apiV1AppConnectionsPost(apiV1AppConnectionsPostRequest?: ApiV1AppConnectionsPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Delete app connection
+     * @param {string} id System-generated unique identifier
+     * @param {string} [userKey] Unique user identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AppConnectionsApi
+     */
+    deleteAppConnection(id: string, userKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary List app connections
+     * @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} [userKey] Unique user identifier
+     * @param {string} [appType] Filter results by app type
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AppConnectionsApi
+     */
+    listAppConnections(startingAfter?: string, endingBefore?: string, limit?: number, userKey?: string, appType?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAppConnections200Response, any>>;
+    /**
+     *
+     * @summary Retrieve app connection
+     * @param {string} id System-generated unique identifier
+     * @param {string} [userKey] Unique user identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AppConnectionsApi
+     */
+    retrieveAppConnection(id: string, userKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAppConnections200ResponseCollectionInner, any>>;
+    /**
+     *
+     * @summary Update app connection
+     * @param {string} id System-generated unique identifier
+     * @param {ApiV1AppConnectionsPostRequest} [apiV1AppConnectionsPostRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AppConnectionsApi
+     */
+    updateAppConnection(id: string, apiV1AppConnectionsPostRequest?: ApiV1AppConnectionsPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAppConnections200ResponseCollectionInner, any>>;
+}