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