telnyx 5.7.1 → 5.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/fax_delivered_webhook_event.rb +193 -144
  5. data/lib/telnyx/models/fax_failed_webhook_event.rb +195 -146
  6. data/lib/telnyx/models/fax_media_processed_webhook_event.rb +177 -128
  7. data/lib/telnyx/models/fax_queued_webhook_event.rb +177 -128
  8. data/lib/telnyx/models/fax_sending_started_webhook_event.rb +177 -128
  9. data/lib/telnyx/models/faxes/action_cancel_response.rb +16 -5
  10. data/lib/telnyx/models/faxes/action_refresh_response.rb +16 -5
  11. data/lib/telnyx/version.rb +1 -1
  12. data/rbi/telnyx/models/fax_delivered_webhook_event.rbi +368 -247
  13. data/rbi/telnyx/models/fax_failed_webhook_event.rbi +388 -262
  14. data/rbi/telnyx/models/fax_media_processed_webhook_event.rbi +356 -239
  15. data/rbi/telnyx/models/fax_queued_webhook_event.rbi +348 -222
  16. data/rbi/telnyx/models/fax_sending_started_webhook_event.rbi +356 -239
  17. data/rbi/telnyx/models/faxes/action_cancel_response.rbi +45 -7
  18. data/rbi/telnyx/models/faxes/action_refresh_response.rbi +45 -7
  19. data/sig/telnyx/models/fax_delivered_webhook_event.rbs +175 -122
  20. data/sig/telnyx/models/fax_failed_webhook_event.rbs +178 -125
  21. data/sig/telnyx/models/fax_media_processed_webhook_event.rbs +165 -112
  22. data/sig/telnyx/models/fax_queued_webhook_event.rbs +165 -112
  23. data/sig/telnyx/models/fax_sending_started_webhook_event.rbs +165 -112
  24. data/sig/telnyx/models/faxes/action_cancel_response.rbs +24 -5
  25. data/sig/telnyx/models/faxes/action_refresh_response.rbs +24 -5
  26. metadata +1 -1
@@ -12,19 +12,57 @@ module Telnyx
12
12
  )
13
13
  end
14
14
 
15
- sig { returns(T.nilable(String)) }
16
- attr_reader :result
15
+ sig do
16
+ returns(T.nilable(Telnyx::Models::Faxes::ActionCancelResponse::Data))
17
+ end
18
+ attr_reader :data
17
19
 
18
- sig { params(result: String).void }
19
- attr_writer :result
20
+ sig do
21
+ params(
22
+ data: Telnyx::Models::Faxes::ActionCancelResponse::Data::OrHash
23
+ ).void
24
+ end
25
+ attr_writer :data
20
26
 
21
- sig { params(result: String).returns(T.attached_class) }
22
- def self.new(result: nil)
27
+ sig do
28
+ params(
29
+ data: Telnyx::Models::Faxes::ActionCancelResponse::Data::OrHash
30
+ ).returns(T.attached_class)
31
+ end
32
+ def self.new(data: nil)
23
33
  end
24
34
 
25
- sig { override.returns({ result: String }) }
35
+ sig do
36
+ override.returns(
37
+ { data: Telnyx::Models::Faxes::ActionCancelResponse::Data }
38
+ )
39
+ end
26
40
  def to_hash
27
41
  end
42
+
43
+ class Data < Telnyx::Internal::Type::BaseModel
44
+ OrHash =
45
+ T.type_alias do
46
+ T.any(
47
+ Telnyx::Models::Faxes::ActionCancelResponse::Data,
48
+ Telnyx::Internal::AnyHash
49
+ )
50
+ end
51
+
52
+ sig { returns(T.nilable(String)) }
53
+ attr_reader :result
54
+
55
+ sig { params(result: String).void }
56
+ attr_writer :result
57
+
58
+ sig { params(result: String).returns(T.attached_class) }
59
+ def self.new(result: nil)
60
+ end
61
+
62
+ sig { override.returns({ result: String }) }
63
+ def to_hash
64
+ end
65
+ end
28
66
  end
29
67
  end
30
68
  end
@@ -12,19 +12,57 @@ module Telnyx
12
12
  )
13
13
  end
14
14
 
