telnyx 5.117.0 → 5.119.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/ai/telephony_settings.rb +11 -1
- data/lib/telnyx/models/inbound_message_payload.rb +9 -1
- data/lib/telnyx/models/message_cancel_scheduled_response.rb +9 -1
- data/lib/telnyx/models/outbound_message_payload.rb +9 -1
- data/lib/telnyx/models/whatsapp/user_data_retrieve_params.rb +16 -0
- data/lib/telnyx/models/whatsapp/user_data_retrieve_response.rb +59 -0
- data/lib/telnyx/models/whatsapp/user_data_update_params.rb +32 -0
- data/lib/telnyx/models/whatsapp/user_data_update_response.rb +59 -0
- data/lib/telnyx/resources/whatsapp/user_data.rb +59 -0
- data/lib/telnyx/resources/whatsapp.rb +5 -0
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +5 -0
- data/rbi/telnyx/models/ai/telephony_settings.rbi +18 -3
- data/rbi/telnyx/models/inbound_message_payload.rbi +11 -0
- data/rbi/telnyx/models/message_cancel_scheduled_response.rbi +11 -0
- data/rbi/telnyx/models/outbound_message_payload.rbi +11 -0
- data/rbi/telnyx/models/whatsapp/user_data_retrieve_params.rbi +32 -0
- data/rbi/telnyx/models/whatsapp/user_data_retrieve_response.rbi +125 -0
- data/rbi/telnyx/models/whatsapp/user_data_update_params.rbi +62 -0
- data/rbi/telnyx/models/whatsapp/user_data_update_response.rbi +123 -0
- data/rbi/telnyx/resources/whatsapp/user_data.rbi +41 -0
- data/rbi/telnyx/resources/whatsapp.rbi +4 -0
- data/sig/telnyx/models/ai/telephony_settings.rbs +10 -3
- data/sig/telnyx/models/inbound_message_payload.rbs +7 -0
- data/sig/telnyx/models/message_cancel_scheduled_response.rbs +7 -0
- data/sig/telnyx/models/outbound_message_payload.rbs +7 -0
- data/sig/telnyx/models/whatsapp/user_data_retrieve_params.rbs +17 -0
- data/sig/telnyx/models/whatsapp/user_data_retrieve_response.rbs +71 -0
- data/sig/telnyx/models/whatsapp/user_data_update_params.rbs +34 -0
- data/sig/telnyx/models/whatsapp/user_data_update_response.rbs +71 -0
- data/sig/telnyx/resources/whatsapp/user_data.rbs +19 -0
- data/sig/telnyx/resources/whatsapp.rbs +2 -0
- metadata +17 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 761de105b75002e26702f001b26a3a303dbb5508212ae31d7a8ce66327de4341
|
|
4
|
+
data.tar.gz: 7e724082f9dac17156807c2929604d575323bfee456f5e89b7f64bff9dd006f7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d8723e3adc0361e81ed025d481cfa4849ca79dc48b54a9513eb6050bde61cbf8c3915321f30f2b8caea8b4408f4230498f2754ab886c3d783de19714132f2421
|
|
7
|
+
data.tar.gz: d1270643a834fa3b4ae308dd2a4a0ad38ad8d3a64a529ce3e5e9dbe1062e9f1fec989f84f0bc0a3a0817c60b039991c3df6638d12b15a4601f93f95c0f0de3c0
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 5.119.0 (2026-05-26)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v5.118.0...v5.119.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.118.0...v5.119.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* TELAPPS-523: document stop_on_conversation_end on assistant recording_settings ([f4731b7](https://github.com/team-telnyx/telnyx-ruby/commit/f4731b7ed76a54314a06c738fe2f3f10f3b5a9ac))
|
|
10
|
+
|
|
11
|
+
## 5.118.0 (2026-05-22)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v5.117.0...v5.118.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.117.0...v5.118.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* MSG-919: documentation for Whatsapp user data ([3683252](https://github.com/team-telnyx/telnyx-ruby/commit/36832521020009060f02d05e0fcb48b9c01cebfb))
|
|
18
|
+
|
|
3
19
|
## 5.117.0 (2026-05-22)
|
|
4
20
|
|
|
5
21
|
Full Changelog: [v5.116.0...v5.117.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.116.0...v5.117.0)
|
data/README.md
CHANGED
|
@@ -171,7 +171,15 @@ module Telnyx
|
|
|
171
171
|
enum: -> { Telnyx::AI::TelephonySettings::RecordingSettings::Format },
|
|
172
172
|
api_name: :format
|
|
173
173
|
|
|
174
|
-
# @!
|
|
174
|
+
# @!attribute stop_on_conversation_end
|
|
175
|
+
# When enabled, the call recording will stop when the conversation ends (for
|
|
176
|
+
# example, when the assistant hangs up or the call is transferred). When disabled,
|
|
177
|
+
# recording continues until the call itself ends.
|
|
178
|
+
#
|
|
179
|
+
# @return [Boolean, nil]
|
|
180
|
+
optional :stop_on_conversation_end, Telnyx::Internal::Type::Boolean
|
|
181
|
+
|
|
182
|
+
# @!method initialize(channels: nil, enabled: nil, file_format: nil, stop_on_conversation_end: nil)
|
|
175
183
|
# Some parameter documentations has been truncated, see
|
|
176
184
|
# {Telnyx::Models::AI::TelephonySettings::RecordingSettings} for more details.
|
|
177
185
|
#
|
|
@@ -182,6 +190,8 @@ module Telnyx
|
|
|
182
190
|
# @param enabled [Boolean] Whether call recording is enabled. When set to false, calls will not be recorded
|
|
183
191
|
#
|
|
184
192
|
# @param file_format [Symbol, Telnyx::Models::AI::TelephonySettings::RecordingSettings::Format] The format of the recording file.
|
|
193
|
+
#
|
|
194
|
+
# @param stop_on_conversation_end [Boolean] When enabled, the call recording will stop when the conversation ends (for examp
|
|
185
195
|
|
|
186
196
|
# The number of channels for the recording. 'single' for mono, 'dual' for stereo.
|
|
187
197
|
#
|
|
@@ -67,6 +67,12 @@ module Telnyx
|
|
|
67
67
|
# @return [String, nil]
|
|
68
68
|
optional :messaging_profile_id, String
|
|
69
69
|
|
|
70
|
+
# @!attribute num_chars
|
|
71
|
+
# The number of characters in the message text
|
|
72
|
+
#
|
|
73
|
+
# @return [Integer, nil]
|
|
74
|
+
optional :num_chars, Integer
|
|
75
|
+
|
|
70
76
|
# @!attribute organization_id
|
|
71
77
|
# Unique identifier for a messaging profile.
|
|
72
78
|
#
|
|
@@ -165,7 +171,7 @@ module Telnyx
|
|
|
165
171
|
# @return [String, nil]
|
|
166
172
|
optional :webhook_url, String, nil?: true
|
|
167
173
|
|
|
168
|
-
# @!method initialize(id: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
174
|
+
# @!method initialize(id: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
169
175
|
# Some parameter documentations has been truncated, see
|
|
170
176
|
# {Telnyx::Models::InboundMessagePayload} for more details.
|
|
171
177
|
#
|
|
@@ -191,6 +197,8 @@ module Telnyx
|
|
|
191
197
|
#
|
|
192
198
|
# @param messaging_profile_id [String] Unique identifier for a messaging profile.
|
|
193
199
|
#
|
|
200
|
+
# @param num_chars [Integer] The number of characters in the message text
|
|
201
|
+
#
|
|
194
202
|
# @param organization_id [String] Unique identifier for a messaging profile.
|
|
195
203
|
#
|
|
196
204
|
# @param parts [Integer] Number of parts into which the message's body must be split.
|
|
@@ -69,6 +69,12 @@ module Telnyx
|
|
|
69
69
|
# @return [String, nil]
|
|
70
70
|
optional :messaging_profile_id, String
|
|
71
71
|
|
|
72
|
+
# @!attribute num_chars
|
|
73
|
+
# The number of characters in the message text
|
|
74
|
+
#
|
|
75
|
+
# @return [Integer, nil]
|
|
76
|
+
optional :num_chars, Integer
|
|
77
|
+
|
|
72
78
|
# @!attribute organization_id
|
|
73
79
|
# The id of the organization the messaging profile belongs to.
|
|
74
80
|
#
|
|
@@ -178,7 +184,7 @@ module Telnyx
|
|
|
178
184
|
# @return [String, nil]
|
|
179
185
|
optional :webhook_url, String, nil?: true
|
|
180
186
|
|
|
181
|
-
# @!method initialize(id: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
187
|
+
# @!method initialize(id: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
182
188
|
# Some parameter documentations has been truncated, see
|
|
183
189
|
# {Telnyx::Models::MessageCancelScheduledResponse} for more details.
|
|
184
190
|
#
|
|
@@ -204,6 +210,8 @@ module Telnyx
|
|
|
204
210
|
#
|
|
205
211
|
# @param messaging_profile_id [String] Unique identifier for a messaging profile.
|
|
206
212
|
#
|
|
213
|
+
# @param num_chars [Integer] The number of characters in the message text
|
|
214
|
+
#
|
|
207
215
|
# @param organization_id [String] The id of the organization the messaging profile belongs to.
|
|
208
216
|
#
|
|
209
217
|
# @param parts [Integer] Number of parts into which the message's body must be split.
|
|
@@ -67,6 +67,12 @@ module Telnyx
|
|
|
67
67
|
# @return [String, nil]
|
|
68
68
|
optional :messaging_profile_id, String
|
|
69
69
|
|
|
70
|
+
# @!attribute num_chars
|
|
71
|
+
# The number of characters in the message text
|
|
72
|
+
#
|
|
73
|
+
# @return [Integer, nil]
|
|
74
|
+
optional :num_chars, Integer
|
|
75
|
+
|
|
70
76
|
# @!attribute organization_id
|
|
71
77
|
# The id of the organization the messaging profile belongs to.
|
|
72
78
|
#
|
|
@@ -184,7 +190,7 @@ module Telnyx
|
|
|
184
190
|
# @return [String, nil]
|
|
185
191
|
optional :webhook_url, String, nil?: true
|
|
186
192
|
|
|
187
|
-
# @!method initialize(id: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
193
|
+
# @!method initialize(id: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
188
194
|
# Some parameter documentations has been truncated, see
|
|
189
195
|
# {Telnyx::Models::OutboundMessagePayload} for more details.
|
|
190
196
|
#
|
|
@@ -210,6 +216,8 @@ module Telnyx
|
|
|
210
216
|
#
|
|
211
217
|
# @param messaging_profile_id [String] Unique identifier for a messaging profile.
|
|
212
218
|
#
|
|
219
|
+
# @param num_chars [Integer] The number of characters in the message text
|
|
220
|
+
#
|
|
213
221
|
# @param organization_id [String] The id of the organization the messaging profile belongs to.
|
|
214
222
|
#
|
|
215
223
|
# @param parts [Integer] Number of parts into which the message's body must be split.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Whatsapp
|
|
6
|
+
# @see Telnyx::Resources::Whatsapp::UserData#retrieve
|
|
7
|
+
class UserDataRetrieveParams < 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,59 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Whatsapp
|
|
6
|
+
# @see Telnyx::Resources::Whatsapp::UserData#retrieve
|
|
7
|
+
class UserDataRetrieveResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data, nil]
|
|
11
|
+
optional :data, -> { Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data]
|
|
15
|
+
|
|
16
|
+
# @see Telnyx::Models::Whatsapp::UserDataRetrieveResponse#data
|
|
17
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
18
|
+
# @!attribute created_at
|
|
19
|
+
#
|
|
20
|
+
# @return [Time, nil]
|
|
21
|
+
optional :created_at, Time
|
|
22
|
+
|
|
23
|
+
# @!attribute record_type
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :record_type, String
|
|
27
|
+
|
|
28
|
+
# @!attribute updated_at
|
|
29
|
+
#
|
|
30
|
+
# @return [Time, nil]
|
|
31
|
+
optional :updated_at, Time
|
|
32
|
+
|
|
33
|
+
# @!attribute webhook_failover_url
|
|
34
|
+
# Failover URL to receive Whatsapp signup events
|
|
35
|
+
#
|
|
36
|
+
# @return [String, nil]
|
|
37
|
+
optional :webhook_failover_url, String
|
|
38
|
+
|
|
39
|
+
# @!attribute webhook_url
|
|
40
|
+
# URL to receive Whatsapp signup events
|
|
41
|
+
#
|
|
42
|
+
# @return [String, nil]
|
|
43
|
+
optional :webhook_url, String
|
|
44
|
+
|
|
45
|
+
# @!method initialize(created_at: nil, record_type: nil, updated_at: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
46
|
+
# @param created_at [Time]
|
|
47
|
+
#
|
|
48
|
+
# @param record_type [String]
|
|
49
|
+
#
|
|
50
|
+
# @param updated_at [Time]
|
|
51
|
+
#
|
|
52
|
+
# @param webhook_failover_url [String] Failover URL to receive Whatsapp signup events
|
|
53
|
+
#
|
|
54
|
+
# @param webhook_url [String] URL to receive Whatsapp signup events
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Whatsapp
|
|
6
|
+
# @see Telnyx::Resources::Whatsapp::UserData#update
|
|
7
|
+
class UserDataUpdateParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute webhook_failover_url
|
|
12
|
+
# Failover URL to send Whatsapp signup events
|
|
13
|
+
#
|
|
14
|
+
# @return [String, nil]
|
|
15
|
+
optional :webhook_failover_url, String
|
|
16
|
+
|
|
17
|
+
# @!attribute webhook_url
|
|
18
|
+
# URL to send Whatsapp signup events
|
|
19
|
+
#
|
|
20
|
+
# @return [String, nil]
|
|
21
|
+
optional :webhook_url, String
|
|
22
|
+
|
|
23
|
+
# @!method initialize(webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
24
|
+
# @param webhook_failover_url [String] Failover URL to send Whatsapp signup events
|
|
25
|
+
#
|
|
26
|
+
# @param webhook_url [String] URL to send Whatsapp signup events
|
|
27
|
+
#
|
|
28
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Whatsapp
|
|
6
|
+
# @see Telnyx::Resources::Whatsapp::UserData#update
|
|
7
|
+
class UserDataUpdateResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data, nil]
|
|
11
|
+
optional :data, -> { Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data]
|
|
15
|
+
|
|
16
|
+
# @see Telnyx::Models::Whatsapp::UserDataUpdateResponse#data
|
|
17
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
18
|
+
# @!attribute created_at
|
|
19
|
+
#
|
|
20
|
+
# @return [Time, nil]
|
|
21
|
+
optional :created_at, Time
|
|
22
|
+
|
|
23
|
+
# @!attribute record_type
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :record_type, String
|
|
27
|
+
|
|
28
|
+
# @!attribute updated_at
|
|
29
|
+
#
|
|
30
|
+
# @return [Time, nil]
|
|
31
|
+
optional :updated_at, Time
|
|
32
|
+
|
|
33
|
+
# @!attribute webhook_failover_url
|
|
34
|
+
# Failover URL to receive Whatsapp signup events
|
|
35
|
+
#
|
|
36
|
+
# @return [String, nil]
|
|
37
|
+
optional :webhook_failover_url, String
|
|
38
|
+
|
|
39
|
+
# @!attribute webhook_url
|
|
40
|
+
# URL to receive Whatsapp signup events
|
|
41
|
+
#
|
|
42
|
+
# @return [String, nil]
|
|
43
|
+
optional :webhook_url, String
|
|
44
|
+
|
|
45
|
+
# @!method initialize(created_at: nil, record_type: nil, updated_at: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
46
|
+
# @param created_at [Time]
|
|
47
|
+
#
|
|
48
|
+
# @param record_type [String]
|
|
49
|
+
#
|
|
50
|
+
# @param updated_at [Time]
|
|
51
|
+
#
|
|
52
|
+
# @param webhook_failover_url [String] Failover URL to receive Whatsapp signup events
|
|
53
|
+
#
|
|
54
|
+
# @param webhook_url [String] URL to receive Whatsapp signup events
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class Whatsapp
|
|
6
|
+
# Manage Whatsapp business accounts
|
|
7
|
+
class UserData
|
|
8
|
+
# Fetch Whatsapp user data
|
|
9
|
+
#
|
|
10
|
+
# @overload retrieve(request_options: {})
|
|
11
|
+
#
|
|
12
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
13
|
+
#
|
|
14
|
+
# @return [Telnyx::Models::Whatsapp::UserDataRetrieveResponse]
|
|
15
|
+
#
|
|
16
|
+
# @see Telnyx::Models::Whatsapp::UserDataRetrieveParams
|
|
17
|
+
def retrieve(params = {})
|
|
18
|
+
@client.request(
|
|
19
|
+
method: :get,
|
|
20
|
+
path: "v2/whatsapp/user_data",
|
|
21
|
+
model: Telnyx::Models::Whatsapp::UserDataRetrieveResponse,
|
|
22
|
+
options: params[:request_options]
|
|
23
|
+
)
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
# Update Whatsapp user data
|
|
27
|
+
#
|
|
28
|
+
# @overload update(webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
29
|
+
#
|
|
30
|
+
# @param webhook_failover_url [String] Failover URL to send Whatsapp signup events
|
|
31
|
+
#
|
|
32
|
+
# @param webhook_url [String] URL to send Whatsapp signup events
|
|
33
|
+
#
|
|
34
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
35
|
+
#
|
|
36
|
+
# @return [Telnyx::Models::Whatsapp::UserDataUpdateResponse]
|
|
37
|
+
#
|
|
38
|
+
# @see Telnyx::Models::Whatsapp::UserDataUpdateParams
|
|
39
|
+
def update(params = {})
|
|
40
|
+
parsed, options = Telnyx::Whatsapp::UserDataUpdateParams.dump_request(params)
|
|
41
|
+
@client.request(
|
|
42
|
+
method: :patch,
|
|
43
|
+
path: "v2/whatsapp/user_data",
|
|
44
|
+
body: parsed,
|
|
45
|
+
model: Telnyx::Models::Whatsapp::UserDataUpdateResponse,
|
|
46
|
+
options: options
|
|
47
|
+
)
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# @api private
|
|
51
|
+
#
|
|
52
|
+
# @param client [Telnyx::Client]
|
|
53
|
+
def initialize(client:)
|
|
54
|
+
@client = client
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
@@ -15,6 +15,10 @@ module Telnyx
|
|
|
15
15
|
# @return [Telnyx::Resources::Whatsapp::PhoneNumbers]
|
|
16
16
|
attr_reader :phone_numbers
|
|
17
17
|
|
|
18
|
+
# Manage Whatsapp business accounts
|
|
19
|
+
# @return [Telnyx::Resources::Whatsapp::UserData]
|
|
20
|
+
attr_reader :user_data
|
|
21
|
+
|
|
18
22
|
# @api private
|
|
19
23
|
#
|
|
20
24
|
# @param client [Telnyx::Client]
|
|
@@ -23,6 +27,7 @@ module Telnyx
|
|
|
23
27
|
@business_accounts = Telnyx::Resources::Whatsapp::BusinessAccounts.new(client: client)
|
|
24
28
|
@templates = Telnyx::Resources::Whatsapp::Templates.new(client: client)
|
|
25
29
|
@phone_numbers = Telnyx::Resources::Whatsapp::PhoneNumbers.new(client: client)
|
|
30
|
+
@user_data = Telnyx::Resources::Whatsapp::UserData.new(client: client)
|
|
26
31
|
end
|
|
27
32
|
end
|
|
28
33
|
end
|
data/lib/telnyx/version.rb
CHANGED
data/lib/telnyx.rb
CHANGED
|
@@ -2374,6 +2374,10 @@ require_relative "telnyx/models/whatsapp/phone_number_verify_params"
|
|
|
2374
2374
|
require_relative "telnyx/models/whatsapp/template_create_params"
|
|
2375
2375
|
require_relative "telnyx/models/whatsapp/template_create_response"
|
|
2376
2376
|
require_relative "telnyx/models/whatsapp/template_list_params"
|
|
2377
|
+
require_relative "telnyx/models/whatsapp/user_data_retrieve_params"
|
|
2378
|
+
require_relative "telnyx/models/whatsapp/user_data_retrieve_response"
|
|
2379
|
+
require_relative "telnyx/models/whatsapp/user_data_update_params"
|
|
2380
|
+
require_relative "telnyx/models/whatsapp/user_data_update_response"
|
|
2377
2381
|
require_relative "telnyx/models/whatsapp_contact"
|
|
2378
2382
|
require_relative "telnyx/models/whatsapp_interactive"
|
|
2379
2383
|
require_relative "telnyx/models/whatsapp_location"
|
|
@@ -2749,6 +2753,7 @@ require_relative "telnyx/resources/whatsapp/phone_numbers/calling_settings"
|
|
|
2749
2753
|
require_relative "telnyx/resources/whatsapp/phone_numbers/profile"
|
|
2750
2754
|
require_relative "telnyx/resources/whatsapp/phone_numbers/profile/photo"
|
|
2751
2755
|
require_relative "telnyx/resources/whatsapp/templates"
|
|
2756
|
+
require_relative "telnyx/resources/whatsapp/user_data"
|
|
2752
2757
|
require_relative "telnyx/resources/whatsapp_message_templates"
|
|
2753
2758
|
require_relative "telnyx/resources/wireguard_interfaces"
|
|
2754
2759
|
require_relative "telnyx/resources/wireguard_peers"
|
|
@@ -386,6 +386,15 @@ module Telnyx
|
|
|
386
386
|
end
|
|
387
387
|
attr_writer :file_format
|
|
388
388
|
|
|
389
|
+
# When enabled, the call recording will stop when the conversation ends (for
|
|
390
|
+
# example, when the assistant hangs up or the call is transferred). When disabled,
|
|
391
|
+
# recording continues until the call itself ends.
|
|
392
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
393
|
+
attr_reader :stop_on_conversation_end
|
|
394
|
+
|
|
395
|
+
sig { params(stop_on_conversation_end: T::Boolean).void }
|
|
396
|
+
attr_writer :stop_on_conversation_end
|
|
397
|
+
|
|
389
398
|
# Configuration for call recording format and channel settings.
|
|
390
399
|
sig do
|
|
391
400
|
params(
|
|
@@ -393,7 +402,8 @@ module Telnyx
|
|
|
393
402
|
Telnyx::AI::TelephonySettings::RecordingSettings::Channels::OrSymbol,
|
|
394
403
|
enabled: T::Boolean,
|
|
395
404
|
file_format:
|
|
396
|
-
Telnyx::AI::TelephonySettings::RecordingSettings::Format::OrSymbol
|
|
405
|
+
Telnyx::AI::TelephonySettings::RecordingSettings::Format::OrSymbol,
|
|
406
|
+
stop_on_conversation_end: T::Boolean
|
|
397
407
|
).returns(T.attached_class)
|
|
398
408
|
end
|
|
399
409
|
def self.new(
|
|
@@ -403,7 +413,11 @@ module Telnyx
|
|
|
403
413
|
# regardless of other recording configuration.
|
|
404
414
|
enabled: nil,
|
|
405
415
|
# The format of the recording file.
|
|
406
|
-
file_format: nil
|
|
416
|
+
file_format: nil,
|
|
417
|
+
# When enabled, the call recording will stop when the conversation ends (for
|
|
418
|
+
# example, when the assistant hangs up or the call is transferred). When disabled,
|
|
419
|
+
# recording continues until the call itself ends.
|
|
420
|
+
stop_on_conversation_end: nil
|
|
407
421
|
)
|
|
408
422
|
end
|
|
409
423
|
|
|
@@ -414,7 +428,8 @@ module Telnyx
|
|
|
414
428
|
Telnyx::AI::TelephonySettings::RecordingSettings::Channels::OrSymbol,
|
|
415
429
|
enabled: T::Boolean,
|
|
416
430
|
file_format:
|
|
417
|
-
Telnyx::AI::TelephonySettings::RecordingSettings::Format::OrSymbol
|
|
431
|
+
Telnyx::AI::TelephonySettings::RecordingSettings::Format::OrSymbol,
|
|
432
|
+
stop_on_conversation_end: T::Boolean
|
|
418
433
|
}
|
|
419
434
|
)
|
|
420
435
|
end
|
|
@@ -103,6 +103,13 @@ module Telnyx
|
|
|
103
103
|
sig { params(messaging_profile_id: String).void }
|
|
104
104
|
attr_writer :messaging_profile_id
|
|
105
105
|
|
|
106
|
+
# The number of characters in the message text
|
|
107
|
+
sig { returns(T.nilable(Integer)) }
|
|
108
|
+
attr_reader :num_chars
|
|
109
|
+
|
|
110
|
+
sig { params(num_chars: Integer).void }
|
|
111
|
+
attr_writer :num_chars
|
|
112
|
+
|
|
106
113
|
# Unique identifier for a messaging profile.
|
|
107
114
|
sig { returns(T.nilable(String)) }
|
|
108
115
|
attr_reader :organization_id
|
|
@@ -222,6 +229,7 @@ module Telnyx
|
|
|
222
229
|
from: Telnyx::InboundMessagePayload::From::OrHash,
|
|
223
230
|
media: T::Array[Telnyx::InboundMessagePayload::Media::OrHash],
|
|
224
231
|
messaging_profile_id: String,
|
|
232
|
+
num_chars: Integer,
|
|
225
233
|
organization_id: String,
|
|
226
234
|
parts: Integer,
|
|
227
235
|
received_at: Time,
|
|
@@ -261,6 +269,8 @@ module Telnyx
|
|
|
261
269
|
media: nil,
|
|
262
270
|
# Unique identifier for a messaging profile.
|
|
263
271
|
messaging_profile_id: nil,
|
|
272
|
+
# The number of characters in the message text
|
|
273
|
+
num_chars: nil,
|
|
264
274
|
# Unique identifier for a messaging profile.
|
|
265
275
|
organization_id: nil,
|
|
266
276
|
# Number of parts into which the message's body must be split.
|
|
@@ -313,6 +323,7 @@ module Telnyx
|
|
|
313
323
|
from: Telnyx::InboundMessagePayload::From,
|
|
314
324
|
media: T::Array[Telnyx::InboundMessagePayload::Media],
|
|
315
325
|
messaging_profile_id: String,
|
|
326
|
+
num_chars: Integer,
|
|
316
327
|
organization_id: String,
|
|
317
328
|
parts: Integer,
|
|
318
329
|
received_at: Time,
|
|
@@ -146,6 +146,13 @@ module Telnyx
|
|
|
146
146
|
sig { params(messaging_profile_id: String).void }
|
|
147
147
|
attr_writer :messaging_profile_id
|
|
148
148
|
|
|
149
|
+
# The number of characters in the message text
|
|
150
|
+
sig { returns(T.nilable(Integer)) }
|
|
151
|
+
attr_reader :num_chars
|
|
152
|
+
|
|
153
|
+
sig { params(num_chars: Integer).void }
|
|
154
|
+
attr_writer :num_chars
|
|
155
|
+
|
|
149
156
|
# The id of the organization the messaging profile belongs to.
|
|
150
157
|
sig { returns(T.nilable(String)) }
|
|
151
158
|
attr_reader :organization_id
|
|
@@ -309,6 +316,7 @@ module Telnyx
|
|
|
309
316
|
Telnyx::Models::MessageCancelScheduledResponse::Media::OrHash
|
|
310
317
|
],
|
|
311
318
|
messaging_profile_id: String,
|
|
319
|
+
num_chars: Integer,
|
|
312
320
|
organization_id: String,
|
|
313
321
|
parts: Integer,
|
|
314
322
|
received_at: Time,
|
|
@@ -353,6 +361,8 @@ module Telnyx
|
|
|
353
361
|
media: nil,
|
|
354
362
|
# Unique identifier for a messaging profile.
|
|
355
363
|
messaging_profile_id: nil,
|
|
364
|
+
# The number of characters in the message text
|
|
365
|
+
num_chars: nil,
|
|
356
366
|
# The id of the organization the messaging profile belongs to.
|
|
357
367
|
organization_id: nil,
|
|
358
368
|
# Number of parts into which the message's body must be split.
|
|
@@ -417,6 +427,7 @@ module Telnyx
|
|
|
417
427
|
media:
|
|
418
428
|
T::Array[Telnyx::Models::MessageCancelScheduledResponse::Media],
|
|
419
429
|
messaging_profile_id: String,
|
|
430
|
+
num_chars: Integer,
|
|
420
431
|
organization_id: String,
|
|
421
432
|
parts: Integer,
|
|
422
433
|
received_at: Time,
|
|
@@ -105,6 +105,13 @@ module Telnyx
|
|
|
105
105
|
sig { params(messaging_profile_id: String).void }
|
|
106
106
|
attr_writer :messaging_profile_id
|
|
107
107
|
|
|
108
|
+
# The number of characters in the message text
|
|
109
|
+
sig { returns(T.nilable(Integer)) }
|
|
110
|
+
attr_reader :num_chars
|
|
111
|
+
|
|
112
|
+
sig { params(num_chars: Integer).void }
|
|
113
|
+
attr_writer :num_chars
|
|
114
|
+
|
|
108
115
|
# The id of the organization the messaging profile belongs to.
|
|
109
116
|
sig { returns(T.nilable(String)) }
|
|
110
117
|
attr_reader :organization_id
|
|
@@ -242,6 +249,7 @@ module Telnyx
|
|
|
242
249
|
from: Telnyx::OutboundMessagePayload::From::OrHash,
|
|
243
250
|
media: T::Array[Telnyx::OutboundMessagePayload::Media::OrHash],
|
|
244
251
|
messaging_profile_id: String,
|
|
252
|
+
num_chars: Integer,
|
|
245
253
|
organization_id: String,
|
|
246
254
|
parts: Integer,
|
|
247
255
|
received_at: Time,
|
|
@@ -283,6 +291,8 @@ module Telnyx
|
|
|
283
291
|
media: nil,
|
|
284
292
|
# Unique identifier for a messaging profile.
|
|
285
293
|
messaging_profile_id: nil,
|
|
294
|
+
# The number of characters in the message text
|
|
295
|
+
num_chars: nil,
|
|
286
296
|
# The id of the organization the messaging profile belongs to.
|
|
287
297
|
organization_id: nil,
|
|
288
298
|
# Number of parts into which the message's body must be split.
|
|
@@ -346,6 +356,7 @@ module Telnyx
|
|
|
346
356
|
from: Telnyx::OutboundMessagePayload::From,
|
|
347
357
|
media: T::Array[Telnyx::OutboundMessagePayload::Media],
|
|
348
358
|
messaging_profile_id: String,
|
|
359
|
+
num_chars: Integer,
|
|
349
360
|
organization_id: String,
|
|
350
361
|
parts: Integer,
|
|
351
362
|
received_at: Time,
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Whatsapp
|
|
6
|
+
class UserDataRetrieveParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
OrHash =
|
|
11
|
+
T.type_alias do
|
|
12
|
+
T.any(
|
|
13
|
+
Telnyx::Whatsapp::UserDataRetrieveParams,
|
|
14
|
+
Telnyx::Internal::AnyHash
|
|
15
|
+
)
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
sig do
|
|
19
|
+
params(request_options: Telnyx::RequestOptions::OrHash).returns(
|
|
20
|
+
T.attached_class
|
|
21
|
+
)
|
|
22
|
+
end
|
|
23
|
+
def self.new(request_options: {})
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
sig { override.returns({ request_options: Telnyx::RequestOptions }) }
|
|
27
|
+
def to_hash
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|