@cobaltio/cobalt-js 9.0.0 → 9.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/cobalt.d.ts +30 -0
  2. package/cobalt.js +46 -0
  3. package/cobalt.ts +65 -0
  4. package/docs/assets/hierarchy.js +1 -1
  5. package/docs/assets/navigation.js +1 -1
  6. package/docs/assets/search.js +1 -1
  7. package/docs/classes/Cobalt.html +32 -21
  8. package/docs/enums/AuthStatus.html +2 -2
  9. package/docs/enums/AuthType.html +2 -2
  10. package/docs/interfaces/Application.html +14 -14
  11. package/docs/interfaces/CobaltOptions.html +3 -3
  12. package/docs/interfaces/Config.html +2 -2
  13. package/docs/interfaces/ConfigField.html +4 -4
  14. package/docs/interfaces/ConfigPayload.html +4 -4
  15. package/docs/interfaces/ConfigWorkflow.html +2 -2
  16. package/docs/interfaces/ExecuteWorkflowPayload.html +9 -0
  17. package/docs/interfaces/Execution.html +2 -2
  18. package/docs/interfaces/InputField.html +9 -9
  19. package/docs/interfaces/Label.html +3 -3
  20. package/docs/interfaces/PublicWorkflow.html +8 -8
  21. package/docs/interfaces/PublicWorkflowPayload.html +4 -4
  22. package/docs/interfaces/PublicWorkflowsPayload.html +2 -2
  23. package/docs/interfaces/RuleOptions.html +2 -2
  24. package/docs/interfaces/UpdateConfigPayload.html +5 -5
  25. package/docs/interfaces/WorkflowPayload.html +4 -4
  26. package/docs/interfaces/WorkflowPayloadResponse.html +4 -0
  27. package/docs/llms.txt +224 -157
  28. package/docs/modules.html +1 -1
  29. package/package.json +1 -1
package/docs/llms.txt CHANGED
@@ -70,20 +70,20 @@ cobalt.token = "COBALT_SESSION_TOKEN";
70
70
 
71
71
  ### AuthStatus
72
72
 
73
- Defined in: [cobalt.ts:10](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L10)
73
+ Defined in: [cobalt.ts:10](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L10)
74
74
 
75
75
  #### Enumeration Members
76
76
 
77
77
  | Enumeration Member | Value | Defined in |
78
78
  | ------ | ------ | ------ |
79
- | <a id="active"></a> `Active` | `"active"` | [cobalt.ts:11](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L11) |
80
- | <a id="expired"></a> `Expired` | `"expired"` | [cobalt.ts:12](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L12) |
79
+ | <a id="active"></a> `Active` | `"active"` | [cobalt.ts:11](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L11) |
80
+ | <a id="expired"></a> `Expired` | `"expired"` | [cobalt.ts:12](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L12) |
81
81
 
82
82
  ***
83
83
 
84
84
  ### AuthType
85
85
 
86
- Defined in: [cobalt.ts:5](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L5)
86
+ Defined in: [cobalt.ts:5](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L5)
87
87
 
88
88
  Cobalt Frontend SDK
89
89
 
@@ -91,14 +91,14 @@ Cobalt Frontend SDK
91
91
 
92
92
  | Enumeration Member | Value | Defined in |
93
93
  | ------ | ------ | ------ |
94
- | <a id="keybased"></a> `KeyBased` | `"keybased"` | [cobalt.ts:7](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L7) |
95
- | <a id="oauth2"></a> `OAuth2` | `"oauth2"` | [cobalt.ts:6](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L6) |
94
+ | <a id="keybased"></a> `KeyBased` | `"keybased"` | [cobalt.ts:7](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L7) |
95
+ | <a id="oauth2"></a> `OAuth2` | `"oauth2"` | [cobalt.ts:6](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L6) |
96
96
 
97
97
  ## Classes
98
98
 
99
99
  ### Cobalt
100
100
 
101
- Defined in: [cobalt.ts:304](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L304)
101
+ Defined in: [cobalt.ts:321](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L321)
102
102
 
103
103
  #### Constructors
104
104
 
