twilio-ruby 7.10.4 → 7.10.6

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

@@ -0,0 +1,1073 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio Conversational Intelligence API
+#    The Conversational Intelligence API includes resources to create and manage intelligence configurations, define and run language operators, and retrieve processed conversations and operator results.  * Use the Configurations resource to create and manage intelligence configurations and define rules that control how and when language operators analyze and transform conversations.  * Use the Operators resource to create custom language operators or retrieve Twilio-author and custom operators. * Use the Conversations resource to retrieve conversations processed with an intelligence configuration, and the OperatorResults resource to retrieve language operator results for those conversations. 
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Intelligence < IntelligenceBase
+            class V3 < Version
+                class ConfigurationList < ListResource
+                
+                    class Action
+                            # @param [type]: [String] The type of Action to be performed after the Rule is triggered. Supported Actions are: - `WEBHOOK`: A webhook Action sends an HTTP request to a specified URL with Rule execution results. 
+                            # @param [method]: [String] The HTTP method to be used when performing the Action. Must be set to `POST`.
+                            # @param [url]: [String] The URL endpoint where the Action will send the HTTP request containing the Rule execution results.
+                        attr_accessor :type, :method, :url
+                        def initialize(payload)
+                                @type = payload["type"]
+                                @method = payload["method"]
+                                @url = payload["url"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "type": @type,
+                                "method": @method,
+                                "url": @url,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class Context
+                            # @param [memory]: [ConfigurationList.ContextMemory] 
+                            # @param [knowledge]: [ConfigurationList.ContextKnowledge] 
+                        attr_accessor :memory, :knowledge
+                        def initialize(payload)
+                                @memory = payload["memory"]
+                                @knowledge = payload["knowledge"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "memory": @memory,
+                                "knowledge": @knowledge,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ContextKnowledge
+                            # @param [bases]: [Array<String>] Specifies the Knowledge Base(s) and corresponding Source(s) to pass to Language Operators in this Rule as context. Only applied to Language Operators that have Knowledge as a context source enabled. 
+                        attr_accessor :bases
+                        def initialize(payload)
+                                @bases = payload["bases"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "bases": @bases,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ContextMemory
+                            # @param [enabled]: [Boolean] When set to `true`, allows this Intelligence Configuration Rule to pass the Profile into attached Language Operators. The profile is only passed to Language Operators that have Memory as a context source enabled. 
+                        attr_accessor :enabled
+                        def initialize(payload)
+                                @enabled = payload["enabled"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "enabled": @enabled,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateConfigurationRequest
+                            # @param [display_name]: [String] The display name of the Intelligence Configuration describing its purpose.
+                            # @param [description]: [String] The description of the Intelligence Configuration further explaining its purpose.
+                            # @param [rules]: [Array<ConfigurationList.RuleCreationRequestPayload>] List of Intelligence Configuration Rules that govern when and how Language Operators run. Each Rule represents a bundle of Operators, Triggers, Context, and Actions to be executed by the Intelligence Configuration on a Conversation. A maximum of five (5) Rules are allowed per Intelligence Configuration.  To create an Intelligence Configuration without any Rules configured yet, pass an empty array (`\"rules\": []`). The Configuration will not execute any Language Operators until at least one Rule has been added. 
+                        attr_accessor :display_name, :description, :rules
+                        def initialize(payload)
+                                @display_name = payload["display_name"]
+                                @description = payload["description"]
+                                @rules = payload["rules"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "displayName": @display_name,
+                                "description": @description,
+                                "rules": @rules,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class Operator
+                            # @param [id]: [String] The unique identifier for the Language Operator to be executed by the Rule. Assigned by Twilio (TTID).
+                            # @param [version]: [String] The specific version of the Language Operator to execute. When provided, the Rule will use this exact version of the Operator. When omitted, the latest active version of the Operator is used at execution time. 
+                            # @param [parameters]: [Hash] Key-value mapping for parameters defined as part of the Operator schema. The key and value passed by the Rule must match the name and data type of the parameter defined in the Operator, respectively. These parameters will customize the behavior of the Operator when executed by the Rule via runtime substitution into the prompt. Note: For parameters of type `knowledge_base_and_source_ids`, the value must be passed in the following format: `knowledge_base_id:knowledge_source_id`. 
+                        attr_accessor :id, :version, :parameters
+                        def initialize(payload)
+                                @id = payload["id"]
+                                @version = payload["version"]
+                                @parameters = payload["parameters"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "id": @id,
+                                "version": @version,
+                                "parameters": @parameters,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class RuleCreationRequestPayload
+                            # @param [operators]: [Array<ConfigurationList.Operator>] List of Operators to be executed by the Rule. Minimum of one (1) and maximum of five (5) Operators allowed per Rule.
+                            # @param [triggers]: [Array<ConfigurationList.Trigger>] List of Triggers that determine when to activate the Rule. Maximum of one (1) Trigger allowed per Rule.
+                            # @param [actions]: [Array<ConfigurationList.Action>] List of Actions to be performed after the Rule is triggered. Maximum of two (2) Actions allowed per Rule.
+                            # @param [context]: [ConfigurationList.Context] 
+                        attr_accessor :operators, :triggers, :actions, :context
+                        def initialize(payload)
+                                @operators = payload["operators"]
+                                @triggers = payload["triggers"]
+                                @actions = payload["actions"]
+                                @context = payload["context"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "operators": @operators,
+                                "triggers": @triggers,
+                                "actions": @actions,
+                                "context": @context,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class RuleUpdateRequestPayload
+                            # @param [id]: [String] Optional field used when updating an existing Rule within an Intelligence Configuration. When provided, the Rule with this `id` is updated; when omitted, a new Rule is created. 
+                            # @param [operators]: [Array<ConfigurationList.Operator>] List of Operators to be executed by the Rule. Minimum of one (1) and maximum of five (5) Operators allowed per Rule.
+                            # @param [triggers]: [Array<ConfigurationList.Trigger>] List of Triggers that determine when to activate the Rule. Maximum of one (1) Trigger allowed per Rule.
+                            # @param [actions]: [Array<ConfigurationList.Action>] List of Actions to be performed after the Rule is triggered. Maximum of two (2) Actions allowed per Rule.
+                            # @param [context]: [ConfigurationList.Context] 
+                        attr_accessor :id, :operators, :triggers, :actions, :context
+                        def initialize(payload)
+                                @id = payload["id"]
+                                @operators = payload["operators"]
+                                @triggers = payload["triggers"]
+                                @actions = payload["actions"]
+                                @context = payload["context"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "id": @id,
+                                "operators": @operators,
+                                "triggers": @triggers,
+                                "actions": @actions,
+                                "context": @context,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class Trigger
+                            # @param [on]: [String] The conversational lifecycle event that will activate execution of the Rule. Available values are: - `COMMUNICATION`: Trigger the Rule on each communication within the Conversation. - `CONVERSATION_END`: Trigger the Rule when the Conversation moves to the `closed` state - `CONVERSATION_INACTIVE`: Trigger the Rule when the Conversation moves to `inactive` state 
+                            # @param [parameters]: [ConfigurationList.TriggerParameters] 
+                        attr_accessor :on, :parameters
+                        def initialize(payload)
+                                @on = payload["on"]
+                                @parameters = payload["parameters"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "on": @on,
+                                "parameters": @parameters,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class TriggerParameters
+                            # @param [count]: [String] When `on` is set to `COMMUNICATION`, this value controls how often the Rule should run. A value of `1` executes the Rule for every communication event. Higher values delay execution until the specified number of communications have occurred since the last execution. 
+                        attr_accessor :count
+                        def initialize(payload)
+                                @count = payload["count"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "count": @count,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class UpdateConfigurationRequest
+                            # @param [display_name]: [String] The display name of the Intelligence Configuration describing its purpose.
+                            # @param [description]: [String] The description of the Intelligence Configuration further explaining its purpose.
+                            # @param [rules]: [Array<ConfigurationList.RuleUpdateRequestPayload>] List of Intelligence Configuration Rules that govern when and how Language Operators run. Each Rule represents a bundle of Operators, Triggers, Context, and Actions to be executed by the Intelligence Configuration on a Conversation. A maximum of five (5) Rules are allowed per Intelligence Configuration. 
+                        attr_accessor :display_name, :description, :rules
+                        def initialize(payload)
+                                @display_name = payload["display_name"]
+                                @description = payload["description"]
+                                @rules = payload["rules"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "displayName": @display_name,
+                                "description": @description,
+                                "rules": @rules,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    class Action
+                            # @param [type]: [String] The type of Action to be performed after the Rule is triggered. Supported Actions are: - `WEBHOOK`: A webhook Action sends an HTTP request to a specified URL with Rule execution results. 
+                            # @param [method]: [String] The HTTP method to be used when performing the Action. Must be set to `POST`.
+                            # @param [url]: [String] The URL endpoint where the Action will send the HTTP request containing the Rule execution results.
+                        attr_accessor :type, :method, :url
+                        def initialize(payload)
+                                @type = payload["type"]
+                                @method = payload["method"]
+                                @url = payload["url"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "type": @type,
+                                "method": @method,
+                                "url": @url,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class Context
+                            # @param [memory]: [ConfigurationList.ContextMemory] 
+                            # @param [knowledge]: [ConfigurationList.ContextKnowledge] 
+                        attr_accessor :memory, :knowledge
+                        def initialize(payload)
+                                @memory = payload["memory"]
+                                @knowledge = payload["knowledge"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "memory": @memory,
+                                "knowledge": @knowledge,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ContextKnowledge
+                            # @param [bases]: [Array<String>] Specifies the Knowledge Base(s) and corresponding Source(s) to pass to Language Operators in this Rule as context. Only applied to Language Operators that have Knowledge as a context source enabled. 
+                        attr_accessor :bases
+                        def initialize(payload)
+                                @bases = payload["bases"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "bases": @bases,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ContextMemory
+                            # @param [enabled]: [Boolean] When set to `true`, allows this Intelligence Configuration Rule to pass the Profile into attached Language Operators. The profile is only passed to Language Operators that have Memory as a context source enabled. 
+                        attr_accessor :enabled
+                        def initialize(payload)
+                                @enabled = payload["enabled"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "enabled": @enabled,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateConfigurationRequest
+                            # @param [display_name]: [String] The display name of the Intelligence Configuration describing its purpose.
+                            # @param [description]: [String] The description of the Intelligence Configuration further explaining its purpose.
+                            # @param [rules]: [Array<ConfigurationList.RuleCreationRequestPayload>] List of Intelligence Configuration Rules that govern when and how Language Operators run. Each Rule represents a bundle of Operators, Triggers, Context, and Actions to be executed by the Intelligence Configuration on a Conversation. A maximum of five (5) Rules are allowed per Intelligence Configuration.  To create an Intelligence Configuration without any Rules configured yet, pass an empty array (`\"rules\": []`). The Configuration will not execute any Language Operators until at least one Rule has been added. 
+                        attr_accessor :display_name, :description, :rules
+                        def initialize(payload)
+                                @display_name = payload["display_name"]
+                                @description = payload["description"]
+                                @rules = payload["rules"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "displayName": @display_name,
+                                "description": @description,
+                                "rules": @rules,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class Operator
+                            # @param [id]: [String] The unique identifier for the Language Operator to be executed by the Rule. Assigned by Twilio (TTID).
+                            # @param [version]: [String] The specific version of the Language Operator to execute. When provided, the Rule will use this exact version of the Operator. When omitted, the latest active version of the Operator is used at execution time. 
+                            # @param [parameters]: [Hash] Key-value mapping for parameters defined as part of the Operator schema. The key and value passed by the Rule must match the name and data type of the parameter defined in the Operator, respectively. These parameters will customize the behavior of the Operator when executed by the Rule via runtime substitution into the prompt. Note: For parameters of type `knowledge_base_and_source_ids`, the value must be passed in the following format: `knowledge_base_id:knowledge_source_id`. 
+                        attr_accessor :id, :version, :parameters
+                        def initialize(payload)
+                                @id = payload["id"]
+                                @version = payload["version"]
+                                @parameters = payload["parameters"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "id": @id,
+                                "version": @version,
+                                "parameters": @parameters,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class RuleCreationRequestPayload
+                            # @param [operators]: [Array<ConfigurationList.Operator>] List of Operators to be executed by the Rule. Minimum of one (1) and maximum of five (5) Operators allowed per Rule.
+                            # @param [triggers]: [Array<ConfigurationList.Trigger>] List of Triggers that determine when to activate the Rule. Maximum of one (1) Trigger allowed per Rule.
+                            # @param [actions]: [Array<ConfigurationList.Action>] List of Actions to be performed after the Rule is triggered. Maximum of two (2) Actions allowed per Rule.
+                            # @param [context]: [ConfigurationList.Context] 
+                        attr_accessor :operators, :triggers, :actions, :context
+                        def initialize(payload)
+                                @operators = payload["operators"]
+                                @triggers = payload["triggers"]
+                                @actions = payload["actions"]
+                                @context = payload["context"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "operators": @operators,
+                                "triggers": @triggers,
+                                "actions": @actions,
+                                "context": @context,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class RuleUpdateRequestPayload
+                            # @param [id]: [String] Optional field used when updating an existing Rule within an Intelligence Configuration. When provided, the Rule with this `id` is updated; when omitted, a new Rule is created. 
+                            # @param [operators]: [Array<ConfigurationList.Operator>] List of Operators to be executed by the Rule. Minimum of one (1) and maximum of five (5) Operators allowed per Rule.
+                            # @param [triggers]: [Array<ConfigurationList.Trigger>] List of Triggers that determine when to activate the Rule. Maximum of one (1) Trigger allowed per Rule.
+                            # @param [actions]: [Array<ConfigurationList.Action>] List of Actions to be performed after the Rule is triggered. Maximum of two (2) Actions allowed per Rule.
+                            # @param [context]: [ConfigurationList.Context] 
+                        attr_accessor :id, :operators, :triggers, :actions, :context
+                        def initialize(payload)
+                                @id = payload["id"]
+                                @operators = payload["operators"]
+                                @triggers = payload["triggers"]
+                                @actions = payload["actions"]
+                                @context = payload["context"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "id": @id,
+                                "operators": @operators,
+                                "triggers": @triggers,
+                                "actions": @actions,
+                                "context": @context,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class Trigger
+                            # @param [on]: [String] The conversational lifecycle event that will activate execution of the Rule. Available values are: - `COMMUNICATION`: Trigger the Rule on each communication within the Conversation. - `CONVERSATION_END`: Trigger the Rule when the Conversation moves to the `closed` state - `CONVERSATION_INACTIVE`: Trigger the Rule when the Conversation moves to `inactive` state 
+                            # @param [parameters]: [ConfigurationList.TriggerParameters] 
+                        attr_accessor :on, :parameters
+                        def initialize(payload)
+                                @on = payload["on"]
+                                @parameters = payload["parameters"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "on": @on,
+                                "parameters": @parameters,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class TriggerParameters
+                            # @param [count]: [String] When `on` is set to `COMMUNICATION`, this value controls how often the Rule should run. A value of `1` executes the Rule for every communication event. Higher values delay execution until the specified number of communications have occurred since the last execution. 
+                        attr_accessor :count
+                        def initialize(payload)
+                                @count = payload["count"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "count": @count,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class UpdateConfigurationRequest
+                            # @param [display_name]: [String] The display name of the Intelligence Configuration describing its purpose.
+                            # @param [description]: [String] The description of the Intelligence Configuration further explaining its purpose.
+                            # @param [rules]: [Array<ConfigurationList.RuleUpdateRequestPayload>] List of Intelligence Configuration Rules that govern when and how Language Operators run. Each Rule represents a bundle of Operators, Triggers, Context, and Actions to be executed by the Intelligence Configuration on a Conversation. A maximum of five (5) Rules are allowed per Intelligence Configuration. 
+                        attr_accessor :display_name, :description, :rules
+                        def initialize(payload)
+                                @display_name = payload["display_name"]
+                                @description = payload["description"]
+                                @rules = payload["rules"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "displayName": @display_name,
+                                "description": @description,
+                                "rules": @rules,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the ConfigurationList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ConfigurationList] ConfigurationList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/ControlPlane/Configurations"
+                        
+                    end
+                    ##
+                    # Create the ConfigurationInstance
+                    # @param [CreateConfigurationRequest] create_configuration_request 
+                    # @return [ConfigurationInstance] Created ConfigurationInstance
+                    def create(create_configuration_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: create_configuration_request.to_json)
+                        ConfigurationInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the ConfigurationInstanceMetadata
+                    # @param [CreateConfigurationRequest] create_configuration_request 
+                    # @return [ConfigurationInstance] Created ConfigurationInstance
+                    def create_with_metadata(create_configuration_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: create_configuration_request.to_json)
+                        configuration_instance = ConfigurationInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        ConfigurationInstanceMetadata.new(
+                            @version,
+                            configuration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+                    ##
+                    # Lists ConfigurationInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [String] page_token Token for pagination
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list(page_token: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            page_token: page_token,
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [String] page_token Token for pagination
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Enumerable] Enumerable that will yield up to limit results
+                    def stream(page_token: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            page_token: page_token,
+                            page_size: limits[:page_size], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists ConfigurationPageMetadata records from the API as a list.
+                      # @param [String] page_token Token for pagination
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list_with_metadata(page_token: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ConfigurationPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields ConfigurationInstance records from the API.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of ConfigurationInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] page_token Token for pagination
+                    
+                    # @return [Page] Page of ConfigurationInstance
+                    def page(page_token: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                                                        'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ConfigurationPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of ConfigurationInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of ConfigurationInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    ConfigurationPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Intelligence.V3.ConfigurationList>'
+                    end
+                end
+
+
+                class ConfigurationContext < InstanceContext
+                    ##
+                    # Initialize the ConfigurationContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] id The unique identifier of the Intelligence Configuration.
+                    # @return [ConfigurationContext] ConfigurationContext
+                    def initialize(version, id)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { id: id,  }
+                        @uri = "/ControlPlane/Configurations/#{@solution[:id]}"
+
+                        
+                    end
+                    ##
+                    # Delete the ConfigurationInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                        ConfigurationInstance.new(
+                          @version,
+                          response.body,
+                            id: @solution[:id],
+                        )
+                        
+                    end
+
+                    ##
+                    # Delete the ConfigurationInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          configuration_instance = ConfigurationInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          ConfigurationInstanceMetadata.new(@version, configuration_instance, response.headers, response.status_code)
+                    end
+
+                    ##
+                    # Fetch the ConfigurationInstance
+                    # @return [ConfigurationInstance] Fetched ConfigurationInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        ConfigurationInstance.new(
+                            @version,
+                            payload,
+                            id: @solution[:id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the ConfigurationInstanceMetadata
+                    # @return [ConfigurationInstance] Fetched ConfigurationInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        configuration_instance = ConfigurationInstance.new(
+                            @version,
+                            response.body,
+                            id: @solution[:id],
+                        )
+                        ConfigurationInstanceMetadata.new(
+                            @version,
+                            configuration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Update the ConfigurationInstance
+                    # @param [UpdateConfigurationRequest] update_configuration_request 
+                    # @return [ConfigurationInstance] Updated ConfigurationInstance
+                    def update(update_configuration_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.update('PUT', @uri, headers: headers, data: update_configuration_request.to_json)
+                        ConfigurationInstance.new(
+                            @version,
+                            payload,
+                            id: @solution[:id],
+                        )
+                    end
+
+                    ##
+                    # Update the ConfigurationInstanceMetadata
+                    # @param [UpdateConfigurationRequest] update_configuration_request 
+                    # @return [ConfigurationInstance] Updated ConfigurationInstance
+                    def update_with_metadata(update_configuration_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('PUT', @uri, headers: headers, data: update_configuration_request.to_json)
+                        configuration_instance = ConfigurationInstance.new(
+                            @version,
+                            response.body,
+                            id: @solution[:id],
+                        )
+                        ConfigurationInstanceMetadata.new(
+                            @version,
+                            configuration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Intelligence.V3.ConfigurationContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Intelligence.V3.ConfigurationContext #{context}>"
+                    end
+                end
+
+                class ConfigurationInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ConfigurationInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ConfigurationInstance] configuration_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [ConfigurationInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, configuration_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @configuration_instance = configuration_instance
+                    end
+
+                    def configuration
+                        @configuration_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ConfigurationInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ConfigurationListResponse < InstanceListResource
+                    # @param [Array<ConfigurationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @configuration_instance = payload.body[key].map do |data|
+                        ConfigurationInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def configuration_instance
+                          @instance
+                      end
+                  end
+
+                class ConfigurationPage < TokenPage
+                    ##
+                    # Initialize the ConfigurationPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ConfigurationPage] ConfigurationPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ConfigurationInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ConfigurationInstance] ConfigurationInstance
+                    def get_instance(payload)
+                        ConfigurationInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Intelligence.V3.ConfigurationPage>'
+                    end
+                end
+
+                class ConfigurationPageMetadata < PageMetadata
+                    attr_reader :configuration_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @configuration_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @configuration_page << ConfigurationListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @configuration_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Intelligence::V3PageMetadata>';
+                    end
+                end
+                class ConfigurationListResponse < InstanceListResource
+
+                    # @param [Array<ConfigurationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @configuration = data_list.map do |data|
+                        ConfigurationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def configuration
+                        @configuration
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class ConfigurationInstance < InstanceResource
+                    ##
+                    # Initialize the ConfigurationInstance
+                    # @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 Configuration
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ConfigurationInstance] ConfigurationInstance
+                    def initialize(version, payload , id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_id' => payload['account_id'],
+                            'id' => payload['id'],
+                            'display_name' => payload['display_name'],
+                            'description' => payload['description'],
+                            'version' => payload['version'] == nil ? payload['version'] : payload['version'].to_i,
+                            'rules' => payload['rules'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                            'code' => payload['code'],
+                            'message' => payload['message'],
+                            'http_status_code' => payload['http_status_code'],
+                            'user_error' => payload['user_error'],
+                            'params' => payload['params'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'id' => id  || @properties['id']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [ConfigurationContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = ConfigurationContext.new(@version , @params['id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The ID of the Account that created the Intelligence Configuration.
+                    def account_id
+                        @properties['account_id']
+                    end
+                    
+                    ##
+                    # @return [String] The unique identifier for the Intelligence Configuration. Assigned by Twilio (TTID).
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] The display name of the Intelligence Configuration describing its purpose.
+                    def display_name
+                        @properties['display_name']
+                    end
+                    
+                    ##
+                    # @return [String] The description of the Intelligence Configuration further explaining its purpose.
+                    def description
+                        @properties['description']
+                    end
+                    
+                    ##
+                    # @return [String] The numeric version of the Intelligence Configuration. Automatically incremented with each update on the resource, used to ensure integrity when updating the Configuration.
+                    def version
+                        @properties['version']
+                    end
+                    
+                    ##
+                    # @return [Array<Rule>] List of Intelligence Configuration Rules that govern when and how Language Operators run. Each Rule represents a bundle of Operators, Triggers, Context, and Actions to be executed by the Intelligence Configuration on a Conversation. A maximum of five (5) Rules are allowed per Intelligence Configuration. 
+                    def rules
+                        @properties['rules']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp of when the Intelligence Configuration was created.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp of when the Intelligence Configuration was last updated.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # @return [String] Twilio-specific error code
+                    def code
+                        @properties['code']
+                    end
+                    
+                    ##
+                    # @return [String] A human readable error message
+                    def message
+                        @properties['message']
+                    end
+                    
+                    ##
+                    # @return [String] HTTP response status code
+                    def http_status_code
+                        @properties['http_status_code']
+                    end
+                    
+                    ##
+                    # @return [Boolean] Whether the error is a user error (true) or a system error (false)
+                    def user_error
+                        @properties['user_error']
+                    end
+                    
+                    ##
+                    # @return [Hash<String, String>] A map of parameters related to the error, for example, a `params.twilioErrorCodeUrl` might hold a URL or link to additional information
+                    def params
+                        @properties['params']
+                    end
+                    
+                    ##
+                    # Delete the ConfigurationInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the ConfigurationInstance
+                    # @return [ConfigurationInstance] Fetched ConfigurationInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the ConfigurationInstance
+                    # @param [UpdateConfigurationRequest] update_configuration_request 
+                    # @return [ConfigurationInstance] Updated ConfigurationInstance
+                    def update(update_configuration_request: nil
+                    )
+
+                        context.update(
+                            update_configuration_request: update_configuration_request, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Intelligence.V3.ConfigurationInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Intelligence.V3.ConfigurationInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end