telnyx 5.36.0 → 5.36.2
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 +18 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +8 -0
- data/lib/telnyx/models/alphanumeric_sender_id_create_params.rb +38 -0
- data/lib/telnyx/models/alphanumeric_sender_id_create_response.rb +77 -0
- data/lib/telnyx/models/alphanumeric_sender_id_delete_params.rb +14 -0
- data/lib/telnyx/models/alphanumeric_sender_id_delete_response.rb +77 -0
- data/lib/telnyx/models/alphanumeric_sender_id_list_params.rb +38 -0
- data/lib/telnyx/models/alphanumeric_sender_id_list_response.rb +66 -0
- data/lib/telnyx/models/alphanumeric_sender_id_retrieve_params.rb +14 -0
- data/lib/telnyx/models/alphanumeric_sender_id_retrieve_response.rb +77 -0
- data/lib/telnyx/models/message_retrieve_group_messages_params.rb +14 -0
- data/lib/telnyx/models/message_retrieve_group_messages_response.rb +16 -0
- data/lib/telnyx/models/message_send_with_alphanumeric_sender_params.rb +70 -0
- data/lib/telnyx/models/message_send_with_alphanumeric_sender_response.rb +16 -0
- data/lib/telnyx/models/messaging_10dlc/brand_update_params.rb +1 -1
- data/lib/telnyx/models/messaging_10dlc/partner_campaign_list_params.rb +1 -1
- data/lib/telnyx/models/messaging_hosted_number_list_params.rb +71 -0
- data/lib/telnyx/models/messaging_hosted_number_retrieve_params.rb +14 -0
- data/lib/telnyx/models/messaging_hosted_number_retrieve_response.rb +16 -0
- data/lib/telnyx/models/messaging_hosted_number_update_params.rb +49 -0
- data/lib/telnyx/models/messaging_hosted_number_update_response.rb +16 -0
- data/lib/telnyx/models/messaging_numbers_bulk_update_create_params.rb +9 -1
- data/lib/telnyx/models/messaging_profile.rb +25 -1
- data/lib/telnyx/models/messaging_profile_create_params.rb +25 -1
- data/lib/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_params.rb +26 -0
- data/lib/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_response.rb +67 -0
- data/lib/telnyx/models/messaging_profile_list_params.rb +17 -1
- data/lib/telnyx/models/messaging_profile_metric_list_params.rb +37 -0
- data/lib/telnyx/models/messaging_profile_metric_list_response.rb +23 -0
- data/lib/telnyx/models/messaging_profile_retrieve_metrics_params.rb +37 -0
- data/lib/telnyx/models/messaging_profile_retrieve_metrics_response.rb +17 -0
- data/lib/telnyx/models/messaging_profiles/action_regenerate_secret_params.rb +16 -0
- data/lib/telnyx/models/messaging_profiles/action_regenerate_secret_response.rb +18 -0
- data/lib/telnyx/models/messaging_tollfree/verification/request_list_params.rb +9 -1
- data/lib/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rb +38 -0
- data/lib/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_response.rb +63 -0
- data/lib/telnyx/models/messaging_tollfree/verification/tf_verification_request.rb +9 -9
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +8 -8
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +8 -8
- data/lib/telnyx/models/mobile_phone_numbers/messaging_list_response.rb +17 -1
- data/lib/telnyx/models/mobile_phone_numbers/messaging_retrieve_response.rb +17 -1
- data/lib/telnyx/models/phone_number_with_messaging_settings.rb +17 -1
- data/lib/telnyx/models/phone_numbers/messaging_list_params.rb +66 -1
- data/lib/telnyx/models/phone_numbers/messaging_update_params.rb +9 -1
- data/lib/telnyx/models/verify_profile.rb +79 -2
- data/lib/telnyx/models/verify_profile_create_params.rb +83 -8
- data/lib/telnyx/models/verify_profile_update_params.rb +77 -2
- data/lib/telnyx/models.rb +25 -0
- data/lib/telnyx/resources/alphanumeric_sender_ids.rb +111 -0
- data/lib/telnyx/resources/messages.rb +54 -0
- data/lib/telnyx/resources/messaging_hosted_numbers.rb +91 -0
- data/lib/telnyx/resources/messaging_numbers_bulk_updates.rb +3 -1
- data/lib/telnyx/resources/messaging_profile_metrics.rb +37 -0
- data/lib/telnyx/resources/messaging_profiles/actions.rb +36 -0
- data/lib/telnyx/resources/messaging_profiles.rb +74 -3
- data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +43 -7
- data/lib/telnyx/resources/phone_numbers/messaging.rb +25 -3
- data/lib/telnyx/resources/verify_profiles.rb +5 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +30 -0
- data/rbi/telnyx/client.rbi +6 -0
- data/rbi/telnyx/models/alphanumeric_sender_id_create_params.rbi +65 -0
- data/rbi/telnyx/models/alphanumeric_sender_id_create_response.rbi +178 -0
- data/rbi/telnyx/models/alphanumeric_sender_id_delete_params.rbi +30 -0
- data/rbi/telnyx/models/alphanumeric_sender_id_delete_response.rbi +178 -0
- data/rbi/telnyx/models/alphanumeric_sender_id_list_params.rbi +71 -0
- data/rbi/telnyx/models/alphanumeric_sender_id_list_response.rbi +138 -0
- data/rbi/telnyx/models/alphanumeric_sender_id_retrieve_params.rbi +30 -0
- data/rbi/telnyx/models/alphanumeric_sender_id_retrieve_response.rbi +180 -0
- data/rbi/telnyx/models/message_retrieve_group_messages_params.rbi +30 -0
- data/rbi/telnyx/models/message_retrieve_group_messages_response.rbi +37 -0
- data/rbi/telnyx/models/message_send_with_alphanumeric_sender_params.rbi +97 -0
- data/rbi/telnyx/models/message_send_with_alphanumeric_sender_response.rbi +33 -0
- data/rbi/telnyx/models/messaging_10dlc/partner_campaign_list_params.rbi +2 -2
- data/rbi/telnyx/models/messaging_hosted_number_list_params.rbi +148 -0
- data/rbi/telnyx/models/messaging_hosted_number_retrieve_params.rbi +30 -0
- data/rbi/telnyx/models/messaging_hosted_number_retrieve_response.rbi +37 -0
- data/rbi/telnyx/models/messaging_hosted_number_update_params.rbi +87 -0
- data/rbi/telnyx/models/messaging_hosted_number_update_response.rbi +37 -0
- data/rbi/telnyx/models/messaging_numbers_bulk_update_create_params.rbi +11 -0
- data/rbi/telnyx/models/messaging_profile.rbi +27 -0
- data/rbi/telnyx/models/messaging_profile_create_params.rbi +24 -0
- data/rbi/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_params.rbi +52 -0
- data/rbi/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_response.rbi +138 -0
- data/rbi/telnyx/models/messaging_profile_list_params.rbi +22 -0
- data/rbi/telnyx/models/messaging_profile_metric_list_params.rbi +114 -0
- data/rbi/telnyx/models/messaging_profile_metric_list_response.rbi +47 -0
- data/rbi/telnyx/models/messaging_profile_retrieve_metrics_params.rbi +117 -0
- data/rbi/telnyx/models/messaging_profile_retrieve_metrics_response.rbi +35 -0
- data/rbi/telnyx/models/messaging_profiles/action_regenerate_secret_params.rbi +32 -0
- data/rbi/telnyx/models/messaging_profiles/action_regenerate_secret_response.rbi +35 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/request_list_params.rbi +11 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rbi +58 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_response.rbi +123 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbi +8 -8
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +9 -6
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi +9 -6
- data/rbi/telnyx/models/mobile_phone_numbers/messaging_list_response.rbi +22 -0
- data/rbi/telnyx/models/mobile_phone_numbers/messaging_retrieve_response.rbi +22 -0
- data/rbi/telnyx/models/phone_number_with_messaging_settings.rbi +22 -0
- data/rbi/telnyx/models/phone_numbers/messaging_list_params.rbi +161 -1
- data/rbi/telnyx/models/phone_numbers/messaging_update_params.rbi +11 -0
- data/rbi/telnyx/models/verify_profile.rbi +131 -4
- data/rbi/telnyx/models/verify_profile_create_params.rbi +143 -13
- data/rbi/telnyx/models/verify_profile_update_params.rbi +127 -0
- data/rbi/telnyx/models.rbi +36 -0
- data/rbi/telnyx/resources/alphanumeric_sender_ids.rbi +84 -0
- data/rbi/telnyx/resources/messages.rbi +46 -0
- data/rbi/telnyx/resources/messaging_hosted_numbers.rbi +77 -0
- data/rbi/telnyx/resources/messaging_numbers_bulk_updates.rbi +3 -0
- data/rbi/telnyx/resources/messaging_profile_metrics.rbi +28 -0
- data/rbi/telnyx/resources/messaging_profiles/actions.rbi +30 -0
- data/rbi/telnyx/resources/messaging_profiles.rbi +59 -0
- data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +33 -6
- data/rbi/telnyx/resources/phone_numbers/messaging.rbi +25 -1
- data/rbi/telnyx/resources/verify_profiles.rbi +4 -0
- data/sig/telnyx/client.rbs +4 -0
- data/sig/telnyx/models/alphanumeric_sender_id_create_params.rbs +38 -0
- data/sig/telnyx/models/alphanumeric_sender_id_create_response.rbs +88 -0
- data/sig/telnyx/models/alphanumeric_sender_id_delete_params.rbs +15 -0
- data/sig/telnyx/models/alphanumeric_sender_id_delete_response.rbs +88 -0
- data/sig/telnyx/models/alphanumeric_sender_id_list_params.rbs +42 -0
- data/sig/telnyx/models/alphanumeric_sender_id_list_response.rbs +69 -0
- data/sig/telnyx/models/alphanumeric_sender_id_retrieve_params.rbs +15 -0
- data/sig/telnyx/models/alphanumeric_sender_id_retrieve_response.rbs +88 -0
- data/sig/telnyx/models/message_retrieve_group_messages_params.rbs +15 -0
- data/sig/telnyx/models/message_retrieve_group_messages_response.rbs +18 -0
- data/sig/telnyx/models/message_send_with_alphanumeric_sender_params.rbs +58 -0
- data/sig/telnyx/models/message_send_with_alphanumeric_sender_response.rbs +18 -0
- data/sig/telnyx/models/messaging_10dlc/partner_campaign_list_params.rbs +2 -2
- data/sig/telnyx/models/messaging_hosted_number_list_params.rbs +76 -0
- data/sig/telnyx/models/messaging_hosted_number_retrieve_params.rbs +15 -0
- data/sig/telnyx/models/messaging_hosted_number_retrieve_response.rbs +18 -0
- data/sig/telnyx/models/messaging_hosted_number_update_params.rbs +42 -0
- data/sig/telnyx/models/messaging_hosted_number_update_response.rbs +18 -0
- data/sig/telnyx/models/messaging_numbers_bulk_update_create_params.rbs +11 -1
- data/sig/telnyx/models/messaging_profile.rbs +17 -0
- data/sig/telnyx/models/messaging_profile_create_params.rbs +15 -0
- data/sig/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_params.rbs +32 -0
- data/sig/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_response.rbs +69 -0
- data/sig/telnyx/models/messaging_profile_list_params.rbs +14 -0
- data/sig/telnyx/models/messaging_profile_metric_list_params.rbs +45 -0
- data/sig/telnyx/models/messaging_profile_metric_list_response.rbs +31 -0
- data/sig/telnyx/models/messaging_profile_retrieve_metrics_params.rbs +45 -0
- data/sig/telnyx/models/messaging_profile_retrieve_metrics_response.rbs +16 -0
- data/sig/telnyx/models/messaging_profiles/action_regenerate_secret_params.rbs +17 -0
- data/sig/telnyx/models/messaging_profiles/action_regenerate_secret_response.rbs +18 -0
- data/sig/telnyx/models/messaging_tollfree/verification/request_list_params.rbs +7 -0
- data/sig/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rbs +32 -0
- data/sig/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_response.rbs +56 -0
- data/sig/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbs +5 -5
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs +7 -5
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_status.rbs +7 -5
- data/sig/telnyx/models/mobile_phone_numbers/messaging_list_response.rbs +14 -0
- data/sig/telnyx/models/mobile_phone_numbers/messaging_retrieve_response.rbs +14 -0
- data/sig/telnyx/models/phone_number_with_messaging_settings.rbs +14 -0
- data/sig/telnyx/models/phone_numbers/messaging_list_params.rbs +66 -1
- data/sig/telnyx/models/phone_numbers/messaging_update_params.rbs +11 -1
- data/sig/telnyx/models/verify_profile.rbs +75 -3
- data/sig/telnyx/models/verify_profile_create_params.rbs +80 -8
- data/sig/telnyx/models/verify_profile_update_params.rbs +70 -0
- data/sig/telnyx/models.rbs +24 -0
- data/sig/telnyx/resources/alphanumeric_sender_ids.rbs +31 -0
- data/sig/telnyx/resources/messages.rbs +16 -0
- data/sig/telnyx/resources/messaging_hosted_numbers.rbs +23 -0
- data/sig/telnyx/resources/messaging_numbers_bulk_updates.rbs +1 -0
- data/sig/telnyx/resources/messaging_profile_metrics.rbs +12 -0
- data/sig/telnyx/resources/messaging_profiles/actions.rbs +14 -0
- data/sig/telnyx/resources/messaging_profiles.rbs +20 -0
- data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +10 -2
- data/sig/telnyx/resources/phone_numbers/messaging.rbs +6 -0
- data/sig/telnyx/resources/verify_profiles.rbs +2 -0
- metadata +92 -2
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class MessagingProfiles
|
|
6
|
+
class Actions
|
|
7
|
+
# Regenerate the v1 secret for a messaging profile.
|
|
8
|
+
#
|
|
9
|
+
# @overload regenerate_secret(id, request_options: {})
|
|
10
|
+
#
|
|
11
|
+
# @param id [String] The identifier of the messaging profile.
|
|
12
|
+
#
|
|
13
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
14
|
+
#
|
|
15
|
+
# @return [Telnyx::Models::MessagingProfiles::ActionRegenerateSecretResponse]
|
|
16
|
+
#
|
|
17
|
+
# @see Telnyx::Models::MessagingProfiles::ActionRegenerateSecretParams
|
|
18
|
+
def regenerate_secret(id, params = {})
|
|
19
|
+
@client.request(
|
|
20
|
+
method: :post,
|
|
21
|
+
path: ["messaging_profiles/%1$s/actions/regenerate_secret", id],
|
|
22
|
+
model: Telnyx::Models::MessagingProfiles::ActionRegenerateSecretResponse,
|
|
23
|
+
options: params[:request_options]
|
|
24
|
+
)
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# @api private
|
|
28
|
+
#
|
|
29
|
+
# @param client [Telnyx::Client]
|
|
30
|
+
def initialize(client:)
|
|
31
|
+
@client = client
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
@@ -6,17 +6,22 @@ module Telnyx
|
|
|
6
6
|
# @return [Telnyx::Resources::MessagingProfiles::AutorespConfigs]
|
|
7
7
|
attr_reader :autoresp_configs
|
|
8
8
|
|
|
9
|
+
# @return [Telnyx::Resources::MessagingProfiles::Actions]
|
|
10
|
+
attr_reader :actions
|
|
11
|
+
|
|
9
12
|
# Some parameter documentations has been truncated, see
|
|
10
13
|
# {Telnyx::Models::MessagingProfileCreateParams} for more details.
|
|
11
14
|
#
|
|
12
15
|
# Create a messaging profile
|
|
13
16
|
#
|
|
14
|
-
# @overload create(name:, whitelisted_destinations:, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, smart_encoding: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
17
|
+
# @overload create(name:, whitelisted_destinations:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, resource_group_id: nil, smart_encoding: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
15
18
|
#
|
|
16
19
|
# @param name [String] A user friendly name for the messaging profile.
|
|
17
20
|
#
|
|
18
21
|
# @param whitelisted_destinations [Array<String>] Destinations to which the messaging profile is allowed to send. The elements in
|
|
19
22
|
#
|
|
23
|
+
# @param ai_assistant_id [String, nil] The AI assistant ID to associate with this messaging profile.
|
|
24
|
+
#
|
|
20
25
|
# @param alpha_sender [String, nil] The alphanumeric sender ID to use when sending to destinations that require an a
|
|
21
26
|
#
|
|
22
27
|
# @param daily_spend_limit [String] The maximum amount of money (in USD) that can be spent by this profile before mi
|
|
@@ -25,6 +30,8 @@ module Telnyx
|
|
|
25
30
|
#
|
|
26
31
|
# @param enabled [Boolean] Specifies whether the messaging profile is enabled or not.
|
|
27
32
|
#
|
|
33
|
+
# @param health_webhook_url [String, nil] A URL to receive health check webhooks for numbers in this profile.
|
|
34
|
+
#
|
|
28
35
|
# @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
|
|
29
36
|
#
|
|
30
37
|
# @param mms_transcoding [Boolean] enables automated resizing of MMS media.
|
|
@@ -33,6 +40,8 @@ module Telnyx
|
|
|
33
40
|
#
|
|
34
41
|
# @param number_pool_settings [Telnyx::Models::NumberPoolSettings, nil] Number Pool allows you to send messages from a pool of numbers of different type
|
|
35
42
|
#
|
|
43
|
+
# @param resource_group_id [String, nil] The resource group ID to associate with this messaging profile.
|
|
44
|
+
#
|
|
36
45
|
# @param smart_encoding [Boolean] Enables automatic character encoding optimization for SMS messages. When enabled
|
|
37
46
|
#
|
|
38
47
|
# @param url_shortener_settings [Telnyx::Models::URLShortenerSettings, nil] The URL shortener feature allows automatic replacement of URLs that were generat
|
|
@@ -138,10 +147,14 @@ module Telnyx
|
|
|
138
147
|
|
|
139
148
|
# List messaging profiles
|
|
140
149
|
#
|
|
141
|
-
# @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
|
|
150
|
+
# @overload list(filter: nil, filter_name_contains: nil, filter_name_eq: nil, page_number: nil, page_size: nil, request_options: {})
|
|
142
151
|
#
|
|
143
152
|
# @param filter [Telnyx::Models::MessagingProfileListParams::Filter] Consolidated filter parameter (deepObject style). Originally: filter[name]
|
|
144
153
|
#
|
|
154
|
+
# @param filter_name_contains [String] Filter profiles by name containing the given string.
|
|
155
|
+
#
|
|
156
|
+
# @param filter_name_eq [String] Filter profiles by exact name match.
|
|
157
|
+
#
|
|
145
158
|
# @param page_number [Integer]
|
|
146
159
|
#
|
|
147
160
|
# @param page_size [Integer]
|
|
@@ -156,7 +169,12 @@ module Telnyx
|
|
|
156
169
|
@client.request(
|
|
157
170
|
method: :get,
|
|
158
171
|
path: "messaging_profiles",
|
|
159
|
-
query: parsed.transform_keys(
|
|
172
|
+
query: parsed.transform_keys(
|
|
173
|
+
filter_name_contains: "filter[name][contains]",
|
|
174
|
+
filter_name_eq: "filter[name][eq]",
|
|
175
|
+
page_number: "page[number]",
|
|
176
|
+
page_size: "page[size]"
|
|
177
|
+
),
|
|
160
178
|
page: Telnyx::Internal::DefaultFlatPagination,
|
|
161
179
|
model: Telnyx::MessagingProfile,
|
|
162
180
|
options: options
|
|
@@ -183,6 +201,33 @@ module Telnyx
|
|
|
183
201
|
)
|
|
184
202
|
end
|
|
185
203
|
|
|
204
|
+
# List all alphanumeric sender IDs associated with a specific messaging profile.
|
|
205
|
+
#
|
|
206
|
+
# @overload list_alphanumeric_sender_ids(id, page_number: nil, page_size: nil, request_options: {})
|
|
207
|
+
#
|
|
208
|
+
# @param id [String] The identifier of the messaging profile.
|
|
209
|
+
#
|
|
210
|
+
# @param page_number [Integer]
|
|
211
|
+
#
|
|
212
|
+
# @param page_size [Integer]
|
|
213
|
+
#
|
|
214
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
215
|
+
#
|
|
216
|
+
# @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse>]
|
|
217
|
+
#
|
|
218
|
+
# @see Telnyx::Models::MessagingProfileListAlphanumericSenderIDsParams
|
|
219
|
+
def list_alphanumeric_sender_ids(id, params = {})
|
|
220
|
+
parsed, options = Telnyx::MessagingProfileListAlphanumericSenderIDsParams.dump_request(params)
|
|
221
|
+
@client.request(
|
|
222
|
+
method: :get,
|
|
223
|
+
path: ["messaging_profiles/%1$s/alphanumeric_sender_ids", id],
|
|
224
|
+
query: parsed.transform_keys(page_number: "page[number]", page_size: "page[size]"),
|
|
225
|
+
page: Telnyx::Internal::DefaultFlatPagination,
|
|
226
|
+
model: Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse,
|
|
227
|
+
options: options
|
|
228
|
+
)
|
|
229
|
+
end
|
|
230
|
+
|
|
186
231
|
# List phone numbers associated with a messaging profile
|
|
187
232
|
#
|
|
188
233
|
# @overload list_phone_numbers(messaging_profile_id, page_number: nil, page_size: nil, request_options: {})
|
|
@@ -237,12 +282,38 @@ module Telnyx
|
|
|
237
282
|
)
|
|
238
283
|
end
|
|
239
284
|
|
|
285
|
+
# Get detailed metrics for a specific messaging profile, broken down by time
|
|
286
|
+
# interval.
|
|
287
|
+
#
|
|
288
|
+
# @overload retrieve_metrics(id, time_frame: nil, request_options: {})
|
|
289
|
+
#
|
|
290
|
+
# @param id [String] The identifier of the messaging profile.
|
|
291
|
+
#
|
|
292
|
+
# @param time_frame [Symbol, Telnyx::Models::MessagingProfileRetrieveMetricsParams::TimeFrame] The time frame for metrics.
|
|
293
|
+
#
|
|
294
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
295
|
+
#
|
|
296
|
+
# @return [Telnyx::Models::MessagingProfileRetrieveMetricsResponse]
|
|
297
|
+
#
|
|
298
|
+
# @see Telnyx::Models::MessagingProfileRetrieveMetricsParams
|
|
299
|
+
def retrieve_metrics(id, params = {})
|
|
300
|
+
parsed, options = Telnyx::MessagingProfileRetrieveMetricsParams.dump_request(params)
|
|
301
|
+
@client.request(
|
|
302
|
+
method: :get,
|
|
303
|
+
path: ["messaging_profiles/%1$s/metrics", id],
|
|
304
|
+
query: parsed,
|
|
305
|
+
model: Telnyx::Models::MessagingProfileRetrieveMetricsResponse,
|
|
306
|
+
options: options
|
|
307
|
+
)
|
|
308
|
+
end
|
|
309
|
+
|
|
240
310
|
# @api private
|
|
241
311
|
#
|
|
242
312
|
# @param client [Telnyx::Client]
|
|
243
313
|
def initialize(client:)
|
|
244
314
|
@client = client
|
|
245
315
|
@autoresp_configs = Telnyx::Resources::MessagingProfiles::AutorespConfigs.new(client: client)
|
|
316
|
+
@actions = Telnyx::Resources::MessagingProfiles::Actions.new(client: client)
|
|
246
317
|
end
|
|
247
318
|
end
|
|
248
319
|
end
|
|
@@ -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:,
|
|
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:, 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, campaign_verify_authorization_token: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, isv_reseller: 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
|
#
|
|
@@ -35,8 +35,6 @@ module Telnyx
|
|
|
35
35
|
#
|
|
36
36
|
# @param corporate_website [String] A URL, including the scheme, pointing to the corporate website
|
|
37
37
|
#
|
|
38
|
-
# @param isv_reseller [String] ISV name
|
|
39
|
-
#
|
|
40
38
|
# @param message_volume [Symbol, Telnyx::Models::MessagingTollfree::Verification::Volume] Message Volume Enums
|
|
41
39
|
#
|
|
42
40
|
# @param opt_in_workflow [String] Human-readable description of how end users will opt into receiving messages fro
|
|
@@ -69,6 +67,8 @@ module Telnyx
|
|
|
69
67
|
#
|
|
70
68
|
# @param help_message_response [String, nil] The message returned when users text 'HELP'
|
|
71
69
|
#
|
|
70
|
+
# @param isv_reseller [String, nil] ISV name
|
|
71
|
+
#
|
|
72
72
|
# @param opt_in_confirmation_response [String, nil] Message sent to users confirming their opt-in to receive messages
|
|
73
73
|
#
|
|
74
74
|
# @param opt_in_keywords [String, nil] Keywords used to collect and process consumer opt-ins
|
|
@@ -121,7 +121,7 @@ module Telnyx
|
|
|
121
121
|
# Update an existing tollfree verification request. This is particularly useful
|
|
122
122
|
# when there are pending customer actions to be taken.
|
|
123
123
|
#
|
|
124
|
-
# @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:,
|
|
124
|
+
# @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:, 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, campaign_verify_authorization_token: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, isv_reseller: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, webhook_url: nil, request_options: {})
|
|
125
125
|
#
|
|
126
126
|
# @param id [String]
|
|
127
127
|
#
|
|
@@ -147,8 +147,6 @@ module Telnyx
|
|
|
147
147
|
#
|
|
148
148
|
# @param corporate_website [String] A URL, including the scheme, pointing to the corporate website
|
|
149
149
|
#
|
|
150
|
-
# @param isv_reseller [String] ISV name
|
|
151
|
-
#
|
|
152
150
|
# @param message_volume [Symbol, Telnyx::Models::MessagingTollfree::Verification::Volume] Message Volume Enums
|
|
153
151
|
#
|
|
154
152
|
# @param opt_in_workflow [String] Human-readable description of how end users will opt into receiving messages fro
|
|
@@ -181,6 +179,8 @@ module Telnyx
|
|
|
181
179
|
#
|
|
182
180
|
# @param help_message_response [String, nil] The message returned when users text 'HELP'
|
|
183
181
|
#
|
|
182
|
+
# @param isv_reseller [String, nil] ISV name
|
|
183
|
+
#
|
|
184
184
|
# @param opt_in_confirmation_response [String, nil] Message sent to users confirming their opt-in to receive messages
|
|
185
185
|
#
|
|
186
186
|
# @param opt_in_keywords [String, nil] Keywords used to collect and process consumer opt-ins
|
|
@@ -213,12 +213,14 @@ module Telnyx
|
|
|
213
213
|
#
|
|
214
214
|
# Get a list of previously-submitted tollfree verification requests
|
|
215
215
|
#
|
|
216
|
-
# @overload list(page:, page_size:, date_end: nil, date_start: nil, phone_number: nil, status: nil, request_options: {})
|
|
216
|
+
# @overload list(page:, page_size:, business_name: nil, date_end: nil, date_start: nil, phone_number: nil, status: nil, request_options: {})
|
|
217
217
|
#
|
|
218
218
|
# @param page [Integer]
|
|
219
219
|
#
|
|
220
220
|
# @param page_size [Integer]
|
|
221
221
|
#
|
|
222
|
+
# @param business_name [String] Filter verification requests by business name
|
|
223
|
+
#
|
|
222
224
|
# @param date_end [Time]
|
|
223
225
|
#
|
|
224
226
|
# @param date_start [Time]
|
|
@@ -269,6 +271,40 @@ module Telnyx
|
|
|
269
271
|
)
|
|
270
272
|
end
|
|
271
273
|
|
|
274
|
+
# Some parameter documentations has been truncated, see
|
|
275
|
+
# {Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryParams}
|
|
276
|
+
# for more details.
|
|
277
|
+
#
|
|
278
|
+
# Get the history of status changes for a verification request.
|
|
279
|
+
#
|
|
280
|
+
# Returns a paginated list of historical status changes including the reason for
|
|
281
|
+
# each change and when it occurred.
|
|
282
|
+
#
|
|
283
|
+
# @overload retrieve_status_history(id, page_number:, page_size:, request_options: {})
|
|
284
|
+
#
|
|
285
|
+
# @param id [String]
|
|
286
|
+
#
|
|
287
|
+
# @param page_number [Integer]
|
|
288
|
+
#
|
|
289
|
+
# @param page_size [Integer] Request this many records per page. This value is automatically clamped if the p
|
|
290
|
+
#
|
|
291
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
292
|
+
#
|
|
293
|
+
# @return [Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse]
|
|
294
|
+
#
|
|
295
|
+
# @see Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryParams
|
|
296
|
+
def retrieve_status_history(id, params)
|
|
297
|
+
parsed, options =
|
|
298
|
+
Telnyx::MessagingTollfree::Verification::RequestRetrieveStatusHistoryParams.dump_request(params)
|
|
299
|
+
@client.request(
|
|
300
|
+
method: :get,
|
|
301
|
+
path: ["messaging_tollfree/verification/requests/%1$s/status_history", id],
|
|
302
|
+
query: parsed.transform_keys(page_number: "page[number]", page_size: "page[size]"),
|
|
303
|
+
model: Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse,
|
|
304
|
+
options: options
|
|
305
|
+
)
|
|
306
|
+
end
|
|
307
|
+
|
|
272
308
|
# @api private
|
|
273
309
|
#
|
|
274
310
|
# @param client [Telnyx::Client]
|
|
@@ -29,7 +29,7 @@ module Telnyx
|
|
|
29
29
|
#
|
|
30
30
|
# Update the messaging profile and/or messaging product of a phone number
|
|
31
31
|
#
|
|
32
|
-
# @overload update(id, messaging_product: nil, messaging_profile_id: nil, request_options: {})
|
|
32
|
+
# @overload update(id, messaging_product: nil, messaging_profile_id: nil, tags: nil, request_options: {})
|
|
33
33
|
#
|
|
34
34
|
# @param id [String] The phone number to update.
|
|
35
35
|
#
|
|
@@ -37,6 +37,8 @@ module Telnyx
|
|
|
37
37
|
#
|
|
38
38
|
# @param messaging_profile_id [String] Configure the messaging profile this phone number is assigned to:
|
|
39
39
|
#
|
|
40
|
+
# @param tags [Array<String>] Tags to set on this phone number.
|
|
41
|
+
#
|
|
40
42
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
41
43
|
#
|
|
42
44
|
# @return [Telnyx::Models::PhoneNumbers::MessagingUpdateResponse]
|
|
@@ -55,10 +57,22 @@ module Telnyx
|
|
|
55
57
|
|
|
56
58
|
# List phone numbers with messaging settings
|
|
57
59
|
#
|
|
58
|
-
# @overload list(page_number: nil, page_size: nil, request_options: {})
|
|
60
|
+
# @overload list(filter_messaging_profile_id: nil, filter_phone_number: nil, filter_phone_number_contains: nil, filter_type: nil, page_number: nil, page_size: nil, sort_phone_number: nil, request_options: {})
|
|
61
|
+
#
|
|
62
|
+
# @param filter_messaging_profile_id [String] Filter by messaging profile ID.
|
|
63
|
+
#
|
|
64
|
+
# @param filter_phone_number [String] Filter by exact phone number (supports comma-separated list).
|
|
65
|
+
#
|
|
66
|
+
# @param filter_phone_number_contains [String] Filter by phone number substring.
|
|
67
|
+
#
|
|
68
|
+
# @param filter_type [Symbol, Telnyx::Models::PhoneNumbers::MessagingListParams::FilterType] Filter by phone number type.
|
|
59
69
|
#
|
|
60
70
|
# @param page_number [Integer]
|
|
71
|
+
#
|
|
61
72
|
# @param page_size [Integer]
|
|
73
|
+
#
|
|
74
|
+
# @param sort_phone_number [Symbol, Telnyx::Models::PhoneNumbers::MessagingListParams::SortPhoneNumber] Sort by phone number.
|
|
75
|
+
#
|
|
62
76
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
63
77
|
#
|
|
64
78
|
# @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::PhoneNumberWithMessagingSettings>]
|
|
@@ -69,7 +83,15 @@ module Telnyx
|
|
|
69
83
|
@client.request(
|
|
70
84
|
method: :get,
|
|
71
85
|
path: "phone_numbers/messaging",
|
|
72
|
-
query: parsed.transform_keys(
|
|
86
|
+
query: parsed.transform_keys(
|
|
87
|
+
filter_messaging_profile_id: "filter[messaging_profile_id]",
|
|
88
|
+
filter_phone_number: "filter[phone_number]",
|
|
89
|
+
filter_phone_number_contains: "filter[phone_number][contains]",
|
|
90
|
+
filter_type: "filter[type]",
|
|
91
|
+
page_number: "page[number]",
|
|
92
|
+
page_size: "page[size]",
|
|
93
|
+
sort_phone_number: "sort[phone_number]"
|
|
94
|
+
),
|
|
73
95
|
page: Telnyx::Internal::DefaultFlatPagination,
|
|
74
96
|
model: Telnyx::PhoneNumberWithMessagingSettings,
|
|
75
97
|
options: options
|
|
@@ -5,12 +5,13 @@ module Telnyx
|
|
|
5
5
|
class VerifyProfiles
|
|
6
6
|
# Creates a new Verify profile to associate verifications with.
|
|
7
7
|
#
|
|
8
|
-
# @overload create(name:, call: nil, flashcall: nil, language: nil, sms: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
8
|
+
# @overload create(name:, call: nil, flashcall: nil, language: nil, rcs: nil, sms: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
9
9
|
#
|
|
10
10
|
# @param name [String]
|
|
11
11
|
# @param call [Telnyx::Models::VerifyProfileCreateParams::Call]
|
|
12
12
|
# @param flashcall [Telnyx::Models::VerifyProfileCreateParams::Flashcall]
|
|
13
13
|
# @param language [String]
|
|
14
|
+
# @param rcs [Telnyx::Models::VerifyProfileCreateParams::Rcs]
|
|
14
15
|
# @param sms [Telnyx::Models::VerifyProfileCreateParams::SMS]
|
|
15
16
|
# @param webhook_failover_url [String]
|
|
16
17
|
# @param webhook_url [String]
|
|
@@ -52,7 +53,7 @@ module Telnyx
|
|
|
52
53
|
|
|
53
54
|
# Update Verify profile
|
|
54
55
|
#
|
|
55
|
-
# @overload update(verify_profile_id, call: nil, flashcall: nil, language: nil, name: nil, sms: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
56
|
+
# @overload update(verify_profile_id, call: nil, flashcall: nil, language: nil, name: nil, rcs: nil, sms: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
56
57
|
#
|
|
57
58
|
# @param verify_profile_id [String] The identifier of the Verify profile to update.
|
|
58
59
|
#
|
|
@@ -64,6 +65,8 @@ module Telnyx
|
|
|
64
65
|
#
|
|
65
66
|
# @param name [String]
|
|
66
67
|
#
|
|
68
|
+
# @param rcs [Telnyx::Models::VerifyProfileUpdateParams::Rcs]
|
|
69
|
+
#
|
|
67
70
|
# @param sms [Telnyx::Models::VerifyProfileUpdateParams::SMS]
|
|
68
71
|
#
|
|
69
72
|
# @param webhook_failover_url [String]
|
data/lib/telnyx/version.rb
CHANGED
data/lib/telnyx.rb
CHANGED
|
@@ -369,6 +369,14 @@ require_relative "telnyx/models/ai_retrieve_models_params"
|
|
|
369
369
|
require_relative "telnyx/models/ai_retrieve_models_response"
|
|
370
370
|
require_relative "telnyx/models/ai_summarize_params"
|
|
371
371
|
require_relative "telnyx/models/ai_summarize_response"
|
|
372
|
+
require_relative "telnyx/models/alphanumeric_sender_id_create_params"
|
|
373
|
+
require_relative "telnyx/models/alphanumeric_sender_id_create_response"
|
|
374
|
+
require_relative "telnyx/models/alphanumeric_sender_id_delete_params"
|
|
375
|
+
require_relative "telnyx/models/alphanumeric_sender_id_delete_response"
|
|
376
|
+
require_relative "telnyx/models/alphanumeric_sender_id_list_params"
|
|
377
|
+
require_relative "telnyx/models/alphanumeric_sender_id_list_response"
|
|
378
|
+
require_relative "telnyx/models/alphanumeric_sender_id_retrieve_params"
|
|
379
|
+
require_relative "telnyx/models/alphanumeric_sender_id_retrieve_response"
|
|
372
380
|
require_relative "telnyx/models/anchorsite_override"
|
|
373
381
|
require_relative "telnyx/models/api_error"
|
|
374
382
|
require_relative "telnyx/models/audit_event_list_params"
|
|
@@ -1065,6 +1073,8 @@ require_relative "telnyx/models/media_upload_params"
|
|
|
1065
1073
|
require_relative "telnyx/models/media_upload_response"
|
|
1066
1074
|
require_relative "telnyx/models/message_cancel_scheduled_params"
|
|
1067
1075
|
require_relative "telnyx/models/message_cancel_scheduled_response"
|
|
1076
|
+
require_relative "telnyx/models/message_retrieve_group_messages_params"
|
|
1077
|
+
require_relative "telnyx/models/message_retrieve_group_messages_response"
|
|
1068
1078
|
require_relative "telnyx/models/message_retrieve_params"
|
|
1069
1079
|
require_relative "telnyx/models/message_retrieve_response"
|
|
1070
1080
|
require_relative "telnyx/models/messages/rc_generate_deeplink_params"
|
|
@@ -1085,6 +1095,8 @@ require_relative "telnyx/models/message_send_short_code_params"
|
|
|
1085
1095
|
require_relative "telnyx/models/message_send_short_code_response"
|
|
1086
1096
|
require_relative "telnyx/models/message_send_whatsapp_params"
|
|
1087
1097
|
require_relative "telnyx/models/message_send_whatsapp_response"
|
|
1098
|
+
require_relative "telnyx/models/message_send_with_alphanumeric_sender_params"
|
|
1099
|
+
require_relative "telnyx/models/message_send_with_alphanumeric_sender_response"
|
|
1088
1100
|
require_relative "telnyx/models/message_template"
|
|
1089
1101
|
require_relative "telnyx/models/messaging/rc_invite_test_number_params"
|
|
1090
1102
|
require_relative "telnyx/models/messaging/rc_invite_test_number_response"
|
|
@@ -1179,6 +1191,7 @@ require_relative "telnyx/models/messaging_error"
|
|
|
1179
1191
|
require_relative "telnyx/models/messaging_feature_set"
|
|
1180
1192
|
require_relative "telnyx/models/messaging_hosted_number_delete_params"
|
|
1181
1193
|
require_relative "telnyx/models/messaging_hosted_number_delete_response"
|
|
1194
|
+
require_relative "telnyx/models/messaging_hosted_number_list_params"
|
|
1182
1195
|
require_relative "telnyx/models/messaging_hosted_number_order"
|
|
1183
1196
|
require_relative "telnyx/models/messaging_hosted_number_order_check_eligibility_params"
|
|
1184
1197
|
require_relative "telnyx/models/messaging_hosted_number_order_check_eligibility_response"
|
|
@@ -1195,6 +1208,10 @@ require_relative "telnyx/models/messaging_hosted_number_orders/action_upload_fil
|
|
|
1195
1208
|
require_relative "telnyx/models/messaging_hosted_number_orders/action_upload_file_response"
|
|
1196
1209
|
require_relative "telnyx/models/messaging_hosted_number_order_validate_codes_params"
|
|
1197
1210
|
require_relative "telnyx/models/messaging_hosted_number_order_validate_codes_response"
|
|
1211
|
+
require_relative "telnyx/models/messaging_hosted_number_retrieve_params"
|
|
1212
|
+
require_relative "telnyx/models/messaging_hosted_number_retrieve_response"
|
|
1213
|
+
require_relative "telnyx/models/messaging_hosted_number_update_params"
|
|
1214
|
+
require_relative "telnyx/models/messaging_hosted_number_update_response"
|
|
1198
1215
|
require_relative "telnyx/models/messaging_numbers_bulk_update_create_params"
|
|
1199
1216
|
require_relative "telnyx/models/messaging_numbers_bulk_update_create_response"
|
|
1200
1217
|
require_relative "telnyx/models/messaging_numbers_bulk_update_retrieve_params"
|
|
@@ -1207,11 +1224,19 @@ require_relative "telnyx/models/messaging_profile_create_params"
|
|
|
1207
1224
|
require_relative "telnyx/models/messaging_profile_create_response"
|
|
1208
1225
|
require_relative "telnyx/models/messaging_profile_delete_params"
|
|
1209
1226
|
require_relative "telnyx/models/messaging_profile_delete_response"
|
|
1227
|
+
require_relative "telnyx/models/messaging_profile_list_alphanumeric_sender_ids_params"
|
|
1228
|
+
require_relative "telnyx/models/messaging_profile_list_alphanumeric_sender_ids_response"
|
|
1210
1229
|
require_relative "telnyx/models/messaging_profile_list_params"
|
|
1211
1230
|
require_relative "telnyx/models/messaging_profile_list_phone_numbers_params"
|
|
1212
1231
|
require_relative "telnyx/models/messaging_profile_list_short_codes_params"
|
|
1232
|
+
require_relative "telnyx/models/messaging_profile_metric_list_params"
|
|
1233
|
+
require_relative "telnyx/models/messaging_profile_metric_list_response"
|
|
1234
|
+
require_relative "telnyx/models/messaging_profile_retrieve_metrics_params"
|
|
1235
|
+
require_relative "telnyx/models/messaging_profile_retrieve_metrics_response"
|
|
1213
1236
|
require_relative "telnyx/models/messaging_profile_retrieve_params"
|
|
1214
1237
|
require_relative "telnyx/models/messaging_profile_retrieve_response"
|
|
1238
|
+
require_relative "telnyx/models/messaging_profiles/action_regenerate_secret_params"
|
|
1239
|
+
require_relative "telnyx/models/messaging_profiles/action_regenerate_secret_response"
|
|
1215
1240
|
require_relative "telnyx/models/messaging_profiles/auto_resp_config"
|
|
1216
1241
|
require_relative "telnyx/models/messaging_profiles/autoresp_config_create_params"
|
|
1217
1242
|
require_relative "telnyx/models/messaging_profiles/autoresp_config_delete_params"
|
|
@@ -1227,6 +1252,8 @@ require_relative "telnyx/models/messaging_tollfree/verification/request_create_p
|
|
|
1227
1252
|
require_relative "telnyx/models/messaging_tollfree/verification/request_delete_params"
|
|
1228
1253
|
require_relative "telnyx/models/messaging_tollfree/verification/request_list_params"
|
|
1229
1254
|
require_relative "telnyx/models/messaging_tollfree/verification/request_retrieve_params"
|
|
1255
|
+
require_relative "telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params"
|
|
1256
|
+
require_relative "telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_response"
|
|
1230
1257
|
require_relative "telnyx/models/messaging_tollfree/verification/request_update_params"
|
|
1231
1258
|
require_relative "telnyx/models/messaging_tollfree/verification/tf_phone_number"
|
|
1232
1259
|
require_relative "telnyx/models/messaging_tollfree/verification/tf_verification_status"
|
|
@@ -2165,6 +2192,7 @@ require_relative "telnyx/resources/ai/missions/runs/telnyx_agents"
|
|
|
2165
2192
|
require_relative "telnyx/resources/ai/missions/tools"
|
|
2166
2193
|
require_relative "telnyx/resources/ai/openai"
|
|
2167
2194
|
require_relative "telnyx/resources/ai/openai/embeddings"
|
|
2195
|
+
require_relative "telnyx/resources/alphanumeric_sender_ids"
|
|
2168
2196
|
require_relative "telnyx/resources/audit_events"
|
|
2169
2197
|
require_relative "telnyx/resources/authentication_providers"
|
|
2170
2198
|
require_relative "telnyx/resources/available_phone_number_blocks"
|
|
@@ -2261,7 +2289,9 @@ require_relative "telnyx/resources/messaging_hosted_number_orders/actions"
|
|
|
2261
2289
|
require_relative "telnyx/resources/messaging_hosted_numbers"
|
|
2262
2290
|
require_relative "telnyx/resources/messaging_numbers_bulk_updates"
|
|
2263
2291
|
require_relative "telnyx/resources/messaging_optouts"
|
|
2292
|
+
require_relative "telnyx/resources/messaging_profile_metrics"
|
|
2264
2293
|
require_relative "telnyx/resources/messaging_profiles"
|
|
2294
|
+
require_relative "telnyx/resources/messaging_profiles/actions"
|
|
2265
2295
|
require_relative "telnyx/resources/messaging_profiles/autoresp_configs"
|
|
2266
2296
|
require_relative "telnyx/resources/messaging_tollfree"
|
|
2267
2297
|
require_relative "telnyx/resources/messaging_tollfree/verification"
|
data/rbi/telnyx/client.rbi
CHANGED
|
@@ -475,6 +475,12 @@ module Telnyx
|
|
|
475
475
|
sig { returns(Telnyx::Resources::Organizations) }
|
|
476
476
|
attr_reader :organizations
|
|
477
477
|
|
|
478
|
+
sig { returns(Telnyx::Resources::AlphanumericSenderIDs) }
|
|
479
|
+
attr_reader :alphanumeric_sender_ids
|
|
480
|
+
|
|
481
|
+
sig { returns(Telnyx::Resources::MessagingProfileMetrics) }
|
|
482
|
+
attr_reader :messaging_profile_metrics
|
|
483
|
+
|
|
478
484
|
# @api private
|
|
479
485
|
sig { override.returns(T::Hash[String, String]) }
|
|
480
486
|
private def auth_headers
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class AlphanumericSenderIDCreateParams < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
7
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
8
|
+
|
|
9
|
+
OrHash =
|
|
10
|
+
T.type_alias do
|
|
11
|
+
T.any(
|
|
12
|
+
Telnyx::AlphanumericSenderIDCreateParams,
|
|
13
|
+
Telnyx::Internal::AnyHash
|
|
14
|
+
)
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# The alphanumeric sender ID string.
|
|
18
|
+
sig { returns(String) }
|
|
19
|
+
attr_accessor :alphanumeric_sender_id
|
|
20
|
+
|
|
21
|
+
# The messaging profile to associate the sender ID with.
|
|
22
|
+
sig { returns(String) }
|
|
23
|
+
attr_accessor :messaging_profile_id
|
|
24
|
+
|
|
25
|
+
# A US long code number to use as fallback when sending to US destinations.
|
|
26
|
+
sig { returns(T.nilable(String)) }
|
|
27
|
+
attr_reader :us_long_code_fallback
|
|
28
|
+
|
|
29
|
+
sig { params(us_long_code_fallback: String).void }
|
|
30
|
+
attr_writer :us_long_code_fallback
|
|
31
|
+
|
|
32
|
+
sig do
|
|
33
|
+
params(
|
|
34
|
+
alphanumeric_sender_id: String,
|
|
35
|
+
messaging_profile_id: String,
|
|
36
|
+
us_long_code_fallback: String,
|
|
37
|
+
request_options: Telnyx::RequestOptions::OrHash
|
|
38
|
+
).returns(T.attached_class)
|
|
39
|
+
end
|
|
40
|
+
def self.new(
|
|
41
|
+
# The alphanumeric sender ID string.
|
|
42
|
+
alphanumeric_sender_id:,
|
|
43
|
+
# The messaging profile to associate the sender ID with.
|
|
44
|
+
messaging_profile_id:,
|
|
45
|
+
# A US long code number to use as fallback when sending to US destinations.
|
|
46
|
+
us_long_code_fallback: nil,
|
|
47
|
+
request_options: {}
|
|
48
|
+
)
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
sig do
|
|
52
|
+
override.returns(
|
|
53
|
+
{
|
|
54
|
+
alphanumeric_sender_id: String,
|
|
55
|
+
messaging_profile_id: String,
|
|
56
|
+
us_long_code_fallback: String,
|
|
57
|
+
request_options: Telnyx::RequestOptions
|
|
58
|
+
}
|
|
59
|
+
)
|
|
60
|
+
end
|
|
61
|
+
def to_hash
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|