@refoldai/refold-js 10.0.0 → 10.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/CLAUDE.md +7 -5
  2. package/docs/assets/hierarchy.js +1 -1
  3. package/docs/assets/icons.js +1 -1
  4. package/docs/assets/icons.svg +1 -1
  5. package/docs/assets/main.js +3 -3
  6. package/docs/assets/navigation.js +1 -1
  7. package/docs/assets/search.js +1 -1
  8. package/docs/classes/Refold.html +29 -27
  9. package/docs/enums/AuthStatus.html +2 -2
  10. package/docs/enums/AuthType.html +2 -2
  11. package/docs/hierarchy.html +1 -1
  12. package/docs/interfaces/Application.html +14 -14
  13. package/docs/interfaces/Config.html +2 -2
  14. package/docs/interfaces/ConfigField.html +4 -4
  15. package/docs/interfaces/ConfigPayload.html +4 -4
  16. package/docs/interfaces/ConfigWorkflow.html +2 -2
  17. package/docs/interfaces/ConnectParams.html +11 -0
  18. package/docs/interfaces/ExecuteWorkflowPayload.html +5 -5
  19. package/docs/interfaces/Execution.html +2 -2
  20. package/docs/interfaces/ExecutionFilters.html +8 -8
  21. package/docs/interfaces/GetExecutionsParams.html +9 -9
  22. package/docs/interfaces/InputField.html +9 -9
  23. package/docs/interfaces/KeyBasedParams.html +5 -0
  24. package/docs/interfaces/Label.html +3 -3
  25. package/docs/interfaces/OAuthParams.html +9 -0
  26. package/docs/interfaces/PublicWorkflow.html +8 -8
  27. package/docs/interfaces/PublicWorkflowPayload.html +4 -4
  28. package/docs/interfaces/PublicWorkflowsPayload.html +7 -7
  29. package/docs/interfaces/RefoldOptions.html +3 -3
  30. package/docs/interfaces/RuleOptions.html +2 -2
  31. package/docs/interfaces/UpdateConfigPayload.html +5 -5
  32. package/docs/interfaces/WorkflowPayload.html +4 -4
  33. package/docs/interfaces/WorkflowPayloadResponse.html +2 -2
  34. package/docs/llms.txt +248 -197
  35. package/docs/modules.html +1 -1
  36. package/docs/types/ExecutionSource.html +1 -1
  37. package/docs/types/ExecutionStatus.html +1 -1
  38. package/docs/types/ExecutionType.html +1 -1
  39. package/package.json +2 -2
  40. package/refold.d.ts +31 -9
  41. package/refold.js +84 -47
  42. package/refold.ts +123 -48
package/docs/llms.txt CHANGED
@@ -70,20 +70,20 @@ refold.token = "REFOLD_SESSION_TOKEN";
70
70
 
71
71
  ### AuthStatus
72
72
 
