Class: Telnyx::Models::InboundMessageWebhookEvent::Data::Payload::Cc

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/inbound_message_webhook_event.rb,
sig/telnyx/models/inbound_message_webhook_event.rbs

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:



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
# File 'lib/telnyx/models/inbound_message_webhook_event.rb', line 303

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::InboundMessageWebhookEvent::Data::Payload::Cc::LineType, nil]
  optional :line_type, enum: -> { Telnyx::InboundMessageWebhookEvent::Data::Payload::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::InboundMessageWebhookEvent::Data::Payload::Cc::Status, nil]
  optional :status, enum: -> { Telnyx::InboundMessageWebhookEvent::Data::Payload::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::InboundMessageWebhookEvent::Data::Payload::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::InboundMessageWebhookEvent::Data::Payload::Cc::Status]

  # The line-type of the receiver.
  #
  # @see Telnyx::Models::InboundMessageWebhookEvent::Data::Payload::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::InboundMessageWebhookEvent::Data::Payload::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

#carrierString?

The carrier of the receiver.

Parameters:

  • (String)

Returns:

  • (String, nil)


308
# File 'lib/telnyx/models/inbound_message_webhook_event.rb', line 308

optional :carrier, String

#line_typeSymbol, ...

The line-type of the receiver.



314
# File 'lib/telnyx/models/inbound_message_webhook_event.rb', line 314

optional :line_type, enum: -> { Telnyx::InboundMessageWebhookEvent::Data::Payload::Cc::LineType }

#phone_numberString?

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

Parameters:

  • (String)

Returns:

  • (String, nil)


320
# File 'lib/telnyx/models/inbound_message_webhook_event.rb', line 320

optional :phone_number, String

#statusSymbol, ...



325
# File 'lib/telnyx/models/inbound_message_webhook_event.rb', line 325

optional :status, enum: -> { Telnyx::InboundMessageWebhookEvent::Data::Payload::Cc::Status }

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/telnyx/models/inbound_message_webhook_event.rb', line 349

Instance Method Details

#to_hash{

Returns:

  • ({)


318
# File 'sig/telnyx/models/inbound_message_webhook_event.rbs', line 318

def to_hash: -> {