Class Cobalt

constructor

• new Cobalt(options?): Cobalt

• Cobalt Frontend SDK

  Parameters

  • options: CobaltOptions = {}

    The options to configure the Cobalt SDK.

  Returns Cobalt

token

config

• config(payload): Promise<any>

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

  Parameters

  • payload: ConfigPayload

    The payload object for config.

  Returns Promise<any>

  The specified config.

connect

• connect(slug, payload?): Promise<boolean>

• Connect the specified application, optionally with the auth data that user provides.

  Parameters

  • slug: string

    The application slug.
  • Optionalpayload: Record<string, string>

    The key value pairs of auth data.

  Returns Promise<boolean>

  Whether the connection was successful.

createEcosystemLead

• createEcosystemLead(payload): Promise<EcosystemLead>

• Create a lead for an ecosystem app.

  Parameters

  • payload: EcosystemLeadPayload

    The payload object for the lead.

  Returns Promise<EcosystemLead>

deleteConfig

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

• Delete the specified config.

  Parameters

  • slug: string

    The application slug.
  • OptionalconfigId: string

    The unique ID of the config.

  Returns Promise<unknown>

deleteConfigField

• deleteConfigField(slug, fieldId, workflowId?): 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.

  Returns Promise<unknown>

disconnect

• disconnect(slug): Promise<void>

• Disconnect the specified application and remove any associated data from Cobalt.

  Parameters

  • slug: string

    The application slug.

  Returns Promise<void>

getApp

• getApp(): Promise<Application[]>

• Returns the list of enabled applications and their details.

  Returns Promise<Application[]>

  The list of applications.
• getApp(slug): Promise<Application>

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

  Parameters

  • slug: string

    The application slug.

  Returns Promise<Application>

  The application details.

getApps

• getApps(): Promise<Application[]>

• Returns all the enabled and ecosystem apps.

  Returns Promise<Application[]>

  The list of applications.

getConfig

• getConfig(slug, configId?): Promise<any>

• Returns the specified config.

  Parameters

  • slug: string

    The application slug.
  • OptionalconfigId: string

    The unique ID of the config.

  Returns Promise<any>

  The specified config.

getConfigField

• getConfigField(slug, fieldId, workflowId?): Promise<any>

• 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.

  Returns Promise<any>

  The specified config field.

getFieldOptions

• getFieldOptions(lhs, slug, fieldId, workflowId?): 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.

  Returns Promise<RuleOptions>

  The specified rule field's options.

updateConfig

• updateConfig(payload): Promise<any>

• Update the specified config.

  Parameters

  • payload: UpdateConfigPayload

    The update payload.

  Returns Promise<any>

  The specified config.

updateConfigField

• updateConfigField(slug, fieldId, value, workflowId?): Promise<any>

• Update the specified config field value.

  Parameters

  • slug: string

    The application slug.
  • fieldId: string

    The unique ID of the field.
  • value:
        | null
        | string
        | number
        | boolean

    The new value for the field.
  • OptionalworkflowId: string

    The unique ID of the workflow.

  Returns Promise<any>

  The updated config field.