class Tradenity::TaxRate

Attributes

__meta[RW]
based_on[RW]
created_at[RW]
customer_groups[RW]
description[RW]
fixed_rate[RW]
geo_zone[RW]
name[RW]
percentage[RW]
status[RW]
tax_class[RW]
type[RW]
updated_at[RW]

Public Class Methods

api_client() click to toggle source
# File lib/tradenity/resources/tax_rate.rb, line 437
def self.api_client
  ApiClient.default
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/tradenity/resources/tax_rate.rb, line 81
def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'description' => :'description',
    :'type' => :'type',
    :'percentage' => :'percentage',
    :'fixed_rate' => :'fixedRate',
    :'status' => :'status',
    :'tax_class' => :'taxClass',
    :'geo_zone' => :'geoZone',
    :'customer_groups' => :'customerGroups',
    :'based_on' => :'basedOn'
  }
end
create_tax_rate(tax_rate, opts = {}) click to toggle source

Create TaxRate Create a new TaxRate @param tax_rate Attributes of taxRate to create @param [Hash] opts the optional parameters @return [TaxRate]

# File lib/tradenity/resources/tax_rate.rb, line 510
def create_tax_rate(tax_rate, opts = {})
  data, _status_code, _headers = create_tax_rate_with_http_info(tax_rate, opts)
  data
end
create_tax_rate_with_http_info(tax_rate, opts = {}) click to toggle source

Create TaxRate Create a new TaxRate @param tax_rate Attributes of taxRate to create @param [Hash] opts the optional parameters @return [Array<(TaxRate, Fixnum, Hash)>] TaxRate data, response status code and response headers

# File lib/tradenity/resources/tax_rate.rb, line 520
def create_tax_rate_with_http_info(tax_rate, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxRate.create_tax_rate ...'
  end
  # verify the required parameter 'tax_rate' is set
  if api_client.config.client_side_validation && tax_rate.nil?
    fail ArgumentError, "Missing the required parameter 'tax_rate' when calling TaxRate.create_tax_rate"
  end
  # resource path
  local_var_path = '/taxRates'

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # 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 = api_client.object_to_http_body(tax_rate)
  auth_names = []
  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 => 'TaxRate')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TaxRate#create_tax_rate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_by_id(id) click to toggle source

Delete TaxRate Delete an instance of TaxRate by its ID. @param id ID of TaxRate to delete. @return [nil]

# File lib/tradenity/resources/tax_rate.rb, line 501
def delete_by_id(id)
  delete_tax_rate_by_id(id)
end
delete_tax_rate_by_id(tax_rate_id, opts = {}) click to toggle source

Delete TaxRate Delete an instance of TaxRate by its ID. @param tax_rate_id ID of taxRate to delete. @param [Hash] opts the optional parameters @return [nil]

# File lib/tradenity/resources/tax_rate.rb, line 564
def delete_tax_rate_by_id(tax_rate_id, opts = {})
  delete_tax_rate_by_id_with_http_info(tax_rate_id, opts)
  nil
end
delete_tax_rate_by_id_with_http_info(tax_rate_id, opts = {}) click to toggle source

