Class Refold

constructor

• new Refold(options?: RefoldOptions): Refold

  Refold Frontend SDK

  Parameters

  • options: RefoldOptions = {}

    The options to configure the Refold SDK.

    • OptionalbaseUrl?: string

      The base URL of the Refold API. You don't need to set this.

    • Optionaltoken?: string

      The session token.

  Returns Refold

token

config

• config(payload: ConfigPayload): Promise<Config>

  Returns the specified config, or creates one if it doesn't exist.

  Parameters

  • payload: ConfigPayload

    The payload object for config.

  Returns Promise<Config>

  The specified config.

connect

• connect(params: ConnectParams): Promise<boolean>

  Connects the specified application using the provided authentication type and optional auth data.

  Parameters

  • params: ConnectParams

    The parameters for connecting the application.

    Which credentials a connect uses, and what to store against the connection.

    • OptionalauthProfileId?: string

      The credential set to connect with, from an application's auth profiles. Omitted, the application's default profile is used.

    • OptionalautoClose?: boolean

      Whether to close the authentication window automatically once the connection succeeds or the wait times out.

    • OptionalconnectionId?: string

      An existing connection to re-authenticate instead of opening a new one.

    • OptionalgrantType?: GrantType

      The application's OAuth grant (from the app object). It no longer selects the transport — every connect is a POST and the server decides — but it still routes: Refold.connect sends a payload-bearing connect down the OAuth path rather than the key-based one when this names GrantType.ClientCredentials and no type was given. Pass type explicitly and it is not needed.

    • Optionalpayload?: Record<string, string>

      The key value pairs of auth data.

    • OptionalpreRequisiteFields?: Record<string, unknown>

      Values the application requires before it can be connected. Read by applications on auth profiles and by connectors; other native applications take theirs as flat keys in payload.

    • Optionalsignal?: AbortSignal

      Signal used to give up on an in-progress authentication — abort it and the returned promise resolves false. Providers that sever the authentication window's handle make an abandoned flow undetectable, so this is the only way to end such a wait before the timeout.

    • slug: string

      The application slug.

    • Optionaltimeout?: number

      Maximum time in milliseconds to wait for authentication before giving up. Set to 0 to wait indefinitely. Defaults to 3 minutes.

    • Optionaltype?: AuthType | ConnectorAuthType

      The authentication type to use — an AuthType for native applications, or one of a universal connector's own types (a key of Application.auth_type_options). If not provided, it defaults to keybased when a payload is given, otherwise oauth2.

    • OptionaluserDefinedFields?: Record<string, unknown>

      Caller metadata to store against the connection.

  Returns Promise<boolean>

  A promise that resolves to true if the connection was successful, otherwise false.

  Throws

  Throws an error if the authentication type is invalid or the connection fails.

createWorkflow

• createWorkflow(params: PublicWorkflowPayload): Promise<PublicWorkflow>

  Create a public workflow for the linked account.

  Parameters

  • params: PublicWorkflowPayload

    The payload for creating a public workflow for the linked account.

    • Optionaldescription?: string

      The workflow description.

    • name: string

      The workflow name.

    • Optionalslug?: string

      The application slug in which this workflow should be created.

  Returns Promise<PublicWorkflow>

  The created public workflow.

deleteConfig

• deleteConfig(
      slug: string,
      configId?: string,
      opts?: ConnectionScoped,
  ): Promise<unknown>

  Delete the specified config.

  Parameters

  • slug: string

    The application slug.

  • OptionalconfigId: string

    The unique ID of the config.

  • Optionalopts: ConnectionScoped = {}

    Names the connection whose config this acts on.

  Returns Promise<unknown>

deleteConfigField

• deleteConfigField(
      slug: string,
      fieldId: string,
      workflowId?: string,
      opts?: ConnectionScoped,
  ): Promise<unknown>

  Delete the specified config field value.

  Parameters

  • slug: string

    The application slug.

  • fieldId: string

    The unique ID of the field.

  • OptionalworkflowId: string

    The unique ID of the workflow.

  • Optionalopts: ConnectionScoped = {}

    Names the connection whose config this acts on.

  Returns Promise<unknown>

