telnyx 5.159.0 → 5.161.0

data/lib/telnyx/models/rcs/capabilities_response.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class CapabilitiesResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute brand_entity
+        #
+        #   @return [Boolean]
+        required :brand_entity, Telnyx::Internal::Type::Boolean
+
+        # @!attribute brand_verification
+        #
+        #   @return [Boolean]
+        required :brand_verification, Telnyx::Internal::Type::Boolean
+
+        # @!attribute campaigns
+        #
+        #   @return [Boolean]
+        required :campaigns, Telnyx::Internal::Type::Boolean
+
+        # @!attribute distinct_launch_phase
+        #
+        #   @return [Boolean]
+        required :distinct_launch_phase, Telnyx::Internal::Type::Boolean
+
+        # @!attribute invite_test_devices
+        #
+        #   @return [Boolean]
+        required :invite_test_devices, Telnyx::Internal::Type::Boolean
+
+        # @!attribute per_carrier_approval
+        #
+        #   @return [Boolean]
+        required :per_carrier_approval, Telnyx::Internal::Type::Boolean
+
+        # @!attribute submission_sections
+        #
+        #   @return [Boolean]
+        required :submission_sections, Telnyx::Internal::Type::Boolean
+
+        # @!attribute templates
+        #
+        #   @return [Boolean]
+        required :templates, Telnyx::Internal::Type::Boolean
+
+        # @!attribute vendor_webhooks
+        #
+        #   @return [Boolean]
+        required :vendor_webhooks, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(brand_entity:, brand_verification:, campaigns:, distinct_launch_phase:, invite_test_devices:, per_carrier_approval:, submission_sections:, templates:, vendor_webhooks:)
+        #   @param brand_entity [Boolean]
+        #   @param brand_verification [Boolean]
+        #   @param campaigns [Boolean]
+        #   @param distinct_launch_phase [Boolean]
+        #   @param invite_test_devices [Boolean]
+        #   @param per_carrier_approval [Boolean]
+        #   @param submission_sections [Boolean]
+        #   @param templates [Boolean]
+        #   @param vendor_webhooks [Boolean]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/carrier_approval_response.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class CarrierApprovalResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute approval_id
+        #
+        #   @return [String]
+        required :approval_id, String
+
+        # @!attribute approved_at
+        #
+        #   @return [Time, nil]
+        required :approved_at, Time, nil?: true
+
+        # @!attribute carrier
+        #
+        #   @return [String, nil]
+        required :carrier, String, nil?: true
+
+        # @!attribute rejected_reason
+        #
+        #   @return [String, nil]
+        required :rejected_reason, String, nil?: true
+
+        # @!attribute scope_type
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::CarrierApprovalResponse::ScopeType]
+        required :scope_type, enum: -> { Telnyx::Rcs::CarrierApprovalResponse::ScopeType }
+
+        # @!attribute status
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::CarrierApprovalResponse::Status]
+        required :status, enum: -> { Telnyx::Rcs::CarrierApprovalResponse::Status }
+
+        # @!attribute submitted_at
+        #
+        #   @return [Time, nil]
+        required :submitted_at, Time, nil?: true
+
+        # @!method initialize(approval_id:, approved_at:, carrier:, rejected_reason:, scope_type:, status:, submitted_at:)
+        #   @param approval_id [String]
+        #   @param approved_at [Time, nil]
+        #   @param carrier [String, nil]
+        #   @param rejected_reason [String, nil]
+        #   @param scope_type [Symbol, Telnyx::Models::Rcs::CarrierApprovalResponse::ScopeType]
+        #   @param status [Symbol, Telnyx::Models::Rcs::CarrierApprovalResponse::Status]
+        #   @param submitted_at [Time, nil]
+
+        # @see Telnyx::Models::Rcs::CarrierApprovalResponse#scope_type
+        module ScopeType
+          extend Telnyx::Internal::Type::Enum
+
+          CARRIER = :carrier
+          HUB = :hub
+          BOT = :bot
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Telnyx::Models::Rcs::CarrierApprovalResponse#status
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          PENDING = :PENDING
+          SUBMITTED = :SUBMITTED
+          APPROVED = :APPROVED
+          REJECTED = :REJECTED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/ein_brand_identifier.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class EinBrandIdentifier < Telnyx::Internal::Type::BaseModel
+        # @!attribute identifier_type
+        #
+        #   @return [Symbol, :EIN]
+        required :identifier_type, const: :EIN
+
+        # @!attribute value
+        #   Nine digits, optionally formatted as NN-NNNNNNN.
+        #
+        #   @return [String]
+        required :value, String
+
+        # @!method initialize(value:, identifier_type: :EIN)
+        #   @param value [String] Nine digits, optionally formatted as NN-NNNNNNN.
+        #
+        #   @param identifier_type [Symbol, :EIN]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/rcs_agent.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class RcsAgent < Telnyx::Internal::Type::BaseModel
+        # @!attribute agent_id
+        #   RCS Agent ID
+        #
+        #   @return [String, nil]
+        optional :agent_id, String
+
+        # @!attribute agent_name
+        #   Human readable agent name
+        #
+        #   @return [String, nil]
+        optional :agent_name, String
+
+        # @!attribute created_at
+        #   Date and time when the resource was created
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute enabled
+        #   Specifies whether the agent is enabled
+        #
+        #   @return [Boolean, nil]
+        optional :enabled, Telnyx::Internal::Type::Boolean
+
+        # @!attribute profile_id
+        #   Messaging profile ID associated with the RCS Agent
+        #
+        #   @return [String, nil]
+        optional :profile_id, String, nil?: true
+
+        # @!attribute updated_at
+        #   Date and time when the resource was updated
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+
+        # @!attribute user_id
+        #   User ID associated with the RCS Agent
+        #
+        #   @return [String, nil]
+        optional :user_id, String
+
+        # @!attribute webhook_failover_url
+        #   Failover URL to receive RCS events
+        #
+        #   @return [String, nil]
+        optional :webhook_failover_url, String, nil?: true
+
+        # @!attribute webhook_url
+        #   URL to receive RCS events
+        #
+        #   @return [String, nil]
+        optional :webhook_url, String, nil?: true
+
+        # @!method initialize(agent_id: nil, agent_name: nil, created_at: nil, enabled: nil, profile_id: nil, updated_at: nil, user_id: nil, webhook_failover_url: nil, webhook_url: nil)
+        #   @param agent_id [String] RCS Agent ID
+        #
+        #   @param agent_name [String] Human readable agent name
+        #
+        #   @param created_at [Time] Date and time when the resource was created
+        #
+        #   @param enabled [Boolean] Specifies whether the agent is enabled
+        #
+        #   @param profile_id [String, nil] Messaging profile ID associated with the RCS Agent
+        #
+        #   @param updated_at [Time] Date and time when the resource was updated
+        #
+        #   @param user_id [String] User ID associated with the RCS Agent
+        #
+        #   @param webhook_failover_url [String, nil] Failover URL to receive RCS events
+        #
+        #   @param webhook_url [String, nil] URL to receive RCS events
+      end
+    end
+
+    RcsAgent = Rcs::RcsAgent
+  end
+end

