telnyx 5.117.0 → 5.118.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a2d11ebb6a136e5761fdabfb0310f614ec8dd25f19e9a6d904bb908a8ab32ba1
4
- data.tar.gz: 6937d70cef0017e78da74fb7e0f5ba113158f258727c47e1e26329fd9068df42
3
+ metadata.gz: 6f714336df7942dbd4bc8eea5ddeb82d990b9301b707f0cf2bd4d1722fe7bc62
4
+ data.tar.gz: 98fbe10db719704fc24b6cc1bf8e87bab5587e92fa80b13435dd00197202520d
5
5
  SHA512:
6
- metadata.gz: 1b672b72def3635919dacabc7603d0a23d72c45cab304a78971447f9a217090c6c34a82bdca6c7994b8c94e0122f5074af03ea6cf555355034542e27fda51e1b
7
- data.tar.gz: 1075538ac99d166f6c96118fa0f4b7ffd2d264bde077dad2c1407546d8e5bb7438e40865deb0f6f4f7430a96ea49c9d7af94693be7ed8ad1c8d7b25ae5523e28
6
+ metadata.gz: ec89bc2ff72804269668cead90a7e9ae942478d94e86aec25773617091db165ea4b673feda8f39f2f79b0e558baaa23cceeca063d3f615c869149602b855d401
7
+ data.tar.gz: 9e372a81a5c437f0cde9306e2c32de19b4f605b6a350141cef28cb1e546eff81f07daf53af5ec1ea2181966a845486d01df63d23355611d18f08eacf5f88a6d7
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 5.118.0 (2026-05-22)
4
+
5
+ Full Changelog: [v5.117.0...v5.118.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.117.0...v5.118.0)
6
+
7
+ ### Features
8
+
9
+ * MSG-919: documentation for Whatsapp user data ([3683252](https://github.com/team-telnyx/telnyx-ruby/commit/36832521020009060f02d05e0fcb48b9c01cebfb))
10
+
3
11
  ## 5.117.0 (2026-05-22)
4
12
 
5
13
  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
@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
24
24
  <!-- x-release-please-start-version -->
25
25
 
26
26
  ```ruby
27
- gem "telnyx", "~> 5.117.0"
27
+ gem "telnyx", "~> 5.118.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -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
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Telnyx
4
- VERSION = "5.117.0"
4
+ VERSION = "5.118.0"
5
5
  end
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"
@@ -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
@@ -0,0 +1,125 @@
1
+ # typed: strong
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Whatsapp
6
+ class UserDataRetrieveResponse < Telnyx::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(
10
+ Telnyx::Models::Whatsapp::UserDataRetrieveResponse,
11
+ Telnyx::Internal::AnyHash
12
+ )
13
+ end
14
+
15
+ sig do
16
+ returns(
17
+ T.nilable(Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data)
18
+ )
19
+ end
20
+ attr_reader :data
21
+
22
+ sig do
23
+ params(
24
+ data:
25
+ Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data::OrHash
26
+ ).void
27
+ end
28
+ attr_writer :data
29
+
30
+ sig do
31
+ params(
32
+ data:
33
+ Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data::OrHash
34
+ ).returns(T.attached_class)
35
+ end
36
+ def self.new(data: nil)
37
+ end
38
+
39
+ sig do
40
+ override.returns(
41
+ { data: Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data }
42
+ )
43
+ end
44
+ def to_hash
45
+ end
46
+
47
+ class Data < Telnyx::Internal::Type::BaseModel
48
+ OrHash =
49
+ T.type_alias do
50
+ T.any(
51
+ Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data,
52
+ Telnyx::Internal::AnyHash
53
+ )
54
+ end
55
+
56
+ sig { returns(T.nilable(Time)) }
57
+ attr_reader :created_at
58
+
59
+ sig { params(created_at: Time).void }
60
+ attr_writer :created_at
61
+
62
+ sig { returns(T.nilable(String)) }
63
+ attr_reader :record_type
64
+
65
+ sig { params(record_type: String).void }
66
+ attr_writer :record_type
67
+
68
+ sig { returns(T.nilable(Time)) }
69
+ attr_reader :updated_at
70
+
71
+ sig { params(updated_at: Time).void }
72
+ attr_writer :updated_at
73
+
74
+ # Failover URL to receive Whatsapp signup events
75
+ sig { returns(T.nilable(String)) }
76
+ attr_reader :webhook_failover_url
77
+
78
+ sig { params(webhook_failover_url: String).void }
79
+ attr_writer :webhook_failover_url
80
+
81
+ # URL to receive Whatsapp signup events
82
+ sig { returns(T.nilable(String)) }
83
+ attr_reader :webhook_url
84
+
85
+ sig { params(webhook_url: String).void }
86
+ attr_writer :webhook_url
87
+
88
+ sig do
89
+ params(
90
+ created_at: Time,
91
+ record_type: String,
92
+ updated_at: Time,
93
+ webhook_failover_url: String,
94
+ webhook_url: String
95
+ ).returns(T.attached_class)
96
+ end
97
+ def self.new(
98
+ created_at: nil,
99
+ record_type: nil,
100
+ updated_at: nil,
101
+ # Failover URL to receive Whatsapp signup events
102
+ webhook_failover_url: nil,
103
+ # URL to receive Whatsapp signup events
104
+ webhook_url: nil
105
+ )
106
+ end
107
+
108
+ sig do
109
+ override.returns(
110
+ {
111
+ created_at: Time,
112
+ record_type: String,
113
+ updated_at: Time,
114
+ webhook_failover_url: String,
115
+ webhook_url: String
116
+ }
117
+ )
118
+ end
119
+ def to_hash
120
+ end
121
+ end
122
+ end
123
+ end
124
+ end
125
+ end
@@ -0,0 +1,62 @@
1
+ # typed: strong
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Whatsapp
6
+ class UserDataUpdateParams < 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::UserDataUpdateParams,
14
+ Telnyx::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ # Failover URL to send Whatsapp signup events
19
+ sig { returns(T.nilable(String)) }
20
+ attr_reader :webhook_failover_url
21
+
22
+ sig { params(webhook_failover_url: String).void }
23
+ attr_writer :webhook_failover_url
24
+
25
+ # URL to send Whatsapp signup events
26
+ sig { returns(T.nilable(String)) }
27
+ attr_reader :webhook_url
28
+
29
+ sig { params(webhook_url: String).void }
30
+ attr_writer :webhook_url
31
+
32
+ sig do
33
+ params(
34
+ webhook_failover_url: String,
35
+ webhook_url: String,
36
+ request_options: Telnyx::RequestOptions::OrHash
37
+ ).returns(T.attached_class)
38
+ end
39
+ def self.new(
40
+ # Failover URL to send Whatsapp signup events
41
+ webhook_failover_url: nil,
42
+ # URL to send Whatsapp signup events
43
+ webhook_url: nil,
44
+ request_options: {}
45
+ )
46
+ end
47
+
48
+ sig do
49
+ override.returns(
50
+ {
51
+ webhook_failover_url: String,
52
+ webhook_url: String,
53
+ request_options: Telnyx::RequestOptions
54
+ }
55
+ )
56
+ end
57
+ def to_hash
58
+ end
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,123 @@
1
+ # typed: strong
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Whatsapp
6
+ class UserDataUpdateResponse < Telnyx::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(
10
+ Telnyx::Models::Whatsapp::UserDataUpdateResponse,
11
+ Telnyx::Internal::AnyHash
12
+ )
13
+ end
14
+
15
+ sig do
16
+ returns(
17
+ T.nilable(Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data)
18
+ )
19
+ end
20
+ attr_reader :data
21
+
22
+ sig do
23
+ params(
24
+ data: Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data::OrHash
25
+ ).void
26
+ end
27
+ attr_writer :data
28
+
29
+ sig do
30
+ params(
31
+ data: Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data::OrHash
32
+ ).returns(T.attached_class)
33
+ end
34
+ def self.new(data: nil)
35
+ end
36
+
37
+ sig do
38
+ override.returns(
39
+ { data: Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data }
40
+ )
41
+ end
42
+ def to_hash
43
+ end
44
+
45
+ class Data < Telnyx::Internal::Type::BaseModel
46
+ OrHash =
47
+ T.type_alias do
48
+ T.any(
49
+ Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data,
50
+ Telnyx::Internal::AnyHash
51
+ )
52
+ end
53
+
54
+ sig { returns(T.nilable(Time)) }
55
+ attr_reader :created_at
56
+
57
+ sig { params(created_at: Time).void }
58
+ attr_writer :created_at
59
+
60
+ sig { returns(T.nilable(String)) }
61
+ attr_reader :record_type
62
+
63
+ sig { params(record_type: String).void }
64
+ attr_writer :record_type
65
+
66
+ sig { returns(T.nilable(Time)) }
67
+ attr_reader :updated_at
68
+
69
+ sig { params(updated_at: Time).void }
70
+ attr_writer :updated_at
71
+
72
+ # Failover URL to receive Whatsapp signup events
73
+ sig { returns(T.nilable(String)) }
74
+ attr_reader :webhook_failover_url
75
+
76
+ sig { params(webhook_failover_url: String).void }
77
+ attr_writer :webhook_failover_url
78
+
79
+ # URL to receive Whatsapp signup events
80
+ sig { returns(T.nilable(String)) }
81
+ attr_reader :webhook_url
82
+
83
+ sig { params(webhook_url: String).void }
84
+ attr_writer :webhook_url
85
+
86
+ sig do
87
+ params(
88
+ created_at: Time,
89
+ record_type: String,
90
+ updated_at: Time,
91
+ webhook_failover_url: String,
92
+ webhook_url: String
93
+ ).returns(T.attached_class)
94
+ end
95
+ def self.new(
96
+ created_at: nil,
97
+ record_type: nil,
98
+ updated_at: nil,
99
+ # Failover URL to receive Whatsapp signup events
100
+ webhook_failover_url: nil,
101
+ # URL to receive Whatsapp signup events
102
+ webhook_url: nil
103
+ )
104
+ end
105
+
106
+ sig do
107
+ override.returns(
108
+ {
109
+ created_at: Time,
110
+ record_type: String,
111
+ updated_at: Time,
112
+ webhook_failover_url: String,
113
+ webhook_url: String
114
+ }
115
+ )
116
+ end
117
+ def to_hash
118
+ end
119
+ end
120
+ end
121
+ end
122
+ end
123
+ end
@@ -0,0 +1,41 @@
1
+ # typed: strong
2
+
3
+ module Telnyx
4
+ module Resources
5
+ class Whatsapp
6
+ # Manage Whatsapp business accounts
7
+ class UserData
8
+ # Fetch Whatsapp user data
9
+ sig do
10
+ params(request_options: Telnyx::RequestOptions::OrHash).returns(
11
+ Telnyx::Models::Whatsapp::UserDataRetrieveResponse
12
+ )
13
+ end
14
+ def retrieve(request_options: {})
15
+ end
16
+
17
+ # Update Whatsapp user data
18
+ sig do
19
+ params(
20
+ webhook_failover_url: String,
21
+ webhook_url: String,
22
+ request_options: Telnyx::RequestOptions::OrHash
23
+ ).returns(Telnyx::Models::Whatsapp::UserDataUpdateResponse)
24
+ end
25
+ def update(
26
+ # Failover URL to send Whatsapp signup events
27
+ webhook_failover_url: nil,
28
+ # URL to send Whatsapp signup events
29
+ webhook_url: nil,
30
+ request_options: {}
31
+ )
32
+ end
33
+
34
+ # @api private
35
+ sig { params(client: Telnyx::Client).returns(T.attached_class) }
36
+ def self.new(client:)
37
+ end
38
+ end
39
+ end
40
+ end
41
+ end
@@ -15,6 +15,10 @@ module Telnyx
15
15
  sig { returns(Telnyx::Resources::Whatsapp::PhoneNumbers) }
16
16
  attr_reader :phone_numbers
17
17
 
18
+ # Manage Whatsapp business accounts
19
+ sig { returns(Telnyx::Resources::Whatsapp::UserData) }
20
+ attr_reader :user_data
21
+
18
22
  # @api private
19
23
  sig { params(client: Telnyx::Client).returns(T.attached_class) }
20
24
  def self.new(client:)
@@ -0,0 +1,17 @@
1
+ module Telnyx
2
+ module Models
3
+ module Whatsapp
4
+ type user_data_retrieve_params =
5
+ { } & Telnyx::Internal::Type::request_parameters
6
+
7
+ class UserDataRetrieveParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ def initialize: (?request_options: Telnyx::request_opts) -> void
12
+
13
+ def to_hash: -> { request_options: Telnyx::RequestOptions }
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,71 @@
1
+ module Telnyx
2
+ module Models
3
+ module Whatsapp
4
+ type user_data_retrieve_response =
5
+ { data: Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data }
6
+
7
+ class UserDataRetrieveResponse < Telnyx::Internal::Type::BaseModel
8
+ attr_reader data: Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data?
9
+
10
+ def data=: (
11
+ Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data
12
+ ) -> Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data
13
+
14
+ def initialize: (
15
+ ?data: Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data
16
+ ) -> void
17
+
18
+ def to_hash: -> {
19
+ data: Telnyx::Models::Whatsapp::UserDataRetrieveResponse::Data
20
+ }
21
+
22
+ type data =
23
+ {
24
+ created_at: Time,
25
+ record_type: String,
26
+ updated_at: Time,
27
+ webhook_failover_url: String,
28
+ webhook_url: String
29
+ }
30
+
31
+ class Data < Telnyx::Internal::Type::BaseModel
32
+ attr_reader created_at: Time?
33
+
34
+ def created_at=: (Time) -> Time
35
+
36
+ attr_reader record_type: String?
37
+
38
+ def record_type=: (String) -> String
39
+
40
+ attr_reader updated_at: Time?
41
+
42
+ def updated_at=: (Time) -> Time
43
+
44
+ attr_reader webhook_failover_url: String?
45
+
46
+ def webhook_failover_url=: (String) -> String
47
+
48
+ attr_reader webhook_url: String?
49
+
50
+ def webhook_url=: (String) -> String
51
+
52
+ def initialize: (
53
+ ?created_at: Time,
54
+ ?record_type: String,
55
+ ?updated_at: Time,
56
+ ?webhook_failover_url: String,
57
+ ?webhook_url: String
58
+ ) -> void
59
+
60
+ def to_hash: -> {
61
+ created_at: Time,
62
+ record_type: String,
63
+ updated_at: Time,
64
+ webhook_failover_url: String,
65
+ webhook_url: String
66
+ }
67
+ end
68
+ end
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,34 @@
1
+ module Telnyx
2
+ module Models
3
+ module Whatsapp
4
+ type user_data_update_params =
5
+ { webhook_failover_url: String, webhook_url: String }
6
+ & Telnyx::Internal::Type::request_parameters
7
+
8
+ class UserDataUpdateParams < Telnyx::Internal::Type::BaseModel
9
+ extend Telnyx::Internal::Type::RequestParameters::Converter
10
+ include Telnyx::Internal::Type::RequestParameters
11
+
12
+ attr_reader webhook_failover_url: String?
13
+
14
+ def webhook_failover_url=: (String) -> String
15
+
16
+ attr_reader webhook_url: String?
17
+
18
+ def webhook_url=: (String) -> String
19
+
20
+ def initialize: (
21
+ ?webhook_failover_url: String,
22
+ ?webhook_url: String,
23
+ ?request_options: Telnyx::request_opts
24
+ ) -> void
25
+
26
+ def to_hash: -> {
27
+ webhook_failover_url: String,
28
+ webhook_url: String,
29
+ request_options: Telnyx::RequestOptions
30
+ }
31
+ end
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,71 @@
1
+ module Telnyx
2
+ module Models
3
+ module Whatsapp
4
+ type user_data_update_response =
5
+ { data: Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data }
6
+
7
+ class UserDataUpdateResponse < Telnyx::Internal::Type::BaseModel
8
+ attr_reader data: Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data?
9
+
10
+ def data=: (
11
+ Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data
12
+ ) -> Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data
13
+
14
+ def initialize: (
15
+ ?data: Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data
16
+ ) -> void
17
+
18
+ def to_hash: -> {
19
+ data: Telnyx::Models::Whatsapp::UserDataUpdateResponse::Data
20
+ }
21
+
22
+ type data =
23
+ {
24
+ created_at: Time,
25
+ record_type: String,
26
+ updated_at: Time,
27
+ webhook_failover_url: String,
28
+ webhook_url: String
29
+ }
30
+
31
+ class Data < Telnyx::Internal::Type::BaseModel
32
+ attr_reader created_at: Time?
33
+
34
+ def created_at=: (Time) -> Time
35
+
36
+ attr_reader record_type: String?
37
+
38
+ def record_type=: (String) -> String
39
+
40
+ attr_reader updated_at: Time?
41
+
42
+ def updated_at=: (Time) -> Time
43
+
44
+ attr_reader webhook_failover_url: String?
45
+
46
+ def webhook_failover_url=: (String) -> String
47
+
48
+ attr_reader webhook_url: String?
49
+
50
+ def webhook_url=: (String) -> String
51
+
52
+ def initialize: (
53
+ ?created_at: Time,
54
+ ?record_type: String,
55
+ ?updated_at: Time,
56
+ ?webhook_failover_url: String,
57
+ ?webhook_url: String
58
+ ) -> void
59
+
60
+ def to_hash: -> {
61
+ created_at: Time,
62
+ record_type: String,
63
+ updated_at: Time,
64
+ webhook_failover_url: String,
65
+ webhook_url: String
66
+ }
67
+ end
68
+ end
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,19 @@
1
+ module Telnyx
2
+ module Resources
3
+ class Whatsapp
4
+ class UserData
5
+ def retrieve: (
6
+ ?request_options: Telnyx::request_opts
7
+ ) -> Telnyx::Models::Whatsapp::UserDataRetrieveResponse
8
+
9
+ def update: (
10
+ ?webhook_failover_url: String,
11
+ ?webhook_url: String,
12
+ ?request_options: Telnyx::request_opts
13
+ ) -> Telnyx::Models::Whatsapp::UserDataUpdateResponse
14
+
15
+ def initialize: (client: Telnyx::Client) -> void
16
+ end
17
+ end
18
+ end
19
+ end
@@ -7,6 +7,8 @@ module Telnyx
7
7
 
8
8
  attr_reader phone_numbers: Telnyx::Resources::Whatsapp::PhoneNumbers
9
9
 
10
+ attr_reader user_data: Telnyx::Resources::Whatsapp::UserData
11
+
10
12
  def initialize: (client: Telnyx::Client) -> void
11
13
  end
12
14
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: telnyx
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.117.0
4
+ version: 5.118.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Telnyx
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-05-22 00:00:00.000000000 Z
11
+ date: 2026-05-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi
@@ -2419,6 +2419,10 @@ files:
2419
2419
  - lib/telnyx/models/whatsapp/template_create_params.rb
2420
2420
  - lib/telnyx/models/whatsapp/template_create_response.rb
2421
2421
  - lib/telnyx/models/whatsapp/template_list_params.rb
2422
+ - lib/telnyx/models/whatsapp/user_data_retrieve_params.rb
2423
+ - lib/telnyx/models/whatsapp/user_data_retrieve_response.rb
2424
+ - lib/telnyx/models/whatsapp/user_data_update_params.rb
2425
+ - lib/telnyx/models/whatsapp/user_data_update_response.rb
2422
2426
  - lib/telnyx/models/whatsapp_contact.rb
2423
2427
  - lib/telnyx/models/whatsapp_interactive.rb
2424
2428
  - lib/telnyx/models/whatsapp_location.rb
@@ -2795,6 +2799,7 @@ files:
2795
2799
  - lib/telnyx/resources/whatsapp/phone_numbers/profile.rb
2796
2800
  - lib/telnyx/resources/whatsapp/phone_numbers/profile/photo.rb
2797
2801
  - lib/telnyx/resources/whatsapp/templates.rb
2802
+ - lib/telnyx/resources/whatsapp/user_data.rb
2798
2803
  - lib/telnyx/resources/whatsapp_message_templates.rb
2799
2804
  - lib/telnyx/resources/wireguard_interfaces.rb
2800
2805
  - lib/telnyx/resources/wireguard_peers.rb
@@ -5154,6 +5159,10 @@ files:
5154
5159
  - rbi/telnyx/models/whatsapp/template_create_params.rbi
5155
5160
  - rbi/telnyx/models/whatsapp/template_create_response.rbi
5156
5161
  - rbi/telnyx/models/whatsapp/template_list_params.rbi
5162
+ - rbi/telnyx/models/whatsapp/user_data_retrieve_params.rbi
5163
+ - rbi/telnyx/models/whatsapp/user_data_retrieve_response.rbi
5164
+ - rbi/telnyx/models/whatsapp/user_data_update_params.rbi
5165
+ - rbi/telnyx/models/whatsapp/user_data_update_response.rbi
5157
5166
  - rbi/telnyx/models/whatsapp_contact.rbi
5158
5167
  - rbi/telnyx/models/whatsapp_interactive.rbi
5159
5168
  - rbi/telnyx/models/whatsapp_location.rbi
@@ -5530,6 +5539,7 @@ files:
5530
5539
  - rbi/telnyx/resources/whatsapp/phone_numbers/profile.rbi
5531
5540
  - rbi/telnyx/resources/whatsapp/phone_numbers/profile/photo.rbi
5532
5541
  - rbi/telnyx/resources/whatsapp/templates.rbi
5542
+ - rbi/telnyx/resources/whatsapp/user_data.rbi
5533
5543
  - rbi/telnyx/resources/whatsapp_message_templates.rbi
5534
5544
  - rbi/telnyx/resources/wireguard_interfaces.rbi
5535
5545
  - rbi/telnyx/resources/wireguard_peers.rbi
@@ -7880,6 +7890,10 @@ files:
7880
7890
  - sig/telnyx/models/whatsapp/template_create_params.rbs
7881
7891
  - sig/telnyx/models/whatsapp/template_create_response.rbs
7882
7892
  - sig/telnyx/models/whatsapp/template_list_params.rbs
7893
+ - sig/telnyx/models/whatsapp/user_data_retrieve_params.rbs
7894
+ - sig/telnyx/models/whatsapp/user_data_retrieve_response.rbs
7895
+ - sig/telnyx/models/whatsapp/user_data_update_params.rbs
7896
+ - sig/telnyx/models/whatsapp/user_data_update_response.rbs
7883
7897
  - sig/telnyx/models/whatsapp_contact.rbs
7884
7898
  - sig/telnyx/models/whatsapp_interactive.rbs
7885
7899
  - sig/telnyx/models/whatsapp_location.rbs
@@ -8256,6 +8270,7 @@ files:
8256
8270
  - sig/telnyx/resources/whatsapp/phone_numbers/profile.rbs
8257
8271
  - sig/telnyx/resources/whatsapp/phone_numbers/profile/photo.rbs
8258
8272
  - sig/telnyx/resources/whatsapp/templates.rbs
8273
+ - sig/telnyx/resources/whatsapp/user_data.rbs
8259
8274
  - sig/telnyx/resources/whatsapp_message_templates.rbs
8260
8275
  - sig/telnyx/resources/wireguard_interfaces.rbs
8261
8276
  - sig/telnyx/resources/wireguard_peers.rbs