twilio-ruby 7.11.1 → 7.11.3

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

@@ -0,0 +1,161 @@
+##
+#    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 CapacityList < ListResource
+                
+                    ##
+                    # Initialize the CapacityList
+                    # @param [Version] version Version that contains the resource
+                    # @return [CapacityList] CapacityList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/ControlPlane/ConversationInsights/CustomFieldMappings/Capacity"
+                        
+                    end
+                    ##
+                    # Fetch the CapacityInstance
+                    # @return [CapacityInstance] Fetched CapacityInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        CapacityInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Fetch the CapacityInstanceMetadata
+                    # @return [CapacityInstance] Fetched CapacityInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        capacity_instance = CapacityInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        CapacityInstanceMetadata.new(
+                            @version,
+                            capacity_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Insights.V3.CapacityList>'
+                    end
+                end
+
+                class CapacityPage < TokenPage
+                    ##
+                    # Initialize the CapacityPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [CapacityPage] CapacityPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of CapacityInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [CapacityInstance] CapacityInstance
+                    def get_instance(payload)
+                        CapacityInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Insights.V3.CapacityPage>'
+                    end
+                end
+
+                class CapacityInstance < InstanceResource
+                    ##
+                    # Initialize the CapacityInstance
+                    # @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 Capacity
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [CapacityInstance] CapacityInstance
+                    def initialize(version, payload )
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'measure' => payload['measure'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [CategoryCapacity] 
+                    def measure
+                        @properties['measure']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Insights.V3.CapacityInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Insights.V3.CapacityInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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/metadata.rb

@@ -5,7 +5,7 @@
 #     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
 #
 #    Twilio - Insights
-#    Insights Domain V3 API. Includes synchronous Query, Metadata, and Async Query (long-running operation) endpoints. 
+#    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
@@ -114,65 +114,6 @@ module Twilio
                     end
                 end
 
-                class MetadataPageMetadata < PageMetadata
-                    attr_reader :metadata_page
-
-                    def initialize(version, response, solution, limit)
-                        super(version, response)
-                        @metadata_page = []
-                        @limit = limit
-                        key = get_key(response.body)
-                        records = 0
-                        while( limit != :unset && records < limit )
-                            @metadata_page << MetadataListResponse.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
-                        @metadata_page.each do |record|
-                          yield record
-                        end
-                    end
-
-                    def to_s
-                      '<Twilio::REST::Insights::V3PageMetadata>';
-                    end
-                end
-                class MetadataListResponse < InstanceListResource
-
-                    # @param [Array<MetadataInstance>] 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
-                      @metadata = data_list.map do |data|
-                        MetadataInstance.new(version, data)
-                      end
-                      @headers = payload.headers
-                      @status_code = payload.status_code
-                    end
-
-                    def metadata
-                        @metadata
-                    end
-
-                    def headers
-                      @headers
-                    end
-
-                    def status_code
-                      @status_code
-                    end
-                end
-
                 class MetadataInstance < InstanceResource
                     ##
                     # Initialize the MetadataInstance

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

@@ -5,7 +5,7 @@
 #     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
 #
 #    Twilio - Insights
-#    Insights Domain V3 API. Includes synchronous Query, Metadata, and Async Query (long-running operation) endpoints. 
+#    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
@@ -274,65 +274,6 @@ module Twilio
                     end
                 end
 
-                class QueryPageMetadata < PageMetadata
-                    attr_reader :query_page
-
-                    def initialize(version, response, solution, limit)
-                        super(version, response)
-                        @query_page = []
-                        @limit = limit
-                        key = get_key(response.body)
-                        records = 0
-                        while( limit != :unset && records < limit )
-                            @query_page << QueryListResponse.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
-                        @query_page.each do |record|
-                          yield record
-                        end
-                    end
-
-                    def to_s
-                      '<Twilio::REST::Insights::V3PageMetadata>';
-                    end
-                end
-                class QueryListResponse < InstanceListResource
-
-                    # @param [Array<QueryInstance>] 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
-                      @query = data_list.map do |data|
-                        QueryInstance.new(version, data)
-                      end
-                      @headers = payload.headers
-                      @status_code = payload.status_code
-                    end
-
-                    def query
-                        @query
-                    end
-
-                    def headers
-                      @headers
-                    end
-
-                    def status_code
-                      @status_code
-                    end
-                end
-
                 class QueryInstance < InstanceResource
                     ##
                     # Initialize the QueryInstance