telnyx 5.170.0 → 5.173.0

data/rbi/telnyx/models/outbound_message_payload.rbi

@@ -15,7 +15,8 @@ module Telnyx
       sig { params(id: String).void }
       attr_writer :id
 
-      # RCS webhook message body. Text messages use the text property.
+      # Message body for RCS and WhatsApp. RCS text messages use the text property.
+      # WhatsApp messages contain the `whatsapp_message` object from the send request.
       sig { returns(T.nilable(Telnyx::OutboundMessagePayload::Body)) }
       attr_reader :body
 
@@ -197,6 +198,21 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :tcr_campaign_registered
 
+      # Telnyx ID of the WhatsApp template used by the message, when known.
+      sig { returns(T.nilable(String)) }
+      attr_reader :template_id
+
+      sig { params(template_id: String).void }
+      attr_writer :template_id
+
+      # Name of the WhatsApp template used by the message. Present for WhatsApp template
+      # messages.
+      sig { returns(T.nilable(String)) }
+      attr_reader :template_name
+
+      sig { params(template_name: String).void }
+      attr_writer :template_name
+
       # Message body (i.e., content) as a non-empty string.
       #
       # **Required for SMS**
@@ -271,6 +287,8 @@ module Telnyx
           tcr_campaign_billable: T::Boolean,
           tcr_campaign_id: T.nilable(String),
           tcr_campaign_registered: T.nilable(String),
+          template_id: String,
+          template_name: String,
           text: String,
           to: T::Array[Telnyx::OutboundMessagePayload::To::OrHash],
           type: Telnyx::OutboundMessagePayload::Type::OrSymbol,
