nexosis_api 2.0.0 → 2.0.1

data/lib/nexosis_api/client/views.rb

@@ -1,105 +1,105 @@
-module NexosisApi
-  # class to operate on views endpoint in Nexosis API
-  class Client
-    # Views-based API operations
-    # @see http://docs.nexosis.com/
-    # @since 1.2.0
-    module Views
-      ## List all existing view defintions, optionally limited by
-      # partial name or participating data sources
-      # @param partial_name [String] optionally limit results by view name
-      # @param dataset_name [String] optionally limit results by dataset used in definition
-      # @param page [Integer] optionally get results by non-zero page - defaults to 0
-      # @param page_size [Integer] optionally limit page size - defaults to 50 (max: 1000)
-      # @return [NexosisApi::PagedArray of NexosisApi::ViewDefinition]
-      # @raise [NexosisApi::HttpException]
-      def list_views(partial_name = '', dataset_name = '', page = 0, page_size = 50)
-        url = '/views'
-        query = {
-          'page': page,
-          'pageSize': page_size
-        }
-        query.store 'partialName', partial_name if partial_name.empty? == false
-        query.store 'dataSetName', dataset_name if dataset_name.empty? == false
-        response = self.class.get(url, headers: @headers, query: query)
-        raise NexosisApi::HttpException('Could not retrieve list of views.', 'attempting list of views', response) unless response.success?
-        NexosisApi::PagedArray.new(response.parsed_response, response.parsed_response['items']
-                               .map { |definition| NexosisApi::ViewDefinition.new(definition) })
-      end
-
-      # Create a new view or update an existing one by name
-      # @param view_name [String] the name of the view to create or update.
-      # @param dataset_name [String] the unique name of a data that is one source of this view.
-      # @param right_datasource_name [String] the additional data source to join in this view.
-      # @return [NexosisApi::ViewDefinition] - definition as created by API
-      # @note @view_name Must be unique within your organization
-      # @raise [NexosisApi::HttpException]
-      def create_view(view_name, dataset_name, right_datasource_name)
-        raise ArgumentError, 'view_name was not provided and is not optional' unless view_name.to_s.empty? == false
-        raise ArgumentError, 'dataset_name was not provided and is not optional' unless dataset_name.to_s.empty? == false
-        raise ArgumentError, 'right_datasource_name was not provided and is not optional' unless right_datasource_name.to_s.empty? == false
-        view_definition = NexosisApi::ViewDefinition.new('viewName' => view_name)
-        view_definition.dataset_name = dataset_name
-        join = NexosisApi::Join.new('dataSet' => { 'name' => right_datasource_name })
-        view_definition.joins = [join]
-        create_view_by_def(view_definition)
-      end
-
-      # Create or update a view based on a view definition object
-      # @param view_definition [NexosisApi::ViewDefinition] an object populated with the view configuration to create
-      # @return [NexosisApi::ViewDefinition] - definition as created by API
-      # @raise [NexosisApi::HttpException]
-      def create_view_by_def(view_definition)
-        view_name = view_definition.view_name
-        raise ArgumentError, 'view_name was not provided and is not optional' unless view_name.to_s.empty? == false
-        url = "/views/#{view_name}"
-        response = self.class.put(url, headers: @headers, body: view_definition.to_json)
-        if response.success?
-          return NexosisApi::ViewDefinition.new(response.parsed_response)
-        else
-          raise NexosisApi::HttpException.new('Could not create the requested view',
-                                              "Attempting to create view named #{view_name}",
-                                              response)
-        end
-      end
-
-      # Deletes the named view and optionally all sessions created from it
-      # @param view_name [String] the view to remove
-      # @param cascade [String] indicate any non-nil to remove associated sessions
-      # @return [void]
-      # @raise [NexosisApi::HttpException]
-      def remove_view(view_name, cascade = nil)
-        raise ArgumentError, 'view_name was not provided and is not optional' unless view_name.to_s.empty? == false
-        url = "/views/#{view_name}"
-        query = 'cascade=sessions' unless cascade.nil?
-        response = self.class.delete(url, headers: @headers, query: query)
-        unless response.success?
-          raise NexosisApi::HttpException.new('Could not delete view',
-                                              "Attempting to delete view #{view_name}",
-                                              response)
-        end
-      end
-
-      # Get the processed data from the view definition
-      #
-      # @param view_name [String] the unique name of the view for which to retrieve data
-      # @param page_number [Integer] zero-based page number of results to retrieve
-      # @param page_size [Integer] Count of results to retrieve in each page (max 1000).
-      # @param query_options [Hash] options hash for limiting and projecting returned results
-      # @note Query Options includes start_date as a DateTime or ISO 8601 compliant string,
-      #    end_date, also as a DateTime or string, and :include as an Array of strings indicating the columns to return.
-      #    The dates can be used independently and are inclusive. Lack of options returns all values within the given page.
-      # @note - the results include any transformations or imputations required to prepare the data for a session
-      # @raise [NexosisApi::HttpException]
-      def get_view(view_name, page_number = 0, page_size = 50, query_options = {})
-        raise ArgumentError, 'view_name was not provided and is not optional' unless view_name.to_s.empty? == false
-        url = "/views/#{view_name}"
-        response = self.class.get(url, headers: @headers,
-                                       query: create_query(page_number, page_size, query_options),
-                                       query_string_normalizer: ->(query_map) { array_query_normalizer(query_map) } )
-        raise NexosisApi::HttpException.new('Could not retrieve data for the given view', "Requesting data for view #{view_name}", response) unless response.success?
-        NexosisApi::ViewData.new(response.parsed_response)
-      end
-    end
-  end
-end
+module NexosisApi
+  # class to operate on views endpoint in Nexosis API
+  class Client
+    # Views-based API operations
+    # @see http://docs.nexosis.com/
+    # @since 1.2.0
+    module Views
+      ## List all existing view defintions, optionally limited by
+      # partial name or participating data sources
+      # @param partial_name [String] optionally limit results by view name
+      # @param dataset_name [String] optionally limit results by dataset used in definition
+      # @param page [Integer] optionally get results by non-zero page - defaults to 0
+      # @param page_size [Integer] optionally limit page size - defaults to 50 (max: 1000)
+      # @return [NexosisApi::PagedArray of NexosisApi::ViewDefinition]
+      # @raise [NexosisApi::HttpException]
+      def list_views(partial_name = '', dataset_name = '', page = 0, page_size = 50)
+        url = '/views'
+        query = {
+          'page': page,
+          'pageSize': page_size
+        }
+        query.store 'partialName', partial_name if partial_name.empty? == false
+        query.store 'dataSetName', dataset_name if dataset_name.empty? == false
+        response = self.class.get(url, headers: @headers, query: query)
+        raise NexosisApi::HttpException('Could not retrieve list of views.', 'attempting list of views', response) unless response.success?
+        NexosisApi::PagedArray.new(response.parsed_response, response.parsed_response['items']
+                               .map { |definition| NexosisApi::ViewDefinition.new(definition) })
+      end
+
+      # Create a new view or update an existing one by name
+      # @param view_name [String] the name of the view to create or update.
+      # @param dataset_name [String] the unique name of a data that is one source of this view.
+      # @param right_datasource_name [String] the additional data source to join in this view.
+      # @return [NexosisApi::ViewDefinition] - definition as created by API
+      # @note @view_name Must be unique within your organization
+      # @raise [NexosisApi::HttpException]
+      def create_view(view_name, dataset_name, right_datasource_name)
+        raise ArgumentError, 'view_name was not provided and is not optional' unless view_name.to_s.empty? == false
+        raise ArgumentError, 'dataset_name was not provided and is not optional' unless dataset_name.to_s.empty? == false
+        raise ArgumentError, 'right_datasource_name was not provided and is not optional' unless right_datasource_name.to_s.empty? == false
+        view_definition = NexosisApi::ViewDefinition.new('viewName' => view_name)
+        view_definition.dataset_name = dataset_name
+        join = NexosisApi::Join.new('dataSet' => { 'name' => right_datasource_name })
+        view_definition.joins = [join]
+        create_view_by_def(view_definition)
+      end
+
+      # Create or update a view based on a view definition object
+      # @param view_definition [NexosisApi::ViewDefinition] an object populated with the view configuration to create
+      # @return [NexosisApi::ViewDefinition] - definition as created by API
+      # @raise [NexosisApi::HttpException]
+      def create_view_by_def(view_definition)
+        view_name = view_definition.view_name
+        raise ArgumentError, 'view_name was not provided and is not optional' unless view_name.to_s.empty? == false
+        url = "/views/#{view_name}"
+        response = self.class.put(url, headers: @headers, body: view_definition.to_json)
+        if response.success?
+          return NexosisApi::ViewDefinition.new(response.parsed_response)
+        else
+          raise NexosisApi::HttpException.new('Could not create the requested view',
+                                              "Attempting to create view named #{view_name}",
+                                              response)
+        end
+      end
+
+      # Deletes the named view and optionally all sessions created from it
+      # @param view_name [String] the view to remove
+      # @param cascade [String] indicate any non-nil to remove associated sessions
+      # @return [void]
+      # @raise [NexosisApi::HttpException]
+      def remove_view(view_name, cascade = nil)
+        raise ArgumentError, 'view_name was not provided and is not optional' unless view_name.to_s.empty? == false
+        url = "/views/#{view_name}"
+        query = 'cascade=sessions' unless cascade.nil?
+        response = self.class.delete(url, headers: @headers, query: query)
+        unless response.success?
+          raise NexosisApi::HttpException.new('Could not delete view',
+                                              "Attempting to delete view #{view_name}",
+                                              response)
+        end
+      end
+
+      # Get the processed data from the view definition
+      #
+      # @param view_name [String] the unique name of the view for which to retrieve data
+      # @param page_number [Integer] zero-based page number of results to retrieve
+      # @param page_size [Integer] Count of results to retrieve in each page (max 1000).
+      # @param query_options [Hash] options hash for limiting and projecting returned results
+      # @note Query Options includes start_date as a DateTime or ISO 8601 compliant string,
+      #    end_date, also as a DateTime or string, and :include as an Array of strings indicating the columns to return.
+      #    The dates can be used independently and are inclusive. Lack of options returns all values within the given page.
+      # @note - the results include any transformations or imputations required to prepare the data for a session
+      # @raise [NexosisApi::HttpException]
+      def get_view(view_name, page_number = 0, page_size = 50, query_options = {})
+        raise ArgumentError, 'view_name was not provided and is not optional' unless view_name.to_s.empty? == false
+        url = "/views/#{view_name}"
+        response = self.class.get(url, headers: @headers,
+                                       query: create_query(page_number, page_size, query_options),
+                                       query_string_normalizer: ->(query_map) { array_query_normalizer(query_map) } )
+        raise NexosisApi::HttpException.new('Could not retrieve data for the given view', "Requesting data for view #{view_name}", response) unless response.success?
+        NexosisApi::ViewData.new(response.parsed_response)
+      end
+    end
+  end
+end

