Class: Telnyx::Models::OutboundMessagePayload::Cc

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/outbound_message_payload.rb

Defined Under Namespace

Modules: LineType, Status

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(carrier: nil, line_type: nil, phone_number: nil, status: nil) ⇒ Object

Parameters:



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/telnyx/models/outbound_message_payload.rb', line 257

class Cc < Telnyx::Internal::Type::BaseModel
  # @!attribute carrier
  #   The carrier of the receiver.
  #
  #   @return [String, nil]
  optional :carrier, String

  # @!attribute line_type
  #   The line-type of the receiver.
  #
  #   @return [Symbol, Telnyx::Models::OutboundMessagePayload::Cc::LineType, nil]
  optional :line_type, enum: -> { Telnyx::OutboundMessagePayload::Cc::LineType }

  # @!attribute phone_number
  #   Receiving address (+E.164 formatted phone number or short code).
  #
  #   @return [String, nil]
  optional :phone_number, String

  # @!attribute status
  #
  #   @return [Symbol, Telnyx::Models::OutboundMessagePayload::Cc::Status, nil]
  optional :status, enum: -> { Telnyx::OutboundMessagePayload::Cc::Status }

  # @!method initialize(carrier: nil, line_type: nil, phone_number: nil, status: nil)
  #   @param carrier [String] The carrier of the receiver.
  #
  #   @param line_type [Symbol, Telnyx::Models::OutboundMessagePayload::Cc::LineType] The line-type of the receiver.
  #
  #   @param phone_number [String] Receiving address (+E.164 formatted phone number or short code).
  #
  #   @param status [Symbol, Telnyx::Models::OutboundMessagePayload::Cc::Status]

  # The line-type of the receiver.
  #
  # @see Telnyx::Models::OutboundMessagePayload::Cc#line_type
  module LineType
    extend Telnyx::Internal::Type::Enum

    WIRELINE = :Wireline
    WIRELESS = :Wireless
    VO_WI_FI = :VoWiFi
    VO_IP = :VoIP
    PRE_PAID_WIRELESS = :"Pre-Paid Wireless"
    EMPTY = :""

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Telnyx::Models::OutboundMessagePayload::Cc#status
  module Status
    extend Telnyx::Internal::Type::Enum

    QUEUED = :queued
    SENDING = :sending
    SENT = :sent
    DELIVERED = :delivered
    SENDING_FAILED = :sending_failed
    DELIVERY_FAILED = :delivery_failed
    DELIVERY_UNCONFIRMED = :delivery_unconfirmed

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#carrier ⇒ String?

The carrier of the receiver.

Returns:

  • (String, nil) 


262
 
# File 'lib/telnyx/models/outbound_message_payload.rb', line 262

optional :carrier, String

#line_type ⇒ Symbol, ...

The line-type of the receiver.

Returns:



268
 
# File 'lib/telnyx/models/outbound_message_payload.rb', line 268

optional :line_type, enum: -> { Telnyx::OutboundMessagePayload::Cc::LineType }

#phone_number ⇒ String?

Receiving address (+E.164 formatted phone number or short code).

Returns:

  • (String, nil) 


274
 
# File 'lib/telnyx/models/outbound_message_payload.rb', line 274

optional :phone_number, String

#status ⇒ Symbol, ...

Returns:



279
 
# File 'lib/telnyx/models/outbound_message_payload.rb', line 279

optional :status, enum: -> { Telnyx::OutboundMessagePayload::Cc::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/outbound_message_payload.rb', line 303