data/lib/telnyx/models/rcs/rcs_agent_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class RcsAgentResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::Rcs::RcsAgent, nil]
+        optional :data, -> { Telnyx::Rcs::RcsAgent }
+
+        # @!method initialize(data: nil)
+        #   @param data [Telnyx::Models::Rcs::RcsAgent]
+      end
+    end
+
+    RcsAgentResponse = Rcs::RcsAgentResponse
+  end
+end

data/lib/telnyx/models/rcs/stock_symbol_brand_identifier.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class StockSymbolBrandIdentifier < Telnyx::Internal::Type::BaseModel
+        # @!attribute identifier_type
+        #
+        #   @return [Symbol, :STOCK_SYMBOL]
+        required :identifier_type, const: :STOCK_SYMBOL
+
+        # @!attribute value
+        #   A stock symbol using EXCHANGE:SYMBOL.
+        #
+        #   @return [String]
+        required :value, String
+
+        # @!method initialize(value:, identifier_type: :STOCK_SYMBOL)
+        #   @param value [String] A stock symbol using EXCHANGE:SYMBOL.
+        #
+        #   @param identifier_type [Symbol, :STOCK_SYMBOL]
+      end
+    end
+  end
+end

data/lib/telnyx/models/recording_available_webhook_event.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class RecordingAvailableWebhookEvent < Telnyx::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique event id; deduplicate deliveries on it.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute data
+      #   Available recording types.
+      #
+      #   @return [Telnyx::Models::RecordingAvailableWebhookEvent::Data]
+      required :data, -> { Telnyx::RecordingAvailableWebhookEvent::Data }
+
+      # @!attribute event
+      #   Event type.
+      #
+      #   @return [Symbol, Telnyx::Models::RecordingAvailableWebhookEvent::Event]
+      required :event, enum: -> { Telnyx::RecordingAvailableWebhookEvent::Event }
+
+      # @!attribute occurred_at
+      #   When the event occurred.
+      #
+      #   @return [Time]
+      required :occurred_at, Time
+
+      # @!attribute version
+      #   Envelope version.
+      #
+      #   @return [String]
+      required :version, String
+
+      # @!method initialize(id:, data:, event:, occurred_at:, version:)
+      #   @param id [String] Unique event id; deduplicate deliveries on it.
+      #
+      #   @param data [Telnyx::Models::RecordingAvailableWebhookEvent::Data] Available recording types.
+      #
+      #   @param event [Symbol, Telnyx::Models::RecordingAvailableWebhookEvent::Event] Event type.
+      #
+      #   @param occurred_at [Time] When the event occurred.
+      #
+      #   @param version [String] Envelope version.
+
+      # @see Telnyx::Models::RecordingAvailableWebhookEvent#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute recording_types
+        #   Available recording types.
+        #
+        #   @return [Array<String>]
+        required :recording_types, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!attribute session_id
+        #   The meeting session this event belongs to.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!method initialize(recording_types:, session_id:)
+        #   Available recording types.
+        #
+        #   @param recording_types [Array<String>] Available recording types.
+        #
+        #   @param session_id [String] The meeting session this event belongs to.
+      end
+
+      # Event type.
+      #
+      # @see Telnyx::Models::RecordingAvailableWebhookEvent#event
+      module Event
+        extend Telnyx::Internal::Type::Enum
+
+        RECORDING_AVAILABLE = :"recording.available"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/report_list_mdrs_response.rb

