@cobaltio/cobalt-js 8.9.2-beta.2 → 9.0.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 +21 -32
- package/cobalt.js +46 -60
- package/cobalt.ts +56 -84
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/Cobalt.html +28 -27
- package/docs/enums/AuthStatus.html +3 -0
- package/docs/enums/AuthType.html +4 -0
- package/docs/interfaces/Application.html +28 -16
- 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/Execution.html +4 -2
- package/docs/interfaces/InputField.html +9 -9
- package/docs/interfaces/Label.html +3 -3
- package/docs/interfaces/PublicWorkflow.html +8 -8
- 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 +193 -207
- package/docs/modules.html +1 -1
- package/package.json +1 -1
- package/docs/interfaces/EcosystemLead.html +0 -6
- package/docs/interfaces/EcosystemLeadPayload.html +0 -5
package/docs/llms.txt
CHANGED
|
@@ -66,11 +66,39 @@ cobalt.token = "COBALT_SESSION_TOKEN";
|
|
|
66
66
|
|
|
67
67
|
This documentation is also available in [llms.txt](https://llmstxt.org) format, which is a simple markdown standard that LLMs can consume easily.
|
|
68
68
|
|
|
69
|
+
## Enumerations
|
|
70
|
+
|
|
71
|
+
### AuthStatus
|
|
72
|
+
|
|
73
|
+
Defined in: [cobalt.ts:10](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L10)
|
|
74
|
+
|
|
75
|
+
#### Enumeration Members
|
|
76
|
+
|
|
77
|
+
| Enumeration Member | Value | Defined in |
|
|
78
|
+
| ------ | ------ | ------ |
|
|
79
|
+
| <a id="active"></a> `Active` | `"active"` | [cobalt.ts:11](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L11) |
|
|
80
|
+
| <a id="expired"></a> `Expired` | `"expired"` | [cobalt.ts:12](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L12) |
|
|
81
|
+
|
|
82
|
+
***
|
|
83
|
+
|
|
84
|
+
### AuthType
|
|
85
|
+
|
|
86
|
+
Defined in: [cobalt.ts:5](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L5)
|
|
87
|
+
|
|
88
|
+
Cobalt Frontend SDK
|
|
89
|
+
|
|
90
|
+
#### Enumeration Members
|
|
91
|
+
|
|
92
|
+
| Enumeration Member | Value | Defined in |
|
|
93
|
+
| ------ | ------ | ------ |
|
|
94
|
+
| <a id="keybased"></a> `KeyBased` | `"keybased"` | [cobalt.ts:7](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L7) |
|
|
95
|
+
| <a id="oauth2"></a> `OAuth2` | `"oauth2"` | [cobalt.ts:6](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L6) |
|
|
96
|
+
|
|
69
97
|
## Classes
|
|
70
98
|
|
|
71
99
|
### Cobalt
|
|
72
100
|
|
|
73
|
-
Defined in: [cobalt.ts:
|
|
101
|
+
Defined in: [cobalt.ts:304](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L304)
|
|
74
102
|
|
|
75
103
|
#### Constructors
|
|
76
104
|
|
|
@@ -78,7 +106,7 @@ Defined in: [cobalt.ts:275](https://github.com/gocobalt/cobalt-js/blob/75a69bc12
|
|
|
78
106
|
|
|
79
107
|
> **new Cobalt**(`options`): [`Cobalt`](#cobalt)
|
|
80
108
|
|
|
81
|
-
Defined in: [cobalt.ts:
|
|
109
|
+
Defined in: [cobalt.ts:314](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L314)
|
|
82
110
|
|
|
83
111
|
Cobalt Frontend SDK
|
|
84
112
|
|
|
@@ -96,7 +124,7 @@ Cobalt Frontend SDK
|
|
|
96
124
|
|
|
97
125
|
| Property | Modifier | Type | Defined in |
|
|
98
126
|
| ------ | ------ | ------ | ------ |
|
|
99
|
-
| <a id="token"></a> `token` | `public` | `string` | [cobalt.ts:
|
|
127
|
+
| <a id="token"></a> `token` | `public` | `string` | [cobalt.ts:306](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L306) |
|
|
100
128
|
|
|
101
129
|
#### Methods
|
|
102
130
|
|
|
@@ -104,7 +132,7 @@ Cobalt Frontend SDK
|
|
|
104
132
|
|
|
105
133
|
> **config**(`payload`): `Promise`\<[`Config`](#config-2)\>
|
|
106
134
|
|
|
107
|
-
Defined in: [cobalt.ts:
|
|
135
|
+
Defined in: [cobalt.ts:578](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L578)
|
|
108
136
|
|
|
109
137
|
Returns the specified config, or creates one if it doesn't exist.
|
|
110
138
|
|
|
@@ -122,50 +150,36 @@ The specified config.
|
|
|
122
150
|
|
|
123
151
|
##### connect()
|
|
124
152
|
|
|
125
|
-
> **connect**(`
|
|
153
|
+
> **connect**(`params`): `Promise`\<`boolean`\>
|
|
126
154
|
|
|
127
|
-
Defined in: [cobalt.ts:
|
|
155
|
+
Defined in: [cobalt.ts:531](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L531)
|
|
128
156
|
|
|
129
|
-
|
|
157
|
+
Connects the specified application using the provided authentication type and optional auth data.
|
|
130
158
|
|
|
131
159
|
###### Parameters
|
|
132
160
|
|
|
133
161
|
| Parameter | Type | Description |
|
|
134
162
|
| ------ | ------ | ------ |
|
|
135
|
-
| `
|
|
136
|
-
| `payload?` | `Record`\<`string`, `string`\> |
|
|
163
|
+
| `params` | \{ `payload?`: `Record`\<`string`, `string`\>; `slug`: `string`; `type?`: [`AuthType`](#authtype); \} | The parameters for connecting the application. |
|
|
164
|
+
| `params.payload?` | `Record`\<`string`, `string`\> | key-value pairs of authentication data required for the specified auth type. |
|
|
165
|
+
| `params.slug` | `string` | The application slug. |
|
|
166
|
+
| `params.type?` | [`AuthType`](#authtype) | The authentication type to use. If not provided, it defaults to `keybased` if payload is provided, otherwise `oauth2`. |
|
|
137
167
|
|
|
138
168
|
###### Returns
|
|
139
169
|
|
|
140
170
|
`Promise`\<`boolean`\>
|
|
141
171
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
##### ~~createEcosystemLead()~~
|
|
145
|
-
|
|
146
|
-
> **createEcosystemLead**(`payload`): `Promise`\<[`EcosystemLead`](#ecosystemlead)\>
|
|
147
|
-
|
|
148
|
-
Defined in: [cobalt.ts:645](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L645)
|
|
149
|
-
|
|
150
|
-
###### Parameters
|
|
151
|
-
|
|
152
|
-
| Parameter | Type | Description |
|
|
153
|
-
| ------ | ------ | ------ |
|
|
154
|
-
| `payload` | [`EcosystemLeadPayload`](#ecosystemleadpayload) | The payload object for the lead. |
|
|
155
|
-
|
|
156
|
-
###### Returns
|
|
157
|
-
|
|
158
|
-
`Promise`\<[`EcosystemLead`](#ecosystemlead)\>
|
|
172
|
+
A promise that resolves to true if the connection was successful, otherwise false.
|
|
159
173
|
|
|
160
|
-
######
|
|
174
|
+
###### Throws
|
|
161
175
|
|
|
162
|
-
|
|
176
|
+
Throws an error if the authentication type is invalid or the connection fails.
|
|
163
177
|
|
|
164
178
|
##### createWorkflow()
|
|
165
179
|
|
|
166
180
|
> **createWorkflow**(`params`): `Promise`\<[`PublicWorkflow`](#publicworkflow)\>
|
|
167
181
|
|
|
168
|
-
Defined in: [cobalt.ts:
|
|
182
|
+
Defined in: [cobalt.ts:820](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L820)
|
|
169
183
|
|
|
170
184
|
Create a public workflow for the linked account.
|
|
171
185
|
|
|
@@ -185,7 +199,7 @@ The created public workflow.
|
|
|
185
199
|
|
|
186
200
|
> **deleteConfig**(`slug`, `configId?`): `Promise`\<`unknown`\>
|
|
187
201
|
|
|
188
|
-
Defined in: [cobalt.ts:
|
|
202
|
+
Defined in: [cobalt.ts:669](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L669)
|
|
189
203
|
|
|
190
204
|
Delete the specified config.
|
|
191
205
|
|
|
@@ -204,7 +218,7 @@ Delete the specified config.
|
|
|
204
218
|
|
|
205
219
|
> **deleteConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<`unknown`\>
|
|
206
220
|
|
|
207
|
-
Defined in: [cobalt.ts:
|
|
221
|
+
Defined in: [cobalt.ts:742](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L742)
|
|
208
222
|
|
|
209
223
|
Delete the specified config field value.
|
|
210
224
|
|
|
@@ -224,7 +238,7 @@ Delete the specified config field value.
|
|
|
224
238
|
|
|
225
239
|
> **deleteWorkflow**(`workflowId`): `Promise`\<`unknown`\>
|
|
226
240
|
|
|
227
|
-
Defined in: [cobalt.ts:
|
|
241
|
+
Defined in: [cobalt.ts:848](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L848)
|
|
228
242
|
|
|
229
243
|
Delete the specified public workflow.
|
|
230
244
|
|
|
@@ -240,9 +254,9 @@ Delete the specified public workflow.
|
|
|
240
254
|
|
|
241
255
|
##### disconnect()
|
|
242
256
|
|
|
243
|
-
> **disconnect**(`slug`): `Promise`\<`
|
|
257
|
+
> **disconnect**(`slug`, `type?`): `Promise`\<`unknown`\>
|
|
244
258
|
|
|
245
|
-
Defined in: [cobalt.ts:
|
|
259
|
+
Defined in: [cobalt.ts:557](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L557)
|
|
246
260
|
|
|
247
261
|
Disconnect the specified application and remove any associated data from Cobalt.
|
|
248
262
|
|
|
@@ -251,10 +265,11 @@ Disconnect the specified application and remove any associated data from Cobalt.
|
|
|
251
265
|
| Parameter | Type | Description |
|
|
252
266
|
| ------ | ------ | ------ |
|
|
253
267
|
| `slug` | `string` | The application slug. |
|
|
268
|
+
| `type?` | [`AuthType`](#authtype) | The authentication type to use. If not provided, it'll remove all the connected accounts. |
|
|
254
269
|
|
|
255
270
|
###### Returns
|
|
256
271
|
|
|
257
|
-
`Promise`\<`
|
|
272
|
+
`Promise`\<`unknown`\>
|
|
258
273
|
|
|
259
274
|
##### getApp()
|
|
260
275
|
|
|
@@ -270,7 +285,7 @@ The application slug.
|
|
|
270
285
|
|
|
271
286
|
> **getApp**(): `Promise`\<[`Application`](#application)[]\>
|
|
272
287
|
|
|
273
|
-
Defined in: [cobalt.ts:
|
|
288
|
+
Defined in: [cobalt.ts:374](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L374)
|
|
274
289
|
|
|
275
290
|
Returns the list of enabled applications and their details.
|
|
276
291
|
|
|
@@ -288,7 +303,7 @@ The application slug.
|
|
|
288
303
|
|
|
289
304
|
> **getApp**(`slug`): `Promise`\<[`Application`](#application)\>
|
|
290
305
|
|
|
291
|
-
Defined in: [cobalt.ts:
|
|
306
|
+
Defined in: [cobalt.ts:381](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L381)
|
|
292
307
|
|
|
293
308
|
Returns the application details for the specified application, provided
|
|
294
309
|
the application is enabled in Cobalt.
|
|
@@ -313,7 +328,7 @@ The application slug.
|
|
|
313
328
|
|
|
314
329
|
> **getApps**(): `Promise`\<[`Application`](#application)[]\>
|
|
315
330
|
|
|
316
|
-
Defined in: [cobalt.ts:
|
|
331
|
+
Defined in: [cobalt.ts:409](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L409)
|
|
317
332
|
|
|
318
333
|
Returns all the enabled apps.
|
|
319
334
|
|
|
@@ -327,7 +342,7 @@ The list of applications.
|
|
|
327
342
|
|
|
328
343
|
> **getConfig**(`slug`, `configId?`): `Promise`\<[`Config`](#config-2)\>
|
|
329
344
|
|
|
330
|
-
Defined in: [cobalt.ts:
|
|
345
|
+
Defined in: [cobalt.ts:625](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L625)
|
|
331
346
|
|
|
332
347
|
Returns the specified config.
|
|
333
348
|
|
|
@@ -348,7 +363,7 @@ The specified config.
|
|
|
348
363
|
|
|
349
364
|
> **getConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
|
|
350
365
|
|
|
351
|
-
Defined in: [cobalt.ts:
|
|
366
|
+
Defined in: [cobalt.ts:692](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L692)
|
|
352
367
|
|
|
353
368
|
Returns the specified field of the config.
|
|
354
369
|
|
|
@@ -370,7 +385,7 @@ The specified config field.
|
|
|
370
385
|
|
|
371
386
|
> **getConfigs**(`slug`): `Promise`\<`object`[]\>
|
|
372
387
|
|
|
373
|
-
Defined in: [cobalt.ts:
|
|
388
|
+
Defined in: [cobalt.ts:604](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L604)
|
|
374
389
|
|
|
375
390
|
Returns the configs created for the specified application.
|
|
376
391
|
|
|
@@ -390,7 +405,7 @@ The configs created for the specified application.
|
|
|
390
405
|
|
|
391
406
|
> **getExecution**(`executionId`): `Promise`\<[`Execution`](#execution)\>
|
|
392
407
|
|
|
393
|
-
Defined in: [cobalt.ts:
|
|
408
|
+
Defined in: [cobalt.ts:891](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L891)
|
|
394
409
|
|
|
395
410
|
Returns the specified workflow execution log.
|
|
396
411
|
|
|
@@ -410,7 +425,7 @@ The specified execution log.
|
|
|
410
425
|
|
|
411
426
|
> **getExecutions**(`params?`): `Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
|
|
412
427
|
|
|
413
|
-
Defined in: [cobalt.ts:
|
|
428
|
+
Defined in: [cobalt.ts:871](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L871)
|
|
414
429
|
|
|
415
430
|
Returns the workflow execution logs for the linked account.
|
|
416
431
|
|
|
@@ -430,7 +445,7 @@ The paginated workflow execution logs.
|
|
|
430
445
|
|
|
431
446
|
> **getFieldOptions**(`lhs`, `slug`, `fieldId`, `workflowId?`): `Promise`\<[`RuleOptions`](#ruleoptions)\>
|
|
432
447
|
|
|
433
|
-
Defined in: [cobalt.ts:
|
|
448
|
+
Defined in: [cobalt.ts:767](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L767)
|
|
434
449
|
|
|
435
450
|
Returns the options for the specified field.
|
|
436
451
|
|
|
@@ -453,7 +468,7 @@ The specified rule field's options.
|
|
|
453
468
|
|
|
454
469
|
> **getWorkflows**(`params?`): `Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
|
|
455
470
|
|
|
456
|
-
Defined in: [cobalt.ts:
|
|
471
|
+
Defined in: [cobalt.ts:796](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L796)
|
|
457
472
|
|
|
458
473
|
Returns the private workflows for the specified application.
|
|
459
474
|
|
|
@@ -471,7 +486,7 @@ Returns the private workflows for the specified application.
|
|
|
471
486
|
|
|
472
487
|
> **updateConfig**(`payload`): `Promise`\<[`Config`](#config-2)\>
|
|
473
488
|
|
|
474
|
-
Defined in: [cobalt.ts:
|
|
489
|
+
Defined in: [cobalt.ts:645](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L645)
|
|
475
490
|
|
|
476
491
|
Update the specified config.
|
|
477
492
|
|
|
@@ -491,7 +506,7 @@ The specified config.
|
|
|
491
506
|
|
|
492
507
|
> **updateConfigField**(`slug`, `fieldId`, `value`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
|
|
493
508
|
|
|
494
|
-
Defined in: [cobalt.ts:
|
|
509
|
+
Defined in: [cobalt.ts:716](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L716)
|
|
495
510
|
|
|
496
511
|
Update the specified config field value.
|
|
497
512
|
|
|
@@ -514,7 +529,7 @@ The updated config field.
|
|
|
514
529
|
|
|
515
530
|
### Application
|
|
516
531
|
|
|
517
|
-
Defined in: [cobalt.ts:
|
|
532
|
+
Defined in: [cobalt.ts:16](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L16)
|
|
518
533
|
|
|
519
534
|
An application in Cobalt.
|
|
520
535
|
|
|
@@ -522,76 +537,80 @@ An application in Cobalt.
|
|
|
522
537
|
|
|
523
538
|
| Property | Type | Description | Defined in |
|
|
524
539
|
| ------ | ------ | ------ | ------ |
|
|
525
|
-
| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:
|
|
526
|
-
| <a id="auth_input_map"></a>
|
|
527
|
-
| <a id="auth_type"></a>
|
|
528
|
-
| <a id="
|
|
529
|
-
|
|
|
530
|
-
|
|
|
531
|
-
| <a id="
|
|
532
|
-
| <a id="
|
|
533
|
-
| <a id="
|
|
534
|
-
| <a id="
|
|
535
|
-
| <a id="
|
|
540
|
+
| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:18](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L18) |
|
|
541
|
+
| <a id="auth_input_map"></a> ~~`auth_input_map?`~~ | [`InputField`](#inputfield)[] | The fields required from the user to connect the application (for `keybased` auth type). **Deprecated** Check `auth_type_options` for multiple auth types support. | [cobalt.ts:69](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L69) |
|
|
542
|
+
| <a id="auth_type"></a> ~~`auth_type`~~ | `"oauth2"` \| `"keybased"` | The type of auth used by application. **Deprecated** Check `auth_type_options` and `connected_accounts` for multiple auth types support. | [cobalt.ts:54](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L54) |
|
|
543
|
+
| <a id="auth_type_options"></a> `auth_type_options?` | `object` | The supported auth types for the application, and the fields required from the user to connect the application. | [cobalt.ts:35](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L35) |
|
|
544
|
+
| `auth_type_options.keybased` | [`InputField`](#inputfield)[] | - | |
|
|
545
|
+
| `auth_type_options.oauth2` | [`InputField`](#inputfield)[] | - | |
|
|
546
|
+
| <a id="connected"></a> ~~`connected?`~~ | `boolean` | Whether the user has connected the application. **Deprecated** Check `connected_accounts` for multiple auth types support. | [cobalt.ts:59](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L59) |
|
|
547
|
+
| <a id="connected_accounts"></a> `connected_accounts?` | `object`[] | The list of connected accounts for this application | [cobalt.ts:40](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L40) |
|
|
548
|
+
| <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:22](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L22) |
|
|
549
|
+
| <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:24](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L24) |
|
|
550
|
+
| <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:20](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L20) |
|
|
551
|
+
| <a id="reauth_required"></a> ~~`reauth_required?`~~ | `boolean` | Whether the connection has expired and re-auth is required. **Deprecated** Check `connected_accounts` for multiple auth types support. | [cobalt.ts:64](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L64) |
|
|
552
|
+
| <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:31](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L31) |
|
|
553
|
+
| <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:33](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L33) |
|
|
554
|
+
| <a id="type"></a> ~~`type`~~ | `string` | **Deprecated** Use `slug` instead. The application slug for native apps and `custom` for custom apps. | [cobalt.ts:29](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L29) |
|
|
536
555
|
|
|
537
556
|
***
|
|
538
557
|
|
|
539
558
|
### CobaltOptions
|
|
540
559
|
|
|
541
|
-
Defined in: [cobalt.ts:
|
|
560
|
+
Defined in: [cobalt.ts:135](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L135)
|
|
542
561
|
|
|
543
562
|
#### Properties
|
|
544
563
|
|
|
545
564
|
| Property | Type | Description | Defined in |
|
|
546
565
|
| ------ | ------ | ------ | ------ |
|
|
547
|
-
| <a id="baseurl"></a> `baseUrl?` | `string` | The base URL of the Cobalt API. You don't need to set this. | [cobalt.ts:
|
|
548
|
-
| <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:
|
|
566
|
+
| <a id="baseurl"></a> `baseUrl?` | `string` | The base URL of the Cobalt API. You don't need to set this. | [cobalt.ts:137](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L137) |
|
|
567
|
+
| <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:139](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L139) |
|
|
549
568
|
|
|
550
569
|
***
|
|
551
570
|
|
|
552
571
|
### Config
|
|
553
572
|
|
|
554
|
-
Defined in: [cobalt.ts:
|
|
573
|
+
Defined in: [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L207)
|
|
555
574
|
|
|
556
575
|
#### Properties
|
|
557
576
|
|
|
558
577
|
| Property | Type | Defined in |
|
|
559
578
|
| ------ | ------ | ------ |
|
|
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:
|
|
579
|
+
| <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:209](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L209) |
|
|
580
|
+
| <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:212](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L212) |
|
|
581
|
+
| <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:210](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L210) |
|
|
582
|
+
| <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:208](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L208) |
|
|
583
|
+
| <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:211](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L211) |
|
|
565
584
|
|
|
566
585
|
***
|
|
567
586
|
|
|
568
587
|
### ConfigField
|
|
569
588
|
|
|
570
|
-
Defined in: [cobalt.ts:
|
|
589
|
+
Defined in: [cobalt.ts:222](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L222)
|
|
571
590
|
|
|
572
591
|
#### Properties
|
|
573
592
|
|
|
574
593
|
| Property | Type | Description | Defined in |
|
|
575
594
|
| ------ | ------ | ------ | ------ |
|
|
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:
|
|
595
|
+
| <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:244](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L244) |
|
|
596
|
+
| <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L225) |
|
|
597
|
+
| <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:242](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L242) |
|
|
598
|
+
| <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:237](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L237) |
|
|
599
|
+
| <a id="id"></a> `id` | `string` | - | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L223) |
|
|
600
|
+
| <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L231) |
|
|
601
|
+
| <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:235](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L235) |
|
|
602
|
+
| <a id="name-1"></a> `name` | `string` | - | [cobalt.ts:224](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L224) |
|
|
603
|
+
| <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:226](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L226) |
|
|
604
|
+
| <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:230](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L230) |
|
|
605
|
+
| <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:240](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L240) |
|
|
606
|
+
| <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:236](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L236) |
|
|
607
|
+
| <a id="value"></a> `value?` | `any` | - | [cobalt.ts:238](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L238) |
|
|
589
608
|
|
|
590
609
|
***
|
|
591
610
|
|
|
592
611
|
### ConfigPayload
|
|
593
612
|
|
|
594
|
-
Defined in: [cobalt.ts:
|
|
613
|
+
Defined in: [cobalt.ts:96](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L96)
|
|
595
614
|
|
|
596
615
|
The payload object for config.
|
|
597
616
|
|
|
@@ -599,105 +618,72 @@ The payload object for config.
|
|
|
599
618
|
|
|
600
619
|
| Property | Type | Description | Defined in |
|
|
601
620
|
| ------ | ------ | ------ | ------ |
|
|
602
|
-
| <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:
|
|
603
|
-
| <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:
|
|
604
|
-
| <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:
|
|
621
|
+
| <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:100](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L100) |
|
|
622
|
+
| <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:102](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L102) |
|
|
623
|
+
| <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:98](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L98) |
|
|
605
624
|
|
|
606
625
|
***
|
|
607
626
|
|
|
608
627
|
### ConfigWorkflow
|
|
609
628
|
|
|
610
|
-
Defined in: [cobalt.ts:
|
|
611
|
-
|
|
612
|
-
#### Properties
|
|
613
|
-
|
|
614
|
-
| Property | Type | Defined in |
|
|
615
|
-
| ------ | ------ | ------ |
|
|
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
|
-
|
|
622
|
-
***
|
|
623
|
-
|
|
624
|
-
### ~~EcosystemLead~~
|
|
625
|
-
|
|
626
|
-
Defined in: [cobalt.ts:107](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/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/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L108) |
|
|
635
|
-
| <a id="created_at"></a> ~~`created_at`~~ | `string` | [cobalt.ts:112](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L112) |
|
|
636
|
-
| <a id="description-2"></a> ~~`description?`~~ | `string` | [cobalt.ts:111](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L111) |
|
|
637
|
-
| <a id="email"></a> ~~`email`~~ | `string` | [cobalt.ts:110](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L110) |
|
|
638
|
-
| <a id="name-3"></a> ~~`name?`~~ | `string` | [cobalt.ts:109](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L109) |
|
|
639
|
-
|
|
640
|
-
***
|
|
641
|
-
|
|
642
|
-
### ~~EcosystemLeadPayload~~
|
|
643
|
-
|
|
644
|
-
Defined in: [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/75a69bc12a168bf0c6c8008ed3680be04c2ac42f/cobalt.ts#L118)
|
|
645
|
-
|
|
646
|
-
#### Deprecated
|
|
629
|
+
Defined in: [cobalt.ts:247](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L247)
|
|
647
630
|
|
|
648
631
|
#### Properties
|
|
649
632
|
|
|
650
633
|
| Property | Type | Defined in |
|
|
651
634
|
| ------ | ------ | ------ |
|
|
652
|
-
| <a id="description-
|
|
653
|
-
| <a id="
|
|
654
|
-
| <a id="
|
|
655
|
-
| <a id="
|
|
635
|
+
| <a id="description-1"></a> `description?` | `string` | [cobalt.ts:250](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L250) |
|
|
636
|
+
| <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:251](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L251) |
|
|
637
|
+
| <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:252](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L252) |
|
|
638
|
+
| <a id="id-1"></a> `id` | `string` | [cobalt.ts:248](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L248) |
|
|
639
|
+
| <a id="name-2"></a> `name` | `string` | [cobalt.ts:249](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L249) |
|
|
656
640
|
|
|
657
641
|
***
|
|
658
642
|
|
|
659
643
|
### Execution
|
|
660
644
|
|
|
661
|
-
Defined in: [cobalt.ts:
|
|
645
|
+
Defined in: [cobalt.ts:255](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L255)
|
|
662
646
|
|
|
663
647
|
#### Properties
|
|
664
648
|
|
|
665
649
|
| Property | Type | Defined in |
|
|
666
650
|
| ------ | ------ | ------ |
|
|
667
|
-
| <a id="_id
|
|
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="
|
|
685
|
-
| <a id="
|
|
686
|
-
| <a id="
|
|
687
|
-
| <a id="
|
|
688
|
-
| <a id="
|
|
689
|
-
| <a id="
|
|
690
|
-
| <a id="
|
|
691
|
-
| <a id="
|
|
692
|
-
| <a id="
|
|
693
|
-
| <a id="
|
|
694
|
-
| <a id="
|
|
651
|
+
| <a id="_id"></a> `_id` | `string` | [cobalt.ts:256](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L256) |
|
|
652
|
+
| <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:260](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L260) |
|
|
653
|
+
| `associated_application._id` | `string` | [cobalt.ts:261](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L261) |
|
|
654
|
+
| `associated_application.icon?` | `string` | [cobalt.ts:263](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L263) |
|
|
655
|
+
| `associated_application.name` | `string` | [cobalt.ts:262](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L262) |
|
|
656
|
+
| <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:284](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L284) |
|
|
657
|
+
| <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:270](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L270) |
|
|
658
|
+
| `associated_trigger_application._id` | `string` | [cobalt.ts:271](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L271) |
|
|
659
|
+
| `associated_trigger_application.app_type?` | `string` | [cobalt.ts:274](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L274) |
|
|
660
|
+
| `associated_trigger_application.icon?` | `string` | [cobalt.ts:273](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L273) |
|
|
661
|
+
| `associated_trigger_application.name` | `string` | [cobalt.ts:272](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L272) |
|
|
662
|
+
| `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:275](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L275) |
|
|
663
|
+
| `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:276](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L276) |
|
|
664
|
+
| `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:277](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L277) |
|
|
665
|
+
| <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:266](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L266) |
|
|
666
|
+
| `associated_workflow._id` | `string` | [cobalt.ts:267](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L267) |
|
|
667
|
+
| `associated_workflow.name` | `string` | [cobalt.ts:268](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L268) |
|
|
668
|
+
| <a id="completion_percentage"></a> `completion_percentage?` | `number` | [cobalt.ts:287](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L287) |
|
|
669
|
+
| <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:283](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L283) |
|
|
670
|
+
| <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:299](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L299) |
|
|
671
|
+
| <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:286](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L286) |
|
|
672
|
+
| <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:285](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L285) |
|
|
673
|
+
| <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:282](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L282) |
|
|
674
|
+
| <a id="id-2"></a> `id?` | `string` | [cobalt.ts:257](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L257) |
|
|
675
|
+
| <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:281](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L281) |
|
|
676
|
+
| <a id="name-3"></a> `name` | `string` | [cobalt.ts:258](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L258) |
|
|
677
|
+
| <a id="nodes"></a> `nodes?` | `object`[] | [cobalt.ts:288](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L288) |
|
|
678
|
+
| <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:259](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L259) |
|
|
679
|
+
| <a id="status"></a> `status` | `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"` | [cobalt.ts:265](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L265) |
|
|
680
|
+
| <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:280](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L280) |
|
|
695
681
|
|
|
696
682
|
***
|
|
697
683
|
|
|
698
684
|
### InputField
|
|
699
685
|
|
|
700
|
-
Defined in: [cobalt.ts:
|
|
686
|
+
Defined in: [cobalt.ts:73](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L73)
|
|
701
687
|
|
|
702
688
|
An Input field to take input from the user.
|
|
703
689
|
|
|
@@ -705,20 +691,20 @@ An Input field to take input from the user.
|
|
|
705
691
|
|
|
706
692
|
| Property | Type | Description | Defined in |
|
|
707
693
|
| ------ | ------ | ------ | ------ |
|
|
708
|
-
| <a id="help_text-1"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:
|
|
709
|
-
| <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:
|
|
710
|
-
| <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:
|
|
711
|
-
| <a id="name-
|
|
712
|
-
| <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:
|
|
713
|
-
| <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:
|
|
714
|
-
| <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:
|
|
715
|
-
| <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:
|
|
694
|
+
| <a id="help_text-1"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:87](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L87) |
|
|
695
|
+
| <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:85](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L85) |
|
|
696
|
+
| <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:81](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L81) |
|
|
697
|
+
| <a id="name-4"></a> `name` | `string` | Key name of the field. | [cobalt.ts:75](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L75) |
|
|
698
|
+
| <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:89](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L89) |
|
|
699
|
+
| <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:83](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L83) |
|
|
700
|
+
| <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:79](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L79) |
|
|
701
|
+
| <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:77](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L77) |
|
|
716
702
|
|
|
717
703
|
***
|
|
718
704
|
|
|
719
705
|
### Label
|
|
720
706
|
|
|
721
|
-
Defined in: [cobalt.ts:
|
|
707
|
+
Defined in: [cobalt.ts:106](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L106)
|
|
722
708
|
|
|
723
709
|
Label Mapping
|
|
724
710
|
|
|
@@ -726,14 +712,14 @@ Label Mapping
|
|
|
726
712
|
|
|
727
713
|
| Property | Type | Description | Defined in |
|
|
728
714
|
| ------ | ------ | ------ | ------ |
|
|
729
|
-
| <a id="name-
|
|
730
|
-
| <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:
|
|
715
|
+
| <a id="name-5"></a> `name` | `string` | The label name. | [cobalt.ts:108](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L108) |
|
|
716
|
+
| <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:110](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L110) |
|
|
731
717
|
|
|
732
718
|
***
|
|
733
719
|
|
|
734
720
|
### PublicWorkflow
|
|
735
721
|
|
|
736
|
-
Defined in: [cobalt.ts:
|
|
722
|
+
Defined in: [cobalt.ts:163](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L163)
|
|
737
723
|
|
|
738
724
|
A public workflow in Cobalt.
|
|
739
725
|
|
|
@@ -741,19 +727,19 @@ A public workflow in Cobalt.
|
|
|
741
727
|
|
|
742
728
|
| Property | Type | Description | Defined in |
|
|
743
729
|
| ------ | ------ | ------ | ------ |
|
|
744
|
-
| <a id="_id-
|
|
745
|
-
| <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:
|
|
746
|
-
| <a id="description-
|
|
747
|
-
| <a id="name-
|
|
748
|
-
| <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:
|
|
749
|
-
| <a id="slug-
|
|
750
|
-
| <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [cobalt.ts:
|
|
730
|
+
| <a id="_id-1"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:165](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L165) |
|
|
731
|
+
| <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:173](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L173) |
|
|
732
|
+
| <a id="description-2"></a> `description?` | `string` | The workflow description. | [cobalt.ts:169](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L169) |
|
|
733
|
+
| <a id="name-6"></a> `name` | `string` | The workflow name. | [cobalt.ts:167](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L167) |
|
|
734
|
+
| <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:177](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L177) |
|
|
735
|
+
| <a id="slug-3"></a> `slug?` | `string` | The application's slug in which this workflow exists. | [cobalt.ts:171](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L171) |
|
|
736
|
+
| <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [cobalt.ts:175](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L175) |
|
|
751
737
|
|
|
752
738
|
***
|
|
753
739
|
|
|
754
740
|
### PublicWorkflowPayload
|
|
755
741
|
|
|
756
|
-
Defined in: [cobalt.ts:
|
|
742
|
+
Defined in: [cobalt.ts:181](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L181)
|
|
757
743
|
|
|
758
744
|
The payload for creating a public workflow for the linked account.
|
|
759
745
|
|
|
@@ -761,15 +747,15 @@ The payload for creating a public workflow for the linked account.
|
|
|
761
747
|
|
|
762
748
|
| Property | Type | Description | Defined in |
|
|
763
749
|
| ------ | ------ | ------ | ------ |
|
|
764
|
-
| <a id="description-
|
|
765
|
-
| <a id="name-
|
|
766
|
-
| <a id="slug-
|
|
750
|
+
| <a id="description-3"></a> `description?` | `string` | The workflow description. | [cobalt.ts:185](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L185) |
|
|
751
|
+
| <a id="name-7"></a> `name` | `string` | The workflow name. | [cobalt.ts:183](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L183) |
|
|
752
|
+
| <a id="slug-4"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [cobalt.ts:187](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L187) |
|
|
767
753
|
|
|
768
754
|
***
|
|
769
755
|
|
|
770
756
|
### PublicWorkflowsPayload
|
|
771
757
|
|
|
772
|
-
Defined in: [cobalt.ts:
|
|
758
|
+
Defined in: [cobalt.ts:190](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L190)
|
|
773
759
|
|
|
774
760
|
#### Extends
|
|
775
761
|
|
|
@@ -779,39 +765,39 @@ Defined in: [cobalt.ts:173](https://github.com/gocobalt/cobalt-js/blob/75a69bc12
|
|
|
779
765
|
|
|
780
766
|
| Property | Type | Inherited from | Defined in |
|
|
781
767
|
| ------ | ------ | ------ | ------ |
|
|
782
|
-
| <a id="limit"></a> `limit?` | `number` | `PaginationProps.limit` | [cobalt.ts:
|
|
783
|
-
| <a id="page"></a> `page?` | `number` | `PaginationProps.page` | [cobalt.ts:
|
|
784
|
-
| <a id="slug-
|
|
768
|
+
| <a id="limit"></a> `limit?` | `number` | `PaginationProps.limit` | [cobalt.ts:196](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L196) |
|
|
769
|
+
| <a id="page"></a> `page?` | `number` | `PaginationProps.page` | [cobalt.ts:195](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L195) |
|
|
770
|
+
| <a id="slug-5"></a> `slug?` | `string` | - | [cobalt.ts:191](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L191) |
|
|
785
771
|
|
|
786
772
|
***
|
|
787
773
|
|
|
788
774
|
### RuleOptions
|
|
789
775
|
|
|
790
|
-
Defined in: [cobalt.ts:
|
|
776
|
+
Defined in: [cobalt.ts:142](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L142)
|
|
791
777
|
|
|
792
778
|
#### Properties
|
|
793
779
|
|
|
794
780
|
| Property | Type | Defined in |
|
|
795
781
|
| ------ | ------ | ------ |
|
|
796
|
-
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:
|
|
797
|
-
| <a id="error"></a> `error?` | `object` | [cobalt.ts:
|
|
798
|
-
| `error.message?` | `string` | [cobalt.ts:
|
|
799
|
-
| `error.stack?` | `string` | [cobalt.ts:
|
|
800
|
-
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:
|
|
801
|
-
| `rule_column.operator` | `object` | [cobalt.ts:
|
|
802
|
-
| `rule_column.operator.name` | `string` | [cobalt.ts:
|
|
803
|
-
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:
|
|
804
|
-
| `rule_column.operator.type` | `"select"` | [cobalt.ts:
|
|
805
|
-
| `rule_column.rhs` | `object` | [cobalt.ts:
|
|
806
|
-
| `rule_column.rhs.name` | `string` | [cobalt.ts:
|
|
807
|
-
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:
|
|
808
|
-
| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:
|
|
782
|
+
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:155](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L155) |
|
|
783
|
+
| <a id="error"></a> `error?` | `object` | [cobalt.ts:156](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L156) |
|
|
784
|
+
| `error.message?` | `string` | [cobalt.ts:157](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L157) |
|
|
785
|
+
| `error.stack?` | `string` | [cobalt.ts:158](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L158) |
|
|
786
|
+
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:143](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L143) |
|
|
787
|
+
| `rule_column.operator` | `object` | [cobalt.ts:149](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L149) |
|
|
788
|
+
| `rule_column.operator.name` | `string` | [cobalt.ts:150](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L150) |
|
|
789
|
+
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:152](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L152) |
|
|
790
|
+
| `rule_column.operator.type` | `"select"` | [cobalt.ts:151](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L151) |
|
|
791
|
+
| `rule_column.rhs` | `object` | [cobalt.ts:144](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L144) |
|
|
792
|
+
| `rule_column.rhs.name` | `string` | [cobalt.ts:145](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L145) |
|
|
793
|
+
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:147](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L147) |
|
|
794
|
+
| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L146) |
|
|
809
795
|
|
|
810
796
|
***
|
|
811
797
|
|
|
812
798
|
### UpdateConfigPayload
|
|
813
799
|
|
|
814
|
-
Defined in: [cobalt.ts:
|
|
800
|
+
Defined in: [cobalt.ts:114](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L114)
|
|
815
801
|
|
|
816
802
|
The configuration data for an application.
|
|
817
803
|
|
|
@@ -819,16 +805,16 @@ The configuration data for an application.
|
|
|
819
805
|
|
|
820
806
|
| Property | Type | Description | Defined in |
|
|
821
807
|
| ------ | ------ | ------ | ------ |
|
|
822
|
-
| <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:
|
|
823
|
-
| <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [cobalt.ts:
|
|
824
|
-
| <a id="slug-
|
|
825
|
-
| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:
|
|
808
|
+
| <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L118) |
|
|
809
|
+
| <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [cobalt.ts:120](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L120) |
|
|
810
|
+
| <a id="slug-6"></a> `slug` | `string` | The application slug | [cobalt.ts:116](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L116) |
|
|
811
|
+
| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:122](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L122) |
|
|
826
812
|
|
|
827
813
|
***
|
|
828
814
|
|
|
829
815
|
### WorkflowPayload
|
|
830
816
|
|
|
831
|
-
Defined in: [cobalt.ts:
|
|
817
|
+
Defined in: [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L126)
|
|
832
818
|
|
|
833
819
|
The workflow.
|
|
834
820
|
|
|
@@ -836,6 +822,6 @@ The workflow.
|
|
|
836
822
|
|
|
837
823
|
| Property | Type | Description | Defined in |
|
|
838
824
|
| ------ | ------ | ------ | ------ |
|
|
839
|
-
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:
|
|
840
|
-
| <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [cobalt.ts:
|
|
841
|
-
| <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:
|
|
825
|
+
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:130](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L130) |
|
|
826
|
+
| <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [cobalt.ts:132](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L132) |
|
|
827
|
+
| <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/caefd941c90edc45c8f28f08c8b3f7e325742361/cobalt.ts#L128) |
|