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