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,71 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::MessagingHostedNumbers#list
|
|
6
|
+
class MessagingHostedNumberListParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute filter_messaging_profile_id
|
|
11
|
+
# Filter by messaging profile ID.
|
|
12
|
+
#
|
|
13
|
+
# @return [String, nil]
|
|
14
|
+
optional :filter_messaging_profile_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute filter_phone_number
|
|
17
|
+
# Filter by exact phone number.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :filter_phone_number, String
|
|
21
|
+
|
|
22
|
+
# @!attribute filter_phone_number_contains
|
|
23
|
+
# Filter by phone number substring.
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :filter_phone_number_contains, String
|
|
27
|
+
|
|
28
|
+
# @!attribute page_number
|
|
29
|
+
#
|
|
30
|
+
# @return [Integer, nil]
|
|
31
|
+
optional :page_number, Integer
|
|
32
|
+
|
|
33
|
+
# @!attribute page_size
|
|
34
|
+
#
|
|
35
|
+
# @return [Integer, nil]
|
|
36
|
+
optional :page_size, Integer
|
|
37
|
+
|
|
38
|
+
# @!attribute sort_phone_number
|
|
39
|
+
# Sort by phone number.
|
|
40
|
+
#
|
|
41
|
+
# @return [Symbol, Telnyx::Models::MessagingHostedNumberListParams::SortPhoneNumber, nil]
|
|
42
|
+
optional :sort_phone_number, enum: -> { Telnyx::MessagingHostedNumberListParams::SortPhoneNumber }
|
|
43
|
+
|
|
44
|
+
# @!method initialize(filter_messaging_profile_id: nil, filter_phone_number: nil, filter_phone_number_contains: nil, page_number: nil, page_size: nil, sort_phone_number: nil, request_options: {})
|
|
45
|
+
# @param filter_messaging_profile_id [String] Filter by messaging profile ID.
|
|
46
|
+
#
|
|
47
|
+
# @param filter_phone_number [String] Filter by exact phone number.
|
|
48
|
+
#
|
|
49
|
+
# @param filter_phone_number_contains [String] Filter by phone number substring.
|
|
50
|
+
#
|
|
51
|
+
# @param page_number [Integer]
|
|
52
|
+
#
|
|
53
|
+
# @param page_size [Integer]
|
|
54
|
+
#
|
|
55
|
+
# @param sort_phone_number [Symbol, Telnyx::Models::MessagingHostedNumberListParams::SortPhoneNumber] Sort by phone number.
|
|
56
|
+
#
|
|
57
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
58
|
+
|
|
59
|
+
# Sort by phone number.
|
|
60
|
+
module SortPhoneNumber
|
|
61
|
+
extend Telnyx::Internal::Type::Enum
|
|
62
|
+
|
|
63
|
+
ASC = :asc
|
|
64
|
+
DESC = :desc
|
|
65
|
+
|
|
66
|
+
# @!method self.values
|
|
67
|
+
# @return [Array<Symbol>]
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
end
|
|
71
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::MessagingHostedNumbers#retrieve
|
|
6
|
+
class MessagingHostedNumberRetrieveParams < 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
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::MessagingHostedNumbers#retrieve
|
|
6
|
+
class MessagingHostedNumberRetrieveResponse < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [Telnyx::Models::PhoneNumberWithMessagingSettings, nil]
|
|
10
|
+
optional :data, -> { Telnyx::PhoneNumberWithMessagingSettings }
|
|
11
|
+
|
|
12
|
+
# @!method initialize(data: nil)
|
|
13
|
+
# @param data [Telnyx::Models::PhoneNumberWithMessagingSettings]
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::MessagingHostedNumbers#update
|
|
6
|
+
class MessagingHostedNumberUpdateParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute messaging_product
|
|
11
|
+
# Configure the messaging product for this number:
|
|
12
|
+
#
|
|
13
|
+
# - Omit this field or set its value to `null` to keep the current value.
|
|
14
|
+
# - Set this field to a quoted product ID to set this phone number to that product
|
|
15
|
+
#
|
|
16
|
+
# @return [String, nil]
|
|
17
|
+
optional :messaging_product, String
|
|
18
|
+
|
|
19
|
+
# @!attribute messaging_profile_id
|
|
20
|
+
# Configure the messaging profile this phone number is assigned to:
|
|
21
|
+
#
|
|
22
|
+
# - Omit this field or set its value to `null` to keep the current value.
|
|
23
|
+
# - Set this field to `""` to unassign the number from its messaging profile
|
|
24
|
+
# - Set this field to a quoted UUID of a messaging profile to assign this number
|
|
25
|
+
# to that messaging profile
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :messaging_profile_id, String
|
|
29
|
+
|
|
30
|
+
# @!attribute tags
|
|
31
|
+
# Tags to set on this phone number.
|
|
32
|
+
#
|
|
33
|
+
# @return [Array<String>, nil]
|
|
34
|
+
optional :tags, Telnyx::Internal::Type::ArrayOf[String]
|
|
35
|
+
|
|
36
|
+
# @!method initialize(messaging_product: nil, messaging_profile_id: nil, tags: nil, request_options: {})
|
|
37
|
+
# Some parameter documentations has been truncated, see
|
|
38
|
+
# {Telnyx::Models::MessagingHostedNumberUpdateParams} for more details.
|
|
39
|
+
#
|
|
40
|
+
# @param messaging_product [String] Configure the messaging product for this number:
|
|
41
|
+
#
|
|
42
|
+
# @param messaging_profile_id [String] Configure the messaging profile this phone number is assigned to:
|
|
43
|
+
#
|
|
44
|
+
# @param tags [Array<String>] Tags to set on this phone number.
|
|
45
|
+
#
|
|
46
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::MessagingHostedNumbers#update
|
|
6
|
+
class MessagingHostedNumberUpdateResponse < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [Telnyx::Models::PhoneNumberWithMessagingSettings, nil]
|
|
10
|
+
optional :data, -> { Telnyx::PhoneNumberWithMessagingSettings }
|
|
11
|
+
|
|
12
|
+
# @!method initialize(data: nil)
|
|
13
|
+
# @param data [Telnyx::Models::PhoneNumberWithMessagingSettings]
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -24,7 +24,13 @@ module Telnyx
|
|
|
24
24
|
# @return [Array<String>]
|
|
25
25
|
required :numbers, Telnyx::Internal::Type::ArrayOf[String]
|
|
26
26
|
|
|
27
|
-
# @!
|
|
27
|
+
# @!attribute assign_only
|
|
28
|
+
# If true, only assign numbers to the profile without changing other settings.
|
|
29
|
+
#
|
|
30
|
+
# @return [Boolean, nil]
|
|
31
|
+
optional :assign_only, Telnyx::Internal::Type::Boolean
|
|
32
|
+
|
|
33
|
+
# @!method initialize(messaging_profile_id:, numbers:, assign_only: nil, request_options: {})
|
|
28
34
|
# Some parameter documentations has been truncated, see
|
|
29
35
|
# {Telnyx::Models::MessagingNumbersBulkUpdateCreateParams} for more details.
|
|
30
36
|
#
|
|
@@ -32,6 +38,8 @@ module Telnyx
|
|
|
32
38
|
#
|
|
33
39
|
# @param numbers [Array<String>] The list of phone numbers to update.
|
|
34
40
|
#
|
|
41
|
+
# @param assign_only [Boolean] If true, only assign numbers to the profile without changing other settings.
|
|
42
|
+
#
|
|
35
43
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
36
44
|
end
|
|
37
45
|
end
|
|
@@ -4,6 +4,12 @@ module Telnyx
|
|
|
4
4
|
module Models
|
|
5
5
|
# @see Telnyx::Resources::MessagingProfiles#list
|
|
6
6
|
class MessagingProfile < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute ai_assistant_id
|
|
8
|
+
# The AI assistant ID associated with this messaging profile.
|
|
9
|
+
#
|
|
10
|
+
# @return [String, nil]
|
|
11
|
+
optional :ai_assistant_id, String, nil?: true
|
|
12
|
+
|
|
7
13
|
# @!attribute alpha_sender
|
|
8
14
|
# The alphanumeric sender ID to use when sending to destinations that require an
|
|
9
15
|
# alphanumeric sender ID.
|
|
@@ -70,6 +76,12 @@ module Telnyx
|
|
|
70
76
|
# @return [Telnyx::Models::NumberPoolSettings, nil]
|
|
71
77
|
optional :number_pool_settings, -> { Telnyx::NumberPoolSettings }, nil?: true
|
|
72
78
|
|
|
79
|
+
# @!attribute organization_id
|
|
80
|
+
# The organization that owns this messaging profile.
|
|
81
|
+
#
|
|
82
|
+
# @return [String, nil]
|
|
83
|
+
optional :organization_id, String
|
|
84
|
+
|
|
73
85
|
# @!attribute redaction_enabled
|
|
74
86
|
# Indicates whether message content redaction is enabled for this profile.
|
|
75
87
|
#
|
|
@@ -83,6 +95,12 @@ module Telnyx
|
|
|
83
95
|
# @return [Integer, nil]
|
|
84
96
|
optional :redaction_level, Integer
|
|
85
97
|
|
|
98
|
+
# @!attribute resource_group_id
|
|
99
|
+
# The resource group ID associated with this messaging profile.
|
|
100
|
+
#
|
|
101
|
+
# @return [String, nil]
|
|
102
|
+
optional :resource_group_id, String, nil?: true
|
|
103
|
+
|
|
86
104
|
# @!attribute smart_encoding
|
|
87
105
|
# Enables automatic character encoding optimization for SMS messages. When
|
|
88
106
|
# enabled, the system automatically selects the most efficient encoding (GSM-7 or
|
|
@@ -163,12 +181,14 @@ module Telnyx
|
|
|
163
181
|
optional :updated_at, Time
|
|
164
182
|
end
|
|
165
183
|
|
|
166
|
-
# @!method initialize(id: nil, alpha_sender: nil, created_at: 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, name: nil, number_pool_settings: nil, record_type: nil, redaction_enabled: nil, redaction_level: nil, smart_encoding: nil, updated_at: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil)
|
|
184
|
+
# @!method initialize(id: nil, ai_assistant_id: nil, alpha_sender: nil, created_at: 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, name: nil, number_pool_settings: nil, organization_id: nil, record_type: nil, redaction_enabled: nil, redaction_level: nil, resource_group_id: nil, smart_encoding: nil, updated_at: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil)
|
|
167
185
|
# Some parameter documentations has been truncated, see
|
|
168
186
|
# {Telnyx::Models::MessagingProfile} for more details.
|
|
169
187
|
#
|
|
170
188
|
# @param id [String] Identifies the type of resource.
|
|
171
189
|
#
|
|
190
|
+
# @param ai_assistant_id [String, nil] The AI assistant ID associated with this messaging profile.
|
|
191
|
+
#
|
|
172
192
|
# @param alpha_sender [String, nil] The alphanumeric sender ID to use when sending to destinations that require an a
|
|
173
193
|
#
|
|
174
194
|
# @param created_at [Time] ISO 8601 formatted date indicating when the resource was created.
|
|
@@ -191,12 +211,16 @@ module Telnyx
|
|
|
191
211
|
#
|
|
192
212
|
# @param number_pool_settings [Telnyx::Models::NumberPoolSettings, nil] Number Pool allows you to send messages from a pool of numbers of different type
|
|
193
213
|
#
|
|
214
|
+
# @param organization_id [String] The organization that owns this messaging profile.
|
|
215
|
+
#
|
|
194
216
|
# @param record_type [Symbol, Telnyx::Models::MessagingProfile::RecordType] Identifies the type of the resource.
|
|
195
217
|
#
|
|
196
218
|
# @param redaction_enabled [Boolean] Indicates whether message content redaction is enabled for this profile.
|
|
197
219
|
#
|
|
198
220
|
# @param redaction_level [Integer] Determines how much information is redacted in messages for privacy or complianc
|
|
199
221
|
#
|
|
222
|
+
# @param resource_group_id [String, nil] The resource group ID associated with this messaging profile.
|
|
223
|
+
#
|
|
200
224
|
# @param smart_encoding [Boolean] Enables automatic character encoding optimization for SMS messages. When enabled
|
|
201
225
|
#
|
|
202
226
|
# @param updated_at [Time] ISO 8601 formatted date indicating when the resource was updated.
|
|
@@ -21,6 +21,12 @@ module Telnyx
|
|
|
21
21
|
# @return [Array<String>]
|
|
22
22
|
required :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
23
23
|
|
|
24
|
+
# @!attribute ai_assistant_id
|
|
25
|
+
# The AI assistant ID to associate with this messaging profile.
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :ai_assistant_id, String, nil?: true
|
|
29
|
+
|
|
24
30
|
# @!attribute alpha_sender
|
|
25
31
|
# The alphanumeric sender ID to use when sending to destinations that require an
|
|
26
32
|
# alphanumeric sender ID.
|
|
@@ -47,6 +53,12 @@ module Telnyx
|
|
|
47
53
|
# @return [Boolean, nil]
|
|
48
54
|
optional :enabled, Telnyx::Internal::Type::Boolean
|
|
49
55
|
|
|
56
|
+
# @!attribute health_webhook_url
|
|
57
|
+
# A URL to receive health check webhooks for numbers in this profile.
|
|
58
|
+
#
|
|
59
|
+
# @return [String, nil]
|
|
60
|
+
optional :health_webhook_url, String, nil?: true
|
|
61
|
+
|
|
50
62
|
# @!attribute mms_fall_back_to_sms
|
|
51
63
|
# enables SMS fallback for MMS messages.
|
|
52
64
|
#
|
|
@@ -75,6 +87,12 @@ module Telnyx
|
|
|
75
87
|
# @return [Telnyx::Models::NumberPoolSettings, nil]
|
|
76
88
|
optional :number_pool_settings, -> { Telnyx::NumberPoolSettings }, nil?: true
|
|
77
89
|
|
|
90
|
+
# @!attribute resource_group_id
|
|
91
|
+
# The resource group ID to associate with this messaging profile.
|
|
92
|
+
#
|
|
93
|
+
# @return [String, nil]
|
|
94
|
+
optional :resource_group_id, String, nil?: true
|
|
95
|
+
|
|
78
96
|
# @!attribute smart_encoding
|
|
79
97
|
# Enables automatic character encoding optimization for SMS messages. When
|
|
80
98
|
# enabled, the system automatically selects the most efficient encoding (GSM-7 or
|
|
@@ -115,7 +133,7 @@ module Telnyx
|
|
|
115
133
|
# @return [String, nil]
|
|
116
134
|
optional :webhook_url, String, nil?: true
|
|
117
135
|
|
|
118
|
-
# @!method initialize(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: {})
|
|
136
|
+
# @!method initialize(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: {})
|
|
119
137
|
# Some parameter documentations has been truncated, see
|
|
120
138
|
# {Telnyx::Models::MessagingProfileCreateParams} for more details.
|
|
121
139
|
#
|
|
@@ -123,6 +141,8 @@ module Telnyx
|
|
|
123
141
|
#
|
|
124
142
|
# @param whitelisted_destinations [Array<String>] Destinations to which the messaging profile is allowed to send. The elements in
|
|
125
143
|
#
|
|
144
|
+
# @param ai_assistant_id [String, nil] The AI assistant ID to associate with this messaging profile.
|
|
145
|
+
#
|
|
126
146
|
# @param alpha_sender [String, nil] The alphanumeric sender ID to use when sending to destinations that require an a
|
|
127
147
|
#
|
|
128
148
|
# @param daily_spend_limit [String] The maximum amount of money (in USD) that can be spent by this profile before mi
|
|
@@ -131,6 +151,8 @@ module Telnyx
|
|
|
131
151
|
#
|
|
132
152
|
# @param enabled [Boolean] Specifies whether the messaging profile is enabled or not.
|
|
133
153
|
#
|
|
154
|
+
# @param health_webhook_url [String, nil] A URL to receive health check webhooks for numbers in this profile.
|
|
155
|
+
#
|
|
134
156
|
# @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
|
|
135
157
|
#
|
|
136
158
|
# @param mms_transcoding [Boolean] enables automated resizing of MMS media.
|
|
@@ -139,6 +161,8 @@ module Telnyx
|
|
|
139
161
|
#
|
|
140
162
|
# @param number_pool_settings [Telnyx::Models::NumberPoolSettings, nil] Number Pool allows you to send messages from a pool of numbers of different type
|
|
141
163
|
#
|
|
164
|
+
# @param resource_group_id [String, nil] The resource group ID to associate with this messaging profile.
|
|
165
|
+
#
|
|
142
166
|
# @param smart_encoding [Boolean] Enables automatic character encoding optimization for SMS messages. When enabled
|
|
143
167
|
#
|
|
144
168
|
# @param url_shortener_settings [Telnyx::Models::URLShortenerSettings, nil] The URL shortener feature allows automatic replacement of URLs that were generat
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::MessagingProfiles#list_alphanumeric_sender_ids
|
|
6
|
+
class MessagingProfileListAlphanumericSenderIDsParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute page_number
|
|
11
|
+
#
|
|
12
|
+
# @return [Integer, nil]
|
|
13
|
+
optional :page_number, Integer
|
|
14
|
+
|
|
15
|
+
# @!attribute page_size
|
|
16
|
+
#
|
|
17
|
+
# @return [Integer, nil]
|
|
18
|
+
optional :page_size, Integer
|
|
19
|
+
|
|
20
|
+
# @!method initialize(page_number: nil, page_size: nil, request_options: {})
|
|
21
|
+
# @param page_number [Integer]
|
|
22
|
+
# @param page_size [Integer]
|
|
23
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::MessagingProfiles#list_alphanumeric_sender_ids
|
|
6
|
+
class MessagingProfileListAlphanumericSenderIDsResponse < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# Uniquely identifies the alphanumeric sender ID resource.
|
|
9
|
+
#
|
|
10
|
+
# @return [String, nil]
|
|
11
|
+
optional :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute alphanumeric_sender_id
|
|
14
|
+
# The alphanumeric sender ID string.
|
|
15
|
+
#
|
|
16
|
+
# @return [String, nil]
|
|
17
|
+
optional :alphanumeric_sender_id, String
|
|
18
|
+
|
|
19
|
+
# @!attribute messaging_profile_id
|
|
20
|
+
# The messaging profile this sender ID belongs to.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :messaging_profile_id, String
|
|
24
|
+
|
|
25
|
+
# @!attribute organization_id
|
|
26
|
+
# The organization that owns this sender ID.
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
optional :organization_id, String
|
|
30
|
+
|
|
31
|
+
# @!attribute record_type
|
|
32
|
+
#
|
|
33
|
+
# @return [Symbol, Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse::RecordType, nil]
|
|
34
|
+
optional :record_type,
|
|
35
|
+
enum: -> { Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse::RecordType }
|
|
36
|
+
|
|
37
|
+
# @!attribute us_long_code_fallback
|
|
38
|
+
# A US long code number to use as fallback when sending to US destinations.
|
|
39
|
+
#
|
|
40
|
+
# @return [String, nil]
|
|
41
|
+
optional :us_long_code_fallback, String
|
|
42
|
+
|
|
43
|
+
# @!method initialize(id: nil, alphanumeric_sender_id: nil, messaging_profile_id: nil, organization_id: nil, record_type: nil, us_long_code_fallback: nil)
|
|
44
|
+
# @param id [String] Uniquely identifies the alphanumeric sender ID resource.
|
|
45
|
+
#
|
|
46
|
+
# @param alphanumeric_sender_id [String] The alphanumeric sender ID string.
|
|
47
|
+
#
|
|
48
|
+
# @param messaging_profile_id [String] The messaging profile this sender ID belongs to.
|
|
49
|
+
#
|
|
50
|
+
# @param organization_id [String] The organization that owns this sender ID.
|
|
51
|
+
#
|
|
52
|
+
# @param record_type [Symbol, Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse::RecordType]
|
|
53
|
+
#
|
|
54
|
+
# @param us_long_code_fallback [String] A US long code number to use as fallback when sending to US destinations.
|
|
55
|
+
|
|
56
|
+
# @see Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse#record_type
|
|
57
|
+
module RecordType
|
|
58
|
+
extend Telnyx::Internal::Type::Enum
|
|
59
|
+
|
|
60
|
+
ALPHANUMERIC_SENDER_ID = :alphanumeric_sender_id
|
|
61
|
+
|
|
62
|
+
# @!method self.values
|
|
63
|
+
# @return [Array<Symbol>]
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
end
|
|
@@ -13,6 +13,18 @@ module Telnyx
|
|
|
13
13
|
# @return [Telnyx::Models::MessagingProfileListParams::Filter, nil]
|
|
14
14
|
optional :filter, -> { Telnyx::MessagingProfileListParams::Filter }
|
|
15
15
|
|
|
16
|
+
# @!attribute filter_name_contains
|
|
17
|
+
# Filter profiles by name containing the given string.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :filter_name_contains, String
|
|
21
|
+
|
|
22
|
+
# @!attribute filter_name_eq
|
|
23
|
+
# Filter profiles by exact name match.
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :filter_name_eq, String
|
|
27
|
+
|
|
16
28
|
# @!attribute page_number
|
|
17
29
|
#
|
|
18
30
|
# @return [Integer, nil]
|
|
@@ -23,9 +35,13 @@ module Telnyx
|
|
|
23
35
|
# @return [Integer, nil]
|
|
24
36
|
optional :page_size, Integer
|
|
25
37
|
|
|
26
|
-
# @!method initialize(filter: nil, page_number: nil, page_size: nil, request_options: {})
|
|
38
|
+
# @!method initialize(filter: nil, filter_name_contains: nil, filter_name_eq: nil, page_number: nil, page_size: nil, request_options: {})
|
|
27
39
|
# @param filter [Telnyx::Models::MessagingProfileListParams::Filter] Consolidated filter parameter (deepObject style). Originally: filter[name]
|
|
28
40
|
#
|
|
41
|
+
# @param filter_name_contains [String] Filter profiles by name containing the given string.
|
|
42
|
+
#
|
|
43
|
+
# @param filter_name_eq [String] Filter profiles by exact name match.
|
|
44
|
+
#
|
|
29
45
|
# @param page_number [Integer]
|
|
30
46
|
#
|
|
31
47
|
# @param page_size [Integer]
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::MessagingProfileMetrics#list
|
|
6
|
+
class MessagingProfileMetricListParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute time_frame
|
|
11
|
+
# The time frame for metrics.
|
|
12
|
+
#
|
|
13
|
+
# @return [Symbol, Telnyx::Models::MessagingProfileMetricListParams::TimeFrame, nil]
|
|
14
|
+
optional :time_frame, enum: -> { Telnyx::MessagingProfileMetricListParams::TimeFrame }
|
|
15
|
+
|
|
16
|
+
# @!method initialize(time_frame: nil, request_options: {})
|
|
17
|
+
# @param time_frame [Symbol, Telnyx::Models::MessagingProfileMetricListParams::TimeFrame] The time frame for metrics.
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
|
|
21
|
+
# The time frame for metrics.
|
|
22
|
+
module TimeFrame
|
|
23
|
+
extend Telnyx::Internal::Type::Enum
|
|
24
|
+
|
|
25
|
+
TIME_FRAME_1H = :"1h"
|
|
26
|
+
TIME_FRAME_3H = :"3h"
|
|
27
|
+
TIME_FRAME_24H = :"24h"
|
|
28
|
+
TIME_FRAME_3D = :"3d"
|
|
29
|
+
TIME_FRAME_7D = :"7d"
|
|
30
|
+
TIME_FRAME_30D = :"30d"
|
|
31
|
+
|
|
32
|
+
# @!method self.values
|
|
33
|
+
# @return [Array<Symbol>]
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::MessagingProfileMetrics#list
|
|
6
|
+
class MessagingProfileMetricListResponse < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [Array<Hash{Symbol=>Object}>, nil]
|
|
10
|
+
optional :data,
|
|
11
|
+
Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
|
|
12
|
+
|
|
13
|
+
# @!attribute meta
|
|
14
|
+
#
|
|
15
|
+
# @return [Telnyx::Models::MessagingPaginationMeta, nil]
|
|
16
|
+
optional :meta, -> { Telnyx::MessagingPaginationMeta }
|
|
17
|
+
|
|
18
|
+
# @!method initialize(data: nil, meta: nil)
|
|
19
|
+
# @param data [Array<Hash{Symbol=>Object}>]
|
|
20
|
+
# @param meta [Telnyx::Models::MessagingPaginationMeta]
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::MessagingProfiles#retrieve_metrics
|
|
6
|
+
class MessagingProfileRetrieveMetricsParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute time_frame
|
|
11
|
+
# The time frame for metrics.
|
|
12
|
+
#
|
|
13
|
+
# @return [Symbol, Telnyx::Models::MessagingProfileRetrieveMetricsParams::TimeFrame, nil]
|
|
14
|
+
optional :time_frame, enum: -> { Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame }
|
|
15
|
+
|
|
16
|
+
# @!method initialize(time_frame: nil, request_options: {})
|
|
17
|
+
# @param time_frame [Symbol, Telnyx::Models::MessagingProfileRetrieveMetricsParams::TimeFrame] The time frame for metrics.
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
|
|
21
|
+
# The time frame for metrics.
|
|
22
|
+
module TimeFrame
|
|
23
|
+
extend Telnyx::Internal::Type::Enum
|
|
24
|
+
|
|
25
|
+
TIME_FRAME_1H = :"1h"
|
|
26
|
+
TIME_FRAME_3H = :"3h"
|
|
27
|
+
TIME_FRAME_24H = :"24h"
|
|
28
|
+
TIME_FRAME_3D = :"3d"
|
|
29
|
+
TIME_FRAME_7D = :"7d"
|
|
30
|
+
TIME_FRAME_30D = :"30d"
|
|
31
|
+
|
|
32
|
+
# @!method self.values
|
|
33
|
+
# @return [Array<Symbol>]
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::MessagingProfiles#retrieve_metrics
|
|
6
|
+
class MessagingProfileRetrieveMetricsResponse < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
# Detailed metrics for a messaging profile.
|
|
9
|
+
#
|
|
10
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
11
|
+
optional :data, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Hash{Symbol=>Object}] Detailed metrics for a messaging profile.
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module MessagingProfiles
|
|
6
|
+
# @see Telnyx::Resources::MessagingProfiles::Actions#regenerate_secret
|
|
7
|
+
class ActionRegenerateSecretParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!method initialize(request_options: {})
|
|
12
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module MessagingProfiles
|
|
6
|
+
# @see Telnyx::Resources::MessagingProfiles::Actions#regenerate_secret
|
|
7
|
+
class ActionRegenerateSecretResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::MessagingProfile, nil]
|
|
11
|
+
optional :data, -> { Telnyx::MessagingProfile }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::MessagingProfile]
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -22,6 +22,12 @@ module Telnyx
|
|
|
22
22
|
# @return [Integer]
|
|
23
23
|
required :page_size, Integer
|
|
24
24
|
|
|
25
|
+
# @!attribute business_name
|
|
26
|
+
# Filter verification requests by business name
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
optional :business_name, String
|
|
30
|
+
|
|
25
31
|
# @!attribute date_end
|
|
26
32
|
#
|
|
27
33
|
# @return [Time, nil]
|
|
@@ -43,7 +49,7 @@ module Telnyx
|
|
|
43
49
|
# @return [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationStatus, nil]
|
|
44
50
|
optional :status, enum: -> { Telnyx::MessagingTollfree::Verification::TfVerificationStatus }
|
|
45
51
|
|
|
46
|
-
# @!method initialize(page:, page_size:, date_end: nil, date_start: nil, phone_number: nil, status: nil, request_options: {})
|
|
52
|
+
# @!method initialize(page:, page_size:, business_name: nil, date_end: nil, date_start: nil, phone_number: nil, status: nil, request_options: {})
|
|
47
53
|
# Some parameter documentations has been truncated, see
|
|
48
54
|
# {Telnyx::Models::MessagingTollfree::Verification::RequestListParams} for more
|
|
49
55
|
# details.
|
|
@@ -52,6 +58,8 @@ module Telnyx
|
|
|
52
58
|
#
|
|
53
59
|
# @param page_size [Integer]
|
|
54
60
|
#
|
|
61
|
+
# @param business_name [String] Filter verification requests by business name
|
|
62
|
+
#
|
|
55
63
|
# @param date_end [Time]
|
|
56
64
|
#
|
|
57
65
|
# @param date_start [Time]
|