@cobaltio/cobalt-js 8.7.2 → 8.9.0

package/docs/llms.txt

@@ -0,0 +1,837 @@
+**@cobaltio/cobalt-js**
+
+***
+
+# Cobalt Javascript SDK
+Cobalt frontend SDK.
+
+## Install
+
+#### npm
+```bash
+npm install @cobaltio/cobalt-js
+```
+
+#### yarn
+```bash
+yarn add @cobaltio/cobalt-js
+```
+
+## Usage
+
+### Include
+
+#### Browser
+```html
+<!-- use this if you get an error saying `exports` is not defined. -->
+<script>var exports = {};</script>
+<!-- use a specific version -->
+<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@8.0.0"></script>
+<!-- use a version range instead of a specific version -->
+<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@8"></script>
+<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@8.0"></script>
+<!-- omit the version completely to use the latest one -->
+<!-- you should NOT use this in production -->
+<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js"></script>
+```
+
+#### Node
+```js
+import { Cobalt } from "@cobaltio/cobalt-js";
+// or, if you're using CommonJS
+const { Cobalt } = require("@cobaltio/cobalt-js");
+```
+
+### Initialize
+```js
+// initialize with token
+const cobalt = new Cobalt({
+    // the token you generate for linked accounts using the cobalt backend SDK
+    token: "COBALT_SESSION_TOKEN",
+    // OPTIONAL: set custom base url for all API requests. only useful if you are hosting Cobalt on premise.
+    baseUrl: "https://cobalt.example.com/backend",
+});
+
+// Or, initialize without token
+const cobalt = new Cobalt();
+// and you can set the token later.
+cobalt.token = "COBALT_SESSION_TOKEN";
+```
+
+# Documentation
+
+- You can read the [SDK documentation here](https://gocobalt.github.io/cobalt-js).
+
+- [`llms.txt`](https://gocobalt.github.io/cobalt-js/llms.txt)
+
+  This documentation is also available in [llms.txt](https://llmstxt.org) format, which is a simple markdown standard that LLMs can consume easily.
+
+## Classes
+
+### Cobalt
+
+Defined in: [cobalt.ts:267](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L267)
+
+#### Constructors
+
+##### Constructor
+
+> **new Cobalt**(`options`): [`Cobalt`](#cobalt)
+
+Defined in: [cobalt.ts:277](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L277)
+
+Cobalt Frontend SDK
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`CobaltOptions`](#cobaltoptions) | The options to configure the Cobalt SDK. |
+
+###### Returns
+
+[`Cobalt`](#cobalt)
+
+#### Properties
+
+| Property | Modifier | Type | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="token"></a> `token` | `public` | `string` | [cobalt.ts:269](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L269) |
+
+#### Methods
+
+##### config()
+
+> **config**(`payload`): `Promise`\<[`Config`](#config-2)\>
+
+Defined in: [cobalt.ts:524](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L524)
+
+Returns the specified config, or creates one if it doesn't exist.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ConfigPayload`](#configpayload) | The payload object for config. |
+
+###### Returns
+
+`Promise`\<[`Config`](#config-2)\>
+
+The specified config.
+
+##### connect()
+
+> **connect**(`slug`, `payload?`): `Promise`\<`boolean`\>
+
+Defined in: [cobalt.ts:464](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L464)
+
+Connect the specified application, optionally with the auth data that user provides.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `slug` | `string` | The application slug. |
+| `payload?` | `Record`\<`string`, `string`\> | The key value pairs of auth data. |
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+Whether the connection was successful.
+
+##### ~~createEcosystemLead()~~
+
+> **createEcosystemLead**(`payload`): `Promise`\<[`EcosystemLead`](#ecosystemlead)\>
+
+Defined in: [cobalt.ts:637](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L637)
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`EcosystemLeadPayload`](#ecosystemleadpayload) | The payload object for the lead. |
+
+###### Returns
+
+`Promise`\<[`EcosystemLead`](#ecosystemlead)\>
+
+###### Deprecated
+
+Create a lead for an ecosystem app.
+
+##### createWorkflow()
+
+> **createWorkflow**(`params`): `Promise`\<[`PublicWorkflow`](#publicworkflow)\>
+
+Defined in: [cobalt.ts:790](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L790)
+
+Create a public workflow for the linked account.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `params` | [`PublicWorkflowPayload`](#publicworkflowpayload) |  |
+
+###### Returns
+
+`Promise`\<[`PublicWorkflow`](#publicworkflow)\>
+
+The created public workflow.
+
+##### deleteConfig()
+
+> **deleteConfig**(`slug`, `configId?`): `Promise`\<`unknown`\>
+
+Defined in: [cobalt.ts:615](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L615)
+
+Delete the specified config.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `slug` | `string` | The application slug. |
+| `configId?` | `string` | The unique ID of the config. |
+
+###### Returns
+
+`Promise`\<`unknown`\>
+
+##### deleteConfigField()
+
+> **deleteConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<`unknown`\>
+
+Defined in: [cobalt.ts:712](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L712)
+
+Delete the specified config field value.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `slug` | `string` | The application slug. |
+| `fieldId` | `string` | The unique ID of the field. |
+| `workflowId?` | `string` | The unique ID of the workflow. |
+
+###### Returns
+
+`Promise`\<`unknown`\>
+
+##### deleteWorkflow()
+
+> **deleteWorkflow**(`workflowId`): `Promise`\<`unknown`\>
+
+Defined in: [cobalt.ts:818](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L818)
+
+Delete the specified public workflow.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `workflowId` | `string` | The workflow ID. |
+
+###### Returns
+
+`Promise`\<`unknown`\>
+
+##### disconnect()
+
+> **disconnect**(`slug`): `Promise`\<`void`\>
+
+Defined in: [cobalt.ts:505](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L505)
+
+Disconnect the specified application and remove any associated data from Cobalt.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `slug` | `string` | The application slug. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+##### getApp()
+
+Returns the application details for the specified application, provided
+the application is enabled in Cobalt. If no application is specified,
+it returns all the enabled applications.
+
+###### Param
+
+The application slug.
+
+###### Call Signature
+
+> **getApp**(): `Promise`\<[`Application`](#application)[]\>
+
+Defined in: [cobalt.ts:337](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L337)
+
+Returns the list of enabled applications and their details.
+
+###### Returns
+
+`Promise`\<[`Application`](#application)[]\>
+
+The application details.
+
+###### Param
+
+The application slug.
+
+###### Call Signature
+
+> **getApp**(`slug`): `Promise`\<[`Application`](#application)\>
+
+Defined in: [cobalt.ts:344](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L344)
+
+Returns the application details for the specified application, provided
+the application is enabled in Cobalt.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `slug` | `string` | The application slug. |
+
+###### Returns
+
+`Promise`\<[`Application`](#application)\>
+
+The application details.
+
+###### Param
+
+The application slug.
+
+##### getApps()
+
+> **getApps**(): `Promise`\<[`Application`](#application)[]\>
+
+Defined in: [cobalt.ts:372](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L372)
+
+Returns all the enabled apps.
+
+###### Returns
+
+`Promise`\<[`Application`](#application)[]\>
+
+The list of applications.
+
+##### getConfig()
+
+> **getConfig**(`slug`, `configId?`): `Promise`\<[`Config`](#config-2)\>
+
+Defined in: [cobalt.ts:571](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L571)
+
+Returns the specified config.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `slug` | `string` | The application slug. |
+| `configId?` | `string` | The unique ID of the config. |
+
+###### Returns
+
+`Promise`\<[`Config`](#config-2)\>
+
+The specified config.
+
+##### getConfigField()
+
+> **getConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
+
+Defined in: [cobalt.ts:662](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L662)
+
+Returns the specified field of the config.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `slug` | `string` | The application slug. |
+| `fieldId` | `string` | The unique ID of the field. |
+| `workflowId?` | `string` | The unique ID of the workflow. |
+
+###### Returns
+
+`Promise`\<[`Config`](#config-2)\>
+
+The specified config field.
+
+##### getConfigs()
+
+> **getConfigs**(`slug`): `Promise`\<`object`[]\>
+
+Defined in: [cobalt.ts:550](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L550)
+
+Returns the configs created for the specified application.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `slug` | `string` | The application slug. |
+
+###### Returns
+
+`Promise`\<`object`[]\>
+
+The configs created for the specified application.
+
+##### getExecution()
+
+> **getExecution**(`executionId`): `Promise`\<[`Execution`](#execution)\>
+
+Defined in: [cobalt.ts:861](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L861)
+
+Returns the specified workflow execution log.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `executionId` | `string` | The execution ID. |
+
+###### Returns
+
+`Promise`\<[`Execution`](#execution)\>
+
+The specified execution log.
+
+##### getExecutions()
+
+> **getExecutions**(`params?`): `Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
+
+Defined in: [cobalt.ts:841](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L841)
+
+Returns the workflow execution logs for the linked account.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `params?` | `PaginationProps` |  |
+
+###### Returns
+
+`Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
+
+The paginated workflow execution logs.
+
+##### getFieldOptions()
+
+> **getFieldOptions**(`lhs`, `slug`, `fieldId`, `workflowId?`): `Promise`\<[`RuleOptions`](#ruleoptions)\>
+
+Defined in: [cobalt.ts:737](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L737)
+
+Returns the options for the specified field.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `lhs` | `string` | The selected value of the lhs field. |
+| `slug` | `string` | The application slug. |
+| `fieldId` | `string` | The unique ID of the field. |
+| `workflowId?` | `string` | The unique ID of the workflow, if this is a workflow field. |
+
+###### Returns
+
+`Promise`\<[`RuleOptions`](#ruleoptions)\>
+
+The specified rule field's options.
+
+##### getWorkflows()
+
+> **getWorkflows**(`params?`): `Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
+
+Defined in: [cobalt.ts:766](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L766)
+
+Returns the private workflows for the specified application.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `params?` | [`PublicWorkflowsPayload`](#publicworkflowspayload) |  |
+
+###### Returns
+
+`Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
+
+##### updateConfig()
+
+> **updateConfig**(`payload`): `Promise`\<[`Config`](#config-2)\>
+
+Defined in: [cobalt.ts:591](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L591)
+
+Update the specified config.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`UpdateConfigPayload`](#updateconfigpayload) | The update payload. |
+
+###### Returns
+
+`Promise`\<[`Config`](#config-2)\>
+
+The specified config.
+
+##### updateConfigField()
+
+> **updateConfigField**(`slug`, `fieldId`, `value`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
+
+Defined in: [cobalt.ts:686](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L686)
+
+Update the specified config field value.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `slug` | `string` | The application slug. |
+| `fieldId` | `string` | The unique ID of the field. |
+| `value` | `null` \| `string` \| `number` \| `boolean` | The new value for the field. |
+| `workflowId?` | `string` | The unique ID of the workflow. |
+
+###### Returns
+
+`Promise`\<[`Config`](#config-2)\>
+
+The updated config field.
+
+## Interfaces
+
+### Application
+
+Defined in: [cobalt.ts:6](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L6)
+
+An application in Cobalt.
+
+#### Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:8](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L8) |
+| <a id="auth_input_map"></a> `auth_input_map?` | [`InputField`](#inputfield)[] | The fields required from the user to connect the application (for `keybased` auth type). | [cobalt.ts:29](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L29) |
+| <a id="auth_type"></a> `auth_type` | `"oauth2"` \| `"keybased"` | The type of auth used by application. | [cobalt.ts:23](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L23) |
+| <a id="connected"></a> `connected?` | `boolean` | Whether the user has connected the application. | [cobalt.ts:25](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L25) |
+| <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:12](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L12) |
+| <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:14](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L14) |
+| <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:10](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L10) |
+| <a id="reauth_required"></a> `reauth_required?` | `boolean` | Whether the connection has expired and re-auth is required. | [cobalt.ts:27](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L27) |
+| <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:21](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L21) |
+| <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:31](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L31) |
+| <a id="type"></a> ~~`type`~~ | `string` | **Deprecated** Use `slug` instead. The application slug for native apps and `custom` for custom apps. | [cobalt.ts:19](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L19) |
+
+***
+
+### CobaltOptions
+
+Defined in: [cobalt.ts:97](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L97)
+
+#### Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="baseurl"></a> `baseUrl?` | `string` | The base URL of the Cobalt API. You don't need to set this. | [cobalt.ts:99](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L99) |
+| <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:101](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L101) |
+
+***
+
+### Config
+
+Defined in: [cobalt.ts:182](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L182)
+
+#### Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:184](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L184) |
+| <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:187](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L187) |
+| <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:185](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L185) |
+| <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:183](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L183) |
+| <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:186](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L186) |
+
+***
+
+### ConfigField
+
+Defined in: [cobalt.ts:197](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L197)
+
+#### Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:219](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L219) |
+| <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:200](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L200) |
+| <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:217](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L217) |
+| <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:212](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L212) |
+| <a id="id"></a> `id` | `string` | - | [cobalt.ts:198](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L198) |
+| <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:206](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L206) |
+| <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:210](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L210) |
+| <a id="name-1"></a> `name` | `string` | - | [cobalt.ts:199](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L199) |
+| <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:201](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L201) |
+| <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:205](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L205) |
+| <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:215](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L215) |
+| <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:211](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L211) |
+| <a id="value"></a> `value?` | `any` | - | [cobalt.ts:213](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L213) |
+
+***
+
+### ConfigPayload
+
+Defined in: [cobalt.ts:58](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L58)
+
+The payload object for config.
+
+#### Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:62](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L62) |
+| <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:64](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L64) |
+| <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:60](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L60) |
+
+***
+
+### ConfigWorkflow
+
+Defined in: [cobalt.ts:222](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L222)
+
+#### Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="description-1"></a> `description?` | `string` | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L225) |
+| <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:226](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L226) |
+| <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:227](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L227) |
+| <a id="id-1"></a> `id` | `string` | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L223) |
+| <a id="name-2"></a> `name` | `string` | [cobalt.ts:224](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L224) |
+
+***
+
+### ~~EcosystemLead~~
+
+Defined in: [cobalt.ts:107](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L107)
+
+#### Deprecated
+
+#### Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="_id"></a> ~~`_id`~~ | `string` | [cobalt.ts:108](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L108) |
+| <a id="created_at"></a> ~~`created_at`~~ | `string` | [cobalt.ts:112](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L112) |
+| <a id="description-2"></a> ~~`description?`~~ | `string` | [cobalt.ts:111](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L111) |
+| <a id="email"></a> ~~`email`~~ | `string` | [cobalt.ts:110](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L110) |
+| <a id="name-3"></a> ~~`name?`~~ | `string` | [cobalt.ts:109](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L109) |
+
+***
+
+### ~~EcosystemLeadPayload~~
+
+Defined in: [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L118)
+
+#### Deprecated
+
+#### Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="description-3"></a> ~~`description?`~~ | `string` | [cobalt.ts:122](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L122) |
+| <a id="email-1"></a> ~~`email`~~ | `string` | [cobalt.ts:121](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L121) |
+| <a id="name-4"></a> ~~`name?`~~ | `string` | [cobalt.ts:120](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L120) |
+| <a id="slug-3"></a> ~~`slug`~~ | `string` | [cobalt.ts:119](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L119) |
+
+***
+
+### Execution
+
+Defined in: [cobalt.ts:230](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L230)
+
+#### Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="_id-1"></a> `_id` | `string` | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L231) |
+| <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:235](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L235) |
+| `associated_application._id` | `string` | [cobalt.ts:236](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L236) |
+| `associated_application.icon?` | `string` | [cobalt.ts:238](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L238) |
+| `associated_application.name` | `string` | [cobalt.ts:237](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L237) |
+| <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:259](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L259) |
+| <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:245](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L245) |
+| `associated_trigger_application._id` | `string` | [cobalt.ts:246](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L246) |
+| `associated_trigger_application.app_type?` | `string` | [cobalt.ts:249](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L249) |
+| `associated_trigger_application.icon?` | `string` | [cobalt.ts:248](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L248) |
+| `associated_trigger_application.name` | `string` | [cobalt.ts:247](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L247) |
+| `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:250](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L250) |
+| `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:251](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L251) |
+| `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:252](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L252) |
+| <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:241](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L241) |
+| `associated_workflow._id` | `string` | [cobalt.ts:242](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L242) |
+| `associated_workflow.name` | `string` | [cobalt.ts:243](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L243) |
+| <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:258](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L258) |
+| <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:262](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L262) |
+| <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:261](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L261) |
+| <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:260](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L260) |
+| <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:257](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L257) |
+| <a id="id-2"></a> `id?` | `string` | [cobalt.ts:232](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L232) |
+| <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:256](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L256) |
+| <a id="name-5"></a> `name` | `string` | [cobalt.ts:233](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L233) |
+| <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:234](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L234) |
+| <a id="status"></a> `status` | `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"` | [cobalt.ts:240](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L240) |
+| <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:255](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L255) |
+
+***
+
+### InputField
+
+Defined in: [cobalt.ts:35](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L35)
+
+An Input field to take input from the user.
+
+#### Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="help_text-1"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:49](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L49) |
+| <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:47](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L47) |
+| <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:43](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L43) |
+| <a id="name-6"></a> `name` | `string` | Key name of the field. | [cobalt.ts:37](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L37) |
+| <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:51](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L51) |
+| <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:45](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L45) |
+| <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:41](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L41) |
+| <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:39](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L39) |
+
+***
+
+### Label
+
+Defined in: [cobalt.ts:68](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L68)
+
+Label Mapping
+
+#### Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="name-7"></a> `name` | `string` | The label name. | [cobalt.ts:70](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L70) |
+| <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:72](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L72) |
+
+***
+
+### PublicWorkflow
+
+Defined in: [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L146)
+
+A public workflow in Cobalt.
+
+#### Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="_id-2"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:148](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L148) |
+| <a id="description-4"></a> `description?` | `string` | The workflow description. | [cobalt.ts:152](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L152) |
+| <a id="name-8"></a> `name` | `string` | The workflow name. | [cobalt.ts:150](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L150) |
+
+***
+
+### PublicWorkflowPayload
+
+Defined in: [cobalt.ts:156](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L156)
+
+The payload for creating a public workflow for the linked account.
+
+#### Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="description-5"></a> `description?` | `string` | The workflow description. | [cobalt.ts:160](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L160) |
+| <a id="name-9"></a> `name` | `string` | The workflow name. | [cobalt.ts:158](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L158) |
+| <a id="slug-4"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [cobalt.ts:162](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L162) |
+
+***
+
+### PublicWorkflowsPayload
+
+Defined in: [cobalt.ts:165](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L165)
+
+#### Extends
+
+- `PaginationProps`
+
+#### Properties
+
+| Property | Type | Inherited from | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="limit"></a> `limit?` | `number` | `PaginationProps.limit` | [cobalt.ts:171](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L171) |
+| <a id="page"></a> `page?` | `number` | `PaginationProps.page` | [cobalt.ts:170](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L170) |
+| <a id="slug-5"></a> `slug?` | `string` | - | [cobalt.ts:166](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L166) |
+
+***
+
+### RuleOptions
+
+Defined in: [cobalt.ts:125](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L125)
+
+#### Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:138](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L138) |
+| <a id="error"></a> `error?` | `object` | [cobalt.ts:139](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L139) |
+| `error.message?` | `string` | [cobalt.ts:140](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L140) |
+| `error.stack?` | `string` | [cobalt.ts:141](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L141) |
+| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L126) |
+| `rule_column.operator` | `object` | [cobalt.ts:132](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L132) |
+| `rule_column.operator.name` | `string` | [cobalt.ts:133](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L133) |
+| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:135](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L135) |
+| `rule_column.operator.type` | `"select"` | [cobalt.ts:134](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L134) |
+| `rule_column.rhs` | `object` | [cobalt.ts:127](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L127) |
+| `rule_column.rhs.name` | `string` | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L128) |
+| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:130](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L130) |
+| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:129](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L129) |
+
+***
+
+### UpdateConfigPayload
+
+Defined in: [cobalt.ts:76](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L76)
+
+The configuration data for an application.
+
+#### Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:80](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L80) |
+| <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [cobalt.ts:82](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L82) |
+| <a id="slug-6"></a> `slug` | `string` | The application slug | [cobalt.ts:78](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L78) |
+| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:84](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L84) |
+
+***
+
+### WorkflowPayload
+
+Defined in: [cobalt.ts:88](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L88)
+
+The workflow.
+
+#### Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:92](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L92) |
+| <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [cobalt.ts:94](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L94) |
+| <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:90](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L90) |