deleteWorkflow

• deleteWorkflow(workflowId: string): Promise<unknown>

  Delete the specified public workflow.

  Parameters

  • workflowId: string

    The workflow ID.

  Returns Promise<unknown>

disconnect

• disconnect(
      slug: string,
      type?: AuthType,
      opts?: ConnectionScoped,
  ): Promise<unknown>

  Disconnect the specified application and remove any associated data from Refold.

  Parameters

  • slug: string

    The application slug.

  • Optionaltype: AuthType

    The authentication type to use. If not provided, it'll remove all the connected accounts.

  • Optionalopts: ConnectionScoped = {}

    Names the connection to revoke. Required where the application holds more than one; the server answers 400 rather than choosing.

  Returns Promise<unknown>

executeWorkflow

• executeWorkflow(options: ExecuteWorkflowPayload): Promise<unknown>

  Execute the specified public workflow.

  Parameters

  • options: ExecuteWorkflowPayload

    The execution payload.

    • Optionalconfig_id?: string

      The config to execute against.

    • Optionalconnection_id?: string

      The connection to authenticate the run through. One config_id can span several connections, so send both to name the config and the credentials.

    • Optionalpayload?: Record<string, any>

      The payload to execute the workflow.

    • Optionalslug?: string

      The application's slug this workflow belongs to.

    • Optionalsync_execution?: boolean

      Whether to execute the workflow synchronously.

    • worklfow: string

      The workflow id or alias.

  Returns Promise<unknown>

getApp

• getApp(): Promise<Application[]>

  Returns the list of enabled applications and their details.

  Returns Promise<Application[]>

  The list of applications.

• getApp(slug: string): Promise<Application>

  Returns the application details for the specified application, provided the application is enabled in Refold.

  Parameters

  • slug: string

    The application slug.

  Returns Promise<Application>

  The application details.

getApps

• getApps(): Promise<Application[]>

  Returns all the enabled apps.

  Returns Promise<Application[]>

  The list of applications.

getConfig

• getConfig(
      slug: string,
      configId?: string,
      excludeOptions?: boolean,
      opts?: ConnectionScoped,
  ): Promise<Config>

  Returns the specified config.

  Parameters

  • slug: string

    The application slug.

  • OptionalconfigId: string

    The unique ID of the config.

  • OptionalexcludeOptions: boolean

    Whether to exclude the options from the fields in the response.

  • Optionalopts: ConnectionScoped = {}

    Names the connection whose config this acts on.

  Returns Promise<Config>

  The specified config.

getConfigField

• getConfigField(
      slug: string,
      fieldId: string,
      workflowId?: string,
      payload?: Record<string, unknown>,
      opts?: ConnectionScoped,
  ): Promise<Config>

  Returns the specified field of the config.

  Parameters

  • slug: string

    The application slug.

  • fieldId: string

    The unique ID of the field.

  • OptionalworkflowId: string

    The unique ID of the workflow.

  • Optionalpayload: Record<string, unknown>

    The payload to be sent in the request body.

  • Optionalopts: ConnectionScoped = {}

    Names the connection whose config this acts on.

  Returns Promise<Config>

  The specified config field.

getConfigs

• getConfigs(
      slug: string,
      opts?: ConnectionScoped,
  ): Promise<{ config_id: string; connection_id?: string }[]>

  Returns the configs created for the specified application.

  Parameters

  • slug: string

    The application slug.

  • Optionalopts: ConnectionScoped = {}

    Narrows the result to one connection's configs.

  Returns Promise<{ config_id: string; connection_id?: string }[]>

  The configs created for the specified application.

getExecution

• getExecution(executionId: string): Promise<Execution>

  Returns the specified workflow execution log.

  Parameters

  • executionId: string

    The execution ID.

  Returns Promise<Execution>

  The specified execution log.

getExecutions