data/lib/nexosis_api/client.rb

@@ -1,118 +1,118 @@
-require 'nexosis_api/algorithm_contestant'
-require 'nexosis_api/algorithm'
-require 'nexosis_api/calendar_jointarget'
-require 'nexosis_api/classifier_result'
-require 'nexosis_api/column'
-require 'nexosis_api/column_options'
-require 'nexosis_api/column_role'
-require 'nexosis_api/column_type'
-require 'nexosis_api/dataset_data'
-require 'nexosis_api/dataset_jointarget'
-require 'nexosis_api/dataset_model'
-require 'nexosis_api/dataset_summary'
-require 'nexosis_api/http_exception'
-require 'nexosis_api/impact_metric'
-require 'nexosis_api/imports_response'
-require 'nexosis_api/join'
-require 'nexosis_api/link'
-require 'nexosis_api/message'
-require 'nexosis_api/metric'
-require 'nexosis_api/model_summary'
-require 'nexosis_api/paged_array'
-require 'nexosis_api/predict_response'
-require 'nexosis_api/session_contest'
-require 'nexosis_api/session_response'
-require 'nexosis_api/session_result'
-require 'nexosis_api/session_selection_metrics'
-require 'nexosis_api/session'
-require 'nexosis_api/time_interval'
-require 'nexosis_api/view_definition'
-require 'nexosis_api/view_data'
-require 'nexosis_api/client/contest'
-require 'nexosis_api/client/sessions'
-require 'nexosis_api/client/datasets'
-require 'nexosis_api/client/imports'
-require 'nexosis_api/client/views'
-require 'nexosis_api/client/models'
-
-module NexosisApi
-  # Primary entry point to working with Nexosis API
-  class Client
-    include HTTParty
-    base_uri 'https://ml.nexosis.com/v1'
-    include Client::Sessions
-    include Client::Datasets
-    include Client::Imports
-    include Client::Views
-    include Client::Models
-    include Client::Contest
-
-    def initialize(options = {})
-      raise ArgumentError, 'api_key was not defined' unless options[:api_key].nil? == false
-      @api_key = options[:api_key]
-      self.class.base_uri options[:base_uri] unless options[:base_uri].nil?
-      @headers = { 'api-key' => @api_key, 'Content-Type' => 'application/json',
-                   'User-Agent' => 'Nexosis-Ruby-API-Client/1.2' }
-      @options = { headers: @headers, format: :json }
-    end
-
-    # Gets the quota stats for the account
-    #
-    # @return [Hash] a hash of quota values and current values
-    def get_account_quotas()
-      session_url = '/sessions?page=0&pageSize=1'
-      response = self.class.get(session_url, @options)
-      response.headers.select { |k, _v| k.to_s.start_with? 'nexosis-account' }
-    end
-
-    # Provide access to read or modify the api key
-    # @return [String]
-    # @since 2.0.0
-    def api_key(value)
-      @api_key = value unless value.nil?
-      @headers['api-key'] = @api_key
-      @api_key
-    end
-
-    private
-
-    # @private
-    def process_csv_to_s csv
-      content = ''
-      if(csv.is_a?(CSV))
-        csv.each do |row|
-          if(csv.headers.nil?)
-            # not using row.to_csv because it uses non-compliant '\n' newline
-            content.concat(row.join(',')).concat("\r\n")
-          else
-            content.concat(row.fields.join(',')).concat("\r\n")
-          end
-        end
-        if(csv.headers.nil? == false)
-          content.prepend(csv.headers.join(',').concat("\r\n")) unless csv.headers.nil?
-        end
-      else
-        content = csv
-      end
-      content
-    end
-
-    # @private
-    def create_query(page_number, page_size, options = {})
-      options.store(:page_number, page_number)
-      options.store(:page_size, page_size)
-      query = {
-        'page' => [page_number],
-        'pageSize' => [page_size]
-      }
-      query['startDate'] = [options[:start_date].iso8601.gsub(/\+/,'%2B')] unless options[:start_date].nil?
-      query['endDate'] = [options[:end_date].iso8601.gsub(/\+/,'%2B')] unless options[:end_date].nil?
-      query['include'] = options[:include] unless options[:include].nil?
-      query
-    end
-
-    def array_query_normalizer(query_set)
-      query_set.map { |key, value| value.map { |v| "#{key}=#{v}" } }.join('&')
-    end
-  end
-end
+require 'nexosis_api/algorithm_contestant'
+require 'nexosis_api/algorithm'
+require 'nexosis_api/calendar_jointarget'
+require 'nexosis_api/classifier_result'
+require 'nexosis_api/column'
+require 'nexosis_api/column_options'
+require 'nexosis_api/column_role'
+require 'nexosis_api/column_type'
+require 'nexosis_api/dataset_data'
+require 'nexosis_api/dataset_jointarget'
+require 'nexosis_api/dataset_model'
+require 'nexosis_api/dataset_summary'
+require 'nexosis_api/http_exception'
+require 'nexosis_api/impact_metric'
+require 'nexosis_api/imports_response'
+require 'nexosis_api/join'
+require 'nexosis_api/link'
+require 'nexosis_api/message'
+require 'nexosis_api/metric'
+require 'nexosis_api/model_summary'
+require 'nexosis_api/paged_array'
+require 'nexosis_api/predict_response'
+require 'nexosis_api/session_contest'
+require 'nexosis_api/session_response'
+require 'nexosis_api/session_result'
+require 'nexosis_api/session_selection_metrics'
+require 'nexosis_api/session'
+require 'nexosis_api/time_interval'
+require 'nexosis_api/view_definition'
+require 'nexosis_api/view_data'
+require 'nexosis_api/client/contest'
+require 'nexosis_api/client/sessions'
+require 'nexosis_api/client/datasets'
+require 'nexosis_api/client/imports'
+require 'nexosis_api/client/views'
+require 'nexosis_api/client/models'
+
+module NexosisApi
+  # Primary entry point to working with Nexosis API
+  class Client
+    include HTTParty
+    base_uri 'https://ml.nexosis.com/v1'
+    include Client::Sessions
+    include Client::Datasets
+    include Client::Imports
+    include Client::Views
+    include Client::Models
+    include Client::Contest
+
+    def initialize(options = {})
+      raise ArgumentError, 'api_key was not defined' unless options[:api_key].nil? == false
+      @api_key = options[:api_key]
+      self.class.base_uri options[:base_uri] unless options[:base_uri].nil?
+      @headers = { 'api-key' => @api_key, 'Content-Type' => 'application/json',
+                   'User-Agent' => 'Nexosis-Ruby-API-Client/1.2' }
+      @options = { headers: @headers, format: :json }
+    end
+
+    # Gets the quota stats for the account
+    #
+    # @return [Hash] a hash of quota values and current values
+    def get_account_quotas()
+      session_url = '/sessions?page=0&pageSize=1'
+      response = self.class.get(session_url, @options)
+      response.headers.select { |k, _v| k.to_s.start_with? 'nexosis-account' }
+    end
+
+    # Provide access to read or modify the api key
+    # @return [String]
+    # @since 2.0.0
+    def api_key(value)
+      @api_key = value unless value.nil?
+      @headers['api-key'] = @api_key
+      @api_key
+    end
+
+    private
+
+    # @private
+    def process_csv_to_s csv
+      content = ''
+      if(csv.is_a?(CSV))
+        csv.each do |row|
+          if(csv.headers.nil?)
+            # not using row.to_csv because it uses non-compliant '\n' newline
+            content.concat(row.join(',')).concat("\r\n")
+          else
+            content.concat(row.fields.join(',')).concat("\r\n")
+          end
+        end
+        if(csv.headers.nil? == false)
+          content.prepend(csv.headers.join(',').concat("\r\n")) unless csv.headers.nil?
+        end
+      else
+        content = csv
+      end
+      content
+    end
+
+    # @private
+    def create_query(page_number, page_size, options = {})
+      options.store(:page_number, page_number)
+      options.store(:page_size, page_size)
+      query = {
+        'page' => [page_number],
+        'pageSize' => [page_size]
+      }
+      query['startDate'] = [options[:start_date].iso8601.gsub(/\+/,'%2B')] unless options[:start_date].nil?
+      query['endDate'] = [options[:end_date].iso8601.gsub(/\+/,'%2B')] unless options[:end_date].nil?
+      query['include'] = options[:include] unless options[:include].nil?
+      query
+    end
+
+    def array_query_normalizer(query_set)
+      query_set.map { |key, value| value.map { |v| "#{key}=#{v}" } }.join('&')
+    end
+  end
+end

