@cobaltio/cobalt-js 9.0.0-beta.1 → 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.
package/docs/llms.txt CHANGED
@@ -66,11 +66,39 @@ cobalt.token = "COBALT_SESSION_TOKEN";
66
66
 
67
67
  This documentation is also available in [llms.txt](https://llmstxt.org) format, which is a simple markdown standard that LLMs can consume easily.
68
68
 
69
+ ## Enumerations
70
+
71
+ ### AuthStatus
72
+
73
+ Defined in: [cobalt.ts:10](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L10)
74
+
75
+ #### Enumeration Members
76
+
77
+ | Enumeration Member | Value | Defined in |
78
+ | ------ | ------ | ------ |
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
+
82
+ ***
83
+
84
+ ### AuthType
85
+
86
+ Defined in: [cobalt.ts:5](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L5)
87
+
88
+ Cobalt Frontend SDK
89
+
90
+ #### Enumeration Members
91
+
92
+ | Enumeration Member | Value | Defined in |
93
+ | ------ | ------ | ------ |
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
+
69
97
  ## Classes
70
98
 
71
99
  ### Cobalt
72
100
 
73
- Defined in: [cobalt.ts:275](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L275)
101
+ Defined in: [cobalt.ts:321](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L321)
74
102
 
75
103
  #### Constructors
76
104
 
@@ -78,7 +106,7 @@ Defined in: [cobalt.ts:275](https://github.com/gocobalt/cobalt-js/blob/75a69bc12
78
106
 
79
107
  > **new Cobalt**(`options`): [`Cobalt`](#cobalt)
80
108
 
81
- Defined in: [cobalt.ts:285](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L285)
109
+ Defined in: [cobalt.ts:331](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L331)
82
110
 
83
111
  Cobalt Frontend SDK
84
112
 
@@ -96,7 +124,7 @@ Cobalt Frontend SDK
96
124
 
97
125
  | Property | Modifier | Type | Defined in |
98
126
  | ------ | ------ | ------ | ------ |
99
- | <a id="token"></a> `token` | `public` | `string` | [cobalt.ts:277](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L277) |
127
+ | <a id="token"></a> `token` | `public` | `string` | [cobalt.ts:323](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L323) |
100
128
 
101
129
  #### Methods
102
130
 
@@ -104,7 +132,7 @@ Cobalt Frontend SDK
104
132
 
105
133
  > **config**(`payload`): `Promise`\<[`Config`](#config-2)\>
106
134
 
107
- Defined in: [cobalt.ts:532](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L532)
135
+ Defined in: [cobalt.ts:595](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L595)
108
136
 
109
137
  Returns the specified config, or creates one if it doesn't exist.
110
138
 
@@ -122,50 +150,36 @@ The specified config.
122
150
 
123
151
  ##### connect()
124
152
 
125
- > **connect**(`slug`, `payload?`): `Promise`\<`boolean`\>
153
+ > **connect**(`params`): `Promise`\<`boolean`\>
126
154
 
127
- Defined in: [cobalt.ts:472](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L472)
155
+ Defined in: [cobalt.ts:548](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L548)
128
156
 
129
- Connect the specified application, optionally with the auth data that user provides.
157
+ Connects the specified application using the provided authentication type and optional auth data.
130
158
 
131
159
  ###### Parameters
132
160
 
133
161
  | Parameter | Type | Description |
134
162
  | ------ | ------ | ------ |
135
- | `slug` | `string` | The application slug. |
136
- | `payload?` | `Record`\<`string`, `string`\> | The key value pairs of auth data. |
163
+ | `params` | \{ `payload?`: `Record`\<`string`, `string`\>; `slug`: `string`; `type?`: [`AuthType`](#authtype); \} | The parameters for connecting the application. |
164
+ | `params.payload?` | `Record`\<`string`, `string`\> | key-value pairs of authentication data required for the specified auth type. |
165
+ | `params.slug` | `string` | The application slug. |
166
+ | `params.type?` | [`AuthType`](#authtype) | The authentication type to use. If not provided, it defaults to `keybased` if payload is provided, otherwise `oauth2`. |
137
167
 
138
168
  ###### Returns
139
169
 
140
170
  `Promise`\<`boolean`\>
141
171
 
142
- Whether the connection was successful.
143
-
144
- ##### ~~createEcosystemLead()~~
145
-
146
- > **createEcosystemLead**(`payload`): `Promise`\<[`EcosystemLead`](#ecosystemlead)\>
147
-
148
- Defined in: [cobalt.ts:645](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L645)
149
-
150
- ###### Parameters
151
-
152
- | Parameter | Type | Description |
153
- | ------ | ------ | ------ |
154
- | `payload` | [`EcosystemLeadPayload`](#ecosystemleadpayload) | The payload object for the lead. |
155
-
156
- ###### Returns
157
-
158
- `Promise`\<[`EcosystemLead`](#ecosystemlead)\>
172
+ A promise that resolves to true if the connection was successful, otherwise false.
159
173
 
160
- ###### Deprecated
174
+ ###### Throws
161
175
 
162
- Create a lead for an ecosystem app.
176
+ Throws an error if the authentication type is invalid or the connection fails.
163
177
 
164
178
  ##### createWorkflow()
165
179
 
166
180
  > **createWorkflow**(`params`): `Promise`\<[`PublicWorkflow`](#publicworkflow)\>
167
181
 
168
- Defined in: [cobalt.ts:798](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L798)
182
+ Defined in: [cobalt.ts:837](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L837)
169
183
 
170
184
  Create a public workflow for the linked account.
171
185
 
@@ -185,7 +199,7 @@ The created public workflow.
185
199
 
186
200
  > **deleteConfig**(`slug`, `configId?`): `Promise`\<`unknown`\>
187
201
 
188
- Defined in: [cobalt.ts:623](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L623)
202
+ Defined in: [cobalt.ts:686](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L686)
189
203
 
190
204
  Delete the specified config.
191
205
 
@@ -204,7 +218,7 @@ Delete the specified config.
204
218
 
205
219
  > **deleteConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<`unknown`\>
206
220
 
207
- Defined in: [cobalt.ts:720](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L720)
221
+ Defined in: [cobalt.ts:759](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L759)
208
222
 
209
223
  Delete the specified config field value.
210
224
 
@@ -224,7 +238,7 @@ Delete the specified config field value.
224
238
 
225
239
  > **deleteWorkflow**(`workflowId`): `Promise`\<`unknown`\>
226
240
 
227
- Defined in: [cobalt.ts:826](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L826)
241
+ Defined in: [cobalt.ts:865](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L865)
228
242
 
229
243
  Delete the specified public workflow.
230
244
 
@@ -240,9 +254,9 @@ Delete the specified public workflow.
240
254
 
241
255
  ##### disconnect()
242
256
 
243
- > **disconnect**(`slug`): `Promise`\<`void`\>
257
+ > **disconnect**(`slug`, `type?`): `Promise`\<`unknown`\>
244
258
 
245
- Defined in: [cobalt.ts:513](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L513)
259
+ Defined in: [cobalt.ts:574](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L574)
246
260
 
247
261
  Disconnect the specified application and remove any associated data from Cobalt.
248
262
 
@@ -251,10 +265,29 @@ Disconnect the specified application and remove any associated data from Cobalt.
251
265
  | Parameter | Type | Description |
252
266
  | ------ | ------ | ------ |
253
267
  | `slug` | `string` | The application slug. |
268
+ | `type?` | [`AuthType`](#authtype) | The authentication type to use. If not provided, it'll remove all the connected accounts. |
254
269
 
255
270
  ###### Returns
256
271
 
257
- `Promise`\<`void`\>
272
+ `Promise`\<`unknown`\>
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`\>
258
291
 
259
292
  ##### getApp()
260
293
 
@@ -270,7 +303,7 @@ The application slug.
270
303
 
271
304
  > **getApp**(): `Promise`\<[`Application`](#application)[]\>
272
305
 
273
- Defined in: [cobalt.ts:345](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L345)
306
+ Defined in: [cobalt.ts:391](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L391)
274
307
 
275
308
  Returns the list of enabled applications and their details.
276
309
 
@@ -288,7 +321,7 @@ The application slug.
288
321
 
289
322
  > **getApp**(`slug`): `Promise`\<[`Application`](#application)\>
290
323
 
291
- Defined in: [cobalt.ts:352](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L352)
324
+ Defined in: [cobalt.ts:398](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L398)
292
325
 
293
326
  Returns the application details for the specified application, provided
294
327
  the application is enabled in Cobalt.
@@ -313,7 +346,7 @@ The application slug.
313
346
 
314
347
  > **getApps**(): `Promise`\<[`Application`](#application)[]\>
315
348
 
316
- Defined in: [cobalt.ts:380](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L380)
349
+ Defined in: [cobalt.ts:426](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L426)
317
350
 
318
351
  Returns all the enabled apps.
319
352
 
@@ -327,7 +360,7 @@ The list of applications.
327
360
 
328
361
  > **getConfig**(`slug`, `configId?`): `Promise`\<[`Config`](#config-2)\>
329
362
 
330
- Defined in: [cobalt.ts:579](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L579)
363
+ Defined in: [cobalt.ts:642](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L642)
331
364
 
332
365
  Returns the specified config.
333
366
 
@@ -348,7 +381,7 @@ The specified config.
348
381
 
349
382
  > **getConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
350
383
 
351
- Defined in: [cobalt.ts:670](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L670)
384
+ Defined in: [cobalt.ts:709](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L709)
352
385
 
353
386
  Returns the specified field of the config.
354
387
 
@@ -370,7 +403,7 @@ The specified config field.
370
403
 
371
404
  > **getConfigs**(`slug`): `Promise`\<`object`[]\>
372
405
 
373
- Defined in: [cobalt.ts:558](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L558)
406
+ Defined in: [cobalt.ts:621](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L621)
374
407
 
375
408
  Returns the configs created for the specified application.
376
409
 
@@ -390,7 +423,7 @@ The configs created for the specified application.
390
423
 
391
424
  > **getExecution**(`executionId`): `Promise`\<[`Execution`](#execution)\>
392
425
 
393
- Defined in: [cobalt.ts:869](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L869)
426
+ Defined in: [cobalt.ts:956](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L956)
394
427
 
395
428
  Returns the specified workflow execution log.
396
429
 
@@ -410,7 +443,7 @@ The specified execution log.
410
443
 
411
444
  > **getExecutions**(`params?`): `Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
412
445
 
413
- Defined in: [cobalt.ts:849](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L849)
446
+ Defined in: [cobalt.ts:936](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L936)
414
447
 
415
448
  Returns the workflow execution logs for the linked account.
416
449
 
@@ -430,7 +463,7 @@ The paginated workflow execution logs.
430
463
 
431
464
  > **getFieldOptions**(`lhs`, `slug`, `fieldId`, `workflowId?`): `Promise`\<[`RuleOptions`](#ruleoptions)\>
432
465
 
433
- Defined in: [cobalt.ts:745](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L745)
466
+ Defined in: [cobalt.ts:784](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L784)
434
467
 
435
468
  Returns the options for the specified field.
436
469
 
@@ -449,11 +482,31 @@ Returns the options for the specified field.
449
482
 
450
483
  The specified rule field's options.
451
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
+
452
505
  ##### getWorkflows()
453
506
 
454
507
  > **getWorkflows**(`params?`): `Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
455
508
 
456
- Defined in: [cobalt.ts:774](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L774)
509
+ Defined in: [cobalt.ts:813](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L813)
457
510
 
458
511
  Returns the private workflows for the specified application.
459
512
 
@@ -471,7 +524,7 @@ Returns the private workflows for the specified application.
471
524
 
472
525
  > **updateConfig**(`payload`): `Promise`\<[`Config`](#config-2)\>
473
526
 
474
- Defined in: [cobalt.ts:599](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L599)
527
+ Defined in: [cobalt.ts:662](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L662)
475
528
 
476
529
  Update the specified config.
477
530
 
@@ -491,7 +544,7 @@ The specified config.
491
544
 
492
545
  > **updateConfigField**(`slug`, `fieldId`, `value`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
493
546
 
494
- Defined in: [cobalt.ts:694](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L694)
547
+ Defined in: [cobalt.ts:733](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L733)
495
548
 
496
549
  Update the specified config field value.
497
550
 
@@ -514,7 +567,7 @@ The updated config field.
514
567
 
515
568
  ### Application
516
569
 
517
- Defined in: [cobalt.ts:6](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L6)
570
+ Defined in: [cobalt.ts:16](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L16)
518
571
 
519
572
  An application in Cobalt.
520
573
 
@@ -522,76 +575,80 @@ An application in Cobalt.
522
575
 
523
576
  | Property | Type | Description | Defined in |
524
577
  | ------ | ------ | ------ | ------ |
525
- | <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:8](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L8) |
526
- | <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/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L29) |
527
- | <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/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L23) |
528
- | <a id="connected"></a> `connected?` | `boolean` | Whether the user has connected the application. | [cobalt.ts:25](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L25) |
529
- | <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:12](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L12) |
530
- | <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:14](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L14) |
531
- | <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:10](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L10) |
532
- | <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/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L27) |
533
- | <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:21](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L21) |
534
- | <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:31](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L31) |
535
- | <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/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L19) |
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) |
582
+ | `auth_type_options.keybased` | [`InputField`](#inputfield)[] | - | |
583
+ | `auth_type_options.oauth2` | [`InputField`](#inputfield)[] | - | |
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) |
536
593
 
537
594
  ***
538
595
 
539
596
  ### CobaltOptions
540
597
 
541
- Defined in: [cobalt.ts:97](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L97)
598
+ Defined in: [cobalt.ts:135](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L135)
542
599
 
543
600
  #### Properties
544
601
 
545
602
  | Property | Type | Description | Defined in |
546
603
  | ------ | ------ | ------ | ------ |
547
- | <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/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L99) |
548
- | <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:101](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L101) |
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) |
549
606
 
550
607
  ***
551
608
 
552
609
  ### Config
553
610
 
554
- Defined in: [cobalt.ts:190](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L190)
611
+ Defined in: [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L207)
555
612
 
556
613
  #### Properties
557
614
 
558
615
  | Property | Type | Defined in |
559
616
  | ------ | ------ | ------ |
560
- | <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:192](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L192) |
561
- | <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:195](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L195) |
562
- | <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:193](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L193) |
563
- | <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:191](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L191) |
564
- | <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:194](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L194) |
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) |
565
622
 
566
623
  ***
567
624
 
568
625
  ### ConfigField
569
626
 
570
- Defined in: [cobalt.ts:205](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L205)
627
+ Defined in: [cobalt.ts:222](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L222)
571
628
 
572
629
  #### Properties
573
630
 
574
631
  | Property | Type | Description | Defined in |
575
632
  | ------ | ------ | ------ | ------ |
576
- | <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:227](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L227) |
577
- | <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:208](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L208) |
578
- | <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L225) |
579
- | <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:220](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L220) |
580
- | <a id="id"></a> `id` | `string` | - | [cobalt.ts:206](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L206) |
581
- | <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:214](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L214) |
582
- | <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:218](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L218) |
583
- | <a id="name-1"></a> `name` | `string` | - | [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L207) |
584
- | <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:209](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L209) |
585
- | <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:213](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L213) |
586
- | <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L223) |
587
- | <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:219](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L219) |
588
- | <a id="value"></a> `value?` | `any` | - | [cobalt.ts:221](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L221) |
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) |
589
646
 
590
647
  ***
591
648
 
592
649
  ### ConfigPayload
593
650
 
594
- Defined in: [cobalt.ts:58](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L58)
651
+ Defined in: [cobalt.ts:96](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L96)
595
652
 
596
653
  The payload object for config.
597
654
 
@@ -599,105 +656,87 @@ The payload object for config.
599
656
 
600
657
  | Property | Type | Description | Defined in |
601
658
  | ------ | ------ | ------ | ------ |
602
- | <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:62](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L62) |
603
- | <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:64](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L64) |
604
- | <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:60](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L60) |
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) |
605
662
 
606
663
  ***
607
664
 
608
665
  ### ConfigWorkflow
609
666
 
610
- Defined in: [cobalt.ts:230](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L230)
667
+ Defined in: [cobalt.ts:247](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L247)
611
668
 
612
669
  #### Properties
613
670
 
614
671
  | Property | Type | Defined in |
615
672
  | ------ | ------ | ------ |
616
- | <a id="description-1"></a> `description?` | `string` | [cobalt.ts:233](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L233) |
617
- | <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:234](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L234) |
618
- | <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:235](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L235) |
619
- | <a id="id-1"></a> `id` | `string` | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L231) |
620
- | <a id="name-2"></a> `name` | `string` | [cobalt.ts:232](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L232) |
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) |
621
678
 
622
679
  ***
623
680
 
624
- ### ~~EcosystemLead~~
681
+ ### ExecuteWorkflowPayload
625
682
 
626
- Defined in: [cobalt.ts:107](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L107)
627
-
628
- #### Deprecated
683
+ Defined in: [cobalt.ts:261](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L261)
629
684
 
630
685
  #### Properties
631
686
 
632
- | Property | Type | Defined in |
633
- | ------ | ------ | ------ |
634
- | <a id="_id"></a> ~~`_id`~~ | `string` | [cobalt.ts:108](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L108) |
635
- | <a id="created_at"></a> ~~`created_at`~~ | `string` | [cobalt.ts:112](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L112) |
636
- | <a id="description-2"></a> ~~`description?`~~ | `string` | [cobalt.ts:111](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L111) |
637
- | <a id="email"></a> ~~`email`~~ | `string` | [cobalt.ts:110](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L110) |
638
- | <a id="name-3"></a> ~~`name?`~~ | `string` | [cobalt.ts:109](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L109) |
639
-
640
- ***
641
-
642
- ### ~~EcosystemLeadPayload~~
643
-
644
- Defined in: [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L118)
645
-
646
- #### Deprecated
647
-
648
- #### Properties
649
-
650
- | Property | Type | Defined in |
651
- | ------ | ------ | ------ |
652
- | <a id="description-3"></a> ~~`description?`~~ | `string` | [cobalt.ts:122](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L122) |
653
- | <a id="email-1"></a> ~~`email`~~ | `string` | [cobalt.ts:121](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L121) |
654
- | <a id="name-4"></a> ~~`name?`~~ | `string` | [cobalt.ts:120](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L120) |
655
- | <a id="slug-3"></a> ~~`slug`~~ | `string` | [cobalt.ts:119](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L119) |
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) |
656
693
 
657
694
  ***
658
695
 
659
696
  ### Execution
660
697
 
661
- Defined in: [cobalt.ts:238](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L238)
698
+ Defined in: [cobalt.ts:272](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L272)
662
699
 
663
700
  #### Properties
664
701
 
665
702
  | Property | Type | Defined in |
666
703
  | ------ | ------ | ------ |
667
- | <a id="_id-1"></a> `_id` | `string` | [cobalt.ts:239](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L239) |
668
- | <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:243](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L243) |
669
- | `associated_application._id` | `string` | [cobalt.ts:244](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L244) |
670
- | `associated_application.icon?` | `string` | [cobalt.ts:246](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L246) |
671
- | `associated_application.name` | `string` | [cobalt.ts:245](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L245) |
672
- | <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:267](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L267) |
673
- | <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:253](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L253) |
674
- | `associated_trigger_application._id` | `string` | [cobalt.ts:254](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L254) |
675
- | `associated_trigger_application.app_type?` | `string` | [cobalt.ts:257](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L257) |
676
- | `associated_trigger_application.icon?` | `string` | [cobalt.ts:256](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L256) |
677
- | `associated_trigger_application.name` | `string` | [cobalt.ts:255](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L255) |
678
- | `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:258](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L258) |
679
- | `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:259](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L259) |
680
- | `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:260](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L260) |
681
- | <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:249](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L249) |
682
- | `associated_workflow._id` | `string` | [cobalt.ts:250](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L250) |
683
- | `associated_workflow.name` | `string` | [cobalt.ts:251](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L251) |
684
- | <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:266](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L266) |
685
- | <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:270](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L270) |
686
- | <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:269](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L269) |
687
- | <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:268](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L268) |
688
- | <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:265](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L265) |
689
- | <a id="id-2"></a> `id?` | `string` | [cobalt.ts:240](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L240) |
690
- | <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:264](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L264) |
691
- | <a id="name-5"></a> `name` | `string` | [cobalt.ts:241](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L241) |
692
- | <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:242](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L242) |
693
- | <a id="status"></a> `status` | `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"` | [cobalt.ts:248](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L248) |
694
- | <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:263](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L263) |
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) |
695
734
 
696
735
  ***
697
736
 
698
737
  ### InputField
699
738
 
700
- Defined in: [cobalt.ts:35](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L35)
739
+ Defined in: [cobalt.ts:73](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L73)
701
740
 
702
741
  An Input field to take input from the user.
703
742
 
@@ -705,20 +744,20 @@ An Input field to take input from the user.
705
744
 
706
745
  | Property | Type | Description | Defined in |
707
746
  | ------ | ------ | ------ | ------ |
708
- | <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/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L49) |
709
- | <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:47](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L47) |
710
- | <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:43](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L43) |
711
- | <a id="name-6"></a> `name` | `string` | Key name of the field. | [cobalt.ts:37](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L37) |
712
- | <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:51](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L51) |
713
- | <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:45](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L45) |
714
- | <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:41](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L41) |
715
- | <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:39](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L39) |
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) |
716
755
 
