telnyx 5.131.0 → 5.148.0

data/lib/telnyx/models/ai/transcription_endpointing_plan.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class TranscriptionEndpointingPlan < Telnyx::Internal::Type::BaseModel
+        # @!attribute on_no_punctuation_seconds
+        #   Seconds to wait after the transcript ends without punctuation.
+        #
+        #   @return [Float, nil]
+        optional :on_no_punctuation_seconds, Float
+
+        # @!attribute on_number_seconds
+        #   Seconds to wait after the transcript ends with a number.
+        #
+        #   @return [Float, nil]
+        optional :on_number_seconds, Float
+
+        # @!attribute on_punctuation_seconds
+        #   Seconds to wait after the transcript ends with punctuation.
+        #
+        #   @return [Float, nil]
+        optional :on_punctuation_seconds, Float
+
+        # @!method initialize(on_no_punctuation_seconds: nil, on_number_seconds: nil, on_punctuation_seconds: nil)
+        #   Endpointing thresholds used to decide when the user has finished speaking.
+        #   Applies to non turn-taking transcription models. For `deepgram/flux`, use
+        #   `transcription.settings.eot_threshold` / `eot_timeout_ms` /
+        #   `eager_eot_threshold`.
+        #
+        #   @param on_no_punctuation_seconds [Float] Seconds to wait after the transcript ends without punctuation.
+        #
+        #   @param on_number_seconds [Float] Seconds to wait after the transcript ends with a number.
+        #
+        #   @param on_punctuation_seconds [Float] Seconds to wait after the transcript ends with punctuation.
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/transfer_tool.rb

@@ -32,7 +32,7 @@ module Telnyx
           #   variable string like `{{ targets }}` where `targets` is returned by the dynamic
           #   variables webhook and resolves to an array of target objects at runtime.
           #
-          #   @return [Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::UnionMember0>, String]
+          #   @return [Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::TargetsList>, String]
           required :targets, union: -> { Telnyx::AI::TransferTool::Transfer::Targets }
 
           # @!method initialize(from:, targets:)
@@ -41,7 +41,7 @@ module Telnyx
           #
           #   @param from [String] Number or SIP URI placing the call.
           #
-          #   @param targets [Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::UnionMember0>, String] The different possible targets of the transfer. The assistant will be able to ch
+          #   @param targets [Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::TargetsList>, String] The different possible targets of the transfer. The assistant will be able to ch
 
           # The different possible targets of the transfer. The assistant will be able to
           # choose one of the targets to transfer the call to. This can also be a dynamic
@@ -52,12 +52,12 @@ module Telnyx
           module Targets
             extend Telnyx::Internal::Type::Union
 
-            variant -> { Telnyx::Models::AI::TransferTool::Transfer::Targets::UnionMember0Array }
+            variant -> { Telnyx::Models::AI::TransferTool::Transfer::Targets::TargetsListArray }
 
             # A dynamic variable string like `{{ targets }}` where `targets` is returned by the dynamic variables webhook and resolves to an array of target objects at runtime.
             variant String
 
-            class UnionMember0 < Telnyx::Internal::Type::BaseModel
+            class TargetsList < Telnyx::Internal::Type::BaseModel
               # @!attribute to
               #   The destination number or SIP URI of the call.
               #
@@ -77,13 +77,11 @@ module Telnyx
             end
 
             # @!method self.variants
-            #   @return [Array(Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::UnionMember0>, String)]
+            #   @return [Array(Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::TargetsList>, String)]
 
             # @type [Telnyx::Internal::Type::Converter]
-            UnionMember0Array =
-              Telnyx::Internal::Type::ArrayOf[-> {
-                Telnyx::AI::TransferTool::Transfer::Targets::UnionMember0
-              }]
+            TargetsListArray =
+              Telnyx::Internal::Type::ArrayOf[-> { Telnyx::AI::TransferTool::Transfer::Targets::TargetsList }]
           end
         end
 

data/lib/telnyx/models/ai_create_response_deprecated_params.rb

@@ -7,13 +7,13 @@ module Telnyx
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 
-      # @!attribute body
+      # @!attribute response_request
       #
       #   @return [Hash{Symbol=>Object}]
-      required :body, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+      required :response_request, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
 
