syllable-sdk 0.1.0-alpha.21 → 0.1.0-alpha.23
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 -34
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/models/components/custommessagecreaterequest.d.ts +6 -0
- package/models/components/custommessagecreaterequest.d.ts.map +1 -1
- package/models/components/custommessagecreaterequest.js +3 -0
- package/models/components/custommessagecreaterequest.js.map +1 -1
- package/models/components/custommessageresponse.d.ts +6 -0
- package/models/components/custommessageresponse.d.ts.map +1 -1
- package/models/components/custommessageresponse.js +3 -0
- package/models/components/custommessageresponse.js.map +1 -1
- package/models/components/custommessageupdaterequest.d.ts +6 -0
- package/models/components/custommessageupdaterequest.d.ts.map +1 -1
- package/models/components/custommessageupdaterequest.js +3 -0
- package/models/components/custommessageupdaterequest.js.map +1 -1
- package/models/components/daocustommessagerule.d.ts +63 -0
- package/models/components/daocustommessagerule.d.ts.map +1 -0
- package/models/components/daocustommessagerule.js +85 -0
- package/models/components/daocustommessagerule.js.map +1 -0
- package/models/components/dayofweek.d.ts +43 -0
- package/models/components/dayofweek.d.ts.map +1 -0
- package/models/components/dayofweek.js +56 -0
- package/models/components/dayofweek.js.map +1 -0
- package/models/components/index.d.ts +2 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +2 -0
- package/models/components/index.js.map +1 -1
- package/models/components/testmessage.d.ts +2 -0
- package/models/components/testmessage.d.ts.map +1 -1
- package/models/components/testmessage.js +4 -0
- package/models/components/testmessage.js.map +1 -1
- package/models/operations/index.d.ts +0 -8
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +0 -8
- package/models/operations/index.js.map +1 -1
- package/package.json +1 -1
- package/sdk/sdk.d.ts +0 -3
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +0 -5
- package/sdk/sdk.js.map +1 -1
- package/src/lib/config.ts +3 -3
- package/src/models/components/custommessagecreaterequest.ts +13 -0
- package/src/models/components/custommessageresponse.ts +13 -0
- package/src/models/components/custommessageupdaterequest.ts +13 -0
- package/src/models/components/daocustommessagerule.ts +129 -0
- package/src/models/components/dayofweek.ts +36 -0
- package/src/models/components/index.ts +2 -0
- package/src/models/components/testmessage.ts +6 -0
- package/src/models/operations/index.ts +0 -8
- package/src/sdk/sdk.ts +0 -6
- package/docs/sdks/dashboards/README.md +0 -587
- package/funcs/dashboardsGetDailyCallVolumeByHour.d.ts +0 -15
- package/funcs/dashboardsGetDailyCallVolumeByHour.d.ts.map +0 -1
- package/funcs/dashboardsGetDailyCallVolumeByHour.js +0 -86
- package/funcs/dashboardsGetDailyCallVolumeByHour.js.map +0 -1
- package/funcs/dashboardsGetMonthlyCallVolumeByDay.d.ts +0 -15
- package/funcs/dashboardsGetMonthlyCallVolumeByDay.d.ts.map +0 -1
- package/funcs/dashboardsGetMonthlyCallVolumeByDay.js +0 -86
- package/funcs/dashboardsGetMonthlyCallVolumeByDay.js.map +0 -1
- package/funcs/dashboardsGetMonthlyCallVolumeByWeek.d.ts +0 -15
- package/funcs/dashboardsGetMonthlyCallVolumeByWeek.d.ts.map +0 -1
- package/funcs/dashboardsGetMonthlyCallVolumeByWeek.js +0 -86
- package/funcs/dashboardsGetMonthlyCallVolumeByWeek.js.map +0 -1
- package/funcs/dashboardsGetSessionAgents.d.ts +0 -15
- package/funcs/dashboardsGetSessionAgents.d.ts.map +0 -1
- package/funcs/dashboardsGetSessionAgents.js +0 -85
- package/funcs/dashboardsGetSessionAgents.js.map +0 -1
- package/funcs/dashboardsGetSessionSummary.d.ts +0 -16
- package/funcs/dashboardsGetSessionSummary.d.ts.map +0 -1
- package/funcs/dashboardsGetSessionSummary.js +0 -107
- package/funcs/dashboardsGetSessionSummary.js.map +0 -1
- package/funcs/dashboardsGetTotalCallVolumeByHour.d.ts +0 -15
- package/funcs/dashboardsGetTotalCallVolumeByHour.d.ts.map +0 -1
- package/funcs/dashboardsGetTotalCallVolumeByHour.js +0 -86
- package/funcs/dashboardsGetTotalCallVolumeByHour.js.map +0 -1
- package/funcs/dashboardsGetWeeklyCallVolumeByWeekday.d.ts +0 -15
- package/funcs/dashboardsGetWeeklyCallVolumeByWeekday.d.ts.map +0 -1
- package/funcs/dashboardsGetWeeklyCallVolumeByWeekday.js +0 -86
- package/funcs/dashboardsGetWeeklyCallVolumeByWeekday.js.map +0 -1
- package/funcs/dashboardsTotalCallVolumeByWeekday.d.ts +0 -15
- package/funcs/dashboardsTotalCallVolumeByWeekday.d.ts.map +0 -1
- package/funcs/dashboardsTotalCallVolumeByWeekday.js +0 -86
- package/funcs/dashboardsTotalCallVolumeByWeekday.js.map +0 -1
- package/models/operations/getdailycallvolumebyhour.d.ts +0 -28
- package/models/operations/getdailycallvolumebyhour.d.ts.map +0 -1
- package/models/operations/getdailycallvolumebyhour.js +0 -57
- package/models/operations/getdailycallvolumebyhour.js.map +0 -1
- package/models/operations/getmonthlycallvolumebyday.d.ts +0 -28
- package/models/operations/getmonthlycallvolumebyday.d.ts.map +0 -1
- package/models/operations/getmonthlycallvolumebyday.js +0 -57
- package/models/operations/getmonthlycallvolumebyday.js.map +0 -1
- package/models/operations/getmonthlycallvolumebyweek.d.ts +0 -28
- package/models/operations/getmonthlycallvolumebyweek.d.ts.map +0 -1
- package/models/operations/getmonthlycallvolumebyweek.js +0 -57
- package/models/operations/getmonthlycallvolumebyweek.js.map +0 -1
- package/models/operations/getsessionagents.d.ts +0 -28
- package/models/operations/getsessionagents.d.ts.map +0 -1
- package/models/operations/getsessionagents.js +0 -55
- package/models/operations/getsessionagents.js.map +0 -1
- package/models/operations/getsessionsummary.d.ts +0 -63
- package/models/operations/getsessionsummary.d.ts.map +0 -1
- package/models/operations/getsessionsummary.js +0 -107
- package/models/operations/getsessionsummary.js.map +0 -1
- package/models/operations/gettotalcallvolumebyhour.d.ts +0 -28
- package/models/operations/gettotalcallvolumebyhour.d.ts.map +0 -1
- package/models/operations/gettotalcallvolumebyhour.js +0 -57
- package/models/operations/gettotalcallvolumebyhour.js.map +0 -1
- package/models/operations/getweeklycallvolumebyweekday.d.ts +0 -28
- package/models/operations/getweeklycallvolumebyweekday.d.ts.map +0 -1
- package/models/operations/getweeklycallvolumebyweekday.js +0 -57
- package/models/operations/getweeklycallvolumebyweekday.js.map +0 -1
- package/models/operations/totalcallvolumebyweekday.d.ts +0 -28
- package/models/operations/totalcallvolumebyweekday.d.ts.map +0 -1
- package/models/operations/totalcallvolumebyweekday.js +0 -57
- package/models/operations/totalcallvolumebyweekday.js.map +0 -1
- package/sdk/dashboards.d.ts +0 -61
- package/sdk/dashboards.d.ts.map +0 -1
- package/sdk/dashboards.js +0 -92
- package/sdk/dashboards.js.map +0 -1
- package/src/funcs/dashboardsGetDailyCallVolumeByHour.ts +0 -111
- package/src/funcs/dashboardsGetMonthlyCallVolumeByDay.ts +0 -113
- package/src/funcs/dashboardsGetMonthlyCallVolumeByWeek.ts +0 -113
- package/src/funcs/dashboardsGetSessionAgents.ts +0 -110
- package/src/funcs/dashboardsGetSessionSummary.ts +0 -143
- package/src/funcs/dashboardsGetTotalCallVolumeByHour.ts +0 -111
- package/src/funcs/dashboardsGetWeeklyCallVolumeByWeekday.ts +0 -113
- package/src/funcs/dashboardsTotalCallVolumeByWeekday.ts +0 -111
- package/src/models/operations/getdailycallvolumebyhour.ts +0 -74
- package/src/models/operations/getmonthlycallvolumebyday.ts +0 -74
- package/src/models/operations/getmonthlycallvolumebyweek.ts +0 -74
- package/src/models/operations/getsessionagents.ts +0 -72
- package/src/models/operations/getsessionsummary.ts +0 -164
- package/src/models/operations/gettotalcallvolumebyhour.ts +0 -74
- package/src/models/operations/getweeklycallvolumebyweekday.ts +0 -75
- package/src/models/operations/totalcallvolumebyweekday.ts +0 -74
- package/src/sdk/dashboards.ts +0 -151
|
@@ -1,587 +0,0 @@
|
|
|
1
|
-
# Dashboards
|
|
2
|
-
(*dashboards*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
Operations related to system dashboard
|
|
7
|
-
|
|
8
|
-
### Available Operations
|
|
9
|
-
|
|
10
|
-
* [totalCallVolumeByWeekday](#totalcallvolumebyweekday) - Get Total Call Volume By Weekday
|
|
11
|
-
* [getTotalCallVolumeByHour](#gettotalcallvolumebyhour) - Get Total Call Volume By Hour
|
|
12
|
-
* [getWeeklyCallVolumeByWeekday](#getweeklycallvolumebyweekday) - Get Weekly Call Volume By Weekday
|
|
13
|
-
* [getDailyCallVolumeByHour](#getdailycallvolumebyhour) - Get Daily Call Volume By Hour
|
|
14
|
-
* [getMonthlyCallVolumeByWeek](#getmonthlycallvolumebyweek) - Get Monthly Call Volume By Week
|
|
15
|
-
* [getMonthlyCallVolumeByDay](#getmonthlycallvolumebyday) - Get Monthly Call Volume By Day
|
|
16
|
-
* [getSessionSummary](#getsessionsummary) - Get Session Summary
|
|
17
|
-
* [getSessionAgents](#getsessionagents) - Get Agents
|
|
18
|
-
|
|
19
|
-
## totalCallVolumeByWeekday
|
|
20
|
-
|
|
21
|
-
Get total call volume by weekday.
|
|
22
|
-
|
|
23
|
-
### Example Usage
|
|
24
|
-
|
|
25
|
-
```typescript
|
|
26
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
27
|
-
|
|
28
|
-
const syllableSDK = new SyllableSDK({
|
|
29
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
30
|
-
});
|
|
31
|
-
|
|
32
|
-
async function run() {
|
|
33
|
-
const result = await syllableSDK.dashboards.totalCallVolumeByWeekday();
|
|
34
|
-
|
|
35
|
-
// Handle the result
|
|
36
|
-
console.log(result);
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
run();
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### Standalone function
|
|
43
|
-
|
|
44
|
-
The standalone function version of this method:
|
|
45
|
-
|
|
46
|
-
```typescript
|
|
47
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
48
|
-
import { dashboardsTotalCallVolumeByWeekday } from "syllable-sdk/funcs/dashboardsTotalCallVolumeByWeekday.js";
|
|
49
|
-
|
|
50
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
51
|
-
// You can create one instance of it to use across an application.
|
|
52
|
-
const syllableSDK = new SyllableSDKCore({
|
|
53
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
54
|
-
});
|
|
55
|
-
|
|
56
|
-
async function run() {
|
|
57
|
-
const res = await dashboardsTotalCallVolumeByWeekday(syllableSDK);
|
|
58
|
-
|
|
59
|
-
if (!res.ok) {
|
|
60
|
-
throw res.error;
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
const { value: result } = res;
|
|
64
|
-
|
|
65
|
-
// Handle the result
|
|
66
|
-
console.log(result);
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
run();
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
### Parameters
|
|
73
|
-
|
|
74
|
-
| Parameter | Type | Required | Description |
|
|
75
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
76
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
77
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
78
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
79
|
-
|
|
80
|
-
### Response
|
|
81
|
-
|
|
82
|
-
**Promise\<[operations.TotalCallVolumeByWeekdayResponseTotalCallVolumeByWeekday](../../models/operations/totalcallvolumebyweekdayresponsetotalcallvolumebyweekday.md)\>**
|
|
83
|
-
|
|
84
|
-
### Errors
|
|
85
|
-
|
|
86
|
-
| Error Type | Status Code | Content Type |
|
|
87
|
-
| --------------- | --------------- | --------------- |
|
|
88
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
89
|
-
|
|
90
|
-
## getTotalCallVolumeByHour
|
|
91
|
-
|
|
92
|
-
Get total call volume by hour.
|
|
93
|
-
|
|
94
|
-
### Example Usage
|
|
95
|
-
|
|
96
|
-
```typescript
|
|
97
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
98
|
-
|
|
99
|
-
const syllableSDK = new SyllableSDK({
|
|
100
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
101
|
-
});
|
|
102
|
-
|
|
103
|
-
async function run() {
|
|
104
|
-
const result = await syllableSDK.dashboards.getTotalCallVolumeByHour();
|
|
105
|
-
|
|
106
|
-
// Handle the result
|
|
107
|
-
console.log(result);
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
run();
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
### Standalone function
|
|
114
|
-
|
|
115
|
-
The standalone function version of this method:
|
|
116
|
-
|
|
117
|
-
```typescript
|
|
118
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
119
|
-
import { dashboardsGetTotalCallVolumeByHour } from "syllable-sdk/funcs/dashboardsGetTotalCallVolumeByHour.js";
|
|
120
|
-
|
|
121
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
122
|
-
// You can create one instance of it to use across an application.
|
|
123
|
-
const syllableSDK = new SyllableSDKCore({
|
|
124
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
125
|
-
});
|
|
126
|
-
|
|
127
|
-
async function run() {
|
|
128
|
-
const res = await dashboardsGetTotalCallVolumeByHour(syllableSDK);
|
|
129
|
-
|
|
130
|
-
if (!res.ok) {
|
|
131
|
-
throw res.error;
|
|
132
|
-
}
|
|
133
|
-
|
|
134
|
-
const { value: result } = res;
|
|
135
|
-
|
|
136
|
-
// Handle the result
|
|
137
|
-
console.log(result);
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
run();
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
### Parameters
|
|
144
|
-
|
|
145
|
-
| Parameter | Type | Required | Description |
|
|
146
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
147
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
148
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
149
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
150
|
-
|
|
151
|
-
### Response
|
|
152
|
-
|
|
153
|
-
**Promise\<[operations.GetTotalCallVolumeByHourResponseGetTotalCallVolumeByHour](../../models/operations/gettotalcallvolumebyhourresponsegettotalcallvolumebyhour.md)\>**
|
|
154
|
-
|
|
155
|
-
### Errors
|
|
156
|
-
|
|
157
|
-
| Error Type | Status Code | Content Type |
|
|
158
|
-
| --------------- | --------------- | --------------- |
|
|
159
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
160
|
-
|
|
161
|
-
## getWeeklyCallVolumeByWeekday
|
|
162
|
-
|
|
163
|
-
Get weekly call volume by weekday.
|
|
164
|
-
|
|
165
|
-
### Example Usage
|
|
166
|
-
|
|
167
|
-
```typescript
|
|
168
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
169
|
-
|
|
170
|
-
const syllableSDK = new SyllableSDK({
|
|
171
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
172
|
-
});
|
|
173
|
-
|
|
174
|
-
async function run() {
|
|
175
|
-
const result = await syllableSDK.dashboards.getWeeklyCallVolumeByWeekday();
|
|
176
|
-
|
|
177
|
-
// Handle the result
|
|
178
|
-
console.log(result);
|
|
179
|
-
}
|
|
180
|
-
|
|
181
|
-
run();
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
### Standalone function
|
|
185
|
-
|
|
186
|
-
The standalone function version of this method:
|
|
187
|
-
|
|
188
|
-
```typescript
|
|
189
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
190
|
-
import { dashboardsGetWeeklyCallVolumeByWeekday } from "syllable-sdk/funcs/dashboardsGetWeeklyCallVolumeByWeekday.js";
|
|
191
|
-
|
|
192
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
193
|
-
// You can create one instance of it to use across an application.
|
|
194
|
-
const syllableSDK = new SyllableSDKCore({
|
|
195
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
196
|
-
});
|
|
197
|
-
|
|
198
|
-
async function run() {
|
|
199
|
-
const res = await dashboardsGetWeeklyCallVolumeByWeekday(syllableSDK);
|
|
200
|
-
|
|
201
|
-
if (!res.ok) {
|
|
202
|
-
throw res.error;
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
const { value: result } = res;
|
|
206
|
-
|
|
207
|
-
// Handle the result
|
|
208
|
-
console.log(result);
|
|
209
|
-
}
|
|
210
|
-
|
|
211
|
-
run();
|
|
212
|
-
```
|
|
213
|
-
|
|
214
|
-
### Parameters
|
|
215
|
-
|
|
216
|
-
| Parameter | Type | Required | Description |
|
|
217
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
218
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
219
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
220
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
221
|
-
|
|
222
|
-
### Response
|
|
223
|
-
|
|
224
|
-
**Promise\<[operations.GetWeeklyCallVolumeByWeekdayResponseGetWeeklyCallVolumeByWeekday](../../models/operations/getweeklycallvolumebyweekdayresponsegetweeklycallvolumebyweekday.md)\>**
|
|
225
|
-
|
|
226
|
-
### Errors
|
|
227
|
-
|
|
228
|
-
| Error Type | Status Code | Content Type |
|
|
229
|
-
| --------------- | --------------- | --------------- |
|
|
230
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
231
|
-
|
|
232
|
-
## getDailyCallVolumeByHour
|
|
233
|
-
|
|
234
|
-
Get daily call volume by hour.
|
|
235
|
-
|
|
236
|
-
### Example Usage
|
|
237
|
-
|
|
238
|
-
```typescript
|
|
239
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
240
|
-
|
|
241
|
-
const syllableSDK = new SyllableSDK({
|
|
242
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
243
|
-
});
|
|
244
|
-
|
|
245
|
-
async function run() {
|
|
246
|
-
const result = await syllableSDK.dashboards.getDailyCallVolumeByHour();
|
|
247
|
-
|
|
248
|
-
// Handle the result
|
|
249
|
-
console.log(result);
|
|
250
|
-
}
|
|
251
|
-
|
|
252
|
-
run();
|
|
253
|
-
```
|
|
254
|
-
|
|
255
|
-
### Standalone function
|
|
256
|
-
|
|
257
|
-
The standalone function version of this method:
|
|
258
|
-
|
|
259
|
-
```typescript
|
|
260
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
261
|
-
import { dashboardsGetDailyCallVolumeByHour } from "syllable-sdk/funcs/dashboardsGetDailyCallVolumeByHour.js";
|
|
262
|
-
|
|
263
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
264
|
-
// You can create one instance of it to use across an application.
|
|
265
|
-
const syllableSDK = new SyllableSDKCore({
|
|
266
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
267
|
-
});
|
|
268
|
-
|
|
269
|
-
async function run() {
|
|
270
|
-
const res = await dashboardsGetDailyCallVolumeByHour(syllableSDK);
|
|
271
|
-
|
|
272
|
-
if (!res.ok) {
|
|
273
|
-
throw res.error;
|
|
274
|
-
}
|
|
275
|
-
|
|
276
|
-
const { value: result } = res;
|
|
277
|
-
|
|
278
|
-
// Handle the result
|
|
279
|
-
console.log(result);
|
|
280
|
-
}
|
|
281
|
-
|
|
282
|
-
run();
|
|
283
|
-
```
|
|
284
|
-
|
|
285
|
-
### Parameters
|
|
286
|
-
|
|
287
|
-
| Parameter | Type | Required | Description |
|
|
288
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
289
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
290
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
291
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
292
|
-
|
|
293
|
-
### Response
|
|
294
|
-
|
|
295
|
-
**Promise\<[operations.GetDailyCallVolumeByHourResponseGetDailyCallVolumeByHour](../../models/operations/getdailycallvolumebyhourresponsegetdailycallvolumebyhour.md)\>**
|
|
296
|
-
|
|
297
|
-
### Errors
|
|
298
|
-
|
|
299
|
-
| Error Type | Status Code | Content Type |
|
|
300
|
-
| --------------- | --------------- | --------------- |
|
|
301
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
302
|
-
|
|
303
|
-
## getMonthlyCallVolumeByWeek
|
|
304
|
-
|
|
305
|
-
Get monthly cal volume by week.
|
|
306
|
-
|
|
307
|
-
### Example Usage
|
|
308
|
-
|
|
309
|
-
```typescript
|
|
310
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
311
|
-
|
|
312
|
-
const syllableSDK = new SyllableSDK({
|
|
313
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
314
|
-
});
|
|
315
|
-
|
|
316
|
-
async function run() {
|
|
317
|
-
const result = await syllableSDK.dashboards.getMonthlyCallVolumeByWeek();
|
|
318
|
-
|
|
319
|
-
// Handle the result
|
|
320
|
-
console.log(result);
|
|
321
|
-
}
|
|
322
|
-
|
|
323
|
-
run();
|
|
324
|
-
```
|
|
325
|
-
|
|
326
|
-
### Standalone function
|
|
327
|
-
|
|
328
|
-
The standalone function version of this method:
|
|
329
|
-
|
|
330
|
-
```typescript
|
|
331
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
332
|
-
import { dashboardsGetMonthlyCallVolumeByWeek } from "syllable-sdk/funcs/dashboardsGetMonthlyCallVolumeByWeek.js";
|
|
333
|
-
|
|
334
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
335
|
-
// You can create one instance of it to use across an application.
|
|
336
|
-
const syllableSDK = new SyllableSDKCore({
|
|
337
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
338
|
-
});
|
|
339
|
-
|
|
340
|
-
async function run() {
|
|
341
|
-
const res = await dashboardsGetMonthlyCallVolumeByWeek(syllableSDK);
|
|
342
|
-
|
|
343
|
-
if (!res.ok) {
|
|
344
|
-
throw res.error;
|
|
345
|
-
}
|
|
346
|
-
|
|
347
|
-
const { value: result } = res;
|
|
348
|
-
|
|
349
|
-
// Handle the result
|
|
350
|
-
console.log(result);
|
|
351
|
-
}
|
|
352
|
-
|
|
353
|
-
run();
|
|
354
|
-
```
|
|
355
|
-
|
|
356
|
-
### Parameters
|
|
357
|
-
|
|
358
|
-
| Parameter | Type | Required | Description |
|
|
359
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
360
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
361
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
362
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
363
|
-
|
|
364
|
-
### Response
|
|
365
|
-
|
|
366
|
-
**Promise\<[operations.GetMonthlyCallVolumeByWeekResponseGetMonthlyCallVolumeByWeek](../../models/operations/getmonthlycallvolumebyweekresponsegetmonthlycallvolumebyweek.md)\>**
|
|
367
|
-
|
|
368
|
-
### Errors
|
|
369
|
-
|
|
370
|
-
| Error Type | Status Code | Content Type |
|
|
371
|
-
| --------------- | --------------- | --------------- |
|
|
372
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
373
|
-
|
|
374
|
-
## getMonthlyCallVolumeByDay
|
|
375
|
-
|
|
376
|
-
Get monthly call volume by day.
|
|
377
|
-
|
|
378
|
-
### Example Usage
|
|
379
|
-
|
|
380
|
-
```typescript
|
|
381
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
382
|
-
|
|
383
|
-
const syllableSDK = new SyllableSDK({
|
|
384
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
385
|
-
});
|
|
386
|
-
|
|
387
|
-
async function run() {
|
|
388
|
-
const result = await syllableSDK.dashboards.getMonthlyCallVolumeByDay();
|
|
389
|
-
|
|
390
|
-
// Handle the result
|
|
391
|
-
console.log(result);
|
|
392
|
-
}
|
|
393
|
-
|
|
394
|
-
run();
|
|
395
|
-
```
|
|
396
|
-
|
|
397
|
-
### Standalone function
|
|
398
|
-
|
|
399
|
-
The standalone function version of this method:
|
|
400
|
-
|
|
401
|
-
```typescript
|
|
402
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
403
|
-
import { dashboardsGetMonthlyCallVolumeByDay } from "syllable-sdk/funcs/dashboardsGetMonthlyCallVolumeByDay.js";
|
|
404
|
-
|
|
405
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
406
|
-
// You can create one instance of it to use across an application.
|
|
407
|
-
const syllableSDK = new SyllableSDKCore({
|
|
408
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
409
|
-
});
|
|
410
|
-
|
|
411
|
-
async function run() {
|
|
412
|
-
const res = await dashboardsGetMonthlyCallVolumeByDay(syllableSDK);
|
|
413
|
-
|
|
414
|
-
if (!res.ok) {
|
|
415
|
-
throw res.error;
|
|
416
|
-
}
|
|
417
|
-
|
|
418
|
-
const { value: result } = res;
|
|
419
|
-
|
|
420
|
-
// Handle the result
|
|
421
|
-
console.log(result);
|
|
422
|
-
}
|
|
423
|
-
|
|
424
|
-
run();
|
|
425
|
-
```
|
|
426
|
-
|
|
427
|
-
### Parameters
|
|
428
|
-
|
|
429
|
-
| Parameter | Type | Required | Description |
|
|
430
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
431
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
432
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
433
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
434
|
-
|
|
435
|
-
### Response
|
|
436
|
-
|
|
437
|
-
**Promise\<[operations.GetMonthlyCallVolumeByDayResponseGetMonthlyCallVolumeByDay](../../models/operations/getmonthlycallvolumebydayresponsegetmonthlycallvolumebyday.md)\>**
|
|
438
|
-
|
|
439
|
-
### Errors
|
|
440
|
-
|
|
441
|
-
| Error Type | Status Code | Content Type |
|
|
442
|
-
| --------------- | --------------- | --------------- |
|
|
443
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
444
|
-
|
|
445
|
-
## getSessionSummary
|
|
446
|
-
|
|
447
|
-
Get session summary data
|
|
448
|
-
|
|
449
|
-
### Example Usage
|
|
450
|
-
|
|
451
|
-
```typescript
|
|
452
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
453
|
-
|
|
454
|
-
const syllableSDK = new SyllableSDK({
|
|
455
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
456
|
-
});
|
|
457
|
-
|
|
458
|
-
async function run() {
|
|
459
|
-
const result = await syllableSDK.dashboards.getSessionSummary({});
|
|
460
|
-
|
|
461
|
-
// Handle the result
|
|
462
|
-
console.log(result);
|
|
463
|
-
}
|
|
464
|
-
|
|
465
|
-
run();
|
|
466
|
-
```
|
|
467
|
-
|
|
468
|
-
### Standalone function
|
|
469
|
-
|
|
470
|
-
The standalone function version of this method:
|
|
471
|
-
|
|
472
|
-
```typescript
|
|
473
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
474
|
-
import { dashboardsGetSessionSummary } from "syllable-sdk/funcs/dashboardsGetSessionSummary.js";
|
|
475
|
-
|
|
476
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
477
|
-
// You can create one instance of it to use across an application.
|
|
478
|
-
const syllableSDK = new SyllableSDKCore({
|
|
479
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
480
|
-
});
|
|
481
|
-
|
|
482
|
-
async function run() {
|
|
483
|
-
const res = await dashboardsGetSessionSummary(syllableSDK, {});
|
|
484
|
-
|
|
485
|
-
if (!res.ok) {
|
|
486
|
-
throw res.error;
|
|
487
|
-
}
|
|
488
|
-
|
|
489
|
-
const { value: result } = res;
|
|
490
|
-
|
|
491
|
-
// Handle the result
|
|
492
|
-
console.log(result);
|
|
493
|
-
}
|
|
494
|
-
|
|
495
|
-
run();
|
|
496
|
-
```
|
|
497
|
-
|
|
498
|
-
### Parameters
|
|
499
|
-
|
|
500
|
-
| Parameter | Type | Required | Description |
|
|
501
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
502
|
-
| `request` | [operations.GetSessionSummaryRequest](../../models/operations/getsessionsummaryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
503
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
504
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
505
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
506
|
-
|
|
507
|
-
### Response
|
|
508
|
-
|
|
509
|
-
**Promise\<[operations.GetSessionSummaryResponseGetSessionSummary](../../models/operations/getsessionsummaryresponsegetsessionsummary.md)\>**
|
|
510
|
-
|
|
511
|
-
### Errors
|
|
512
|
-
|
|
513
|
-
| Error Type | Status Code | Content Type |
|
|
514
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
515
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
516
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
517
|
-
|
|
518
|
-
## getSessionAgents
|
|
519
|
-
|
|
520
|
-
Get list of agents for session summary dropdown
|
|
521
|
-
|
|
522
|
-
### Example Usage
|
|
523
|
-
|
|
524
|
-
```typescript
|
|
525
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
526
|
-
|
|
527
|
-
const syllableSDK = new SyllableSDK({
|
|
528
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
529
|
-
});
|
|
530
|
-
|
|
531
|
-
async function run() {
|
|
532
|
-
const result = await syllableSDK.dashboards.getSessionAgents();
|
|
533
|
-
|
|
534
|
-
// Handle the result
|
|
535
|
-
console.log(result);
|
|
536
|
-
}
|
|
537
|
-
|
|
538
|
-
run();
|
|
539
|
-
```
|
|
540
|
-
|
|
541
|
-
### Standalone function
|
|
542
|
-
|
|
543
|
-
The standalone function version of this method:
|
|
544
|
-
|
|
545
|
-
```typescript
|
|
546
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
547
|
-
import { dashboardsGetSessionAgents } from "syllable-sdk/funcs/dashboardsGetSessionAgents.js";
|
|
548
|
-
|
|
549
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
550
|
-
// You can create one instance of it to use across an application.
|
|
551
|
-
const syllableSDK = new SyllableSDKCore({
|
|
552
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
553
|
-
});
|
|
554
|
-
|
|
555
|
-
async function run() {
|
|
556
|
-
const res = await dashboardsGetSessionAgents(syllableSDK);
|
|
557
|
-
|
|
558
|
-
if (!res.ok) {
|
|
559
|
-
throw res.error;
|
|
560
|
-
}
|
|
561
|
-
|
|
562
|
-
const { value: result } = res;
|
|
563
|
-
|
|
564
|
-
// Handle the result
|
|
565
|
-
console.log(result);
|
|
566
|
-
}
|
|
567
|
-
|
|
568
|
-
run();
|
|
569
|
-
```
|
|
570
|
-
|
|
571
|
-
### Parameters
|
|
572
|
-
|
|
573
|
-
| Parameter | Type | Required | Description |
|
|
574
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
575
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
576
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
577
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
578
|
-
|
|
579
|
-
### Response
|
|
580
|
-
|
|
581
|
-
**Promise\<[operations.GetSessionAgentsResponseGetSessionAgents](../../models/operations/getsessionagentsresponsegetsessionagents.md)\>**
|
|
582
|
-
|
|
583
|
-
### Errors
|
|
584
|
-
|
|
585
|
-
| Error Type | Status Code | Content Type |
|
|
586
|
-
| --------------- | --------------- | --------------- |
|
|
587
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import { SyllableSDKCore } from "../core.js";
|
|
2
|
-
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
-
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
|
|
4
|
-
import { SDKError } from "../models/errors/sdkerror.js";
|
|
5
|
-
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
6
|
-
import * as operations from "../models/operations/index.js";
|
|
7
|
-
import { Result } from "../types/fp.js";
|
|
8
|
-
/**
|
|
9
|
-
* Get Daily Call Volume By Hour
|
|
10
|
-
*
|
|
11
|
-
* @remarks
|
|
12
|
-
* Get daily call volume by hour.
|
|
13
|
-
*/
|
|
14
|
-
export declare function dashboardsGetDailyCallVolumeByHour(client: SyllableSDKCore, options?: RequestOptions): Promise<Result<operations.GetDailyCallVolumeByHourResponseGetDailyCallVolumeByHour, SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
|
|
15
|
-
//# sourceMappingURL=dashboardsGetDailyCallVolumeByHour.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"dashboardsGetDailyCallVolumeByHour.d.ts","sourceRoot":"","sources":["../src/funcs/dashboardsGetDailyCallVolumeByHour.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAsB,kCAAkC,CACtD,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,wDAAwD,EACjE,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAqEA"}
|