@cobaltio/cobalt-js 9.2.0 → 9.2.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 +2 -1
- package/cobalt.js +3 -4
- package/cobalt.ts +4 -2
- package/docs/classes/Cobalt.html +24 -23
- package/docs/enums/AuthStatus.html +2 -2
- package/docs/enums/AuthType.html +2 -2
- package/docs/interfaces/Application.html +14 -14
- 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/ExecuteWorkflowPayload.html +5 -5
- package/docs/interfaces/Execution.html +2 -2
- package/docs/interfaces/ExecutionFilters.html +8 -8
- package/docs/interfaces/GetExecutionsParams.html +8 -8
- 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 +6 -6
- package/docs/interfaces/RuleOptions.html +2 -2
- package/docs/interfaces/UpdateConfigPayload.html +5 -5
- package/docs/interfaces/WorkflowPayload.html +4 -4
- package/docs/interfaces/WorkflowPayloadResponse.html +2 -2
- package/docs/llms.txt +195 -194
- package/docs/types/ExecutionSource.html +1 -1
- package/docs/types/ExecutionStatus.html +1 -1
- package/docs/types/ExecutionType.html +1 -1
- package/package.json +1 -1
package/docs/llms.txt
CHANGED
|
@@ -70,20 +70,20 @@ cobalt.token = "COBALT_SESSION_TOKEN";
|
|
|
70
70
|
|
|
71
71
|
### AuthStatus
|
|
72
72
|
|
|
73
|
-
Defined in: [cobalt.ts:10](https://github.com/gocobalt/cobalt-js/blob/
|
|
73
|
+
Defined in: [cobalt.ts:10](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L10)
|
|
74
74
|
|
|
75
75
|
#### Enumeration Members
|
|
76
76
|
|
|
77
77
|
| Enumeration Member | Value | Defined in |
|
|
78
78
|
| ------ | ------ | ------ |
|
|
79
|
-
| <a id="enumeration-member-active"></a> `Active` | `"active"` | [cobalt.ts:11](https://github.com/gocobalt/cobalt-js/blob/
|
|
80
|
-
| <a id="enumeration-member-expired"></a> `Expired` | `"expired"` | [cobalt.ts:12](https://github.com/gocobalt/cobalt-js/blob/
|
|
79
|
+
| <a id="enumeration-member-active"></a> `Active` | `"active"` | [cobalt.ts:11](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L11) |
|
|
80
|
+
| <a id="enumeration-member-expired"></a> `Expired` | `"expired"` | [cobalt.ts:12](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L12) |
|
|
81
81
|
|
|
82
82
|
***
|
|
83
83
|
|
|
84
84
|
### AuthType
|
|
85
85
|
|
|
86
|
-
Defined in: [cobalt.ts:5](https://github.com/gocobalt/cobalt-js/blob/
|
|
86
|
+
Defined in: [cobalt.ts:5](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L5)
|
|
87
87
|
|
|
88
88
|
Cobalt Frontend SDK
|
|
89
89
|
|
|
@@ -91,14 +91,14 @@ Cobalt Frontend SDK
|
|
|
91
91
|
|
|
92
92
|
| Enumeration Member | Value | Defined in |
|
|
93
93
|
| ------ | ------ | ------ |
|
|
94
|
-
| <a id="enumeration-member-keybased"></a> `KeyBased` | `"keybased"` | [cobalt.ts:7](https://github.com/gocobalt/cobalt-js/blob/
|
|
95
|
-
| <a id="enumeration-member-oauth2"></a> `OAuth2` | `"oauth2"` | [cobalt.ts:6](https://github.com/gocobalt/cobalt-js/blob/
|
|
94
|
+
| <a id="enumeration-member-keybased"></a> `KeyBased` | `"keybased"` | [cobalt.ts:7](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L7) |
|
|
95
|
+
| <a id="enumeration-member-oauth2"></a> `OAuth2` | `"oauth2"` | [cobalt.ts:6](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L6) |
|
|
96
96
|
|
|
97
97
|
## Classes
|
|
98
98
|
|
|
99
99
|
### Cobalt
|
|
100
100
|
|
|
101
|
-
Defined in: [cobalt.ts:364](https://github.com/gocobalt/cobalt-js/blob/
|
|
101
|
+
Defined in: [cobalt.ts:364](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L364)
|
|
102
102
|
|
|
103
103
|
#### Constructors
|
|
104
104
|
|
|
@@ -106,7 +106,7 @@ Defined in: [cobalt.ts:364](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5
|
|
|
106
106
|
|
|
107
107
|
> **new Cobalt**(`options?`): [`Cobalt`](#cobalt)
|
|
108
108
|
|
|
109
|
-
Defined in: [cobalt.ts:374](https://github.com/gocobalt/cobalt-js/blob/
|
|
109
|
+
Defined in: [cobalt.ts:374](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L374)
|
|
110
110
|
|
|
111
111
|
Cobalt Frontend SDK
|
|
112
112
|
|
|
@@ -124,7 +124,7 @@ Cobalt Frontend SDK
|
|
|
124
124
|
|
|
125
125
|
| Property | Modifier | Type | Defined in |
|
|
126
126
|
| ------ | ------ | ------ | ------ |
|
|
127
|
-
| <a id="token"></a> `token` | `public` | `string` | [cobalt.ts:366](https://github.com/gocobalt/cobalt-js/blob/
|
|
127
|
+
| <a id="token"></a> `token` | `public` | `string` | [cobalt.ts:366](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L366) |
|
|
128
128
|
|
|
129
129
|
#### Methods
|
|
130
130
|
|
|
@@ -132,7 +132,7 @@ Cobalt Frontend SDK
|
|
|
132
132
|
|
|
133
133
|
> **config**(`payload`): `Promise`\<[`Config`](#config-1)\>
|
|
134
134
|
|
|
135
|
-
Defined in: [cobalt.ts:638](https://github.com/gocobalt/cobalt-js/blob/
|
|
135
|
+
Defined in: [cobalt.ts:638](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L638)
|
|
136
136
|
|
|
137
137
|
Returns the specified config, or creates one if it doesn't exist.
|
|
138
138
|
|
|
@@ -152,7 +152,7 @@ The specified config.
|
|
|
152
152
|
|
|
153
153
|
> **connect**(`params`): `Promise`\<`boolean`\>
|
|
154
154
|
|
|
155
|
-
Defined in: [cobalt.ts:591](https://github.com/gocobalt/cobalt-js/blob/
|
|
155
|
+
Defined in: [cobalt.ts:591](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L591)
|
|
156
156
|
|
|
157
157
|
Connects the specified application using the provided authentication type and optional auth data.
|
|
158
158
|
|
|
@@ -179,7 +179,7 @@ Throws an error if the authentication type is invalid or the connection fails.
|
|
|
179
179
|
|
|
180
180
|
> **createWorkflow**(`params`): `Promise`\<[`PublicWorkflow`](#publicworkflow)\>
|
|
181
181
|
|
|
182
|
-
Defined in: [cobalt.ts:
|
|
182
|
+
Defined in: [cobalt.ts:892](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L892)
|
|
183
183
|
|
|
184
184
|
Create a public workflow for the linked account.
|
|
185
185
|
|
|
@@ -199,7 +199,7 @@ The created public workflow.
|
|
|
199
199
|
|
|
200
200
|
> **deleteConfig**(`slug`, `configId?`): `Promise`\<`unknown`\>
|
|
201
201
|
|
|
202
|
-
Defined in: [cobalt.ts:
|
|
202
|
+
Defined in: [cobalt.ts:731](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L731)
|
|
203
203
|
|
|
204
204
|
Delete the specified config.
|
|
205
205
|
|
|
@@ -218,7 +218,7 @@ Delete the specified config.
|
|
|
218
218
|
|
|
219
219
|
> **deleteConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<`unknown`\>
|
|
220
220
|
|
|
221
|
-
Defined in: [cobalt.ts:
|
|
221
|
+
Defined in: [cobalt.ts:804](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L804)
|
|
222
222
|
|
|
223
223
|
Delete the specified config field value.
|
|
224
224
|
|
|
@@ -238,7 +238,7 @@ Delete the specified config field value.
|
|
|
238
238
|
|
|
239
239
|
> **deleteWorkflow**(`workflowId`): `Promise`\<`unknown`\>
|
|
240
240
|
|
|
241
|
-
Defined in: [cobalt.ts:
|
|
241
|
+
Defined in: [cobalt.ts:920](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L920)
|
|
242
242
|
|
|
243
243
|
Delete the specified public workflow.
|
|
244
244
|
|
|
@@ -256,7 +256,7 @@ Delete the specified public workflow.
|
|
|
256
256
|
|
|
257
257
|
> **disconnect**(`slug`, `type?`): `Promise`\<`unknown`\>
|
|
258
258
|
|
|
259
|
-
Defined in: [cobalt.ts:617](https://github.com/gocobalt/cobalt-js/blob/
|
|
259
|
+
Defined in: [cobalt.ts:617](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L617)
|
|
260
260
|
|
|
261
261
|
Disconnect the specified application and remove any associated data from Cobalt.
|
|
262
262
|
|
|
@@ -275,7 +275,7 @@ Disconnect the specified application and remove any associated data from Cobalt.
|
|
|
275
275
|
|
|
276
276
|
> **executeWorkflow**(`options`): `Promise`\<`unknown`\>
|
|
277
277
|
|
|
278
|
-
Defined in: [cobalt.ts:
|
|
278
|
+
Defined in: [cobalt.ts:964](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L964)
|
|
279
279
|
|
|
280
280
|
Execute the specified public workflow.
|
|
281
281
|
|
|
@@ -303,7 +303,7 @@ The application slug.
|
|
|
303
303
|
|
|
304
304
|
> **getApp**(): `Promise`\<[`Application`](#application)[]\>
|
|
305
305
|
|
|
306
|
-
Defined in: [cobalt.ts:434](https://github.com/gocobalt/cobalt-js/blob/
|
|
306
|
+
Defined in: [cobalt.ts:434](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L434)
|
|
307
307
|
|
|
308
308
|
Returns the list of enabled applications and their details.
|
|
309
309
|
|
|
@@ -317,7 +317,7 @@ The list of applications.
|
|
|
317
317
|
|
|
318
318
|
> **getApp**(`slug`): `Promise`\<[`Application`](#application)\>
|
|
319
319
|
|
|
320
|
-
Defined in: [cobalt.ts:441](https://github.com/gocobalt/cobalt-js/blob/
|
|
320
|
+
Defined in: [cobalt.ts:441](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L441)
|
|
321
321
|
|
|
322
322
|
Returns the application details for the specified application, provided
|
|
323
323
|
the application is enabled in Cobalt.
|
|
@@ -338,7 +338,7 @@ The application details.
|
|
|
338
338
|
|
|
339
339
|
> **getApps**(): `Promise`\<[`Application`](#application)[]\>
|
|
340
340
|
|
|
341
|
-
Defined in: [cobalt.ts:469](https://github.com/gocobalt/cobalt-js/blob/
|
|
341
|
+
Defined in: [cobalt.ts:469](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L469)
|
|
342
342
|
|
|
343
343
|
Returns all the enabled apps.
|
|
344
344
|
|
|
@@ -350,9 +350,9 @@ The list of applications.
|
|
|
350
350
|
|
|
351
351
|
##### getConfig()
|
|
352
352
|
|
|
353
|
-
> **getConfig**(`slug`, `configId?`): `Promise`\<[`Config`](#config-1)\>
|
|
353
|
+
> **getConfig**(`slug`, `configId?`, `excludeOptions?`): `Promise`\<[`Config`](#config-1)\>
|
|
354
354
|
|
|
355
|
-
Defined in: [cobalt.ts:
|
|
355
|
+
Defined in: [cobalt.ts:686](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L686)
|
|
356
356
|
|
|
357
357
|
Returns the specified config.
|
|
358
358
|
|
|
@@ -362,6 +362,7 @@ Returns the specified config.
|
|
|
362
362
|
| ------ | ------ | ------ |
|
|
363
363
|
| `slug` | `string` | The application slug. |
|
|
364
364
|
| `configId?` | `string` | The unique ID of the config. |
|
|
365
|
+
| `excludeOptions?` | `boolean` | Whether to exclude the options from the fields in the response. |
|
|
365
366
|
|
|
366
367
|
###### Returns
|
|
367
368
|
|
|
@@ -373,7 +374,7 @@ The specified config.
|
|
|
373
374
|
|
|
374
375
|
> **getConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<[`Config`](#config-1)\>
|
|
375
376
|
|
|
376
|
-
Defined in: [cobalt.ts:
|
|
377
|
+
Defined in: [cobalt.ts:754](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L754)
|
|
377
378
|
|
|
378
379
|
Returns the specified field of the config.
|
|
379
380
|
|
|
@@ -395,7 +396,7 @@ The specified config field.
|
|
|
395
396
|
|
|
396
397
|
> **getConfigs**(`slug`): `Promise`\<`object`[]\>
|
|
397
398
|
|
|
398
|
-
Defined in: [cobalt.ts:664](https://github.com/gocobalt/cobalt-js/blob/
|
|
399
|
+
Defined in: [cobalt.ts:664](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L664)
|
|
399
400
|
|
|
400
401
|
Returns the configs created for the specified application.
|
|
401
402
|
|
|
@@ -415,7 +416,7 @@ The configs created for the specified application.
|
|
|
415
416
|
|
|
416
417
|
> **getExecution**(`executionId`): `Promise`\<[`Execution`](#execution)\>
|
|
417
418
|
|
|
418
|
-
Defined in: [cobalt.ts:
|
|
419
|
+
Defined in: [cobalt.ts:1024](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L1024)
|
|
419
420
|
|
|
420
421
|
Returns the specified workflow execution log.
|
|
421
422
|
|
|
@@ -435,7 +436,7 @@ The specified execution log.
|
|
|
435
436
|
|
|
436
437
|
> **getExecutions**(`params?`): `Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
|
|
437
438
|
|
|
438
|
-
Defined in: [cobalt.ts:
|
|
439
|
+
Defined in: [cobalt.ts:998](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L998)
|
|
439
440
|
|
|
440
441
|
Returns the workflow execution logs for the linked account.
|
|
441
442
|
|
|
@@ -455,7 +456,7 @@ The paginated workflow execution logs.
|
|
|
455
456
|
|
|
456
457
|
> **getFieldOptions**(`lhs`, `slug`, `fieldId`, `workflowId?`): `Promise`\<[`RuleOptions`](#ruleoptions)\>
|
|
457
458
|
|
|
458
|
-
Defined in: [cobalt.ts:
|
|
459
|
+
Defined in: [cobalt.ts:829](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L829)
|
|
459
460
|
|
|
460
461
|
Returns the options for the specified field.
|
|
461
462
|
|
|
@@ -478,7 +479,7 @@ The specified rule field's options.
|
|
|
478
479
|
|
|
479
480
|
> **getWorkflowPayload**(`workflowId`): `Promise`\<[`WorkflowPayloadResponse`](#workflowpayloadresponse)\>
|
|
480
481
|
|
|
481
|
-
Defined in: [cobalt.ts:
|
|
482
|
+
Defined in: [cobalt.ts:941](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L941)
|
|
482
483
|
|
|
483
484
|
Returns the execution payload for the specified public workflow.
|
|
484
485
|
|
|
@@ -498,7 +499,7 @@ The workflow payload response.
|
|
|
498
499
|
|
|
499
500
|
> **getWorkflows**(`params?`): `Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
|
|
500
501
|
|
|
501
|
-
Defined in: [cobalt.ts:
|
|
502
|
+
Defined in: [cobalt.ts:862](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L862)
|
|
502
503
|
|
|
503
504
|
Returns the private workflows for the specified application.
|
|
504
505
|
|
|
@@ -516,7 +517,7 @@ Returns the private workflows for the specified application.
|
|
|
516
517
|
|
|
517
518
|
> **updateConfig**(`payload`): `Promise`\<[`Config`](#config-1)\>
|
|
518
519
|
|
|
519
|
-
Defined in: [cobalt.ts:
|
|
520
|
+
Defined in: [cobalt.ts:707](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L707)
|
|
520
521
|
|
|
521
522
|
Update the specified config.
|
|
522
523
|
|
|
@@ -536,7 +537,7 @@ The specified config.
|
|
|
536
537
|
|
|
537
538
|
> **updateConfigField**(`slug`, `fieldId`, `value`, `workflowId?`): `Promise`\<[`Config`](#config-1)\>
|
|
538
539
|
|
|
539
|
-
Defined in: [cobalt.ts:
|
|
540
|
+
Defined in: [cobalt.ts:778](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L778)
|
|
540
541
|
|
|
541
542
|
Update the specified config field value.
|
|
542
543
|
|
|
@@ -559,7 +560,7 @@ The updated config field.
|
|
|
559
560
|
|
|
560
561
|
### Application
|
|
561
562
|
|
|
562
|
-
Defined in: [cobalt.ts:16](https://github.com/gocobalt/cobalt-js/blob/
|
|
563
|
+
Defined in: [cobalt.ts:16](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L16)
|
|
563
564
|
|
|
564
565
|
An application in Cobalt.
|
|
565
566
|
|
|
@@ -567,80 +568,80 @@ An application in Cobalt.
|
|
|
567
568
|
|
|
568
569
|
| Property | Type | Description | Defined in |
|
|
569
570
|
| ------ | ------ | ------ | ------ |
|
|
570
|
-
| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:18](https://github.com/gocobalt/cobalt-js/blob/
|
|
571
|
-
| <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/
|
|
572
|
-
| <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/
|
|
573
|
-
| <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/
|
|
571
|
+
| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:18](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L18) |
|
|
572
|
+
| <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/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L69) |
|
|
573
|
+
| <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/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L54) |
|
|
574
|
+
| <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/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L35) |
|
|
574
575
|
| `auth_type_options.keybased` | [`InputField`](#inputfield)[] | - | |
|
|
575
576
|
| `auth_type_options.oauth2` | [`InputField`](#inputfield)[] | - | |
|
|
576
|
-
| <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/
|
|
577
|
-
| <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/
|
|
578
|
-
| <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:22](https://github.com/gocobalt/cobalt-js/blob/
|
|
579
|
-
| <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:24](https://github.com/gocobalt/cobalt-js/blob/
|
|
580
|
-
| <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:20](https://github.com/gocobalt/cobalt-js/blob/
|
|
581
|
-
| <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/
|
|
582
|
-
| <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:31](https://github.com/gocobalt/cobalt-js/blob/
|
|
583
|
-
| <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:33](https://github.com/gocobalt/cobalt-js/blob/
|
|
584
|
-
| <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/
|
|
577
|
+
| <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/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L59) |
|
|
578
|
+
| <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/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L40) |
|
|
579
|
+
| <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:22](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L22) |
|
|
580
|
+
| <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:24](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L24) |
|
|
581
|
+
| <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:20](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L20) |
|
|
582
|
+
| <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/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L64) |
|
|
583
|
+
| <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:31](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L31) |
|
|
584
|
+
| <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:33](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L33) |
|
|
585
|
+
| <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/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L29) |
|
|
585
586
|
|
|
586
587
|
***
|
|
587
588
|
|
|
588
589
|
### CobaltOptions
|
|
589
590
|
|
|
590
|
-
Defined in: [cobalt.ts:135](https://github.com/gocobalt/cobalt-js/blob/
|
|
591
|
+
Defined in: [cobalt.ts:135](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L135)
|
|
591
592
|
|
|
592
593
|
#### Properties
|
|
593
594
|
|
|
594
595
|
| Property | Type | Description | Defined in |
|
|
595
596
|
| ------ | ------ | ------ | ------ |
|
|
596
|
-
| <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/
|
|
597
|
-
| <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:139](https://github.com/gocobalt/cobalt-js/blob/
|
|
597
|
+
| <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/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L137) |
|
|
598
|
+
| <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:139](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L139) |
|
|
598
599
|
|
|
599
600
|
***
|
|
600
601
|
|
|
601
602
|
### Config
|
|
602
603
|
|
|
603
|
-
Defined in: [cobalt.ts:250](https://github.com/gocobalt/cobalt-js/blob/
|
|
604
|
+
Defined in: [cobalt.ts:250](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L250)
|
|
604
605
|
|
|
605
606
|
#### Properties
|
|
606
607
|
|
|
607
608
|
| Property | Type | Defined in |
|
|
608
609
|
| ------ | ------ | ------ |
|
|
609
|
-
| <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:252](https://github.com/gocobalt/cobalt-js/blob/
|
|
610
|
-
| <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:255](https://github.com/gocobalt/cobalt-js/blob/
|
|
611
|
-
| <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:253](https://github.com/gocobalt/cobalt-js/blob/
|
|
612
|
-
| <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:251](https://github.com/gocobalt/cobalt-js/blob/
|
|
613
|
-
| <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:254](https://github.com/gocobalt/cobalt-js/blob/
|
|
610
|
+
| <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:252](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L252) |
|
|
611
|
+
| <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:255](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L255) |
|
|
612
|
+
| <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:253](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L253) |
|
|
613
|
+
| <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:251](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L251) |
|
|
614
|
+
| <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:254](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L254) |
|
|
614
615
|
|
|
615
616
|
***
|
|
616
617
|
|
|
617
618
|
### ConfigField
|
|
618
619
|
|
|
619
|
-
Defined in: [cobalt.ts:265](https://github.com/gocobalt/cobalt-js/blob/
|
|
620
|
+
Defined in: [cobalt.ts:265](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L265)
|
|
620
621
|
|
|
621
622
|
#### Properties
|
|
622
623
|
|
|
623
624
|
| Property | Type | Description | Defined in |
|
|
624
625
|
| ------ | ------ | ------ | ------ |
|
|
625
|
-
| <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:287](https://github.com/gocobalt/cobalt-js/blob/
|
|
626
|
-
| <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:268](https://github.com/gocobalt/cobalt-js/blob/
|
|
627
|
-
| <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:285](https://github.com/gocobalt/cobalt-js/blob/
|
|
628
|
-
| <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:280](https://github.com/gocobalt/cobalt-js/blob/
|
|
629
|
-
| <a id="id"></a> `id` | `string` | - | [cobalt.ts:266](https://github.com/gocobalt/cobalt-js/blob/
|
|
630
|
-
| <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:274](https://github.com/gocobalt/cobalt-js/blob/
|
|
631
|
-
| <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:278](https://github.com/gocobalt/cobalt-js/blob/
|
|
632
|
-
| <a id="name-1"></a> `name` | `string` | - | [cobalt.ts:267](https://github.com/gocobalt/cobalt-js/blob/
|
|
633
|
-
| <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:269](https://github.com/gocobalt/cobalt-js/blob/
|
|
634
|
-
| <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:273](https://github.com/gocobalt/cobalt-js/blob/
|
|
635
|
-
| <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:283](https://github.com/gocobalt/cobalt-js/blob/
|
|
636
|
-
| <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:279](https://github.com/gocobalt/cobalt-js/blob/
|
|
637
|
-
| <a id="value"></a> `value?` | `any` | - | [cobalt.ts:281](https://github.com/gocobalt/cobalt-js/blob/
|
|
626
|
+
| <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:287](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L287) |
|
|
627
|
+
| <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:268](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L268) |
|
|
628
|
+
| <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:285](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L285) |
|
|
629
|
+
| <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:280](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L280) |
|
|
630
|
+
| <a id="id"></a> `id` | `string` | - | [cobalt.ts:266](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L266) |
|
|
631
|
+
| <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:274](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L274) |
|
|
632
|
+
| <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:278](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L278) |
|
|
633
|
+
| <a id="name-1"></a> `name` | `string` | - | [cobalt.ts:267](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L267) |
|
|
634
|
+
| <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:269](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L269) |
|
|
635
|
+
| <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:273](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L273) |
|
|
636
|
+
| <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:283](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L283) |
|
|
637
|
+
| <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:279](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L279) |
|
|
638
|
+
| <a id="value"></a> `value?` | `any` | - | [cobalt.ts:281](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L281) |
|
|
638
639
|
|
|
639
640
|
***
|
|
640
641
|
|
|
641
642
|
### ConfigPayload
|
|
642
643
|
|
|
643
|
-
Defined in: [cobalt.ts:96](https://github.com/gocobalt/cobalt-js/blob/
|
|
644
|
+
Defined in: [cobalt.ts:96](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L96)
|
|
644
645
|
|
|
645
646
|
The payload object for config.
|
|
646
647
|
|
|
@@ -648,87 +649,87 @@ The payload object for config.
|
|
|
648
649
|
|
|
649
650
|
| Property | Type | Description | Defined in |
|
|
650
651
|
| ------ | ------ | ------ | ------ |
|
|
651
|
-
| <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:100](https://github.com/gocobalt/cobalt-js/blob/
|
|
652
|
-
| <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:102](https://github.com/gocobalt/cobalt-js/blob/
|
|
653
|
-
| <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:98](https://github.com/gocobalt/cobalt-js/blob/
|
|
652
|
+
| <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:100](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L100) |
|
|
653
|
+
| <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:102](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L102) |
|
|
654
|
+
| <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:98](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L98) |
|
|
654
655
|
|
|
655
656
|
***
|
|
656
657
|
|
|
657
658
|
### ConfigWorkflow
|
|
658
659
|
|
|
659
|
-
Defined in: [cobalt.ts:290](https://github.com/gocobalt/cobalt-js/blob/
|
|
660
|
+
Defined in: [cobalt.ts:290](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L290)
|
|
660
661
|
|
|
661
662
|
#### Properties
|
|
662
663
|
|
|
663
664
|
| Property | Type | Defined in |
|
|
664
665
|
| ------ | ------ | ------ |
|
|
665
|
-
| <a id="description-1"></a> `description?` | `string` | [cobalt.ts:293](https://github.com/gocobalt/cobalt-js/blob/
|
|
666
|
-
| <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:294](https://github.com/gocobalt/cobalt-js/blob/
|
|
667
|
-
| <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:295](https://github.com/gocobalt/cobalt-js/blob/
|
|
668
|
-
| <a id="id-1"></a> `id` | `string` | [cobalt.ts:291](https://github.com/gocobalt/cobalt-js/blob/
|
|
669
|
-
| <a id="name-2"></a> `name` | `string` | [cobalt.ts:292](https://github.com/gocobalt/cobalt-js/blob/
|
|
666
|
+
| <a id="description-1"></a> `description?` | `string` | [cobalt.ts:293](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L293) |
|
|
667
|
+
| <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:294](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L294) |
|
|
668
|
+
| <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:295](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L295) |
|
|
669
|
+
| <a id="id-1"></a> `id` | `string` | [cobalt.ts:291](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L291) |
|
|
670
|
+
| <a id="name-2"></a> `name` | `string` | [cobalt.ts:292](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L292) |
|
|
670
671
|
|
|
671
672
|
***
|
|
672
673
|
|
|
673
674
|
### ExecuteWorkflowPayload
|
|
674
675
|
|
|
675
|
-
Defined in: [cobalt.ts:304](https://github.com/gocobalt/cobalt-js/blob/
|
|
676
|
+
Defined in: [cobalt.ts:304](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L304)
|
|
676
677
|
|
|
677
678
|
#### Properties
|
|
678
679
|
|
|
679
680
|
| Property | Type | Description | Defined in |
|
|
680
681
|
| ------ | ------ | ------ | ------ |
|
|
681
|
-
| <a id="payload"></a> `payload?` | `Record`\<`string`, `any`\> | The payload to execute the workflow. | [cobalt.ts:310](https://github.com/gocobalt/cobalt-js/blob/
|
|
682
|
-
| <a id="slug-3"></a> `slug?` | `string` | The application's slug this workflow belongs to. | [cobalt.ts:308](https://github.com/gocobalt/cobalt-js/blob/
|
|
683
|
-
| <a id="sync_execution"></a> `sync_execution?` | `boolean` | Whether to execute the workflow synchronously. | [cobalt.ts:312](https://github.com/gocobalt/cobalt-js/blob/
|
|
684
|
-
| <a id="worklfow"></a> `worklfow` | `string` | The workflow id or alias. | [cobalt.ts:306](https://github.com/gocobalt/cobalt-js/blob/
|
|
682
|
+
| <a id="payload"></a> `payload?` | `Record`\<`string`, `any`\> | The payload to execute the workflow. | [cobalt.ts:310](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L310) |
|
|
683
|
+
| <a id="slug-3"></a> `slug?` | `string` | The application's slug this workflow belongs to. | [cobalt.ts:308](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L308) |
|
|
684
|
+
| <a id="sync_execution"></a> `sync_execution?` | `boolean` | Whether to execute the workflow synchronously. | [cobalt.ts:312](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L312) |
|
|
685
|
+
| <a id="worklfow"></a> `worklfow` | `string` | The workflow id or alias. | [cobalt.ts:306](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L306) |
|
|
685
686
|
|
|
686
687
|
***
|
|
687
688
|
|
|
688
689
|
### Execution
|
|
689
690
|
|
|
690
|
-
Defined in: [cobalt.ts:315](https://github.com/gocobalt/cobalt-js/blob/
|
|
691
|
+
Defined in: [cobalt.ts:315](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L315)
|
|
691
692
|
|
|
692
693
|
#### Properties
|
|
693
694
|
|
|
694
695
|
| Property | Type | Defined in |
|
|
695
696
|
| ------ | ------ | ------ |
|
|
696
|
-
| <a id="_id"></a> `_id` | `string` | [cobalt.ts:316](https://github.com/gocobalt/cobalt-js/blob/
|
|
697
|
-
| <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:320](https://github.com/gocobalt/cobalt-js/blob/
|
|
698
|
-
| `associated_application._id` | `string` | [cobalt.ts:321](https://github.com/gocobalt/cobalt-js/blob/
|
|
699
|
-
| `associated_application.icon?` | `string` | [cobalt.ts:323](https://github.com/gocobalt/cobalt-js/blob/
|
|
700
|
-
| `associated_application.name` | `string` | [cobalt.ts:322](https://github.com/gocobalt/cobalt-js/blob/
|
|
701
|
-
| <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:344](https://github.com/gocobalt/cobalt-js/blob/
|
|
702
|
-
| <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:330](https://github.com/gocobalt/cobalt-js/blob/
|
|
703
|
-
| `associated_trigger_application._id` | `string` | [cobalt.ts:331](https://github.com/gocobalt/cobalt-js/blob/
|
|
704
|
-
| `associated_trigger_application.app_type?` | `string` | [cobalt.ts:334](https://github.com/gocobalt/cobalt-js/blob/
|
|
705
|
-
| `associated_trigger_application.icon?` | `string` | [cobalt.ts:333](https://github.com/gocobalt/cobalt-js/blob/
|
|
706
|
-
| `associated_trigger_application.name` | `string` | [cobalt.ts:332](https://github.com/gocobalt/cobalt-js/blob/
|
|
707
|
-
| `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:335](https://github.com/gocobalt/cobalt-js/blob/
|
|
708
|
-
| `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:336](https://github.com/gocobalt/cobalt-js/blob/
|
|
709
|
-
| `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:337](https://github.com/gocobalt/cobalt-js/blob/
|
|
710
|
-
| <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:326](https://github.com/gocobalt/cobalt-js/blob/
|
|
711
|
-
| `associated_workflow._id` | `string` | [cobalt.ts:327](https://github.com/gocobalt/cobalt-js/blob/
|
|
712
|
-
| `associated_workflow.name` | `string` | [cobalt.ts:328](https://github.com/gocobalt/cobalt-js/blob/
|
|
713
|
-
| <a id="completion_percentage"></a> `completion_percentage?` | `number` | [cobalt.ts:347](https://github.com/gocobalt/cobalt-js/blob/
|
|
714
|
-
| <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:343](https://github.com/gocobalt/cobalt-js/blob/
|
|
715
|
-
| <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:359](https://github.com/gocobalt/cobalt-js/blob/
|
|
716
|
-
| <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:346](https://github.com/gocobalt/cobalt-js/blob/
|
|
717
|
-
| <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:345](https://github.com/gocobalt/cobalt-js/blob/
|
|
718
|
-
| <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:342](https://github.com/gocobalt/cobalt-js/blob/
|
|
719
|
-
| <a id="id-2"></a> `id?` | `string` | [cobalt.ts:317](https://github.com/gocobalt/cobalt-js/blob/
|
|
720
|
-
| <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:341](https://github.com/gocobalt/cobalt-js/blob/
|
|
721
|
-
| <a id="name-3"></a> `name` | `string` | [cobalt.ts:318](https://github.com/gocobalt/cobalt-js/blob/
|
|
722
|
-
| <a id="nodes"></a> `nodes?` | `object`[] | [cobalt.ts:348](https://github.com/gocobalt/cobalt-js/blob/
|
|
723
|
-
| <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:319](https://github.com/gocobalt/cobalt-js/blob/
|
|
724
|
-
| <a id="status"></a> `status` | [`ExecutionStatus`](#executionstatus-1) | [cobalt.ts:325](https://github.com/gocobalt/cobalt-js/blob/
|
|
725
|
-
| <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:340](https://github.com/gocobalt/cobalt-js/blob/
|
|
697
|
+
| <a id="_id"></a> `_id` | `string` | [cobalt.ts:316](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L316) |
|
|
698
|
+
| <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:320](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L320) |
|
|
699
|
+
| `associated_application._id` | `string` | [cobalt.ts:321](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L321) |
|
|
700
|
+
| `associated_application.icon?` | `string` | [cobalt.ts:323](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L323) |
|
|
701
|
+
| `associated_application.name` | `string` | [cobalt.ts:322](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L322) |
|
|
702
|
+
| <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:344](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L344) |
|
|
703
|
+
| <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:330](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L330) |
|
|
704
|
+
| `associated_trigger_application._id` | `string` | [cobalt.ts:331](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L331) |
|
|
705
|
+
| `associated_trigger_application.app_type?` | `string` | [cobalt.ts:334](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L334) |
|
|
706
|
+
| `associated_trigger_application.icon?` | `string` | [cobalt.ts:333](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L333) |
|
|
707
|
+
| `associated_trigger_application.name` | `string` | [cobalt.ts:332](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L332) |
|
|
708
|
+
| `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:335](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L335) |
|
|
709
|
+
| `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:336](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L336) |
|
|
710
|
+
| `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:337](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L337) |
|
|
711
|
+
| <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:326](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L326) |
|
|
712
|
+
| `associated_workflow._id` | `string` | [cobalt.ts:327](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L327) |
|
|
713
|
+
| `associated_workflow.name` | `string` | [cobalt.ts:328](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L328) |
|
|
714
|
+
| <a id="completion_percentage"></a> `completion_percentage?` | `number` | [cobalt.ts:347](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L347) |
|
|
715
|
+
| <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:343](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L343) |
|
|
716
|
+
| <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:359](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L359) |
|
|
717
|
+
| <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:346](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L346) |
|
|
718
|
+
| <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:345](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L345) |
|
|
719
|
+
| <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:342](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L342) |
|
|
720
|
+
| <a id="id-2"></a> `id?` | `string` | [cobalt.ts:317](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L317) |
|
|
721
|
+
| <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:341](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L341) |
|
|
722
|
+
| <a id="name-3"></a> `name` | `string` | [cobalt.ts:318](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L318) |
|
|
723
|
+
| <a id="nodes"></a> `nodes?` | `object`[] | [cobalt.ts:348](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L348) |
|
|
724
|
+
| <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:319](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L319) |
|
|
725
|
+
| <a id="status"></a> `status` | [`ExecutionStatus`](#executionstatus-1) | [cobalt.ts:325](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L325) |
|
|
726
|
+
| <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:340](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L340) |
|
|
726
727
|
|
|
727
728
|
***
|
|
728
729
|
|
|
729
730
|
### ExecutionFilters
|
|
730
731
|
|
|
731
|
-
Defined in: [cobalt.ts:219](https://github.com/gocobalt/cobalt-js/blob/
|
|
732
|
+
Defined in: [cobalt.ts:219](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L219)
|
|
732
733
|
|
|
733
734
|
Filters for narrowing down the list of workflow executions.
|
|
734
735
|
|
|
@@ -740,19 +741,19 @@ Filters for narrowing down the list of workflow executions.
|
|
|
740
741
|
|
|
741
742
|
| Property | Type | Description | Defined in |
|
|
742
743
|
| ------ | ------ | ------ | ------ |
|
|
743
|
-
| <a id="end_date"></a> `end_date?` | `string` | Filter executions that started on or before this ISO 8601 date string. | [cobalt.ts:229](https://github.com/gocobalt/cobalt-js/blob/
|
|
744
|
-
| <a id="execution_source"></a> `execution_source?` | [`ExecutionSource`](#executionsource) | Filter by the trigger source that initiated the execution. | [cobalt.ts:233](https://github.com/gocobalt/cobalt-js/blob/
|
|
745
|
-
| <a id="execution_type"></a> `execution_type?` | [`ExecutionType`](#executiontype) | Filter by how the execution was invoked — synchronously or asynchronously. | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/
|
|
746
|
-
| <a id="start_date"></a> `start_date?` | `string` | Filter executions that started on or after this ISO 8601 date string. | [cobalt.ts:227](https://github.com/gocobalt/cobalt-js/blob/
|
|
747
|
-
| <a id="status-1"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [cobalt.ts:221](https://github.com/gocobalt/cobalt-js/blob/
|
|
748
|
-
| <a id="workflow_id"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/
|
|
749
|
-
| <a id="workflow_name"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/
|
|
744
|
+
| <a id="end_date"></a> `end_date?` | `string` | Filter executions that started on or before this ISO 8601 date string. | [cobalt.ts:229](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L229) |
|
|
745
|
+
| <a id="execution_source"></a> `execution_source?` | [`ExecutionSource`](#executionsource) | Filter by the trigger source that initiated the execution. | [cobalt.ts:233](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L233) |
|
|
746
|
+
| <a id="execution_type"></a> `execution_type?` | [`ExecutionType`](#executiontype) | Filter by how the execution was invoked — synchronously or asynchronously. | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L231) |
|
|
747
|
+
| <a id="start_date"></a> `start_date?` | `string` | Filter executions that started on or after this ISO 8601 date string. | [cobalt.ts:227](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L227) |
|
|
748
|
+
| <a id="status-1"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [cobalt.ts:221](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L221) |
|
|
749
|
+
| <a id="workflow_id"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L225) |
|
|
750
|
+
| <a id="workflow_name"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L223) |
|
|
750
751
|
|
|
751
752
|
***
|
|
752
753
|
|
|
753
754
|
### GetExecutionsParams
|
|
754
755
|
|
|
755
|
-
Defined in: [cobalt.ts:237](https://github.com/gocobalt/cobalt-js/blob/
|
|
756
|
+
Defined in: [cobalt.ts:237](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L237)
|
|
756
757
|
|
|
757
758
|
Parameters for filtering and paginating the list of workflow executions.
|
|
758
759
|
|
|
@@ -770,21 +771,21 @@ Any additional filter keys supported by the API.
|
|
|
770
771
|
|
|
771
772
|
| Property | Type | Description | Inherited from | Defined in |
|
|
772
773
|
| ------ | ------ | ------ | ------ | ------ |
|
|
773
|
-
| <a id="end_date-1"></a> `end_date?` | `string` | Filter executions that started on or before this ISO 8601 date string. | [`ExecutionFilters`](#executionfilters).[`end_date`](#end_date) | [cobalt.ts:229](https://github.com/gocobalt/cobalt-js/blob/
|
|
774
|
-
| <a id="execution_source-1"></a> `execution_source?` | [`ExecutionSource`](#executionsource) | Filter by the trigger source that initiated the execution. | [`ExecutionFilters`](#executionfilters).[`execution_source`](#execution_source) | [cobalt.ts:233](https://github.com/gocobalt/cobalt-js/blob/
|
|
775
|
-
| <a id="execution_type-1"></a> `execution_type?` | [`ExecutionType`](#executiontype) | Filter by how the execution was invoked — synchronously or asynchronously. | [`ExecutionFilters`](#executionfilters).[`execution_type`](#execution_type) | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/
|
|
776
|
-
| <a id="limit"></a> `limit?` | `number` | - | `PaginationProps.limit` | [cobalt.ts:208](https://github.com/gocobalt/cobalt-js/blob/
|
|
777
|
-
| <a id="page"></a> `page?` | `number` | - | `PaginationProps.page` | [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/
|
|
778
|
-
| <a id="start_date-1"></a> `start_date?` | `string` | Filter executions that started on or after this ISO 8601 date string. | [`ExecutionFilters`](#executionfilters).[`start_date`](#start_date) | [cobalt.ts:227](https://github.com/gocobalt/cobalt-js/blob/
|
|
779
|
-
| <a id="status-2"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [`ExecutionFilters`](#executionfilters).[`status`](#status-1) | [cobalt.ts:221](https://github.com/gocobalt/cobalt-js/blob/
|
|
780
|
-
| <a id="workflow_id-1"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [`ExecutionFilters`](#executionfilters).[`workflow_id`](#workflow_id) | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/
|
|
781
|
-
| <a id="workflow_name-1"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [`ExecutionFilters`](#executionfilters).[`workflow_name`](#workflow_name) | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/
|
|
774
|
+
| <a id="end_date-1"></a> `end_date?` | `string` | Filter executions that started on or before this ISO 8601 date string. | [`ExecutionFilters`](#executionfilters).[`end_date`](#end_date) | [cobalt.ts:229](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L229) |
|
|
775
|
+
| <a id="execution_source-1"></a> `execution_source?` | [`ExecutionSource`](#executionsource) | Filter by the trigger source that initiated the execution. | [`ExecutionFilters`](#executionfilters).[`execution_source`](#execution_source) | [cobalt.ts:233](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L233) |
|
|
776
|
+
| <a id="execution_type-1"></a> `execution_type?` | [`ExecutionType`](#executiontype) | Filter by how the execution was invoked — synchronously or asynchronously. | [`ExecutionFilters`](#executionfilters).[`execution_type`](#execution_type) | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L231) |
|
|
777
|
+
| <a id="limit"></a> `limit?` | `number` | - | `PaginationProps.limit` | [cobalt.ts:208](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L208) |
|
|
778
|
+
| <a id="page"></a> `page?` | `number` | - | `PaginationProps.page` | [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L207) |
|
|
779
|
+
| <a id="start_date-1"></a> `start_date?` | `string` | Filter executions that started on or after this ISO 8601 date string. | [`ExecutionFilters`](#executionfilters).[`start_date`](#start_date) | [cobalt.ts:227](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L227) |
|
|
780
|
+
| <a id="status-2"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [`ExecutionFilters`](#executionfilters).[`status`](#status-1) | [cobalt.ts:221](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L221) |
|
|
781
|
+
| <a id="workflow_id-1"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [`ExecutionFilters`](#executionfilters).[`workflow_id`](#workflow_id) | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L225) |
|
|
782
|
+
| <a id="workflow_name-1"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [`ExecutionFilters`](#executionfilters).[`workflow_name`](#workflow_name) | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L223) |
|
|
782
783
|
|
|
783
784
|
***
|
|
784
785
|
|
|
785
786
|
### InputField
|
|
786
787
|
|
|
787
|
-
Defined in: [cobalt.ts:73](https://github.com/gocobalt/cobalt-js/blob/
|
|
788
|
+
Defined in: [cobalt.ts:73](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L73)
|
|
788
789
|
|
|
789
790
|
An Input field to take input from the user.
|
|
790
791
|
|
|
@@ -792,20 +793,20 @@ An Input field to take input from the user.
|
|
|
792
793
|
|
|
793
794
|
| Property | Type | Description | Defined in |
|
|
794
795
|
| ------ | ------ | ------ | ------ |
|
|
795
|
-
| <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/
|
|
796
|
-
| <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:85](https://github.com/gocobalt/cobalt-js/blob/
|
|
797
|
-
| <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:81](https://github.com/gocobalt/cobalt-js/blob/
|
|
798
|
-
| <a id="name-4"></a> `name` | `string` | Key name of the field. | [cobalt.ts:75](https://github.com/gocobalt/cobalt-js/blob/
|
|
799
|
-
| <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:89](https://github.com/gocobalt/cobalt-js/blob/
|
|
800
|
-
| <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:83](https://github.com/gocobalt/cobalt-js/blob/
|
|
801
|
-
| <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:79](https://github.com/gocobalt/cobalt-js/blob/
|
|
802
|
-
| <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:77](https://github.com/gocobalt/cobalt-js/blob/
|
|
796
|
+
| <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/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L87) |
|
|
797
|
+
| <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:85](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L85) |
|
|
798
|
+
| <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:81](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L81) |
|
|
799
|
+
| <a id="name-4"></a> `name` | `string` | Key name of the field. | [cobalt.ts:75](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L75) |
|
|
800
|
+
| <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:89](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L89) |
|
|
801
|
+
| <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:83](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L83) |
|
|
802
|
+
| <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:79](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L79) |
|
|
803
|
+
| <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:77](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L77) |
|
|
803
804
|
|
|
804
805
|
***
|
|
805
806
|
|
|
806
807
|
### Label
|
|
807
808
|
|
|
808
|
-
Defined in: [cobalt.ts:106](https://github.com/gocobalt/cobalt-js/blob/
|
|
809
|
+
Defined in: [cobalt.ts:106](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L106)
|
|
809
810
|
|
|
810
811
|
Label Mapping
|
|
811
812
|
|
|
@@ -813,14 +814,14 @@ Label Mapping
|
|
|
813
814
|
|
|
814
815
|
| Property | Type | Description | Defined in |
|
|
815
816
|
| ------ | ------ | ------ | ------ |
|
|
816
|
-
| <a id="name-5"></a> `name` | `string` | The label name. | [cobalt.ts:108](https://github.com/gocobalt/cobalt-js/blob/
|
|
817
|
-
| <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:110](https://github.com/gocobalt/cobalt-js/blob/
|
|
817
|
+
| <a id="name-5"></a> `name` | `string` | The label name. | [cobalt.ts:108](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L108) |
|
|
818
|
+
| <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:110](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L110) |
|
|
818
819
|
|
|
819
820
|
***
|
|
820
821
|
|
|
821
822
|
### PublicWorkflow
|
|
822
823
|
|
|
823
|
-
Defined in: [cobalt.ts:163](https://github.com/gocobalt/cobalt-js/blob/
|
|
824
|
+
Defined in: [cobalt.ts:163](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L163)
|
|
824
825
|
|
|
825
826
|
A public workflow in Cobalt.
|
|
826
827
|
|
|
@@ -828,19 +829,19 @@ A public workflow in Cobalt.
|
|
|
828
829
|
|
|
829
830
|
| Property | Type | Description | Defined in |
|
|
830
831
|
| ------ | ------ | ------ | ------ |
|
|
831
|
-
| <a id="_id-1"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:165](https://github.com/gocobalt/cobalt-js/blob/
|
|
832
|
-
| <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:173](https://github.com/gocobalt/cobalt-js/blob/
|
|
833
|
-
| <a id="description-2"></a> `description?` | `string` | The workflow description. | [cobalt.ts:169](https://github.com/gocobalt/cobalt-js/blob/
|
|
834
|
-
| <a id="name-6"></a> `name` | `string` | The workflow name. | [cobalt.ts:167](https://github.com/gocobalt/cobalt-js/blob/
|
|
835
|
-
| <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:177](https://github.com/gocobalt/cobalt-js/blob/
|
|
836
|
-
| <a id="slug-4"></a> `slug?` | `string` | The application's slug in which this workflow exists. | [cobalt.ts:171](https://github.com/gocobalt/cobalt-js/blob/
|
|
837
|
-
| <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [cobalt.ts:175](https://github.com/gocobalt/cobalt-js/blob/
|
|
832
|
+
| <a id="_id-1"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:165](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L165) |
|
|
833
|
+
| <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:173](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L173) |
|
|
834
|
+
| <a id="description-2"></a> `description?` | `string` | The workflow description. | [cobalt.ts:169](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L169) |
|
|
835
|
+
| <a id="name-6"></a> `name` | `string` | The workflow name. | [cobalt.ts:167](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L167) |
|
|
836
|
+
| <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:177](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L177) |
|
|
837
|
+
| <a id="slug-4"></a> `slug?` | `string` | The application's slug in which this workflow exists. | [cobalt.ts:171](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L171) |
|
|
838
|
+
| <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [cobalt.ts:175](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L175) |
|
|
838
839
|
|
|
839
840
|
***
|
|
840
841
|
|
|
841
842
|
### PublicWorkflowPayload
|
|
842
843
|
|
|
843
|
-
Defined in: [cobalt.ts:181](https://github.com/gocobalt/cobalt-js/blob/
|
|
844
|
+
Defined in: [cobalt.ts:181](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L181)
|
|
844
845
|
|
|
845
846
|
The payload for creating a public workflow for the linked account.
|
|
846
847
|
|
|
@@ -848,15 +849,15 @@ The payload for creating a public workflow for the linked account.
|
|
|
848
849
|
|
|
849
850
|
| Property | Type | Description | Defined in |
|
|
850
851
|
| ------ | ------ | ------ | ------ |
|
|
851
|
-
| <a id="description-3"></a> `description?` | `string` | The workflow description. | [cobalt.ts:185](https://github.com/gocobalt/cobalt-js/blob/
|
|
852
|
-
| <a id="name-7"></a> `name` | `string` | The workflow name. | [cobalt.ts:183](https://github.com/gocobalt/cobalt-js/blob/
|
|
853
|
-
| <a id="slug-5"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [cobalt.ts:187](https://github.com/gocobalt/cobalt-js/blob/
|
|
852
|
+
| <a id="description-3"></a> `description?` | `string` | The workflow description. | [cobalt.ts:185](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L185) |
|
|
853
|
+
| <a id="name-7"></a> `name` | `string` | The workflow name. | [cobalt.ts:183](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L183) |
|
|
854
|
+
| <a id="slug-5"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [cobalt.ts:187](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L187) |
|
|
854
855
|
|
|
855
856
|
***
|
|
856
857
|
|
|
857
858
|
### PublicWorkflowsPayload
|
|
858
859
|
|
|
859
|
-
Defined in: [cobalt.ts:191](https://github.com/gocobalt/cobalt-js/blob/
|
|
860
|
+
Defined in: [cobalt.ts:191](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L191)
|
|
860
861
|
|
|
861
862
|
Parameters for filtering and paginating the list of workflows.
|
|
862
863
|
|
|
@@ -874,43 +875,43 @@ Any additional filter keys supported by the API.
|
|
|
874
875
|
|
|
875
876
|
| Property | Type | Description | Inherited from | Defined in |
|
|
876
877
|
| ------ | ------ | ------ | ------ | ------ |
|
|
877
|
-
| <a id="end_date-2"></a> `end_date?` | `string` | Filter workflows created on or before this ISO 8601 date string. | - | [cobalt.ts:199](https://github.com/gocobalt/cobalt-js/blob/
|
|
878
|
-
| <a id="limit-1"></a> `limit?` | `number` | - | `PaginationProps.limit` | [cobalt.ts:208](https://github.com/gocobalt/cobalt-js/blob/
|
|
879
|
-
| <a id="name-8"></a> `name?` | `string` | Filter workflows by name (partial match). | - | [cobalt.ts:195](https://github.com/gocobalt/cobalt-js/blob/
|
|
880
|
-
| <a id="page-1"></a> `page?` | `number` | - | `PaginationProps.page` | [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/
|
|
881
|
-
| <a id="published-1"></a> `published?` | `boolean` | Filter by workflow published status. `true` returns only published workflows, `false` returns only drafts. | - | [cobalt.ts:201](https://github.com/gocobalt/cobalt-js/blob/
|
|
882
|
-
| <a id="slug-6"></a> `slug?` | `string` | Filter workflows by the application slug. | - | [cobalt.ts:193](https://github.com/gocobalt/cobalt-js/blob/
|
|
883
|
-
| <a id="start_date-2"></a> `start_date?` | `string` | Filter workflows created on or after this ISO 8601 date string. | - | [cobalt.ts:197](https://github.com/gocobalt/cobalt-js/blob/
|
|
878
|
+
| <a id="end_date-2"></a> `end_date?` | `string` | Filter workflows created on or before this ISO 8601 date string. | - | [cobalt.ts:199](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L199) |
|
|
879
|
+
| <a id="limit-1"></a> `limit?` | `number` | - | `PaginationProps.limit` | [cobalt.ts:208](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L208) |
|
|
880
|
+
| <a id="name-8"></a> `name?` | `string` | Filter workflows by name (partial match). | - | [cobalt.ts:195](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L195) |
|
|
881
|
+
| <a id="page-1"></a> `page?` | `number` | - | `PaginationProps.page` | [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L207) |
|
|
882
|
+
| <a id="published-1"></a> `published?` | `boolean` | Filter by workflow published status. `true` returns only published workflows, `false` returns only drafts. | - | [cobalt.ts:201](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L201) |
|
|
883
|
+
| <a id="slug-6"></a> `slug?` | `string` | Filter workflows by the application slug. | - | [cobalt.ts:193](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L193) |
|
|
884
|
+
| <a id="start_date-2"></a> `start_date?` | `string` | Filter workflows created on or after this ISO 8601 date string. | - | [cobalt.ts:197](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L197) |
|
|
884
885
|
|
|
885
886
|
***
|
|
886
887
|
|
|
887
888
|
### RuleOptions
|
|
888
889
|
|
|
889
|
-
Defined in: [cobalt.ts:142](https://github.com/gocobalt/cobalt-js/blob/
|
|
890
|
+
Defined in: [cobalt.ts:142](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L142)
|
|
890
891
|
|
|
891
892
|
#### Properties
|
|
892
893
|
|
|
893
894
|
| Property | Type | Defined in |
|
|
894
895
|
| ------ | ------ | ------ |
|
|
895
|
-
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:155](https://github.com/gocobalt/cobalt-js/blob/
|
|
896
|
-
| <a id="error"></a> `error?` | `object` | [cobalt.ts:156](https://github.com/gocobalt/cobalt-js/blob/
|
|
897
|
-
| `error.message?` | `string` | [cobalt.ts:157](https://github.com/gocobalt/cobalt-js/blob/
|
|
898
|
-
| `error.stack?` | `string` | [cobalt.ts:158](https://github.com/gocobalt/cobalt-js/blob/
|
|
899
|
-
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:143](https://github.com/gocobalt/cobalt-js/blob/
|
|
900
|
-
| `rule_column.operator` | `object` | [cobalt.ts:149](https://github.com/gocobalt/cobalt-js/blob/
|
|
901
|
-
| `rule_column.operator.name` | `string` | [cobalt.ts:150](https://github.com/gocobalt/cobalt-js/blob/
|
|
902
|
-
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:152](https://github.com/gocobalt/cobalt-js/blob/
|
|
903
|
-
| `rule_column.operator.type` | `"select"` | [cobalt.ts:151](https://github.com/gocobalt/cobalt-js/blob/
|
|
904
|
-
| `rule_column.rhs` | `object` | [cobalt.ts:144](https://github.com/gocobalt/cobalt-js/blob/
|
|
905
|
-
| `rule_column.rhs.name` | `string` | [cobalt.ts:145](https://github.com/gocobalt/cobalt-js/blob/
|
|
906
|
-
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:147](https://github.com/gocobalt/cobalt-js/blob/
|
|
907
|
-
| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/
|
|
896
|
+
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:155](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L155) |
|
|
897
|
+
| <a id="error"></a> `error?` | `object` | [cobalt.ts:156](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L156) |
|
|
898
|
+
| `error.message?` | `string` | [cobalt.ts:157](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L157) |
|
|
899
|
+
| `error.stack?` | `string` | [cobalt.ts:158](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L158) |
|
|
900
|
+
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:143](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L143) |
|
|
901
|
+
| `rule_column.operator` | `object` | [cobalt.ts:149](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L149) |
|
|
902
|
+
| `rule_column.operator.name` | `string` | [cobalt.ts:150](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L150) |
|
|
903
|
+
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:152](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L152) |
|
|
904
|
+
| `rule_column.operator.type` | `"select"` | [cobalt.ts:151](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L151) |
|
|
905
|
+
| `rule_column.rhs` | `object` | [cobalt.ts:144](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L144) |
|
|
906
|
+
| `rule_column.rhs.name` | `string` | [cobalt.ts:145](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L145) |
|
|
907
|
+
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:147](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L147) |
|
|
908
|
+
| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L146) |
|
|
908
909
|
|
|
909
910
|
***
|
|
910
911
|
|
|
911
912
|
### UpdateConfigPayload
|
|
912
913
|
|
|
913
|
-
Defined in: [cobalt.ts:114](https://github.com/gocobalt/cobalt-js/blob/
|
|
914
|
+
Defined in: [cobalt.ts:114](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L114)
|
|
914
915
|
|
|
915
916
|
The configuration data for an application.
|
|
916
917
|
|
|
@@ -918,16 +919,16 @@ The configuration data for an application.
|
|
|
918
919
|
|
|
919
920
|
| Property | Type | Description | Defined in |
|
|
920
921
|
| ------ | ------ | ------ | ------ |
|
|
921
|
-
| <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/
|
|
922
|
-
| <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/
|
|
923
|
-
| <a id="slug-7"></a> `slug` | `string` | The application slug | [cobalt.ts:116](https://github.com/gocobalt/cobalt-js/blob/
|
|
924
|
-
| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:122](https://github.com/gocobalt/cobalt-js/blob/
|
|
922
|
+
| <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L118) |
|
|
923
|
+
| <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/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L120) |
|
|
924
|
+
| <a id="slug-7"></a> `slug` | `string` | The application slug | [cobalt.ts:116](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L116) |
|
|
925
|
+
| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:122](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L122) |
|
|
925
926
|
|
|
926
927
|
***
|
|
927
928
|
|
|
928
929
|
### WorkflowPayload
|
|
929
930
|
|
|
930
|
-
Defined in: [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/
|
|
931
|
+
Defined in: [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L126)
|
|
931
932
|
|
|
932
933
|
The workflow.
|
|
933
934
|
|
|
@@ -935,23 +936,23 @@ The workflow.
|
|
|
935
936
|
|
|
936
937
|
| Property | Type | Description | Defined in |
|
|
937
938
|
| ------ | ------ | ------ | ------ |
|
|
938
|
-
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:130](https://github.com/gocobalt/cobalt-js/blob/
|
|
939
|
-
| <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/
|
|
940
|
-
| <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/
|
|
939
|
+
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:130](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L130) |
|
|
940
|
+
| <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/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L132) |
|
|
941
|
+
| <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L128) |
|
|
941
942
|
|
|
942
943
|
***
|
|
943
944
|
|
|
944
945
|
### WorkflowPayloadResponse
|
|
945
946
|
|
|
946
|
-
Defined in: [cobalt.ts:298](https://github.com/gocobalt/cobalt-js/blob/
|
|
947
|
+
Defined in: [cobalt.ts:298](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L298)
|
|
947
948
|
|
|
948
949
|
#### Properties
|
|
949
950
|
|
|
950
951
|
| Property | Type | Defined in |
|
|
951
952
|
| ------ | ------ | ------ |
|
|
952
|
-
| <a id="payload-1"></a> `payload` | `Record`\<`string`, `any`\> | [cobalt.ts:299](https://github.com/gocobalt/cobalt-js/blob/
|
|
953
|
-
| <a id="schema"></a> `schema?` | `unknown` | [cobalt.ts:300](https://github.com/gocobalt/cobalt-js/blob/
|
|
954
|
-
| <a id="schema_interpreted"></a> `schema_interpreted?` | `unknown` | [cobalt.ts:301](https://github.com/gocobalt/cobalt-js/blob/
|
|
953
|
+
| <a id="payload-1"></a> `payload` | `Record`\<`string`, `any`\> | [cobalt.ts:299](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L299) |
|
|
954
|
+
| <a id="schema"></a> `schema?` | `unknown` | [cobalt.ts:300](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L300) |
|
|
955
|
+
| <a id="schema_interpreted"></a> `schema_interpreted?` | `unknown` | [cobalt.ts:301](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L301) |
|
|
955
956
|
|
|
956
957
|
## Type Aliases
|
|
957
958
|
|
|
@@ -959,7 +960,7 @@ Defined in: [cobalt.ts:298](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5
|
|
|
959
960
|
|
|
960
961
|
> **ExecutionSource** = `"Event"` \| `"Schedule"` \| `"API Call"`
|
|
961
962
|
|
|
962
|
-
Defined in: [cobalt.ts:214](https://github.com/gocobalt/cobalt-js/blob/
|
|
963
|
+
Defined in: [cobalt.ts:214](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L214)
|
|
963
964
|
|
|
964
965
|
The trigger source that initiated a workflow execution.
|
|
965
966
|
|
|
@@ -969,7 +970,7 @@ The trigger source that initiated a workflow execution.
|
|
|
969
970
|
|
|
970
971
|
> **ExecutionStatus** = `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"`
|
|
971
972
|
|
|
972
|
-
Defined in: [cobalt.ts:212](https://github.com/gocobalt/cobalt-js/blob/
|
|
973
|
+
Defined in: [cobalt.ts:212](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L212)
|
|
973
974
|
|
|
974
975
|
The current status of a workflow execution.
|
|
975
976
|
|
|
@@ -979,6 +980,6 @@ The current status of a workflow execution.
|
|
|
979
980
|
|
|
980
981
|
> **ExecutionType** = `"SYNC"` \| `"ASYNC"`
|
|
981
982
|
|
|
982
|
-
Defined in: [cobalt.ts:216](https://github.com/gocobalt/cobalt-js/blob/
|
|
983
|
+
Defined in: [cobalt.ts:216](https://github.com/gocobalt/cobalt-js/blob/efd14ac8a77cf69a893a8e4eae26a77d85370c5f/cobalt.ts#L216)
|
|
983
984
|
|
|
984
985
|
Whether a workflow execution runs synchronously (waits for result) or asynchronously (fire-and-forget).
|