telnyx 5.167.0 → 5.168.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.
Files changed (167) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +4 -0
  5. data/lib/telnyx/models/ai/assistant_a2_a_agent.rb +195 -0
  6. data/lib/telnyx/models/ai/assistant_create_params.rb +16 -1
  7. data/lib/telnyx/models/ai/assistant_update_params.rb +17 -1
  8. data/lib/telnyx/models/ai/assistants/update_assistant.rb +17 -1
  9. data/lib/telnyx/models/ai/chat_completion_request.rb +125 -48
  10. data/lib/telnyx/models/ai/inference_embedding.rb +16 -1
  11. data/lib/telnyx/models/ai/telephony_settings.rb +15 -1
  12. data/lib/telnyx/models/compute/func_retrieve_logs_params.rb +66 -0
  13. data/lib/telnyx/models/compute/func_retrieve_logs_response.rb +161 -0
  14. data/lib/telnyx/models/compute/func_retrieve_metric_aggregates_params.rb +69 -0
  15. data/lib/telnyx/models/compute/func_retrieve_metric_aggregates_response.rb +137 -0
  16. data/lib/telnyx/models/compute/func_retrieve_revisions_params.rb +34 -0
  17. data/lib/telnyx/models/compute/func_retrieve_revisions_response.rb +101 -0
  18. data/lib/telnyx/models/compute/func_retrieve_ship_inspection_params.rb +22 -0
  19. data/lib/telnyx/models/compute/func_retrieve_ship_inspection_response.rb +94 -0
  20. data/lib/telnyx/models/compute/functions_observability_pagination_meta.rb +35 -0
  21. data/lib/telnyx/models/compute/logs_meta.rb +23 -0
  22. data/lib/telnyx/models/credential_connection.rb +4 -1
  23. data/lib/telnyx/models/email_inboxes/email_message.rb +12 -1
  24. data/lib/telnyx/models/email_message_batch_params.rb +4 -1
  25. data/lib/telnyx/models/email_message_batch_response.rb +1 -0
  26. data/lib/telnyx/models/fqdn_connection.rb +5 -2
  27. data/lib/telnyx/models/fqdn_connections/fqdn_authentication.rb +9 -2
  28. data/lib/telnyx/models/messaging_inbound_message_payload.rb +210 -67
  29. data/lib/telnyx/models/messaging_messaging_profile.rb +11 -1
  30. data/lib/telnyx/models/messaging_profile_create_params.rb +11 -1
  31. data/lib/telnyx/models/messaging_profile_features.rb +26 -0
  32. data/lib/telnyx/models/messaging_profile_update_params.rb +11 -1
  33. data/lib/telnyx/models/uac_connection.rb +4 -1
  34. data/lib/telnyx/models/uac_external_settings.rb +6 -2
  35. data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +5 -1
  36. data/lib/telnyx/models/unwrap_webhook_event.rb +5 -1
  37. data/lib/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rb +104 -1
  38. data/lib/telnyx/models/whatsapp/phone_number_get_response.rb +103 -1
  39. data/lib/telnyx/models/whatsapp/phone_number_list_response.rb +103 -1
  40. data/lib/telnyx/models/whatsapp/phone_number_retrieve_phone_number_params.rb +22 -0
  41. data/lib/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rb +207 -0
  42. data/lib/telnyx/models/whatsapp_account_update.rb +112 -0
  43. data/lib/telnyx/models/whatsapp_message_echo.rb +340 -0
  44. data/lib/telnyx/models/x402/credit_account/payment_list_params.rb +34 -0
  45. data/lib/telnyx/models/x402/credit_account/payment_retrieve_params.rb +24 -0
  46. data/lib/telnyx/models/x402/credit_account/payment_retrieve_response.rb +21 -0
  47. data/lib/telnyx/models/x402/credit_account/x402_transaction_record.rb +113 -0
  48. data/lib/telnyx/models.rb +8 -0
  49. data/lib/telnyx/resources/ai/assistants/versions.rb +3 -1
  50. data/lib/telnyx/resources/ai/assistants.rb +6 -2
  51. data/lib/telnyx/resources/ai/openai/chat.rb +2 -8
  52. data/lib/telnyx/resources/compute/funcs.rb +141 -0
  53. data/lib/telnyx/resources/compute.rb +18 -0
  54. data/lib/telnyx/resources/email_messages.rb +4 -2
  55. data/lib/telnyx/resources/messaging_profiles.rb +6 -2
  56. data/lib/telnyx/resources/webhooks.rb +2 -2
  57. data/lib/telnyx/resources/whatsapp/phone_numbers.rb +22 -0
  58. data/lib/telnyx/resources/x402/credit_account/payments.rb +71 -0
  59. data/lib/telnyx/resources/x402/credit_account.rb +8 -2
  60. data/lib/telnyx/version.rb +1 -1
  61. data/lib/telnyx.rb +23 -0
  62. data/rbi/telnyx/client.rbi +3 -0
  63. data/rbi/telnyx/models/ai/assistant_a2_a_agent.rbi +345 -0
  64. data/rbi/telnyx/models/ai/assistant_create_params.rbi +29 -0
  65. data/rbi/telnyx/models/ai/assistant_update_params.rbi +31 -0
  66. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +31 -0
  67. data/rbi/telnyx/models/ai/chat_completion_request.rbi +224 -92
  68. data/rbi/telnyx/models/ai/inference_embedding.rbi +29 -0
  69. data/rbi/telnyx/models/ai/telephony_settings.rbi +23 -0
  70. data/rbi/telnyx/models/compute/func_retrieve_logs_params.rbi +130 -0
  71. data/rbi/telnyx/models/compute/func_retrieve_logs_response.rbi +410 -0
  72. data/rbi/telnyx/models/compute/func_retrieve_metric_aggregates_params.rbi +102 -0
  73. data/rbi/telnyx/models/compute/func_retrieve_metric_aggregates_response.rbi +231 -0
  74. data/rbi/telnyx/models/compute/func_retrieve_revisions_params.rbi +59 -0
  75. data/rbi/telnyx/models/compute/func_retrieve_revisions_response.rbi +213 -0
  76. data/rbi/telnyx/models/compute/func_retrieve_ship_inspection_params.rbi +40 -0
  77. data/rbi/telnyx/models/compute/func_retrieve_ship_inspection_response.rbi +252 -0
  78. data/rbi/telnyx/models/compute/functions_observability_pagination_meta.rbi +70 -0
  79. data/rbi/telnyx/models/compute/logs_meta.rbi +38 -0
  80. data/rbi/telnyx/models/credential_connection.rbi +8 -2
  81. data/rbi/telnyx/models/email_inboxes/email_message.rbi +22 -3
  82. data/rbi/telnyx/models/email_message_batch_params.rbi +6 -0
  83. data/rbi/telnyx/models/email_message_batch_response.rbi +5 -0
  84. data/rbi/telnyx/models/fqdn_connection.rbi +8 -2
  85. data/rbi/telnyx/models/fqdn_connections/fqdn_authentication.rbi +8 -2
  86. data/rbi/telnyx/models/messaging_inbound_message_payload.rbi +450 -193
  87. data/rbi/telnyx/models/messaging_messaging_profile.rbi +19 -0
  88. data/rbi/telnyx/models/messaging_profile_create_params.rbi +19 -0
  89. data/rbi/telnyx/models/messaging_profile_features.rbi +43 -0
  90. data/rbi/telnyx/models/messaging_profile_update_params.rbi +19 -0
  91. data/rbi/telnyx/models/uac_connection.rbi +8 -2
  92. data/rbi/telnyx/models/uac_external_settings.rbi +10 -2
  93. data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +3 -1
  94. data/rbi/telnyx/models/unwrap_webhook_event.rbi +3 -1
  95. data/rbi/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rbi +213 -0
  96. data/rbi/telnyx/models/whatsapp/phone_number_get_response.rbi +213 -0
  97. data/rbi/telnyx/models/whatsapp/phone_number_list_response.rbi +213 -0
  98. data/rbi/telnyx/models/whatsapp/phone_number_retrieve_phone_number_params.rbi +40 -0
  99. data/rbi/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rbi +401 -0
  100. data/rbi/telnyx/models/whatsapp_account_update.rbi +236 -0
  101. data/rbi/telnyx/models/whatsapp_message_echo.rbi +611 -0
  102. data/rbi/telnyx/models/x402/credit_account/payment_list_params.rbi +64 -0
  103. data/rbi/telnyx/models/x402/credit_account/payment_retrieve_params.rbi +42 -0
  104. data/rbi/telnyx/models/x402/credit_account/payment_retrieve_response.rbi +53 -0
  105. data/rbi/telnyx/models/x402/credit_account/x402_transaction_record.rbi +219 -0
  106. data/rbi/telnyx/models.rbi +8 -0
  107. data/rbi/telnyx/resources/ai/assistants/versions.rbi +12 -0
  108. data/rbi/telnyx/resources/ai/assistants.rbi +21 -0
  109. data/rbi/telnyx/resources/ai/openai/chat.rbi +9 -13
  110. data/rbi/telnyx/resources/compute/funcs.rbi +111 -0
  111. data/rbi/telnyx/resources/compute.rbi +15 -0
  112. data/rbi/telnyx/resources/email_messages.rbi +6 -2
  113. data/rbi/telnyx/resources/messaging_profiles.rbi +10 -0
  114. data/rbi/telnyx/resources/webhooks.rbi +6 -2
  115. data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi +18 -0
  116. data/rbi/telnyx/resources/x402/credit_account/payments.rbi +60 -0
  117. data/rbi/telnyx/resources/x402/credit_account.rbi +5 -0
  118. data/sig/telnyx/client.rbs +2 -0
  119. data/sig/telnyx/models/ai/assistant_a2_a_agent.rbs +140 -0
  120. data/sig/telnyx/models/ai/assistant_create_params.rbs +9 -0
  121. data/sig/telnyx/models/ai/assistant_update_params.rbs +9 -0
  122. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +9 -0
  123. data/sig/telnyx/models/ai/chat_completion_request.rbs +86 -44
  124. data/sig/telnyx/models/ai/inference_embedding.rbs +9 -0
  125. data/sig/telnyx/models/ai/telephony_settings.rbs +7 -0
  126. data/sig/telnyx/models/compute/func_retrieve_logs_params.rbs +69 -0
  127. data/sig/telnyx/models/compute/func_retrieve_logs_response.rbs +210 -0
  128. data/sig/telnyx/models/compute/func_retrieve_metric_aggregates_params.rbs +66 -0
  129. data/sig/telnyx/models/compute/func_retrieve_metric_aggregates_response.rbs +149 -0
  130. data/sig/telnyx/models/compute/func_retrieve_revisions_params.rbs +38 -0
  131. data/sig/telnyx/models/compute/func_retrieve_revisions_response.rbs +131 -0
  132. data/sig/telnyx/models/compute/func_retrieve_ship_inspection_params.rbs +22 -0
  133. data/sig/telnyx/models/compute/func_retrieve_ship_inspection_response.rbs +117 -0
  134. data/sig/telnyx/models/compute/functions_observability_pagination_meta.rbs +45 -0
  135. data/sig/telnyx/models/compute/logs_meta.rbs +21 -0
  136. data/sig/telnyx/models/email_inboxes/email_message.rbs +12 -3
  137. data/sig/telnyx/models/email_message_batch_response.rbs +2 -0
  138. data/sig/telnyx/models/messaging_inbound_message_payload.rbs +207 -95
  139. data/sig/telnyx/models/messaging_messaging_profile.rbs +5 -0
  140. data/sig/telnyx/models/messaging_profile_create_params.rbs +5 -0
  141. data/sig/telnyx/models/messaging_profile_features.rbs +15 -0
  142. data/sig/telnyx/models/messaging_profile_update_params.rbs +5 -0
  143. data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +2 -0
  144. data/sig/telnyx/models/unwrap_webhook_event.rbs +2 -0
  145. data/sig/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rbs +90 -0
  146. data/sig/telnyx/models/whatsapp/phone_number_get_response.rbs +90 -0
  147. data/sig/telnyx/models/whatsapp/phone_number_list_response.rbs +90 -0
  148. data/sig/telnyx/models/whatsapp/phone_number_retrieve_phone_number_params.rbs +25 -0
  149. data/sig/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rbs +201 -0
  150. data/sig/telnyx/models/whatsapp_account_update.rbs +107 -0
  151. data/sig/telnyx/models/whatsapp_message_echo.rbs +291 -0
  152. data/sig/telnyx/models/x402/credit_account/payment_list_params.rbs +36 -0
  153. data/sig/telnyx/models/x402/credit_account/payment_retrieve_params.rbs +27 -0
  154. data/sig/telnyx/models/x402/credit_account/payment_retrieve_response.rbs +26 -0
  155. data/sig/telnyx/models/x402/credit_account/x402_transaction_record.rbs +104 -0
  156. data/sig/telnyx/models.rbs +8 -0
  157. data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
  158. data/sig/telnyx/resources/ai/assistants.rbs +2 -0
  159. data/sig/telnyx/resources/ai/openai/chat.rbs +1 -4
  160. data/sig/telnyx/resources/compute/funcs.rbs +41 -0
  161. data/sig/telnyx/resources/compute.rbs +9 -0
  162. data/sig/telnyx/resources/messaging_profiles.rbs +2 -0
  163. data/sig/telnyx/resources/webhooks.rbs +6 -2
  164. data/sig/telnyx/resources/whatsapp/phone_numbers.rbs +5 -0
  165. data/sig/telnyx/resources/x402/credit_account/payments.rbs +22 -0
  166. data/sig/telnyx/resources/x402/credit_account.rbs +2 -0
  167. metadata +71 -2
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module X402
6
+ module CreditAccount
7
+ # @see Telnyx::Resources::X402::CreditAccount::Payments#list
8
+ class PaymentListParams < Telnyx::Internal::Type::BaseModel
9
+ extend Telnyx::Internal::Type::RequestParameters::Converter
10
+ include Telnyx::Internal::Type::RequestParameters
11
+
12
+ # @!attribute page_number
13
+ # The page number to load.
14
+ #
15
+ # @return [Integer, nil]
16
+ optional :page_number, Integer
17
+
18
+ # @!attribute page_size
19
+ # The size of the page.
20
+ #
21
+ # @return [Integer, nil]
22
+ optional :page_size, Integer
23
+
24
+ # @!method initialize(page_number: nil, page_size: nil, request_options: {})
25
+ # @param page_number [Integer] The page number to load.
26
+ #
27
+ # @param page_size [Integer] The size of the page.
28
+ #
29
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
30
+ end
31
+ end
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module X402
6
+ module CreditAccount
7
+ # @see Telnyx::Resources::X402::CreditAccount::Payments#retrieve
8
+ class PaymentRetrieveParams < Telnyx::Internal::Type::BaseModel
9
+ extend Telnyx::Internal::Type::RequestParameters::Converter
10
+ include Telnyx::Internal::Type::RequestParameters
11
+
12
+ # @!attribute id
13
+ #
14
+ # @return [String]
15
+ required :id, String
16
+
17
+ # @!method initialize(id:, request_options: {})
18
+ # @param id [String]
19
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module X402
6
+ module CreditAccount
7
+ # @see Telnyx::Resources::X402::CreditAccount::Payments#retrieve
8
+ class PaymentRetrieveResponse < Telnyx::Internal::Type::BaseModel
9
+ # @!attribute data
10
+ # An x402 payment transaction.
11
+ #
12
+ # @return [Telnyx::Models::X402::CreditAccount::X402TransactionRecord, nil]
13
+ optional :data, -> { Telnyx::X402::CreditAccount::X402TransactionRecord }
14
+
15
+ # @!method initialize(data: nil)
16
+ # @param data [Telnyx::Models::X402::CreditAccount::X402TransactionRecord] An x402 payment transaction.
17
+ end
18
+ end
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,113 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module X402
6
+ module CreditAccount
7
+ # @see Telnyx::Resources::X402::CreditAccount::Payments#list
8
+ class X402TransactionRecord < Telnyx::Internal::Type::BaseModel
9
+ # @!attribute id
10
+ # Unique transaction identifier.
11
+ #
12
+ # @return [String, nil]
13
+ optional :id, String
14
+
15
+ # @!attribute amount
16
+ # The transaction amount in the specified currency.
17
+ #
18
+ # @return [String, nil]
19
+ optional :amount, String
20
+
21
+ # @!attribute created_at
22
+ # ISO 8601 timestamp when the transaction was created.
23
+ #
24
+ # @return [Time, nil]
25
+ optional :created_at, Time
26
+
27
+ # @!attribute currency
28
+ # The currency of the transaction amount (e.g. USD).
29
+ #
30
+ # @return [String, nil]
31
+ optional :currency, String
32
+
33
+ # @!attribute quote_id
34
+ # The original quote ID associated with this transaction.
35
+ #
36
+ # @return [String, nil]
37
+ optional :quote_id, String
38
+
39
+ # @!attribute record_type
40
+ #
41
+ # @return [Symbol, Telnyx::Models::X402::CreditAccount::X402TransactionRecord::RecordType, nil]
42
+ optional :record_type, enum: -> { Telnyx::X402::CreditAccount::X402TransactionRecord::RecordType }
43
+
44
+ # @!attribute status
45
+ # The settlement status of the transaction. x402 transactions are created after
46
+ # successful on-chain settlement, so the status is `settled`.
47
+ #
48
+ # @return [Symbol, Telnyx::Models::X402::CreditAccount::X402TransactionRecord::Status, nil]
49
+ optional :status, enum: -> { Telnyx::X402::CreditAccount::X402TransactionRecord::Status }
50
+
51
+ # @!attribute tx_hash
52
+ # The on-chain transaction hash, if available.
53
+ #
54
+ # @return [String, nil]
55
+ optional :tx_hash, String, nil?: true
56
+
57
+ # @!attribute updated_at
58
+ # ISO 8601 timestamp when the transaction was last updated.
59
+ #
60
+ # @return [Time, nil]
61
+ optional :updated_at, Time
62
+
63
+ # @!method initialize(id: nil, amount: nil, created_at: nil, currency: nil, quote_id: nil, record_type: nil, status: nil, tx_hash: nil, updated_at: nil)
64
+ # Some parameter documentations has been truncated, see
65
+ # {Telnyx::Models::X402::CreditAccount::X402TransactionRecord} for more details.
66
+ #
67
+ # An x402 payment transaction.
68
+ #
69
+ # @param id [String] Unique transaction identifier.
70
+ #
71
+ # @param amount [String] The transaction amount in the specified currency.
72
+ #
73
+ # @param created_at [Time] ISO 8601 timestamp when the transaction was created.
74
+ #
75
+ # @param currency [String] The currency of the transaction amount (e.g. USD).
76
+ #
77
+ # @param quote_id [String] The original quote ID associated with this transaction.
78
+ #
79
+ # @param record_type [Symbol, Telnyx::Models::X402::CreditAccount::X402TransactionRecord::RecordType]
80
+ #
81
+ # @param status [Symbol, Telnyx::Models::X402::CreditAccount::X402TransactionRecord::Status] The settlement status of the transaction. x402 transactions are created after su
82
+ #
83
+ # @param tx_hash [String, nil] The on-chain transaction hash, if available.
84
+ #
85
+ # @param updated_at [Time] ISO 8601 timestamp when the transaction was last updated.
86
+
87
+ # @see Telnyx::Models::X402::CreditAccount::X402TransactionRecord#record_type
88
+ module RecordType
89
+ extend Telnyx::Internal::Type::Enum
90
+
91
+ X402_TRANSACTION = :x402_transaction
92
+
93
+ # @!method self.values
94
+ # @return [Array<Symbol>]
95
+ end
96
+
97
+ # The settlement status of the transaction. x402 transactions are created after
98
+ # successful on-chain settlement, so the status is `settled`.
99
+ #
100
+ # @see Telnyx::Models::X402::CreditAccount::X402TransactionRecord#status
101
+ module Status
102
+ extend Telnyx::Internal::Type::Enum
103
+
104
+ SETTLED = :settled
105
+
106
+ # @!method self.values
107
+ # @return [Array<Symbol>]
108
+ end
109
+ end
110
+ end
111
+ end
112
+ end
113
+ end
data/lib/telnyx/models.rb CHANGED
@@ -386,6 +386,8 @@ module Telnyx
386
386
 
