telnyx 5.41.0 → 5.42.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.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/calls/action_answer_params.rb +57 -1
  5. data/lib/telnyx/models/calls/action_bridge_params.rb +10 -1
  6. data/lib/telnyx/models/calls/action_hangup_params.rb +9 -1
  7. data/lib/telnyx/models/payment_create_stored_payment_transaction_params.rb +22 -0
  8. data/lib/telnyx/models/payment_create_stored_payment_transaction_response.rb +91 -0
  9. data/lib/telnyx/models/queue_create_params.rb +30 -0
  10. data/lib/telnyx/models/queue_create_response.rb +97 -0
  11. data/lib/telnyx/models/queue_delete_params.rb +14 -0
  12. data/lib/telnyx/models/queue_list_params.rb +30 -0
  13. data/lib/telnyx/models/queue_list_response.rb +86 -0
  14. data/lib/telnyx/models/queue_update_params.rb +22 -0
  15. data/lib/telnyx/models/queue_update_response.rb +97 -0
  16. data/lib/telnyx/models.rb +10 -0
  17. data/lib/telnyx/resources/calls/actions.rb +13 -3
  18. data/lib/telnyx/resources/payment.rb +22 -0
  19. data/lib/telnyx/resources/queues.rb +93 -0
  20. data/lib/telnyx/version.rb +1 -1
  21. data/lib/telnyx.rb +9 -0
  22. data/rbi/telnyx/models/calls/action_answer_params.rbi +146 -0
  23. data/rbi/telnyx/models/calls/action_bridge_params.rbi +13 -0
  24. data/rbi/telnyx/models/calls/action_hangup_params.rbi +13 -0
  25. data/rbi/telnyx/models/payment_create_stored_payment_transaction_params.rbi +43 -0
  26. data/rbi/telnyx/models/payment_create_stored_payment_transaction_response.rbi +235 -0
  27. data/rbi/telnyx/models/queue_create_params.rbi +54 -0
  28. data/rbi/telnyx/models/queue_create_response.rbi +160 -0
  29. data/rbi/telnyx/models/queue_delete_params.rbi +27 -0
  30. data/rbi/telnyx/models/queue_list_params.rbi +57 -0
  31. data/rbi/telnyx/models/queue_list_response.rbi +122 -0
  32. data/rbi/telnyx/models/queue_update_params.rbi +40 -0
  33. data/rbi/telnyx/models/queue_update_response.rbi +160 -0
  34. data/rbi/telnyx/models.rbi +11 -0
  35. data/rbi/telnyx/resources/calls/actions.rbi +25 -0
  36. data/rbi/telnyx/resources/payment.rbi +14 -0
  37. data/rbi/telnyx/resources/queues.rbi +69 -0
  38. data/sig/telnyx/models/calls/action_answer_params.rbs +49 -1
  39. data/sig/telnyx/models/calls/action_bridge_params.rbs +7 -0
  40. data/sig/telnyx/models/calls/action_hangup_params.rbs +13 -1
  41. data/sig/telnyx/models/payment_create_stored_payment_transaction_params.rbs +23 -0
  42. data/sig/telnyx/models/payment_create_stored_payment_transaction_response.rbs +116 -0
  43. data/sig/telnyx/models/queue_create_params.rbs +30 -0
  44. data/sig/telnyx/models/queue_create_response.rbs +80 -0
  45. data/sig/telnyx/models/queue_delete_params.rbs +14 -0
  46. data/sig/telnyx/models/queue_list_params.rbs +32 -0
  47. data/sig/telnyx/models/queue_list_response.rbs +65 -0
  48. data/sig/telnyx/models/queue_update_params.rbs +23 -0
  49. data/sig/telnyx/models/queue_update_response.rbs +80 -0
  50. data/sig/telnyx/models.rbs +10 -0
  51. data/sig/telnyx/resources/calls/actions.rbs +5 -0
  52. data/sig/telnyx/resources/payment.rbs +5 -0
  53. data/sig/telnyx/resources/queues.rbs +23 -0
  54. metadata +28 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: eb4611fdc07e052850cd0d14258d628088de0a8cea430674691259bf8141af79