@@ -106,7 +106,7 @@ Defined in: [cobalt.ts:304](https://github.com/gocobalt/cobalt-js/blob/caefd941c
106
106
 
107
107
  > **new Cobalt**(`options`): [`Cobalt`](#cobalt)
108
108
 
109
- Defined in: [cobalt.ts:314](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L314)
109
+ Defined in: [cobalt.ts:331](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L331)
110
110
 
111
111
  Cobalt Frontend SDK
112
112
 
@@ -124,7 +124,7 @@ Cobalt Frontend SDK
124
124
 
125
125
  | Property | Modifier | Type | Defined in |
126
126
  | ------ | ------ | ------ | ------ |
127
- | <a id="token"></a> `token` | `public` | `string` | [cobalt.ts:306](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L306) |
127
+ | <a id="token"></a> `token` | `public` | `string` | [cobalt.ts:323](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L323) |
128
128
 
129
129
  #### Methods
130
130
 
@@ -132,7 +132,7 @@ Cobalt Frontend SDK
132
132
 
133
133
  > **config**(`payload`): `Promise`\<[`Config`](#config-2)\>
134
134
 
135
- Defined in: [cobalt.ts:578](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L578)
135
+ Defined in: [cobalt.ts:595](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L595)
136
136
 
137
137
  Returns the specified config, or creates one if it doesn't exist.
138
138
 
@@ -152,7 +152,7 @@ The specified config.
152
152
 
153
153
  > **connect**(`params`): `Promise`\<`boolean`\>
154
154
 
155
- Defined in: [cobalt.ts:531](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L531)
155
+ Defined in: [cobalt.ts:548](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L548)
156
156
 
157
157
  Connects the specified application using the provided authentication type and optional auth data.
158
158
 
@@ -179,7 +179,7 @@ Throws an error if the authentication type is invalid or the connection fails.
179
179
 
180
180
  > **createWorkflow**(`params`): `Promise`\<[`PublicWorkflow`](#publicworkflow)\>
181
181
 
182
- Defined in: [cobalt.ts:820](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L820)
182
+ Defined in: [cobalt.ts:837](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L837)
183
183
 
184
184
  Create a public workflow for the linked account.
185
185
 
@@ -199,7 +199,7 @@ The created public workflow.
199
199
 
200
200
  > **deleteConfig**(`slug`, `configId?`): `Promise`\<`unknown`\>
201
201
 
202
- Defined in: [cobalt.ts:669](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L669)
202
+ Defined in: [cobalt.ts:686](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L686)
203
203
 
204
204
  Delete the specified config.
205
205
 
@@ -218,7 +218,7 @@ Delete the specified config.
218
218
 
219
219
  > **deleteConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<`unknown`\>
220
220
 
221
- Defined in: [cobalt.ts:742](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L742)
221
+ Defined in: [cobalt.ts:759](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L759)
222
222
 
223
223
  Delete the specified config field value.
224
224
 
@@ -238,7 +238,7 @@ Delete the specified config field value.
238
238
 
239
239
  > **deleteWorkflow**(`workflowId`): `Promise`\<`unknown`\>
240
240
 
241
- Defined in: [cobalt.ts:848](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L848)
241
+ Defined in: [cobalt.ts:865](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L865)
242
242
 
243
243
  Delete the specified public workflow.
244
244
 
@@ -256,7 +256,7 @@ Delete the specified public workflow.
256
256
 
257
257
  > **disconnect**(`slug`, `type?`): `Promise`\<`unknown`\>
258
258
 
259
- Defined in: [cobalt.ts:557](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L557)
259
+ Defined in: [cobalt.ts:574](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L574)
260
260
 
261
261
  Disconnect the specified application and remove any associated data from Cobalt.
262
262
 
@@ -271,6 +271,24 @@ Disconnect the specified application and remove any associated data from Cobalt.
271
271
 
272
272
  `Promise`\<`unknown`\>
273
273
 
274
+ ##### executeWorkflow()
275
+
276
+ > **executeWorkflow**(`options`): `Promise`\<`unknown`\>
277
+
278
+ Defined in: [cobalt.ts:909](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L909)
279
+
280
+ Execute the specified public workflow.
281
+
282
+ ###### Parameters
283
+
284
+ | Parameter | Type | Description |
285
+ | ------ | ------ | ------ |
286
+ | `options` | [`ExecuteWorkflowPayload`](#executeworkflowpayload) | The execution payload. |
287
+
288
+ ###### Returns
289
+
290
+ `Promise`\<`unknown`\>
291
+
274
292
  ##### getApp()
275
293
 
276
294
  Returns the application details for the specified application, provided
@@ -285,7 +303,7 @@ The application slug.
285
303
 
286
304
  > **getApp**(): `Promise`\<[`Application`](#application)[]\>
287
305
 
288
- Defined in: [cobalt.ts:374](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L374)
306
+ Defined in: [cobalt.ts:391](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L391)
289
307
 
290
308
  Returns the list of enabled applications and their details.
291
309
 
@@ -303,7 +321,7 @@ The application slug.
303
321
 
304
322
  > **getApp**(`slug`): `Promise`\<[`Application`](#application)\>
305
323
 
306
- Defined in: [cobalt.ts:381](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L381)
324
+ Defined in: [cobalt.ts:398](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L398)
307
325
 
308
326
  Returns the application details for the specified application, provided
309
327
  the application is enabled in Cobalt.
@@ -328,7 +346,7 @@ The application slug.
328
346
 
329
347
  > **getApps**(): `Promise`\<[`Application`](#application)[]\>
330
348
 
331
- Defined in: [cobalt.ts:409](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L409)
349
+ Defined in: [cobalt.ts:426](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L426)
332
350
 
333
351
  Returns all the enabled apps.
334
352
 
@@ -342,7 +360,7 @@ The list of applications.
342
360
 
343
361
  > **getConfig**(`slug`, `configId?`): `Promise`\<[`Config`](#config-2)\>
344
362
 
345
- Defined in: [cobalt.ts:625](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L625)
363
+ Defined in: [cobalt.ts:642](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L642)
346
364
 
347
365
  Returns the specified config.
348
366
 
@@ -363,7 +381,7 @@ The specified config.
363
381
 
364
382
  > **getConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
365
383
 
366
- Defined in: [cobalt.ts:692](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L692)
384
+ Defined in: [cobalt.ts:709](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L709)
367
385
 
368
386
  Returns the specified field of the config.
369
387
 
@@ -385,7 +403,7 @@ The specified config field.
385
403
 
386
404
  > **getConfigs**(`slug`): `Promise`\<`object`[]\>
387
405
 
388
- Defined in: [cobalt.ts:604](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L604)
406
+ Defined in: [cobalt.ts:621](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L621)
389
407
 
390
408
  Returns the configs created for the specified application.
391
409
 
@@ -405,7 +423,7 @@ The configs created for the specified application.
405
423
 
406
424
  > **getExecution**(`executionId`): `Promise`\<[`Execution`](#execution)\>
407
425
 
408
- Defined in: [cobalt.ts:891](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L891)
426
+ Defined in: [cobalt.ts:956](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L956)
409
427
 
410
428
  Returns the specified workflow execution log.
411
429
 
@@ -425,7 +443,7 @@ The specified execution log.
425
443
 
426
444
  > **getExecutions**(`params?`): `Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
427
445
 
428
- Defined in: [cobalt.ts:871](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L871)
446
+ Defined in: [cobalt.ts:936](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L936)
429
447
 
430
448
  Returns the workflow execution logs for the linked account.
431
449
 
@@ -445,7 +463,7 @@ The paginated workflow execution logs.
445
463
 
446
464
  > **getFieldOptions**(`lhs`, `slug`, `fieldId`, `workflowId?`): `Promise`\<[`RuleOptions`](#ruleoptions)\>
447
465
 
448
- Defined in: [cobalt.ts:767](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L767)
466
+ Defined in: [cobalt.ts:784](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L784)
449
467
 
450
468
  Returns the options for the specified field.
451
469
 
@@ -464,11 +482,31 @@ Returns the options for the specified field.
464
482
 
465
483
  The specified rule field's options.
466
484
 
485
+ ##### getWorkflowPayload()
486
+
487
+ > **getWorkflowPayload**(`workflowId`): `Promise`\<[`WorkflowPayloadResponse`](#workflowpayloadresponse)\>
488
+
489
+ Defined in: [cobalt.ts:886](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L886)
490
+
491
+ Returns the execution payload for the specified public workflow.
492
+
493
+ ###### Parameters
494
+
495
+ | Parameter | Type | Description |
496
+ | ------ | ------ | ------ |
497
+ | `workflowId` | `string` | The workflow ID. |
498
+
499
+ ###### Returns
500
+
501
+ `Promise`\<[`WorkflowPayloadResponse`](#workflowpayloadresponse)\>
502
+
503
+ The workflow payload response.
504
+
467
505
  ##### getWorkflows()
468
506
 
469
507
  > **getWorkflows**(`params?`): `Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
470
508
 
471
- Defined in: [cobalt.ts:796](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L796)
509
+ Defined in: [cobalt.ts:813](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L813)
472
510
 
473
511
  Returns the private workflows for the specified application.
474
512
 
@@ -486,7 +524,7 @@ Returns the private workflows for the specified application.
486
524
 
487
525
  > **updateConfig**(`payload`): `Promise`\<[`Config`](#config-2)\>
488
526
 
489
- Defined in: [cobalt.ts:645](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L645)
527
+ Defined in: [cobalt.ts:662](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L662)
490
528
 
491
529
  Update the specified config.
492
530
 
@@ -506,7 +544,7 @@ The specified config.
506
544
 
507
545
  > **updateConfigField**(`slug`, `fieldId`, `value`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
508
546
 
509
- Defined in: [cobalt.ts:716](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L716)
547
+ Defined in: [cobalt.ts:733](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L733)
510
548
 
511
549
  Update the specified config field value.
512
550
 
@@ -529,7 +567,7 @@ The updated config field.
529
567
 
530
568
  ### Application
531
569
 
532
- Defined in: [cobalt.ts:16](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L16)
570
+ Defined in: [cobalt.ts:16](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L16)
533
571
 
534
572
  An application in Cobalt.
535
573
 
@@ -537,80 +575,80 @@ An application in Cobalt.
537
575
 
538
576
  | Property | Type | Description | Defined in |
539
577
  | ------ | ------ | ------ | ------ |
540
- | <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:18](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L18) |
541
- | <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). **Deprecated** Check `auth_type_options` for multiple auth types support. | [cobalt.ts:69](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L69) |
542
- | <a id="auth_type"></a> ~~`auth_type`~~ | `"oauth2"` \| `"keybased"` | The type of auth used by application. **Deprecated** Check `auth_type_options` and `connected_accounts` for multiple auth types support. | [cobalt.ts:54](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L54) |
543
- | <a id="auth_type_options"></a> `auth_type_options?` | `object` | The supported auth types for the application, and the fields required from the user to connect the application. | [cobalt.ts:35](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L35) |
578
+ | <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:18](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L18) |
579
+ | <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). **Deprecated** Check `auth_type_options` for multiple auth types support. | [cobalt.ts:69](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L69) |
580
+ | <a id="auth_type"></a> ~~`auth_type`~~ | `"oauth2"` \| `"keybased"` | The type of auth used by application. **Deprecated** Check `auth_type_options` and `connected_accounts` for multiple auth types support. | [cobalt.ts:54](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L54) |
581
+ | <a id="auth_type_options"></a> `auth_type_options?` | `object` | The supported auth types for the application, and the fields required from the user to connect the application. | [cobalt.ts:35](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L35) |
544
582
  | `auth_type_options.keybased` | [`InputField`](#inputfield)[] | - | |
545
583
  | `auth_type_options.oauth2` | [`InputField`](#inputfield)[] | - | |
546
- | <a id="connected"></a> ~~`connected?`~~ | `boolean` | Whether the user has connected the application. **Deprecated** Check `connected_accounts` for multiple auth types support. | [cobalt.ts:59](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L59) |
547
- | <a id="connected_accounts"></a> `connected_accounts?` | `object`[] | The list of connected accounts for this application | [cobalt.ts:40](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L40) |
548
- | <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:22](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L22) |
549
- | <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:24](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L24) |
550
- | <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:20](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L20) |
551
- | <a id="reauth_required"></a> ~~`reauth_required?`~~ | `boolean` | Whether the connection has expired and re-auth is required. **Deprecated** Check `connected_accounts` for multiple auth types support. | [cobalt.ts:64](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L64) |
552
- | <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:31](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L31) |
553
- | <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:33](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L33) |
554
- | <a id="type"></a> ~~`type`~~ | `string` | **Deprecated** Use `slug` instead. The application slug for native apps and `custom` for custom apps. | [cobalt.ts:29](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L29) |
584
+ | <a id="connected"></a> ~~`connected?`~~ | `boolean` | Whether the user has connected the application. **Deprecated** Check `connected_accounts` for multiple auth types support. | [cobalt.ts:59](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L59) |
585
+ | <a id="connected_accounts"></a> `connected_accounts?` | `object`[] | The list of connected accounts for this application | [cobalt.ts:40](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L40) |
586
+ | <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:22](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L22) |
587
+ | <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:24](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L24) |
588
+ | <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:20](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L20) |
589
+ | <a id="reauth_required"></a> ~~`reauth_required?`~~ | `boolean` | Whether the connection has expired and re-auth is required. **Deprecated** Check `connected_accounts` for multiple auth types support. | [cobalt.ts:64](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L64) |
590
+ | <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:31](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L31) |
591
+ | <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:33](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L33) |
592
+ | <a id="type"></a> ~~`type`~~ | `string` | **Deprecated** Use `slug` instead. The application slug for native apps and `custom` for custom apps. | [cobalt.ts:29](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L29) |
555
593
 