387
387
  CommentRetrieveParams = Telnyx::Models::CommentRetrieveParams
388
388
 
389
+ Compute = Telnyx::Models::Compute
390
+
389
391
  Conference = Telnyx::Models::Conference
390
392
 
391
393
  ConferenceCreated = Telnyx::Models::ConferenceCreated
@@ -1173,6 +1175,8 @@ module Telnyx
1173
1175
 
1174
1176
  MessagingProfileDeleteParams = Telnyx::Models::MessagingProfileDeleteParams
1175
1177
 
1178
+ MessagingProfileFeatures = Telnyx::Models::MessagingProfileFeatures
1179
+
1176
1180
  MessagingProfileListAlphanumericSenderIDsParams =
1177
1181
  Telnyx::Models::MessagingProfileListAlphanumericSenderIDsParams
1178
1182
 
@@ -2161,6 +2165,8 @@ module Telnyx
2161
2165
 
2162
2166
  Whatsapp = Telnyx::Models::Whatsapp
2163
2167
 
2168
+ WhatsappAccountUpdate = Telnyx::Models::WhatsappAccountUpdate
2169
+
2164
2170
  WhatsappContact = Telnyx::Models::WhatsappContact
2165
2171
 
2166
2172
  WhatsappInteractive = Telnyx::Models::WhatsappInteractive
