@cobaltio/cobalt-js 0.1.1 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +105 -210
- package/cobalt.js +103 -200
- package/cobalt.min.js +1 -1
- package/docs.md +104 -209
- package/package.json +1 -2
package/README.md
CHANGED
|
@@ -21,7 +21,7 @@ yarn add @cobaltio/cobalt-js
|
|
|
21
21
|
|
|
22
22
|
#### Browser
|
|
23
23
|
```js
|
|
24
|
-
<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@
|
|
24
|
+
<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@1"></script>
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
#### Node
|
|
@@ -59,21 +59,15 @@ cobalt.token = "COBALT_SESSION_TOKEN";
|
|
|
59
59
|
## Typedefs
|
|
60
60
|
|
|
61
61
|
<dl>
|
|
62
|
-
<dt><a href="#Field">Field</a> : <code>object</code></dt>
|
|
63
|
-
<dd><p>The Node Field object available for configuration.</p>
|
|
64
|
-
</dd>
|
|
65
|
-
<dt><a href="#Node">Node</a> : <code>object</code></dt>
|
|
66
|
-
<dd><p>The Node object available for configuration.</p>
|
|
67
|
-
</dd>
|
|
68
|
-
<dt><a href="#Workflow">Workflow</a> : <code>object</code></dt>
|
|
69
|
-
<dd><p>The installed workflow.</p>
|
|
70
|
-
</dd>
|
|
71
|
-
<dt><a href="#AppAuthStatus">AppAuthStatus</a> : <code>object</code></dt>
|
|
72
|
-
<dd><p>The auth status of the user for an application.</p>
|
|
73
|
-
</dd>
|
|
74
62
|
<dt><a href="#AppConfig">AppConfig</a> : <code>object</code></dt>
|
|
75
63
|
<dd><p>The configuration data for an application.</p>
|
|
76
64
|
</dd>
|
|
65
|
+
<dt><a href="#AppInstance">AppInstance</a> : <code>Object</code></dt>
|
|
66
|
+
<dd><p>An installed application.</p>
|
|
67
|
+
</dd>
|
|
68
|
+
<dt><a href="#Workflow">Workflow</a> : <code>Object</code></dt>
|
|
69
|
+
<dd><p>The workflow.</p>
|
|
70
|
+
</dd>
|
|
77
71
|
</dl>
|
|
78
72
|
|
|
79
73
|
<a name="Cobalt"></a>
|
|
@@ -82,26 +76,25 @@ cobalt.token = "COBALT_SESSION_TOKEN";
|
|
|
82
76
|
Cobalt Frontend SDK
|
|
83
77
|
|
|
84
78
|
**Kind**: global class
|
|
79
|
+
**Properties**
|
|
80
|
+
|
|
81
|
+
| Name | Type | Description |
|
|
82
|
+
| --- | --- | --- |
|
|
83
|
+
| token | <code>String</code> | The session token. |
|
|
84
|
+
|
|
85
85
|
|
|
86
86
|
* [Cobalt](#Cobalt)
|
|
87
87
|
* [new Cobalt(options)](#new_Cobalt_new)
|
|
88
|
-
* [.
|
|
89
|
-
* [.
|
|
90
|
-
* [.
|
|
91
|
-
* [.
|
|
88
|
+
* [.oauth(application)](#Cobalt+oauth) ⇒ <code>Promise.<Boolean></code>
|
|
89
|
+
* [.auth(application, payload)](#Cobalt+auth) ⇒ <code>Promise.<unknown></code>
|
|
90
|
+
* [.authCustom(applicationId, payload)](#Cobalt+authCustom) ⇒ <code>Promise.<unknown></code>
|
|
91
|
+
* [.checkAuth(application)](#Cobalt+checkAuth) ⇒ <code>Promise.<Boolean></code>
|
|
92
|
+
* [.removeAuth(application, [applicationId])](#Cobalt+removeAuth) ⇒ <code>Promise.<void></code>
|
|
92
93
|
* [.getAppConfig(application)](#Cobalt+getAppConfig) ⇒ [<code>Promise.<AppConfig></code>](#AppConfig)
|
|
93
|
-
* [.
|
|
94
|
-
* [.
|
|
95
|
-
* [.
|
|
96
|
-
* [.
|
|
97
|
-
* [.removeAppAuth()](#Cobalt+removeAppAuth) ⇒ <code>Promise.<void></code>
|
|
98
|
-
* [.getNodeConfiguration()](#Cobalt+getNodeConfiguration) ⇒ <code>Promise.<Array.<Field>></code>
|
|
99
|
-
* [.saveNode()](#Cobalt+saveNode) ⇒ [<code>Promise.<Workflow></code>](#Workflow)
|
|
100
|
-
* [.getWorkflowConfiguration()](#Cobalt+getWorkflowConfiguration) ⇒ [<code>Promise.<Workflow></code>](#Workflow)
|
|
101
|
-
* [.activateWorkflow()](#Cobalt+activateWorkflow) ⇒ <code>Promise.<void></code>
|
|
102
|
-
* [.activateWorkflows()](#Cobalt+activateWorkflows) ⇒ <code>Promise.<void></code>
|
|
103
|
-
* [.toggleWorkflowStatus()](#Cobalt+toggleWorkflowStatus) ⇒ [<code>Promise.<Workflow></code>](#Workflow)
|
|
104
|
-
* [.deleteWorkflow()](#Cobalt+deleteWorkflow) ⇒ <code>Promise.<unknown></code>
|
|
94
|
+
* [.install(applicationId, payload)](#Cobalt+install) ⇒ [<code>Promise.<AppInstance></code>](#AppInstance)
|
|
95
|
+
* [.getInstallation(applicationId, installationId)](#Cobalt+getInstallation) ⇒ [<code>Promise.<AppInstance></code>](#AppInstance)
|
|
96
|
+
* [.updateInstallation(applicationId, installationId, payload)](#Cobalt+updateInstallation) ⇒ [<code>Promise.<AppInstance></code>](#AppInstance)
|
|
97
|
+
* [.deleteInstallation(applicationId, installationId)](#Cobalt+deleteInstallation) ⇒ <code>Promise.<unknown></code>
|
|
105
98
|
|
|
106
99
|
<a name="new_Cobalt_new"></a>
|
|
107
100
|
|
|
@@ -111,271 +104,173 @@ Cobalt Frontend SDK
|
|
|
111
104
|
|
|
112
105
|
| Param | Type | Default | Description |
|
|
113
106
|
| --- | --- | --- | --- |
|
|
114
|
-
| options | <code>
|
|
115
|
-
| [options.token] | <code>
|
|
116
|
-
| [options.baseUrl] | <code>
|
|
117
|
-
|
|
118
|
-
<a name="Cobalt+token"></a>
|
|
119
|
-
|
|
120
|
-
### cobalt.token ⇒ <code>string</code>
|
|
121
|
-
**Kind**: instance property of [<code>Cobalt</code>](#Cobalt)
|
|
122
|
-
**Returns**: <code>string</code> - The session token.
|
|
123
|
-
<a name="Cobalt+token"></a>
|
|
124
|
-
|
|
125
|
-
### cobalt.token ⇒ <code>string</code>
|
|
126
|
-
**Kind**: instance property of [<code>Cobalt</code>](#Cobalt)
|
|
127
|
-
**Returns**: <code>string</code> - The session token.
|
|
128
|
-
<a name="Cobalt+baseUrl"></a>
|
|
129
|
-
|
|
130
|
-
### cobalt.baseUrl ⇒ <code>string</code>
|
|
131
|
-
**Kind**: instance property of [<code>Cobalt</code>](#Cobalt)
|
|
132
|
-
**Returns**: <code>string</code> - The base URL of cobalt API.
|
|
133
|
-
<a name="Cobalt+installTemplate"></a>
|
|
134
|
-
|
|
135
|
-
### cobalt.installTemplate() ⇒ [<code>Promise.<Workflow></code>](#Workflow)
|
|
136
|
-
Install the given template.
|
|
137
|
-
|
|
138
|
-
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
139
|
-
**Properties**
|
|
140
|
-
|
|
141
|
-
| Name | Type | Description |
|
|
142
|
-
| --- | --- | --- |
|
|
143
|
-
| templateId | <code>string</code> | The ID of the template you want to install. |
|
|
144
|
-
| udf | <code>object</code> | Custom key value pairs you want to store with the installed worklfow. |
|
|
145
|
-
|
|
146
|
-
<a name="Cobalt+getAppConfig"></a>
|
|
147
|
-
|
|
148
|
-
### cobalt.getAppConfig(application) ⇒ [<code>Promise.<AppConfig></code>](#AppConfig)
|
|
149
|
-
Returns the configuration data for the specified application.
|
|
150
|
-
|
|
151
|
-
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
152
|
-
**Returns**: [<code>Promise.<AppConfig></code>](#AppConfig) - The specified application's configuration data.
|
|
153
|
-
|
|
154
|
-
| Param | Type | Description |
|
|
155
|
-
| --- | --- | --- |
|
|
156
|
-
| application | <code>string</code> | The application ID. |
|
|
157
|
-
|
|
158
|
-
<a name="Cobalt+getAppAuthStatus"></a>
|
|
159
|
-
|
|
160
|
-
### cobalt.getAppAuthStatus() ⇒ <code>Promise.<boolean></code>
|
|
161
|
-
Returns the auth status of the user for the specified application.
|
|
162
|
-
|
|
163
|
-
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
164
|
-
**Returns**: <code>Promise.<boolean></code> - The auth status of the user.
|
|
165
|
-
**Properties**
|
|
166
|
-
|
|
167
|
-
| Name | Type | Description |
|
|
168
|
-
| --- | --- | --- |
|
|
169
|
-
| application | <code>string</code> | The application type. |
|
|
170
|
-
|
|
171
|
-
<a name="Cobalt+getAppAuthUrl"></a>
|
|
172
|
-
|
|
173
|
-
### cobalt.getAppAuthUrl() ⇒ <code>Promise.<string></code>
|
|
174
|
-
Returns the auth URL that users can use to authenticate themselves to the
|
|
175
|
-
specified application.
|
|
176
|
-
|
|
177
|
-
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
178
|
-
**Returns**: <code>Promise.<string></code> - The auth URL where users can authenticate themselves.
|
|
179
|
-
**Properties**
|
|
180
|
-
|
|
181
|
-
| Name | Type | Description |
|
|
182
|
-
| --- | --- | --- |
|
|
183
|
-
| application | <code>string</code> | The application type. |
|
|
107
|
+
| options | <code>Object</code> | | The options to configure the Cobalt SDK. |
|
|
108
|
+
| [options.token] | <code>String</code> | | The session token. |
|
|
109
|
+
| [options.baseUrl] | <code>String</code> | <code>https://api.gocobalt.io</code> | The base URL of the Cobalt API. |
|
|
184
110
|
|
|
185
111
|
<a name="Cobalt+oauth"></a>
|
|
186
112
|
|
|
187
|
-
### cobalt.oauth() ⇒ <code>Promise.<
|
|
188
|
-
Handle OAuth for the specified application.
|
|
113
|
+
### cobalt.oauth(application) ⇒ <code>Promise.<Boolean></code>
|
|
114
|
+
Handle OAuth for the specified native application.
|
|
189
115
|
|
|
190
116
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
191
|
-
**Returns**: <code>Promise.<
|
|
192
|
-
**Properties**
|
|
117
|
+
**Returns**: <code>Promise.<Boolean></code> - Whether the user authenticated.
|
|
193
118
|
|
|
194
|
-
|
|
|
119
|
+
| Param | Type | Description |
|
|
195
120
|
| --- | --- | --- |
|
|
196
|
-
| application | <code>
|
|
121
|
+
| application | <code>String</code> | The application type. |
|
|
197
122
|
|
|
198
|
-
<a name="Cobalt+
|
|
123
|
+
<a name="Cobalt+auth"></a>
|
|
199
124
|
|
|
200
|
-
### cobalt.
|
|
125
|
+
### cobalt.auth(application, payload) ⇒ <code>Promise.<unknown></code>
|
|
201
126
|
Save the auth data that user provides to authenticate themselves to the
|
|
202
|
-
specified application.
|
|
127
|
+
specified native application.
|
|
203
128
|
|
|
204
129
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
205
|
-
**Properties**
|
|
206
130
|
|
|
207
|
-
|
|
|
131
|
+
| Param | Type | Description |
|
|
208
132
|
| --- | --- | --- |
|
|
209
|
-
| application | <code>
|
|
210
|
-
| payload | <code>
|
|
211
|
-
| appId | <code>object</code> | The application ID in case of custom applications. |
|
|
133
|
+
| application | <code>String</code> | The application type. |
|
|
134
|
+
| payload | <code>Object.<string, (string\|number\|boolean)></code> | The key value pairs of auth data. |
|
|
212
135
|
|
|
213
|
-
<a name="Cobalt+
|
|
136
|
+
<a name="Cobalt+authCustom"></a>
|
|
214
137
|
|
|
215
|
-
### cobalt.
|
|
216
|
-
|
|
138
|
+
### cobalt.authCustom(applicationId, payload) ⇒ <code>Promise.<unknown></code>
|
|
139
|
+
Save the auth data that user provides to authenticate themselves to the
|
|
140
|
+
specified custom application.
|
|
217
141
|
|
|
218
142
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
219
|
-
**Properties**
|
|
220
143
|
|
|
221
|
-
|
|
|
144
|
+
| Param | Type | Description |
|
|
222
145
|
| --- | --- | --- |
|
|
223
|
-
|
|
|
224
|
-
|
|
|
146
|
+
| applicationId | <code>String</code> | The application ID of the custom application. |
|
|
147
|
+
| payload | <code>Object.<string, (string\|number\|boolean)></code> | The key value pairs of auth data. |
|
|
225
148
|
|
|
226
|
-
<a name="Cobalt+
|
|
149
|
+
<a name="Cobalt+checkAuth"></a>
|
|
227
150
|
|
|
228
|
-
### cobalt.
|
|
229
|
-
Returns the
|
|
151
|
+
### cobalt.checkAuth(application) ⇒ <code>Promise.<Boolean></code>
|
|
152
|
+
Returns the auth status of the user for the specified application.
|
|
230
153
|
|
|
231
154
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
232
|
-
**
|
|
155
|
+
**Returns**: <code>Promise.<Boolean></code> - The auth status of the user.
|
|
233
156
|
|
|
234
|
-
|
|
|
157
|
+
| Param | Type | Description |
|
|
235
158
|
| --- | --- | --- |
|
|
236
|
-
|
|
|
237
|
-
| nodeId | <code>string</code> | The ID of the node. |
|
|
238
|
-
| fieldName | <code>string</code> | The field name for which config data is required. |
|
|
239
|
-
| selectedValues | <code>object</code> | The input data already selected for the node. |
|
|
159
|
+
| application | <code>String</code> | The application type. |
|
|
240
160
|
|
|
241
|
-
<a name="Cobalt+
|
|
161
|
+
<a name="Cobalt+removeAuth"></a>
|
|
242
162
|
|
|
243
|
-
### cobalt.
|
|
244
|
-
|
|
163
|
+
### cobalt.removeAuth(application, [applicationId]) ⇒ <code>Promise.<void></code>
|
|
164
|
+
Unauthorize the specified application and remove any associated data from Cobalt.
|
|
245
165
|
|
|
246
166
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
247
|
-
**Properties**
|
|
248
167
|
|
|
249
|
-
|
|
|
168
|
+
| Param | Type | Description |
|
|
250
169
|
| --- | --- | --- |
|
|
251
|
-
|
|
|
252
|
-
|
|
|
253
|
-
| inputData | <code>object</code> | The input data for the node. |
|
|
170
|
+
| application | <code>String</code> | The application type. |
|
|
171
|
+
| [applicationId] | <code>String</code> | The application ID in case of custom applications. |
|
|
254
172
|
|
|
255
|
-
<a name="Cobalt+
|
|
173
|
+
<a name="Cobalt+getAppConfig"></a>
|
|
256
174
|
|
|
257
|
-
### cobalt.
|
|
258
|
-
Returns the
|
|
175
|
+
### cobalt.getAppConfig(application) ⇒ [<code>Promise.<AppConfig></code>](#AppConfig)
|
|
176
|
+
Returns the configuration data for the specified application.
|
|
259
177
|
|
|
260
178
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
261
|
-
**
|
|
179
|
+
**Returns**: [<code>Promise.<AppConfig></code>](#AppConfig) - The specified application's configuration data.
|
|
262
180
|
|
|
263
|
-
|
|
|
181
|
+
| Param | Type | Description |
|
|
264
182
|
| --- | --- | --- |
|
|
265
|
-
|
|
|
183
|
+
| application | <code>String</code> | The application ID. |
|
|
266
184
|
|
|
267
|
-
<a name="Cobalt+
|
|
185
|
+
<a name="Cobalt+install"></a>
|
|
268
186
|
|
|
269
|
-
### cobalt.
|
|
270
|
-
|
|
187
|
+
### cobalt.install(applicationId, payload) ⇒ [<code>Promise.<AppInstance></code>](#AppInstance)
|
|
188
|
+
Install the specified application.
|
|
271
189
|
|
|
272
190
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
273
|
-
**
|
|
191
|
+
**Returns**: [<code>Promise.<AppInstance></code>](#AppInstance) - The specified application installation.
|
|
274
192
|
|
|
275
|
-
|
|
|
193
|
+
| Param | Type | Description |
|
|
276
194
|
| --- | --- | --- |
|
|
277
|
-
|
|
|
195
|
+
| applicationId | <code>String</code> | The application ID. |
|
|
196
|
+
| payload | [<code>AppInstance</code>](#AppInstance) | The install payload. |
|
|
278
197
|
|
|
279
|
-
<a name="Cobalt+
|
|
198
|
+
<a name="Cobalt+getInstallation"></a>
|
|
280
199
|
|
|
281
|
-
### cobalt.
|
|
282
|
-
|
|
200
|
+
### cobalt.getInstallation(applicationId, installationId) ⇒ [<code>Promise.<AppInstance></code>](#AppInstance)
|
|
201
|
+
Returns the specified application installation.
|
|
283
202
|
|
|
284
203
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
285
|
-
**
|
|
204
|
+
**Returns**: [<code>Promise.<AppInstance></code>](#AppInstance) - The specified application installation.
|
|
286
205
|
|
|
287
|
-
|
|
|
206
|
+
| Param | Type | Description |
|
|
288
207
|
| --- | --- | --- |
|
|
289
|
-
|
|
|
208
|
+
| applicationId | <code>String</code> | The application ID. |
|
|
209
|
+
| installationId | <code>String</code> | The installation ID of the application instance. |
|
|
290
210
|
|
|
291
|
-
<a name="Cobalt+
|
|
211
|
+
<a name="Cobalt+updateInstallation"></a>
|
|
292
212
|
|
|
293
|
-
### cobalt.
|
|
294
|
-
|
|
213
|
+
### cobalt.updateInstallation(applicationId, installationId, payload) ⇒ [<code>Promise.<AppInstance></code>](#AppInstance)
|
|
214
|
+
Update the specified application installation.
|
|
295
215
|
|
|
296
216
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
297
|
-
**
|
|
217
|
+
**Returns**: [<code>Promise.<AppInstance></code>](#AppInstance) - The specified application installation.
|
|
298
218
|
|
|
299
|
-
|
|
|
219
|
+
| Param | Type | Description |
|
|
300
220
|
| --- | --- | --- |
|
|
301
|
-
|
|
|
221
|
+
| applicationId | <code>String</code> | The application ID. |
|
|
222
|
+
| installationId | <code>String</code> | The installation ID of the application instance. |
|
|
223
|
+
| payload | [<code>AppInstance</code>](#AppInstance) | The update payload. |
|
|
302
224
|
|
|
303
|
-
<a name="Cobalt+
|
|
225
|
+
<a name="Cobalt+deleteInstallation"></a>
|
|
304
226
|
|
|
305
|
-
### cobalt.
|
|
306
|
-
Delete the specified
|
|
227
|
+
### cobalt.deleteInstallation(applicationId, installationId) ⇒ <code>Promise.<unknown></code>
|
|
228
|
+
Delete the specified installation.
|
|
307
229
|
|
|
308
230
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
309
|
-
**Properties**
|
|
310
231
|
|
|
311
|
-
|
|
|
232
|
+
| Param | Type | Description |
|
|
312
233
|
| --- | --- | --- |
|
|
313
|
-
|
|
|
234
|
+
| applicationId | <code>String</code> | The application ID. |
|
|
235
|
+
| installationId | <code>String</code> | The installation ID of the application instance. |
|
|
314
236
|
|
|
315
|
-
<a name="
|
|
237
|
+
<a name="AppConfig"></a>
|
|
316
238
|
|
|
317
|
-
##
|
|
318
|
-
The
|
|
239
|
+
## AppConfig : <code>object</code>
|
|
240
|
+
The configuration data for an application.
|
|
319
241
|
|
|
320
242
|
**Kind**: global typedef
|
|
321
243
|
**Properties**
|
|
322
244
|
|
|
323
245
|
| Name | Type | Description |
|
|
324
246
|
| --- | --- | --- |
|
|
325
|
-
|
|
|
326
|
-
|
|
|
327
|
-
| placeholder | <code>string</code> | The placeholder text for the field. |
|
|
328
|
-
| required | <code>boolean</code> | Whether the field is required. |
|
|
247
|
+
| application_data_slots | <code>Array.<DataSlot></code> | Array of application data slots. |
|
|
248
|
+
| workflows | [<code>Array.<Workflow></code>](#Workflow) | Array of workflows. |
|
|
329
249
|
|
|
330
|
-
<a name="
|
|
250
|
+
<a name="AppInstance"></a>
|
|
331
251
|
|
|
332
|
-
##
|
|
333
|
-
|
|
252
|
+
## AppInstance : <code>Object</code>
|
|
253
|
+
An installed application.
|
|
334
254
|
|
|
335
255
|
**Kind**: global typedef
|
|
336
256
|
**Properties**
|
|
337
257
|
|
|
338
258
|
| Name | Type | Description |
|
|
339
259
|
| --- | --- | --- |
|
|
340
|
-
|
|
|
341
|
-
|
|
|
342
|
-
|
|
|
260
|
+
| [installation_id] | <code>String</code> | Unique ID for the installation. |
|
|
261
|
+
| application_data_slots | <code>Object.<string, (string\|number\|boolean)></code> | A map of application data slots and their values. |
|
|
262
|
+
| workflows | [<code>Array.<Workflow></code>](#Workflow) | Whether the workflow is enabled. |
|
|
343
263
|
|
|
344
264
|
<a name="Workflow"></a>
|
|
345
265
|
|
|
346
|
-
## Workflow : <code>
|
|
347
|
-
The
|
|
348
|
-
|
|
349
|
-
**Kind**: global typedef
|
|
350
|
-
**Properties**
|
|
351
|
-
|
|
352
|
-
| Name | Type | Description |
|
|
353
|
-
| --- | --- | --- |
|
|
354
|
-
| workflow_id | <code>string</code> | The ID of the installed workflow. |
|
|
355
|
-
| applications | <code>Array.<unknown></code> | The applications integrated in the workflow. |
|
|
356
|
-
| configure | [<code>Array.<Node></code>](#Node) | The configuration data for the workflow. |
|
|
357
|
-
|
|
358
|
-
<a name="AppAuthStatus"></a>
|
|
359
|
-
|
|
360
|
-
## AppAuthStatus : <code>object</code>
|
|
361
|
-
The auth status of the user for an application.
|
|
362
|
-
|
|
363
|
-
**Kind**: global typedef
|
|
364
|
-
**Properties**
|
|
365
|
-
|
|
366
|
-
| Name | Type | Description |
|
|
367
|
-
| --- | --- | --- |
|
|
368
|
-
| status | <code>boolean</code> | Whether the user has authenticated with this application. |
|
|
369
|
-
|
|
370
|
-
<a name="AppConfig"></a>
|
|
371
|
-
|
|
372
|
-
## AppConfig : <code>object</code>
|
|
373
|
-
The configuration data for an application.
|
|
266
|
+
## Workflow : <code>Object</code>
|
|
267
|
+
The workflow.
|
|
374
268
|
|
|
375
269
|
**Kind**: global typedef
|
|
376
270
|
**Properties**
|
|
377
271
|
|
|
378
272
|
| Name | Type | Description |
|
|
379
273
|
| --- | --- | --- |
|
|
380
|
-
|
|
|
381
|
-
|
|
|
274
|
+
| id | <code>String</code> | The ID of the workflow. |
|
|
275
|
+
| enabled | <code>Boolean</code> | Whether the workflow is enabled. |
|
|
276
|
+
| data_slots | <code>Object.<string, (string\|number\|boolean)></code> | A map of workflow's data slots and their values. |
|