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