@@ -2171,6 +2177,8 @@ module Telnyx
2171
2177
 
2172
2178
  WhatsappMessageContent = Telnyx::Models::WhatsappMessageContent
2173
2179
 
2180
+ WhatsappMessageEcho = Telnyx::Models::WhatsappMessageEcho
2181
+
2174
2182
  WhatsappMessageTemplateDeleteParams = Telnyx::Models::WhatsappMessageTemplateDeleteParams
2175
2183
 
2176
2184
  WhatsappMessageTemplateRetrieveParams = Telnyx::Models::WhatsappMessageTemplateRetrieveParams
@@ -43,12 +43,14 @@ module Telnyx
43
43
  # Updates the configuration of a specific assistant version. Can not update main
44
44
  # version
45
45
  #
46
- # @overload update(version_id, assistant_id:, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
46
+ # @overload update(version_id, assistant_id:, a2a_agents: nil, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
47
47
  #
48
48
  # @param version_id [String] Path param: Unique identifier of the version.
49
49
  #
50
50
  # @param assistant_id [String] Path param: Unique identifier of the assistant.
51
51
  #
52
+ # @param a2a_agents [Array<Telnyx::Models::AI::AssistantA2AAgent>] Body param: A2A agents this assistant can delegate to. Tools are not stored here
53
+ #
52
54
  # @param conversation_flow [Telnyx::Models::AI::ConversationFlowReq] Body param: Conversation flow as supplied by API clients (create / update).
