ultracart_api 3.9.8 → 3.10.0

data/lib/ultracart_api/api/channel_partner_api.rb

@@ -0,0 +1,256 @@
+=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 'addressable/uri'
+
+module UltracartClient
+  class ChannelPartnerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::ChannelPartnerApi.new(api_client)
+    end
+
+    # Cancel channel partner order by channel partner order id
+    # Cancel channel partner order by channel partner order id 
+    # @param order_id The channel partner order id to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [ChannelPartnerCancelResponse]
+    def cancel_order_by_channel_partner_order_id(order_id, opts = {})
+      data, _status_code, _headers = cancel_order_by_channel_partner_order_id_with_http_info(order_id, opts)
+      data
+    end
+
+    # Cancel channel partner order by channel partner order id
+    # Cancel channel partner order by channel partner order id 
+    # @param order_id The channel partner order id to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ChannelPartnerCancelResponse, Fixnum, Hash)>] ChannelPartnerCancelResponse data, response status code and response headers
+    def cancel_order_by_channel_partner_order_id_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelPartnerApi.cancel_order_by_channel_partner_order_id ...'
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling ChannelPartnerApi.cancel_order_by_channel_partner_order_id"
+      end
+      # resource path
+      local_var_path = '/channel_partner/cancel/by_channel_partner_order_id/{order_id}'.sub('{' + 'order_id' + '}', order_id.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 = 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,
+        :return_type => 'ChannelPartnerCancelResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChannelPartnerApi#cancel_order_by_channel_partner_order_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Cancel channel partner order by UltraCart order id
+    # Cancel channel partner order by UltraCart order id 
+    # @param order_id The UltraCart order id to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [ChannelPartnerCancelResponse]
+    def cancel_order_by_channel_ultra_cart_order_id(order_id, opts = {})
+      data, _status_code, _headers = cancel_order_by_channel_ultra_cart_order_id_with_http_info(order_id, opts)
+      data
+    end
+
+    # Cancel channel partner order by UltraCart order id
+    # Cancel channel partner order by UltraCart order id 
+    # @param order_id The UltraCart order id to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ChannelPartnerCancelResponse, Fixnum, Hash)>] ChannelPartnerCancelResponse data, response status code and response headers
+    def cancel_order_by_channel_ultra_cart_order_id_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelPartnerApi.cancel_order_by_channel_ultra_cart_order_id ...'
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling ChannelPartnerApi.cancel_order_by_channel_ultra_cart_order_id"
+      end
+      # resource path
+      local_var_path = '/channel_partner/cancel/by_ultracart_order_id/{order_id}'.sub('{' + 'order_id' + '}', order_id.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 = 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,
+        :return_type => 'ChannelPartnerCancelResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChannelPartnerApi#cancel_order_by_channel_ultra_cart_order_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Estimate shipping for channel partner order
+    # Estimate shipping for order from a channel partner. 
+    # @param channel_partner_order Order needing shipping estimate
+    # @param [Hash] opts the optional parameters
+    # @return [ChannelPartnerEstimateShippingResponse]
+    def estimate_shipping_for_channel_partner_order(channel_partner_order, opts = {})
+      data, _status_code, _headers = estimate_shipping_for_channel_partner_order_with_http_info(channel_partner_order, opts)
+      data
+    end
+
+    # Estimate shipping for channel partner order
+    # Estimate shipping for order from a channel partner. 
+    # @param channel_partner_order Order needing shipping estimate
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ChannelPartnerEstimateShippingResponse, Fixnum, Hash)>] ChannelPartnerEstimateShippingResponse data, response status code and response headers
+    def estimate_shipping_for_channel_partner_order_with_http_info(channel_partner_order, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelPartnerApi.estimate_shipping_for_channel_partner_order ...'
+      end
+      # verify the required parameter 'channel_partner_order' is set
+      if @api_client.config.client_side_validation && channel_partner_order.nil?
+        fail ArgumentError, "Missing the required parameter 'channel_partner_order' when calling ChannelPartnerApi.estimate_shipping_for_channel_partner_order"
+      end
+      # resource path
+      local_var_path = '/channel_partner/estimate_shipping'
+
+      # 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(channel_partner_order)
+      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 => 'ChannelPartnerEstimateShippingResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChannelPartnerApi#estimate_shipping_for_channel_partner_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Insert channel partner order
+    # Insert order from a channel partner. 
+    # @param channel_partner_order Order to insert
+    # @param [Hash] opts the optional parameters
+    # @return [ChannelPartnerImportResponse]
+    def import_channel_partner_order(channel_partner_order, opts = {})
+      data, _status_code, _headers = import_channel_partner_order_with_http_info(channel_partner_order, opts)
+      data
+    end
+
+    # Insert channel partner order
+    # Insert order from a channel partner. 
+    # @param channel_partner_order Order to insert
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ChannelPartnerImportResponse, Fixnum, Hash)>] ChannelPartnerImportResponse data, response status code and response headers
+    def import_channel_partner_order_with_http_info(channel_partner_order, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelPartnerApi.import_channel_partner_order ...'
+      end
+      # verify the required parameter 'channel_partner_order' is set
+      if @api_client.config.client_side_validation && channel_partner_order.nil?
+        fail ArgumentError, "Missing the required parameter 'channel_partner_order' when calling ChannelPartnerApi.import_channel_partner_order"
+      end
+      # resource path
+      local_var_path = '/channel_partner/import'
+
+      # 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(channel_partner_order)
+      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 => 'ChannelPartnerImportResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChannelPartnerApi#import_channel_partner_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb

@@ -44,6 +44,9 @@ module UltracartClient
     # Shipping method name
     attr_accessor :name
 
+    # True if this shipping method requires customers to physically pickup product themselves
+    attr_accessor :pickup
+
     attr_accessor :tax
 
     attr_accessor :total_tax
@@ -62,6 +65,7 @@ module UltracartClient
         :'estimated_delivery' => :'estimated_delivery',
         :'lift_gate_option' => :'lift_gate_option',
         :'name' => :'name',
+        :'pickup' => :'pickup',
         :'tax' => :'tax',
         :'total_tax' => :'total_tax'
       }