data/lib/nexosis_api/column.rb

@@ -1,50 +1,50 @@
-module NexosisApi
-  # class to hold the parsed results of column metadata
-  class Column
-    def initialize(column_name, value_hash)
-      @name = column_name
-      @type = NexosisApi::ColumnType.const_get(value_hash['dataType'].upcase) unless value_hash['dataType'].nil?
-      @role = NexosisApi::ColumnRole.const_get(value_hash['role'].upcase) unless value_hash['role'].nil?
-      @imputation = value_hash['imputation'] unless value_hash['imputation'].nil?
-      @aggregation = value_hash['aggregation'] unless value_hash['aggregation'].nil?
-    end
-    # The column header, label, or name
-    # @return [String]
-    attr_accessor :name
-
-    # The data type of this column
-    # @note Either string, numeric, logical, or date
-    # @return [NexosisApi::ColumnType]
-    attr_accessor :type
-
-    # The role of this column
-    # @note Either none, timestamp, target, or feature
-    # @return [NexosisApi::ColumnRole]
-    attr_accessor :role
-
-    # The strategy used to imput missing values
-    # @note Either Zeroes, Mean, Median, or Mode
-    # @return [String]
-    attr_accessor :imputation
-
-    # The strategy used to aggregate data if requested prediction period is greater than observation period
-    # @note Either Sum, Mean, Median, or Mode
-    # @return [String]
-    attr_accessor :aggregation
-
-    # utility method to format a column description in the way it is expected on input
-    def to_hash
-      { name => { 'dataType' => type.to_s,
-                  'role' => role.to_s,
-                  'imputation' => imputation.to_s,
-                  'aggregation' => aggregation.to_s } }
-    end
-
-    # allows json to be built for api requests
-    def self.to_json(column_array)
-      result = {}
-      column_array.each { |col| result[col.to_hash.keys[0]] = col.to_hash.values[0] } 
-      result
-    end
-  end
-end
+module NexosisApi
+  # class to hold the parsed results of column metadata
+  class Column
+    def initialize(column_name, value_hash)
+      @name = column_name
+      @type = NexosisApi::ColumnType.const_get(value_hash['dataType'].upcase) unless value_hash['dataType'].nil?
+      @role = NexosisApi::ColumnRole.const_get(value_hash['role'].upcase) unless value_hash['role'].nil?
+      @imputation = value_hash['imputation'] unless value_hash['imputation'].nil?
+      @aggregation = value_hash['aggregation'] unless value_hash['aggregation'].nil?
+    end
+    # The column header, label, or name
+    # @return [String]
+    attr_accessor :name
+
+    # The data type of this column
+    # @note Either string, numeric, logical, or date
+    # @return [NexosisApi::ColumnType]
+    attr_accessor :type
+
+    # The role of this column
+    # @note Either none, timestamp, target, or feature
+    # @return [NexosisApi::ColumnRole]
+    attr_accessor :role
+
+    # The strategy used to imput missing values
+    # @note Either Zeroes, Mean, Median, or Mode
+    # @return [String]
+    attr_accessor :imputation
+
+    # The strategy used to aggregate data if requested prediction period is greater than observation period
+    # @note Either Sum, Mean, Median, or Mode
+    # @return [String]
+    attr_accessor :aggregation
+
+    # utility method to format a column description in the way it is expected on input
+    def to_hash
+      { name => { 'dataType' => type.to_s,
+                  'role' => role.to_s,
+                  'imputation' => imputation.to_s,
+                  'aggregation' => aggregation.to_s } }
+    end
+
+    # allows json to be built for api requests
+    def self.to_json(column_array)
+      result = {}
+      column_array.each { |col| result[col.to_hash.keys[0]] = col.to_hash.values[0] } 
+      result
+    end
+  end
+end

