telnyx 5.35.0 → 5.36.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 (73) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/internal/type/base_model.rb +1 -1
  5. data/lib/telnyx/models/ai/conversation_add_message_params.rb +4 -4
  6. data/lib/telnyx/models/api_error.rb +4 -4
  7. data/lib/telnyx/models/available_phone_number_block_list_response.rb +7 -7
  8. data/lib/telnyx/models/conferences/{action_end_params.rb → action_end_conference_params.rb} +3 -3
  9. data/lib/telnyx/models/conferences/{action_end_response.rb → action_end_conference_response.rb} +2 -2
  10. data/lib/telnyx/models/conferences/{action_gather_using_audio_params.rb → action_gather_dtmf_audio_params.rb} +3 -3
  11. data/lib/telnyx/models/conferences/{action_gather_using_audio_response.rb → action_gather_dtmf_audio_response.rb} +2 -2
  12. data/lib/telnyx/models/customer_service_record.rb +9 -1
  13. data/lib/telnyx/models/number_reservation.rb +9 -1
  14. data/lib/telnyx/models/phone_number_delete_response.rb +9 -1
  15. data/lib/telnyx/models/phone_number_detailed.rb +17 -1
  16. data/lib/telnyx/models/phone_number_slim_list_response.rb +17 -1
  17. data/lib/telnyx/models/phone_number_update_params.rb +9 -1
  18. data/lib/telnyx/models/porting_order.rb +180 -1
  19. data/lib/telnyx/models/porting_orders/phone_number_block_list_params.rb +7 -7
  20. data/lib/telnyx/models/reserved_phone_number.rb +9 -1
  21. data/lib/telnyx/models/room_composition.rb +9 -1
  22. data/lib/telnyx/models/telephony_credential.rb +9 -1
  23. data/lib/telnyx/models/texml/accounts/call_calls_params.rb +4 -4
  24. data/lib/telnyx/resources/conferences/actions.rb +14 -14
  25. data/lib/telnyx/resources/phone_numbers.rb +3 -1
  26. data/lib/telnyx/resources/texml/accounts/calls.rb +2 -2
  27. data/lib/telnyx/version.rb +1 -1
  28. data/lib/telnyx.rb +4 -4
  29. data/rbi/telnyx/models/ai/conversation_add_message_params.rbi +5 -5
  30. data/rbi/telnyx/models/api_error.rbi +6 -6
  31. data/rbi/telnyx/models/available_phone_number_block_list_response.rbi +12 -12
  32. data/rbi/telnyx/models/conferences/{action_end_params.rbi → action_end_conference_params.rbi} +2 -2
  33. data/rbi/telnyx/models/conferences/{action_end_response.rbi → action_end_conference_response.rbi} +2 -2
  34. data/rbi/telnyx/models/conferences/{action_gather_using_audio_params.rbi → action_gather_dtmf_audio_params.rbi} +2 -2
  35. data/rbi/telnyx/models/conferences/{action_gather_using_audio_response.rbi → action_gather_dtmf_audio_response.rbi} +2 -2
  36. data/rbi/telnyx/models/customer_service_record.rbi +14 -3
  37. data/rbi/telnyx/models/number_reservation.rbi +11 -0
  38. data/rbi/telnyx/models/phone_number_delete_response.rbi +11 -0
  39. data/rbi/telnyx/models/phone_number_detailed.rbi +25 -3
  40. data/rbi/telnyx/models/phone_number_slim_list_response.rbi +25 -3
  41. data/rbi/telnyx/models/phone_number_update_params.rbi +11 -0
  42. data/rbi/telnyx/models/porting_order.rbi +495 -0
  43. data/rbi/telnyx/models/porting_orders/phone_number_block_list_params.rbi +18 -18
  44. data/rbi/telnyx/models/reserved_phone_number.rbi +11 -0
  45. data/rbi/telnyx/models/room_composition.rbi +11 -0
  46. data/rbi/telnyx/models/telephony_credential.rbi +14 -3
  47. data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +6 -6
  48. data/rbi/telnyx/resources/conferences/actions.rbi +4 -4
  49. data/rbi/telnyx/resources/phone_numbers.rbi +3 -0
  50. data/rbi/telnyx/resources/texml/accounts/calls.rbi +2 -2
  51. data/sig/telnyx/models/ai/conversation_add_message_params.rbs +5 -5
  52. data/sig/telnyx/models/api_error.rbs +5 -5
  53. data/sig/telnyx/models/available_phone_number_block_list_response.rbs +10 -10
  54. data/sig/telnyx/models/conferences/{action_end_params.rbs → action_end_conference_params.rbs} +2 -2
  55. data/sig/telnyx/models/conferences/{action_end_response.rbs → action_end_conference_response.rbs} +2 -2
  56. data/sig/telnyx/models/conferences/{action_gather_using_audio_params.rbs → action_gather_dtmf_audio_params.rbs} +2 -2
  57. data/sig/telnyx/models/conferences/{action_gather_using_audio_response.rbs → action_gather_dtmf_audio_response.rbs} +2 -2
  58. data/sig/telnyx/models/customer_service_record.rbs +10 -3
  59. data/sig/telnyx/models/number_reservation.rbs +7 -0
  60. data/sig/telnyx/models/phone_number_delete_response.rbs +7 -0
  61. data/sig/telnyx/models/phone_number_detailed.rbs +17 -3
  62. data/sig/telnyx/models/phone_number_slim_list_response.rbs +17 -3
  63. data/sig/telnyx/models/phone_number_update_params.rbs +7 -0
  64. data/sig/telnyx/models/porting_order.rbs +199 -0
  65. data/sig/telnyx/models/porting_orders/phone_number_block_list_params.rbs +5 -5
  66. data/sig/telnyx/models/reserved_phone_number.rbs +7 -0
  67. data/sig/telnyx/models/room_composition.rbs +7 -0
  68. data/sig/telnyx/models/telephony_credential.rbs +10 -3
  69. data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +5 -5
  70. data/sig/telnyx/resources/conferences/actions.rbs +4 -4
  71. data/sig/telnyx/resources/phone_numbers.rbs +1 -0
  72. data/sig/telnyx/resources/texml/accounts/calls.rbs +1 -1
  73. metadata +13 -13
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1e645ba6a9061dc718c1f7a5529148efe72a16ece964549ce097b38054faca4f
4
- data.tar.gz: 46bd67aac79c0eaac41b03767e81bacd88d79e2221047541bdde20b32cca437b
3
+ metadata.gz: f11e82841a4f0ab08500d9643c03692b1d5237bf37a48b10c446bb875862e3ba
4
+ data.tar.gz: 9ee736e5619354cfd3e7f097446090800c9aa31c5aad3cf9c0c7ebb3404e8b5b
5
5
  SHA512:
