telnyx 4.2.0 → 4.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +23 -0
- data/README.md +1 -1
- data/lib/telnyx/internal/util.rb +5 -5
- data/lib/telnyx/models/ai/assistant_import_params.rb +1 -0
- data/lib/telnyx/models/ai/import_metadata.rb +1 -0
- data/lib/telnyx/models/messaging_tollfree/verification/tf_verification_request.rb +114 -1
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +99 -1
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +99 -1
- data/lib/telnyx/models/network_coverage_list_response.rb +1 -2
- data/lib/telnyx/models/outbound_voice_profile.rb +47 -1
- data/lib/telnyx/models/outbound_voice_profile_create_params.rb +47 -1
- data/lib/telnyx/models/outbound_voice_profile_list_params.rb +5 -5
- data/lib/telnyx/models/outbound_voice_profile_update_params.rb +47 -1
- data/lib/telnyx/models/requirement_group.rb +2 -0
- data/lib/telnyx/models/requirement_group_list_params.rb +1 -0
- data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +46 -2
- data/lib/telnyx/resources/outbound_voice_profiles.rb +7 -3
- data/lib/telnyx/resources/sim_cards/actions.rb +6 -6
- data/lib/telnyx/version.rb +1 -1
- data/rbi/telnyx/models/ai/assistant_import_params.rbi +5 -0
- data/rbi/telnyx/models/ai/import_metadata.rbi +5 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbi +165 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +164 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi +164 -0
- data/rbi/telnyx/models/network_coverage_list_response.rbi +4 -8
- data/rbi/telnyx/models/outbound_voice_profile.rbi +81 -0
- data/rbi/telnyx/models/outbound_voice_profile_create_params.rbi +88 -0
- data/rbi/telnyx/models/outbound_voice_profile_list_params.rbi +6 -6
- data/rbi/telnyx/models/outbound_voice_profile_update_params.rbi +88 -0
- data/rbi/telnyx/models/requirement_group.rbi +7 -0
- data/rbi/telnyx/models/requirement_group_list_params.rbi +5 -0
- data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +84 -0
- data/rbi/telnyx/resources/outbound_voice_profiles.rbi +12 -2
- data/rbi/telnyx/resources/sim_cards/actions.rbi +6 -6
- data/sig/telnyx/models/ai/assistant_import_params.rbs +2 -1
- data/sig/telnyx/models/ai/import_metadata.rbs +2 -1
- data/sig/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbs +76 -0
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs +98 -0
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_status.rbs +98 -0
- data/sig/telnyx/models/outbound_voice_profile.rbs +38 -0
- data/sig/telnyx/models/outbound_voice_profile_create_params.rbs +38 -0
- data/sig/telnyx/models/outbound_voice_profile_update_params.rbs +38 -0
- data/sig/telnyx/models/requirement_group.rbs +6 -2
- data/sig/telnyx/models/requirement_group_list_params.rbs +3 -1
- data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +22 -0
- data/sig/telnyx/resources/outbound_voice_profiles.rbs +2 -0
- metadata +2 -2
|
@@ -25,6 +25,13 @@ module Telnyx
|
|
|
25
25
|
# @return [Telnyx::Models::OutboundCallRecording, nil]
|
|
26
26
|
optional :call_recording, -> { Telnyx::OutboundCallRecording }
|
|
27
27
|
|
|
28
|
+
# @!attribute calling_window
|
|
29
|
+
# (BETA) Specifies the time window and call limits for calls made using this
|
|
30
|
+
# outbound voice profile. Note that all times are UTC in 24-hour clock time.
|
|
31
|
+
#
|
|
32
|
+
# @return [Telnyx::Models::OutboundVoiceProfileCreateParams::CallingWindow, nil]
|
|
33
|
+
optional :calling_window, -> { Telnyx::OutboundVoiceProfileCreateParams::CallingWindow }
|
|
34
|
+
|
|
28
35
|
# @!attribute concurrent_call_limit
|
|
29
36
|
# Must be no more than your global concurrent call limit. Null means no limit.
|
|
30
37
|
#
|
|
@@ -89,7 +96,7 @@ module Telnyx
|
|
|
89
96
|
# @return [Array<String>, nil]
|
|
90
97
|
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
91
98
|
|
|
92
|
-
# @!method initialize(name:, billing_group_id: nil, call_recording: nil, concurrent_call_limit: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, max_destination_rate: nil, service_plan: nil, tags: nil, traffic_type: nil, usage_payment_method: nil, whitelisted_destinations: nil, request_options: {})
|
|
99
|
+
# @!method initialize(name:, billing_group_id: nil, call_recording: nil, calling_window: nil, concurrent_call_limit: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, max_destination_rate: nil, service_plan: nil, tags: nil, traffic_type: nil, usage_payment_method: nil, whitelisted_destinations: nil, request_options: {})
|
|
93
100
|
# Some parameter documentations has been truncated, see
|
|
94
101
|
# {Telnyx::Models::OutboundVoiceProfileCreateParams} for more details.
|
|
95
102
|
#
|
|
@@ -99,6 +106,8 @@ module Telnyx
|
|
|
99
106
|
#
|
|
100
107
|
# @param call_recording [Telnyx::Models::OutboundCallRecording]
|
|
101
108
|
#
|
|
109
|
+
# @param calling_window [Telnyx::Models::OutboundVoiceProfileCreateParams::CallingWindow] (BETA) Specifies the time window and call limits for calls made using this outbo
|
|
110
|
+
#
|
|
102
111
|
# @param concurrent_call_limit [Integer, nil] Must be no more than your global concurrent call limit. Null means no limit.
|
|
103
112
|
#
|
|
104
113
|
# @param daily_spend_limit [String] The maximum amount of usage charges, in USD, you want Telnyx to allow on this ou
|
|
@@ -120,6 +129,43 @@ module Telnyx
|
|
|
120
129
|
# @param whitelisted_destinations [Array<String>] The list of destinations you want to be able to call using this outbound voice p
|
|
121
130
|
#
|
|
122
131
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
132
|
+
|
|
133
|
+
class CallingWindow < Telnyx::Internal::Type::BaseModel
|
|
134
|
+
# @!attribute calls_per_cld
|
|
135
|
+
# (BETA) The maximum number of calls that can be initiated to a single called
|
|
136
|
+
# party (CLD) within the calling window. A null value means no limit.
|
|
137
|
+
#
|
|
138
|
+
# @return [Integer, nil]
|
|
139
|
+
optional :calls_per_cld, Integer
|
|
140
|
+
|
|
141
|
+
# @!attribute end_time
|
|
142
|
+
# (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
|
|
143
|
+
# longer allowed to start.
|
|
144
|
+
#
|
|
145
|
+
# @return [Time, nil]
|
|
146
|
+
optional :end_time, Time
|
|
147
|
+
|
|
148
|
+
# @!attribute start_time
|
|
149
|
+
# (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
|
|
150
|
+
# allowed to start.
|
|
151
|
+
#
|
|
152
|
+
# @return [Time, nil]
|
|
153
|
+
optional :start_time, Time
|
|
154
|
+
|
|
155
|
+
# @!method initialize(calls_per_cld: nil, end_time: nil, start_time: nil)
|
|
156
|
+
# Some parameter documentations has been truncated, see
|
|
157
|
+
# {Telnyx::Models::OutboundVoiceProfileCreateParams::CallingWindow} for more
|
|
158
|
+
# details.
|
|
159
|
+
#
|
|
160
|
+
# (BETA) Specifies the time window and call limits for calls made using this
|
|
161
|
+
# outbound voice profile. Note that all times are UTC in 24-hour clock time.
|
|
162
|
+
#
|
|
163
|
+
# @param calls_per_cld [Integer] (BETA) The maximum number of calls that can be initiated to a single called part
|
|
164
|
+
#
|
|
165
|
+
# @param end_time [Time] (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no lo
|
|
166
|
+
#
|
|
167
|
+
# @param start_time [Time] (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are allow
|
|
168
|
+
end
|
|
123
169
|
end
|
|
124
170
|
end
|
|
125
171
|
end
|
|
@@ -15,8 +15,8 @@ module Telnyx
|
|
|
15
15
|
optional :filter, -> { Telnyx::OutboundVoiceProfileListParams::Filter }
|
|
16
16
|
|
|
17
17
|
# @!attribute page
|
|
18
|
-
# Consolidated page parameter (deepObject style). Originally: page[
|
|
19
|
-
# page[
|
|
18
|
+
# Consolidated page parameter (deepObject style). Originally: page[size],
|
|
19
|
+
# page[number]
|
|
20
20
|
#
|
|
21
21
|
# @return [Telnyx::Models::OutboundVoiceProfileListParams::Page, nil]
|
|
22
22
|
optional :page, -> { Telnyx::OutboundVoiceProfileListParams::Page }
|
|
@@ -46,7 +46,7 @@ module Telnyx
|
|
|
46
46
|
#
|
|
47
47
|
# @param filter [Telnyx::Models::OutboundVoiceProfileListParams::Filter] Consolidated filter parameter (deepObject style). Originally: filter[name]conta
|
|
48
48
|
#
|
|
49
|
-
# @param page [Telnyx::Models::OutboundVoiceProfileListParams::Page] Consolidated page parameter (deepObject style). Originally: page[
|
|
49
|
+
# @param page [Telnyx::Models::OutboundVoiceProfileListParams::Page] Consolidated page parameter (deepObject style). Originally: page[size], page[num
|
|
50
50
|
#
|
|
51
51
|
# @param sort [Symbol, Telnyx::Models::OutboundVoiceProfileListParams::Sort] Specifies the sort order for results. By default sorting direction is ascending.
|
|
52
52
|
#
|
|
@@ -94,8 +94,8 @@ module Telnyx
|
|
|
94
94
|
optional :size, Integer
|
|
95
95
|
|
|
96
96
|
# @!method initialize(number: nil, size: nil)
|
|
97
|
-
# Consolidated page parameter (deepObject style). Originally: page[
|
|
98
|
-
# page[
|
|
97
|
+
# Consolidated page parameter (deepObject style). Originally: page[size],
|
|
98
|
+
# page[number]
|
|
99
99
|
#
|
|
100
100
|
# @param number [Integer] The page number to load.
|
|
101
101
|
#
|
|
@@ -25,6 +25,13 @@ module Telnyx
|
|
|
25
25
|
# @return [Telnyx::Models::OutboundCallRecording, nil]
|
|
26
26
|
optional :call_recording, -> { Telnyx::OutboundCallRecording }
|
|
27
27
|
|
|
28
|
+
# @!attribute calling_window
|
|
29
|
+
# (BETA) Specifies the time window and call limits for calls made using this
|
|
30
|
+
# outbound voice profile.
|
|
31
|
+
#
|
|
32
|
+
# @return [Telnyx::Models::OutboundVoiceProfileUpdateParams::CallingWindow, nil]
|
|
33
|
+
optional :calling_window, -> { Telnyx::OutboundVoiceProfileUpdateParams::CallingWindow }
|
|
34
|
+
|
|
28
35
|
# @!attribute concurrent_call_limit
|
|
29
36
|
# Must be no more than your global concurrent call limit. Null means no limit.
|
|
30
37
|
#
|
|
@@ -89,7 +96,7 @@ module Telnyx
|
|
|
89
96
|
# @return [Array<String>, nil]
|
|
90
97
|
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
91
98
|
|
|
92
|
-
# @!method initialize(name:, billing_group_id: nil, call_recording: nil, concurrent_call_limit: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, max_destination_rate: nil, service_plan: nil, tags: nil, traffic_type: nil, usage_payment_method: nil, whitelisted_destinations: nil, request_options: {})
|
|
99
|
+
# @!method initialize(name:, billing_group_id: nil, call_recording: nil, calling_window: nil, concurrent_call_limit: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, max_destination_rate: nil, service_plan: nil, tags: nil, traffic_type: nil, usage_payment_method: nil, whitelisted_destinations: nil, request_options: {})
|
|
93
100
|
# Some parameter documentations has been truncated, see
|
|
94
101
|
# {Telnyx::Models::OutboundVoiceProfileUpdateParams} for more details.
|
|
95
102
|
#
|
|
@@ -99,6 +106,8 @@ module Telnyx
|
|
|
99
106
|
#
|
|
100
107
|
# @param call_recording [Telnyx::Models::OutboundCallRecording]
|
|
101
108
|
#
|
|
109
|
+
# @param calling_window [Telnyx::Models::OutboundVoiceProfileUpdateParams::CallingWindow] (BETA) Specifies the time window and call limits for calls made using this outbo
|
|
110
|
+
#
|
|
102
111
|
# @param concurrent_call_limit [Integer, nil] Must be no more than your global concurrent call limit. Null means no limit.
|
|
103
112
|
#
|
|
104
113
|
# @param daily_spend_limit [String] The maximum amount of usage charges, in USD, you want Telnyx to allow on this ou
|
|
@@ -120,6 +129,43 @@ module Telnyx
|
|
|
120
129
|
# @param whitelisted_destinations [Array<String>] The list of destinations you want to be able to call using this outbound voice p
|
|
121
130
|
#
|
|
122
131
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
132
|
+
|
|
133
|
+
class CallingWindow < Telnyx::Internal::Type::BaseModel
|
|
134
|
+
# @!attribute calls_per_cld
|
|
135
|
+
# (BETA) The maximum number of calls that can be initiated to a single called
|
|
136
|
+
# party (CLD) within the calling window. A null value means no limit.
|
|
137
|
+
#
|
|
138
|
+
# @return [Integer, nil]
|
|
139
|
+
optional :calls_per_cld, Integer
|
|
140
|
+
|
|
141
|
+
# @!attribute end_time
|
|
142
|
+
# (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
|
|
143
|
+
# longer allowed to start.
|
|
144
|
+
#
|
|
145
|
+
# @return [Time, nil]
|
|
146
|
+
optional :end_time, Time
|
|
147
|
+
|
|
148
|
+
# @!attribute start_time
|
|
149
|
+
# (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
|
|
150
|
+
# allowed to start.
|
|
151
|
+
#
|
|
152
|
+
# @return [Time, nil]
|
|
153
|
+
optional :start_time, Time
|
|
154
|
+
|
|
155
|
+
# @!method initialize(calls_per_cld: nil, end_time: nil, start_time: nil)
|
|
156
|
+
# Some parameter documentations has been truncated, see
|
|
157
|
+
# {Telnyx::Models::OutboundVoiceProfileUpdateParams::CallingWindow} for more
|
|
158
|
+
# details.
|
|
159
|
+
#
|
|
160
|
+
# (BETA) Specifies the time window and call limits for calls made using this
|
|
161
|
+
# outbound voice profile.
|
|
162
|
+
#
|
|
163
|
+
# @param calls_per_cld [Integer] (BETA) The maximum number of calls that can be initiated to a single called part
|
|
164
|
+
#
|
|
165
|
+
# @param end_time [Time] (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no lo
|
|
166
|
+
#
|
|
167
|
+
# @param start_time [Time] (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are allow
|
|
168
|
+
end
|
|
123
169
|
end
|
|
124
170
|
end
|
|
125
171
|
end
|
|
@@ -120,6 +120,7 @@ module Telnyx
|
|
|
120
120
|
UNAPPROVED = :unapproved
|
|
121
121
|
PENDING_APPROVAL = :"pending-approval"
|
|
122
122
|
DECLINED = :declined
|
|
123
|
+
EXPIRED = :expired
|
|
123
124
|
|
|
124
125
|
# @!method self.values
|
|
125
126
|
# @return [Array<Symbol>]
|
|
@@ -134,6 +135,7 @@ module Telnyx
|
|
|
134
135
|
UNAPPROVED = :unapproved
|
|
135
136
|
PENDING_APPROVAL = :"pending-approval"
|
|
136
137
|
DECLINED = :declined
|
|
138
|
+
EXPIRED = :expired
|
|
137
139
|
|
|
138
140
|
# @!method self.values
|
|
139
141
|
# @return [Array<Symbol>]
|
|
@@ -11,7 +11,7 @@ module Telnyx
|
|
|
11
11
|
#
|
|
12
12
|
# Submit a new tollfree verification request
|
|
13
13
|
#
|
|
14
|
-
# @overload create(additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, business_addr2: nil, webhook_url: nil, request_options: {})
|
|
14
|
+
# @overload create(additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, webhook_url: nil, request_options: {})
|
|
15
15
|
#
|
|
16
16
|
# @param additional_information [String] Any additional information
|
|
17
17
|
#
|
|
@@ -51,8 +51,30 @@ module Telnyx
|
|
|
51
51
|
#
|
|
52
52
|
# @param use_case_summary [String] Human-readable summary of the desired use-case
|
|
53
53
|
#
|
|
54
|
+
# @param age_gated_content [Boolean] Indicates if messaging content requires age gating (e.g., 18+). Defaults to fals
|
|
55
|
+
#
|
|
54
56
|
# @param business_addr2 [String] Line 2 of the business address
|
|
55
57
|
#
|
|
58
|
+
# @param business_registration_country [String, nil] ISO 3166-1 alpha-2 country code of the issuing business authority. Must be exact
|
|
59
|
+
#
|
|
60
|
+
# @param business_registration_number [String, nil] Official business registration number (e.g., Employer Identification Number (EIN
|
|
61
|
+
#
|
|
62
|
+
# @param business_registration_type [String, nil] Type of business registration being provided. Required from January 2026.
|
|
63
|
+
#
|
|
64
|
+
# @param doing_business_as [String, nil] Doing Business As (DBA) name if different from legal name
|
|
65
|
+
#
|
|
66
|
+
# @param entity_type [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationRequest::EntityType, nil] Business entity classification
|
|
67
|
+
#
|
|
68
|
+
# @param help_message_response [String, nil] The message returned when users text 'HELP'
|
|
69
|
+
#
|
|
70
|
+
# @param opt_in_confirmation_response [String, nil] Message sent to users confirming their opt-in to receive messages
|
|
71
|
+
#
|
|
72
|
+
# @param opt_in_keywords [String, nil] Keywords used to collect and process consumer opt-ins
|
|
73
|
+
#
|
|
74
|
+
# @param privacy_policy_url [String, nil] URL pointing to the business's privacy policy. Plain string, no URL format valid
|
|
75
|
+
#
|
|
76
|
+
# @param terms_and_condition_url [String, nil] URL pointing to the business's terms and conditions. Plain string, no URL format
|
|
77
|
+
#
|
|
56
78
|
# @param webhook_url [String] URL that should receive webhooks relating to this verification request
|
|
57
79
|
#
|
|
58
80
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -97,7 +119,7 @@ module Telnyx
|
|
|
97
119
|
# Update an existing tollfree verification request. This is particularly useful
|
|
98
120
|
# when there are pending customer actions to be taken.
|
|
99
121
|
#
|
|
100
|
-
# @overload update(id, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, business_addr2: nil, webhook_url: nil, request_options: {})
|
|
122
|
+
# @overload update(id, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, webhook_url: nil, request_options: {})
|
|
101
123
|
#
|
|
102
124
|
# @param id [String]
|
|
103
125
|
#
|
|
@@ -139,8 +161,30 @@ module Telnyx
|
|
|
139
161
|
#
|
|
140
162
|
# @param use_case_summary [String] Human-readable summary of the desired use-case
|
|
141
163
|
#
|
|
164
|
+
# @param age_gated_content [Boolean] Indicates if messaging content requires age gating (e.g., 18+). Defaults to fals
|
|
165
|
+
#
|
|
142
166
|
# @param business_addr2 [String] Line 2 of the business address
|
|
143
167
|
#
|
|
168
|
+
# @param business_registration_country [String, nil] ISO 3166-1 alpha-2 country code of the issuing business authority. Must be exact
|
|
169
|
+
#
|
|
170
|
+
# @param business_registration_number [String, nil] Official business registration number (e.g., Employer Identification Number (EIN
|
|
171
|
+
#
|
|
172
|
+
# @param business_registration_type [String, nil] Type of business registration being provided. Required from January 2026.
|
|
173
|
+
#
|
|
174
|
+
# @param doing_business_as [String, nil] Doing Business As (DBA) name if different from legal name
|
|
175
|
+
#
|
|
176
|
+
# @param entity_type [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationRequest::EntityType, nil] Business entity classification
|
|
177
|
+
#
|
|
178
|
+
# @param help_message_response [String, nil] The message returned when users text 'HELP'
|
|
179
|
+
#
|
|
180
|
+
# @param opt_in_confirmation_response [String, nil] Message sent to users confirming their opt-in to receive messages
|
|
181
|
+
#
|
|
182
|
+
# @param opt_in_keywords [String, nil] Keywords used to collect and process consumer opt-ins
|
|
183
|
+
#
|
|
184
|
+
# @param privacy_policy_url [String, nil] URL pointing to the business's privacy policy. Plain string, no URL format valid
|
|
185
|
+
#
|
|
186
|
+
# @param terms_and_condition_url [String, nil] URL pointing to the business's terms and conditions. Plain string, no URL format
|
|
187
|
+
#
|
|
144
188
|
# @param webhook_url [String] URL that should receive webhooks relating to this verification request
|
|
145
189
|
#
|
|
146
190
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -8,7 +8,7 @@ module Telnyx
|
|
|
8
8
|
#
|
|
9
9
|
# Create an outbound voice profile.
|
|
10
10
|
#
|
|
11
|
-
# @overload create(name:, billing_group_id: nil, call_recording: nil, concurrent_call_limit: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, max_destination_rate: nil, service_plan: nil, tags: nil, traffic_type: nil, usage_payment_method: nil, whitelisted_destinations: nil, request_options: {})
|
|
11
|
+
# @overload create(name:, billing_group_id: nil, call_recording: nil, calling_window: nil, concurrent_call_limit: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, max_destination_rate: nil, service_plan: nil, tags: nil, traffic_type: nil, usage_payment_method: nil, whitelisted_destinations: nil, request_options: {})
|
|
12
12
|
#
|
|
13
13
|
# @param name [String] A user-supplied name to help with organization.
|
|
14
14
|
#
|
|
@@ -16,6 +16,8 @@ module Telnyx
|
|
|
16
16
|
#
|
|
17
17
|
# @param call_recording [Telnyx::Models::OutboundCallRecording]
|
|
18
18
|
#
|
|
19
|
+
# @param calling_window [Telnyx::Models::OutboundVoiceProfileCreateParams::CallingWindow] (BETA) Specifies the time window and call limits for calls made using this outbo
|
|
20
|
+
#
|
|
19
21
|
# @param concurrent_call_limit [Integer, nil] Must be no more than your global concurrent call limit. Null means no limit.
|
|
20
22
|
#
|
|
21
23
|
# @param daily_spend_limit [String] The maximum amount of usage charges, in USD, you want Telnyx to allow on this ou
|
|
@@ -77,7 +79,7 @@ module Telnyx
|
|
|
77
79
|
#
|
|
78
80
|
# Updates an existing outbound voice profile.
|
|
79
81
|
#
|
|
80
|
-
# @overload update(id, name:, billing_group_id: nil, call_recording: nil, concurrent_call_limit: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, max_destination_rate: nil, service_plan: nil, tags: nil, traffic_type: nil, usage_payment_method: nil, whitelisted_destinations: nil, request_options: {})
|
|
82
|
+
# @overload update(id, name:, billing_group_id: nil, call_recording: nil, calling_window: nil, concurrent_call_limit: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, max_destination_rate: nil, service_plan: nil, tags: nil, traffic_type: nil, usage_payment_method: nil, whitelisted_destinations: nil, request_options: {})
|
|
81
83
|
#
|
|
82
84
|
# @param id [String] Identifies the resource.
|
|
83
85
|
#
|
|
@@ -87,6 +89,8 @@ module Telnyx
|
|
|
87
89
|
#
|
|
88
90
|
# @param call_recording [Telnyx::Models::OutboundCallRecording]
|
|
89
91
|
#
|
|
92
|
+
# @param calling_window [Telnyx::Models::OutboundVoiceProfileUpdateParams::CallingWindow] (BETA) Specifies the time window and call limits for calls made using this outbo
|
|
93
|
+
#
|
|
90
94
|
# @param concurrent_call_limit [Integer, nil] Must be no more than your global concurrent call limit. Null means no limit.
|
|
91
95
|
#
|
|
92
96
|
# @param daily_spend_limit [String] The maximum amount of usage charges, in USD, you want Telnyx to allow on this ou
|
|
@@ -133,7 +137,7 @@ module Telnyx
|
|
|
133
137
|
#
|
|
134
138
|
# @param filter [Telnyx::Models::OutboundVoiceProfileListParams::Filter] Consolidated filter parameter (deepObject style). Originally: filter[name]conta
|
|
135
139
|
#
|
|
136
|
-
# @param page [Telnyx::Models::OutboundVoiceProfileListParams::Page] Consolidated page parameter (deepObject style). Originally: page[
|
|
140
|
+
# @param page [Telnyx::Models::OutboundVoiceProfileListParams::Page] Consolidated page parameter (deepObject style). Originally: page[size], page[num
|
|
137
141
|
#
|
|
138
142
|
# @param sort [Symbol, Telnyx::Models::OutboundVoiceProfileListParams::Sort] Specifies the sort order for results. By default sorting direction is ascending.
|
|
139
143
|
#
|
|
@@ -56,7 +56,7 @@ module Telnyx
|
|
|
56
56
|
# This API triggers an asynchronous operation to set a public IP for each of the
|
|
57
57
|
# specified SIM cards.<br/> For each SIM Card a SIM Card Action will be generated.
|
|
58
58
|
# The status of the SIM Card Action can be followed through the
|
|
59
|
-
# [List SIM Card Action](https://
|
|
59
|
+
# [List SIM Card Action](https://developers.telnyx.com/api/wireless/list-sim-card-actions)
|
|
60
60
|
# API.
|
|
61
61
|
#
|
|
62
62
|
# @overload bulk_set_public_ips(sim_card_ids:, request_options: {})
|
|
@@ -82,7 +82,7 @@ module Telnyx
|
|
|
82
82
|
# impossible to consume data.<br/> The API will trigger an asynchronous operation
|
|
83
83
|
# called a SIM Card Action. Transitioning to the disabled state may take a period
|
|
84
84
|
# of time. The status of the SIM Card Action can be followed through the
|
|
85
|
-
# [List SIM Card Action](https://
|
|
85
|
+
# [List SIM Card Action](https://developers.telnyx.com/api/wireless/list-sim-card-actions)
|
|
86
86
|
# API.
|
|
87
87
|
#
|
|
88
88
|
# @overload disable(id, request_options: {})
|
|
@@ -108,7 +108,7 @@ module Telnyx
|
|
|
108
108
|
# card group.<br/> The API will trigger an asynchronous operation called a SIM
|
|
109
109
|
# Card Action. Transitioning to the enabled state may take a period of time. The
|
|
110
110
|
# status of the SIM Card Action can be followed through the
|
|
111
|
-
# [List SIM Card Action](https://
|
|
111
|
+
# [List SIM Card Action](https://developers.telnyx.com/api/wireless/list-sim-card-actions)
|
|
112
112
|
# API.
|
|
113
113
|
#
|
|
114
114
|
# @overload enable(id, request_options: {})
|
|
@@ -132,7 +132,7 @@ module Telnyx
|
|
|
132
132
|
# This API removes an existing public IP from a SIM card. <br/><br/> The API will
|
|
133
133
|
# trigger an asynchronous operation called a SIM Card Action. The status of the
|
|
134
134
|
# SIM Card Action can be followed through the
|
|
135
|
-
# [List SIM Card Action](https://
|
|
135
|
+
# [List SIM Card Action](https://developers.telnyx.com/api/wireless/list-sim-card-actions)
|
|
136
136
|
# API.
|
|
137
137
|
#
|
|
138
138
|
# @overload remove_public_ip(id, request_options: {})
|
|
@@ -160,7 +160,7 @@ module Telnyx
|
|
|
160
160
|
# public IP to the SIM card. <br/><br/> The API will trigger an asynchronous
|
|
161
161
|
# operation called a SIM Card Action. The status of the SIM Card Action can be
|
|
162
162
|
# followed through the
|
|
163
|
-
# [List SIM Card Action](https://
|
|
163
|
+
# [List SIM Card Action](https://developers.telnyx.com/api/wireless/list-sim-card-actions)
|
|
164
164
|
# API. <br/><br/> Setting a Public IP to a SIM Card incurs a charge and will only
|
|
165
165
|
# succeed if the account has sufficient funds.
|
|
166
166
|
#
|
|
@@ -192,7 +192,7 @@ module Telnyx
|
|
|
192
192
|
# API will trigger an asynchronous operation called a SIM Card Action.
|
|
193
193
|
# Transitioning to the standby state may take a period of time. The status of the
|
|
194
194
|
# SIM Card Action can be followed through the
|
|
195
|
-
# [List SIM Card Action](https://
|
|
195
|
+
# [List SIM Card Action](https://developers.telnyx.com/api/wireless/list-sim-card-actions)
|
|
196
196
|
# API.
|
|
197
197
|
#
|
|
198
198
|
# @overload set_standby(id, request_options: {})
|
data/lib/telnyx/version.rb
CHANGED
|
@@ -105,6 +105,14 @@ module Telnyx
|
|
|
105
105
|
sig { returns(String) }
|
|
106
106
|
attr_accessor :use_case_summary
|
|
107
107
|
|
|
108
|
+
# Indicates if messaging content requires age gating (e.g., 18+). Defaults to
|
|
109
|
+
# false if not provided.
|
|
110
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
111
|
+
attr_reader :age_gated_content
|
|
112
|
+
|
|
113
|
+
sig { params(age_gated_content: T::Boolean).void }
|
|
114
|
+
attr_writer :age_gated_content
|
|
115
|
+
|
|
108
116
|
# Line 2 of the business address
|
|
109
117
|
sig { returns(T.nilable(String)) }
|
|
110
118
|
attr_reader :business_addr2
|
|
@@ -112,6 +120,57 @@ module Telnyx
|
|
|
112
120
|
sig { params(business_addr2: String).void }
|
|
113
121
|
attr_writer :business_addr2
|
|
114
122
|
|
|
123
|
+
# ISO 3166-1 alpha-2 country code of the issuing business authority. Must be
|
|
124
|
+
# exactly 2 letters. Automatically converted to uppercase. Required from
|
|
125
|
+
# January 2026.
|
|
126
|
+
sig { returns(T.nilable(String)) }
|
|
127
|
+
attr_accessor :business_registration_country
|
|
128
|
+
|
|
129
|
+
# Official business registration number (e.g., Employer Identification Number
|
|
130
|
+
# (EIN) in the U.S.). Required from January 2026.
|
|
131
|
+
sig { returns(T.nilable(String)) }
|
|
132
|
+
attr_accessor :business_registration_number
|
|
133
|
+
|
|
134
|
+
# Type of business registration being provided. Required from January 2026.
|
|
135
|
+
sig { returns(T.nilable(String)) }
|
|
136
|
+
attr_accessor :business_registration_type
|
|
137
|
+
|
|
138
|
+
# Doing Business As (DBA) name if different from legal name
|
|
139
|
+
sig { returns(T.nilable(String)) }
|
|
140
|
+
attr_accessor :doing_business_as
|
|
141
|
+
|
|
142
|
+
# Business entity classification
|
|
143
|
+
sig do
|
|
144
|
+
returns(
|
|
145
|
+
T.nilable(
|
|
146
|
+
Telnyx::MessagingTollfree::Verification::TfVerificationRequest::EntityType::OrSymbol
|
|
147
|
+
)
|
|
148
|
+
)
|
|
149
|
+
end
|
|
150
|
+
attr_accessor :entity_type
|
|
151
|
+
|
|
152
|
+
# The message returned when users text 'HELP'
|
|
153
|
+
sig { returns(T.nilable(String)) }
|
|
154
|
+
attr_accessor :help_message_response
|
|
155
|
+
|
|
156
|
+
# Message sent to users confirming their opt-in to receive messages
|
|
157
|
+
sig { returns(T.nilable(String)) }
|
|
158
|
+
attr_accessor :opt_in_confirmation_response
|
|
159
|
+
|
|
160
|
+
# Keywords used to collect and process consumer opt-ins
|
|
161
|
+
sig { returns(T.nilable(String)) }
|
|
162
|
+
attr_accessor :opt_in_keywords
|
|
163
|
+
|
|
164
|
+
# URL pointing to the business's privacy policy. Plain string, no URL format
|
|
165
|
+
# validation.
|
|
166
|
+
sig { returns(T.nilable(String)) }
|
|
167
|
+
attr_accessor :privacy_policy_url
|
|
168
|
+
|
|
169
|
+
# URL pointing to the business's terms and conditions. Plain string, no URL format
|
|
170
|
+
# validation.
|
|
171
|
+
sig { returns(T.nilable(String)) }
|
|
172
|
+
attr_accessor :terms_and_condition_url
|
|
173
|
+
|
|
115
174
|
# URL that should receive webhooks relating to this verification request
|
|
116
175
|
sig { returns(T.nilable(String)) }
|
|
117
176
|
attr_reader :webhook_url
|
|
@@ -147,7 +206,21 @@ module Telnyx
|
|
|
147
206
|
use_case:
|
|
148
207
|
Telnyx::MessagingTollfree::Verification::UseCaseCategories::OrSymbol,
|
|
149
208
|
use_case_summary: String,
|
|
209
|
+
age_gated_content: T::Boolean,
|
|
150
210
|
business_addr2: String,
|
|
211
|
+
business_registration_country: T.nilable(String),
|
|
212
|
+
business_registration_number: T.nilable(String),
|
|
213
|
+
business_registration_type: T.nilable(String),
|
|
214
|
+
doing_business_as: T.nilable(String),
|
|
215
|
+
entity_type:
|
|
216
|
+
T.nilable(
|
|
217
|
+
Telnyx::MessagingTollfree::Verification::TfVerificationRequest::EntityType::OrSymbol
|
|
218
|
+
),
|
|
219
|
+
help_message_response: T.nilable(String),
|
|
220
|
+
opt_in_confirmation_response: T.nilable(String),
|
|
221
|
+
opt_in_keywords: T.nilable(String),
|
|
222
|
+
privacy_policy_url: T.nilable(String),
|
|
223
|
+
terms_and_condition_url: T.nilable(String),
|
|
151
224
|
webhook_url: String
|
|
152
225
|
).returns(T.attached_class)
|
|
153
226
|
end
|
|
@@ -194,8 +267,36 @@ module Telnyx
|
|
|
194
267
|
use_case:,
|
|
195
268
|
# Human-readable summary of the desired use-case
|
|
196
269
|
use_case_summary:,
|
|
270
|
+
# Indicates if messaging content requires age gating (e.g., 18+). Defaults to
|
|
271
|
+
# false if not provided.
|
|
272
|
+
age_gated_content: nil,
|
|
197
273
|
# Line 2 of the business address
|
|
198
274
|
business_addr2: nil,
|
|
275
|
+
# ISO 3166-1 alpha-2 country code of the issuing business authority. Must be
|
|
276
|
+
# exactly 2 letters. Automatically converted to uppercase. Required from
|
|
277
|
+
# January 2026.
|
|
278
|
+
business_registration_country: nil,
|
|
279
|
+
# Official business registration number (e.g., Employer Identification Number
|
|
280
|
+
# (EIN) in the U.S.). Required from January 2026.
|
|
281
|
+
business_registration_number: nil,
|
|
282
|
+
# Type of business registration being provided. Required from January 2026.
|
|
283
|
+
business_registration_type: nil,
|
|
284
|
+
# Doing Business As (DBA) name if different from legal name
|
|
285
|
+
doing_business_as: nil,
|
|
286
|
+
# Business entity classification
|
|
287
|
+
entity_type: nil,
|
|
288
|
+
# The message returned when users text 'HELP'
|
|
289
|
+
help_message_response: nil,
|
|
290
|
+
# Message sent to users confirming their opt-in to receive messages
|
|
291
|
+
opt_in_confirmation_response: nil,
|
|
292
|
+
# Keywords used to collect and process consumer opt-ins
|
|
293
|
+
opt_in_keywords: nil,
|
|
294
|
+
# URL pointing to the business's privacy policy. Plain string, no URL format
|
|
295
|
+
# validation.
|
|
296
|
+
privacy_policy_url: nil,
|
|
297
|
+
# URL pointing to the business's terms and conditions. Plain string, no URL format
|
|
298
|
+
# validation.
|
|
299
|
+
terms_and_condition_url: nil,
|
|
199
300
|
# URL that should receive webhooks relating to this verification request
|
|
200
301
|
webhook_url: nil
|
|
201
302
|
)
|
|
@@ -229,13 +330,77 @@ module Telnyx
|
|
|
229
330
|
use_case:
|
|
230
331
|
Telnyx::MessagingTollfree::Verification::UseCaseCategories::OrSymbol,
|
|
231
332
|
use_case_summary: String,
|
|
333
|
+
age_gated_content: T::Boolean,
|
|
232
334
|
business_addr2: String,
|
|
335
|
+
business_registration_country: T.nilable(String),
|
|
336
|
+
business_registration_number: T.nilable(String),
|
|
337
|
+
business_registration_type: T.nilable(String),
|
|
338
|
+
doing_business_as: T.nilable(String),
|
|
339
|
+
entity_type:
|
|
340
|
+
T.nilable(
|
|
341
|
+
Telnyx::MessagingTollfree::Verification::TfVerificationRequest::EntityType::OrSymbol
|
|
342
|
+
),
|
|
343
|
+
help_message_response: T.nilable(String),
|
|
344
|
+
opt_in_confirmation_response: T.nilable(String),
|
|
345
|
+
opt_in_keywords: T.nilable(String),
|
|
346
|
+
privacy_policy_url: T.nilable(String),
|
|
347
|
+
terms_and_condition_url: T.nilable(String),
|
|
233
348
|
webhook_url: String
|
|
234
349
|
}
|
|
235
350
|
)
|
|
236
351
|
end
|
|
237
352
|
def to_hash
|
|
238
353
|
end
|
|
354
|
+
|
|
355
|
+
# Business entity classification
|
|
356
|
+
module EntityType
|
|
357
|
+
extend Telnyx::Internal::Type::Enum
|
|
358
|
+
|
|
359
|
+
TaggedSymbol =
|
|
360
|
+
T.type_alias do
|
|
361
|
+
T.all(
|
|
362
|
+
Symbol,
|
|
363
|
+
Telnyx::MessagingTollfree::Verification::TfVerificationRequest::EntityType
|
|
364
|
+
)
|
|
365
|
+
end
|
|
366
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
367
|
+
|
|
368
|
+
SOLE_PROPRIETOR =
|
|
369
|
+
T.let(
|
|
370
|
+
:SOLE_PROPRIETOR,
|
|
371
|
+
Telnyx::MessagingTollfree::Verification::TfVerificationRequest::EntityType::TaggedSymbol
|
|
372
|
+
)
|
|
373
|
+
PRIVATE_PROFIT =
|
|
374
|
+
T.let(
|
|
375
|
+
:PRIVATE_PROFIT,
|
|
376
|
+
Telnyx::MessagingTollfree::Verification::TfVerificationRequest::EntityType::TaggedSymbol
|
|
377
|
+
)
|
|
378
|
+
PUBLIC_PROFIT =
|
|
379
|
+
T.let(
|
|
380
|
+
:PUBLIC_PROFIT,
|
|
381
|
+
Telnyx::MessagingTollfree::Verification::TfVerificationRequest::EntityType::TaggedSymbol
|
|
382
|
+
)
|
|
383
|
+
NON_PROFIT =
|
|
384
|
+
T.let(
|
|
385
|
+
:NON_PROFIT,
|
|
386
|
+
Telnyx::MessagingTollfree::Verification::TfVerificationRequest::EntityType::TaggedSymbol
|
|
387
|
+
)
|
|
388
|
+
GOVERNMENT =
|
|
389
|
+
T.let(
|
|
390
|
+
:GOVERNMENT,
|
|
391
|
+
Telnyx::MessagingTollfree::Verification::TfVerificationRequest::EntityType::TaggedSymbol
|
|
392
|
+
)
|
|
393
|
+
|
|
394
|
+
sig do
|
|
395
|
+
override.returns(
|
|
396
|
+
T::Array[
|
|
397
|
+
Telnyx::MessagingTollfree::Verification::TfVerificationRequest::EntityType::TaggedSymbol
|
|
398
|
+
]
|
|
399
|
+
)
|
|
400
|
+
end
|
|
401
|
+
def self.values
|
|
402
|
+
end
|
|
403
|
+
end
|
|
239
404
|
end
|
|
240
405
|
end
|
|
241
406
|
end
|