voxtelesys-flow 2.12.0 → 2.14.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 +17 -17
- package/dist/index.js +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
## Overview
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
The `voxtelesys-flow` library allows users to implement
|
|
7
|
+
[missio™ Canvas](https://voxtelesys.com/missio-canvas) is a low/no-code user interface for building and managing communication flows.
|
|
8
|
+
The `voxtelesys-flow` library allows users to implement Canvas into their own front-end JavaScript applications.
|
|
9
9
|
|
|
10
10
|
## Getting Started
|
|
11
11
|
|
|
@@ -19,13 +19,13 @@ npm i voxtelesys-flow
|
|
|
19
19
|
|
|
20
20
|
### Initialization
|
|
21
21
|
|
|
22
|
-
To initialize
|
|
22
|
+
To initialize Canvas, create an empty HTML element to mount into:
|
|
23
23
|
|
|
24
24
|
```html
|
|
25
25
|
<div id="element-id"/>
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Then, mount
|
|
28
|
+
Then, mount Canvas using the ID of the HTML element and the available [configuration options](#configuration):
|
|
29
29
|
|
|
30
30
|
```js
|
|
31
31
|
import { FlowBuilder } from 'voxtelesys-flow'
|
|
@@ -44,7 +44,7 @@ await FlowBuilder.init('element-id', {
|
|
|
44
44
|
})
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
The default CSS styling for
|
|
47
|
+
The default CSS styling for Canvas is bundled with the JavaScript and will be automatically loaded when the library is imported.
|
|
48
48
|
|
|
49
49
|
### Configuration
|
|
50
50
|
|
|
@@ -56,29 +56,29 @@ The default CSS styling for the VAST Flow Builder is bundled with the JavaScript
|
|
|
56
56
|
|
|
57
57
|
- `flowGuid`
|
|
58
58
|
|
|
59
|
-
Required. The GUID of the
|
|
60
|
-
visit the [
|
|
61
|
-
|
|
59
|
+
Required. The GUID of the flow that the user will be able to view and edit in Canvas once it has been mounted. To view the flows that belong to your account,
|
|
60
|
+
visit the [Canvas](https://portal.voxtelesys.net/canvas) page on the Customer Portal. Alternatively, you can retrieve a list of flows using the `GET /flows` route on the Dashboard API, or create a new
|
|
61
|
+
flow using the `POST /flows` route.
|
|
62
62
|
|
|
63
63
|
- `onBack`
|
|
64
64
|
|
|
65
|
-
Optional. A function that is executed when the back arrow in
|
|
65
|
+
Optional. A function that is executed when the back arrow in Canvas is clicked. If `onBack` is omitted, then the back arrow will be hidden.
|
|
66
66
|
|
|
67
67
|
- `companyName`
|
|
68
68
|
|
|
69
|
-
Optional. The text to be displayed at the bottom of
|
|
69
|
+
Optional. The text to be displayed at the bottom of Canvas next to "Powered by Voxtelesys". The `companyName` parameter is used to co-brand Canvas by displaying your
|
|
70
70
|
company's name on the screen.
|
|
71
71
|
|
|
72
72
|
- `companyLogo`
|
|
73
73
|
|
|
74
|
-
Optional. The path or URL of an image to be displayed at the bottom of
|
|
74
|
+
Optional. The path or URL of an image to be displayed at the bottom of Canvas next to "Powered by Voxtelesys". The `companyLogo` parameter is used to co-brand Canvas by displaying your
|
|
75
75
|
company's logo on the screen.
|
|
76
76
|
|
|
77
77
|
- `styling`
|
|
78
78
|
|
|
79
|
-
Optional. An object with properties that override CSS styles in
|
|
79
|
+
Optional. An object with properties that override CSS styles in Canvas.
|
|
80
80
|
|
|
81
|
-
The `styling` object can be used to customize the look and feel of
|
|
81
|
+
The `styling` object can be used to customize the look and feel of Canvas, such as its colors and font sizes. The properties available in `styling` are listed [below](#styling-overrides).
|
|
82
82
|
|
|
83
83
|
#### Styling Overrides
|
|
84
84
|
|
|
@@ -170,10 +170,10 @@ The default CSS styling for the VAST Flow Builder is bundled with the JavaScript
|
|
|
170
170
|
|
|
171
171
|
## Dashboard API
|
|
172
172
|
|
|
173
|
-
All HTTP requests from
|
|
173
|
+
All HTTP requests from Canvas are directed to publicly-available routes on the Dashboard API using the API key provided.
|
|
174
174
|
|
|
175
|
-
In addition to the routes used directly by
|
|
176
|
-
- View and manage
|
|
175
|
+
In addition to the routes used directly by Canvas, the Dashboard API also provides the ability to:
|
|
176
|
+
- View and manage flows and flow versions
|
|
177
177
|
- View and update telephone numbers (TNs)
|
|
178
178
|
- View and manage route profiles and route profile routes
|
|
179
179
|
- View and manage Voice API profiles
|
|
@@ -183,4 +183,4 @@ See the Dashboard API [documentation](https://dashboardapi.voxtelesys.com/) for
|
|
|
183
183
|
|
|
184
184
|
## Additional Resources
|
|
185
185
|
|
|
186
|
-
- [
|
|
186
|
+
- [Canvas Tutorials](https://voxtelesys.com/learning-hub/tutorials?category=canvas)
|
package/dist/index.js
CHANGED
|
@@ -10,16 +10,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
10
10
|
let module;
|
|
11
11
|
export class FlowBuilder {
|
|
12
12
|
/**
|
|
13
|
-
* Initializes the
|
|
13
|
+
* Initializes the SDK.
|
|
14
14
|
*
|
|
15
|
-
* @param elementId - The ID of the HTML element to render
|
|
15
|
+
* @param elementId - The ID of the HTML element to render Canvas in (required).
|
|
16
16
|
* @param options.apiToken - The API token for authentication (required).
|
|
17
17
|
*/
|
|
18
18
|
static init(elementId, options) {
|
|
19
19
|
return __awaiter(this, void 0, void 0, function* () {
|
|
20
20
|
// @ts-ignore
|
|
21
21
|
if (!module)
|
|
22
|
-
module = yield import('https://dmfmrckmde2ek.cloudfront.net/vast-flow-builder-v4.
|
|
22
|
+
module = yield import('https://dmfmrckmde2ek.cloudfront.net/vast-flow-builder-v4.13.0.js');
|
|
23
23
|
yield module.init(elementId, options);
|
|
24
24
|
});
|
|
25
25
|
}
|