telnyx 5.150.0 → 5.151.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 (76) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +10 -1
  4. data/lib/telnyx/models/ai_retrieve_conversation_histories_params.rb +22 -48
  5. data/lib/telnyx/models/ai_retrieve_conversation_histories_response.rb +10 -50
  6. data/lib/telnyx/models/calls/deepgram_nova2_config.rb +23 -1
  7. data/lib/telnyx/models/calls/deepgram_nova3_config.rb +22 -1
  8. data/lib/telnyx/models/calls/transcription_start_request.rb +5 -3
  9. data/lib/telnyx/models/public_internet_gateway.rb +24 -1
  10. data/lib/telnyx/models/texml/accounts/call_calls_params.rb +9 -69
  11. data/lib/telnyx/models/virtual_cross_connect_create.rb +176 -2
  12. data/lib/telnyx/models/wireguard_interface.rb +24 -1
  13. data/lib/telnyx/resources/ai.rb +20 -21
  14. data/lib/telnyx/resources/calls/actions.rb +1 -1
  15. data/lib/telnyx/version.rb +1 -1
  16. data/lib/telnyx.rb +1 -0
  17. data/rbi/telnyx/models/ai_retrieve_conversation_histories_params.rbi +30 -97
  18. data/rbi/telnyx/models/ai_retrieve_conversation_histories_response.rbi +10 -85
  19. data/rbi/telnyx/models/calls/deepgram_nova2_config.rbi +34 -0
  20. data/rbi/telnyx/models/calls/deepgram_nova3_config.rbi +32 -0
  21. data/rbi/telnyx/models/calls/transcription_start_request.rbi +5 -0
  22. data/rbi/telnyx/models/public_internet_gateway.rbi +45 -3
  23. data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +12 -189
  24. data/rbi/telnyx/models/virtual_cross_connect_create.rbi +265 -7
  25. data/rbi/telnyx/models/wireguard_interface.rbi +48 -3
  26. data/rbi/telnyx/models.rbi +0 -7
  27. data/rbi/telnyx/resources/ai.rbi +21 -28
  28. data/rbi/telnyx/resources/calls/actions.rbi +1 -0
  29. data/sig/telnyx/models/ai_retrieve_conversation_histories_params.rbs +15 -34
  30. data/sig/telnyx/models/ai_retrieve_conversation_histories_response.rbs +0 -24
  31. data/sig/telnyx/models/calls/deepgram_nova2_config.rbs +14 -0
  32. data/sig/telnyx/models/calls/deepgram_nova3_config.rbs +14 -0
  33. data/sig/telnyx/models/calls/transcription_start_request.rbs +1 -0
  34. data/sig/telnyx/models/public_internet_gateway.rbs +32 -3
  35. data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +15 -63
  36. data/sig/telnyx/models/virtual_cross_connect_create.rbs +138 -7
  37. data/sig/telnyx/models/wireguard_interface.rbs +34 -3
  38. data/sig/telnyx/models.rbs +0 -1
  39. data/sig/telnyx/resources/ai.rbs +2 -3
  40. metadata +2 -38
  41. data/lib/telnyx/models/dir/phone_number_create_params.rb +0 -47
  42. data/lib/telnyx/models/dir/phone_number_create_response.rb +0 -32
  43. data/lib/telnyx/models/dir/phone_number_delete_all_params.rb +0 -28
  44. data/lib/telnyx/models/dir/phone_number_delete_all_response.rb +0 -103
  45. data/lib/telnyx/models/dir_loa_params.rb +0 -79
  46. data/lib/telnyx/models/dir_retrieve_document_types_params.rb +0 -14
  47. data/lib/telnyx/models/dir_retrieve_document_types_response.rb +0 -51
  48. data/lib/telnyx/models/dir_retrieve_infringement_claims_params.rb +0 -40
  49. data/lib/telnyx/models/dir_retrieve_infringement_claims_response.rb +0 -30
  50. data/lib/telnyx/models/dir_update_infringement_update_params.rb +0 -134
  51. data/lib/telnyx/models/enterprises/reputation/loa_create_params.rb +0 -146
  52. data/lib/telnyx/models/enterprises/reputation/loa_patch_all_params.rb +0 -38
  53. data/rbi/telnyx/models/dir/phone_number_create_params.rbi +0 -72
  54. data/rbi/telnyx/models/dir/phone_number_create_response.rbi +0 -48
  55. data/rbi/telnyx/models/dir/phone_number_delete_all_params.rbi +0 -48
  56. data/rbi/telnyx/models/dir/phone_number_delete_all_response.rbi +0 -206
  57. data/rbi/telnyx/models/dir_loa_params.rbi +0 -120
  58. data/rbi/telnyx/models/dir_retrieve_document_types_params.rbi +0 -30
  59. data/rbi/telnyx/models/dir_retrieve_document_types_response.rbi +0 -103
  60. data/rbi/telnyx/models/dir_retrieve_infringement_claims_params.rbi +0 -66
  61. data/rbi/telnyx/models/dir_retrieve_infringement_claims_response.rbi +0 -55
  62. data/rbi/telnyx/models/dir_update_infringement_update_params.rbi +0 -256
  63. data/rbi/telnyx/models/enterprises/reputation/loa_create_params.rbi +0 -238
  64. data/rbi/telnyx/models/enterprises/reputation/loa_patch_all_params.rbi +0 -60
  65. data/sig/telnyx/models/dir/phone_number_create_params.rbs +0 -38
  66. data/sig/telnyx/models/dir/phone_number_create_response.rbs +0 -16
  67. data/sig/telnyx/models/dir/phone_number_delete_all_params.rbs +0 -30
  68. data/sig/telnyx/models/dir/phone_number_delete_all_response.rbs +0 -86
  69. data/sig/telnyx/models/dir_loa_params.rbs +0 -61
  70. data/sig/telnyx/models/dir_retrieve_document_types_params.rbs +0 -15
  71. data/sig/telnyx/models/dir_retrieve_document_types_response.rbs +0 -41
  72. data/sig/telnyx/models/dir_retrieve_infringement_claims_params.rbs +0 -36
  73. data/sig/telnyx/models/dir_retrieve_infringement_claims_response.rbs +0 -25
  74. data/sig/telnyx/models/dir_update_infringement_update_params.rbs +0 -111
  75. data/sig/telnyx/models/enterprises/reputation/loa_create_params.rbs +0 -135
  76. data/sig/telnyx/models/enterprises/reputation/loa_patch_all_params.rbs +0 -32
