@cobaltio/cobalt-js 9.3.0-beta.2 → 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/cobalt.d.ts +2 -1
- package/cobalt.js +5 -1
- package/cobalt.ts +5 -1
- package/docs/assets/icons.js +1 -1
- package/docs/assets/icons.svg +1 -1
- package/docs/assets/main.js +3 -3
- package/docs/classes/Cobalt.html +25 -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 +217 -218
- 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/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/71e906b72
|
|
|
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:819](https://github.com/gocobalt/cobalt-js/blob/
|
|
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
|
|
|
@@ -300,15 +300,13 @@ it returns all the enabled applications.
|
|
|
300
300
|
|
|
301
301
|
###### Param
|
|
302
302
|
|
|
303
|
-
**slug**
|
|
304
|
-
|
|
305
303
|
The application slug.
|
|
306
304
|
|
|
307
305
|
###### Call Signature
|
|
308
306
|
|
|
309
307
|
> **getApp**(): `Promise`\<[`Application`](#application)[]\>
|
|
310
308
|
|
|
311
|
-
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)
|
|
312
310
|
|
|
313
311
|
Returns the list of enabled applications and their details.
|
|
314
312
|
|
|
@@ -322,7 +320,7 @@ The list of applications.
|
|
|
322
320
|
|
|
323
321
|
> **getApp**(`slug`): `Promise`\<[`Application`](#application)\>
|
|
324
322
|
|
|
325
|
-
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)
|
|
326
324
|
|
|
327
325
|
Returns the application details for the specified application, provided
|
|
328
326
|
the application is enabled in Cobalt.
|
|
@@ -343,7 +341,7 @@ The application details.
|
|
|
343
341
|
|
|
344
342
|
> **getApps**(): `Promise`\<[`Application`](#application)[]\>
|
|
345
343
|
|
|
346
|
-
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)
|
|
347
345
|
|
|
348
346
|
Returns all the enabled apps.
|
|
349
347
|
|
|
@@ -357,7 +355,7 @@ The list of applications.
|
|
|
357
355
|
|
|
358
356
|
> **getAuthConfigs**(`slug`): `Promise`\<[`AuthConfig`](#authconfig)[]\>
|
|
359
357
|
|
|
360
|
-
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)
|
|
361
359
|
|
|
362
360
|
Returns the auth configs for the specified application.
|
|
363
361
|
|
|
@@ -377,7 +375,7 @@ The auth configs.
|
|
|
377
375
|
|
|
378
376
|
> **getConfig**(`slug`, `configId?`, `excludeOptions?`): `Promise`\<[`Config`](#config-1)\>
|
|
379
377
|
|
|
380
|
-
Defined in: [cobalt.ts:774](https://github.com/gocobalt/cobalt-js/blob/
|
|
378
|
+
Defined in: [cobalt.ts:774](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L774)
|
|
381
379
|
|
|
382
380
|
Returns the specified config.
|
|
383
381
|
|
|
@@ -397,9 +395,9 @@ The specified config.
|
|
|
397
395
|
|
|
398
396
|
##### getConfigField()
|
|
399
397
|
|
|
400
|
-
> **getConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<[`Config`](#config-1)\>
|
|
398
|
+
> **getConfigField**(`slug`, `fieldId`, `workflowId?`, `payload?`): `Promise`\<[`Config`](#config-1)\>
|
|
401
399
|
|
|
402
|
-
Defined in: [cobalt.ts:
|
|
400
|
+
Defined in: [cobalt.ts:843](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L843)
|
|
403
401
|
|
|
404
402
|
Returns the specified field of the config.
|
|
405
403
|
|
|
@@ -410,6 +408,7 @@ Returns the specified field of the config.
|
|
|
410
408
|
| `slug` | `string` | The application slug. |
|
|
411
409
|
| `fieldId` | `string` | The unique ID of the field. |
|
|
412
410
|
| `workflowId?` | `string` | The unique ID of the workflow. |
|
|
411
|
+
| `payload?` | `Record`\<`string`, `unknown`\> | The payload to be sent in the request body. |
|
|
413
412
|
|
|
414
413
|
###### Returns
|
|
415
414
|
|
|
@@ -421,7 +420,7 @@ The specified config field.
|
|
|
421
420
|
|
|
422
421
|
> **getConfigs**(`slug`): `Promise`\<`object`[]\>
|
|
423
422
|
|
|
424
|
-
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)
|
|
425
424
|
|
|
426
425
|
Returns the configs created for the specified application.
|
|
427
426
|
|
|
@@ -441,7 +440,7 @@ The configs created for the specified application.
|
|
|
441
440
|
|
|
442
441
|
> **getExecution**(`executionId`): `Promise`\<[`Execution`](#execution)\>
|
|
443
442
|
|
|
444
|
-
Defined in: [cobalt.ts:
|
|
443
|
+
Defined in: [cobalt.ts:1116](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L1116)
|
|
445
444
|
|
|
446
445
|
Returns the specified workflow execution log.
|
|
447
446
|
|
|
@@ -461,7 +460,7 @@ The specified execution log.
|
|
|
461
460
|
|
|
462
461
|
> **getExecutions**(`params?`): `Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
|
|
463
462
|
|
|
464
|
-
Defined in: [cobalt.ts:
|
|
463
|
+
Defined in: [cobalt.ts:1090](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L1090)
|
|
465
464
|
|
|
466
465
|
Returns the workflow execution logs for the linked account.
|
|
467
466
|
|
|
@@ -481,7 +480,7 @@ The paginated workflow execution logs.
|
|
|
481
480
|
|
|
482
481
|
> **getFieldOptions**(`lhs`, `slug`, `fieldId`, `workflowId?`): `Promise`\<[`RuleOptions`](#ruleoptions)\>
|
|
483
482
|
|
|
484
|
-
Defined in: [cobalt.ts:
|
|
483
|
+
Defined in: [cobalt.ts:921](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L921)
|
|
485
484
|
|
|
486
485
|
Returns the options for the specified field.
|
|
487
486
|
|
|
@@ -504,7 +503,7 @@ The specified rule field's options.
|
|
|
504
503
|
|
|
505
504
|
> **getWorkflowPayload**(`workflowId`): `Promise`\<[`WorkflowPayloadResponse`](#workflowpayloadresponse)\>
|
|
506
505
|
|
|
507
|
-
Defined in: [cobalt.ts:
|
|
506
|
+
Defined in: [cobalt.ts:1033](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L1033)
|
|
508
507
|
|
|
509
508
|
Returns the execution payload for the specified public workflow.
|
|
510
509
|
|
|
@@ -524,7 +523,7 @@ The workflow payload response.
|
|
|
524
523
|
|
|
525
524
|
> **getWorkflows**(`params?`): `Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
|
|
526
525
|
|
|
527
|
-
Defined in: [cobalt.ts:
|
|
526
|
+
Defined in: [cobalt.ts:954](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L954)
|
|
528
527
|
|
|
529
528
|
Returns the private workflows for the specified application.
|
|
530
529
|
|
|
@@ -542,7 +541,7 @@ Returns the private workflows for the specified application.
|
|
|
542
541
|
|
|
543
542
|
> **updateConfig**(`payload`): `Promise`\<[`Config`](#config-1)\>
|
|
544
543
|
|
|
545
|
-
Defined in: [cobalt.ts:795](https://github.com/gocobalt/cobalt-js/blob/
|
|
544
|
+
Defined in: [cobalt.ts:795](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L795)
|
|
546
545
|
|
|
547
546
|
Update the specified config.
|
|
548
547
|
|
|
@@ -562,7 +561,7 @@ The specified config.
|
|
|
562
561
|
|
|
563
562
|
> **updateConfigField**(`slug`, `fieldId`, `value`, `workflowId?`): `Promise`\<[`Config`](#config-1)\>
|
|
564
563
|
|
|
565
|
-
Defined in: [cobalt.ts:
|
|
564
|
+
Defined in: [cobalt.ts:870](https://github.com/gocobalt/cobalt-js/blob/f9d0a8764ac4e7df3a85e0f0d8e0609553d0b342/cobalt.ts#L870)
|
|
566
565
|
|
|
567
566
|
Update the specified config field value.
|
|
568
567
|
|
|
@@ -585,7 +584,7 @@ The updated config field.
|
|
|
585
584
|
|
|
586
585
|
### Application
|
|
587
586
|
|
|
588
|
-
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)
|
|
589
588
|
|
|
590
589
|
An application in Cobalt.
|
|
591
590
|
|
|
@@ -593,95 +592,95 @@ An application in Cobalt.
|
|
|
593
592
|
|
|
594
593
|
| Property | Type | Description | Defined in |
|
|
595
594
|
| ------ | ------ | ------ | ------ |
|
|
596
|
-
| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:34](https://github.com/gocobalt/cobalt-js/blob/
|
|
597
|
-
| <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/
|
|
598
|
-
| <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/
|
|
599
|
-
| <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) |
|
|
600
599
|
| `auth_type_options.keybased` | [`InputField`](#inputfield)[] | - | |
|
|
601
600
|
| `auth_type_options.oauth2` | [`InputField`](#inputfield)[] | - | |
|
|
602
|
-
| <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/
|
|
603
|
-
| <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/
|
|
604
|
-
| <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:38](https://github.com/gocobalt/cobalt-js/blob/
|
|
605
|
-
| <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:40](https://github.com/gocobalt/cobalt-js/blob/
|
|
606
|
-
| <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:36](https://github.com/gocobalt/cobalt-js/blob/
|
|
607
|
-
| <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/
|
|
608
|
-
| <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:47](https://github.com/gocobalt/cobalt-js/blob/
|
|
609
|
-
| <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:49](https://github.com/gocobalt/cobalt-js/blob/
|
|
610
|
-
| <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) |
|
|
611
610
|
|
|
612
611
|
***
|
|
613
612
|
|
|
614
613
|
### AuthConfig
|
|
615
614
|
|
|
616
|
-
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)
|
|
617
616
|
|
|
618
617
|
#### Properties
|
|
619
618
|
|
|
620
619
|
| Property | Type | Description | Defined in |
|
|
621
620
|
| ------ | ------ | ------ | ------ |
|
|
622
|
-
| <a id="_id"></a> `_id` | `string` | The auth config ID. | [cobalt.ts:81](https://github.com/gocobalt/cobalt-js/blob/
|
|
623
|
-
| <a id="description-1"></a> `description?` | `string` | The description of the auth config. | [cobalt.ts:85](https://github.com/gocobalt/cobalt-js/blob/
|
|
624
|
-
| <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/
|
|
625
|
-
| <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) |
|
|
626
625
|
|
|
627
626
|
***
|
|
628
627
|
|
|
629
628
|
### CobaltOptions
|
|
630
629
|
|
|
631
|
-
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)
|
|
632
631
|
|
|
633
632
|
#### Properties
|
|
634
633
|
|
|
635
634
|
| Property | Type | Description | Defined in |
|
|
636
635
|
| ------ | ------ | ------ | ------ |
|
|
637
|
-
| <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/
|
|
638
|
-
| <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) |
|
|
639
638
|
|
|
640
639
|
***
|
|
641
640
|
|
|
642
641
|
### Config
|
|
643
642
|
|
|
644
|
-
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)
|
|
645
644
|
|
|
646
645
|
#### Properties
|
|
647
646
|
|
|
648
647
|
| Property | Type | Defined in |
|
|
649
648
|
| ------ | ------ | ------ |
|
|
650
|
-
| <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:290](https://github.com/gocobalt/cobalt-js/blob/
|
|
651
|
-
| <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:293](https://github.com/gocobalt/cobalt-js/blob/
|
|
652
|
-
| <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:291](https://github.com/gocobalt/cobalt-js/blob/
|
|
653
|
-
| <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:289](https://github.com/gocobalt/cobalt-js/blob/
|
|
654
|
-
| <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) |
|
|
655
654
|
|
|
656
655
|
***
|
|
657
656
|
|
|
658
657
|
### ConfigField
|
|
659
658
|
|
|
660
|
-
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)
|
|
661
660
|
|
|
662
661
|
#### Properties
|
|
663
662
|
|
|
664
663
|
| Property | Type | Description | Defined in |
|
|
665
664
|
| ------ | ------ | ------ | ------ |
|
|
666
|
-
| <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/
|
|
667
|
-
| <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:306](https://github.com/gocobalt/cobalt-js/blob/
|
|
668
|
-
| <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:323](https://github.com/gocobalt/cobalt-js/blob/
|
|
669
|
-
| <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:318](https://github.com/gocobalt/cobalt-js/blob/
|
|
670
|
-
| <a id="id"></a> `id` | `string` | - | [cobalt.ts:304](https://github.com/gocobalt/cobalt-js/blob/
|
|
671
|
-
| <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:312](https://github.com/gocobalt/cobalt-js/blob/
|
|
672
|
-
| <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:316](https://github.com/gocobalt/cobalt-js/blob/
|
|
673
|
-
| <a id="name-2"></a> `name` | `string` | - | [cobalt.ts:305](https://github.com/gocobalt/cobalt-js/blob/
|
|
674
|
-
| <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:307](https://github.com/gocobalt/cobalt-js/blob/
|
|
675
|
-
| <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:311](https://github.com/gocobalt/cobalt-js/blob/
|
|
676
|
-
| <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:321](https://github.com/gocobalt/cobalt-js/blob/
|
|
677
|
-
| <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:317](https://github.com/gocobalt/cobalt-js/blob/
|
|
678
|
-
| <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) |
|
|
679
678
|
|
|
680
679
|
***
|
|
681
680
|
|
|
682
681
|
### ConfigPayload
|
|
683
682
|
|
|
684
|
-
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)
|
|
685
684
|
|
|
686
685
|
The payload object for config.
|
|
687
686
|
|
|
@@ -689,31 +688,31 @@ The payload object for config.
|
|
|
689
688
|
|
|
690
689
|
| Property | Type | Description | Defined in |
|
|
691
690
|
| ------ | ------ | ------ | ------ |
|
|
692
|
-
| <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:138](https://github.com/gocobalt/cobalt-js/blob/
|
|
693
|
-
| <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:140](https://github.com/gocobalt/cobalt-js/blob/
|
|
694
|
-
| <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) |
|
|
695
694
|
|
|
696
695
|
***
|
|
697
696
|
|
|
698
697
|
### ConfigWorkflow
|
|
699
698
|
|
|
700
|
-
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)
|
|
701
700
|
|
|
702
701
|
#### Properties
|
|
703
702
|
|
|
704
703
|
| Property | Type | Defined in |
|
|
705
704
|
| ------ | ------ | ------ |
|
|
706
|
-
| <a id="description-2"></a> `description?` | `string` | [cobalt.ts:331](https://github.com/gocobalt/cobalt-js/blob/
|
|
707
|
-
| <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:332](https://github.com/gocobalt/cobalt-js/blob/
|
|
708
|
-
| <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:333](https://github.com/gocobalt/cobalt-js/blob/
|
|
709
|
-
| <a id="id-1"></a> `id` | `string` | [cobalt.ts:329](https://github.com/gocobalt/cobalt-js/blob/
|
|
710
|
-
| <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) |
|
|
711
710
|
|
|
712
711
|
***
|
|
713
712
|
|
|
714
713
|
### ConnectedAccount
|
|
715
714
|
|
|
716
|
-
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)
|
|
717
716
|
|
|
718
717
|
A connected account for an application.
|
|
719
718
|
|
|
@@ -721,74 +720,74 @@ A connected account for an application.
|
|
|
721
720
|
|
|
722
721
|
| Property | Type | Description | Defined in |
|
|
723
722
|
| ------ | ------ | ------ | ------ |
|
|
724
|
-
| <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/
|
|
725
|
-
| <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/
|
|
726
|
-
| <a id="connectedat"></a> `connectedAt` | `string` | The timestamp at which the account was connected. | [cobalt.ts:26](https://github.com/gocobalt/cobalt-js/blob/
|
|
727
|
-
| <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/
|
|
728
|
-
| <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/
|
|
729
|
-
| <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) |
|
|
730
729
|
|
|
731
730
|
***
|
|
732
731
|
|
|
733
732
|
### ExecuteWorkflowPayload
|
|
734
733
|
|
|
735
|
-
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)
|
|
736
735
|
|
|
737
736
|
#### Properties
|
|
738
737
|
|
|
739
738
|
| Property | Type | Description | Defined in |
|
|
740
739
|
| ------ | ------ | ------ | ------ |
|
|
741
|
-
| <a id="payload"></a> `payload?` | `Record`\<`string`, `any`\> | The payload to execute the workflow. | [cobalt.ts:348](https://github.com/gocobalt/cobalt-js/blob/
|
|
742
|
-
| <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/
|
|
743
|
-
| <a id="sync_execution"></a> `sync_execution?` | `boolean` | Whether to execute the workflow synchronously. | [cobalt.ts:350](https://github.com/gocobalt/cobalt-js/blob/
|
|
744
|
-
| <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) |
|
|
745
744
|
|
|
746
745
|
***
|
|
747
746
|
|
|
748
747
|
### Execution
|
|
749
748
|
|
|
750
|
-
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)
|
|
751
750
|
|
|
752
751
|
#### Properties
|
|
753
752
|
|
|
754
753
|
| Property | Type | Defined in |
|
|
755
754
|
| ------ | ------ | ------ |
|
|
756
|
-
| <a id="_id-1"></a> `_id` | `string` | [cobalt.ts:354](https://github.com/gocobalt/cobalt-js/blob/
|
|
757
|
-
| <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:358](https://github.com/gocobalt/cobalt-js/blob/
|
|
758
|
-
| `associated_application._id` | `string` | [cobalt.ts:359](https://github.com/gocobalt/cobalt-js/blob/
|
|
759
|
-
| `associated_application.icon?` | `string` | [cobalt.ts:361](https://github.com/gocobalt/cobalt-js/blob/
|
|
760
|
-
| `associated_application.name` | `string` | [cobalt.ts:360](https://github.com/gocobalt/cobalt-js/blob/
|
|
761
|
-
| <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:382](https://github.com/gocobalt/cobalt-js/blob/
|
|
762
|
-
| <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:368](https://github.com/gocobalt/cobalt-js/blob/
|
|
763
|
-
| `associated_trigger_application._id` | `string` | [cobalt.ts:369](https://github.com/gocobalt/cobalt-js/blob/
|
|
764
|
-
| `associated_trigger_application.app_type?` | `string` | [cobalt.ts:372](https://github.com/gocobalt/cobalt-js/blob/
|
|
765
|
-
| `associated_trigger_application.icon?` | `string` | [cobalt.ts:371](https://github.com/gocobalt/cobalt-js/blob/
|
|
766
|
-
| `associated_trigger_application.name` | `string` | [cobalt.ts:370](https://github.com/gocobalt/cobalt-js/blob/
|
|
767
|
-
| `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:373](https://github.com/gocobalt/cobalt-js/blob/
|
|
768
|
-
| `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:374](https://github.com/gocobalt/cobalt-js/blob/
|
|
769
|
-
| `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:375](https://github.com/gocobalt/cobalt-js/blob/
|
|
770
|
-
| <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:364](https://github.com/gocobalt/cobalt-js/blob/
|
|
771
|
-
| `associated_workflow._id` | `string` | [cobalt.ts:365](https://github.com/gocobalt/cobalt-js/blob/
|
|
772
|
-
| `associated_workflow.name` | `string` | [cobalt.ts:366](https://github.com/gocobalt/cobalt-js/blob/
|
|
773
|
-
| <a id="completion_percentage"></a> `completion_percentage?` | `number` | [cobalt.ts:385](https://github.com/gocobalt/cobalt-js/blob/
|
|
774
|
-
| <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:381](https://github.com/gocobalt/cobalt-js/blob/
|
|
775
|
-
| <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:397](https://github.com/gocobalt/cobalt-js/blob/
|
|
776
|
-
| <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:384](https://github.com/gocobalt/cobalt-js/blob/
|
|
777
|
-
| <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:383](https://github.com/gocobalt/cobalt-js/blob/
|
|
778
|
-
| <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:380](https://github.com/gocobalt/cobalt-js/blob/
|
|
779
|
-
| <a id="id-2"></a> `id?` | `string` | [cobalt.ts:355](https://github.com/gocobalt/cobalt-js/blob/
|
|
780
|
-
| <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:379](https://github.com/gocobalt/cobalt-js/blob/
|
|
781
|
-
| <a id="name-4"></a> `name` | `string` | [cobalt.ts:356](https://github.com/gocobalt/cobalt-js/blob/
|
|
782
|
-
| <a id="nodes"></a> `nodes?` | `object`[] | [cobalt.ts:386](https://github.com/gocobalt/cobalt-js/blob/
|
|
783
|
-
| <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:357](https://github.com/gocobalt/cobalt-js/blob/
|
|
784
|
-
| <a id="status-1"></a> `status` | [`ExecutionStatus`](#executionstatus-1) | [cobalt.ts:363](https://github.com/gocobalt/cobalt-js/blob/
|
|
785
|
-
| <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) |
|
|
786
785
|
|
|
787
786
|
***
|
|
788
787
|
|
|
789
788
|
### ExecutionFilters
|
|
790
789
|
|
|
791
|
-
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)
|
|
792
791
|
|
|
793
792
|
Filters for narrowing down the list of workflow executions.
|
|
794
793
|
|
|
@@ -800,19 +799,19 @@ Filters for narrowing down the list of workflow executions.
|
|
|
800
799
|
|
|
801
800
|
| Property | Type | Description | Defined in |
|
|
802
801
|
| ------ | ------ | ------ | ------ |
|
|
803
|
-
| <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/
|
|
804
|
-
| <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/
|
|
805
|
-
| <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/
|
|
806
|
-
| <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/
|
|
807
|
-
| <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/
|
|
808
|
-
| <a id="workflow_id"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [cobalt.ts:263](https://github.com/gocobalt/cobalt-js/blob/
|
|
809
|
-
| <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) |
|
|
810
809
|
|
|
811
810
|
***
|
|
812
811
|
|
|
813
812
|
### GetExecutionsParams
|
|
814
813
|
|
|
815
|
-
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)
|
|
816
815
|
|
|
817
816
|
Parameters for filtering and paginating the list of workflow executions.
|
|
818
817
|
|
|
@@ -830,21 +829,21 @@ Any additional filter keys supported by the API.
|
|
|
830
829
|
|
|
831
830
|
| Property | Type | Description | Inherited from | Defined in |
|
|
832
831
|
| ------ | ------ | ------ | ------ | ------ |
|
|
833
|
-
| <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/
|
|
834
|
-
| <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/
|
|
835
|
-
| <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/
|
|
836
|
-
| <a id="limit"></a> `limit?` | `number` | - | `PaginationProps.limit` | [cobalt.ts:246](https://github.com/gocobalt/cobalt-js/blob/
|
|
837
|
-
| <a id="page"></a> `page?` | `number` | - | `PaginationProps.page` | [cobalt.ts:245](https://github.com/gocobalt/cobalt-js/blob/
|
|
838
|
-
| <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/
|
|
839
|
-
| <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/
|
|
840
|
-
| <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/
|
|
841
|
-
| <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) |
|
|
842
841
|
|
|
843
842
|
***
|
|
844
843
|
|
|
845
844
|
### InputField
|
|
846
845
|
|
|
847
|
-
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)
|
|
848
847
|
|
|
849
848
|
An Input field to take input from the user.
|
|
850
849
|
|
|
@@ -852,34 +851,34 @@ An Input field to take input from the user.
|
|
|
852
851
|
|
|
853
852
|
| Property | Type | Description | Defined in |
|
|
854
853
|
| ------ | ------ | ------ | ------ |
|
|
855
|
-
| <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/
|
|
856
|
-
| <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:103](https://github.com/gocobalt/cobalt-js/blob/
|
|
857
|
-
| <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:99](https://github.com/gocobalt/cobalt-js/blob/
|
|
858
|
-
| <a id="name-5"></a> `name` | `string` | Key name of the field. | [cobalt.ts:93](https://github.com/gocobalt/cobalt-js/blob/
|
|
859
|
-
| <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:107](https://github.com/gocobalt/cobalt-js/blob/
|
|
860
|
-
| <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:101](https://github.com/gocobalt/cobalt-js/blob/
|
|
861
|
-
| <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:97](https://github.com/gocobalt/cobalt-js/blob/
|
|
862
|
-
| <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) |
|
|
863
862
|
|
|
864
863
|
***
|
|
865
864
|
|
|
866
865
|
### KeyBasedParams
|
|
867
866
|
|
|
868
|
-
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)
|
|
869
868
|
|
|
870
869
|
#### Properties
|
|
871
870
|
|
|
872
871
|
| Property | Type | Description | Defined in |
|
|
873
872
|
| ------ | ------ | ------ | ------ |
|
|
874
|
-
| <a id="authconfig-1"></a> `authConfig?` | `string` | The identifier of the auth config. | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/
|
|
875
|
-
| <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/
|
|
876
|
-
| <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) |
|
|
877
876
|
|
|
878
877
|
***
|
|
879
878
|
|
|
880
879
|
### Label
|
|
881
880
|
|
|
882
|
-
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)
|
|
883
882
|
|
|
884
883
|
Label Mapping
|
|
885
884
|
|
|
@@ -887,29 +886,29 @@ Label Mapping
|
|
|
887
886
|
|
|
888
887
|
| Property | Type | Description | Defined in |
|
|
889
888
|
| ------ | ------ | ------ | ------ |
|
|
890
|
-
| <a id="name-6"></a> `name` | `string` | The label name. | [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/
|
|
891
|
-
| <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) |
|
|
892
891
|
|
|
893
892
|
***
|
|
894
893
|
|
|
895
894
|
### OAuthParams
|
|
896
895
|
|
|
897
|
-
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)
|
|
898
897
|
|
|
899
898
|
#### Properties
|
|
900
899
|
|
|
901
900
|
| Property | Type | Description | Defined in |
|
|
902
901
|
| ------ | ------ | ------ | ------ |
|
|
903
|
-
| <a id="authconfig-2"></a> `authConfig?` | `string` | The identifier of the auth config. | [cobalt.ts:117](https://github.com/gocobalt/cobalt-js/blob/
|
|
904
|
-
| <a id="autoclose"></a> `autoClose?` | `boolean` | Whether to close the authentication window automatically. | [cobalt.ts:121](https://github.com/gocobalt/cobalt-js/blob/
|
|
905
|
-
| <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/
|
|
906
|
-
| <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) |
|
|
907
906
|
|
|
908
907
|
***
|
|
909
908
|
|
|
910
909
|
### PublicWorkflow
|
|
911
910
|
|
|
912
|
-
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)
|
|
913
912
|
|
|
914
913
|
A public workflow in Cobalt.
|
|
915
914
|
|
|
@@ -917,19 +916,19 @@ A public workflow in Cobalt.
|
|
|
917
916
|
|
|
918
917
|
| Property | Type | Description | Defined in |
|
|
919
918
|
| ------ | ------ | ------ | ------ |
|
|
920
|
-
| <a id="_id-2"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:203](https://github.com/gocobalt/cobalt-js/blob/
|
|
921
|
-
| <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:211](https://github.com/gocobalt/cobalt-js/blob/
|
|
922
|
-
| <a id="description-3"></a> `description?` | `string` | The workflow description. | [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/
|
|
923
|
-
| <a id="name-7"></a> `name` | `string` | The workflow name. | [cobalt.ts:205](https://github.com/gocobalt/cobalt-js/blob/
|
|
924
|
-
| <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:215](https://github.com/gocobalt/cobalt-js/blob/
|
|
925
|
-
| <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/
|
|
926
|
-
| <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) |
|
|
927
926
|
|
|
928
927
|
***
|
|
929
928
|
|
|
930
929
|
### PublicWorkflowPayload
|
|
931
930
|
|
|
932
|
-
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)
|
|
933
932
|
|
|
934
933
|
The payload for creating a public workflow for the linked account.
|
|
935
934
|
|
|
@@ -937,15 +936,15 @@ The payload for creating a public workflow for the linked account.
|
|
|
937
936
|
|
|
938
937
|
| Property | Type | Description | Defined in |
|
|
939
938
|
| ------ | ------ | ------ | ------ |
|
|
940
|
-
| <a id="description-4"></a> `description?` | `string` | The workflow description. | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/
|
|
941
|
-
| <a id="name-8"></a> `name` | `string` | The workflow name. | [cobalt.ts:221](https://github.com/gocobalt/cobalt-js/blob/
|
|
942
|
-
| <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) |
|
|
943
942
|
|
|
944
943
|
***
|
|
945
944
|
|
|
946
945
|
### PublicWorkflowsPayload
|
|
947
946
|
|
|
948
|
-
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)
|
|
949
948
|
|
|
950
949
|
Parameters for filtering and paginating the list of workflows.
|
|
951
950
|
|
|
@@ -963,43 +962,43 @@ Any additional filter keys supported by the API.
|
|
|
963
962
|
|
|
964
963
|
| Property | Type | Description | Inherited from | Defined in |
|
|
965
964
|
| ------ | ------ | ------ | ------ | ------ |
|
|
966
|
-
| <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/
|
|
967
|
-
| <a id="limit-1"></a> `limit?` | `number` | - | `PaginationProps.limit` | [cobalt.ts:246](https://github.com/gocobalt/cobalt-js/blob/
|
|
968
|
-
| <a id="name-9"></a> `name?` | `string` | Filter workflows by name (partial match). | - | [cobalt.ts:233](https://github.com/gocobalt/cobalt-js/blob/
|
|
969
|
-
| <a id="page-1"></a> `page?` | `number` | - | `PaginationProps.page` | [cobalt.ts:245](https://github.com/gocobalt/cobalt-js/blob/
|
|
970
|
-
| <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/
|
|
971
|
-
| <a id="slug-8"></a> `slug?` | `string` | Filter workflows by the application slug. | - | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/
|
|
972
|
-
| <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) |
|
|
973
972
|
|
|
974
973
|
***
|
|
975
974
|
|
|
976
975
|
### RuleOptions
|
|
977
976
|
|
|
978
|
-
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)
|
|
979
978
|
|
|
980
979
|
#### Properties
|
|
981
980
|
|
|
982
981
|
| Property | Type | Defined in |
|
|
983
982
|
| ------ | ------ | ------ |
|
|
984
|
-
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:193](https://github.com/gocobalt/cobalt-js/blob/
|
|
985
|
-
| <a id="error"></a> `error?` | `object` | [cobalt.ts:194](https://github.com/gocobalt/cobalt-js/blob/
|
|
986
|
-
| `error.message?` | `string` | [cobalt.ts:195](https://github.com/gocobalt/cobalt-js/blob/
|
|
987
|
-
| `error.stack?` | `string` | [cobalt.ts:196](https://github.com/gocobalt/cobalt-js/blob/
|
|
988
|
-
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:181](https://github.com/gocobalt/cobalt-js/blob/
|
|
989
|
-
| `rule_column.operator` | `object` | [cobalt.ts:187](https://github.com/gocobalt/cobalt-js/blob/
|
|
990
|
-
| `rule_column.operator.name` | `string` | [cobalt.ts:188](https://github.com/gocobalt/cobalt-js/blob/
|
|
991
|
-
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:190](https://github.com/gocobalt/cobalt-js/blob/
|
|
992
|
-
| `rule_column.operator.type` | `"select"` | [cobalt.ts:189](https://github.com/gocobalt/cobalt-js/blob/
|
|
993
|
-
| `rule_column.rhs` | `object` | [cobalt.ts:182](https://github.com/gocobalt/cobalt-js/blob/
|
|
994
|
-
| `rule_column.rhs.name` | `string` | [cobalt.ts:183](https://github.com/gocobalt/cobalt-js/blob/
|
|
995
|
-
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:185](https://github.com/gocobalt/cobalt-js/blob/
|
|
996
|
-
| `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) |
|
|
997
996
|
|
|
998
997
|
***
|
|
999
998
|
|
|
1000
999
|
### UpdateConfigPayload
|
|
1001
1000
|
|
|
1002
|
-
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)
|
|
1003
1002
|
|
|
1004
1003
|
The configuration data for an application.
|
|
1005
1004
|
|
|
@@ -1007,16 +1006,16 @@ The configuration data for an application.
|
|
|
1007
1006
|
|
|
1008
1007
|
| Property | Type | Description | Defined in |
|
|
1009
1008
|
| ------ | ------ | ------ | ------ |
|
|
1010
|
-
| <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:156](https://github.com/gocobalt/cobalt-js/blob/
|
|
1011
|
-
| <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/
|
|
1012
|
-
| <a id="slug-9"></a> `slug` | `string` | The application slug | [cobalt.ts:154](https://github.com/gocobalt/cobalt-js/blob/
|
|
1013
|
-
| <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) |
|
|
1014
1013
|
|
|
1015
1014
|
***
|
|
1016
1015
|
|
|
1017
1016
|
### WorkflowPayload
|
|
1018
1017
|
|
|
1019
|
-
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)
|
|
1020
1019
|
|
|
1021
1020
|
The workflow.
|
|
1022
1021
|
|
|
@@ -1024,23 +1023,23 @@ The workflow.
|
|
|
1024
1023
|
|
|
1025
1024
|
| Property | Type | Description | Defined in |
|
|
1026
1025
|
| ------ | ------ | ------ | ------ |
|
|
1027
|
-
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:168](https://github.com/gocobalt/cobalt-js/blob/
|
|
1028
|
-
| <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/
|
|
1029
|
-
| <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) |
|
|
1030
1029
|
|
|
1031
1030
|
***
|
|
1032
1031
|
|
|
1033
1032
|
### WorkflowPayloadResponse
|
|
1034
1033
|
|
|
1035
|
-
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)
|
|
1036
1035
|
|
|
1037
1036
|
#### Properties
|
|
1038
1037
|
|
|
1039
1038
|
| Property | Type | Defined in |
|
|
1040
1039
|
| ------ | ------ | ------ |
|
|
1041
|
-
| <a id="payload-3"></a> `payload` | `Record`\<`string`, `any`\> | [cobalt.ts:337](https://github.com/gocobalt/cobalt-js/blob/
|
|
1042
|
-
| <a id="schema"></a> `schema?` | `unknown` | [cobalt.ts:338](https://github.com/gocobalt/cobalt-js/blob/
|
|
1043
|
-
| <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) |
|
|
1044
1043
|
|
|
1045
1044
|
## Type Aliases
|
|
1046
1045
|
|
|
@@ -1048,7 +1047,7 @@ Defined in: [cobalt.ts:336](https://github.com/gocobalt/cobalt-js/blob/71e906b72
|
|
|
1048
1047
|
|
|
1049
1048
|
> **ExecutionSource** = `"Event"` \| `"Schedule"` \| `"API Call"`
|
|
1050
1049
|
|
|
1051
|
-
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)
|
|
1052
1051
|
|
|
1053
1052
|
The trigger source that initiated a workflow execution.
|
|
1054
1053
|
|
|
@@ -1058,7 +1057,7 @@ The trigger source that initiated a workflow execution.
|
|
|
1058
1057
|
|
|
1059
1058
|
> **ExecutionStatus** = `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"`
|
|
1060
1059
|
|
|
1061
|
-
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)
|
|
1062
1061
|
|
|
1063
1062
|
The current status of a workflow execution.
|
|
1064
1063
|
|
|
@@ -1068,6 +1067,6 @@ The current status of a workflow execution.
|
|
|
1068
1067
|
|
|
1069
1068
|
> **ExecutionType** = `"SYNC"` \| `"ASYNC"`
|
|
1070
1069
|
|
|
1071
|
-
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)
|
|
1072
1071
|
|
|
1073
1072
|
Whether a workflow execution runs synchronously (waits for result) or asynchronously (fire-and-forget).
|