717
756
  ***
718
757
 
719
758
  ### Label
720
759
 
721
- Defined in: [cobalt.ts:68](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L68)
760
+ Defined in: [cobalt.ts:106](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L106)
722
761
 
723
762
  Label Mapping
724
763
 
@@ -726,14 +765,14 @@ Label Mapping
726
765
 
727
766
  | Property | Type | Description | Defined in |
728
767
  | ------ | ------ | ------ | ------ |
729
- | <a id="name-7"></a> `name` | `string` | The label name. | [cobalt.ts:70](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L70) |
730
- | <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:72](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L72) |
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) |
731
770
 
732
771
  ***
733
772
 
734
773
  ### PublicWorkflow
735
774
 
736
- Defined in: [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L146)
775
+ Defined in: [cobalt.ts:163](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L163)
737
776
 
738
777
  A public workflow in Cobalt.
739
778
 
@@ -741,19 +780,19 @@ A public workflow in Cobalt.
741
780
 
742
781
  | Property | Type | Description | Defined in |
743
782
  | ------ | ------ | ------ | ------ |
744
- | <a id="_id-2"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:148](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L148) |
745
- | <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:156](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L156) |
746
- | <a id="description-4"></a> `description?` | `string` | The workflow description. | [cobalt.ts:152](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L152) |
747
- | <a id="name-8"></a> `name` | `string` | The workflow name. | [cobalt.ts:150](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L150) |
748
- | <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:160](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L160) |
749
- | <a id="slug-4"></a> `slug?` | `string` | The application's slug in which this workflow exists. | [cobalt.ts:154](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L154) |
750
- | <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [cobalt.ts:158](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L158) |
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) |
751
790
 
