ultracart_api 3.11.16 → 3.11.17

data/lib/ultracart_api/api/datawarehouse_api.rb

@@ -32,6 +32,60 @@ module UltracartClient
       UltracartClient::DatawarehouseApi.new(api_client)
     end
 
+    # Delete a custom dashboard
+    # Delete a custom dashboard on the UltraCart account. 
+    # @param custom_dashboard_oid The dashboard oid to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_custom_dashboard(custom_dashboard_oid, opts = {})
+      delete_custom_dashboard_with_http_info(custom_dashboard_oid, opts)
+      nil
+    end
+
+    # Delete a custom dashboard
+    # Delete a custom dashboard on the UltraCart account. 
+    # @param custom_dashboard_oid The dashboard oid to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_custom_dashboard_with_http_info(custom_dashboard_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.delete_custom_dashboard ...'
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.delete_custom_dashboard"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}'.sub('{' + 'custom_dashboard_oid' + '}', custom_dashboard_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#delete_custom_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Delete a custom report
     # Delete a custom report on the UltraCart account. 
     # @param custom_report_oid The report oid to delete.
@@ -200,7 +254,7 @@ module UltracartClient
     # @param execution_request Request to execute custom report
     # @param custom_report_oid The report oid to execute.
     # @param [Hash] opts the optional parameters
-    # @return [CustomReportResponse]
+    # @return [CustomReportExecutionResponse]
     def execute_custom_report(execution_request, custom_report_oid, opts = {})
       data, _status_code, _headers = execute_custom_report_with_http_info(execution_request, custom_report_oid, opts)
       data
@@ -211,7 +265,7 @@ module UltracartClient
     # @param execution_request Request to execute custom report
     # @param custom_report_oid The report oid to execute.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(CustomReportResponse, Fixnum, Hash)>] CustomReportResponse data, response status code and response headers