• getExecutions(
      params?: GetExecutionsParams,
  ): Promise<PaginatedResponse<Execution>>

  Returns the workflow execution logs for the linked account.

  Parameters

  • Optionalparams: GetExecutionsParams = {}

    Parameters for filtering and paginating the list of workflow executions.

    • [key: string]: string | number | undefined

      Any additional filter keys supported by the API.

    • Optionalend_date?: string

      Filter executions that started on or before this ISO 8601 date string.

    • Optionalexecution_source?: ExecutionSource

      Filter by the trigger source that initiated the execution.

    • Optionalexecution_type?: ExecutionType

      Filter by how the execution was invoked — synchronously or asynchronously.

    • Optionallimit?: number

    • Optionalpage?: number

    • Optionalstart_date?: string

      Filter executions that started on or after this ISO 8601 date string.

    • Optionalstatus?: ExecutionStatus

      Filter executions by their current status.

    • Optionalworkflow_id?: string

      Filter executions by workflow ID.

    • Optionalworkflow_name?: string

      Filter executions by workflow name (partial match).

  Returns Promise<PaginatedResponse<Execution>>

  The paginated workflow execution logs.

getFieldOptions

• getFieldOptions(
      lhs: string,
      slug: string,
      fieldId: string,
      workflowId?: string,
      opts?: ConnectionScoped,
  ): Promise<RuleOptions>

  Returns the options for the specified field.

  Parameters

  • lhs: string

    The selected value of the lhs field.

  • slug: string

    The application slug.

  • fieldId: string

    The unique ID of the field.

  • OptionalworkflowId: string

    The unique ID of the workflow, if this is a workflow field.

  • Optionalopts: ConnectionScoped = {}

    Names the connection whose config to resolve against.

  Returns Promise<RuleOptions>

  The specified rule field's options.

getWorkflowPayload

• getWorkflowPayload(workflowId: string): Promise<WorkflowPayloadResponse>

  Returns the execution payload for the specified public workflow.

  Parameters

  • workflowId: string

    The workflow ID.

  Returns Promise<WorkflowPayloadResponse>

  The workflow payload response.

getWorkflows

• getWorkflows(
      params?: PublicWorkflowsPayload,
  ): Promise<PaginatedResponse<PublicWorkflow>>

  Returns the private workflows for the specified application.

  Parameters

  • params: PublicWorkflowsPayload = {}

    Parameters for filtering and paginating the list of workflows.

    • [key: string]: string | number | boolean | undefined

      Any additional filter keys supported by the API.

    • Optionalend_date?: string

      Filter workflows created on or before this ISO 8601 date string.

    • Optionallimit?: number

    • Optionalname?: string

      Filter workflows by name (partial match).

    • Optionalpage?: number

    • Optionalpublished?: boolean

      Filter by workflow published status. true returns only published workflows, false returns only drafts.

    • Optionalslug?: string

      Filter workflows by the application slug.

    • Optionalstart_date?: string

      Filter workflows created on or after this ISO 8601 date string.

  Returns Promise<PaginatedResponse<PublicWorkflow>>

toggleConfigWorkflow

• toggleConfigWorkflow(
      payload: ToggleConfigWorkflowPayload,
  ): Promise<ConfigWorkflow[]>

  Enables or disables a single workflow within a config, without re-installing the config.

  Parameters

  • payload: ToggleConfigWorkflowPayload

    The toggle payload.

  Returns Promise<ConfigWorkflow[]>

  The updated list of workflows in the config.

updateConfig

• updateConfig(payload: UpdateConfigPayload): Promise<Config>

  Update the specified config.

  Parameters

  • payload: UpdateConfigPayload

    The update payload.

  Returns Promise<Config>

  The specified config.

updateConfigField

• updateConfigField(
      slug: string,
      fieldId: string,
      value: string | number | boolean | null,
      workflowId?: string,
      opts?: ConnectionScoped,
  ): Promise<Config>

  Update the specified config field value.

  Parameters

  • slug: string

    The application slug.

  • fieldId: string

    The unique ID of the field.

  • value: string | number | boolean | null

    The new value for the field.

  • OptionalworkflowId: string

    The unique ID of the workflow.

  • Optionalopts: ConnectionScoped = {}

    Names the connection whose config this acts on.

  Returns Promise<Config>

  The updated config field.