diff --git a/.gitignore b/.gitignore index 53fa6f8..bbd4940 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ node_modules/ dist/ -types/ +/types/* lib/ \ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.CreateConnectionData.html b/docs/types/sdk_client_types_gen.CreateConnectionData.html new file mode 100644 index 0000000..4a7595d --- /dev/null +++ b/docs/types/sdk_client_types_gen.CreateConnectionData.html @@ -0,0 +1 @@ +CreateConnectionData | composio-core

Type alias CreateConnectionData

CreateConnectionData: {
    requestBody?: {
        data?: {
            [key: string]: unknown;
        };
        integrationId: string;
        redirectUri?: string;
        userUuid?: string;
    };
}

Type declaration

  • Optional requestBody?: {
        data?: {
            [key: string]: unknown;
        };
        integrationId: string;
        redirectUri?: string;
        userUuid?: string;
    }
    • Optional data?: {
          [key: string]: unknown;
      }
      • [key: string]: unknown
    • integrationId: string
    • Optional redirectUri?: string
    • Optional userUuid?: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.CreateConnectionResponse.html b/docs/types/sdk_client_types_gen.CreateConnectionResponse.html new file mode 100644 index 0000000..a14871e --- /dev/null +++ b/docs/types/sdk_client_types_gen.CreateConnectionResponse.html @@ -0,0 +1 @@ +CreateConnectionResponse | composio-core

Type alias CreateConnectionResponse

CreateConnectionResponse: {
    connectedAccountId?: string;
    connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
    redirectUrl?: string;
}

Type declaration

  • Optional connectedAccountId?: string
  • Optional connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED"
  • Optional redirectUrl?: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.CreateIntegrationData.html b/docs/types/sdk_client_types_gen.CreateIntegrationData.html new file mode 100644 index 0000000..c6adc3b --- /dev/null +++ b/docs/types/sdk_client_types_gen.CreateIntegrationData.html @@ -0,0 +1,12 @@ +CreateIntegrationData | composio-core

Type alias CreateIntegrationData

CreateIntegrationData: {
    requestBody?: {
        appId?: string;
        authConfig?: {
            api_key?: string;
            base_url?: string;
            client_id?: string;
            client_secret?: string;
            consumer_key?: string;
            consumer_secret?: string;
            [key: string]: unknown;
        };
        authScheme?: AuthScheme;
        name?: string;
        useComposioAuth?: boolean;
    };
}

Type declaration

  • Optional requestBody?: {
        appId?: string;
        authConfig?: {
            api_key?: string;
            base_url?: string;
            client_id?: string;
            client_secret?: string;
            consumer_key?: string;
            consumer_secret?: string;
            [key: string]: unknown;
        };
        authScheme?: AuthScheme;
        name?: string;
        useComposioAuth?: boolean;
    }
    • Optional appId?: string

      The unique identifier of the app associated with the connector.

      +
    • Optional authConfig?: {
          api_key?: string;
          base_url?: string;
          client_id?: string;
          client_secret?: string;
          consumer_key?: string;
          consumer_secret?: string;
          [key: string]: unknown;
      }

      An object containing the authentication configuration for the connector.

      +
      • [key: string]: unknown
      • Optional api_key?: string

        The API key used for authentication with the app - if authScheme is API_KEY

        +
      • Optional base_url?: string

        The base URL for making API requests to the app.

        +
      • Optional client_id?: string

        The client ID used for authentication with the app - if authScheme is OAUTH2

        +
      • Optional client_secret?: string

        The client secret used for authentication with the app - if authScheme is OAUTH2

        +
      • Optional consumer_key?: string

        The Consumer key used for authentication with the app - if authScheme is OAUTH1

        +
      • Optional consumer_secret?: string

        The Consumer secret used for authentication with the app - if authScheme is OAUTH1

        +
    • Optional authScheme?: AuthScheme

      The authentication scheme used by the connector (e.g., "OAUTH2", "API_KEY").

      +
    • Optional name?: string

      The name of the connector.

      +
    • Optional useComposioAuth?: boolean

      Use default Composio credentials to proceed. The developer app credentials will be of Composio.

      +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.CreateIntegrationResponse.html b/docs/types/sdk_client_types_gen.CreateIntegrationResponse.html new file mode 100644 index 0000000..7e874ab --- /dev/null +++ b/docs/types/sdk_client_types_gen.CreateIntegrationResponse.html @@ -0,0 +1,15 @@ +CreateIntegrationResponse | composio-core

Type alias CreateIntegrationResponse

CreateIntegrationResponse: {
    appId?: string;
    appName?: string;
    authConfig?: {
        base_url?: string;
        client_id?: string;
        client_secret?: string;
    };
    authScheme?: string;
    createdAt?: string;
    enabled?: boolean;
    expectedInputFields?: {
        [key: string]: unknown;
    }[];
    id?: string;
    logo?: string;
    name?: string;
    updatedAt?: string;
}

Type declaration

  • Optional appId?: string

    The unique identifier of the app associated with the connector.

    +
  • Optional appName?: string

    The name of the app associated with the connector.

    +
  • Optional authConfig?: {
        base_url?: string;
        client_id?: string;
        client_secret?: string;
    }

    An object containing the authentication configuration for the connector.

    +
    • Optional base_url?: string

      The base URL for making API requests to the app.

      +
    • Optional client_id?: string

      The client ID used for authentication with the app.

      +
    • Optional client_secret?: string

      The client secret used for authentication with the app.

      +
  • Optional authScheme?: string

    The authentication scheme used by the connector.

    +
  • Optional createdAt?: string

    The timestamp indicating when the connector was created.

    +
  • Optional enabled?: boolean

    A boolean indicating whether the connector is enabled or not.

    +
  • Optional expectedInputFields?: {
        [key: string]: unknown;
    }[]

    An array of input fields expected by the connector.

    +
  • Optional id?: string

    The unique identifier of the newly created connector.

    +
  • Optional logo?: string

    The URL of the logo of the app associated with the connector.

    +
  • Optional name?: string

    The name of the connector.

    +
  • Optional updatedAt?: string

    The timestamp indicating when the connector was last updated.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.DeleteConnectionData.html b/docs/types/sdk_client_types_gen.DeleteConnectionData.html new file mode 100644 index 0000000..d6dc59c --- /dev/null +++ b/docs/types/sdk_client_types_gen.DeleteConnectionData.html @@ -0,0 +1,2 @@ +DeleteConnectionData | composio-core

Type alias DeleteConnectionData

DeleteConnectionData: {
    connectedAccountId: string;
}

Type declaration

  • connectedAccountId: string

    The unique identifier of the connection.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.DeleteConnectionResponse.html b/docs/types/sdk_client_types_gen.DeleteConnectionResponse.html new file mode 100644 index 0000000..e2db1f5 --- /dev/null +++ b/docs/types/sdk_client_types_gen.DeleteConnectionResponse.html @@ -0,0 +1,2 @@ +DeleteConnectionResponse | composio-core

Type alias DeleteConnectionResponse

DeleteConnectionResponse: {
    status?: string;
}

Type declaration

  • Optional status?: string

    Status of the api call.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.ExecuteActionData.html b/docs/types/sdk_client_types_gen.ExecuteActionData.html new file mode 100644 index 0000000..f86a4ab --- /dev/null +++ b/docs/types/sdk_client_types_gen.ExecuteActionData.html @@ -0,0 +1,4 @@ +ExecuteActionData | composio-core

Type alias ExecuteActionData

ExecuteActionData: {
    actionName: string;
    requestBody?: {
        appName?: string;
        connectedAccountId?: string;
        input?: {
            [key: string]: unknown;
        };
    };
}

Type declaration

  • actionName: string

    The name of the action to execute.

    +
  • Optional requestBody?: {
        appName?: string;
        connectedAccountId?: string;
        input?: {
            [key: string]: unknown;
        };
    }
    • Optional appName?: string
    • Optional connectedAccountId?: string

      The unique identifier of the connection to use for executing the action.

      +
    • Optional input?: {
          [key: string]: unknown;
      }

      An object containing the input parameters for the action.

      +
      • [key: string]: unknown

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.ExecuteActionResponse.html b/docs/types/sdk_client_types_gen.ExecuteActionResponse.html new file mode 100644 index 0000000..865daa7 --- /dev/null +++ b/docs/types/sdk_client_types_gen.ExecuteActionResponse.html @@ -0,0 +1,4 @@ +ExecuteActionResponse | composio-core

Type alias ExecuteActionResponse

ExecuteActionResponse: {
    execution_details?: {
        executed?: boolean;
    };
    response_data?: {
        [key: string]: unknown;
    };
}

Type declaration

  • Optional execution_details?: {
        executed?: boolean;
    }

    An object containing the details of the action execution.

    +
    • Optional executed?: boolean

      A boolean indicating whether the action was executed successfully.

      +
  • Optional response_data?: {
        [key: string]: unknown;
    }

    An object containing the response data from the action execution.

    +
    • [key: string]: unknown

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.GetActionData.html b/docs/types/sdk_client_types_gen.GetActionData.html new file mode 100644 index 0000000..231c7b4 --- /dev/null +++ b/docs/types/sdk_client_types_gen.GetActionData.html @@ -0,0 +1,2 @@ +GetActionData | composio-core

Type alias GetActionData

GetActionData: {
    actionName: string;
}

Type declaration

  • actionName: string

    The unique identifier of the action.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.GetActionResponse.html b/docs/types/sdk_client_types_gen.GetActionResponse.html new file mode 100644 index 0000000..c865c50 --- /dev/null +++ b/docs/types/sdk_client_types_gen.GetActionResponse.html @@ -0,0 +1,19 @@ +GetActionResponse | composio-core

Type alias GetActionResponse

GetActionResponse: {
    appId?: string;
    appKey?: string;
    appName?: string;
    description?: string;
    display_name?: string;
    enabled?: boolean;
    logo?: string;
    name?: string;
    parameters?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
    response?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
}[]

Type declaration

  • Optional appId?: string

    The unique identifier of the app associated with the action.

    +
  • Optional appKey?: string

    The key of the app associated with the action.

    +
  • Optional appName?: string

    The name of the app associated with the action.

    +
  • Optional description?: string

    A description of the action.

    +
  • Optional display_name?: string

    The display name of the action.

    +
  • Optional enabled?: boolean

    A boolean indicating whether the action is enabled or not.

    +
  • Optional logo?: string

    The URL of the logo of the app associated with the action.

    +
  • Optional name?: string

    The name of the action.

    +
  • Optional parameters?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    }

    An object describing the input parameters of the action.

    +
    • Optional properties?: {
          [key: string]: unknown;
      }

      An object containing the properties of the input parameters.

      +
      • [key: string]: unknown
    • Optional required?: string[]

      An array of required parameter names.

      +
    • Optional title?: string

      The title of the input parameters.

      +
    • Optional type?: string

      The type of the input parameters (e.g., "object").

      +
  • Optional response?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    }

    An object describing the response of the action.

    +
    • Optional properties?: {
          [key: string]: unknown;
      }

      An object containing the properties of the response.

      +
      • [key: string]: unknown
    • Optional required?: string[]

      An array of required response field names.

      +
    • Optional title?: string

      The title of the response.

      +
    • Optional type?: string

      The type of the response (e.g., "object").

      +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.GetActiveTriggerData.html b/docs/types/sdk_client_types_gen.GetActiveTriggerData.html new file mode 100644 index 0000000..78c82ec --- /dev/null +++ b/docs/types/sdk_client_types_gen.GetActiveTriggerData.html @@ -0,0 +1,2 @@ +GetActiveTriggerData | composio-core

Type alias GetActiveTriggerData

GetActiveTriggerData: {
    triggerId: string;
}

Type declaration

  • triggerId: string

    The ID of the trigger to retrieve.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.GetActiveTriggerResponse.html b/docs/types/sdk_client_types_gen.GetActiveTriggerResponse.html new file mode 100644 index 0000000..444f5b7 --- /dev/null +++ b/docs/types/sdk_client_types_gen.GetActiveTriggerResponse.html @@ -0,0 +1,10 @@ +GetActiveTriggerResponse | composio-core

Type alias GetActiveTriggerResponse

GetActiveTriggerResponse: {
    connectionId?: string;
    createdAt?: string;
    disabledAt?: string;
    id?: string;
    state?: {
        [key: string]: unknown;
    };
    triggerConfig?: {
        [key: string]: unknown;
    };
    triggerData?: string;
    triggerName?: string;
    updatedAt?: string;
}

Type declaration

  • Optional connectionId?: string

    Identifier for the connection associated with the trigger.

    +
  • Optional createdAt?: string

    Timestamp when the trigger was created.

    +
  • Optional disabledAt?: string

    Timestamp when the trigger was disabled, if applicable.

    +
  • Optional id?: string

    Unique identifier for the trigger.

    +
  • Optional state?: {
        [key: string]: unknown;
    }

    State information for the trigger.

    +
    • [key: string]: unknown
  • Optional triggerConfig?: {
        [key: string]: unknown;
    }

    Configuration settings for the trigger.

    +
    • [key: string]: unknown
  • Optional triggerData?: string

    Data associated with the trigger.

    +
  • Optional triggerName?: string

    Name of the trigger.

    +
  • Optional updatedAt?: string

    Timestamp when the trigger was last updated.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.GetAppData.html b/docs/types/sdk_client_types_gen.GetAppData.html new file mode 100644 index 0000000..6be67a7 --- /dev/null +++ b/docs/types/sdk_client_types_gen.GetAppData.html @@ -0,0 +1 @@ +GetAppData | composio-core

Type alias GetAppData

GetAppData: {
    appKey: string;
}

Type declaration

  • appKey: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.GetAppResponse.html b/docs/types/sdk_client_types_gen.GetAppResponse.html new file mode 100644 index 0000000..bd2ea6d --- /dev/null +++ b/docs/types/sdk_client_types_gen.GetAppResponse.html @@ -0,0 +1 @@ +GetAppResponse | composio-core

Type alias GetAppResponse

GetAppResponse: {
    appId: string;
    auth_schemes: {
        auth_mode: string;
        authorization_url?: string;
        client_id?: string;
        client_secret?: string;
        default_scopes?: string[];
        fields?: {
            default?: string;
            description: string;
            displayName: string;
            expected_from_customer: boolean;
            name: string;
            required: boolean;
            type: string;
        }[];
        proxy?: {
            base_url?: string;
        };
        scheme_name?: string;
        token_response_metadata?: string[];
        token_url?: string;
    }[];
    categories: string[];
    configuration_docs_text?: string;
    description?: string;
    docs?: string;
    documentation_doc_text?: string;
    group: string;
    key: string;
    logo?: string;
    meta: {
        actionsCount: number;
        is_custom_app: boolean;
        triggersCount: number;
    };
    name: string;
    status: string;
    testConnectors?: {
        authScheme: string;
        id: string;
        name: string;
    }[];
    yaml: any;
}

Type declaration

  • appId: string
  • auth_schemes: {
        auth_mode: string;
        authorization_url?: string;
        client_id?: string;
        client_secret?: string;
        default_scopes?: string[];
        fields?: {
            default?: string;
            description: string;
            displayName: string;
            expected_from_customer: boolean;
            name: string;
            required: boolean;
            type: string;
        }[];
        proxy?: {
            base_url?: string;
        };
        scheme_name?: string;
        token_response_metadata?: string[];
        token_url?: string;
    }[]
  • categories: string[]
  • Optional configuration_docs_text?: string
  • Optional description?: string
  • Optional docs?: string
  • Optional documentation_doc_text?: string
  • group: string
  • key: string
  • Optional logo?: string
  • meta: {
        actionsCount: number;
        is_custom_app: boolean;
        triggersCount: number;
    }
    • actionsCount: number
    • is_custom_app: boolean
    • triggersCount: number
  • name: string
  • status: string
  • Optional testConnectors?: {
        authScheme: string;
        id: string;
        name: string;
    }[]
  • yaml: any

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.GetConnectedAccountData.html b/docs/types/sdk_client_types_gen.GetConnectedAccountData.html new file mode 100644 index 0000000..f180007 --- /dev/null +++ b/docs/types/sdk_client_types_gen.GetConnectedAccountData.html @@ -0,0 +1,2 @@ +GetConnectedAccountData | composio-core

Type alias GetConnectedAccountData

GetConnectedAccountData: {
    connectedAccountId: string;
}

Type declaration

  • connectedAccountId: string

    The unique identifier of the connection.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.GetConnectedAccountResponse.html b/docs/types/sdk_client_types_gen.GetConnectedAccountResponse.html new file mode 100644 index 0000000..26cd036 --- /dev/null +++ b/docs/types/sdk_client_types_gen.GetConnectedAccountResponse.html @@ -0,0 +1,13 @@ +GetConnectedAccountResponse | composio-core

Type alias GetConnectedAccountResponse

GetConnectedAccountResponse: {
    connectionParams?: {
        access_token?: string;
        base_url?: string;
        client_id?: string;
        client_secret?: string;
        scope?: string;
        token_type?: string;
    };
    createdAt?: string;
    id?: string;
    integrationId: string;
    status?: "ACTIVE" | "INITIATED" | "FAILED";
    updatedAt?: string;
}

Type declaration

  • Optional connectionParams?: {
        access_token?: string;
        base_url?: string;
        client_id?: string;
        client_secret?: string;
        scope?: string;
        token_type?: string;
    }

    An object containing the parameters specific to the connection.

    +
    • Optional access_token?: string

      The access token used for authentication with the connected app.

      +
    • Optional base_url?: string

      The base URL for making API requests to the connected app.

      +
    • Optional client_id?: string

      The client ID used for authentication with the connected app.

      +
    • Optional client_secret?: string

      The client secret used for authentication with the connected app.

      +
    • Optional scope?: string

      The scope of permissions granted to the connection.

      +
    • Optional token_type?: string

      The type of token used for authentication (e.g., "bearer").

      +
  • Optional createdAt?: string

    The timestamp indicating when the connection was created.

    +
  • Optional id?: string

    The unique identifier of the connection.

    +
  • integrationId: string

    The unique identifier of the connector associated with the connection.

    +
  • Optional status?: "ACTIVE" | "INITIATED" | "FAILED"

    The status of the connection (e.g., "SUCCESS").

    +
  • Optional updatedAt?: string

    The timestamp indicating when the connection was last updated.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.GetIntegrationData.html b/docs/types/sdk_client_types_gen.GetIntegrationData.html new file mode 100644 index 0000000..802953e --- /dev/null +++ b/docs/types/sdk_client_types_gen.GetIntegrationData.html @@ -0,0 +1,2 @@ +GetIntegrationData | composio-core

Type alias GetIntegrationData

GetIntegrationData: {
    integrationId: string;
}

Type declaration

  • integrationId: string

    The unique identifier of the integration.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.GetIntegrationResponse.html b/docs/types/sdk_client_types_gen.GetIntegrationResponse.html new file mode 100644 index 0000000..2897822 --- /dev/null +++ b/docs/types/sdk_client_types_gen.GetIntegrationResponse.html @@ -0,0 +1,15 @@ +GetIntegrationResponse | composio-core

Type alias GetIntegrationResponse

GetIntegrationResponse: {
    appId?: string;
    appName?: string;
    authConfig?: {
        base_url?: string;
        client_id?: string;
        client_secret?: string;
    };
    authScheme?: string;
    createdAt?: string;
    enabled?: boolean;
    expectedInputFields?: {
        [key: string]: unknown;
    }[];
    id?: string;
    logo?: string;
    name?: string;
    updatedAt?: string;
}

Type declaration

  • Optional appId?: string

    The unique identifier of the app associated with the connector.

    +
  • Optional appName?: string

    The name of the app associated with the connector.

    +
  • Optional authConfig?: {
        base_url?: string;
        client_id?: string;
        client_secret?: string;
    }

    An object containing the authentication configuration for the connector.

    +
    • Optional base_url?: string

      The base URL for making API requests to the app.

      +
    • Optional client_id?: string

      The client ID used for authentication with the app.

      +
    • Optional client_secret?: string

      The client secret used for authentication with the app.

      +
  • Optional authScheme?: string

    The authentication scheme used by the connector (e.g., "OAUTH2", "API_KEY").

    +
  • Optional createdAt?: string

    The timestamp indicating when the connector was created.

    +
  • Optional enabled?: boolean

    A boolean indicating whether the connector is enabled or not.

    +
  • Optional expectedInputFields?: {
        [key: string]: unknown;
    }[]

    An array of input fields expected by the connector.

    +
  • Optional id?: string

    The unique identifier of the connector.

    +
  • Optional logo?: string

    The URL of the logo of the app associated with the connector.

    +
  • Optional name?: string

    The name of the connector.

    +
  • Optional updatedAt?: string

    The timestamp indicating when the connector was last updated.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.GetListActionsData.html b/docs/types/sdk_client_types_gen.GetListActionsData.html new file mode 100644 index 0000000..3c10b1b --- /dev/null +++ b/docs/types/sdk_client_types_gen.GetListActionsData.html @@ -0,0 +1,8 @@ +GetListActionsData | composio-core

Type alias GetListActionsData

GetListActionsData: {
    actions?: string;
    apps?: string;
    showAll?: boolean;
    showEnabledOnly?: boolean;
    tags?: string;
    useCase?: string;
    usecaseLimit?: string;
}

Type declaration

  • Optional actions?: string

    Filter by Action names

    +
  • Optional apps?: string

    Name of the apps like "github", "linear" seperated by a comma

    +
  • Optional showAll?: boolean

    Show all actions - i.e disable pagination

    +
  • Optional showEnabledOnly?: boolean

    Show actions enabled for the API Key

    +
  • Optional tags?: string

    Filter by Action tags

    +
  • Optional useCase?: string

    Filter by use case

    +
  • Optional usecaseLimit?: string

    Limit of use-cases based search

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.GetListActionsResponse.html b/docs/types/sdk_client_types_gen.GetListActionsResponse.html new file mode 100644 index 0000000..d28d7b4 --- /dev/null +++ b/docs/types/sdk_client_types_gen.GetListActionsResponse.html @@ -0,0 +1,2 @@ +GetListActionsResponse | composio-core

Type alias GetListActionsResponse

GetListActionsResponse: {
    items?: {
        appId?: string;
        appName?: string;
        description?: string;
        display_name?: string;
        enabled?: boolean;
        logo?: string;
        name?: string;
        parameters?: {
            properties?: {
                [key: string]: unknown;
            };
            required?: string[];
            title?: string;
            type?: string;
        };
        response?: {
            properties?: {
                [key: string]: unknown;
            };
            required?: string[];
            title?: string;
            type?: string;
        };
    }[];
    page: number;
    totalPages: number;
}

Type declaration

  • Optional items?: {
        appId?: string;
        appName?: string;
        description?: string;
        display_name?: string;
        enabled?: boolean;
        logo?: string;
        name?: string;
        parameters?: {
            properties?: {
                [key: string]: unknown;
            };
            required?: string[];
            title?: string;
            type?: string;
        };
        response?: {
            properties?: {
                [key: string]: unknown;
            };
            required?: string[];
            title?: string;
            type?: string;
        };
    }[]

    An array of action objects.

    +
  • page: number
  • totalPages: number

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.ListActiveTriggersData.html b/docs/types/sdk_client_types_gen.ListActiveTriggersData.html new file mode 100644 index 0000000..5772c31 --- /dev/null +++ b/docs/types/sdk_client_types_gen.ListActiveTriggersData.html @@ -0,0 +1,5 @@ +ListActiveTriggersData | composio-core

Type alias ListActiveTriggersData

ListActiveTriggersData: {
    connectedAccountIds?: string;
    integrationIds?: string;
    triggerIds?: string;
    triggerNames?: string;
}

Type declaration

  • Optional connectedAccountIds?: string

    Filter by Connected Account ids

    +
  • Optional integrationIds?: string

    Filter by Integration ids

    +
  • Optional triggerIds?: string

    Filter by Trigger ids

    +
  • Optional triggerNames?: string

    Filter by Trigger names

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.ListActiveTriggersResponse.html b/docs/types/sdk_client_types_gen.ListActiveTriggersResponse.html new file mode 100644 index 0000000..37ca9c3 --- /dev/null +++ b/docs/types/sdk_client_types_gen.ListActiveTriggersResponse.html @@ -0,0 +1,4 @@ +ListActiveTriggersResponse | composio-core

Type alias ListActiveTriggersResponse

ListActiveTriggersResponse: {
    pageInfo?: {
        currentPage?: number;
        perPage?: number;
        totalPages?: number;
    };
    triggers?: {
        connectionId?: string;
        createdAt?: string;
        disabledAt?: string;
        id?: string;
        state?: {
            [key: string]: unknown;
        };
        triggerConfig?: {
            [key: string]: unknown;
        };
        triggerData?: string;
        triggerName?: string;
        updatedAt?: string;
    }[];
}

Type declaration

  • Optional pageInfo?: {
        currentPage?: number;
        perPage?: number;
        totalPages?: number;
    }
    • Optional currentPage?: number

      The current page number.

      +
    • Optional perPage?: number

      The number of items per page.

      +
    • Optional totalPages?: number

      The total number of pages.

      +
  • Optional triggers?: {
        connectionId?: string;
        createdAt?: string;
        disabledAt?: string;
        id?: string;
        state?: {
            [key: string]: unknown;
        };
        triggerConfig?: {
            [key: string]: unknown;
        };
        triggerData?: string;
        triggerName?: string;
        updatedAt?: string;
    }[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.ListAllAppsResponse.html b/docs/types/sdk_client_types_gen.ListAllAppsResponse.html new file mode 100644 index 0000000..458c284 --- /dev/null +++ b/docs/types/sdk_client_types_gen.ListAllAppsResponse.html @@ -0,0 +1,2 @@ +ListAllAppsResponse | composio-core

Type alias ListAllAppsResponse

ListAllAppsResponse: {
    items?: {
        appId?: string;
        categories?: string[];
        description?: string;
        key?: string;
        logo?: string;
        name?: string;
    }[];
}

Type declaration

  • Optional items?: {
        appId?: string;
        categories?: string[];
        description?: string;
        key?: string;
        logo?: string;
        name?: string;
    }[]

    An array of app objects.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.ListAllConnectionsData.html b/docs/types/sdk_client_types_gen.ListAllConnectionsData.html new file mode 100644 index 0000000..ff7e5fc --- /dev/null +++ b/docs/types/sdk_client_types_gen.ListAllConnectionsData.html @@ -0,0 +1,5 @@ +ListAllConnectionsData | composio-core

Type alias ListAllConnectionsData

ListAllConnectionsData: {
    integrationId?: string;
    page?: number;
    pageSize?: number;
    user_uuid?: string;
}

Type declaration

  • Optional integrationId?: string

    Filter by using specific Integration

    +
  • Optional page?: number

    Page number to fetch

    +
  • Optional pageSize?: number

    Page size to assume

    +
  • Optional user_uuid?: string

    Filter by using specific entity id, seperated by comma

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.ListAllConnectionsResponse.html b/docs/types/sdk_client_types_gen.ListAllConnectionsResponse.html new file mode 100644 index 0000000..a3cc6e8 --- /dev/null +++ b/docs/types/sdk_client_types_gen.ListAllConnectionsResponse.html @@ -0,0 +1 @@ +ListAllConnectionsResponse | composio-core

Type alias ListAllConnectionsResponse

ListAllConnectionsResponse: {
    items?: {
        appName?: string;
        connectionParams?: {
            access_token?: string;
            base_url?: string;
            bot_id?: string;
            client_id?: string;
            client_secret?: string;
            created_at?: number;
            duplicated_template_id?: string;
            expires_in?: number;
            organization?: string;
            owner?: {
                type?: string;
                user?: {
                    avatar_url?: string;
                    id?: string;
                    name?: string;
                    object?: string;
                    person?: {
                        email?: string;
                    };
                    type?: string;
                };
            } | string;
            refresh_token?: string;
            request_id?: string;
            scope?: string;
            token_type?: string;
            workspace_icon?: string;
            workspace_id?: string;
            workspace_name?: string;
        };
        connectorId?: string;
        createdAt?: string;
        id?: string;
        logo?: string;
        status?: "FAILED" | "INITIATED" | "ACTIVE";
        updatedAt?: string;
    }[];
    page?: number;
    totalPages?: number;
}

Type declaration

  • Optional items?: {
        appName?: string;
        connectionParams?: {
            access_token?: string;
            base_url?: string;
            bot_id?: string;
            client_id?: string;
            client_secret?: string;
            created_at?: number;
            duplicated_template_id?: string;
            expires_in?: number;
            organization?: string;
            owner?: {
                type?: string;
                user?: {
                    avatar_url?: string;
                    id?: string;
                    name?: string;
                    object?: string;
                    person?: {
                        email?: string;
                    };
                    type?: string;
                };
            } | string;
            refresh_token?: string;
            request_id?: string;
            scope?: string;
            token_type?: string;
            workspace_icon?: string;
            workspace_id?: string;
            workspace_name?: string;
        };
        connectorId?: string;
        createdAt?: string;
        id?: string;
        logo?: string;
        status?: "FAILED" | "INITIATED" | "ACTIVE";
        updatedAt?: string;
    }[]
  • Optional page?: number
  • Optional totalPages?: number

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.ListAllIntegrationsData.html b/docs/types/sdk_client_types_gen.ListAllIntegrationsData.html new file mode 100644 index 0000000..a35c550 --- /dev/null +++ b/docs/types/sdk_client_types_gen.ListAllIntegrationsData.html @@ -0,0 +1,3 @@ +ListAllIntegrationsData | composio-core

Type alias ListAllIntegrationsData

ListAllIntegrationsData: {
    page?: number;
    pageSize?: number;
}

Type declaration

  • Optional page?: number

    Page number to fetch

    +
  • Optional pageSize?: number

    Page Size to assume

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.ListAllIntegrationsResponse.html b/docs/types/sdk_client_types_gen.ListAllIntegrationsResponse.html new file mode 100644 index 0000000..c9ba47d --- /dev/null +++ b/docs/types/sdk_client_types_gen.ListAllIntegrationsResponse.html @@ -0,0 +1 @@ +ListAllIntegrationsResponse | composio-core

Type alias ListAllIntegrationsResponse

ListAllIntegrationsResponse: {
    items?: {
        appId?: string;
        appName?: string;
        authScheme?: string;
        createdAt?: string;
        enabled?: boolean;
        id?: string;
        logo?: string;
        name?: string;
        updatedAt?: string;
    }[];
    page?: number;
    totalPages?: number;
}

Type declaration

  • Optional items?: {
        appId?: string;
        appName?: string;
        authScheme?: string;
        createdAt?: string;
        enabled?: boolean;
        id?: string;
        logo?: string;
        name?: string;
        updatedAt?: string;
    }[]
  • Optional page?: number
  • Optional totalPages?: number

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.ListTriggersData.html b/docs/types/sdk_client_types_gen.ListTriggersData.html new file mode 100644 index 0000000..a0c6f06 --- /dev/null +++ b/docs/types/sdk_client_types_gen.ListTriggersData.html @@ -0,0 +1,4 @@ +ListTriggersData | composio-core

Type alias ListTriggersData

ListTriggersData: {
    appNames?: string;
    connectedAccountIds?: string;
    showEnabledOnly?: boolean;
}

Type declaration

  • Optional appNames?: string

    Name of the apps like "github", "linear" seperated by a comma

    +
  • Optional connectedAccountIds?: string

    Filter by Aonnected Account ids

    +
  • Optional showEnabledOnly?: boolean

    Show triggers enabled for the API Key

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.ListTriggersResponse.html b/docs/types/sdk_client_types_gen.ListTriggersResponse.html new file mode 100644 index 0000000..c967217 --- /dev/null +++ b/docs/types/sdk_client_types_gen.ListTriggersResponse.html @@ -0,0 +1,19 @@ +ListTriggersResponse | composio-core

Type alias ListTriggersResponse

ListTriggersResponse: {
    appId?: string;
    appKey?: string;
    appName?: string;
    config?: {
        properties?: {
            description?: string;
            required?: string[];
            title?: string;
            type?: string;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
    count?: number;
    description?: string;
    display_name?: string;
    enabled?: boolean;
    instructions?: string;
    logo?: string;
    name?: string;
    payload?: {
        properties?: {
            author: string;
            id: string;
            message: string;
            timestamp: string;
            url: string;
        };
    };
}[]

Type declaration

  • Optional appId?: string

    The unique ID of the app.

    +
  • Optional appKey?: string

    The key of the app.

    +
  • Optional appName?: string

    The name of the app.

    +
  • Optional config?: {
        properties?: {
            description?: string;
            required?: string[];
            title?: string;
            type?: string;
        };
        required?: string[];
        title?: string;
        type?: string;
    }
    • Optional properties?: {
          description?: string;
          required?: string[];
          title?: string;
          type?: string;
      }
      • Optional description?: string

        string

        +
      • Optional required?: string[]
      • Optional title?: string

        string

        +
      • Optional type?: string

        string

        +
    • Optional required?: string[]
    • Optional title?: string
    • Optional type?: string
  • Optional count?: number

    The count of the event.

    +
  • Optional description?: string

    A brief description of the event.

    +
  • Optional display_name?: string

    The display name of the event.

    +
  • Optional enabled?: boolean

    Whether the event is enabled.

    +
  • Optional instructions?: string

    Instructions for the event.

    +
  • Optional logo?: string

    The URL of the app's logo image.

    +
  • Optional name?: string

    The name of the event.

    +
  • Optional payload?: {
        properties?: {
            author: string;
            id: string;
            message: string;
            timestamp: string;
            url: string;
        };
    }
    • Optional properties?: {
          author: string;
          id: string;
          message: string;
          timestamp: string;
          url: string;
      }
      • author: string

        The GitHub username of the commit author.

        +
      • id: string

        The SHA of the commit.

        +
      • message: string

        The commit message.

        +
      • timestamp: string

        The timestamp of the commit.

        +
      • url: string

        The GitHub URL of the commit.

        +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.PatchUpdateActiveTriggerStatusData.html b/docs/types/sdk_client_types_gen.PatchUpdateActiveTriggerStatusData.html new file mode 100644 index 0000000..1421e61 --- /dev/null +++ b/docs/types/sdk_client_types_gen.PatchUpdateActiveTriggerStatusData.html @@ -0,0 +1,2 @@ +PatchUpdateActiveTriggerStatusData | composio-core

Type alias PatchUpdateActiveTriggerStatusData

PatchUpdateActiveTriggerStatusData: {
    requestBody: {
        enabled: boolean;
    };
    triggerId: string;
}

Type declaration

  • requestBody: {
        enabled: boolean;
    }
    • enabled: boolean
  • triggerId: string

    The ID of the trigger to enable or disable.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.PatchUpdateActiveTriggerStatusResponse.html b/docs/types/sdk_client_types_gen.PatchUpdateActiveTriggerStatusResponse.html new file mode 100644 index 0000000..bb8d364 --- /dev/null +++ b/docs/types/sdk_client_types_gen.PatchUpdateActiveTriggerStatusResponse.html @@ -0,0 +1 @@ +PatchUpdateActiveTriggerStatusResponse | composio-core

Type alias PatchUpdateActiveTriggerStatusResponse

PatchUpdateActiveTriggerStatusResponse: {
    status: "success";
}

Type declaration

  • status: "success"

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.SetupTriggerData.html b/docs/types/sdk_client_types_gen.SetupTriggerData.html new file mode 100644 index 0000000..70f1d41 --- /dev/null +++ b/docs/types/sdk_client_types_gen.SetupTriggerData.html @@ -0,0 +1 @@ +SetupTriggerData | composio-core

Type alias SetupTriggerData

SetupTriggerData: {
    connectedAccountId: string;
    requestBody: {
        triggerConfig: any;
        verifyHost?: string;
    };
    triggerName: string;
}

Type declaration

  • connectedAccountId: string
  • requestBody: {
        triggerConfig: any;
        verifyHost?: string;
    }
    • triggerConfig: any
    • Optional verifyHost?: string
  • triggerName: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.SetupTriggerResponse.html b/docs/types/sdk_client_types_gen.SetupTriggerResponse.html new file mode 100644 index 0000000..7211162 --- /dev/null +++ b/docs/types/sdk_client_types_gen.SetupTriggerResponse.html @@ -0,0 +1 @@ +SetupTriggerResponse | composio-core

Type alias SetupTriggerResponse

SetupTriggerResponse: {
    status: "success";
    trigger: GetActiveTriggerResponse;
}

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.UpdateIntegrationData.html b/docs/types/sdk_client_types_gen.UpdateIntegrationData.html new file mode 100644 index 0000000..3447153 --- /dev/null +++ b/docs/types/sdk_client_types_gen.UpdateIntegrationData.html @@ -0,0 +1,3 @@ +UpdateIntegrationData | composio-core

Type alias UpdateIntegrationData

UpdateIntegrationData: {
    integrationId: string;
    requestBody?: {
        enabled?: boolean;
    };
}

Type declaration

  • integrationId: string

    The unique identifier of the integration.

    +
  • Optional requestBody?: {
        enabled?: boolean;
    }
    • Optional enabled?: boolean

      All the parameters that you see in the GET connector

      +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.UpdateIntegrationResponse.html b/docs/types/sdk_client_types_gen.UpdateIntegrationResponse.html new file mode 100644 index 0000000..1250493 --- /dev/null +++ b/docs/types/sdk_client_types_gen.UpdateIntegrationResponse.html @@ -0,0 +1 @@ +UpdateIntegrationResponse | composio-core

Type alias UpdateIntegrationResponse

UpdateIntegrationResponse: {
    status?: string;
}

Type declaration

  • Optional status?: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/sdk_client_types_gen._OpenApiTs.html b/docs/types/sdk_client_types_gen._OpenApiTs.html new file mode 100644 index 0000000..39aa7cc --- /dev/null +++ b/docs/types/sdk_client_types_gen._OpenApiTs.html @@ -0,0 +1,109 @@ +$OpenApiTs | composio-core

Type alias $OpenApiTs

$OpenApiTs: {
    /v1/actions/{actionName}: {
        get: {
            req: GetActionData;
            res: {
                200: {
                    appId?: string;
                    appName?: string;
                    description?: string;
                    display_name?: string;
                    enabled?: boolean;
                    logo?: string;
                    name?: string;
                    parameters?: {
                        properties?: {
                            [key: string]: unknown;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                    response?: {
                        properties?: {
                            [key: string]: unknown;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                };
                404: unknown;
            };
        };
    };
    /v1/actions/{actionName}/execute: {
        post: {
            req: ExecuteActionData;
            res: {
                200: {
                    execution_details?: {
                        executed?: boolean;
                    };
                    response_data?: {
                        [key: string]: unknown;
                    };
                };
                404: unknown;
            };
        };
    };
    /v1/apps: {
        get: {
            res: {
                200: {
                    items?: {
                        appId?: string;
                        categories?: string[];
                        description?: string;
                        key?: string;
                        logo?: string;
                        name?: string;
                    }[];
                };
            };
        };
    };
    /v1/connectedAccounts: {
        get: {
            req: ListAllConnectionsData;
            res: {
                200: {
                    items?: {
                        appName?: string;
                        connectionParams?: {
                            access_token?: string;
                            base_url?: string;
                            bot_id?: string;
                            client_id?: string;
                            client_secret?: string;
                            created_at?: number;
                            duplicated_template_id?: string;
                            expires_in?: number;
                            organization?: string;
                            owner?: {
                                type?: string;
                                user?: {
                                    avatar_url?: ...;
                                    id?: ...;
                                    name?: ...;
                                    object?: ...;
                                    person?: ...;
                                    type?: ...;
                                };
                            } | string;
                            refresh_token?: string;
                            request_id?: string;
                            scope?: string;
                            token_type?: string;
                            workspace_icon?: string;
                            workspace_id?: string;
                            workspace_name?: string;
                        };
                        connectorId?: string;
                        createdAt?: string;
                        id?: string;
                        logo?: string;
                        status?: "FAILED" | "INITIATED" | "ACTIVE";
                        updatedAt?: string;
                    }[];
                    page?: number;
                    totalPages?: number;
                };
            };
        };
        post: {
            req: CreateConnectionData;
            res: {
                200: {
                    connectionId?: string;
                    connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
                    redirectUrl?: string;
                };
                404: unknown;
            };
        };
    };
    /v1/connectedAccounts/{connectedAccountId}: {
        delete: {
            req: DeleteConnectionData;
            res: {
                200: {
                    status?: string;
                };
                404: unknown;
            };
        };
        get: {
            req: GetConnectedAccountData;
            res: {
                200: {
                    connectionParams?: {
                        access_token?: string;
                        base_url?: string;
                        client_id?: string;
                        client_secret?: string;
                        scope?: string;
                        token_type?: string;
                    };
                    createdAt?: string;
                    id?: string;
                    integrationId?: string;
                    status?: "ACTIVE" | "INITIATED" | "FAILED";
                    updatedAt?: string;
                };
                404: unknown;
            };
        };
    };
    /v1/integrations: {
        get: {
            req: ListAllIntegrationsData;
            res: {
                200: {
                    items?: {
                        appId?: string;
                        appName?: string;
                        authScheme?: string;
                        createdAt?: string;
                        enabled?: boolean;
                        id?: string;
                        logo?: string;
                        name?: string;
                        updatedAt?: string;
                    }[];
                    page?: number;
                    totalPages?: number;
                };
            };
        };
        post: {
            req: CreateIntegrationData;
            res: {
                200: {
                    appId?: string;
                    appName?: string;
                    authConfig?: {
                        base_url?: string;
                        client_id?: string;
                        client_secret?: string;
                    };
                    authScheme?: string;
                    createdAt?: string;
                    enabled?: boolean;
                    expectedInputFields?: {
                        [key: string]: unknown;
                    }[];
                    id?: string;
                    logo?: string;
                    name?: string;
                    updatedAt?: string;
                };
                400: unknown;
            };
        };
    };
    /v1/integrations/{integrationId}: {
        get: {
            req: GetIntegrationData;
            res: {
                200: {
                    appId?: string;
                    appName?: string;
                    authConfig?: {
                        base_url?: string;
                        client_id?: string;
                        client_secret?: string;
                    };
                    authScheme?: string;
                    createdAt?: string;
                    enabled?: boolean;
                    expectedInputFields?: {
                        [key: string]: unknown;
                    }[];
                    id?: string;
                    logo?: string;
                    name?: string;
                    updatedAt?: string;
                };
                404: unknown;
            };
        };
        patch: {
            req: UpdateIntegrationData;
            res: {
                200: {
                    status?: string;
                };
                404: unknown;
            };
        };
    };
    /v1/triggers: {
        get: {
            req: ListTriggersData;
            res: {
                200: {
                    appId?: string;
                    appKey?: string;
                    appName?: string;
                    config?: {
                        properties?: {
                            description?: string;
                            required?: string[];
                            title?: string;
                            type?: string;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                    count?: number;
                    description?: string;
                    display_name?: string;
                    enabled?: boolean;
                    instructions?: string;
                    logo?: string;
                    name?: string;
                    payload?: {
                        properties?: {
                            author: string;
                            id: string;
                            message: string;
                            timestamp: string;
                            url: string;
                        };
                    };
                }[];
            };
        };
    };
    /v1/triggers/active_triggers: {
        get: {
            req: ListActiveTriggersData;
            res: {
                200: {
                    pageInfo?: {
                        currentPage?: number;
                        perPage?: number;
                        totalPages?: number;
                    };
                    triggers?: {
                        connectionId?: string;
                        createdAt?: string;
                        disabledAt?: string;
                        id?: string;
                        state?: {
                            [key: string]: unknown;
                        };
                        triggerConfig?: {
                            [key: string]: unknown;
                        };
                        triggerData?: string;
                        triggerName?: string;
                        updatedAt?: string;
                    }[];
                };
            };
        };
    };
    /v1/triggers/get/{triggerId}: {
        get: {
            req: GetActiveTriggerData;
            res: {
                200: {
                    connectionId?: string;
                    createdAt?: string;
                    disabledAt?: string;
                    id?: string;
                    state?: {
                        [key: string]: unknown;
                    };
                    triggerConfig?: {
                        [key: string]: unknown;
                    };
                    triggerData?: string;
                    triggerName?: string;
                    updatedAt?: string;
                };
                404: unknown;
                500: unknown;
            };
        };
    };
    /v2/actions: {
        get: {
            req: GetListActionsData;
            res: {
                200: {
                    items?: {
                        appId?: string;
                        appName?: string;
                        description?: string;
                        display_name?: string;
                        enabled?: boolean;
                        logo?: string;
                        name?: string;
                        parameters?: {
                            properties?: {
                                [key: string]: unknown;
                            };
                            required?: string[];
                            title?: string;
                            type?: string;
                        };
                        response?: {
                            properties?: {
                                [key: string]: unknown;
                            };
                            required?: string[];
                            title?: string;
                            type?: string;
                        };
                    }[];
                    page?: number;
                    totalPages?: number;
                };
            };
        };
    };
}

Type declaration

  • /v1/actions/{actionName}: {
        get: {
            req: GetActionData;
            res: {
                200: {
                    appId?: string;
                    appName?: string;
                    description?: string;
                    display_name?: string;
                    enabled?: boolean;
                    logo?: string;
                    name?: string;
                    parameters?: {
                        properties?: {
                            [key: string]: unknown;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                    response?: {
                        properties?: {
                            [key: string]: unknown;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                };
                404: unknown;
            };
        };
    }
    • get: {
          req: GetActionData;
          res: {
              200: {
                  appId?: string;
                  appName?: string;
                  description?: string;
                  display_name?: string;
                  enabled?: boolean;
                  logo?: string;
                  name?: string;
                  parameters?: {
                      properties?: {
                          [key: string]: unknown;
                      };
                      required?: string[];
                      title?: string;
                      type?: string;
                  };
                  response?: {
                      properties?: {
                          [key: string]: unknown;
                      };
                      required?: string[];
                      title?: string;
                      type?: string;
                  };
              };
              404: unknown;
          };
      }
      • req: GetActionData
      • res: {
            200: {
                appId?: string;
                appName?: string;
                description?: string;
                display_name?: string;
                enabled?: boolean;
                logo?: string;
                name?: string;
                parameters?: {
                    properties?: {
                        [key: string]: unknown;
                    };
                    required?: string[];
                    title?: string;
                    type?: string;
                };
                response?: {
                    properties?: {
                        [key: string]: unknown;
                    };
                    required?: string[];
                    title?: string;
                    type?: string;
                };
            };
            404: unknown;
        }
        • 200: {
              appId?: string;
              appName?: string;
              description?: string;
              display_name?: string;
              enabled?: boolean;
              logo?: string;
              name?: string;
              parameters?: {
                  properties?: {
                      [key: string]: unknown;
                  };
                  required?: string[];
                  title?: string;
                  type?: string;
              };
              response?: {
                  properties?: {
                      [key: string]: unknown;
                  };
                  required?: string[];
                  title?: string;
                  type?: string;
              };
          }

          OK

          +
          • Optional appId?: string

            The unique identifier of the app associated with the action.

            +
          • Optional appName?: string

            The name of the app associated with the action.

            +
          • Optional description?: string

            A description of the action.

            +
          • Optional display_name?: string

            The display name of the action.

            +
          • Optional enabled?: boolean

            A boolean indicating whether the action is enabled or not.

            +
          • Optional logo?: string

            The URL of the logo of the app associated with the action.

            +
          • Optional name?: string

            The name of the action.

            +
          • Optional parameters?: {
                properties?: {
                    [key: string]: unknown;
                };
                required?: string[];
                title?: string;
                type?: string;
            }

            An object describing the input parameters of the action.

            +
            • Optional properties?: {
                  [key: string]: unknown;
              }

              An object containing the properties of the input parameters.

              +
              • [key: string]: unknown
            • Optional required?: string[]

              An array of required parameter names.

              +
            • Optional title?: string

              The title of the input parameters.

              +
            • Optional type?: string

              The type of the input parameters (e.g., "object").

              +
          • Optional response?: {
                properties?: {
                    [key: string]: unknown;
                };
                required?: string[];
                title?: string;
                type?: string;
            }

            An object describing the response of the action.

            +
            • Optional properties?: {
                  [key: string]: unknown;
              }

              An object containing the properties of the response.

              +
              • [key: string]: unknown
            • Optional required?: string[]

              An array of required response field names.

              +
            • Optional title?: string

              The title of the response.

              +
            • Optional type?: string

              The type of the response (e.g., "object").

              +
        • 404: unknown

          Not Found

          +
  • /v1/actions/{actionName}/execute: {
        post: {
            req: ExecuteActionData;
            res: {
                200: {
                    execution_details?: {
                        executed?: boolean;
                    };
                    response_data?: {
                        [key: string]: unknown;
                    };
                };
                404: unknown;
            };
        };
    }
    • post: {
          req: ExecuteActionData;
          res: {
              200: {
                  execution_details?: {
                      executed?: boolean;
                  };
                  response_data?: {
                      [key: string]: unknown;
                  };
              };
              404: unknown;
          };
      }
      • req: ExecuteActionData
      • res: {
            200: {
                execution_details?: {
                    executed?: boolean;
                };
                response_data?: {
                    [key: string]: unknown;
                };
            };
            404: unknown;
        }
        • 200: {
              execution_details?: {
                  executed?: boolean;
              };
              response_data?: {
                  [key: string]: unknown;
              };
          }

          OK

          +
          • Optional execution_details?: {
                executed?: boolean;
            }

            An object containing the details of the action execution.

            +
            • Optional executed?: boolean

              A boolean indicating whether the action was executed successfully.

              +
          • Optional response_data?: {
                [key: string]: unknown;
            }

            An object containing the response data from the action execution.

            +
            • [key: string]: unknown
        • 404: unknown

          Not Found

          +
  • /v1/apps: {
        get: {
            res: {
                200: {
                    items?: {
                        appId?: string;
                        categories?: string[];
                        description?: string;
                        key?: string;
                        logo?: string;
                        name?: string;
                    }[];
                };
            };
        };
    }
    • get: {
          res: {
              200: {
                  items?: {
                      appId?: string;
                      categories?: string[];
                      description?: string;
                      key?: string;
                      logo?: string;
                      name?: string;
                  }[];
              };
          };
      }
      • res: {
            200: {
                items?: {
                    appId?: string;
                    categories?: string[];
                    description?: string;
                    key?: string;
                    logo?: string;
                    name?: string;
                }[];
            };
        }
        • 200: {
              items?: {
                  appId?: string;
                  categories?: string[];
                  description?: string;
                  key?: string;
                  logo?: string;
                  name?: string;
              }[];
          }

          OK

          +
          • Optional items?: {
                appId?: string;
                categories?: string[];
                description?: string;
                key?: string;
                logo?: string;
                name?: string;
            }[]

            An array of app objects.

            +
  • /v1/connectedAccounts: {
        get: {
            req: ListAllConnectionsData;
            res: {
                200: {
                    items?: {
                        appName?: string;
                        connectionParams?: {
                            access_token?: string;
                            base_url?: string;
                            bot_id?: string;
                            client_id?: string;
                            client_secret?: string;
                            created_at?: number;
                            duplicated_template_id?: string;
                            expires_in?: number;
                            organization?: string;
                            owner?: {
                                type?: string;
                                user?: {
                                    avatar_url?: ...;
                                    id?: ...;
                                    name?: ...;
                                    object?: ...;
                                    person?: ...;
                                    type?: ...;
                                };
                            } | string;
                            refresh_token?: string;
                            request_id?: string;
                            scope?: string;
                            token_type?: string;
                            workspace_icon?: string;
                            workspace_id?: string;
                            workspace_name?: string;
                        };
                        connectorId?: string;
                        createdAt?: string;
                        id?: string;
                        logo?: string;
                        status?: "FAILED" | "INITIATED" | "ACTIVE";
                        updatedAt?: string;
                    }[];
                    page?: number;
                    totalPages?: number;
                };
            };
        };
        post: {
            req: CreateConnectionData;
            res: {
                200: {
                    connectionId?: string;
                    connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
                    redirectUrl?: string;
                };
                404: unknown;
            };
        };
    }
    • get: {
          req: ListAllConnectionsData;
          res: {
              200: {
                  items?: {
                      appName?: string;
                      connectionParams?: {
                          access_token?: string;
                          base_url?: string;
                          bot_id?: string;
                          client_id?: string;
                          client_secret?: string;
                          created_at?: number;
                          duplicated_template_id?: string;
                          expires_in?: number;
                          organization?: string;
                          owner?: {
                              type?: string;
                              user?: {
                                  avatar_url?: ...;
                                  id?: ...;
                                  name?: ...;
                                  object?: ...;
                                  person?: ...;
                                  type?: ...;
                              };
                          } | string;
                          refresh_token?: string;
                          request_id?: string;
                          scope?: string;
                          token_type?: string;
                          workspace_icon?: string;
                          workspace_id?: string;
                          workspace_name?: string;
                      };
                      connectorId?: string;
                      createdAt?: string;
                      id?: string;
                      logo?: string;
                      status?: "FAILED" | "INITIATED" | "ACTIVE";
                      updatedAt?: string;
                  }[];
                  page?: number;
                  totalPages?: number;
              };
          };
      }
      • req: ListAllConnectionsData
      • res: {
            200: {
                items?: {
                    appName?: string;
                    connectionParams?: {
                        access_token?: string;
                        base_url?: string;
                        bot_id?: string;
                        client_id?: string;
                        client_secret?: string;
                        created_at?: number;
                        duplicated_template_id?: string;
                        expires_in?: number;
                        organization?: string;
                        owner?: {
                            type?: string;
                            user?: {
                                avatar_url?: ...;
                                id?: ...;
                                name?: ...;
                                object?: ...;
                                person?: ...;
                                type?: ...;
                            };
                        } | string;
                        refresh_token?: string;
                        request_id?: string;
                        scope?: string;
                        token_type?: string;
                        workspace_icon?: string;
                        workspace_id?: string;
                        workspace_name?: string;
                    };
                    connectorId?: string;
                    createdAt?: string;
                    id?: string;
                    logo?: string;
                    status?: "FAILED" | "INITIATED" | "ACTIVE";
                    updatedAt?: string;
                }[];
                page?: number;
                totalPages?: number;
            };
        }
        • 200: {
              items?: {
                  appName?: string;
                  connectionParams?: {
                      access_token?: string;
                      base_url?: string;
                      bot_id?: string;
                      client_id?: string;
                      client_secret?: string;
                      created_at?: number;
                      duplicated_template_id?: string;
                      expires_in?: number;
                      organization?: string;
                      owner?: {
                          type?: string;
                          user?: {
                              avatar_url?: ...;
                              id?: ...;
                              name?: ...;
                              object?: ...;
                              person?: ...;
                              type?: ...;
                          };
                      } | string;
                      refresh_token?: string;
                      request_id?: string;
                      scope?: string;
                      token_type?: string;
                      workspace_icon?: string;
                      workspace_id?: string;
                      workspace_name?: string;
                  };
                  connectorId?: string;
                  createdAt?: string;
                  id?: string;
                  logo?: string;
                  status?: "FAILED" | "INITIATED" | "ACTIVE";
                  updatedAt?: string;
              }[];
              page?: number;
              totalPages?: number;
          }

          OK

          +
          • Optional items?: {
                appName?: string;
                connectionParams?: {
                    access_token?: string;
                    base_url?: string;
                    bot_id?: string;
                    client_id?: string;
                    client_secret?: string;
                    created_at?: number;
                    duplicated_template_id?: string;
                    expires_in?: number;
                    organization?: string;
                    owner?: {
                        type?: string;
                        user?: {
                            avatar_url?: ...;
                            id?: ...;
                            name?: ...;
                            object?: ...;
                            person?: ...;
                            type?: ...;
                        };
                    } | string;
                    refresh_token?: string;
                    request_id?: string;
                    scope?: string;
                    token_type?: string;
                    workspace_icon?: string;
                    workspace_id?: string;
                    workspace_name?: string;
                };
                connectorId?: string;
                createdAt?: string;
                id?: string;
                logo?: string;
                status?: "FAILED" | "INITIATED" | "ACTIVE";
                updatedAt?: string;
            }[]
          • Optional page?: number
          • Optional totalPages?: number
    • post: {
          req: CreateConnectionData;
          res: {
              200: {
                  connectionId?: string;
                  connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
                  redirectUrl?: string;
              };
              404: unknown;
          };
      }
      • req: CreateConnectionData
      • res: {
            200: {
                connectionId?: string;
                connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
                redirectUrl?: string;
            };
            404: unknown;
        }
        • 200: {
              connectionId?: string;
              connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
              redirectUrl?: string;
          }

          OK

          +
          • Optional connectionId?: string
          • Optional connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED"
          • Optional redirectUrl?: string
        • 404: unknown

          { +"message": "Connector not found" +}

          +
  • /v1/connectedAccounts/{connectedAccountId}: {
        delete: {
            req: DeleteConnectionData;
            res: {
                200: {
                    status?: string;
                };
                404: unknown;
            };
        };
        get: {
            req: GetConnectedAccountData;
            res: {
                200: {
                    connectionParams?: {
                        access_token?: string;
                        base_url?: string;
                        client_id?: string;
                        client_secret?: string;
                        scope?: string;
                        token_type?: string;
                    };
                    createdAt?: string;
                    id?: string;
                    integrationId?: string;
                    status?: "ACTIVE" | "INITIATED" | "FAILED";
                    updatedAt?: string;
                };
                404: unknown;
            };
        };
    }
    • delete: {
          req: DeleteConnectionData;
          res: {
              200: {
                  status?: string;
              };
              404: unknown;
          };
      }
      • req: DeleteConnectionData
      • res: {
            200: {
                status?: string;
            };
            404: unknown;
        }
        • 200: {
              status?: string;
          }

          { +"message": "Connection not found or already deleted" +}

          +
          • Optional status?: string

            Status of the api call.

            +
        • 404: unknown

          Not Found

          +
    • get: {
          req: GetConnectedAccountData;
          res: {
              200: {
                  connectionParams?: {
                      access_token?: string;
                      base_url?: string;
                      client_id?: string;
                      client_secret?: string;
                      scope?: string;
                      token_type?: string;
                  };
                  createdAt?: string;
                  id?: string;
                  integrationId?: string;
                  status?: "ACTIVE" | "INITIATED" | "FAILED";
                  updatedAt?: string;
              };
              404: unknown;
          };
      }
      • req: GetConnectedAccountData
      • res: {
            200: {
                connectionParams?: {
                    access_token?: string;
                    base_url?: string;
                    client_id?: string;
                    client_secret?: string;
                    scope?: string;
                    token_type?: string;
                };
                createdAt?: string;
                id?: string;
                integrationId?: string;
                status?: "ACTIVE" | "INITIATED" | "FAILED";
                updatedAt?: string;
            };
            404: unknown;
        }
        • 200: {
              connectionParams?: {
                  access_token?: string;
                  base_url?: string;
                  client_id?: string;
                  client_secret?: string;
                  scope?: string;
                  token_type?: string;
              };
              createdAt?: string;
              id?: string;
              integrationId?: string;
              status?: "ACTIVE" | "INITIATED" | "FAILED";
              updatedAt?: string;
          }

          OK

          +
          • Optional connectionParams?: {
                access_token?: string;
                base_url?: string;
                client_id?: string;
                client_secret?: string;
                scope?: string;
                token_type?: string;
            }

            An object containing the parameters specific to the connection.

            +
            • Optional access_token?: string

              The access token used for authentication with the connected app.

              +
            • Optional base_url?: string

              The base URL for making API requests to the connected app.

              +
            • Optional client_id?: string

              The client ID used for authentication with the connected app.

              +
            • Optional client_secret?: string

              The client secret used for authentication with the connected app.

              +
            • Optional scope?: string

              The scope of permissions granted to the connection.

              +
            • Optional token_type?: string

              The type of token used for authentication (e.g., "bearer").

              +
          • Optional createdAt?: string

            The timestamp indicating when the connection was created.

            +
          • Optional id?: string

            The unique identifier of the connection.

            +
          • Optional integrationId?: string

            The unique identifier of the connector associated with the connection.

            +
          • Optional status?: "ACTIVE" | "INITIATED" | "FAILED"

            The status of the connection (e.g., "SUCCESS").

            +
          • Optional updatedAt?: string

            The timestamp indicating when the connection was last updated.

            +
        • 404: unknown

          { +"message": "Connection not found or already deleted" +}

          +
  • /v1/integrations: {
        get: {
            req: ListAllIntegrationsData;
            res: {
                200: {
                    items?: {
                        appId?: string;
                        appName?: string;
                        authScheme?: string;
                        createdAt?: string;
                        enabled?: boolean;
                        id?: string;
                        logo?: string;
                        name?: string;
                        updatedAt?: string;
                    }[];
                    page?: number;
                    totalPages?: number;
                };
            };
        };
        post: {
            req: CreateIntegrationData;
            res: {
                200: {
                    appId?: string;
                    appName?: string;
                    authConfig?: {
                        base_url?: string;
                        client_id?: string;
                        client_secret?: string;
                    };
                    authScheme?: string;
                    createdAt?: string;
                    enabled?: boolean;
                    expectedInputFields?: {
                        [key: string]: unknown;
                    }[];
                    id?: string;
                    logo?: string;
                    name?: string;
                    updatedAt?: string;
                };
                400: unknown;
            };
        };
    }
    • get: {
          req: ListAllIntegrationsData;
          res: {
              200: {
                  items?: {
                      appId?: string;
                      appName?: string;
                      authScheme?: string;
                      createdAt?: string;
                      enabled?: boolean;
                      id?: string;
                      logo?: string;
                      name?: string;
                      updatedAt?: string;
                  }[];
                  page?: number;
                  totalPages?: number;
              };
          };
      }
      • req: ListAllIntegrationsData
      • res: {
            200: {
                items?: {
                    appId?: string;
                    appName?: string;
                    authScheme?: string;
                    createdAt?: string;
                    enabled?: boolean;
                    id?: string;
                    logo?: string;
                    name?: string;
                    updatedAt?: string;
                }[];
                page?: number;
                totalPages?: number;
            };
        }
        • 200: {
              items?: {
                  appId?: string;
                  appName?: string;
                  authScheme?: string;
                  createdAt?: string;
                  enabled?: boolean;
                  id?: string;
                  logo?: string;
                  name?: string;
                  updatedAt?: string;
              }[];
              page?: number;
              totalPages?: number;
          }

          OK

          +
          • Optional items?: {
                appId?: string;
                appName?: string;
                authScheme?: string;
                createdAt?: string;
                enabled?: boolean;
                id?: string;
                logo?: string;
                name?: string;
                updatedAt?: string;
            }[]
          • Optional page?: number
          • Optional totalPages?: number
    • post: {
          req: CreateIntegrationData;
          res: {
              200: {
                  appId?: string;
                  appName?: string;
                  authConfig?: {
                      base_url?: string;
                      client_id?: string;
                      client_secret?: string;
                  };
                  authScheme?: string;
                  createdAt?: string;
                  enabled?: boolean;
                  expectedInputFields?: {
                      [key: string]: unknown;
                  }[];
                  id?: string;
                  logo?: string;
                  name?: string;
                  updatedAt?: string;
              };
              400: unknown;
          };
      }
      • req: CreateIntegrationData
      • res: {
            200: {
                appId?: string;
                appName?: string;
                authConfig?: {
                    base_url?: string;
                    client_id?: string;
                    client_secret?: string;
                };
                authScheme?: string;
                createdAt?: string;
                enabled?: boolean;
                expectedInputFields?: {
                    [key: string]: unknown;
                }[];
                id?: string;
                logo?: string;
                name?: string;
                updatedAt?: string;
            };
            400: unknown;
        }
        • 200: {
              appId?: string;
              appName?: string;
              authConfig?: {
                  base_url?: string;
                  client_id?: string;
                  client_secret?: string;
              };
              authScheme?: string;
              createdAt?: string;
              enabled?: boolean;
              expectedInputFields?: {
                  [key: string]: unknown;
              }[];
              id?: string;
              logo?: string;
              name?: string;
              updatedAt?: string;
          }

          OK

          +
          • Optional appId?: string

            The unique identifier of the app associated with the connector.

            +
          • Optional appName?: string

            The name of the app associated with the connector.

            +
          • Optional authConfig?: {
                base_url?: string;
                client_id?: string;
                client_secret?: string;
            }

            An object containing the authentication configuration for the connector.

            +
            • Optional base_url?: string

              The base URL for making API requests to the app.

              +
            • Optional client_id?: string

              The client ID used for authentication with the app.

              +
            • Optional client_secret?: string

              The client secret used for authentication with the app.

              +
          • Optional authScheme?: string

            The authentication scheme used by the connector.

            +
          • Optional createdAt?: string

            The timestamp indicating when the connector was created.

            +
          • Optional enabled?: boolean

            A boolean indicating whether the connector is enabled or not.

            +
          • Optional expectedInputFields?: {
                [key: string]: unknown;
            }[]

            An array of input fields expected by the connector.

            +
          • Optional id?: string

            The unique identifier of the newly created connector.

            +
          • Optional logo?: string

            The URL of the logo of the app associated with the connector.

            +
          • Optional name?: string

            The name of the connector.

            +
          • Optional updatedAt?: string

            The timestamp indicating when the connector was last updated.

            +
        • 400: unknown

          Bad Request

          +
  • /v1/integrations/{integrationId}: {
        get: {
            req: GetIntegrationData;
            res: {
                200: {
                    appId?: string;
                    appName?: string;
                    authConfig?: {
                        base_url?: string;
                        client_id?: string;
                        client_secret?: string;
                    };
                    authScheme?: string;
                    createdAt?: string;
                    enabled?: boolean;
                    expectedInputFields?: {
                        [key: string]: unknown;
                    }[];
                    id?: string;
                    logo?: string;
                    name?: string;
                    updatedAt?: string;
                };
                404: unknown;
            };
        };
        patch: {
            req: UpdateIntegrationData;
            res: {
                200: {
                    status?: string;
                };
                404: unknown;
            };
        };
    }
    • get: {
          req: GetIntegrationData;
          res: {
              200: {
                  appId?: string;
                  appName?: string;
                  authConfig?: {
                      base_url?: string;
                      client_id?: string;
                      client_secret?: string;
                  };
                  authScheme?: string;
                  createdAt?: string;
                  enabled?: boolean;
                  expectedInputFields?: {
                      [key: string]: unknown;
                  }[];
                  id?: string;
                  logo?: string;
                  name?: string;
                  updatedAt?: string;
              };
              404: unknown;
          };
      }
      • req: GetIntegrationData
      • res: {
            200: {
                appId?: string;
                appName?: string;
                authConfig?: {
                    base_url?: string;
                    client_id?: string;
                    client_secret?: string;
                };
                authScheme?: string;
                createdAt?: string;
                enabled?: boolean;
                expectedInputFields?: {
                    [key: string]: unknown;
                }[];
                id?: string;
                logo?: string;
                name?: string;
                updatedAt?: string;
            };
            404: unknown;
        }
        • 200: {
              appId?: string;
              appName?: string;
              authConfig?: {
                  base_url?: string;
                  client_id?: string;
                  client_secret?: string;
              };
              authScheme?: string;
              createdAt?: string;
              enabled?: boolean;
              expectedInputFields?: {
                  [key: string]: unknown;
              }[];
              id?: string;
              logo?: string;
              name?: string;
              updatedAt?: string;
          }

          OK

          +
          • Optional appId?: string

            The unique identifier of the app associated with the connector.

            +
          • Optional appName?: string

            The name of the app associated with the connector.

            +
          • Optional authConfig?: {
                base_url?: string;
                client_id?: string;
                client_secret?: string;
            }

            An object containing the authentication configuration for the connector.

            +
            • Optional base_url?: string

              The base URL for making API requests to the app.

              +
            • Optional client_id?: string

              The client ID used for authentication with the app.

              +
            • Optional client_secret?: string

              The client secret used for authentication with the app.

              +
          • Optional authScheme?: string

            The authentication scheme used by the connector (e.g., "OAUTH2", "API_KEY").

            +
          • Optional createdAt?: string

            The timestamp indicating when the connector was created.

            +
          • Optional enabled?: boolean

            A boolean indicating whether the connector is enabled or not.

            +
          • Optional expectedInputFields?: {
                [key: string]: unknown;
            }[]

            An array of input fields expected by the connector.

            +
          • Optional id?: string

            The unique identifier of the connector.

            +
          • Optional logo?: string

            The URL of the logo of the app associated with the connector.

            +
          • Optional name?: string

            The name of the connector.

            +
          • Optional updatedAt?: string

            The timestamp indicating when the connector was last updated.

            +
        • 404: unknown

          Not Found

          +
    • patch: {
          req: UpdateIntegrationData;
          res: {
              200: {
                  status?: string;
              };
              404: unknown;
          };
      }
      • req: UpdateIntegrationData
      • res: {
            200: {
                status?: string;
            };
            404: unknown;
        }
        • 200: {
              status?: string;
          }

          OK

          +
          • Optional status?: string
        • 404: unknown

          Not Found

          +
  • /v1/triggers: {
        get: {
            req: ListTriggersData;
            res: {
                200: {
                    appId?: string;
                    appKey?: string;
                    appName?: string;
                    config?: {
                        properties?: {
                            description?: string;
                            required?: string[];
                            title?: string;
                            type?: string;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                    count?: number;
                    description?: string;
                    display_name?: string;
                    enabled?: boolean;
                    instructions?: string;
                    logo?: string;
                    name?: string;
                    payload?: {
                        properties?: {
                            author: string;
                            id: string;
                            message: string;
                            timestamp: string;
                            url: string;
                        };
                    };
                }[];
            };
        };
    }
    • get: {
          req: ListTriggersData;
          res: {
              200: {
                  appId?: string;
                  appKey?: string;
                  appName?: string;
                  config?: {
                      properties?: {
                          description?: string;
                          required?: string[];
                          title?: string;
                          type?: string;
                      };
                      required?: string[];
                      title?: string;
                      type?: string;
                  };
                  count?: number;
                  description?: string;
                  display_name?: string;
                  enabled?: boolean;
                  instructions?: string;
                  logo?: string;
                  name?: string;
                  payload?: {
                      properties?: {
                          author: string;
                          id: string;
                          message: string;
                          timestamp: string;
                          url: string;
                      };
                  };
              }[];
          };
      }
      • req: ListTriggersData
      • res: {
            200: {
                appId?: string;
                appKey?: string;
                appName?: string;
                config?: {
                    properties?: {
                        description?: string;
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                    required?: string[];
                    title?: string;
                    type?: string;
                };
                count?: number;
                description?: string;
                display_name?: string;
                enabled?: boolean;
                instructions?: string;
                logo?: string;
                name?: string;
                payload?: {
                    properties?: {
                        author: string;
                        id: string;
                        message: string;
                        timestamp: string;
                        url: string;
                    };
                };
            }[];
        }
        • 200: {
              appId?: string;
              appKey?: string;
              appName?: string;
              config?: {
                  properties?: {
                      description?: string;
                      required?: string[];
                      title?: string;
                      type?: string;
                  };
                  required?: string[];
                  title?: string;
                  type?: string;
              };
              count?: number;
              description?: string;
              display_name?: string;
              enabled?: boolean;
              instructions?: string;
              logo?: string;
              name?: string;
              payload?: {
                  properties?: {
                      author: string;
                      id: string;
                      message: string;
                      timestamp: string;
                      url: string;
                  };
              };
          }[]

          OK

          +
  • /v1/triggers/active_triggers: {
        get: {
            req: ListActiveTriggersData;
            res: {
                200: {
                    pageInfo?: {
                        currentPage?: number;
                        perPage?: number;
                        totalPages?: number;
                    };
                    triggers?: {
                        connectionId?: string;
                        createdAt?: string;
                        disabledAt?: string;
                        id?: string;
                        state?: {
                            [key: string]: unknown;
                        };
                        triggerConfig?: {
                            [key: string]: unknown;
                        };
                        triggerData?: string;
                        triggerName?: string;
                        updatedAt?: string;
                    }[];
                };
            };
        };
    }
    • get: {
          req: ListActiveTriggersData;
          res: {
              200: {
                  pageInfo?: {
                      currentPage?: number;
                      perPage?: number;
                      totalPages?: number;
                  };
                  triggers?: {
                      connectionId?: string;
                      createdAt?: string;
                      disabledAt?: string;
                      id?: string;
                      state?: {
                          [key: string]: unknown;
                      };
                      triggerConfig?: {
                          [key: string]: unknown;
                      };
                      triggerData?: string;
                      triggerName?: string;
                      updatedAt?: string;
                  }[];
              };
          };
      }
      • req: ListActiveTriggersData
      • res: {
            200: {
                pageInfo?: {
                    currentPage?: number;
                    perPage?: number;
                    totalPages?: number;
                };
                triggers?: {
                    connectionId?: string;
                    createdAt?: string;
                    disabledAt?: string;
                    id?: string;
                    state?: {
                        [key: string]: unknown;
                    };
                    triggerConfig?: {
                        [key: string]: unknown;
                    };
                    triggerData?: string;
                    triggerName?: string;
                    updatedAt?: string;
                }[];
            };
        }
        • 200: {
              pageInfo?: {
                  currentPage?: number;
                  perPage?: number;
                  totalPages?: number;
              };
              triggers?: {
                  connectionId?: string;
                  createdAt?: string;
                  disabledAt?: string;
                  id?: string;
                  state?: {
                      [key: string]: unknown;
                  };
                  triggerConfig?: {
                      [key: string]: unknown;
                  };
                  triggerData?: string;
                  triggerName?: string;
                  updatedAt?: string;
              }[];
          }

          A list of active triggers

          +
          • Optional pageInfo?: {
                currentPage?: number;
                perPage?: number;
                totalPages?: number;
            }
            • Optional currentPage?: number

              The current page number.

              +
            • Optional perPage?: number

              The number of items per page.

              +
            • Optional totalPages?: number

              The total number of pages.

              +
          • Optional triggers?: {
                connectionId?: string;
                createdAt?: string;
                disabledAt?: string;
                id?: string;
                state?: {
                    [key: string]: unknown;
                };
                triggerConfig?: {
                    [key: string]: unknown;
                };
                triggerData?: string;
                triggerName?: string;
                updatedAt?: string;
            }[]
  • /v1/triggers/get/{triggerId}: {
        get: {
            req: GetActiveTriggerData;
            res: {
                200: {
                    connectionId?: string;
                    createdAt?: string;
                    disabledAt?: string;
                    id?: string;
                    state?: {
                        [key: string]: unknown;
                    };
                    triggerConfig?: {
                        [key: string]: unknown;
                    };
                    triggerData?: string;
                    triggerName?: string;
                    updatedAt?: string;
                };
                404: unknown;
                500: unknown;
            };
        };
    }
    • get: {
          req: GetActiveTriggerData;
          res: {
              200: {
                  connectionId?: string;
                  createdAt?: string;
                  disabledAt?: string;
                  id?: string;
                  state?: {
                      [key: string]: unknown;
                  };
                  triggerConfig?: {
                      [key: string]: unknown;
                  };
                  triggerData?: string;
                  triggerName?: string;
                  updatedAt?: string;
              };
              404: unknown;
              500: unknown;
          };
      }
      • req: GetActiveTriggerData
      • res: {
            200: {
                connectionId?: string;
                createdAt?: string;
                disabledAt?: string;
                id?: string;
                state?: {
                    [key: string]: unknown;
                };
                triggerConfig?: {
                    [key: string]: unknown;
                };
                triggerData?: string;
                triggerName?: string;
                updatedAt?: string;
            };
            404: unknown;
            500: unknown;
        }
        • 200: {
              connectionId?: string;
              createdAt?: string;
              disabledAt?: string;
              id?: string;
              state?: {
                  [key: string]: unknown;
              };
              triggerConfig?: {
                  [key: string]: unknown;
              };
              triggerData?: string;
              triggerName?: string;
              updatedAt?: string;
          }

          A successful response containing the details of the active trigger.

          +
          • Optional connectionId?: string

            Identifier for the connection associated with the trigger.

            +
          • Optional createdAt?: string

            Timestamp when the trigger was created.

            +
          • Optional disabledAt?: string

            Timestamp when the trigger was disabled, if applicable.

            +
          • Optional id?: string

            Unique identifier for the trigger.

            +
          • Optional state?: {
                [key: string]: unknown;
            }

            State information for the trigger.

            +
            • [key: string]: unknown
          • Optional triggerConfig?: {
                [key: string]: unknown;
            }

            Configuration settings for the trigger.

            +
            • [key: string]: unknown
          • Optional triggerData?: string

            Data associated with the trigger.

            +
          • Optional triggerName?: string

            Name of the trigger.

            +
          • Optional updatedAt?: string

            Timestamp when the trigger was last updated.

            +
        • 404: unknown

          Trigger not found

          +
        • 500: unknown

          Internal server error

          +
  • /v2/actions: {
        get: {
            req: GetListActionsData;
            res: {
                200: {
                    items?: {
                        appId?: string;
                        appName?: string;
                        description?: string;
                        display_name?: string;
                        enabled?: boolean;
                        logo?: string;
                        name?: string;
                        parameters?: {
                            properties?: {
                                [key: string]: unknown;
                            };
                            required?: string[];
                            title?: string;
                            type?: string;
                        };
                        response?: {
                            properties?: {
                                [key: string]: unknown;
                            };
                            required?: string[];
                            title?: string;
                            type?: string;
                        };
                    }[];
                    page?: number;
                    totalPages?: number;
                };
            };
        };
    }
    • get: {
          req: GetListActionsData;
          res: {
              200: {
                  items?: {
                      appId?: string;
                      appName?: string;
                      description?: string;
                      display_name?: string;
                      enabled?: boolean;
                      logo?: string;
                      name?: string;
                      parameters?: {
                          properties?: {
                              [key: string]: unknown;
                          };
                          required?: string[];
                          title?: string;
                          type?: string;
                      };
                      response?: {
                          properties?: {
                              [key: string]: unknown;
                          };
                          required?: string[];
                          title?: string;
                          type?: string;
                      };
                  }[];
                  page?: number;
                  totalPages?: number;
              };
          };
      }
      • req: GetListActionsData
      • res: {
            200: {
                items?: {
                    appId?: string;
                    appName?: string;
                    description?: string;
                    display_name?: string;
                    enabled?: boolean;
                    logo?: string;
                    name?: string;
                    parameters?: {
                        properties?: {
                            [key: string]: unknown;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                    response?: {
                        properties?: {
                            [key: string]: unknown;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                }[];
                page?: number;
                totalPages?: number;
            };
        }
        • 200: {
              items?: {
                  appId?: string;
                  appName?: string;
                  description?: string;
                  display_name?: string;
                  enabled?: boolean;
                  logo?: string;
                  name?: string;
                  parameters?: {
                      properties?: {
                          [key: string]: unknown;
                      };
                      required?: string[];
                      title?: string;
                      type?: string;
                  };
                  response?: {
                      properties?: {
                          [key: string]: unknown;
                      };
                      required?: string[];
                      title?: string;
                      type?: string;
                  };
              }[];
              page?: number;
              totalPages?: number;
          }

          OK

          +
          • Optional items?: {
                appId?: string;
                appName?: string;
                description?: string;
                display_name?: string;
                enabled?: boolean;
                logo?: string;
                name?: string;
                parameters?: {
                    properties?: {
                        [key: string]: unknown;
                    };
                    required?: string[];
                    title?: string;
                    type?: string;
                };
                response?: {
                    properties?: {
                        [key: string]: unknown;
                    };
                    required?: string[];
                    title?: string;
                    type?: string;
                };
            }[]

            An array of action objects.

            +
          • Optional page?: number

            The current page number of the action list.

            +
          • Optional totalPages?: number

            The total number of pages available for the action list.

            +

Settings

Member Visibility

Theme

\ No newline at end of file