@@ -283,7 +301,8 @@ module Telnyx
       def self.new(
         # Identifies the type of resource.
         id: nil,
-        # RCS webhook message body. Text messages use the text property.
+        # Message body for RCS and WhatsApp. RCS text messages use the text property.
+        # WhatsApp messages contain the `whatsapp_message` object from the send request.
         body: nil,
         cc: nil,
         # ISO 8601 formatted date indicating when the message was finalized.
@@ -330,6 +349,11 @@ module Telnyx
         tcr_campaign_id: nil,
         # The registration status of the TCR campaign.
         tcr_campaign_registered: nil,
+        # Telnyx ID of the WhatsApp template used by the message, when known.
+        template_id: nil,
+        # Name of the WhatsApp template used by the message. Present for WhatsApp template
+        # messages.
+        template_name: nil,
         # Message body (i.e., content) as a non-empty string.
         #
         # **Required for SMS**
@@ -382,6 +406,8 @@ module Telnyx
             tcr_campaign_billable: T::Boolean,
             tcr_campaign_id: T.nilable(String),
             tcr_campaign_registered: T.nilable(String),
+            template_id: String,
+            template_name: String,
             text: String,
             to: T::Array[Telnyx::OutboundMessagePayload::To],
             type: Telnyx::OutboundMessagePayload::Type::TaggedSymbol,
@@ -411,7 +437,8 @@ module Telnyx
         sig { params(text: String).void }
         attr_writer :text
 
-        # RCS webhook message body. Text messages use the text property.
+        # Message body for RCS and WhatsApp. RCS text messages use the text property.
+        # WhatsApp messages contain the `whatsapp_message` object from the send request.
         sig { params(text: String).returns(T.attached_class) }
         def self.new(
           # RCS text message.
@@ -1269,6 +1296,8 @@ module Telnyx
         SMS = T.let(:SMS, Telnyx::OutboundMessagePayload::Type::TaggedSymbol)
         MMS = T.let(:MMS, Telnyx::OutboundMessagePayload::Type::TaggedSymbol)
         RCS = T.let(:RCS, Telnyx::OutboundMessagePayload::Type::TaggedSymbol)
+        WHATSAPP =
+          T.let(:WHATSAPP, Telnyx::OutboundMessagePayload::Type::TaggedSymbol)
 
         sig do
           override.returns(

data/rbi/telnyx/models/pay_connector.rbi

@@ -0,0 +1,298 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class PayConnector < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Telnyx::PayConnector, Telnyx::Internal::AnyHash) }
+
+      # Connector identifier.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Redacted stored configuration. Generic connector fields are shown here. Unknown
+      # config keys are discarded. Password and token are never returned.
+      sig { returns(T.nilable(Telnyx::PayConnector::Config)) }
+      attr_reader :config
+
+      sig { params(config: Telnyx::PayConnector::Config::OrHash).void }
+      attr_writer :config
+
+      # Creation time.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      # Configured mode.
+      sig { returns(T.nilable(Telnyx::PayConnector::Mode::TaggedSymbol)) }
+      attr_reader :mode
+
+      sig { params(mode: Telnyx::PayConnector::Mode::OrSymbol).void }
+      attr_writer :mode
+
+      # Connector name used for retrieval, update, deletion and Pay.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # Owning organization; assigned from authentication, not request input.
+      sig { returns(T.nilable(String)) }
+      attr_reader :organization_id
+
+      sig { params(organization_id: String).void }
+      attr_writer :organization_id
+
+      # Resource type.
+      sig { returns(T.nilable(Telnyx::PayConnector::RecordType::TaggedSymbol)) }
+      attr_reader :record_type
+
+      sig do
+        params(record_type: Telnyx::PayConnector::RecordType::OrSymbol).void
+      end
+      attr_writer :record_type
+
+      # Connector type; generic is covered by this reference. Other types may appear in
+      # unfiltered lists.
+      sig { returns(T.nilable(String)) }
+      attr_reader :type
+
+      sig { params(type: String).void }
+      attr_writer :type
+
+      # Last update time.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: Time).void }
+      attr_writer :updated_at
+
+      # Creating user; assigned from authentication, not request input.
+      sig { returns(T.nilable(String)) }
+      attr_reader :user_id
+
+      sig { params(user_id: String).void }
+      attr_writer :user_id
+
+      # Organization-owned connector. Examples and config properties here describe
+      # generic connectors; listing is not restricted to that type unless
+      # filter[type]=generic is supplied. Passwords and bearer tokens are omitted, not
+      # masked. Defaults for auth_type and timeout need not appear in stored config.
+      sig do
+        params(
+          id: String,
+          config: Telnyx::PayConnector::Config::OrHash,
+          created_at: Time,
+          mode: Telnyx::PayConnector::Mode::OrSymbol,
+          name: String,
+          organization_id: String,
+          record_type: Telnyx::PayConnector::RecordType::OrSymbol,
+          type: String,
+          updated_at: Time,
+          user_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Connector identifier.
+        id: nil,
+        # Redacted stored configuration. Generic connector fields are shown here. Unknown
+        # config keys are discarded. Password and token are never returned.
+        config: nil,
+        # Creation time.
+        created_at: nil,
+        # Configured mode.
+        mode: nil,
+        # Connector name used for retrieval, update, deletion and Pay.
+        name: nil,
+        # Owning organization; assigned from authentication, not request input.
+        organization_id: nil,
+        # Resource type.
+        record_type: nil,
+        # Connector type; generic is covered by this reference. Other types may appear in
+        # unfiltered lists.
+        type: nil,
+        # Last update time.
+        updated_at: nil,
+        # Creating user; assigned from authentication, not request input.
+        user_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            config: Telnyx::PayConnector::Config,
+            created_at: Time,
+            mode: Telnyx::PayConnector::Mode::TaggedSymbol,
+            name: String,
+            organization_id: String,
+            record_type: Telnyx::PayConnector::RecordType::TaggedSymbol,
+            type: String,
+            updated_at: Time,
+            user_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Config < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::PayConnector::Config, Telnyx::Internal::AnyHash)
+          end
+
+        # Stored processor authentication selection. Omitted if it was not explicitly
+        # configured.
+        sig do
+          returns(
+            T.nilable(Telnyx::PayConnector::Config::AuthType::TaggedSymbol)
+          )
+        end
+        attr_reader :auth_type
+
+        sig do
+          params(
+            auth_type: Telnyx::PayConnector::Config::AuthType::OrSymbol
+          ).void
+        end
+        attr_writer :auth_type
+
+        # HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+        # transit.
+        sig { returns(T.nilable(String)) }
+        attr_reader :endpoint_url
+
+        sig { params(endpoint_url: String).void }
+        attr_writer :endpoint_url
+
+        # Stored processor HTTP timeout in milliseconds. Omitted when no timeout was
+        # configured; the effective runtime default is 10000.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :timeout
+
+        sig { params(timeout: Integer).void }
+        attr_writer :timeout
+
+        # Stored username, when supplied. Required to be a nonblank string for basic
+        # authentication.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :username
+
+        sig { params(username: T.anything).void }
+        attr_writer :username
+
+        # Redacted stored configuration. Generic connector fields are shown here. Unknown
+        # config keys are discarded. Password and token are never returned.
+        sig do
+          params(
+            auth_type: Telnyx::PayConnector::Config::AuthType::OrSymbol,
+            endpoint_url: String,
+            timeout: Integer,
+            username: T.anything
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Stored processor authentication selection. Omitted if it was not explicitly
+          # configured.
+          auth_type: nil,
+          # HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+          # transit.
+          endpoint_url: nil,
+          # Stored processor HTTP timeout in milliseconds. Omitted when no timeout was
+          # configured; the effective runtime default is 10000.
+          timeout: nil,
+          # Stored username, when supplied. Required to be a nonblank string for basic
+          # authentication.
+          username: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              auth_type: Telnyx::PayConnector::Config::AuthType::TaggedSymbol,
+              endpoint_url: String,
+              timeout: Integer,
+              username: T.anything
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Stored processor authentication selection. Omitted if it was not explicitly
+        # configured.
+        module AuthType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::PayConnector::Config::AuthType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          NONE =
+            T.let(:none, Telnyx::PayConnector::Config::AuthType::TaggedSymbol)
+          BASIC =
+            T.let(:basic, Telnyx::PayConnector::Config::AuthType::TaggedSymbol)
+          BEARER =
+            T.let(:bearer, Telnyx::PayConnector::Config::AuthType::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::PayConnector::Config::AuthType::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      # Configured mode.
+      module Mode
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::PayConnector::Mode) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TEST = T.let(:test, Telnyx::PayConnector::Mode::TaggedSymbol)
+        LIVE = T.let(:live, Telnyx::PayConnector::Mode::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Telnyx::PayConnector::Mode::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
+      # Resource type.
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::PayConnector::RecordType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PAY_CONNECTOR =
+          T.let(:pay_connector, Telnyx::PayConnector::RecordType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::PayConnector::RecordType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/pay_connector_create_params.rbi

@@ -0,0 +1,156 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class PayConnectorCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::PayConnectorCreateParams, Telnyx::Internal::AnyHash)
+        end
+
+      # Configuration for a generic connector. A config update replaces the complete
+      # object, not individual keys. Unknown config keys are discarded. Authentication
+      # credentials must be nonblank strings when required by the selected auth_type.
+      sig do
+        returns(
+          T.any(
+            Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault,
+            Telnyx::GenericPayConnectorConfig::BearerAuthentication,
+            Telnyx::GenericPayConnectorConfig::NoProcessorAuthentication
+          )
+        )
+      end
+      attr_accessor :config
+
+      # Unique within the authenticated organization. Used in resource paths and as
+      # connector_name in the Call Control Pay request. Cannot be renamed by update.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Defaults to test on creation. Test restricts collected card numbers but still
+      # contacts the configured processor; use a processor sandbox URL and sandbox
+      # credentials. Live removes the test-card restriction. Neither mode locks API
+      # updates.
+      sig do
+        returns(T.nilable(Telnyx::PayConnectorCreateParams::Mode::OrSymbol))
+      end
+      attr_reader :mode
+
+      sig do
+        params(mode: Telnyx::PayConnectorCreateParams::Mode::OrSymbol).void
+      end
+      attr_writer :mode
+
+      # Connector type covered by this reference.
+      sig do
+        returns(T.nilable(Telnyx::PayConnectorCreateParams::Type::OrSymbol))
+      end
+      attr_reader :type
+
+      sig do
+        params(type: Telnyx::PayConnectorCreateParams::Type::OrSymbol).void
+      end
+      attr_writer :type
+
+      sig do
+        params(
+          config:
+            T.any(
+              Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault::OrHash,
+              Telnyx::GenericPayConnectorConfig::BearerAuthentication::OrHash,
+              Telnyx::GenericPayConnectorConfig::NoProcessorAuthentication::OrHash
+            ),
+          name: String,
+          mode: Telnyx::PayConnectorCreateParams::Mode::OrSymbol,
+          type: Telnyx::PayConnectorCreateParams::Type::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Configuration for a generic connector. A config update replaces the complete
+        # object, not individual keys. Unknown config keys are discarded. Authentication
+        # credentials must be nonblank strings when required by the selected auth_type.
+        config:,
+        # Unique within the authenticated organization. Used in resource paths and as
+        # connector_name in the Call Control Pay request. Cannot be renamed by update.
+        name:,
+        # Defaults to test on creation. Test restricts collected card numbers but still
+        # contacts the configured processor; use a processor sandbox URL and sandbox
+        # credentials. Live removes the test-card restriction. Neither mode locks API
+        # updates.
+        mode: nil,
+        # Connector type covered by this reference.
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            config:
+              T.any(
+                Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault,
+                Telnyx::GenericPayConnectorConfig::BearerAuthentication,
+                Telnyx::GenericPayConnectorConfig::NoProcessorAuthentication
+              ),
+            name: String,
+            mode: Telnyx::PayConnectorCreateParams::Mode::OrSymbol,
+            type: Telnyx::PayConnectorCreateParams::Type::OrSymbol,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Defaults to test on creation. Test restricts collected card numbers but still
+      # contacts the configured processor; use a processor sandbox URL and sandbox
+      # credentials. Live removes the test-card restriction. Neither mode locks API
+      # updates.
+      module Mode
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::PayConnectorCreateParams::Mode) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TEST =
+          T.let(:test, Telnyx::PayConnectorCreateParams::Mode::TaggedSymbol)
+        LIVE =
+          T.let(:live, Telnyx::PayConnectorCreateParams::Mode::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::PayConnectorCreateParams::Mode::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Connector type covered by this reference.
+      module Type
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::PayConnectorCreateParams::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        GENERIC =
+          T.let(:generic, Telnyx::PayConnectorCreateParams::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::PayConnectorCreateParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/pay_connector_delete_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class PayConnectorDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::PayConnectorDeleteParams, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig do
+        params(
+          name: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(name:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { name: String, request_options: Telnyx::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end