@@ -11,12 +11,12 @@ module Telnyx
 
       # @!attribute meta
       #
-      #   @return [Telnyx::Models::Reports::PaginationMetaReporting, nil]
-      optional :meta, -> { Telnyx::Reports::PaginationMetaReporting }
+      #   @return [Telnyx::Models::Reports::ReportingPaginationMeta77109e5d17, nil]
+      optional :meta, -> { Telnyx::Reports::ReportingPaginationMeta77109e5d17 }
 
       # @!method initialize(data: nil, meta: nil)
       #   @param data [Array<Telnyx::Models::ReportListMdrsResponse::Data>]
-      #   @param meta [Telnyx::Models::Reports::PaginationMetaReporting]
+      #   @param meta [Telnyx::Models::Reports::ReportingPaginationMeta77109e5d17]
 
       class Data < Telnyx::Internal::Type::BaseModel
         # @!attribute id

data/lib/telnyx/models/reports/reporting_pagination_meta_77109e5d17.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Reports
+      class ReportingPaginationMeta77109e5d17 < Telnyx::Internal::Type::BaseModel
+        # @!attribute page_number
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!attribute total_pages
+        #
+        #   @return [Integer, nil]
+        optional :total_pages, Integer
+
+        # @!attribute total_results
+        #
+        #   @return [Integer, nil]
+        optional :total_results, Integer
+
+        # @!method initialize(page_number: nil, page_size: nil, total_pages: nil, total_results: nil)
+        #   @param page_number [Integer]
+        #   @param page_size [Integer]
+        #   @param total_pages [Integer]
+        #   @param total_results [Integer]
+      end
+    end
+
+    ReportingPaginationMeta77109e5d17 = Reports::ReportingPaginationMeta77109e5d17
+  end
+end