@@ -1,16 +1,147 @@
1
1
  module Telnyx
2
2
  module Models
3
- type virtual_cross_connect_create = { }
3
+ type virtual_cross_connect_create =
4
+ {
5
+ name: String,
6
+ network_id: String,
7
+ status: Telnyx::Models::interface_status,
8
+ region_code: String,
9
+ bandwidth_mbps: Float,
10
+ bgp_asn: Float,
11
+ cloud_provider: Telnyx::Models::VirtualCrossConnectCreate::cloud_provider,
12
+ cloud_provider_region: String,
13
+ primary_bgp_key: String,
14
+ primary_cloud_account_id: String,
15
+ primary_cloud_ip: String,
16
+ primary_enabled: bool,
17
+ primary_telnyx_ip: String,
18
+ secondary_bgp_key: String,
19
+ secondary_cloud_account_id: String,
20
+ secondary_cloud_ip: String,
21
+ secondary_enabled: bool,
22
+ secondary_telnyx_ip: String
23
+ }
4
24
 
5
25
  class VirtualCrossConnectCreate < Telnyx::Models::Record
6
- def initialize: -> void
26
+ def name: -> String?
7
27
 
8
- def to_hash: -> { }
28
+ def name=: (String _) -> String
9
29
 
10
- type cloud_provider =
11
- :aws
12
- | :azure
13
- | :gce
30
+ def network_id: -> String?
31
+
32
+ def network_id=: (String _) -> String
33
+
34
+ def region_code: -> String
35
+
36
+ def region_code=: (String _) -> String
37
+
38
+ def bandwidth_mbps: -> Float?
39
+
40
+ def bandwidth_mbps=: (Float _) -> Float
41
+
42
+ def bgp_asn: -> Float?
43
+
44
+ def bgp_asn=: (Float _) -> Float
45
+
46
+ def cloud_provider: -> Telnyx::Models::VirtualCrossConnectCreate::cloud_provider?
47
+
48
+ def cloud_provider=: (
49
+ Telnyx::Models::VirtualCrossConnectCreate::cloud_provider _
50
+ ) -> Telnyx::Models::VirtualCrossConnectCreate::cloud_provider
51
+
52
+ def cloud_provider_region: -> String?
53
+
54
+ def cloud_provider_region=: (String _) -> String
55
+
56
+ def primary_bgp_key: -> String?
57
+
58
+ def primary_bgp_key=: (String _) -> String
59
+
60
+ def primary_cloud_account_id: -> String?
61
+
62
+ def primary_cloud_account_id=: (String _) -> String
63
+
64
+ def primary_cloud_ip: -> String?
65
+
66
+ def primary_cloud_ip=: (String _) -> String
67
+
68
+ def primary_telnyx_ip: -> String?
69
+
70
+ def primary_telnyx_ip=: (String _) -> String
71
+
72
+ def secondary_bgp_key: -> String?
73
+
74
+ def secondary_bgp_key=: (String _) -> String
75
+
76
+ def secondary_cloud_account_id: -> String?
77
+
78
+ def secondary_cloud_account_id=: (String _) -> String
79
+
80
+ def secondary_cloud_ip: -> String?
81
+
82
+ def secondary_cloud_ip=: (String _) -> String
83
+
84
+ def secondary_telnyx_ip: -> String?
85
+
86
+ def secondary_telnyx_ip=: (String _) -> String
87
+
88
+ def status: -> Telnyx::Models::interface_status?
89
+
90
+ def status=: (
91
+ Telnyx::Models::interface_status _
92
+ ) -> Telnyx::Models::interface_status
93
+
94
+ def primary_enabled: -> bool?
95
+
96
+ def primary_enabled=: (bool _) -> bool
97
+
98
+ def secondary_enabled: -> bool?
99
+
100
+ def secondary_enabled=: (bool _) -> bool
101
+
102
+ def initialize: (
103
+ region_code: String,
104
+ ?name: String,
105
+ ?network_id: String,
106
+ ?status: Telnyx::Models::interface_status,
107
+ ?bandwidth_mbps: Float,
108
+ ?bgp_asn: Float,
109
+ ?cloud_provider: Telnyx::Models::VirtualCrossConnectCreate::cloud_provider,
110
+ ?cloud_provider_region: String,
111
+ ?primary_bgp_key: String,
112
+ ?primary_cloud_account_id: String,
113
+ ?primary_cloud_ip: String,
114
+ ?primary_enabled: bool,
115
+ ?primary_telnyx_ip: String,
116
+ ?secondary_bgp_key: String,
117
+ ?secondary_cloud_account_id: String,
118
+ ?secondary_cloud_ip: String,
119
+ ?secondary_enabled: bool,
120
+ ?secondary_telnyx_ip: String
121
+ ) -> void
122
+
123
+ def to_hash: -> {
124
+ name: String,
125
+ network_id: String,
126
+ status: Telnyx::Models::interface_status,
127
+ region_code: String,
128
+ bandwidth_mbps: Float,
129
+ bgp_asn: Float,
130
+ cloud_provider: Telnyx::Models::VirtualCrossConnectCreate::cloud_provider,
131
+ cloud_provider_region: String,
132
+ primary_bgp_key: String,
133
+ primary_cloud_account_id: String,
134
+ primary_cloud_ip: String,
135
+ primary_enabled: bool,
136
+ primary_telnyx_ip: String,
137
+ secondary_bgp_key: String,
138
+ secondary_cloud_account_id: String,
139
+ secondary_cloud_ip: String,
140
+ secondary_enabled: bool,
141
+ secondary_telnyx_ip: String
142
+ }
143
+
144
+ type cloud_provider = :aws | :azure | :gce
14
145
 