53
55
  #
54
56
  # @param description [String] Body param
@@ -39,12 +39,14 @@ module Telnyx
39
39
  # Creates a new AI assistant from the provided configuration, including its model,
40
40
  # instructions, and attached tools, and returns the created assistant.
41
41
  #
42
- # @overload create(instructions:, name:, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, idempotency_key: nil, request_options: {})
42
+ # @overload create(instructions:, name:, a2a_agents: nil, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, idempotency_key: nil, request_options: {})
43
43
  #
44
44
  # @param instructions [String] Body param: System instructions for the assistant. These may be templated with [
45
45
  #
46
46
  # @param name [String] Body param
47
47
  #
48
+ # @param a2a_agents [Array<Telnyx::Models::AI::AssistantA2AAgent>] Body param: A2A agents this assistant can delegate to. Tools are not stored here
49
+ #
48
50
  # @param conversation_flow [Telnyx::Models::AI::ConversationFlowReq] Body param: Conversation flow as supplied by API clients (create / update).
49
51
  #
50
52
  # @param description [String] Body param
@@ -155,10 +157,12 @@ module Telnyx
155
157
  # assistant. The request can also control how the change is promoted across
156
158
  # assistant versions.
157
159
  #
158
- # @overload update(assistant_id, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, promote_to_main: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
160
+ # @overload update(assistant_id, a2a_agents: nil, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, promote_to_main: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
159
161
  #
