@cobaltio/cobalt-js 9.2.0-beta.5 → 9.2.0
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 +62 -49
- package/cobalt.js +422 -365
- package/cobalt.ts +101 -121
- 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 +42 -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 +16 -17
- 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 +260 -229
- 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/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/100d8c1b5f12564b62e0d54af1b32d158a635668/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/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L11) |
|
|
80
|
+
| <a id="enumeration-member-expired"></a> `Expired` | `"expired"` | [cobalt.ts:12](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/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/100d8c1b5f12564b62e0d54af1b32d158a635668/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/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L7) |
|
|
95
|
+
| <a id="enumeration-member-oauth2"></a> `OAuth2` | `"oauth2"` | [cobalt.ts:6](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/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/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L364)
|
|
102
102
|
|
|
103
103
|
#### Constructors
|
|
104
104
|
|
|
@@ -106,7 +106,7 @@ Defined in: [cobalt.ts:354](https://github.com/gocobalt/cobalt-js/blob/f9c4cac42
|
|
|
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/100d8c1b5f12564b62e0d54af1b32d158a635668/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/100d8c1b5f12564b62e0d54af1b32d158a635668/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/100d8c1b5f12564b62e0d54af1b32d158a635668/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/100d8c1b5f12564b62e0d54af1b32d158a635668/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:890](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L890)
|
|
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:729](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L729)
|
|
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:802](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L802)
|
|
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:918](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L918)
|
|
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/100d8c1b5f12564b62e0d54af1b32d158a635668/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:962](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L962)
|
|
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/100d8c1b5f12564b62e0d54af1b32d158a635668/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/100d8c1b5f12564b62e0d54af1b32d158a635668/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/100d8c1b5f12564b62e0d54af1b32d158a635668/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:480](https://github.com/gocobalt/cobalt-js/blob/f9c4cac4281e323329085886549cd5d1a1ca8176/cobalt.ts#L480)
|
|
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
353
|
> **getConfig**(`slug`, `configId?`): `Promise`\<[`Config`](#config-1)\>
|
|
377
354
|
|
|
378
|
-
Defined in: [cobalt.ts:
|
|
355
|
+
Defined in: [cobalt.ts:685](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L685)
|
|
379
356
|
|
|
380
357
|
Returns the specified config.
|
|
381
358
|
|
|
@@ -396,7 +373,7 @@ The specified config.
|
|
|
396
373
|
|
|
397
374
|
> **getConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<[`Config`](#config-1)\>
|
|
398
375
|
|
|
399
|
-
Defined in: [cobalt.ts:
|
|
376
|
+
Defined in: [cobalt.ts:752](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L752)
|
|
400
377
|
|
|
401
378
|
Returns the specified field of the config.
|
|
402
379
|
|
|
@@ -418,7 +395,7 @@ The specified config field.
|
|
|
418
395
|
|
|
419
396
|
> **getConfigs**(`slug`): `Promise`\<`object`[]\>
|
|
420
397
|
|
|
421
|
-
Defined in: [cobalt.ts:
|
|
398
|
+
Defined in: [cobalt.ts:664](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L664)
|
|
422
399
|
|
|
423
400
|
Returns the configs created for the specified application.
|
|
424
401
|
|
|
@@ -438,7 +415,7 @@ The configs created for the specified application.
|
|
|
438
415
|
|
|
439
416
|
> **getExecution**(`executionId`): `Promise`\<[`Execution`](#execution)\>
|
|
440
417
|
|
|
441
|
-
Defined in: [cobalt.ts:
|
|
418
|
+
Defined in: [cobalt.ts:1022](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L1022)
|
|
442
419
|
|
|
443
420
|
Returns the specified workflow execution log.
|
|
444
421
|
|
|
@@ -458,7 +435,7 @@ The specified execution log.
|
|
|
458
435
|
|
|
459
436
|
> **getExecutions**(`params?`): `Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
|
|
460
437
|
|
|
461
|
-
Defined in: [cobalt.ts:
|
|
438
|
+
Defined in: [cobalt.ts:996](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L996)
|
|
462
439
|
|
|
463
440
|
Returns the workflow execution logs for the linked account.
|
|
464
441
|
|
|
@@ -466,7 +443,7 @@ Returns the workflow execution logs for the linked account.
|
|
|
466
443
|
|
|
467
444
|
| Parameter | Type | Description |
|
|
468
445
|
| ------ | ------ | ------ |
|
|
469
|
-
| `params?` | `
|
|
446
|
+
| `params?` | [`GetExecutionsParams`](#getexecutionsparams) | - |
|
|
470
447
|
|
|
471
448
|
###### Returns
|
|
472
449
|
|
|
@@ -478,7 +455,7 @@ The paginated workflow execution logs.
|
|
|
478
455
|
|
|
479
456
|
> **getFieldOptions**(`lhs`, `slug`, `fieldId`, `workflowId?`): `Promise`\<[`RuleOptions`](#ruleoptions)\>
|
|
480
457
|
|
|
481
|
-
Defined in: [cobalt.ts:
|
|
458
|
+
Defined in: [cobalt.ts:827](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L827)
|
|
482
459
|
|
|
483
460
|
Returns the options for the specified field.
|
|
484
461
|
|
|
@@ -501,7 +478,7 @@ The specified rule field's options.
|
|
|
501
478
|
|
|
502
479
|
> **getWorkflowPayload**(`workflowId`): `Promise`\<[`WorkflowPayloadResponse`](#workflowpayloadresponse)\>
|
|
503
480
|
|
|
504
|
-
Defined in: [cobalt.ts:
|
|
481
|
+
Defined in: [cobalt.ts:939](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L939)
|
|
505
482
|
|
|
506
483
|
Returns the execution payload for the specified public workflow.
|
|
507
484
|
|
|
@@ -521,7 +498,7 @@ The workflow payload response.
|
|
|
521
498
|
|
|
522
499
|
> **getWorkflows**(`params?`): `Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
|
|
523
500
|
|
|
524
|
-
Defined in: [cobalt.ts:
|
|
501
|
+
Defined in: [cobalt.ts:860](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L860)
|
|
525
502
|
|
|
526
503
|
Returns the private workflows for the specified application.
|
|
527
504
|
|
|
@@ -529,7 +506,7 @@ Returns the private workflows for the specified application.
|
|
|
529
506
|
|
|
530
507
|
| Parameter | Type | Description |
|
|
531
508
|
| ------ | ------ | ------ |
|
|
532
|
-
| `params
|
|
509
|
+
| `params` | [`PublicWorkflowsPayload`](#publicworkflowspayload) | - |
|
|
533
510
|
|
|
534
511
|
###### Returns
|
|
535
512
|
|
|
@@ -539,7 +516,7 @@ Returns the private workflows for the specified application.
|
|
|
539
516
|
|
|
540
517
|
> **updateConfig**(`payload`): `Promise`\<[`Config`](#config-1)\>
|
|
541
518
|
|
|
542
|
-
Defined in: [cobalt.ts:
|
|
519
|
+
Defined in: [cobalt.ts:705](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L705)
|
|
543
520
|
|
|
544
521
|
Update the specified config.
|
|
545
522
|
|
|
@@ -559,7 +536,7 @@ The specified config.
|
|
|
559
536
|
|
|
560
537
|
> **updateConfigField**(`slug`, `fieldId`, `value`, `workflowId?`): `Promise`\<[`Config`](#config-1)\>
|
|
561
538
|
|
|
562
|
-
Defined in: [cobalt.ts:
|
|
539
|
+
Defined in: [cobalt.ts:776](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L776)
|
|
563
540
|
|
|
564
541
|
Update the specified config field value.
|
|
565
542
|
|
|
@@ -582,7 +559,7 @@ The updated config field.
|
|
|
582
559
|
|
|
583
560
|
### Application
|
|
584
561
|
|
|
585
|
-
Defined in: [cobalt.ts:16](https://github.com/gocobalt/cobalt-js/blob/
|
|
562
|
+
Defined in: [cobalt.ts:16](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L16)
|
|
586
563
|
|
|
587
564
|
An application in Cobalt.
|
|
588
565
|
|
|
@@ -590,95 +567,80 @@ An application in Cobalt.
|
|
|
590
567
|
|
|
591
568
|
| Property | Type | Description | Defined in |
|
|
592
569
|
| ------ | ------ | ------ | ------ |
|
|
593
|
-
| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:18](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:
|
|
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:35](https://github.com/gocobalt/cobalt-js/blob/
|
|
570
|
+
| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:18](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L18) |
|
|
571
|
+
| <a id="auth_input_map"></a> ~~`auth_input_map?`~~ | [`InputField`](#inputfield)[] | The fields required from the user to connect the application (for `keybased` auth type). **Deprecated** Check `auth_type_options` for multiple auth types support. | [cobalt.ts:69](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L69) |
|
|
572
|
+
| <a id="auth_type"></a> ~~`auth_type`~~ | `"oauth2"` \| `"keybased"` | The type of auth used by application. **Deprecated** Check `auth_type_options` and `connected_accounts` for multiple auth types support. | [cobalt.ts:54](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L54) |
|
|
573
|
+
| <a id="auth_type_options"></a> `auth_type_options?` | `object` | The supported auth types for the application, and the fields required from the user to connect the application. | [cobalt.ts:35](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L35) |
|
|
597
574
|
| `auth_type_options.keybased` | [`InputField`](#inputfield)[] | - | |
|
|
598
575
|
| `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?` | `object`[] | The list of connected accounts for this application | [cobalt.ts:40](https://github.com/gocobalt/cobalt-js/blob/
|
|
601
|
-
| <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:22](https://github.com/gocobalt/cobalt-js/blob/
|
|
602
|
-
| <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:24](https://github.com/gocobalt/cobalt-js/blob/
|
|
603
|
-
| <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:20](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:
|
|
605
|
-
| <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:31](https://github.com/gocobalt/cobalt-js/blob/
|
|
606
|
-
| <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:33](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:29](https://github.com/gocobalt/cobalt-js/blob/
|
|
608
|
-
|
|
609
|
-
***
|
|
610
|
-
|
|
611
|
-
### AuthConfig
|
|
612
|
-
|
|
613
|
-
Defined in: [cobalt.ts:74](https://github.com/gocobalt/cobalt-js/blob/f9c4cac4281e323329085886549cd5d1a1ca8176/cobalt.ts#L74)
|
|
614
|
-
|
|
615
|
-
#### Properties
|
|
616
|
-
|
|
617
|
-
| Property | Type | Description | Defined in |
|
|
618
|
-
| ------ | ------ | ------ | ------ |
|
|
619
|
-
| <a id="_id"></a> `_id` | `string` | The auth config ID. | [cobalt.ts:76](https://github.com/gocobalt/cobalt-js/blob/f9c4cac4281e323329085886549cd5d1a1ca8176/cobalt.ts#L76) |
|
|
620
|
-
| <a id="description-1"></a> `description?` | `string` | The description of the auth config. | [cobalt.ts:80](https://github.com/gocobalt/cobalt-js/blob/f9c4cac4281e323329085886549cd5d1a1ca8176/cobalt.ts#L80) |
|
|
621
|
-
| <a id="is_default"></a> `is_default?` | `boolean` | Whether the auth config is the default auth config for the application. | [cobalt.ts:82](https://github.com/gocobalt/cobalt-js/blob/f9c4cac4281e323329085886549cd5d1a1ca8176/cobalt.ts#L82) |
|
|
622
|
-
| <a id="name-1"></a> `name` | `string` | The display name of the auth config. | [cobalt.ts:78](https://github.com/gocobalt/cobalt-js/blob/f9c4cac4281e323329085886549cd5d1a1ca8176/cobalt.ts#L78) |
|
|
576
|
+
| <a id="connected"></a> ~~`connected?`~~ | `boolean` | Whether the user has connected the application. **Deprecated** Check `connected_accounts` for multiple auth types support. | [cobalt.ts:59](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L59) |
|
|
577
|
+
| <a id="connected_accounts"></a> `connected_accounts?` | `object`[] | The list of connected accounts for this application | [cobalt.ts:40](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L40) |
|
|
578
|
+
| <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:22](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L22) |
|
|
579
|
+
| <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:24](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L24) |
|
|
580
|
+
| <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:20](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L20) |
|
|
581
|
+
| <a id="reauth_required"></a> ~~`reauth_required?`~~ | `boolean` | Whether the connection has expired and re-auth is required. **Deprecated** Check `connected_accounts` for multiple auth types support. | [cobalt.ts:64](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L64) |
|
|
582
|
+
| <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:31](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L31) |
|
|
583
|
+
| <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:33](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L33) |
|
|
584
|
+
| <a id="type"></a> ~~`type`~~ | `string` | **Deprecated** Use `slug` instead. The application slug for native apps and `custom` for custom apps. | [cobalt.ts:29](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L29) |
|
|
623
585
|
|
|
624
586
|
***
|
|
625
587
|
|
|
626
588
|
### CobaltOptions
|
|
627
589
|
|
|
628
|
-
Defined in: [cobalt.ts:
|
|
590
|
+
Defined in: [cobalt.ts:135](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L135)
|
|
629
591
|
|
|
630
592
|
#### Properties
|
|
631
593
|
|
|
632
594
|
| Property | Type | Description | Defined in |
|
|
633
595
|
| ------ | ------ | ------ | ------ |
|
|
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:
|
|
596
|
+
| <a id="baseurl"></a> `baseUrl?` | `string` | The base URL of the Cobalt API. You don't need to set this. | [cobalt.ts:137](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L137) |
|
|
597
|
+
| <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:139](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L139) |
|
|
636
598
|
|
|
637
599
|
***
|
|
638
600
|
|
|
639
601
|
### Config
|
|
640
602
|
|
|
641
|
-
Defined in: [cobalt.ts:
|
|
603
|
+
Defined in: [cobalt.ts:250](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L250)
|
|
642
604
|
|
|
643
605
|
#### Properties
|
|
644
606
|
|
|
645
607
|
| Property | Type | Defined in |
|
|
646
608
|
| ------ | ------ | ------ |
|
|
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:
|
|
609
|
+
| <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:252](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L252) |
|
|
610
|
+
| <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:255](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L255) |
|
|
611
|
+
| <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:253](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L253) |
|
|
612
|
+
| <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:251](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L251) |
|
|
613
|
+
| <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:254](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L254) |
|
|
652
614
|
|
|
653
615
|
***
|
|
654
616
|
|
|
655
617
|
### ConfigField
|
|
656
618
|
|
|
657
|
-
Defined in: [cobalt.ts:
|
|
619
|
+
Defined in: [cobalt.ts:265](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L265)
|
|
658
620
|
|
|
659
621
|
#### Properties
|
|
660
622
|
|
|
661
623
|
| Property | Type | Description | Defined in |
|
|
662
624
|
| ------ | ------ | ------ | ------ |
|
|
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:
|
|
625
|
+
| <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:287](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L287) |
|
|
626
|
+
| <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:268](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L268) |
|
|
627
|
+
| <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:285](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L285) |
|
|
628
|
+
| <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:280](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L280) |
|
|
629
|
+
| <a id="id"></a> `id` | `string` | - | [cobalt.ts:266](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L266) |
|
|
630
|
+
| <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:274](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L274) |
|
|
631
|
+
| <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:278](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L278) |
|
|
632
|
+
| <a id="name-1"></a> `name` | `string` | - | [cobalt.ts:267](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L267) |
|
|
633
|
+
| <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:269](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L269) |
|
|
634
|
+
| <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:273](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L273) |
|
|
635
|
+
| <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:283](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L283) |
|
|
636
|
+
| <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:279](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L279) |
|
|
637
|
+
| <a id="value"></a> `value?` | `any` | - | [cobalt.ts:281](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L281) |
|
|
676
638
|
|
|
677
639
|
***
|
|
678
640
|
|
|
679
641
|
### ConfigPayload
|
|
680
642
|
|
|
681
|
-
Defined in: [cobalt.ts:
|
|
643
|
+
Defined in: [cobalt.ts:96](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L96)
|
|
682
644
|
|
|
683
645
|
The payload object for config.
|
|
684
646
|
|
|
@@ -686,152 +648,179 @@ The payload object for config.
|
|
|
686
648
|
|
|
687
649
|
| Property | Type | Description | Defined in |
|
|
688
650
|
| ------ | ------ | ------ | ------ |
|
|
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:
|
|
651
|
+
| <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:100](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L100) |
|
|
652
|
+
| <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:102](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L102) |
|
|
653
|
+
| <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:98](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L98) |
|
|
692
654
|
|
|
693
655
|
***
|
|
694
656
|
|
|
695
657
|
### ConfigWorkflow
|
|
696
658
|
|
|
697
|
-
Defined in: [cobalt.ts:
|
|
659
|
+
Defined in: [cobalt.ts:290](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L290)
|
|
698
660
|
|
|
699
661
|
#### Properties
|
|
700
662
|
|
|
701
663
|
| Property | Type | Defined in |
|
|
702
664
|
| ------ | ------ | ------ |
|
|
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-
|
|
665
|
+
| <a id="description-1"></a> `description?` | `string` | [cobalt.ts:293](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L293) |
|
|
666
|
+
| <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:294](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L294) |
|
|
667
|
+
| <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:295](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L295) |
|
|
668
|
+
| <a id="id-1"></a> `id` | `string` | [cobalt.ts:291](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L291) |
|
|
669
|
+
| <a id="name-2"></a> `name` | `string` | [cobalt.ts:292](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L292) |
|
|
708
670
|
|
|
709
671
|
***
|
|
710
672
|
|
|
711
673
|
### ExecuteWorkflowPayload
|
|
712
674
|
|
|
713
|
-
Defined in: [cobalt.ts:
|
|
675
|
+
Defined in: [cobalt.ts:304](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L304)
|
|
714
676
|
|
|
715
677
|
#### Properties
|
|
716
678
|
|
|
717
679
|
| Property | Type | Description | Defined in |
|
|
718
680
|
| ------ | ------ | ------ | ------ |
|
|
719
|
-
| <a id="payload"></a> `payload?` | `Record`\<`string`, `any`\> | The payload to execute the workflow. | [cobalt.ts:
|
|
720
|
-
| <a id="slug-3"></a> `slug?` | `string` | The application's slug this workflow belongs to. | [cobalt.ts:
|
|
721
|
-
| <a id="sync_execution"></a> `sync_execution?` | `boolean` | Whether to execute the workflow synchronously. | [cobalt.ts:
|
|
722
|
-
| <a id="worklfow"></a> `worklfow` | `string` | The workflow id or alias. | [cobalt.ts:
|
|
681
|
+
| <a id="payload"></a> `payload?` | `Record`\<`string`, `any`\> | The payload to execute the workflow. | [cobalt.ts:310](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L310) |
|
|
682
|
+
| <a id="slug-3"></a> `slug?` | `string` | The application's slug this workflow belongs to. | [cobalt.ts:308](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L308) |
|
|
683
|
+
| <a id="sync_execution"></a> `sync_execution?` | `boolean` | Whether to execute the workflow synchronously. | [cobalt.ts:312](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L312) |
|
|
684
|
+
| <a id="worklfow"></a> `worklfow` | `string` | The workflow id or alias. | [cobalt.ts:306](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L306) |
|
|
723
685
|
|
|
724
686
|
***
|
|
725
687
|
|
|
726
688
|
### Execution
|
|
727
689
|
|
|
728
|
-
Defined in: [cobalt.ts:
|
|
690
|
+
Defined in: [cobalt.ts:315](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L315)
|
|
729
691
|
|
|
730
692
|
#### Properties
|
|
731
693
|
|
|
732
694
|
| Property | Type | Defined in |
|
|
733
695
|
| ------ | ------ | ------ |
|
|
734
|
-
| <a id="_id
|
|
735
|
-
| <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:
|
|
736
|
-
| `associated_application._id` | `string` | [cobalt.ts:
|
|
737
|
-
| `associated_application.icon?` | `string` | [cobalt.ts:
|
|
738
|
-
| `associated_application.name` | `string` | [cobalt.ts:
|
|
739
|
-
| <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:
|
|
740
|
-
| <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:
|
|
741
|
-
| `associated_trigger_application._id` | `string` | [cobalt.ts:
|
|
742
|
-
| `associated_trigger_application.app_type?` | `string` | [cobalt.ts:
|
|
743
|
-
| `associated_trigger_application.icon?` | `string` | [cobalt.ts:
|
|
744
|
-
| `associated_trigger_application.name` | `string` | [cobalt.ts:
|
|
745
|
-
| `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:
|
|
746
|
-
| `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:
|
|
747
|
-
| `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:
|
|
748
|
-
| <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:
|
|
749
|
-
| `associated_workflow._id` | `string` | [cobalt.ts:
|
|
750
|
-
| `associated_workflow.name` | `string` | [cobalt.ts:
|
|
751
|
-
| <a id="completion_percentage"></a> `completion_percentage?` | `number` | [cobalt.ts:
|
|
752
|
-
| <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:
|
|
753
|
-
| <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:
|
|
754
|
-
| <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:
|
|
755
|
-
| <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:
|
|
756
|
-
| <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:
|
|
757
|
-
| <a id="id-2"></a> `id?` | `string` | [cobalt.ts:
|
|
758
|
-
| <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:
|
|
759
|
-
| <a id="name-
|
|
760
|
-
| <a id="nodes"></a> `nodes?` | `object`[] | [cobalt.ts:
|
|
761
|
-
| <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:
|
|
762
|
-
| <a id="status"></a> `status` | `
|
|
763
|
-
| <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:
|
|
696
|
+
| <a id="_id"></a> `_id` | `string` | [cobalt.ts:316](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L316) |
|
|
697
|
+
| <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:320](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L320) |
|
|
698
|
+
| `associated_application._id` | `string` | [cobalt.ts:321](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L321) |
|
|
699
|
+
| `associated_application.icon?` | `string` | [cobalt.ts:323](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L323) |
|
|
700
|
+
| `associated_application.name` | `string` | [cobalt.ts:322](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L322) |
|
|
701
|
+
| <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:344](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L344) |
|
|
702
|
+
| <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:330](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L330) |
|
|
703
|
+
| `associated_trigger_application._id` | `string` | [cobalt.ts:331](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L331) |
|
|
704
|
+
| `associated_trigger_application.app_type?` | `string` | [cobalt.ts:334](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L334) |
|
|
705
|
+
| `associated_trigger_application.icon?` | `string` | [cobalt.ts:333](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L333) |
|
|
706
|
+
| `associated_trigger_application.name` | `string` | [cobalt.ts:332](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L332) |
|
|
707
|
+
| `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:335](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L335) |
|
|
708
|
+
| `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:336](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L336) |
|
|
709
|
+
| `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:337](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L337) |
|
|
710
|
+
| <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:326](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L326) |
|
|
711
|
+
| `associated_workflow._id` | `string` | [cobalt.ts:327](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L327) |
|
|
712
|
+
| `associated_workflow.name` | `string` | [cobalt.ts:328](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L328) |
|
|
713
|
+
| <a id="completion_percentage"></a> `completion_percentage?` | `number` | [cobalt.ts:347](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L347) |
|
|
714
|
+
| <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:343](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L343) |
|
|
715
|
+
| <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:359](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L359) |
|
|
716
|
+
| <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:346](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L346) |
|
|
717
|
+
| <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:345](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L345) |
|
|
718
|
+
| <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:342](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L342) |
|
|
719
|
+
| <a id="id-2"></a> `id?` | `string` | [cobalt.ts:317](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L317) |
|
|
720
|
+
| <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:341](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L341) |
|
|
721
|
+
| <a id="name-3"></a> `name` | `string` | [cobalt.ts:318](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L318) |
|
|
722
|
+
| <a id="nodes"></a> `nodes?` | `object`[] | [cobalt.ts:348](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L348) |
|
|
723
|
+
| <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:319](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L319) |
|
|
724
|
+
| <a id="status"></a> `status` | [`ExecutionStatus`](#executionstatus-1) | [cobalt.ts:325](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L325) |
|
|
725
|
+
| <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:340](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L340) |
|
|
764
726
|
|
|
765
727
|
***
|
|
766
728
|
|
|
767
|
-
###
|
|
729
|
+
### ExecutionFilters
|
|
768
730
|
|
|
769
|
-
Defined in: [cobalt.ts:
|
|
731
|
+
Defined in: [cobalt.ts:219](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L219)
|
|
770
732
|
|
|
771
|
-
|
|
733
|
+
Filters for narrowing down the list of workflow executions.
|
|
734
|
+
|
|
735
|
+
#### Extended by
|
|
736
|
+
|
|
737
|
+
- [`GetExecutionsParams`](#getexecutionsparams)
|
|
772
738
|
|
|
773
739
|
#### Properties
|
|
774
740
|
|
|
775
741
|
| Property | Type | Description | Defined in |
|
|
776
742
|
| ------ | ------ | ------ | ------ |
|
|
777
|
-
| <a id="
|
|
778
|
-
| <a id="
|
|
779
|
-
| <a id="
|
|
780
|
-
| <a id="
|
|
781
|
-
| <a id="
|
|
782
|
-
| <a id="
|
|
783
|
-
| <a id="
|
|
784
|
-
| <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:90](https://github.com/gocobalt/cobalt-js/blob/f9c4cac4281e323329085886549cd5d1a1ca8176/cobalt.ts#L90) |
|
|
743
|
+
| <a id="end_date"></a> `end_date?` | `string` | Filter executions that started on or before this ISO 8601 date string. | [cobalt.ts:229](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L229) |
|
|
744
|
+
| <a id="execution_source"></a> `execution_source?` | [`ExecutionSource`](#executionsource) | Filter by the trigger source that initiated the execution. | [cobalt.ts:233](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L233) |
|
|
745
|
+
| <a id="execution_type"></a> `execution_type?` | [`ExecutionType`](#executiontype) | Filter by how the execution was invoked — synchronously or asynchronously. | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L231) |
|
|
746
|
+
| <a id="start_date"></a> `start_date?` | `string` | Filter executions that started on or after this ISO 8601 date string. | [cobalt.ts:227](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L227) |
|
|
747
|
+
| <a id="status-1"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [cobalt.ts:221](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L221) |
|
|
748
|
+
| <a id="workflow_id"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L225) |
|
|
749
|
+
| <a id="workflow_name"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L223) |
|
|
785
750
|
|
|
786
751
|
***
|
|
787
752
|
|
|
788
|
-
###
|
|
753
|
+
### GetExecutionsParams
|
|
754
|
+
|
|
755
|
+
Defined in: [cobalt.ts:237](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L237)
|
|
756
|
+
|
|
757
|
+
Parameters for filtering and paginating the list of workflow executions.
|
|
758
|
+
|
|
759
|
+
#### Extends
|
|
760
|
+
|
|
761
|
+
- `PaginationProps`.[`ExecutionFilters`](#executionfilters)
|
|
762
|
+
|
|
763
|
+
#### Indexable
|
|
789
764
|
|
|
790
|
-
|
|
765
|
+
> \[`key`: `string`\]: `string` \| `number` \| `undefined`
|
|
766
|
+
|
|
767
|
+
Any additional filter keys supported by the API.
|
|
791
768
|
|
|
792
769
|
#### Properties
|
|
793
770
|
|
|
794
|
-
| Property | Type | Description | Defined in |
|
|
795
|
-
| ------ | ------ | ------ | ------ |
|
|
796
|
-
| <a id="
|
|
797
|
-
| <a id="
|
|
798
|
-
| <a id="
|
|
771
|
+
| Property | Type | Description | Inherited from | Defined in |
|
|
772
|
+
| ------ | ------ | ------ | ------ | ------ |
|
|
773
|
+
| <a id="end_date-1"></a> `end_date?` | `string` | Filter executions that started on or before this ISO 8601 date string. | [`ExecutionFilters`](#executionfilters).[`end_date`](#end_date) | [cobalt.ts:229](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L229) |
|
|
774
|
+
| <a id="execution_source-1"></a> `execution_source?` | [`ExecutionSource`](#executionsource) | Filter by the trigger source that initiated the execution. | [`ExecutionFilters`](#executionfilters).[`execution_source`](#execution_source) | [cobalt.ts:233](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L233) |
|
|
775
|
+
| <a id="execution_type-1"></a> `execution_type?` | [`ExecutionType`](#executiontype) | Filter by how the execution was invoked — synchronously or asynchronously. | [`ExecutionFilters`](#executionfilters).[`execution_type`](#execution_type) | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L231) |
|
|
776
|
+
| <a id="limit"></a> `limit?` | `number` | - | `PaginationProps.limit` | [cobalt.ts:208](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L208) |
|
|
777
|
+
| <a id="page"></a> `page?` | `number` | - | `PaginationProps.page` | [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L207) |
|
|
778
|
+
| <a id="start_date-1"></a> `start_date?` | `string` | Filter executions that started on or after this ISO 8601 date string. | [`ExecutionFilters`](#executionfilters).[`start_date`](#start_date) | [cobalt.ts:227](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L227) |
|
|
779
|
+
| <a id="status-2"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [`ExecutionFilters`](#executionfilters).[`status`](#status-1) | [cobalt.ts:221](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L221) |
|
|
780
|
+
| <a id="workflow_id-1"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [`ExecutionFilters`](#executionfilters).[`workflow_id`](#workflow_id) | [cobalt.ts:225](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L225) |
|
|
781
|
+
| <a id="workflow_name-1"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [`ExecutionFilters`](#executionfilters).[`workflow_name`](#workflow_name) | [cobalt.ts:223](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L223) |
|
|
799
782
|
|
|
800
783
|
***
|
|
801
784
|
|
|
802
|
-
###
|
|
785
|
+
### InputField
|
|
803
786
|
|
|
804
|
-
Defined in: [cobalt.ts:
|
|
787
|
+
Defined in: [cobalt.ts:73](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L73)
|
|
805
788
|
|
|
806
|
-
|
|
789
|
+
An Input field to take input from the user.
|
|
807
790
|
|
|
808
791
|
#### Properties
|
|
809
792
|
|
|
810
793
|
| Property | Type | Description | Defined in |
|
|
811
794
|
| ------ | ------ | ------ | ------ |
|
|
812
|
-
| <a id="
|
|
813
|
-
| <a id="
|
|
795
|
+
| <a id="help_text-1"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:87](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L87) |
|
|
796
|
+
| <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:85](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L85) |
|
|
797
|
+
| <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:81](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L81) |
|
|
798
|
+
| <a id="name-4"></a> `name` | `string` | Key name of the field. | [cobalt.ts:75](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L75) |
|
|
799
|
+
| <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:89](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L89) |
|
|
800
|
+
| <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:83](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L83) |
|
|
801
|
+
| <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:79](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L79) |
|
|
802
|
+
| <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:77](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L77) |
|
|
814
803
|
|
|
815
804
|
***
|
|
816
805
|
|
|
817
|
-
###
|
|
806
|
+
### Label
|
|
807
|
+
|
|
808
|
+
Defined in: [cobalt.ts:106](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L106)
|
|
818
809
|
|
|
819
|
-
|
|
810
|
+
Label Mapping
|
|
820
811
|
|
|
821
812
|
#### Properties
|
|
822
813
|
|
|
823
814
|
| Property | Type | Description | Defined in |
|
|
824
815
|
| ------ | ------ | ------ | ------ |
|
|
825
|
-
| <a id="
|
|
826
|
-
| <a id="
|
|
827
|
-
| <a id="payload-2"></a> `payload?` | `Record`\<`string`, `string`\> | The key value pairs of auth data. | [cobalt.ts:114](https://github.com/gocobalt/cobalt-js/blob/f9c4cac4281e323329085886549cd5d1a1ca8176/cobalt.ts#L114) |
|
|
828
|
-
| <a id="slug-5"></a> `slug` | `string` | The application slug. | [cobalt.ts:110](https://github.com/gocobalt/cobalt-js/blob/f9c4cac4281e323329085886549cd5d1a1ca8176/cobalt.ts#L110) |
|
|
816
|
+
| <a id="name-5"></a> `name` | `string` | The label name. | [cobalt.ts:108](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L108) |
|
|
817
|
+
| <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:110](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L110) |
|
|
829
818
|
|
|
830
819
|
***
|
|
831
820
|
|
|
832
821
|
### PublicWorkflow
|
|
833
822
|
|
|
834
|
-
Defined in: [cobalt.ts:
|
|
823
|
+
Defined in: [cobalt.ts:163](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L163)
|
|
835
824
|
|
|
836
825
|
A public workflow in Cobalt.
|
|
837
826
|
|
|
@@ -839,19 +828,19 @@ A public workflow in Cobalt.
|
|
|
839
828
|
|
|
840
829
|
| Property | Type | Description | Defined in |
|
|
841
830
|
| ------ | ------ | ------ | ------ |
|
|
842
|
-
| <a id="_id-
|
|
843
|
-
| <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:
|
|
844
|
-
| <a id="description-
|
|
845
|
-
| <a id="name-
|
|
846
|
-
| <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:
|
|
847
|
-
| <a id="slug-
|
|
848
|
-
| <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [cobalt.ts:
|
|
831
|
+
| <a id="_id-1"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:165](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L165) |
|
|
832
|
+
| <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:173](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L173) |
|
|
833
|
+
| <a id="description-2"></a> `description?` | `string` | The workflow description. | [cobalt.ts:169](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L169) |
|
|
834
|
+
| <a id="name-6"></a> `name` | `string` | The workflow name. | [cobalt.ts:167](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L167) |
|
|
835
|
+
| <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:177](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L177) |
|
|
836
|
+
| <a id="slug-4"></a> `slug?` | `string` | The application's slug in which this workflow exists. | [cobalt.ts:171](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L171) |
|
|
837
|
+
| <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [cobalt.ts:175](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L175) |
|
|
849
838
|
|
|
850
839
|
***
|
|
851
840
|
|
|
852
841
|
### PublicWorkflowPayload
|
|
853
842
|
|
|
854
|
-
Defined in: [cobalt.ts:
|
|
843
|
+
Defined in: [cobalt.ts:181](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L181)
|
|
855
844
|
|
|
856
845
|
The payload for creating a public workflow for the linked account.
|
|
857
846
|
|
|
@@ -859,57 +848,69 @@ The payload for creating a public workflow for the linked account.
|
|
|
859
848
|
|
|
860
849
|
| Property | Type | Description | Defined in |
|
|
861
850
|
| ------ | ------ | ------ | ------ |
|
|
862
|
-
| <a id="description-
|
|
863
|
-
| <a id="name-
|
|
864
|
-
| <a id="slug-
|
|
851
|
+
| <a id="description-3"></a> `description?` | `string` | The workflow description. | [cobalt.ts:185](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L185) |
|
|
852
|
+
| <a id="name-7"></a> `name` | `string` | The workflow name. | [cobalt.ts:183](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L183) |
|
|
853
|
+
| <a id="slug-5"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [cobalt.ts:187](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L187) |
|
|
865
854
|
|
|
866
855
|
***
|
|
867
856
|
|
|
868
857
|
### PublicWorkflowsPayload
|
|
869
858
|
|
|
870
|
-
Defined in: [cobalt.ts:
|
|
859
|
+
Defined in: [cobalt.ts:191](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L191)
|
|
860
|
+
|
|
861
|
+
Parameters for filtering and paginating the list of workflows.
|
|
871
862
|
|
|
872
863
|
#### Extends
|
|
873
864
|
|
|
874
865
|
- `PaginationProps`
|
|
875
866
|
|
|
867
|
+
#### Indexable
|
|
868
|
+
|
|
869
|
+
> \[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined`
|
|
870
|
+
|
|
871
|
+
Any additional filter keys supported by the API.
|
|
872
|
+
|
|
876
873
|
#### Properties
|
|
877
874
|
|
|
878
|
-
| Property | Type | Inherited from | Defined in |
|
|
879
|
-
| ------ | ------ | ------ | ------ |
|
|
880
|
-
| <a id="
|
|
881
|
-
| <a id="
|
|
882
|
-
| <a id="
|
|
875
|
+
| Property | Type | Description | Inherited from | Defined in |
|
|
876
|
+
| ------ | ------ | ------ | ------ | ------ |
|
|
877
|
+
| <a id="end_date-2"></a> `end_date?` | `string` | Filter workflows created on or before this ISO 8601 date string. | - | [cobalt.ts:199](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L199) |
|
|
878
|
+
| <a id="limit-1"></a> `limit?` | `number` | - | `PaginationProps.limit` | [cobalt.ts:208](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L208) |
|
|
879
|
+
| <a id="name-8"></a> `name?` | `string` | Filter workflows by name (partial match). | - | [cobalt.ts:195](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L195) |
|
|
880
|
+
| <a id="page-1"></a> `page?` | `number` | - | `PaginationProps.page` | [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L207) |
|
|
881
|
+
| <a id="published-1"></a> `published?` | `boolean` | Filter by workflow published status. `true` returns only published workflows, `false` returns only drafts. | - | [cobalt.ts:201](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L201) |
|
|
882
|
+
| <a id="slug-6"></a> `slug?` | `string` | Filter workflows by the application slug. | - | [cobalt.ts:193](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L193) |
|
|
883
|
+
| <a id="start_date-2"></a> `start_date?` | `string` | Filter workflows created on or after this ISO 8601 date string. | - | [cobalt.ts:197](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L197) |
|
|
883
884
|
|
|
884
885
|
***
|
|
885
886
|
|
|
886
887
|
### RuleOptions
|
|
887
888
|
|
|
888
|
-
Defined in: [cobalt.ts:
|
|
889
|
+
Defined in: [cobalt.ts:142](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L142)
|
|
889
890
|
|
|
890
891
|
#### Properties
|
|
891
892
|
|
|
892
893
|
| Property | Type | Defined in |
|
|
893
894
|
| ------ | ------ | ------ |
|
|
894
|
-
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:
|
|
895
|
-
| <a id="error"></a> `error?` | `object` | [cobalt.ts:
|
|
896
|
-
| `error.message?` | `string` | [cobalt.ts:
|
|
897
|
-
| `error.stack?` | `string` | [cobalt.ts:
|
|
898
|
-
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:
|
|
899
|
-
| `rule_column.operator` | `object` | [cobalt.ts:
|
|
900
|
-
| `rule_column.operator.name` | `string` | [cobalt.ts:
|
|
901
|
-
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:
|
|
902
|
-
| `rule_column.operator.type` | `"select"` | [cobalt.ts:
|
|
903
|
-
| `rule_column.rhs` | `object` | [cobalt.ts:
|
|
904
|
-
| `rule_column.rhs.name` | `string` | [cobalt.ts:
|
|
905
|
-
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:
|
|
906
|
-
| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:
|
|
895
|
+
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:155](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L155) |
|
|
896
|
+
| <a id="error"></a> `error?` | `object` | [cobalt.ts:156](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L156) |
|
|
897
|
+
| `error.message?` | `string` | [cobalt.ts:157](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L157) |
|
|
898
|
+
| `error.stack?` | `string` | [cobalt.ts:158](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L158) |
|
|
899
|
+
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:143](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L143) |
|
|
900
|
+
| `rule_column.operator` | `object` | [cobalt.ts:149](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L149) |
|
|
901
|
+
| `rule_column.operator.name` | `string` | [cobalt.ts:150](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L150) |
|
|
902
|
+
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:152](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L152) |
|
|
903
|
+
| `rule_column.operator.type` | `"select"` | [cobalt.ts:151](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L151) |
|
|
904
|
+
| `rule_column.rhs` | `object` | [cobalt.ts:144](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L144) |
|
|
905
|
+
| `rule_column.rhs.name` | `string` | [cobalt.ts:145](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L145) |
|
|
906
|
+
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:147](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L147) |
|
|
907
|
+
| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L146) |
|
|
907
908
|
|
|
908
909
|
***
|
|
909
910
|
|
|
910
911
|
### UpdateConfigPayload
|
|
911
912
|
|
|
912
|
-
Defined in: [cobalt.ts:
|
|
913
|
+
Defined in: [cobalt.ts:114](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L114)
|
|
913
914
|
|
|
914
915
|
The configuration data for an application.
|
|
915
916
|
|
|
@@ -917,16 +918,16 @@ The configuration data for an application.
|
|
|
917
918
|
|
|
918
919
|
| Property | Type | Description | Defined in |
|
|
919
920
|
| ------ | ------ | ------ | ------ |
|
|
920
|
-
| <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:
|
|
921
|
-
| <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [cobalt.ts:
|
|
922
|
-
| <a id="slug-
|
|
923
|
-
| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:
|
|
921
|
+
| <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L118) |
|
|
922
|
+
| <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [cobalt.ts:120](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L120) |
|
|
923
|
+
| <a id="slug-7"></a> `slug` | `string` | The application slug | [cobalt.ts:116](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L116) |
|
|
924
|
+
| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:122](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L122) |
|
|
924
925
|
|
|
925
926
|
***
|
|
926
927
|
|
|
927
928
|
### WorkflowPayload
|
|
928
929
|
|
|
929
|
-
Defined in: [cobalt.ts:
|
|
930
|
+
Defined in: [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L126)
|
|
930
931
|
|
|
931
932
|
The workflow.
|
|
932
933
|
|
|
@@ -934,20 +935,50 @@ The workflow.
|
|
|
934
935
|
|
|
935
936
|
| Property | Type | Description | Defined in |
|
|
936
937
|
| ------ | ------ | ------ | ------ |
|
|
937
|
-
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:
|
|
938
|
-
| <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [cobalt.ts:
|
|
939
|
-
| <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:
|
|
938
|
+
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:130](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L130) |
|
|
939
|
+
| <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [cobalt.ts:132](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L132) |
|
|
940
|
+
| <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L128) |
|
|
940
941
|
|
|
941
942
|
***
|
|
942
943
|
|
|
943
944
|
### WorkflowPayloadResponse
|
|
944
945
|
|
|
945
|
-
Defined in: [cobalt.ts:
|
|
946
|
+
Defined in: [cobalt.ts:298](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L298)
|
|
946
947
|
|
|
947
948
|
#### Properties
|
|
948
949
|
|
|
949
950
|
| Property | Type | Defined in |
|
|
950
951
|
| ------ | ------ | ------ |
|
|
951
|
-
| <a id="payload-
|
|
952
|
-
| <a id="schema"></a> `schema?` | `unknown` | [cobalt.ts:
|
|
953
|
-
| <a id="schema_interpreted"></a> `schema_interpreted?` | `unknown` | [cobalt.ts:
|
|
952
|
+
| <a id="payload-1"></a> `payload` | `Record`\<`string`, `any`\> | [cobalt.ts:299](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L299) |
|
|
953
|
+
| <a id="schema"></a> `schema?` | `unknown` | [cobalt.ts:300](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L300) |
|
|
954
|
+
| <a id="schema_interpreted"></a> `schema_interpreted?` | `unknown` | [cobalt.ts:301](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L301) |
|
|
955
|
+
|
|
956
|
+
## Type Aliases
|
|
957
|
+
|
|
958
|
+
### ExecutionSource
|
|
959
|
+
|
|
960
|
+
> **ExecutionSource** = `"Event"` \| `"Schedule"` \| `"API Call"`
|
|
961
|
+
|
|
962
|
+
Defined in: [cobalt.ts:214](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L214)
|
|
963
|
+
|
|
964
|
+
The trigger source that initiated a workflow execution.
|
|
965
|
+
|
|
966
|
+
***
|
|
967
|
+
|
|
968
|
+
### ExecutionStatus
|
|
969
|
+
|
|
970
|
+
> **ExecutionStatus** = `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"`
|
|
971
|
+
|
|
972
|
+
Defined in: [cobalt.ts:212](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L212)
|
|
973
|
+
|
|
974
|
+
The current status of a workflow execution.
|
|
975
|
+
|
|
976
|
+
***
|
|
977
|
+
|
|
978
|
+
### ExecutionType
|
|
979
|
+
|
|
980
|
+
> **ExecutionType** = `"SYNC"` \| `"ASYNC"`
|
|
981
|
+
|
|
982
|
+
Defined in: [cobalt.ts:216](https://github.com/gocobalt/cobalt-js/blob/100d8c1b5f12564b62e0d54af1b32d158a635668/cobalt.ts#L216)
|
|
983
|
+
|
|
984
|
+
Whether a workflow execution runs synchronously (waits for result) or asynchronously (fire-and-forget).
|