@cobaltio/cobalt-js 8.8.0 → 8.9.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/cobalt.d.ts +91 -7
- package/cobalt.js +47 -4
- package/cobalt.ts +124 -9
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/Cobalt.html +29 -21
- package/docs/interfaces/Application.html +18 -13
- package/docs/interfaces/CobaltOptions.html +3 -3
- package/docs/interfaces/Config.html +2 -2
- package/docs/interfaces/ConfigField.html +8 -2
- package/docs/interfaces/ConfigPayload.html +4 -4
- package/docs/interfaces/ConfigWorkflow.html +2 -2
- package/docs/interfaces/EcosystemLead.html +6 -6
- package/docs/interfaces/EcosystemLeadPayload.html +5 -5
- package/docs/interfaces/Execution.html +17 -0
- package/docs/interfaces/InputField.html +13 -7
- package/docs/interfaces/Label.html +3 -3
- package/docs/interfaces/PublicWorkflow.html +4 -4
- package/docs/interfaces/PublicWorkflowPayload.html +4 -4
- package/docs/interfaces/PublicWorkflowsPayload.html +2 -2
- package/docs/interfaces/RuleOptions.html +2 -2
- package/docs/interfaces/UpdateConfigPayload.html +5 -5
- package/docs/interfaces/WorkflowPayload.html +4 -4
- package/docs/llms.txt +221 -126
- package/docs/modules.html +1 -1
- package/package.json +1 -1
package/docs/llms.txt
CHANGED
|
@@ -70,7 +70,7 @@ cobalt.token = "COBALT_SESSION_TOKEN";
|
|
|
70
70
|
|
|
71
71
|
### Cobalt
|
|
72
72
|
|
|
73
|
-
Defined in: [cobalt.ts:
|
|
73
|
+
Defined in: [cobalt.ts:267](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L267)
|
|
74
74
|
|
|
75
75
|
#### Constructors
|
|
76
76
|
|
|
@@ -78,7 +78,7 @@ Defined in: [cobalt.ts:196](https://github.com/gocobalt/cobalt-js/blob/b0775f9f6
|
|
|
78
78
|
|
|
79
79
|
> **new Cobalt**(`options`): [`Cobalt`](#cobalt)
|
|
80
80
|
|
|
81
|
-
Defined in: [cobalt.ts:
|
|
81
|
+
Defined in: [cobalt.ts:277](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L277)
|
|
82
82
|
|
|
83
83
|
Cobalt Frontend SDK
|
|
84
84
|
|
|
@@ -96,7 +96,7 @@ Cobalt Frontend SDK
|
|
|
96
96
|
|
|
97
97
|
| Property | Modifier | Type | Defined in |
|
|
98
98
|
| ------ | ------ | ------ | ------ |
|
|
99
|
-
| <a id="token"></a> `token` | `public` | `string` | [cobalt.ts:
|
|
99
|
+
| <a id="token"></a> `token` | `public` | `string` | [cobalt.ts:269](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L269) |
|
|
100
100
|
|
|
101
101
|
#### Methods
|
|
102
102
|
|
|
@@ -104,7 +104,7 @@ Cobalt Frontend SDK
|
|
|
104
104
|
|
|
105
105
|
> **config**(`payload`): `Promise`\<[`Config`](#config-2)\>
|
|
106
106
|
|
|
107
|
-
Defined in: [cobalt.ts:
|
|
107
|
+
Defined in: [cobalt.ts:524](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L524)
|
|
108
108
|
|
|
109
109
|
Returns the specified config, or creates one if it doesn't exist.
|
|
110
110
|
|
|
@@ -124,7 +124,7 @@ The specified config.
|
|
|
124
124
|
|
|
125
125
|
> **connect**(`slug`, `payload?`): `Promise`\<`boolean`\>
|
|
126
126
|
|
|
127
|
-
Defined in: [cobalt.ts:
|
|
127
|
+
Defined in: [cobalt.ts:464](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L464)
|
|
128
128
|
|
|
129
129
|
Connect the specified application, optionally with the auth data that user provides.
|
|
130
130
|
|
|
@@ -141,13 +141,11 @@ Connect the specified application, optionally with the auth data that user provi
|
|
|
141
141
|
|
|
142
142
|
Whether the connection was successful.
|
|
143
143
|
|
|
144
|
-
##### createEcosystemLead()
|
|
144
|
+
##### ~~createEcosystemLead()~~
|
|
145
145
|
|
|
146
146
|
> **createEcosystemLead**(`payload`): `Promise`\<[`EcosystemLead`](#ecosystemlead)\>
|
|
147
147
|
|
|
148
|
-
Defined in: [cobalt.ts:
|
|
149
|
-
|
|
150
|
-
Create a lead for an ecosystem app.
|
|
148
|
+
Defined in: [cobalt.ts:637](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L637)
|
|
151
149
|
|
|
152
150
|
###### Parameters
|
|
153
151
|
|
|
@@ -159,11 +157,15 @@ Create a lead for an ecosystem app.
|
|
|
159
157
|
|
|
160
158
|
`Promise`\<[`EcosystemLead`](#ecosystemlead)\>
|
|
161
159
|
|
|
160
|
+
###### Deprecated
|
|
161
|
+
|
|
162
|
+
Create a lead for an ecosystem app.
|
|
163
|
+
|
|
162
164
|
##### createWorkflow()
|
|
163
165
|
|
|
164
166
|
> **createWorkflow**(`params`): `Promise`\<[`PublicWorkflow`](#publicworkflow)\>
|
|
165
167
|
|
|
166
|
-
Defined in: [cobalt.ts:
|
|
168
|
+
Defined in: [cobalt.ts:790](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L790)
|
|
167
169
|
|
|
168
170
|
Create a public workflow for the linked account.
|
|
169
171
|
|
|
@@ -183,7 +185,7 @@ The created public workflow.
|
|
|
183
185
|
|
|
184
186
|
> **deleteConfig**(`slug`, `configId?`): `Promise`\<`unknown`\>
|
|
185
187
|
|
|
186
|
-
Defined in: [cobalt.ts:
|
|
188
|
+
Defined in: [cobalt.ts:615](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L615)
|
|
187
189
|
|
|
188
190
|
Delete the specified config.
|
|
189
191
|
|
|
@@ -202,7 +204,7 @@ Delete the specified config.
|
|
|
202
204
|
|
|
203
205
|
> **deleteConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<`unknown`\>
|
|
204
206
|
|
|
205
|
-
Defined in: [cobalt.ts:
|
|
207
|
+
Defined in: [cobalt.ts:712](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L712)
|
|
206
208
|
|
|
207
209
|
Delete the specified config field value.
|
|
208
210
|
|
|
@@ -222,7 +224,7 @@ Delete the specified config field value.
|
|
|
222
224
|
|
|
223
225
|
> **deleteWorkflow**(`workflowId`): `Promise`\<`unknown`\>
|
|
224
226
|
|
|
225
|
-
Defined in: [cobalt.ts:
|
|
227
|
+
Defined in: [cobalt.ts:818](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L818)
|
|
226
228
|
|
|
227
229
|
Delete the specified public workflow.
|
|
228
230
|
|
|
@@ -240,7 +242,7 @@ Delete the specified public workflow.
|
|
|
240
242
|
|
|
241
243
|
> **disconnect**(`slug`): `Promise`\<`void`\>
|
|
242
244
|
|
|
243
|
-
Defined in: [cobalt.ts:
|
|
245
|
+
Defined in: [cobalt.ts:505](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L505)
|
|
244
246
|
|
|
245
247
|
Disconnect the specified application and remove any associated data from Cobalt.
|
|
246
248
|
|
|
@@ -268,7 +270,7 @@ The application slug.
|
|
|
268
270
|
|
|
269
271
|
> **getApp**(): `Promise`\<[`Application`](#application)[]\>
|
|
270
272
|
|
|
271
|
-
Defined in: [cobalt.ts:
|
|
273
|
+
Defined in: [cobalt.ts:337](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L337)
|
|
272
274
|
|
|
273
275
|
Returns the list of enabled applications and their details.
|
|
274
276
|
|
|
@@ -286,7 +288,7 @@ The application slug.
|
|
|
286
288
|
|
|
287
289
|
> **getApp**(`slug`): `Promise`\<[`Application`](#application)\>
|
|
288
290
|
|
|
289
|
-
Defined in: [cobalt.ts:
|
|
291
|
+
Defined in: [cobalt.ts:344](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L344)
|
|
290
292
|
|
|
291
293
|
Returns the application details for the specified application, provided
|
|
292
294
|
the application is enabled in Cobalt.
|
|
@@ -311,9 +313,9 @@ The application slug.
|
|
|
311
313
|
|
|
312
314
|
> **getApps**(): `Promise`\<[`Application`](#application)[]\>
|
|
313
315
|
|
|
314
|
-
Defined in: [cobalt.ts:
|
|
316
|
+
Defined in: [cobalt.ts:372](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L372)
|
|
315
317
|
|
|
316
|
-
Returns all the enabled
|
|
318
|
+
Returns all the enabled apps.
|
|
317
319
|
|
|
318
320
|
###### Returns
|
|
319
321
|
|
|
@@ -325,7 +327,7 @@ The list of applications.
|
|
|
325
327
|
|
|
326
328
|
> **getConfig**(`slug`, `configId?`): `Promise`\<[`Config`](#config-2)\>
|
|
327
329
|
|
|
328
|
-
Defined in: [cobalt.ts:
|
|
330
|
+
Defined in: [cobalt.ts:571](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L571)
|
|
329
331
|
|
|
330
332
|
Returns the specified config.
|
|
331
333
|
|
|
@@ -346,7 +348,7 @@ The specified config.
|
|
|
346
348
|
|
|
347
349
|
> **getConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
|
|
348
350
|
|
|
349
|
-
Defined in: [cobalt.ts:
|
|
351
|
+
Defined in: [cobalt.ts:662](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L662)
|
|
350
352
|
|
|
351
353
|
Returns the specified field of the config.
|
|
352
354
|
|
|
@@ -368,7 +370,7 @@ The specified config field.
|
|
|
368
370
|
|
|
369
371
|
> **getConfigs**(`slug`): `Promise`\<`object`[]\>
|
|
370
372
|
|
|
371
|
-
Defined in: [cobalt.ts:
|
|
373
|
+
Defined in: [cobalt.ts:550](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L550)
|
|
372
374
|
|
|
373
375
|
Returns the configs created for the specified application.
|
|
374
376
|
|
|
@@ -384,11 +386,51 @@ Returns the configs created for the specified application.
|
|
|
384
386
|
|
|
385
387
|
The configs created for the specified application.
|
|
386
388
|
|
|
389
|
+
##### getExecution()
|
|
390
|
+
|
|
391
|
+
> **getExecution**(`executionId`): `Promise`\<[`Execution`](#execution)\>
|
|
392
|
+
|
|
393
|
+
Defined in: [cobalt.ts:861](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L861)
|
|
394
|
+
|
|
395
|
+
Returns the specified workflow execution log.
|
|
396
|
+
|
|
397
|
+
###### Parameters
|
|
398
|
+
|
|
399
|
+
| Parameter | Type | Description |
|
|
400
|
+
| ------ | ------ | ------ |
|
|
401
|
+
| `executionId` | `string` | The execution ID. |
|
|
402
|
+
|
|
403
|
+
###### Returns
|
|
404
|
+
|
|
405
|
+
`Promise`\<[`Execution`](#execution)\>
|
|
406
|
+
|
|
407
|
+
The specified execution log.
|
|
408
|
+
|
|
409
|
+
##### getExecutions()
|
|
410
|
+
|
|
411
|
+
> **getExecutions**(`params?`): `Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
|
|
412
|
+
|
|
413
|
+
Defined in: [cobalt.ts:841](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L841)
|
|
414
|
+
|
|
415
|
+
Returns the workflow execution logs for the linked account.
|
|
416
|
+
|
|
417
|
+
###### Parameters
|
|
418
|
+
|
|
419
|
+
| Parameter | Type | Description |
|
|
420
|
+
| ------ | ------ | ------ |
|
|
421
|
+
| `params?` | `PaginationProps` | |
|
|
422
|
+
|
|
423
|
+
###### Returns
|
|
424
|
+
|
|
425
|
+
`Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
|
|
426
|
+
|
|
427
|
+
The paginated workflow execution logs.
|
|
428
|
+
|
|
387
429
|
##### getFieldOptions()
|
|
388
430
|
|
|
389
431
|
> **getFieldOptions**(`lhs`, `slug`, `fieldId`, `workflowId?`): `Promise`\<[`RuleOptions`](#ruleoptions)\>
|
|
390
432
|
|
|
391
|
-
Defined in: [cobalt.ts:
|
|
433
|
+
Defined in: [cobalt.ts:737](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L737)
|
|
392
434
|
|
|
393
435
|
Returns the options for the specified field.
|
|
394
436
|
|
|
@@ -409,9 +451,11 @@ The specified rule field's options.
|
|
|
409
451
|
|
|
410
452
|
##### getWorkflows()
|
|
411
453
|
|
|
412
|
-
> **getWorkflows**(`params?`): `Promise`\<[`PublicWorkflow`](#publicworkflow)
|
|
454
|
+
> **getWorkflows**(`params?`): `Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
|
|
455
|
+
|
|
456
|
+
Defined in: [cobalt.ts:766](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L766)
|
|
413
457
|
|
|
414
|
-
|
|
458
|
+
Returns the private workflows for the specified application.
|
|
415
459
|
|
|
416
460
|
###### Parameters
|
|
417
461
|
|
|
@@ -421,13 +465,13 @@ Defined in: [cobalt.ts:694](https://github.com/gocobalt/cobalt-js/blob/b0775f9f6
|
|
|
421
465
|
|
|
422
466
|
###### Returns
|
|
423
467
|
|
|
424
|
-
`Promise`\<[`PublicWorkflow`](#publicworkflow)
|
|
468
|
+
`Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
|
|
425
469
|
|
|
426
470
|
##### updateConfig()
|
|
427
471
|
|
|
428
472
|
> **updateConfig**(`payload`): `Promise`\<[`Config`](#config-2)\>
|
|
429
473
|
|
|
430
|
-
Defined in: [cobalt.ts:
|
|
474
|
+
Defined in: [cobalt.ts:591](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L591)
|
|
431
475
|
|
|
432
476
|
Update the specified config.
|
|
433
477
|
|
|
@@ -447,7 +491,7 @@ The specified config.
|
|
|
447
491
|
|
|
448
492
|
> **updateConfigField**(`slug`, `fieldId`, `value`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
|
|
449
493
|
|
|
450
|
-
Defined in: [cobalt.ts:
|
|
494
|
+
Defined in: [cobalt.ts:686](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L686)
|
|
451
495
|
|
|
452
496
|
Update the specified config field value.
|
|
453
497
|
|
|
@@ -470,7 +514,7 @@ The updated config field.
|
|
|
470
514
|
|
|
471
515
|
### Application
|
|
472
516
|
|
|
473
|
-
Defined in: [cobalt.ts:6](https://github.com/gocobalt/cobalt-js/blob/
|
|
517
|
+
Defined in: [cobalt.ts:6](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L6)
|
|
474
518
|
|
|
475
519
|
An application in Cobalt.
|
|
476
520
|
|
|
@@ -478,71 +522,76 @@ An application in Cobalt.
|
|
|
478
522
|
|
|
479
523
|
| Property | Type | Description | Defined in |
|
|
480
524
|
| ------ | ------ | ------ | ------ |
|
|
481
|
-
| <a id="
|
|
482
|
-
| <a id="
|
|
483
|
-
| <a id="
|
|
484
|
-
| <a id="
|
|
485
|
-
| <a id="
|
|
486
|
-
| <a id="
|
|
487
|
-
| <a id="
|
|
488
|
-
| <a id="
|
|
489
|
-
| <a id="
|
|
525
|
+
| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:8](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L25) |
|
|
529
|
+
| <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:12](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L12) |
|
|
530
|
+
| <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:14](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L14) |
|
|
531
|
+
| <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:10](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L27) |
|
|
533
|
+
| <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:21](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L19) |
|
|
490
536
|
|
|
491
537
|
***
|
|
492
538
|
|
|
493
539
|
### CobaltOptions
|
|
494
540
|
|
|
495
|
-
Defined in: [cobalt.ts:
|
|
541
|
+
Defined in: [cobalt.ts:97](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L97)
|
|
496
542
|
|
|
497
543
|
#### Properties
|
|
498
544
|
|
|
499
545
|
| Property | Type | Description | Defined in |
|
|
500
546
|
| ------ | ------ | ------ | ------ |
|
|
501
|
-
| <a id="baseurl"></a> `baseUrl?` | `string` | The base URL of the Cobalt API. You don't need to set this. | [cobalt.ts:
|
|
502
|
-
| <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:
|
|
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/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L99) |
|
|
548
|
+
| <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:101](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L101) |
|
|
503
549
|
|
|
504
550
|
***
|
|
505
551
|
|
|
506
552
|
### Config
|
|
507
553
|
|
|
508
|
-
Defined in: [cobalt.ts:
|
|
554
|
+
Defined in: [cobalt.ts:182](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L182)
|
|
509
555
|
|
|
510
556
|
#### Properties
|
|
511
557
|
|
|
512
558
|
| Property | Type | Defined in |
|
|
513
559
|
| ------ | ------ | ------ |
|
|
514
|
-
| <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:
|
|
515
|
-
| <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:
|
|
516
|
-
| <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:
|
|
517
|
-
| <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:
|
|
518
|
-
| <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:
|
|
560
|
+
| <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:184](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L184) |
|
|
561
|
+
| <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:187](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L187) |
|
|
562
|
+
| <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:185](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L185) |
|
|
563
|
+
| <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:183](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L183) |
|
|
564
|
+
| <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:186](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L186) |
|
|
519
565
|
|
|
520
566
|
***
|
|
521
567
|
|
|
522
568
|
### ConfigField
|
|
523
569
|
|
|
524
|
-
Defined in: [cobalt.ts:
|
|
570
|
+
Defined in: [cobalt.ts:197](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L197)
|
|
525
571
|
|
|
526
572
|
#### Properties
|
|
527
573
|
|
|
528
|
-
| Property | Type | Defined in |
|
|
529
|
-
| ------ | ------ | ------ |
|
|
530
|
-
| <a id="
|
|
531
|
-
| <a id="
|
|
532
|
-
| <a id="
|
|
533
|
-
| <a id="
|
|
534
|
-
| <a id="
|
|
535
|
-
| <a id="
|
|
536
|
-
| <a id="
|
|
537
|
-
| <a id="
|
|
538
|
-
| <a id="
|
|
539
|
-
| <a id="
|
|
574
|
+
| Property | Type | Description | Defined in |
|
|
575
|
+
| ------ | ------ | ------ | ------ |
|
|
576
|
+
| <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:219](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L219) |
|
|
577
|
+
| <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:200](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L200) |
|
|
578
|
+
| <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:217](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L217) |
|
|
579
|
+
| <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:212](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L212) |
|
|
580
|
+
| <a id="id"></a> `id` | `string` | - | [cobalt.ts:198](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L198) |
|
|
581
|
+
| <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:206](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L206) |
|
|
582
|
+
| <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:210](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L210) |
|
|
583
|
+
| <a id="name-1"></a> `name` | `string` | - | [cobalt.ts:199](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L199) |
|
|
584
|
+
| <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:201](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L201) |
|
|
585
|
+
| <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:205](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L205) |
|
|
586
|
+
| <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:215](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L215) |
|
|
587
|
+
| <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:211](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L211) |
|
|
588
|
+
| <a id="value"></a> `value?` | `any` | - | [cobalt.ts:213](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L213) |
|
|
540
589
|
|
|
541
590
|
***
|
|
542
591
|
|
|
543
592
|
### ConfigPayload
|
|
544
593
|
|
|
545
|
-
Defined in: [cobalt.ts:
|
|
594
|
+
Defined in: [cobalt.ts:58](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L58)
|
|
546
595
|
|
|
547
596
|
The payload object for config.
|
|
548
597
|
|
|
@@ -550,62 +599,105 @@ The payload object for config.
|
|
|
550
599
|
|
|
551
600
|
| Property | Type | Description | Defined in |
|
|
552
601
|
| ------ | ------ | ------ | ------ |
|
|
553
|
-
| <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:
|
|
554
|
-
| <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:
|
|
555
|
-
| <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:
|
|
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/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L64) |
|
|
604
|
+
| <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:60](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L60) |
|
|
556
605
|
|
|
557
606
|
***
|
|
558
607
|
|
|
559
608
|
### ConfigWorkflow
|
|
560
609
|
|
|
561
|
-
Defined in: [cobalt.ts:
|
|
610
|
+
Defined in: [cobalt.ts:222](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L222)
|
|
562
611
|
|
|
563
612
|
#### Properties
|
|
564
613
|
|
|
565
614
|
| Property | Type | Defined in |
|
|
566
615
|
| ------ | ------ | ------ |
|
|
567
|
-
| <a id="description-1"></a> `description?` | `string` | [cobalt.ts:
|
|
568
|
-
| <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:
|
|
569
|
-
| <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:
|
|
570
|
-
| <a id="id-1"></a> `id` | `string` | [cobalt.ts:
|
|
571
|
-
| <a id="name-2"></a> `name` | `string` | [cobalt.ts:
|
|
616
|
+
| <a id="description-1"></a> `description?` | `string` | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L225) |
|
|
617
|
+
| <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:226](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L226) |
|
|
618
|
+
| <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:227](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L227) |
|
|
619
|
+
| <a id="id-1"></a> `id` | `string` | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L223) |
|
|
620
|
+
| <a id="name-2"></a> `name` | `string` | [cobalt.ts:224](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L224) |
|
|
572
621
|
|
|
573
622
|
***
|
|
574
623
|
|
|
575
|
-
### EcosystemLead
|
|
624
|
+
### ~~EcosystemLead~~
|
|
625
|
+
|
|
626
|
+
Defined in: [cobalt.ts:107](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L107)
|
|
627
|
+
|
|
628
|
+
#### Deprecated
|
|
629
|
+
|
|
630
|
+
#### Properties
|
|
631
|
+
|
|
632
|
+
| Property | Type | Defined in |
|
|
633
|
+
| ------ | ------ | ------ |
|
|
634
|
+
| <a id="_id"></a> ~~`_id`~~ | `string` | [cobalt.ts:108](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L108) |
|
|
635
|
+
| <a id="created_at"></a> ~~`created_at`~~ | `string` | [cobalt.ts:112](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L112) |
|
|
636
|
+
| <a id="description-2"></a> ~~`description?`~~ | `string` | [cobalt.ts:111](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L111) |
|
|
637
|
+
| <a id="email"></a> ~~`email`~~ | `string` | [cobalt.ts:110](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L110) |
|
|
638
|
+
| <a id="name-3"></a> ~~`name?`~~ | `string` | [cobalt.ts:109](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L109) |
|
|
639
|
+
|
|
640
|
+
***
|
|
641
|
+
|
|
642
|
+
### ~~EcosystemLeadPayload~~
|
|
643
|
+
|
|
644
|
+
Defined in: [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L118)
|
|
576
645
|
|
|
577
|
-
|
|
646
|
+
#### Deprecated
|
|
578
647
|
|
|
579
648
|
#### Properties
|
|
580
649
|
|
|
581
650
|
| Property | Type | Defined in |
|
|
582
651
|
| ------ | ------ | ------ |
|
|
583
|
-
| <a id="
|
|
584
|
-
| <a id="
|
|
585
|
-
| <a id="
|
|
586
|
-
| <a id="
|
|
587
|
-
| <a id="name-3"></a> `name?` | `string` | [cobalt.ts:90](https://github.com/gocobalt/cobalt-js/blob/b0775f9f64cc18029ce91bf46d52322be65eaa24/cobalt.ts#L90) |
|
|
652
|
+
| <a id="description-3"></a> ~~`description?`~~ | `string` | [cobalt.ts:122](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L122) |
|
|
653
|
+
| <a id="email-1"></a> ~~`email`~~ | `string` | [cobalt.ts:121](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L121) |
|
|
654
|
+
| <a id="name-4"></a> ~~`name?`~~ | `string` | [cobalt.ts:120](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L120) |
|
|
655
|
+
| <a id="slug-3"></a> ~~`slug`~~ | `string` | [cobalt.ts:119](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L119) |
|
|
588
656
|
|
|
589
657
|
***
|
|
590
658
|
|
|
591
|
-
###
|
|
659
|
+
### Execution
|
|
592
660
|
|
|
593
|
-
Defined in: [cobalt.ts:
|
|
661
|
+
Defined in: [cobalt.ts:230](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L230)
|
|
594
662
|
|
|
595
663
|
#### Properties
|
|
596
664
|
|
|
597
665
|
| Property | Type | Defined in |
|
|
598
666
|
| ------ | ------ | ------ |
|
|
599
|
-
| <a id="
|
|
600
|
-
| <a id="
|
|
601
|
-
|
|
|
602
|
-
|
|
|
667
|
+
| <a id="_id-1"></a> `_id` | `string` | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L231) |
|
|
668
|
+
| <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:235](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L235) |
|
|
669
|
+
| `associated_application._id` | `string` | [cobalt.ts:236](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L236) |
|
|
670
|
+
| `associated_application.icon?` | `string` | [cobalt.ts:238](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L238) |
|
|
671
|
+
| `associated_application.name` | `string` | [cobalt.ts:237](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L237) |
|
|
672
|
+
| <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:259](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L259) |
|
|
673
|
+
| <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:245](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L245) |
|
|
674
|
+
| `associated_trigger_application._id` | `string` | [cobalt.ts:246](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L246) |
|
|
675
|
+
| `associated_trigger_application.app_type?` | `string` | [cobalt.ts:249](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L249) |
|
|
676
|
+
| `associated_trigger_application.icon?` | `string` | [cobalt.ts:248](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L248) |
|
|
677
|
+
| `associated_trigger_application.name` | `string` | [cobalt.ts:247](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L247) |
|
|
678
|
+
| `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:250](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L250) |
|
|
679
|
+
| `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:251](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L251) |
|
|
680
|
+
| `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:252](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L252) |
|
|
681
|
+
| <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:241](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L241) |
|
|
682
|
+
| `associated_workflow._id` | `string` | [cobalt.ts:242](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L242) |
|
|
683
|
+
| `associated_workflow.name` | `string` | [cobalt.ts:243](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L243) |
|
|
684
|
+
| <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:258](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L258) |
|
|
685
|
+
| <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:262](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L262) |
|
|
686
|
+
| <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:261](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L261) |
|
|
687
|
+
| <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:260](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L260) |
|
|
688
|
+
| <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:257](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L257) |
|
|
689
|
+
| <a id="id-2"></a> `id?` | `string` | [cobalt.ts:232](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L232) |
|
|
690
|
+
| <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:256](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L256) |
|
|
691
|
+
| <a id="name-5"></a> `name` | `string` | [cobalt.ts:233](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L233) |
|
|
692
|
+
| <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:234](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L234) |
|
|
693
|
+
| <a id="status"></a> `status` | `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"` | [cobalt.ts:240](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L240) |
|
|
694
|
+
| <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:255](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L255) |
|
|
603
695
|
|
|
604
696
|
***
|
|
605
697
|
|
|
606
698
|
### InputField
|
|
607
699
|
|
|
608
|
-
Defined in: [cobalt.ts:
|
|
700
|
+
Defined in: [cobalt.ts:35](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L35)
|
|
609
701
|
|
|
610
702
|
An Input field to take input from the user.
|
|
611
703
|
|
|
@@ -613,17 +705,20 @@ An Input field to take input from the user.
|
|
|
613
705
|
|
|
614
706
|
| Property | Type | Description | Defined in |
|
|
615
707
|
| ------ | ------ | ------ | ------ |
|
|
616
|
-
| <a id="
|
|
617
|
-
| <a id="
|
|
618
|
-
| <a id="
|
|
619
|
-
| <a id="
|
|
620
|
-
| <a id="
|
|
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/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L39) |
|
|
621
716
|
|
|
622
717
|
***
|
|
623
718
|
|
|
624
719
|
### Label
|
|
625
720
|
|
|
626
|
-
Defined in: [cobalt.ts:
|
|
721
|
+
Defined in: [cobalt.ts:68](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L68)
|
|
627
722
|
|
|
628
723
|
Label Mapping
|
|
629
724
|
|
|
@@ -631,14 +726,14 @@ Label Mapping
|
|
|
631
726
|
|
|
632
727
|
| Property | Type | Description | Defined in |
|
|
633
728
|
| ------ | ------ | ------ | ------ |
|
|
634
|
-
| <a id="name-
|
|
635
|
-
| <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:
|
|
729
|
+
| <a id="name-7"></a> `name` | `string` | The label name. | [cobalt.ts:70](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/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/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L72) |
|
|
636
731
|
|
|
637
732
|
***
|
|
638
733
|
|
|
639
734
|
### PublicWorkflow
|
|
640
735
|
|
|
641
|
-
Defined in: [cobalt.ts:
|
|
736
|
+
Defined in: [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L146)
|
|
642
737
|
|
|
643
738
|
A public workflow in Cobalt.
|
|
644
739
|
|
|
@@ -646,15 +741,15 @@ A public workflow in Cobalt.
|
|
|
646
741
|
|
|
647
742
|
| Property | Type | Description | Defined in |
|
|
648
743
|
| ------ | ------ | ------ | ------ |
|
|
649
|
-
| <a id="_id-
|
|
650
|
-
| <a id="description-4"></a> `description?` | `string` | The workflow description. | [cobalt.ts:
|
|
651
|
-
| <a id="name-
|
|
744
|
+
| <a id="_id-2"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:148](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L148) |
|
|
745
|
+
| <a id="description-4"></a> `description?` | `string` | The workflow description. | [cobalt.ts:152](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L152) |
|
|
746
|
+
| <a id="name-8"></a> `name` | `string` | The workflow name. | [cobalt.ts:150](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L150) |
|
|
652
747
|
|
|
653
748
|
***
|
|
654
749
|
|
|
655
750
|
### PublicWorkflowPayload
|
|
656
751
|
|
|
657
|
-
Defined in: [cobalt.ts:
|
|
752
|
+
Defined in: [cobalt.ts:156](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L156)
|
|
658
753
|
|
|
659
754
|
The payload for creating a public workflow for the linked account.
|
|
660
755
|
|
|
@@ -662,15 +757,15 @@ The payload for creating a public workflow for the linked account.
|
|
|
662
757
|
|
|
663
758
|
| Property | Type | Description | Defined in |
|
|
664
759
|
| ------ | ------ | ------ | ------ |
|
|
665
|
-
| <a id="description-5"></a> `description?` | `string` | The workflow description. | [cobalt.ts:
|
|
666
|
-
| <a id="name-
|
|
667
|
-
| <a id="slug-4"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [cobalt.ts:
|
|
760
|
+
| <a id="description-5"></a> `description?` | `string` | The workflow description. | [cobalt.ts:160](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L160) |
|
|
761
|
+
| <a id="name-9"></a> `name` | `string` | The workflow name. | [cobalt.ts:158](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L158) |
|
|
762
|
+
| <a id="slug-4"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [cobalt.ts:162](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L162) |
|
|
668
763
|
|
|
669
764
|
***
|
|
670
765
|
|
|
671
766
|
### PublicWorkflowsPayload
|
|
672
767
|
|
|
673
|
-
Defined in: [cobalt.ts:
|
|
768
|
+
Defined in: [cobalt.ts:165](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L165)
|
|
674
769
|
|
|
675
770
|
#### Extends
|
|
676
771
|
|
|
@@ -680,39 +775,39 @@ Defined in: [cobalt.ts:143](https://github.com/gocobalt/cobalt-js/blob/b0775f9f6
|
|
|
680
775
|
|
|
681
776
|
| Property | Type | Inherited from | Defined in |
|
|
682
777
|
| ------ | ------ | ------ | ------ |
|
|
683
|
-
| <a id="limit"></a> `limit?` | `number` | `PaginationProps.limit` | [cobalt.ts:
|
|
684
|
-
| <a id="page"></a> `page?` | `number` | `PaginationProps.page` | [cobalt.ts:
|
|
685
|
-
| <a id="slug-5"></a> `slug?` | `string` | - | [cobalt.ts:
|
|
778
|
+
| <a id="limit"></a> `limit?` | `number` | `PaginationProps.limit` | [cobalt.ts:171](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L171) |
|
|
779
|
+
| <a id="page"></a> `page?` | `number` | `PaginationProps.page` | [cobalt.ts:170](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L170) |
|
|
780
|
+
| <a id="slug-5"></a> `slug?` | `string` | - | [cobalt.ts:166](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L166) |
|
|
686
781
|
|
|
687
782
|
***
|
|
688
783
|
|
|
689
784
|
### RuleOptions
|
|
690
785
|
|
|
691
|
-
Defined in: [cobalt.ts:
|
|
786
|
+
Defined in: [cobalt.ts:125](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L125)
|
|
692
787
|
|
|
693
788
|
#### Properties
|
|
694
789
|
|
|
695
790
|
| Property | Type | Defined in |
|
|
696
791
|
| ------ | ------ | ------ |
|
|
697
|
-
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:
|
|
698
|
-
| <a id="error"></a> `error?` | `object` | [cobalt.ts:
|
|
699
|
-
| `error.message?` | `string` | [cobalt.ts:
|
|
700
|
-
| `error.stack?` | `string` | [cobalt.ts:
|
|
701
|
-
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:
|
|
702
|
-
| `rule_column.operator` | `object` | [cobalt.ts:
|
|
703
|
-
| `rule_column.operator.name` | `string` | [cobalt.ts:
|
|
704
|
-
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:
|
|
705
|
-
| `rule_column.operator.type` | `"select"` | [cobalt.ts:
|
|
706
|
-
| `rule_column.rhs` | `object` | [cobalt.ts:
|
|
707
|
-
| `rule_column.rhs.name` | `string` | [cobalt.ts:
|
|
708
|
-
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:
|
|
709
|
-
| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:
|
|
792
|
+
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:138](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L138) |
|
|
793
|
+
| <a id="error"></a> `error?` | `object` | [cobalt.ts:139](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L139) |
|
|
794
|
+
| `error.message?` | `string` | [cobalt.ts:140](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L140) |
|
|
795
|
+
| `error.stack?` | `string` | [cobalt.ts:141](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L141) |
|
|
796
|
+
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L126) |
|
|
797
|
+
| `rule_column.operator` | `object` | [cobalt.ts:132](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L132) |
|
|
798
|
+
| `rule_column.operator.name` | `string` | [cobalt.ts:133](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L133) |
|
|
799
|
+
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:135](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L135) |
|
|
800
|
+
| `rule_column.operator.type` | `"select"` | [cobalt.ts:134](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L134) |
|
|
801
|
+
| `rule_column.rhs` | `object` | [cobalt.ts:127](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L127) |
|
|
802
|
+
| `rule_column.rhs.name` | `string` | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L128) |
|
|
803
|
+
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:130](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L130) |
|
|
804
|
+
| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:129](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L129) |
|
|
710
805
|
|
|
711
806
|
***
|
|
712
807
|
|
|
713
808
|
### UpdateConfigPayload
|
|
714
809
|
|
|
715
|
-
Defined in: [cobalt.ts:
|
|
810
|
+
Defined in: [cobalt.ts:76](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L76)
|
|
716
811
|
|
|
717
812
|
The configuration data for an application.
|
|
718
813
|
|
|
@@ -720,16 +815,16 @@ The configuration data for an application.
|
|
|
720
815
|
|
|
721
816
|
| Property | Type | Description | Defined in |
|
|
722
817
|
| ------ | ------ | ------ | ------ |
|
|
723
|
-
| <a id="config_id-
|
|
724
|
-
| <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [cobalt.ts:
|
|
725
|
-
| <a id="slug-6"></a> `slug` | `string` | The application slug | [cobalt.ts:
|
|
726
|
-
| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:
|
|
818
|
+
| <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:80](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L80) |
|
|
819
|
+
| <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [cobalt.ts:82](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L82) |
|
|
820
|
+
| <a id="slug-6"></a> `slug` | `string` | The application slug | [cobalt.ts:78](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L78) |
|
|
821
|
+
| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:84](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L84) |
|
|
727
822
|
|
|
728
823
|
***
|
|
729
824
|
|
|
730
825
|
### WorkflowPayload
|
|
731
826
|
|
|
732
|
-
Defined in: [cobalt.ts:
|
|
827
|
+
Defined in: [cobalt.ts:88](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L88)
|
|
733
828
|
|
|
734
829
|
The workflow.
|
|
735
830
|
|
|
@@ -737,6 +832,6 @@ The workflow.
|
|
|
737
832
|
|
|
738
833
|
| Property | Type | Description | Defined in |
|
|
739
834
|
| ------ | ------ | ------ | ------ |
|
|
740
|
-
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:
|
|
741
|
-
| <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [cobalt.ts:
|
|
742
|
-
| <a id="id-
|
|
835
|
+
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:92](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L92) |
|
|
836
|
+
| <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [cobalt.ts:94](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L94) |
|
|
837
|
+
| <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:90](https://github.com/gocobalt/cobalt-js/blob/16eca84ac399316b053aeb5413affb7ab3323410/cobalt.ts#L90) |
|