@cobaltio/cobalt-js 9.3.0-beta.1 → 9.3.0-beta.3
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/.github/pull_request_template.md +48 -0
- package/.github/workflows/pr-validation.yml +224 -0
- package/CLAUDE.md +10 -0
- package/cobalt.d.ts +4 -2
- package/cobalt.js +8 -2
- package/cobalt.ts +9 -3
- package/docs/classes/Cobalt.html +26 -24
- package/docs/enums/AuthStatus.html +2 -2
- package/docs/enums/AuthType.html +2 -2
- package/docs/interfaces/Application.html +14 -14
- package/docs/interfaces/AuthConfig.html +5 -5
- 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/ConnectedAccount.html +7 -7
- 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/KeyBasedParams.html +4 -4
- package/docs/interfaces/Label.html +3 -3
- package/docs/interfaces/OAuthParams.html +5 -5
- 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 +219 -217
- package/docs/types/ExecutionSource.html +1 -1
- package/docs/types/ExecutionStatus.html +1 -1
- package/docs/types/ExecutionType.html +1 -1
- package/package.json +3 -3
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/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/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/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L11) |
|
|
80
|
+
| <a id="enumeration-member-expired"></a> `Expired` | `"expired"` | [cobalt.ts:12](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/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/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/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/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L7) |
|
|
95
|
+
| <a id="enumeration-member-oauth2"></a> `OAuth2` | `"oauth2"` | [cobalt.ts:6](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L6) |
|
|
96
96
|
|
|
97
97
|
## Classes
|
|
98
98
|
|
|
99
99
|
### Cobalt
|
|
100
100
|
|
|
101
|
-
Defined in: [cobalt.ts:402](https://github.com/gocobalt/cobalt-js/blob/
|
|
101
|
+
Defined in: [cobalt.ts:402](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L402)
|
|
102
102
|
|
|
103
103
|
#### Constructors
|
|
104
104
|
|
|
@@ -106,7 +106,7 @@ Defined in: [cobalt.ts:402](https://github.com/gocobalt/cobalt-js/blob/875971167
|
|
|
106
106
|
|
|
107
107
|
> **new Cobalt**(`options?`): [`Cobalt`](#cobalt)
|
|
108
108
|
|
|
109
|
-
Defined in: [cobalt.ts:412](https://github.com/gocobalt/cobalt-js/blob/
|
|
109
|
+
Defined in: [cobalt.ts:412](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L412)
|
|
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:404](https://github.com/gocobalt/cobalt-js/blob/
|
|
127
|
+
| <a id="token"></a> `token` | `public` | `string` | [cobalt.ts:404](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L404) |
|
|
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:726](https://github.com/gocobalt/cobalt-js/blob/
|
|
135
|
+
Defined in: [cobalt.ts:726](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L726)
|
|
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:670](https://github.com/gocobalt/cobalt-js/blob/
|
|
155
|
+
Defined in: [cobalt.ts:670](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L670)
|
|
156
156
|
|
|
157
157
|
Connects the specified application using the provided authentication type and optional auth data.
|
|
158
158
|
|
|
@@ -181,7 +181,7 @@ Throws an error if the authentication type is invalid or the connection fails.
|
|
|
181
181
|
|
|
182
182
|
> **createWorkflow**(`params`): `Promise`\<[`PublicWorkflow`](#publicworkflow)\>
|
|
183
183
|
|
|
184
|
-
Defined in: [cobalt.ts:
|
|
184
|
+
Defined in: [cobalt.ts:984](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L984)
|
|
185
185
|
|
|
186
186
|
Create a public workflow for the linked account.
|
|
187
187
|
|
|
@@ -201,7 +201,7 @@ The created public workflow.
|
|
|
201
201
|
|
|
202
202
|
> **deleteConfig**(`slug`, `configId?`): `Promise`\<`unknown`\>
|
|
203
203
|
|
|
204
|
-
Defined in: [cobalt.ts:
|
|
204
|
+
Defined in: [cobalt.ts:819](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L819)
|
|
205
205
|
|
|
206
206
|
Delete the specified config.
|
|
207
207
|
|
|
@@ -220,7 +220,7 @@ Delete the specified config.
|
|
|
220
220
|
|
|
221
221
|
> **deleteConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<`unknown`\>
|
|
222
222
|
|
|
223
|
-
Defined in: [cobalt.ts:
|
|
223
|
+
Defined in: [cobalt.ts:896](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L896)
|
|
224
224
|
|
|
225
225
|
Delete the specified config field value.
|
|
226
226
|
|
|
@@ -240,7 +240,7 @@ Delete the specified config field value.
|
|
|
240
240
|
|
|
241
241
|
> **deleteWorkflow**(`workflowId`): `Promise`\<`unknown`\>
|
|
242
242
|
|
|
243
|
-
Defined in: [cobalt.ts:
|
|
243
|
+
Defined in: [cobalt.ts:1012](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L1012)
|
|
244
244
|
|
|
245
245
|
Delete the specified public workflow.
|
|
246
246
|
|
|
@@ -258,7 +258,7 @@ Delete the specified public workflow.
|
|
|
258
258
|
|
|
259
259
|
> **disconnect**(`slug`, `type?`, `authConfig?`): `Promise`\<`unknown`\>
|
|
260
260
|
|
|
261
|
-
Defined in: [cobalt.ts:701](https://github.com/gocobalt/cobalt-js/blob/
|
|
261
|
+
Defined in: [cobalt.ts:701](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L701)
|
|
262
262
|
|
|
263
263
|
Disconnect the specified application and remove any associated data from Cobalt.
|
|
264
264
|
|
|
@@ -278,7 +278,7 @@ Disconnect the specified application and remove any associated data from Cobalt.
|
|
|
278
278
|
|
|
279
279
|
> **executeWorkflow**(`options`): `Promise`\<`unknown`\>
|
|
280
280
|
|
|
281
|
-
Defined in: [cobalt.ts:
|
|
281
|
+
Defined in: [cobalt.ts:1056](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L1056)
|
|
282
282
|
|
|
283
283
|
Execute the specified public workflow.
|
|
284
284
|
|
|
@@ -306,7 +306,7 @@ The application slug.
|
|
|
306
306
|
|
|
307
307
|
> **getApp**(): `Promise`\<[`Application`](#application)[]\>
|
|
308
308
|
|
|
309
|
-
Defined in: [cobalt.ts:472](https://github.com/gocobalt/cobalt-js/blob/
|
|
309
|
+
Defined in: [cobalt.ts:472](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L472)
|
|
310
310
|
|
|
311
311
|
Returns the list of enabled applications and their details.
|
|
312
312
|
|
|
@@ -320,7 +320,7 @@ The list of applications.
|
|
|
320
320
|
|
|
321
321
|
> **getApp**(`slug`): `Promise`\<[`Application`](#application)\>
|
|
322
322
|
|
|
323
|
-
Defined in: [cobalt.ts:479](https://github.com/gocobalt/cobalt-js/blob/
|
|
323
|
+
Defined in: [cobalt.ts:479](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L479)
|
|
324
324
|
|
|
325
325
|
Returns the application details for the specified application, provided
|
|
326
326
|
the application is enabled in Cobalt.
|
|
@@ -341,7 +341,7 @@ The application details.
|
|
|
341
341
|
|
|
342
342
|
> **getApps**(): `Promise`\<[`Application`](#application)[]\>
|
|
343
343
|
|
|
344
|
-
Defined in: [cobalt.ts:507](https://github.com/gocobalt/cobalt-js/blob/
|
|
344
|
+
Defined in: [cobalt.ts:507](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L507)
|
|
345
345
|
|
|
346
346
|
Returns all the enabled apps.
|
|
347
347
|
|
|
@@ -355,7 +355,7 @@ The list of applications.
|
|
|
355
355
|
|
|
356
356
|
> **getAuthConfigs**(`slug`): `Promise`\<[`AuthConfig`](#authconfig)[]\>
|
|
357
357
|
|
|
358
|
-
Defined in: [cobalt.ts:528](https://github.com/gocobalt/cobalt-js/blob/
|
|
358
|
+
Defined in: [cobalt.ts:528](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L528)
|
|
359
359
|
|
|
360
360
|
Returns the auth configs for the specified application.
|
|
361
361
|
|
|
@@ -373,9 +373,9 @@ The auth configs.
|
|
|
373
373
|
|
|
374
374
|
##### getConfig()
|
|
375
375
|
|
|
376
|
-
> **getConfig**(`slug`, `configId?`): `Promise`\<[`Config`](#config-1)\>
|
|
376
|
+
> **getConfig**(`slug`, `configId?`, `excludeOptions?`): `Promise`\<[`Config`](#config-1)\>
|
|
377
377
|
|
|
378
|
-
Defined in: [cobalt.ts:
|
|
378
|
+
Defined in: [cobalt.ts:774](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L774)
|
|
379
379
|
|
|
380
380
|
Returns the specified config.
|
|
381
381
|
|
|
@@ -385,6 +385,7 @@ Returns the specified config.
|
|
|
385
385
|
| ------ | ------ | ------ |
|
|
386
386
|
| `slug` | `string` | The application slug. |
|
|
387
387
|
| `configId?` | `string` | The unique ID of the config. |
|
|
388
|
+
| `excludeOptions?` | `boolean` | Whether to exclude the options from the fields in the response. |
|
|
388
389
|
|
|
389
390
|
###### Returns
|
|
390
391
|
|
|
@@ -394,9 +395,9 @@ The specified config.
|
|
|
394
395
|
|
|
395
396
|
##### getConfigField()
|
|
396
397
|
|
|
397
|
-
> **getConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<[`Config`](#config-1)\>
|
|
398
|
+
> **getConfigField**(`slug`, `fieldId`, `workflowId?`, `payload?`): `Promise`\<[`Config`](#config-1)\>
|
|
398
399
|
|
|
399
|
-
Defined in: [cobalt.ts:
|
|
400
|
+
Defined in: [cobalt.ts:843](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L843)
|
|
400
401
|
|
|
401
402
|
Returns the specified field of the config.
|
|
402
403
|
|
|
@@ -407,6 +408,7 @@ Returns the specified field of the config.
|
|
|
407
408
|
| `slug` | `string` | The application slug. |
|
|
408
409
|
| `fieldId` | `string` | The unique ID of the field. |
|
|
409
410
|
| `workflowId?` | `string` | The unique ID of the workflow. |
|
|
411
|
+
| `payload?` | `Record`\<`string`, `unknown`\> | The payload to be sent in the request body. |
|
|
410
412
|
|
|
411
413
|
###### Returns
|
|
412
414
|
|
|
@@ -418,7 +420,7 @@ The specified config field.
|
|
|
418
420
|
|
|
419
421
|
> **getConfigs**(`slug`): `Promise`\<`object`[]\>
|
|
420
422
|
|
|
421
|
-
Defined in: [cobalt.ts:752](https://github.com/gocobalt/cobalt-js/blob/
|
|
423
|
+
Defined in: [cobalt.ts:752](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L752)
|
|
422
424
|
|
|
423
425
|
Returns the configs created for the specified application.
|
|
424
426
|
|
|
@@ -438,7 +440,7 @@ The configs created for the specified application.
|
|
|
438
440
|
|
|
439
441
|
> **getExecution**(`executionId`): `Promise`\<[`Execution`](#execution)\>
|
|
440
442
|
|
|
441
|
-
Defined in: [cobalt.ts:
|
|
443
|
+
Defined in: [cobalt.ts:1116](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L1116)
|
|
442
444
|
|
|
443
445
|
Returns the specified workflow execution log.
|
|
444
446
|
|
|
@@ -458,7 +460,7 @@ The specified execution log.
|
|
|
458
460
|
|
|
459
461
|
> **getExecutions**(`params?`): `Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
|
|
460
462
|
|
|
461
|
-
Defined in: [cobalt.ts:
|
|
463
|
+
Defined in: [cobalt.ts:1090](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L1090)
|
|
462
464
|
|
|
463
465
|
Returns the workflow execution logs for the linked account.
|
|
464
466
|
|
|
@@ -478,7 +480,7 @@ The paginated workflow execution logs.
|
|
|
478
480
|
|
|
479
481
|
> **getFieldOptions**(`lhs`, `slug`, `fieldId`, `workflowId?`): `Promise`\<[`RuleOptions`](#ruleoptions)\>
|
|
480
482
|
|
|
481
|
-
Defined in: [cobalt.ts:
|
|
483
|
+
Defined in: [cobalt.ts:921](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L921)
|
|
482
484
|
|
|
483
485
|
Returns the options for the specified field.
|
|
484
486
|
|
|
@@ -501,7 +503,7 @@ The specified rule field's options.
|
|
|
501
503
|
|
|
502
504
|
> **getWorkflowPayload**(`workflowId`): `Promise`\<[`WorkflowPayloadResponse`](#workflowpayloadresponse)\>
|
|
503
505
|
|
|
504
|
-
Defined in: [cobalt.ts:
|
|
506
|
+
Defined in: [cobalt.ts:1033](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L1033)
|
|
505
507
|
|
|
506
508
|
Returns the execution payload for the specified public workflow.
|
|
507
509
|
|
|
@@ -521,7 +523,7 @@ The workflow payload response.
|
|
|
521
523
|
|
|
522
524
|
> **getWorkflows**(`params?`): `Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
|
|
523
525
|
|
|
524
|
-
Defined in: [cobalt.ts:
|
|
526
|
+
Defined in: [cobalt.ts:954](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L954)
|
|
525
527
|
|
|
526
528
|
Returns the private workflows for the specified application.
|
|
527
529
|
|
|
@@ -539,7 +541,7 @@ Returns the private workflows for the specified application.
|
|
|
539
541
|
|
|
540
542
|
> **updateConfig**(`payload`): `Promise`\<[`Config`](#config-1)\>
|
|
541
543
|
|
|
542
|
-
Defined in: [cobalt.ts:
|
|
544
|
+
Defined in: [cobalt.ts:795](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L795)
|
|
543
545
|
|
|
544
546
|
Update the specified config.
|
|
545
547
|
|
|
@@ -559,7 +561,7 @@ The specified config.
|
|
|
559
561
|
|
|
560
562
|
> **updateConfigField**(`slug`, `fieldId`, `value`, `workflowId?`): `Promise`\<[`Config`](#config-1)\>
|
|
561
563
|
|
|
562
|
-
Defined in: [cobalt.ts:
|
|
564
|
+
Defined in: [cobalt.ts:870](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L870)
|
|
563
565
|
|
|
564
566
|
Update the specified config field value.
|
|
565
567
|
|
|
@@ -582,7 +584,7 @@ The updated config field.
|
|
|
582
584
|
|
|
583
585
|
### Application
|
|
584
586
|
|
|
585
|
-
Defined in: [cobalt.ts:32](https://github.com/gocobalt/cobalt-js/blob/
|
|
587
|
+
Defined in: [cobalt.ts:32](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L32)
|
|
586
588
|
|
|
587
589
|
An application in Cobalt.
|
|
588
590
|
|
|
@@ -590,95 +592,95 @@ An application in Cobalt.
|
|
|
590
592
|
|
|
591
593
|
| Property | Type | Description | Defined in |
|
|
592
594
|
| ------ | ------ | ------ | ------ |
|
|
593
|
-
| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:34](https://github.com/gocobalt/cobalt-js/blob/
|
|
594
|
-
| <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:76](https://github.com/gocobalt/cobalt-js/blob/
|
|
595
|
-
| <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:61](https://github.com/gocobalt/cobalt-js/blob/
|
|
596
|
-
| <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:51](https://github.com/gocobalt/cobalt-js/blob/
|
|
595
|
+
| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:34](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L34) |
|
|
596
|
+
| <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:76](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L76) |
|
|
597
|
+
| <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:61](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L61) |
|
|
598
|
+
| <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:51](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L51) |
|
|
597
599
|
| `auth_type_options.keybased` | [`InputField`](#inputfield)[] | - | |
|
|
598
600
|
| `auth_type_options.oauth2` | [`InputField`](#inputfield)[] | - | |
|
|
599
|
-
| <a id="connected"></a> ~~`connected?`~~ | `boolean` | Whether the user has connected the application. **Deprecated** Check `connected_accounts` for multiple auth types support. | [cobalt.ts:66](https://github.com/gocobalt/cobalt-js/blob/
|
|
600
|
-
| <a id="connected_accounts"></a> `connected_accounts?` | [`ConnectedAccount`](#connectedaccount)[] | The list of connected accounts for this application | [cobalt.ts:56](https://github.com/gocobalt/cobalt-js/blob/
|
|
601
|
-
| <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:38](https://github.com/gocobalt/cobalt-js/blob/
|
|
602
|
-
| <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:40](https://github.com/gocobalt/cobalt-js/blob/
|
|
603
|
-
| <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:36](https://github.com/gocobalt/cobalt-js/blob/
|
|
604
|
-
| <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:71](https://github.com/gocobalt/cobalt-js/blob/
|
|
605
|
-
| <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:47](https://github.com/gocobalt/cobalt-js/blob/
|
|
606
|
-
| <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:49](https://github.com/gocobalt/cobalt-js/blob/
|
|
607
|
-
| <a id="type"></a> ~~`type`~~ | `string` | **Deprecated** Use `slug` instead. The application slug for native apps and `custom` for custom apps. | [cobalt.ts:45](https://github.com/gocobalt/cobalt-js/blob/
|
|
601
|
+
| <a id="connected"></a> ~~`connected?`~~ | `boolean` | Whether the user has connected the application. **Deprecated** Check `connected_accounts` for multiple auth types support. | [cobalt.ts:66](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L66) |
|
|
602
|
+
| <a id="connected_accounts"></a> `connected_accounts?` | [`ConnectedAccount`](#connectedaccount)[] | The list of connected accounts for this application | [cobalt.ts:56](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L56) |
|
|
603
|
+
| <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:38](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L38) |
|
|
604
|
+
| <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:40](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L40) |
|
|
605
|
+
| <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:36](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L36) |
|
|
606
|
+
| <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:71](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L71) |
|
|
607
|
+
| <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:47](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L47) |
|
|
608
|
+
| <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:49](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L49) |
|
|
609
|
+
| <a id="type"></a> ~~`type`~~ | `string` | **Deprecated** Use `slug` instead. The application slug for native apps and `custom` for custom apps. | [cobalt.ts:45](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L45) |
|
|
608
610
|
|
|
609
611
|
***
|
|
610
612
|
|
|
611
613
|
### AuthConfig
|
|
612
614
|
|
|
613
|
-
Defined in: [cobalt.ts:79](https://github.com/gocobalt/cobalt-js/blob/
|
|
615
|
+
Defined in: [cobalt.ts:79](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L79)
|
|
614
616
|
|
|
615
617
|
#### Properties
|
|
616
618
|
|
|
617
619
|
| Property | Type | Description | Defined in |
|
|
618
620
|
| ------ | ------ | ------ | ------ |
|
|
619
|
-
| <a id="_id"></a> `_id` | `string` | The auth config ID. | [cobalt.ts:81](https://github.com/gocobalt/cobalt-js/blob/
|
|
620
|
-
| <a id="description-1"></a> `description?` | `string` | The description of the auth config. | [cobalt.ts:85](https://github.com/gocobalt/cobalt-js/blob/
|
|
621
|
-
| <a id="is_default"></a> `is_default?` | `boolean` | Whether the auth config is the default auth config for the application. | [cobalt.ts:87](https://github.com/gocobalt/cobalt-js/blob/
|
|
622
|
-
| <a id="name-1"></a> `name` | `string` | The display name of the auth config. | [cobalt.ts:83](https://github.com/gocobalt/cobalt-js/blob/
|
|
621
|
+
| <a id="_id"></a> `_id` | `string` | The auth config ID. | [cobalt.ts:81](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L81) |
|
|
622
|
+
| <a id="description-1"></a> `description?` | `string` | The description of the auth config. | [cobalt.ts:85](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L85) |
|
|
623
|
+
| <a id="is_default"></a> `is_default?` | `boolean` | Whether the auth config is the default auth config for the application. | [cobalt.ts:87](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L87) |
|
|
624
|
+
| <a id="name-1"></a> `name` | `string` | The display name of the auth config. | [cobalt.ts:83](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L83) |
|
|
623
625
|
|
|
624
626
|
***
|
|
625
627
|
|
|
626
628
|
### CobaltOptions
|
|
627
629
|
|
|
628
|
-
Defined in: [cobalt.ts:173](https://github.com/gocobalt/cobalt-js/blob/
|
|
630
|
+
Defined in: [cobalt.ts:173](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L173)
|
|
629
631
|
|
|
630
632
|
#### Properties
|
|
631
633
|
|
|
632
634
|
| Property | Type | Description | Defined in |
|
|
633
635
|
| ------ | ------ | ------ | ------ |
|
|
634
|
-
| <a id="baseurl"></a> `baseUrl?` | `string` | The base URL of the Cobalt API. You don't need to set this. | [cobalt.ts:175](https://github.com/gocobalt/cobalt-js/blob/
|
|
635
|
-
| <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:177](https://github.com/gocobalt/cobalt-js/blob/
|
|
636
|
+
| <a id="baseurl"></a> `baseUrl?` | `string` | The base URL of the Cobalt API. You don't need to set this. | [cobalt.ts:175](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L175) |
|
|
637
|
+
| <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:177](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L177) |
|
|
636
638
|
|
|
637
639
|
***
|
|
638
640
|
|
|
639
641
|
### Config
|
|
640
642
|
|
|
641
|
-
Defined in: [cobalt.ts:288](https://github.com/gocobalt/cobalt-js/blob/
|
|
643
|
+
Defined in: [cobalt.ts:288](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L288)
|
|
642
644
|
|
|
643
645
|
#### Properties
|
|
644
646
|
|
|
645
647
|
| Property | Type | Defined in |
|
|
646
648
|
| ------ | ------ | ------ |
|
|
647
|
-
| <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:290](https://github.com/gocobalt/cobalt-js/blob/
|
|
648
|
-
| <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:293](https://github.com/gocobalt/cobalt-js/blob/
|
|
649
|
-
| <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:291](https://github.com/gocobalt/cobalt-js/blob/
|
|
650
|
-
| <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:289](https://github.com/gocobalt/cobalt-js/blob/
|
|
651
|
-
| <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:292](https://github.com/gocobalt/cobalt-js/blob/
|
|
649
|
+
| <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:290](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L290) |
|
|
650
|
+
| <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:293](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L293) |
|
|
651
|
+
| <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:291](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L291) |
|
|
652
|
+
| <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:289](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L289) |
|
|
653
|
+
| <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:292](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L292) |
|
|
652
654
|
|
|
653
655
|
***
|
|
654
656
|
|
|
655
657
|
### ConfigField
|
|
656
658
|
|
|
657
|
-
Defined in: [cobalt.ts:303](https://github.com/gocobalt/cobalt-js/blob/
|
|
659
|
+
Defined in: [cobalt.ts:303](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L303)
|
|
658
660
|
|
|
659
661
|
#### Properties
|
|
660
662
|
|
|
661
663
|
| Property | Type | Description | Defined in |
|
|
662
664
|
| ------ | ------ | ------ | ------ |
|
|
663
|
-
| <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:325](https://github.com/gocobalt/cobalt-js/blob/
|
|
664
|
-
| <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:306](https://github.com/gocobalt/cobalt-js/blob/
|
|
665
|
-
| <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:323](https://github.com/gocobalt/cobalt-js/blob/
|
|
666
|
-
| <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:318](https://github.com/gocobalt/cobalt-js/blob/
|
|
667
|
-
| <a id="id"></a> `id` | `string` | - | [cobalt.ts:304](https://github.com/gocobalt/cobalt-js/blob/
|
|
668
|
-
| <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:312](https://github.com/gocobalt/cobalt-js/blob/
|
|
669
|
-
| <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:316](https://github.com/gocobalt/cobalt-js/blob/
|
|
670
|
-
| <a id="name-2"></a> `name` | `string` | - | [cobalt.ts:305](https://github.com/gocobalt/cobalt-js/blob/
|
|
671
|
-
| <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:307](https://github.com/gocobalt/cobalt-js/blob/
|
|
672
|
-
| <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:311](https://github.com/gocobalt/cobalt-js/blob/
|
|
673
|
-
| <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:321](https://github.com/gocobalt/cobalt-js/blob/
|
|
674
|
-
| <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:317](https://github.com/gocobalt/cobalt-js/blob/
|
|
675
|
-
| <a id="value"></a> `value?` | `any` | - | [cobalt.ts:319](https://github.com/gocobalt/cobalt-js/blob/
|
|
665
|
+
| <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:325](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L325) |
|
|
666
|
+
| <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:306](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L306) |
|
|
667
|
+
| <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:323](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L323) |
|
|
668
|
+
| <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:318](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L318) |
|
|
669
|
+
| <a id="id"></a> `id` | `string` | - | [cobalt.ts:304](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L304) |
|
|
670
|
+
| <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:312](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L312) |
|
|
671
|
+
| <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:316](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L316) |
|
|
672
|
+
| <a id="name-2"></a> `name` | `string` | - | [cobalt.ts:305](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L305) |
|
|
673
|
+
| <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:307](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L307) |
|
|
674
|
+
| <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:311](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L311) |
|
|
675
|
+
| <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:321](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L321) |
|
|
676
|
+
| <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:317](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L317) |
|
|
677
|
+
| <a id="value"></a> `value?` | `any` | - | [cobalt.ts:319](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L319) |
|
|
676
678
|
|
|
677
679
|
***
|
|
678
680
|
|
|
679
681
|
### ConfigPayload
|
|
680
682
|
|
|
681
|
-
Defined in: [cobalt.ts:134](https://github.com/gocobalt/cobalt-js/blob/
|
|
683
|
+
Defined in: [cobalt.ts:134](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L134)
|
|
682
684
|
|
|
683
685
|
The payload object for config.
|
|
684
686
|
|
|
@@ -686,31 +688,31 @@ The payload object for config.
|
|
|
686
688
|
|
|
687
689
|
| Property | Type | Description | Defined in |
|
|
688
690
|
| ------ | ------ | ------ | ------ |
|
|
689
|
-
| <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:138](https://github.com/gocobalt/cobalt-js/blob/
|
|
690
|
-
| <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:140](https://github.com/gocobalt/cobalt-js/blob/
|
|
691
|
-
| <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:136](https://github.com/gocobalt/cobalt-js/blob/
|
|
691
|
+
| <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:138](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L138) |
|
|
692
|
+
| <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:140](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L140) |
|
|
693
|
+
| <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:136](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L136) |
|
|
692
694
|
|
|
693
695
|
***
|
|
694
696
|
|
|
695
697
|
### ConfigWorkflow
|
|
696
698
|
|
|
697
|
-
Defined in: [cobalt.ts:328](https://github.com/gocobalt/cobalt-js/blob/
|
|
699
|
+
Defined in: [cobalt.ts:328](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L328)
|
|
698
700
|
|
|
699
701
|
#### Properties
|
|
700
702
|
|
|
701
703
|
| Property | Type | Defined in |
|
|
702
704
|
| ------ | ------ | ------ |
|
|
703
|
-
| <a id="description-2"></a> `description?` | `string` | [cobalt.ts:331](https://github.com/gocobalt/cobalt-js/blob/
|
|
704
|
-
| <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:332](https://github.com/gocobalt/cobalt-js/blob/
|
|
705
|
-
| <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:333](https://github.com/gocobalt/cobalt-js/blob/
|
|
706
|
-
| <a id="id-1"></a> `id` | `string` | [cobalt.ts:329](https://github.com/gocobalt/cobalt-js/blob/
|
|
707
|
-
| <a id="name-3"></a> `name` | `string` | [cobalt.ts:330](https://github.com/gocobalt/cobalt-js/blob/
|
|
705
|
+
| <a id="description-2"></a> `description?` | `string` | [cobalt.ts:331](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L331) |
|
|
706
|
+
| <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:332](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L332) |
|
|
707
|
+
| <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:333](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L333) |
|
|
708
|
+
| <a id="id-1"></a> `id` | `string` | [cobalt.ts:329](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L329) |
|
|
709
|
+
| <a id="name-3"></a> `name` | `string` | [cobalt.ts:330](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L330) |
|
|
708
710
|
|
|
709
711
|
***
|
|
710
712
|
|
|
711
713
|
### ConnectedAccount
|
|
712
714
|
|
|
713
|
-
Defined in: [cobalt.ts:16](https://github.com/gocobalt/cobalt-js/blob/
|
|
715
|
+
Defined in: [cobalt.ts:16](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L16)
|
|
714
716
|
|
|
715
717
|
A connected account for an application.
|
|
716
718
|
|
|
@@ -718,74 +720,74 @@ A connected account for an application.
|
|
|
718
720
|
|
|
719
721
|
| Property | Type | Description | Defined in |
|
|
720
722
|
| ------ | ------ | ------ | ------ |
|
|
721
|
-
| <a id="auth_config_id"></a> `auth_config_id` | `string` | The identifier of the auth config. | [cobalt.ts:20](https://github.com/gocobalt/cobalt-js/blob/
|
|
722
|
-
| <a id="auth_type-1"></a> `auth_type` | [`AuthType`](#authtype) | The auth type used to connect the account. | [cobalt.ts:24](https://github.com/gocobalt/cobalt-js/blob/
|
|
723
|
-
| <a id="connectedat"></a> `connectedAt` | `string` | The timestamp at which the account was connected. | [cobalt.ts:26](https://github.com/gocobalt/cobalt-js/blob/
|
|
724
|
-
| <a id="connection_id"></a> `connection_id` | `string` | The unique identifier for this connected account. | [cobalt.ts:18](https://github.com/gocobalt/cobalt-js/blob/
|
|
725
|
-
| <a id="identifier"></a> `identifier` | `unknown` | The identifier (username, email, etc.) of the connected account. | [cobalt.ts:22](https://github.com/gocobalt/cobalt-js/blob/
|
|
726
|
-
| <a id="status"></a> `status?` | [`AuthStatus`](#authstatus) | The current status of the connection. | [cobalt.ts:28](https://github.com/gocobalt/cobalt-js/blob/
|
|
723
|
+
| <a id="auth_config_id"></a> `auth_config_id` | `string` | The identifier of the auth config. | [cobalt.ts:20](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L20) |
|
|
724
|
+
| <a id="auth_type-1"></a> `auth_type` | [`AuthType`](#authtype) | The auth type used to connect the account. | [cobalt.ts:24](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L24) |
|
|
725
|
+
| <a id="connectedat"></a> `connectedAt` | `string` | The timestamp at which the account was connected. | [cobalt.ts:26](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L26) |
|
|
726
|
+
| <a id="connection_id"></a> `connection_id` | `string` | The unique identifier for this connected account. | [cobalt.ts:18](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L18) |
|
|
727
|
+
| <a id="identifier"></a> `identifier` | `unknown` | The identifier (username, email, etc.) of the connected account. | [cobalt.ts:22](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L22) |
|
|
728
|
+
| <a id="status"></a> `status?` | [`AuthStatus`](#authstatus) | The current status of the connection. | [cobalt.ts:28](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L28) |
|
|
727
729
|
|
|
728
730
|
***
|
|
729
731
|
|
|
730
732
|
### ExecuteWorkflowPayload
|
|
731
733
|
|
|
732
|
-
Defined in: [cobalt.ts:342](https://github.com/gocobalt/cobalt-js/blob/
|
|
734
|
+
Defined in: [cobalt.ts:342](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L342)
|
|
733
735
|
|
|
734
736
|
#### Properties
|
|
735
737
|
|
|
736
738
|
| Property | Type | Description | Defined in |
|
|
737
739
|
| ------ | ------ | ------ | ------ |
|
|
738
|
-
| <a id="payload"></a> `payload?` | `Record`\<`string`, `any`\> | The payload to execute the workflow. | [cobalt.ts:348](https://github.com/gocobalt/cobalt-js/blob/
|
|
739
|
-
| <a id="slug-3"></a> `slug?` | `string` | The application's slug this workflow belongs to. | [cobalt.ts:346](https://github.com/gocobalt/cobalt-js/blob/
|
|
740
|
-
| <a id="sync_execution"></a> `sync_execution?` | `boolean` | Whether to execute the workflow synchronously. | [cobalt.ts:350](https://github.com/gocobalt/cobalt-js/blob/
|
|
741
|
-
| <a id="worklfow"></a> `worklfow` | `string` | The workflow id or alias. | [cobalt.ts:344](https://github.com/gocobalt/cobalt-js/blob/
|
|
740
|
+
| <a id="payload"></a> `payload?` | `Record`\<`string`, `any`\> | The payload to execute the workflow. | [cobalt.ts:348](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L348) |
|
|
741
|
+
| <a id="slug-3"></a> `slug?` | `string` | The application's slug this workflow belongs to. | [cobalt.ts:346](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L346) |
|
|
742
|
+
| <a id="sync_execution"></a> `sync_execution?` | `boolean` | Whether to execute the workflow synchronously. | [cobalt.ts:350](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L350) |
|
|
743
|
+
| <a id="worklfow"></a> `worklfow` | `string` | The workflow id or alias. | [cobalt.ts:344](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L344) |
|
|
742
744
|
|
|
743
745
|
***
|
|
744
746
|
|
|
745
747
|
### Execution
|
|
746
748
|
|
|
747
|
-
Defined in: [cobalt.ts:353](https://github.com/gocobalt/cobalt-js/blob/
|
|
749
|
+
Defined in: [cobalt.ts:353](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L353)
|
|
748
750
|
|
|
749
751
|
#### Properties
|
|
750
752
|
|
|
751
753
|
| Property | Type | Defined in |
|
|
752
754
|
| ------ | ------ | ------ |
|
|
753
|
-
| <a id="_id-1"></a> `_id` | `string` | [cobalt.ts:354](https://github.com/gocobalt/cobalt-js/blob/
|
|
754
|
-
| <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:358](https://github.com/gocobalt/cobalt-js/blob/
|
|
755
|
-
| `associated_application._id` | `string` | [cobalt.ts:359](https://github.com/gocobalt/cobalt-js/blob/
|
|
756
|
-
| `associated_application.icon?` | `string` | [cobalt.ts:361](https://github.com/gocobalt/cobalt-js/blob/
|
|
757
|
-
| `associated_application.name` | `string` | [cobalt.ts:360](https://github.com/gocobalt/cobalt-js/blob/
|
|
758
|
-
| <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:382](https://github.com/gocobalt/cobalt-js/blob/
|
|
759
|
-
| <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:368](https://github.com/gocobalt/cobalt-js/blob/
|
|
760
|
-
| `associated_trigger_application._id` | `string` | [cobalt.ts:369](https://github.com/gocobalt/cobalt-js/blob/
|
|
761
|
-
| `associated_trigger_application.app_type?` | `string` | [cobalt.ts:372](https://github.com/gocobalt/cobalt-js/blob/
|
|
762
|
-
| `associated_trigger_application.icon?` | `string` | [cobalt.ts:371](https://github.com/gocobalt/cobalt-js/blob/
|
|
763
|
-
| `associated_trigger_application.name` | `string` | [cobalt.ts:370](https://github.com/gocobalt/cobalt-js/blob/
|
|
764
|
-
| `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:373](https://github.com/gocobalt/cobalt-js/blob/
|
|
765
|
-
| `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:374](https://github.com/gocobalt/cobalt-js/blob/
|
|
766
|
-
| `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:375](https://github.com/gocobalt/cobalt-js/blob/
|
|
767
|
-
| <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:364](https://github.com/gocobalt/cobalt-js/blob/
|
|
768
|
-
| `associated_workflow._id` | `string` | [cobalt.ts:365](https://github.com/gocobalt/cobalt-js/blob/
|
|
769
|
-
| `associated_workflow.name` | `string` | [cobalt.ts:366](https://github.com/gocobalt/cobalt-js/blob/
|
|
770
|
-
| <a id="completion_percentage"></a> `completion_percentage?` | `number` | [cobalt.ts:385](https://github.com/gocobalt/cobalt-js/blob/
|
|
771
|
-
| <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:381](https://github.com/gocobalt/cobalt-js/blob/
|
|
772
|
-
| <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:397](https://github.com/gocobalt/cobalt-js/blob/
|
|
773
|
-
| <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:384](https://github.com/gocobalt/cobalt-js/blob/
|
|
774
|
-
| <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:383](https://github.com/gocobalt/cobalt-js/blob/
|
|
775
|
-
| <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:380](https://github.com/gocobalt/cobalt-js/blob/
|
|
776
|
-
| <a id="id-2"></a> `id?` | `string` | [cobalt.ts:355](https://github.com/gocobalt/cobalt-js/blob/
|
|
777
|
-
| <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:379](https://github.com/gocobalt/cobalt-js/blob/
|
|
778
|
-
| <a id="name-4"></a> `name` | `string` | [cobalt.ts:356](https://github.com/gocobalt/cobalt-js/blob/
|
|
779
|
-
| <a id="nodes"></a> `nodes?` | `object`[] | [cobalt.ts:386](https://github.com/gocobalt/cobalt-js/blob/
|
|
780
|
-
| <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:357](https://github.com/gocobalt/cobalt-js/blob/
|
|
781
|
-
| <a id="status-1"></a> `status` | [`ExecutionStatus`](#executionstatus-1) | [cobalt.ts:363](https://github.com/gocobalt/cobalt-js/blob/
|
|
782
|
-
| <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:378](https://github.com/gocobalt/cobalt-js/blob/
|
|
755
|
+
| <a id="_id-1"></a> `_id` | `string` | [cobalt.ts:354](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L354) |
|
|
756
|
+
| <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:358](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L358) |
|
|
757
|
+
| `associated_application._id` | `string` | [cobalt.ts:359](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L359) |
|
|
758
|
+
| `associated_application.icon?` | `string` | [cobalt.ts:361](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L361) |
|
|
759
|
+
| `associated_application.name` | `string` | [cobalt.ts:360](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L360) |
|
|
760
|
+
| <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:382](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L382) |
|
|
761
|
+
| <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:368](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L368) |
|
|
762
|
+
| `associated_trigger_application._id` | `string` | [cobalt.ts:369](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L369) |
|
|
763
|
+
| `associated_trigger_application.app_type?` | `string` | [cobalt.ts:372](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L372) |
|
|
764
|
+
| `associated_trigger_application.icon?` | `string` | [cobalt.ts:371](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L371) |
|
|
765
|
+
| `associated_trigger_application.name` | `string` | [cobalt.ts:370](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L370) |
|
|
766
|
+
| `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:373](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L373) |
|
|
767
|
+
| `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:374](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L374) |
|
|
768
|
+
| `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:375](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L375) |
|
|
769
|
+
| <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:364](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L364) |
|
|
770
|
+
| `associated_workflow._id` | `string` | [cobalt.ts:365](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L365) |
|
|
771
|
+
| `associated_workflow.name` | `string` | [cobalt.ts:366](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L366) |
|
|
772
|
+
| <a id="completion_percentage"></a> `completion_percentage?` | `number` | [cobalt.ts:385](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L385) |
|
|
773
|
+
| <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:381](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L381) |
|
|
774
|
+
| <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:397](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L397) |
|
|
775
|
+
| <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:384](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L384) |
|
|
776
|
+
| <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:383](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L383) |
|
|
777
|
+
| <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:380](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L380) |
|
|
778
|
+
| <a id="id-2"></a> `id?` | `string` | [cobalt.ts:355](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L355) |
|
|
779
|
+
| <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:379](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L379) |
|
|
780
|
+
| <a id="name-4"></a> `name` | `string` | [cobalt.ts:356](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L356) |
|
|
781
|
+
| <a id="nodes"></a> `nodes?` | `object`[] | [cobalt.ts:386](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L386) |
|
|
782
|
+
| <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:357](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L357) |
|
|
783
|
+
| <a id="status-1"></a> `status` | [`ExecutionStatus`](#executionstatus-1) | [cobalt.ts:363](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L363) |
|
|
784
|
+
| <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:378](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L378) |
|
|
783
785
|
|
|
784
786
|
***
|
|
785
787
|
|
|
786
788
|
### ExecutionFilters
|
|
787
789
|
|
|
788
|
-
Defined in: [cobalt.ts:257](https://github.com/gocobalt/cobalt-js/blob/
|
|
790
|
+
Defined in: [cobalt.ts:257](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L257)
|
|
789
791
|
|
|
790
792
|
Filters for narrowing down the list of workflow executions.
|
|
791
793
|
|
|
@@ -797,19 +799,19 @@ Filters for narrowing down the list of workflow executions.
|
|
|
797
799
|
|
|
798
800
|
| Property | Type | Description | Defined in |
|
|
799
801
|
| ------ | ------ | ------ | ------ |
|
|
800
|
-
| <a id="end_date"></a> `end_date?` | `string` | Filter executions that started on or before this ISO 8601 date string. | [cobalt.ts:267](https://github.com/gocobalt/cobalt-js/blob/
|
|
801
|
-
| <a id="execution_source"></a> `execution_source?` | [`ExecutionSource`](#executionsource) | Filter by the trigger source that initiated the execution. | [cobalt.ts:271](https://github.com/gocobalt/cobalt-js/blob/
|
|
802
|
-
| <a id="execution_type"></a> `execution_type?` | [`ExecutionType`](#executiontype) | Filter by how the execution was invoked — synchronously or asynchronously. | [cobalt.ts:269](https://github.com/gocobalt/cobalt-js/blob/
|
|
803
|
-
| <a id="start_date"></a> `start_date?` | `string` | Filter executions that started on or after this ISO 8601 date string. | [cobalt.ts:265](https://github.com/gocobalt/cobalt-js/blob/
|
|
804
|
-
| <a id="status-2"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [cobalt.ts:259](https://github.com/gocobalt/cobalt-js/blob/
|
|
805
|
-
| <a id="workflow_id"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [cobalt.ts:263](https://github.com/gocobalt/cobalt-js/blob/
|
|
806
|
-
| <a id="workflow_name"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [cobalt.ts:261](https://github.com/gocobalt/cobalt-js/blob/
|
|
802
|
+
| <a id="end_date"></a> `end_date?` | `string` | Filter executions that started on or before this ISO 8601 date string. | [cobalt.ts:267](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L267) |
|
|
803
|
+
| <a id="execution_source"></a> `execution_source?` | [`ExecutionSource`](#executionsource) | Filter by the trigger source that initiated the execution. | [cobalt.ts:271](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L271) |
|
|
804
|
+
| <a id="execution_type"></a> `execution_type?` | [`ExecutionType`](#executiontype) | Filter by how the execution was invoked — synchronously or asynchronously. | [cobalt.ts:269](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L269) |
|
|
805
|
+
| <a id="start_date"></a> `start_date?` | `string` | Filter executions that started on or after this ISO 8601 date string. | [cobalt.ts:265](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L265) |
|
|
806
|
+
| <a id="status-2"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [cobalt.ts:259](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L259) |
|
|
807
|
+
| <a id="workflow_id"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [cobalt.ts:263](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L263) |
|
|
808
|
+
| <a id="workflow_name"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [cobalt.ts:261](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L261) |
|
|
807
809
|
|
|
808
810
|
***
|
|
809
811
|
|
|
810
812
|
### GetExecutionsParams
|
|
811
813
|
|
|
812
|
-
Defined in: [cobalt.ts:275](https://github.com/gocobalt/cobalt-js/blob/
|
|
814
|
+
Defined in: [cobalt.ts:275](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L275)
|
|
813
815
|
|
|
814
816
|
Parameters for filtering and paginating the list of workflow executions.
|
|
815
817
|
|
|
@@ -827,21 +829,21 @@ Any additional filter keys supported by the API.
|
|
|
827
829
|
|
|
828
830
|
| Property | Type | Description | Inherited from | Defined in |
|
|
829
831
|
| ------ | ------ | ------ | ------ | ------ |
|
|
830
|
-
| <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:267](https://github.com/gocobalt/cobalt-js/blob/
|
|
831
|
-
| <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:271](https://github.com/gocobalt/cobalt-js/blob/
|
|
832
|
-
| <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:269](https://github.com/gocobalt/cobalt-js/blob/
|
|
833
|
-
| <a id="limit"></a> `limit?` | `number` | - | `PaginationProps.limit` | [cobalt.ts:246](https://github.com/gocobalt/cobalt-js/blob/
|
|
834
|
-
| <a id="page"></a> `page?` | `number` | - | `PaginationProps.page` | [cobalt.ts:245](https://github.com/gocobalt/cobalt-js/blob/
|
|
835
|
-
| <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:265](https://github.com/gocobalt/cobalt-js/blob/
|
|
836
|
-
| <a id="status-3"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [`ExecutionFilters`](#executionfilters).[`status`](#status-2) | [cobalt.ts:259](https://github.com/gocobalt/cobalt-js/blob/
|
|
837
|
-
| <a id="workflow_id-1"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [`ExecutionFilters`](#executionfilters).[`workflow_id`](#workflow_id) | [cobalt.ts:263](https://github.com/gocobalt/cobalt-js/blob/
|
|
838
|
-
| <a id="workflow_name-1"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [`ExecutionFilters`](#executionfilters).[`workflow_name`](#workflow_name) | [cobalt.ts:261](https://github.com/gocobalt/cobalt-js/blob/
|
|
832
|
+
| <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:267](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L267) |
|
|
833
|
+
| <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:271](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L271) |
|
|
834
|
+
| <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:269](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L269) |
|
|
835
|
+
| <a id="limit"></a> `limit?` | `number` | - | `PaginationProps.limit` | [cobalt.ts:246](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L246) |
|
|
836
|
+
| <a id="page"></a> `page?` | `number` | - | `PaginationProps.page` | [cobalt.ts:245](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L245) |
|
|
837
|
+
| <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:265](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L265) |
|
|
838
|
+
| <a id="status-3"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [`ExecutionFilters`](#executionfilters).[`status`](#status-2) | [cobalt.ts:259](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L259) |
|
|
839
|
+
| <a id="workflow_id-1"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [`ExecutionFilters`](#executionfilters).[`workflow_id`](#workflow_id) | [cobalt.ts:263](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L263) |
|
|
840
|
+
| <a id="workflow_name-1"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [`ExecutionFilters`](#executionfilters).[`workflow_name`](#workflow_name) | [cobalt.ts:261](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L261) |
|
|
839
841
|
|
|
840
842
|
***
|
|
841
843
|
|
|
842
844
|
### InputField
|
|
843
845
|
|
|
844
|
-
Defined in: [cobalt.ts:91](https://github.com/gocobalt/cobalt-js/blob/
|
|
846
|
+
Defined in: [cobalt.ts:91](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L91)
|
|
845
847
|
|
|
846
848
|
An Input field to take input from the user.
|
|
847
849
|
|
|
@@ -849,34 +851,34 @@ An Input field to take input from the user.
|
|
|
849
851
|
|
|
850
852
|
| Property | Type | Description | Defined in |
|
|
851
853
|
| ------ | ------ | ------ | ------ |
|
|
852
|
-
| <a id="help_text-1"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:105](https://github.com/gocobalt/cobalt-js/blob/
|
|
853
|
-
| <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:103](https://github.com/gocobalt/cobalt-js/blob/
|
|
854
|
-
| <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:99](https://github.com/gocobalt/cobalt-js/blob/
|
|
855
|
-
| <a id="name-5"></a> `name` | `string` | Key name of the field. | [cobalt.ts:93](https://github.com/gocobalt/cobalt-js/blob/
|
|
856
|
-
| <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:107](https://github.com/gocobalt/cobalt-js/blob/
|
|
857
|
-
| <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:101](https://github.com/gocobalt/cobalt-js/blob/
|
|
858
|
-
| <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:97](https://github.com/gocobalt/cobalt-js/blob/
|
|
859
|
-
| <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:95](https://github.com/gocobalt/cobalt-js/blob/
|
|
854
|
+
| <a id="help_text-1"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:105](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L105) |
|
|
855
|
+
| <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:103](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L103) |
|
|
856
|
+
| <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:99](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L99) |
|
|
857
|
+
| <a id="name-5"></a> `name` | `string` | Key name of the field. | [cobalt.ts:93](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L93) |
|
|
858
|
+
| <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:107](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L107) |
|
|
859
|
+
| <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:101](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L101) |
|
|
860
|
+
| <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:97](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L97) |
|
|
861
|
+
| <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:95](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L95) |
|
|
860
862
|
|
|
861
863
|
***
|
|
862
864
|
|
|
863
865
|
### KeyBasedParams
|
|
864
866
|
|
|
865
|
-
Defined in: [cobalt.ts:124](https://github.com/gocobalt/cobalt-js/blob/
|
|
867
|
+
Defined in: [cobalt.ts:124](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L124)
|
|
866
868
|
|
|
867
869
|
#### Properties
|
|
868
870
|
|
|
869
871
|
| Property | Type | Description | Defined in |
|
|
870
872
|
| ------ | ------ | ------ | ------ |
|
|
871
|
-
| <a id="authconfig-1"></a> `authConfig?` | `string` | The identifier of the auth config. | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/
|
|
872
|
-
| <a id="payload-1"></a> `payload?` | `Record`\<`string`, `string`\> | The key value pairs of auth data. | [cobalt.ts:130](https://github.com/gocobalt/cobalt-js/blob/
|
|
873
|
-
| <a id="slug-4"></a> `slug` | `string` | The application slug. | [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/
|
|
873
|
+
| <a id="authconfig-1"></a> `authConfig?` | `string` | The identifier of the auth config. | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L128) |
|
|
874
|
+
| <a id="payload-1"></a> `payload?` | `Record`\<`string`, `string`\> | The key value pairs of auth data. | [cobalt.ts:130](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L130) |
|
|
875
|
+
| <a id="slug-4"></a> `slug` | `string` | The application slug. | [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L126) |
|
|
874
876
|
|
|
875
877
|
***
|
|
876
878
|
|
|
877
879
|
### Label
|
|
878
880
|
|
|
879
|
-
Defined in: [cobalt.ts:144](https://github.com/gocobalt/cobalt-js/blob/
|
|
881
|
+
Defined in: [cobalt.ts:144](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L144)
|
|
880
882
|
|
|
881
883
|
Label Mapping
|
|
882
884
|
|
|
@@ -884,29 +886,29 @@ Label Mapping
|
|
|
884
886
|
|
|
885
887
|
| Property | Type | Description | Defined in |
|
|
886
888
|
| ------ | ------ | ------ | ------ |
|
|
887
|
-
| <a id="name-6"></a> `name` | `string` | The label name. | [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/
|
|
888
|
-
| <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:148](https://github.com/gocobalt/cobalt-js/blob/
|
|
889
|
+
| <a id="name-6"></a> `name` | `string` | The label name. | [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L146) |
|
|
890
|
+
| <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:148](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L148) |
|
|
889
891
|
|
|
890
892
|
***
|
|
891
893
|
|
|
892
894
|
### OAuthParams
|
|
893
895
|
|
|
894
|
-
Defined in: [cobalt.ts:113](https://github.com/gocobalt/cobalt-js/blob/
|
|
896
|
+
Defined in: [cobalt.ts:113](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L113)
|
|
895
897
|
|
|
896
898
|
#### Properties
|
|
897
899
|
|
|
898
900
|
| Property | Type | Description | Defined in |
|
|
899
901
|
| ------ | ------ | ------ | ------ |
|
|
900
|
-
| <a id="authconfig-2"></a> `authConfig?` | `string` | The identifier of the auth config. | [cobalt.ts:117](https://github.com/gocobalt/cobalt-js/blob/
|
|
901
|
-
| <a id="autoclose"></a> `autoClose?` | `boolean` | Whether to close the authentication window automatically. | [cobalt.ts:121](https://github.com/gocobalt/cobalt-js/blob/
|
|
902
|
-
| <a id="payload-2"></a> `payload?` | `Record`\<`string`, `string`\> | The key value pairs of auth data. | [cobalt.ts:119](https://github.com/gocobalt/cobalt-js/blob/
|
|
903
|
-
| <a id="slug-5"></a> `slug` | `string` | The application slug. | [cobalt.ts:115](https://github.com/gocobalt/cobalt-js/blob/
|
|
902
|
+
| <a id="authconfig-2"></a> `authConfig?` | `string` | The identifier of the auth config. | [cobalt.ts:117](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L117) |
|
|
903
|
+
| <a id="autoclose"></a> `autoClose?` | `boolean` | Whether to close the authentication window automatically. | [cobalt.ts:121](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L121) |
|
|
904
|
+
| <a id="payload-2"></a> `payload?` | `Record`\<`string`, `string`\> | The key value pairs of auth data. | [cobalt.ts:119](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L119) |
|
|
905
|
+
| <a id="slug-5"></a> `slug` | `string` | The application slug. | [cobalt.ts:115](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L115) |
|
|
904
906
|
|
|
905
907
|
***
|
|
906
908
|
|
|
907
909
|
### PublicWorkflow
|
|
908
910
|
|
|
909
|
-
Defined in: [cobalt.ts:201](https://github.com/gocobalt/cobalt-js/blob/
|
|
911
|
+
Defined in: [cobalt.ts:201](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L201)
|
|
910
912
|
|
|
911
913
|
A public workflow in Cobalt.
|
|
912
914
|
|
|
@@ -914,19 +916,19 @@ A public workflow in Cobalt.
|
|
|
914
916
|
|
|
915
917
|
| Property | Type | Description | Defined in |
|
|
916
918
|
| ------ | ------ | ------ | ------ |
|
|
917
|
-
| <a id="_id-2"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:203](https://github.com/gocobalt/cobalt-js/blob/
|
|
918
|
-
| <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:211](https://github.com/gocobalt/cobalt-js/blob/
|
|
919
|
-
| <a id="description-3"></a> `description?` | `string` | The workflow description. | [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/
|
|
920
|
-
| <a id="name-7"></a> `name` | `string` | The workflow name. | [cobalt.ts:205](https://github.com/gocobalt/cobalt-js/blob/
|
|
921
|
-
| <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:215](https://github.com/gocobalt/cobalt-js/blob/
|
|
922
|
-
| <a id="slug-6"></a> `slug?` | `string` | The application's slug in which this workflow exists. | [cobalt.ts:209](https://github.com/gocobalt/cobalt-js/blob/
|
|
923
|
-
| <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [cobalt.ts:213](https://github.com/gocobalt/cobalt-js/blob/
|
|
919
|
+
| <a id="_id-2"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:203](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L203) |
|
|
920
|
+
| <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:211](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L211) |
|
|
921
|
+
| <a id="description-3"></a> `description?` | `string` | The workflow description. | [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L207) |
|
|
922
|
+
| <a id="name-7"></a> `name` | `string` | The workflow name. | [cobalt.ts:205](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L205) |
|
|
923
|
+
| <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:215](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L215) |
|
|
924
|
+
| <a id="slug-6"></a> `slug?` | `string` | The application's slug in which this workflow exists. | [cobalt.ts:209](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L209) |
|
|
925
|
+
| <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [cobalt.ts:213](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L213) |
|
|
924
926
|
|
|
925
927
|
***
|
|
926
928
|
|
|
927
929
|
### PublicWorkflowPayload
|
|
928
930
|
|
|
929
|
-
Defined in: [cobalt.ts:219](https://github.com/gocobalt/cobalt-js/blob/
|
|
931
|
+
Defined in: [cobalt.ts:219](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L219)
|
|
930
932
|
|
|
931
933
|
The payload for creating a public workflow for the linked account.
|
|
932
934
|
|
|
@@ -934,15 +936,15 @@ The payload for creating a public workflow for the linked account.
|
|
|
934
936
|
|
|
935
937
|
| Property | Type | Description | Defined in |
|
|
936
938
|
| ------ | ------ | ------ | ------ |
|
|
937
|
-
| <a id="description-4"></a> `description?` | `string` | The workflow description. | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/
|
|
938
|
-
| <a id="name-8"></a> `name` | `string` | The workflow name. | [cobalt.ts:221](https://github.com/gocobalt/cobalt-js/blob/
|
|
939
|
-
| <a id="slug-7"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/
|
|
939
|
+
| <a id="description-4"></a> `description?` | `string` | The workflow description. | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L223) |
|
|
940
|
+
| <a id="name-8"></a> `name` | `string` | The workflow name. | [cobalt.ts:221](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L221) |
|
|
941
|
+
| <a id="slug-7"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L225) |
|
|
940
942
|
|
|
941
943
|
***
|
|
942
944
|
|
|
943
945
|
### PublicWorkflowsPayload
|
|
944
946
|
|
|
945
|
-
Defined in: [cobalt.ts:229](https://github.com/gocobalt/cobalt-js/blob/
|
|
947
|
+
Defined in: [cobalt.ts:229](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L229)
|
|
946
948
|
|
|
947
949
|
Parameters for filtering and paginating the list of workflows.
|
|
948
950
|
|
|
@@ -960,43 +962,43 @@ Any additional filter keys supported by the API.
|
|
|
960
962
|
|
|
961
963
|
| Property | Type | Description | Inherited from | Defined in |
|
|
962
964
|
| ------ | ------ | ------ | ------ | ------ |
|
|
963
|
-
| <a id="end_date-2"></a> `end_date?` | `string` | Filter workflows created on or before this ISO 8601 date string. | - | [cobalt.ts:237](https://github.com/gocobalt/cobalt-js/blob/
|
|
964
|
-
| <a id="limit-1"></a> `limit?` | `number` | - | `PaginationProps.limit` | [cobalt.ts:246](https://github.com/gocobalt/cobalt-js/blob/
|
|
965
|
-
| <a id="name-9"></a> `name?` | `string` | Filter workflows by name (partial match). | - | [cobalt.ts:233](https://github.com/gocobalt/cobalt-js/blob/
|
|
966
|
-
| <a id="page-1"></a> `page?` | `number` | - | `PaginationProps.page` | [cobalt.ts:245](https://github.com/gocobalt/cobalt-js/blob/
|
|
967
|
-
| <a id="published-1"></a> `published?` | `boolean` | Filter by workflow published status. `true` returns only published workflows, `false` returns only drafts. | - | [cobalt.ts:239](https://github.com/gocobalt/cobalt-js/blob/
|
|
968
|
-
| <a id="slug-8"></a> `slug?` | `string` | Filter workflows by the application slug. | - | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/
|
|
969
|
-
| <a id="start_date-2"></a> `start_date?` | `string` | Filter workflows created on or after this ISO 8601 date string. | - | [cobalt.ts:235](https://github.com/gocobalt/cobalt-js/blob/
|
|
965
|
+
| <a id="end_date-2"></a> `end_date?` | `string` | Filter workflows created on or before this ISO 8601 date string. | - | [cobalt.ts:237](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L237) |
|
|
966
|
+
| <a id="limit-1"></a> `limit?` | `number` | - | `PaginationProps.limit` | [cobalt.ts:246](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L246) |
|
|
967
|
+
| <a id="name-9"></a> `name?` | `string` | Filter workflows by name (partial match). | - | [cobalt.ts:233](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L233) |
|
|
968
|
+
| <a id="page-1"></a> `page?` | `number` | - | `PaginationProps.page` | [cobalt.ts:245](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L245) |
|
|
969
|
+
| <a id="published-1"></a> `published?` | `boolean` | Filter by workflow published status. `true` returns only published workflows, `false` returns only drafts. | - | [cobalt.ts:239](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L239) |
|
|
970
|
+
| <a id="slug-8"></a> `slug?` | `string` | Filter workflows by the application slug. | - | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L231) |
|
|
971
|
+
| <a id="start_date-2"></a> `start_date?` | `string` | Filter workflows created on or after this ISO 8601 date string. | - | [cobalt.ts:235](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L235) |
|
|
970
972
|
|
|
971
973
|
***
|
|
972
974
|
|
|
973
975
|
### RuleOptions
|
|
974
976
|
|
|
975
|
-
Defined in: [cobalt.ts:180](https://github.com/gocobalt/cobalt-js/blob/
|
|
977
|
+
Defined in: [cobalt.ts:180](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L180)
|
|
976
978
|
|
|
977
979
|
#### Properties
|
|
978
980
|
|
|
979
981
|
| Property | Type | Defined in |
|
|
980
982
|
| ------ | ------ | ------ |
|
|
981
|
-
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:193](https://github.com/gocobalt/cobalt-js/blob/
|
|
982
|
-
| <a id="error"></a> `error?` | `object` | [cobalt.ts:194](https://github.com/gocobalt/cobalt-js/blob/
|
|
983
|
-
| `error.message?` | `string` | [cobalt.ts:195](https://github.com/gocobalt/cobalt-js/blob/
|
|
984
|
-
| `error.stack?` | `string` | [cobalt.ts:196](https://github.com/gocobalt/cobalt-js/blob/
|
|
985
|
-
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:181](https://github.com/gocobalt/cobalt-js/blob/
|
|
986
|
-
| `rule_column.operator` | `object` | [cobalt.ts:187](https://github.com/gocobalt/cobalt-js/blob/
|
|
987
|
-
| `rule_column.operator.name` | `string` | [cobalt.ts:188](https://github.com/gocobalt/cobalt-js/blob/
|
|
988
|
-
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:190](https://github.com/gocobalt/cobalt-js/blob/
|
|
989
|
-
| `rule_column.operator.type` | `"select"` | [cobalt.ts:189](https://github.com/gocobalt/cobalt-js/blob/
|
|
990
|
-
| `rule_column.rhs` | `object` | [cobalt.ts:182](https://github.com/gocobalt/cobalt-js/blob/
|
|
991
|
-
| `rule_column.rhs.name` | `string` | [cobalt.ts:183](https://github.com/gocobalt/cobalt-js/blob/
|
|
992
|
-
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:185](https://github.com/gocobalt/cobalt-js/blob/
|
|
993
|
-
| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:184](https://github.com/gocobalt/cobalt-js/blob/
|
|
983
|
+
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:193](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L193) |
|
|
984
|
+
| <a id="error"></a> `error?` | `object` | [cobalt.ts:194](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L194) |
|
|
985
|
+
| `error.message?` | `string` | [cobalt.ts:195](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L195) |
|
|
986
|
+
| `error.stack?` | `string` | [cobalt.ts:196](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L196) |
|
|
987
|
+
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:181](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L181) |
|
|
988
|
+
| `rule_column.operator` | `object` | [cobalt.ts:187](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L187) |
|
|
989
|
+
| `rule_column.operator.name` | `string` | [cobalt.ts:188](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L188) |
|
|
990
|
+
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:190](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L190) |
|
|
991
|
+
| `rule_column.operator.type` | `"select"` | [cobalt.ts:189](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L189) |
|
|
992
|
+
| `rule_column.rhs` | `object` | [cobalt.ts:182](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L182) |
|
|
993
|
+
| `rule_column.rhs.name` | `string` | [cobalt.ts:183](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L183) |
|
|
994
|
+
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:185](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L185) |
|
|
995
|
+
| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:184](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L184) |
|
|
994
996
|
|
|
995
997
|
***
|
|
996
998
|
|
|
997
999
|
### UpdateConfigPayload
|
|
998
1000
|
|
|
999
|
-
Defined in: [cobalt.ts:152](https://github.com/gocobalt/cobalt-js/blob/
|
|
1001
|
+
Defined in: [cobalt.ts:152](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L152)
|
|
1000
1002
|
|
|
1001
1003
|
The configuration data for an application.
|
|
1002
1004
|
|
|
@@ -1004,16 +1006,16 @@ The configuration data for an application.
|
|
|
1004
1006
|
|
|
1005
1007
|
| Property | Type | Description | Defined in |
|
|
1006
1008
|
| ------ | ------ | ------ | ------ |
|
|
1007
|
-
| <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:156](https://github.com/gocobalt/cobalt-js/blob/
|
|
1008
|
-
| <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [cobalt.ts:158](https://github.com/gocobalt/cobalt-js/blob/
|
|
1009
|
-
| <a id="slug-9"></a> `slug` | `string` | The application slug | [cobalt.ts:154](https://github.com/gocobalt/cobalt-js/blob/
|
|
1010
|
-
| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:160](https://github.com/gocobalt/cobalt-js/blob/
|
|
1009
|
+
| <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:156](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L156) |
|
|
1010
|
+
| <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [cobalt.ts:158](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L158) |
|
|
1011
|
+
| <a id="slug-9"></a> `slug` | `string` | The application slug | [cobalt.ts:154](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L154) |
|
|
1012
|
+
| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:160](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L160) |
|
|
1011
1013
|
|
|
1012
1014
|
***
|
|
1013
1015
|
|
|
1014
1016
|
### WorkflowPayload
|
|
1015
1017
|
|
|
1016
|
-
Defined in: [cobalt.ts:164](https://github.com/gocobalt/cobalt-js/blob/
|
|
1018
|
+
Defined in: [cobalt.ts:164](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L164)
|
|
1017
1019
|
|
|
1018
1020
|
The workflow.
|
|
1019
1021
|
|
|
@@ -1021,23 +1023,23 @@ The workflow.
|
|
|
1021
1023
|
|
|
1022
1024
|
| Property | Type | Description | Defined in |
|
|
1023
1025
|
| ------ | ------ | ------ | ------ |
|
|
1024
|
-
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:168](https://github.com/gocobalt/cobalt-js/blob/
|
|
1025
|
-
| <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [cobalt.ts:170](https://github.com/gocobalt/cobalt-js/blob/
|
|
1026
|
-
| <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:166](https://github.com/gocobalt/cobalt-js/blob/
|
|
1026
|
+
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:168](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L168) |
|
|
1027
|
+
| <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [cobalt.ts:170](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L170) |
|
|
1028
|
+
| <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:166](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L166) |
|
|
1027
1029
|
|
|
1028
1030
|
***
|
|
1029
1031
|
|
|
1030
1032
|
### WorkflowPayloadResponse
|
|
1031
1033
|
|
|
1032
|
-
Defined in: [cobalt.ts:336](https://github.com/gocobalt/cobalt-js/blob/
|
|
1034
|
+
Defined in: [cobalt.ts:336](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L336)
|
|
1033
1035
|
|
|
1034
1036
|
#### Properties
|
|
1035
1037
|
|
|
1036
1038
|
| Property | Type | Defined in |
|
|
1037
1039
|
| ------ | ------ | ------ |
|
|
1038
|
-
| <a id="payload-3"></a> `payload` | `Record`\<`string`, `any`\> | [cobalt.ts:337](https://github.com/gocobalt/cobalt-js/blob/
|
|
1039
|
-
| <a id="schema"></a> `schema?` | `unknown` | [cobalt.ts:338](https://github.com/gocobalt/cobalt-js/blob/
|
|
1040
|
-
| <a id="schema_interpreted"></a> `schema_interpreted?` | `unknown` | [cobalt.ts:339](https://github.com/gocobalt/cobalt-js/blob/
|
|
1040
|
+
| <a id="payload-3"></a> `payload` | `Record`\<`string`, `any`\> | [cobalt.ts:337](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L337) |
|
|
1041
|
+
| <a id="schema"></a> `schema?` | `unknown` | [cobalt.ts:338](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L338) |
|
|
1042
|
+
| <a id="schema_interpreted"></a> `schema_interpreted?` | `unknown` | [cobalt.ts:339](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L339) |
|
|
1041
1043
|
|
|
1042
1044
|
## Type Aliases
|
|
1043
1045
|
|
|
@@ -1045,7 +1047,7 @@ Defined in: [cobalt.ts:336](https://github.com/gocobalt/cobalt-js/blob/875971167
|
|
|
1045
1047
|
|
|
1046
1048
|
> **ExecutionSource** = `"Event"` \| `"Schedule"` \| `"API Call"`
|
|
1047
1049
|
|
|
1048
|
-
Defined in: [cobalt.ts:252](https://github.com/gocobalt/cobalt-js/blob/
|
|
1050
|
+
Defined in: [cobalt.ts:252](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L252)
|
|
1049
1051
|
|
|
1050
1052
|
The trigger source that initiated a workflow execution.
|
|
1051
1053
|
|
|
@@ -1055,7 +1057,7 @@ The trigger source that initiated a workflow execution.
|
|
|
1055
1057
|
|
|
1056
1058
|
> **ExecutionStatus** = `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"`
|
|
1057
1059
|
|
|
1058
|
-
Defined in: [cobalt.ts:250](https://github.com/gocobalt/cobalt-js/blob/
|
|
1060
|
+
Defined in: [cobalt.ts:250](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L250)
|
|
1059
1061
|
|
|
1060
1062
|
The current status of a workflow execution.
|
|
1061
1063
|
|
|
@@ -1065,6 +1067,6 @@ The current status of a workflow execution.
|
|
|
1065
1067
|
|
|
1066
1068
|
> **ExecutionType** = `"SYNC"` \| `"ASYNC"`
|
|
1067
1069
|
|
|
1068
|
-
Defined in: [cobalt.ts:254](https://github.com/gocobalt/cobalt-js/blob/
|
|
1070
|
+
Defined in: [cobalt.ts:254](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L254)
|
|
1069
1071
|
|
|
1070
1072
|
Whether a workflow execution runs synchronously (waits for result) or asynchronously (fire-and-forget).
|