160
162
  # @param assistant_id [String] Unique identifier of the assistant.
161
163
  #
164
+ # @param a2a_agents [Array<Telnyx::Models::AI::AssistantA2AAgent>] A2A agents this assistant can delegate to. Tools are not stored here: at the sta
165
+ #
162
166
  # @param conversation_flow [Telnyx::Models::AI::ConversationFlowReq] Conversation flow as supplied by API clients (create / update).
163
167
  #
164
168
  # @param description [String]
@@ -13,7 +13,7 @@ module Telnyx
13
13
  # and may be used with the OpenAI JS or Python SDK by setting the base URL to
14
14
  # `https://api.telnyx.com/v2/ai/openai`.
15
15
  #
16
- # @overload create_completion(messages:, api_key_ref: nil, best_of: nil, early_stopping: nil, enable_thinking: nil, frequency_penalty: nil, guided_choice: nil, guided_json: nil, guided_regex: nil, length_penalty: nil, logprobs: nil, max_tokens: nil, min_p: nil, mode: nil, model: nil, n: nil, presence_penalty: nil, reasoning_effort: nil, region: nil, response_format: nil, seed: nil, service_tier: nil, stop: nil, stream: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, use_beam_search: nil, request_options: {})
16
+ # @overload create_completion(messages:, api_key_ref: nil, best_of: nil, early_stopping: nil, enable_thinking: nil, frequency_penalty: nil, length_penalty: nil, logprobs: nil, max_tokens: nil, min_p: nil, mode: nil, model: nil, n: nil, presence_penalty: nil, reasoning_effort: nil, region: nil, response_format: nil, seed: nil, service_tier: nil, stop: nil, stream: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, use_beam_search: nil, request_options: {})
17
17
  #
