telnyx 5.80.0 → 5.82.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 +16 -0
- data/README.md +1 -1
- data/lib/telnyx/models/hosted_number_order_event_webhook_event.rb +256 -0
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +3 -1
- data/lib/telnyx/models/unwrap_webhook_event.rb +3 -1
- data/lib/telnyx/models/verify_profile.rb +87 -1
- data/lib/telnyx/models/verify_profile_create_params.rb +25 -10
- data/lib/telnyx/models/verify_profile_update_params.rb +25 -10
- data/lib/telnyx/models.rb +2 -0
- data/lib/telnyx/resources/webhooks.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +1 -0
- data/rbi/telnyx/models/hosted_number_order_event_webhook_event.rbi +697 -0
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +1 -0
- data/rbi/telnyx/models/unwrap_webhook_event.rbi +1 -0
- data/rbi/telnyx/models/verify_profile.rbi +131 -3
- data/rbi/telnyx/models/verify_profile_create_params.rbi +24 -13
- data/rbi/telnyx/models/verify_profile_update_params.rbi +24 -13
- data/rbi/telnyx/models.rbi +3 -0
- data/rbi/telnyx/resources/webhooks.rbi +2 -0
- data/sig/telnyx/models/hosted_number_order_event_webhook_event.rbs +281 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +1 -0
- data/sig/telnyx/models/unwrap_webhook_event.rbs +1 -0
- data/sig/telnyx/models/verify_profile.rbs +74 -3
- data/sig/telnyx/models/verify_profile_create_params.rbs +15 -7
- data/sig/telnyx/models/verify_profile_update_params.rbs +15 -7
- data/sig/telnyx/models.rbs +2 -0
- data/sig/telnyx/resources/webhooks.rbs +2 -0
- metadata +5 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 86dd19a54da99721d7ba89203195968a2078948f620f40ad94d2cc65f3e70529
|
|
4
|
+
data.tar.gz: 160bbed7d53c401607159acbb5f4214915632653c3fb251e085cbb9911e36331
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 80f96b099e224c16ca297255a8627901bcf4b47cbbc731a8a0f64b995c4206744e27ddd7c65617058f0bd64b925d85fbde45053db4f21e130c93a0ced44cf256
|
|
7
|
+
data.tar.gz: 5211feb2ce70e880ea9dee6dac47cf6ef7f4b041721ab30f87cdbc2af0f274bd9e8671ec2ca5e69945111386b7d59b8adcd0ac34d9653a92ff96a1e331d8cf4b
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 5.82.0 (2026-04-22)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v5.81.0...v5.82.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.81.0...v5.82.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* MSG-6857: ([3064039](https://github.com/team-telnyx/telnyx-ruby/commit/30640396eb21360151f93dc6d84a4ba9730a7bfe))
|
|
10
|
+
|
|
11
|
+
## 5.81.0 (2026-04-22)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v5.80.0...v5.81.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.80.0...v5.81.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* MSG-6841: add missing whatsapp api docs ([be4e44d](https://github.com/team-telnyx/telnyx-ruby/commit/be4e44d5fa6813033cc2c93ba6ef5b3483d86717))
|
|
18
|
+
|
|
3
19
|
## 5.80.0 (2026-04-21)
|
|
4
20
|
|
|
5
21
|
Full Changelog: [v5.79.0...v5.80.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.79.0...v5.80.0)
|
data/README.md
CHANGED
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class HostedNumberOrderEventWebhookEvent < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute data
|
|
7
|
+
#
|
|
8
|
+
# @return [Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data, nil]
|
|
9
|
+
optional :data, -> { Telnyx::HostedNumberOrderEventWebhookEvent::Data }
|
|
10
|
+
|
|
11
|
+
# @!method initialize(data: nil)
|
|
12
|
+
# @param data [Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data]
|
|
13
|
+
|
|
14
|
+
# @see Telnyx::Models::HostedNumberOrderEventWebhookEvent#data
|
|
15
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
16
|
+
# @!attribute id
|
|
17
|
+
# Unique identifier for the event.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :id, String
|
|
21
|
+
|
|
22
|
+
# @!attribute event_type
|
|
23
|
+
# The type of event being delivered. Internal transfer events are only emitted for
|
|
24
|
+
# orders where the numbers are already active on another Telnyx account.
|
|
25
|
+
#
|
|
26
|
+
# @return [Symbol, Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::EventType, nil]
|
|
27
|
+
optional :event_type, enum: -> { Telnyx::HostedNumberOrderEventWebhookEvent::Data::EventType }
|
|
28
|
+
|
|
29
|
+
# @!attribute occurred_at
|
|
30
|
+
# ISO 8601 formatted date indicating when the event was generated.
|
|
31
|
+
#
|
|
32
|
+
# @return [Time, nil]
|
|
33
|
+
optional :occurred_at, Time
|
|
34
|
+
|
|
35
|
+
# @!attribute payload
|
|
36
|
+
# Payload delivered with every messaging*hosted_numbers_orders.\* event.
|
|
37
|
+
# `approval_deadline` and `decision` are meaningful only for
|
|
38
|
+
# `internal_transfer*\*` events.
|
|
39
|
+
#
|
|
40
|
+
# @return [Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload, nil]
|
|
41
|
+
optional :payload, -> { Telnyx::HostedNumberOrderEventWebhookEvent::Data::Payload }
|
|
42
|
+
|
|
43
|
+
# @!attribute record_type
|
|
44
|
+
# Identifies the type of the resource.
|
|
45
|
+
#
|
|
46
|
+
# @return [Symbol, Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::RecordType, nil]
|
|
47
|
+
optional :record_type, enum: -> { Telnyx::HostedNumberOrderEventWebhookEvent::Data::RecordType }
|
|
48
|
+
|
|
49
|
+
# @!method initialize(id: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
|
|
50
|
+
# Some parameter documentations has been truncated, see
|
|
51
|
+
# {Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data} for more details.
|
|
52
|
+
#
|
|
53
|
+
# @param id [String] Unique identifier for the event.
|
|
54
|
+
#
|
|
55
|
+
# @param event_type [Symbol, Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::EventType] The type of event being delivered. Internal transfer events are only emitted for
|
|
56
|
+
#
|
|
57
|
+
# @param occurred_at [Time] ISO 8601 formatted date indicating when the event was generated.
|
|
58
|
+
#
|
|
59
|
+
# @param payload [Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload] Payload delivered with every messaging*hosted_numbers_orders.\* event.
|
|
60
|
+
# `approval*
|
|
61
|
+
#
|
|
62
|
+
# @param record_type [Symbol, Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::RecordType] Identifies the type of the resource.
|
|
63
|
+
|
|
64
|
+
# The type of event being delivered. Internal transfer events are only emitted for
|
|
65
|
+
# orders where the numbers are already active on another Telnyx account.
|
|
66
|
+
#
|
|
67
|
+
# @see Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data#event_type
|
|
68
|
+
module EventType
|
|
69
|
+
extend Telnyx::Internal::Type::Enum
|
|
70
|
+
|
|
71
|
+
MESSAGING_HOSTED_NUMBERS_ORDERS_CREATED = :"messaging_hosted_numbers_orders.created"
|
|
72
|
+
MESSAGING_HOSTED_NUMBERS_ORDERS_UPDATED = :"messaging_hosted_numbers_orders.updated"
|
|
73
|
+
MESSAGING_HOSTED_NUMBERS_ORDERS_DELETED = :"messaging_hosted_numbers_orders.deleted"
|
|
74
|
+
MESSAGING_HOSTED_NUMBERS_ORDERS_INTERNAL_TRANSFER_DETECTED =
|
|
75
|
+
:"messaging_hosted_numbers_orders.internal_transfer_detected"
|
|
76
|
+
MESSAGING_HOSTED_NUMBERS_ORDERS_INTERNAL_TRANSFER_APPROVAL_REQUESTED =
|
|
77
|
+
:"messaging_hosted_numbers_orders.internal_transfer_approval_requested"
|
|
78
|
+
MESSAGING_HOSTED_NUMBERS_ORDERS_INTERNAL_TRANSFER_APPROVED =
|
|
79
|
+
:"messaging_hosted_numbers_orders.internal_transfer_approved"
|
|
80
|
+
MESSAGING_HOSTED_NUMBERS_ORDERS_INTERNAL_TRANSFER_REJECTED =
|
|
81
|
+
:"messaging_hosted_numbers_orders.internal_transfer_rejected"
|
|
82
|
+
MESSAGING_HOSTED_NUMBERS_ORDERS_INTERNAL_TRANSFER_AUTO_APPROVED =
|
|
83
|
+
:"messaging_hosted_numbers_orders.internal_transfer_auto_approved"
|
|
84
|
+
|
|
85
|
+
# @!method self.values
|
|
86
|
+
# @return [Array<Symbol>]
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# @see Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data#payload
|
|
90
|
+
class Payload < Telnyx::Internal::Type::BaseModel
|
|
91
|
+
# @!attribute approval_deadline
|
|
92
|
+
# Unix timestamp (seconds) by which the losing organization must respond before
|
|
93
|
+
# auto-approval. Populated on internal-transfer events once an approval window has
|
|
94
|
+
# been issued.
|
|
95
|
+
#
|
|
96
|
+
# @return [Integer, nil]
|
|
97
|
+
optional :approval_deadline, Integer, nil?: true
|
|
98
|
+
|
|
99
|
+
# @!attribute decision
|
|
100
|
+
# Approval decision for the internal transfer. Defaults to `pending` for
|
|
101
|
+
# non-internal-transfer events.
|
|
102
|
+
#
|
|
103
|
+
# @return [Symbol, Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload::Decision, nil]
|
|
104
|
+
optional :decision, enum: -> { Telnyx::HostedNumberOrderEventWebhookEvent::Data::Payload::Decision }
|
|
105
|
+
|
|
106
|
+
# @!attribute numbers
|
|
107
|
+
#
|
|
108
|
+
# @return [Array<Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload::Number>, nil]
|
|
109
|
+
optional :numbers,
|
|
110
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::HostedNumberOrderEventWebhookEvent::Data::Payload::Number] }
|
|
111
|
+
|
|
112
|
+
# @!attribute order_id
|
|
113
|
+
# The ID of the hosted number order.
|
|
114
|
+
#
|
|
115
|
+
# @return [String, nil]
|
|
116
|
+
optional :order_id, String
|
|
117
|
+
|
|
118
|
+
# @!attribute order_status
|
|
119
|
+
# Current status of the order.
|
|
120
|
+
#
|
|
121
|
+
# @return [Symbol, Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload::OrderStatus, nil]
|
|
122
|
+
optional :order_status,
|
|
123
|
+
enum: -> { Telnyx::HostedNumberOrderEventWebhookEvent::Data::Payload::OrderStatus }
|
|
124
|
+
|
|
125
|
+
# @!attribute profile_id
|
|
126
|
+
# The messaging profile associated with the order.
|
|
127
|
+
#
|
|
128
|
+
# @return [String, nil]
|
|
129
|
+
optional :profile_id, String
|
|
130
|
+
|
|
131
|
+
# @!attribute user_id
|
|
132
|
+
# The organization that owns the order.
|
|
133
|
+
#
|
|
134
|
+
# @return [String, nil]
|
|
135
|
+
optional :user_id, String
|
|
136
|
+
|
|
137
|
+
# @!method initialize(approval_deadline: nil, decision: nil, numbers: nil, order_id: nil, order_status: nil, profile_id: nil, user_id: nil)
|
|
138
|
+
# Some parameter documentations has been truncated, see
|
|
139
|
+
# {Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload} for more
|
|
140
|
+
# details.
|
|
141
|
+
#
|
|
142
|
+
# Payload delivered with every messaging*hosted_numbers_orders.\* event.
|
|
143
|
+
# `approval_deadline` and `decision` are meaningful only for
|
|
144
|
+
# `internal_transfer*\*` events.
|
|
145
|
+
#
|
|
146
|
+
# @param approval_deadline [Integer, nil] Unix timestamp (seconds) by which the losing organization must respond before au
|
|
147
|
+
#
|
|
148
|
+
# @param decision [Symbol, Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload::Decision] Approval decision for the internal transfer. Defaults to `pending` for non-inter
|
|
149
|
+
#
|
|
150
|
+
# @param numbers [Array<Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload::Number>]
|
|
151
|
+
#
|
|
152
|
+
# @param order_id [String] The ID of the hosted number order.
|
|
153
|
+
#
|
|
154
|
+
# @param order_status [Symbol, Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload::OrderStatus] Current status of the order.
|
|
155
|
+
#
|
|
156
|
+
# @param profile_id [String] The messaging profile associated with the order.
|
|
157
|
+
#
|
|
158
|
+
# @param user_id [String] The organization that owns the order.
|
|
159
|
+
|
|
160
|
+
# Approval decision for the internal transfer. Defaults to `pending` for
|
|
161
|
+
# non-internal-transfer events.
|
|
162
|
+
#
|
|
163
|
+
# @see Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload#decision
|
|
164
|
+
module Decision
|
|
165
|
+
extend Telnyx::Internal::Type::Enum
|
|
166
|
+
|
|
167
|
+
PENDING = :pending
|
|
168
|
+
APPROVED = :approved
|
|
169
|
+
REJECTED = :rejected
|
|
170
|
+
|
|
171
|
+
# @!method self.values
|
|
172
|
+
# @return [Array<Symbol>]
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
class Number < Telnyx::Internal::Type::BaseModel
|
|
176
|
+
# @!attribute status
|
|
177
|
+
# Current status of this phone number within the order.
|
|
178
|
+
#
|
|
179
|
+
# @return [Symbol, Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload::Number::Status, nil]
|
|
180
|
+
optional :status, enum: -> { Telnyx::HostedNumberOrderEventWebhookEvent::Data::Payload::Number::Status }
|
|
181
|
+
|
|
182
|
+
# @!attribute value
|
|
183
|
+
# Phone number in +E.164 format.
|
|
184
|
+
#
|
|
185
|
+
# @return [String, nil]
|
|
186
|
+
optional :value, String
|
|
187
|
+
|
|
188
|
+
# @!method initialize(status: nil, value: nil)
|
|
189
|
+
# @param status [Symbol, Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload::Number::Status] Current status of this phone number within the order.
|
|
190
|
+
#
|
|
191
|
+
# @param value [String] Phone number in +E.164 format.
|
|
192
|
+
|
|
193
|
+
# Current status of this phone number within the order.
|
|
194
|
+
#
|
|
195
|
+
# @see Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload::Number#status
|
|
196
|
+
module Status
|
|
197
|
+
extend Telnyx::Internal::Type::Enum
|
|
198
|
+
|
|
199
|
+
DELETED = :deleted
|
|
200
|
+
FAILED = :failed
|
|
201
|
+
FAILED_ACTIVATION = :failed_activation
|
|
202
|
+
FAILED_CARRIER_REJECTED = :failed_carrier_rejected
|
|
203
|
+
FAILED_INELIGIBLE_CARRIER = :failed_ineligible_carrier
|
|
204
|
+
FAILED_NUMBER_ALREADY_HOSTED = :failed_number_already_hosted
|
|
205
|
+
FAILED_NUMBER_NOT_FOUND = :failed_number_not_found
|
|
206
|
+
FAILED_OWNERSHIP_VERIFICATION = :failed_ownership_verification
|
|
207
|
+
FAILED_TIMEOUT = :failed_timeout
|
|
208
|
+
OWNERSHIP_SUCCESSFUL = :ownership_successful
|
|
209
|
+
PENDING = :pending
|
|
210
|
+
PROVISIONING = :provisioning
|
|
211
|
+
SUCCESSFUL = :successful
|
|
212
|
+
|
|
213
|
+
# @!method self.values
|
|
214
|
+
# @return [Array<Symbol>]
|
|
215
|
+
end
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
# Current status of the order.
|
|
219
|
+
#
|
|
220
|
+
# @see Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data::Payload#order_status
|
|
221
|
+
module OrderStatus
|
|
222
|
+
extend Telnyx::Internal::Type::Enum
|
|
223
|
+
|
|
224
|
+
PENDING = :pending
|
|
225
|
+
PROVISIONING = :provisioning
|
|
226
|
+
SUCCESSFUL = :successful
|
|
227
|
+
FAILED = :failed
|
|
228
|
+
DELETED = :deleted
|
|
229
|
+
CARRIER_REJECTED = :carrier_rejected
|
|
230
|
+
COMPLIANCE_REVIEW_FAILED = :compliance_review_failed
|
|
231
|
+
INCOMPLETE_DOCUMENTATION = :incomplete_documentation
|
|
232
|
+
INCORRECT_BILLING_INFORMATION = :incorrect_billing_information
|
|
233
|
+
INELIGIBLE_CARRIER = :ineligible_carrier
|
|
234
|
+
LOA_FILE_INVALID = :loa_file_invalid
|
|
235
|
+
LOA_FILE_SUCCESSFUL = :loa_file_successful
|
|
236
|
+
|
|
237
|
+
# @!method self.values
|
|
238
|
+
# @return [Array<Symbol>]
|
|
239
|
+
end
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
# Identifies the type of the resource.
|
|
243
|
+
#
|
|
244
|
+
# @see Telnyx::Models::HostedNumberOrderEventWebhookEvent::Data#record_type
|
|
245
|
+
module RecordType
|
|
246
|
+
extend Telnyx::Internal::Type::Enum
|
|
247
|
+
|
|
248
|
+
EVENT = :event
|
|
249
|
+
|
|
250
|
+
# @!method self.values
|
|
251
|
+
# @return [Array<Symbol>]
|
|
252
|
+
end
|
|
253
|
+
end
|
|
254
|
+
end
|
|
255
|
+
end
|
|
256
|
+
end
|
|
@@ -123,6 +123,8 @@ module Telnyx
|
|
|
123
123
|
|
|
124
124
|
variant -> { Telnyx::FaxSendingStarted }
|
|
125
125
|
|
|
126
|
+
variant -> { Telnyx::HostedNumberOrderEventWebhookEvent }
|
|
127
|
+
|
|
126
128
|
variant -> { Telnyx::InboundMessageWebhookEvent }
|
|
127
129
|
|
|
128
130
|
variant -> { Telnyx::NumberOrderStatusUpdate }
|
|
@@ -132,7 +134,7 @@ module Telnyx
|
|
|
132
134
|
variant -> { Telnyx::TranscriptionWebhookEvent }
|
|
133
135
|
|
|
134
136
|
# @!method self.variants
|
|
135
|
-
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
137
|
+
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
136
138
|
end
|
|
137
139
|
end
|
|
138
140
|
end
|
|
@@ -123,6 +123,8 @@ module Telnyx
|
|
|
123
123
|
|
|
124
124
|
variant -> { Telnyx::FaxSendingStarted }
|
|
125
125
|
|
|
126
|
+
variant -> { Telnyx::HostedNumberOrderEventWebhookEvent }
|
|
127
|
+
|
|
126
128
|
variant -> { Telnyx::InboundMessageWebhookEvent }
|
|
127
129
|
|
|
128
130
|
variant -> { Telnyx::NumberOrderStatusUpdate }
|
|
@@ -132,7 +134,7 @@ module Telnyx
|
|
|
132
134
|
variant -> { Telnyx::TranscriptionWebhookEvent }
|
|
133
135
|
|
|
134
136
|
# @!method self.variants
|
|
135
|
-
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
137
|
+
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
136
138
|
end
|
|
137
139
|
end
|
|
138
140
|
end
|
|
@@ -65,7 +65,12 @@ module Telnyx
|
|
|
65
65
|
# @return [String, nil]
|
|
66
66
|
optional :webhook_url, String
|
|
67
67
|
|
|
68
|
-
# @!
|
|
68
|
+
# @!attribute whatsapp
|
|
69
|
+
#
|
|
70
|
+
# @return [Telnyx::Models::VerifyProfile::Whatsapp, nil]
|
|
71
|
+
optional :whatsapp, -> { Telnyx::VerifyProfile::Whatsapp }
|
|
72
|
+
|
|
73
|
+
# @!method initialize(id: nil, call: nil, created_at: nil, flashcall: nil, language: nil, name: nil, rcs: nil, record_type: nil, sms: nil, updated_at: nil, webhook_failover_url: nil, webhook_url: nil, whatsapp: nil)
|
|
69
74
|
# @param id [String]
|
|
70
75
|
#
|
|
71
76
|
# @param call [Telnyx::Models::VerifyProfile::Call]
|
|
@@ -89,6 +94,8 @@ module Telnyx
|
|
|
89
94
|
# @param webhook_failover_url [String]
|
|
90
95
|
#
|
|
91
96
|
# @param webhook_url [String]
|
|
97
|
+
#
|
|
98
|
+
# @param whatsapp [Telnyx::Models::VerifyProfile::Whatsapp]
|
|
92
99
|
|
|
93
100
|
# @see Telnyx::Models::VerifyProfile#call
|
|
94
101
|
class Call < Telnyx::Internal::Type::BaseModel
|
|
@@ -310,6 +317,85 @@ module Telnyx
|
|
|
310
317
|
#
|
|
311
318
|
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
312
319
|
end
|
|
320
|
+
|
|
321
|
+
# @see Telnyx::Models::VerifyProfile#whatsapp
|
|
322
|
+
class Whatsapp < Telnyx::Internal::Type::BaseModel
|
|
323
|
+
# @!attribute app_name
|
|
324
|
+
# The name that identifies the application requesting 2fa in the verification
|
|
325
|
+
# message.
|
|
326
|
+
#
|
|
327
|
+
# @return [String, nil]
|
|
328
|
+
optional :app_name, String
|
|
329
|
+
|
|
330
|
+
# @!attribute code_length
|
|
331
|
+
# The length of the verify code to generate.
|
|
332
|
+
#
|
|
333
|
+
# @return [Integer, nil]
|
|
334
|
+
optional :code_length, Integer
|
|
335
|
+
|
|
336
|
+
# @!attribute default_verification_timeout_secs
|
|
337
|
+
# For every request that is initiated via this Verify profile, this sets the
|
|
338
|
+
# number of seconds before a verification request code expires. Once the
|
|
339
|
+
# verification request expires, the user cannot use the code to verify their
|
|
340
|
+
# identity.
|
|
341
|
+
#
|
|
342
|
+
# @return [Integer, nil]
|
|
343
|
+
optional :default_verification_timeout_secs, Integer
|
|
344
|
+
|
|
345
|
+
# @!attribute messaging_template_id
|
|
346
|
+
# The message template identifier selected from /verify_profiles/templates
|
|
347
|
+
#
|
|
348
|
+
# @return [String, nil]
|
|
349
|
+
optional :messaging_template_id, String
|
|
350
|
+
|
|
351
|
+
# @!attribute sender_phone_number
|
|
352
|
+
# Phone number registered on the customer WABA to send OTPs from
|
|
353
|
+
#
|
|
354
|
+
# @return [String, nil]
|
|
355
|
+
optional :sender_phone_number, String, nil?: true
|
|
356
|
+
|
|
357
|
+
# @!attribute template_id
|
|
358
|
+
# Customer pre-approved authentication template name registered on Meta
|
|
359
|
+
#
|
|
360
|
+
# @return [String, nil]
|
|
361
|
+
optional :template_id, String, nil?: true
|
|
362
|
+
|
|
363
|
+
# @!attribute waba_id
|
|
364
|
+
# Customer Meta WABA ID for Bring-Your-Own-WABA sending
|
|
365
|
+
#
|
|
366
|
+
# @return [String, nil]
|
|
367
|
+
optional :waba_id, String, nil?: true
|
|
368
|
+
|
|
369
|
+
# @!attribute whitelisted_destinations
|
|
370
|
+
# Enabled country destinations to send verification codes. The elements in the
|
|
371
|
+
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
372
|
+
# destinations will be allowed. **Conditionally required:** this field must be
|
|
373
|
+
# provided when your organization is configured to require explicit whitelisted
|
|
374
|
+
# destinations; otherwise it is optional.
|
|
375
|
+
#
|
|
376
|
+
# @return [Array<String>, nil]
|
|
377
|
+
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
378
|
+
|
|
379
|
+
# @!method initialize(app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, sender_phone_number: nil, template_id: nil, waba_id: nil, whitelisted_destinations: nil)
|
|
380
|
+
# Some parameter documentations has been truncated, see
|
|
381
|
+
# {Telnyx::Models::VerifyProfile::Whatsapp} for more details.
|
|
382
|
+
#
|
|
383
|
+
# @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
|
|
384
|
+
#
|
|
385
|
+
# @param code_length [Integer] The length of the verify code to generate.
|
|
386
|
+
#
|
|
387
|
+
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
388
|
+
#
|
|
389
|
+
# @param messaging_template_id [String] The message template identifier selected from /verify_profiles/templates
|
|
390
|
+
#
|
|
391
|
+
# @param sender_phone_number [String, nil] Phone number registered on the customer WABA to send OTPs from
|
|
392
|
+
#
|
|
393
|
+
# @param template_id [String, nil] Customer pre-approved authentication template name registered on Meta
|
|
394
|
+
#
|
|
395
|
+
# @param waba_id [String, nil] Customer Meta WABA ID for Bring-Your-Own-WABA sending
|
|
396
|
+
#
|
|
397
|
+
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
398
|
+
end
|
|
313
399
|
end
|
|
314
400
|
end
|
|
315
401
|
end
|
|
@@ -282,13 +282,6 @@ module Telnyx
|
|
|
282
282
|
end
|
|
283
283
|
|
|
284
284
|
class Whatsapp < Telnyx::Internal::Type::BaseModel
|
|
285
|
-
# @!attribute app_name
|
|
286
|
-
# The name that identifies the application requesting 2fa in the verification
|
|
287
|
-
# message.
|
|
288
|
-
#
|
|
289
|
-
# @return [String, nil]
|
|
290
|
-
optional :app_name, String
|
|
291
|
-
|
|
292
285
|
# @!attribute default_verification_timeout_secs
|
|
293
286
|
# For every request that is initiated via this Verify profile, this sets the
|
|
294
287
|
# number of seconds before a verification request code expires. Once the
|
|
@@ -298,6 +291,24 @@ module Telnyx
|
|
|
298
291
|
# @return [Integer, nil]
|
|
299
292
|
optional :default_verification_timeout_secs, Integer
|
|
300
293
|
|
|
294
|
+
# @!attribute sender_phone_number
|
|
295
|
+
# Phone number registered on the customer WABA to send OTPs from
|
|
296
|
+
#
|
|
297
|
+
# @return [String, nil]
|
|
298
|
+
optional :sender_phone_number, String, nil?: true
|
|
299
|
+
|
|
300
|
+
# @!attribute template_id
|
|
301
|
+
# Customer pre-approved authentication template name registered on Meta
|
|
302
|
+
#
|
|
303
|
+
# @return [String, nil]
|
|
304
|
+
optional :template_id, String, nil?: true
|
|
305
|
+
|
|
306
|
+
# @!attribute waba_id
|
|
307
|
+
# Customer Meta WABA ID for Bring-Your-Own-WABA sending
|
|
308
|
+
#
|
|
309
|
+
# @return [String, nil]
|
|
310
|
+
optional :waba_id, String, nil?: true
|
|
311
|
+
|
|
301
312
|
# @!attribute whitelisted_destinations
|
|
302
313
|
# Enabled country destinations to send verification codes. The elements in the
|
|
303
314
|
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
@@ -308,14 +319,18 @@ module Telnyx
|
|
|
308
319
|
# @return [Array<String>, nil]
|
|
309
320
|
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
310
321
|
|
|
311
|
-
# @!method initialize(
|
|
322
|
+
# @!method initialize(default_verification_timeout_secs: nil, sender_phone_number: nil, template_id: nil, waba_id: nil, whitelisted_destinations: nil)
|
|
312
323
|
# Some parameter documentations has been truncated, see
|
|
313
324
|
# {Telnyx::Models::VerifyProfileCreateParams::Whatsapp} for more details.
|
|
314
325
|
#
|
|
315
|
-
# @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
|
|
316
|
-
#
|
|
317
326
|
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
318
327
|
#
|
|
328
|
+
# @param sender_phone_number [String, nil] Phone number registered on the customer WABA to send OTPs from
|
|
329
|
+
#
|
|
330
|
+
# @param template_id [String, nil] Customer pre-approved authentication template name registered on Meta
|
|
331
|
+
#
|
|
332
|
+
# @param waba_id [String, nil] Customer Meta WABA ID for Bring-Your-Own-WABA sending
|
|
333
|
+
#
|
|
319
334
|
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
320
335
|
end
|
|
321
336
|
end
|
|
@@ -288,13 +288,6 @@ module Telnyx
|
|
|
288
288
|
end
|
|
289
289
|
|
|
290
290
|
class Whatsapp < Telnyx::Internal::Type::BaseModel
|
|
291
|
-
# @!attribute app_name
|
|
292
|
-
# The name that identifies the application requesting 2fa in the verification
|
|
293
|
-
# message.
|
|
294
|
-
#
|
|
295
|
-
# @return [String, nil]
|
|
296
|
-
optional :app_name, String
|
|
297
|
-
|
|
298
291
|
# @!attribute default_verification_timeout_secs
|
|
299
292
|
# For every request that is initiated via this Verify profile, this sets the
|
|
300
293
|
# number of seconds before a verification request code expires. Once the
|
|
@@ -304,6 +297,24 @@ module Telnyx
|
|
|
304
297
|
# @return [Integer, nil]
|
|
305
298
|
optional :default_verification_timeout_secs, Integer
|
|
306
299
|
|
|
300
|
+
# @!attribute sender_phone_number
|
|
301
|
+
# Phone number registered on the customer WABA to send OTPs from
|
|
302
|
+
#
|
|
303
|
+
# @return [String, nil]
|
|
304
|
+
optional :sender_phone_number, String, nil?: true
|
|
305
|
+
|
|
306
|
+
# @!attribute template_id
|
|
307
|
+
# Customer pre-approved authentication template name registered on Meta
|
|
308
|
+
#
|
|
309
|
+
# @return [String, nil]
|
|
310
|
+
optional :template_id, String, nil?: true
|
|
311
|
+
|
|
312
|
+
# @!attribute waba_id
|
|
313
|
+
# Customer Meta WABA ID for Bring-Your-Own-WABA sending
|
|
314
|
+
#
|
|
315
|
+
# @return [String, nil]
|
|
316
|
+
optional :waba_id, String, nil?: true
|
|
317
|
+
|
|
307
318
|
# @!attribute whitelisted_destinations
|
|
308
319
|
# Enabled country destinations to send verification codes. The elements in the
|
|
309
320
|
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
@@ -314,14 +325,18 @@ module Telnyx
|
|
|
314
325
|
# @return [Array<String>, nil]
|
|
315
326
|
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
316
327
|
|
|
317
|
-
# @!method initialize(
|
|
328
|
+
# @!method initialize(default_verification_timeout_secs: nil, sender_phone_number: nil, template_id: nil, waba_id: nil, whitelisted_destinations: nil)
|
|
318
329
|
# Some parameter documentations has been truncated, see
|
|
319
330
|
# {Telnyx::Models::VerifyProfileUpdateParams::Whatsapp} for more details.
|
|
320
331
|
#
|
|
321
|
-
# @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
|
|
322
|
-
#
|
|
323
332
|
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
324
333
|
#
|
|
334
|
+
# @param sender_phone_number [String, nil] Phone number registered on the customer WABA to send OTPs from
|
|
335
|
+
#
|
|
336
|
+
# @param template_id [String, nil] Customer pre-approved authentication template name registered on Meta
|
|
337
|
+
#
|
|
338
|
+
# @param waba_id [String, nil] Customer Meta WABA ID for Bring-Your-Own-WABA sending
|
|
339
|
+
#
|
|
325
340
|
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
326
341
|
end
|
|
327
342
|
end
|
data/lib/telnyx/models.rb
CHANGED
|
@@ -708,6 +708,8 @@ module Telnyx
|
|
|
708
708
|
|
|
709
709
|
HostedNumber = Telnyx::Models::HostedNumber
|
|
710
710
|
|
|
711
|
+
HostedNumberOrderEventWebhookEvent = Telnyx::Models::HostedNumberOrderEventWebhookEvent
|
|
712
|
+
|
|
711
713
|
HTTP = Telnyx::Models::HTTP
|
|
712
714
|
|
|
713
715
|
InboundChannelListParams = Telnyx::Models::InboundChannelListParams
|
|
@@ -5,7 +5,7 @@ module Telnyx
|
|
|
5
5
|
class Webhooks
|
|
6
6
|
# @param payload [String] The raw webhook payload as a string
|
|
7
7
|
#
|
|
8
|
-
# @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
|
|
8
|
+
# @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
|
|
9
9
|
def unsafe_unwrap(payload)
|
|
10
10
|
parsed = JSON.parse(payload, symbolize_names: true)
|
|
11
11
|
Telnyx::Internal::Type::Converter.coerce(Telnyx::Models::UnsafeUnwrapWebhookEvent, parsed)
|
|
@@ -17,7 +17,7 @@ module Telnyx
|
|
|
17
17
|
#
|
|
18
18
|
# @param key [String, nil] The webhook signing key
|
|
19
19
|
#
|
|
20
|
-
# @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
|
|
20
|
+
# @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
|
|
21
21
|
def unwrap(payload, headers:, key: @client.public_key)
|
|
22
22
|
if key.nil?
|
|
23
23
|
raise ArgumentError.new("Cannot verify a webhook without a key on either the client's public_key or passed in as an argument")
|
data/lib/telnyx/version.rb
CHANGED