15
146
  module CloudProvider
16
147
  extend Telnyx::Internal::Type::Enum
@@ -1,11 +1,42 @@
1
1
  module Telnyx
2
2
  module Models
3
- type wireguard_interface = { }
3
+ type wireguard_interface =
4
+ {
5
+ name: String,
6
+ network_id: String,
7
+ status: Telnyx::Models::interface_status,
8
+ enable_sip_trunking: bool,
9
+ endpoint: String,
10
+ public_key: String
11
+ }
4
12
 
5
13
  class WireguardInterface < Telnyx::Models::Record
6
- def initialize: -> void
14
+ def name: -> String?
7
15
 
8
- def to_hash: -> { }
16
+ def name=: (String _) -> String
17
+
18
+ def network_id: -> String?
19
+
20
+ def network_id=: (String _) -> String
21
+
22
+ def enable_sip_trunking: -> bool?
23
+
24
+ def enable_sip_trunking=: (bool _) -> bool
25
+
26
+ def initialize: (
27
+ ?name: String,
28
+ ?network_id: String,
29
+ ?enable_sip_trunking: bool
30
+ ) -> void
31
+
32
+ def to_hash: -> {
33
+ name: String,
34
+ network_id: String,
35
+ status: Telnyx::Models::interface_status,
36
+ enable_sip_trunking: bool,
37
+ endpoint: String,
38
+ public_key: String
39
+ }
9
40
  end
