phonic 0.32.1 → 0.32.3
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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +23 -18
- package/dist/cjs/api/errors/TooManyRequestsError.d.ts +6 -0
- package/dist/cjs/api/errors/TooManyRequestsError.js +54 -0
- package/dist/cjs/api/errors/index.d.ts +1 -0
- package/dist/cjs/api/errors/index.js +1 -0
- package/dist/cjs/api/resources/agents/client/requests/AgentsCreateRequest.d.ts +8 -0
- package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.d.ts +14 -0
- package/dist/cjs/api/resources/agents/client/requests/UpsertAgentRequest.d.ts +6 -0
- package/dist/cjs/api/resources/agents/types/AgentsUpdateResponse.d.ts +5 -0
- package/dist/cjs/api/resources/apiKeys/client/Client.d.ts +79 -0
- package/dist/cjs/api/resources/apiKeys/client/Client.js +293 -0
- package/dist/cjs/api/resources/apiKeys/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/apiKeys/client/index.js +17 -0
- package/dist/cjs/api/resources/apiKeys/client/requests/CreateApiKeyRequest.d.ts +10 -0
- package/dist/cjs/api/resources/apiKeys/client/requests/CreateApiKeyRequest.js +3 -0
- package/dist/cjs/api/resources/apiKeys/client/requests/UpdateApiKeyRequest.d.ts +10 -0
- package/dist/cjs/api/resources/apiKeys/client/requests/UpdateApiKeyRequest.js +3 -0
- package/dist/cjs/api/resources/apiKeys/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/apiKeys/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/apiKeys/exports.d.ts +2 -0
- package/dist/cjs/api/resources/apiKeys/exports.js +21 -0
- package/dist/cjs/api/resources/apiKeys/index.d.ts +2 -0
- package/dist/cjs/api/resources/apiKeys/index.js +18 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeysDeleteResponse.d.ts +3 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeysDeleteResponse.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeysUpdateResponse.d.ts +3 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeysUpdateResponse.js +3 -0
- package/dist/cjs/api/resources/apiKeys/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/apiKeys/types/index.js +18 -0
- package/dist/cjs/api/resources/auth/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/auth/client/Client.js +70 -0
- package/dist/cjs/api/resources/auth/client/requests/CreateConversationTokenRequest.d.ts +13 -0
- package/dist/cjs/api/resources/auth/client/requests/CreateConversationTokenRequest.js +3 -0
- package/dist/cjs/api/resources/auth/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/auth/types/AuthCreateConversationTokenResponse.d.ts +6 -0
- package/dist/cjs/api/resources/auth/types/AuthCreateConversationTokenResponse.js +3 -0
- package/dist/cjs/api/resources/auth/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/auth/types/index.js +1 -0
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +26 -1
- package/dist/cjs/api/resources/conversations/client/Client.js +78 -0
- package/dist/cjs/api/resources/conversations/client/requests/ReplayConversationRequest.d.ts +10 -0
- package/dist/cjs/api/resources/conversations/client/requests/ReplayConversationRequest.js +3 -0
- package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsEvaluateResponse.d.ts +19 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsEvaluateResponse.js +17 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsReplayResponse.d.ts +4 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsReplayResponse.js +3 -0
- package/dist/cjs/api/resources/conversations/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/conversations/types/index.js +2 -0
- package/dist/cjs/api/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/index.js +5 -1
- package/dist/cjs/api/resources/projects/client/Client.d.ts +16 -0
- package/dist/cjs/api/resources/projects/client/Client.js +58 -0
- package/dist/cjs/api/resources/projects/types/ProjectsListEvalsResponse.d.ts +4 -0
- package/dist/cjs/api/resources/projects/types/ProjectsListEvalsResponse.js +3 -0
- package/dist/cjs/api/resources/projects/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/projects/types/index.js +1 -0
- package/dist/cjs/api/resources/tools/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/tools/client/Client.js +2 -1
- package/dist/cjs/api/resources/tools/client/requests/CreateToolRequest.d.ts +4 -1
- package/dist/cjs/api/resources/tools/client/requests/UpdateToolRequest.d.ts +5 -13
- package/dist/cjs/api/resources/tools/client/requests/UpdateToolRequest.js +0 -8
- package/dist/cjs/api/resources/workspace/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/workspace/client/Client.js +65 -0
- package/dist/cjs/api/resources/workspace/client/index.d.ts +1 -1
- package/dist/cjs/api/resources/workspace/client/index.js +15 -0
- package/dist/cjs/api/resources/workspace/client/requests/UpdateWorkspaceRequest.d.ts +16 -0
- package/dist/cjs/api/resources/workspace/client/requests/UpdateWorkspaceRequest.js +3 -0
- package/dist/cjs/api/resources/workspace/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/workspace/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/workspace/types/WorkspaceGetResponse.d.ts +6 -0
- package/dist/cjs/api/resources/workspace/types/WorkspaceUpdateResponse.d.ts +3 -0
- package/dist/cjs/api/resources/workspace/types/WorkspaceUpdateResponse.js +3 -0
- package/dist/cjs/api/resources/workspace/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/workspace/types/index.js +1 -0
- package/dist/cjs/api/types/Agent.d.ts +9 -0
- package/dist/cjs/api/types/AgentIntegration.d.ts +13 -0
- package/dist/cjs/api/types/AgentIntegration.js +3 -0
- package/dist/cjs/api/types/ApiKeyWithSecret.d.ts +8 -0
- package/dist/cjs/api/types/ApiKeyWithSecret.js +3 -0
- package/dist/cjs/api/types/AudioChunkResponsePayload.d.ts +2 -0
- package/dist/cjs/api/types/ConfigOptions.d.ts +67 -0
- package/dist/cjs/api/types/Conversation.d.ts +27 -0
- package/dist/cjs/api/types/Conversation.js +4 -0
- package/dist/cjs/api/types/ConversationEval.d.ts +22 -1
- package/dist/cjs/api/types/ConversationEval.js +11 -0
- package/dist/cjs/api/types/ConversationEvalPromptInfo.d.ts +7 -0
- package/dist/cjs/api/types/ConversationEvalPromptInfo.js +3 -0
- package/dist/cjs/api/types/ConversationExtraction.d.ts +2 -4
- package/dist/cjs/api/types/ConversationItem.d.ts +4 -2
- package/dist/cjs/api/types/CreateAgentRequest.d.ts +8 -0
- package/dist/cjs/api/types/DataRetentionPolicy.d.ts +21 -0
- package/dist/cjs/api/types/DataRetentionPolicy.js +3 -0
- package/dist/cjs/api/types/DtmfPayload.d.ts +2 -0
- package/dist/cjs/api/types/ExtractionField.d.ts +2 -2
- package/dist/cjs/api/types/OutboundCallConfig.d.ts +45 -1
- package/dist/cjs/api/types/OutboundCallConfig.js +6 -0
- package/dist/cjs/api/types/OutboundNumberPool.d.ts +9 -0
- package/dist/cjs/api/types/OutboundNumberPool.js +3 -0
- package/dist/cjs/api/types/Tool.d.ts +3 -1
- package/dist/cjs/api/types/index.d.ts +5 -0
- package/dist/cjs/api/types/index.js +5 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +5 -0
- package/dist/esm/api/errors/TooManyRequestsError.d.mts +6 -0
- package/dist/esm/api/errors/TooManyRequestsError.mjs +17 -0
- package/dist/esm/api/errors/index.d.mts +1 -0
- package/dist/esm/api/errors/index.mjs +1 -0
- package/dist/esm/api/resources/agents/client/requests/AgentsCreateRequest.d.mts +8 -0
- package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.d.mts +14 -0
- package/dist/esm/api/resources/agents/client/requests/UpsertAgentRequest.d.mts +6 -0
- package/dist/esm/api/resources/agents/types/AgentsUpdateResponse.d.mts +5 -0
- package/dist/esm/api/resources/apiKeys/client/Client.d.mts +79 -0
- package/dist/esm/api/resources/apiKeys/client/Client.mjs +256 -0
- package/dist/esm/api/resources/apiKeys/client/index.d.mts +1 -0
- package/dist/esm/api/resources/apiKeys/client/index.mjs +1 -0
- package/dist/esm/api/resources/apiKeys/client/requests/CreateApiKeyRequest.d.mts +10 -0
- package/dist/esm/api/resources/apiKeys/client/requests/CreateApiKeyRequest.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/client/requests/UpdateApiKeyRequest.d.mts +10 -0
- package/dist/esm/api/resources/apiKeys/client/requests/UpdateApiKeyRequest.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/apiKeys/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/apiKeys/exports.d.mts +2 -0
- package/dist/esm/api/resources/apiKeys/exports.mjs +3 -0
- package/dist/esm/api/resources/apiKeys/index.d.mts +2 -0
- package/dist/esm/api/resources/apiKeys/index.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeysDeleteResponse.d.mts +3 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeysDeleteResponse.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeysUpdateResponse.d.mts +3 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeysUpdateResponse.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/index.d.mts +2 -0
- package/dist/esm/api/resources/apiKeys/types/index.mjs +2 -0
- package/dist/esm/api/resources/auth/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/auth/client/Client.mjs +70 -0
- package/dist/esm/api/resources/auth/client/requests/CreateConversationTokenRequest.d.mts +13 -0
- package/dist/esm/api/resources/auth/client/requests/CreateConversationTokenRequest.mjs +2 -0
- package/dist/esm/api/resources/auth/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/auth/types/AuthCreateConversationTokenResponse.d.mts +6 -0
- package/dist/esm/api/resources/auth/types/AuthCreateConversationTokenResponse.mjs +2 -0
- package/dist/esm/api/resources/auth/types/index.d.mts +1 -0
- package/dist/esm/api/resources/auth/types/index.mjs +1 -0
- package/dist/esm/api/resources/conversations/client/Client.d.mts +26 -1
- package/dist/esm/api/resources/conversations/client/Client.mjs +78 -0
- package/dist/esm/api/resources/conversations/client/requests/ReplayConversationRequest.d.mts +10 -0
- package/dist/esm/api/resources/conversations/client/requests/ReplayConversationRequest.mjs +2 -0
- package/dist/esm/api/resources/conversations/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/conversations/types/ConversationsEvaluateResponse.d.mts +19 -0
- package/dist/esm/api/resources/conversations/types/ConversationsEvaluateResponse.mjs +14 -0
- package/dist/esm/api/resources/conversations/types/ConversationsReplayResponse.d.mts +4 -0
- package/dist/esm/api/resources/conversations/types/ConversationsReplayResponse.mjs +2 -0
- package/dist/esm/api/resources/conversations/types/index.d.mts +2 -0
- package/dist/esm/api/resources/conversations/types/index.mjs +2 -0
- package/dist/esm/api/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/index.mjs +4 -0
- package/dist/esm/api/resources/projects/client/Client.d.mts +16 -0
- package/dist/esm/api/resources/projects/client/Client.mjs +58 -0
- package/dist/esm/api/resources/projects/types/ProjectsListEvalsResponse.d.mts +4 -0
- package/dist/esm/api/resources/projects/types/ProjectsListEvalsResponse.mjs +2 -0
- package/dist/esm/api/resources/projects/types/index.d.mts +1 -0
- package/dist/esm/api/resources/projects/types/index.mjs +1 -0
- package/dist/esm/api/resources/tools/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/tools/client/Client.mjs +2 -1
- package/dist/esm/api/resources/tools/client/requests/CreateToolRequest.d.mts +4 -1
- package/dist/esm/api/resources/tools/client/requests/UpdateToolRequest.d.mts +5 -13
- package/dist/esm/api/resources/tools/client/requests/UpdateToolRequest.mjs +0 -8
- package/dist/esm/api/resources/workspace/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/workspace/client/Client.mjs +65 -0
- package/dist/esm/api/resources/workspace/client/index.d.mts +1 -1
- package/dist/esm/api/resources/workspace/client/index.mjs +1 -1
- package/dist/esm/api/resources/workspace/client/requests/UpdateWorkspaceRequest.d.mts +16 -0
- package/dist/esm/api/resources/workspace/client/requests/UpdateWorkspaceRequest.mjs +2 -0
- package/dist/esm/api/resources/workspace/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/workspace/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/workspace/types/WorkspaceGetResponse.d.mts +6 -0
- package/dist/esm/api/resources/workspace/types/WorkspaceUpdateResponse.d.mts +3 -0
- package/dist/esm/api/resources/workspace/types/WorkspaceUpdateResponse.mjs +2 -0
- package/dist/esm/api/resources/workspace/types/index.d.mts +1 -0
- package/dist/esm/api/resources/workspace/types/index.mjs +1 -0
- package/dist/esm/api/types/Agent.d.mts +9 -0
- package/dist/esm/api/types/AgentIntegration.d.mts +13 -0
- package/dist/esm/api/types/AgentIntegration.mjs +2 -0
- package/dist/esm/api/types/ApiKeyWithSecret.d.mts +8 -0
- package/dist/esm/api/types/ApiKeyWithSecret.mjs +2 -0
- package/dist/esm/api/types/AudioChunkResponsePayload.d.mts +2 -0
- package/dist/esm/api/types/ConfigOptions.d.mts +67 -0
- package/dist/esm/api/types/Conversation.d.mts +27 -0
- package/dist/esm/api/types/Conversation.mjs +4 -0
- package/dist/esm/api/types/ConversationEval.d.mts +22 -1
- package/dist/esm/api/types/ConversationEval.mjs +10 -1
- package/dist/esm/api/types/ConversationEvalPromptInfo.d.mts +7 -0
- package/dist/esm/api/types/ConversationEvalPromptInfo.mjs +2 -0
- package/dist/esm/api/types/ConversationExtraction.d.mts +2 -4
- package/dist/esm/api/types/ConversationItem.d.mts +4 -2
- package/dist/esm/api/types/CreateAgentRequest.d.mts +8 -0
- package/dist/esm/api/types/DataRetentionPolicy.d.mts +21 -0
- package/dist/esm/api/types/DataRetentionPolicy.mjs +2 -0
- package/dist/esm/api/types/DtmfPayload.d.mts +2 -0
- package/dist/esm/api/types/ExtractionField.d.mts +2 -2
- package/dist/esm/api/types/OutboundCallConfig.d.mts +45 -1
- package/dist/esm/api/types/OutboundCallConfig.mjs +6 -0
- package/dist/esm/api/types/OutboundNumberPool.d.mts +9 -0
- package/dist/esm/api/types/OutboundNumberPool.mjs +2 -0
- package/dist/esm/api/types/Tool.d.mts +3 -1
- package/dist/esm/api/types/index.d.mts +5 -0
- package/dist/esm/api/types/index.mjs +5 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +12 -1
- package/reference.md +540 -2
package/reference.md
CHANGED
|
@@ -872,7 +872,8 @@ await client.tools.create({
|
|
|
872
872
|
}],
|
|
873
873
|
require_speech_before_tool_call: false,
|
|
874
874
|
forbid_speech_after_tool_call: false,
|
|
875
|
-
allow_tool_chaining: true
|
|
875
|
+
allow_tool_chaining: true,
|
|
876
|
+
context: "Press the A button 5 times then gently shake the printer."
|
|
876
877
|
});
|
|
877
878
|
|
|
878
879
|
```
|
|
@@ -1690,6 +1691,338 @@ await client.workspace.get();
|
|
|
1690
1691
|
</dl>
|
|
1691
1692
|
|
|
1692
1693
|
|
|
1694
|
+
</dd>
|
|
1695
|
+
</dl>
|
|
1696
|
+
</details>
|
|
1697
|
+
|
|
1698
|
+
<details><summary><code>client.workspace.<a href="/src/api/resources/workspace/client/Client.ts">update</a>({ ...params }) -> Phonic.WorkspaceUpdateResponse</code></summary>
|
|
1699
|
+
<dl>
|
|
1700
|
+
<dd>
|
|
1701
|
+
|
|
1702
|
+
#### 📝 Description
|
|
1703
|
+
|
|
1704
|
+
<dl>
|
|
1705
|
+
<dd>
|
|
1706
|
+
|
|
1707
|
+
<dl>
|
|
1708
|
+
<dd>
|
|
1709
|
+
|
|
1710
|
+
Updates the workspace.
|
|
1711
|
+
</dd>
|
|
1712
|
+
</dl>
|
|
1713
|
+
</dd>
|
|
1714
|
+
</dl>
|
|
1715
|
+
|
|
1716
|
+
#### 🔌 Usage
|
|
1717
|
+
|
|
1718
|
+
<dl>
|
|
1719
|
+
<dd>
|
|
1720
|
+
|
|
1721
|
+
<dl>
|
|
1722
|
+
<dd>
|
|
1723
|
+
|
|
1724
|
+
```typescript
|
|
1725
|
+
await client.workspace.update({
|
|
1726
|
+
logo_url: "https://example.com/logo.png",
|
|
1727
|
+
invite_link_allowed_domains: ["example.com"],
|
|
1728
|
+
ip_allowlist: ["203.0.113.0/24"]
|
|
1729
|
+
});
|
|
1730
|
+
|
|
1731
|
+
```
|
|
1732
|
+
</dd>
|
|
1733
|
+
</dl>
|
|
1734
|
+
</dd>
|
|
1735
|
+
</dl>
|
|
1736
|
+
|
|
1737
|
+
#### ⚙️ Parameters
|
|
1738
|
+
|
|
1739
|
+
<dl>
|
|
1740
|
+
<dd>
|
|
1741
|
+
|
|
1742
|
+
<dl>
|
|
1743
|
+
<dd>
|
|
1744
|
+
|
|
1745
|
+
**request:** `Phonic.UpdateWorkspaceRequest`
|
|
1746
|
+
|
|
1747
|
+
</dd>
|
|
1748
|
+
</dl>
|
|
1749
|
+
|
|
1750
|
+
<dl>
|
|
1751
|
+
<dd>
|
|
1752
|
+
|
|
1753
|
+
**requestOptions:** `WorkspaceClient.RequestOptions`
|
|
1754
|
+
|
|
1755
|
+
</dd>
|
|
1756
|
+
</dl>
|
|
1757
|
+
</dd>
|
|
1758
|
+
</dl>
|
|
1759
|
+
|
|
1760
|
+
|
|
1761
|
+
</dd>
|
|
1762
|
+
</dl>
|
|
1763
|
+
</details>
|
|
1764
|
+
|
|
1765
|
+
## ApiKeys
|
|
1766
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">create</a>({ ...params }) -> Phonic.ApiKeyWithSecret</code></summary>
|
|
1767
|
+
<dl>
|
|
1768
|
+
<dd>
|
|
1769
|
+
|
|
1770
|
+
#### 📝 Description
|
|
1771
|
+
|
|
1772
|
+
<dl>
|
|
1773
|
+
<dd>
|
|
1774
|
+
|
|
1775
|
+
<dl>
|
|
1776
|
+
<dd>
|
|
1777
|
+
|
|
1778
|
+
Creates a new API key in the workspace.
|
|
1779
|
+
</dd>
|
|
1780
|
+
</dl>
|
|
1781
|
+
</dd>
|
|
1782
|
+
</dl>
|
|
1783
|
+
|
|
1784
|
+
#### 🔌 Usage
|
|
1785
|
+
|
|
1786
|
+
<dl>
|
|
1787
|
+
<dd>
|
|
1788
|
+
|
|
1789
|
+
<dl>
|
|
1790
|
+
<dd>
|
|
1791
|
+
|
|
1792
|
+
```typescript
|
|
1793
|
+
await client.apiKeys.create({
|
|
1794
|
+
name: "production-key"
|
|
1795
|
+
});
|
|
1796
|
+
|
|
1797
|
+
```
|
|
1798
|
+
</dd>
|
|
1799
|
+
</dl>
|
|
1800
|
+
</dd>
|
|
1801
|
+
</dl>
|
|
1802
|
+
|
|
1803
|
+
#### ⚙️ Parameters
|
|
1804
|
+
|
|
1805
|
+
<dl>
|
|
1806
|
+
<dd>
|
|
1807
|
+
|
|
1808
|
+
<dl>
|
|
1809
|
+
<dd>
|
|
1810
|
+
|
|
1811
|
+
**request:** `Phonic.CreateApiKeyRequest`
|
|
1812
|
+
|
|
1813
|
+
</dd>
|
|
1814
|
+
</dl>
|
|
1815
|
+
|
|
1816
|
+
<dl>
|
|
1817
|
+
<dd>
|
|
1818
|
+
|
|
1819
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
1820
|
+
|
|
1821
|
+
</dd>
|
|
1822
|
+
</dl>
|
|
1823
|
+
</dd>
|
|
1824
|
+
</dl>
|
|
1825
|
+
|
|
1826
|
+
|
|
1827
|
+
</dd>
|
|
1828
|
+
</dl>
|
|
1829
|
+
</details>
|
|
1830
|
+
|
|
1831
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">delete</a>(id) -> Phonic.ApiKeysDeleteResponse</code></summary>
|
|
1832
|
+
<dl>
|
|
1833
|
+
<dd>
|
|
1834
|
+
|
|
1835
|
+
#### 📝 Description
|
|
1836
|
+
|
|
1837
|
+
<dl>
|
|
1838
|
+
<dd>
|
|
1839
|
+
|
|
1840
|
+
<dl>
|
|
1841
|
+
<dd>
|
|
1842
|
+
|
|
1843
|
+
Deletes an API key.
|
|
1844
|
+
</dd>
|
|
1845
|
+
</dl>
|
|
1846
|
+
</dd>
|
|
1847
|
+
</dl>
|
|
1848
|
+
|
|
1849
|
+
#### 🔌 Usage
|
|
1850
|
+
|
|
1851
|
+
<dl>
|
|
1852
|
+
<dd>
|
|
1853
|
+
|
|
1854
|
+
<dl>
|
|
1855
|
+
<dd>
|
|
1856
|
+
|
|
1857
|
+
```typescript
|
|
1858
|
+
await client.apiKeys.delete("id");
|
|
1859
|
+
|
|
1860
|
+
```
|
|
1861
|
+
</dd>
|
|
1862
|
+
</dl>
|
|
1863
|
+
</dd>
|
|
1864
|
+
</dl>
|
|
1865
|
+
|
|
1866
|
+
#### ⚙️ Parameters
|
|
1867
|
+
|
|
1868
|
+
<dl>
|
|
1869
|
+
<dd>
|
|
1870
|
+
|
|
1871
|
+
<dl>
|
|
1872
|
+
<dd>
|
|
1873
|
+
|
|
1874
|
+
**id:** `string` — The ID of the API key to delete.
|
|
1875
|
+
|
|
1876
|
+
</dd>
|
|
1877
|
+
</dl>
|
|
1878
|
+
|
|
1879
|
+
<dl>
|
|
1880
|
+
<dd>
|
|
1881
|
+
|
|
1882
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
1883
|
+
|
|
1884
|
+
</dd>
|
|
1885
|
+
</dl>
|
|
1886
|
+
</dd>
|
|
1887
|
+
</dl>
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
</dd>
|
|
1891
|
+
</dl>
|
|
1892
|
+
</details>
|
|
1893
|
+
|
|
1894
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">update</a>(id, { ...params }) -> Phonic.ApiKeysUpdateResponse</code></summary>
|
|
1895
|
+
<dl>
|
|
1896
|
+
<dd>
|
|
1897
|
+
|
|
1898
|
+
#### 📝 Description
|
|
1899
|
+
|
|
1900
|
+
<dl>
|
|
1901
|
+
<dd>
|
|
1902
|
+
|
|
1903
|
+
<dl>
|
|
1904
|
+
<dd>
|
|
1905
|
+
|
|
1906
|
+
Updates an API key.
|
|
1907
|
+
</dd>
|
|
1908
|
+
</dl>
|
|
1909
|
+
</dd>
|
|
1910
|
+
</dl>
|
|
1911
|
+
|
|
1912
|
+
#### 🔌 Usage
|
|
1913
|
+
|
|
1914
|
+
<dl>
|
|
1915
|
+
<dd>
|
|
1916
|
+
|
|
1917
|
+
<dl>
|
|
1918
|
+
<dd>
|
|
1919
|
+
|
|
1920
|
+
```typescript
|
|
1921
|
+
await client.apiKeys.update("id", {
|
|
1922
|
+
name: "renamed-key"
|
|
1923
|
+
});
|
|
1924
|
+
|
|
1925
|
+
```
|
|
1926
|
+
</dd>
|
|
1927
|
+
</dl>
|
|
1928
|
+
</dd>
|
|
1929
|
+
</dl>
|
|
1930
|
+
|
|
1931
|
+
#### ⚙️ Parameters
|
|
1932
|
+
|
|
1933
|
+
<dl>
|
|
1934
|
+
<dd>
|
|
1935
|
+
|
|
1936
|
+
<dl>
|
|
1937
|
+
<dd>
|
|
1938
|
+
|
|
1939
|
+
**id:** `string` — The ID of the API key to update.
|
|
1940
|
+
|
|
1941
|
+
</dd>
|
|
1942
|
+
</dl>
|
|
1943
|
+
|
|
1944
|
+
<dl>
|
|
1945
|
+
<dd>
|
|
1946
|
+
|
|
1947
|
+
**request:** `Phonic.UpdateApiKeyRequest`
|
|
1948
|
+
|
|
1949
|
+
</dd>
|
|
1950
|
+
</dl>
|
|
1951
|
+
|
|
1952
|
+
<dl>
|
|
1953
|
+
<dd>
|
|
1954
|
+
|
|
1955
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
1956
|
+
|
|
1957
|
+
</dd>
|
|
1958
|
+
</dl>
|
|
1959
|
+
</dd>
|
|
1960
|
+
</dl>
|
|
1961
|
+
|
|
1962
|
+
|
|
1963
|
+
</dd>
|
|
1964
|
+
</dl>
|
|
1965
|
+
</details>
|
|
1966
|
+
|
|
1967
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">rotate</a>(id) -> Phonic.ApiKeyWithSecret</code></summary>
|
|
1968
|
+
<dl>
|
|
1969
|
+
<dd>
|
|
1970
|
+
|
|
1971
|
+
#### 📝 Description
|
|
1972
|
+
|
|
1973
|
+
<dl>
|
|
1974
|
+
<dd>
|
|
1975
|
+
|
|
1976
|
+
<dl>
|
|
1977
|
+
<dd>
|
|
1978
|
+
|
|
1979
|
+
Rotates an API key, generating a new secret and invalidating the old one.
|
|
1980
|
+
</dd>
|
|
1981
|
+
</dl>
|
|
1982
|
+
</dd>
|
|
1983
|
+
</dl>
|
|
1984
|
+
|
|
1985
|
+
#### 🔌 Usage
|
|
1986
|
+
|
|
1987
|
+
<dl>
|
|
1988
|
+
<dd>
|
|
1989
|
+
|
|
1990
|
+
<dl>
|
|
1991
|
+
<dd>
|
|
1992
|
+
|
|
1993
|
+
```typescript
|
|
1994
|
+
await client.apiKeys.rotate("id");
|
|
1995
|
+
|
|
1996
|
+
```
|
|
1997
|
+
</dd>
|
|
1998
|
+
</dl>
|
|
1999
|
+
</dd>
|
|
2000
|
+
</dl>
|
|
2001
|
+
|
|
2002
|
+
#### ⚙️ Parameters
|
|
2003
|
+
|
|
2004
|
+
<dl>
|
|
2005
|
+
<dd>
|
|
2006
|
+
|
|
2007
|
+
<dl>
|
|
2008
|
+
<dd>
|
|
2009
|
+
|
|
2010
|
+
**id:** `string` — The ID of the API key to rotate.
|
|
2011
|
+
|
|
2012
|
+
</dd>
|
|
2013
|
+
</dl>
|
|
2014
|
+
|
|
2015
|
+
<dl>
|
|
2016
|
+
<dd>
|
|
2017
|
+
|
|
2018
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
2019
|
+
|
|
2020
|
+
</dd>
|
|
2021
|
+
</dl>
|
|
2022
|
+
</dd>
|
|
2023
|
+
</dl>
|
|
2024
|
+
|
|
2025
|
+
|
|
1693
2026
|
</dd>
|
|
1694
2027
|
</dl>
|
|
1695
2028
|
</details>
|
|
@@ -2232,7 +2565,7 @@ await client.conversations.listEvaluations("id");
|
|
|
2232
2565
|
</dl>
|
|
2233
2566
|
</details>
|
|
2234
2567
|
|
|
2235
|
-
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">evaluate</a>(id, { ...params }) -> Phonic.
|
|
2568
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">evaluate</a>(id, { ...params }) -> Phonic.ConversationsEvaluateResponse</code></summary>
|
|
2236
2569
|
<dl>
|
|
2237
2570
|
<dd>
|
|
2238
2571
|
|
|
@@ -2459,6 +2792,82 @@ await client.conversations.sipOutboundCall({
|
|
|
2459
2792
|
</dl>
|
|
2460
2793
|
|
|
2461
2794
|
|
|
2795
|
+
</dd>
|
|
2796
|
+
</dl>
|
|
2797
|
+
</details>
|
|
2798
|
+
|
|
2799
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">replay</a>(id, { ...params }) -> Phonic.ConversationsReplayResponse</code></summary>
|
|
2800
|
+
<dl>
|
|
2801
|
+
<dd>
|
|
2802
|
+
|
|
2803
|
+
#### 📝 Description
|
|
2804
|
+
|
|
2805
|
+
<dl>
|
|
2806
|
+
<dd>
|
|
2807
|
+
|
|
2808
|
+
<dl>
|
|
2809
|
+
<dd>
|
|
2810
|
+
|
|
2811
|
+
Replays an ended conversation by re-running its recorded audio through an
|
|
2812
|
+
agent. Requires API key or access token authentication. The conversation must
|
|
2813
|
+
have audio recordings available and an associated agent (or one specified in
|
|
2814
|
+
the request body).
|
|
2815
|
+
</dd>
|
|
2816
|
+
</dl>
|
|
2817
|
+
</dd>
|
|
2818
|
+
</dl>
|
|
2819
|
+
|
|
2820
|
+
#### 🔌 Usage
|
|
2821
|
+
|
|
2822
|
+
<dl>
|
|
2823
|
+
<dd>
|
|
2824
|
+
|
|
2825
|
+
<dl>
|
|
2826
|
+
<dd>
|
|
2827
|
+
|
|
2828
|
+
```typescript
|
|
2829
|
+
await client.conversations.replay("id", {
|
|
2830
|
+
agent: "support-agent"
|
|
2831
|
+
});
|
|
2832
|
+
|
|
2833
|
+
```
|
|
2834
|
+
</dd>
|
|
2835
|
+
</dl>
|
|
2836
|
+
</dd>
|
|
2837
|
+
</dl>
|
|
2838
|
+
|
|
2839
|
+
#### ⚙️ Parameters
|
|
2840
|
+
|
|
2841
|
+
<dl>
|
|
2842
|
+
<dd>
|
|
2843
|
+
|
|
2844
|
+
<dl>
|
|
2845
|
+
<dd>
|
|
2846
|
+
|
|
2847
|
+
**id:** `string` — The ID of the conversation to replay.
|
|
2848
|
+
|
|
2849
|
+
</dd>
|
|
2850
|
+
</dl>
|
|
2851
|
+
|
|
2852
|
+
<dl>
|
|
2853
|
+
<dd>
|
|
2854
|
+
|
|
2855
|
+
**request:** `Phonic.ReplayConversationRequest`
|
|
2856
|
+
|
|
2857
|
+
</dd>
|
|
2858
|
+
</dl>
|
|
2859
|
+
|
|
2860
|
+
<dl>
|
|
2861
|
+
<dd>
|
|
2862
|
+
|
|
2863
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2864
|
+
|
|
2865
|
+
</dd>
|
|
2866
|
+
</dl>
|
|
2867
|
+
</dd>
|
|
2868
|
+
</dl>
|
|
2869
|
+
|
|
2870
|
+
|
|
2462
2871
|
</dd>
|
|
2463
2872
|
</dl>
|
|
2464
2873
|
</details>
|
|
@@ -2525,6 +2934,72 @@ await client.auth.createSessionToken({
|
|
|
2525
2934
|
</dl>
|
|
2526
2935
|
|
|
2527
2936
|
|
|
2937
|
+
</dd>
|
|
2938
|
+
</dl>
|
|
2939
|
+
</details>
|
|
2940
|
+
|
|
2941
|
+
<details><summary><code>client.auth.<a href="/src/api/resources/auth/client/Client.ts">createConversationToken</a>({ ...params }) -> Phonic.AuthCreateConversationTokenResponse</code></summary>
|
|
2942
|
+
<dl>
|
|
2943
|
+
<dd>
|
|
2944
|
+
|
|
2945
|
+
#### 📝 Description
|
|
2946
|
+
|
|
2947
|
+
<dl>
|
|
2948
|
+
<dd>
|
|
2949
|
+
|
|
2950
|
+
<dl>
|
|
2951
|
+
<dd>
|
|
2952
|
+
|
|
2953
|
+
Creates a short-lived conversation token scoped to a specific agent. Conversation tokens are useful for client-side applications that start a conversation with a single agent without exposing your API key.
|
|
2954
|
+
</dd>
|
|
2955
|
+
</dl>
|
|
2956
|
+
</dd>
|
|
2957
|
+
</dl>
|
|
2958
|
+
|
|
2959
|
+
#### 🔌 Usage
|
|
2960
|
+
|
|
2961
|
+
<dl>
|
|
2962
|
+
<dd>
|
|
2963
|
+
|
|
2964
|
+
<dl>
|
|
2965
|
+
<dd>
|
|
2966
|
+
|
|
2967
|
+
```typescript
|
|
2968
|
+
await client.auth.createConversationToken({
|
|
2969
|
+
agent_id: "agent_12cf6e88-c254-4d3e-a149-a7f1bdd22783",
|
|
2970
|
+
ttl_seconds: 30
|
|
2971
|
+
});
|
|
2972
|
+
|
|
2973
|
+
```
|
|
2974
|
+
</dd>
|
|
2975
|
+
</dl>
|
|
2976
|
+
</dd>
|
|
2977
|
+
</dl>
|
|
2978
|
+
|
|
2979
|
+
#### ⚙️ Parameters
|
|
2980
|
+
|
|
2981
|
+
<dl>
|
|
2982
|
+
<dd>
|
|
2983
|
+
|
|
2984
|
+
<dl>
|
|
2985
|
+
<dd>
|
|
2986
|
+
|
|
2987
|
+
**request:** `Phonic.CreateConversationTokenRequest`
|
|
2988
|
+
|
|
2989
|
+
</dd>
|
|
2990
|
+
</dl>
|
|
2991
|
+
|
|
2992
|
+
<dl>
|
|
2993
|
+
<dd>
|
|
2994
|
+
|
|
2995
|
+
**requestOptions:** `AuthClient.RequestOptions`
|
|
2996
|
+
|
|
2997
|
+
</dd>
|
|
2998
|
+
</dl>
|
|
2999
|
+
</dd>
|
|
3000
|
+
</dl>
|
|
3001
|
+
|
|
3002
|
+
|
|
2528
3003
|
</dd>
|
|
2529
3004
|
</dl>
|
|
2530
3005
|
</details>
|
|
@@ -3053,3 +3528,66 @@ await client.projects.createEvalPrompt("id", {
|
|
|
3053
3528
|
</dl>
|
|
3054
3529
|
</details>
|
|
3055
3530
|
|
|
3531
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">listEvals</a>(id) -> Phonic.ProjectsListEvalsResponse</code></summary>
|
|
3532
|
+
<dl>
|
|
3533
|
+
<dd>
|
|
3534
|
+
|
|
3535
|
+
#### 📝 Description
|
|
3536
|
+
|
|
3537
|
+
<dl>
|
|
3538
|
+
<dd>
|
|
3539
|
+
|
|
3540
|
+
<dl>
|
|
3541
|
+
<dd>
|
|
3542
|
+
|
|
3543
|
+
Returns all conversation evaluation results for a project.
|
|
3544
|
+
</dd>
|
|
3545
|
+
</dl>
|
|
3546
|
+
</dd>
|
|
3547
|
+
</dl>
|
|
3548
|
+
|
|
3549
|
+
#### 🔌 Usage
|
|
3550
|
+
|
|
3551
|
+
<dl>
|
|
3552
|
+
<dd>
|
|
3553
|
+
|
|
3554
|
+
<dl>
|
|
3555
|
+
<dd>
|
|
3556
|
+
|
|
3557
|
+
```typescript
|
|
3558
|
+
await client.projects.listEvals("id");
|
|
3559
|
+
|
|
3560
|
+
```
|
|
3561
|
+
</dd>
|
|
3562
|
+
</dl>
|
|
3563
|
+
</dd>
|
|
3564
|
+
</dl>
|
|
3565
|
+
|
|
3566
|
+
#### ⚙️ Parameters
|
|
3567
|
+
|
|
3568
|
+
<dl>
|
|
3569
|
+
<dd>
|
|
3570
|
+
|
|
3571
|
+
<dl>
|
|
3572
|
+
<dd>
|
|
3573
|
+
|
|
3574
|
+
**id:** `string` — The ID of the project.
|
|
3575
|
+
|
|
3576
|
+
</dd>
|
|
3577
|
+
</dl>
|
|
3578
|
+
|
|
3579
|
+
<dl>
|
|
3580
|
+
<dd>
|
|
3581
|
+
|
|
3582
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
3583
|
+
|
|
3584
|
+
</dd>
|
|
3585
|
+
</dl>
|
|
3586
|
+
</dd>
|
|
3587
|
+
</dl>
|
|
3588
|
+
|
|
3589
|
+
|
|
3590
|
+
</dd>
|
|
3591
|
+
</dl>
|
|
3592
|
+
</details>
|
|
3593
|
+
|