phonic 0.31.11 → 0.31.13

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 (153) hide show
  1. package/README.md +1 -0
  2. package/dist/cjs/BaseClient.js +2 -2
  3. package/dist/cjs/Client.d.ts +6 -0
  4. package/dist/cjs/Client.js +20 -10
  5. package/dist/cjs/api/errors/UnprocessableEntityError.d.ts +6 -0
  6. package/dist/cjs/api/errors/UnprocessableEntityError.js +54 -0
  7. package/dist/cjs/api/errors/index.d.ts +1 -0
  8. package/dist/cjs/api/errors/index.js +1 -0
  9. package/dist/cjs/api/resources/agents/client/Client.d.ts +3 -0
  10. package/dist/cjs/api/resources/agents/client/Client.js +3 -0
  11. package/dist/cjs/api/resources/agents/client/requests/AgentsCreateRequest.d.ts +3 -0
  12. package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.d.ts +3 -0
  13. package/dist/cjs/api/resources/agents/client/requests/UpsertAgentRequest.d.ts +1 -0
  14. package/dist/cjs/api/resources/conversationItems/client/Client.d.ts +39 -0
  15. package/dist/cjs/api/resources/conversationItems/client/Client.js +139 -0
  16. package/dist/cjs/api/resources/conversationItems/client/index.d.ts +1 -0
  17. package/dist/cjs/api/resources/conversationItems/client/index.js +17 -0
  18. package/dist/cjs/api/resources/conversationItems/client/requests/ReplayConversationItemRequest.d.ts +12 -0
  19. package/dist/cjs/api/resources/conversationItems/client/requests/ReplayConversationItemRequest.js +3 -0
  20. package/dist/cjs/api/resources/conversationItems/client/requests/index.d.ts +1 -0
  21. package/dist/cjs/api/resources/conversationItems/client/requests/index.js +2 -0
  22. package/dist/cjs/api/resources/conversationItems/exports.d.ts +2 -0
  23. package/dist/cjs/api/resources/conversationItems/exports.js +21 -0
  24. package/dist/cjs/api/resources/conversationItems/index.d.ts +1 -0
  25. package/dist/cjs/api/resources/conversationItems/index.js +17 -0
  26. package/dist/cjs/api/resources/conversations/client/Client.d.ts +1 -0
  27. package/dist/cjs/api/resources/conversations/client/Client.js +3 -0
  28. package/dist/cjs/api/resources/conversations/client/Socket.d.ts +3 -1
  29. package/dist/cjs/api/resources/conversations/client/Socket.js +8 -0
  30. package/dist/cjs/api/resources/conversations/client/requests/OutboundCallRequest.d.ts +1 -0
  31. package/dist/cjs/api/resources/conversations/types/ConversationsListResponse.d.ts +1 -9
  32. package/dist/cjs/api/resources/index.d.ts +4 -0
  33. package/dist/cjs/api/resources/index.js +5 -1
  34. package/dist/cjs/api/resources/projects/client/requests/UpdateProjectRequest.d.ts +2 -0
  35. package/dist/cjs/api/resources/workspace/client/Client.d.ts +26 -0
  36. package/dist/cjs/api/resources/workspace/client/Client.js +110 -0
  37. package/dist/cjs/api/resources/workspace/client/index.d.ts +1 -0
  38. package/dist/cjs/api/resources/workspace/client/index.js +2 -0
  39. package/dist/cjs/api/resources/workspace/exports.d.ts +2 -0
  40. package/dist/cjs/api/resources/workspace/exports.js +21 -0
  41. package/dist/cjs/api/resources/workspace/index.d.ts +2 -0
  42. package/dist/cjs/api/resources/workspace/index.js +18 -0
  43. package/dist/cjs/api/resources/workspace/types/WorkspaceGetResponse.d.ts +6 -0
  44. package/dist/cjs/api/resources/workspace/types/WorkspaceGetResponse.js +3 -0
  45. package/dist/cjs/api/resources/workspace/types/index.d.ts +1 -0
  46. package/dist/cjs/api/resources/workspace/types/index.js +17 -0
  47. package/dist/cjs/api/types/Agent.d.ts +2 -0
  48. package/dist/cjs/api/types/BadRequestErrorBody.d.ts +1 -1
  49. package/dist/cjs/api/types/ConfigOptions.d.ts +2 -0
  50. package/dist/cjs/api/types/Conversation.d.ts +10 -0
  51. package/dist/cjs/api/types/ConversationItem.d.ts +2 -0
  52. package/dist/cjs/api/types/ConversationsListResponseConversation.d.ts +4 -0
  53. package/dist/cjs/api/types/ConversationsListResponseConversation.js +3 -0
  54. package/dist/cjs/api/types/ConversationsListResponseConversations.d.ts +5 -0
  55. package/dist/cjs/api/types/ConversationsListResponseConversations.js +3 -0
  56. package/dist/cjs/api/types/ConversationsListResponseConversationsPagination.d.ts +6 -0
  57. package/dist/cjs/api/types/ConversationsListResponseConversationsPagination.js +3 -0
  58. package/dist/cjs/api/types/CreateAgentRequest.d.ts +2 -0
  59. package/dist/cjs/api/types/MutePayload.d.ts +3 -0
  60. package/dist/cjs/api/types/MutePayload.js +3 -0
  61. package/dist/cjs/api/types/OutboundCallConfig.d.ts +2 -0
  62. package/dist/cjs/api/types/Project.d.ts +4 -0
  63. package/dist/cjs/api/types/ReplayConversationItemResponse.d.ts +16 -0
  64. package/dist/cjs/api/types/ReplayConversationItemResponse.js +3 -0
  65. package/dist/cjs/api/types/ReplayToolCall.d.ts +29 -0
  66. package/dist/cjs/api/types/ReplayToolCall.js +12 -0
  67. package/dist/cjs/api/types/SipCallError.d.ts +24 -0
  68. package/dist/cjs/api/types/SipCallError.js +16 -0
  69. package/dist/cjs/api/types/UnmutePayload.d.ts +3 -0
  70. package/dist/cjs/api/types/UnmutePayload.js +3 -0
  71. package/dist/cjs/api/types/index.d.ts +8 -0
  72. package/dist/cjs/api/types/index.js +8 -0
  73. package/dist/cjs/custom/ReconnectableConversationsSocket.d.ts +2 -0
  74. package/dist/cjs/custom/ReconnectableConversationsSocket.js +6 -0
  75. package/dist/cjs/version.d.ts +1 -1
  76. package/dist/cjs/version.js +1 -1
  77. package/dist/esm/BaseClient.mjs +2 -2
  78. package/dist/esm/Client.d.mts +6 -0
  79. package/dist/esm/Client.mjs +10 -0
  80. package/dist/esm/api/errors/UnprocessableEntityError.d.mts +6 -0
  81. package/dist/esm/api/errors/UnprocessableEntityError.mjs +17 -0
  82. package/dist/esm/api/errors/index.d.mts +1 -0
  83. package/dist/esm/api/errors/index.mjs +1 -0
  84. package/dist/esm/api/resources/agents/client/Client.d.mts +3 -0
  85. package/dist/esm/api/resources/agents/client/Client.mjs +3 -0
  86. package/dist/esm/api/resources/agents/client/requests/AgentsCreateRequest.d.mts +3 -0
  87. package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.d.mts +3 -0
  88. package/dist/esm/api/resources/agents/client/requests/UpsertAgentRequest.d.mts +1 -0
  89. package/dist/esm/api/resources/conversationItems/client/Client.d.mts +39 -0
  90. package/dist/esm/api/resources/conversationItems/client/Client.mjs +102 -0
  91. package/dist/esm/api/resources/conversationItems/client/index.d.mts +1 -0
  92. package/dist/esm/api/resources/conversationItems/client/index.mjs +1 -0
  93. package/dist/esm/api/resources/conversationItems/client/requests/ReplayConversationItemRequest.d.mts +12 -0
  94. package/dist/esm/api/resources/conversationItems/client/requests/ReplayConversationItemRequest.mjs +2 -0
  95. package/dist/esm/api/resources/conversationItems/client/requests/index.d.mts +1 -0
  96. package/dist/esm/api/resources/conversationItems/client/requests/index.mjs +1 -0
  97. package/dist/esm/api/resources/conversationItems/exports.d.mts +2 -0
  98. package/dist/esm/api/resources/conversationItems/exports.mjs +3 -0
  99. package/dist/esm/api/resources/conversationItems/index.d.mts +1 -0
  100. package/dist/esm/api/resources/conversationItems/index.mjs +1 -0
  101. package/dist/esm/api/resources/conversations/client/Client.d.mts +1 -0
  102. package/dist/esm/api/resources/conversations/client/Client.mjs +3 -0
  103. package/dist/esm/api/resources/conversations/client/Socket.d.mts +3 -1
  104. package/dist/esm/api/resources/conversations/client/Socket.mjs +8 -0
  105. package/dist/esm/api/resources/conversations/client/requests/OutboundCallRequest.d.mts +1 -0
  106. package/dist/esm/api/resources/conversations/types/ConversationsListResponse.d.mts +1 -9
  107. package/dist/esm/api/resources/index.d.mts +4 -0
  108. package/dist/esm/api/resources/index.mjs +4 -0
  109. package/dist/esm/api/resources/projects/client/requests/UpdateProjectRequest.d.mts +2 -0
  110. package/dist/esm/api/resources/workspace/client/Client.d.mts +26 -0
  111. package/dist/esm/api/resources/workspace/client/Client.mjs +73 -0
  112. package/dist/esm/api/resources/workspace/client/index.d.mts +1 -0
  113. package/dist/esm/api/resources/workspace/client/index.mjs +1 -0
  114. package/dist/esm/api/resources/workspace/exports.d.mts +2 -0
  115. package/dist/esm/api/resources/workspace/exports.mjs +3 -0
  116. package/dist/esm/api/resources/workspace/index.d.mts +2 -0
  117. package/dist/esm/api/resources/workspace/index.mjs +2 -0
  118. package/dist/esm/api/resources/workspace/types/WorkspaceGetResponse.d.mts +6 -0
  119. package/dist/esm/api/resources/workspace/types/WorkspaceGetResponse.mjs +2 -0
  120. package/dist/esm/api/resources/workspace/types/index.d.mts +1 -0
  121. package/dist/esm/api/resources/workspace/types/index.mjs +1 -0
  122. package/dist/esm/api/types/Agent.d.mts +2 -0
  123. package/dist/esm/api/types/BadRequestErrorBody.d.mts +1 -1
  124. package/dist/esm/api/types/ConfigOptions.d.mts +2 -0
  125. package/dist/esm/api/types/Conversation.d.mts +10 -0
  126. package/dist/esm/api/types/ConversationItem.d.mts +2 -0
  127. package/dist/esm/api/types/ConversationsListResponseConversation.d.mts +4 -0
  128. package/dist/esm/api/types/ConversationsListResponseConversation.mjs +2 -0
  129. package/dist/esm/api/types/ConversationsListResponseConversations.d.mts +5 -0
  130. package/dist/esm/api/types/ConversationsListResponseConversations.mjs +2 -0
  131. package/dist/esm/api/types/ConversationsListResponseConversationsPagination.d.mts +6 -0
  132. package/dist/esm/api/types/ConversationsListResponseConversationsPagination.mjs +2 -0
  133. package/dist/esm/api/types/CreateAgentRequest.d.mts +2 -0
  134. package/dist/esm/api/types/MutePayload.d.mts +3 -0
  135. package/dist/esm/api/types/MutePayload.mjs +2 -0
  136. package/dist/esm/api/types/OutboundCallConfig.d.mts +2 -0
  137. package/dist/esm/api/types/Project.d.mts +4 -0
  138. package/dist/esm/api/types/ReplayConversationItemResponse.d.mts +16 -0
  139. package/dist/esm/api/types/ReplayConversationItemResponse.mjs +2 -0
  140. package/dist/esm/api/types/ReplayToolCall.d.mts +29 -0
  141. package/dist/esm/api/types/ReplayToolCall.mjs +9 -0
  142. package/dist/esm/api/types/SipCallError.d.mts +24 -0
  143. package/dist/esm/api/types/SipCallError.mjs +13 -0
  144. package/dist/esm/api/types/UnmutePayload.d.mts +3 -0
  145. package/dist/esm/api/types/UnmutePayload.mjs +2 -0
  146. package/dist/esm/api/types/index.d.mts +8 -0
  147. package/dist/esm/api/types/index.mjs +8 -0
  148. package/dist/esm/custom/ReconnectableConversationsSocket.d.mts +2 -0
  149. package/dist/esm/custom/ReconnectableConversationsSocket.mjs +6 -0
  150. package/dist/esm/version.d.mts +1 -1
  151. package/dist/esm/version.mjs +1 -1
  152. package/package.json +23 -1
  153. package/reference.md +138 -0
