telnyx 5.156.0 → 5.158.0
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +22 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/anthropic/v1_messages_params.rb +209 -0
- data/lib/telnyx/models/ai/anthropic/v1_messages_response.rb +12 -0
- data/lib/telnyx/models/ai/assistant_create_params.rb +2 -2
- data/lib/telnyx/models/ai/assistant_tool.rb +25 -1
- data/lib/telnyx/models/ai/assistant_update_params.rb +2 -2
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +2 -2
- data/lib/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rb +103 -0
- data/lib/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rb +54 -0
- data/lib/telnyx/models/ai/inference_embedding.rb +6 -6
- data/lib/telnyx/models/ai/pay_tool_params.rb +46 -0
- data/lib/telnyx/models/ai/tool_create_params.rb +7 -1
- data/lib/telnyx/models/ai/tool_update_params.rb +7 -1
- data/lib/telnyx/models/ai/transcription_settings.rb +3 -3
- data/lib/telnyx/models/call_answered.rb +35 -3
- data/lib/telnyx/models/call_dial_params.rb +13 -1
- data/lib/telnyx/models/call_hangup.rb +35 -3
- data/lib/telnyx/models/call_initiated.rb +35 -3
- data/lib/telnyx/models/calls/transcription_config.rb +8 -4
- data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -1
- data/lib/telnyx/models/doc_reqs_requirement.rb +29 -4
- data/lib/telnyx/models/inbound_message.rb +278 -28
- data/lib/telnyx/models/inbound_message_webhook_event.rb +70 -3
- data/lib/telnyx/models/managed_account_list_params.rb +45 -3
- data/lib/telnyx/models/requirement_list_params.rb +10 -1
- data/lib/telnyx/models/requirement_retrieve_params.rb +14 -1
- data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -1
- data/lib/telnyx/models/storage/cloudf_create_params.rb +56 -0
- data/lib/telnyx/models/storage/cloudf_delete_params.rb +22 -0
- data/lib/telnyx/models/storage/cloudf_list_params.rb +109 -0
- data/lib/telnyx/models/storage/cloudf_list_response.rb +165 -0
- data/lib/telnyx/models/storage/cloudf_retrieve_params.rb +22 -0
- data/lib/telnyx/models/storage/cloudf_update_params.rb +36 -0
- data/lib/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rb +30 -0
- data/lib/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rb +129 -0
- data/lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb +129 -0
- data/lib/telnyx/models/storage/cloudfs_filesystem_status.rb +28 -0
- data/lib/telnyx/models/verify_profile.rb +2 -2
- data/lib/telnyx/models/verify_profile_create_params.rb +2 -2
- data/lib/telnyx/models/verify_profile_update_params.rb +2 -2
- data/lib/telnyx/resources/ai/anthropic/v1.rb +91 -0
- data/lib/telnyx/resources/ai/anthropic.rb +20 -0
- data/lib/telnyx/resources/ai/assistants/versions.rb +1 -1
- data/lib/telnyx/resources/ai/assistants.rb +2 -2
- data/lib/telnyx/resources/ai/conversations/conversation_insights.rb +55 -0
- data/lib/telnyx/resources/ai/conversations.rb +5 -0
- data/lib/telnyx/resources/ai/tools.rb +5 -2
- data/lib/telnyx/resources/ai.rb +4 -0
- data/lib/telnyx/resources/calls.rb +3 -1
- data/lib/telnyx/resources/requirements.rb +13 -3
- data/lib/telnyx/resources/storage/cloudfs/actions.rb +54 -0
- data/lib/telnyx/resources/storage/cloudfs.rb +187 -0
- data/lib/telnyx/resources/storage.rb +6 -0
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +20 -0
- data/rbi/telnyx/models/ai/anthropic/v1_messages_params.rbi +314 -0
- data/rbi/telnyx/models/ai/anthropic/v1_messages_response.rbi +15 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +8 -4
- data/rbi/telnyx/models/ai/assistant_tool.rbi +37 -1
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +8 -4
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +8 -4
- data/rbi/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rbi +188 -0
- data/rbi/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rbi +94 -0
- data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -6
- data/rbi/telnyx/models/ai/pay_tool_params.rbi +71 -0
- data/rbi/telnyx/models/ai/tool_create_params.rbi +9 -0
- data/rbi/telnyx/models/ai/tool_update_params.rbi +9 -0
- data/rbi/telnyx/models/ai/transcription_settings.rbi +5 -5
- data/rbi/telnyx/models/call_answered.rbi +92 -4
- data/rbi/telnyx/models/call_dial_params.rbi +19 -0
- data/rbi/telnyx/models/call_hangup.rbi +90 -4
- data/rbi/telnyx/models/call_initiated.rbi +94 -4
- data/rbi/telnyx/models/calls/transcription_config.rbi +15 -7
- data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +2 -2
- data/rbi/telnyx/models/doc_reqs_requirement.rbi +38 -9
- data/rbi/telnyx/models/inbound_message.rbi +324 -58
- data/rbi/telnyx/models/inbound_message_webhook_event.rbi +173 -4
- data/rbi/telnyx/models/managed_account_list_params.rbi +130 -6
- data/rbi/telnyx/models/requirement_list_params.rbi +13 -0
- data/rbi/telnyx/models/requirement_retrieve_params.rbi +21 -2
- data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +2 -2
- data/rbi/telnyx/models/storage/cloudf_create_params.rbi +103 -0
- data/rbi/telnyx/models/storage/cloudf_delete_params.rbi +40 -0
- data/rbi/telnyx/models/storage/cloudf_list_params.rbi +232 -0
- data/rbi/telnyx/models/storage/cloudf_list_response.rbi +327 -0
- data/rbi/telnyx/models/storage/cloudf_retrieve_params.rbi +40 -0
- data/rbi/telnyx/models/storage/cloudf_update_params.rbi +61 -0
- data/rbi/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rbi +50 -0
- data/rbi/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbi +229 -0
- data/rbi/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbi +227 -0
- data/rbi/telnyx/models/storage/cloudfs_filesystem_status.rbi +57 -0
- data/rbi/telnyx/models/verify_profile.rbi +2 -2
- data/rbi/telnyx/models/verify_profile_create_params.rbi +2 -2
- data/rbi/telnyx/models/verify_profile_update_params.rbi +2 -2
- data/rbi/telnyx/resources/ai/anthropic/v1.rbi +106 -0
- data/rbi/telnyx/resources/ai/anthropic.rbi +17 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +2 -1
- data/rbi/telnyx/resources/ai/assistants.rbi +4 -2
- data/rbi/telnyx/resources/ai/conversations/conversation_insights.rbi +68 -0
- data/rbi/telnyx/resources/ai/conversations.rbi +6 -0
- data/rbi/telnyx/resources/ai/tools.rbi +4 -0
- data/rbi/telnyx/resources/ai.rbi +3 -0
- data/rbi/telnyx/resources/calls.rbi +7 -0
- data/rbi/telnyx/resources/managed_accounts.rbi +1 -1
- data/rbi/telnyx/resources/requirements.rbi +8 -0
- data/rbi/telnyx/resources/storage/cloudfs/actions.rbi +46 -0
- data/rbi/telnyx/resources/storage/cloudfs.rbi +152 -0
- data/rbi/telnyx/resources/storage.rbi +5 -0
- data/sig/telnyx/models/ai/anthropic/v1_messages_params.rbs +175 -0
- data/sig/telnyx/models/ai/anthropic/v1_messages_response.rbs +11 -0
- data/sig/telnyx/models/ai/assistant_tool.rbs +13 -0
- data/sig/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rbs +74 -0
- data/sig/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rbs +34 -0
- data/sig/telnyx/models/ai/pay_tool_params.rbs +41 -0
- data/sig/telnyx/models/ai/tool_create_params.rbs +7 -0
- data/sig/telnyx/models/ai/tool_update_params.rbs +7 -0
- data/sig/telnyx/models/ai/transcription_settings.rbs +2 -2
- data/sig/telnyx/models/call_answered.rbs +39 -6
- data/sig/telnyx/models/call_dial_params.rbs +7 -0
- data/sig/telnyx/models/call_hangup.rbs +39 -6
- data/sig/telnyx/models/call_initiated.rbs +39 -6
- data/sig/telnyx/models/calls/transcription_config.rbs +2 -2
- data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +2 -2
- data/sig/telnyx/models/doc_reqs_requirement.rbs +25 -8
- data/sig/telnyx/models/inbound_message.rbs +204 -35
- data/sig/telnyx/models/inbound_message_webhook_event.rbs +81 -5
- data/sig/telnyx/models/managed_account_list_params.rbs +47 -3
- data/sig/telnyx/models/requirement_list_params.rbs +8 -1
- data/sig/telnyx/models/requirement_retrieve_params.rbs +12 -2
- data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -2
- data/sig/telnyx/models/storage/cloudf_create_params.rbs +50 -0
- data/sig/telnyx/models/storage/cloudf_delete_params.rbs +22 -0
- data/sig/telnyx/models/storage/cloudf_list_params.rbs +112 -0
- data/sig/telnyx/models/storage/cloudf_list_response.rbs +163 -0
- data/sig/telnyx/models/storage/cloudf_retrieve_params.rbs +22 -0
- data/sig/telnyx/models/storage/cloudf_update_params.rbs +32 -0
- data/sig/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rbs +32 -0
- data/sig/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbs +115 -0
- data/sig/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbs +115 -0
- data/sig/telnyx/models/storage/cloudfs_filesystem_status.rbs +21 -0
- data/sig/telnyx/resources/ai/anthropic/v1.rbs +35 -0
- data/sig/telnyx/resources/ai/anthropic.rbs +11 -0
- data/sig/telnyx/resources/ai/conversations/conversation_insights.rbs +20 -0
- data/sig/telnyx/resources/ai/conversations.rbs +2 -0
- data/sig/telnyx/resources/ai/tools.rbs +2 -0
- data/sig/telnyx/resources/ai.rbs +2 -0
- data/sig/telnyx/resources/calls.rbs +1 -0
- data/sig/telnyx/resources/requirements.rbs +2 -0
- data/sig/telnyx/resources/storage/cloudfs/actions.rbs +17 -0
- data/sig/telnyx/resources/storage/cloudfs.rbs +45 -0
- data/sig/telnyx/resources/storage.rbs +2 -0
- metadata +62 -2
|
@@ -254,7 +254,7 @@ module Telnyx
|
|
|
254
254
|
optional :sender_phone_number, String, nil?: true
|
|
255
255
|
|
|
256
256
|
# @!attribute template_id
|
|
257
|
-
# Customer pre-approved authentication template
|
|
257
|
+
# Customer pre-approved authentication template ID registered on Meta
|
|
258
258
|
#
|
|
259
259
|
# @return [String, nil]
|
|
260
260
|
optional :template_id, String, nil?: true
|
|
@@ -283,7 +283,7 @@ module Telnyx
|
|
|
283
283
|
#
|
|
284
284
|
# @param sender_phone_number [String, nil] Phone number registered on the customer WABA to send OTPs from
|
|
285
285
|
#
|
|
286
|
-
# @param template_id [String, nil] Customer pre-approved authentication template
|
|
286
|
+
# @param template_id [String, nil] Customer pre-approved authentication template ID registered on Meta
|
|
287
287
|
#
|
|
288
288
|
# @param waba_id [String, nil] Customer Meta WABA ID for Bring-Your-Own-WABA sending
|
|
289
289
|
#
|
|
@@ -216,7 +216,7 @@ module Telnyx
|
|
|
216
216
|
optional :sender_phone_number, String, nil?: true
|
|
217
217
|
|
|
218
218
|
# @!attribute template_id
|
|
219
|
-
# Customer pre-approved authentication template
|
|
219
|
+
# Customer pre-approved authentication template ID registered on Meta
|
|
220
220
|
#
|
|
221
221
|
# @return [String, nil]
|
|
222
222
|
optional :template_id, String, nil?: true
|
|
@@ -245,7 +245,7 @@ module Telnyx
|
|
|
245
245
|
#
|
|
246
246
|
# @param sender_phone_number [String, nil] Phone number registered on the customer WABA to send OTPs from
|
|
247
247
|
#
|
|
248
|
-
# @param template_id [String, nil] Customer pre-approved authentication template
|
|
248
|
+
# @param template_id [String, nil] Customer pre-approved authentication template ID registered on Meta
|
|
249
249
|
#
|
|
250
250
|
# @param waba_id [String, nil] Customer Meta WABA ID for Bring-Your-Own-WABA sending
|
|
251
251
|
#
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class AI
|
|
6
|
+
class Anthropic
|
|
7
|
+
class V1
|
|
8
|
+
# Some parameter documentations has been truncated, see
|
|
9
|
+
# {Telnyx::Models::AI::Anthropic::V1MessagesParams} for more details.
|
|
10
|
+
#
|
|
11
|
+
# Send a message to a language model using the Anthropic Messages API format. This
|
|
12
|
+
# endpoint is compatible with the
|
|
13
|
+
# [Anthropic Messages API](https://docs.anthropic.com/en/api/messages) and may be
|
|
14
|
+
# used with the Anthropic JS or Python SDK by setting the base URL to
|
|
15
|
+
# `https://api.telnyx.com/v2/ai/anthropic`.
|
|
16
|
+
#
|
|
17
|
+
# The endpoint translates Anthropic-format requests into Telnyx's inference
|
|
18
|
+
# internals, then translates the response back to the Anthropic message shape.
|
|
19
|
+
# Streaming responses use Anthropic SSE event types (`message_start`,
|
|
20
|
+
# `content_block_start`, `content_block_delta`, `content_block_stop`,
|
|
21
|
+
# `message_delta`, `message_stop`).
|
|
22
|
+
#
|
|
23
|
+
# @overload messages(max_tokens:, messages:, model:, api_key_ref: nil, billing_group_id: nil, fallback_config: nil, max_retries: nil, mcp_servers: nil, metadata: nil, service_tier: nil, stop_sequences: nil, stream: nil, system_: nil, temperature: nil, thinking: nil, timeout: nil, tool_choice: nil, tools: nil, top_k: nil, top_p: nil, request_options: {})
|
|
24
|
+
#
|
|
25
|
+
# @param max_tokens [Integer] The maximum number of tokens to generate in the response.
|
|
26
|
+
#
|
|
27
|
+
# @param messages [Array<Hash{Symbol=>Object}>] The messages to send to the model, following the [Anthropic Messages API](https:
|
|
28
|
+
#
|
|
29
|
+
# @param model [String] The model to use for generating the response, for example `zai-org/GLM-5.2` or a
|
|
30
|
+
#
|
|
31
|
+
# @param api_key_ref [String] If you are using an external inference provider, this field allows you to pass a
|
|
32
|
+
#
|
|
33
|
+
# @param billing_group_id [String] The billing group ID to associate with this request.
|
|
34
|
+
#
|
|
35
|
+
# @param fallback_config [Hash{Symbol=>Object}] Configuration for model fallback behavior when the primary model is unavailable.
|
|
36
|
+
#
|
|
37
|
+
# @param max_retries [Integer] Maximum number of retries for the request.
|
|
38
|
+
#
|
|
39
|
+
# @param mcp_servers [Array<Hash{Symbol=>Object}>] List of MCP (Model Context Protocol) servers to make available to the model.
|
|
40
|
+
#
|
|
41
|
+
# @param metadata [Hash{Symbol=>Object}] An object describing metadata about the request.
|
|
42
|
+
#
|
|
43
|
+
# @param service_tier [String] Service tier for the request.
|
|
44
|
+
#
|
|
45
|
+
# @param stop_sequences [Array<String>] Custom sequences that will cause the model to stop generating.
|
|
46
|
+
#
|
|
47
|
+
# @param stream [Boolean] Whether to stream the response as Anthropic-format Server-Sent Events.
|
|
48
|
+
#
|
|
49
|
+
# @param system_ [String, Array<Hash{Symbol=>Object}>] System prompt. Can be a string or an array of content blocks following the Anthr
|
|
50
|
+
#
|
|
51
|
+
# @param temperature [Float] Amount of randomness injected into the response. Ranges from 0 to 1.
|
|
52
|
+
#
|
|
53
|
+
# @param thinking [Hash{Symbol=>Object}] Extended thinking configuration for models that support it. Set `type` to `enabl
|
|
54
|
+
#
|
|
55
|
+
# @param timeout [Float] Request timeout in seconds.
|
|
56
|
+
#
|
|
57
|
+
# @param tool_choice [Hash{Symbol=>Object}] Controls how the model uses tools, following the Anthropic API format.
|
|
58
|
+
#
|
|
59
|
+
# @param tools [Array<Hash{Symbol=>Object}>] Definitions of tools that the model may use, following the Anthropic API format.
|
|
60
|
+
#
|
|
61
|
+
# @param top_k [Integer] Top-k sampling parameter. Only sample from the top K options for each subsequent
|
|
62
|
+
#
|
|
63
|
+
# @param top_p [Float] Nucleus sampling parameter. Use temperature or top_p, but not both.
|
|
64
|
+
#
|
|
65
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
66
|
+
#
|
|
67
|
+
# @return [Hash{Symbol=>Object}]
|
|
68
|
+
#
|
|
69
|
+
# @see Telnyx::Models::AI::Anthropic::V1MessagesParams
|
|
70
|
+
def messages(params)
|
|
71
|
+
parsed, options = Telnyx::AI::Anthropic::V1MessagesParams.dump_request(params)
|
|
72
|
+
@client.request(
|
|
73
|
+
method: :post,
|
|
74
|
+
path: "ai/anthropic/v1/messages",
|
|
75
|
+
body: parsed,
|
|
76
|
+
model: Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
|
|
77
|
+
options: options
|
|
78
|
+
)
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
# @api private
|
|
82
|
+
#
|
|
83
|
+
# @param client [Telnyx::Client]
|
|
84
|
+
def initialize(client:)
|
|
85
|
+
@client = client
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
end
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class AI
|
|
6
|
+
class Anthropic
|
|
7
|
+
# @return [Telnyx::Resources::AI::Anthropic::V1]
|
|
8
|
+
attr_reader :v1
|
|
9
|
+
|
|
10
|
+
# @api private
|
|
11
|
+
#
|
|
12
|
+
# @param client [Telnyx::Client]
|
|
13
|
+
def initialize(client:)
|
|
14
|
+
@client = client
|
|
15
|
+
@v1 = Telnyx::Resources::AI::Anthropic::V1.new(client: client)
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
@@ -97,7 +97,7 @@ module Telnyx
|
|
|
97
97
|
#
|
|
98
98
|
# @param tool_ids [Array<String>] Body param: IDs of shared tools to attach to the assistant. New integrations sho
|
|
99
99
|
#
|
|
100
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Body param: Deprecated for new integrations. Inline tool definitions available t
|
|
100
|
+
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Body param: Deprecated for new integrations. Inline tool definitions available t
|
|
101
101
|
#
|
|
102
102
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings] Body param
|
|
103
103
|
#
|
|
@@ -88,7 +88,7 @@ module Telnyx
|
|
|
88
88
|
#
|
|
89
89
|
# @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
|
|
90
90
|
#
|
|
91
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
91
|
+
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
92
92
|
#
|
|
93
93
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
94
94
|
#
|
|
@@ -202,7 +202,7 @@ module Telnyx
|
|
|
202
202
|
#
|
|
203
203
|
# @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
|
|
204
204
|
#
|
|
205
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
205
|
+
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
206
206
|
#
|
|
207
207
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
208
208
|
#
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class AI
|
|
6
|
+
class Conversations
|
|
7
|
+
# Manage historical AI assistant conversations
|
|
8
|
+
class ConversationInsights
|
|
9
|
+
# Some parameter documentations has been truncated, see
|
|
10
|
+
# {Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesParams}
|
|
11
|
+
# for more details.
|
|
12
|
+
#
|
|
13
|
+
# Aggregate conversation insights by specified fields
|
|
14
|
+
#
|
|
15
|
+
# @overload retrieve_aggregates(created_at: nil, group_by: nil, insight_id: nil, metadata: nil, show: nil, request_options: {})
|
|
16
|
+
#
|
|
17
|
+
# @param created_at [String] Filter by creation datetime to scope the aggregation window. Supports range oper
|
|
18
|
+
#
|
|
19
|
+
# @param group_by [Array<String>] Fields to group by (can be comma-separated or multiple parameters). Prefix a fie
|
|
20
|
+
#
|
|
21
|
+
# @param insight_id [String] Optional insight ID to filter conversation insights. Only insights matching this
|
|
22
|
+
#
|
|
23
|
+
# @param metadata [Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesParams::Metadata]
|
|
24
|
+
#
|
|
25
|
+
# @param show [Array<String>] Fields to include in the result (can be comma-separated or multiple parameters).
|
|
26
|
+
#
|
|
27
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
28
|
+
#
|
|
29
|
+
# @return [Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse]
|
|
30
|
+
#
|
|
31
|
+
# @see Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesParams
|
|
32
|
+
def retrieve_aggregates(params = {})
|
|
33
|
+
parsed, options =
|
|
34
|
+
Telnyx::AI::Conversations::ConversationInsightRetrieveAggregatesParams.dump_request(params)
|
|
35
|
+
query = Telnyx::Internal::Util.encode_query_params(parsed)
|
|
36
|
+
@client.request(
|
|
37
|
+
method: :get,
|
|
38
|
+
path: "ai/conversations/conversation-insights/aggregates",
|
|
39
|
+
query: query,
|
|
40
|
+
model: Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse,
|
|
41
|
+
options: options
|
|
42
|
+
)
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# @api private
|
|
46
|
+
#
|
|
47
|
+
# @param client [Telnyx::Client]
|
|
48
|
+
def initialize(client:)
|
|
49
|
+
@client = client
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
@@ -17,6 +17,10 @@ module Telnyx
|
|
|
17
17
|
# @return [Telnyx::Resources::AI::Conversations::Messages]
|
|
18
18
|
attr_reader :messages
|
|
19
19
|
|
|
20
|
+
# Manage historical AI assistant conversations
|
|
21
|
+
# @return [Telnyx::Resources::AI::Conversations::ConversationInsights]
|
|
22
|
+
attr_reader :conversation_insights
|
|
23
|
+
|
|
20
24
|
# Some parameter documentations has been truncated, see
|
|
21
25
|
# {Telnyx::Models::AI::ConversationCreateParams} for more details.
|
|
22
26
|
#
|
|
@@ -237,6 +241,7 @@ module Telnyx
|
|
|
237
241
|
@insight_groups = Telnyx::Resources::AI::Conversations::InsightGroups.new(client: client)
|
|
238
242
|
@insights = Telnyx::Resources::AI::Conversations::Insights.new(client: client)
|
|
239
243
|
@messages = Telnyx::Resources::AI::Conversations::Messages.new(client: client)
|
|
244
|
+
@conversation_insights = Telnyx::Resources::AI::Conversations::ConversationInsights.new(client: client)
|
|
240
245
|
end
|
|
241
246
|
end
|
|
242
247
|
end
|
|
@@ -7,7 +7,7 @@ module Telnyx
|
|
|
7
7
|
class Tools
|
|
8
8
|
# Create Tool
|
|
9
9
|
#
|
|
10
|
-
# @overload create(display_name:, type:, client_side_tool: nil, function: nil, handoff: nil, invite: nil, retrieval: nil, timeout_ms: nil, webhook: nil, request_options: {})
|
|
10
|
+
# @overload create(display_name:, type:, client_side_tool: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, webhook: nil, request_options: {})
|
|
11
11
|
#
|
|
12
12
|
# @param display_name [String]
|
|
13
13
|
# @param type [String]
|
|
@@ -15,6 +15,7 @@ module Telnyx
|
|
|
15
15
|
# @param function [Hash{Symbol=>Object}]
|
|
16
16
|
# @param handoff [Hash{Symbol=>Object}]
|
|
17
17
|
# @param invite [Hash{Symbol=>Object}]
|
|
18
|
+
# @param pay [Telnyx::Models::AI::PayToolParams]
|
|
18
19
|
# @param retrieval [Hash{Symbol=>Object}]
|
|
19
20
|
# @param timeout_ms [Integer]
|
|
20
21
|
# @param webhook [Hash{Symbol=>Object}]
|
|
@@ -56,7 +57,7 @@ module Telnyx
|
|
|
56
57
|
|
|
57
58
|
# Update Tool
|
|
58
59
|
#
|
|
59
|
-
# @overload update(tool_id, client_side_tool: nil, display_name: nil, function: nil, handoff: nil, invite: nil, retrieval: nil, timeout_ms: nil, type: nil, webhook: nil, request_options: {})
|
|
60
|
+
# @overload update(tool_id, client_side_tool: nil, display_name: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, type: nil, webhook: nil, request_options: {})
|
|
60
61
|
#
|
|
61
62
|
# @param tool_id [String] Unique identifier of the tool.
|
|
62
63
|
#
|
|
@@ -70,6 +71,8 @@ module Telnyx
|
|
|
70
71
|
#
|
|
71
72
|
# @param invite [Hash{Symbol=>Object}]
|
|
72
73
|
#
|
|
74
|
+
# @param pay [Telnyx::Models::AI::PayToolParams]
|
|
75
|
+
#
|
|
73
76
|
# @param retrieval [Hash{Symbol=>Object}]
|
|
74
77
|
#
|
|
75
78
|
# @param timeout_ms [Integer]
|
data/lib/telnyx/resources/ai.rb
CHANGED
|
@@ -44,6 +44,9 @@ module Telnyx
|
|
|
44
44
|
# @return [Telnyx::Resources::AI::Tools]
|
|
45
45
|
attr_reader :tools
|
|
46
46
|
|
|
47
|
+
# @return [Telnyx::Resources::AI::Anthropic]
|
|
48
|
+
attr_reader :anthropic
|
|
49
|
+
|
|
47
50
|
# Some parameter documentations has been truncated, see
|
|
48
51
|
# {Telnyx::Models::AIRetrieveConversationHistoriesParams} for more details.
|
|
49
52
|
#
|
|
@@ -208,6 +211,7 @@ module Telnyx
|
|
|
208
211
|
@missions = Telnyx::Resources::AI::Missions.new(client: client)
|
|
209
212
|
@openai = Telnyx::Resources::AI::OpenAI.new(client: client)
|
|
210
213
|
@tools = Telnyx::Resources::AI::Tools.new(client: client)
|
|
214
|
+
@anthropic = Telnyx::Resources::AI::Anthropic.new(client: client)
|
|
211
215
|
end
|
|
212
216
|
end
|
|
213
217
|
end
|
|
@@ -35,7 +35,7 @@ module Telnyx
|
|
|
35
35
|
# When the `record` parameter is set to `record-from-answer`, the response will
|
|
36
36
|
# include a `recording_id` field.
|
|
37
37
|
#
|
|
38
|
-
# @overload dial(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, assistant: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, conversation_relay_config: nil, custom_headers: nil, deepfake_detection: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_digits_on_answer: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
|
|
38
|
+
# @overload dial(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, assistant: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, conversation_relay_config: nil, custom_headers: nil, deepfake_detection: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, retry_on_timeout: nil, send_digits_on_answer: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
|
|
39
39
|
#
|
|
40
40
|
# @param connection_id [String] The ID of the Call Control App (formerly ID of the connection) to be used when d
|
|
41
41
|
#
|
|
@@ -105,6 +105,8 @@ module Telnyx
|
|
|
105
105
|
#
|
|
106
106
|
# @param record_trim [Symbol, Telnyx::Models::CallDialParams::RecordTrim] When set to `trim-silence`, silence will be removed from the beginning and end o
|
|
107
107
|
#
|
|
108
|
+
# @param retry_on_timeout [Boolean] Whether to keep trying the remaining routing paths (e.g. alternate providers/gat
|
|
109
|
+
#
|
|
108
110
|
# @param send_digits_on_answer [String] DTMF digits to send automatically after the called party answers. Useful for rea
|
|
109
111
|
#
|
|
110
112
|
# @param send_silence_when_idle [Boolean] Generate silence RTP packets when no transmission available.
|
|
@@ -4,23 +4,31 @@ module Telnyx
|
|
|
4
4
|
module Resources
|
|
5
5
|
# Requirements for international numbers and porting orders
|
|
6
6
|
class Requirements
|
|
7
|
+
# Some parameter documentations has been truncated, see
|
|
8
|
+
# {Telnyx::Models::RequirementRetrieveParams} for more details.
|
|
9
|
+
#
|
|
7
10
|
# Retrieve a document requirement record
|
|
8
11
|
#
|
|
9
|
-
# @overload retrieve(id, request_options: {})
|
|
12
|
+
# @overload retrieve(id, version: nil, request_options: {})
|
|
10
13
|
#
|
|
11
14
|
# @param id [String] Uniquely identifies the requirement_type record
|
|
12
15
|
#
|
|
16
|
+
# @param version [Integer] Filter by requirement version number. When omitted, returns the currently-active
|
|
17
|
+
#
|
|
13
18
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
14
19
|
#
|
|
15
20
|
# @return [Telnyx::Models::RequirementRetrieveResponse]
|
|
16
21
|
#
|
|
17
22
|
# @see Telnyx::Models::RequirementRetrieveParams
|
|
18
23
|
def retrieve(id, params = {})
|
|
24
|
+
parsed, options = Telnyx::RequirementRetrieveParams.dump_request(params)
|
|
25
|
+
query = Telnyx::Internal::Util.encode_query_params(parsed)
|
|
19
26
|
@client.request(
|
|
20
27
|
method: :get,
|
|
21
28
|
path: ["requirements/%1$s", id],
|
|
29
|
+
query: query,
|
|
22
30
|
model: Telnyx::Models::RequirementRetrieveResponse,
|
|
23
|
-
options:
|
|
31
|
+
options: options
|
|
24
32
|
)
|
|
25
33
|
end
|
|
26
34
|
|
|
@@ -29,7 +37,7 @@ module Telnyx
|
|
|
29
37
|
#
|
|
30
38
|
# List all requirements with filtering, sorting, and pagination
|
|
31
39
|
#
|
|
32
|
-
# @overload list(filter: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
|
|
40
|
+
# @overload list(filter: nil, page_number: nil, page_size: nil, sort: nil, version: nil, request_options: {})
|
|
33
41
|
#
|
|
34
42
|
# @param filter [Telnyx::Models::RequirementListParams::Filter] Consolidated filter parameter for requirements (deepObject style). Originally: f
|
|
35
43
|
#
|
|
@@ -39,6 +47,8 @@ module Telnyx
|
|
|
39
47
|
#
|
|
40
48
|
# @param sort [Array<Symbol, Telnyx::Models::RequirementListParams::Sort>] Consolidated sort parameter for requirements (deepObject style). Originally: sor
|
|
41
49
|
#
|
|
50
|
+
# @param version [Integer] Filter by requirement version number. When omitted, returns the currently-active
|
|
51
|
+
#
|
|
42
52
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
43
53
|
#
|
|
44
54
|
# @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::DocReqsRequirement>]
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class Storage
|
|
6
|
+
class Cloudfs
|
|
7
|
+
# Manage CloudFS filesystems — JuiceFS-compatible filesystems backed by Telnyx
|
|
8
|
+
# Cloud Storage
|
|
9
|
+
class Actions
|
|
10
|
+
# Some parameter documentations has been truncated, see
|
|
11
|
+
# {Telnyx::Models::Storage::Cloudfs::ActionRotateMetaTokenParams} for more
|
|
12
|
+
# details.
|
|
13
|
+
#
|
|
14
|
+
# Issues a new metadata access token for the filesystem and returns the full
|
|
15
|
+
# filesystem, including the new `meta_token` and credential-bearing `meta_url`.
|
|
16
|
+
# The previous token stops authenticating immediately; the metadata database and
|
|
17
|
+
# S3 bucket are unchanged. The request takes no body. Allowed while the filesystem
|
|
18
|
+
# is `ready` or `needs_format`; otherwise returns a `409`. Retrying with the same
|
|
19
|
+
# `Idempotency-Key` within 24 hours replays the original response — including the
|
|
20
|
+
# same token — instead of rotating again.
|
|
21
|
+
#
|
|
22
|
+
# @overload rotate_meta_token(id, idempotency_key:, request_options: {})
|
|
23
|
+
#
|
|
24
|
+
# @param id [String] CloudFS filesystem ID
|
|
25
|
+
#
|
|
26
|
+
# @param idempotency_key [String] Unique key that makes the request idempotent (1-255 characters: letters, numbers
|
|
27
|
+
#
|
|
28
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
29
|
+
#
|
|
30
|
+
# @return [Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper]
|
|
31
|
+
#
|
|
32
|
+
# @see Telnyx::Models::Storage::Cloudfs::ActionRotateMetaTokenParams
|
|
33
|
+
def rotate_meta_token(id, params)
|
|
34
|
+
parsed, options = Telnyx::Storage::Cloudfs::ActionRotateMetaTokenParams.dump_request(params)
|
|
35
|
+
@client.request(
|
|
36
|
+
method: :post,
|
|
37
|
+
path: ["storage/cloudfs/%1$s/actions/rotate-meta-token", id],
|
|
38
|
+
headers: parsed.transform_keys(idempotency_key: "idempotency-key"),
|
|
39
|
+
model: Telnyx::Storage::CloudfsFilesystemResponseWrapper,
|
|
40
|
+
options: options
|
|
41
|
+
)
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# @api private
|
|
45
|
+
#
|
|
46
|
+
# @param client [Telnyx::Client]
|
|
47
|
+
def initialize(client:)
|
|
48
|
+
@client = client
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
end
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class Storage
|
|
6
|
+
# Manage CloudFS filesystems — JuiceFS-compatible filesystems backed by Telnyx
|
|
7
|
+
# Cloud Storage
|
|
8
|
+
class Cloudfs
|
|
9
|
+
# Manage CloudFS filesystems — JuiceFS-compatible filesystems backed by Telnyx
|
|
10
|
+
# Cloud Storage
|
|
11
|
+
# @return [Telnyx::Resources::Storage::Cloudfs::Actions]
|
|
12
|
+
attr_reader :actions
|
|
13
|
+
|
|
14
|
+
# Some parameter documentations has been truncated, see
|
|
15
|
+
# {Telnyx::Models::Storage::CloudfCreateParams} for more details.
|
|
16
|
+
#
|
|
17
|
+
# Creates a CloudFS filesystem. Provisioning is synchronous — typically a few
|
|
18
|
+
# seconds, up to a few minutes — and the filesystem is returned with status
|
|
19
|
+
# `ready`, together with its S3 bucket and metadata connection details. This
|
|
20
|
+
# response is the only time the filesystem's `meta_token` — and the
|
|
21
|
+
# credential-bearing `meta_url` — are returned; store them securely. If the token
|
|
22
|
+
# is lost, issue a new one with the rotate-meta-token action. Names are unique
|
|
23
|
+
# within your organization: creating with an existing name returns a `422`.
|
|
24
|
+
# Requests are idempotent: retrying with the same `Idempotency-Key` within 24
|
|
25
|
+
# hours replays the original response instead of creating another filesystem.
|
|
26
|
+
#
|
|
27
|
+
# @overload create(name:, region:, idempotency_key:, request_options: {})
|
|
28
|
+
#
|
|
29
|
+
# @param name [String] Body param: Filesystem name, unique within your organization. Names are trimmed
|
|
30
|
+
#
|
|
31
|
+
# @param region [Symbol, Telnyx::Models::Storage::CloudfCreateParams::Region] Body param: Region where the filesystem's storage and metadata are provisioned.
|
|
32
|
+
#
|
|
33
|
+
# @param idempotency_key [String] Header param: Unique key that makes the request idempotent (1-255 characters: le
|
|
34
|
+
#
|
|
35
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
36
|
+
#
|
|
37
|
+
# @return [Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper]
|
|
38
|
+
#
|
|
39
|
+
# @see Telnyx::Models::Storage::CloudfCreateParams
|
|
40
|
+
def create(params)
|
|
41
|
+
parsed, options = Telnyx::Storage::CloudfCreateParams.dump_request(params)
|
|
42
|
+
header_params = {idempotency_key: "idempotency-key"}
|
|
43
|
+
@client.request(
|
|
44
|
+
method: :post,
|
|
45
|
+
path: "storage/cloudfs",
|
|
46
|
+
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
47
|
+
body: parsed.except(*header_params.keys),
|
|
48
|
+
model: Telnyx::Storage::CloudfsFilesystemResponseWrapper,
|
|
49
|
+
options: options
|
|
50
|
+
)
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
# Retrieves a CloudFS filesystem by its ID. The returned `meta_url` omits the
|
|
54
|
+
# credential — the metadata token is only ever returned by create and
|
|
55
|
+
# rotate-meta-token. A filesystem whose last lifecycle action failed includes a
|
|
56
|
+
# customer-safe `error` message.
|
|
57
|
+
#
|
|
58
|
+
# @overload retrieve(id, request_options: {})
|
|
59
|
+
#
|
|
60
|
+
# @param id [String] CloudFS filesystem ID
|
|
61
|
+
#
|
|
62
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
63
|
+
#
|
|
64
|
+
# @return [Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper]
|
|
65
|
+
#
|
|
66
|
+
# @see Telnyx::Models::Storage::CloudfRetrieveParams
|
|
67
|
+
def retrieve(id, params = {})
|
|
68
|
+
@client.request(
|
|
69
|
+
method: :get,
|
|
70
|
+
path: ["storage/cloudfs/%1$s", id],
|
|
71
|
+
model: Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper,
|
|
72
|
+
options: params[:request_options]
|
|
73
|
+
)
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# Some parameter documentations has been truncated, see
|
|
77
|
+
# {Telnyx::Models::Storage::CloudfUpdateParams} for more details.
|
|
78
|
+
#
|
|
79
|
+
# Updates a CloudFS filesystem. Only `name` can be changed; other fields are
|
|
80
|
+
# immutable and unknown fields are rejected with a `400`. Renaming to a name that
|
|
81
|
+
# already exists in your organization returns a `422`.
|
|
82
|
+
#
|
|
83
|
+
# @overload update(id, name: nil, request_options: {})
|
|
84
|
+
#
|
|
85
|
+
# @param id [String] CloudFS filesystem ID
|
|
86
|
+
#
|
|
87
|
+
# @param name [String] New filesystem name, unique within your organization. Names are trimmed and lowe
|
|
88
|
+
#
|
|
89
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
90
|
+
#
|
|
91
|
+
# @return [Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper]
|
|
92
|
+
#
|
|
93
|
+
# @see Telnyx::Models::Storage::CloudfUpdateParams
|
|
94
|
+
def update(id, params = {})
|
|
95
|
+
parsed, options = Telnyx::Storage::CloudfUpdateParams.dump_request(params)
|
|
96
|
+
@client.request(
|
|
97
|
+
method: :patch,
|
|
98
|
+
path: ["storage/cloudfs/%1$s", id],
|
|
99
|
+
body: parsed,
|
|
100
|
+
model: Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper,
|
|
101
|
+
options: options
|
|
102
|
+
)
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# Some parameter documentations has been truncated, see
|
|
106
|
+
# {Telnyx::Models::Storage::CloudfListParams} for more details.
|
|
107
|
+
#
|
|
108
|
+
# Lists the CloudFS filesystems for the authenticated user's organization. Results
|
|
109
|
+
# use cursor-based pagination: fetch the next page by passing `meta.cursors.after`
|
|
110
|
+
# as `page[after]`, or follow the `meta.next` URL.
|
|
111
|
+
#
|
|
112
|
+
# @overload list(filter_name: nil, filter_region: nil, filter_status: nil, page_after: nil, page_before: nil, page_limit: nil, sort: nil, request_options: {})
|
|
113
|
+
#
|
|
114
|
+
# @param filter_name [String] Return only the filesystem whose name matches exactly.
|
|
115
|
+
#
|
|
116
|
+
# @param filter_region [String] Return only filesystems in this region.
|
|
117
|
+
#
|
|
118
|
+
# @param filter_status [Symbol, Telnyx::Models::Storage::CloudfListParams::FilterStatus] Return only filesystems with this status. Unrecognized values are ignored.
|
|
119
|
+
#
|
|
120
|
+
# @param page_after [String] Opaque cursor from a previous response's `meta.cursors.after`; returns the page
|
|
121
|
+
#
|
|
122
|
+
# @param page_before [String] Opaque cursor from a previous response's `meta.cursors.before`; returns the page
|
|
123
|
+
#
|
|
124
|
+
# @param page_limit [Integer] The number of filesystems to return per page. Values above 250 are treated as 25
|
|
125
|
+
#
|
|
126
|
+
# @param sort [Symbol, Telnyx::Models::Storage::CloudfListParams::Sort] Sort order for the results: a field name for ascending, or the field name prefix
|
|
127
|
+
#
|
|
128
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
129
|
+
#
|
|
130
|
+
# @return [Telnyx::Models::Storage::CloudfListResponse]
|
|
131
|
+
#
|
|
132
|
+
# @see Telnyx::Models::Storage::CloudfListParams
|
|
133
|
+
def list(params = {})
|
|
134
|
+
parsed, options = Telnyx::Storage::CloudfListParams.dump_request(params)
|
|
135
|
+
query = Telnyx::Internal::Util.encode_query_params(parsed)
|
|
136
|
+
@client.request(
|
|
137
|
+
method: :get,
|
|
138
|
+
path: "storage/cloudfs",
|
|
139
|
+
query: query.transform_keys(
|
|
140
|
+
filter_name: "filter[name]",
|
|
141
|
+
filter_region: "filter[region]",
|
|
142
|
+
filter_status: "filter[status]",
|
|
143
|
+
page_after: "page[after]",
|
|
144
|
+
page_before: "page[before]",
|
|
145
|
+
page_limit: "page[limit]"
|
|
146
|
+
),
|
|
147
|
+
model: Telnyx::Models::Storage::CloudfListResponse,
|
|
148
|
+
options: options
|
|
149
|
+
)
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
# Permanently deletes a CloudFS filesystem, removing its S3 bucket and its
|
|
153
|
+
# metadata database. Deletion is synchronous: the response returns the
|
|
154
|
+
# filesystem's final state with status `deleted`. There is no restore. A
|
|
155
|
+
# filesystem that is still `provisioning` returns a `409`. If the filesystem still
|
|
156
|
+
# contains data, the request may be rejected with a `409` — drain the bucket and
|
|
157
|
+
# retry.
|
|
158
|
+
#
|
|
159
|
+
# @overload delete(id, request_options: {})
|
|
160
|
+
#
|
|
161
|
+
# @param id [String] CloudFS filesystem ID
|
|
162
|
+
#
|
|
163
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
164
|
+
#
|
|
165
|
+
# @return [Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper]
|
|
166
|
+
#
|
|
167
|
+
# @see Telnyx::Models::Storage::CloudfDeleteParams
|
|
168
|
+
def delete(id, params = {})
|
|
169
|
+
@client.request(
|
|
170
|
+
method: :delete,
|
|
171
|
+
path: ["storage/cloudfs/%1$s", id],
|
|
172
|
+
model: Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper,
|
|
173
|
+
options: params[:request_options]
|
|
174
|
+
)
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
# @api private
|
|
178
|
+
#
|
|
179
|
+
# @param client [Telnyx::Client]
|
|
180
|
+
def initialize(client:)
|
|
181
|
+
@client = client
|
|
182
|
+
@actions = Telnyx::Resources::Storage::Cloudfs::Actions.new(client: client)
|
|
183
|
+
end
|
|
184
|
+
end
|
|
185
|
+
end
|
|
186
|
+
end
|
|
187
|
+
end
|
|
@@ -20,6 +20,11 @@ module Telnyx
|
|
|
20
20
|
# @return [Telnyx::Resources::Storage::Kvs]
|
|
21
21
|
attr_reader :kvs
|
|
22
22
|
|
|
23
|
+
# Manage CloudFS filesystems — JuiceFS-compatible filesystems backed by Telnyx
|
|
24
|
+
# Cloud Storage
|
|
25
|
+
# @return [Telnyx::Resources::Storage::Cloudfs]
|
|
26
|
+
attr_reader :cloudfs
|
|
27
|
+
|
|
23
28
|
# List Migration Source coverage
|
|
24
29
|
#
|
|
25
30
|
# @overload list_migration_source_coverage(request_options: {})
|
|
@@ -47,6 +52,7 @@ module Telnyx
|
|
|
47
52
|
@migration_sources = Telnyx::Resources::Storage::MigrationSources.new(client: client)
|
|
48
53
|
@migrations = Telnyx::Resources::Storage::Migrations.new(client: client)
|
|
49
54
|
@kvs = Telnyx::Resources::Storage::Kvs.new(client: client)
|
|
55
|
+
@cloudfs = Telnyx::Resources::Storage::Cloudfs.new(client: client)
|
|
50
56
|
end
|
|
51
57
|
end
|
|
52
58
|
end
|
data/lib/telnyx/version.rb
CHANGED