752
791
  ***
753
792
 
754
793
  ### PublicWorkflowPayload
755
794
 
756
- Defined in: [cobalt.ts:164](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L164)
795
+ Defined in: [cobalt.ts:181](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L181)
757
796
 
758
797
  The payload for creating a public workflow for the linked account.
759
798
 
@@ -761,15 +800,15 @@ The payload for creating a public workflow for the linked account.
761
800
 
762
801
  | Property | Type | Description | Defined in |
763
802
  | ------ | ------ | ------ | ------ |
764
- | <a id="description-5"></a> `description?` | `string` | The workflow description. | [cobalt.ts:168](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L168) |
765
- | <a id="name-9"></a> `name` | `string` | The workflow name. | [cobalt.ts:166](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L166) |
766
- | <a id="slug-5"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [cobalt.ts:170](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L170) |
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) |
767
806
 
768
807
  ***
769
808
 
770
809
  ### PublicWorkflowsPayload
771
810
 
772
- Defined in: [cobalt.ts:173](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L173)
811
+ Defined in: [cobalt.ts:190](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L190)
773
812
 
774
813
  #### Extends
775
814
 
@@ -779,39 +818,39 @@ Defined in: [cobalt.ts:173](https://github.com/gocobalt/cobalt-js/blob/75a69bc12
779
818
 
780
819
  | Property | Type | Inherited from | Defined in |
781
820
  | ------ | ------ | ------ | ------ |
782
- | <a id="limit"></a> `limit?` | `number` | `PaginationProps.limit` | [cobalt.ts:179](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L179) |
783
- | <a id="page"></a> `page?` | `number` | `PaginationProps.page` | [cobalt.ts:178](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L178) |
784
- | <a id="slug-6"></a> `slug?` | `string` | - | [cobalt.ts:174](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L174) |
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) |
785
824
 