18
18
  # @param messages [Array<Telnyx::Models::AI::ChatCompletionRequest::Message>] A list of the previous chat messages for context.
19
19
  #
@@ -27,12 +27,6 @@ module Telnyx
27
27
  #
28
28
  # @param frequency_penalty [Float] Higher values will penalize the model from repeating the same output tokens.
29
29
  #
30
- # @param guided_choice [Array<String>] If specified, the output will be exactly one of the choices.
31
- #
32
- # @param guided_json [Hash{Symbol=>Object}] Must be a valid JSON schema. If specified, the output will follow the JSON schem
33
- #
34
- # @param guided_regex [String] If specified, the output will follow the regex pattern.
35
- #
36
30
  # @param length_penalty [Float] This is used with `use_beam_search` to prefer shorter or longer completions.
37
31
  #
38
32
  # @param logprobs [Boolean] Whether to return log probabilities of the output tokens or not. If true, return
@@ -53,7 +47,7 @@ module Telnyx
53
47
  #
54
48
  # @param region [Symbol, Telnyx::Models::AI::ChatCompletionRequest::Region] Optional data-residency region the request should be served from, using the same
55
49
  #
56
- # @param response_format [Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat] Use this is you want to guarantee a JSON output without defining a schema. For c
50
+ # @param response_format [Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatText, Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonObject, Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonSchemaParam] Controls the format of the model output. `json_object` guarantees valid JSON out
57
51
  #
58
52
  # @param seed [Integer] If specified, the system will make a best effort to sample deterministically, su
59
53
  #
