retell-sdk 1.15.8 → 1.15.9

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 (100) hide show
  1. package/dist/sdk/models/operations/createphonecall 2.js +2 -2
  2. package/dist/sdk/models/operations/createphonecall.js +2 -2
  3. package/dist/sdk/models/operations/listcalls 2.js +2 -2
  4. package/dist/sdk/models/operations/listcalls.js +2 -2
  5. package/dist/sdk/models/shared/calldetail 2.js +2 -2
  6. package/dist/sdk/models/shared/calldetail.js +2 -2
  7. package/docs/sdk/models/errors/createagentresponse422responsebody.md +11 -0
  8. package/docs/sdk/models/errors/createagentresponse500responsebody.md +11 -0
  9. package/docs/sdk/models/errors/createagentresponsebody.md +11 -0
  10. package/docs/sdk/models/errors/createagentresponseresponsebody.md +11 -0
  11. package/docs/sdk/models/errors/createphonecallresponse402responsebody.md +11 -0
  12. package/docs/sdk/models/errors/createphonecallresponse422responsebody.md +11 -0
  13. package/docs/sdk/models/errors/createphonecallresponse429responsebody.md +11 -0
  14. package/docs/sdk/models/errors/createphonecallresponse500responsebody.md +11 -0
  15. package/docs/sdk/models/errors/createphonecallresponsebody.md +11 -0
  16. package/docs/sdk/models/errors/createphonecallresponseresponsebody.md +11 -0
  17. package/docs/sdk/models/errors/createphonenumberresponse402responsebody.md +11 -0
  18. package/docs/sdk/models/errors/createphonenumberresponse422responsebody.md +11 -0
  19. package/docs/sdk/models/errors/createphonenumberresponse500responsebody.md +11 -0
  20. package/docs/sdk/models/errors/createphonenumberresponsebody.md +11 -0
  21. package/docs/sdk/models/errors/createphonenumberresponseresponsebody.md +11 -0
  22. package/docs/sdk/models/errors/deleteagentresponse422responsebody.md +11 -0
  23. package/docs/sdk/models/errors/deleteagentresponse500responsebody.md +11 -0
  24. package/docs/sdk/models/errors/deleteagentresponsebody.md +11 -0
  25. package/docs/sdk/models/errors/deleteagentresponseresponsebody.md +11 -0
  26. package/docs/sdk/models/errors/deletephonenumberresponse422responsebody.md +11 -0
  27. package/docs/sdk/models/errors/deletephonenumberresponse500responsebody.md +11 -0
  28. package/docs/sdk/models/errors/deletephonenumberresponsebody.md +11 -0
  29. package/docs/sdk/models/errors/deletephonenumberresponseresponsebody.md +11 -0
  30. package/docs/sdk/models/errors/getagentresponse422responsebody.md +11 -0
  31. package/docs/sdk/models/errors/getagentresponse500responsebody.md +11 -0
  32. package/docs/sdk/models/errors/getagentresponsebody.md +11 -0
  33. package/docs/sdk/models/errors/getagentresponseresponsebody.md +11 -0
  34. package/docs/sdk/models/errors/getcallresponse422responsebody.md +11 -0
  35. package/docs/sdk/models/errors/getcallresponse500responsebody.md +11 -0
  36. package/docs/sdk/models/errors/getcallresponsebody.md +11 -0
  37. package/docs/sdk/models/errors/getcallresponseresponsebody.md +11 -0
  38. package/docs/sdk/models/errors/getphonenumberresponse422responsebody.md +11 -0
  39. package/docs/sdk/models/errors/getphonenumberresponse500responsebody.md +11 -0
  40. package/docs/sdk/models/errors/getphonenumberresponsebody.md +11 -0
  41. package/docs/sdk/models/errors/getphonenumberresponseresponsebody.md +11 -0
  42. package/docs/sdk/models/errors/listagentsresponsebody.md +11 -0
  43. package/docs/sdk/models/errors/listagentsresponseresponsebody.md +11 -0
  44. package/docs/sdk/models/errors/listcallsresponse500responsebody.md +11 -0
  45. package/docs/sdk/models/errors/listcallsresponsebody.md +11 -0
  46. package/docs/sdk/models/errors/listcallsresponseresponsebody.md +11 -0
  47. package/docs/sdk/models/errors/listphonenumbersresponse500responsebody.md +11 -0
  48. package/docs/sdk/models/errors/listphonenumbersresponsebody.md +11 -0
  49. package/docs/sdk/models/errors/listphonenumbersresponseresponsebody.md +11 -0
  50. package/docs/sdk/models/errors/updateagentresponse422responsebody.md +11 -0
  51. package/docs/sdk/models/errors/updateagentresponse500responsebody.md +11 -0
  52. package/docs/sdk/models/errors/updateagentresponsebody.md +11 -0
  53. package/docs/sdk/models/errors/updateagentresponseresponsebody.md +11 -0
  54. package/docs/sdk/models/errors/updatephoneagentresponse422responsebody.md +11 -0
  55. package/docs/sdk/models/errors/updatephoneagentresponse500responsebody.md +11 -0
  56. package/docs/sdk/models/errors/updatephoneagentresponsebody.md +11 -0
  57. package/docs/sdk/models/errors/updatephoneagentresponseresponsebody.md +11 -0
  58. package/docs/sdk/models/operations/callstatus.md +12 -0
  59. package/docs/sdk/models/operations/calltype.md +10 -0
  60. package/docs/sdk/models/operations/createagentrequestbody.md +15 -0
  61. package/docs/sdk/models/operations/createagentresponse.md +11 -0
  62. package/docs/sdk/models/operations/createphonecallcalltype.md +12 -0
  63. package/docs/sdk/models/operations/createphonecallrequestbody.md +9 -0
  64. package/docs/sdk/models/operations/createphonecallresponse.md +11 -0
  65. package/docs/sdk/models/operations/createphonecallresponsebody.md +16 -0
  66. package/docs/sdk/models/operations/createphonenumberrequestbody.md +9 -0
  67. package/docs/sdk/models/operations/createphonenumberresponse.md +11 -0
  68. package/docs/sdk/models/operations/deleteagentrequest.md +8 -0
  69. package/docs/sdk/models/operations/deleteagentresponse.md +10 -0
  70. package/docs/sdk/models/operations/deletephonenumberrequest.md +8 -0
  71. package/docs/sdk/models/operations/deletephonenumberresponse.md +10 -0
  72. package/docs/sdk/models/operations/filtercriteria.md +13 -0
  73. package/docs/sdk/models/operations/getagentrequest.md +8 -0
  74. package/docs/sdk/models/operations/getagentresponse.md +11 -0
  75. package/docs/sdk/models/operations/getcallrequest.md +8 -0
  76. package/docs/sdk/models/operations/getcallresponse.md +11 -0
  77. package/docs/sdk/models/operations/getphonenumberrequest.md +8 -0
  78. package/docs/sdk/models/operations/getphonenumberresponse.md +11 -0
  79. package/docs/sdk/models/operations/listagentsresponse.md +11 -0
  80. package/docs/sdk/models/operations/listcallsrequest.md +10 -0
  81. package/docs/sdk/models/operations/listcallsresponse.md +11 -0
  82. package/docs/sdk/models/operations/listphonenumbersresponse.md +11 -0
  83. package/docs/sdk/models/operations/phonenumber.md +11 -0
  84. package/docs/sdk/models/operations/sortorder.md +11 -0
  85. package/docs/sdk/models/operations/updateagentrequest.md +9 -0
  86. package/docs/sdk/models/operations/updateagentresponse.md +11 -0
  87. package/docs/sdk/models/operations/updatephoneagentrequest.md +9 -0
  88. package/docs/sdk/models/operations/updatephoneagentrequestbody.md +8 -0
  89. package/docs/sdk/models/operations/updatephoneagentresponse.md +11 -0
  90. package/docs/sdk/models/shared/agent.md +17 -0
  91. package/docs/sdk/models/shared/agentnodefaultnorequired.md +15 -0
  92. package/docs/sdk/models/shared/agentpromptparams.md +9 -0
  93. package/docs/sdk/models/shared/calldetail.md +17 -0
  94. package/docs/sdk/models/shared/callphonenumber.md +11 -0
  95. package/docs/sdk/models/shared/callstatus.md +12 -0
  96. package/docs/sdk/models/shared/calltype.md +12 -0
  97. package/docs/sdk/models/shared/phonenumber.md +12 -0
  98. package/docs/sdk/models/shared/security.md +8 -0
  99. package/docs/sdks/retellclient/README.md +673 -0
  100. package/package.json +26 -30