package/reference.md CHANGED
@@ -116,6 +116,7 @@ await client.agents.create({
116
116
  default_language: "en",
117
117
  additional_languages: ["es"],
118
118
  multilingual_mode: "request",
119
+ push_to_talk: false,
119
120
  boosted_keywords: ["Load ID", "dispatch"],
120
121
  min_words_to_interrupt: 1,
121
122
  configuration_endpoint: {
@@ -214,6 +215,7 @@ await client.agents.upsert({
214
215
  default_language: "en",
215
216
  additional_languages: ["es"],
216
217
  multilingual_mode: "request",
218
+ push_to_talk: false,
217
219
  boosted_keywords: ["Load ID", "dispatch"],
218
220
  min_words_to_interrupt: 1,
219
221
  configuration_endpoint: {
@@ -458,6 +460,7 @@ await client.agents.update("nameOrId", {
458
460
  default_language: "en",
459
461
  additional_languages: ["es"],
460
462
  multilingual_mode: "request",
463
+ push_to_talk: false,
461
464
  boosted_keywords: ["Load ID", "dispatch"],
462
465
  min_words_to_interrupt: 1,
463
466
  configuration_endpoint: {
@@ -1616,6 +1619,140 @@ await client.voices.get("id");
1616
1619
  </dl>
1617
1620
 
1618
1621
 
1622
+ </dd>
1623
+ </dl>
1624
+ </details>
1625
+
1626
+ ## Workspace
1627
+ <details><summary><code>client.workspace.<a href="/src/api/resources/workspace/client/Client.ts">get</a>() -> Phonic.WorkspaceGetResponse</code></summary>
1628
+ <dl>
1629
+ <dd>
1630
+
1631
+ #### 📝 Description
1632
+
1633
+ <dl>
1634
+ <dd>
1635
+
1636
+ <dl>
1637
+ <dd>
1638
+
1639
+ Returns information about the workspace.
1640
+ </dd>
1641
+ </dl>
1642
+ </dd>
1643
+ </dl>
1644
+
1645
+ #### 🔌 Usage
1646
+
1647
+ <dl>
1648
+ <dd>
1649
+
1650
+ <dl>
1651
+ <dd>
1652
+
1653
+ ```typescript
1654
+ await client.workspace.get();
1655
+
1656
+ ```
1657
+ </dd>
1658
+ </dl>
1659
+ </dd>
1660
+ </dl>
1661
+
1662
+ #### ⚙️ Parameters
1663
+
1664
+ <dl>
1665
+ <dd>
1666
+
1667
+ <dl>
1668
+ <dd>
1669
+
1670
+ **requestOptions:** `WorkspaceClient.RequestOptions`
1671
+
1672
+ </dd>
1673
+ </dl>
1674
+ </dd>
1675
+ </dl>
1676
+
1677
+
1678
+ </dd>
1679
+ </dl>
1680
+ </details>
1681
+
1682
+ ## ConversationItems
1683
+ <details><summary><code>client.conversationItems.<a href="/src/api/resources/conversationItems/client/Client.ts">replay</a>(id, { ...params }) -> Phonic.ReplayConversationItemResponse</code></summary>
1684
+ <dl>
1685
+ <dd>
1686
+
1687
+ #### 📝 Description
1688
+
1689
+ <dl>
1690
+ <dd>
1691
+
1692
+ <dl>
1693
+ <dd>
1694
+
1695
+ Returns the alternative response(s) the assistant would have
1696
+ produced for this conversation turn given changes to the agent system prompt.
1697
+
1698
+ Only assistant items from ended conversations can be replayed. The
1699
+ conversation must have an associated agent.
1700
+ </dd>
1701
+ </dl>
1702
+ </dd>
1703
+ </dl>
1704
+
1705
+ #### 🔌 Usage
1706
+
1707
+ <dl>
1708
+ <dd>
1709
+
1710
+ <dl>
1711
+ <dd>
1712
+
1713
+ ```typescript
1714
+ await client.conversationItems.replay("id", {
1715
+ system_prompt: "system_prompt"
1716
+ });
1717
+
1718
+ ```
1719
+ </dd>
1720
+ </dl>
1721
+ </dd>
1722
+ </dl>
1723
+
1724
+ #### ⚙️ Parameters
1725
+
1726
+ <dl>
1727
+ <dd>
1728
+
1729
+ <dl>
1730
+ <dd>
1731
+
1732
+ **id:** `string` — The ID of the conversation item to replay.
1733
+
1734
+ </dd>
1735
+ </dl>
1736
+
1737
+ <dl>
1738
+ <dd>
1739
+
1740
+ **request:** `Phonic.ReplayConversationItemRequest`
1741
+
1742
+ </dd>
1743
+ </dl>
1744
+
1745
+ <dl>
1746
+ <dd>
1747
+
1748
+ **requestOptions:** `ConversationItemsClient.RequestOptions`
1749
+
1750
+ </dd>
1751
+ </dl>
1752
+ </dd>
1753
+ </dl>
1754
+
1755
+
1619
1756
  </dd>
1620
1757
  </dl>
1621
1758
  </details>
@@ -2198,6 +2335,7 @@ await client.conversations.outboundCall({
2198
2335
  default_language: "en",
2199
2336
  additional_languages: ["es"],
2200
2337
  multilingual_mode: "request",
2338
+ push_to_talk: false,
2201
2339
  boosted_keywords: ["Load ID", "dispatch"],
2202
2340
  min_words_to_interrupt: 1,
2203
2341
  tools: ["keypad_input"]