6
- metadata.gz: a5e0273786072f20e1fa458ba7ffe87b253fa953110136a0ea1fe240431c78c154e0be360fd036130383f523cba473d6365e9bfdd22d0ecebe2eef8efa630c92
7
- data.tar.gz: 7d5cdb767a4d61702b16b30f1cd97ff69a5a8392dc911a587cdb152a6746340accfe1fbf190b26af1e50a1c8866189cf0bf7d50d0c442c9bfa4956fded392c7a
6
+ metadata.gz: 4a169cfa53dc5a828e372e78500579454a646ee8f1a6c0e72b370eca1cc81fd0b9a6e6b7ad976166aa61df2e0c57a7c3b7b71c9738dbd673d8fd9c53acf39356
7
+ data.tar.gz: 9b413e23f7cca8cf23734f6245761249449a830b99a99f1e822812f1b4d23b4c5037f9da5ad6bc3f4cb6276d01b1804b413d6ecae0b1f136b0e7367c03e53c87
data/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## 5.36.0 (2026-02-20)
4
+
5
+ Full Changelog: [v5.35.0...v5.36.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.35.0...v5.36.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** manual updates ([eaf686d](https://github.com/team-telnyx/telnyx-ruby/commit/eaf686da95ddfdec3860bfe85233874e72ef44b8))
10
+ * fix-stainless-sdk-timeout ([611e77c](https://github.com/team-telnyx/telnyx-ruby/commit/611e77c332f7c627976428a0f92648e06666224f))
11
+
12
+
13
+ ### Bug Fixes
14
+
15
+ * move unsupported string formats to x-format ([52b1b5e](https://github.com/team-telnyx/telnyx-ruby/commit/52b1b5e2de3c0ade5595a4825f542ff4f896b0ac))
16
+
3
17
  ## 5.35.0 (2026-02-20)
4
18
 
5
19
  Full Changelog: [v5.34.0...v5.35.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.34.0...v5.35.0)
data/README.md CHANGED
@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
24
24
  <!-- x-release-please-start-version -->
25
25
 
26
26
  ```ruby
27
- gem "telnyx", "~> 5.35.0"
27
+ gem "telnyx", "~> 5.36.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -442,7 +442,7 @@ module Telnyx
442
442
  # api_error => {
443
443
  # code: code,
444
444
  # title: title,
445
- # detail: detail
445
+ # description: description
446
446
  # }
447
447
  def deconstruct_keys(keys)
448
448
  (keys || self.class.known_fields.keys)
@@ -70,9 +70,9 @@ module Telnyx
70
70
 
71
71
  variant Telnyx::Internal::Type::Boolean
72
72
 
73
- variant -> { Telnyx::Models::AI::ConversationAddMessageParams::Metadata::UnionMember3Array }
73
+ variant -> { Telnyx::Models::AI::ConversationAddMessageParams::Metadata::UnionArrayVariant3Array }
74
74
 
75
- module UnionMember3
75
+ module UnionArrayVariant3
76
76
  extend Telnyx::Internal::Type::Union
77
77
 
78
78
  variant String
@@ -89,9 +89,9 @@ module Telnyx
89
89
  # @return [Array(String, Integer, Boolean, Array<String, Integer, Boolean>)]
90
90
 
91
91
  # @type [Telnyx::Internal::Type::Converter]
92
- UnionMember3Array =
92
+ UnionArrayVariant3Array =
93
93
  Telnyx::Internal::Type::ArrayOf[union: -> {
94
- Telnyx::AI::ConversationAddMessageParams::Metadata::UnionMember3
94
+ Telnyx::AI::ConversationAddMessageParams::Metadata::UnionArrayVariant3
95
95
  }]
96
96
  end
97
97
 
@@ -13,10 +13,10 @@ module Telnyx
13
13
  # @return [String]
14
14
  required :title, String
15
15
 
16
- # @!attribute detail
16
+ # @!attribute description
17
17
  #
18
18
  # @return [String, nil]
19
- optional :detail, String
19
+ optional :description, String
20
20
 
21
21
  # @!attribute meta
22
22
  #
@@ -28,10 +28,10 @@ module Telnyx
28
28
  # @return [Telnyx::Models::APIError::Source, nil]
29
29
  optional :source, -> { Telnyx::APIError::Source }
30
30
 
31
- # @!method initialize(code:, title:, detail: nil, meta: nil, source: nil)
31
+ # @!method initialize(code:, title:, description: nil, meta: nil, source: nil)
32
32
  # @param code [String]
33
33
  # @param title [String]
34
- # @param detail [String]
34
+ # @param description [String]
35
35
  # @param meta [Hash{Symbol=>Object}]
36
36
  # @param source [Telnyx::Models::APIError::Source]
37
37
 
@@ -32,6 +32,11 @@ module Telnyx
32
32
  optional :features,
33
33
  -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AvailablePhoneNumberBlockListResponse::Data::Feature] }
34
34
 
35
+ # @!attribute phone_number
36
+ #
37
+ # @return [String, nil]
38
+ optional :phone_number, String
39
+
35
40
  # @!attribute range
36
41
  #
37
42
  # @return [Integer, nil]
@@ -49,18 +54,13 @@ module Telnyx
49
54
  optional :region_information,
50
55
  -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AvailablePhoneNumberBlockListResponse::Data::RegionInformation] }
51
56
 
52
- # @!attribute starting_number
53
- #
54
- # @return [String, nil]
55
- optional :starting_number, String
56
-
57
- # @!method initialize(cost_information: nil, features: nil, range: nil, record_type: nil, region_information: nil, starting_number: nil)
57
+ # @!method initialize(cost_information: nil, features: nil, phone_number: nil, range: nil, record_type: nil, region_information: nil)
58
58
  # @param cost_information [Telnyx::Models::AvailablePhoneNumberBlockListResponse::Data::CostInformation]
59
59
  # @param features [Array<Telnyx::Models::AvailablePhoneNumberBlockListResponse::Data::Feature>]
60
+ # @param phone_number [String]
60
61
  # @param range [Integer]
61
62
  # @param record_type [Symbol, Telnyx::Models::AvailablePhoneNumberBlockListResponse::Data::RecordType]
62
63
  # @param region_information [Array<Telnyx::Models::AvailablePhoneNumberBlockListResponse::Data::RegionInformation>]
63
- # @param starting_number [String]
64
64
 
65
65
  # @see Telnyx::Models::AvailablePhoneNumberBlockListResponse::Data#cost_information
66
66
  class CostInformation < Telnyx::Internal::Type::BaseModel
@@ -3,8 +3,8 @@
3
3
  module Telnyx
4
4
  module Models
5
5
  module Conferences
6
- # @see Telnyx::Resources::Conferences::Actions#end_
7
- class ActionEndParams < Telnyx::Internal::Type::BaseModel
6
+ # @see Telnyx::Resources::Conferences::Actions#end_conference
7
+ class ActionEndConferenceParams < Telnyx::Internal::Type::BaseModel
8
8
  extend Telnyx::Internal::Type::RequestParameters::Converter
9
9
  include Telnyx::Internal::Type::RequestParameters
10
10
 
@@ -17,7 +17,7 @@ module Telnyx
17
17
 
18
18
  # @!method initialize(command_id: nil, request_options: {})
19
19
  # Some parameter documentations has been truncated, see
20
- # {Telnyx::Models::Conferences::ActionEndParams} for more details.
20
+ # {Telnyx::Models::Conferences::ActionEndConferenceParams} for more details.
21
21
  #
22
22
  # @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
23
23
  #
@@ -3,8 +3,8 @@
3
3
  module Telnyx
4
4
  module Models
5
5
  module Conferences
6
- # @see Telnyx::Resources::Conferences::Actions#end_
7
- class ActionEndResponse < Telnyx::Internal::Type::BaseModel
6
+ # @see Telnyx::Resources::Conferences::Actions#end_conference
7
+ class ActionEndConferenceResponse < Telnyx::Internal::Type::BaseModel
8
8
  # @!attribute data
9
9
  #
10
10
  # @return [Telnyx::Models::Conferences::ConferenceCommandResult, nil]
@@ -3,8 +3,8 @@
3
3
  module Telnyx
4
4
  module Models
5
5
  module Conferences
6
- # @see Telnyx::Resources::Conferences::Actions#gather_using_audio
7
- class ActionGatherUsingAudioParams < Telnyx::Internal::Type::BaseModel
6
+ # @see Telnyx::Resources::Conferences::Actions#gather_dtmf_audio
7
+ class ActionGatherDtmfAudioParams < Telnyx::Internal::Type::BaseModel
8
8
  extend Telnyx::Internal::Type::RequestParameters::Converter
9
9
  include Telnyx::Internal::Type::RequestParameters
10
10
 
@@ -111,7 +111,7 @@ module Telnyx
111
111
 
112
112
  # @!method initialize(call_control_id:, audio_url: nil, client_state: nil, gather_id: nil, initial_timeout_millis: nil, inter_digit_timeout_millis: nil, invalid_audio_url: nil, invalid_media_name: nil, maximum_digits: nil, maximum_tries: nil, media_name: nil, minimum_digits: nil, stop_playback_on_dtmf: nil, terminating_digit: nil, timeout_millis: nil, valid_digits: nil, request_options: {})
113
113
  # Some parameter documentations has been truncated, see
114
- # {Telnyx::Models::Conferences::ActionGatherUsingAudioParams} for more details.
114
+ # {Telnyx::Models::Conferences::ActionGatherDtmfAudioParams} for more details.
115
115
  #
116
116
  # @param call_control_id [String] Unique identifier and token for controlling the call leg that will receive the g
117
117
  #
@@ -3,8 +3,8 @@
3
3
  module Telnyx
4
4
  module Models
5
5
  module Conferences
6
- # @see Telnyx::Resources::Conferences::Actions#gather_using_audio
7
- class ActionGatherUsingAudioResponse < Telnyx::Internal::Type::BaseModel
6
+ # @see Telnyx::Resources::Conferences::Actions#gather_dtmf_audio
7
+ class ActionGatherDtmfAudioResponse < Telnyx::Internal::Type::BaseModel
8
8
  # @!attribute data
9
9
  #
10
10
  # @return [Telnyx::Models::Conferences::ConferenceCommandResult, nil]
@@ -30,6 +30,12 @@ module Telnyx
30
30
  # @return [Symbol, Telnyx::Models::CustomerServiceRecord::Status, nil]
31
31
  optional :status, enum: -> { Telnyx::CustomerServiceRecord::Status }
32
32
 
33
+ # @!attribute webhook_url
34
+ # Callback URL to receive webhook notifications.
35
+ #
36
+ # @return [String, nil]
37
+ optional :webhook_url, String
38
+
33
39
  response_only do
34
40
  # @!attribute id
35
41
  # Uniquely identifies this customer service record
@@ -56,7 +62,7 @@ module Telnyx
56
62
  optional :updated_at, Time
57
63
  end
58
64
 
59
- # @!method initialize(id: nil, created_at: nil, error_message: nil, phone_number: nil, record_type: nil, result: nil, status: nil, updated_at: nil)
65
+ # @!method initialize(id: nil, created_at: nil, error_message: nil, phone_number: nil, record_type: nil, result: nil, status: nil, updated_at: nil, webhook_url: nil)
60
66
  # Some parameter documentations has been truncated, see
61
67
  # {Telnyx::Models::CustomerServiceRecord} for more details.
62
68
  #
@@ -75,6 +81,8 @@ module Telnyx
75
81
  # @param status [Symbol, Telnyx::Models::CustomerServiceRecord::Status] The status of the customer service record
76
82
  #
77
83
  # @param updated_at [Time] ISO 8601 formatted date indicating when the resource was created.
84
+ #
85
+ # @param webhook_url [String] Callback URL to receive webhook notifications.
78
86
 
79
87
  # @see Telnyx::Models::CustomerServiceRecord#result
80
88
  class Result < Telnyx::Internal::Type::BaseModel
@@ -27,6 +27,12 @@ module Telnyx
27
27
  # @return [Time, nil]
28
28
  optional :created_at, Time
29
29
 
30
+ # @!attribute errors
31
+ # Errors the reservation could happen upon
32
+ #
33
+ # @return [String, nil]
34
+ optional :errors, String
35
+
30
36
  # @!attribute record_type
31
37
  #
32
38
  # @return [String, nil]
@@ -45,13 +51,15 @@ module Telnyx
45
51
  optional :updated_at, Time
46
52
  end
47
53
 
48
- # @!method initialize(id: nil, created_at: nil, customer_reference: nil, phone_numbers: nil, record_type: nil, status: nil, updated_at: nil)
54
+ # @!method initialize(id: nil, created_at: nil, customer_reference: nil, errors: nil, phone_numbers: nil, record_type: nil, status: nil, updated_at: nil)
49
55
  # @param id [String]
50
56
  #
51
57
  # @param created_at [Time] An ISO 8901 datetime string denoting when the numbers reservation was created.
52
58
  #
53
59
  # @param customer_reference [String] A customer reference string for customer look ups.
54
60
  #
61
+ # @param errors [String] Errors the reservation could happen upon
62
+ #
55
63
  # @param phone_numbers [Array<Telnyx::Models::ReservedPhoneNumber>]
56
64
  #
57
65
  # @param record_type [String]
@@ -125,6 +125,12 @@ module Telnyx
125
125
  # @return [Boolean, nil]
126
126
  optional :emergency_enabled, Telnyx::Internal::Type::Boolean
127
127
 
128
+ # @!attribute hd_voice_enabled
129
+ # Indicates whether HD voice is enabled for this number.
130
+ #
131
+ # @return [Boolean, nil]
132
+ optional :hd_voice_enabled, Telnyx::Internal::Type::Boolean
133
+
128
134
  # @!attribute phone_number
129
135
  # The +E.164-formatted phone number associated with this record.
130
136
  #
@@ -169,7 +175,7 @@ module Telnyx
169
175
  optional :updated_at, String
170
176
  end
171
177
 
172
- # @!method initialize(id: nil, billing_group_id: nil, call_forwarding_enabled: nil, call_recording_enabled: nil, caller_id_name_enabled: nil, cnam_listing_enabled: nil, connection_id: nil, connection_name: nil, created_at: nil, customer_reference: nil, deletion_lock_enabled: nil, emergency_address_id: nil, emergency_enabled: nil, external_pin: nil, messaging_profile_id: nil, messaging_profile_name: nil, phone_number: nil, phone_number_type: nil, purchased_at: nil, record_type: nil, status: nil, t38_fax_gateway_enabled: nil, tags: nil, updated_at: nil)
178
+ # @!method initialize(id: nil, billing_group_id: nil, call_forwarding_enabled: nil, call_recording_enabled: nil, caller_id_name_enabled: nil, cnam_listing_enabled: nil, connection_id: nil, connection_name: nil, created_at: nil, customer_reference: nil, deletion_lock_enabled: nil, emergency_address_id: nil, emergency_enabled: nil, external_pin: nil, hd_voice_enabled: nil, messaging_profile_id: nil, messaging_profile_name: nil, phone_number: nil, phone_number_type: nil, purchased_at: nil, record_type: nil, status: nil, t38_fax_gateway_enabled: nil, tags: nil, updated_at: nil)
173
179
  # Some parameter documentations has been truncated, see
174
180
  # {Telnyx::Models::PhoneNumberDeleteResponse::Data} for more details.
175
181
  #
@@ -201,6 +207,8 @@ module Telnyx
201
207
  #
202
208
  # @param external_pin [String] If someone attempts to port your phone number away from Telnyx and your phone nu
203
209
  #
210
+ # @param hd_voice_enabled [Boolean] Indicates whether HD voice is enabled for this number.
211
+ #
204
212
  # @param messaging_profile_id [String] Identifies the messaging profile associated with the phone number.
205
213
  #
206
214
  # @param messaging_profile_name [String] The name of the messaging profile associated with the phone number.
@@ -170,6 +170,12 @@ module Telnyx
170
170
  # @return [Boolean, nil]
171
171
  optional :emergency_enabled, Telnyx::Internal::Type::Boolean
172
172
 
173
+ # @!attribute hd_voice_enabled
174
+ # Indicates whether HD voice is enabled for this number.
175
+ #
176
+ # @return [Boolean, nil]
177
+ optional :hd_voice_enabled, Telnyx::Internal::Type::Boolean
178
+
173
179
  # @!attribute source_type
174
180
  # Indicates if the phone number was purchased or ported in. For some numbers this
175
181
  # information may not be available.
@@ -182,9 +188,15 @@ module Telnyx
182
188
  #
183
189
  # @return [Boolean, nil]
184
190
  optional :t38_fax_gateway_enabled, Telnyx::Internal::Type::Boolean
191
+
192
+ # @!attribute updated_at
193
+ # ISO 8601 formatted date indicating when the resource was updated.
194
+ #
195
+ # @return [String, nil]
196
+ optional :updated_at, String
185
197
  end
186
198
 
187
- # @!method initialize(id:, country_iso_alpha2:, created_at:, deletion_lock_enabled:, external_pin:, phone_number:, phone_number_type:, purchased_at:, record_type:, status:, tags:, billing_group_id: nil, call_forwarding_enabled: nil, call_recording_enabled: nil, caller_id_name_enabled: nil, cnam_listing_enabled: nil, connection_id: nil, connection_name: nil, customer_reference: nil, emergency_address_id: nil, emergency_enabled: nil, emergency_status: nil, inbound_call_screening: nil, messaging_profile_id: nil, messaging_profile_name: nil, source_type: nil, t38_fax_gateway_enabled: nil)
199
+ # @!method initialize(id:, country_iso_alpha2:, created_at:, deletion_lock_enabled:, external_pin:, phone_number:, phone_number_type:, purchased_at:, record_type:, status:, tags:, billing_group_id: nil, call_forwarding_enabled: nil, call_recording_enabled: nil, caller_id_name_enabled: nil, cnam_listing_enabled: nil, connection_id: nil, connection_name: nil, customer_reference: nil, emergency_address_id: nil, emergency_enabled: nil, emergency_status: nil, hd_voice_enabled: nil, inbound_call_screening: nil, messaging_profile_id: nil, messaging_profile_name: nil, source_type: nil, t38_fax_gateway_enabled: nil, updated_at: nil)
188
200
  # Some parameter documentations has been truncated, see
189
201
  # {Telnyx::Models::PhoneNumberDetailed} for more details.
190
202
  #
@@ -232,6 +244,8 @@ module Telnyx
232
244
  #
233
245
  # @param emergency_status [Symbol, Telnyx::Models::PhoneNumberDetailed::EmergencyStatus] Indicates the status of the provisioning of emergency services for the phone num
234
246
  #
247
+ # @param hd_voice_enabled [Boolean] Indicates whether HD voice is enabled for this number.
248
+ #
235
249
  # @param inbound_call_screening [Symbol, Telnyx::Models::PhoneNumberDetailed::InboundCallScreening] The inbound_call_screening setting is a phone number configuration option variab
236
250
  #
237
251
  # @param messaging_profile_id [String, nil] Identifies the messaging profile associated with the phone number.
@@ -241,6 +255,8 @@ module Telnyx
241
255
  # @param source_type [Symbol, Telnyx::Models::PhoneNumberDetailed::SourceType, nil] Indicates if the phone number was purchased or ported in. For some numbers this
242
256
  #
243
257
  # @param t38_fax_gateway_enabled [Boolean] Indicates whether T38 Fax Gateway for inbound calls to this number.
258
+ #
259
+ # @param updated_at [String] ISO 8601 formatted date indicating when the resource was updated.
244
260
 
245
261
  # The phone number's type. Note: For numbers purchased prior to July 2023 or when
246
262
  # fetching a number's details immediately after a purchase completes, the legacy
@@ -107,6 +107,12 @@ module Telnyx
107
107
  # @return [Boolean, nil]
108
108
  optional :emergency_enabled, Telnyx::Internal::Type::Boolean
109
109
 
110
+ # @!attribute hd_voice_enabled
111
+ # Indicates whether HD voice is enabled for this number.
112
+ #
113
+ # @return [Boolean, nil]
114
+ optional :hd_voice_enabled, Telnyx::Internal::Type::Boolean
115
+
110
116
  # @!attribute phone_number
111
117
  # The +E.164-formatted phone number associated with this record.
112
118
  #
@@ -144,9 +150,15 @@ module Telnyx
144
150
  #
145
151
  # @return [Boolean, nil]
146
152
  optional :t38_fax_gateway_enabled, Telnyx::Internal::Type::Boolean
153
+
154
+ # @!attribute updated_at
155
+ # ISO 8601 formatted date indicating when the resource was updated.
156
+ #
157
+ # @return [String, nil]
158
+ optional :updated_at, String
147
159
  end
148
160
 
149
- # @!method initialize(id: nil, billing_group_id: nil, call_forwarding_enabled: nil, call_recording_enabled: nil, caller_id_name_enabled: nil, cnam_listing_enabled: nil, connection_id: nil, country_iso_alpha2: nil, created_at: nil, customer_reference: nil, emergency_address_id: nil, emergency_enabled: nil, emergency_status: nil, external_pin: nil, inbound_call_screening: nil, phone_number: nil, phone_number_type: nil, purchased_at: nil, record_type: nil, status: nil, t38_fax_gateway_enabled: nil)
161
+ # @!method initialize(id: nil, billing_group_id: nil, call_forwarding_enabled: nil, call_recording_enabled: nil, caller_id_name_enabled: nil, cnam_listing_enabled: nil, connection_id: nil, country_iso_alpha2: nil, created_at: nil, customer_reference: nil, emergency_address_id: nil, emergency_enabled: nil, emergency_status: nil, external_pin: nil, hd_voice_enabled: nil, inbound_call_screening: nil, phone_number: nil, phone_number_type: nil, purchased_at: nil, record_type: nil, status: nil, t38_fax_gateway_enabled: nil, updated_at: nil)
150
162
  # Some parameter documentations has been truncated, see
151
163
  # {Telnyx::Models::PhoneNumberSlimListResponse} for more details.
152
164
  #
@@ -178,6 +190,8 @@ module Telnyx
178
190
  #
179
191
  # @param external_pin [String] If someone attempts to port your phone number away from Telnyx and your phone nu
180
192
  #
193
+ # @param hd_voice_enabled [Boolean] Indicates whether HD voice is enabled for this number.
194
+ #
181
195
  # @param inbound_call_screening [Symbol, Telnyx::Models::PhoneNumberSlimListResponse::InboundCallScreening] The inbound_call_screening setting is a phone number configuration option variab
182
196
  #
183
197
  # @param phone_number [String] The +E.164-formatted phone number associated with this record.
@@ -191,6 +205,8 @@ module Telnyx
191
205
  # @param status [Symbol, Telnyx::Models::PhoneNumberSlimListResponse::Status] The phone number's current status.
192
206
  #
193
207
  # @param t38_fax_gateway_enabled [Boolean] Indicates whether T38 Fax Gateway for inbound calls to this number.
208
+ #
209
+ # @param updated_at [String] ISO 8601 formatted date indicating when the resource was updated.
194
210
 
195
211
  # Indicates the status of the provisioning of emergency services for the phone
196
212
  # number. This field contains information about activity that may be ongoing for a
@@ -7,6 +7,12 @@ module Telnyx
7
7
  extend Telnyx::Internal::Type::RequestParameters::Converter
8
8
  include Telnyx::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute address_id
11
+ # Identifies the address associated with the phone number.
12
+ #
13
+ # @return [String, nil]
14
+ optional :address_id, String
15
+
10
16
  # @!attribute billing_group_id
11
17
  # Identifies the billing group associated with the phone number.
12
18
  #
@@ -46,10 +52,12 @@ module Telnyx
46
52
  # @return [Array<String>, nil]
47
53
  optional :tags, Telnyx::Internal::Type::ArrayOf[String]
48
54
 
49
- # @!method initialize(billing_group_id: nil, connection_id: nil, customer_reference: nil, external_pin: nil, hd_voice_enabled: nil, tags: nil, request_options: {})
55
+ # @!method initialize(address_id: nil, billing_group_id: nil, connection_id: nil, customer_reference: nil, external_pin: nil, hd_voice_enabled: nil, tags: nil, request_options: {})
50
56
  # Some parameter documentations has been truncated, see
51
57
  # {Telnyx::Models::PhoneNumberUpdateParams} for more details.
52
58
  #
59
+ # @param address_id [String] Identifies the address associated with the phone number.
60
+ #
53
61
  # @param billing_group_id [String] Identifies the billing group associated with the phone number.
54
62
  #
55
63
  # @param connection_id [String] Identifies the connection associated with the phone number.
@@ -62,6 +62,12 @@ module Telnyx
62
62
  # @return [Symbol, Telnyx::Models::PortingOrder::PhoneNumberType, nil]
63
63
  optional :phone_number_type, enum: -> { Telnyx::PortingOrder::PhoneNumberType }
64
64
 
65
+ # @!attribute phone_numbers
66
+ # List of phone numbers associated with this porting order
67
+ #
68
+ # @return [Array<Telnyx::Models::PortingOrder::PhoneNumber>, nil]
69
+ optional :phone_numbers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::PortingOrder::PhoneNumber] }
70
+
65
71
  # @!attribute requirements
66
72
  # List of documentation requirements for porting numbers. Can be set directly or
67
73
  # via the `requirement_group_id` parameter.
@@ -155,7 +161,7 @@ module Telnyx
155
161
  optional :updated_at, Time
156
162
  end
157
163
 
158
- # @!method initialize(id: nil, activation_settings: nil, additional_steps: nil, created_at: nil, customer_group_reference: nil, customer_reference: nil, description: nil, documents: nil, end_user: nil, messaging: nil, misc: nil, old_service_provider_ocn: nil, parent_support_key: nil, phone_number_configuration: nil, phone_number_type: nil, porting_phone_numbers_count: nil, record_type: nil, requirements: nil, requirements_met: nil, status: nil, support_key: nil, updated_at: nil, user_feedback: nil, user_id: nil, webhook_url: nil)
164
+ # @!method initialize(id: nil, activation_settings: nil, additional_steps: nil, created_at: nil, customer_group_reference: nil, customer_reference: nil, description: nil, documents: nil, end_user: nil, messaging: nil, misc: nil, old_service_provider_ocn: nil, parent_support_key: nil, phone_number_configuration: nil, phone_number_type: nil, phone_numbers: nil, porting_phone_numbers_count: nil, record_type: nil, requirements: nil, requirements_met: nil, status: nil, support_key: nil, updated_at: nil, user_feedback: nil, user_id: nil, webhook_url: nil)
159
165
  # Some parameter documentations has been truncated, see
160
166
  # {Telnyx::Models::PortingOrder} for more details.
161
167
  #
@@ -189,6 +195,8 @@ module Telnyx
189
195
  #
190
196
  # @param phone_number_type [Symbol, Telnyx::Models::PortingOrder::PhoneNumberType] The type of the phone number
191
197
  #
198
+ # @param phone_numbers [Array<Telnyx::Models::PortingOrder::PhoneNumber>] List of phone numbers associated with this porting order
199
+ #
192
200
  # @param porting_phone_numbers_count [Integer] Count of phone numbers associated with this porting order
193
201
  #
194
202
  # @param record_type [String] Identifies the type of the resource.
@@ -235,6 +243,177 @@ module Telnyx
235
243
  # @!method self.values
236
244
  # @return [Array<Symbol>]
237
245
  end
246
+
247
+ class PhoneNumber < Telnyx::Internal::Type::BaseModel
248
+ # @!attribute activation_status
249
+ # Activation status
250
+ #
251
+ # @return [Symbol, Telnyx::Models::PortingOrder::PhoneNumber::ActivationStatus, nil]
252
+ optional :activation_status, enum: -> { Telnyx::PortingOrder::PhoneNumber::ActivationStatus }
253
+
254
+ # @!attribute phone_number
255
+ # E164 formatted phone number
256
+ #
257
+ # @return [String, nil]
258
+ optional :phone_number, String
259
+
260
+ # @!attribute phone_number_type
261
+ # The type of the phone number
262
+ #
263
+ # @return [Symbol, Telnyx::Models::PortingOrder::PhoneNumber::PhoneNumberType, nil]
264
+ optional :phone_number_type, enum: -> { Telnyx::PortingOrder::PhoneNumber::PhoneNumberType }
265
+
266
+ # @!attribute portability_status
267
+ # Specifies whether Telnyx is able to confirm portability this number in the
268
+ # United States & Canada. International phone numbers are provisional by default.
269
+ #
270
+ # @return [Symbol, Telnyx::Models::PortingOrder::PhoneNumber::PortabilityStatus, nil]
271
+ optional :portability_status, enum: -> { Telnyx::PortingOrder::PhoneNumber::PortabilityStatus }
272
+
273
+ # @!attribute porting_order_id
274
+ # Identifies the associated port request
275
+ #
276
+ # @return [String, nil]
277
+ optional :porting_order_id, String
278
+
279
+ # @!attribute porting_order_status
280
+ # The current status of the porting order
281
+ #
282
+ # @return [Symbol, Telnyx::Models::PortingOrder::PhoneNumber::PortingOrderStatus, nil]
283
+ optional :porting_order_status, enum: -> { Telnyx::PortingOrder::PhoneNumber::PortingOrderStatus }
284
+
285
+ # @!attribute requirements_status
286
+ # The current status of the requirements in a INTL porting order
287
+ #
288
+ # @return [Symbol, Telnyx::Models::PortingOrder::PhoneNumber::RequirementsStatus, nil]
289
+ optional :requirements_status, enum: -> { Telnyx::PortingOrder::PhoneNumber::RequirementsStatus }
290
+
291
+ # @!attribute support_key
292
+ # A key to reference this porting order when contacting Telnyx customer support
293
+ #
294
+ # @return [String, nil]
295
+ optional :support_key, String
296
+
297
+ response_only do
298
+ # @!attribute record_type
299
+ # Identifies the type of the resource.
300
+ #
301
+ # @return [String, nil]
302
+ optional :record_type, String
303
+ end
304
+
305
+ # @!method initialize(activation_status: nil, phone_number: nil, phone_number_type: nil, portability_status: nil, porting_order_id: nil, porting_order_status: nil, record_type: nil, requirements_status: nil, support_key: nil)
306
+ # Some parameter documentations has been truncated, see
307
+ # {Telnyx::Models::PortingOrder::PhoneNumber} for more details.
308
+ #
309
+ # @param activation_status [Symbol, Telnyx::Models::PortingOrder::PhoneNumber::ActivationStatus] Activation status
310
+ #
311
+ # @param phone_number [String] E164 formatted phone number
312
+ #
313
+ # @param phone_number_type [Symbol, Telnyx::Models::PortingOrder::PhoneNumber::PhoneNumberType] The type of the phone number
314
+ #
315
+ # @param portability_status [Symbol, Telnyx::Models::PortingOrder::PhoneNumber::PortabilityStatus] Specifies whether Telnyx is able to confirm portability this number in the Unite
316
+ #
317
+ # @param porting_order_id [String] Identifies the associated port request
318
+ #
319
+ # @param porting_order_status [Symbol, Telnyx::Models::PortingOrder::PhoneNumber::PortingOrderStatus] The current status of the porting order
320
+ #
321
+ # @param record_type [String] Identifies the type of the resource.
322
+ #
323
+ # @param requirements_status [Symbol, Telnyx::Models::PortingOrder::PhoneNumber::RequirementsStatus] The current status of the requirements in a INTL porting order
324
+ #
325
+ # @param support_key [String] A key to reference this porting order when contacting Telnyx customer support
326
+
327
+ # Activation status
328
+ #
329
+ # @see Telnyx::Models::PortingOrder::PhoneNumber#activation_status
330
+ module ActivationStatus
331
+ extend Telnyx::Internal::Type::Enum
332
+
333
+ NEW = :New
334
+ PENDING = :Pending
335
+ CONFLICT = :Conflict
336
+ CANCEL_PENDING = :"Cancel Pending"
337
+ FAILED = :Failed
338
+ CONCURRED = :Concurred
339
+ ACTIVATE_RDY = :"Activate RDY"
340
+ DISCONNECT_PENDING = :"Disconnect Pending"
341
+ CONCURRENCE_SENT = :"Concurrence Sent"
342
+ OLD = :Old
343
+ SENDING = :Sending
344
+ ACTIVE = :Active
345
+ CANCELLED = :Cancelled
346
+
347
+ # @!method self.values
348
+ # @return [Array<Symbol>]
349
+ end
350
+
351
+ # The type of the phone number
352
+ #
353
+ # @see Telnyx::Models::PortingOrder::PhoneNumber#phone_number_type
354
+ module PhoneNumberType
355
+ extend Telnyx::Internal::Type::Enum
356
+
357
+ LANDLINE = :landline
358
+ LOCAL = :local
359
+ MOBILE = :mobile
360
+ NATIONAL = :national
361
+ SHARED_COST = :shared_cost
362
+ TOLL_FREE = :toll_free
363
+
364
+ # @!method self.values
365
+ # @return [Array<Symbol>]
366
+ end
367
+
368
+ # Specifies whether Telnyx is able to confirm portability this number in the
369
+ # United States & Canada. International phone numbers are provisional by default.
370
+ #
371
+ # @see Telnyx::Models::PortingOrder::PhoneNumber#portability_status
372
+ module PortabilityStatus
373
+ extend Telnyx::Internal::Type::Enum
374
+
375
+ PENDING = :pending
376
+ CONFIRMED = :confirmed
377
+ PROVISIONAL = :provisional
378
+
379
+ # @!method self.values
380
+ # @return [Array<Symbol>]
381
+ end
382
+
383
+ # The current status of the porting order
384
+ #
385
+ # @see Telnyx::Models::PortingOrder::PhoneNumber#porting_order_status
386
+ module PortingOrderStatus
387
+ extend Telnyx::Internal::Type::Enum
388
+
389
+ DRAFT = :draft
390
+ IN_PROCESS = :"in-process"
391
+ SUBMITTED = :submitted
392
+ EXCEPTION = :exception
393
+ FOC_DATE_CONFIRMED = :"foc-date-confirmed"
394
+ CANCEL_PENDING = :"cancel-pending"
395
+ PORTED = :ported
396
+ CANCELLED = :cancelled
397
+
398
+ # @!method self.values
399
+ # @return [Array<Symbol>]
400
+ end
401
+
402
+ # The current status of the requirements in a INTL porting order
403
+ #
404
+ # @see Telnyx::Models::PortingOrder::PhoneNumber#requirements_status
405
+ module RequirementsStatus
406
+ extend Telnyx::Internal::Type::Enum
407
+
408
+ REQUIREMENT_INFO_PENDING = :"requirement-info-pending"
409
+ REQUIREMENT_INFO_UNDER_REVIEW = :"requirement-info-under-review"
410
+ REQUIREMENT_INFO_EXCEPTION = :"requirement-info-exception"
411
+ APPROVED = :approved
412
+
413
+ # @!method self.values
414
+ # @return [Array<Symbol>]
415
+ end
416
+ end
238
417
  end
239
418
  end
240
419
  end