@cobaltio/cobalt-js 8.9.0 → 8.9.1
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 +8 -0
- package/cobalt.ts +8 -0
- package/docs/assets/search.js +1 -1
- package/docs/classes/Cobalt.html +22 -22
- package/docs/interfaces/Application.html +12 -12
- package/docs/interfaces/CobaltOptions.html +3 -3
- package/docs/interfaces/Config.html +2 -2
- package/docs/interfaces/ConfigField.html +4 -4
- package/docs/interfaces/ConfigPayload.html +4 -4
- package/docs/interfaces/ConfigWorkflow.html +2 -2
- package/docs/interfaces/EcosystemLead.html +2 -2
- package/docs/interfaces/EcosystemLeadPayload.html +2 -2
- package/docs/interfaces/Execution.html +2 -2
- package/docs/interfaces/InputField.html +9 -9
- package/docs/interfaces/Label.html +3 -3
- package/docs/interfaces/PublicWorkflow.html +12 -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 +159 -155
- 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:275](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L275)
|
|
74
74
|
|
|
75
75
|
#### Constructors
|
|
76
76
|
|
|
@@ -78,7 +78,7 @@ Defined in: [cobalt.ts:267](https://github.com/gocobalt/cobalt-js/blob/16eca84ac
|
|
|
78
78
|
|
|
79
79
|
> **new Cobalt**(`options`): [`Cobalt`](#cobalt)
|
|
80
80
|
|
|
81
|
-
Defined in: [cobalt.ts:
|
|
81
|
+
Defined in: [cobalt.ts:285](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L285)
|
|
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:277](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L277) |
|
|
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:532](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L532)
|
|
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:472](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L472)
|
|
128
128
|
|
|
129
129
|
Connect the specified application, optionally with the auth data that user provides.
|
|
130
130
|
|
|
@@ -145,7 +145,7 @@ Whether the connection was successful.
|
|
|
145
145
|
|
|
146
146
|
> **createEcosystemLead**(`payload`): `Promise`\<[`EcosystemLead`](#ecosystemlead)\>
|
|
147
147
|
|
|
148
|
-
Defined in: [cobalt.ts:
|
|
148
|
+
Defined in: [cobalt.ts:645](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L645)
|
|
149
149
|
|
|
150
150
|
###### Parameters
|
|
151
151
|
|
|
@@ -165,7 +165,7 @@ Create a lead for an ecosystem app.
|
|
|
165
165
|
|
|
166
166
|
> **createWorkflow**(`params`): `Promise`\<[`PublicWorkflow`](#publicworkflow)\>
|
|
167
167
|
|
|
168
|
-
Defined in: [cobalt.ts:
|
|
168
|
+
Defined in: [cobalt.ts:798](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L798)
|
|
169
169
|
|
|
170
170
|
Create a public workflow for the linked account.
|
|
171
171
|
|
|
@@ -185,7 +185,7 @@ The created public workflow.
|
|
|
185
185
|
|
|
186
186
|
> **deleteConfig**(`slug`, `configId?`): `Promise`\<`unknown`\>
|
|
187
187
|
|
|
188
|
-
Defined in: [cobalt.ts:
|
|
188
|
+
Defined in: [cobalt.ts:623](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L623)
|
|
189
189
|
|
|
190
190
|
Delete the specified config.
|
|
191
191
|
|
|
@@ -204,7 +204,7 @@ Delete the specified config.
|
|
|
204
204
|
|
|
205
205
|
> **deleteConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<`unknown`\>
|
|
206
206
|
|
|
207
|
-
Defined in: [cobalt.ts:
|
|
207
|
+
Defined in: [cobalt.ts:720](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L720)
|
|
208
208
|
|
|
209
209
|
Delete the specified config field value.
|
|
210
210
|
|
|
@@ -224,7 +224,7 @@ Delete the specified config field value.
|
|
|
224
224
|
|
|
225
225
|
> **deleteWorkflow**(`workflowId`): `Promise`\<`unknown`\>
|
|
226
226
|
|
|
227
|
-
Defined in: [cobalt.ts:
|
|
227
|
+
Defined in: [cobalt.ts:826](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L826)
|
|
228
228
|
|
|
229
229
|
Delete the specified public workflow.
|
|
230
230
|
|
|
@@ -242,7 +242,7 @@ Delete the specified public workflow.
|
|
|
242
242
|
|
|
243
243
|
> **disconnect**(`slug`): `Promise`\<`void`\>
|
|
244
244
|
|
|
245
|
-
Defined in: [cobalt.ts:
|
|
245
|
+
Defined in: [cobalt.ts:513](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L513)
|
|
246
246
|
|
|
247
247
|
Disconnect the specified application and remove any associated data from Cobalt.
|
|
248
248
|
|
|
@@ -270,7 +270,7 @@ The application slug.
|
|
|
270
270
|
|
|
271
271
|
> **getApp**(): `Promise`\<[`Application`](#application)[]\>
|
|
272
272
|
|
|
273
|
-
Defined in: [cobalt.ts:
|
|
273
|
+
Defined in: [cobalt.ts:345](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L345)
|
|
274
274
|
|
|
275
275
|
Returns the list of enabled applications and their details.
|
|
276
276
|
|
|
@@ -288,7 +288,7 @@ The application slug.
|
|
|
288
288
|
|
|
289
289
|
> **getApp**(`slug`): `Promise`\<[`Application`](#application)\>
|
|
290
290
|
|
|
291
|
-
Defined in: [cobalt.ts:
|
|
291
|
+
Defined in: [cobalt.ts:352](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L352)
|
|
292
292
|
|
|
293
293
|
Returns the application details for the specified application, provided
|
|
294
294
|
the application is enabled in Cobalt.
|
|
@@ -313,7 +313,7 @@ The application slug.
|
|
|
313
313
|
|
|
314
314
|
> **getApps**(): `Promise`\<[`Application`](#application)[]\>
|
|
315
315
|
|
|
316
|
-
Defined in: [cobalt.ts:
|
|
316
|
+
Defined in: [cobalt.ts:380](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L380)
|
|
317
317
|
|
|
318
318
|
Returns all the enabled apps.
|
|
319
319
|
|
|
@@ -327,7 +327,7 @@ The list of applications.
|
|
|
327
327
|
|
|
328
328
|
> **getConfig**(`slug`, `configId?`): `Promise`\<[`Config`](#config-2)\>
|
|
329
329
|
|
|
330
|
-
Defined in: [cobalt.ts:
|
|
330
|
+
Defined in: [cobalt.ts:579](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L579)
|
|
331
331
|
|
|
332
332
|
Returns the specified config.
|
|
333
333
|
|
|
@@ -348,7 +348,7 @@ The specified config.
|
|
|
348
348
|
|
|
349
349
|
> **getConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
|
|
350
350
|
|
|
351
|
-
Defined in: [cobalt.ts:
|
|
351
|
+
Defined in: [cobalt.ts:670](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L670)
|
|
352
352
|
|
|
353
353
|
Returns the specified field of the config.
|
|
354
354
|
|
|
@@ -370,7 +370,7 @@ The specified config field.
|
|
|
370
370
|
|
|
371
371
|
> **getConfigs**(`slug`): `Promise`\<`object`[]\>
|
|
372
372
|
|
|
373
|
-
Defined in: [cobalt.ts:
|
|
373
|
+
Defined in: [cobalt.ts:558](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L558)
|
|
374
374
|
|
|
375
375
|
Returns the configs created for the specified application.
|
|
376
376
|
|
|
@@ -390,7 +390,7 @@ The configs created for the specified application.
|
|
|
390
390
|
|
|
391
391
|
> **getExecution**(`executionId`): `Promise`\<[`Execution`](#execution)\>
|
|
392
392
|
|
|
393
|
-
Defined in: [cobalt.ts:
|
|
393
|
+
Defined in: [cobalt.ts:869](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L869)
|
|
394
394
|
|
|
395
395
|
Returns the specified workflow execution log.
|
|
396
396
|
|
|
@@ -410,7 +410,7 @@ The specified execution log.
|
|
|
410
410
|
|
|
411
411
|
> **getExecutions**(`params?`): `Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
|
|
412
412
|
|
|
413
|
-
Defined in: [cobalt.ts:
|
|
413
|
+
Defined in: [cobalt.ts:849](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L849)
|
|
414
414
|
|
|
415
415
|
Returns the workflow execution logs for the linked account.
|
|
416
416
|
|
|
@@ -430,7 +430,7 @@ The paginated workflow execution logs.
|
|
|
430
430
|
|
|
431
431
|
> **getFieldOptions**(`lhs`, `slug`, `fieldId`, `workflowId?`): `Promise`\<[`RuleOptions`](#ruleoptions)\>
|
|
432
432
|
|
|
433
|
-
Defined in: [cobalt.ts:
|
|
433
|
+
Defined in: [cobalt.ts:745](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L745)
|
|
434
434
|
|
|
435
435
|
Returns the options for the specified field.
|
|
436
436
|
|
|
@@ -453,7 +453,7 @@ The specified rule field's options.
|
|
|
453
453
|
|
|
454
454
|
> **getWorkflows**(`params?`): `Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
|
|
455
455
|
|
|
456
|
-
Defined in: [cobalt.ts:
|
|
456
|
+
Defined in: [cobalt.ts:774](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L774)
|
|
457
457
|
|
|
458
458
|
Returns the private workflows for the specified application.
|
|
459
459
|
|
|
@@ -471,7 +471,7 @@ Returns the private workflows for the specified application.
|
|
|
471
471
|
|
|
472
472
|
> **updateConfig**(`payload`): `Promise`\<[`Config`](#config-2)\>
|
|
473
473
|
|
|
474
|
-
Defined in: [cobalt.ts:
|
|
474
|
+
Defined in: [cobalt.ts:599](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L599)
|
|
475
475
|
|
|
476
476
|
Update the specified config.
|
|
477
477
|
|
|
@@ -491,7 +491,7 @@ The specified config.
|
|
|
491
491
|
|
|
492
492
|
> **updateConfigField**(`slug`, `fieldId`, `value`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
|
|
493
493
|
|
|
494
|
-
Defined in: [cobalt.ts:
|
|
494
|
+
Defined in: [cobalt.ts:694](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L694)
|
|
495
495
|
|
|
496
496
|
Update the specified config field value.
|
|
497
497
|
|
|
@@ -514,7 +514,7 @@ The updated config field.
|
|
|
514
514
|
|
|
515
515
|
### Application
|
|
516
516
|
|
|
517
|
-
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/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L6)
|
|
518
518
|
|
|
519
519
|
An application in Cobalt.
|
|
520
520
|
|
|
@@ -522,76 +522,76 @@ An application in Cobalt.
|
|
|
522
522
|
|
|
523
523
|
| Property | Type | Description | Defined in |
|
|
524
524
|
| ------ | ------ | ------ | ------ |
|
|
525
|
-
| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:8](https://github.com/gocobalt/cobalt-js/blob/
|
|
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/
|
|
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/
|
|
528
|
-
| <a id="connected"></a> `connected?` | `boolean` | Whether the user has connected the application. | [cobalt.ts:25](https://github.com/gocobalt/cobalt-js/blob/
|
|
529
|
-
| <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:12](https://github.com/gocobalt/cobalt-js/blob/
|
|
530
|
-
| <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:14](https://github.com/gocobalt/cobalt-js/blob/
|
|
531
|
-
| <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:10](https://github.com/gocobalt/cobalt-js/blob/
|
|
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/
|
|
533
|
-
| <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:21](https://github.com/gocobalt/cobalt-js/blob/
|
|
534
|
-
| <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:31](https://github.com/gocobalt/cobalt-js/blob/
|
|
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/
|
|
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) |
|
|
536
536
|
|
|
537
537
|
***
|
|
538
538
|
|
|
539
539
|
### CobaltOptions
|
|
540
540
|
|
|
541
|
-
Defined in: [cobalt.ts:97](https://github.com/gocobalt/cobalt-js/blob/
|
|
541
|
+
Defined in: [cobalt.ts:97](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L97)
|
|
542
542
|
|
|
543
543
|
#### Properties
|
|
544
544
|
|
|
545
545
|
| Property | Type | Description | Defined in |
|
|
546
546
|
| ------ | ------ | ------ | ------ |
|
|
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/
|
|
548
|
-
| <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:101](https://github.com/gocobalt/cobalt-js/blob/
|
|
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) |
|
|
549
549
|
|
|
550
550
|
***
|
|
551
551
|
|
|
552
552
|
### Config
|
|
553
553
|
|
|
554
|
-
Defined in: [cobalt.ts:
|
|
554
|
+
Defined in: [cobalt.ts:190](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L190)
|
|
555
555
|
|
|
556
556
|
#### Properties
|
|
557
557
|
|
|
558
558
|
| Property | Type | Defined in |
|
|
559
559
|
| ------ | ------ | ------ |
|
|
560
|
-
| <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:
|
|
561
|
-
| <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:
|
|
562
|
-
| <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:
|
|
563
|
-
| <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:
|
|
564
|
-
| <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:
|
|
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) |
|
|
565
565
|
|
|
566
566
|
***
|
|
567
567
|
|
|
568
568
|
### ConfigField
|
|
569
569
|
|
|
570
|
-
Defined in: [cobalt.ts:
|
|
570
|
+
Defined in: [cobalt.ts:205](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L205)
|
|
571
571
|
|
|
572
572
|
#### Properties
|
|
573
573
|
|
|
574
574
|
| Property | Type | Description | Defined in |
|
|
575
575
|
| ------ | ------ | ------ | ------ |
|
|
576
|
-
| <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:
|
|
577
|
-
| <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:
|
|
578
|
-
| <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:
|
|
579
|
-
| <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:
|
|
580
|
-
| <a id="id"></a> `id` | `string` | - | [cobalt.ts:
|
|
581
|
-
| <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:
|
|
582
|
-
| <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:
|
|
583
|
-
| <a id="name-1"></a> `name` | `string` | - | [cobalt.ts:
|
|
584
|
-
| <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:
|
|
585
|
-
| <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:
|
|
586
|
-
| <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:
|
|
587
|
-
| <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:
|
|
588
|
-
| <a id="value"></a> `value?` | `any` | - | [cobalt.ts:
|
|
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) |
|
|
589
589
|
|
|
590
590
|
***
|
|
591
591
|
|
|
592
592
|
### ConfigPayload
|
|
593
593
|
|
|
594
|
-
Defined in: [cobalt.ts:58](https://github.com/gocobalt/cobalt-js/blob/
|
|
594
|
+
Defined in: [cobalt.ts:58](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L58)
|
|
595
595
|
|
|
596
596
|
The payload object for config.
|
|
597
597
|
|
|
@@ -599,31 +599,31 @@ The payload object for config.
|
|
|
599
599
|
|
|
600
600
|
| Property | Type | Description | Defined in |
|
|
601
601
|
| ------ | ------ | ------ | ------ |
|
|
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/
|
|
603
|
-
| <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:64](https://github.com/gocobalt/cobalt-js/blob/
|
|
604
|
-
| <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:60](https://github.com/gocobalt/cobalt-js/blob/
|
|
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) |
|
|
605
605
|
|
|
606
606
|
***
|
|
607
607
|
|
|
608
608
|
### ConfigWorkflow
|
|
609
609
|
|
|
610
|
-
Defined in: [cobalt.ts:
|
|
610
|
+
Defined in: [cobalt.ts:230](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L230)
|
|
611
611
|
|
|
612
612
|
#### Properties
|
|
613
613
|
|
|
614
614
|
| Property | Type | Defined in |
|
|
615
615
|
| ------ | ------ | ------ |
|
|
616
|
-
| <a id="description-1"></a> `description?` | `string` | [cobalt.ts:
|
|
617
|
-
| <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:
|
|
618
|
-
| <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:
|
|
619
|
-
| <a id="id-1"></a> `id` | `string` | [cobalt.ts:
|
|
620
|
-
| <a id="name-2"></a> `name` | `string` | [cobalt.ts:
|
|
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) |
|
|
621
621
|
|
|
622
622
|
***
|
|
623
623
|
|
|
624
624
|
### ~~EcosystemLead~~
|
|
625
625
|
|
|
626
|
-
Defined in: [cobalt.ts:107](https://github.com/gocobalt/cobalt-js/blob/
|
|
626
|
+
Defined in: [cobalt.ts:107](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L107)
|
|
627
627
|
|
|
628
628
|
#### Deprecated
|
|
629
629
|
|
|
@@ -631,17 +631,17 @@ Defined in: [cobalt.ts:107](https://github.com/gocobalt/cobalt-js/blob/16eca84ac
|
|
|
631
631
|
|
|
632
632
|
| Property | Type | Defined in |
|
|
633
633
|
| ------ | ------ | ------ |
|
|
634
|
-
| <a id="_id"></a> ~~`_id`~~ | `string` | [cobalt.ts:108](https://github.com/gocobalt/cobalt-js/blob/
|
|
635
|
-
| <a id="created_at"></a> ~~`created_at`~~ | `string` | [cobalt.ts:112](https://github.com/gocobalt/cobalt-js/blob/
|
|
636
|
-
| <a id="description-2"></a> ~~`description?`~~ | `string` | [cobalt.ts:111](https://github.com/gocobalt/cobalt-js/blob/
|
|
637
|
-
| <a id="email"></a> ~~`email`~~ | `string` | [cobalt.ts:110](https://github.com/gocobalt/cobalt-js/blob/
|
|
638
|
-
| <a id="name-3"></a> ~~`name?`~~ | `string` | [cobalt.ts:109](https://github.com/gocobalt/cobalt-js/blob/
|
|
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
639
|
|
|
640
640
|
***
|
|
641
641
|
|
|
642
642
|
### ~~EcosystemLeadPayload~~
|
|
643
643
|
|
|
644
|
-
Defined in: [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/
|
|
644
|
+
Defined in: [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L118)
|
|
645
645
|
|
|
646
646
|
#### Deprecated
|
|
647
647
|
|
|
@@ -649,55 +649,55 @@ Defined in: [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/16eca84ac
|
|
|
649
649
|
|
|
650
650
|
| Property | Type | Defined in |
|
|
651
651
|
| ------ | ------ | ------ |
|
|
652
|
-
| <a id="description-3"></a> ~~`description?`~~ | `string` | [cobalt.ts:122](https://github.com/gocobalt/cobalt-js/blob/
|
|
653
|
-
| <a id="email-1"></a> ~~`email`~~ | `string` | [cobalt.ts:121](https://github.com/gocobalt/cobalt-js/blob/
|
|
654
|
-
| <a id="name-4"></a> ~~`name?`~~ | `string` | [cobalt.ts:120](https://github.com/gocobalt/cobalt-js/blob/
|
|
655
|
-
| <a id="slug-3"></a> ~~`slug`~~ | `string` | [cobalt.ts:119](https://github.com/gocobalt/cobalt-js/blob/
|
|
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) |
|
|
656
656
|
|
|
657
657
|
***
|
|
658
658
|
|
|
659
659
|
### Execution
|
|
660
660
|
|
|
661
|
-
Defined in: [cobalt.ts:
|
|
661
|
+
Defined in: [cobalt.ts:238](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L238)
|
|
662
662
|
|
|
663
663
|
#### Properties
|
|
664
664
|
|
|
665
665
|
| Property | Type | Defined in |
|
|
666
666
|
| ------ | ------ | ------ |
|
|
667
|
-
| <a id="_id-1"></a> `_id` | `string` | [cobalt.ts:
|
|
668
|
-
| <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:
|
|
669
|
-
| `associated_application._id` | `string` | [cobalt.ts:
|
|
670
|
-
| `associated_application.icon?` | `string` | [cobalt.ts:
|
|
671
|
-
| `associated_application.name` | `string` | [cobalt.ts:
|
|
672
|
-
| <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:
|
|
673
|
-
| <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:
|
|
674
|
-
| `associated_trigger_application._id` | `string` | [cobalt.ts:
|
|
675
|
-
| `associated_trigger_application.app_type?` | `string` | [cobalt.ts:
|
|
676
|
-
| `associated_trigger_application.icon?` | `string` | [cobalt.ts:
|
|
677
|
-
| `associated_trigger_application.name` | `string` | [cobalt.ts:
|
|
678
|
-
| `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:
|
|
679
|
-
| `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:
|
|
680
|
-
| `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:
|
|
681
|
-
| <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:
|
|
682
|
-
| `associated_workflow._id` | `string` | [cobalt.ts:
|
|
683
|
-
| `associated_workflow.name` | `string` | [cobalt.ts:
|
|
684
|
-
| <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:
|
|
685
|
-
| <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:
|
|
686
|
-
| <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:
|
|
687
|
-
| <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:
|
|
688
|
-
| <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:
|
|
689
|
-
| <a id="id-2"></a> `id?` | `string` | [cobalt.ts:
|
|
690
|
-
| <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:
|
|
691
|
-
| <a id="name-5"></a> `name` | `string` | [cobalt.ts:
|
|
692
|
-
| <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:
|
|
693
|
-
| <a id="status"></a> `status` | `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"` | [cobalt.ts:
|
|
694
|
-
| <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:
|
|
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) |
|
|
695
695
|
|
|
696
696
|
***
|
|
697
697
|
|
|
698
698
|
### InputField
|
|
699
699
|
|
|
700
|
-
Defined in: [cobalt.ts:35](https://github.com/gocobalt/cobalt-js/blob/
|
|
700
|
+
Defined in: [cobalt.ts:35](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L35)
|
|
701
701
|
|
|
702
702
|
An Input field to take input from the user.
|
|
703
703
|
|
|
@@ -705,20 +705,20 @@ An Input field to take input from the user.
|
|
|
705
705
|
|
|
706
706
|
| Property | Type | Description | Defined in |
|
|
707
707
|
| ------ | ------ | ------ | ------ |
|
|
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/
|
|
709
|
-
| <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:47](https://github.com/gocobalt/cobalt-js/blob/
|
|
710
|
-
| <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:43](https://github.com/gocobalt/cobalt-js/blob/
|
|
711
|
-
| <a id="name-6"></a> `name` | `string` | Key name of the field. | [cobalt.ts:37](https://github.com/gocobalt/cobalt-js/blob/
|
|
712
|
-
| <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:51](https://github.com/gocobalt/cobalt-js/blob/
|
|
713
|
-
| <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:45](https://github.com/gocobalt/cobalt-js/blob/
|
|
714
|
-
| <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:41](https://github.com/gocobalt/cobalt-js/blob/
|
|
715
|
-
| <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:39](https://github.com/gocobalt/cobalt-js/blob/
|
|
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) |
|
|
716
716
|
|
|
717
717
|
***
|
|
718
718
|
|
|
719
719
|
### Label
|
|
720
720
|
|
|
721
|
-
Defined in: [cobalt.ts:68](https://github.com/gocobalt/cobalt-js/blob/
|
|
721
|
+
Defined in: [cobalt.ts:68](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L68)
|
|
722
722
|
|
|
723
723
|
Label Mapping
|
|
724
724
|
|
|
@@ -726,14 +726,14 @@ Label Mapping
|
|
|
726
726
|
|
|
727
727
|
| Property | Type | Description | Defined in |
|
|
728
728
|
| ------ | ------ | ------ | ------ |
|
|
729
|
-
| <a id="name-7"></a> `name` | `string` | The label name. | [cobalt.ts:70](https://github.com/gocobalt/cobalt-js/blob/
|
|
730
|
-
| <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:72](https://github.com/gocobalt/cobalt-js/blob/
|
|
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) |
|
|
731
731
|
|
|
732
732
|
***
|
|
733
733
|
|
|
734
734
|
### PublicWorkflow
|
|
735
735
|
|
|
736
|
-
Defined in: [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/
|
|
736
|
+
Defined in: [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L146)
|
|
737
737
|
|
|
738
738
|
A public workflow in Cobalt.
|
|
739
739
|
|
|
@@ -741,15 +741,19 @@ A public workflow in Cobalt.
|
|
|
741
741
|
|
|
742
742
|
| Property | Type | Description | Defined in |
|
|
743
743
|
| ------ | ------ | ------ | ------ |
|
|
744
|
-
| <a id="_id-2"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:148](https://github.com/gocobalt/cobalt-js/blob/
|
|
745
|
-
| <a id="
|
|
746
|
-
| <a id="
|
|
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) |
|
|
747
751
|
|
|
748
752
|
***
|
|
749
753
|
|
|
750
754
|
### PublicWorkflowPayload
|
|
751
755
|
|
|
752
|
-
Defined in: [cobalt.ts:
|
|
756
|
+
Defined in: [cobalt.ts:164](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L164)
|
|
753
757
|
|
|
754
758
|
The payload for creating a public workflow for the linked account.
|
|
755
759
|
|
|
@@ -757,15 +761,15 @@ The payload for creating a public workflow for the linked account.
|
|
|
757
761
|
|
|
758
762
|
| Property | Type | Description | Defined in |
|
|
759
763
|
| ------ | ------ | ------ | ------ |
|
|
760
|
-
| <a id="description-5"></a> `description?` | `string` | The workflow description. | [cobalt.ts:
|
|
761
|
-
| <a id="name-9"></a> `name` | `string` | The workflow name. | [cobalt.ts:
|
|
762
|
-
| <a id="slug-
|
|
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) |
|
|
763
767
|
|
|
764
768
|
***
|
|
765
769
|
|
|
766
770
|
### PublicWorkflowsPayload
|
|
767
771
|
|
|
768
|
-
Defined in: [cobalt.ts:
|
|
772
|
+
Defined in: [cobalt.ts:173](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L173)
|
|
769
773
|
|
|
770
774
|
#### Extends
|
|
771
775
|
|
|
@@ -775,39 +779,39 @@ Defined in: [cobalt.ts:165](https://github.com/gocobalt/cobalt-js/blob/16eca84ac
|
|
|
775
779
|
|
|
776
780
|
| Property | Type | Inherited from | Defined in |
|
|
777
781
|
| ------ | ------ | ------ | ------ |
|
|
778
|
-
| <a id="limit"></a> `limit?` | `number` | `PaginationProps.limit` | [cobalt.ts:
|
|
779
|
-
| <a id="page"></a> `page?` | `number` | `PaginationProps.page` | [cobalt.ts:
|
|
780
|
-
| <a id="slug-
|
|
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) |
|
|
781
785
|
|
|
782
786
|
***
|
|
783
787
|
|
|
784
788
|
### RuleOptions
|
|
785
789
|
|
|
786
|
-
Defined in: [cobalt.ts:125](https://github.com/gocobalt/cobalt-js/blob/
|
|
790
|
+
Defined in: [cobalt.ts:125](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L125)
|
|
787
791
|
|
|
788
792
|
#### Properties
|
|
789
793
|
|
|
790
794
|
| Property | Type | Defined in |
|
|
791
795
|
| ------ | ------ | ------ |
|
|
792
|
-
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:138](https://github.com/gocobalt/cobalt-js/blob/
|
|
793
|
-
| <a id="error"></a> `error?` | `object` | [cobalt.ts:139](https://github.com/gocobalt/cobalt-js/blob/
|
|
794
|
-
| `error.message?` | `string` | [cobalt.ts:140](https://github.com/gocobalt/cobalt-js/blob/
|
|
795
|
-
| `error.stack?` | `string` | [cobalt.ts:141](https://github.com/gocobalt/cobalt-js/blob/
|
|
796
|
-
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/
|
|
797
|
-
| `rule_column.operator` | `object` | [cobalt.ts:132](https://github.com/gocobalt/cobalt-js/blob/
|
|
798
|
-
| `rule_column.operator.name` | `string` | [cobalt.ts:133](https://github.com/gocobalt/cobalt-js/blob/
|
|
799
|
-
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:135](https://github.com/gocobalt/cobalt-js/blob/
|
|
800
|
-
| `rule_column.operator.type` | `"select"` | [cobalt.ts:134](https://github.com/gocobalt/cobalt-js/blob/
|
|
801
|
-
| `rule_column.rhs` | `object` | [cobalt.ts:127](https://github.com/gocobalt/cobalt-js/blob/
|
|
802
|
-
| `rule_column.rhs.name` | `string` | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/
|
|
803
|
-
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:130](https://github.com/gocobalt/cobalt-js/blob/
|
|
804
|
-
| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:129](https://github.com/gocobalt/cobalt-js/blob/
|
|
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) |
|
|
805
809
|
|
|
806
810
|
***
|
|
807
811
|
|
|
808
812
|
### UpdateConfigPayload
|
|
809
813
|
|
|
810
|
-
Defined in: [cobalt.ts:76](https://github.com/gocobalt/cobalt-js/blob/
|
|
814
|
+
Defined in: [cobalt.ts:76](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L76)
|
|
811
815
|
|
|
812
816
|
The configuration data for an application.
|
|
813
817
|
|
|
@@ -815,16 +819,16 @@ The configuration data for an application.
|
|
|
815
819
|
|
|
816
820
|
| Property | Type | Description | Defined in |
|
|
817
821
|
| ------ | ------ | ------ | ------ |
|
|
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/
|
|
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/
|
|
820
|
-
| <a id="slug-
|
|
821
|
-
| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:84](https://github.com/gocobalt/cobalt-js/blob/
|
|
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) |
|
|
822
826
|
|
|
823
827
|
***
|
|
824
828
|
|
|
825
829
|
### WorkflowPayload
|
|
826
830
|
|
|
827
|
-
Defined in: [cobalt.ts:88](https://github.com/gocobalt/cobalt-js/blob/
|
|
831
|
+
Defined in: [cobalt.ts:88](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L88)
|
|
828
832
|
|
|
829
833
|
The workflow.
|
|
830
834
|
|
|
@@ -832,6 +836,6 @@ The workflow.
|
|
|
832
836
|
|
|
833
837
|
| Property | Type | Description | Defined in |
|
|
834
838
|
| ------ | ------ | ------ | ------ |
|
|
835
|
-
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:92](https://github.com/gocobalt/cobalt-js/blob/
|
|
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/
|
|
837
|
-
| <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:90](https://github.com/gocobalt/cobalt-js/blob/
|
|
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) |
|