Delete TaxRate Delete an instance of TaxRate by its ID. @param tax_rate_id ID of taxRate to delete. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/tradenity/resources/tax_rate.rb, line 574
def delete_tax_rate_by_id_with_http_info(tax_rate_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxRate.delete_tax_rate_by_id ...'
  end
  # verify the required parameter 'tax_rate_id' is set
  if api_client.config.client_side_validation && tax_rate_id.nil?
    fail ArgumentError, "Missing the required parameter 'tax_rate_id' when calling TaxRate.delete_tax_rate_by_id"
  end
  # resource path
  local_var_path = '/taxRates/{taxRateId}'.sub('{' + 'taxRateId' + '}', tax_rate_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # 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 = []
  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: TaxRate#delete_tax_rate_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
find_all() click to toggle source

List TaxRates Return a list of TaxRates @param [Hash] opts the optional parameters @return [Page<TaxRate>]

# File lib/tradenity/resources/tax_rate.rb, line 469
def find_all
  list_all_tax_rates
end
find_all_by(opts = {}) click to toggle source

Find List of TaxRate Return multiple instances of TaxRate by its attributes. @param [Hash] opts the search parameters @return [Page<Collection>]

# File lib/tradenity/resources/tax_rate.rb, line 477
def find_all_by(opts = {})
  list_all_tax_rates(opts)
end
find_by_id(id) click to toggle source

Find TaxRate Return single instance of TaxRate by its ID. @param id ID of TaxRate to return @return [TaxRate]

# File lib/tradenity/resources/tax_rate.rb, line 493
def find_by_id(id)
  get_tax_rate_by_id(id)
end
find_one_by(opts = {}) click to toggle source

Find TaxRate by its parameters Return single instance of Collection by its attributes. @param [Hash] opts search parameters @return [TaxRate]

# File lib/tradenity/resources/tax_rate.rb, line 485
def find_one_by(opts = {})
  list_all_tax_rates(opts)[0]
end
get_tax_rate_by_id(tax_rate_id, opts = {}) click to toggle source

Find TaxRate Return single instance of TaxRate by its ID. @param tax_rate_id ID of taxRate to return @param [Hash] opts the optional parameters @return [TaxRate]

# File lib/tradenity/resources/tax_rate.rb, line 617
def get_tax_rate_by_id(tax_rate_id, opts = {})
  data, _status_code, _headers = get_tax_rate_by_id_with_http_info(tax_rate_id, opts)
  data
end
get_tax_rate_by_id_with_http_info(tax_rate_id, opts = {}) click to toggle source

Find TaxRate Return single instance of TaxRate by its ID. @param tax_rate_id ID of taxRate to return @param [Hash] opts the optional parameters @return [Array<(TaxRate, Fixnum, Hash)>] TaxRate data, response status code and response headers

# File lib/tradenity/resources/tax_rate.rb, line 627
def get_tax_rate_by_id_with_http_info(tax_rate_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxRate.get_tax_rate_by_id ...'
  end
  # verify the required parameter 'tax_rate_id' is set
  if api_client.config.client_side_validation && tax_rate_id.nil?
    fail ArgumentError, "Missing the required parameter 'tax_rate_id' when calling TaxRate.get_tax_rate_by_id"
  end
  # resource path
  local_var_path = '/taxRates/{taxRateId}'.sub('{' + 'taxRateId' + '}', tax_rate_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # 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 = []
  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 => 'TaxRate')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TaxRate#get_tax_rate_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_all_tax_rates(opts = {}) click to toggle source

List TaxRates Return a list of TaxRates @param [Hash] opts the optional parameters @option opts [Integer] :page page number @option opts [Integer] :size page size @option opts [String] :sort page order @return [Page<TaxRate>]

# File lib/tradenity/resources/tax_rate.rb, line 673
def list_all_tax_rates(opts = {})
  data, _status_code, _headers = list_all_tax_rates_with_http_info(opts)
  data
end
list_all_tax_rates_with_http_info(opts = {}) click to toggle source

List TaxRates Return a list of TaxRates @param [Hash] opts the optional parameters @option opts [Integer] :page page number @option opts [Integer] :size page size @option opts [String] :sort page order @return [Array<(Page<TaxRate>, Fixnum, Hash)>] Page<TaxRate> data, response status code and response headers

# File lib/tradenity/resources/tax_rate.rb, line 685
def list_all_tax_rates_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxRate.list_all_tax_rates ...'
  end
  # resource path
  local_var_path = '/taxRates'

  # query parameters
  query_params = opts
  # query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  # query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  # query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = {}
  # 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 = []
  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 => 'Page<TaxRate>')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TaxRate#list_all_tax_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/tradenity/resources/tax_rate.rb, line 122
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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'__meta')
    self.__meta = attributes[:'__meta']
  end

  if attributes.has_key?(:'createdAt')
    self.created_at = attributes[:'createdAt']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'updatedAt')
    self.updated_at = attributes[:'updatedAt']
  end

  if attributes.has_key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'percentage')
    self.percentage = attributes[:'percentage']
  end

  if attributes.has_key?(:'fixedRate')
    self.fixed_rate = attributes[:'fixedRate']
  end

  if attributes.has_key?(:'fixed_rate')
    self.fixed_rate = attributes[:'fixed_rate']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'taxClass')
    self.tax_class = attributes[:'taxClass']
  end

  if attributes.has_key?(:'tax_class')
    self.tax_class = attributes[:'tax_class']
  end

  if attributes.has_key?(:'geoZone')
    self.geo_zone = attributes[:'geoZone']
  end

  if attributes.has_key?(:'geo_zone')
    self.geo_zone = attributes[:'geo_zone']
  end

  if attributes.has_key?(:'customerGroups')
    if (value = attributes[:'customerGroups']).is_a?(Array)
      self.customer_groups = value
    end
  end

  if attributes.has_key?(:'customer_groups')
    if (value = attributes[:'customer_groups']).is_a?(Array)
      self.customer_groups = value
    end
  end

  if attributes.has_key?(:'basedOn')
    self.based_on = attributes[:'basedOn']
  end

  if attributes.has_key?(:'based_on')
    self.based_on = attributes[:'based_on']
  end
