phonic 0.32.20 → 0.32.22

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 (116) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/Client.d.ts +3 -0
  3. package/dist/cjs/Client.js +13 -8
  4. package/dist/cjs/api/errors/BadGatewayError.d.ts +6 -0
  5. package/dist/cjs/api/errors/BadGatewayError.js +54 -0
  6. package/dist/cjs/api/errors/index.d.ts +1 -0
  7. package/dist/cjs/api/errors/index.js +1 -0
  8. package/dist/cjs/api/resources/agents/client/requests/AgentsCreateRequest.d.ts +2 -0
  9. package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.d.ts +2 -0
  10. package/dist/cjs/api/resources/conversations/client/Client.d.ts +3 -0
  11. package/dist/cjs/api/resources/conversations/client/Client.js +9 -0
  12. package/dist/cjs/api/resources/index.d.ts +2 -0
  13. package/dist/cjs/api/resources/index.js +3 -1
  14. package/dist/cjs/api/resources/responses/client/Client.d.ts +72 -0
  15. package/dist/cjs/api/resources/responses/client/Client.js +169 -0
  16. package/dist/cjs/api/resources/responses/client/index.d.ts +1 -0
  17. package/dist/cjs/api/resources/responses/client/index.js +17 -0
  18. package/dist/cjs/api/resources/responses/client/requests/GenerateResponsesRequest.d.ts +46 -0
  19. package/dist/cjs/api/resources/responses/client/requests/GenerateResponsesRequest.js +3 -0
  20. package/dist/cjs/api/resources/responses/client/requests/index.d.ts +1 -0
  21. package/dist/cjs/api/resources/responses/client/requests/index.js +2 -0
  22. package/dist/cjs/api/resources/responses/exports.d.ts +2 -0
  23. package/dist/cjs/api/resources/responses/exports.js +21 -0
  24. package/dist/cjs/api/resources/responses/index.d.ts +1 -0
  25. package/dist/cjs/api/resources/responses/index.js +17 -0
  26. package/dist/cjs/api/resources/tools/client/requests/CreateToolRequest.d.ts +3 -1
  27. package/dist/cjs/api/resources/tools/client/requests/UpdateToolRequest.d.ts +3 -1
  28. package/dist/cjs/api/types/Agent.d.ts +2 -0
  29. package/dist/cjs/api/types/ConfigOptions.d.ts +2 -0
  30. package/dist/cjs/api/types/ConflictErrorBody.d.ts +2 -0
  31. package/dist/cjs/api/types/ConflictErrorBody.js +3 -0
  32. package/dist/cjs/api/types/Conversation.d.ts +2 -0
  33. package/dist/cjs/api/types/CreateAgentRequest.d.ts +2 -0
  34. package/dist/cjs/api/types/GenerateResponsesResponse.d.ts +5 -0
  35. package/dist/cjs/api/types/GenerateResponsesResponse.js +3 -0
  36. package/dist/cjs/api/types/GeneratedResponse.d.ts +7 -0
  37. package/dist/cjs/api/types/GeneratedResponse.js +3 -0
  38. package/dist/cjs/api/types/GeneratedToolCall.d.ts +10 -0
  39. package/dist/cjs/api/types/GeneratedToolCall.js +3 -0
  40. package/dist/cjs/api/types/OutboundCallConfig.d.ts +2 -0
  41. package/dist/cjs/api/types/ResponsesAssistantMessage.d.ts +11 -0
  42. package/dist/cjs/api/types/ResponsesAssistantMessage.js +3 -0
  43. package/dist/cjs/api/types/ResponsesInputItem.d.ts +5 -0
  44. package/dist/cjs/api/types/ResponsesInputItem.js +3 -0
  45. package/dist/cjs/api/types/ResponsesToolCall.d.ts +13 -0
  46. package/dist/cjs/api/types/ResponsesToolCall.js +3 -0
  47. package/dist/cjs/api/types/ResponsesToolCallOutput.d.ts +24 -0
  48. package/dist/cjs/api/types/ResponsesToolCallOutput.js +3 -0
  49. package/dist/cjs/api/types/ResponsesToolDefinition.d.ts +11 -0
  50. package/dist/cjs/api/types/ResponsesToolDefinition.js +3 -0
  51. package/dist/cjs/api/types/ResponsesUserMessage.d.ts +8 -0
  52. package/dist/cjs/api/types/ResponsesUserMessage.js +3 -0
  53. package/dist/cjs/api/types/Tool.d.ts +3 -1
  54. package/dist/cjs/api/types/index.d.ts +10 -0
  55. package/dist/cjs/api/types/index.js +10 -0
  56. package/dist/cjs/version.d.ts +1 -1
  57. package/dist/cjs/version.js +1 -1
  58. package/dist/esm/BaseClient.mjs +2 -2
  59. package/dist/esm/Client.d.mts +3 -0
  60. package/dist/esm/Client.mjs +5 -0
  61. package/dist/esm/api/errors/BadGatewayError.d.mts +6 -0
  62. package/dist/esm/api/errors/BadGatewayError.mjs +17 -0
  63. package/dist/esm/api/errors/index.d.mts +1 -0
  64. package/dist/esm/api/errors/index.mjs +1 -0
  65. package/dist/esm/api/resources/agents/client/requests/AgentsCreateRequest.d.mts +2 -0
  66. package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.d.mts +2 -0
  67. package/dist/esm/api/resources/conversations/client/Client.d.mts +3 -0
  68. package/dist/esm/api/resources/conversations/client/Client.mjs +9 -0
  69. package/dist/esm/api/resources/index.d.mts +2 -0
  70. package/dist/esm/api/resources/index.mjs +2 -0
  71. package/dist/esm/api/resources/responses/client/Client.d.mts +72 -0
  72. package/dist/esm/api/resources/responses/client/Client.mjs +132 -0
  73. package/dist/esm/api/resources/responses/client/index.d.mts +1 -0
  74. package/dist/esm/api/resources/responses/client/index.mjs +1 -0
  75. package/dist/esm/api/resources/responses/client/requests/GenerateResponsesRequest.d.mts +46 -0
  76. package/dist/esm/api/resources/responses/client/requests/GenerateResponsesRequest.mjs +2 -0
  77. package/dist/esm/api/resources/responses/client/requests/index.d.mts +1 -0
  78. package/dist/esm/api/resources/responses/client/requests/index.mjs +1 -0
  79. package/dist/esm/api/resources/responses/exports.d.mts +2 -0
  80. package/dist/esm/api/resources/responses/exports.mjs +3 -0
  81. package/dist/esm/api/resources/responses/index.d.mts +1 -0
  82. package/dist/esm/api/resources/responses/index.mjs +1 -0
  83. package/dist/esm/api/resources/tools/client/requests/CreateToolRequest.d.mts +3 -1
  84. package/dist/esm/api/resources/tools/client/requests/UpdateToolRequest.d.mts +3 -1
  85. package/dist/esm/api/types/Agent.d.mts +2 -0
  86. package/dist/esm/api/types/ConfigOptions.d.mts +2 -0
  87. package/dist/esm/api/types/ConflictErrorBody.d.mts +2 -0
  88. package/dist/esm/api/types/ConflictErrorBody.mjs +2 -0
  89. package/dist/esm/api/types/Conversation.d.mts +2 -0
  90. package/dist/esm/api/types/CreateAgentRequest.d.mts +2 -0
  91. package/dist/esm/api/types/GenerateResponsesResponse.d.mts +5 -0
  92. package/dist/esm/api/types/GenerateResponsesResponse.mjs +2 -0
  93. package/dist/esm/api/types/GeneratedResponse.d.mts +7 -0
  94. package/dist/esm/api/types/GeneratedResponse.mjs +2 -0
  95. package/dist/esm/api/types/GeneratedToolCall.d.mts +10 -0
  96. package/dist/esm/api/types/GeneratedToolCall.mjs +2 -0
  97. package/dist/esm/api/types/OutboundCallConfig.d.mts +2 -0
  98. package/dist/esm/api/types/ResponsesAssistantMessage.d.mts +11 -0
  99. package/dist/esm/api/types/ResponsesAssistantMessage.mjs +2 -0
  100. package/dist/esm/api/types/ResponsesInputItem.d.mts +5 -0
  101. package/dist/esm/api/types/ResponsesInputItem.mjs +2 -0
  102. package/dist/esm/api/types/ResponsesToolCall.d.mts +13 -0
  103. package/dist/esm/api/types/ResponsesToolCall.mjs +2 -0
  104. package/dist/esm/api/types/ResponsesToolCallOutput.d.mts +24 -0
  105. package/dist/esm/api/types/ResponsesToolCallOutput.mjs +2 -0
  106. package/dist/esm/api/types/ResponsesToolDefinition.d.mts +11 -0
  107. package/dist/esm/api/types/ResponsesToolDefinition.mjs +2 -0
  108. package/dist/esm/api/types/ResponsesUserMessage.d.mts +8 -0
  109. package/dist/esm/api/types/ResponsesUserMessage.mjs +2 -0
  110. package/dist/esm/api/types/Tool.d.mts +3 -1
  111. package/dist/esm/api/types/index.d.mts +10 -0
  112. package/dist/esm/api/types/index.mjs +10 -0
  113. package/dist/esm/version.d.mts +1 -1
  114. package/dist/esm/version.mjs +1 -1
  115. package/package.json +12 -1
  116. package/reference.md +104 -0