73
- Defined in: [refold.ts:10](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L10)
73
+ Defined in: [refold.ts:10](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.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"` | [refold.ts:11](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L11) |
80
- | <a id="enumeration-member-expired"></a> `Expired` | `"expired"` | [refold.ts:12](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L12) |
79
+ | <a id="enumeration-member-active"></a> `Active` | `"active"` | [refold.ts:11](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L11) |
80
+ | <a id="enumeration-member-expired"></a> `Expired` | `"expired"` | [refold.ts:12](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L12) |
81
81
 
82
82
  ***
83
83
 
84
84
  ### AuthType
85
85
 
86
- Defined in: [refold.ts:5](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L5)
86
+ Defined in: [refold.ts:5](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L5)
87
87
 
88
88
  Refold Frontend SDK
89
89
 
@@ -91,14 +91,14 @@ Refold Frontend SDK
91
91
 
92
92
  | Enumeration Member | Value | Defined in |
93
93
  | ------ | ------ | ------ |
94
- | <a id="enumeration-member-keybased"></a> `KeyBased` | `"keybased"` | [refold.ts:7](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L7) |
95
- | <a id="enumeration-member-oauth2"></a> `OAuth2` | `"oauth2"` | [refold.ts:6](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L6) |
94
+ | <a id="enumeration-member-keybased"></a> `KeyBased` | `"keybased"` | [refold.ts:7](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L7) |
95
+ | <a id="enumeration-member-oauth2"></a> `OAuth2` | `"oauth2"` | [refold.ts:6](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L6) |
96
96
 
97
97
  ## Classes
98
98
 
99
99
  ### Refold
100
100
 
101
- Defined in: [refold.ts:364](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L364)
101
+ Defined in: [refold.ts:396](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L396)
102
102
 
103
103
  #### Constructors
104
104
 
@@ -106,7 +106,7 @@ Defined in: [refold.ts:364](https://github.com/gocobalt/refold-js/blob/c234ec1f1
106
106
 
107
107
  > **new Refold**(`options?`): [`Refold`](#refold)
108
108
 
109
- Defined in: [refold.ts:374](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L374)
109
+ Defined in: [refold.ts:406](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L406)
110
110
 
111
111
  Refold Frontend SDK
112
112
 
@@ -124,7 +124,7 @@ Refold Frontend SDK
124
124
 
125
125
  | Property | Modifier | Type | Defined in |
126
126
  | ------ | ------ | ------ | ------ |
127
- | <a id="token"></a> `token` | `public` | `string` | [refold.ts:366](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L366) |
127
+ | <a id="token"></a> `token` | `public` | `string` | [refold.ts:398](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L398) |
128
128
 
129
129
  #### Methods
130
130
 
@@ -132,7 +132,7 @@ Refold Frontend SDK
132
132
 
133
133
  > **config**(`payload`): `Promise`\<[`Config`](#config-1)\>
134
134
 
135
- Defined in: [refold.ts:638](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L638)
135
+ Defined in: [refold.ts:713](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L713)
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: [refold.ts:591](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L591)
155
+ Defined in: [refold.ts:668](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L668)
156
156
 
157
157
  Connects the specified application using the provided authentication type and optional auth data.
158
158
 
@@ -160,10 +160,7 @@ 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. |
164
- | `params.payload?` | `Record`\<`string`, `string`\> | key-value pairs of authentication data required for the specified auth type. |
165
- | `params.slug` | `string` | The application slug. |
166
- | `params.type?` | [`AuthType`](#authtype) | The authentication type to use. If not provided, it defaults to `keybased` if payload is provided, otherwise `oauth2`. |
163
+ | `params` | [`ConnectParams`](#connectparams) | The parameters for connecting the application. |
167
164
 
168
165
  ###### Returns
169
166
 
@@ -179,7 +176,7 @@ Throws an error if the authentication type is invalid or the connection fails.
179
176
 
180
177
  > **createWorkflow**(`params`): `Promise`\<[`PublicWorkflow`](#publicworkflow)\>
181
178
 
182
- Defined in: [refold.ts:896](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L896)
179
+ Defined in: [refold.ts:971](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L971)
183
180
 
184
181
  Create a public workflow for the linked account.
185
182
 
@@ -199,7 +196,7 @@ The created public workflow.
199
196
 
200
197
  > **deleteConfig**(`slug`, `configId?`): `Promise`\<`unknown`\>
201
198
 
202
- Defined in: [refold.ts:731](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L731)
199
+ Defined in: [refold.ts:806](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L806)
203
200
 
204
201
  Delete the specified config.
205
202
 
@@ -218,7 +215,7 @@ Delete the specified config.
218
215
 
219
216
  > **deleteConfigField**(`slug`, `fieldId`, `workflowId?`): `Promise`\<`unknown`\>
220
217
 
221
- Defined in: [refold.ts:808](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L808)
218
+ Defined in: [refold.ts:883](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L883)
222
219
 
223
220
  Delete the specified config field value.
224
221
 
@@ -238,7 +235,7 @@ Delete the specified config field value.
238
235
 
239
236
  > **deleteWorkflow**(`workflowId`): `Promise`\<`unknown`\>
240
237
 
241
- Defined in: [refold.ts:924](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L924)
238
+ Defined in: [refold.ts:999](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L999)
242
239
 
243
240
  Delete the specified public workflow.
244
241
 
@@ -256,7 +253,7 @@ Delete the specified public workflow.
256
253
 
257
254
  > **disconnect**(`slug`, `type?`): `Promise`\<`unknown`\>
258
255
 
259
- Defined in: [refold.ts:617](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L617)
256
+ Defined in: [refold.ts:692](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L692)
260
257
 
261
258
  Disconnect the specified application and remove any associated data from Refold.
262
259
 
@@ -275,7 +272,7 @@ Disconnect the specified application and remove any associated data from Refold.
275
272
 
276
273
  > **executeWorkflow**(`options`): `Promise`\<`unknown`\>
277
274
 
278
- Defined in: [refold.ts:968](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L968)
275
+ Defined in: [refold.ts:1043](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L1043)
279
276
 
280
277
  Execute the specified public workflow.
281
278
 
@@ -297,13 +294,15 @@ it returns all the enabled applications.
297
294
 
298
295
  ###### Param
299
296
 
297
+ **slug**
298
+
300
299
  The application slug.
301
300
 
302
301
  ###### Call Signature
303
302
 
304
303
  > **getApp**(): `Promise`\<[`Application`](#application)[]\>
305
304
 
306
- Defined in: [refold.ts:434](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L434)
305
+ Defined in: [refold.ts:466](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L466)
307
306
 
308
307
  Returns the list of enabled applications and their details.
309
308
 
@@ -317,7 +316,7 @@ The list of applications.
317
316
 
318
317
  > **getApp**(`slug`): `Promise`\<[`Application`](#application)\>
319
318
 
320
- Defined in: [refold.ts:441](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L441)
319
+ Defined in: [refold.ts:473](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L473)
321
320
 
322
321
  Returns the application details for the specified application, provided
323
322
  the application is enabled in Refold.
@@ -338,7 +337,7 @@ The application details.
338
337
 
339
338
  > **getApps**(): `Promise`\<[`Application`](#application)[]\>
340
339
 
341
- Defined in: [refold.ts:469](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L469)
340
+ Defined in: [refold.ts:501](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L501)
342
341
 
343
342
  Returns all the enabled apps.
344
343
 
@@ -352,7 +351,7 @@ The list of applications.
352
351
 
353
352
  > **getConfig**(`slug`, `configId?`, `excludeOptions?`): `Promise`\<[`Config`](#config-1)\>
354
353
 
355
- Defined in: [refold.ts:686](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L686)
354
+ Defined in: [refold.ts:761](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L761)
356
355
 
357
356
  Returns the specified config.
358
357
 
@@ -374,7 +373,7 @@ The specified config.
374
373
 
375
374
  > **getConfigField**(`slug`, `fieldId`, `workflowId?`, `payload?`): `Promise`\<[`Config`](#config-1)\>
376
375
 
377
- Defined in: [refold.ts:755](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L755)
376
+ Defined in: [refold.ts:830](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L830)
378
377
 
379
378
  Returns the specified field of the config.
380
379
 
@@ -397,7 +396,7 @@ The specified config field.
397
396
 
398
397
  > **getConfigs**(`slug`): `Promise`\<`object`[]\>
399
398
 
400
- Defined in: [refold.ts:664](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L664)
399
+ Defined in: [refold.ts:739](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L739)
401
400
 
402
401
  Returns the configs created for the specified application.
403
402
 
@@ -417,7 +416,7 @@ The configs created for the specified application.
417
416
 
418
417
  > **getExecution**(`executionId`): `Promise`\<[`Execution`](#execution)\>
419
418
 
420
- Defined in: [refold.ts:1028](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L1028)
419
+ Defined in: [refold.ts:1103](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L1103)
421
420
 
422
421
  Returns the specified workflow execution log.
423
422
 
@@ -437,7 +436,7 @@ The specified execution log.
437
436
 
438
437
  > **getExecutions**(`params?`): `Promise`\<`PaginatedResponse`\<[`Execution`](#execution)\>\>
439
438
 
440
- Defined in: [refold.ts:1002](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L1002)
439
+ Defined in: [refold.ts:1077](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L1077)
441
440
 
442
441
  Returns the workflow execution logs for the linked account.
443
442
 
@@ -457,7 +456,7 @@ The paginated workflow execution logs.
457
456
 
458
457
  > **getFieldOptions**(`lhs`, `slug`, `fieldId`, `workflowId?`): `Promise`\<[`RuleOptions`](#ruleoptions)\>
459
458
 
460
- Defined in: [refold.ts:833](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L833)
459
+ Defined in: [refold.ts:908](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L908)
461
460
 
462
461
  Returns the options for the specified field.
463
462
 
@@ -480,7 +479,7 @@ The specified rule field's options.
480
479
 
481
480
  > **getWorkflowPayload**(`workflowId`): `Promise`\<[`WorkflowPayloadResponse`](#workflowpayloadresponse)\>
482
481
 
483
- Defined in: [refold.ts:945](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L945)
482
+ Defined in: [refold.ts:1020](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L1020)
484
483
 
485
484
  Returns the execution payload for the specified public workflow.
486
485
 
@@ -500,7 +499,7 @@ The workflow payload response.
500
499
 
501
500
  > **getWorkflows**(`params?`): `Promise`\<`PaginatedResponse`\<[`PublicWorkflow`](#publicworkflow)\>\>
502
501
 
503
- Defined in: [refold.ts:866](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L866)
502
+ Defined in: [refold.ts:941](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L941)
504
503
 
505
504
  Returns the private workflows for the specified application.
506
505
 
@@ -518,7 +517,7 @@ Returns the private workflows for the specified application.
518
517
 
519
518
  > **updateConfig**(`payload`): `Promise`\<[`Config`](#config-1)\>
520
519
 
521
- Defined in: [refold.ts:707](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L707)
520
+ Defined in: [refold.ts:782](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L782)
522
521
 
523
522
  Update the specified config.
524
523
 
@@ -538,7 +537,7 @@ The specified config.
538
537
 
539
538
  > **updateConfigField**(`slug`, `fieldId`, `value`, `workflowId?`): `Promise`\<[`Config`](#config-1)\>
540
539
 
541
- Defined in: [refold.ts:782](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L782)
540
+ Defined in: [refold.ts:857](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L857)
542
541
 
543
542
  Update the specified config field value.
544
543
 
@@ -561,7 +560,7 @@ The updated config field.
561
560
 
562
561
  ### Application
563
562
 
564
- Defined in: [refold.ts:16](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L16)
563
+ Defined in: [refold.ts:16](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L16)
565
564
 
566
565
  An application in Refold.
567
566
 
@@ -569,67 +568,67 @@ An application in Refold.
569
568
 
570
569
  | Property | Type | Description | Defined in |
571
570
  | ------ | ------ | ------ | ------ |
572
- | <a id="app_id"></a> `app_id` | `string` | Application ID | [refold.ts:18](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L18) |
573
- | <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. | [refold.ts:69](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L69) |
574
- | <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. | [refold.ts:54](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L54) |
575
- | <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. | [refold.ts:35](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L35) |
571
+ | <a id="app_id"></a> `app_id` | `string` | Application ID | [refold.ts:18](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L18) |
572
+ | <a id="auth_input_map"></a> ~~`auth_input_map?`~~ | [`InputField`](#inputfield)[] | The fields required from the user to connect the application (for `keybased` auth type). **Deprecated** Check `auth_type_options` for multiple auth types support. | [refold.ts:69](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L69) |
573
+ | <a id="auth_type"></a> ~~`auth_type`~~ | `"oauth2"` \| `"keybased"` | The type of auth used by application. **Deprecated** Check `auth_type_options` and `connected_accounts` for multiple auth types support. | [refold.ts:54](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L54) |
574
+ | <a id="auth_type_options"></a> `auth_type_options?` | `object` | The supported auth types for the application, and the fields required from the user to connect the application. | [refold.ts:35](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L35) |
576
575
  | `auth_type_options.keybased` | [`InputField`](#inputfield)[] | - | |
577
576
  | `auth_type_options.oauth2` | [`InputField`](#inputfield)[] | - | |
578
- | <a id="connected"></a> ~~`connected?`~~ | `boolean` | Whether the user has connected the application. **Deprecated** Check `connected_accounts` for multiple auth types support. | [refold.ts:59](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L59) |
579
- | <a id="connected_accounts"></a> `connected_accounts?` | `object`[] | The list of connected accounts for this application | [refold.ts:40](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L40) |
580
- | <a id="description"></a> `description` | `string` | The application description. | [refold.ts:22](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L22) |
581
- | <a id="icon"></a> `icon` | `string` | The application icon. | [refold.ts:24](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L24) |
582
- | <a id="name"></a> `name` | `string` | The application name. | [refold.ts:20](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L20) |
583
- | <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. | [refold.ts:64](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L64) |
584
- | <a id="slug"></a> `slug` | `string` | The application slug. | [refold.ts:31](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L31) |
585
- | <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [refold.ts:33](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L33) |
586
- | <a id="type"></a> ~~`type`~~ | `string` | **Deprecated** Use `slug` instead. The application slug for native apps and `custom` for custom apps. | [refold.ts:29](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L29) |
577
+ | <a id="connected"></a> ~~`connected?`~~ | `boolean` | Whether the user has connected the application. **Deprecated** Check `connected_accounts` for multiple auth types support. | [refold.ts:59](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L59) |
578
+ | <a id="connected_accounts"></a> `connected_accounts?` | `object`[] | The list of connected accounts for this application | [refold.ts:40](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L40) |
579
+ | <a id="description"></a> `description` | `string` | The application description. | [refold.ts:22](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L22) |
580
+ | <a id="icon"></a> `icon` | `string` | The application icon. | [refold.ts:24](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L24) |
581
+ | <a id="name"></a> `name` | `string` | The application name. | [refold.ts:20](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L20) |
582
+ | <a id="reauth_required"></a> ~~`reauth_required?`~~ | `boolean` | Whether the connection has expired and re-auth is required. **Deprecated** Check `connected_accounts` for multiple auth types support. | [refold.ts:64](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L64) |
583
+ | <a id="slug"></a> `slug` | `string` | The application slug. | [refold.ts:31](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L31) |
584
+ | <a id="tags"></a> `tags?` | `string`[] | The categories/tags for the application. | [refold.ts:33](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L33) |
585
+ | <a id="type"></a> ~~`type`~~ | `string` | **Deprecated** Use `slug` instead. The application slug for native apps and `custom` for custom apps. | [refold.ts:29](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L29) |
587
586
 
588
587
  ***
589
588
 
590
589
  ### Config
591
590
 
592
- Defined in: [refold.ts:250](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L250)
591
+ Defined in: [refold.ts:273](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L273)
593
592
 
594
593
  #### Properties
595
594
 
596
595
  | Property | Type | Defined in |
597
596
  | ------ | ------ | ------ |
598
- | <a id="config_id"></a> `config_id?` | `string` | [refold.ts:252](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L252) |
599
- | <a id="field_errors"></a> `field_errors?` | `object`[] | [refold.ts:255](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L255) |
600
- | <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [refold.ts:253](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L253) |
601
- | <a id="slug-1"></a> `slug` | `string` | [refold.ts:251](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L251) |
602
- | <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [refold.ts:254](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L254) |
597
+ | <a id="config_id"></a> `config_id?` | `string` | [refold.ts:275](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L275) |
598
+ | <a id="field_errors"></a> `field_errors?` | `object`[] | [refold.ts:278](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L278) |
599
+ | <a id="fields"></a> `fields?` | [`ConfigField`](#configfield)[] | [refold.ts:276](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L276) |
600
+ | <a id="slug-1"></a> `slug` | `string` | [refold.ts:274](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L274) |
601
+ | <a id="workflows"></a> `workflows?` | [`ConfigWorkflow`](#configworkflow)[] | [refold.ts:277](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L277) |
603
602
 
604
603
  ***
605
604
 
606
605
  ### ConfigField
607
606
 
608
- Defined in: [refold.ts:265](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L265)
607
+ Defined in: [refold.ts:288](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L288)
609
608
 
610
609
  #### Properties
611
610
 
612
611
  | Property | Type | Description | Defined in |
613
612
  | ------ | ------ | ------ | ------ |
614
- | <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [refold.ts:287](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L287) |
615
- | <a id="field_type"></a> `field_type` | `string` | - | [refold.ts:268](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L268) |
616
- | <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [refold.ts:285](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L285) |
617
- | <a id="hidden"></a> `hidden?` | `boolean` | - | [refold.ts:280](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L280) |
618
- | <a id="id"></a> `id` | `string` | - | [refold.ts:266](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L266) |
619
- | <a id="labels"></a> `labels?` | `object`[] | - | [refold.ts:274](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L274) |
620
- | <a id="multiple"></a> `multiple?` | `boolean` | - | [refold.ts:278](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L278) |
621
- | <a id="name-1"></a> `name` | `string` | - | [refold.ts:267](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L267) |
622
- | <a id="options"></a> `options?` | `object`[] | - | [refold.ts:269](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L269) |
623
- | <a id="parent"></a> `parent?` | `string` | - | [refold.ts:273](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L273) |
624
- | <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [refold.ts:283](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L283) |
625
- | <a id="required"></a> `required?` | `boolean` | - | [refold.ts:279](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L279) |
626
- | <a id="value"></a> `value?` | `any` | - | [refold.ts:281](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L281) |
613
+ | <a id="associated_page"></a> `associated_page?` | `string` | The page this field is associated with. | [refold.ts:310](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L310) |
614
+ | <a id="field_type"></a> `field_type` | `string` | - | [refold.ts:291](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L291) |
615
+ | <a id="help_text"></a> `help_text?` | `string` | The help text for the field. | [refold.ts:308](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L308) |
616
+ | <a id="hidden"></a> `hidden?` | `boolean` | - | [refold.ts:303](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L303) |
617
+ | <a id="id"></a> `id` | `string` | - | [refold.ts:289](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L289) |
618
+ | <a id="labels"></a> `labels?` | `object`[] | - | [refold.ts:297](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L297) |
619
+ | <a id="multiple"></a> `multiple?` | `boolean` | - | [refold.ts:301](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L301) |
620
+ | <a id="name-1"></a> `name` | `string` | - | [refold.ts:290](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L290) |
621
+ | <a id="options"></a> `options?` | `object`[] | - | [refold.ts:292](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L292) |
622
+ | <a id="parent"></a> `parent?` | `string` | - | [refold.ts:296](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L296) |
623
+ | <a id="placeholder"></a> `placeholder?` | `string` | The placeholder for the field. | [refold.ts:306](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L306) |
624
+ | <a id="required"></a> `required?` | `boolean` | - | [refold.ts:302](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L302) |
625
+ | <a id="value"></a> `value?` | `any` | - | [refold.ts:304](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L304) |
627
626
 
628
627
  ***
629
628
 
630
629
  ### ConfigPayload
631
630
 
632
- Defined in: [refold.ts:96](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L96)
631
+ Defined in: [refold.ts:119](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L119)
633
632
 
634
633
  The payload object for config.
635
634
 
@@ -637,87 +636,107 @@ The payload object for config.
637
636
 
638
637
  | Property | Type | Description | Defined in |
639
638
  | ------ | ------ | ------ | ------ |
640
- | <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [refold.ts:100](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L100) |
641
- | <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [refold.ts:102](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L102) |
642
- | <a id="slug-2"></a> `slug` | `string` | The application slug. | [refold.ts:98](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L98) |
639
+ | <a id="config_id-1"></a> `config_id?` | `string` | Unique ID for the config. | [refold.ts:123](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L123) |
640
+ | <a id="labels-1"></a> `labels?` | [`Label`](#label-1)[] | The dynamic label mappings. | [refold.ts:125](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L125) |
641
+ | <a id="slug-2"></a> `slug` | `string` | The application slug. | [refold.ts:121](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L121) |
643
642
 
644
643
  ***
645
644
 
646
645
  ### ConfigWorkflow
647
646
 
648
- Defined in: [refold.ts:290](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L290)
647
+ Defined in: [refold.ts:313](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L313)
649
648
 
650
649
  #### Properties
651
650
 
652
651
  | Property | Type | Defined in |
653
652
  | ------ | ------ | ------ |
654
- | <a id="description-1"></a> `description?` | `string` | [refold.ts:293](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L293) |
655
- | <a id="enabled"></a> `enabled` | `boolean` | [refold.ts:294](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L294) |
656
- | <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [refold.ts:295](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L295) |
657
- | <a id="id-1"></a> `id` | `string` | [refold.ts:291](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L291) |
658
- | <a id="name-2"></a> `name` | `string` | [refold.ts:292](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L292) |
653
+ | <a id="description-1"></a> `description?` | `string` | [refold.ts:316](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L316) |
654
+ | <a id="enabled"></a> `enabled` | `boolean` | [refold.ts:317](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L317) |
655
+ | <a id="fields-1"></a> `fields?` | [`ConfigField`](#configfield)[] | [refold.ts:318](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L318) |
656
+ | <a id="id-1"></a> `id` | `string` | [refold.ts:314](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L314) |
657
+ | <a id="name-2"></a> `name` | `string` | [refold.ts:315](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L315) |
658
+
659
+ ***
660
+
661
+ ### ConnectParams
662
+
663
+ Defined in: [refold.ts:113](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L113)
664
+
665
+ #### Extends
666
+
667
+ - [`OAuthParams`](#oauthparams)
668
+
669
+ #### Properties
670
+
671
+ | Property | Type | Description | Inherited from | Defined in |
672
+ | ------ | ------ | ------ | ------ | ------ |
673
+ | <a id="autoclose"></a> `autoClose?` | `boolean` | Whether to close the authentication window automatically. | [`OAuthParams`](#oauthparams).[`autoClose`](#autoclose-1) | [refold.ts:101](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L101) |
674
+ | <a id="payload"></a> `payload?` | `Record`\<`string`, `string`\> | The key value pairs of auth data. | [`OAuthParams`](#oauthparams).[`payload`](#payload-3) | [refold.ts:99](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L99) |
675
+ | <a id="slug-3"></a> `slug` | `string` | The application slug. | [`OAuthParams`](#oauthparams).[`slug`](#slug-6) | [refold.ts:97](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L97) |
676
+ | <a id="timeout"></a> `timeout?` | `number` | Maximum time in milliseconds to wait for authentication before giving up. Set to `0` to wait indefinitely. Defaults to 5 minutes. | [`OAuthParams`](#oauthparams).[`timeout`](#timeout-1) | [refold.ts:103](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L103) |
677
+ | <a id="type-1"></a> `type?` | [`AuthType`](#authtype) | The authentication type to use. If not provided, it defaults to `keybased` if payload is provided, otherwise `oauth2`. | - | [refold.ts:115](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L115) |
659
678
 
660
679
  ***
661
680
 
662
681
  ### ExecuteWorkflowPayload
663
682
 
664
- Defined in: [refold.ts:304](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L304)
683
+ Defined in: [refold.ts:327](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L327)
665
684
 
666
685
  #### Properties
667
686
 
668
687
  | Property | Type | Description | Defined in |
669
688
  | ------ | ------ | ------ | ------ |
670
- | <a id="payload"></a> `payload?` | `Record`\<`string`, `any`\> | The payload to execute the workflow. | [refold.ts:310](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L310) |
671
- | <a id="slug-3"></a> `slug?` | `string` | The application's slug this workflow belongs to. | [refold.ts:308](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L308) |
672
- | <a id="sync_execution"></a> `sync_execution?` | `boolean` | Whether to execute the workflow synchronously. | [refold.ts:312](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L312) |
673
- | <a id="worklfow"></a> `worklfow` | `string` | The workflow id or alias. | [refold.ts:306](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L306) |
689
+ | <a id="payload-1"></a> `payload?` | `Record`\<`string`, `any`\> | The payload to execute the workflow. | [refold.ts:333](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L333) |
690
+ | <a id="slug-4"></a> `slug?` | `string` | The application's slug this workflow belongs to. | [refold.ts:331](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L331) |
691
+ | <a id="sync_execution"></a> `sync_execution?` | `boolean` | Whether to execute the workflow synchronously. | [refold.ts:335](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L335) |
692
+ | <a id="worklfow"></a> `worklfow` | `string` | The workflow id or alias. | [refold.ts:329](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L329) |
674
693
 
675
694
  ***
676
695
 
677
696
  ### Execution
678
697
 
679
- Defined in: [refold.ts:315](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L315)
698
+ Defined in: [refold.ts:338](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L338)
680
699
 
681
700
  #### Properties
682
701
 
683
702
  | Property | Type | Defined in |
684
703
  | ------ | ------ | ------ |
685
- | <a id="_id"></a> `_id` | `string` | [refold.ts:316](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L316) |
686
- | <a id="associated_application"></a> `associated_application` | `object` | [refold.ts:320](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L320) |
687
- | `associated_application._id` | `string` | [refold.ts:321](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L321) |
688
- | `associated_application.icon?` | `string` | [refold.ts:323](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L323) |
689
- | `associated_application.name` | `string` | [refold.ts:322](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L322) |
690
- | <a id="associated_event_id"></a> `associated_event_id` | `string` | [refold.ts:344](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L344) |
691
- | <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [refold.ts:330](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L330) |
692
- | `associated_trigger_application._id` | `string` | [refold.ts:331](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L331) |
693
- | `associated_trigger_application.app_type?` | `string` | [refold.ts:334](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L334) |
694
- | `associated_trigger_application.icon?` | `string` | [refold.ts:333](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L333) |
695
- | `associated_trigger_application.name` | `string` | [refold.ts:332](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L332) |
696
- | `associated_trigger_application.origin_trigger` | `object` | [refold.ts:335](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L335) |
697
- | `associated_trigger_application.origin_trigger._id` | `string` | [refold.ts:336](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L336) |
698
- | `associated_trigger_application.origin_trigger.name` | `string` | [refold.ts:337](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L337) |
699
- | <a id="associated_workflow"></a> `associated_workflow` | `object` | [refold.ts:326](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L326) |
700
- | `associated_workflow._id` | `string` | [refold.ts:327](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L327) |
701
- | `associated_workflow.name` | `string` | [refold.ts:328](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L328) |
702
- | <a id="completion_percentage"></a> `completion_percentage?` | `number` | [refold.ts:347](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L347) |
703
- | <a id="config_id-2"></a> `config_id` | `string` | [refold.ts:343](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L343) |
704
- | <a id="createdat"></a> `createdAt` | `string` | [refold.ts:359](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L359) |
705
- | <a id="custom_application_id"></a> `custom_application_id?` | `string` | [refold.ts:346](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L346) |
706
- | <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [refold.ts:345](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L345) |
707
- | <a id="environment"></a> `environment` | `"test"` \| `"production"` | [refold.ts:342](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L342) |
708
- | <a id="id-2"></a> `id?` | `string` | [refold.ts:317](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L317) |
709
- | <a id="linked_account_id"></a> `linked_account_id` | `string` | [refold.ts:341](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L341) |
710
- | <a id="name-3"></a> `name` | `string` | [refold.ts:318](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L318) |
711
- | <a id="nodes"></a> `nodes?` | `object`[] | [refold.ts:348](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L348) |
712
- | <a id="org_id"></a> `org_id` | `string` | [refold.ts:319](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L319) |
713
- | <a id="status"></a> `status` | [`ExecutionStatus`](#executionstatus-1) | [refold.ts:325](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L325) |
714
- | <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [refold.ts:340](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L340) |
704
+ | <a id="_id"></a> `_id` | `string` | [refold.ts:339](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L339) |
705
+ | <a id="associated_application"></a> `associated_application` | `object` | [refold.ts:343](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L343) |
706
+ | `associated_application._id` | `string` | [refold.ts:344](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L344) |
707
+ | `associated_application.icon?` | `string` | [refold.ts:346](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L346) |
708
+ | `associated_application.name` | `string` | [refold.ts:345](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L345) |
709
+ | <a id="associated_event_id"></a> `associated_event_id` | `string` | [refold.ts:367](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L367) |
710
+ | <a id="associated_trigger_application"></a> `associated_trigger_application` | `object` | [refold.ts:353](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L353) |
711
+ | `associated_trigger_application._id` | `string` | [refold.ts:354](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L354) |
712
+ | `associated_trigger_application.app_type?` | `string` | [refold.ts:357](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L357) |
713
+ | `associated_trigger_application.icon?` | `string` | [refold.ts:356](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L356) |
714
+ | `associated_trigger_application.name` | `string` | [refold.ts:355](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L355) |
715
+ | `associated_trigger_application.origin_trigger` | `object` | [refold.ts:358](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L358) |
716
+ | `associated_trigger_application.origin_trigger._id` | `string` | [refold.ts:359](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L359) |
717
+ | `associated_trigger_application.origin_trigger.name` | `string` | [refold.ts:360](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L360) |
718
+ | <a id="associated_workflow"></a> `associated_workflow` | `object` | [refold.ts:349](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L349) |
719
+ | `associated_workflow._id` | `string` | [refold.ts:350](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L350) |
720
+ | `associated_workflow.name` | `string` | [refold.ts:351](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L351) |
721
+ | <a id="completion_percentage"></a> `completion_percentage?` | `number` | [refold.ts:370](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L370) |
722
+ | <a id="config_id-2"></a> `config_id` | `string` | [refold.ts:366](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L366) |
723
+ | <a id="createdat"></a> `createdAt` | `string` | [refold.ts:382](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L382) |
724
+ | <a id="custom_application_id"></a> `custom_application_id?` | `string` | [refold.ts:369](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L369) |
725
+ | <a id="custom_trigger_id"></a> `custom_trigger_id?` | `string` | [refold.ts:368](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L368) |
726
+ | <a id="environment"></a> `environment` | `"test"` \| `"production"` | [refold.ts:365](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L365) |
727
+ | <a id="id-2"></a> `id?` | `string` | [refold.ts:340](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L340) |
728
+ | <a id="linked_account_id"></a> `linked_account_id` | `string` | [refold.ts:364](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L364) |
729
+ | <a id="name-3"></a> `name` | `string` | [refold.ts:341](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L341) |
730
+ | <a id="nodes"></a> `nodes?` | `object`[] | [refold.ts:371](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L371) |
731
+ | <a id="org_id"></a> `org_id` | `string` | [refold.ts:342](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L342) |
732
+ | <a id="status"></a> `status` | [`ExecutionStatus`](#executionstatus-1) | [refold.ts:348](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L348) |
733
+ | <a id="trigger_application_event"></a> `trigger_application_event?` | `string` | [refold.ts:363](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L363) |
715
734
 
716
735
  ***
717
736
 
718
737
  ### ExecutionFilters
719
738
 
720
- Defined in: [refold.ts:219](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L219)
739
+ Defined in: [refold.ts:242](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L242)
721
740
 
722
741
  Filters for narrowing down the list of workflow executions.
723
742
 
@@ -729,19 +748,19 @@ Filters for narrowing down the list of workflow executions.
729
748
 
730
749
  | Property | Type | Description | Defined in |
731
750
  | ------ | ------ | ------ | ------ |
732
- | <a id="end_date"></a> `end_date?` | `string` | Filter executions that started on or before this ISO 8601 date string. | [refold.ts:229](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L229) |
733
- | <a id="execution_source"></a> `execution_source?` | [`ExecutionSource`](#executionsource) | Filter by the trigger source that initiated the execution. | [refold.ts:233](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L233) |
734
- | <a id="execution_type"></a> `execution_type?` | [`ExecutionType`](#executiontype) | Filter by how the execution was invoked — synchronously or asynchronously. | [refold.ts:231](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L231) |
735
- | <a id="start_date"></a> `start_date?` | `string` | Filter executions that started on or after this ISO 8601 date string. | [refold.ts:227](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L227) |
736
- | <a id="status-1"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [refold.ts:221](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L221) |
737
- | <a id="workflow_id"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [refold.ts:225](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L225) |
738
- | <a id="workflow_name"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [refold.ts:223](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L223) |
751
+ | <a id="end_date"></a> `end_date?` | `string` | Filter executions that started on or before this ISO 8601 date string. | [refold.ts:252](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L252) |
752
+ | <a id="execution_source"></a> `execution_source?` | [`ExecutionSource`](#executionsource) | Filter by the trigger source that initiated the execution. | [refold.ts:256](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L256) |
753
+ | <a id="execution_type"></a> `execution_type?` | [`ExecutionType`](#executiontype) | Filter by how the execution was invoked — synchronously or asynchronously. | [refold.ts:254](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L254) |
754
+ | <a id="start_date"></a> `start_date?` | `string` | Filter executions that started on or after this ISO 8601 date string. | [refold.ts:250](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L250) |
755
+ | <a id="status-1"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [refold.ts:244](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L244) |
756
+ | <a id="workflow_id"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [refold.ts:248](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L248) |
757
+ | <a id="workflow_name"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [refold.ts:246](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L246) |
739
758
 
740
759
  ***
741
760
 
742
761
  ### GetExecutionsParams
743
762
 
744
- Defined in: [refold.ts:237](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L237)
763
+ Defined in: [refold.ts:260](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L260)
745
764
 
746
765
  Parameters for filtering and paginating the list of workflow executions.
747
766
 
@@ -759,21 +778,21 @@ Any additional filter keys supported by the API.
759
778
 
760
779
  | Property | Type | Description | Inherited from | Defined in |
761
780
  | ------ | ------ | ------ | ------ | ------ |
762
- | <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) | [refold.ts:229](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L229) |
763
- | <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) | [refold.ts:233](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L233) |
764
- | <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) | [refold.ts:231](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L231) |
765
- | <a id="limit"></a> `limit?` | `number` | - | `PaginationProps.limit` | [refold.ts:208](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L208) |
766
- | <a id="page"></a> `page?` | `number` | - | `PaginationProps.page` | [refold.ts:207](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L207) |
767
- | <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) | [refold.ts:227](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L227) |
768
- | <a id="status-2"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [`ExecutionFilters`](#executionfilters).[`status`](#status-1) | [refold.ts:221](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L221) |
769
- | <a id="workflow_id-1"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [`ExecutionFilters`](#executionfilters).[`workflow_id`](#workflow_id) | [refold.ts:225](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L225) |
770
- | <a id="workflow_name-1"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [`ExecutionFilters`](#executionfilters).[`workflow_name`](#workflow_name) | [refold.ts:223](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L223) |
781
+ | <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) | [refold.ts:252](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L252) |
782
+ | <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) | [refold.ts:256](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L256) |
783
+ | <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) | [refold.ts:254](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L254) |
784
+ | <a id="limit"></a> `limit?` | `number` | - | `PaginationProps.limit` | [refold.ts:231](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L231) |
785
+ | <a id="page"></a> `page?` | `number` | - | `PaginationProps.page` | [refold.ts:230](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L230) |
786
+ | <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) | [refold.ts:250](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L250) |
787
+ | <a id="status-2"></a> `status?` | [`ExecutionStatus`](#executionstatus-1) | Filter executions by their current status. | [`ExecutionFilters`](#executionfilters).[`status`](#status-1) | [refold.ts:244](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L244) |
788
+ | <a id="workflow_id-1"></a> `workflow_id?` | `string` | Filter executions by workflow ID. | [`ExecutionFilters`](#executionfilters).[`workflow_id`](#workflow_id) | [refold.ts:248](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L248) |
789
+ | <a id="workflow_name-1"></a> `workflow_name?` | `string` | Filter executions by workflow name (partial match). | [`ExecutionFilters`](#executionfilters).[`workflow_name`](#workflow_name) | [refold.ts:246](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L246) |
771
790
 
772
791
  ***
773
792
 
774
793
  ### InputField
775
794
 
776
- Defined in: [refold.ts:73](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L73)
795
+ Defined in: [refold.ts:73](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L73)
777
796
 
778
797
  An Input field to take input from the user.
779
798
 
@@ -781,20 +800,33 @@ An Input field to take input from the user.
781
800
 
782
801
  | Property | Type | Description | Defined in |
783
802
  | ------ | ------ | ------ | ------ |
784
- | <a id="help_text-1"></a> `help_text?` | `string` | The help text for the field. | [refold.ts:87](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L87) |
785
- | <a id="label"></a> `label` | `string` | The label of the field. | [refold.ts:85](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L85) |
786
- | <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [refold.ts:81](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L81) |
787
- | <a id="name-4"></a> `name` | `string` | Key name of the field. | [refold.ts:75](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L75) |
788
- | <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [refold.ts:89](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L89) |
789
- | <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [refold.ts:83](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L83) |
790
- | <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [refold.ts:79](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L79) |
791
- | <a id="type-1"></a> `type` | `string` | Input type of the field. | [refold.ts:77](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L77) |
803
+ | <a id="help_text-1"></a> `help_text?` | `string` | The help text for the field. | [refold.ts:87](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L87) |
804
+ | <a id="label"></a> `label` | `string` | The label of the field. | [refold.ts:85](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L85) |
805
+ | <a id="multiple-1"></a> `multiple?` | `boolean` | Whether the field accepts multiple values. | [refold.ts:81](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L81) |
806
+ | <a id="name-4"></a> `name` | `string` | Key name of the field. | [refold.ts:75](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L75) |
807
+ | <a id="options-1"></a> `options?` | `object`[] | The options for the field. | [refold.ts:89](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L89) |
808
+ | <a id="placeholder-1"></a> `placeholder` | `string` | The placeholder of the field. | [refold.ts:83](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L83) |
809
+ | <a id="required-1"></a> `required` | `boolean` | Whether the field is required. | [refold.ts:79](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L79) |
810
+ | <a id="type-2"></a> `type` | `string` | Input type of the field. | [refold.ts:77](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L77) |
811
+
812
+ ***
813
+
814
+ ### KeyBasedParams
815
+
816
+ Defined in: [refold.ts:106](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L106)
817
+
818
+ #### Properties
819
+
820
+ | Property | Type | Description | Defined in |
821
+ | ------ | ------ | ------ | ------ |
822
+ | <a id="payload-2"></a> `payload?` | `Record`\<`string`, `string`\> | The key value pairs of auth data. | [refold.ts:110](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L110) |
823
+ | <a id="slug-5"></a> `slug` | `string` | The application slug. | [refold.ts:108](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L108) |
792
824
 
793
825
  ***
794
826
 
795
827
  ### Label
796
828
 
797
- Defined in: [refold.ts:106](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L106)
829
+ Defined in: [refold.ts:129](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L129)
798
830
 
799
831
  Label Mapping
800
832
 
@@ -802,14 +834,33 @@ Label Mapping
802
834
 
803
835
  | Property | Type | Description | Defined in |
804
836
  | ------ | ------ | ------ | ------ |
805
- | <a id="name-5"></a> `name` | `string` | The label name. | [refold.ts:108](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L108) |
806
- | <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [refold.ts:110](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L110) |
837
+ | <a id="name-5"></a> `name` | `string` | The label name. | [refold.ts:131](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L131) |
838
+ | <a id="value-1"></a> `value` | `string` \| `number` \| `boolean` | The label value. | [refold.ts:133](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L133) |
839
+
840
+ ***
841
+
842
+ ### OAuthParams
843
+
844
+ Defined in: [refold.ts:95](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L95)
845
+
846
+ #### Extended by
847
+
848
+ - [`ConnectParams`](#connectparams)
849
+
850
+ #### Properties
851
+
852
+ | Property | Type | Description | Defined in |
853
+ | ------ | ------ | ------ | ------ |
854
+ | <a id="autoclose-1"></a> `autoClose?` | `boolean` | Whether to close the authentication window automatically. | [refold.ts:101](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L101) |
855
+ | <a id="payload-3"></a> `payload?` | `Record`\<`string`, `string`\> | The key value pairs of auth data. | [refold.ts:99](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L99) |
856
+ | <a id="slug-6"></a> `slug` | `string` | The application slug. | [refold.ts:97](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L97) |
857
+ | <a id="timeout-1"></a> `timeout?` | `number` | Maximum time in milliseconds to wait for authentication before giving up. Set to `0` to wait indefinitely. Defaults to 5 minutes. | [refold.ts:103](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L103) |
807
858
 
808
859
  ***
809
860
 
810
861
  ### PublicWorkflow
811
862
 
812
- Defined in: [refold.ts:163](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L163)
863
+ Defined in: [refold.ts:186](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L186)
813
864
 
814
865
  A public workflow in Refold.
815
866
 
@@ -817,19 +868,19 @@ A public workflow in Refold.
817
868
 
818
869
  | Property | Type | Description | Defined in |
819
870
  | ------ | ------ | ------ | ------ |
820
- | <a id="_id-1"></a> `_id` | `string` | The workflow ID. | [refold.ts:165](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L165) |
821
- | <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [refold.ts:173](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L173) |
822
- | <a id="description-2"></a> `description?` | `string` | The workflow description. | [refold.ts:169](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L169) |
823
- | <a id="name-6"></a> `name` | `string` | The workflow name. | [refold.ts:167](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L167) |
824
- | <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [refold.ts:177](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L177) |
825
- | <a id="slug-4"></a> `slug?` | `string` | The application's slug in which this workflow exists. | [refold.ts:171](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L171) |
826
- | <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [refold.ts:175](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L175) |
871
+ | <a id="_id-1"></a> `_id` | `string` | The workflow ID. | [refold.ts:188](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L188) |
872
+ | <a id="createdat-1"></a> `createdAt` | `string` | The workflow created at. | [refold.ts:196](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L196) |
873
+ | <a id="description-2"></a> `description?` | `string` | The workflow description. | [refold.ts:192](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L192) |
874
+ | <a id="name-6"></a> `name` | `string` | The workflow name. | [refold.ts:190](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L190) |
875
+ | <a id="published"></a> `published` | `boolean` | Whether the workflow is published. | [refold.ts:200](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L200) |
876
+ | <a id="slug-7"></a> `slug?` | `string` | The application's slug in which this workflow exists. | [refold.ts:194](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L194) |
877
+ | <a id="updatedat"></a> `updatedAt` | `string` | The workflow updated at. | [refold.ts:198](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L198) |
827
878
 
828
879
  ***
829
880
 
830
881
  ### PublicWorkflowPayload
831
882
 
832
- Defined in: [refold.ts:181](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L181)
883
+ Defined in: [refold.ts:204](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L204)
833
884
 
834
885
  The payload for creating a public workflow for the linked account.
835
886
 
@@ -837,15 +888,15 @@ The payload for creating a public workflow for the linked account.
837
888
 
838
889
  | Property | Type | Description | Defined in |
839
890
  | ------ | ------ | ------ | ------ |
840
- | <a id="description-3"></a> `description?` | `string` | The workflow description. | [refold.ts:185](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L185) |
841
- | <a id="name-7"></a> `name` | `string` | The workflow name. | [refold.ts:183](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L183) |
842
- | <a id="slug-5"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [refold.ts:187](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L187) |
891
+ | <a id="description-3"></a> `description?` | `string` | The workflow description. | [refold.ts:208](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L208) |
892
+ | <a id="name-7"></a> `name` | `string` | The workflow name. | [refold.ts:206](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L206) |
893
+ | <a id="slug-8"></a> `slug?` | `string` | The application slug in which this workflow should be created. | [refold.ts:210](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L210) |
843
894
 
844
895
  ***
845
896
 
846
897
  ### PublicWorkflowsPayload
847
898
 
848
- Defined in: [refold.ts:191](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L191)
899
+ Defined in: [refold.ts:214](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L214)
849
900
 
850
901
  Parameters for filtering and paginating the list of workflows.
851
902
 
@@ -863,56 +914,56 @@ Any additional filter keys supported by the API.
863
914
 
864
915
  | Property | Type | Description | Inherited from | Defined in |
865
916
  | ------ | ------ | ------ | ------ | ------ |
866
- | <a id="end_date-2"></a> `end_date?` | `string` | Filter workflows created on or before this ISO 8601 date string. | - | [refold.ts:199](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L199) |
867
- | <a id="limit-1"></a> `limit?` | `number` | - | `PaginationProps.limit` | [refold.ts:208](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L208) |
868
- | <a id="name-8"></a> `name?` | `string` | Filter workflows by name (partial match). | - | [refold.ts:195](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L195) |
869
- | <a id="page-1"></a> `page?` | `number` | - | `PaginationProps.page` | [refold.ts:207](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L207) |
870
- | <a id="published-1"></a> `published?` | `boolean` | Filter by workflow published status. `true` returns only published workflows, `false` returns only drafts. | - | [refold.ts:201](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L201) |
871
- | <a id="slug-6"></a> `slug?` | `string` | Filter workflows by the application slug. | - | [refold.ts:193](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L193) |
872
- | <a id="start_date-2"></a> `start_date?` | `string` | Filter workflows created on or after this ISO 8601 date string. | - | [refold.ts:197](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L197) |
917
+ | <a id="end_date-2"></a> `end_date?` | `string` | Filter workflows created on or before this ISO 8601 date string. | - | [refold.ts:222](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L222) |
918
+ | <a id="limit-1"></a> `limit?` | `number` | - | `PaginationProps.limit` | [refold.ts:231](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L231) |
919
+ | <a id="name-8"></a> `name?` | `string` | Filter workflows by name (partial match). | - | [refold.ts:218](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L218) |
920
+ | <a id="page-1"></a> `page?` | `number` | - | `PaginationProps.page` | [refold.ts:230](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L230) |
921
+ | <a id="published-1"></a> `published?` | `boolean` | Filter by workflow published status. `true` returns only published workflows, `false` returns only drafts. | - | [refold.ts:224](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L224) |
922
+ | <a id="slug-9"></a> `slug?` | `string` | Filter workflows by the application slug. | - | [refold.ts:216](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L216) |
923
+ | <a id="start_date-2"></a> `start_date?` | `string` | Filter workflows created on or after this ISO 8601 date string. | - | [refold.ts:220](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L220) |
873
924
 
874
925
  ***
875
926
 
876
927
  ### RefoldOptions
877
928
 
878
- Defined in: [refold.ts:135](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L135)
929
+ Defined in: [refold.ts:158](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L158)
879
930
 
880
931
  #### Properties
881
932
 
882
933
  | Property | Type | Description | Defined in |
883
934
  | ------ | ------ | ------ | ------ |
884
- | <a id="baseurl"></a> `baseUrl?` | `string` | The base URL of the Refold API. You don't need to set this. | [refold.ts:137](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L137) |
885
- | <a id="token-1"></a> `token?` | `string` | The session token. | [refold.ts:139](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L139) |
935
+ | <a id="baseurl"></a> `baseUrl?` | `string` | The base URL of the Refold API. You don't need to set this. | [refold.ts:160](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L160) |
936
+ | <a id="token-1"></a> `token?` | `string` | The session token. | [refold.ts:162](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L162) |
886
937
 
887
938
  ***
888
939
 
889
940
  ### RuleOptions
890
941
 
891
- Defined in: [refold.ts:142](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L142)
942
+ Defined in: [refold.ts:165](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L165)
892
943
 
893
944
  #### Properties
894
945
 
895
946
  | Property | Type | Defined in |
896
947
  | ------ | ------ | ------ |
897
- | <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [refold.ts:155](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L155) |
898
- | <a id="error"></a> `error?` | `object` | [refold.ts:156](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L156) |
899
- | `error.message?` | `string` | [refold.ts:157](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L157) |
900
- | `error.stack?` | `string` | [refold.ts:158](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L158) |
901
- | <a id="rule_column"></a> `rule_column` | `object` | [refold.ts:143](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L143) |
902
- | `rule_column.operator` | `object` | [refold.ts:149](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L149) |
903
- | `rule_column.operator.name` | `string` | [refold.ts:150](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L150) |
904
- | `rule_column.operator.options` | [`Label`](#label-1)[] | [refold.ts:152](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L152) |
905
- | `rule_column.operator.type` | `"select"` | [refold.ts:151](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L151) |
906
- | `rule_column.rhs` | `object` | [refold.ts:144](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L144) |
907
- | `rule_column.rhs.name` | `string` | [refold.ts:145](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L145) |
908
- | `rule_column.rhs.options?` | [`Label`](#label-1)[] | [refold.ts:147](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L147) |
909
- | `rule_column.rhs.type` | `"text"` \| `"select"` | [refold.ts:146](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L146) |
948
+ | <a id="conditional_code_stdout"></a> `conditional_code_stdout?` | `string`[] | [refold.ts:178](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L178) |
949
+ | <a id="error"></a> `error?` | `object` | [refold.ts:179](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L179) |
950
+ | `error.message?` | `string` | [refold.ts:180](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L180) |
951
+ | `error.stack?` | `string` | [refold.ts:181](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L181) |
952
+ | <a id="rule_column"></a> `rule_column` | `object` | [refold.ts:166](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L166) |
953
+ | `rule_column.operator` | `object` | [refold.ts:172](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L172) |
954
+ | `rule_column.operator.name` | `string` | [refold.ts:173](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L173) |
955
+ | `rule_column.operator.options` | [`Label`](#label-1)[] | [refold.ts:175](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L175) |
956
+ | `rule_column.operator.type` | `"select"` | [refold.ts:174](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L174) |
957
+ | `rule_column.rhs` | `object` | [refold.ts:167](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L167) |
958
+ | `rule_column.rhs.name` | `string` | [refold.ts:168](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L168) |
959
+ | `rule_column.rhs.options?` | [`Label`](#label-1)[] | [refold.ts:170](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L170) |
960
+ | `rule_column.rhs.type` | `"text"` \| `"select"` | [refold.ts:169](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L169) |
910
961
 
911
962
  ***
912
963
 
913
964
  ### UpdateConfigPayload
914
965
 
915
- Defined in: [refold.ts:114](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L114)
966
+ Defined in: [refold.ts:137](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L137)
916
967
 
917
968
  The configuration data for an application.
918
969
 
@@ -920,16 +971,16 @@ The configuration data for an application.
920
971
 
921
972
  | Property | Type | Description | Defined in |
922
973
  | ------ | ------ | ------ | ------ |
923
- | <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [refold.ts:118](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L118) |
924
- | <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [refold.ts:120](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L120) |
925
- | <a id="slug-7"></a> `slug` | `string` | The application slug | [refold.ts:116](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L116) |
926
- | <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [refold.ts:122](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L122) |
974
+ | <a id="config_id-3"></a> `config_id?` | `string` | Unique ID for the config. | [refold.ts:141](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L141) |
975
+ | <a id="fields-2"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of application fields and their values. | [refold.ts:143](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L143) |
976
+ | <a id="slug-10"></a> `slug` | `string` | The application slug | [refold.ts:139](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L139) |
977
+ | <a id="workflows-1"></a> `workflows` | [`WorkflowPayload`](#workflowpayload)[] | The config workflows data. | [refold.ts:145](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L145) |
927
978
 
928
979
  ***
929
980
 
930
981
  ### WorkflowPayload
931
982
 
932
- Defined in: [refold.ts:126](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L126)
983
+ Defined in: [refold.ts:149](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L149)
933
984
 
934
985
  The workflow.
935
986
 
@@ -937,23 +988,23 @@ The workflow.
937
988
 
938
989
  | Property | Type | Description | Defined in |
939
990
  | ------ | ------ | ------ | ------ |
940
- | <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [refold.ts:130](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L130) |
941
- | <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [refold.ts:132](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L132) |
942
- | <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [refold.ts:128](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L128) |
991
+ | <a id="enabled-1"></a> `enabled` | `boolean` | Whether the workflow is enabled. | [refold.ts:153](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L153) |
992
+ | <a id="fields-3"></a> `fields` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | A map of workflow field names and their values. | [refold.ts:155](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L155) |
993
+ | <a id="id-3"></a> `id` | `string` | The ID of the workflow. | [refold.ts:151](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L151) |
943
994
 
944
995
  ***
945
996
 
946
997
  ### WorkflowPayloadResponse
947
998
 
948
- Defined in: [refold.ts:298](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L298)
999
+ Defined in: [refold.ts:321](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L321)
949
1000
 
950
1001
  #### Properties
951
1002
 
952
1003
  | Property | Type | Defined in |
953
1004
  | ------ | ------ | ------ |
954
- | <a id="payload-1"></a> `payload` | `Record`\<`string`, `any`\> | [refold.ts:299](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L299) |
955
- | <a id="schema"></a> `schema?` | `unknown` | [refold.ts:300](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L300) |
956
- | <a id="schema_interpreted"></a> `schema_interpreted?` | `unknown` | [refold.ts:301](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L301) |
1005
+ | <a id="payload-4"></a> `payload` | `Record`\<`string`, `any`\> | [refold.ts:322](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L322) |
1006
+ | <a id="schema"></a> `schema?` | `unknown` | [refold.ts:323](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L323) |
1007
+ | <a id="schema_interpreted"></a> `schema_interpreted?` | `unknown` | [refold.ts:324](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L324) |
957
1008
 
958
1009
  ## Type Aliases
959
1010
 
@@ -961,7 +1012,7 @@ Defined in: [refold.ts:298](https://github.com/gocobalt/refold-js/blob/c234ec1f1
961
1012
 
962
1013
  > **ExecutionSource** = `"Event"` \| `"Schedule"` \| `"API Call"`
963
1014
 
964
- Defined in: [refold.ts:214](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L214)
1015
+ Defined in: [refold.ts:237](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L237)
965
1016
 
966
1017
  The trigger source that initiated a workflow execution.
967
1018
 
@@ -971,7 +1022,7 @@ The trigger source that initiated a workflow execution.
971
1022
 
972
1023
  > **ExecutionStatus** = `"COMPLETED"` \| `"RUNNING"` \| `"ERRORED"` \| `"STOPPED"` \| `"STOPPING"` \| `"TIMED_OUT"`
973
1024
 
974
- Defined in: [refold.ts:212](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L212)
1025
+ Defined in: [refold.ts:235](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L235)
975
1026
 
976
1027
  The current status of a workflow execution.
977
1028
 
@@ -981,6 +1032,6 @@ The current status of a workflow execution.
981
1032
 
982
1033
  > **ExecutionType** = `"SYNC"` \| `"ASYNC"`
983
1034
 
984
- Defined in: [refold.ts:216](https://github.com/gocobalt/refold-js/blob/c234ec1f1c2c551a366c639651fe6f9201f6ff9f/refold.ts#L216)
1035
+ Defined in: [refold.ts:239](https://github.com/gocobalt/refold-js/blob/dd01907590c42bc396ff72f349f49c0267f88e7a/refold.ts#L239)
985
1036
 
986
1037
  Whether a workflow execution runs synchronously (waits for result) or asynchronously (fire-and-forget).