end
replace_tax_rate_by_id(tax_rate_id, tax_rate, opts = {}) click to toggle source

Replace TaxRate Replace all attributes of TaxRate @param tax_rate_id ID of taxRate to replace @param tax_rate Attributes of taxRate to replace @param [Hash] opts the optional parameters @return [TaxRate]

# File lib/tradenity/resources/tax_rate.rb, line 729
def replace_tax_rate_by_id(tax_rate_id, tax_rate, opts = {})
  data, _status_code, _headers = replace_tax_rate_by_id_with_http_info(tax_rate_id, tax_rate, opts)
  data
end
replace_tax_rate_by_id_with_http_info(tax_rate_id, tax_rate, opts = {}) click to toggle source

Replace TaxRate Replace all attributes of TaxRate @param tax_rate_id ID of taxRate to replace @param tax_rate Attributes of taxRate to replace @param [Hash] opts the optional parameters @return [Array<(TaxRate, Fixnum, Hash)>] TaxRate data, response status code and response headers

# File lib/tradenity/resources/tax_rate.rb, line 740
def replace_tax_rate_by_id_with_http_info(tax_rate_id, tax_rate, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxRate.replace_tax_rate_by_id ...'
  end
  # verify the required parameter 'tax_rate_id' is set
  if api_client.config.client_side_validation && tax_rate_id.nil?
    fail ArgumentError, "Missing the required parameter 'tax_rate_id' when calling TaxRate.replace_tax_rate_by_id"
  end
  # verify the required parameter 'tax_rate' is set
  if api_client.config.client_side_validation && tax_rate.nil?
    fail ArgumentError, "Missing the required parameter 'tax_rate' when calling TaxRate.replace_tax_rate_by_id"
  end
  # resource path
  local_var_path = '/taxRates/{taxRateId}'.sub('{' + 'taxRateId' + '}', tax_rate_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # 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 = api_client.object_to_http_body(tax_rate)
  auth_names = []
  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 => 'TaxRate')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TaxRate#replace_tax_rate_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/tradenity/resources/tax_rate.rb, line 101
def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'description' => :'String',
    :'type' => :'String',
    :'percentage' => :'Float',
    :'fixed_rate' => :'Integer',
    :'status' => :'String',
    :'tax_class' => :'TaxClass',
    :'geo_zone' => :'GeoZone',
    :'customer_groups' => :'Array<CustomerGroup>',
    :'based_on' => :'String'
  }
end
update_tax_rate_by_id(tax_rate_id, tax_rate, opts = {}) click to toggle source

Update TaxRate Update attributes of TaxRate @param tax_rate_id ID of taxRate to update. @param tax_rate Attributes of taxRate to update. @param [Hash] opts the optional parameters @return [TaxRate]

# File lib/tradenity/resources/tax_rate.rb, line 789
def update_tax_rate_by_id(tax_rate_id, tax_rate, opts = {})
  data, _status_code, _headers = update_tax_rate_by_id_with_http_info(tax_rate_id, tax_rate, opts)
  data
end
update_tax_rate_by_id_with_http_info(tax_rate_id, tax_rate, opts = {}) click to toggle source

Update TaxRate Update attributes of TaxRate @param tax_rate_id ID of taxRate to update. @param tax_rate Attributes of taxRate to update. @param [Hash] opts the optional parameters @return [Array<(TaxRate, Fixnum, Hash)>] TaxRate data, response status code and response headers