data/lib/nexosis_api/column_options.rb

@@ -1,38 +1,38 @@
-module NexosisApi
-  # Class for holding the join options on a column in a view-based join
-  # @since 1.2.0
-  class ColumnOptions
-    # Create a new option for a join column.
-    # @param column_name [String] the name of the original column from the source dataset
-    # @param options_hash [Hash] additional information about how to process the column in a join
-    def initialize(column_name, options_hash)
-      @column_name = column_name
-      @join_interval = NexosisApi::TimeInterval.const_get(options_hash['joinInterval'].upcase) unless options_hash['joinInterval'].nil?
-      @alias = options_hash['alias']
-    end
-
-    # The name of the column on which these options are applied
-    # @return [String]
-    attr_accessor :column_name
-
-    # Optional interval of a time series column being joined to another time series
-    # @note not valid outside of join defintion
-    # @return [NexosisApi::TimeInterval]
-    attr_accessor :join_interval
-
-    # Optional alias of the column when participating in a join
-    # @note An alias can be used to keep two same-named columns distinct
-    # or to merge two distinctly named columns. By default same-named columns
-    # on two sides of a join will be merged.
-    # @return [String]
-    attr_accessor :alias
-
-    # builds a custom hash which will match api requests
-    def to_hash
-      hash = { column_name => {} }
-      hash[column_name]['join_interval'] = join_interval.to_s unless join_interval.nil?
-      hash[column_name]['alias'] = @alias.to_s unless @alias.nil?
-      hash
-    end
-  end
-end
+module NexosisApi
+  # Class for holding the join options on a column in a view-based join
+  # @since 1.2.0
+  class ColumnOptions
+    # Create a new option for a join column.
+    # @param column_name [String] the name of the original column from the source dataset
+    # @param options_hash [Hash] additional information about how to process the column in a join
+    def initialize(column_name, options_hash)
+      @column_name = column_name
+      @join_interval = NexosisApi::TimeInterval.const_get(options_hash['joinInterval'].upcase) unless options_hash['joinInterval'].nil?
+      @alias = options_hash['alias']
+    end
+
+    # The name of the column on which these options are applied
+    # @return [String]
+    attr_accessor :column_name
+
+    # Optional interval of a time series column being joined to another time series
+    # @note not valid outside of join defintion
+    # @return [NexosisApi::TimeInterval]
+    attr_accessor :join_interval
+
+    # Optional alias of the column when participating in a join
+    # @note An alias can be used to keep two same-named columns distinct
+    # or to merge two distinctly named columns. By default same-named columns
+    # on two sides of a join will be merged.
+    # @return [String]
+    attr_accessor :alias
+
+    # builds a custom hash which will match api requests
+    def to_hash
+      hash = { column_name => {} }
+      hash[column_name]['join_interval'] = join_interval.to_s unless join_interval.nil?
+      hash[column_name]['alias'] = @alias.to_s unless @alias.nil?
+      hash
+    end
+  end
+end