@@ -205,13 +205,15 @@ export interface CreateToolRequest {
205
205
  phone_number?: string | null;
206
206
  /** DTMF digits to send after the transfer connects (e.g., "1234"). Defaults to null. Ignored when dynamic_dtmf is true. */
207
207
  dtmf?: string | null;
208
+ /** Fixed line the agent speaks into the bridged call once the transfer connects. Defaults to null, meaning no announcement. Must be null when keep_listening is false, since a SIP REFER transfer has no bridged call to speak it on. Only available for built_in_transfer_to_phone_number tools. */
209
+ post_transfer_message?: string | null;
208
210
  /** When true, the agent determines the DTMF digits at call time (and may choose to send none); the static dtmf is ignored. Only sent when use_agent_phone_number is true (not on a SIP REFER transfer). */
209
211
  dynamic_dtmf?: boolean;
210
212
  /** When true, Phonic will transfer the call using the agent's phone number. When false, Phonic will transfer the call using the phone number of the party to whom the agent is connected. This is only available for built_in_transfer_to_phone_number tools. */
211
213
  use_agent_phone_number?: boolean;
212
214
  /** When true, Phonic will listen in and tell the user if the transfer hits voicemail. This is only available for built_in_transfer_to_phone_number tools when use_agent_phone_number is true. */
213
215
  detect_voicemail?: boolean;
214
- /** When true, Phonic bridges the transfer and stays on the call. When false, the call is handed off with a SIP REFER and Phonic drops out, which requires use_agent_phone_number and detect_voicemail to be false, dtmf to be null and dynamic_dtmf to be false. Only available for built_in_transfer_to_phone_number tools. Defaults to the value of use_agent_phone_number. */
216
+ /** When true, Phonic bridges the transfer and stays on the call. When false, the call is handed off with a SIP REFER and Phonic drops out, which requires use_agent_phone_number and detect_voicemail to be false, dtmf and post_transfer_message to be null and dynamic_dtmf to be false. Only available for built_in_transfer_to_phone_number tools. Defaults to the value of use_agent_phone_number. */
215
217
  keep_listening?: boolean;
216
218
  /** Array of agent names that the LLM can choose from when transferring. Required for built_in_transfer_to_agent tools. All agents must exist in the same project as the tool. */
217
219
  agents_to_transfer_to?: string[];
@@ -45,13 +45,15 @@ export interface UpdateToolRequest {
45
45
  phone_number?: string | null;
46
46
  /** DTMF digits to send after the transfer connects (e.g., "1234"). Can be set to null to remove DTMF. Ignored when dynamic_dtmf is true. */
47
47
  dtmf?: string | null;
48
+ /** Fixed line the agent speaks into the bridged call once the transfer connects. Can be set to null to remove the announcement. Must be null when the resulting keep_listening is false. Only applicable to built_in_transfer_to_phone_number tools. */
49
+ post_transfer_message?: string | null;
48
50
  /** When true, the agent determines the DTMF digits at call time (and may choose to send none); the static dtmf is ignored. Only sent when use_agent_phone_number is true (not on a SIP REFER transfer). */
49
51
  dynamic_dtmf?: boolean;
50
52
  /** When true, Phonic will transfer the call using the agent's phone number. When false, Phonic will transfer the call using the phone number of the party to whom the agent is connected. This is only available for built_in_transfer_to_phone_number tools. */
51
53
  use_agent_phone_number?: boolean;
52
54
  /** When true, Phonic will listen in and tell the user if the transfer hits voicemail. This is only available for built_in_transfer_to_phone_number tools when use_agent_phone_number is true. */
53
55
  detect_voicemail?: boolean;
54
- /** When true, Phonic bridges the transfer and stays on the call. When false, the call is handed off with a SIP REFER and Phonic drops out, which requires the resulting use_agent_phone_number and detect_voicemail to be false, dtmf to be null and dynamic_dtmf to be false. Only applicable to built_in_transfer_to_phone_number tools. */
56
+ /** When true, Phonic bridges the transfer and stays on the call. When false, the call is handed off with a SIP REFER and Phonic drops out, which requires the resulting use_agent_phone_number and detect_voicemail to be false, dtmf and post_transfer_message to be null and dynamic_dtmf to be false. Only applicable to built_in_transfer_to_phone_number tools. */
55
57
  keep_listening?: boolean;
56
58
  /** Array of agent names that the LLM can choose from when transferring. All agents must exist in the same project as the tool. */
57
59
  agents_to_transfer_to?: string[];
@@ -86,6 +86,8 @@ export interface Agent {
86
86
  vad_threshold?: number | undefined;
87
87
  /** When `true`, PII and PHI are redacted from text transcripts (e.g. replaced with tags like `[PHONE]`) and bleeped from audio recordings after the conversation ends. */
88
88
  enable_redaction?: boolean | undefined;
89
+ /** When `true`, an inaudible watermark is embedded in the audio the agent generates. */
90
+ enable_watermarking?: boolean | undefined;
89
91
  /** The URL-friendly slug of the agent. */
90
92
  slug?: string | undefined;
91
93
  /** When `true`, the assistant emits backchannel cues (e.g. "mm-hmm") while the user is speaking. */
@@ -71,6 +71,8 @@ export interface ConfigOptions {
71
71
  template_variables?: Record<string, string> | undefined;
72
72
  /** When `true`, PII and PHI are redacted from text transcripts (e.g. replaced with tags like `[PHONE]`) and bleeped from audio recordings after the conversation ends. */
73
73
  enable_redaction?: boolean | undefined;
74
+ /** When `true`, an inaudible watermark is embedded in the audio the assistant generates. */
75
+ enable_watermarking?: boolean | undefined;
74
76
  /** Names of pre-configured MCP servers to make available to the assistant. Names must be unique. */
75
77
  mcp_servers?: string[] | undefined;
76
78
  /** Names of observability integrations to enable for the conversation. Each must be one of the supported providers. */
@@ -0,0 +1,2 @@
1
+ import type * as Phonic from "../index.js";
2
+ export type ConflictErrorBody = Phonic.SipCallError | Phonic.BasicError;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -94,6 +94,8 @@ export interface Conversation {
94
94
  redacted_transcript?: (string | null) | undefined;
95
95
  /** Arbitrary metadata associated with the conversation. */
96
96
  metadata?: (Record<string, unknown> | null) | undefined;
97
+ /** Whether an inaudible watermark was embedded in the audio the agent generated during the conversation. */
98
+ enable_watermarking?: boolean | undefined;
97
99
  /** Controls how long transcripts and audio recordings are retained before deletion. */
98
100
  data_retention_policy?: Phonic.DataRetentionPolicy | undefined;
99
101
  /** Information about when transcripts and audio recordings are or were scheduled to be deleted. */
@@ -88,6 +88,8 @@ export interface CreateAgentRequest {
88
88
  vad_threshold?: number | undefined;
89
89
  /** When `true`, PII and PHI are redacted from text transcripts (e.g. replaced with tags like `[PHONE]`) and bleeped from audio recordings after the conversation ends. */
90
90
  enable_redaction?: boolean | undefined;
91
+ /** When `true`, an inaudible watermark is embedded in the audio the agent generates. */
92
+ enable_watermarking?: boolean | undefined;
91
93
  /** Array of MCP server IDs to make available to the agent. */
92
94
  mcp_server_ids?: string[] | undefined;
93
95
  /** Names of observability integrations to enable for the agent. Each must be one of the supported providers. */
@@ -0,0 +1,5 @@
1
+ import type * as Phonic from "../index.js";
2
+ export interface GenerateResponsesResponse {
3
+ /** The generated responses - always `num_responses` of them. */
4
+ responses: Phonic.GeneratedResponse[];
5
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ import type * as Phonic from "../index.js";
2
+ export interface GeneratedResponse {
3
+ /** The text the assistant would say. Empty when the response only makes tool calls. */
4
+ text: string;
5
+ /** Tool calls the assistant would make - note that the tools are not actually called. */
6
+ tool_calls: Phonic.GeneratedToolCall[];
7
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,10 @@
1
+ export interface GeneratedToolCall {
2
+ /** Identifier for this tool call. Send it back as the `tool_call_id` of the matching `tool_call_output` input item. */
3
+ tool_call_id: string;
4
+ /** Name of the tool to call. Always one of the `tool_definitions` from the request. */
5
+ tool_name: string;
6
+ /** Arguments the assistant produced for the request body. */
7
+ request_body?: Record<string, unknown> | undefined;
8
+ /** Arguments the assistant produced as query parameters. */
9
+ query_params?: Record<string, string> | undefined;
10
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -49,6 +49,8 @@ export interface OutboundCallConfig {
49
49
  tools?: OutboundCallConfig.Tools.Item[] | undefined;
50
50
  /** When `true`, PII and PHI are redacted from text transcripts (e.g. replaced with tags like `[PHONE]`) and bleeped from audio recordings after the conversation ends. */
51
51
  enable_redaction?: boolean | undefined;
52
+ /** When `true`, an inaudible watermark is embedded in the audio the agent generates. */
53
+ enable_watermarking?: boolean | undefined;
52
54
  /** The speech-to-speech model to use. */
53
55
  model?: "merritt" | undefined;
54
56
  /** The audio speed of the agent. */
@@ -0,0 +1,11 @@
1
+ import type * as Phonic from "../index.js";
2
+ /**
3
+ * An assistant turn. Must carry `text`, `tool_calls`, or both.
4
+ */
5
+ export interface ResponsesAssistantMessage {
6
+ role: "assistant";
7
+ /** What the assistant said. Empty when the turn only made tool calls. */
8
+ text: string;
9
+ /** Tool calls the assistant made on this turn. Each one must be followed immediately by its matching `tool_call_output` item. */
10
+ tool_calls?: Phonic.ResponsesToolCall[] | undefined;
11
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,5 @@
1
+ import type * as Phonic from "../index.js";
2
+ /**
3
+ * One item of conversation history - a user message, an assistant message, or the output of an assistant tool call.
4
+ */
5
+ export type ResponsesInputItem = Phonic.ResponsesUserMessage | Phonic.ResponsesAssistantMessage | Phonic.ResponsesToolCallOutput;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,13 @@
1
+ /**
2
+ * A tool call the assistant made earlier in the conversation.
3
+ */
4
+ export interface ResponsesToolCall {
5
+ /** Identifier for this tool call, unique within `input`. */
6
+ tool_call_id: string;
7
+ /** Name of the called tool. */
8
+ tool_name: string;
9
+ /** Arguments the assistant passed in the request body. */
10
+ request_body?: (Record<string, unknown> | null) | undefined;
11
+ /** Arguments the assistant passed as query parameters. An argument cannot appear in both `request_body` and `query_params`. */
12
+ query_params?: (Record<string, string | null> | null) | undefined;
13
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,24 @@
1
+ /**
2
+ * The result of an assistant tool call. Must record an outcome through `response_body`, `response_status_code`, `error_message`, `timed_out`, or `interrupted`.
3
+ */
4
+ export interface ResponsesToolCallOutput {
5
+ type: "tool_call_output";
6
+ /** The `tool_call_id` of the assistant tool call this output belongs to. */
7
+ tool_call_id: string;
8
+ /** The value the tool returned. Can be any JSON-serializable value. */
9
+ response_body?: (ResponsesToolCallOutput.ResponseBody | null) | undefined;
10
+ /** HTTP status code the tool returned, for tools called over HTTP. */
11
+ response_status_code?: (number | null) | undefined;
12
+ /** Whether the tool call timed out. */
13
+ timed_out?: boolean | undefined;
14
+ /** The error the tool call failed with. */
15
+ error_message?: (string | null) | undefined;
16
+ /** Whether the tool call was interrupted before it finished. */
17
+ interrupted?: boolean | undefined;
18
+ }
19
+ export declare namespace ResponsesToolCallOutput {
20
+ /**
21
+ * The value the tool returned. Can be any JSON-serializable value.
22
+ */
23
+ type ResponseBody = Record<string, unknown> | unknown[] | string | number | boolean;
24
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,11 @@
1
+ import type * as Phonic from "../index.js";
2
+ /**
3
+ * A tool the assistant may call, defined inline for this request only.
4
+ */
5
+ export interface ResponsesToolDefinition {
6
+ /** The tool name. */
7
+ name: string;
8
+ /** What the tool does. The model uses this to decide when to call it. */
9
+ description: string;
10
+ parameters: Phonic.ToolParametersJsonSchema;
11
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Something the user said.
3
+ */
4
+ export interface ResponsesUserMessage {
5
+ role: "user";
6
+ /** What the user said. */
7
+ text: string;
8
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -36,13 +36,15 @@ export interface Tool {
36
36
  phone_number?: (string | null) | undefined;
37
37
  /** DTMF digits to send after the transfer connects (e.g., "1234"). Defaults to null. Ignored when dynamic_dtmf is true. */
38
38
  dtmf?: (string | null) | undefined;
39
+ /** Fixed line the agent speaks into the bridged call once the transfer connects. Defaults to null, meaning no announcement. Always null when keep_listening is false. Only returned for built_in_transfer_to_phone_number tools. */
40
+ post_transfer_message?: (string | null) | undefined;
39
41
  /** When true, the agent determines the DTMF digits at call time (and may choose to send none); the static dtmf is ignored. Only sent when use_agent_phone_number is true (not on a SIP REFER transfer). */
40
42
  dynamic_dtmf?: boolean | undefined;
41
43
  /** When true, Phonic will transfer the call using the agent's phone number. When false, Phonic will transfer the call using the phone number of the party to whom the agent is connected. This is only available for built_in_transfer_to_phone_number tools. */
42
44
  use_agent_phone_number?: boolean | undefined;
43
45
  /** When true, Phonic will listen in and tell the user if the transfer hits voicemail. This is only available for built_in_transfer_to_phone_number tools when use_agent_phone_number is true. */
44
46
  detect_voicemail?: boolean | undefined;
45
- /** When true, Phonic bridges the transfer and stays on the call. When false, the call is handed off with a SIP REFER and Phonic drops out, so use_agent_phone_number, detect_voicemail and dynamic_dtmf are false and dtmf is null. Only returned for built_in_transfer_to_phone_number tools. */
47
+ /** When true, Phonic bridges the transfer and stays on the call. When false, the call is handed off with a SIP REFER and Phonic drops out, so use_agent_phone_number, detect_voicemail and dynamic_dtmf are false and dtmf and post_transfer_message are null. Only returned for built_in_transfer_to_phone_number tools. */
46
48
  keep_listening?: boolean | undefined;
47
49
  /** Array of agent names that the LLM can choose from when transferring. Required for built_in_transfer_to_agent tools. */
48
50
  agents_to_transfer_to?: string[] | undefined;
@@ -16,6 +16,7 @@ export * from "./BuiltInToolDefinition.js";
16
16
  export * from "./ChooseNotToRespondToolConfig.js";
17
17
  export * from "./ConfigOptions.js";
18
18
  export * from "./ConfigPayload.js";
19
+ export * from "./ConflictErrorBody.js";
19
20
  export * from "./Conversation.js";
20
21
  export * from "./ConversationAnalysis.js";
21
22
  export * from "./ConversationCreatedPayload.js";
@@ -37,7 +38,10 @@ export * from "./ErrorPayload.js";
37
38
  export * from "./ExternalStoragePolicy.js";
38
39
  export * from "./ExtractionField.js";
39
40
  export * from "./ExtractionSchema.js";
41
+ export * from "./GeneratedResponse.js";
42
+ export * from "./GeneratedToolCall.js";
40
43
  export * from "./GenerateReplyPayload.js";
44
+ export * from "./GenerateResponsesResponse.js";
41
45
  export * from "./InlineWebSocketTool.js";
42
46
  export * from "./InputCancelledPayload.js";
43
47
  export * from "./InputTextPayload.js";
@@ -55,6 +59,12 @@ export * from "./ReadyToStartConversationPayload.js";
55
59
  export * from "./ReplayConversationItemResponse.js";
56
60
  export * from "./ReplayToolCall.js";
57
61
  export * from "./ResetPayload.js";
62
+ export * from "./ResponsesAssistantMessage.js";
63
+ export * from "./ResponsesInputItem.js";
64
+ export * from "./ResponsesToolCall.js";
65
+ export * from "./ResponsesToolCallOutput.js";
66
+ export * from "./ResponsesToolDefinition.js";
67
+ export * from "./ResponsesUserMessage.js";
58
68
  export * from "./SayPayload.js";
59
69
  export * from "./SetExternalIdPayload.js";
60
70
  export * from "./SipCallError.js";
@@ -32,6 +32,7 @@ __exportStar(require("./BuiltInToolDefinition.js"), exports);
32
32
  __exportStar(require("./ChooseNotToRespondToolConfig.js"), exports);
33
33
  __exportStar(require("./ConfigOptions.js"), exports);
34
34
  __exportStar(require("./ConfigPayload.js"), exports);
35
+ __exportStar(require("./ConflictErrorBody.js"), exports);
35
36
  __exportStar(require("./Conversation.js"), exports);
36
37
  __exportStar(require("./ConversationAnalysis.js"), exports);
37
38
  __exportStar(require("./ConversationCreatedPayload.js"), exports);
@@ -53,7 +54,10 @@ __exportStar(require("./ErrorPayload.js"), exports);
53
54
  __exportStar(require("./ExternalStoragePolicy.js"), exports);
54
55
  __exportStar(require("./ExtractionField.js"), exports);
55
56
  __exportStar(require("./ExtractionSchema.js"), exports);
57
+ __exportStar(require("./GeneratedResponse.js"), exports);
58
+ __exportStar(require("./GeneratedToolCall.js"), exports);
56
59
  __exportStar(require("./GenerateReplyPayload.js"), exports);
60
+ __exportStar(require("./GenerateResponsesResponse.js"), exports);
57
61
  __exportStar(require("./InlineWebSocketTool.js"), exports);
58
62
  __exportStar(require("./InputCancelledPayload.js"), exports);
59
63
  __exportStar(require("./InputTextPayload.js"), exports);
@@ -71,6 +75,12 @@ __exportStar(require("./ReadyToStartConversationPayload.js"), exports);
71
75
  __exportStar(require("./ReplayConversationItemResponse.js"), exports);
72
76
  __exportStar(require("./ReplayToolCall.js"), exports);
73
77
  __exportStar(require("./ResetPayload.js"), exports);
78
+ __exportStar(require("./ResponsesAssistantMessage.js"), exports);
79
+ __exportStar(require("./ResponsesInputItem.js"), exports);
80
+ __exportStar(require("./ResponsesToolCall.js"), exports);
81
+ __exportStar(require("./ResponsesToolCallOutput.js"), exports);
82
+ __exportStar(require("./ResponsesToolDefinition.js"), exports);
83
+ __exportStar(require("./ResponsesUserMessage.js"), exports);
74
84
  __exportStar(require("./SayPayload.js"), exports);
75
85
  __exportStar(require("./SetExternalIdPayload.js"), exports);
76
86
  __exportStar(require("./SipCallError.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.32.20";
1
+ export declare const SDK_VERSION = "0.32.22";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.32.20";
4
+ exports.SDK_VERSION = "0.32.22";
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
6
6
  const headers = mergeHeaders({
7
7
  "X-Fern-Language": "JavaScript",
8
8
  "X-Fern-SDK-Name": "phonic",
9
- "X-Fern-SDK-Version": "0.32.20",
10
- "User-Agent": "phonic/0.32.20",
9
+ "X-Fern-SDK-Version": "0.32.22",
10
+ "User-Agent": "phonic/0.32.22",
11
11
  "X-Fern-Runtime": core.RUNTIME.type,
12
12
  "X-Fern-Runtime-Version": core.RUNTIME.version,
13
13
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -6,6 +6,7 @@ import { ConversationsClient } from "./api/resources/conversations/client/Client
6
6
  import { ExternalStoragePoliciesClient } from "./api/resources/externalStoragePolicies/client/Client.mjs";
7
7
  import { ExtractionSchemasClient } from "./api/resources/extractionSchemas/client/Client.mjs";
8
8
  import { ProjectsClient } from "./api/resources/projects/client/Client.mjs";
9
+ import { ResponsesClient } from "./api/resources/responses/client/Client.mjs";
9
10
  import { ToolsClient } from "./api/resources/tools/client/Client.mjs";
10
11
  import { TtsClient } from "./api/resources/tts/client/Client.mjs";
11
12
  import { VoicesClient } from "./api/resources/voices/client/Client.mjs";
@@ -39,6 +40,7 @@ export declare class PhonicClient {
39
40
  protected _conversationItems: ConversationItemsClient | undefined;
40
41
  protected _auth: AuthClient | undefined;
41
42
  protected _projects: ProjectsClient | undefined;
43
+ protected _responses: ResponsesClient | undefined;
42
44
  protected _workspace: WorkspaceClient | undefined;
43
45
  protected _externalStoragePolicies: ExternalStoragePoliciesClient | undefined;
44
46
  constructor(options?: PhonicClient.Options);
@@ -52,6 +54,7 @@ export declare class PhonicClient {
52
54
  get conversationItems(): ConversationItemsClient;
53
55
  get auth(): AuthClient;
54
56
  get projects(): ProjectsClient;
57
+ get responses(): ResponsesClient;
55
58
  get workspace(): WorkspaceClient;
56
59
  get externalStoragePolicies(): ExternalStoragePoliciesClient;
57
60
  /**
@@ -16,6 +16,7 @@ import { ConversationsClient } from "./api/resources/conversations/client/Client
16
16
  import { ExternalStoragePoliciesClient } from "./api/resources/externalStoragePolicies/client/Client.mjs";
17
17
  import { ExtractionSchemasClient } from "./api/resources/extractionSchemas/client/Client.mjs";
18
18
  import { ProjectsClient } from "./api/resources/projects/client/Client.mjs";
19
+ import { ResponsesClient } from "./api/resources/responses/client/Client.mjs";
19
20
  import { ToolsClient } from "./api/resources/tools/client/Client.mjs";
20
21
  import { TtsClient } from "./api/resources/tts/client/Client.mjs";
21
22
  import { VoicesClient } from "./api/resources/voices/client/Client.mjs";
@@ -67,6 +68,10 @@ export class PhonicClient {
67
68
  var _a;
68
69
  return ((_a = this._projects) !== null && _a !== void 0 ? _a : (this._projects = new ProjectsClient(this._options)));
69
70
  }
71
+ get responses() {
72
+ var _a;
73
+ return ((_a = this._responses) !== null && _a !== void 0 ? _a : (this._responses = new ResponsesClient(this._options)));
74
+ }
70
75
  get workspace() {
71
76
  var _a;
72
77
  return ((_a = this._workspace) !== null && _a !== void 0 ? _a : (this._workspace = new WorkspaceClient(this._options)));
@@ -0,0 +1,6 @@
1
+ import type * as core from "../../core/index.mjs";
2
+ import * as errors from "../../errors/index.mjs";
3
+ import type * as Phonic from "../index.mjs";
4
+ export declare class BadGatewayError extends errors.PhonicError {
5
+ constructor(body: Phonic.BasicError, rawResponse?: core.RawResponse);
6
+ }
@@ -0,0 +1,17 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as errors from "../../errors/index.mjs";
3
+ export class BadGatewayError extends errors.PhonicError {
4
+ constructor(body, rawResponse) {
5
+ super({
6
+ message: "BadGatewayError",
7
+ statusCode: 502,
8
+ body: body,
9
+ rawResponse: rawResponse,
10
+ });
11
+ Object.setPrototypeOf(this, new.target.prototype);
12
+ if (Error.captureStackTrace) {
13
+ Error.captureStackTrace(this, this.constructor);
14
+ }
15
+ this.name = this.constructor.name;
16
+ }
17
+ }
@@ -1,3 +1,4 @@
1
+ export * from "./BadGatewayError.mjs";
1
2
  export * from "./BadRequestError.mjs";
2
3
  export * from "./ConflictError.mjs";
3
4
  export * from "./ForbiddenError.mjs";
@@ -1,3 +1,4 @@
1
+ export * from "./BadGatewayError.mjs";
1
2
  export * from "./BadRequestError.mjs";
2
3
  export * from "./ConflictError.mjs";
3
4
  export * from "./ForbiddenError.mjs";
@@ -135,6 +135,8 @@ export interface AgentsCreateRequest {
135
135
  vad_threshold?: number;
136
136
  /** When `true`, PII and PHI are redacted from text transcripts (e.g. replaced with tags like `[PHONE]`) and bleeped from audio recordings after the conversation ends. */
137
137
  enable_redaction?: boolean;
138
+ /** When `true`, an inaudible watermark is embedded in the audio the agent generates. */
139
+ enable_watermarking?: boolean;
138
140
  /** Array of MCP server IDs to make available to the agent. */
139
141
  mcp_server_ids?: string[];
140
142
  /** Names of observability integrations to enable for the agent. Each must be one of the supported providers. */
@@ -141,6 +141,8 @@ export interface UpdateAgentRequest {
141
141
  vad_threshold?: number;
142
142
  /** When `true`, PII and PHI are redacted from text transcripts (e.g. replaced with tags like `[PHONE]`) and bleeped from audio recordings after the conversation ends. */
143
143
  enable_redaction?: boolean;
144
+ /** When `true`, an inaudible watermark is embedded in the audio the agent generates. */
145
+ enable_watermarking?: boolean;
144
146
  /** Array of MCP server IDs to make available to the agent. */
145
147
  mcp_server_ids?: string[];
146
148
  /** Names of observability integrations to enable for the agent. Each must be one of the supported providers. */
@@ -227,6 +227,8 @@ export declare class ConversationsClient {
227
227
  * @throws {@link Phonic.BadRequestError}
228
228
  * @throws {@link Phonic.UnauthorizedError}
229
229
  * @throws {@link Phonic.NotFoundError}
230
+ * @throws {@link Phonic.ConflictError}
231
+ * @throws {@link Phonic.TooManyRequestsError}
230
232
  * @throws {@link Phonic.InternalServerError}
231
233
  *
232
234
  * @example
@@ -264,6 +266,7 @@ export declare class ConversationsClient {
264
266
  * @throws {@link Phonic.BadRequestError}
265
267
  * @throws {@link Phonic.UnauthorizedError}
266
268
  * @throws {@link Phonic.ConflictError}
269
+ * @throws {@link Phonic.TooManyRequestsError}
267
270
  * @throws {@link Phonic.InternalServerError}
268
271
  *
269
272
  * @example
@@ -704,6 +704,8 @@ export class ConversationsClient {
704
704
  * @throws {@link Phonic.BadRequestError}
705
705
  * @throws {@link Phonic.UnauthorizedError}
706
706
  * @throws {@link Phonic.NotFoundError}
707
+ * @throws {@link Phonic.ConflictError}
708
+ * @throws {@link Phonic.TooManyRequestsError}
707
709
  * @throws {@link Phonic.InternalServerError}
708
710
  *
709
711
  * @example
@@ -767,6 +769,10 @@ export class ConversationsClient {
767
769
  throw new Phonic.UnauthorizedError(_response.error.body, _response.rawResponse);
768
770
  case 404:
769
771
  throw new Phonic.NotFoundError(_response.error.body, _response.rawResponse);
772
+ case 409:
773
+ throw new Phonic.ConflictError(_response.error.body, _response.rawResponse);
774
+ case 429:
775
+ throw new Phonic.TooManyRequestsError(_response.error.body, _response.rawResponse);
770
776
  case 500:
771
777
  throw new Phonic.InternalServerError(_response.error.body, _response.rawResponse);
772
778
  default:
@@ -789,6 +795,7 @@ export class ConversationsClient {
789
795
  * @throws {@link Phonic.BadRequestError}
790
796
  * @throws {@link Phonic.UnauthorizedError}
791
797
  * @throws {@link Phonic.ConflictError}
798
+ * @throws {@link Phonic.TooManyRequestsError}
792
799
  * @throws {@link Phonic.InternalServerError}
793
800
  *
794
801
  * @example
@@ -840,6 +847,8 @@ export class ConversationsClient {
840
847
  throw new Phonic.UnauthorizedError(_response.error.body, _response.rawResponse);
841
848
  case 409:
842
849
  throw new Phonic.ConflictError(_response.error.body, _response.rawResponse);
850
+ case 429:
851
+ throw new Phonic.TooManyRequestsError(_response.error.body, _response.rawResponse);
843
852
  case 500:
844
853
  throw new Phonic.InternalServerError(_response.error.body, _response.rawResponse);
845
854
  default:
@@ -21,6 +21,8 @@ export * from "./extractionSchemas/types/index.mjs";
21
21
  export * from "./projects/client/requests/index.mjs";
22
22
  export * as projects from "./projects/index.mjs";
23
23
  export * from "./projects/types/index.mjs";
24
+ export * from "./responses/client/requests/index.mjs";
25
+ export * as responses from "./responses/index.mjs";
24
26
  export * from "./tools/client/requests/index.mjs";
25
27
  export * as tools from "./tools/index.mjs";
26
28
  export * from "./tools/types/index.mjs";
@@ -21,6 +21,8 @@ export * from "./extractionSchemas/types/index.mjs";
21
21
  export * from "./projects/client/requests/index.mjs";
22
22
  export * as projects from "./projects/index.mjs";
23
23
  export * from "./projects/types/index.mjs";
24
+ export * from "./responses/client/requests/index.mjs";
25
+ export * as responses from "./responses/index.mjs";
24
26
  export * from "./tools/client/requests/index.mjs";
25
27
  export * as tools from "./tools/index.mjs";
26
28
  export * from "./tools/types/index.mjs";
@@ -0,0 +1,72 @@
1
+ import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
2
+ import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
3
+ import * as core from "../../../../core/index.mjs";
4
+ import * as Phonic from "../../../index.mjs";
5
+ export declare namespace ResponsesClient {
6
+ type Options = BaseClientOptions;
7
+ interface RequestOptions extends BaseRequestOptions {
8
+ }
9
+ }
10
+ export declare class ResponsesClient {
11
+ protected readonly _options: NormalizedClientOptionsWithAuth<ResponsesClient.Options>;
12
+ constructor(options?: ResponsesClient.Options);
13
+ /**
14
+ * Generates one or more alternative assistant responses for a conversation
15
+ * you supply inline to simulate Phonic agent behavior.
16
+ *
17
+ * This endpoint is stateless, so it does not create a new conversation or
18
+ * store anything. The request carries the system prompt, a conversation so
19
+ * far as `input`, and the tools the assistant may call as
20
+ * `tool_definitions`.
21
+ *
22
+ * Each item in `input` is a user message, an assistant message (with
23
+ * optional `tool_calls`), or a `tool_call_output`. Every assistant tool
24
+ * call must be followed immediately by the `tool_call_output` item that
25
+ * carries its result.
26
+ *
27
+ * This is an experimental feature and must be enabled for your workspace;
28
+ * otherwise, it returns `404`. Please contact our team if you would like
29
+ * access.
30
+ *
31
+ * @param {Phonic.GenerateResponsesRequest} request
32
+ * @param {ResponsesClient.RequestOptions} requestOptions - Request-specific configuration.
33
+ *
34
+ * @throws {@link Phonic.BadRequestError}
35
+ * @throws {@link Phonic.UnauthorizedError}
36
+ * @throws {@link Phonic.NotFoundError}
37
+ * @throws {@link Phonic.TooManyRequestsError}
38
+ * @throws {@link Phonic.InternalServerError}
39
+ * @throws {@link Phonic.BadGatewayError}
40
+ * @throws {@link Phonic.ServiceUnavailableError}
41
+ *
42
+ * @example
43
+ * await client.responses.create({
44
+ * system_prompt: "You help callers find a pizza shop. Be friendly and concise.",
45
+ * voice_id: "sabrina",
46
+ * default_language: "en",
47
+ * additional_languages: ["es"],
48
+ * input: [{
49
+ * role: "user",
50
+ * text: "Where should I get pizza near Union Square?"
51
+ * }],
52
+ * tool_definitions: [{
53
+ * name: "search_pizza_shop_recs",
54
+ * description: "Search for pizza shop recommendations.",
55
+ * parameters: {
56
+ * type: "object",
57
+ * properties: {
58
+ * "location": {
59
+ * "type": "string",
60
+ * "description": "The neighborhood to search in."
61
+ * }
62
+ * },
63
+ * required: ["location"],
64
+ * additionalProperties: false
65
+ * }
66
+ * }],
67
+ * num_responses: 2
68
+ * })
69
+ */
70
+ create(request: Phonic.GenerateResponsesRequest, requestOptions?: ResponsesClient.RequestOptions): core.HttpResponsePromise<Phonic.GenerateResponsesResponse>;
71
+ private __create;
72
+ }