# File lib/tradenity/resources/tax_rate.rb, line 800
def update_tax_rate_by_id_with_http_info(tax_rate_id, tax_rate, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxRate.update_tax_rate_by_id ...'
  end
  # verify the required parameter 'tax_rate_id' is set
  if api_client.config.client_side_validation && tax_rate_id.nil?
    fail ArgumentError, "Missing the required parameter 'tax_rate_id' when calling TaxRate.update_tax_rate_by_id"
  end
  # verify the required parameter 'tax_rate' is set
  if api_client.config.client_side_validation && tax_rate.nil?
    fail ArgumentError, "Missing the required parameter 'tax_rate' when calling TaxRate.update_tax_rate_by_id"
  end
  # resource path
  local_var_path = '/taxRates/{taxRateId}'.sub('{' + 'taxRateId' + '}', tax_rate_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # 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 = api_client.object_to_http_body(tax_rate)
  auth_names = []
  data, status_code, headers = api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TaxRate')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TaxRate#update_tax_rate_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/tradenity/resources/tax_rate.rb, line 302
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      __meta == o.__meta &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      name == o.name &&
      description == o.description &&
      type == o.type &&
      percentage == o.percentage &&
      fixed_rate == o.fixed_rate &&
      status == o.status &&
      tax_class == o.tax_class &&
      geo_zone == o.geo_zone &&
      customer_groups == o.customer_groups &&
      based_on == o.based_on
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/tradenity/resources/tax_rate.rb, line 356
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 = Tradenity.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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

# File lib/tradenity/resources/tax_rate.rb, line 422
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
based_on=(based_on) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] based_on Object to be assigned

# File lib/tradenity/resources/tax_rate.rb, line 292
def based_on=(based_on)
  validator = EnumAttributeValidator.new('String', ['shippingAddress', 'billingAddress'])
  unless validator.valid?(based_on)
    fail ArgumentError, 'invalid value for "based_on", must be one of #{validator.allowable_values}.'
  end
  @based_on = based_on
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/tradenity/resources/tax_rate.rb, line 335
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 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
create() click to toggle source

Create TaxRate Create a new TaxRate

# File lib/tradenity/resources/tax_rate.rb, line 443
def create
  data = self.class.create_tax_rate(self)
  self.id = data.id
  data
end
delete() click to toggle source

Delete TaxRate Delete this instance of TaxRate. @return [nil]

# File lib/tradenity/resources/tax_rate.rb, line 459
def delete
  self.class.delete_tax_rate_by_id(self.id)
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/tradenity/resources/tax_rate.rb, line 322
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/tradenity/resources/tax_rate.rb, line 328
def hash
  [__meta, created_at, updated_at, name, description, type, percentage, fixed_rate, status, tax_class, geo_zone, customer_groups, based_on].hash
end
id() click to toggle source
# File lib/tradenity/resources/tax_rate.rb, line 21
def id
  if instance_variable_defined?('@id') && @id != nil
    @id
  elsif __meta && __meta.href != nil
    @id = __meta.href.split('/')[-1]
    @id
  else
    nil
  end
end
id=(id) click to toggle source
# File lib/tradenity/resources/tax_rate.rb, line 17
def id=(id)
  @id = id
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/tradenity/resources/tax_rate.rb, line 218
def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @percentage.nil?
    invalid_properties.push('invalid value for "percentage", percentage cannot be nil.')
  end

  if @fixed_rate.nil?
    invalid_properties.push('invalid value for "fixed_rate", fixed_rate cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @tax_class.nil?
    invalid_properties.push('invalid value for "tax_class", tax_class cannot be nil.')
  end

  if @geo_zone.nil?
    invalid_properties.push('invalid value for "geo_zone", geo_zone cannot be nil.')
  end

  invalid_properties
end
status=(status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

# File lib/tradenity/resources/tax_rate.rb, line 282
def status=(status)
  validator = EnumAttributeValidator.new('String', ['enabled', 'disabled'])
  unless validator.valid?(status)
    fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
  end
  @status = status
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/tradenity/resources/tax_rate.rb, line 402
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/tradenity/resources/tax_rate.rb, line 408
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/tradenity/resources/tax_rate.rb, line 396
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/tradenity/resources/tax_rate.rb, line 272
def type=(type)
  validator = EnumAttributeValidator.new('String', ['percentage', 'fixed'])
  unless validator.valid?(type)
    fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
  end
  @type = type
end
update() click to toggle source

Update TaxRate Update attributes of TaxRate @return [TaxRate]

# File lib/tradenity/resources/tax_rate.rb, line 452
def update
  self.class.update_tax_rate_by_id(self.id, self)
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/tradenity/resources/tax_rate.rb, line 253
def valid?
  return false if @name.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ['percentage', 'fixed'])
  return false unless type_validator.valid?(@type)
  return false if @percentage.nil?
  return false if @fixed_rate.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ['enabled', 'disabled'])
  return false unless status_validator.valid?(@status)
  return false if @tax_class.nil?
  return false if @geo_zone.nil?
  based_on_validator = EnumAttributeValidator.new('String', ['shippingAddress', 'billingAddress'])
  return false unless based_on_validator.valid?(@based_on)
  true
end