556
594
  ***
557
595
 
558
596
  ### CobaltOptions
559
597
 
560
- Defined in: [cobalt.ts:135](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L135)
598
+ Defined in: [cobalt.ts:135](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L135)
561
599
 
562
600
  #### Properties
563
601
 
564
602
  | Property | Type | Description | Defined in |
565
603
  | ------ | ------ | ------ | ------ |
566
- | <a id="baseurl"></a> `baseUrl?` | `string` | The base URL of the Cobalt API. You don't need to set this. | [cobalt.ts:137](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L137) |
567
- | <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:139](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L139) |
604
+ | <a id="baseurl"></a> `baseUrl?` | `string` | The base URL of the Cobalt API. You don't need to set this. | [cobalt.ts:137](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L137) |
605
+ | <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:139](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L139) |
568
606
 
569
607
  ***
570
608
 
571
609
  ### Config
572
610
 
573
- Defined in: [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L207)
611
+ Defined in: [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L207)
574
612
 
575
613
  #### Properties
576
614
 
577
615
  | Property | Type | Defined in |
578
616
  | ------ | ------ | ------ |
579
- | <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:209](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L209) |
580
- | <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:212](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L212) |
581
- | <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:210](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L210) |
582
- | <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:208](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L208) |
583
- | <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:211](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L211) |
617
+ | <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:209](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L209) |
618
+ | <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:212](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L212) |
619
+ | <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:210](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L210) |
620
+ | <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:208](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L208) |
621
+ | <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:211](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L211) |
584
622
 