15
- sig { returns(T.nilable(String)) }
16
- attr_reader :result
15
+ sig do
16
+ returns(T.nilable(Telnyx::Models::Faxes::ActionRefreshResponse::Data))
17
+ end
18
+ attr_reader :data
17
19
 
18
- sig { params(result: String).void }
19
- attr_writer :result
20
+ sig do
21
+ params(
22
+ data: Telnyx::Models::Faxes::ActionRefreshResponse::Data::OrHash
23
+ ).void
24
+ end
25
+ attr_writer :data
20
26
 
21
- sig { params(result: String).returns(T.attached_class) }
22
- def self.new(result: nil)
27
+ sig do
28
+ params(
29
+ data: Telnyx::Models::Faxes::ActionRefreshResponse::Data::OrHash
30
+ ).returns(T.attached_class)
31
+ end
32
+ def self.new(data: nil)
23
33
  end
24
34
 
25
- sig { override.returns({ result: String }) }
35
+ sig do
36
+ override.returns(
37
+ { data: Telnyx::Models::Faxes::ActionRefreshResponse::Data }
38
+ )
39
+ end
26
40
  def to_hash
27
41
  end
42
+
43
+ class Data < Telnyx::Internal::Type::BaseModel
44
+ OrHash =
45
+ T.type_alias do
46
+ T.any(
47
+ Telnyx::Models::Faxes::ActionRefreshResponse::Data,
48
+ Telnyx::Internal::AnyHash
49
+ )
50
+ end
51
+
52
+ sig { returns(T.nilable(String)) }
53
+ attr_reader :result
54
+
55
+ sig { params(result: String).void }
56
+ attr_writer :result
57
+
58
+ sig { params(result: String).returns(T.attached_class) }
59
+ def self.new(result: nil)
60
+ end
61
+
62
+ sig { override.returns({ result: String }) }
63
+ def to_hash
64
+ end
65
+ end
28
66
  end
29
67
  end
30
68
  end
@@ -2,188 +2,241 @@ module Telnyx
2
2
  module Models
3
3
  type fax_delivered_webhook_event =
4
4
  {
5
- id: String,
6
- event_type: Telnyx::Models::FaxDeliveredWebhookEvent::event_type,
7
- payload: Telnyx::FaxDeliveredWebhookEvent::Payload,
8
- record_type: Telnyx::Models::FaxDeliveredWebhookEvent::record_type
5
+ data: Telnyx::FaxDeliveredWebhookEvent::Data,
6
+ meta: Telnyx::FaxDeliveredWebhookEvent::Meta
9
7
  }
10
8
 
11
9
  class FaxDeliveredWebhookEvent < Telnyx::Internal::Type::BaseModel
12
- attr_reader id: String?
10
+ attr_reader data: Telnyx::FaxDeliveredWebhookEvent::Data?
13
11
 
14
- def id=: (String) -> String
12
+ def data=: (
13
+ Telnyx::FaxDeliveredWebhookEvent::Data
14
+ ) -> Telnyx::FaxDeliveredWebhookEvent::Data
15
15
 
16
- attr_reader event_type: Telnyx::Models::FaxDeliveredWebhookEvent::event_type?
16
+ attr_reader meta: Telnyx::FaxDeliveredWebhookEvent::Meta?
17
17
 
18
- def event_type=: (
19
- Telnyx::Models::FaxDeliveredWebhookEvent::event_type
20
- ) -> Telnyx::Models::FaxDeliveredWebhookEvent::event_type
21
-
22
- attr_reader payload: Telnyx::FaxDeliveredWebhookEvent::Payload?
23
-
24
- def payload=: (
25
- Telnyx::FaxDeliveredWebhookEvent::Payload
26
- ) -> Telnyx::FaxDeliveredWebhookEvent::Payload
27
-
28
- attr_reader record_type: Telnyx::Models::FaxDeliveredWebhookEvent::record_type?
29
-
30
- def record_type=: (
31
- Telnyx::Models::FaxDeliveredWebhookEvent::record_type
32
- ) -> Telnyx::Models::FaxDeliveredWebhookEvent::record_type
18
+ def meta=: (
19
+ Telnyx::FaxDeliveredWebhookEvent::Meta
20
+ ) -> Telnyx::FaxDeliveredWebhookEvent::Meta
33
21
 
