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.
Files changed (66) hide show
  1. package/bin/mcp-server.js +6 -6
  2. package/bin/mcp-server.js.map +4 -4
  3. package/examples/package-lock.json +1 -1
  4. package/jsr.json +1 -1
  5. package/lib/config.d.ts +3 -3
  6. package/lib/config.js +3 -3
  7. package/mcp-server/mcp-server.js +1 -1
  8. package/mcp-server/server.js +1 -1
  9. package/openapi.json +33 -33
  10. package/package.json +1 -1
  11. package/src/lib/config.ts +3 -3
  12. package/src/mcp-server/mcp-server.ts +1 -1
  13. package/src/mcp-server/server.ts +1 -1
  14. package/.devcontainer/README.md +0 -35
  15. package/api-reference/sdks/agents/README.md +0 -224
  16. package/api-reference/sdks/availabletargets/README.md +0 -49
  17. package/api-reference/sdks/channels/README.md +0 -92
  18. package/api-reference/sdks/chats/README.md +0 -55
  19. package/api-reference/sdks/conversations/README.md +0 -91
  20. package/api-reference/sdks/dashboards/README.md +0 -321
  21. package/api-reference/sdks/events/README.md +0 -50
  22. package/api-reference/sdks/greetings/README.md +0 -223
  23. package/api-reference/sdks/organizations/README.md +0 -48
  24. package/api-reference/sdks/prompts/README.md +0 -225
  25. package/api-reference/sdks/sessions/README.md +0 -50
  26. package/api-reference/sdks/syllable/README.md +0 -22
  27. package/api-reference/sdks/targets/README.md +0 -194
  28. package/api-reference/sdks/tools/README.md +0 -92
  29. package/docs/sdks/agents/README.md +0 -589
  30. package/docs/sdks/batches/README.md +0 -742
  31. package/docs/sdks/campaigns/README.md +0 -526
  32. package/docs/sdks/channels/README.md +0 -401
  33. package/docs/sdks/conversations/README.md +0 -100
  34. package/docs/sdks/custommessages/README.md +0 -496
  35. package/docs/sdks/dashboards/README.md +0 -481
  36. package/docs/sdks/datasources/README.md +0 -458
  37. package/docs/sdks/directory/README.md +0 -727
  38. package/docs/sdks/events/README.md +0 -100
  39. package/docs/sdks/folders/README.md +0 -675
  40. package/docs/sdks/fullsummary/README.md +0 -82
  41. package/docs/sdks/incidents/README.md +0 -501
  42. package/docs/sdks/insights/README.md +0 -100
  43. package/docs/sdks/languagegroups/README.md +0 -565
  44. package/docs/sdks/latency/README.md +0 -82
  45. package/docs/sdks/numbers/README.md +0 -250
  46. package/docs/sdks/organizations/README.md +0 -317
  47. package/docs/sdks/permissions/README.md +0 -78
  48. package/docs/sdks/prompts/README.md +0 -592
  49. package/docs/sdks/pronunciations/README.md +0 -360
  50. package/docs/sdks/roles/README.md +0 -430
  51. package/docs/sdks/services/README.md +0 -430
  52. package/docs/sdks/sessiondebug/README.md +0 -236
  53. package/docs/sdks/sessionlabels/README.md +0 -262
  54. package/docs/sdks/sessions/README.md +0 -325
  55. package/docs/sdks/syllablesdktools/README.md +0 -578
  56. package/docs/sdks/takeouts/README.md +0 -228
  57. package/docs/sdks/targets/README.md +0 -454
  58. package/docs/sdks/test/README.md +0 -92
  59. package/docs/sdks/tools/README.md +0 -518
  60. package/docs/sdks/transcript/README.md +0 -82
  61. package/docs/sdks/twilio/README.md +0 -246
  62. package/docs/sdks/users/README.md +0 -561
  63. package/docs/sdks/v1/README.md +0 -561
  64. package/docs/sdks/voicegroups/README.md +0 -551
  65. package/docs/sdks/workflows/README.md +0 -781
  66. package/examples/README.md +0 -31
@@ -18,7 +18,7 @@
18
18
  },