585
623
  ***
586
624
 
587
625
  ### ConfigField
588
626
 
589
- Defined in: [cobalt.ts:222](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L222)
627
+ Defined in: [cobalt.ts:222](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L222)
590
628
 
591
629
  #### Properties
592
630
 
593
631
  | Property | Type | Description | Defined in |
594
632
  | ------ | ------ | ------ | ------ |
595
- | <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:244](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L244) |
596
- | <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L225) |
597
- | <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:242](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L242) |
598
- | <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:237](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L237) |
599
- | <a id="id"></a> `id` | `string` | - | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L223) |
600
- | <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L231) |
601
- | <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:235](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L235) |
602
- | <a id="name-1"></a> `name` | `string` | - | [cobalt.ts:224](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L224) |
603
- | <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:226](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L226) |
604
- | <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:230](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L230) |
605
- | <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:240](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L240) |
606
- | <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:236](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L236) |
607
- | <a id="value"></a> `value?` | `any` | - | [cobalt.ts:238](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L238) |
633
+ | <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:244](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L244) |
634
+ | <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L225) |
635
+ | <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:242](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L242) |
636
+ | <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:237](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L237) |
637
+ | <a id="id"></a> `id` | `string` | - | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L223) |
638
+ | <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L231) |
639
+ | <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:235](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L235) |
640
+ | <a id="name-1"></a> `name` | `string` | - | [cobalt.ts:224](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L224) |
641
+ | <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:226](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L226) |
642
+ | <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:230](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L230) |
643
+ | <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:240](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L240) |
644
+ | <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:236](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L236) |
645
+ | <a id="value"></a> `value?` | `any` | - | [cobalt.ts:238](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L238) |
608
646
 