-      # @!method initialize(body:, request_options: {})
-      #   @param body [Hash{Symbol=>Object}]
+      # @!method initialize(response_request:, request_options: {})
+      #   @param response_request [Hash{Symbol=>Object}]
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/telnyx/models/ai_retrieve_conversation_histories_params.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::AI#retrieve_conversation_histories
+    class AIRetrieveConversationHistoriesParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute q
+      #   Natural language search query. The text is embedded into a 1024-dimensional
+      #   vector and compared against indexed record chunks using kNN cosine similarity.
+      #
+      #   @return [String]
+      required :q, String
+
+      # @!attribute record_type
+      #   The type of records to search. Each record type is stored in a separate vector
+      #   index.
+      #
+      #   @return [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesParams::RecordType]
+      required :record_type, enum: -> { Telnyx::AIRetrieveConversationHistoriesParams::RecordType }
+
+      # @!attribute filter_document_id
+      #   Filter by document identifier (exact match). Populated for knowledge_base
+      #   records.
+      #
+      #   @return [String, nil]
+      optional :filter_document_id, String
+
+      # @!attribute filter_ingested_at_gte
+      #   Only include records ingested (chunked, embedded, and indexed) on or after this
+      #   ISO 8601 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :filter_ingested_at_gte, Time
+
+      # @!attribute filter_ingested_at_lte
+      #   Only include records ingested (chunked, embedded, and indexed) on or before this
+      #   ISO 8601 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :filter_ingested_at_lte, Time
+
+      # @!attribute filter_record_created_at_gte
+      #   Only include records whose original creation time is on or after this ISO 8601
+      #   timestamp.
+      #
+      #   @return [Time, nil]
+      optional :filter_record_created_at_gte, Time
+
+      # @!attribute filter_record_created_at_lte
+      #   Only include records whose original creation time is on or before this ISO 8601
+      #   timestamp.
+      #
+      #   @return [Time, nil]
+      optional :filter_record_created_at_lte, Time
+
+      # @!attribute filter_record_id
+      #   Filter to chunks belonging to a specific parent record (exact match).
+      #
+      #   @return [String, nil]
+      optional :filter_record_id, String
+
+      # @!attribute filter_region_in
+      #   Filter by the region stored on the record. Comma-separated to match multiple
+      #   regions (USA, DEU, AUS, UAE). Distinct from the `region` parameter, which
+      #   selects which cluster(s) are queried.
+      #
+      #   @return [String, nil]
+      optional :filter_region_in, String
+
+      # @!attribute filter_retention
+      #   Filter by retention policy (exact match). Filter-only: not returned in the
+      #   response body.
+      #
+      #   @return [String, nil]
+      optional :filter_retention, String
+
+      # @!attribute filter_user_id
+      #   Filter to records owned by a specific user (exact match).
+      #
+      #   @return [String, nil]
+      optional :filter_user_id, String
+
+      # @!attribute min_score
+      #   Minimum cosine similarity score threshold (0.0 to 1.0). Results below this
+      #   threshold are excluded.
+      #
+      #   @return [Float, nil]
+      optional :min_score, Float
+
+      # @!attribute region
+      #   Restrict search to a specific region's OpenSearch cluster. When omitted, all
+      #   regions are queried in parallel (fan-out) and results are merged by cosine
+      #   similarity score.
+      #
+      #   @return [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesParams::Region, nil]
+      optional :region, enum: -> { Telnyx::AIRetrieveConversationHistoriesParams::Region }
+
+      # @!attribute top_k
+      #   Maximum number of results to return. Defaults to 20, maximum 100.
+      #
+      #   @return [Integer, nil]
+      optional :top_k, Integer
+
+      # @!method initialize(q:, record_type:, filter_document_id: nil, filter_ingested_at_gte: nil, filter_ingested_at_lte: nil, filter_record_created_at_gte: nil, filter_record_created_at_lte: nil, filter_record_id: nil, filter_region_in: nil, filter_retention: nil, filter_user_id: nil, min_score: nil, region: nil, top_k: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::AIRetrieveConversationHistoriesParams} for more details.
+      #
+      #   @param q [String] Natural language search query. The text is embedded into a 1024-dimensional vect
+      #
+      #   @param record_type [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesParams::RecordType] The type of records to search. Each record type is stored in a separate vector i
+      #
+      #   @param filter_document_id [String] Filter by document identifier (exact match). Populated for knowledge_base record
+      #
+      #   @param filter_ingested_at_gte [Time] Only include records ingested (chunked, embedded, and indexed) on or after this
+      #
+      #   @param filter_ingested_at_lte [Time] Only include records ingested (chunked, embedded, and indexed) on or before this
+      #
+      #   @param filter_record_created_at_gte [Time] Only include records whose original creation time is on or after this ISO 8601 t
+      #
+      #   @param filter_record_created_at_lte [Time] Only include records whose original creation time is on or before this ISO 8601
+      #
+      #   @param filter_record_id [String] Filter to chunks belonging to a specific parent record (exact match).
+      #
+      #   @param filter_region_in [String] Filter by the region stored on the record. Comma-separated to match multiple reg
+      #
+      #   @param filter_retention [String] Filter by retention policy (exact match). Filter-only: not returned in the respo
+      #
+      #   @param filter_user_id [String] Filter to records owned by a specific user (exact match).
+      #
+      #   @param min_score [Float] Minimum cosine similarity score threshold (0.0 to 1.0). Results below this thres
+      #
+      #   @param region [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesParams::Region] Restrict search to a specific region's OpenSearch cluster. When omitted, all reg
+      #
+      #   @param top_k [Integer] Maximum number of results to return. Defaults to 20, maximum 100.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # The type of records to search. Each record type is stored in a separate vector
+      # index.
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        VOICE = :voice
+        MESSAGE = :message
+        AI_PIPELINE_STORAGE = :ai_pipeline_storage
+        KNOWLEDGE_BASE = :knowledge_base
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Restrict search to a specific region's OpenSearch cluster. When omitted, all
+      # regions are queried in parallel (fan-out) and results are merged by cosine
+      # similarity score.
+      module Region
+        extend Telnyx::Internal::Type::Enum
+
+        USA = :USA
+        DEU = :DEU
+        AUS = :AUS
+        UAE = :UAE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai_retrieve_conversation_histories_response.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::AI#retrieve_conversation_histories
+    class AIRetrieveConversationHistoriesResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #   Ranked list of matching text chunks, sorted by cosine similarity score
+      #   descending.
+      #
+      #   @return [Array<Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data>]
+      required :data,
+               -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data] }
+
+      # @!attribute meta
+      #   Pagination metadata following the standard Telnyx V2 API format.
+      #
+      #   @return [Telnyx::Models::AIRetrieveConversationHistoriesResponse::Meta]
+      required :meta, -> { Telnyx::Models::AIRetrieveConversationHistoriesResponse::Meta }
+
+      # @!method initialize(data:, meta:)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::AIRetrieveConversationHistoriesResponse} for more details.
+      #
+      #   Search response following the standard Telnyx V2 API format.
+      #
+      #   @param data [Array<Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data>] Ranked list of matching text chunks, sorted by cosine similarity score descendin
+      #
+      #   @param meta [Telnyx::Models::AIRetrieveConversationHistoriesResponse::Meta] Pagination metadata following the standard Telnyx V2 API format.
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique chunk identifier.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute chunk_index
+        #   Zero-based index of this chunk within the parent record.
+        #
+        #   @return [Integer]
+        required :chunk_index, Integer
+
+        # @!attribute chunk_total
+        #   Total number of chunks the parent record was split into.
+        #
+        #   @return [Integer]
+        required :chunk_total, Integer
+
+        # @!attribute document_id
+        #   Document identifier. Present only for knowledge_base records; null for all other
+        #   record types.
+        #
+        #   @return [String, nil]
+        required :document_id, String, nil?: true
+
+        # @!attribute ingested_at
+        #   When the record was chunked, embedded, and indexed (ISO 8601).
+        #
+        #   @return [Time]
+        required :ingested_at, Time
+
+        # @!attribute organization_id
+        #   Identifier of the organization that owns this record.
+        #
+        #   @return [String]
+        required :organization_id, String
+
+        # @!attribute record_created_at
+        #   When the original record was created (ISO 8601).
+        #
+        #   @return [Time]
+        required :record_created_at, Time
+
+        # @!attribute record_id
+        #   Identifier of the parent record. Multiple chunks from the same record share this
+        #   ID.
+        #
+        #   @return [String]
+        required :record_id, String
+
+        # @!attribute record_type
+        #   Type of the record.
+        #
+        #   @return [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType]
+        required :record_type,
+                 enum: -> { Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType }
+
+        # @!attribute region
+        #   The region where this record is stored.
+        #
+        #   @return [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::Region]
+        required :region, enum: -> { Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::Region }
+
+        # @!attribute score
+        #   Cosine similarity score between the query vector and this chunk's vector. Higher
+        #   values indicate greater semantic relevance.
+        #
+        #   @return [Float]
+        required :score, Float
+
+        # @!attribute text
+        #   The text content of this chunk (up to 480 tokens).
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute user_id
+        #   Identifier of the user who owns this record.
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!attribute metadata
+        #   Arbitrary metadata attached to the record at ingestion time. Stored as a
+        #   flat_object in OpenSearch and filterable via filter[field]=value query
+        #   parameters.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+        # @!method initialize(id:, chunk_index:, chunk_total:, document_id:, ingested_at:, organization_id:, record_created_at:, record_id:, record_type:, region:, score:, text:, user_id:, metadata: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data} for more
+        #   details.
+        #
+        #   A single search result representing one chunk of a conversation history record.
+        #   Records are split into chunks of up to 480 tokens with 64-token overlap at
+        #   ingestion time.
+        #
+        #   @param id [String] Unique chunk identifier.
+        #
+        #   @param chunk_index [Integer] Zero-based index of this chunk within the parent record.
+        #
+        #   @param chunk_total [Integer] Total number of chunks the parent record was split into.
+        #
+        #   @param document_id [String, nil] Document identifier. Present only for knowledge_base records; null for all other
+        #
+        #   @param ingested_at [Time] When the record was chunked, embedded, and indexed (ISO 8601).
+        #
+        #   @param organization_id [String] Identifier of the organization that owns this record.
+        #
+        #   @param record_created_at [Time] When the original record was created (ISO 8601).
+        #
+        #   @param record_id [String] Identifier of the parent record. Multiple chunks from the same record share this
+        #
+        #   @param record_type [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType] Type of the record.
+        #
+        #   @param region [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::Region] The region where this record is stored.
+        #
+        #   @param score [Float] Cosine similarity score between the query vector and this chunk's vector. Higher
+        #
+        #   @param text [String] The text content of this chunk (up to 480 tokens).
+        #
+        #   @param user_id [String] Identifier of the user who owns this record.
+        #
+        #   @param metadata [Hash{Symbol=>Object}] Arbitrary metadata attached to the record at ingestion time. Stored as a flat_ob
+
+        # Type of the record.
+        #
+        # @see Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          VOICE = :voice
+          MESSAGE = :message
+          AI_PIPELINE_STORAGE = :ai_pipeline_storage
+          KNOWLEDGE_BASE = :knowledge_base
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The region where this record is stored.
+        #
+        # @see Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data#region
+        module Region
+          extend Telnyx::Internal::Type::Enum
+
+          USA = :USA
+          DEU = :DEU
+          AUS = :AUS
+          UAE = :UAE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see Telnyx::Models::AIRetrieveConversationHistoriesResponse#meta
+      class Meta < Telnyx::Internal::Type::BaseModel
+        # @!attribute page_number
+        #   Current page number (always 1 — this API does not support pagination, use top_k
+        #   instead).
+        #
+        #   @return [Integer]
+        required :page_number, Integer
+
+        # @!attribute page_size
+        #   Number of results per page (equals the effective top_k value).
+        #
+        #   @return [Integer]
+        required :page_size, Integer
+
+        # @!attribute total_pages
+        #   Total number of pages.
+        #
+        #   @return [Integer]
+        required :total_pages, Integer
+
+        # @!attribute total_results
+        #   Total number of matching results across all queried regions (before top_k
+        #   truncation).
+        #
+        #   @return [Integer]
+        required :total_results, Integer
+
+        # @!method initialize(page_number:, page_size:, total_pages:, total_results:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AIRetrieveConversationHistoriesResponse::Meta} for more
+        #   details.
+        #
+        #   Pagination metadata following the standard Telnyx V2 API format.
+        #
+        #   @param page_number [Integer] Current page number (always 1 — this API does not support pagination, use top_k
+        #
+        #   @param page_size [Integer] Number of results per page (equals the effective top_k value).
+        #
+        #   @param total_pages [Integer] Total number of pages.
+        #
+        #   @param total_results [Integer] Total number of matching results across all queried regions (before top_k trunca
+      end
+    end
+  end
+end

