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