609
647
  ***
610
648
 
611
649
  ### ConfigPayload
612
650
 
613
- Defined in: [cobalt.ts:96](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L96)
651
+ Defined in: [cobalt.ts:96](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L96)
614
652
 
615
653
  The payload object for config.
616
654
 
@@ -618,72 +656,87 @@ The payload object for config.
618
656
 
619
657
  | Property | Type | Description | Defined in |
620
658
  | ------ | ------ | ------ | ------ |
621
- | <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:100](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L100) |
622
- | <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:102](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L102) |
623
- | <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:98](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L98) |
659
+ | <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:100](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L100) |
660
+ | <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:102](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L102) |
661
+ | <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:98](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L98) |
624
662
 
625
663
  ***
626
664
 
627
665
  ### ConfigWorkflow
628
666
 
629
- Defined in: [cobalt.ts:247](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L247)
667
+ Defined in: [cobalt.ts:247](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L247)
630
668
 
631
669
  #### Properties
632
670
 
633
671
  | Property | Type | Defined in |
634
672
  | ------ | ------ | ------ |
635
- | <a id="description-1"></a> `description?` | `string` | [cobalt.ts:250](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L250) |
636
- | <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:251](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L251) |
637
- | <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:252](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L252) |
638
- | <a id="id-1"></a> `id` | `string` | [cobalt.ts:248](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L248) |
639
- | <a id="name-2"></a> `name` | `string` | [cobalt.ts:249](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L249) |
673
+ | <a id="description-1"></a> `description?` | `string` | [cobalt.ts:250](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L250) |
674
+ | <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:251](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L251) |
675
+ | <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:252](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L252) |
676
+ | <a id="id-1"></a> `id` | `string` | [cobalt.ts:248](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L248) |
677
+ | <a id="name-2"></a> `name` | `string` | [cobalt.ts:249](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L249) |
678
+
679
+ ***
680
+
681
+ ### ExecuteWorkflowPayload
682
+
683
+ Defined in: [cobalt.ts:261](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L261)
684
+
685
+ #### Properties
686
+
687
+ | Property | Type | Description | Defined in |
688
+ | ------ | ------ | ------ | ------ |
689
+ | <a id="payload"></a> `payload?` | `Record`\<`string`, `any`\> | The payload to execute the workflow. | [cobalt.ts:267](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L267) |
690
+ | <a id="slug-3"></a> `slug?` | `string` | The application's slug this workflow belongs to. | [cobalt.ts:265](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L265) |
691
+ | <a id="sync_execution"></a> `sync_execution?` | `boolean` | Whether to execute the workflow synchronously. | [cobalt.ts:269](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L269) |
692
+ | <a id="worklfow"></a> `worklfow` | `string` | The workflow id or alias. | [cobalt.ts:263](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L263) |
640
693
 
641
694
  ***
642
695
 
643
696
  ### Execution
644
697
 
645
- Defined in: [cobalt.ts:255](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L255)
698
+ Defined in: [cobalt.ts:272](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L272)
646
699
 
647
700
  #### Properties
648
701
 
649
702
  | Property | Type | Defined in |
650
703
  | ------ | ------ | ------ |
