syllable-sdk 1.0.8-rc.1 → 1.0.8-rc.2
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/bin/mcp-server.js +6 -6
- package/bin/mcp-server.js.map +4 -4
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.js +1 -1
- package/openapi.json +33 -33
- package/package.json +1 -1
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/.devcontainer/README.md +0 -35
- package/api-reference/sdks/agents/README.md +0 -224
- package/api-reference/sdks/availabletargets/README.md +0 -49
- package/api-reference/sdks/channels/README.md +0 -92
- package/api-reference/sdks/chats/README.md +0 -55
- package/api-reference/sdks/conversations/README.md +0 -91
- package/api-reference/sdks/dashboards/README.md +0 -321
- package/api-reference/sdks/events/README.md +0 -50
- package/api-reference/sdks/greetings/README.md +0 -223
- package/api-reference/sdks/organizations/README.md +0 -48
- package/api-reference/sdks/prompts/README.md +0 -225
- package/api-reference/sdks/sessions/README.md +0 -50
- package/api-reference/sdks/syllable/README.md +0 -22
- package/api-reference/sdks/targets/README.md +0 -194
- package/api-reference/sdks/tools/README.md +0 -92
- package/docs/sdks/agents/README.md +0 -589
- package/docs/sdks/batches/README.md +0 -742
- package/docs/sdks/campaigns/README.md +0 -526
- package/docs/sdks/channels/README.md +0 -401
- package/docs/sdks/conversations/README.md +0 -100
- package/docs/sdks/custommessages/README.md +0 -496
- package/docs/sdks/dashboards/README.md +0 -481
- package/docs/sdks/datasources/README.md +0 -458
- package/docs/sdks/directory/README.md +0 -727
- package/docs/sdks/events/README.md +0 -100
- package/docs/sdks/folders/README.md +0 -675
- package/docs/sdks/fullsummary/README.md +0 -82
- package/docs/sdks/incidents/README.md +0 -501
- package/docs/sdks/insights/README.md +0 -100
- package/docs/sdks/languagegroups/README.md +0 -565
- package/docs/sdks/latency/README.md +0 -82
- package/docs/sdks/numbers/README.md +0 -250
- package/docs/sdks/organizations/README.md +0 -317
- package/docs/sdks/permissions/README.md +0 -78
- package/docs/sdks/prompts/README.md +0 -592
- package/docs/sdks/pronunciations/README.md +0 -360
- package/docs/sdks/roles/README.md +0 -430
- package/docs/sdks/services/README.md +0 -430
- package/docs/sdks/sessiondebug/README.md +0 -236
- package/docs/sdks/sessionlabels/README.md +0 -262
- package/docs/sdks/sessions/README.md +0 -325
- package/docs/sdks/syllablesdktools/README.md +0 -578
- package/docs/sdks/takeouts/README.md +0 -228
- package/docs/sdks/targets/README.md +0 -454
- package/docs/sdks/test/README.md +0 -92
- package/docs/sdks/tools/README.md +0 -518
- package/docs/sdks/transcript/README.md +0 -82
- package/docs/sdks/twilio/README.md +0 -246
- package/docs/sdks/users/README.md +0 -561
- package/docs/sdks/v1/README.md +0 -561
- package/docs/sdks/voicegroups/README.md +0 -551
- package/docs/sdks/workflows/README.md +0 -781
- package/examples/README.md +0 -31
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
# FullSummary
|
|
2
|
-
(*sessions.fullSummary*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [getById](#getbyid) - Get Full Session Summary By Id
|
|
9
|
-
|
|
10
|
-
## getById
|
|
11
|
-
|
|
12
|
-
Get Full Session Summary By Id
|
|
13
|
-
|
|
14
|
-
### Example Usage
|
|
15
|
-
|
|
16
|
-
<!-- UsageSnippet language="typescript" operationID="session_full_summary_get_by_id" method="get" path="/api/v1/sessions/full-summary/{session_id}" -->
|
|
17
|
-
```typescript
|
|
18
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
19
|
-
|
|
20
|
-
const syllableSDK = new SyllableSDK({
|
|
21
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
22
|
-
});
|
|
23
|
-
|
|
24
|
-
async function run() {
|
|
25
|
-
const result = await syllableSDK.sessions.fullSummary.getById({
|
|
26
|
-
sessionId: "<id>",
|
|
27
|
-
});
|
|
28
|
-
|
|
29
|
-
console.log(result);
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
run();
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
### Standalone function
|
|
36
|
-
|
|
37
|
-
The standalone function version of this method:
|
|
38
|
-
|
|
39
|
-
```typescript
|
|
40
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
41
|
-
import { sessionsFullSummaryGetById } from "syllable-sdk/funcs/sessionsFullSummaryGetById.js";
|
|
42
|
-
|
|
43
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
44
|
-
// You can create one instance of it to use across an application.
|
|
45
|
-
const syllableSDK = new SyllableSDKCore({
|
|
46
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
47
|
-
});
|
|
48
|
-
|
|
49
|
-
async function run() {
|
|
50
|
-
const res = await sessionsFullSummaryGetById(syllableSDK, {
|
|
51
|
-
sessionId: "<id>",
|
|
52
|
-
});
|
|
53
|
-
if (res.ok) {
|
|
54
|
-
const { value: result } = res;
|
|
55
|
-
console.log(result);
|
|
56
|
-
} else {
|
|
57
|
-
console.log("sessionsFullSummaryGetById failed:", res.error);
|
|
58
|
-
}
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
run();
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
### Parameters
|
|
65
|
-
|
|
66
|
-
| Parameter | Type | Required | Description |
|
|
67
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
68
|
-
| `request` | [operations.SessionFullSummaryGetByIdRequest](../../models/operations/sessionfullsummarygetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
69
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
70
|
-
| `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. |
|
|
71
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
72
|
-
|
|
73
|
-
### Response
|
|
74
|
-
|
|
75
|
-
**Promise\<[components.SessionSummaryResponse](../../models/components/sessionsummaryresponse.md)\>**
|
|
76
|
-
|
|
77
|
-
### Errors
|
|
78
|
-
|
|
79
|
-
| Error Type | Status Code | Content Type |
|
|
80
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
81
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
82
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -1,501 +0,0 @@
|
|
|
1
|
-
# Incidents
|
|
2
|
-
(*incidents*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
Operations related to incidents.
|
|
7
|
-
|
|
8
|
-
### Available Operations
|
|
9
|
-
|
|
10
|
-
* [list](#list) - List Incidents
|
|
11
|
-
* [create](#create) - Create Incident
|
|
12
|
-
* [update](#update) - Update Incident
|
|
13
|
-
* [incidentGetOrganizations](#incidentgetorganizations) - Get Organizations
|
|
14
|
-
* [getById](#getbyid) - Get Incident By Id
|
|
15
|
-
* [delete](#delete) - Delete Incident
|
|
16
|
-
|
|
17
|
-
## list
|
|
18
|
-
|
|
19
|
-
List service incidents with pagination and filtering
|
|
20
|
-
|
|
21
|
-
### Example Usage
|
|
22
|
-
|
|
23
|
-
<!-- UsageSnippet language="typescript" operationID="incident_list" method="get" path="/api/v1/incidents/" -->
|
|
24
|
-
```typescript
|
|
25
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
26
|
-
|
|
27
|
-
const syllableSDK = new SyllableSDK({
|
|
28
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
29
|
-
});
|
|
30
|
-
|
|
31
|
-
async function run() {
|
|
32
|
-
const result = await syllableSDK.incidents.list({
|
|
33
|
-
page: 0,
|
|
34
|
-
searchFields: [
|
|
35
|
-
"updated_at",
|
|
36
|
-
],
|
|
37
|
-
searchFieldValues: [
|
|
38
|
-
"Some Object Name",
|
|
39
|
-
],
|
|
40
|
-
startDatetime: "2023-01-01T00:00:00Z",
|
|
41
|
-
endDatetime: "2024-01-01T00:00:00Z",
|
|
42
|
-
});
|
|
43
|
-
|
|
44
|
-
console.log(result);
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
run();
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
### Standalone function
|
|
51
|
-
|
|
52
|
-
The standalone function version of this method:
|
|
53
|
-
|
|
54
|
-
```typescript
|
|
55
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
56
|
-
import { incidentsList } from "syllable-sdk/funcs/incidentsList.js";
|
|
57
|
-
|
|
58
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
59
|
-
// You can create one instance of it to use across an application.
|
|
60
|
-
const syllableSDK = new SyllableSDKCore({
|
|
61
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
62
|
-
});
|
|
63
|
-
|
|
64
|
-
async function run() {
|
|
65
|
-
const res = await incidentsList(syllableSDK, {
|
|
66
|
-
page: 0,
|
|
67
|
-
searchFields: [
|
|
68
|
-
"updated_at",
|
|
69
|
-
],
|
|
70
|
-
searchFieldValues: [
|
|
71
|
-
"Some Object Name",
|
|
72
|
-
],
|
|
73
|
-
startDatetime: "2023-01-01T00:00:00Z",
|
|
74
|
-
endDatetime: "2024-01-01T00:00:00Z",
|
|
75
|
-
});
|
|
76
|
-
if (res.ok) {
|
|
77
|
-
const { value: result } = res;
|
|
78
|
-
console.log(result);
|
|
79
|
-
} else {
|
|
80
|
-
console.log("incidentsList failed:", res.error);
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
run();
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
### Parameters
|
|
88
|
-
|
|
89
|
-
| Parameter | Type | Required | Description |
|
|
90
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
91
|
-
| `request` | [operations.IncidentListRequest](../../models/operations/incidentlistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
92
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
93
|
-
| `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. |
|
|
94
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
95
|
-
|
|
96
|
-
### Response
|
|
97
|
-
|
|
98
|
-
**Promise\<[components.ListResponseIncidentResponse](../../models/components/listresponseincidentresponse.md)\>**
|
|
99
|
-
|
|
100
|
-
### Errors
|
|
101
|
-
|
|
102
|
-
| Error Type | Status Code | Content Type |
|
|
103
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
104
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
105
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
106
|
-
|
|
107
|
-
## create
|
|
108
|
-
|
|
109
|
-
Create a new incident
|
|
110
|
-
|
|
111
|
-
### Example Usage
|
|
112
|
-
|
|
113
|
-
<!-- UsageSnippet language="typescript" operationID="incident_create" method="post" path="/api/v1/incidents/" -->
|
|
114
|
-
```typescript
|
|
115
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
116
|
-
|
|
117
|
-
const syllableSDK = new SyllableSDK({
|
|
118
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
119
|
-
});
|
|
120
|
-
|
|
121
|
-
async function run() {
|
|
122
|
-
const result = await syllableSDK.incidents.create({
|
|
123
|
-
description: "Service outage in region X",
|
|
124
|
-
startDatetime: new Date("2023-10-01T08:00:00Z"),
|
|
125
|
-
resolutionDatetime: new Date("2023-10-01T12:00:00Z"),
|
|
126
|
-
impactCategory: "High",
|
|
127
|
-
sessionsImpacted: 1500,
|
|
128
|
-
markdown: "**Incident Details**",
|
|
129
|
-
organizationId: 123,
|
|
130
|
-
subOrganizationId: 456,
|
|
131
|
-
});
|
|
132
|
-
|
|
133
|
-
console.log(result);
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
run();
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
### Standalone function
|
|
140
|
-
|
|
141
|
-
The standalone function version of this method:
|
|
142
|
-
|
|
143
|
-
```typescript
|
|
144
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
145
|
-
import { incidentsCreate } from "syllable-sdk/funcs/incidentsCreate.js";
|
|
146
|
-
|
|
147
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
148
|
-
// You can create one instance of it to use across an application.
|
|
149
|
-
const syllableSDK = new SyllableSDKCore({
|
|
150
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
151
|
-
});
|
|
152
|
-
|
|
153
|
-
async function run() {
|
|
154
|
-
const res = await incidentsCreate(syllableSDK, {
|
|
155
|
-
description: "Service outage in region X",
|
|
156
|
-
startDatetime: new Date("2023-10-01T08:00:00Z"),
|
|
157
|
-
resolutionDatetime: new Date("2023-10-01T12:00:00Z"),
|
|
158
|
-
impactCategory: "High",
|
|
159
|
-
sessionsImpacted: 1500,
|
|
160
|
-
markdown: "**Incident Details**",
|
|
161
|
-
organizationId: 123,
|
|
162
|
-
subOrganizationId: 456,
|
|
163
|
-
});
|
|
164
|
-
if (res.ok) {
|
|
165
|
-
const { value: result } = res;
|
|
166
|
-
console.log(result);
|
|
167
|
-
} else {
|
|
168
|
-
console.log("incidentsCreate failed:", res.error);
|
|
169
|
-
}
|
|
170
|
-
}
|
|
171
|
-
|
|
172
|
-
run();
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
### Parameters
|
|
176
|
-
|
|
177
|
-
| Parameter | Type | Required | Description |
|
|
178
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
179
|
-
| `request` | [components.IncidentCreateRequest](../../models/components/incidentcreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
180
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
181
|
-
| `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. |
|
|
182
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
183
|
-
|
|
184
|
-
### Response
|
|
185
|
-
|
|
186
|
-
**Promise\<[components.IncidentResponse](../../models/components/incidentresponse.md)\>**
|
|
187
|
-
|
|
188
|
-
### Errors
|
|
189
|
-
|
|
190
|
-
| Error Type | Status Code | Content Type |
|
|
191
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
192
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
193
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
194
|
-
|
|
195
|
-
## update
|
|
196
|
-
|
|
197
|
-
Update an existing incident
|
|
198
|
-
|
|
199
|
-
### Example Usage
|
|
200
|
-
|
|
201
|
-
<!-- UsageSnippet language="typescript" operationID="incident_update" method="put" path="/api/v1/incidents/" -->
|
|
202
|
-
```typescript
|
|
203
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
204
|
-
|
|
205
|
-
const syllableSDK = new SyllableSDK({
|
|
206
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
207
|
-
});
|
|
208
|
-
|
|
209
|
-
async function run() {
|
|
210
|
-
const result = await syllableSDK.incidents.update({
|
|
211
|
-
description: "Service outage in region X",
|
|
212
|
-
startDatetime: new Date("2023-10-01T08:00:00Z"),
|
|
213
|
-
resolutionDatetime: new Date("2023-10-01T12:00:00Z"),
|
|
214
|
-
impactCategory: "High",
|
|
215
|
-
sessionsImpacted: 1500,
|
|
216
|
-
markdown: "**Incident Details**",
|
|
217
|
-
organizationId: 123,
|
|
218
|
-
subOrganizationId: 456,
|
|
219
|
-
id: 1,
|
|
220
|
-
});
|
|
221
|
-
|
|
222
|
-
console.log(result);
|
|
223
|
-
}
|
|
224
|
-
|
|
225
|
-
run();
|
|
226
|
-
```
|
|
227
|
-
|
|
228
|
-
### Standalone function
|
|
229
|
-
|
|
230
|
-
The standalone function version of this method:
|
|
231
|
-
|
|
232
|
-
```typescript
|
|
233
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
234
|
-
import { incidentsUpdate } from "syllable-sdk/funcs/incidentsUpdate.js";
|
|
235
|
-
|
|
236
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
237
|
-
// You can create one instance of it to use across an application.
|
|
238
|
-
const syllableSDK = new SyllableSDKCore({
|
|
239
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
240
|
-
});
|
|
241
|
-
|
|
242
|
-
async function run() {
|
|
243
|
-
const res = await incidentsUpdate(syllableSDK, {
|
|
244
|
-
description: "Service outage in region X",
|
|
245
|
-
startDatetime: new Date("2023-10-01T08:00:00Z"),
|
|
246
|
-
resolutionDatetime: new Date("2023-10-01T12:00:00Z"),
|
|
247
|
-
impactCategory: "High",
|
|
248
|
-
sessionsImpacted: 1500,
|
|
249
|
-
markdown: "**Incident Details**",
|
|
250
|
-
organizationId: 123,
|
|
251
|
-
subOrganizationId: 456,
|
|
252
|
-
id: 1,
|
|
253
|
-
});
|
|
254
|
-
if (res.ok) {
|
|
255
|
-
const { value: result } = res;
|
|
256
|
-
console.log(result);
|
|
257
|
-
} else {
|
|
258
|
-
console.log("incidentsUpdate failed:", res.error);
|
|
259
|
-
}
|
|
260
|
-
}
|
|
261
|
-
|
|
262
|
-
run();
|
|
263
|
-
```
|
|
264
|
-
|
|
265
|
-
### Parameters
|
|
266
|
-
|
|
267
|
-
| Parameter | Type | Required | Description |
|
|
268
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
269
|
-
| `request` | [components.IncidentUpdateRequest](../../models/components/incidentupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
270
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
271
|
-
| `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. |
|
|
272
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
273
|
-
|
|
274
|
-
### Response
|
|
275
|
-
|
|
276
|
-
**Promise\<[components.IncidentResponse](../../models/components/incidentresponse.md)\>**
|
|
277
|
-
|
|
278
|
-
### Errors
|
|
279
|
-
|
|
280
|
-
| Error Type | Status Code | Content Type |
|
|
281
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
282
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
283
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
284
|
-
|
|
285
|
-
## incidentGetOrganizations
|
|
286
|
-
|
|
287
|
-
Get all organizations
|
|
288
|
-
|
|
289
|
-
### Example Usage
|
|
290
|
-
|
|
291
|
-
<!-- UsageSnippet language="typescript" operationID="incident_get_organizations" method="get" path="/api/v1/incidents/organizations" -->
|
|
292
|
-
```typescript
|
|
293
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
294
|
-
|
|
295
|
-
const syllableSDK = new SyllableSDK({
|
|
296
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
297
|
-
});
|
|
298
|
-
|
|
299
|
-
async function run() {
|
|
300
|
-
const result = await syllableSDK.incidents.incidentGetOrganizations();
|
|
301
|
-
|
|
302
|
-
console.log(result);
|
|
303
|
-
}
|
|
304
|
-
|
|
305
|
-
run();
|
|
306
|
-
```
|
|
307
|
-
|
|
308
|
-
### Standalone function
|
|
309
|
-
|
|
310
|
-
The standalone function version of this method:
|
|
311
|
-
|
|
312
|
-
```typescript
|
|
313
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
314
|
-
import { incidentsIncidentGetOrganizations } from "syllable-sdk/funcs/incidentsIncidentGetOrganizations.js";
|
|
315
|
-
|
|
316
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
317
|
-
// You can create one instance of it to use across an application.
|
|
318
|
-
const syllableSDK = new SyllableSDKCore({
|
|
319
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
320
|
-
});
|
|
321
|
-
|
|
322
|
-
async function run() {
|
|
323
|
-
const res = await incidentsIncidentGetOrganizations(syllableSDK);
|
|
324
|
-
if (res.ok) {
|
|
325
|
-
const { value: result } = res;
|
|
326
|
-
console.log(result);
|
|
327
|
-
} else {
|
|
328
|
-
console.log("incidentsIncidentGetOrganizations failed:", res.error);
|
|
329
|
-
}
|
|
330
|
-
}
|
|
331
|
-
|
|
332
|
-
run();
|
|
333
|
-
```
|
|
334
|
-
|
|
335
|
-
### Parameters
|
|
336
|
-
|
|
337
|
-
| Parameter | Type | Required | Description |
|
|
338
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
339
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
340
|
-
| `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. |
|
|
341
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
342
|
-
|
|
343
|
-
### Response
|
|
344
|
-
|
|
345
|
-
**Promise\<[components.IncidentOrganizationResponse[]](../../models/.md)\>**
|
|
346
|
-
|
|
347
|
-
### Errors
|
|
348
|
-
|
|
349
|
-
| Error Type | Status Code | Content Type |
|
|
350
|
-
| --------------- | --------------- | --------------- |
|
|
351
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
352
|
-
|
|
353
|
-
## getById
|
|
354
|
-
|
|
355
|
-
Get incident by ID
|
|
356
|
-
|
|
357
|
-
### Example Usage
|
|
358
|
-
|
|
359
|
-
<!-- UsageSnippet language="typescript" operationID="incident_get_by_id" method="get" path="/api/v1/incidents/{incident_id}" -->
|
|
360
|
-
```typescript
|
|
361
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
362
|
-
|
|
363
|
-
const syllableSDK = new SyllableSDK({
|
|
364
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
365
|
-
});
|
|
366
|
-
|
|
367
|
-
async function run() {
|
|
368
|
-
const result = await syllableSDK.incidents.getById({
|
|
369
|
-
incidentId: 835824,
|
|
370
|
-
});
|
|
371
|
-
|
|
372
|
-
console.log(result);
|
|
373
|
-
}
|
|
374
|
-
|
|
375
|
-
run();
|
|
376
|
-
```
|
|
377
|
-
|
|
378
|
-
### Standalone function
|
|
379
|
-
|
|
380
|
-
The standalone function version of this method:
|
|
381
|
-
|
|
382
|
-
```typescript
|
|
383
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
384
|
-
import { incidentsGetById } from "syllable-sdk/funcs/incidentsGetById.js";
|
|
385
|
-
|
|
386
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
387
|
-
// You can create one instance of it to use across an application.
|
|
388
|
-
const syllableSDK = new SyllableSDKCore({
|
|
389
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
390
|
-
});
|
|
391
|
-
|
|
392
|
-
async function run() {
|
|
393
|
-
const res = await incidentsGetById(syllableSDK, {
|
|
394
|
-
incidentId: 835824,
|
|
395
|
-
});
|
|
396
|
-
if (res.ok) {
|
|
397
|
-
const { value: result } = res;
|
|
398
|
-
console.log(result);
|
|
399
|
-
} else {
|
|
400
|
-
console.log("incidentsGetById failed:", res.error);
|
|
401
|
-
}
|
|
402
|
-
}
|
|
403
|
-
|
|
404
|
-
run();
|
|
405
|
-
```
|
|
406
|
-
|
|
407
|
-
### Parameters
|
|
408
|
-
|
|
409
|
-
| Parameter | Type | Required | Description |
|
|
410
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
411
|
-
| `request` | [operations.IncidentGetByIdRequest](../../models/operations/incidentgetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
412
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
413
|
-
| `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. |
|
|
414
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
415
|
-
|
|
416
|
-
### Response
|
|
417
|
-
|
|
418
|
-
**Promise\<[components.IncidentResponse](../../models/components/incidentresponse.md)\>**
|
|
419
|
-
|
|
420
|
-
### Errors
|
|
421
|
-
|
|
422
|
-
| Error Type | Status Code | Content Type |
|
|
423
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
424
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
425
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
426
|
-
|
|
427
|
-
## delete
|
|
428
|
-
|
|
429
|
-
Delete an incident by ID
|
|
430
|
-
|
|
431
|
-
### Example Usage
|
|
432
|
-
|
|
433
|
-
<!-- UsageSnippet language="typescript" operationID="incident_delete" method="delete" path="/api/v1/incidents/{incident_id}" -->
|
|
434
|
-
```typescript
|
|
435
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
436
|
-
|
|
437
|
-
const syllableSDK = new SyllableSDK({
|
|
438
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
439
|
-
});
|
|
440
|
-
|
|
441
|
-
async function run() {
|
|
442
|
-
const result = await syllableSDK.incidents.delete({
|
|
443
|
-
incidentId: 400877,
|
|
444
|
-
reason: "<value>",
|
|
445
|
-
});
|
|
446
|
-
|
|
447
|
-
console.log(result);
|
|
448
|
-
}
|
|
449
|
-
|
|
450
|
-
run();
|
|
451
|
-
```
|
|
452
|
-
|
|
453
|
-
### Standalone function
|
|
454
|
-
|
|
455
|
-
The standalone function version of this method:
|
|
456
|
-
|
|
457
|
-
```typescript
|
|
458
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
459
|
-
import { incidentsDelete } from "syllable-sdk/funcs/incidentsDelete.js";
|
|
460
|
-
|
|
461
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
462
|
-
// You can create one instance of it to use across an application.
|
|
463
|
-
const syllableSDK = new SyllableSDKCore({
|
|
464
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
465
|
-
});
|
|
466
|
-
|
|
467
|
-
async function run() {
|
|
468
|
-
const res = await incidentsDelete(syllableSDK, {
|
|
469
|
-
incidentId: 400877,
|
|
470
|
-
reason: "<value>",
|
|
471
|
-
});
|
|
472
|
-
if (res.ok) {
|
|
473
|
-
const { value: result } = res;
|
|
474
|
-
console.log(result);
|
|
475
|
-
} else {
|
|
476
|
-
console.log("incidentsDelete failed:", res.error);
|
|
477
|
-
}
|
|
478
|
-
}
|
|
479
|
-
|
|
480
|
-
run();
|
|
481
|
-
```
|
|
482
|
-
|
|
483
|
-
### Parameters
|
|
484
|
-
|
|
485
|
-
| Parameter | Type | Required | Description |
|
|
486
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
487
|
-
| `request` | [operations.IncidentDeleteRequest](../../models/operations/incidentdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
488
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
489
|
-
| `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. |
|
|
490
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
491
|
-
|
|
492
|
-
### Response
|
|
493
|
-
|
|
494
|
-
**Promise\<[any](../../models/.md)\>**
|
|
495
|
-
|
|
496
|
-
### Errors
|
|
497
|
-
|
|
498
|
-
| Error Type | Status Code | Content Type |
|
|
499
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
500
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
501
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|