10
41
  end
11
42
  end
@@ -525,7 +525,6 @@ module Telnyx
525
525
 
526
526
  class DirListParams = Telnyx::Models::DirListParams
527
527
 
528
- class DirLoaParams = Telnyx::Models::DirLoaParams
529
528
  class DirNewLoaParams = Telnyx::Models::DirNewLoaParams
530
529
 
531
530
  class DirRetrieveParams = Telnyx::Models::DirRetrieveParams
@@ -32,8 +32,6 @@ module Telnyx
32
32
 
33
33
  def retrieve_conversation_histories: (
34
34
  q: String,
35
- record_type: Telnyx::Models::AIRetrieveConversationHistoriesParams::record_type,
36
- ?filter_document_id: String,
37
35
  ?filter_ingested_at_gte: Time,
38
36
  ?filter_ingested_at_lte: Time,
39
37
  ?filter_record_created_at_gte: Time,
@@ -43,8 +41,9 @@ module Telnyx
43
41
  ?filter_retention: String,
44
42
  ?filter_user_id: String,
45
43
  ?min_score: Float,
44
+ ?page_number: Integer,
45
+ ?page_size: Integer,
46
46
  ?region: Telnyx::Models::AIRetrieveConversationHistoriesParams::region,
47
- ?top_k: Integer,
48
47
  ?request_options: Telnyx::request_opts
49
48
  ) -> Telnyx::Models::AIRetrieveConversationHistoriesResponse
50
49
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: telnyx
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.150.0
4
+ version: 5.151.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Telnyx
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-07-01 00:00:00.000000000 Z
11
+ date: 2026-07-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi
@@ -888,10 +888,6 @@ files:
888
888
  - lib/telnyx/models/dir/phone_number_batch_list_params.rb
889
889
  - lib/telnyx/models/dir/phone_number_batch_retrieve_params.rb
890
890
  - lib/telnyx/models/dir/phone_number_batch_retrieve_response.rb
891
- - lib/telnyx/models/dir/phone_number_create_params.rb
892
- - lib/telnyx/models/dir/phone_number_create_response.rb
893
- - lib/telnyx/models/dir/phone_number_delete_all_params.rb
894
- - lib/telnyx/models/dir/phone_number_delete_all_response.rb
895
891
  - lib/telnyx/models/dir/phone_number_list_params.rb
896
892
  - lib/telnyx/models/dir/phone_number_remove_params.rb
897
893
  - lib/telnyx/models/dir/phone_number_remove_response.rb
@@ -902,17 +898,11 @@ files:
902
898
  - lib/telnyx/models/dir_list_document_types_response.rb
903
899
  - lib/telnyx/models/dir_list_infringement_claims_params.rb
904
900
  - lib/telnyx/models/dir_list_params.rb
905
- - lib/telnyx/models/dir_loa_params.rb
906
901
  - lib/telnyx/models/dir_new_loa_params.rb
907
- - lib/telnyx/models/dir_retrieve_document_types_params.rb
908
- - lib/telnyx/models/dir_retrieve_document_types_response.rb
909
- - lib/telnyx/models/dir_retrieve_infringement_claims_params.rb
910
- - lib/telnyx/models/dir_retrieve_infringement_claims_response.rb
911
902
  - lib/telnyx/models/dir_retrieve_params.rb
912
903
  - lib/telnyx/models/dir_status.rb
913
904
  - lib/telnyx/models/dir_submit_params.rb
914
905
  - lib/telnyx/models/dir_update_infringement_params.rb
915
- - lib/telnyx/models/dir_update_infringement_update_params.rb
916
906
  - lib/telnyx/models/dir_update_params.rb
917
907
  - lib/telnyx/models/dir_wrapped.rb
918
908
  - lib/telnyx/models/doc_reqs_requirement.rb
@@ -967,8 +957,6 @@ files:
967
957
  - lib/telnyx/models/enterprises/enterprise_reputation_public.rb
968
958
  - lib/telnyx/models/enterprises/enterprise_reputation_public_wrapped.rb
969
959
  - lib/telnyx/models/enterprises/reputation/agent_input.rb
970
- - lib/telnyx/models/enterprises/reputation/loa_create_params.rb
971
- - lib/telnyx/models/enterprises/reputation/loa_patch_all_params.rb
972
960
  - lib/telnyx/models/enterprises/reputation/loa_render_params.rb
973
961
  - lib/telnyx/models/enterprises/reputation/loa_update_params.rb