data/lib/telnyx/models/session_status_changed_webhook_event.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class SessionStatusChangedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique event id; deduplicate deliveries on it.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute data
+      #   Status transition details.
+      #
+      #   @return [Telnyx::Models::SessionStatusChangedWebhookEvent::Data]
+      required :data, -> { Telnyx::SessionStatusChangedWebhookEvent::Data }
+
+      # @!attribute event
+      #   Event type.
+      #
+      #   @return [Symbol, Telnyx::Models::SessionStatusChangedWebhookEvent::Event]
+      required :event, enum: -> { Telnyx::SessionStatusChangedWebhookEvent::Event }
+
+      # @!attribute occurred_at
+      #   When the event occurred.
+      #
+      #   @return [Time]
+      required :occurred_at, Time
+
+      # @!attribute version
+      #   Envelope version.
+      #
+      #   @return [String]
+      required :version, String
+
+      # @!method initialize(id:, data:, event:, occurred_at:, version:)
+      #   @param id [String] Unique event id; deduplicate deliveries on it.
+      #
+      #   @param data [Telnyx::Models::SessionStatusChangedWebhookEvent::Data] Status transition details.
+      #
+      #   @param event [Symbol, Telnyx::Models::SessionStatusChangedWebhookEvent::Event] Event type.
+      #
+      #   @param occurred_at [Time] When the event occurred.
+      #
+      #   @param version [String] Envelope version.
+
+      # @see Telnyx::Models::SessionStatusChangedWebhookEvent#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute recording
+        #   Whether the session is recording at this lifecycle edge.
+        #
+        #   @return [Boolean]
+        required :recording, Telnyx::Internal::Type::Boolean
+
+        # @!attribute session_id
+        #   The meeting session this event belongs to.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute status
+        #   The new session status.
+        #
+        #   @return [String]
+        required :status, String
+
+        # @!attribute status_detail
+        #   Additional detail about the status (for example `timeout_exceeded_everyone_left`
+        #   or `cancelled`), or null.
+        #
+        #   @return [String, nil]
+        required :status_detail, String, nil?: true
+
+        # @!method initialize(recording:, session_id:, status:, status_detail:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::SessionStatusChangedWebhookEvent::Data} for more details.
+        #
+        #   Status transition details.
+        #
+        #   @param recording [Boolean] Whether the session is recording at this lifecycle edge.
+        #
+        #   @param session_id [String] The meeting session this event belongs to.
+        #
+        #   @param status [String] The new session status.
+        #
+        #   @param status_detail [String, nil] Additional detail about the status (for example `timeout_exceeded_everyone_left`
+      end
+
+      # Event type.
+      #
+      # @see Telnyx::Models::SessionStatusChangedWebhookEvent#event
+      module Event
+        extend Telnyx::Internal::Type::Enum
+
+        SESSION_STATUS_CHANGED = :"session.status_changed"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/sim_cards/action_bulk_enable_voice_params.rb

@@ -13,8 +13,23 @@ module Telnyx
         #   @return [String]
         required :sim_card_group_id, String
 