4
- data.tar.gz: bf2b6ebe2d72d9c1aca45d4d3d6b36f7f3504cc9d059fab75e8e7ec46ba9153d
3
+ metadata.gz: 138ead5bf4f50b5046b2685d02d3416ce75e1697f666004ba06548c2391d30d7
4
+ data.tar.gz: a2f0ad97452c890325aff5e52a961ef3cb2d5d9a62993149c399acedaa2df25a
5
5
  SHA512:
6
- metadata.gz: 380b0cf54fcf0f2927117dc5d6c85af1f4d674ebcf50e5e65b93205762193055c2089dfea221ae42d9a5fa186dc8125b444430f6b894a29c65336077f2744fbf
7
- data.tar.gz: c6c74babd6a564947e71650861928050687029705224ab767cc7a127982aa2ed5b0f9faaf180a6b24617e1441b9cc1690a1c684b77f093692ac31b22db5f8aeb
6
+ metadata.gz: 950291edb200b07944774c865646304cb42428494654a8e79ff76ce7731d944d5679d98d58ccd350473e6b64308c748cb149dc37ffe1d46072965effc5faff37
7
+ data.tar.gz: 345eada6283afc7507f0d35cce26c9a0fb3e6ebea389314b6a4402e5d53a40ff565acc613a1845fae2955c48b4298cd83fae708eed48006f54886824f04a49f8
data/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## 5.42.0 (2026-02-25)
4
+
5
+ Full Changelog: [v5.41.0...v5.42.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.41.0...v5.42.0)
6
+
7
+ ### Features
8
+
9
+ * PORTAL-5923: Add stored_payment_transactions endpoint to OpenAPI docs ([24a4227](https://github.com/team-telnyx/telnyx-ruby/commit/24a422719b6c6d2c0926de5cc7cde8ce5f856d1e))
10
+
11
+
12
+ ### Documentation
13
+
14
+ * **call-control:** Add missing params to hangup, bridge, answer ([226b831](https://github.com/team-telnyx/telnyx-ruby/commit/226b83115dc78fe81d8a2b261b7f410e5431a624))
15
+ * **call-control:** Add queue CRUD endpoints ([a507591](https://github.com/team-telnyx/telnyx-ruby/commit/a50759135b22ff1ffd49fa05f511c7298850c7aa))
16
+
3
17
  ## 5.41.0 (2026-02-25)
4
18
 
5
19
  Full Changelog: [v5.40.0...v5.41.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.40.0...v5.41.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.41.0"
27
+ gem "telnyx", "~> 5.42.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -169,6 +169,15 @@ module Telnyx
169
169
  # @return [Telnyx::Models::Calls::TranscriptionStartRequest, nil]
170
170
  optional :transcription_config, -> { Telnyx::Calls::TranscriptionStartRequest }
171
171
 
172
+ # @!attribute webhook_retries_policies
173
+ # A map of event types to retry policies. Each retry policy contains an array of
174
+ # `retries_ms` specifying the delays between retry attempts in milliseconds.
175
+ # Maximum 5 retries, total delay cannot exceed 60 seconds.
176
+ #
177
+ # @return [Hash{Symbol=>Telnyx::Models::Calls::ActionAnswerParams::WebhookRetriesPolicy}, nil]
178
+ optional :webhook_retries_policies,
179
+ -> { Telnyx::Internal::Type::HashOf[Telnyx::Calls::ActionAnswerParams::WebhookRetriesPolicy] }
180
+
172
181
  # @!attribute webhook_url
173
182
  # Use this field to override the URL for which Telnyx will send subsequent
174
183
  # webhooks to for this call.
@@ -182,7 +191,21 @@ module Telnyx
182
191
  # @return [Symbol, Telnyx::Models::Calls::ActionAnswerParams::WebhookURLMethod, nil]
183
192
  optional :webhook_url_method, enum: -> { Telnyx::Calls::ActionAnswerParams::WebhookURLMethod }
184
193
 
185
- # @!method initialize(billing_group_id: nil, client_state: nil, command_id: nil, custom_headers: nil, preferred_codecs: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_headers: nil, sound_modifications: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_track: nil, stream_url: nil, transcription: nil, transcription_config: nil, webhook_url: nil, webhook_url_method: nil, request_options: {})
194
+ # @!attribute webhook_urls
195
+ # A map of event types to webhook URLs. When an event of the specified type
196
+ # occurs, the webhook URL associated with that event type will be called instead
197
+ # of `webhook_url`. Events not mapped here will use the default `webhook_url`.
198
+ #
199
+ # @return [Hash{Symbol=>String}, nil]
200
+ optional :webhook_urls, Telnyx::Internal::Type::HashOf[String]
201
+
202
+ # @!attribute webhook_urls_method
203
+ # HTTP request method to invoke `webhook_urls`.
204
+ #
205
+ # @return [Symbol, Telnyx::Models::Calls::ActionAnswerParams::WebhookURLsMethod, nil]
206
+ optional :webhook_urls_method, enum: -> { Telnyx::Calls::ActionAnswerParams::WebhookURLsMethod }
207
+
208
+ # @!method initialize(billing_group_id: nil, client_state: nil, command_id: nil, custom_headers: nil, preferred_codecs: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_headers: nil, sound_modifications: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_track: nil, stream_url: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
186
209
  # Some parameter documentations has been truncated, see
187
210
  # {Telnyx::Models::Calls::ActionAnswerParams} for more details.
188
211
  #
@@ -235,10 +258,16 @@ module Telnyx
235
258
  #
236
259
  # @param transcription_config [Telnyx::Models::Calls::TranscriptionStartRequest]
237
260
  #
261
+ # @param webhook_retries_policies [Hash{Symbol=>Telnyx::Models::Calls::ActionAnswerParams::WebhookRetriesPolicy}] A map of event types to retry policies. Each retry policy contains an array of `
262
+ #
238
263
  # @param webhook_url [String] Use this field to override the URL for which Telnyx will send subsequent webhook
239
264
  #
240
265
  # @param webhook_url_method [Symbol, Telnyx::Models::Calls::ActionAnswerParams::WebhookURLMethod] HTTP request type used for `webhook_url`.
241
266
  #
267
+ # @param webhook_urls [Hash{Symbol=>String}] A map of event types to webhook URLs. When an event of the specified type occurs
268
+ #
269
+ # @param webhook_urls_method [Symbol, Telnyx::Models::Calls::ActionAnswerParams::WebhookURLsMethod] HTTP request method to invoke `webhook_urls`.
270
+ #
242
271
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
243
272
 
244
273
  # The list of comma-separated codecs in a preferred order for the forked media to
@@ -322,6 +351,22 @@ module Telnyx
322
351
  # @return [Array<Symbol>]
323
352
  end
324
353
 
354
+ class WebhookRetriesPolicy < Telnyx::Internal::Type::BaseModel
355
+ # @!attribute retries_ms
356
+ # Array of delays in milliseconds between retry attempts. Total sum cannot exceed
357
+ # 60000ms.
358
+ #
359
+ # @return [Array<Integer>, nil]
360
+ optional :retries_ms, Telnyx::Internal::Type::ArrayOf[Integer]
361
+
362
+ # @!method initialize(retries_ms: nil)
363
+ # Some parameter documentations has been truncated, see
364
+ # {Telnyx::Models::Calls::ActionAnswerParams::WebhookRetriesPolicy} for more
365
+ # details.
366
+ #
367
+ # @param retries_ms [Array<Integer>] Array of delays in milliseconds between retry attempts. Total sum cannot exceed
368
+ end
369
+
325
370
  # HTTP request type used for `webhook_url`.
326
371
  module WebhookURLMethod
327
372
  extend Telnyx::Internal::Type::Enum
@@ -332,6 +377,17 @@ module Telnyx
332
377
  # @!method self.values
333
378
  # @return [Array<Symbol>]
334
379
  end
380
+
381
+ # HTTP request method to invoke `webhook_urls`.
382
+ module WebhookURLsMethod
383
+ extend Telnyx::Internal::Type::Enum
384
+
385
+ POST = :POST
386
+ GET = :GET
387
+
388
+ # @!method self.values
389
+ # @return [Array<Symbol>]
390
+ end
335
391
  end
336
392
  end
337
393
  end
@@ -29,6 +29,13 @@ module Telnyx
29
29
  # @return [String, nil]
30
30
  optional :command_id, String
31
31
 
32
+ # @!attribute hold_after_unbridge
33
+ # Specifies behavior after the bridge ends. If set to `true`, the current leg will
34
+ # be put on hold after unbridge instead of being hung up.
35
+ #
36
+ # @return [Boolean, nil]
37
+ optional :hold_after_unbridge, Telnyx::Internal::Type::Boolean
38
+
32
39
  # @!attribute mute_dtmf
33
40
  # When enabled, DTMF tones are not passed to the call participant. The webhooks
34
41
  # containing the DTMF information will be sent.
@@ -150,7 +157,7 @@ module Telnyx
150
157
  # @return [String, nil]
151
158
  optional :video_room_id, String
152
159
 
153
- # @!method initialize(call_control_id_to_bridge_with:, client_state: nil, command_id: nil, mute_dtmf: nil, park_after_unbridge: nil, play_ringtone: nil, prevent_double_bridge: nil, queue: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, ringtone: nil, video_room_context: nil, video_room_id: nil, request_options: {})
160
+ # @!method initialize(call_control_id_to_bridge_with:, client_state: nil, command_id: nil, hold_after_unbridge: nil, mute_dtmf: nil, park_after_unbridge: nil, play_ringtone: nil, prevent_double_bridge: nil, queue: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, ringtone: nil, video_room_context: nil, video_room_id: nil, request_options: {})
154
161
  # Some parameter documentations has been truncated, see
155
162
  # {Telnyx::Models::Calls::ActionBridgeParams} for more details.
156
163
  #
@@ -160,6 +167,8 @@ module Telnyx
160
167
  #
161
168
  # @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
162
169
  #
170
+ # @param hold_after_unbridge [Boolean] Specifies behavior after the bridge ends. If set to `true`, the current leg will
171
+ #
163
172
  # @param mute_dtmf [Symbol, Telnyx::Models::Calls::ActionBridgeParams::MuteDtmf] When enabled, DTMF tones are not passed to the call participant. The webhooks co
164
173
  #
165
174
  # @param park_after_unbridge [String] Specifies behavior after the bridge ends (i.e. the opposite leg either hangs up
@@ -22,7 +22,13 @@ module Telnyx
22
22
  # @return [String, nil]
23
23
  optional :command_id, String
24
24
 
25
- # @!method initialize(client_state: nil, command_id: nil, request_options: {})
25
+ # @!attribute custom_headers
26
+ # Custom headers to be added to the SIP BYE message.
27
+ #
28
+ # @return [Array<Telnyx::Models::CustomSipHeader>, nil]
29
+ optional :custom_headers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::CustomSipHeader] }
30
+
31
+ # @!method initialize(client_state: nil, command_id: nil, custom_headers: nil, request_options: {})
26
32
  # Some parameter documentations has been truncated, see
27
33
  # {Telnyx::Models::Calls::ActionHangupParams} for more details.
28
34
  #
@@ -30,6 +36,8 @@ module Telnyx
30
36
  #
31
37
  # @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
32
38
  #
39
+ # @param custom_headers [Array<Telnyx::Models::CustomSipHeader>] Custom headers to be added to the SIP BYE message.
40
+ #
33
41
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
34
42
  end
35
43
  end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::Payment#create_stored_payment_transaction
6
+ class PaymentCreateStoredPaymentTransactionParams < Telnyx::Internal::Type::BaseModel
7
+ extend Telnyx::Internal::Type::RequestParameters::Converter
8
+ include Telnyx::Internal::Type::RequestParameters
9
+
10
+ # @!attribute amount
11
+ # Amount in dollars and cents, e.g. "120.00"
12
+ #
13
+ # @return [String]
14
+ required :amount, String
15
+
16
+ # @!method initialize(amount:, request_options: {})
17
+ # @param amount [String] Amount in dollars and cents, e.g. "120.00"
18
+ #
19
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,91 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::Payment#create_stored_payment_transaction
6
+ class PaymentCreateStoredPaymentTransactionResponse < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data, nil]
10
+ optional :data, -> { Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data }
11
+
12
+ # @!method initialize(data: nil)
13
+ # @param data [Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data]
14
+
15
+ # @see Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse#data
16
+ class Data < Telnyx::Internal::Type::BaseModel
17
+ # @!attribute id
18
+ #
19
+ # @return [String, nil]
20
+ optional :id, String
21
+
22
+ # @!attribute amount_cents
23
+ #
24
+ # @return [Integer, nil]
25
+ optional :amount_cents, Integer
26
+
27
+ # @!attribute amount_currency
28
+ #
29
+ # @return [String, nil]
30
+ optional :amount_currency, String
31
+
32
+ # @!attribute auto_recharge
33
+ #
34
+ # @return [Boolean, nil]
35
+ optional :auto_recharge, Telnyx::Internal::Type::Boolean
36
+
37
+ # @!attribute created_at
38
+ #
39
+ # @return [Time, nil]
40
+ optional :created_at, Time
41
+
42
+ # @!attribute processor_status
43
+ #
44
+ # @return [String, nil]
45
+ optional :processor_status, String
46
+
47
+ # @!attribute record_type
48
+ #
49
+ # @return [Symbol, Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::RecordType, nil]
50
+ optional :record_type,
51
+ enum: -> { Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::RecordType }
52
+
53
+ # @!attribute transaction_processing_type
54
+ #
55
+ # @return [Symbol, Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::TransactionProcessingType, nil]
56
+ optional :transaction_processing_type,
57
+ enum: -> { Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::TransactionProcessingType }
58
+
59
+ # @!method initialize(id: nil, amount_cents: nil, amount_currency: nil, auto_recharge: nil, created_at: nil, processor_status: nil, record_type: nil, transaction_processing_type: nil)
60
+ # @param id [String]
61
+ # @param amount_cents [Integer]
62
+ # @param amount_currency [String]
63
+ # @param auto_recharge [Boolean]
64
+ # @param created_at [Time]
65
+ # @param processor_status [String]
66
+ # @param record_type [Symbol, Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::RecordType]
67
+ # @param transaction_processing_type [Symbol, Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::TransactionProcessingType]
68
+
69
+ # @see Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data#record_type
70
+ module RecordType
71
+ extend Telnyx::Internal::Type::Enum
72
+
73
+ TRANSACTION = :transaction
74
+
75
+ # @!method self.values
76
+ # @return [Array<Symbol>]
77
+ end
78
+
79
+ # @see Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data#transaction_processing_type
80
+ module TransactionProcessingType
81
+ extend Telnyx::Internal::Type::Enum
82
+
83
+ STORED_PAYMENT = :stored_payment
84
+
85
+ # @!method self.values
86
+ # @return [Array<Symbol>]
87
+ end
88
+ end
89
+ end
90
+ end
91
+ end
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::Queues#create
6
+ class QueueCreateParams < Telnyx::Internal::Type::BaseModel
7
+ extend Telnyx::Internal::Type::RequestParameters::Converter
8
+ include Telnyx::Internal::Type::RequestParameters
9
+
10
+ # @!attribute queue_name
11
+ # The name of the queue. Must be between 1 and 255 characters.
12
+ #
13
+ # @return [String]
14
+ required :queue_name, String
15
+
16
+ # @!attribute max_size
17
+ # The maximum number of calls allowed in the queue.
18
+ #
19
+ # @return [Integer, nil]
20
+ optional :max_size, Integer
21
+
22
+ # @!method initialize(queue_name:, max_size: nil, request_options: {})
23
+ # @param queue_name [String] The name of the queue. Must be between 1 and 255 characters.
24
+ #
25
+ # @param max_size [Integer] The maximum number of calls allowed in the queue.
26
+ #
27
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,97 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::Queues#create
6
+ class QueueCreateResponse < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [Telnyx::Models::QueueCreateResponse::Data, nil]
10
+ optional :data, -> { Telnyx::Models::QueueCreateResponse::Data }
11
+
12
+ # @!method initialize(data: nil)
13
+ # @param data [Telnyx::Models::QueueCreateResponse::Data]
14
+
15
+ # @see Telnyx::Models::QueueCreateResponse#data
16
+ class Data < Telnyx::Internal::Type::BaseModel
17
+ # @!attribute id
18
+ # Uniquely identifies the queue
19
+ #
20
+ # @return [String]
21
+ required :id, String
22
+
23
+ # @!attribute average_wait_time_secs
24
+ # The average time that the calls currently in the queue have spent waiting, given
25
+ # in seconds.
26
+ #
27
+ # @return [Integer]
28
+ required :average_wait_time_secs, Integer
29
+
30
+ # @!attribute created_at
31
+ # ISO 8601 formatted date of when the queue was created
32
+ #
33
+ # @return [String]
34
+ required :created_at, String
35
+
36
+ # @!attribute current_size
37
+ # The number of calls currently in the queue
38
+ #
39
+ # @return [Integer]
40
+ required :current_size, Integer
41
+
42
+ # @!attribute max_size
43
+ # The maximum number of calls allowed in the queue
44
+ #
45
+ # @return [Integer]
46
+ required :max_size, Integer
47
+
48
+ # @!attribute name
49
+ # Name of the queue
50
+ #
51
+ # @return [String]
52
+ required :name, String
53
+
54
+ # @!attribute record_type
55
+ #
56
+ # @return [Symbol, Telnyx::Models::QueueCreateResponse::Data::RecordType]
57
+ required :record_type, enum: -> { Telnyx::Models::QueueCreateResponse::Data::RecordType }
58
+
59
+ # @!attribute updated_at
60
+ # ISO 8601 formatted date of when the queue was last updated
61
+ #
62
+ # @return [String]
63
+ required :updated_at, String
64
+
65
+ # @!method initialize(id:, average_wait_time_secs:, created_at:, current_size:, max_size:, name:, record_type:, updated_at:)
66
+ # Some parameter documentations has been truncated, see
67
+ # {Telnyx::Models::QueueCreateResponse::Data} for more details.
68
+ #
69
+ # @param id [String] Uniquely identifies the queue
70
+ #
71
+ # @param average_wait_time_secs [Integer] The average time that the calls currently in the queue have spent waiting, given
72
+ #
73
+ # @param created_at [String] ISO 8601 formatted date of when the queue was created
74
+ #
75
+ # @param current_size [Integer] The number of calls currently in the queue
76
+ #
77
+ # @param max_size [Integer] The maximum number of calls allowed in the queue
78
+ #
79
+ # @param name [String] Name of the queue
80
+ #
81
+ # @param record_type [Symbol, Telnyx::Models::QueueCreateResponse::Data::RecordType]
82
+ #
83
+ # @param updated_at [String] ISO 8601 formatted date of when the queue was last updated
84
+
85
+ # @see Telnyx::Models::QueueCreateResponse::Data#record_type
86
+ module RecordType
87
+ extend Telnyx::Internal::Type::Enum
88
+
89
+ QUEUE = :queue
90
+
91
+ # @!method self.values
92
+ # @return [Array<Symbol>]
93
+ end
94
+ end
95
+ end
96
+ end
97
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::Queues#delete
6
+ class QueueDeleteParams < Telnyx::Internal::Type::BaseModel
7
+ extend Telnyx::Internal::Type::RequestParameters::Converter
8
+ include Telnyx::Internal::Type::RequestParameters
9
+
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::Queues#list
6
+ class QueueListParams < Telnyx::Internal::Type::BaseModel
7
+ extend Telnyx::Internal::Type::RequestParameters::Converter
8
+ include Telnyx::Internal::Type::RequestParameters
9
+
10
+ # @!attribute page_number
11
+ # The page number to load
12
+ #
13
+ # @return [Integer, nil]
14
+ optional :page_number, Integer
15
+
16
+ # @!attribute page_size
17
+ # The size of the page
18
+ #
19
+ # @return [Integer, nil]
20
+ optional :page_size, Integer
21
+
22
+ # @!method initialize(page_number: nil, page_size: nil, request_options: {})
23
+ # @param page_number [Integer] The page number to load
24
+ #
25
+ # @param page_size [Integer] The size of the page
26
+ #
27
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,86 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::Queues#list
6
+ class QueueListResponse < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # Uniquely identifies the queue
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute average_wait_time_secs
14
+ # The average time that the calls currently in the queue have spent waiting, given
15
+ # in seconds.
16
+ #
17
+ # @return [Integer]
18
+ required :average_wait_time_secs, Integer
19
+
20
+ # @!attribute created_at
21
+ # ISO 8601 formatted date of when the queue was created
22
+ #
23
+ # @return [String]
24
+ required :created_at, String
25
+
26
+ # @!attribute current_size
27
+ # The number of calls currently in the queue
28
+ #
29
+ # @return [Integer]
30
+ required :current_size, Integer
31
+
32
+ # @!attribute max_size
33
+ # The maximum number of calls allowed in the queue
34
+ #
35
+ # @return [Integer]
36
+ required :max_size, Integer
37
+
38
+ # @!attribute name
39
+ # Name of the queue
40
+ #
41
+ # @return [String]
42
+ required :name, String
43
+
44
+ # @!attribute record_type
45
+ #
46
+ # @return [Symbol, Telnyx::Models::QueueListResponse::RecordType]
47
+ required :record_type, enum: -> { Telnyx::Models::QueueListResponse::RecordType }
48
+
49
+ # @!attribute updated_at
50
+ # ISO 8601 formatted date of when the queue was last updated
51
+ #
52
+ # @return [String]
53
+ required :updated_at, String
54
+
55
+ # @!method initialize(id:, average_wait_time_secs:, created_at:, current_size:, max_size:, name:, record_type:, updated_at:)
56
+ # Some parameter documentations has been truncated, see
57
+ # {Telnyx::Models::QueueListResponse} for more details.
58
+ #
59
+ # @param id [String] Uniquely identifies the queue
60
+ #
61
+ # @param average_wait_time_secs [Integer] The average time that the calls currently in the queue have spent waiting, given
62
+ #
63
+ # @param created_at [String] ISO 8601 formatted date of when the queue was created
64
+ #
65
+ # @param current_size [Integer] The number of calls currently in the queue
66
+ #
67
+ # @param max_size [Integer] The maximum number of calls allowed in the queue
68
+ #
69
+ # @param name [String] Name of the queue
70
+ #
71
+ # @param record_type [Symbol, Telnyx::Models::QueueListResponse::RecordType]
72
+ #
73
+ # @param updated_at [String] ISO 8601 formatted date of when the queue was last updated
74
+
75
+ # @see Telnyx::Models::QueueListResponse#record_type
76
+ module RecordType
77
+ extend Telnyx::Internal::Type::Enum
78
+
79
+ QUEUE = :queue
80
+
81
+ # @!method self.values
82
+ # @return [Array<Symbol>]
83
+ end
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::Queues#update
6
+ class QueueUpdateParams < Telnyx::Internal::Type::BaseModel
7
+ extend Telnyx::Internal::Type::RequestParameters::Converter
8
+ include Telnyx::Internal::Type::RequestParameters
9
+
10
+ # @!attribute max_size
11
+ # The maximum number of calls allowed in the queue.
12
+ #
13
+ # @return [Integer]
14
+ required :max_size, Integer
15
+
16
+ # @!method initialize(max_size:, request_options: {})
17
+ # @param max_size [Integer] The maximum number of calls allowed in the queue.
18
+ #
19
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end