telnyx 5.166.0 → 5.167.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 +12 -0
- data/README.md +1 -1
- data/lib/telnyx/internal/default_flat_pagination.rb +7 -3
- data/lib/telnyx/internal/default_flat_pagination_for_inexplicit_number_orders.rb +7 -3
- data/lib/telnyx/internal/default_flat_pagination_top_level_array.rb +10 -8
- data/lib/telnyx/internal/default_pagination_for_log_messages.rb +7 -3
- data/lib/telnyx/internal/default_pagination_for_messaging_tollfree.rb +12 -3
- data/lib/telnyx/internal/default_pagination_for_queues.rb +12 -3
- data/lib/telnyx/internal/per_page_pagination.rb +8 -1
- data/lib/telnyx/internal/per_page_pagination_v2.rb +8 -1
- data/lib/telnyx/internal/type/converter.rb +2 -0
- data/lib/telnyx/models/ai/anthropic/v1_messages_params.rb +57 -1
- data/lib/telnyx/models/ai/chat_completion_request.rb +61 -1
- data/lib/telnyx/models/ai/openai_create_response_params.rb +57 -1
- data/lib/telnyx/models/messaging_messaging_profile.rb +274 -0
- data/lib/telnyx/models/messaging_profile.rb +0 -1
- data/lib/telnyx/models/messaging_profile_create_response.rb +3 -3
- data/lib/telnyx/models/messaging_profile_delete_response.rb +3 -3
- data/lib/telnyx/models/messaging_profile_retrieve_response.rb +3 -3
- data/lib/telnyx/models/messaging_profile_update_params.rb +22 -1
- data/lib/telnyx/models/messaging_profile_update_response.rb +3 -3
- data/lib/telnyx/models/messaging_profiles/action_regenerate_secret_response.rb +3 -3
- data/lib/telnyx/models.rb +2 -0
- data/lib/telnyx/resources/ai/anthropic/v1.rb +5 -1
- data/lib/telnyx/resources/ai/openai/chat.rb +5 -1
- data/lib/telnyx/resources/ai/openai.rb +5 -1
- data/lib/telnyx/resources/messaging_profiles.rb +7 -3
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +1 -0
- data/rbi/telnyx/models/ai/anthropic/v1_messages_params.rbi +139 -0
- data/rbi/telnyx/models/ai/chat_completion_request.rbi +116 -0
- data/rbi/telnyx/models/ai/openai_create_response_params.rbi +136 -0
- data/rbi/telnyx/models/messaging_messaging_profile.rbi +444 -0
- data/rbi/telnyx/models/messaging_profile.rbi +4 -6
- data/rbi/telnyx/models/messaging_profile_create_response.rbi +6 -4
- data/rbi/telnyx/models/messaging_profile_delete_response.rbi +6 -4
- data/rbi/telnyx/models/messaging_profile_retrieve_response.rbi +6 -4
- data/rbi/telnyx/models/messaging_profile_update_params.rbi +32 -0
- data/rbi/telnyx/models/messaging_profile_update_response.rbi +6 -4
- data/rbi/telnyx/models/messaging_profiles/action_regenerate_secret_response.rbi +4 -4
- data/rbi/telnyx/models.rbi +2 -0
- data/rbi/telnyx/resources/ai/anthropic/v1.rbi +14 -0
- data/rbi/telnyx/resources/ai/openai/chat.rbi +14 -0
- data/rbi/telnyx/resources/ai/openai.rbi +14 -0
- data/rbi/telnyx/resources/messaging_profiles.rbi +14 -1
- data/sig/telnyx/models/ai/anthropic/v1_messages_params.rbs +42 -0
- data/sig/telnyx/models/ai/chat_completion_request.rbs +42 -0
- data/sig/telnyx/models/ai/openai_create_response_params.rbs +42 -0
- data/sig/telnyx/models/messaging_messaging_profile.rbs +207 -0
- data/sig/telnyx/models/messaging_profile_create_response.rbs +8 -5
- data/sig/telnyx/models/messaging_profile_delete_response.rbs +8 -5
- data/sig/telnyx/models/messaging_profile_retrieve_response.rbs +7 -5
- data/sig/telnyx/models/messaging_profile_update_params.rbs +14 -0
- data/sig/telnyx/models/messaging_profile_update_response.rbs +8 -5
- data/sig/telnyx/models/messaging_profiles/action_regenerate_secret_response.rbs +7 -5
- data/sig/telnyx/models.rbs +2 -0
- data/sig/telnyx/resources/ai/anthropic/v1.rbs +2 -0
- data/sig/telnyx/resources/ai/openai/chat.rbs +2 -0
- data/sig/telnyx/resources/ai/openai.rbs +2 -0
- data/sig/telnyx/resources/messaging_profiles.rbs +3 -1
- metadata +5 -2
|
@@ -0,0 +1,444 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class MessagingMessagingProfile < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
OrHash =
|
|
7
|
+
T.type_alias do
|
|
8
|
+
T.any(Telnyx::MessagingMessagingProfile, Telnyx::Internal::AnyHash)
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
# The AI assistant ID associated with this messaging profile.
|
|
12
|
+
sig { returns(T.nilable(String)) }
|
|
13
|
+
attr_accessor :ai_assistant_id
|
|
14
|
+
|
|
15
|
+
# The alphanumeric sender ID to use when sending to destinations that require an
|
|
16
|
+
# alphanumeric sender ID.
|
|
17
|
+
sig { returns(T.nilable(String)) }
|
|
18
|
+
attr_accessor :alpha_sender
|
|
19
|
+
|
|
20
|
+
# The maximum amount of money (in USD) that can be spent by this profile before
|
|
21
|
+
# midnight UTC.
|
|
22
|
+
sig { returns(T.nilable(String)) }
|
|
23
|
+
attr_reader :daily_spend_limit
|
|
24
|
+
|
|
25
|
+
sig { params(daily_spend_limit: String).void }
|
|
26
|
+
attr_writer :daily_spend_limit
|
|
27
|
+
|
|
28
|
+
# Whether to enforce the value configured by `daily_spend_limit`.
|
|
29
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
30
|
+
attr_reader :daily_spend_limit_enabled
|
|
31
|
+
|
|
32
|
+
sig { params(daily_spend_limit_enabled: T::Boolean).void }
|
|
33
|
+
attr_writer :daily_spend_limit_enabled
|
|
34
|
+
|
|
35
|
+
# Specifies whether the messaging profile is enabled or not.
|
|
36
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
37
|
+
attr_reader :enabled
|
|
38
|
+
|
|
39
|
+
sig { params(enabled: T::Boolean).void }
|
|
40
|
+
attr_writer :enabled
|
|
41
|
+
|
|
42
|
+
# DEPRECATED: health check url service checking
|
|
43
|
+
sig { returns(T.nilable(String)) }
|
|
44
|
+
attr_accessor :health_webhook_url
|
|
45
|
+
|
|
46
|
+
# enables SMS fallback for MMS messages.
|
|
47
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
48
|
+
attr_reader :mms_fall_back_to_sms
|
|
49
|
+
|
|
50
|
+
sig { params(mms_fall_back_to_sms: T::Boolean).void }
|
|
51
|
+
attr_writer :mms_fall_back_to_sms
|
|
52
|
+
|
|
53
|
+
# enables automated resizing of MMS media.
|
|
54
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
55
|
+
attr_reader :mms_transcoding
|
|
56
|
+
|
|
57
|
+
sig { params(mms_transcoding: T::Boolean).void }
|
|
58
|
+
attr_writer :mms_transcoding
|
|
59
|
+
|
|
60
|
+
# Send messages only to mobile phone numbers.
|
|
61
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
62
|
+
attr_reader :mobile_only
|
|
63
|
+
|
|
64
|
+
sig { params(mobile_only: T::Boolean).void }
|
|
65
|
+
attr_writer :mobile_only
|
|
66
|
+
|
|
67
|
+
# A user friendly name for the messaging profile.
|
|
68
|
+
sig { returns(T.nilable(String)) }
|
|
69
|
+
attr_reader :name
|
|
70
|
+
|
|
71
|
+
sig { params(name: String).void }
|
|
72
|
+
attr_writer :name
|
|
73
|
+
|
|
74
|
+
# Number Pool allows you to send messages from a pool of numbers of different
|
|
75
|
+
# types, assigning weights to each type. The pool consists of all the long code
|
|
76
|
+
# and toll free numbers assigned to the messaging profile.
|
|
77
|
+
#
|
|
78
|
+
# To disable this feature, set the object field to `null`.
|
|
79
|
+
sig { returns(T.nilable(Telnyx::NumberPoolSettings)) }
|
|
80
|
+
attr_reader :number_pool_settings
|
|
81
|
+
|
|
82
|
+
sig do
|
|
83
|
+
params(
|
|
84
|
+
number_pool_settings: T.nilable(Telnyx::NumberPoolSettings::OrHash)
|
|
85
|
+
).void
|
|
86
|
+
end
|
|
87
|
+
attr_writer :number_pool_settings
|
|
88
|
+
|
|
89
|
+
# The organization that owns this messaging profile.
|
|
90
|
+
sig { returns(T.nilable(String)) }
|
|
91
|
+
attr_reader :organization_id
|
|
92
|
+
|
|
93
|
+
sig { params(organization_id: String).void }
|
|
94
|
+
attr_writer :organization_id
|
|
95
|
+
|
|
96
|
+
# Indicates whether message content redaction is enabled for this profile. When
|
|
97
|
+
# enabled, message text, MMS media, and the counterparty phone number are redacted
|
|
98
|
+
# in message records and reporting. Requires organization activation — contact
|
|
99
|
+
# support to enable. The field is only present in responses for organizations with
|
|
100
|
+
# redaction access.
|
|
101
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
102
|
+
attr_reader :redaction_enabled
|
|
103
|
+
|
|
104
|
+
sig { params(redaction_enabled: T::Boolean).void }
|
|
105
|
+
attr_writer :redaction_enabled
|
|
106
|
+
|
|
107
|
+
# Determines how much information is redacted for privacy or compliance purposes.
|
|
108
|
+
# Level 1: message records and reporting are redacted, but inbound webhook
|
|
109
|
+
# payloads are not. Level 2 (default): message records, reporting, and inbound
|
|
110
|
+
# webhook payloads are all redacted.
|
|
111
|
+
sig { returns(T.nilable(Integer)) }
|
|
112
|
+
attr_reader :redaction_level
|
|
113
|
+
|
|
114
|
+
sig { params(redaction_level: Integer).void }
|
|
115
|
+
attr_writer :redaction_level
|
|
116
|
+
|
|
117
|
+
# The resource group ID associated with this messaging profile.
|
|
118
|
+
sig { returns(T.nilable(String)) }
|
|
119
|
+
attr_accessor :resource_group_id
|
|
120
|
+
|
|
121
|
+
# Enables automatic character encoding optimization for SMS messages. When
|
|
122
|
+
# enabled, the system automatically selects the most efficient encoding (GSM-7 or
|
|
123
|
+
# UCS-2) based on message content to maximize character limits and minimize costs.
|
|
124
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
125
|
+
attr_reader :smart_encoding
|
|
126
|
+
|
|
127
|
+
sig { params(smart_encoding: T::Boolean).void }
|
|
128
|
+
attr_writer :smart_encoding
|
|
129
|
+
|
|
130
|
+
# The URL shortener feature allows automatic replacement of URLs that were
|
|
131
|
+
# generated using a public URL shortener service. Some examples include bit.do,
|
|
132
|
+
# bit.ly, goo.gl, ht.ly, is.gd, ow.ly, rebrand.ly, t.co, tiny.cc, and tinyurl.com.
|
|
133
|
+
# Such URLs are replaced with with links generated by Telnyx. The use of custom
|
|
134
|
+
# links can improve branding and message deliverability.
|
|
135
|
+
#
|
|
136
|
+
# To disable this feature, set the object field to `null`.
|
|
137
|
+
sig { returns(T.nilable(Telnyx::URLShortenerSettings)) }
|
|
138
|
+
attr_reader :url_shortener_settings
|
|
139
|
+
|
|
140
|
+
sig do
|
|
141
|
+
params(
|
|
142
|
+
url_shortener_settings:
|
|
143
|
+
T.nilable(Telnyx::URLShortenerSettings::OrHash)
|
|
144
|
+
).void
|
|
145
|
+
end
|
|
146
|
+
attr_writer :url_shortener_settings
|
|
147
|
+
|
|
148
|
+
# Secret used to authenticate with v1 endpoints.
|
|
149
|
+
sig { returns(T.nilable(String)) }
|
|
150
|
+
attr_reader :v1_secret
|
|
151
|
+
|
|
152
|
+
sig { params(v1_secret: String).void }
|
|
153
|
+
attr_writer :v1_secret
|
|
154
|
+
|
|
155
|
+
# Determines which webhook format will be used, Telnyx API v1, v2, or a legacy
|
|
156
|
+
# 2010-04-01 format.
|
|
157
|
+
sig do
|
|
158
|
+
returns(
|
|
159
|
+
T.nilable(
|
|
160
|
+
Telnyx::MessagingMessagingProfile::WebhookAPIVersion::TaggedSymbol
|
|
161
|
+
)
|
|
162
|
+
)
|
|
163
|
+
end
|
|
164
|
+
attr_reader :webhook_api_version
|
|
165
|
+
|
|
166
|
+
sig do
|
|
167
|
+
params(
|
|
168
|
+
webhook_api_version:
|
|
169
|
+
Telnyx::MessagingMessagingProfile::WebhookAPIVersion::OrSymbol
|
|
170
|
+
).void
|
|
171
|
+
end
|
|
172
|
+
attr_writer :webhook_api_version
|
|
173
|
+
|
|
174
|
+
# The failover URL where webhooks related to this messaging profile will be sent
|
|
175
|
+
# if sending to the primary URL fails.
|
|
176
|
+
sig { returns(T.nilable(String)) }
|
|
177
|
+
attr_accessor :webhook_failover_url
|
|
178
|
+
|
|
179
|
+
# The URL where webhooks related to this messaging profile will be sent.
|
|
180
|
+
sig { returns(T.nilable(String)) }
|
|
181
|
+
attr_accessor :webhook_url
|
|
182
|
+
|
|
183
|
+
# Destinations to which the messaging profile is allowed to send. The elements in
|
|
184
|
+
# the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
185
|
+
# destinations will be allowed.
|
|
186
|
+
sig { returns(T.nilable(T::Array[String])) }
|
|
187
|
+
attr_reader :whitelisted_destinations
|
|
188
|
+
|
|
189
|
+
sig { params(whitelisted_destinations: T::Array[String]).void }
|
|
190
|
+
attr_writer :whitelisted_destinations
|
|
191
|
+
|
|
192
|
+
# Identifies the type of resource.
|
|
193
|
+
sig { returns(T.nilable(String)) }
|
|
194
|
+
attr_reader :id
|
|
195
|
+
|
|
196
|
+
sig { params(id: String).void }
|
|
197
|
+
attr_writer :id
|
|
198
|
+
|
|
199
|
+
# ISO 8601 formatted date indicating when the resource was created.
|
|
200
|
+
sig { returns(T.nilable(Time)) }
|
|
201
|
+
attr_reader :created_at
|
|
202
|
+
|
|
203
|
+
sig { params(created_at: Time).void }
|
|
204
|
+
attr_writer :created_at
|
|
205
|
+
|
|
206
|
+
# Identifies the type of the resource.
|
|
207
|
+
sig do
|
|
208
|
+
returns(
|
|
209
|
+
T.nilable(Telnyx::MessagingMessagingProfile::RecordType::TaggedSymbol)
|
|
210
|
+
)
|
|
211
|
+
end
|
|
212
|
+
attr_reader :record_type
|
|
213
|
+
|
|
214
|
+
sig do
|
|
215
|
+
params(
|
|
216
|
+
record_type: Telnyx::MessagingMessagingProfile::RecordType::OrSymbol
|
|
217
|
+
).void
|
|
218
|
+
end
|
|
219
|
+
attr_writer :record_type
|
|
220
|
+
|
|
221
|
+
# ISO 8601 formatted date indicating when the resource was updated.
|
|
222
|
+
sig { returns(T.nilable(Time)) }
|
|
223
|
+
attr_reader :updated_at
|
|
224
|
+
|
|
225
|
+
sig { params(updated_at: Time).void }
|
|
226
|
+
attr_writer :updated_at
|
|
227
|
+
|
|
228
|
+
sig do
|
|
229
|
+
params(
|
|
230
|
+
id: String,
|
|
231
|
+
ai_assistant_id: T.nilable(String),
|
|
232
|
+
alpha_sender: T.nilable(String),
|
|
233
|
+
created_at: Time,
|
|
234
|
+
daily_spend_limit: String,
|
|
235
|
+
daily_spend_limit_enabled: T::Boolean,
|
|
236
|
+
enabled: T::Boolean,
|
|
237
|
+
health_webhook_url: T.nilable(String),
|
|
238
|
+
mms_fall_back_to_sms: T::Boolean,
|
|
239
|
+
mms_transcoding: T::Boolean,
|
|
240
|
+
mobile_only: T::Boolean,
|
|
241
|
+
name: String,
|
|
242
|
+
number_pool_settings: T.nilable(Telnyx::NumberPoolSettings::OrHash),
|
|
243
|
+
organization_id: String,
|
|
244
|
+
record_type: Telnyx::MessagingMessagingProfile::RecordType::OrSymbol,
|
|
245
|
+
redaction_enabled: T::Boolean,
|
|
246
|
+
redaction_level: Integer,
|
|
247
|
+
resource_group_id: T.nilable(String),
|
|
248
|
+
smart_encoding: T::Boolean,
|
|
249
|
+
updated_at: Time,
|
|
250
|
+
url_shortener_settings:
|
|
251
|
+
T.nilable(Telnyx::URLShortenerSettings::OrHash),
|
|
252
|
+
v1_secret: String,
|
|
253
|
+
webhook_api_version:
|
|
254
|
+
Telnyx::MessagingMessagingProfile::WebhookAPIVersion::OrSymbol,
|
|
255
|
+
webhook_failover_url: T.nilable(String),
|
|
256
|
+
webhook_url: T.nilable(String),
|
|
257
|
+
whitelisted_destinations: T::Array[String]
|
|
258
|
+
).returns(T.attached_class)
|
|
259
|
+
end
|
|
260
|
+
def self.new(
|
|
261
|
+
# Identifies the type of resource.
|
|
262
|
+
id: nil,
|
|
263
|
+
# The AI assistant ID associated with this messaging profile.
|
|
264
|
+
ai_assistant_id: nil,
|
|
265
|
+
# The alphanumeric sender ID to use when sending to destinations that require an
|
|
266
|
+
# alphanumeric sender ID.
|
|
267
|
+
alpha_sender: nil,
|
|
268
|
+
# ISO 8601 formatted date indicating when the resource was created.
|
|
269
|
+
created_at: nil,
|
|
270
|
+
# The maximum amount of money (in USD) that can be spent by this profile before
|
|
271
|
+
# midnight UTC.
|
|
272
|
+
daily_spend_limit: nil,
|
|
273
|
+
# Whether to enforce the value configured by `daily_spend_limit`.
|
|
274
|
+
daily_spend_limit_enabled: nil,
|
|
275
|
+
# Specifies whether the messaging profile is enabled or not.
|
|
276
|
+
enabled: nil,
|
|
277
|
+
# DEPRECATED: health check url service checking
|
|
278
|
+
health_webhook_url: nil,
|
|
279
|
+
# enables SMS fallback for MMS messages.
|
|
280
|
+
mms_fall_back_to_sms: nil,
|
|
281
|
+
# enables automated resizing of MMS media.
|
|
282
|
+
mms_transcoding: nil,
|
|
283
|
+
# Send messages only to mobile phone numbers.
|
|
284
|
+
mobile_only: nil,
|
|
285
|
+
# A user friendly name for the messaging profile.
|
|
286
|
+
name: nil,
|
|
287
|
+
# Number Pool allows you to send messages from a pool of numbers of different
|
|
288
|
+
# types, assigning weights to each type. The pool consists of all the long code
|
|
289
|
+
# and toll free numbers assigned to the messaging profile.
|
|
290
|
+
#
|
|
291
|
+
# To disable this feature, set the object field to `null`.
|
|
292
|
+
number_pool_settings: nil,
|
|
293
|
+
# The organization that owns this messaging profile.
|
|
294
|
+
organization_id: nil,
|
|
295
|
+
# Identifies the type of the resource.
|
|
296
|
+
record_type: nil,
|
|
297
|
+
# Indicates whether message content redaction is enabled for this profile. When
|
|
298
|
+
# enabled, message text, MMS media, and the counterparty phone number are redacted
|
|
299
|
+
# in message records and reporting. Requires organization activation — contact
|
|
300
|
+
# support to enable. The field is only present in responses for organizations with
|
|
301
|
+
# redaction access.
|
|
302
|
+
redaction_enabled: nil,
|
|
303
|
+
# Determines how much information is redacted for privacy or compliance purposes.
|
|
304
|
+
# Level 1: message records and reporting are redacted, but inbound webhook
|
|
305
|
+
# payloads are not. Level 2 (default): message records, reporting, and inbound
|
|
306
|
+
# webhook payloads are all redacted.
|
|
307
|
+
redaction_level: nil,
|
|
308
|
+
# The resource group ID associated with this messaging profile.
|
|
309
|
+
resource_group_id: nil,
|
|
310
|
+
# Enables automatic character encoding optimization for SMS messages. When
|
|
311
|
+
# enabled, the system automatically selects the most efficient encoding (GSM-7 or
|
|
312
|
+
# UCS-2) based on message content to maximize character limits and minimize costs.
|
|
313
|
+
smart_encoding: nil,
|
|
314
|
+
# ISO 8601 formatted date indicating when the resource was updated.
|
|
315
|
+
updated_at: nil,
|
|
316
|
+
# The URL shortener feature allows automatic replacement of URLs that were
|
|
317
|
+
# generated using a public URL shortener service. Some examples include bit.do,
|
|
318
|
+
# bit.ly, goo.gl, ht.ly, is.gd, ow.ly, rebrand.ly, t.co, tiny.cc, and tinyurl.com.
|
|
319
|
+
# Such URLs are replaced with with links generated by Telnyx. The use of custom
|
|
320
|
+
# links can improve branding and message deliverability.
|
|
321
|
+
#
|
|
322
|
+
# To disable this feature, set the object field to `null`.
|
|
323
|
+
url_shortener_settings: nil,
|
|
324
|
+
# Secret used to authenticate with v1 endpoints.
|
|
325
|
+
v1_secret: nil,
|
|
326
|
+
# Determines which webhook format will be used, Telnyx API v1, v2, or a legacy
|
|
327
|
+
# 2010-04-01 format.
|
|
328
|
+
webhook_api_version: nil,
|
|
329
|
+
# The failover URL where webhooks related to this messaging profile will be sent
|
|
330
|
+
# if sending to the primary URL fails.
|
|
331
|
+
webhook_failover_url: nil,
|
|
332
|
+
# The URL where webhooks related to this messaging profile will be sent.
|
|
333
|
+
webhook_url: nil,
|
|
334
|
+
# Destinations to which the messaging profile is allowed to send. The elements in
|
|
335
|
+
# the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
336
|
+
# destinations will be allowed.
|
|
337
|
+
whitelisted_destinations: nil
|
|
338
|
+
)
|
|
339
|
+
end
|
|
340
|
+
|
|
341
|
+
sig do
|
|
342
|
+
override.returns(
|
|
343
|
+
{
|
|
344
|
+
id: String,
|
|
345
|
+
ai_assistant_id: T.nilable(String),
|
|
346
|
+
alpha_sender: T.nilable(String),
|
|
347
|
+
created_at: Time,
|
|
348
|
+
daily_spend_limit: String,
|
|
349
|
+
daily_spend_limit_enabled: T::Boolean,
|
|
350
|
+
enabled: T::Boolean,
|
|
351
|
+
health_webhook_url: T.nilable(String),
|
|
352
|
+
mms_fall_back_to_sms: T::Boolean,
|
|
353
|
+
mms_transcoding: T::Boolean,
|
|
354
|
+
mobile_only: T::Boolean,
|
|
355
|
+
name: String,
|
|
356
|
+
number_pool_settings: T.nilable(Telnyx::NumberPoolSettings),
|
|
357
|
+
organization_id: String,
|
|
358
|
+
record_type:
|
|
359
|
+
Telnyx::MessagingMessagingProfile::RecordType::TaggedSymbol,
|
|
360
|
+
redaction_enabled: T::Boolean,
|
|
361
|
+
redaction_level: Integer,
|
|
362
|
+
resource_group_id: T.nilable(String),
|
|
363
|
+
smart_encoding: T::Boolean,
|
|
364
|
+
updated_at: Time,
|
|
365
|
+
url_shortener_settings: T.nilable(Telnyx::URLShortenerSettings),
|
|
366
|
+
v1_secret: String,
|
|
367
|
+
webhook_api_version:
|
|
368
|
+
Telnyx::MessagingMessagingProfile::WebhookAPIVersion::TaggedSymbol,
|
|
369
|
+
webhook_failover_url: T.nilable(String),
|
|
370
|
+
webhook_url: T.nilable(String),
|
|
371
|
+
whitelisted_destinations: T::Array[String]
|
|
372
|
+
}
|
|
373
|
+
)
|
|
374
|
+
end
|
|
375
|
+
def to_hash
|
|
376
|
+
end
|
|
377
|
+
|
|
378
|
+
# Identifies the type of the resource.
|
|
379
|
+
module RecordType
|
|
380
|
+
extend Telnyx::Internal::Type::Enum
|
|
381
|
+
|
|
382
|
+
TaggedSymbol =
|
|
383
|
+
T.type_alias do
|
|
384
|
+
T.all(Symbol, Telnyx::MessagingMessagingProfile::RecordType)
|
|
385
|
+
end
|
|
386
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
387
|
+
|
|
388
|
+
MESSAGING_PROFILE =
|
|
389
|
+
T.let(
|
|
390
|
+
:messaging_profile,
|
|
391
|
+
Telnyx::MessagingMessagingProfile::RecordType::TaggedSymbol
|
|
392
|
+
)
|
|
393
|
+
|
|
394
|
+
sig do
|
|
395
|
+
override.returns(
|
|
396
|
+
T::Array[
|
|
397
|
+
Telnyx::MessagingMessagingProfile::RecordType::TaggedSymbol
|
|
398
|
+
]
|
|
399
|
+
)
|
|
400
|
+
end
|
|
401
|
+
def self.values
|
|
402
|
+
end
|
|
403
|
+
end
|
|
404
|
+
|
|
405
|
+
# Determines which webhook format will be used, Telnyx API v1, v2, or a legacy
|
|
406
|
+
# 2010-04-01 format.
|
|
407
|
+
module WebhookAPIVersion
|
|
408
|
+
extend Telnyx::Internal::Type::Enum
|
|
409
|
+
|
|
410
|
+
TaggedSymbol =
|
|
411
|
+
T.type_alias do
|
|
412
|
+
T.all(Symbol, Telnyx::MessagingMessagingProfile::WebhookAPIVersion)
|
|
413
|
+
end
|
|
414
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
415
|
+
|
|
416
|
+
V1 =
|
|
417
|
+
T.let(
|
|
418
|
+
:"1",
|
|
419
|
+
Telnyx::MessagingMessagingProfile::WebhookAPIVersion::TaggedSymbol
|
|
420
|
+
)
|
|
421
|
+
V2 =
|
|
422
|
+
T.let(
|
|
423
|
+
:"2",
|
|
424
|
+
Telnyx::MessagingMessagingProfile::WebhookAPIVersion::TaggedSymbol
|
|
425
|
+
)
|
|
426
|
+
V2010_04_01 =
|
|
427
|
+
T.let(
|
|
428
|
+
:"2010-04-01",
|
|
429
|
+
Telnyx::MessagingMessagingProfile::WebhookAPIVersion::TaggedSymbol
|
|
430
|
+
)
|
|
431
|
+
|
|
432
|
+
sig do
|
|
433
|
+
override.returns(
|
|
434
|
+
T::Array[
|
|
435
|
+
Telnyx::MessagingMessagingProfile::WebhookAPIVersion::TaggedSymbol
|
|
436
|
+
]
|
|
437
|
+
)
|
|
438
|
+
end
|
|
439
|
+
def self.values
|
|
440
|
+
end
|
|
441
|
+
end
|
|
442
|
+
end
|
|
443
|
+
end
|
|
444
|
+
end
|
|
@@ -150,7 +150,7 @@ module Telnyx
|
|
|
150
150
|
# 2010-04-01 format.
|
|
151
151
|
sig do
|
|
152
152
|
returns(
|
|
153
|
-
T.nilable(Telnyx::MessagingProfile::WebhookAPIVersion::
|
|
153
|
+
T.nilable(Telnyx::MessagingProfile::WebhookAPIVersion::OrSymbol)
|
|
154
154
|
)
|
|
155
155
|
end
|
|
156
156
|
attr_reader :webhook_api_version
|
|
@@ -196,9 +196,7 @@ module Telnyx
|
|
|
196
196
|
attr_writer :created_at
|
|
197
197
|
|
|
198
198
|
# Identifies the type of the resource.
|
|
199
|
-
sig
|
|
200
|
-
returns(T.nilable(Telnyx::MessagingProfile::RecordType::TaggedSymbol))
|
|
201
|
-
end
|
|
199
|
+
sig { returns(T.nilable(Telnyx::MessagingProfile::RecordType::OrSymbol)) }
|
|
202
200
|
attr_reader :record_type
|
|
203
201
|
|
|
204
202
|
sig do
|
|
@@ -337,7 +335,7 @@ module Telnyx
|
|
|
337
335
|
name: String,
|
|
338
336
|
number_pool_settings: T.nilable(Telnyx::NumberPoolSettings),
|
|
339
337
|
organization_id: String,
|
|
340
|
-
record_type: Telnyx::MessagingProfile::RecordType::
|
|
338
|
+
record_type: Telnyx::MessagingProfile::RecordType::OrSymbol,
|
|
341
339
|
redaction_enabled: T::Boolean,
|
|
342
340
|
redaction_level: Integer,
|
|
343
341
|
resource_group_id: T.nilable(String),
|
|
@@ -346,7 +344,7 @@ module Telnyx
|
|
|
346
344
|
url_shortener_settings: T.nilable(Telnyx::URLShortenerSettings),
|
|
347
345
|
v1_secret: String,
|
|
348
346
|
webhook_api_version:
|
|
349
|
-
Telnyx::MessagingProfile::WebhookAPIVersion::
|
|
347
|
+
Telnyx::MessagingProfile::WebhookAPIVersion::OrSymbol,
|
|
350
348
|
webhook_failover_url: T.nilable(String),
|
|
351
349
|
webhook_url: T.nilable(String),
|
|
352
350
|
whitelisted_destinations: T::Array[String]
|
|
@@ -11,19 +11,21 @@ module Telnyx
|
|
|
11
11
|
)
|
|
12
12
|
end
|
|
13
13
|
|
|
14
|
-
sig { returns(T.nilable(Telnyx::
|
|
14
|
+
sig { returns(T.nilable(Telnyx::MessagingMessagingProfile)) }
|
|
15
15
|
attr_reader :data
|
|
16
16
|
|
|
17
|
-
sig { params(data: Telnyx::
|
|
17
|
+
sig { params(data: Telnyx::MessagingMessagingProfile::OrHash).void }
|
|
18
18
|
attr_writer :data
|
|
19
19
|
|
|
20
20
|
sig do
|
|
21
|
-
params(data: Telnyx::
|
|
21
|
+
params(data: Telnyx::MessagingMessagingProfile::OrHash).returns(
|
|
22
|
+
T.attached_class
|
|
23
|
+
)
|
|
22
24
|
end
|
|
23
25
|
def self.new(data: nil)
|
|
24
26
|
end
|
|
25
27
|
|
|
26
|
-
sig { override.returns({ data: Telnyx::
|
|
28
|
+
sig { override.returns({ data: Telnyx::MessagingMessagingProfile }) }
|
|
27
29
|
def to_hash
|
|
28
30
|
end
|
|
29
31
|
end
|
|
@@ -11,19 +11,21 @@ module Telnyx
|
|
|
11
11
|
)
|
|
12
12
|
end
|
|
13
13
|
|
|
14
|
-
sig { returns(T.nilable(Telnyx::
|
|
14
|
+
sig { returns(T.nilable(Telnyx::MessagingMessagingProfile)) }
|
|
15
15
|
attr_reader :data
|
|
16
16
|
|
|
17
|
-
sig { params(data: Telnyx::
|
|
17
|
+
sig { params(data: Telnyx::MessagingMessagingProfile::OrHash).void }
|
|
18
18
|
attr_writer :data
|
|
19
19
|
|
|
20
20
|
sig do
|
|
21
|
-
params(data: Telnyx::
|
|
21
|
+
params(data: Telnyx::MessagingMessagingProfile::OrHash).returns(
|
|
22
|
+
T.attached_class
|
|
23
|
+
)
|
|
22
24
|
end
|
|
23
25
|
def self.new(data: nil)
|
|
24
26
|
end
|
|
25
27
|
|
|
26
|
-
sig { override.returns({ data: Telnyx::
|
|
28
|
+
sig { override.returns({ data: Telnyx::MessagingMessagingProfile }) }
|
|
27
29
|
def to_hash
|
|
28
30
|
end
|
|
29
31
|
end
|
|
@@ -11,19 +11,21 @@ module Telnyx
|
|
|
11
11
|
)
|
|
12
12
|
end
|
|
13
13
|
|
|
14
|
-
sig { returns(T.nilable(Telnyx::
|
|
14
|
+
sig { returns(T.nilable(Telnyx::MessagingMessagingProfile)) }
|
|
15
15
|
attr_reader :data
|
|
16
16
|
|
|
17
|
-
sig { params(data: Telnyx::
|
|
17
|
+
sig { params(data: Telnyx::MessagingMessagingProfile::OrHash).void }
|
|
18
18
|
attr_writer :data
|
|
19
19
|
|
|
20
20
|
sig do
|
|
21
|
-
params(data: Telnyx::
|
|
21
|
+
params(data: Telnyx::MessagingMessagingProfile::OrHash).returns(
|
|
22
|
+
T.attached_class
|
|
23
|
+
)
|
|
22
24
|
end
|
|
23
25
|
def self.new(data: nil)
|
|
24
26
|
end
|
|
25
27
|
|
|
26
|
-
sig { override.returns({ data: Telnyx::
|
|
28
|
+
sig { override.returns({ data: Telnyx::MessagingMessagingProfile }) }
|
|
27
29
|
def to_hash
|
|
28
30
|
end
|
|
29
31
|
end
|
|
@@ -88,6 +88,25 @@ module Telnyx
|
|
|
88
88
|
end
|
|
89
89
|
attr_writer :number_pool_settings
|
|
90
90
|
|
|
91
|
+
# Set to true to enable message content redaction on this profile, or false to
|
|
92
|
+
# disable it. Ignored if the organization is not on the redaction allowlist. See
|
|
93
|
+
# the [Message Redaction guide](/docs/messaging/messages/message-redaction) for
|
|
94
|
+
# what is redacted.
|
|
95
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
96
|
+
attr_reader :redaction_enabled
|
|
97
|
+
|
|
98
|
+
sig { params(redaction_enabled: T::Boolean).void }
|
|
99
|
+
attr_writer :redaction_enabled
|
|
100
|
+
|
|
101
|
+
# The redaction level to apply when redaction is enabled. 1: redact message
|
|
102
|
+
# records and reporting only. 2 (default): also redact inbound webhook payloads.
|
|
103
|
+
# See the [Message Redaction guide](/docs/messaging/messages/message-redaction).
|
|
104
|
+
sig { returns(T.nilable(Integer)) }
|
|
105
|
+
attr_reader :redaction_level
|
|
106
|
+
|
|
107
|
+
sig { params(redaction_level: Integer).void }
|
|
108
|
+
attr_writer :redaction_level
|
|
109
|
+
|
|
91
110
|
# Enables automatic character encoding optimization for SMS messages. When
|
|
92
111
|
# enabled, the system automatically selects the most efficient encoding (GSM-7 or
|
|
93
112
|
# UCS-2) based on message content to maximize character limits and minimize costs.
|
|
@@ -174,6 +193,8 @@ module Telnyx
|
|
|
174
193
|
mobile_only: T::Boolean,
|
|
175
194
|
name: String,
|
|
176
195
|
number_pool_settings: T.nilable(Telnyx::NumberPoolSettings::OrHash),
|
|
196
|
+
redaction_enabled: T::Boolean,
|
|
197
|
+
redaction_level: Integer,
|
|
177
198
|
smart_encoding: T::Boolean,
|
|
178
199
|
url_shortener_settings:
|
|
179
200
|
T.nilable(Telnyx::URLShortenerSettings::OrHash),
|
|
@@ -214,6 +235,15 @@ module Telnyx
|
|
|
214
235
|
#
|
|
215
236
|
# To disable this feature, set the object field to `null`.
|
|
216
237
|
number_pool_settings: nil,
|
|
238
|
+
# Set to true to enable message content redaction on this profile, or false to
|
|
239
|
+
# disable it. Ignored if the organization is not on the redaction allowlist. See
|
|
240
|
+
# the [Message Redaction guide](/docs/messaging/messages/message-redaction) for
|
|
241
|
+
# what is redacted.
|
|
242
|
+
redaction_enabled: nil,
|
|
243
|
+
# The redaction level to apply when redaction is enabled. 1: redact message
|
|
244
|
+
# records and reporting only. 2 (default): also redact inbound webhook payloads.
|
|
245
|
+
# See the [Message Redaction guide](/docs/messaging/messages/message-redaction).
|
|
246
|
+
redaction_level: nil,
|
|
217
247
|
# Enables automatic character encoding optimization for SMS messages. When
|
|
218
248
|
# enabled, the system automatically selects the most efficient encoding (GSM-7 or
|
|
219
249
|
# UCS-2) based on message content to maximize character limits and minimize costs.
|
|
@@ -260,6 +290,8 @@ module Telnyx
|
|
|
260
290
|
mobile_only: T::Boolean,
|
|
261
291
|
name: String,
|
|
262
292
|
number_pool_settings: T.nilable(Telnyx::NumberPoolSettings),
|
|
293
|
+
redaction_enabled: T::Boolean,
|
|
294
|
+
redaction_level: Integer,
|
|
263
295
|
smart_encoding: T::Boolean,
|
|
264
296
|
url_shortener_settings: T.nilable(Telnyx::URLShortenerSettings),
|
|
265
297
|
v1_secret: String,
|
|
@@ -11,19 +11,21 @@ module Telnyx
|
|
|
11
11
|
)
|
|
12
12
|
end
|
|
13
13
|
|
|
14
|
-
sig { returns(T.nilable(Telnyx::
|
|
14
|
+
sig { returns(T.nilable(Telnyx::MessagingMessagingProfile)) }
|
|
15
15
|
attr_reader :data
|
|
16
16
|
|
|
17
|
-
sig { params(data: Telnyx::
|
|
17
|
+
sig { params(data: Telnyx::MessagingMessagingProfile::OrHash).void }
|
|
18
18
|
attr_writer :data
|
|
19
19
|
|
|
20
20
|
sig do
|
|
21
|
-
params(data: Telnyx::
|
|
21
|
+
params(data: Telnyx::MessagingMessagingProfile::OrHash).returns(
|
|
22
|
+
T.attached_class
|
|
23
|
+
)
|
|
22
24
|
end
|
|
23
25
|
def self.new(data: nil)
|
|
24
26
|
end
|
|
25
27
|
|
|
26
|
-
sig { override.returns({ data: Telnyx::
|
|
28
|
+
sig { override.returns({ data: Telnyx::MessagingMessagingProfile }) }
|
|
27
29
|
def to_hash
|
|
28
30
|
end
|
|
29
31
|
end
|
|
@@ -12,21 +12,21 @@ module Telnyx
|
|
|
12
12
|
)
|
|
13
13
|
end
|
|
14
14
|
|
|
15
|
-
sig { returns(T.nilable(Telnyx::
|
|
15
|
+
sig { returns(T.nilable(Telnyx::MessagingMessagingProfile)) }
|
|
16
16
|
attr_reader :data
|
|
17
17
|
|
|
18
|
-
sig { params(data: Telnyx::
|
|
18
|
+
sig { params(data: Telnyx::MessagingMessagingProfile::OrHash).void }
|
|
19
19
|
attr_writer :data
|
|
20
20
|
|
|
21
21
|
sig do
|
|
22
|
-
params(data: Telnyx::
|
|
22
|
+
params(data: Telnyx::MessagingMessagingProfile::OrHash).returns(
|
|
23
23
|
T.attached_class
|
|
24
24
|
)
|
|
25
25
|
end
|
|
26
26
|
def self.new(data: nil)
|
|
27
27
|
end
|
|
28
28
|
|
|
29
|
-
sig { override.returns({ data: Telnyx::
|
|
29
|
+
sig { override.returns({ data: Telnyx::MessagingMessagingProfile }) }
|
|
30
30
|
def to_hash
|
|
31
31
|
end
|
|
32
32
|
end
|
data/rbi/telnyx/models.rbi
CHANGED
|
@@ -1254,6 +1254,8 @@ module Telnyx
|
|
|
1254
1254
|
MessagingInboundMessagePayload =
|
|
1255
1255
|
Telnyx::Models::MessagingInboundMessagePayload
|
|
1256
1256
|
|
|
1257
|
+
MessagingMessagingProfile = Telnyx::Models::MessagingMessagingProfile
|
|
1258
|
+
|
|
1257
1259
|
MessagingMetricsTimeFrame = Telnyx::Models::MessagingMetricsTimeFrame
|
|
1258
1260
|
|
|
1259
1261
|
MessagingNumbersBulkUpdateCreateParams =
|