786
825
  ***
787
826
 
788
827
  ### RuleOptions
789
828
 
790
- Defined in: [cobalt.ts:125](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L125)
829
+ Defined in: [cobalt.ts:142](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L142)
791
830
 
792
831
  #### Properties
793
832
 
794
833
  | Property | Type | Defined in |
795
834
  | ------ | ------ | ------ |
796
- | <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:138](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L138) |
797
- | <a id="error"></a> `error?` | `object` | [cobalt.ts:139](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L139) |
798
- | `error.message?` | `string` | [cobalt.ts:140](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L140) |
799
- | `error.stack?` | `string` | [cobalt.ts:141](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L141) |
800
- | <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L126) |
801
- | `rule_column.operator` | `object` | [cobalt.ts:132](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L132) |
802
- | `rule_column.operator.name` | `string` | [cobalt.ts:133](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L133) |
803
- | `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:135](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L135) |
804
- | `rule_column.operator.type` | `"select"` | [cobalt.ts:134](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L134) |
805
- | `rule_column.rhs` | `object` | [cobalt.ts:127](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L127) |
806
- | `rule_column.rhs.name` | `string` | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L128) |
807
- | `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:130](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L130) |
808
- | `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:129](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L129) |
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) |
809
848
 
810
849
  ***
811
850
 
812
851
  ### UpdateConfigPayload
813
852
 
814
- Defined in: [cobalt.ts:76](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L76)
853
+ Defined in: [cobalt.ts:114](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L114)
815
854
 
816
855
  The configuration data for an application.
817
856
 
@@ -819,16 +858,16 @@ The configuration data for an application.
819
858
 
820
859
  | Property | Type | Description | Defined in |
821
860
  | ------ | ------ | ------ | ------ |
822
- | <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:80](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L80) |
823
- | <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/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L82) |
824
- | <a id="slug-7"></a> `slug` | `string` | The application slug | [cobalt.ts:78](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L78) |
825
- | <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:84](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L84) |
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) |
826
865
 
827
866
  ***
828
867
 
829
868
  ### WorkflowPayload
830
869
 
831
- Defined in: [cobalt.ts:88](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L88)
870
+ Defined in: [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/e0fb46a98d8b881d3e37d2b779eb45568a50b1b1/cobalt.ts#L126)
832
871
 
833
872
  The workflow.
834
873
 
@@ -836,6 +875,20 @@ The workflow.
836
875
 
837
876
  | Property | Type | Description | Defined in |
838
877
  | ------ | ------ | ------ | ------ |
839
- | <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:92](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L92) |
840
- | <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/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L94) |
841
- | <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:90](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L90) |
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) |