974
962
  - lib/telnyx/models/enterprises/reputation/number_associate_params.rb
@@ -3746,10 +3734,6 @@ files:
3746
3734
  - rbi/telnyx/models/dir/phone_number_batch_list_params.rbi
3747
3735
  - rbi/telnyx/models/dir/phone_number_batch_retrieve_params.rbi
3748
3736
  - rbi/telnyx/models/dir/phone_number_batch_retrieve_response.rbi
3749
- - rbi/telnyx/models/dir/phone_number_create_params.rbi
3750
- - rbi/telnyx/models/dir/phone_number_create_response.rbi
3751
- - rbi/telnyx/models/dir/phone_number_delete_all_params.rbi
3752
- - rbi/telnyx/models/dir/phone_number_delete_all_response.rbi
3753
3737
  - rbi/telnyx/models/dir/phone_number_list_params.rbi
3754
3738
  - rbi/telnyx/models/dir/phone_number_remove_params.rbi
3755
3739
  - rbi/telnyx/models/dir/phone_number_remove_response.rbi
@@ -3760,17 +3744,11 @@ files:
3760
3744
  - rbi/telnyx/models/dir_list_document_types_response.rbi
3761
3745
  - rbi/telnyx/models/dir_list_infringement_claims_params.rbi
3762
3746
  - rbi/telnyx/models/dir_list_params.rbi
3763
- - rbi/telnyx/models/dir_loa_params.rbi
3764
3747
  - rbi/telnyx/models/dir_new_loa_params.rbi
3765
- - rbi/telnyx/models/dir_retrieve_document_types_params.rbi
3766
- - rbi/telnyx/models/dir_retrieve_document_types_response.rbi
3767
- - rbi/telnyx/models/dir_retrieve_infringement_claims_params.rbi
3768
- - rbi/telnyx/models/dir_retrieve_infringement_claims_response.rbi
3769
3748
  - rbi/telnyx/models/dir_retrieve_params.rbi
3770
3749
  - rbi/telnyx/models/dir_status.rbi
3771
3750
  - rbi/telnyx/models/dir_submit_params.rbi
3772
3751
  - rbi/telnyx/models/dir_update_infringement_params.rbi
3773
- - rbi/telnyx/models/dir_update_infringement_update_params.rbi
3774
3752
  - rbi/telnyx/models/dir_update_params.rbi
3775
3753
  - rbi/telnyx/models/dir_wrapped.rbi
3776
3754
  - rbi/telnyx/models/doc_reqs_requirement.rbi
@@ -3825,8 +3803,6 @@ files:
3825
3803
  - rbi/telnyx/models/enterprises/enterprise_reputation_public.rbi
3826
3804
  - rbi/telnyx/models/enterprises/enterprise_reputation_public_wrapped.rbi
3827
3805
  - rbi/telnyx/models/enterprises/reputation/agent_input.rbi
3828
- - rbi/telnyx/models/enterprises/reputation/loa_create_params.rbi
3829
- - rbi/telnyx/models/enterprises/reputation/loa_patch_all_params.rbi
3830
3806
  - rbi/telnyx/models/enterprises/reputation/loa_render_params.rbi
3831
3807
  - rbi/telnyx/models/enterprises/reputation/loa_update_params.rbi
3832
3808
  - rbi/telnyx/models/enterprises/reputation/number_associate_params.rbi
@@ -6595,10 +6571,6 @@ files:
6595
6571
  - sig/telnyx/models/dir/phone_number_batch_list_params.rbs
6596
6572
  - sig/telnyx/models/dir/phone_number_batch_retrieve_params.rbs
6597
6573
  - sig/telnyx/models/dir/phone_number_batch_retrieve_response.rbs
6598
- - sig/telnyx/models/dir/phone_number_create_params.rbs
6599
- - sig/telnyx/models/dir/phone_number_create_response.rbs
6600
- - sig/telnyx/models/dir/phone_number_delete_all_params.rbs
6601
- - sig/telnyx/models/dir/phone_number_delete_all_response.rbs
6602
6574
  - sig/telnyx/models/dir/phone_number_list_params.rbs
6603
6575
  - sig/telnyx/models/dir/phone_number_remove_params.rbs
6604
6576
  - sig/telnyx/models/dir/phone_number_remove_response.rbs
@@ -6609,17 +6581,11 @@ files:
6609
6581
  - sig/telnyx/models/dir_list_document_types_response.rbs
6610
6582
  - sig/telnyx/models/dir_list_infringement_claims_params.rbs
