telnyx 5.162.0 → 5.164.0

data/sig/telnyx/models/messaging_inbound_message_payload.rbs

@@ -0,0 +1,595 @@
+module Telnyx
+  module Models
+    type messaging_inbound_message_payload =
+      {
+        id: String,
+        cc: ::Array[Telnyx::MessagingInboundMessagePayload::Cc],
+        completed_at: Time?,
+        cost: Telnyx::MessagingInboundMessagePayload::Cost?,
+        cost_breakdown: Telnyx::MessagingInboundMessagePayload::CostBreakdown?,
+        direction: Telnyx::Models::MessagingInboundMessagePayload::direction,
+        encoding: String,
+        errors: ::Array[Telnyx::MessagingError0b38e7044b],
+        from: Telnyx::MessagingInboundMessagePayload::From,
+        media: ::Array[Telnyx::MessagingInboundMessagePayload::Media],
+        messaging_profile_id: String,
+        num_chars: Integer,
+        organization_id: String,
+        parts: Integer,
+        received_at: Time,
+        record_type: Telnyx::Models::MessagingInboundMessagePayload::record_type,
+        sent_at: Time?,
+        subject: String?,
+        tags: ::Array[String],
+        tcr_campaign_billable: bool,
+        tcr_campaign_id: String?,
+        tcr_campaign_registered: String?,
+        text: String,
+        to: ::Array[Telnyx::MessagingInboundMessagePayload::To],
+        type: Telnyx::Models::MessagingInboundMessagePayload::type_,
+        valid_until: Time?,
+        webhook_failover_url: String?,
+        webhook_url: String?
+      }
+
+    class MessagingInboundMessagePayload < Telnyx::Internal::Type::BaseModel
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader cc: ::Array[Telnyx::MessagingInboundMessagePayload::Cc]?
+
+      def cc=: (
+        ::Array[Telnyx::MessagingInboundMessagePayload::Cc]
+      ) -> ::Array[Telnyx::MessagingInboundMessagePayload::Cc]
+
+      attr_accessor completed_at: Time?
+
+      attr_accessor cost: Telnyx::MessagingInboundMessagePayload::Cost?
+
+      attr_accessor cost_breakdown: Telnyx::MessagingInboundMessagePayload::CostBreakdown?
+
+      attr_reader direction: Telnyx::Models::MessagingInboundMessagePayload::direction?
+
+      def direction=: (
+        Telnyx::Models::MessagingInboundMessagePayload::direction
+      ) -> Telnyx::Models::MessagingInboundMessagePayload::direction
+
+      attr_reader encoding: String?
+
+      def encoding=: (String) -> String
+
+      attr_reader errors: ::Array[Telnyx::MessagingError0b38e7044b]?
+
+      def errors=: (
+        ::Array[Telnyx::MessagingError0b38e7044b]
+      ) -> ::Array[Telnyx::MessagingError0b38e7044b]
+
+      attr_reader from: Telnyx::MessagingInboundMessagePayload::From?
+
+      def from=: (
+        Telnyx::MessagingInboundMessagePayload::From
+      ) -> Telnyx::MessagingInboundMessagePayload::From
+
+      attr_reader media: ::Array[Telnyx::MessagingInboundMessagePayload::Media]?
+
+      def media=: (
+        ::Array[Telnyx::MessagingInboundMessagePayload::Media]
+      ) -> ::Array[Telnyx::MessagingInboundMessagePayload::Media]
+
+      attr_reader messaging_profile_id: String?
+
+      def messaging_profile_id=: (String) -> String
+
+      attr_reader num_chars: Integer?
+
+      def num_chars=: (Integer) -> Integer
+
+      attr_reader organization_id: String?
+
+      def organization_id=: (String) -> String
+
+      attr_reader parts: Integer?
+
+      def parts=: (Integer) -> Integer
+
+      attr_reader received_at: Time?
+
+      def received_at=: (Time) -> Time
+
+      attr_reader record_type: Telnyx::Models::MessagingInboundMessagePayload::record_type?
+
+      def record_type=: (
+        Telnyx::Models::MessagingInboundMessagePayload::record_type
+      ) -> Telnyx::Models::MessagingInboundMessagePayload::record_type
+
+      attr_accessor sent_at: Time?
+
+      attr_accessor subject: String?
+
+      attr_reader tags: ::Array[String]?
+
+      def tags=: (::Array[String]) -> ::Array[String]
+
+      attr_reader tcr_campaign_billable: bool?
+
+      def tcr_campaign_billable=: (bool) -> bool
+
+      attr_accessor tcr_campaign_id: String?
+
+      attr_accessor tcr_campaign_registered: String?
+
+      attr_reader text: String?
+
+      def text=: (String) -> String
+
+      attr_reader to: ::Array[Telnyx::MessagingInboundMessagePayload::To]?
+
+      def to=: (
+        ::Array[Telnyx::MessagingInboundMessagePayload::To]
+      ) -> ::Array[Telnyx::MessagingInboundMessagePayload::To]
+
+      attr_reader type: Telnyx::Models::MessagingInboundMessagePayload::type_?
+
+      def type=: (
+        Telnyx::Models::MessagingInboundMessagePayload::type_
+      ) -> Telnyx::Models::MessagingInboundMessagePayload::type_
+
+      attr_accessor valid_until: Time?
+
+      attr_accessor webhook_failover_url: String?
+
+      attr_accessor webhook_url: String?
+
+      def initialize: (
+        ?id: String,
+        ?cc: ::Array[Telnyx::MessagingInboundMessagePayload::Cc],
+        ?completed_at: Time?,
+        ?cost: Telnyx::MessagingInboundMessagePayload::Cost?,
+        ?cost_breakdown: Telnyx::MessagingInboundMessagePayload::CostBreakdown?,
+        ?direction: Telnyx::Models::MessagingInboundMessagePayload::direction,
+        ?encoding: String,
+        ?errors: ::Array[Telnyx::MessagingError0b38e7044b],
+        ?from: Telnyx::MessagingInboundMessagePayload::From,
+        ?media: ::Array[Telnyx::MessagingInboundMessagePayload::Media],
+        ?messaging_profile_id: String,
+        ?num_chars: Integer,
+        ?organization_id: String,
+        ?parts: Integer,
+        ?received_at: Time,
+        ?record_type: Telnyx::Models::MessagingInboundMessagePayload::record_type,
+        ?sent_at: Time?,
+        ?subject: String?,
+        ?tags: ::Array[String],
+        ?tcr_campaign_billable: bool,
+        ?tcr_campaign_id: String?,
+        ?tcr_campaign_registered: String?,
+        ?text: String,
+        ?to: ::Array[Telnyx::MessagingInboundMessagePayload::To],
+        ?type: Telnyx::Models::MessagingInboundMessagePayload::type_,
+        ?valid_until: Time?,
+        ?webhook_failover_url: String?,
+        ?webhook_url: String?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        cc: ::Array[Telnyx::MessagingInboundMessagePayload::Cc],
+        completed_at: Time?,
+        cost: Telnyx::MessagingInboundMessagePayload::Cost?,
+        cost_breakdown: Telnyx::MessagingInboundMessagePayload::CostBreakdown?,
+        direction: Telnyx::Models::MessagingInboundMessagePayload::direction,
+        encoding: String,
+        errors: ::Array[Telnyx::MessagingError0b38e7044b],
+        from: Telnyx::MessagingInboundMessagePayload::From,
+        media: ::Array[Telnyx::MessagingInboundMessagePayload::Media],
+        messaging_profile_id: String,
+        num_chars: Integer,
+        organization_id: String,
+        parts: Integer,
+        received_at: Time,
+        record_type: Telnyx::Models::MessagingInboundMessagePayload::record_type,
+        sent_at: Time?,
+        subject: String?,
+        tags: ::Array[String],
+        tcr_campaign_billable: bool,
+        tcr_campaign_id: String?,
+        tcr_campaign_registered: String?,
+        text: String,
+        to: ::Array[Telnyx::MessagingInboundMessagePayload::To],
+        type: Telnyx::Models::MessagingInboundMessagePayload::type_,
+        valid_until: Time?,
+        webhook_failover_url: String?,
+        webhook_url: String?
+      }
+
+      type cc =
+        {
+          carrier: String,
+          line_type: Telnyx::Models::MessagingInboundMessagePayload::Cc::line_type,
+          phone_number: String,
+          status: Telnyx::Models::MessagingInboundMessagePayload::Cc::status
+        }
+
+      class Cc < Telnyx::Internal::Type::BaseModel
+        attr_reader carrier: String?
+
+        def carrier=: (String) -> String
+
+        attr_reader line_type: Telnyx::Models::MessagingInboundMessagePayload::Cc::line_type?
+
+        def line_type=: (
+          Telnyx::Models::MessagingInboundMessagePayload::Cc::line_type
+        ) -> Telnyx::Models::MessagingInboundMessagePayload::Cc::line_type
+
+        attr_reader phone_number: String?
+
+        def phone_number=: (String) -> String
+
+        attr_reader status: Telnyx::Models::MessagingInboundMessagePayload::Cc::status?
+
+        def status=: (
+          Telnyx::Models::MessagingInboundMessagePayload::Cc::status
+        ) -> Telnyx::Models::MessagingInboundMessagePayload::Cc::status
+
+        def initialize: (
+          ?carrier: String,
+          ?line_type: Telnyx::Models::MessagingInboundMessagePayload::Cc::line_type,
+          ?phone_number: String,
+          ?status: Telnyx::Models::MessagingInboundMessagePayload::Cc::status
+        ) -> void
+
+        def to_hash: -> {
+          carrier: String,
+          line_type: Telnyx::Models::MessagingInboundMessagePayload::Cc::line_type,
+          phone_number: String,
+          status: Telnyx::Models::MessagingInboundMessagePayload::Cc::status
+        }
+
+        type line_type =
+          :Wireline | :Wireless | :VoWiFi | :VoIP | :"Pre-Paid Wireless" | :""
+
+        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: :""
+
+          def self?.values: -> ::Array[Telnyx::Models::MessagingInboundMessagePayload::Cc::line_type]
+        end
+
+        type status =
+          :queued
+          | :sending
+          | :sent
+          | :delivered
+          | :sending_failed
+          | :delivery_failed
+          | :delivery_unconfirmed
+
+        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
+
+          def self?.values: -> ::Array[Telnyx::Models::MessagingInboundMessagePayload::Cc::status]
+        end
+      end
+
+      type cost = { amount: String, currency: String }
+
+      class Cost < Telnyx::Internal::Type::BaseModel
+        attr_reader amount: String?
+
+        def amount=: (String) -> String
+
+        attr_reader currency: String?
+
+        def currency=: (String) -> String
+
+        def initialize: (?amount: String, ?currency: String) -> void
+
+        def to_hash: -> { amount: String, currency: String }
+      end
+
+      type cost_breakdown =
+        {
+          carrier_fee: Telnyx::MessagingInboundMessagePayload::CostBreakdown::CarrierFee,
+          rate: Telnyx::MessagingInboundMessagePayload::CostBreakdown::Rate
+        }
+
+      class CostBreakdown < Telnyx::Internal::Type::BaseModel
+        attr_reader carrier_fee: Telnyx::MessagingInboundMessagePayload::CostBreakdown::CarrierFee?
+
+        def carrier_fee=: (
+          Telnyx::MessagingInboundMessagePayload::CostBreakdown::CarrierFee
+        ) -> Telnyx::MessagingInboundMessagePayload::CostBreakdown::CarrierFee
+
+        attr_reader rate: Telnyx::MessagingInboundMessagePayload::CostBreakdown::Rate?
+
+        def rate=: (
+          Telnyx::MessagingInboundMessagePayload::CostBreakdown::Rate
+        ) -> Telnyx::MessagingInboundMessagePayload::CostBreakdown::Rate
+
+        def initialize: (
+          ?carrier_fee: Telnyx::MessagingInboundMessagePayload::CostBreakdown::CarrierFee,
+          ?rate: Telnyx::MessagingInboundMessagePayload::CostBreakdown::Rate
+        ) -> void
+
+        def to_hash: -> {
+          carrier_fee: Telnyx::MessagingInboundMessagePayload::CostBreakdown::CarrierFee,
+          rate: Telnyx::MessagingInboundMessagePayload::CostBreakdown::Rate
+        }
+
+        type carrier_fee = { amount: String, currency: String }
+
+        class CarrierFee < Telnyx::Internal::Type::BaseModel
+          attr_reader amount: String?
+
+          def amount=: (String) -> String
+
+          attr_reader currency: String?
+
+          def currency=: (String) -> String
+
+          def initialize: (?amount: String, ?currency: String) -> void
+
+          def to_hash: -> { amount: String, currency: String }
+        end
+
+        type rate = { amount: String, currency: String }
+
+        class Rate < Telnyx::Internal::Type::BaseModel
+          attr_reader amount: String?
+
+          def amount=: (String) -> String
+
+          attr_reader currency: String?
+
+          def currency=: (String) -> String
+
+          def initialize: (?amount: String, ?currency: String) -> void
+
+          def to_hash: -> { amount: String, currency: String }
+        end
+      end
+
+      type direction = :inbound
+
+      module Direction
+        extend Telnyx::Internal::Type::Enum
+
+        INBOUND: :inbound
+
+        def self?.values: -> ::Array[Telnyx::Models::MessagingInboundMessagePayload::direction]
+      end
+
+      type from =
+        {
+          carrier: String,
+          line_type: Telnyx::Models::MessagingInboundMessagePayload::From::line_type,
+          phone_number: String,
+          status: Telnyx::Models::MessagingInboundMessagePayload::From::status
+        }
+
+      class From < Telnyx::Internal::Type::BaseModel
+        attr_reader carrier: String?
+
+        def carrier=: (String) -> String
+
+        attr_reader line_type: Telnyx::Models::MessagingInboundMessagePayload::From::line_type?
+
+        def line_type=: (
+          Telnyx::Models::MessagingInboundMessagePayload::From::line_type
+        ) -> Telnyx::Models::MessagingInboundMessagePayload::From::line_type
+
+        attr_reader phone_number: String?
+
+        def phone_number=: (String) -> String
+
+        attr_reader status: Telnyx::Models::MessagingInboundMessagePayload::From::status?
+
+        def status=: (
+          Telnyx::Models::MessagingInboundMessagePayload::From::status
+        ) -> Telnyx::Models::MessagingInboundMessagePayload::From::status
+
+        def initialize: (
+          ?carrier: String,
+          ?line_type: Telnyx::Models::MessagingInboundMessagePayload::From::line_type,
+          ?phone_number: String,
+          ?status: Telnyx::Models::MessagingInboundMessagePayload::From::status
+        ) -> void
+
+        def to_hash: -> {
+          carrier: String,
+          line_type: Telnyx::Models::MessagingInboundMessagePayload::From::line_type,
+          phone_number: String,
+          status: Telnyx::Models::MessagingInboundMessagePayload::From::status
+        }
+
+        type line_type =
+          :Wireline | :Wireless | :VoWiFi | :VoIP | :"Pre-Paid Wireless" | :""
+
+        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: :""
+
+          def self?.values: -> ::Array[Telnyx::Models::MessagingInboundMessagePayload::From::line_type]
+        end
+
+        type status = :received | :delivered
+
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          RECEIVED: :received
+          DELIVERED: :delivered
+
+          def self?.values: -> ::Array[Telnyx::Models::MessagingInboundMessagePayload::From::status]
+        end
+      end
+
+      type media =
+        {
+          content_type: String,
+          :hash_sha256 => String,
+          size: Integer,
+          url: String
+        }
+
+      class Media < Telnyx::Internal::Type::BaseModel
+        attr_reader content_type: String?
+
+        def content_type=: (String) -> String
+
+        attr_reader hash_sha256: String?
+
+        def hash_sha256=: (String) -> String
+
+        attr_reader size: Integer?
+
+        def size=: (Integer) -> Integer
+
+        attr_reader url: String?
+
+        def url=: (String) -> String
+
+        def initialize: (
+          ?content_type: String,
+          ?hash_sha256: String,
+          ?size: Integer,
+          ?url: String
+        ) -> void
+
+        def to_hash: -> {
+          content_type: String,
+          :hash_sha256 => String,
+          size: Integer,
+          url: String
+        }
+      end
+
+      type record_type = :message
+
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        MESSAGE: :message
+
+        def self?.values: -> ::Array[Telnyx::Models::MessagingInboundMessagePayload::record_type]
+      end
+
+      type to =
+        {
+          carrier: String,
+          line_type: Telnyx::Models::MessagingInboundMessagePayload::To::line_type,
+          phone_number: String,
+          status: Telnyx::Models::MessagingInboundMessagePayload::To::status
+        }
+
+      class To < Telnyx::Internal::Type::BaseModel
+        attr_reader carrier: String?
+
+        def carrier=: (String) -> String
+
+        attr_reader line_type: Telnyx::Models::MessagingInboundMessagePayload::To::line_type?
+
+        def line_type=: (
+          Telnyx::Models::MessagingInboundMessagePayload::To::line_type
+        ) -> Telnyx::Models::MessagingInboundMessagePayload::To::line_type
+
+        attr_reader phone_number: String?
+
+        def phone_number=: (String) -> String
+
+        attr_reader status: Telnyx::Models::MessagingInboundMessagePayload::To::status?
+
+        def status=: (
+          Telnyx::Models::MessagingInboundMessagePayload::To::status
+        ) -> Telnyx::Models::MessagingInboundMessagePayload::To::status
+
+        def initialize: (
+          ?carrier: String,
+          ?line_type: Telnyx::Models::MessagingInboundMessagePayload::To::line_type,
+          ?phone_number: String,
+          ?status: Telnyx::Models::MessagingInboundMessagePayload::To::status
+        ) -> void
+
+        def to_hash: -> {
+          carrier: String,
+          line_type: Telnyx::Models::MessagingInboundMessagePayload::To::line_type,
+          phone_number: String,
+          status: Telnyx::Models::MessagingInboundMessagePayload::To::status
+        }
+
+        type line_type =
+          :Wireline | :Wireless | :VoWiFi | :VoIP | :"Pre-Paid Wireless" | :""
+
+        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: :""
+
+          def self?.values: -> ::Array[Telnyx::Models::MessagingInboundMessagePayload::To::line_type]
+        end
+
+        type status =
+          :queued
+          | :sending
+          | :sent
+          | :delivered
+          | :sending_failed
+          | :delivery_failed
+          | :delivery_unconfirmed
+          | :webhook_delivered
+
+        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
+          WEBHOOK_DELIVERED: :webhook_delivered
+
+          def self?.values: -> ::Array[Telnyx::Models::MessagingInboundMessagePayload::To::status]
+        end
+      end
+
+      type type_ = :SMS | :MMS
+
+      module Type
+        extend Telnyx::Internal::Type::Enum
+
+        SMS: :SMS
+        MMS: :MMS
+
+        def self?.values: -> ::Array[Telnyx::Models::MessagingInboundMessagePayload::type_]
+      end
+    end
+  end
+end