@cobaltio/cobalt-js 9.0.0 → 9.2.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/cobalt.d.ts +56 -8
- package/cobalt.js +363 -358
- package/cobalt.ts +129 -19
- 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 +36 -23
- package/docs/enums/AuthStatus.html +2 -2
- package/docs/enums/AuthType.html +2 -2
- package/docs/interfaces/Application.html +15 -14
- 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/ExecuteWorkflowPayload.html +9 -0
- package/docs/interfaces/Execution.html +2 -2
- 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 +7 -0
- package/docs/interfaces/PublicWorkflow.html +8 -8
- package/docs/interfaces/PublicWorkflowPayload.html +4 -4
- package/docs/interfaces/PublicWorkflowsPayload.html +2 -2
- 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 +4 -0
- package/docs/llms.txt +256 -159
- package/docs/modules.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/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L10)
|
|
74
74
|
|
|
75
75
|
#### Enumeration Members
|
|
76
76
|
|
|
77
77
|
| Enumeration Member | Value | Defined in |
|
|
78
78
|
| ------ | ------ | ------ |
|
|
79
|
-
| <a id="active"></a> `Active` | `"active"` | [cobalt.ts:11](https://github.com/gocobalt/cobalt-js/blob/
|
|
80
|
-
| <a id="expired"></a> `Expired` | `"expired"` | [cobalt.ts:12](https://github.com/gocobalt/cobalt-js/blob/
|
|
79
|
+
| <a id="active"></a> `Active` | `"active"` | [cobalt.ts:11](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L11) |
|
|
80
|
+
| <a id="expired"></a> `Expired` | `"expired"` | [cobalt.ts:12](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/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/1f74ac73d962f26dd757ccf54a623cc808ed24d9/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="keybased"></a> `KeyBased` | `"keybased"` | [cobalt.ts:7](https://github.com/gocobalt/cobalt-js/blob/
|
|
95
|
-
| <a id="oauth2"></a> `OAuth2` | `"oauth2"` | [cobalt.ts:6](https://github.com/gocobalt/cobalt-js/blob/
|
|
94
|
+
| <a id="keybased"></a> `KeyBased` | `"keybased"` | [cobalt.ts:7](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L7) |
|
|
95
|
+
| <a id="oauth2"></a> `OAuth2` | `"oauth2"` | [cobalt.ts:6](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/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:341](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L341)
|
|
102
102
|
|
|
103
103
|
#### Constructors
|
|
104
104
|
|
|
@@ -106,7 +106,7 @@ Defined in: [cobalt.ts:304](https://github.com/gocobalt/cobalt-js/blob/caefd941c
|
|
|
106
106
|
|
|
107
107
|
> **new Cobalt**(`options`): [`Cobalt`](#cobalt)
|
|
108
108
|
|
|
109
|
-
Defined in: [cobalt.ts:
|
|
109
|
+
Defined in: [cobalt.ts:351](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L351)
|
|
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:343](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L343) |
|
|
128
128
|
|
|
129
129
|
#### Methods
|
|
130
130
|
|
|
@@ -132,7 +132,7 @@ Cobalt Frontend SDK
|
|
|
132
132
|
|
|
133
133
|
> **config**(`payload`): `Promise`\<[`Config`](#config-2)\>
|
|
134
134
|
|
|
135
|
-
Defined in: [cobalt.ts:
|
|
135
|
+
Defined in: [cobalt.ts:640](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L640)
|
|
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:586](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L586)
|
|
156
156
|
|
|
157
157
|
Connects the specified application using the provided authentication type and optional auth data.
|
|
158
158
|
|
|
@@ -160,7 +160,8 @@ 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` | \{ `connection?`: `string`; `payload?`: `Record`\<`string`, `string`\>; `slug`: `string`; `type?`: [`AuthType`](#authtype); \} | The parameters for connecting the application. |
|
|
164
|
+
| `params.connection?` | `string` | The connection identifier of the auth config. |
|
|
164
165
|
| `params.payload?` | `Record`\<`string`, `string`\> | key-value pairs of authentication data required for the specified auth type. |
|
|
165
166
|
| `params.slug` | `string` | The application slug. |
|
|
166
167
|
| `params.type?` | [`AuthType`](#authtype) | The authentication type to use. If not provided, it defaults to `keybased` if payload is provided, otherwise `oauth2`. |
|
|
@@ -179,7 +180,7 @@ Throws an error if the authentication type is invalid or the connection fails.
|
|
|
179
180
|
|
|
180
181
|
> **createWorkflow**(`params`): `Promise`\<[`PublicWorkflow`](#publicworkflow)\>
|
|
181
182
|
|
|
182
|
-
Defined in: [cobalt.ts:
|
|
183
|
+
Defined in: [cobalt.ts:882](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L882)
|
|
183
184
|
|
|
184
185
|
Create a public workflow for the linked account.
|
|
185
186
|
|
|
@@ -199,7 +200,7 @@ The created public workflow.
|
|
|
199
200
|
|
|
200
201
|
> **deleteConfig**(`slug`, `configId?`): `Promise`\<`unknown`\>
|
|
201
202
|
|
|
202
|
-
Defined in: [cobalt.ts:
|
|
203
|
+
Defined in: [cobalt.ts:731](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L731)
|
|
203
204
|
|
|
204
205
|
Delete the specified config.
|
|
205
206
|
|
|
@@ -218,7 +219,7 @@ Delete the specified config.
|
|
|
218
219
|
|
|
219
220
|
> **deleteConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<`unknown`\>
|
|
220
221
|
|
|
221
|
-
Defined in: [cobalt.ts:
|
|
222
|
+
Defined in: [cobalt.ts:804](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L804)
|
|
222
223
|
|
|
223
224
|
Delete the specified config field value.
|
|
224
225
|
|
|
@@ -238,7 +239,7 @@ Delete the specified config field value.
|
|
|
238
239
|
|
|
239
240
|
> **deleteWorkflow**(`workflowId`): `Promise`\<`unknown`\>
|
|
240
241
|
|
|
241
|
-
Defined in: [cobalt.ts:
|
|
242
|
+
Defined in: [cobalt.ts:910](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L910)
|
|
242
243
|
|
|
243
244
|
Delete the specified public workflow.
|
|
244
245
|
|
|
@@ -254,9 +255,9 @@ Delete the specified public workflow.
|
|
|
254
255
|
|
|
255
256
|
##### disconnect()
|
|
256
257
|
|
|
257
|
-
> **disconnect**(`slug`, `type?`): `Promise`\<`unknown`\>
|
|
258
|
+
> **disconnect**(`slug`, `type?`, `connection?`): `Promise`\<`unknown`\>
|
|
258
259
|
|
|
259
|
-
Defined in: [cobalt.ts:
|
|
260
|
+
Defined in: [cobalt.ts:615](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L615)
|
|
260
261
|
|
|
261
262
|
Disconnect the specified application and remove any associated data from Cobalt.
|
|
262
263
|
|
|
@@ -266,6 +267,25 @@ Disconnect the specified application and remove any associated data from Cobalt.
|
|
|
266
267
|
| ------ | ------ | ------ |
|
|
267
268
|
| `slug` | `string` | The application slug. |
|
|
268
269
|
| `type?` | [`AuthType`](#authtype) | The authentication type to use. If not provided, it'll remove all the connected accounts. |
|
|
270
|
+
| `connection?` | `string` | The connection identifier of the auth config. |
|
|
271
|
+
|
|
272
|
+
###### Returns
|
|
273
|
+
|
|
274
|
+
`Promise`\<`unknown`\>
|
|
275
|
+
|
|
276
|
+
##### executeWorkflow()
|
|
277
|
+
|
|
278
|
+
> **executeWorkflow**(`options`): `Promise`\<`unknown`\>
|
|
279
|
+
|
|
280
|
+
Defined in: [cobalt.ts:954](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L954)
|
|
281
|
+
|
|
282
|
+
Execute the specified public workflow.
|
|
283
|
+
|
|
284
|
+
###### Parameters
|
|
285
|
+
|
|
286
|
+
| Parameter | Type | Description |
|
|
287
|
+
| ------ | ------ | ------ |
|
|
288
|
+
| `options` | [`ExecuteWorkflowPayload`](#executeworkflowpayload) | The execution payload. |
|
|
269
289
|
|
|
270
290
|
###### Returns
|
|
271
291
|
|
|
@@ -285,7 +305,7 @@ The application slug.
|
|
|
285
305
|
|
|
286
306
|
> **getApp**(): `Promise`\<[`Application`](#application)[]\>
|
|
287
307
|
|
|
288
|
-
Defined in: [cobalt.ts:
|
|
308
|
+
Defined in: [cobalt.ts:411](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L411)
|
|
289
309
|
|
|
290
310
|
Returns the list of enabled applications and their details.
|
|
291
311
|
|
|
@@ -303,7 +323,7 @@ The application slug.
|
|
|
303
323
|
|
|
304
324
|
> **getApp**(`slug`): `Promise`\<[`Application`](#application)\>
|
|
305
325
|
|
|
306
|
-
Defined in: [cobalt.ts:
|
|
326
|
+
Defined in: [cobalt.ts:418](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L418)
|
|
307
327
|
|
|
308
328
|
Returns the application details for the specified application, provided
|
|
309
329
|
the application is enabled in Cobalt.
|
|
@@ -328,7 +348,7 @@ The application slug.
|
|
|
328
348
|
|
|
329
349
|
> **getApps**(): `Promise`\<[`Application`](#application)[]\>
|
|
330
350
|
|
|
331
|
-
Defined in: [cobalt.ts:
|
|
351
|
+
Defined in: [cobalt.ts:446](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L446)
|
|
332
352
|
|
|
333
353
|
Returns all the enabled apps.
|
|
334
354
|
|
|
@@ -342,7 +362,7 @@ The list of applications.
|
|
|
342
362
|
|
|
343
363
|
> **getConfig**(`slug`, `configId?`): `Promise`\<[`Config`](#config-2)\>
|
|
344
364
|
|
|
345
|
-
Defined in: [cobalt.ts:
|
|
365
|
+
Defined in: [cobalt.ts:687](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L687)
|
|
346
366
|
|
|
347
367
|
Returns the specified config.
|
|
348
368
|
|
|
@@ -363,7 +383,7 @@ The specified config.
|
|
|
363
383
|
|
|
364
384
|
> **getConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
|
|
365
385
|
|
|
366
|
-
Defined in: [cobalt.ts:
|
|
386
|
+
Defined in: [cobalt.ts:754](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L754)
|
|
367
387
|
|
|
368
388
|
Returns the specified field of the config.
|
|
369
389
|
|
|
@@ -385,7 +405,7 @@ The specified config field.
|
|
|
385
405
|
|
|
386
406
|
> **getConfigs**(`slug`): `Promise`\<`object`[]\>
|
|
387
407
|
|
|
388
|
-
Defined in: [cobalt.ts:
|
|
408
|
+
Defined in: [cobalt.ts:666](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L666)
|
|
389
409
|
|
|
390
410
|
Returns the configs created for the specified application.
|
|
391
411
|
|
|
@@ -405,7 +425,7 @@ The configs created for the specified application.
|
|
|
405
425
|
|
|
406
426
|
> **getExecution**(`executionId`): `Promise`\<[`Execution`](#execution)\>
|
|
407
427
|
|
|
408
|
-
Defined in: [cobalt.ts:
|
|
428
|
+
Defined in: [cobalt.ts:1001](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L1001)
|
|
409
429
|
|
|
410
430
|
Returns the specified workflow execution log.
|
|
411
431
|
|
|
@@ -425,7 +445,7 @@ The specified execution log.
|
|
|
425
445
|
|
|
426
446
|
> **getExecutions**(`params?`): `Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
|
|
427
447
|
|
|
428
|
-
Defined in: [cobalt.ts:
|
|
448
|
+
Defined in: [cobalt.ts:981](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L981)
|
|
429
449
|
|
|
430
450
|
Returns the workflow execution logs for the linked account.
|
|
431
451
|
|
|
@@ -445,7 +465,7 @@ The paginated workflow execution logs.
|
|
|
445
465
|
|
|
446
466
|
> **getFieldOptions**(`lhs`, `slug`, `fieldId`, `workflowId?`): `Promise`\<[`RuleOptions`](#ruleoptions)\>
|
|
447
467
|
|
|
448
|
-
Defined in: [cobalt.ts:
|
|
468
|
+
Defined in: [cobalt.ts:829](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L829)
|
|
449
469
|
|
|
450
470
|
Returns the options for the specified field.
|
|
451
471
|
|
|
@@ -464,11 +484,31 @@ Returns the options for the specified field.
|
|
|
464
484
|
|
|
465
485
|
The specified rule field's options.
|
|
466
486
|
|
|
487
|
+
##### getWorkflowPayload()
|
|
488
|
+
|
|
489
|
+
> **getWorkflowPayload**(`workflowId`): `Promise`\<[`WorkflowPayloadResponse`](#workflowpayloadresponse)\>
|
|
490
|
+
|
|
491
|
+
Defined in: [cobalt.ts:931](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L931)
|
|
492
|
+
|
|
493
|
+
Returns the execution payload for the specified public workflow.
|
|
494
|
+
|
|
495
|
+
###### Parameters
|
|
496
|
+
|
|
497
|
+
| Parameter | Type | Description |
|
|
498
|
+
| ------ | ------ | ------ |
|
|
499
|
+
| `workflowId` | `string` | The workflow ID. |
|
|
500
|
+
|
|
501
|
+
###### Returns
|
|
502
|
+
|
|
503
|
+
`Promise`\<[`WorkflowPayloadResponse`](#workflowpayloadresponse)\>
|
|
504
|
+
|
|
505
|
+
The workflow payload response.
|
|
506
|
+
|
|
467
507
|
##### getWorkflows()
|
|
468
508
|
|
|
469
509
|
> **getWorkflows**(`params?`): `Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
|
|
470
510
|
|
|
471
|
-
Defined in: [cobalt.ts:
|
|
511
|
+
Defined in: [cobalt.ts:858](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L858)
|
|
472
512
|
|
|
473
513
|
Returns the private workflows for the specified application.
|
|
474
514
|
|
|
@@ -486,7 +526,7 @@ Returns the private workflows for the specified application.
|
|
|
486
526
|
|
|
487
527
|
> **updateConfig**(`payload`): `Promise`\<[`Config`](#config-2)\>
|
|
488
528
|
|
|
489
|
-
Defined in: [cobalt.ts:
|
|
529
|
+
Defined in: [cobalt.ts:707](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L707)
|
|
490
530
|
|
|
491
531
|
Update the specified config.
|
|
492
532
|
|
|
@@ -506,7 +546,7 @@ The specified config.
|
|
|
506
546
|
|
|
507
547
|
> **updateConfigField**(`slug`, `fieldId`, `value`, `workflowId?`): `Promise`\<[`Config`](#config-2)\>
|
|
508
548
|
|
|
509
|
-
Defined in: [cobalt.ts:
|
|
549
|
+
Defined in: [cobalt.ts:778](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L778)
|
|
510
550
|
|
|
511
551
|
Update the specified config field value.
|
|
512
552
|
|
|
@@ -529,7 +569,7 @@ The updated config field.
|
|
|
529
569
|
|
|
530
570
|
### Application
|
|
531
571
|
|
|
532
|
-
Defined in: [cobalt.ts:16](https://github.com/gocobalt/cobalt-js/blob/
|
|
572
|
+
Defined in: [cobalt.ts:16](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L16)
|
|
533
573
|
|
|
534
574
|
An application in Cobalt.
|
|
535
575
|
|
|
@@ -537,80 +577,80 @@ An application in Cobalt.
|
|
|
537
577
|
|
|
538
578
|
| Property | Type | Description | Defined in |
|
|
539
579
|
| ------ | ------ | ------ | ------ |
|
|
540
|
-
| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:18](https://github.com/gocobalt/cobalt-js/blob/
|
|
541
|
-
| <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:
|
|
542
|
-
| <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:
|
|
543
|
-
| <a id="auth_type_options"></a> `auth_type_options?` | `object` | The supported auth types for the application, and the fields required from the user to connect the application. | [cobalt.ts:35](https://github.com/gocobalt/cobalt-js/blob/
|
|
580
|
+
| <a id="app_id"></a> `app_id` | `string` | Application ID | [cobalt.ts:18](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L18) |
|
|
581
|
+
| <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:71](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L71) |
|
|
582
|
+
| <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:56](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L56) |
|
|
583
|
+
| <a id="auth_type_options"></a> `auth_type_options?` | `object` | The supported auth types for the application, and the fields required from the user to connect the application. | [cobalt.ts:35](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L35) |
|
|
544
584
|
| `auth_type_options.keybased` | [`InputField`](#inputfield)[] | - | |
|
|
545
585
|
| `auth_type_options.oauth2` | [`InputField`](#inputfield)[] | - | |
|
|
546
|
-
| <a id="connected"></a> ~~`connected?`~~ | `boolean` | Whether the user has connected the application. **Deprecated** Check `connected_accounts` for multiple auth types support. | [cobalt.ts:
|
|
547
|
-
| <a id="connected_accounts"></a> `connected_accounts?` | `object`[] | The list of connected accounts for this application | [cobalt.ts:40](https://github.com/gocobalt/cobalt-js/blob/
|
|
548
|
-
| <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:22](https://github.com/gocobalt/cobalt-js/blob/
|
|
549
|
-
| <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:24](https://github.com/gocobalt/cobalt-js/blob/
|
|
550
|
-
| <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:20](https://github.com/gocobalt/cobalt-js/blob/
|
|
551
|
-
| <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:
|
|
552
|
-
| <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:31](https://github.com/gocobalt/cobalt-js/blob/
|
|
553
|
-
| <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:33](https://github.com/gocobalt/cobalt-js/blob/
|
|
554
|
-
| <a id="type"></a> ~~`type`~~ | `string` | **Deprecated** Use `slug` instead. The application slug for native apps and `custom` for custom apps. | [cobalt.ts:29](https://github.com/gocobalt/cobalt-js/blob/
|
|
586
|
+
| <a id="connected"></a> ~~`connected?`~~ | `boolean` | Whether the user has connected the application. **Deprecated** Check `connected_accounts` for multiple auth types support. | [cobalt.ts:61](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L61) |
|
|
587
|
+
| <a id="connected_accounts"></a> `connected_accounts?` | `object`[] | The list of connected accounts for this application | [cobalt.ts:40](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L40) |
|
|
588
|
+
| <a id="description"></a> `description` | `string` | The application description. | [cobalt.ts:22](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L22) |
|
|
589
|
+
| <a id="icon"></a> `icon` | `string` | The application icon. | [cobalt.ts:24](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L24) |
|
|
590
|
+
| <a id="name"></a> `name` | `string` | The application name. | [cobalt.ts:20](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L20) |
|
|
591
|
+
| <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:66](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L66) |
|
|
592
|
+
| <a id="slug"></a> `slug` | `string` | The application slug. | [cobalt.ts:31](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L31) |
|
|
593
|
+
| <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [cobalt.ts:33](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L33) |
|
|
594
|
+
| <a id="type"></a> ~~`type`~~ | `string` | **Deprecated** Use `slug` instead. The application slug for native apps and `custom` for custom apps. | [cobalt.ts:29](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L29) |
|
|
555
595
|
|
|
556
596
|
***
|
|
557
597
|
|
|
558
598
|
### CobaltOptions
|
|
559
599
|
|
|
560
|
-
Defined in: [cobalt.ts:
|
|
600
|
+
Defined in: [cobalt.ts:155](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L155)
|
|
561
601
|
|
|
562
602
|
#### Properties
|
|
563
603
|
|
|
564
604
|
| Property | Type | Description | Defined in |
|
|
565
605
|
| ------ | ------ | ------ | ------ |
|
|
566
|
-
| <a id="baseurl"></a> `baseUrl?` | `string` | The base URL of the Cobalt API. You don't need to set this. | [cobalt.ts:
|
|
567
|
-
| <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:
|
|
606
|
+
| <a id="baseurl"></a> `baseUrl?` | `string` | The base URL of the Cobalt API. You don't need to set this. | [cobalt.ts:157](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L157) |
|
|
607
|
+
| <a id="token-1"></a> `token?` | `string` | The session token. | [cobalt.ts:159](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L159) |
|
|
568
608
|
|
|
569
609
|
***
|
|
570
610
|
|
|
571
611
|
### Config
|
|
572
612
|
|
|
573
|
-
Defined in: [cobalt.ts:
|
|
613
|
+
Defined in: [cobalt.ts:227](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L227)
|
|
574
614
|
|
|
575
615
|
#### Properties
|
|
576
616
|
|
|
577
617
|
| Property | Type | Defined in |
|
|
578
618
|
| ------ | ------ | ------ |
|
|
579
|
-
| <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:
|
|
580
|
-
| <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:
|
|
581
|
-
| <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:
|
|
582
|
-
| <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:
|
|
583
|
-
| <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:
|
|
619
|
+
| <a id="config_id"></a> `config_id?` | `string` | [cobalt.ts:229](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L229) |
|
|
620
|
+
| <a id="field_errors"></a> `field_errors?` | `object`[] | [cobalt.ts:232](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L232) |
|
|
621
|
+
| <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:230](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L230) |
|
|
622
|
+
| <a id="slug-1"></a> `slug` | `string` | [cobalt.ts:228](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L228) |
|
|
623
|
+
| <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [cobalt.ts:231](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L231) |
|
|
584
624
|
|
|
585
625
|
***
|
|
586
626
|
|
|
587
627
|
### ConfigField
|
|
588
628
|
|
|
589
|
-
Defined in: [cobalt.ts:
|
|
629
|
+
Defined in: [cobalt.ts:242](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L242)
|
|
590
630
|
|
|
591
631
|
#### Properties
|
|
592
632
|
|
|
593
633
|
| Property | Type | Description | Defined in |
|
|
594
634
|
| ------ | ------ | ------ | ------ |
|
|
595
|
-
| <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:
|
|
596
|
-
| <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:
|
|
597
|
-
| <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:
|
|
598
|
-
| <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:
|
|
599
|
-
| <a id="id"></a> `id` | `string` | - | [cobalt.ts:
|
|
600
|
-
| <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:
|
|
601
|
-
| <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:
|
|
602
|
-
| <a id="name-1"></a> `name` | `string` | - | [cobalt.ts:
|
|
603
|
-
| <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:
|
|
604
|
-
| <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:
|
|
605
|
-
| <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:
|
|
606
|
-
| <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:
|
|
607
|
-
| <a id="value"></a> `value?` | `any` | - | [cobalt.ts:
|
|
635
|
+
| <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [cobalt.ts:264](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L264) |
|
|
636
|
+
| <a id="field_type"></a> `field_type` | `string` | - | [cobalt.ts:245](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L245) |
|
|
637
|
+
| <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:262](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L262) |
|
|
638
|
+
| <a id="hidden"></a> `hidden?` | `boolean` | - | [cobalt.ts:257](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L257) |
|
|
639
|
+
| <a id="id"></a> `id` | `string` | - | [cobalt.ts:243](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L243) |
|
|
640
|
+
| <a id="labels"></a> `labels?` | `object`[] | - | [cobalt.ts:251](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L251) |
|
|
641
|
+
| <a id="multiple"></a> `multiple?` | `boolean` | - | [cobalt.ts:255](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L255) |
|
|
642
|
+
| <a id="name-1"></a> `name` | `string` | - | [cobalt.ts:244](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L244) |
|
|
643
|
+
| <a id="options"></a> `options?` | `object`[] | - | [cobalt.ts:246](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L246) |
|
|
644
|
+
| <a id="parent"></a> `parent?` | `string` | - | [cobalt.ts:250](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L250) |
|
|
645
|
+
| <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [cobalt.ts:260](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L260) |
|
|
646
|
+
| <a id="required"></a> `required?` | `boolean` | - | [cobalt.ts:256](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L256) |
|
|
647
|
+
| <a id="value"></a> `value?` | `any` | - | [cobalt.ts:258](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L258) |
|
|
608
648
|
|
|
609
649
|
***
|
|
610
650
|
|
|
611
651
|
### ConfigPayload
|
|
612
652
|
|
|
613
|
-
Defined in: [cobalt.ts:
|
|
653
|
+
Defined in: [cobalt.ts:116](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L116)
|
|
614
654
|
|
|
615
655
|
The payload object for config.
|
|
616
656
|
|
|
@@ -618,72 +658,87 @@ The payload object for config.
|
|
|
618
658
|
|
|
619
659
|
| Property | Type | Description | Defined in |
|
|
620
660
|
| ------ | ------ | ------ | ------ |
|
|
621
|
-
| <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:
|
|
622
|
-
| <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:
|
|
623
|
-
| <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:
|
|
661
|
+
| <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:120](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L120) |
|
|
662
|
+
| <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [cobalt.ts:122](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L122) |
|
|
663
|
+
| <a id="slug-2"></a> `slug` | `string` | The application slug. | [cobalt.ts:118](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L118) |
|
|
624
664
|
|
|
625
665
|
***
|
|
626
666
|
|
|
627
667
|
### ConfigWorkflow
|
|
628
668
|
|
|
629
|
-
Defined in: [cobalt.ts:
|
|
669
|
+
Defined in: [cobalt.ts:267](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L267)
|
|
630
670
|
|
|
631
671
|
#### Properties
|
|
632
672
|
|
|
633
673
|
| Property | Type | Defined in |
|
|
634
674
|
| ------ | ------ | ------ |
|
|
635
|
-
| <a id="description-1"></a> `description?` | `string` | [cobalt.ts:
|
|
636
|
-
| <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:
|
|
637
|
-
| <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:
|
|
638
|
-
| <a id="id-1"></a> `id` | `string` | [cobalt.ts:
|
|
639
|
-
| <a id="name-2"></a> `name` | `string` | [cobalt.ts:
|
|
675
|
+
| <a id="description-1"></a> `description?` | `string` | [cobalt.ts:270](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L270) |
|
|
676
|
+
| <a id="enabled"></a> `enabled` | `boolean` | [cobalt.ts:271](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L271) |
|
|
677
|
+
| <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [cobalt.ts:272](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L272) |
|
|
678
|
+
| <a id="id-1"></a> `id` | `string` | [cobalt.ts:268](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L268) |
|
|
679
|
+
| <a id="name-2"></a> `name` | `string` | [cobalt.ts:269](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L269) |
|
|
680
|
+
|
|
681
|
+
***
|
|
682
|
+
|
|
683
|
+
### ExecuteWorkflowPayload
|
|
684
|
+
|
|
685
|
+
Defined in: [cobalt.ts:281](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L281)
|
|
686
|
+
|
|
687
|
+
#### Properties
|
|
688
|
+
|
|
689
|
+
| Property | Type | Description | Defined in |
|
|
690
|
+
| ------ | ------ | ------ | ------ |
|
|
691
|
+
| <a id="payload"></a> `payload?` | `Record`\<`string`, `any`\> | The payload to execute the workflow. | [cobalt.ts:287](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L287) |
|
|
692
|
+
| <a id="slug-3"></a> `slug?` | `string` | The application's slug this workflow belongs to. | [cobalt.ts:285](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L285) |
|
|
693
|
+
| <a id="sync_execution"></a> `sync_execution?` | `boolean` | Whether to execute the workflow synchronously. | [cobalt.ts:289](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L289) |
|
|
694
|
+
| <a id="worklfow"></a> `worklfow` | `string` | The workflow id or alias. | [cobalt.ts:283](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L283) |
|
|
640
695
|
|
|
641
696
|
***
|
|
642
697
|
|
|
643
698
|
### Execution
|
|
644
699
|
|
|
645
|
-
Defined in: [cobalt.ts:
|
|
700
|
+
Defined in: [cobalt.ts:292](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L292)
|
|
646
701
|
|
|
647
702
|
#### Properties
|
|
648
703
|
|
|
649
704
|
| Property | Type | Defined in |
|
|
650
705
|
| ------ | ------ | ------ |
|
|
651
|
-
| <a id="_id"></a> `_id` | `string` | [cobalt.ts:
|
|
652
|
-
| <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:
|
|
653
|
-
| `associated_application._id` | `string` | [cobalt.ts:
|
|
654
|
-
| `associated_application.icon?` | `string` | [cobalt.ts:
|
|
655
|
-
| `associated_application.name` | `string` | [cobalt.ts:
|
|
656
|
-
| <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:
|
|
657
|
-
| <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:
|
|
658
|
-
| `associated_trigger_application._id` | `string` | [cobalt.ts:
|
|
659
|
-
| `associated_trigger_application.app_type?` | `string` | [cobalt.ts:
|
|
660
|
-
| `associated_trigger_application.icon?` | `string` | [cobalt.ts:
|
|
661
|
-
| `associated_trigger_application.name` | `string` | [cobalt.ts:
|
|
662
|
-
| `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:
|
|
663
|
-
| `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:
|
|
664
|
-
| `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:
|
|
665
|
-
| <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:
|
|
666
|
-
| `associated_workflow._id` | `string` | [cobalt.ts:
|
|
667
|
-
| `associated_workflow.name` | `string` | [cobalt.ts:
|
|
668
|
-
| <a id="completion_percentage"></a> `completion_percentage?` | `number` | [cobalt.ts:
|
|
669
|
-
| <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:
|
|
670
|
-
| <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:
|
|
671
|
-
| <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:
|
|
672
|
-
| <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:
|
|
673
|
-
| <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:
|
|
674
|
-
| <a id="id-2"></a> `id?` | `string` | [cobalt.ts:
|
|
675
|
-
| <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:
|
|
676
|
-
| <a id="name-3"></a> `name` | `string` | [cobalt.ts:
|
|
677
|
-
| <a id="nodes"></a> `nodes?` | `object`[] | [cobalt.ts:
|
|
678
|
-
| <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:
|
|
679
|
-
| <a id="status"></a> `status` | `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"` | [cobalt.ts:
|
|
680
|
-
| <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:
|
|
706
|
+
| <a id="_id"></a> `_id` | `string` | [cobalt.ts:293](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L293) |
|
|
707
|
+
| <a id="associated_application"></a> `associated_application` | `object` | [cobalt.ts:297](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L297) |
|
|
708
|
+
| `associated_application._id` | `string` | [cobalt.ts:298](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L298) |
|
|
709
|
+
| `associated_application.icon?` | `string` | [cobalt.ts:300](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L300) |
|
|
710
|
+
| `associated_application.name` | `string` | [cobalt.ts:299](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L299) |
|
|
711
|
+
| <a id="associated_event_id"></a> `associated_event_id` | `string` | [cobalt.ts:321](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L321) |
|
|
712
|
+
| <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [cobalt.ts:307](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L307) |
|
|
713
|
+
| `associated_trigger_application._id` | `string` | [cobalt.ts:308](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L308) |
|
|
714
|
+
| `associated_trigger_application.app_type?` | `string` | [cobalt.ts:311](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L311) |
|
|
715
|
+
| `associated_trigger_application.icon?` | `string` | [cobalt.ts:310](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L310) |
|
|
716
|
+
| `associated_trigger_application.name` | `string` | [cobalt.ts:309](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L309) |
|
|
717
|
+
| `associated_trigger_application.origin_trigger` | `object` | [cobalt.ts:312](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L312) |
|
|
718
|
+
| `associated_trigger_application.origin_trigger._id` | `string` | [cobalt.ts:313](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L313) |
|
|
719
|
+
| `associated_trigger_application.origin_trigger.name` | `string` | [cobalt.ts:314](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L314) |
|
|
720
|
+
| <a id="associated_workflow"></a> `associated_workflow` | `object` | [cobalt.ts:303](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L303) |
|
|
721
|
+
| `associated_workflow._id` | `string` | [cobalt.ts:304](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L304) |
|
|
722
|
+
| `associated_workflow.name` | `string` | [cobalt.ts:305](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L305) |
|
|
723
|
+
| <a id="completion_percentage"></a> `completion_percentage?` | `number` | [cobalt.ts:324](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L324) |
|
|
724
|
+
| <a id="config_id-2"></a> `config_id` | `string` | [cobalt.ts:320](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L320) |
|
|
725
|
+
| <a id="createdat"></a> `createdAt` | `string` | [cobalt.ts:336](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L336) |
|
|
726
|
+
| <a id="custom_application_id"></a> `custom_application_id?` | `string` | [cobalt.ts:323](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L323) |
|
|
727
|
+
| <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [cobalt.ts:322](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L322) |
|
|
728
|
+
| <a id="environment"></a> `environment` | `"test"` \| `"production"` | [cobalt.ts:319](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L319) |
|
|
729
|
+
| <a id="id-2"></a> `id?` | `string` | [cobalt.ts:294](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L294) |
|
|
730
|
+
| <a id="linked_account_id"></a> `linked_account_id` | `string` | [cobalt.ts:318](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L318) |
|
|
731
|
+
| <a id="name-3"></a> `name` | `string` | [cobalt.ts:295](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L295) |
|
|
732
|
+
| <a id="nodes"></a> `nodes?` | `object`[] | [cobalt.ts:325](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L325) |
|
|
733
|
+
| <a id="org_id"></a> `org_id` | `string` | [cobalt.ts:296](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L296) |
|
|
734
|
+
| <a id="status"></a> `status` | `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"` | [cobalt.ts:302](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L302) |
|
|
735
|
+
| <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [cobalt.ts:317](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L317) |
|
|
681
736
|
|
|
682
737
|
***
|
|
683
738
|
|
|
684
739
|
### InputField
|
|
685
740
|
|
|
686
|
-
Defined in: [cobalt.ts:
|
|
741
|
+
Defined in: [cobalt.ts:75](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L75)
|
|
687
742
|
|
|
688
743
|
An Input field to take input from the user.
|
|
689
744
|
|
|
@@ -691,20 +746,34 @@ An Input field to take input from the user.
|
|
|
691
746
|
|
|
692
747
|
| Property | Type | Description | Defined in |
|
|
693
748
|
| ------ | ------ | ------ | ------ |
|
|
694
|
-
| <a id="help_text-1"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:
|
|
695
|
-
| <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:
|
|
696
|
-
| <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:
|
|
697
|
-
| <a id="name-4"></a> `name` | `string` | Key name of the field. | [cobalt.ts:
|
|
698
|
-
| <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:
|
|
699
|
-
| <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:
|
|
700
|
-
| <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:
|
|
701
|
-
| <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:
|
|
749
|
+
| <a id="help_text-1"></a> `help_text?` | `string` | The help text for the field. | [cobalt.ts:89](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L89) |
|
|
750
|
+
| <a id="label"></a> `label` | `string` | The label of the field. | [cobalt.ts:87](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L87) |
|
|
751
|
+
| <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [cobalt.ts:83](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L83) |
|
|
752
|
+
| <a id="name-4"></a> `name` | `string` | Key name of the field. | [cobalt.ts:77](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L77) |
|
|
753
|
+
| <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [cobalt.ts:91](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L91) |
|
|
754
|
+
| <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [cobalt.ts:85](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L85) |
|
|
755
|
+
| <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [cobalt.ts:81](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L81) |
|
|
756
|
+
| <a id="type-1"></a> `type` | `string` | Input type of the field. | [cobalt.ts:79](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L79) |
|
|
757
|
+
|
|
758
|
+
***
|
|
759
|
+
|
|
760
|
+
### KeyBasedParams
|
|
761
|
+
|
|
762
|
+
Defined in: [cobalt.ts:106](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L106)
|
|
763
|
+
|
|
764
|
+
#### Properties
|
|
765
|
+
|
|
766
|
+
| Property | Type | Description | Defined in |
|
|
767
|
+
| ------ | ------ | ------ | ------ |
|
|
768
|
+
| <a id="connection"></a> `connection?` | `string` | The connection identifier. | [cobalt.ts:110](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L110) |
|
|
769
|
+
| <a id="payload-1"></a> `payload?` | `Record`\<`string`, `string`\> | The key value pairs of auth data. | [cobalt.ts:112](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L112) |
|
|
770
|
+
| <a id="slug-4"></a> `slug` | `string` | The application slug. | [cobalt.ts:108](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L108) |
|
|
702
771
|
|
|
703
772
|
***
|
|
704
773
|
|
|
705
774
|
### Label
|
|
706
775
|
|
|
707
|
-
Defined in: [cobalt.ts:
|
|
776
|
+
Defined in: [cobalt.ts:126](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L126)
|
|
708
777
|
|
|
709
778
|
Label Mapping
|
|
710
779
|
|
|
@@ -712,14 +781,28 @@ Label Mapping
|
|
|
712
781
|
|
|
713
782
|
| Property | Type | Description | Defined in |
|
|
714
783
|
| ------ | ------ | ------ | ------ |
|
|
715
|
-
| <a id="name-5"></a> `name` | `string` | The label name. | [cobalt.ts:
|
|
716
|
-
| <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:
|
|
784
|
+
| <a id="name-5"></a> `name` | `string` | The label name. | [cobalt.ts:128](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L128) |
|
|
785
|
+
| <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [cobalt.ts:130](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L130) |
|
|
786
|
+
|
|
787
|
+
***
|
|
788
|
+
|
|
789
|
+
### OAuthParams
|
|
790
|
+
|
|
791
|
+
Defined in: [cobalt.ts:97](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L97)
|
|
792
|
+
|
|
793
|
+
#### Properties
|
|
794
|
+
|
|
795
|
+
| Property | Type | Description | Defined in |
|
|
796
|
+
| ------ | ------ | ------ | ------ |
|
|
797
|
+
| <a id="connection-1"></a> `connection?` | `string` | The connection identifier. | [cobalt.ts:101](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L101) |
|
|
798
|
+
| <a id="payload-2"></a> `payload?` | `Record`\<`string`, `string`\> | The key value pairs of auth data. | [cobalt.ts:103](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L103) |
|
|
799
|
+
| <a id="slug-5"></a> `slug` | `string` | The application slug. | [cobalt.ts:99](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L99) |
|
|
717
800
|
|
|
718
801
|
***
|
|
719
802
|
|
|
720
803
|
### PublicWorkflow
|
|
721
804
|
|
|
722
|
-
Defined in: [cobalt.ts:
|
|
805
|
+
Defined in: [cobalt.ts:183](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L183)
|
|
723
806
|
|
|
724
807
|
A public workflow in Cobalt.
|
|
725
808
|
|
|
@@ -727,19 +810,19 @@ A public workflow in Cobalt.
|
|
|
727
810
|
|
|
728
811
|
| Property | Type | Description | Defined in |
|
|
729
812
|
| ------ | ------ | ------ | ------ |
|
|
730
|
-
| <a id="_id-1"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:
|
|
731
|
-
| <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:
|
|
732
|
-
| <a id="description-2"></a> `description?` | `string` | The workflow description. | [cobalt.ts:
|
|
733
|
-
| <a id="name-6"></a> `name` | `string` | The workflow name. | [cobalt.ts:
|
|
734
|
-
| <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:
|
|
735
|
-
| <a id="slug-
|
|
736
|
-
| <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [cobalt.ts:
|
|
813
|
+
| <a id="_id-1"></a> `_id` | `string` | The workflow ID. | [cobalt.ts:185](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L185) |
|
|
814
|
+
| <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [cobalt.ts:193](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L193) |
|
|
815
|
+
| <a id="description-2"></a> `description?` | `string` | The workflow description. | [cobalt.ts:189](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L189) |
|
|
816
|
+
| <a id="name-6"></a> `name` | `string` | The workflow name. | [cobalt.ts:187](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L187) |
|
|
817
|
+
| <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [cobalt.ts:197](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L197) |
|
|
818
|
+
| <a id="slug-6"></a> `slug?` | `string` | The application's slug in which this workflow exists. | [cobalt.ts:191](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L191) |
|
|
819
|
+
| <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [cobalt.ts:195](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L195) |
|
|
737
820
|
|
|
738
821
|
***
|
|
739
822
|
|
|
740
823
|
### PublicWorkflowPayload
|
|
741
824
|
|
|
742
|
-
Defined in: [cobalt.ts:
|
|
825
|
+
Defined in: [cobalt.ts:201](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L201)
|
|
743
826
|
|
|
744
827
|
The payload for creating a public workflow for the linked account.
|
|
745
828
|
|
|
@@ -747,15 +830,15 @@ The payload for creating a public workflow for the linked account.
|
|
|
747
830
|
|
|
748
831
|
| Property | Type | Description | Defined in |
|
|
749
832
|
| ------ | ------ | ------ | ------ |
|
|
750
|
-
| <a id="description-3"></a> `description?` | `string` | The workflow description. | [cobalt.ts:
|
|
751
|
-
| <a id="name-7"></a> `name` | `string` | The workflow name. | [cobalt.ts:
|
|
752
|
-
| <a id="slug-
|
|
833
|
+
| <a id="description-3"></a> `description?` | `string` | The workflow description. | [cobalt.ts:205](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L205) |
|
|
834
|
+
| <a id="name-7"></a> `name` | `string` | The workflow name. | [cobalt.ts:203](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L203) |
|
|
835
|
+
| <a id="slug-7"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [cobalt.ts:207](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L207) |
|
|
753
836
|
|
|
754
837
|
***
|
|
755
838
|
|
|
756
839
|
### PublicWorkflowsPayload
|
|
757
840
|
|
|
758
|
-
Defined in: [cobalt.ts:
|
|
841
|
+
Defined in: [cobalt.ts:210](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L210)
|
|
759
842
|
|
|
760
843
|
#### Extends
|
|
761
844
|
|
|
@@ -765,39 +848,39 @@ Defined in: [cobalt.ts:190](https://github.com/gocobalt/cobalt-js/blob/caefd941c
|
|
|
765
848
|
|
|
766
849
|
| Property | Type | Inherited from | Defined in |
|
|
767
850
|
| ------ | ------ | ------ | ------ |
|
|
768
|
-
| <a id="limit"></a> `limit?` | `number` | `PaginationProps.limit` | [cobalt.ts:
|
|
769
|
-
| <a id="page"></a> `page?` | `number` | `PaginationProps.page` | [cobalt.ts:
|
|
770
|
-
| <a id="slug-
|
|
851
|
+
| <a id="limit"></a> `limit?` | `number` | `PaginationProps.limit` | [cobalt.ts:216](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L216) |
|
|
852
|
+
| <a id="page"></a> `page?` | `number` | `PaginationProps.page` | [cobalt.ts:215](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L215) |
|
|
853
|
+
| <a id="slug-8"></a> `slug?` | `string` | - | [cobalt.ts:211](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L211) |
|
|
771
854
|
|
|
772
855
|
***
|
|
773
856
|
|
|
774
857
|
### RuleOptions
|
|
775
858
|
|
|
776
|
-
Defined in: [cobalt.ts:
|
|
859
|
+
Defined in: [cobalt.ts:162](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L162)
|
|
777
860
|
|
|
778
861
|
#### Properties
|
|
779
862
|
|
|
780
863
|
| Property | Type | Defined in |
|
|
781
864
|
| ------ | ------ | ------ |
|
|
782
|
-
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:
|
|
783
|
-
| <a id="error"></a> `error?` | `object` | [cobalt.ts:
|
|
784
|
-
| `error.message?` | `string` | [cobalt.ts:
|
|
785
|
-
| `error.stack?` | `string` | [cobalt.ts:
|
|
786
|
-
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:
|
|
787
|
-
| `rule_column.operator` | `object` | [cobalt.ts:
|
|
788
|
-
| `rule_column.operator.name` | `string` | [cobalt.ts:
|
|
789
|
-
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:
|
|
790
|
-
| `rule_column.operator.type` | `"select"` | [cobalt.ts:
|
|
791
|
-
| `rule_column.rhs` | `object` | [cobalt.ts:
|
|
792
|
-
| `rule_column.rhs.name` | `string` | [cobalt.ts:
|
|
793
|
-
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:
|
|
794
|
-
| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:
|
|
865
|
+
| <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [cobalt.ts:175](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L175) |
|
|
866
|
+
| <a id="error"></a> `error?` | `object` | [cobalt.ts:176](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L176) |
|
|
867
|
+
| `error.message?` | `string` | [cobalt.ts:177](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L177) |
|
|
868
|
+
| `error.stack?` | `string` | [cobalt.ts:178](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L178) |
|
|
869
|
+
| <a id="rule_column"></a> `rule_column` | `object` | [cobalt.ts:163](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L163) |
|
|
870
|
+
| `rule_column.operator` | `object` | [cobalt.ts:169](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L169) |
|
|
871
|
+
| `rule_column.operator.name` | `string` | [cobalt.ts:170](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L170) |
|
|
872
|
+
| `rule_column.operator.options` | [`Label`](#label-1)[] | [cobalt.ts:172](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L172) |
|
|
873
|
+
| `rule_column.operator.type` | `"select"` | [cobalt.ts:171](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L171) |
|
|
874
|
+
| `rule_column.rhs` | `object` | [cobalt.ts:164](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L164) |
|
|
875
|
+
| `rule_column.rhs.name` | `string` | [cobalt.ts:165](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L165) |
|
|
876
|
+
| `rule_column.rhs.options?` | [`Label`](#label-1)[] | [cobalt.ts:167](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L167) |
|
|
877
|
+
| `rule_column.rhs.type` | `"text"` \| `"select"` | [cobalt.ts:166](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L166) |
|
|
795
878
|
|
|
796
879
|
***
|
|
797
880
|
|
|
798
881
|
### UpdateConfigPayload
|
|
799
882
|
|
|
800
|
-
Defined in: [cobalt.ts:
|
|
883
|
+
Defined in: [cobalt.ts:134](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L134)
|
|
801
884
|
|
|
802
885
|
The configuration data for an application.
|
|
803
886
|
|
|
@@ -805,16 +888,16 @@ The configuration data for an application.
|
|
|
805
888
|
|
|
806
889
|
| Property | Type | Description | Defined in |
|
|
807
890
|
| ------ | ------ | ------ | ------ |
|
|
808
|
-
| <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:
|
|
809
|
-
| <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [cobalt.ts:
|
|
810
|
-
| <a id="slug-
|
|
811
|
-
| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:
|
|
891
|
+
| <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [cobalt.ts:138](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L138) |
|
|
892
|
+
| <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [cobalt.ts:140](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L140) |
|
|
893
|
+
| <a id="slug-9"></a> `slug` | `string` | The application slug | [cobalt.ts:136](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L136) |
|
|
894
|
+
| <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [cobalt.ts:142](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L142) |
|
|
812
895
|
|
|
813
896
|
***
|
|
814
897
|
|
|
815
898
|
### WorkflowPayload
|
|
816
899
|
|
|
817
|
-
Defined in: [cobalt.ts:
|
|
900
|
+
Defined in: [cobalt.ts:146](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L146)
|
|
818
901
|
|
|
819
902
|
The workflow.
|
|
820
903
|
|
|
@@ -822,6 +905,20 @@ The workflow.
|
|
|
822
905
|
|
|
823
906
|
| Property | Type | Description | Defined in |
|
|
824
907
|
| ------ | ------ | ------ | ------ |
|
|
825
|
-
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:
|
|
826
|
-
| <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [cobalt.ts:
|
|
827
|
-
| <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:
|
|
908
|
+
| <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [cobalt.ts:150](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L150) |
|
|
909
|
+
| <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [cobalt.ts:152](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L152) |
|
|
910
|
+
| <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [cobalt.ts:148](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L148) |
|
|
911
|
+
|
|
912
|
+
***
|
|
913
|
+
|
|
914
|
+
### WorkflowPayloadResponse
|
|
915
|
+
|
|
916
|
+
Defined in: [cobalt.ts:275](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L275)
|
|
917
|
+
|
|
918
|
+
#### Properties
|
|
919
|
+
|
|
920
|
+
| Property | Type | Defined in |
|
|
921
|
+
| ------ | ------ | ------ |
|
|
922
|
+
| <a id="payload-3"></a> `payload` | `Record`\<`string`, `any`\> | [cobalt.ts:276](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L276) |
|
|
923
|
+
| <a id="schema"></a> `schema?` | `unknown` | [cobalt.ts:277](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L277) |
|
|
924
|
+
| <a id="schema_interpreted"></a> `schema_interpreted?` | `unknown` | [cobalt.ts:278](https://github.com/gocobalt/cobalt-js/blob/1f74ac73d962f26dd757ccf54a623cc808ed24d9/cobalt.ts#L278) |
|