data/lib/telnyx/models/branded_calling_pagination_meta.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class BrandedCallingPaginationMeta < Telnyx::Internal::Type::BaseModel
+      # @!attribute page_number
+      #   1-based index of this page. Echoes the `page[number]` query parameter (default
+      #   `1`).
+      #
+      #   @return [Integer]
+      required :page_number, Integer
+
+      # @!attribute page_size
+      #   Number of items returned in this page's `data` array. Capped at 250.
+      #
+      #   @return [Integer]
+      required :page_size, Integer
+
+      # @!attribute total_pages
+      #   Total number of pages available given the current `page_size`.
+      #
+      #   @return [Integer]
+      required :total_pages, Integer
+
+      # @!attribute total_results
+      #   Total number of items across all pages (excludes soft-deleted rows).
+      #
+      #   @return [Integer]
+      required :total_results, Integer
+
+      # @!method initialize(page_number:, page_size:, total_pages:, total_results:)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::BrandedCallingPaginationMeta} for more details.
+      #
+      #   JSON:API pagination metadata returned with every paginated list response. Page
+      #   numbering is 1-based. `page_size` reports the number of items actually returned
+      #   in `data` for this page; the requested size is taken from the `page[size]` query
+      #   parameter.
+      #
+      #   @param page_number [Integer] 1-based index of this page. Echoes the `page[number]` query parameter (default `
+      #
+      #   @param page_size [Integer] Number of items returned in this page's `data` array. Capped at 250.
+      #
+      #   @param total_pages [Integer] Total number of pages available given the current `page_size`.
+      #
+      #   @param total_results [Integer] Total number of items across all pages (excludes soft-deleted rows).
+    end
+  end
+end