-        # @!method initialize(sim_card_group_id:, request_options: {})
+        # @!attribute connection_id
+        #   The identifier of the Mobile Voice Connection to associate with the SIM cards.
+        #   The connection must be owned by the same user and of type
+        #   <code>mobile_voice</code>. If omitted, voice is enabled without a connection
+        #   association.
+        #
+        #   @return [String, nil]
+        optional :connection_id, String
+
+        # @!method initialize(sim_card_group_id:, connection_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::SimCards::ActionBulkEnableVoiceParams} for more details.
+        #
         #   @param sim_card_group_id [String]
+        #
+        #   @param connection_id [String] The identifier of the Mobile Voice Connection to associate with the SIM cards. T
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/telnyx/models/sim_cards/action_disable_response.rb

@@ -9,14 +9,14 @@ module Telnyx
         #   This object represents a SIM card action. It allows tracking the current status
         #   of an operation that impacts the SIM card.
         #
-        #   @return [Telnyx::Models::SimCards::SimCardAction, nil]
-        optional :data, -> { Telnyx::SimCards::SimCardAction }
+        #   @return [Telnyx::Models::SimCards::WirelessSimCardAction, nil]
+        optional :data, -> { Telnyx::SimCards::WirelessSimCardAction }
 
         # @!method initialize(data: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::SimCards::ActionDisableResponse} for more details.
         #
-        #   @param data [Telnyx::Models::SimCards::SimCardAction] This object represents a SIM card action. It allows tracking the current status
+        #   @param data [Telnyx::Models::SimCards::WirelessSimCardAction] This object represents a SIM card action. It allows tracking the current status
       end
     end
   end

data/lib/telnyx/models/sim_cards/action_disable_voice_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module SimCards
+      # @see Telnyx::Resources::SimCards::Actions#disable_voice
+      class ActionDisableVoiceParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/sim_cards/action_disable_voice_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module SimCards
+      # @see Telnyx::Resources::SimCards::Actions#disable_voice
+      class ActionDisableVoiceResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #   This object represents a SIM card action. It allows tracking the current status
+        #   of an operation that impacts the SIM card.
+        #
+        #   @return [Telnyx::Models::SimCards::WirelessSimCardAction, nil]
+        optional :data, -> { Telnyx::SimCards::WirelessSimCardAction }
+
+        # @!method initialize(data: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::SimCards::ActionDisableVoiceResponse} for more details.
+        #
+        #   @param data [Telnyx::Models::SimCards::WirelessSimCardAction] This object represents a SIM card action. It allows tracking the current status
+      end
+    end
+  end
+end

data/lib/telnyx/models/sim_cards/action_enable_response.rb

@@ -9,14 +9,14 @@ module Telnyx
         #   This object represents a SIM card action. It allows tracking the current status
         #   of an operation that impacts the SIM card.
         #
-        #   @return [Telnyx::Models::SimCards::SimCardAction, nil]
-        optional :data, -> { Telnyx::SimCards::SimCardAction }
+        #   @return [Telnyx::Models::SimCards::WirelessSimCardAction, nil]
+        optional :data, -> { Telnyx::SimCards::WirelessSimCardAction }
 
         # @!method initialize(data: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::SimCards::ActionEnableResponse} for more details.
         #
-        #   @param data [Telnyx::Models::SimCards::SimCardAction] This object represents a SIM card action. It allows tracking the current status
+        #   @param data [Telnyx::Models::SimCards::WirelessSimCardAction] This object represents a SIM card action. It allows tracking the current status
       end
     end
   end

data/lib/telnyx/models/sim_cards/action_enable_voice_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module SimCards
+      # @see Telnyx::Resources::SimCards::Actions#enable_voice
+      class ActionEnableVoiceParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute connection_id
+        #   The identifier of the Mobile Voice Connection to associate with this SIM card.
+        #   The connection must be owned by the same user and of type
+        #   <code>mobile_voice</code>. If omitted, voice is enabled without a connection
+        #   association.
+        #
+        #   @return [String, nil]
+        optional :connection_id, String
+
+        # @!method initialize(id:, connection_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::SimCards::ActionEnableVoiceParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param connection_id [String] The identifier of the Mobile Voice Connection to associate with this SIM card. T
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end