twilio-ruby 7.11.2 → 7.11.3

data/lib/twilio-ruby/rest/insights/v3/custom_field_mapping.rb

@@ -0,0 +1,279 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Insights
+#    The Twilio Insights v3 API provides semantic query access to Conversations analytics data. Resources include synchronous Query, Metadata, and asynchronous QueryJobs for long-running queries. 
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Insights < InsightsBase
+            class V3 < Version
+                class CustomFieldMappingList < ListResource
+                
+                    class CustomFieldMappingRequest
+                            # @param [category]: [MappingCategory] 
+                            # @param [name]: [String] Customer-facing name for the field; becomes the ClickHouse Map key and the platform field alias. Unique per account across every `sourceType` — the Map key namespace is account-global. 
+                            # @param [description]: [String] Optional, free-text description of this custom field mapping. Display-only — not part of any uniqueness check. 
+                            # @param [entity_metadata]: [CustomFieldMappingList.IntelligenceOperatorEntityMetadata] 
+                        attr_accessor :category, :name, :description, :entity_metadata
+                        def initialize(payload)
+                                @category = payload["category"]
+                                @name = payload["name"]
+                                @description = payload["description"]
+                                @entity_metadata = payload["entity_metadata"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "category": @category,
+                                "name": @name,
+                                "description": @description,
+                                "entityMetadata": @entity_metadata,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the CustomFieldMappingList
+                    # @param [Version] version Version that contains the resource
+                    # @return [CustomFieldMappingList] CustomFieldMappingList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/ControlPlane/ConversationInsights/CustomFieldMappings"
+                        
+                    end
+                    ##
+                    # Create the CustomFieldMappingInstance
+                    # @param [CustomFieldMappingRequest] custom_field_mapping_request 
+                    # @return [CustomFieldMappingInstance] Created CustomFieldMappingInstance
+                    def create(custom_field_mapping_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: custom_field_mapping_request.to_json)
+                        CustomFieldMappingInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the CustomFieldMappingInstanceMetadata
+                    # @param [CustomFieldMappingRequest] custom_field_mapping_request 
+                    # @return [CustomFieldMappingInstance] Created CustomFieldMappingInstance
+                    def create_with_metadata(custom_field_mapping_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: custom_field_mapping_request.to_json)
+                        custom_field_mapping_instance = CustomFieldMappingInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        CustomFieldMappingInstanceMetadata.new(
+                            @version,
+                            custom_field_mapping_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Fetch the CustomFieldMappingInstance
+                    # @return [CustomFieldMappingInstance] Fetched CustomFieldMappingInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        CustomFieldMappingInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Fetch the CustomFieldMappingInstanceMetadata
+                    # @return [CustomFieldMappingInstance] Fetched CustomFieldMappingInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        custom_field_mapping_instance = CustomFieldMappingInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        CustomFieldMappingInstanceMetadata.new(
+                            @version,
+                            custom_field_mapping_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Insights.V3.CustomFieldMappingList>'
+                    end
+                end
+
+                class CustomFieldMappingPage < TokenPage
+                    ##
+                    # Initialize the CustomFieldMappingPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [CustomFieldMappingPage] CustomFieldMappingPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of CustomFieldMappingInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [CustomFieldMappingInstance] CustomFieldMappingInstance
+                    def get_instance(payload)
+                        CustomFieldMappingInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Insights.V3.CustomFieldMappingPage>'
+                    end
+                end
+
+                class CustomFieldMappingInstance < InstanceResource
+                    ##
+                    # Initialize the CustomFieldMappingInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this CustomFieldMapping
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [CustomFieldMappingInstance] CustomFieldMappingInstance
+                    def initialize(version, payload )
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'id' => payload['id'],
+                            'category' => payload['category'],
+                            'name' => payload['name'],
+                            'description' => payload['description'],
+                            'entity_metadata' => payload['entity_metadata'],
+                            'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                            'updated_at' => Twilio.deserialize_iso8601_datetime(payload['updated_at']),
+                            'mappings' => payload['mappings'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] TTID for conversation insights custom field mapping
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [MappingCategory] 
+                    def category
+                        @properties['category']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def name
+                        @properties['name']
+                    end
+                    
+                    ##
+                    # @return [String] Optional, free-text description supplied at registration time. Display-only — not part of any uniqueness check. 
+                    def description
+                        @properties['description']
+                    end
+                    
+                    ##
+                    # @return [IntelligenceOperatorEntityMetadata] 
+                    def entity_metadata
+                        @properties['entity_metadata']
+                    end
+                    
+                    ##
+                    # @return [Time] When the mapping was registered.
+                    def created_at
+                        @properties['created_at']
+                    end
+                    
+                    ##
+                    # @return [Time] When the mapping was last materially modified in-place. Null until the first update-in-place.
+                    def updated_at
+                        @properties['updated_at']
+                    end
+                    
+                    ##
+                    # @return [Array<CustomFieldMappingResponse>] 
+                    def mappings
+                        @properties['mappings']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Insights.V3.CustomFieldMappingInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Insights.V3.CustomFieldMappingInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/insights/v3.rb

@@ -21,11 +21,23 @@ module Twilio
                 def initialize(domain)
                     super
                     @version = 'v3'
+                    @capacity = nil
+                    @custom_field_mappings = nil
                     @metadata = nil
                     @query = nil
                     @query_jobs = nil
                 end
 
+                ##
+                # @return [Twilio::REST::Insights::V3::CapacityList]
+                def capacity
+                    @capacity ||= CapacityList.new self
+                end
+                ##
+                # @return [Twilio::REST::Insights::V3::CustomFieldMappingList]
+                def custom_field_mappings
+                    @custom_field_mappings ||= CustomFieldMappingList.new self
+                end
                 ##
                 # @return [Twilio::REST::Insights::V3::MetadataList]
                 def metadata

data/lib/twilio-ruby/rest/intelligence/v3/rule_execution.rb

@@ -23,17 +23,20 @@ module Twilio
                             # @param [intelligence_configuration_id]: [String] The Intelligence Configuration identifier to execute the Rule within.
                             # @param [rule_id]: [String] The rule identifier to execute within the selected Intelligence Configuration.
                             # @param [conversation_id]: [String] The Conversation identifier to execute the Rule against.
-                        attr_accessor :intelligence_configuration_id, :rule_id, :conversation_id
+                            # @param [rule]: [RuleExecutionList.RuleOverride] 
+                        attr_accessor :intelligence_configuration_id, :rule_id, :conversation_id, :rule
                         def initialize(payload)
                                 @intelligence_configuration_id = payload["intelligence_configuration_id"]
                                 @rule_id = payload["rule_id"]
                                 @conversation_id = payload["conversation_id"]
+                                @rule = payload["rule"]
                         end
                         def to_json(options = {})
                         {
                                 "intelligenceConfigurationId": @intelligence_configuration_id,
                                 "ruleId": @rule_id,
                                 "conversationId": @conversation_id,
+                                "rule": @rule,
                         }.to_json(options)
                         end
                     end
@@ -105,6 +108,22 @@ module Twilio
                         end
                     end
 
+                    class OperatorOverride
+                            # @param [id]: [String] The operator id (as configured in the stored rule) to override.
+                            # @param [parameters]: [Hash<String, Object>] Parameter overrides merged into the stored operator's parameters.
+                        attr_accessor :id, :parameters
+                        def initialize(payload)
+                                @id = payload["id"]
+                                @parameters = payload["parameters"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "id": @id,
+                                "parameters": @parameters,
+                        }.to_json(options)
+                        end
+                    end
+
                     class ResolvedContext
                             # @param [memory]: [ResolvedContextMemory] 
                             # @param [knowledge]: [ResolvedContextKnowledge] 
@@ -166,6 +185,19 @@ module Twilio
                         end
                     end
 
+                    class RuleOverride
+                            # @param [operators]: [Array<RuleExecutionList.OperatorOverride>] Operator parameter overrides, merged key-by-key into the stored operator's parameters (override wins on matching keys; unspecified keys retain their stored values). Operators in the stored rule not referenced here execute with their stored parameters unchanged. 
+                        attr_accessor :operators
+                        def initialize(payload)
+                                @operators = payload["operators"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "operators": @operators,
+                        }.to_json(options)
+                        end
+                    end
+
                     class SystemMetaData
                             # @param [resolved_model]: [String] The underlying LLM model used for this execution.
                             # @param [latency_ms]: [Integer] Operator execution time in milliseconds.

data/lib/twilio-ruby/rest/memory/v1/data_mapping.rb

@@ -470,7 +470,7 @@ module Twilio
                     # @return [DataMappingInstance] Patched DataMappingInstance
                     def patch(
                       if_match: :unset,
-                      data_mapping_core: :unset
+                      data_mapping_core: nil
                     )
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
@@ -495,7 +495,7 @@ module Twilio
                     # @return [DataMappingInstance] Patchd DataMappingInstance
                     def patch_with_metadata(
                       if_match: :unset,
-                    data_mapping_core: :unset
+                    data_mapping_core: nil
                     )
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
@@ -807,7 +807,7 @@ module Twilio
                     # @return [DataMappingInstance] Patched DataMappingInstance
                     def patch(
                       if_match: :unset,
-                      data_mapping_core: :unset
+                      data_mapping_core: nil
                     )
 
                         context.patch(

data/lib/twilio-ruby/rest/memory/v1/store.rb

@@ -388,7 +388,7 @@ module Twilio
                     # @return [StoreInstance] Patched StoreInstance
                     def patch(
                       if_match: :unset,
-                      patch_store_request: :unset
+                      patch_store_request: nil
                     )
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
@@ -412,7 +412,7 @@ module Twilio
                     # @return [StoreInstance] Patchd StoreInstance
                     def patch_with_metadata(
                       if_match: :unset,
-                    patch_store_request: :unset
+                    patch_store_request: nil
                     )
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
@@ -716,7 +716,7 @@ module Twilio
                     # @return [StoreInstance] Patched StoreInstance
                     def patch(
                       if_match: :unset,
-                      patch_store_request: :unset
+                      patch_store_request: nil
                     )
 
                         context.patch(

data/lib/twilio-ruby/rest/memory/v1/trait_group.rb

@@ -594,7 +594,7 @@ module Twilio
                     # @return [TraitGroupInstance] Patched TraitGroupInstance
                     def patch(
                       if_match: :unset,
-                      patch_trait_group_request: :unset
+                      patch_trait_group_request: nil
                     )
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
@@ -619,7 +619,7 @@ module Twilio
                     # @return [TraitGroupInstance] Patchd TraitGroupInstance
                     def patch_with_metadata(
                       if_match: :unset,
-                    patch_trait_group_request: :unset
+                    patch_trait_group_request: nil
                     )
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
@@ -924,7 +924,7 @@ module Twilio
                     # @return [TraitGroupInstance] Patched TraitGroupInstance
                     def patch(
                       if_match: :unset,
-                      patch_trait_group_request: :unset
+                      patch_trait_group_request: nil
                     )
 
                         context.patch(

data/lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb

@@ -635,7 +635,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Hash] Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length.
+                    # @return [Hash] Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length. For `passkeys` factors, it contains the `aaguid` of the authenticator once the factor is verified, and `date_last_approved` (ISO 8601) once the factor has been used to approve a challenge.
                     def metadata
                         @properties['metadata']
                     end

data/lib/twilio-ruby/rest/verify/v2/service/new_verify_factor.rb

@@ -265,7 +265,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Hash] Custom metadata associated with the factor.
+                    # @return [Hash] Metadata associated with the factor. For `passkeys` factors, it contains the `aaguid` of the authenticator once the factor is verified, and `date_last_approved` (ISO 8601) once the factor has been used to approve a challenge.
                     def metadata
                         @properties['metadata']
                     end