6611
6583
  - sig/telnyx/models/dir_list_params.rbs
6612
- - sig/telnyx/models/dir_loa_params.rbs
6613
6584
  - sig/telnyx/models/dir_new_loa_params.rbs
6614
- - sig/telnyx/models/dir_retrieve_document_types_params.rbs
6615
- - sig/telnyx/models/dir_retrieve_document_types_response.rbs
6616
- - sig/telnyx/models/dir_retrieve_infringement_claims_params.rbs
6617
- - sig/telnyx/models/dir_retrieve_infringement_claims_response.rbs
6618
6585
  - sig/telnyx/models/dir_retrieve_params.rbs
6619
6586
  - sig/telnyx/models/dir_status.rbs
6620
6587
  - sig/telnyx/models/dir_submit_params.rbs
6621
6588
  - sig/telnyx/models/dir_update_infringement_params.rbs
6622
- - sig/telnyx/models/dir_update_infringement_update_params.rbs
6623
6589
  - sig/telnyx/models/dir_update_params.rbs
6624
6590
  - sig/telnyx/models/dir_wrapped.rbs
6625
6591
  - sig/telnyx/models/doc_reqs_requirement.rbs
@@ -6674,8 +6640,6 @@ files:
6674
6640
  - sig/telnyx/models/enterprises/enterprise_reputation_public.rbs
6675
6641
  - sig/telnyx/models/enterprises/enterprise_reputation_public_wrapped.rbs
6676
6642
  - sig/telnyx/models/enterprises/reputation/agent_input.rbs
6677
- - sig/telnyx/models/enterprises/reputation/loa_create_params.rbs
6678
- - sig/telnyx/models/enterprises/reputation/loa_patch_all_params.rbs
6679
6643
  - sig/telnyx/models/enterprises/reputation/loa_render_params.rbs
6680
6644
  - sig/telnyx/models/enterprises/reputation/loa_update_params.rbs
6681
6645
  - sig/telnyx/models/enterprises/reputation/number_associate_params.rbs