34
22
  def initialize: (
35
- ?id: String,
36
- ?event_type: Telnyx::Models::FaxDeliveredWebhookEvent::event_type,
37
- ?payload: Telnyx::FaxDeliveredWebhookEvent::Payload,
38
- ?record_type: Telnyx::Models::FaxDeliveredWebhookEvent::record_type
23
+ ?data: Telnyx::FaxDeliveredWebhookEvent::Data,
24
+ ?meta: Telnyx::FaxDeliveredWebhookEvent::Meta
39
25
  ) -> void
40
26
 
41
27
  def to_hash: -> {
42
- id: String,
43
- event_type: Telnyx::Models::FaxDeliveredWebhookEvent::event_type,
44
- payload: Telnyx::FaxDeliveredWebhookEvent::Payload,
45
- record_type: Telnyx::Models::FaxDeliveredWebhookEvent::record_type
28
+ data: Telnyx::FaxDeliveredWebhookEvent::Data,
29
+ meta: Telnyx::FaxDeliveredWebhookEvent::Meta
46
30
  }
47
31
 
48
- type event_type = :"fax.delivered"
32
+ type data =
33
+ {
34
+ id: String,
35
+ event_type: Telnyx::Models::FaxDeliveredWebhookEvent::Data::event_type,
36
+ occurred_at: Time,
37
+ payload: Telnyx::FaxDeliveredWebhookEvent::Data::Payload,
38
+ record_type: Telnyx::Models::FaxDeliveredWebhookEvent::Data::record_type
39
+ }
40
+
41
+ class Data < Telnyx::Internal::Type::BaseModel
42
+ attr_reader id: String?
49
43
 
50
- module EventType
51
- extend Telnyx::Internal::Type::Enum
44
+ def id=: (String) -> String
52
45
 
53
- FAX_DELIVERED: :"fax.delivered"
46
+ attr_reader event_type: Telnyx::Models::FaxDeliveredWebhookEvent::Data::event_type?
54
47
 
55
- def self?.values: -> ::Array[Telnyx::Models::FaxDeliveredWebhookEvent::event_type]
56
- end
48
+ def event_type=: (
49
+ Telnyx::Models::FaxDeliveredWebhookEvent::Data::event_type
50
+ ) -> Telnyx::Models::FaxDeliveredWebhookEvent::Data::event_type
57
51
 