@@ -0,0 +1,141 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Resources
5
+ class Compute
6
+ class Funcs
7
+ # Returns logs oldest first. `type=runtime` (default) returns function
8
+ # stdout/stderr. `type=invocations` returns one platform-generated record per HTTP
9
+ # request served.
10
+ #
11
+ # @overload retrieve_logs(id, end_time: nil, limit: nil, start_time: nil, type: nil, request_options: {})
12
+ #
13
+ # @param id [String] Function ID
14
+ #
15
+ # @param end_time [Time] Return records at or before this RFC 3339 timestamp.
16
+ #
17
+ # @param limit [Integer] Maximum records to return.
18
+ #
19
+ # @param start_time [Time] Return records at or after this RFC 3339 timestamp.
20
+ #
21
+ # @param type [Symbol, Telnyx::Models::Compute::FuncRetrieveLogsParams::Type] Log stream to return.
22
+ #
23
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
24
+ #
25
+ # @return [Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncRuntimeLogsResponse, Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncInvocationLogsResponse]
26
+ #
27
+ # @see Telnyx::Models::Compute::FuncRetrieveLogsParams
28
+ def retrieve_logs(id, params = {})
29
+ parsed, options = Telnyx::Compute::FuncRetrieveLogsParams.dump_request(params)
30
+ query = Telnyx::Internal::Util.encode_query_params(parsed)
31
+ @client.request(
32
+ method: :get,
33
+ path: ["compute/funcs/%1$s/logs", id],
34
+ query: query,
35
+ model: Telnyx::Models::Compute::FuncRetrieveLogsResponse,
36
+ options: options
37
+ )
38
+ end
39
+
40
+ # Returns aggregate request, latency, CPU, memory, and resource-limit metrics for
41
+ # a function over the requested window.
42
+ #
43
+ # @overload retrieve_metric_aggregates(id, end_time:, start_time:, filter_edge_site: nil, filter_namespace: nil, page_number: nil, page_size: nil, request_options: {})
44
+ #
45
+ # @param id [String] Function ID
46
+ #
47
+ # @param end_time [Time] Exclusive window end, UTC ISO 8601 with milliseconds
48
+ #
49
+ # @param start_time [Time] Inclusive window start, UTC ISO 8601 with milliseconds
50
+ #
51
+ # @param filter_edge_site [String] Edge site filter
52
+ #
53
+ # @param filter_namespace [String] Kubernetes namespace filter
54
+ #
55
+ # @param page_number [Integer]
56
+ #
57
+ # @param page_size [Integer]
58
+ #
59
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
60
+ #
61
+ # @return [Telnyx::Models::Compute::FuncRetrieveMetricAggregatesResponse]
62
+ #
63
+ # @see Telnyx::Models::Compute::FuncRetrieveMetricAggregatesParams
64
+ def retrieve_metric_aggregates(id, params)
65
+ parsed, options = Telnyx::Compute::FuncRetrieveMetricAggregatesParams.dump_request(params)
66
+ query = Telnyx::Internal::Util.encode_query_params(parsed)
67
+ @client.request(
68
+ method: :get,
69
+ path: ["compute/funcs/%1$s/metric_aggregates", id],
70
+ query: query.transform_keys(
71
+ filter_edge_site: "filter[edge_site]",
72
+ filter_namespace: "filter[namespace]",
73
+ page_number: "page[number]",
74
+ page_size: "page[size]"
75
+ ),
76
+ model: Telnyx::Models::Compute::FuncRetrieveMetricAggregatesResponse,
77
+ options: options
78
+ )
79
+ end
80
+
81
+ # Lists a function's ship history newest first, including per-ship failure stage
82
+ # and reason when recorded.
83
+ #
84
+ # @overload retrieve_revisions(id, page_number: nil, page_size: nil, request_options: {})
85
+ #
86
+ # @param id [String] Function ID
87
+ #
88
+ # @param page_number [Integer]
89
+ #
90
+ # @param page_size [Integer]
91
+ #
92
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
93
+ #
94
+ # @return [Telnyx::Models::Compute::FuncRetrieveRevisionsResponse]
95
+ #
96
+ # @see Telnyx::Models::Compute::FuncRetrieveRevisionsParams
97
+ def retrieve_revisions(id, params = {})
98
+ parsed, options = Telnyx::Compute::FuncRetrieveRevisionsParams.dump_request(params)
99
+ query = Telnyx::Internal::Util.encode_query_params(parsed)
100
+ @client.request(
101
+ method: :get,
102
+ path: ["compute/funcs/%1$s/revisions", id],
103
+ query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
104
+ model: Telnyx::Models::Compute::FuncRetrieveRevisionsResponse,
105
+ options: options
106
+ )
107
+ end
108
+
109
+ # Returns the latest ship outcome. The stage is `none` on success, `pending` while
110
+ # building, or a failure stage such as `build`, `platform`, `pre_build`, `deploy`,
111
+ # or `security_review`. This stage-neutral customer-facing path is an alias over
112
+ # the same inspection resource as `build_log_inspection`.
113
+ #
114
+ # @overload retrieve_ship_inspection(id, request_options: {})
115
+ #
116
+ # @param id [String] Function ID
117
+ #
118
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
119
+ #
120
+ # @return [Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse]
121
+ #
122
+ # @see Telnyx::Models::Compute::FuncRetrieveShipInspectionParams
123
+ def retrieve_ship_inspection(id, params = {})
124
+ @client.request(
125
+ method: :get,
126
+ path: ["compute/funcs/%1$s/ship_inspection", id],
127
+ model: Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse,
128
+ options: params[:request_options]
129
+ )
130
+ end
131
+
132
+ # @api private
133
+ #
134
+ # @param client [Telnyx::Client]
135
+ def initialize(client:)
136
+ @client = client
137
+ end
138
+ end
139
+ end
140
+ end
141
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Resources
5
+ class Compute
6
+ # @return [Telnyx::Resources::Compute::Funcs]
7
+ attr_reader :funcs
8
+
9
+ # @api private
10
+ #
11
+ # @param client [Telnyx::Client]
12
+ def initialize(client:)
13
+ @client = client
14
+ @funcs = Telnyx::Resources::Compute::Funcs.new(client: client)
15
+ end
16
+ end
17
+ end
18
+ end
@@ -172,11 +172,13 @@ module Telnyx
172
172
  # Some parameter documentations has been truncated, see
