@cobaltio/cobalt-js 2.1.3 → 3.0.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.
- package/README.md +250 -325
- package/cobalt.js +96 -160
- package/docs.md +59 -134
- package/package.json +34 -36
- package/cobalt.min.js +0 -1
package/README.md
CHANGED
|
@@ -1,325 +1,250 @@
|
|
|
1
|
-
# cobalt.js
|
|
2
|
-
Cobalt frontend SDK.
|
|
3
|
-
|
|
4
|
-
## Install
|
|
5
|
-
|
|
6
|
-
#### npm
|
|
7
|
-
```bash
|
|
8
|
-
npm install @cobaltio/cobalt-js
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
#### yarn
|
|
12
|
-
```bash
|
|
13
|
-
yarn add @cobaltio/cobalt-js
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Usage
|
|
17
|
-
|
|
18
|
-
<!-- Check the SDK [documentation](docs.md) for detailed information. -->
|
|
19
|
-
|
|
20
|
-
### Include
|
|
21
|
-
|
|
22
|
-
#### Browser
|
|
23
|
-
```html
|
|
24
|
-
<!-- import the latest version -->
|
|
25
|
-
<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js"></script>
|
|
26
|
-
<!-- import a specific version -->
|
|
27
|
-
<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@2"></script>
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
#### Node
|
|
31
|
-
```js
|
|
32
|
-
// CommonJS
|
|
33
|
-
const Cobalt = require("@cobaltio/cobalt-js");
|
|
34
|
-
// ESM
|
|
35
|
-
import Cobalt from "@cobaltio/cobalt-js";
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
### Initialize
|
|
39
|
-
```js
|
|
40
|
-
// initialize with token
|
|
41
|
-
const cobalt = new Cobalt({
|
|
42
|
-
// the token you generate for linked accounts using the cobalt backend SDK
|
|
43
|
-
token: "COBALT_SESSION_TOKEN",
|
|
44
|
-
});
|
|
45
|
-
|
|
46
|
-
// initialize without token
|
|
47
|
-
const cobalt = new Cobalt();
|
|
48
|
-
// the token you generate for linked accounts using the cobalt backend SDK
|
|
49
|
-
cobalt.token = "COBALT_SESSION_TOKEN";
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
### SDK
|
|
53
|
-
|
|
54
|
-
## Classes
|
|
55
|
-
|
|
56
|
-
<dl>
|
|
57
|
-
<dt><a href="#Cobalt">Cobalt</a></dt>
|
|
58
|
-
<dd><p>Cobalt Frontend SDK</p>
|
|
59
|
-
</dd>
|
|
60
|
-
</dl>
|
|
61
|
-
|
|
62
|
-
## Typedefs
|
|
63
|
-
|
|
64
|
-
<dl>
|
|
65
|
-
<dt><a href="#
|
|
66
|
-
<dd><p>
|
|
67
|
-
</dd>
|
|
68
|
-
<dt><a href="#
|
|
69
|
-
<dd><p>Field Mapping Label</p>
|
|
70
|
-
</dd>
|
|
71
|
-
<dt><a href="#DynamicFields">DynamicFields</a> : <code>Object</code></dt>
|
|
72
|
-
<dd><p>The dynamic fields payload.</p>
|
|
73
|
-
</dd>
|
|
74
|
-
<dt><a href="#
|
|
75
|
-
<dd><p>
|
|
76
|
-
</dd>
|
|
77
|
-
<dt><a href="#Workflow">Workflow</a> : <code>Object</code></dt>
|
|
78
|
-
<dd><p>The workflow.</p>
|
|
79
|
-
</dd>
|
|
80
|
-
</dl>
|
|
81
|
-
|
|
82
|
-
<a name="Cobalt"></a>
|
|
83
|
-
|
|
84
|
-
## Cobalt
|
|
85
|
-
Cobalt Frontend SDK
|
|
86
|
-
|
|
87
|
-
**Kind**: global class
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
* [
|
|
96
|
-
* [
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
|
119
|
-
|
|
|
120
|
-
|
|
121
|
-
<
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
|
131
|
-
|
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
specified
|
|
138
|
-
|
|
139
|
-
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
|
143
|
-
|
|
|
144
|
-
|
|
|
145
|
-
|
|
146
|
-
<
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
|
157
|
-
|
|
|
158
|
-
|
|
159
|
-
<
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
|
170
|
-
|
|
171
|
-
<
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
|
196
|
-
|
|
197
|
-
<
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
|
221
|
-
|
|
222
|
-
<
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
|
233
|
-
|
|
|
234
|
-
|
|
235
|
-
<
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
|
247
|
-
|
|
|
248
|
-
|
|
249
|
-
<
|
|
250
|
-
|
|
251
|
-
### cobalt.deleteSavedConfig(applicationId, configId) ⇒ <code>Promise.<unknown></code>
|
|
252
|
-
Delete the specified saved config.
|
|
253
|
-
|
|
254
|
-
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
255
|
-
|
|
256
|
-
| Param | Type | Description |
|
|
257
|
-
| --- | --- | --- |
|
|
258
|
-
| applicationId | <code>String</code> | The application ID. |
|
|
259
|
-
| configId | <code>String</code> | The config ID of the saved config. |
|
|
260
|
-
|
|
261
|
-
<a name="Config"></a>
|
|
262
|
-
|
|
263
|
-
## Config : <code>object</code>
|
|
264
|
-
The configuration data for an application.
|
|
265
|
-
|
|
266
|
-
**Kind**: global typedef
|
|
267
|
-
**Properties**
|
|
268
|
-
|
|
269
|
-
| Name | Type | Description |
|
|
270
|
-
| --- | --- | --- |
|
|
271
|
-
| application_data_slots | <code>Array.<DataSlot></code> | Array of application data slots. |
|
|
272
|
-
| workflows | [<code>Array.<Workflow></code>](#Workflow) | Array of workflows. |
|
|
273
|
-
|
|
274
|
-
<a name="Label"></a>
|
|
275
|
-
|
|
276
|
-
## Label : <code>Object</code>
|
|
277
|
-
Field Mapping Label
|
|
278
|
-
|
|
279
|
-
**Kind**: global typedef
|
|
280
|
-
**Properties**
|
|
281
|
-
|
|
282
|
-
| Name | Type | Description |
|
|
283
|
-
| --- | --- | --- |
|
|
284
|
-
| name | <code>string</code> | The Label name. |
|
|
285
|
-
| value | <code>string</code> \| <code>number</code> \| <code>boolean</code> | The Label value. |
|
|
286
|
-
|
|
287
|
-
<a name="DynamicFields"></a>
|
|
288
|
-
|
|
289
|
-
## DynamicFields : <code>Object</code>
|
|
290
|
-
The dynamic fields payload.
|
|
291
|
-
|
|
292
|
-
**Kind**: global typedef
|
|
293
|
-
**Properties**
|
|
294
|
-
|
|
295
|
-
| Name | Type | Description |
|
|
296
|
-
| --- | --- | --- |
|
|
297
|
-
| map_fields_object | <code>Object.<string, Array.<Label>></code> | desc. |
|
|
298
|
-
|
|
299
|
-
<a name="SavedConfig"></a>
|
|
300
|
-
|
|
301
|
-
## SavedConfig : <code>Object</code>
|
|
302
|
-
An saved config.
|
|
303
|
-
|
|
304
|
-
**Kind**: global typedef
|
|
305
|
-
**Properties**
|
|
306
|
-
|
|
307
|
-
| Name | Type | Description |
|
|
308
|
-
| --- | --- | --- |
|
|
309
|
-
| [config_id] | <code>String</code> | Unique ID for the saved config. |
|
|
310
|
-
| application_data_slots | <code>Object.<string, (string\|number\|boolean)></code> | A map of application data slots and their values. |
|
|
311
|
-
| workflows | [<code>Array.<Workflow></code>](#Workflow) | Whether the workflow is enabled. |
|
|
312
|
-
|
|
313
|
-
<a name="Workflow"></a>
|
|
314
|
-
|
|
315
|
-
## Workflow : <code>Object</code>
|
|
316
|
-
The workflow.
|
|
317
|
-
|
|
318
|
-
**Kind**: global typedef
|
|
319
|
-
**Properties**
|
|
320
|
-
|
|
321
|
-
| Name | Type | Description |
|
|
322
|
-
| --- | --- | --- |
|
|
323
|
-
| id | <code>String</code> | The ID of the workflow. |
|
|
324
|
-
| enabled | <code>Boolean</code> | Whether the workflow is enabled. |
|
|
325
|
-
| data_slots | <code>Object.<string, (string\|number\|boolean)></code> | A map of workflow's data slots and their values. |
|
|
1
|
+
# cobalt.js
|
|
2
|
+
Cobalt frontend SDK.
|
|
3
|
+
|
|
4
|
+
## Install
|
|
5
|
+
|
|
6
|
+
#### npm
|
|
7
|
+
```bash
|
|
8
|
+
npm install @cobaltio/cobalt-js
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
#### yarn
|
|
12
|
+
```bash
|
|
13
|
+
yarn add @cobaltio/cobalt-js
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
<!-- Check the SDK [documentation](docs.md) for detailed information. -->
|
|
19
|
+
|
|
20
|
+
### Include
|
|
21
|
+
|
|
22
|
+
#### Browser
|
|
23
|
+
```html
|
|
24
|
+
<!-- import the latest version -->
|
|
25
|
+
<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js"></script>
|
|
26
|
+
<!-- import a specific version -->
|
|
27
|
+
<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@2"></script>
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
#### Node
|
|
31
|
+
```js
|
|
32
|
+
// CommonJS
|
|
33
|
+
const Cobalt = require("@cobaltio/cobalt-js");
|
|
34
|
+
// ESM
|
|
35
|
+
import Cobalt from "@cobaltio/cobalt-js";
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Initialize
|
|
39
|
+
```js
|
|
40
|
+
// initialize with token
|
|
41
|
+
const cobalt = new Cobalt({
|
|
42
|
+
// the token you generate for linked accounts using the cobalt backend SDK
|
|
43
|
+
token: "COBALT_SESSION_TOKEN",
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
// initialize without token
|
|
47
|
+
const cobalt = new Cobalt();
|
|
48
|
+
// the token you generate for linked accounts using the cobalt backend SDK
|
|
49
|
+
cobalt.token = "COBALT_SESSION_TOKEN";
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### SDK
|
|
53
|
+
|
|
54
|
+
## Classes
|
|
55
|
+
|
|
56
|
+
<dl>
|
|
57
|
+
<dt><a href="#Cobalt">Cobalt</a></dt>
|
|
58
|
+
<dd><p>Cobalt Frontend SDK</p>
|
|
59
|
+
</dd>
|
|
60
|
+
</dl>
|
|
61
|
+
|
|
62
|
+
## Typedefs
|
|
63
|
+
|
|
64
|
+
<dl>
|
|
65
|
+
<dt><a href="#Label">Label</a> : <code>Object</code></dt>
|
|
66
|
+
<dd><p>Field Mapping Label</p>
|
|
67
|
+
</dd>
|
|
68
|
+
<dt><a href="#DynamicField">DynamicField</a> : <code>Object</code></dt>
|
|
69
|
+
<dd><p>Field Mapping Label</p>
|
|
70
|
+
</dd>
|
|
71
|
+
<dt><a href="#DynamicFields">DynamicFields</a> : <code>Object</code></dt>
|
|
72
|
+
<dd><p>The dynamic fields payload.</p>
|
|
73
|
+
</dd>
|
|
74
|
+
<dt><a href="#Config">Config</a> : <code>Object</code></dt>
|
|
75
|
+
<dd><p>The configuration data for an application.</p>
|
|
76
|
+
</dd>
|
|
77
|
+
<dt><a href="#Workflow">Workflow</a> : <code>Object</code></dt>
|
|
78
|
+
<dd><p>The workflow.</p>
|
|
79
|
+
</dd>
|
|
80
|
+
</dl>
|
|
81
|
+
|
|
82
|
+
<a name="Cobalt"></a>
|
|
83
|
+
|
|
84
|
+
## Cobalt
|
|
85
|
+
Cobalt Frontend SDK
|
|
86
|
+
|
|
87
|
+
**Kind**: global class
|
|
88
|
+
|
|
89
|
+
* [Cobalt](#Cobalt)
|
|
90
|
+
* [new Cobalt(options)](#new_Cobalt_new)
|
|
91
|
+
* [.connect(slug, [payload])](#Cobalt+connect) ⇒ <code>Promise.<Boolean></code>
|
|
92
|
+
* [.disconnect(slug)](#Cobalt+disconnect) ⇒ <code>Promise.<void></code>
|
|
93
|
+
* [.config(slug, configId, [fields])](#Cobalt+config) ⇒ [<code>Promise.<Config></code>](#Config)
|
|
94
|
+
* [.getConfig(slug, configId)](#Cobalt+getConfig) ⇒ [<code>Promise.<Config></code>](#Config)
|
|
95
|
+
* [.updateConfig(slug, configId, payload)](#Cobalt+updateConfig) ⇒ [<code>Promise.<Config></code>](#Config)
|
|
96
|
+
* [.deleteConfig(slug, configId)](#Cobalt+deleteConfig) ⇒ <code>Promise.<unknown></code>
|
|
97
|
+
|
|
98
|
+
<a name="new_Cobalt_new"></a>
|
|
99
|
+
|
|
100
|
+
### new Cobalt(options)
|
|
101
|
+
Cobalt Frontend SDK
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
| Param | Type | Default | Description |
|
|
105
|
+
| --- | --- | --- | --- |
|
|
106
|
+
| options | <code>Object</code> | | The options to configure the Cobalt SDK. |
|
|
107
|
+
| [options.token] | <code>String</code> | | The session token. |
|
|
108
|
+
| [options.baseUrl] | <code>String</code> | <code>https://api.gocobalt.io</code> | The base URL of the Cobalt API. |
|
|
109
|
+
|
|
110
|
+
<a name="Cobalt+connect"></a>
|
|
111
|
+
|
|
112
|
+
### cobalt.connect(slug, [payload]) ⇒ <code>Promise.<Boolean></code>
|
|
113
|
+
Connect the specified application, optionally with the auth data that user provides.
|
|
114
|
+
|
|
115
|
+
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
116
|
+
**Returns**: <code>Promise.<Boolean></code> - Whether the connection was successful.
|
|
117
|
+
|
|
118
|
+
| Param | Type | Default | Description |
|
|
119
|
+
| --- | --- | --- | --- |
|
|
120
|
+
| slug | <code>String</code> | | The application slug. |
|
|
121
|
+
| [payload] | <code>Object.<string, (string\|number\|boolean)></code> | <code>{}</code> | The key value pairs of auth data. |
|
|
122
|
+
|
|
123
|
+
<a name="Cobalt+disconnect"></a>
|
|
124
|
+
|
|
125
|
+
### cobalt.disconnect(slug) ⇒ <code>Promise.<void></code>
|
|
126
|
+
Disconnect the specified application and remove any associated data from Cobalt.
|
|
127
|
+
|
|
128
|
+
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
129
|
+
|
|
130
|
+
| Param | Type | Description |
|
|
131
|
+
| --- | --- | --- |
|
|
132
|
+
| slug | <code>String</code> | The application slug. |
|
|
133
|
+
|
|
134
|
+
<a name="Cobalt+config"></a>
|
|
135
|
+
|
|
136
|
+
### cobalt.config(slug, configId, [fields]) ⇒ [<code>Promise.<Config></code>](#Config)
|
|
137
|
+
Returns the specified config, or creates one if it doesn't exist.
|
|
138
|
+
|
|
139
|
+
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
140
|
+
**Returns**: [<code>Promise.<Config></code>](#Config) - The specified config.
|
|
141
|
+
|
|
142
|
+
| Param | Type | Description |
|
|
143
|
+
| --- | --- | --- |
|
|
144
|
+
| slug | <code>String</code> | The application slug. |
|
|
145
|
+
| configId | <code>String</code> | A unique ID for the config. |
|
|
146
|
+
| [fields] | [<code>DynamicFields</code>](#DynamicFields) | The dynamic fields payload. |
|
|
147
|
+
|
|
148
|
+
<a name="Cobalt+getConfig"></a>
|
|
149
|
+
|
|
150
|
+
### cobalt.getConfig(slug, configId) ⇒ [<code>Promise.<Config></code>](#Config)
|
|
151
|
+
Returns the specified config.
|
|
152
|
+
|
|
153
|
+
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
154
|
+
**Returns**: [<code>Promise.<Config></code>](#Config) - The specified config.
|
|
155
|
+
|
|
156
|
+
| Param | Type | Description |
|
|
157
|
+
| --- | --- | --- |
|
|
158
|
+
| slug | <code>String</code> | The application slug. |
|
|
159
|
+
| configId | <code>String</code> | The unique ID of the config. |
|
|
160
|
+
|
|
161
|
+
<a name="Cobalt+updateConfig"></a>
|
|
162
|
+
|
|
163
|
+
### cobalt.updateConfig(slug, configId, payload) ⇒ [<code>Promise.<Config></code>](#Config)
|
|
164
|
+
Update the specified config.
|
|
165
|
+
|
|
166
|
+
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
167
|
+
**Returns**: [<code>Promise.<Config></code>](#Config) - The specified config.
|
|
168
|
+
|
|
169
|
+
| Param | Type | Description |
|
|
170
|
+
| --- | --- | --- |
|
|
171
|
+
| slug | <code>String</code> | The application slug. |
|
|
172
|
+
| configId | <code>String</code> | The unique ID of the config. |
|
|
173
|
+
| payload | [<code>Config</code>](#Config) | The update payload. |
|
|
174
|
+
|
|
175
|
+
<a name="Cobalt+deleteConfig"></a>
|
|
176
|
+
|
|
177
|
+
### cobalt.deleteConfig(slug, configId) ⇒ <code>Promise.<unknown></code>
|
|
178
|
+
Delete the specified config.
|
|
179
|
+
|
|
180
|
+
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
181
|
+
|
|
182
|
+
| Param | Type | Description |
|
|
183
|
+
| --- | --- | --- |
|
|
184
|
+
| slug | <code>String</code> | The application slug. |
|
|
185
|
+
| configId | <code>String</code> | The unique ID of the config. |
|
|
186
|
+
|
|
187
|
+
<a name="Label"></a>
|
|
188
|
+
|
|
189
|
+
## Label : <code>Object</code>
|
|
190
|
+
Field Mapping Label
|
|
191
|
+
|
|
192
|
+
**Kind**: global typedef
|
|
193
|
+
**Properties**
|
|
194
|
+
|
|
195
|
+
| Name | Type | Description |
|
|
196
|
+
| --- | --- | --- |
|
|
197
|
+
| name | <code>string</code> | The Label name. |
|
|
198
|
+
| value | <code>string</code> \| <code>number</code> \| <code>boolean</code> | The Label value. |
|
|
199
|
+
|
|
200
|
+
<a name="DynamicField"></a>
|
|
201
|
+
|
|
202
|
+
## DynamicField : <code>Object</code>
|
|
203
|
+
Field Mapping Label
|
|
204
|
+
|
|
205
|
+
**Kind**: global typedef
|
|
206
|
+
**Properties**
|
|
207
|
+
|
|
208
|
+
| Name | Type | Description |
|
|
209
|
+
| --- | --- | --- |
|
|
210
|
+
| fields | [<code>Array.<Label></code>](#Label) | The Label name. |
|
|
211
|
+
|
|
212
|
+
<a name="DynamicFields"></a>
|
|
213
|
+
|
|
214
|
+
## DynamicFields : <code>Object</code>
|
|
215
|
+
The dynamic fields payload.
|
|
216
|
+
|
|
217
|
+
**Kind**: global typedef
|
|
218
|
+
**Properties**
|
|
219
|
+
|
|
220
|
+
| Name | Type | Description |
|
|
221
|
+
| --- | --- | --- |
|
|
222
|
+
| map_fields_object | <code>Object.<string, DynamicField></code> | desc. |
|
|
223
|
+
|
|
224
|
+
<a name="Config"></a>
|
|
225
|
+
|
|
226
|
+
## Config : <code>Object</code>
|
|
227
|
+
The configuration data for an application.
|
|
228
|
+
|
|
229
|
+
**Kind**: global typedef
|
|
230
|
+
**Properties**
|
|
231
|
+
|
|
232
|
+
| Name | Type | Description |
|
|
233
|
+
| --- | --- | --- |
|
|
234
|
+
| [config_id] | <code>String</code> | Unique ID for the config. |
|
|
235
|
+
| application_data_slots | <code>Object.<string, (string\|number\|boolean)></code> | A map of application data slots and their values. |
|
|
236
|
+
| workflows | [<code>Array.<Workflow></code>](#Workflow) | Whether the workflow is enabled. |
|
|
237
|
+
|
|
238
|
+
<a name="Workflow"></a>
|
|
239
|
+
|
|
240
|
+
## Workflow : <code>Object</code>
|
|
241
|
+
The workflow.
|
|
242
|
+
|
|
243
|
+
**Kind**: global typedef
|
|
244
|
+
**Properties**
|
|
245
|
+
|
|
246
|
+
| Name | Type | Description |
|
|
247
|
+
| --- | --- | --- |
|
|
248
|
+
| id | <code>String</code> | The ID of the workflow. |
|
|
249
|
+
| enabled | <code>Boolean</code> | Whether the workflow is enabled. |
|
|
250
|
+
| data_slots | <code>Object.<string, (string\|number\|boolean)></code> | A map of workflow's data slots and their values. |
|