651
- | <a id="_id"></a> `_id` | `string` | [cobalt.ts:256](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L256) |
652
- | <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:260](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L260) |
653
- | `associated_application._id` | `string` | [cobalt.ts:261](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L261) |
654
- | `associated_application.icon?` | `string` | [cobalt.ts:263](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L263) |
655
- | `associated_application.name` | `string` | [cobalt.ts:262](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L262) |
656
- | <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:284](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L284) |
657
- | <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:270](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L270) |
658
- | `associated_trigger_application._id` | `string` | [cobalt.ts:271](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L271) |
659
- | `associated_trigger_application.app_type?` | `string` | [cobalt.ts:274](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L274) |
660
- | `associated_trigger_application.icon?` | `string` | [cobalt.ts:273](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L273) |
661
- | `associated_trigger_application.name` | `string` | [cobalt.ts:272](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L272) |
662
- | `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:275](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L275) |
663
- | `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:276](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L276) |
664
- | `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:277](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L277) |
665
- | <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:266](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L266) |
666
- | `associated_workflow._id` | `string` | [cobalt.ts:267](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L267) |
667
- | `associated_workflow.name` | `string` | [cobalt.ts:268](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L268) |
668
- | <a id="completion_percentage"></a> `completion_percentage?` | `number` | [cobalt.ts:287](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L287) |
669
- | <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:283](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L283) |
670
- | <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:299](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L299) |
671
- | <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:286](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L286) |
672
- | <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:285](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L285) |
673
- | <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:282](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L282) |
674
- | <a id="id-2"></a> `id?` | `string` | [cobalt.ts:257](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L257) |
675
- | <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:281](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L281) |
676
- | <a id="name-3"></a> `name` | `string` | [cobalt.ts:258](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L258) |
677
- | <a id="nodes"></a> `nodes?` | `object`[] | [cobalt.ts:288](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L288) |
678
- | <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:259](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L259) |
679
- | <a id="status"></a> `status` | `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"` | [cobalt.ts:265](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L265) |
680
- | <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:280](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L280) |
704
+ | <a id="_id"></a> `_id` | `string` | [cobalt.ts:273](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L273) |
705
+ | <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:277](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L277) |
706
+ | `associated_application._id` | `string` | [cobalt.ts:278](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L278) |
707
+ | `associated_application.icon?` | `string` | [cobalt.ts:280](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L280) |
708
+ | `associated_application.name` | `string` | [cobalt.ts:279](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L279) |
709
+ | <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:301](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L301) |
710
+ | <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:287](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L287) |
711
+ | `associated_trigger_application._id` | `string` | [cobalt.ts:288](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L288) |
712
+ | `associated_trigger_application.app_type?` | `string` | [cobalt.ts:291](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L291) |
713
+ | `associated_trigger_application.icon?` | `string` | [cobalt.ts:290](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L290) |
714
+ | `associated_trigger_application.name` | `string` | [cobalt.ts:289](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L289) |
715
+ | `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:292](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L292) |
716
+ | `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:293](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L293) |
717
+ | `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:294](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L294) |
718
+ | <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:283](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L283) |
719
+ | `associated_workflow._id` | `string` | [cobalt.ts:284](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L284) |
720
+ | `associated_workflow.name` | `string` | [cobalt.ts:285](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L285) |
721
+ | <a id="completion_percentage"></a> `completion_percentage?` | `number` | [cobalt.ts:304](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L304) |
722
+ | <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:300](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L300) |
723
+ | <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:316](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L316) |
724
+ | <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:303](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L303) |
725
+ | <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:302](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L302) |
726
+ | <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:299](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L299) |
727
+ | <a id="id-2"></a> `id?` | `string` | [cobalt.ts:274](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L274) |
728
+ | <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:298](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L298) |
729
+ | <a id="name-3"></a> `name` | `string` | [cobalt.ts:275](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L275) |
730
+ | <a id="nodes"></a> `nodes?` | `object`[] | [cobalt.ts:305](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L305) |
731
+ | <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:276](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L276) |
732
+ | <a id="status"></a> `status` | `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"` | [cobalt.ts:282](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L282) |
733
+ | <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:297](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L297) |
681
734
 
682
735
  ***
683
736
 
684
737
  ### InputField
685
738
 
686
- Defined in: [cobalt.ts:73](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L73)
739
+ Defined in: [cobalt.ts:73](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L73)
687
740
 
688
741
  An Input field to take input from the user.
689
742
 
@@ -691,20 +744,20 @@ An Input field to take input from the user.
691
744
 
692
745
  | Property | Type | Description | Defined in |
693
746
  | ------ | ------ | ------ | ------ |
694
- | <a id="help_text-1"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:87](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L87) |
695
- | <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:85](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L85) |
696
- | <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:81](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L81) |
697
- | <a id="name-4"></a> `name` | `string` | Key name of the field. | [cobalt.ts:75](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L75) |
698
- | <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:89](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L89) |
699
- | <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:83](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L83) |
700
- | <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:79](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L79) |
701
- | <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:77](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L77) |
747
+ | <a id="help_text-1"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:87](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L87) |
748
+ | <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:85](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L85) |
749
+ | <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:81](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L81) |
750
+ | <a id="name-4"></a> `name` | `string` | Key name of the field. | [cobalt.ts:75](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L75) |
751
+ | <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:89](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L89) |
752
+ | <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:83](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L83) |
753
+ | <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:79](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L79) |
754
+ | <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:77](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L77) |
702
755
 