173
173
  # {Telnyx::Models::EmailMessageBatchParams} for more details.
174
174
  #
175
- # Creates up to 50 email messages in a single request.
175
+ # Creates up to 1,000 email messages in a single request. Each message is
176
+ # validated and sent independently; per-message failures do not affect other
177
+ # messages in the batch. All responses use 207 Multi-Status.
176
178
  #
177
179
  # @overload batch(messages:, sandbox_mode: nil, idempotency_key: nil, request_options: {})
178
180
  #
179
- # @param messages [Array<Telnyx::Models::EmailMessageBatchParams::Message>] Body param
181
+ # @param messages [Array<Telnyx::Models::EmailMessageBatchParams::Message>] Body param: Array of email messages to send. Up to 1,000 messages per batch requ
180
182
  #
181
183
  # @param sandbox_mode [Boolean] Body param: Applies sandbox mode to all messages in the batch. Overrides any per
182
184
  #
@@ -16,7 +16,7 @@ module Telnyx
16
16
  # Creates a messaging profile that controls outbound sender selection, webhook
17
17
  # delivery, and inbound message handling for associated numbers and short codes.
18
18
  #
19
- # @overload create(name:, whitelisted_destinations:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, resource_group_id: nil, smart_encoding: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
19
+ # @overload create(name:, whitelisted_destinations:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, resource_group_id: nil, smart_encoding: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
20
20
  #
21
21
  # @param name [String] A user friendly name for the messaging profile.
22
22
  #
@@ -32,6 +32,8 @@ module Telnyx
32
32
  #
33
33
  # @param enabled [Boolean] Specifies whether the messaging profile is enabled or not.
34
34
  #
35
+ # @param features [Telnyx::Models::MessagingProfileFeatures, nil] Telnyx product features the messaging customer can enable on the messaging profi
36
+ #
35
37
  # @param health_webhook_url [String, nil] A URL to receive health check webhooks for numbers in this profile.
36
38
  #
37
39
  # @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
@@ -97,7 +99,7 @@ module Telnyx
97
99
  # Updates the supplied settings on the specified messaging profile. Settings
98
100
  # omitted from the request remain unchanged.
99
101
  #
100
- # @overload update(messaging_profile_id, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, redaction_enabled: nil, redaction_level: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
102
+ # @overload update(messaging_profile_id, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, redaction_enabled: nil, redaction_level: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
101
103
  #
102
104
  # @param messaging_profile_id [String] The id of the messaging profile to retrieve
103
105
  #
@@ -111,6 +113,8 @@ module Telnyx
111
113
  #
112
114
  # @param enabled [Boolean] Specifies whether the messaging profile is enabled or not.
113
115
  #
116
+ # @param features [Telnyx::Models::MessagingProfileFeatures, nil] Telnyx product features the messaging customer can enable on the messaging profi
117
+ #
114
118
  # @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
115
119
  #
116
120
  # @param mms_transcoding [Boolean] enables automated resizing of MMS media.
@@ -5,7 +5,7 @@ module Telnyx
5
5
  class Webhooks
6
6
  # @param payload [String] The raw webhook payload as a string
7
7
  #
8
- # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
8
+ # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho]
9
9
  def unsafe_unwrap(payload)
10
10
  parsed = JSON.parse(payload, symbolize_names: true)
11
11
  Telnyx::Internal::Type::Converter.coerce(Telnyx::Models::UnsafeUnwrapWebhookEvent, parsed)
@@ -17,7 +17,7 @@ module Telnyx
17
17
  #
18
18
  # @param key [String, nil] The webhook signing key
19
19
  #
20
- # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
20
+ # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho]
21
21
  def unwrap(payload, headers:, key: @client.public_key)
22
22
  if key.nil?
23
23
  raise ArgumentError.new("Cannot verify a webhook without a key on either the client's public_key or passed in as an argument")
@@ -135,6 +135,28 @@ module Telnyx
135
135
  )
136
136
  end
137
137
 
138
+ # Returns one WhatsApp phone number linked to the authenticated Telnyx account.
139
+ # For a coexistence number in the `syncing` state, the response includes
140
+ # `sync_progress`.
141
+ #
142
+ # @overload retrieve_phone_number(phone_number, request_options: {})
143
+ #
144
+ # @param phone_number [String] Phone number (E.164 format)
145
+ #
146
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
147
+ #
148
+ # @return [Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse]
149
+ #
150
+ # @see Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberParams
151
+ def retrieve_phone_number(phone_number, params = {})
152
+ @client.request(
153
+ method: :get,
154
+ path: ["whatsapp/phone_numbers/%1$s", phone_number],
155
+ model: Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse,
156
+ options: params[:request_options]
157
+ )
158
+ end
159
+
138
160
  # Submits the verification code received for the specified WhatsApp phone number.
139
161
  #
140
162
  # @overload verify(phone_number, code:, request_options: {})