@@ -81,6 +85,7 @@ module UltracartClient
         :'estimated_delivery' => :'String',
         :'lift_gate_option' => :'BOOLEAN',
         :'name' => :'String',
+        :'pickup' => :'BOOLEAN',
         :'tax' => :'Currency',
         :'total_tax' => :'Currency'
       }
@@ -138,6 +143,10 @@ module UltracartClient
         self.name = attributes[:'name']
       end
 
+      if attributes.has_key?(:'pickup')
+        self.pickup = attributes[:'pickup']
+      end
+
       if attributes.has_key?(:'tax')
         self.tax = attributes[:'tax']
       end
@@ -176,6 +185,7 @@ module UltracartClient
           estimated_delivery == o.estimated_delivery &&
           lift_gate_option == o.lift_gate_option &&
           name == o.name &&
+          pickup == o.pickup &&
           tax == o.tax &&
           total_tax == o.total_tax
     end
@@ -189,7 +199,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [allow_3rd_party_billing, comment, cost, cost_before_discount, default_method, discount, discounted, display_name, estimated_delivery, lift_gate_option, name, tax, total_tax].hash
+      [allow_3rd_party_billing, comment, cost, cost_before_discount, default_method, discount, discounted, display_name, estimated_delivery, lift_gate_option, name, pickup, tax, total_tax].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/channel_partner_cancel_response.rb

@@ -0,0 +1,224 @@
+=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 ChannelPartnerCancelResponse
+    # Array of errors if errors occurred
+    attr_accessor :cancel_errors
+
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cancel_errors' => :'cancel_errors',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'cancel_errors' => :'Array<String>',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'BOOLEAN',
+        :'warning' => :'Warning'
+      }
+    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?(:'cancel_errors')
+        if (value = attributes[:'cancel_errors']).is_a?(Array)
+          self.cancel_errors = value
+        end
+      end
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'warning')
+        self.warning = attributes[:'warning']
+      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 &&
+          cancel_errors == o.cancel_errors &&
+          error == o.error &&
+          metadata == o.metadata &&
+          success == o.success &&
+          warning == o.warning
+    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
+      [cancel_errors, error, metadata, success, warning].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