package/docs/sdk/models/errors/listagentsresponsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # ListAgentsResponseBody
2
+
3
+ Unauthorized
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | API key is missing or invalid. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/listagentsresponseresponsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # ListAgentsResponseResponseBody
2
+
3
+ Internal Server Error
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | An unexpected server error occurred. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/listcallsresponse500responsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # ListCallsResponse500ResponseBody
2
+
3
+ Internal Server Error
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | An unexpected server error occurred. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/listcallsresponsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # ListCallsResponseBody
2
+
3
+ Bad Request
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | Invalid request format, please check API reference. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/listcallsresponseresponsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # ListCallsResponseResponseBody
2
+
3
+ Unauthorized
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | API key is missing or invalid. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/listphonenumbersresponse500responsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # ListPhoneNumbersResponse500ResponseBody
2
+
3
+ Internal Server Error
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | An unexpected server error occurred. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/listphonenumbersresponsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # ListPhoneNumbersResponseBody
2
+
3
+ Bad Request
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | Invalid request format, please check API reference. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/listphonenumbersresponseresponsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # ListPhoneNumbersResponseResponseBody
2
+
3
+ Unauthorized
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | API key is missing or invalid. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/updateagentresponse422responsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # UpdateAgentResponse422ResponseBody
2
+
3
+ Unprocessable Content
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | Cannot find requested asset under given api key. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/updateagentresponse500responsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # UpdateAgentResponse500ResponseBody
2
+
3
+ Internal Server Error
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | An unexpected server error occurred. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/updateagentresponsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # UpdateAgentResponseBody
2
+
3
+ Bad Request
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | Invalid request format, please check API reference. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/updateagentresponseresponsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # UpdateAgentResponseResponseBody
2
+
3
+ Unauthorized
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | API key is missing or invalid. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/updatephoneagentresponse422responsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # UpdatePhoneAgentResponse422ResponseBody
2
+
3
+ Unprocessable Content
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | Cannot find requested asset under given api key. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/updatephoneagentresponse500responsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # UpdatePhoneAgentResponse500ResponseBody
2
+
3
+ Internal Server Error
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | An unexpected server error occurred. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/updatephoneagentresponsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # UpdatePhoneAgentResponseBody
2
+
3
+ Bad Request
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | Invalid request format, please check API reference. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/errors/updatephoneagentresponseresponsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # UpdatePhoneAgentResponseResponseBody
2
+
3
+ Unauthorized
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | API key is missing or invalid. |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
package/docs/sdk/models/operations/callstatus.md ADDED
@@ -0,0 +1,12 @@
1
+ # CallStatus
2
+
3
+ Status of call.
4
+
5
+
6
+ ## Values
7
+
8
+ | Name | Value |
9
+ | --------- | --------- |
10
+ | `Ongoing` | ongoing |
11
+ | `Ended` | ended |
12
+ | `Error` | error |
package/docs/sdk/models/operations/calltype.md ADDED
@@ -0,0 +1,10 @@
1
+ # CallType
2
+
3
+
4
+ ## Values
5
+
6
+ | Name | Value |
7
+ | ------------------- | ------------------- |
8
+ | `InboundPhoneCall` | inbound_phone_call |
9
+ | `OutboundPhoneCall` | outbound_phone_call |
10
+ | `WebCall` | web_call |
package/docs/sdk/models/operations/createagentrequestbody.md ADDED
@@ -0,0 +1,15 @@
1
+ # CreateAgentRequestBody
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
+ | `prompt` | *string* | :heavy_check_mark: | The prompt agent will follow. Check out [Prompt Best Practices](/features/agent-prompt-guide). Can use `${YOUR_PARAM_NAME}` to represent dynamic data that would get injected at each call. Learn more about [Agent Prompt Parameters](/features/agent-prompt-parameter). | You are a marketing assistant. You help come up with creative content ideas and content like marketing emails, blog posts, tweets, ad copy and product descriptions. You respond concisely, with filler words in it. |
9
+ | `voiceId` | *string* | :heavy_check_mark: | Unique voice id used for the agent. Find list of available voices and their characteristics in [Voices](/features/voices). | elevenlabs-xxcrwXReTKMHWjqi7Q27 |
10
+ | `agentName` | *string* | :heavy_minus_sign: | The name of the agent. Only used for your own reference. | Jarvis |
11
+ | `enableBeginMessage` | *boolean* | :heavy_minus_sign: | Whether the agent begins the call with a pre-defined message. When this is false, the agent will still start the call, but with a dynamic message. If you wish for user to be the first to talk, set this to true and set `begin_message` as empty string. | true |
12
+ | `beginMessage` | *string* | :heavy_minus_sign: | Pre-defined message for agent to say in the begining of call. Only used when `enable_begin_message` is true. When empty, agent would wait for user to talk first. | Hello there, how can I help you? |
13
+ | `enableEndCall` | *boolean* | :heavy_minus_sign: | Whether the agent can end a call. If false, the agent would never end a call. | true |
14
+ | `enableEndMessage` | *boolean* | :heavy_minus_sign: | Whether the agent attempts to end the call with a pre-defined message. When this is false, the agent might still be the last one speaking in the call, but the massage can be dynamic. | false |
15
+ | `endMessage` | *string* | :heavy_minus_sign: | Pre-defined message for agent to say when agent ends the call. Only used when `enable_end_call` and `enable_end_message` is true. If you wish for agent to hang up without saying anything, set this to empty string. | Hope you have a good day, goodbye. |
package/docs/sdk/models/operations/createagentresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # CreateAgentResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
11
+ | `agent` | [shared.Agent](../../../sdk/models/shared/agent.md) | :heavy_minus_sign: | Successfully created a new agent. |
package/docs/sdk/models/operations/createphonecallcalltype.md ADDED
@@ -0,0 +1,12 @@
1
+ # CreatePhoneCallCallType
2
+
3
+ Web call or phone call.
4
+
5
+
6
+ ## Values
7
+
8
+ | Name | Value |
9
+ | ------------------- | ------------------- |
10
+ | `InboundPhoneCall` | inbound_phone_call |
11
+ | `OutboundPhoneCall` | outbound_phone_call |
12
+ | `WebCall` | web_call |
package/docs/sdk/models/operations/createphonecallrequestbody.md ADDED
@@ -0,0 +1,9 @@
1
+ # CreatePhoneCallRequestBody
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
+ | `phoneNumber` | [operations.PhoneNumber](../../../sdk/models/operations/phonenumber.md) | :heavy_check_mark: | N/A |
9
+ | `agentPromptParams` | [shared.AgentPromptParams](../../../sdk/models/shared/agentpromptparams.md)[] | :heavy_minus_sign: | Supply values to your agent prompt parameters. If the given key value cannot match any param in prompt, it would have have any effect. Learn more about [Agent Prompt Parameters](/features/agent-prompt-parameter). |
package/docs/sdk/models/operations/createphonecallresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # CreatePhoneCallResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
11
+ | `object` | [operations.CreatePhoneCallResponseBody](../../../sdk/models/operations/createphonecallresponsebody.md) | :heavy_minus_sign: | Successfully retrieved an agent. |
package/docs/sdk/models/operations/createphonecallresponsebody.md ADDED
@@ -0,0 +1,16 @@
1
+ # CreatePhoneCallResponseBody
2
+
3
+ Successfully retrieved an agent.
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description | Example |
9
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10
+ | `callId` | *string* | :heavy_check_mark: | Unique id of the call. | Jabr9TXYYJHfvl6Syypi88rdAHYHmcq6 |
11
+ | `agentId` | *string* | :heavy_check_mark: | Corresponding agent id of this call. | oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD |
12
+ | `callType` | [operations.CreatePhoneCallCallType](../../../sdk/models/operations/createphonecallcalltype.md) | :heavy_check_mark: | Web call or phone call. | inbound_phone_call |
13
+ | `phoneNumber` | [shared.CallPhoneNumber](../../../sdk/models/shared/callphonenumber.md) | :heavy_check_mark: | N/A | |
14
+ | `callStatus` | [operations.CallStatus](../../../sdk/models/operations/callstatus.md) | :heavy_check_mark: | Status of call. | ended |
15
+ | `agentPromptParams` | [shared.AgentPromptParams](../../../sdk/models/shared/agentpromptparams.md)[] | :heavy_minus_sign: | Supply values to your agent prompt parameters. If the given key value cannot match any param in prompt, it would have have any effect. Learn more about [Agent Prompt Parameters](/features/agent-prompt-parameter). | |
16
+ | `startTimestamp` | *number* | :heavy_check_mark: | Begin timestamp (milliseconds since epoch) of the call. | 1703302407333 |
package/docs/sdk/models/operations/createphonenumberrequestbody.md ADDED
@@ -0,0 +1,9 @@
1
+ # CreatePhoneNumberRequestBody
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
8
+ | `agentId` | *string* | :heavy_check_mark: | Unique agent id to associate with this phone number. Can be updated with [Update Phone Agent](/api/update-phone-agent). | oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD |
9
+ | `areaCode` | *number* | :heavy_minus_sign: | The desired area code of the number. Must be valid US area code, which is a 3 digit integer. | 415 |
package/docs/sdk/models/operations/createphonenumberresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # CreatePhoneNumberResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
11
+ | `phoneNumber` | [shared.PhoneNumber](../../../sdk/models/shared/phonenumber.md) | :heavy_minus_sign: | Successfully created a new phone number. |
package/docs/sdk/models/operations/deleteagentrequest.md ADDED
@@ -0,0 +1,8 @@
1
+ # DeleteAgentRequest
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
8
+ | `agentId` | *string* | :heavy_check_mark: | Unique id of the agent to be deleted. | oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD |
package/docs/sdk/models/operations/deleteagentresponse.md ADDED
@@ -0,0 +1,10 @@
1
+ # DeleteAgentResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
package/docs/sdk/models/operations/deletephonenumberrequest.md ADDED
@@ -0,0 +1,8 @@
1
+ # DeletePhoneNumberRequest
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
8
+ | `phoneNumber` | *string* | :heavy_check_mark: | Phone number to delete in E.164 format. |
package/docs/sdk/models/operations/deletephonenumberresponse.md ADDED
@@ -0,0 +1,10 @@
1
+ # DeletePhoneNumberResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
package/docs/sdk/models/operations/filtercriteria.md ADDED
@@ -0,0 +1,13 @@
1
+ # FilterCriteria
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
8
+ | `agentId` | *string*[] | :heavy_minus_sign: | Only retrieve calls that are made with specific agent(s). | ["oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD"] |
9
+ | `callType` | [operations.CallType](../../../sdk/models/operations/calltype.md)[] | :heavy_minus_sign: | Only retrieve calls of specific type(s). | ["inbound_phone_call","outbound_phone_call"] |
10
+ | `beforeStartTimestamp` | *number* | :heavy_minus_sign: | Exclusive. Filter calls that start before this timestamp. | 1703302407399 |
11
+ | `afterStartTimestamp` | *number* | :heavy_minus_sign: | Inclusive. Filter calls that start on or after this timestamp. | 1703302407300 |
12
+ | `beforeEndTimestamp` | *number* | :heavy_minus_sign: | Exclusive. Filter calls that end before this timestamp. | 1703302428899 |
13
+ | `afterEndTimestamp` | *number* | :heavy_minus_sign: | Inclusive. Filter calls that end on or after this timestamp. | 1703302428800 |
package/docs/sdk/models/operations/getagentrequest.md ADDED
@@ -0,0 +1,8 @@
1
+ # GetAgentRequest
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
8
+ | `agentId` | *string* | :heavy_check_mark: | Unique id of the agent to be retrieved. | 16b980523634a6dc504898cda492e939 |
package/docs/sdk/models/operations/getagentresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # GetAgentResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
11
+ | `agent` | [shared.Agent](../../../sdk/models/shared/agent.md) | :heavy_minus_sign: | Successfully retrieved an agent. |
package/docs/sdk/models/operations/getcallrequest.md ADDED
@@ -0,0 +1,8 @@
1
+ # GetCallRequest
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
8
+ | `callId` | *string* | :heavy_check_mark: | The call id to retrieve call history for. | 119c3f8e47135a29e65947eeb34cf12d |
package/docs/sdk/models/operations/getcallresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # GetCallResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
11
+ | `callDetail` | [shared.CallDetail](../../../sdk/models/shared/calldetail.md) | :heavy_minus_sign: | Successfully retrieved an agent. |
package/docs/sdk/models/operations/getphonenumberrequest.md ADDED
@@ -0,0 +1,8 @@
1
+ # GetPhoneNumberRequest
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
8
+ | `phoneNumber` | *string* | :heavy_check_mark: | Phone number in E.164 format to retreive more information. | +14159095857 |
package/docs/sdk/models/operations/getphonenumberresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # GetPhoneNumberResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
11
+ | `phoneNumber` | [shared.PhoneNumber](../../../sdk/models/shared/phonenumber.md) | :heavy_minus_sign: | Successfully retrieved a phone number. |
package/docs/sdk/models/operations/listagentsresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # ListAgentsResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
11
+ | `agents` | [shared.Agent](../../../sdk/models/shared/agent.md)[] | :heavy_minus_sign: | Successfully retrieved all agents. |
package/docs/sdk/models/operations/listcallsrequest.md ADDED
@@ -0,0 +1,10 @@
1
+ # ListCallsRequest
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
8
+ | `filterCriteria` | [operations.FilterCriteria](../../../sdk/models/operations/filtercriteria.md) | :heavy_minus_sign: | N/A |
9
+ | `sortOrder` | [operations.SortOrder](../../../sdk/models/operations/sortorder.md) | :heavy_minus_sign: | The calls will be sorted by `start_timestamp`, whether to return the calls in ascending or descending order. |
10
+ | `limit` | *number* | :heavy_minus_sign: | Limit the number of calls returned. |