703
756
  ***
704
757
 
705
758
  ### Label
706
759
 
707
- Defined in: [cobalt.ts:106](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L106)
760
+ Defined in: [cobalt.ts:106](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L106)
708
761
 
709
762
  Label Mapping
710
763
 
@@ -712,14 +765,14 @@ Label Mapping
712
765
 
713
766
  | Property | Type | Description | Defined in |
714
767
  | ------ | ------ | ------ | ------ |
715
- | <a id="name-5"></a> `name` | `string` | The label name. | [cobalt.ts:108](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L108) |
716
- | <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:110](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L110) |
768
+ | <a id="name-5"></a> `name` | `string` | The label name. | [cobalt.ts:108](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L108) |
769
+ | <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:110](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L110) |
717
770
 
718
771
  ***
719
772
 
720
773
  ### PublicWorkflow
721
774
 
722
- Defined in: [cobalt.ts:163](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L163)
775
+ Defined in: [cobalt.ts:163](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L163)
723
776
 
724
777
  A public workflow in Cobalt.
725
778
 
@@ -727,19 +780,19 @@ A public workflow in Cobalt.
727
780
 
728
781
  | Property | Type | Description | Defined in |
729
782
  | ------ | ------ | ------ | ------ |
730
- | <a id="_id-1"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:165](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L165) |
731
- | <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:173](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L173) |
732
- | <a id="description-2"></a> `description?` | `string` | The workflow description. | [cobalt.ts:169](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L169) |
733
- | <a id="name-6"></a> `name` | `string` | The workflow name. | [cobalt.ts:167](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L167) |
734
- | <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:177](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L177) |
735
- | <a id="slug-3"></a> `slug?` | `string` | The application's slug in which this workflow exists. | [cobalt.ts:171](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L171) |
736
- | <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [cobalt.ts:175](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L175) |
783
+ | <a id="_id-1"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:165](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L165) |
784
+ | <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:173](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L173) |
785
+ | <a id="description-2"></a> `description?` | `string` | The workflow description. | [cobalt.ts:169](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L169) |
786
+ | <a id="name-6"></a> `name` | `string` | The workflow name. | [cobalt.ts:167](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L167) |
787
+ | <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:177](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L177) |
788
+ | <a id="slug-4"></a> `slug?` | `string` | The application's slug in which this workflow exists. | [cobalt.ts:171](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L171) |
789
+ | <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [cobalt.ts:175](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L175) |
737
790
 
738
791
  ***
739
792
 
740
793
  ### PublicWorkflowPayload
741
794
 
742
- Defined in: [cobalt.ts:181](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L181)
795
+ Defined in: [cobalt.ts:181](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L181)
743
796
 
744
797
  The payload for creating a public workflow for the linked account.
745
798
 
@@ -747,15 +800,15 @@ The payload for creating a public workflow for the linked account.
747
800
 
748
801
  | Property | Type | Description | Defined in |
749
802
  | ------ | ------ | ------ | ------ |
750
- | <a id="description-3"></a> `description?` | `string` | The workflow description. | [cobalt.ts:185](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L185) |
751
- | <a id="name-7"></a> `name` | `string` | The workflow name. | [cobalt.ts:183](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L183) |
752
- | <a id="slug-4"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [cobalt.ts:187](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L187) |
803
+ | <a id="description-3"></a> `description?` | `string` | The workflow description. | [cobalt.ts:185](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L185) |
804
+ | <a id="name-7"></a> `name` | `string` | The workflow name. | [cobalt.ts:183](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L183) |
805
+ | <a id="slug-5"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [cobalt.ts:187](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L187) |
753
806
 
754
807
  ***
755
808
 
756
809
  ### PublicWorkflowsPayload
757
810
 
758
- Defined in: [cobalt.ts:190](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L190)
811
+ Defined in: [cobalt.ts:190](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L190)
759
812
 
760
813
  #### Extends
761
814
 