58
- type payload =
59
- {
60
- call_duration_secs: Integer,
61
- client_state: String,
62
- connection_id: String,
63
- direction: Telnyx::Models::FaxDeliveredWebhookEvent::Payload::direction,
64
- fax_id: String,
65
- from: String,
66
- media_name: String,
67
- original_media_url: String,
68
- page_count: Integer,
69
- status: Telnyx::Models::FaxDeliveredWebhookEvent::Payload::status,
70
- to: String,
71
- user_id: String
52
+ attr_reader occurred_at: Time?
53
+
54
+ def occurred_at=: (Time) -> Time
55
+
56
+ attr_reader payload: Telnyx::FaxDeliveredWebhookEvent::Data::Payload?
57
+
58
+ def payload=: (
59
+ Telnyx::FaxDeliveredWebhookEvent::Data::Payload
60
+ ) -> Telnyx::FaxDeliveredWebhookEvent::Data::Payload
61
+
62
+ attr_reader record_type: Telnyx::Models::FaxDeliveredWebhookEvent::Data::record_type?
63
+
64
+ def record_type=: (
65
+ Telnyx::Models::FaxDeliveredWebhookEvent::Data::record_type
66
+ ) -> Telnyx::Models::FaxDeliveredWebhookEvent::Data::record_type
67
+
68
+ def initialize: (
69
+ ?id: String,
70
+ ?event_type: Telnyx::Models::FaxDeliveredWebhookEvent::Data::event_type,
71
+ ?occurred_at: Time,
72
+ ?payload: Telnyx::FaxDeliveredWebhookEvent::Data::Payload,
73
+ ?record_type: Telnyx::Models::FaxDeliveredWebhookEvent::Data::record_type
74
+ ) -> void
75
+
76
+ def to_hash: -> {
77
+ id: String,
78
+ event_type: Telnyx::Models::FaxDeliveredWebhookEvent::Data::event_type,
79
+ occurred_at: Time,
80
+ payload: Telnyx::FaxDeliveredWebhookEvent::Data::Payload,
81
+ record_type: Telnyx::Models::FaxDeliveredWebhookEvent::Data::record_type
72
82
  }
73
83
 
74
- class Payload < Telnyx::Internal::Type::BaseModel
75
- attr_reader call_duration_secs: Integer?
84
+ type event_type = :"fax.delivered"
76
85
 
77
- def call_duration_secs=: (Integer) -> Integer
86
+ module EventType
87
+ extend Telnyx::Internal::Type::Enum
78
88
 
79
- attr_reader client_state: String?
89
+ FAX_DELIVERED: :"fax.delivered"
80
90
 
81
- def client_state=: (String) -> String
91
+ def self?.values: -> ::Array[Telnyx::Models::FaxDeliveredWebhookEvent::Data::event_type]
92
+ end
82
93
 
83
- attr_reader connection_id: String?
94
+ type payload =
95
+ {
96
+ call_duration_secs: Integer,
97
+ client_state: String,
98
+ connection_id: String,
99
+ direction: Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::direction,
100
+ fax_id: String,
101
+ from: String,
102
+ media_name: String,
103
+ original_media_url: String,
104
+ page_count: Integer,
105
+ status: Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::status,
106
+ to: String,
107
+ user_id: String
108
+ }
84
109
 
85
- def connection_id=: (String) -> String
110
+ class Payload < Telnyx::Internal::Type::BaseModel
111
+ attr_reader call_duration_secs: Integer?
86
112
 
87
- attr_reader direction: Telnyx::Models::FaxDeliveredWebhookEvent::Payload::direction?
113
+ def call_duration_secs=: (Integer) -> Integer
88
114
 
89
- def direction=: (
90
- Telnyx::Models::FaxDeliveredWebhookEvent::Payload::direction
91
- ) -> Telnyx::Models::FaxDeliveredWebhookEvent::Payload::direction
115
+ attr_reader client_state: String?
92
116
 
93
- attr_reader fax_id: String?
117
+ def client_state=: (String) -> String
94
118
 
95
- def fax_id=: (String) -> String
119
+ attr_reader connection_id: String?
96
120
 
97
- attr_reader from: String?
121
+ def connection_id=: (String) -> String
98
122
 
99
- def from=: (String) -> String
123
+ attr_reader direction: Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::direction?
100
124
 
101
- attr_reader media_name: String?
125
+ def direction=: (
126
+ Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::direction
127
+ ) -> Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::direction
102
128
 
103
- def media_name=: (String) -> String
129
+ attr_reader fax_id: String?
104
130
 
105
- attr_reader original_media_url: String?
131
+ def fax_id=: (String) -> String
106
132
 
107
- def original_media_url=: (String) -> String
133
+ attr_reader from: String?
108
134
 
109
- attr_reader page_count: Integer?
135
+ def from=: (String) -> String
110
136
 
111
- def page_count=: (Integer) -> Integer
137
+ attr_reader media_name: String?
112
138
 
113
- attr_reader status: Telnyx::Models::FaxDeliveredWebhookEvent::Payload::status?
139
+ def media_name=: (String) -> String
114
140
 
115
- def status=: (
116
- Telnyx::Models::FaxDeliveredWebhookEvent::Payload::status
117
- ) -> Telnyx::Models::FaxDeliveredWebhookEvent::Payload::status
141
+ attr_reader original_media_url: String?
118
142
 
119
- attr_reader to: String?
143
+ def original_media_url=: (String) -> String
120
144
 
121
- def to=: (String) -> String
145
+ attr_reader page_count: Integer?
122
146
 
123
- attr_reader user_id: String?
147
+ def page_count=: (Integer) -> Integer
124
148
 
125
- def user_id=: (String) -> String
149
+ attr_reader status: Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::status?
126
150
 
127
- def initialize: (
128
- ?call_duration_secs: Integer,
129
- ?client_state: String,
130
- ?connection_id: String,
131
- ?direction: Telnyx::Models::FaxDeliveredWebhookEvent::Payload::direction,
132
- ?fax_id: String,
133
- ?from: String,
134
- ?media_name: String,
135
- ?original_media_url: String,
136
- ?page_count: Integer,
137
- ?status: Telnyx::Models::FaxDeliveredWebhookEvent::Payload::status,
138
- ?to: String,
139
- ?user_id: String
140
- ) -> void
151
+ def status=: (
152
+ Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::status
153
+ ) -> Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::status
141
154
 
142
- def to_hash: -> {
143
- call_duration_secs: Integer,
144
- client_state: String,
145
- connection_id: String,
146
- direction: Telnyx::Models::FaxDeliveredWebhookEvent::Payload::direction,
147
- fax_id: String,
148
- from: String,
149
- media_name: String,
150
- original_media_url: String,
151
- page_count: Integer,
152
- status: Telnyx::Models::FaxDeliveredWebhookEvent::Payload::status,
153
- to: String,
154
- user_id: String
155
- }
155
+ attr_reader to: String?
156
156
 
157
- type direction = :inbound | :outbound
157
+ def to=: (String) -> String
158
158
 
159
- module Direction
160
- extend Telnyx::Internal::Type::Enum
159
+ attr_reader user_id: String?
160
+
161
+ def user_id=: (String) -> String
162
+
163
+ def initialize: (
164
+ ?call_duration_secs: Integer,
165
+ ?client_state: String,
166
+ ?connection_id: String,
167
+ ?direction: Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::direction,
168
+ ?fax_id: String,
169
+ ?from: String,
170
+ ?media_name: String,
171
+ ?original_media_url: String,
172
+ ?page_count: Integer,
173
+ ?status: Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::status,
174
+ ?to: String,
175
+ ?user_id: String
176
+ ) -> void
177
+
178
+ def to_hash: -> {
179
+ call_duration_secs: Integer,
180
+ client_state: String,
181
+ connection_id: String,
182
+ direction: Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::direction,
183
+ fax_id: String,
184
+ from: String,
185
+ media_name: String,
186
+ original_media_url: String,
187
+ page_count: Integer,
188
+ status: Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::status,
189
+ to: String,
190
+ user_id: String
191
+ }
161
192
 
162
- INBOUND: :inbound
163
- OUTBOUND: :outbound
193
+ type direction = :inbound | :outbound
164
194
 
165
- def self?.values: -> ::Array[Telnyx::Models::FaxDeliveredWebhookEvent::Payload::direction]
195
+ module Direction
196
+ extend Telnyx::Internal::Type::Enum
197
+
198
+ INBOUND: :inbound
199
+ OUTBOUND: :outbound
200
+
201
+ def self?.values: -> ::Array[Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::direction]
202
+ end
203
+
204
+ type status = :delivered
205
+
206
+ module Status
207
+ extend Telnyx::Internal::Type::Enum
208
+
209
+ DELIVERED: :delivered
210
+
211
+ def self?.values: -> ::Array[Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::status]
212
+ end
166
213
  end
167
214
 
168
- type status = :delivered
215
+ type record_type = :event
169
216
 
170
- module Status
217
+ module RecordType
171
218
  extend Telnyx::Internal::Type::Enum
172
219
 
173
- DELIVERED: :delivered
220
+ EVENT: :event
174
221
 
175
- def self?.values: -> ::Array[Telnyx::Models::FaxDeliveredWebhookEvent::Payload::status]
222
+ def self?.values: -> ::Array[Telnyx::Models::FaxDeliveredWebhookEvent::Data::record_type]
176
223
  end
177
224
  end
178
225
 
179
- type record_type = :event
226
+ type meta = { attempt: Integer, delivered_to: String }
227
+
228
+ class Meta < Telnyx::Internal::Type::BaseModel
229
+ attr_reader attempt: Integer?
230
+
231
+ def attempt=: (Integer) -> Integer
232
+
233
+ attr_reader delivered_to: String?
180
234
 
181
- module RecordType
182
- extend Telnyx::Internal::Type::Enum
235
+ def delivered_to=: (String) -> String
183
236
 
184
- EVENT: :event
237
+ def initialize: (?attempt: Integer, ?delivered_to: String) -> void
185
238
 
186
- def self?.values: -> ::Array[Telnyx::Models::FaxDeliveredWebhookEvent::record_type]
239
+ def to_hash: -> { attempt: Integer, delivered_to: String }
187
240
  end
188
241
  end
189
242
  end