19
19
  "..": {
20
20
  "name": "syllable-sdk",
21
- "version": "1.0.8-rc.1",
21
+ "version": "1.0.8-rc.2",
22
22
  "dependencies": {
23
23
  "zod": "^3.25.0 || ^4.0.0"
24
24
  },
package/jsr.json CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  {
4
4
  "name": "syllable-sdk",
5
- "version": "1.0.8-rc.1",
5
+ "version": "1.0.8-rc.2",
6
6
  "exports": {
7
7
  ".": "./src/index.ts",
8
8
  "./models/errors": "./src/models/errors/index.ts",
package/lib/config.d.ts CHANGED
@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
31
31
  export declare const SDK_METADATA: {
32
32
  readonly language: "typescript";
33
33
  readonly openapiDocVersion: "0.0.2";
34
- readonly sdkVersion: "1.0.8-rc.1";
35
- readonly genVersion: "2.731.6";
36
- readonly userAgent: "speakeasy-sdk/typescript 1.0.8-rc.1 2.731.6 0.0.2 syllable-sdk";
34
+ readonly sdkVersion: "1.0.8-rc.2";
35
+ readonly genVersion: "2.737.0";
36
+ readonly userAgent: "speakeasy-sdk/typescript 1.0.8-rc.2 2.737.0 0.0.2 syllable-sdk";
37
37
  };
38
38
  //# sourceMappingURL=config.d.ts.map
package/lib/config.js CHANGED
@@ -31,8 +31,8 @@ function serverURLFromOptions(options) {
31
31
  exports.SDK_METADATA = {
32
32
  language: "typescript",
33
33
  openapiDocVersion: "0.0.2",
34
- sdkVersion: "1.0.8-rc.1",
35
- genVersion: "2.731.6",
36
- userAgent: "speakeasy-sdk/typescript 1.0.8-rc.1 2.731.6 0.0.2 syllable-sdk",
34
+ sdkVersion: "1.0.8-rc.2",
35
+ genVersion: "2.737.0",
36
+ userAgent: "speakeasy-sdk/typescript 1.0.8-rc.2 2.737.0 0.0.2 syllable-sdk",
37
37
  };
38
38
  //# sourceMappingURL=config.js.map
@@ -22,7 +22,7 @@ const routes = (0, core_1.buildRouteMap)({
22
22
  exports.app = (0, core_1.buildApplication)(routes, {
23
23
  name: "mcp",
24
24
  versionInfo: {
25
- currentVersion: "1.0.8-rc.1",
25
+ currentVersion: "1.0.8-rc.2",
26
26
  },
27
27
  });
28
28
  (0, core_1.run)(exports.app, node_process_1.default.argv.slice(2), (0, cli_js_1.buildContext)(node_process_1.default));
@@ -171,7 +171,7 @@ const voiceGroupsVoiceGroupsCreateVoiceSample_js_1 = require("./tools/voiceGroup
171
171
  function createMCPServer(deps) {
172
172
  const server = new mcp_js_1.McpServer({
173
173
  name: "SyllableSDK",
174
- version: "1.0.8-rc.1",
174
+ version: "1.0.8-rc.2",
175
175
  });
176
176
  const client = new core_js_1.SyllableSDKCore({
177
177
  apiKeyHeader: deps.apiKeyHeader,
package/openapi.json CHANGED
@@ -13785,7 +13785,7 @@
13785
13785
  "title": "Batch Id",
13786
13786
  "description": "Unique ID for conversation batch",
13787
13787
  "examples": [
13788
- "20251030.9"
13788
+ "20251103.9"
13789
13789
  ]
13790
13790
  },
13791
13791
  "campaign_id": {
@@ -13809,7 +13809,7 @@
13809
13809
  "title": "Expires On",
13810
13810
  "description": "Timestamp of batch expiration",
13811
13811
  "examples": [
13812
- "2025-10-31T00:00:00Z"
13812
+ "2025-11-04T00:00:00Z"
13813
13813
  ]
13814
13814
  },
13815
13815
  "paused": {
@@ -13862,7 +13862,7 @@
13862
13862
  "title": "Created At",
13863
13863
  "description": "Timestamp of batch creation",
13864
13864
  "examples": [
13865
- "2025-10-30T00:00:00Z"
13865
+ "2025-11-03T00:00:00Z"
13866
13866
  ]
13867
13867
  },
13868
13868
  "deleted_at": {
@@ -13878,7 +13878,7 @@
13878
13878
  "title": "Deleted At",
13879
13879
  "description": "Timestamp of batch deletion",
13880
13880
  "examples": [
13881
- "2025-10-30T00:00:00Z"
13881
+ "2025-11-03T00:00:00Z"
13882
13882
  ]
13883
13883
  },
13884
13884
  "deleted_reason": {
@@ -13909,7 +13909,7 @@
13909
13909
  "title": "Last Updated At",
13910
13910
  "description": "Timestamp of last change to batch",
13911
13911
  "examples": [
13912
- "2025-10-30T00:00:00Z"
13912
+ "2025-11-03T00:00:00Z"
13913
13913
  ]
13914
13914
  },
13915
13915
  "last_updated_by": {
@@ -14665,7 +14665,7 @@
14665
14665
  "title": "Batch Id",
14666
14666
  "description": "Unique ID for conversation batch",
14667
14667
  "examples": [
14668
- "20251030.9"
14668
+ "20251103.9"
14669
14669
  ]
14670
14670
  },
14671
14671
  "campaign_id": {
@@ -14689,7 +14689,7 @@
14689
14689
  "title": "Expires On",
14690
14690
  "description": "Timestamp of batch expiration",
14691
14691
  "examples": [
14692
- "2025-10-31T00:00:00Z"
14692
+ "2025-11-04T00:00:00Z"
14693
14693
  ]
14694
14694
  },
14695
14695
  "paused": {
@@ -14742,7 +14742,7 @@
14742
14742
  "title": "Created At",
14743
14743
  "description": "Timestamp of batch creation",
14744
14744
  "examples": [
14745
- "2025-10-30T00:00:00Z"
14745
+ "2025-11-03T00:00:00Z"
14746
14746
  ]
14747
14747
  },
14748
14748
  "deleted_at": {
@@ -14758,7 +14758,7 @@
14758
14758
  "title": "Deleted At",
14759
14759
  "description": "Timestamp of batch deletion",
14760
14760
  "examples": [
14761
- "2025-10-30T00:00:00Z"
14761
+ "2025-11-03T00:00:00Z"
14762
14762
  ]
14763
14763
  },
14764
14764
  "deleted_reason": {
@@ -14789,7 +14789,7 @@
14789
14789
  "title": "Last Updated At",
14790
14790
  "description": "Timestamp of last change to batch",
14791
14791
  "examples": [
14792
- "2025-10-30T00:00:00Z"
14792
+ "2025-11-03T00:00:00Z"
14793
14793
  ]
14794
14794
  },
14795
14795
  "last_updated_by": {
@@ -14832,7 +14832,7 @@
14832
14832
  "title": "Batch Id",
14833
14833
  "description": "Unique ID for conversation batch",
14834
14834
  "examples": [
14835
- "20251030.9"
14835
+ "20251103.9"
14836
14836
  ]
14837
14837
  },
14838
14838
  "campaign_id": {
@@ -14856,7 +14856,7 @@
14856
14856
  "title": "Expires On",
14857
14857
  "description": "Timestamp of batch expiration",
14858
14858
  "examples": [
14859
- "2025-10-31T00:00:00Z"
14859
+ "2025-11-04T00:00:00Z"
14860
14860
  ]
14861
14861
  },
14862
14862
  "paused": {
@@ -15005,7 +15005,7 @@
15005
15005
  "title": "Created At",
15006
15006
  "description": "Timestamp of request creation",
15007
15007
  "examples": [
15008
- "2025-10-29T00:00:00Z"
15008
+ "2025-11-02T00:00:00Z"
15009
15009
  ]
15010
15010
  },
15011
15011
  "sent_at": {
@@ -15021,7 +15021,7 @@
15021
15021
  "title": "Sent At",
15022
15022
  "description": "Timestamp at which request was sent",
15023
15023
  "examples": [
15024
- "2025-10-30T00:00:00Z"
15024
+ "2025-11-03T00:00:00Z"
15025
15025
  ]
15026
15026
  },
15027
15027
  "attempt_count": {
@@ -17123,7 +17123,7 @@
17123
17123
  "title": "Created At",
17124
17124
  "description": "Timestamp at which insight upload folder was created",
17125
17125
  "examples": [
17126
- "2025-10-29T00:00:00Z"
17126
+ "2025-11-02T00:00:00Z"
17127
17127
  ]
17128
17128
  },
17129
17129
  "updated_at": {
@@ -17132,7 +17132,7 @@
17132
17132
  "title": "Updated At",
17133
17133
  "description": "Timestamp at which insight upload folder was last updated",
17134
17134
  "examples": [
17135
- "2025-10-30T00:00:00Z"
17135
+ "2025-11-03T00:00:00Z"
17136
17136
  ]
17137
17137
  },
17138
17138
  "last_updated_by": {
@@ -17818,7 +17818,7 @@
17818
17818
  "title": "Created At",
17819
17819
  "description": "Timestamp of at which insight tool configuration was created",
17820
17820
  "examples": [
17821
- "2025-10-29T00:00:00Z"
17821
+ "2025-11-02T00:00:00Z"
17822
17822
  ]
17823
17823
  },
17824
17824
  "updated_at": {
@@ -17827,7 +17827,7 @@
17827
17827
  "title": "Updated At",
17828
17828
  "description": "Timestamp at which insight tool configuration was last updated",
17829
17829
  "examples": [
17830
- "2025-10-30T00:00:00Z"
17830
+ "2025-11-03T00:00:00Z"
17831
17831
  ]
17832
17832
  },
17833
17833
  "last_updated_by": {
@@ -18208,7 +18208,7 @@
18208
18208
  "title": "Start Datetime",
18209
18209
  "description": "Target session timestamp the workflow (backfill) should start. An empty value indicates start on activation - live sessions only",
18210
18210
  "examples": [
18211
- "2025-10-29T00:00:00Z"
18211
+ "2025-11-02T00:00:00Z"
18212
18212
  ]
18213
18213
  },
18214
18214
  "end_datetime": {
@@ -18224,7 +18224,7 @@
18224
18224
  "title": "End Datetime",
18225
18225
  "description": "Target session timestamp the workflow (backfill) should end. An empty value indicates no end, i.e., include live sessions until deactivation",
18226
18226
  "examples": [
18227
- "2025-10-30T00:00:00Z"
18227
+ "2025-11-03T00:00:00Z"
18228
18228
  ]
18229
18229
  }
18230
18230
  },
@@ -18299,7 +18299,7 @@
18299
18299
  "title": "Start Datetime",
18300
18300
  "description": "Target session timestamp the workflow (backfill) should start. An empty value indicates start on activation - live sessions only",
18301
18301
  "examples": [
18302
- "2025-10-29T00:00:00Z"
18302
+ "2025-11-02T00:00:00Z"
18303
18303
  ]
18304
18304
  },
18305
18305
  "end_datetime": {
@@ -18315,7 +18315,7 @@
18315
18315
  "title": "End Datetime",
18316
18316
  "description": "Target session timestamp the workflow (backfill) should end. An empty value indicates no end, i.e., include live sessions until deactivation",
18317
18317
  "examples": [
18318
- "2025-10-30T00:00:00Z"
18318
+ "2025-11-03T00:00:00Z"
18319
18319
  ]
18320
18320
  },
18321
18321
  "id": {
@@ -18368,7 +18368,7 @@
18368
18368
  "title": "Created At",
18369
18369
  "description": "Timestamp at which the insight workflow was created",
18370
18370
  "examples": [
18371
- "2025-10-29T00:00:00Z"
18371
+ "2025-11-02T00:00:00Z"
18372
18372
  ]
18373
18373
  },
18374
18374
  "updated_at": {
@@ -18377,7 +18377,7 @@
18377
18377
  "title": "Updated At",
18378
18378
  "description": "Timestamp of most recent update to the insight workflow",
18379
18379
  "examples": [
18380
- "2025-10-30T00:00:00Z"
18380
+ "2025-11-03T00:00:00Z"
18381
18381
  ]
18382
18382
  },
18383
18383
  "last_updated_by": {
@@ -18473,7 +18473,7 @@
18473
18473
  "title": "Created At",
18474
18474
  "description": "Timestamp at which insight upload folder was created",
18475
18475
  "examples": [
18476
- "2025-10-29T00:00:00Z"
18476
+ "2025-11-02T00:00:00Z"
18477
18477
  ]
18478
18478
  },
18479
18479
  "updated_at": {
@@ -18482,7 +18482,7 @@
18482
18482
  "title": "Updated At",
18483
18483
  "description": "Timestamp at which insight upload folder was last updated",
18484
18484
  "examples": [
18485
- "2025-10-30T00:00:00Z"
18485
+ "2025-11-03T00:00:00Z"
18486
18486
  ]
18487
18487
  },
18488
18488
  "last_updated_by": {
@@ -18717,7 +18717,7 @@
18717
18717
  "title": "Created At",
18718
18718
  "description": "Timestamp at which insight tool result was created",
18719
18719
  "examples": [
18720
- "2025-10-29T00:00:00Z"
18720
+ "2025-11-02T00:00:00Z"
18721
18721
  ]
18722
18722
  },
18723
18723
  "updated_at": {
@@ -18726,7 +18726,7 @@
18726
18726
  "title": "Updated At",
18727
18727
  "description": "Timestamp at which insight tool result was last updated",
18728
18728
  "examples": [
18729
- "2025-10-30T00:00:00Z"
18729
+ "2025-11-03T00:00:00Z"
18730
18730
  ]
18731
18731
  },
18732
18732
  "upload_file_metadata": {
@@ -18871,7 +18871,7 @@
18871
18871
  "title": "Start Time",
18872
18872
  "description": "Start time of the uploaded file",
18873
18873
  "examples": [
18874
- "2025-10-29T00:00:00Z"
18874
+ "2025-11-02T00:00:00Z"
18875
18875
  ]
18876
18876
  },
18877
18877
  "end_time": {
@@ -18887,7 +18887,7 @@
18887
18887
  "title": "End Time",
18888
18888
  "description": "End time of the uploaded file",
18889
18889
  "examples": [
18890
- "2025-10-30T00:00:00Z"
18890
+ "2025-11-03T00:00:00Z"
18891
18891
  ]
18892
18892
  },
18893
18893
  "error_message": {
@@ -18942,7 +18942,7 @@
18942
18942
  "title": "Created At",
18943
18943
  "description": "Timestamp at which insight upload file was created",
18944
18944
  "examples": [
18945
- "2025-10-29T00:00:00Z"
18945
+ "2025-11-02T00:00:00Z"
18946
18946
  ]
18947
18947
  }
18948
18948
  },
@@ -22115,7 +22115,7 @@
22115
22115
  "title": "Created At",
22116
22116
  "description": "Timestamp of campaign creation",
22117
22117
  "examples": [
22118
- "2025-10-30T00:00:00Z"
22118
+ "2025-11-03T00:00:00Z"
22119
22119
  ]
22120
22120
  },
22121
22121
  "updated_at": {
@@ -22124,7 +22124,7 @@
22124
22124
  "title": "Updated At",
22125
22125
  "description": "Timestamp of campaign update",
22126
22126
  "examples": [
22127
- "2025-10-30T00:00:00Z"
22127
+ "2025-11-03T00:00:00Z"
22128
22128
  ]
22129
22129
  },
22130
22130
  "last_updated_by": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "syllable-sdk",
3
- "version": "1.0.8-rc.1",
3
+ "version": "1.0.8-rc.2",
4
4
  "author": "Syllable",
5
5
  "bin": {
6
6
  "mcp": "bin/mcp-server.js"
package/src/lib/config.ts CHANGED
@@ -61,7 +61,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
61
61
  export const SDK_METADATA = {
62
62
  language: "typescript",
63
63
  openapiDocVersion: "0.0.2",
64
- sdkVersion: "1.0.8-rc.1",
65
- genVersion: "2.731.6",
66
- userAgent: "speakeasy-sdk/typescript 1.0.8-rc.1 2.731.6 0.0.2 syllable-sdk",
64
+ sdkVersion: "1.0.8-rc.2",
65
+ genVersion: "2.737.0",
66
+ userAgent: "speakeasy-sdk/typescript 1.0.8-rc.2 2.737.0 0.0.2 syllable-sdk",
67
67
  } as const;
@@ -19,7 +19,7 @@ const routes = buildRouteMap({
19
19
  export const app = buildApplication(routes, {
20
20
  name: "mcp",
21
21
  versionInfo: {
22
- currentVersion: "1.0.8-rc.1",
22
+ currentVersion: "1.0.8-rc.2",
23
23
  },
24
24
  });
25
25
 
@@ -183,7 +183,7 @@ export function createMCPServer(deps: {
183
183
  }) {
184
184
  const server = new McpServer({
185
185
  name: "SyllableSDK",
186
- version: "1.0.8-rc.1",
186
+ version: "1.0.8-rc.2",
187
187
  });
188
188
 
189
189
  const client = new SyllableSDKCore({
@@ -1,35 +0,0 @@
1
-
2
- <div align="center">
3
- <a href="https://codespaces.new/asksyllable/syllable-sdk-typescript.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
4
- </div>
5
- <br>
6
-
7
- > **Remember to shutdown a GitHub Codespace when it is not in use!**
8
-
9
- # Dev Containers Quick Start
10
-
11
- The default location for usage snippets is the `samples` directory.
12
-
13
- ## Running a Usage Sample
14
-
15
- A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
16
-
17
- ```
18
- ts-node root.ts
19
- ```
20
-
21
- ## Generating Additional Usage Samples
22
-
23
- The speakeasy CLI allows you to generate more usage snippets. Here's how:
24
-
25
- - To generate a sample for a specific operation by providing an operation ID, use:
26
-
27
- ```
28
- speakeasy generate usage -s openapi.yaml -l typescript -i {INPUT_OPERATION_ID} -o ./samples
29
- ```
30
-
31
- - To generate samples for an entire namespace (like a tag or group name), use:
32
-
33
- ```
34
- speakeasy generate usage -s openapi.yaml -l typescript -n {INPUT_TAG_NAME} -o ./samples
35
- ```
@@ -1,224 +0,0 @@
1
- # Agents
2
- (*agents*)
3
-
4
- ## Overview
5
-
6
- Operations related to agents
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Agent List
11
- * [create](#create) - Create Agent
12
- * [update](#update) - Update Agent
13
- * [get_by_id](#get_by_id) - Get Agent By Id
14
- * [delete](#delete) - Delete Agent
15
-
16
- ## list
17
-
18
- List the existing agents
19
-
20
- ### Example Usage
21
-
22
- ```python
23
- import os
24
- from syllable_sdk import Syllable
25
-
26
- s = Syllable(
27
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
28
- )
29
-
30
- res = s.agents.list()
31
-
32
- if res is not None:
33
- # handle response
34
- pass
35
-
36
- ```
37
-
38
- ### Parameters
39
-
40
- | Parameter | Type | Required | Description |
41
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
42
- | `request` | [models.AgentListRequest](../../models/agentlistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
43
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
44
-
45
- ### Response
46
-
47
- **[models.AgentListResponse](../../models/agentlistresponse.md)**
48
-
49
- ### Errors
50
-
51
- | Error Type | Status Code | Content Type |
52
- | -------------------------- | -------------------------- | -------------------------- |
53
- | models.HTTPValidationError | 422 | application/json |
54
- | models.SDKError | 4XX, 5XX | \*/\* |
55
-
56
- ## create
57
-
58
- Create a new agent
59
-
60
- ### Example Usage
61
-
62
- ```python
63
- import os
64
- from syllable_sdk import Syllable
65
-
66
- s = Syllable(
67
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
68
- )
69
-
70
- res = s.agents.create(request={
71
- "name": "<value>",
72
- "timezone": "Antarctica/Rothera",
73
- "type_extra": {},
74
- })
75
-
76
- if res is not None:
77
- # handle response
78
- pass
79
-
80
- ```
81
-
82
- ### Parameters
83
-
84
- | Parameter | Type | Required | Description |
85
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
86
- | `request` | [models.AgentCreate](../../models/agentcreate.md) | :heavy_check_mark: | The request object to use for the request. |
87
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
88
-
89
- ### Response
90
-
91
- **[models.Agent](../../models/agent.md)**
92
-
93
- ### Errors
94
-
95
- | Error Type | Status Code | Content Type |
96
- | -------------------------- | -------------------------- | -------------------------- |
97
- | models.HTTPValidationError | 422 | application/json |
98
- | models.SDKError | 4XX, 5XX | \*/\* |
99
-
100
- ## update
101
-
102
- Update an existing agent
103
-
104
- ### Example Usage
105
-
106
- ```python
107
- import os
108
- from syllable_sdk import Syllable
109
-
110
- s = Syllable(
111
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
112
- )
113
-
114
- res = s.agents.update(request={
115
- "name": "<value>",
116
- "timezone": "Europe/Tallinn",
117
- "type_extra": {},
118
- "id": 597129,
119
- })
120
-
121
- if res is not None:
122
- # handle response
123
- pass
124
-
125
- ```
126
-
127
- ### Parameters
128
-
129
- | Parameter | Type | Required | Description |
130
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
131
- | `request` | [models.Agent](../../models/agent.md) | :heavy_check_mark: | The request object to use for the request. |
132
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
133
-
134
- ### Response
135
-
136
- **[models.Agent](../../models/agent.md)**
137
-
138
- ### Errors
139
-
140
- | Error Type | Status Code | Content Type |
141
- | -------------------------- | -------------------------- | -------------------------- |
142
- | models.HTTPValidationError | 422 | application/json |
143
- | models.SDKError | 4XX, 5XX | \*/\* |
144
-
145
- ## get_by_id
146
-
147
- Get an agent by ID.
148
-
149
- ### Example Usage
150
-
151
- ```python
152
- import os
153
- from syllable_sdk import Syllable
154
-
155
- s = Syllable(
156
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
157
- )
158
-
159
- res = s.agents.get_by_id(agent_id=931598)
160
-
161
- if res is not None:
162
- # handle response
163
- pass
164
-
165
- ```
166
-
167
- ### Parameters
168
-
169
- | Parameter | Type | Required | Description |
170
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
171
- | `agent_id` | *int* | :heavy_check_mark: | N/A |
172
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
173
-
174
- ### Response
175
-
176
- **[models.Agent](../../models/agent.md)**
177
-
178
- ### Errors
179
-
180
- | Error Type | Status Code | Content Type |
181
- | -------------------------- | -------------------------- | -------------------------- |
182
- | models.HTTPValidationError | 422 | application/json |
183
- | models.SDKError | 4XX, 5XX | \*/\* |
184
-
185
- ## delete
186
-
187
- Delete an agent by ID
188
-
189
- ### Example Usage
190
-
191
- ```python
192
- import os
193
- from syllable_sdk import Syllable
194
-
195
- s = Syllable(
196
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
197
- )
198
-
199
- res = s.agents.delete(agent_id=5705, reason="<value>")
200
-
201
- if res is not None:
202
- # handle response
203
- pass
204
-
205
- ```
206
-
207
- ### Parameters
208
-
209
- | Parameter | Type | Required | Description |
210
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
211
- | `agent_id` | *int* | :heavy_check_mark: | N/A |
212
- | `reason` | *str* | :heavy_check_mark: | N/A |
213
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
214
-
215
- ### Response
216
-
217
- **[Any](../../models/.md)**
218
-
219
- ### Errors
220
-
221
- | Error Type | Status Code | Content Type |
222
- | -------------------------- | -------------------------- | -------------------------- |
223
- | models.HTTPValidationError | 422 | application/json |
224
- | models.SDKError | 4XX, 5XX | \*/\* |