+    # @return [Array<(CustomReportExecutionResponse, Fixnum, Hash)>] CustomReportExecutionResponse data, response status code and response headers
     def execute_custom_report_with_http_info(execution_request, custom_report_oid, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DatawarehouseApi.execute_custom_report ...'
@@ -250,12 +304,67 @@ module UltracartClient
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'CustomReportResponse')
+        :return_type => 'CustomReportExecutionResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: DatawarehouseApi#execute_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+    # Execute a custom reports
+    # Execute a custom reports on the UltraCart account. 
+    # @param execution_request Request to execute custom reports
+    # @param [Hash] opts the optional parameters
+    # @return [CustomReportsExecutionResponse]
+    def execute_custom_reports(execution_request, opts = {})
+      data, _status_code, _headers = execute_custom_reports_with_http_info(execution_request, opts)
+      data
+    end
+
+    # Execute a custom reports
+    # Execute a custom reports on the UltraCart account. 
+    # @param execution_request Request to execute custom reports
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomReportsExecutionResponse, Fixnum, Hash)>] CustomReportsExecutionResponse data, response status code and response headers
+    def execute_custom_reports_with_http_info(execution_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.execute_custom_reports ...'
+      end
+      # verify the required parameter 'execution_request' is set
+      if @api_client.config.client_side_validation && execution_request.nil?
+        fail ArgumentError, "Missing the required parameter 'execution_request' when calling DatawarehouseApi.execute_custom_reports"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_reports/execute'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(execution_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomReportsExecutionResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#execute_custom_reports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Execute the report queries
     # Execute the report queries 
     # @param query_request Query request
@@ -310,6 +419,110 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get a custom dashboard
+    # Retrieve a custom dashboard 
+    # @param custom_dashboard_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardResponse]
+    def get_custom_dashboard(custom_dashboard_oid, opts = {})
+      data, _status_code, _headers = get_custom_dashboard_with_http_info(custom_dashboard_oid, opts)
+      data
+    end
+
+    # Get a custom dashboard
+    # Retrieve a custom dashboard 
+    # @param custom_dashboard_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardResponse, Fixnum, Hash)>] CustomDashboardResponse data, response status code and response headers
+    def get_custom_dashboard_with_http_info(custom_dashboard_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_dashboard ...'
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.get_custom_dashboard"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}'.sub('{' + 'custom_dashboard_oid' + '}', custom_dashboard_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomDashboardResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get custom dashboards
+    # Retrieve a custom dashboards 
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardsResponse]
+    def get_custom_dashboards(opts = {})
+      data, _status_code, _headers = get_custom_dashboards_with_http_info(opts)
+      data
+    end
+
+    # Get custom dashboards
+    # Retrieve a custom dashboards 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardsResponse, Fixnum, Hash)>] CustomDashboardsResponse data, response status code and response headers
+    def get_custom_dashboards_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_dashboards ...'
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomDashboardsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_dashboards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get a custom report
     # Retrieve a custom report 
     # @param custom_report_oid 
@@ -732,6 +945,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Create a custom dashboard
+    # Create a new custom dashboard on the UltraCart account. 
+    # @param dashboard Dashboard to create
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardResponse]
+    def insert_custom_dashboard(dashboard, opts = {})
+      data, _status_code, _headers = insert_custom_dashboard_with_http_info(dashboard, opts)
+      data
+    end
+
+    # Create a custom dashboard
+    # Create a new custom dashboard on the UltraCart account. 
+    # @param dashboard Dashboard to create
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardResponse, Fixnum, Hash)>] CustomDashboardResponse data, response status code and response headers
+    def insert_custom_dashboard_with_http_info(dashboard, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.insert_custom_dashboard ...'
+      end
+      # verify the required parameter 'dashboard' is set
+      if @api_client.config.client_side_validation && dashboard.nil?
+        fail ArgumentError, "Missing the required parameter 'dashboard' when calling DatawarehouseApi.insert_custom_dashboard"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(dashboard)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomDashboardResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#insert_custom_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Create a custom report
     # Create a new custom report on the UltraCart account. 
     # @param report Report to create
@@ -842,6 +1110,67 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Update a custom dashboard
+    # Update a custom dashboard on the UltraCart account. 
+    # @param dashboard Dashboard to custom update
+    # @param custom_dashboard_oid The dashboard oid to custom update.
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardResponse]
+    def update_custom_dashboard(dashboard, custom_dashboard_oid, opts = {})
+      data, _status_code, _headers = update_custom_dashboard_with_http_info(dashboard, custom_dashboard_oid, opts)
+      data
+    end
+
+    # Update a custom dashboard
+    # Update a custom dashboard on the UltraCart account. 
+    # @param dashboard Dashboard to custom update
+    # @param custom_dashboard_oid The dashboard oid to custom update.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardResponse, Fixnum, Hash)>] CustomDashboardResponse data, response status code and response headers
+    def update_custom_dashboard_with_http_info(dashboard, custom_dashboard_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.update_custom_dashboard ...'
+      end
+      # verify the required parameter 'dashboard' is set
+      if @api_client.config.client_side_validation && dashboard.nil?
+        fail ArgumentError, "Missing the required parameter 'dashboard' when calling DatawarehouseApi.update_custom_dashboard"
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.update_custom_dashboard"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}'.sub('{' + 'custom_dashboard_oid' + '}', custom_dashboard_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(dashboard)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomDashboardResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#update_custom_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update a custom report
     # Update a custom report on the UltraCart account. 
     # @param report Report to custom update

data/lib/ultracart_api/models/custom_dashboard.rb

@@ -0,0 +1,213 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class CustomDashboard
+    attr_accessor :data_warehouse_custom_dashboard_oid
+
+    attr_accessor :merchant_id
+
+    attr_accessor :name
+
+    attr_accessor :pages
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data_warehouse_custom_dashboard_oid' => :'data_warehouse_custom_dashboard_oid',
+        :'merchant_id' => :'merchant_id',
+        :'name' => :'name',
+        :'pages' => :'pages'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'data_warehouse_custom_dashboard_oid' => :'Integer',
+        :'merchant_id' => :'String',
+        :'name' => :'String',
+        :'pages' => :'Array<CustomDashboardPage>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'data_warehouse_custom_dashboard_oid')
+        self.data_warehouse_custom_dashboard_oid = attributes[:'data_warehouse_custom_dashboard_oid']
+      end
+
+      if attributes.has_key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'pages')
+        if (value = attributes[:'pages']).is_a?(Array)
+          self.pages = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          data_warehouse_custom_dashboard_oid == o.data_warehouse_custom_dashboard_oid &&
+          merchant_id == o.merchant_id &&
+          name == o.name &&
+          pages == o.pages
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [data_warehouse_custom_dashboard_oid, merchant_id, name, pages].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end