@@ -1,47 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- module Dir
6
- # @see Telnyx::Resources::Dir::PhoneNumbers#create
7
- class PhoneNumberCreateParams < Telnyx::Internal::Type::BaseModel
8
- extend Telnyx::Internal::Type::RequestParameters::Converter
9
- include Telnyx::Internal::Type::RequestParameters
10
-
11
- # @!attribute dir_id
12
- #
13
- # @return [String]
14
- required :dir_id, String
15
-
16
- # @!attribute documents
17
- # Supporting documents covering this batch. At least one entry with
18
- # `document_type: letter_of_authorization` is required - the LOA authorises Telnyx
19
- # to register these numbers under the DIR. Each `document_id` must come from the
20
- # Telnyx Documents API. Additional document types (e.g. business registration) may
21
- # be included alongside the LOA.
22
- #
23
- # @return [Array<Telnyx::Models::Document>]
24
- required :documents, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Document] }
25
-
26
- # @!attribute phone_numbers
27
- # 1–15 phone numbers in E.164 format. 10-digit US numbers are auto-prefixed with
28
- # `1`.
29
- #
30
- # @return [Array<String>]
31
- required :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]
32
-
33
- # @!method initialize(dir_id:, documents:, phone_numbers:, request_options: {})
34
- # Some parameter documentations has been truncated, see
35
- # {Telnyx::Models::Dir::PhoneNumberCreateParams} for more details.
36
- #
37
- # @param dir_id [String]
38
- #
39
- # @param documents [Array<Telnyx::Models::Document>] Supporting documents covering this batch. At least one entry with `document_type
40
- #
41
- # @param phone_numbers [Array<String>] 1–15 phone numbers in E.164 format. 10-digit US numbers are auto-prefixed with `
42
- #
43
- # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
44
- end
45
- end
46
- end
47
- end
@@ -1,32 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- module Dir
6
- # @see Telnyx::Resources::Dir::PhoneNumbers#create
7
- class PhoneNumberCreateResponse < Telnyx::Internal::Type::BaseModel
8
- # @!attribute data
9
- # Phone numbers accepted into the new batch. List order mirrors the request order.
10
- # Each element shares the same `batch_id`.
11
- #
12
- # @return [Array<Telnyx::Models::Dir::DirPhoneNumber>]
13
- required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Dir::DirPhoneNumber] }
14
-
15
- # @!method initialize(data:)
16
- # Some parameter documentations has been truncated, see
17
- # {Telnyx::Models::Dir::PhoneNumberCreateResponse} for more details.
18
- #
19
- # Bulk-add success response (HTTP 201). All numbers in the request were accepted
20
- # into a single new batch. Every entry in `data` shares the same `batch_id` - read
21
- # it from any element to obtain the batch id for subsequent
22
- # `GET .../phone_number_batches/{batch_id}` calls. If any number in the request
23
- # fails (schema-invalid, not in inventory, already attached to another DIR, etc.)
24
- # the entire request is rejected with HTTP 400 and the canonical Telnyx error
25
- # envelope; the success body described here is therefore an all-or-nothing
26
- # payload.
27
- #
28
- # @param data [Array<Telnyx::Models::Dir::DirPhoneNumber>] Phone numbers accepted into the new batch. List order mirrors the request order.
29
- end
30
- end
31
- end
32
- end
@@ -1,28 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- module Dir
6
- # @see Telnyx::Resources::Dir::PhoneNumbers#delete_all
7
- class PhoneNumberDeleteAllParams < Telnyx::Internal::Type::BaseModel
8
- extend Telnyx::Internal::Type::RequestParameters::Converter
9
- include Telnyx::Internal::Type::RequestParameters
10
-
11
- # @!attribute dir_id
12
- #
13
- # @return [String]
14
- required :dir_id, String
15
-
16
- # @!attribute phone_numbers
17
- #
18
- # @return [Array<String>]
19
- required :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]
20
-
21
- # @!method initialize(dir_id:, phone_numbers:, request_options: {})
22
- # @param dir_id [String]
23
- # @param phone_numbers [Array<String>]
24
- # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
25
- end
26
- end
27
- end
28
- end
@@ -1,103 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- module Dir
6
- # @see Telnyx::Resources::Dir::PhoneNumbers#delete_all
7
- class PhoneNumberDeleteAllResponse < Telnyx::Internal::Type::BaseModel
8
- # @!attribute data
9
- # Phone numbers that were successfully soft-deleted. Bare E.164 strings.
10
- #
11
- # @return [Array<String>]
12
- required :data, Telnyx::Internal::Type::ArrayOf[String]
13
-
14
- # @!attribute meta
15
- #
16
- # @return [Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta]
17
- required :meta, -> { Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta }
18
-
19
- # @!method initialize(data:, meta:)
20
- # Bulk-delete partial-success response. `data` is the list of phone numbers that
21
- # were soft-deleted. `meta.errors` holds per-number failures (e.g. number not
22
- # associated with this DIR). When EVERY number in the request fails, the endpoint
23
- # instead returns 400 with the canonical Telnyx error envelope and `data`/`meta`
24
- # are absent.
25
- #
26
- # @param data [Array<String>] Phone numbers that were successfully soft-deleted. Bare E.164 strings.
27
- #
28
- # @param meta [Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta]
29
-
30
- # @see Telnyx::Models::Dir::PhoneNumberDeleteAllResponse#meta
31
- class Meta < Telnyx::Internal::Type::BaseModel
32
- # @!attribute errors
33
- # Per-number failures that did not block the call. Each entry has `phone_number`,
34
- # `code`, `title`, `detail`.
35
- #
36
- # @return [Array<Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error>]
37
- required :errors,
38
- -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error] }
39
-
40
- # @!method initialize(errors:)
41
- # Some parameter documentations has been truncated, see
42
- # {Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta} for more details.
43
- #
44
- # @param errors [Array<Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error>] Per-number failures that did not block the call. Each entry has `phone_number`,
45
-
46
- class Error < Telnyx::Internal::Type::BaseModel
47
- # @!attribute code
48
- # Stable per-number error code. Currently only `not_associated` is emitted, when
49
- # the number is not attached to this DIR.
50
- #
51
- # @return [Symbol, Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error::Code]
52
- required :code, enum: -> { Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error::Code }
53
-
54
- # @!attribute detail
55
- #
56
- # @return [String]
57
- required :detail, String
58
-
59
- # @!attribute phone_number
60
- #
61
- # @return [String]
62
- required :phone_number, String
63
-
64
- # @!attribute title
65
- #
66
- # @return [String]
67
- required :title, String
68
-
69
- # @!method initialize(code:, detail:, phone_number:, title:)
70
- # Some parameter documentations has been truncated, see
71
- # {Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error} for more
72
- # details.
73
- #
74
- # Per-number error returned by the bulk-delete endpoint. Bulk-add does not use
75
- # this shape - it returns a 400 with the canonical envelope grouping numbers by
76
- # failure category.
77
- #
78
- # @param code [Symbol, Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error::Code] Stable per-number error code. Currently only `not_associated` is emitted, when t
79
- #
80
- # @param detail [String]
81
- #
82
- # @param phone_number [String]
83
- #
84
- # @param title [String]
85
-
86
- # Stable per-number error code. Currently only `not_associated` is emitted, when
87
- # the number is not attached to this DIR.
88
- #
89
- # @see Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error#code
90
- module Code
91
- extend Telnyx::Internal::Type::Enum
92
-
93
- NOT_ASSOCIATED = :not_associated
94
-
95
- # @!method self.values
96
- # @return [Array<Symbol>]
97
- end
98
- end
99
- end
100
- end
101
- end
102
- end
103
- end
@@ -1,79 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- # @see Telnyx::Resources::Dir#loa
6
- class DirLoaParams < Telnyx::Internal::Type::BaseModel
7
- extend Telnyx::Internal::Type::RequestParameters::Converter
8
- include Telnyx::Internal::Type::RequestParameters
9
-
10
- # @!attribute dir_id
11
- #
12
- # @return [String]
13
- required :dir_id, String
14
-
15
- # @!attribute phone_numbers
16
- # Telephone numbers to authorize on the DIR, in `+E164` format (`+` followed by
17
- # 10-15 digits). Max 15 per request.
18
- #
19
- # @return [Array<String>]
20
- required :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]
21
-
22
- # @!attribute agent
23
- # Third-party reseller / partner managing the enterprise's phone numbers. Omit
24
- # when the enterprise works directly with Telnyx.
25
- #
26
- # @return [Telnyx::Models::Enterprises::Reputation::AgentInput, nil]
27
- optional :agent, -> { Telnyx::Enterprises::Reputation::AgentInput }
28
-
29
- # @!attribute signature
30
- # Optional. When provided the rendered PDF embeds the signature image, printed
31
- # name, and signed-at date. When absent the PDF is returned unsigned so the
32
- # customer can sign externally and upload it via the Documents API.
33
- #
34
- # @return [Telnyx::Models::DirLoaParams::Signature, nil]
35
- optional :signature, -> { Telnyx::DirLoaParams::Signature }
36
-
37
- # @!method initialize(dir_id:, phone_numbers:, agent: nil, signature: nil, request_options: {})
38
- # Some parameter documentations has been truncated, see
39
- # {Telnyx::Models::DirLoaParams} for more details.
40
- #
41
- # @param dir_id [String]
42
- #
43
- # @param phone_numbers [Array<String>] Telephone numbers to authorize on the DIR, in `+E164` format (`+` followed by 10
44
- #
45
- # @param agent [Telnyx::Models::Enterprises::Reputation::AgentInput] Third-party reseller / partner managing the enterprise's phone numbers. Omit whe
46
- #
47
- # @param signature [Telnyx::Models::DirLoaParams::Signature] Optional. When provided the rendered PDF embeds the signature image, printed nam
48
- #
49
- # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
50
-
51
- class Signature < Telnyx::Internal::Type::BaseModel
52
- # @!attribute image_base64
53
- # PNG image, base64-encoded.
54
- #
55
- # @return [String]
56
- required :image_base64, String
57
-
58
- # @!attribute signer_name
59
- # Optional. When absent the rendered PDF falls back to the enterprise contact's
60
- # legal name.
61
- #
62
- # @return [String, nil]
63
- optional :signer_name, String, nil?: true
64
-
65
- # @!method initialize(image_base64:, signer_name: nil)
66
- # Some parameter documentations has been truncated, see
67
- # {Telnyx::Models::DirLoaParams::Signature} for more details.
68
- #
69
- # Optional. When provided the rendered PDF embeds the signature image, printed
70
- # name, and signed-at date. When absent the PDF is returned unsigned so the
71
- # customer can sign externally and upload it via the Documents API.
72
- #
73
- # @param image_base64 [String] PNG image, base64-encoded.
74
- #
75
- # @param signer_name [String, nil] Optional. When absent the rendered PDF falls back to the enterprise contact's le
76
- end
77
- end
78
- end
79
- end
@@ -1,14 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- # @see Telnyx::Resources::Dir#retrieve_document_types
6
- class DirRetrieveDocumentTypesParams < Telnyx::Internal::Type::BaseModel
7
- extend Telnyx::Internal::Type::RequestParameters::Converter
8
- include Telnyx::Internal::Type::RequestParameters
9
-
10
- # @!method initialize(request_options: {})
11
- # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
12
- end
13
- end
14
- end