data/lib/telnyx/models/bulk_sim_card_action_detailed.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::BulkSimCardActions#list
+    class BulkSimCardActionDetailed < Telnyx::Internal::Type::BaseModel
+      # @!attribute sim_card_actions_summary
+      #
+      #   @return [Array<Telnyx::Models::SimCardActionsSummary>, nil]
+      optional :sim_card_actions_summary, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::SimCardActionsSummary] }
+
+      response_only do
+        # @!attribute id
+        #   Identifies the resource.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute action_type
+        #   The action type. It can be one of the following: <br/>
+        #
+        #   <ul>
+        #   <li><code>bulk_disable_voice</code> - disable voice for every SIM Card in a SIM Card Group.</li>
+        #   <li><code>bulk_enable_voice</code> - enable voice for every SIM Card in a SIM Card Group.</li>
+        #   <li><code>bulk_set_public_ips</code> - set a public IP for each specified SIM Card.</li>
+        #   </ul>
+        #
+        #   @return [Symbol, Telnyx::Models::BulkSimCardActionDetailed::ActionType, nil]
+        optional :action_type, enum: -> { Telnyx::BulkSimCardActionDetailed::ActionType }
+
+        # @!attribute created_at
+        #   ISO 8601 formatted date-time indicating when the resource was created.
+        #
+        #   @return [String, nil]
+        optional :created_at, String
+
+        # @!attribute record_type
+        #
+        #   @return [String, nil]
+        optional :record_type, String
+
+        # @!attribute settings
+        #   A JSON object representation of the bulk action payload.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :settings, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+        # @!attribute updated_at
+        #   ISO 8601 formatted date-time indicating when the resource was updated.
+        #
+        #   @return [String, nil]
+        optional :updated_at, String
+      end
+
+      # @!method initialize(id: nil, action_type: nil, created_at: nil, record_type: nil, settings: nil, sim_card_actions_summary: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::BulkSimCardActionDetailed} for more details.
+      #
+      #   @param id [String] Identifies the resource.
+      #
+      #   @param action_type [Symbol, Telnyx::Models::BulkSimCardActionDetailed::ActionType] The action type. It can be one of the following: <br/>
+      #
+      #   @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
+      #
+      #   @param record_type [String]
+      #
+      #   @param settings [Hash{Symbol=>Object}] A JSON object representation of the bulk action payload.
+      #
+      #   @param sim_card_actions_summary [Array<Telnyx::Models::SimCardActionsSummary>]
+      #
+      #   @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was updated.
+
+      # The action type. It can be one of the following: <br/>
+      #
+      # <ul>
+      # <li><code>bulk_disable_voice</code> - disable voice for every SIM Card in a SIM Card Group.</li>
+      # <li><code>bulk_enable_voice</code> - enable voice for every SIM Card in a SIM Card Group.</li>
+      # <li><code>bulk_set_public_ips</code> - set a public IP for each specified SIM Card.</li>
+      # </ul>
+      #
+      # @see Telnyx::Models::BulkSimCardActionDetailed#action_type
+      module ActionType
+        extend Telnyx::Internal::Type::Enum
+
+        BULK_DISABLE_VOICE = :bulk_disable_voice
+        BULK_ENABLE_VOICE = :bulk_enable_voice
+        BULK_SET_PUBLIC_IPS = :bulk_set_public_ips
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end