@@ -765,39 +818,39 @@ Defined in: [cobalt.ts:190](https://github.com/gocobalt/cobalt-js/blob/caefd941c
765
818
 
766
819
  | Property | Type | Inherited from | Defined in |
767
820
  | ------ | ------ | ------ | ------ |
768
- | <a id="limit"></a> `limit?` | `number` | `PaginationProps.limit` | [cobalt.ts:196](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L196) |
769
- | <a id="page"></a> `page?` | `number` | `PaginationProps.page` | [cobalt.ts:195](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L195) |
770
- | <a id="slug-5"></a> `slug?` | `string` | - | [cobalt.ts:191](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L191) |
821
+ | <a id="limit"></a> `limit?` | `number` | `PaginationProps.limit` | [cobalt.ts:196](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L196) |
822
+ | <a id="page"></a> `page?` | `number` | `PaginationProps.page` | [cobalt.ts:195](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L195) |
823
+ | <a id="slug-6"></a> `slug?` | `string` | - | [cobalt.ts:191](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L191) |
771
824
 
772
825
  ***
773
826
 
774
827
  ### RuleOptions
775
828
 
776
- Defined in: [cobalt.ts:142](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L142)
829
+ Defined in: [cobalt.ts:142](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L142)
777
830
 
778
831
  #### Properties
779
832
 
780
833
  | Property | Type | Defined in |
781
834
  | ------ | ------ | ------ |
782
- | <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:155](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L155) |
783
- | <a id="error"></a> `error?` | `object` | [cobalt.ts:156](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L156) |
784
- | `error.message?` | `string` | [cobalt.ts:157](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L157) |
785
- | `error.stack?` | `string` | [cobalt.ts:158](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L158) |
786
- | <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:143](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L143) |
787
- | `rule_column.operator` | `object` | [cobalt.ts:149](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L149) |
788
- | `rule_column.operator.name` | `string` | [cobalt.ts:150](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L150) |
789
- | `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:152](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L152) |
790
- | `rule_column.operator.type` | `"select"` | [cobalt.ts:151](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L151) |
791
- | `rule_column.rhs` | `object` | [cobalt.ts:144](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L144) |
792
- | `rule_column.rhs.name` | `string` | [cobalt.ts:145](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L145) |
793
- | `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:147](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L147) |
794
- | `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L146) |
835
+ | <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:155](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L155) |
836
+ | <a id="error"></a> `error?` | `object` | [cobalt.ts:156](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L156) |
837
+ | `error.message?` | `string` | [cobalt.ts:157](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L157) |
838
+ | `error.stack?` | `string` | [cobalt.ts:158](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L158) |
839
+ | <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:143](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L143) |
840
+ | `rule_column.operator` | `object` | [cobalt.ts:149](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L149) |
841
+ | `rule_column.operator.name` | `string` | [cobalt.ts:150](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L150) |
842
+ | `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:152](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L152) |
843
+ | `rule_column.operator.type` | `"select"` | [cobalt.ts:151](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L151) |
844
+ | `rule_column.rhs` | `object` | [cobalt.ts:144](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L144) |
845
+ | `rule_column.rhs.name` | `string` | [cobalt.ts:145](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L145) |
846
+ | `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:147](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L147) |
847
+ | `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L146) |
795
848
 
796
849
  ***
797
850
 
798
851
  ### UpdateConfigPayload
799
852
 
800
- Defined in: [cobalt.ts:114](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L114)
853
+ Defined in: [cobalt.ts:114](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L114)
801
854
 
802
855
  The configuration data for an application.
803
856
 
@@ -805,16 +858,16 @@ The configuration data for an application.
805
858
 
806
859
  | Property | Type | Description | Defined in |
807
860
  | ------ | ------ | ------ | ------ |
808
- | <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L118) |
809
- | <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [cobalt.ts:120](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L120) |
810
- | <a id="slug-6"></a> `slug` | `string` | The application slug | [cobalt.ts:116](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L116) |
811
- | <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:122](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L122) |
861
+ | <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L118) |
862
+ | <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [cobalt.ts:120](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L120) |
863
+ | <a id="slug-7"></a> `slug` | `string` | The application slug | [cobalt.ts:116](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L116) |
864
+ | <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:122](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L122) |
812
865
 
813
866
  ***
814
867
 
815
868
  ### WorkflowPayload
816
869
 
817
- Defined in: [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L126)
870
+ Defined in: [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L126)
818
871
 
819
872
  The workflow.
820
873
 
@@ -822,6 +875,20 @@ The workflow.
822
875
 
823
876
  | Property | Type | Description | Defined in |
824
877
  | ------ | ------ | ------ | ------ |
825
- | <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:130](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L130) |
826
- | <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [cobalt.ts:132](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L132) |
827
- | <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L128) |
878
+ | <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:130](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L130) |
879
+ | <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [cobalt.ts:132](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L132) |
880
+ | <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L128) |
881
+
882
+ ***
883
+
884
+ ### WorkflowPayloadResponse
885
+
886
+ Defined in: [cobalt.ts:255](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L255)
887
+
888
+ #### Properties
889
+
890
+ | Property | Type | Defined in |
891
+ | ------ | ------ | ------ |
892
+ | <a id="payload-1"></a> `payload` | `Record`\<`string`, `any`\> | [cobalt.ts:256](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L256) |
893
+ | <a id="schema"></a> `schema?` | `unknown` | [cobalt.ts:257](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L257) |
894
+ | <a id="schema_interpreted"></a> `schema_interpreted?` | `unknown` | [cobalt.ts:258](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L258) |