Class: Io::Flow::V0::Models::HarmonizedItem

Inherits:

Object

• Object
• Io::Flow::V0::Models::HarmonizedItem

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Overview

A harmonized item stores explicit information about this item for the purposes of harmonization / classification. The harmonization process begins by creating a harmonized item; this kicks off the internal processes. Once assigned, codes will be available via the hs6 and hs10 resources

Instance Attribute Summary

• #attributes ⇒ Object readonly

  Returns the value of attribute attributes.

• #categories ⇒ Object readonly

  Returns the value of attribute categories.

• #description ⇒ Object readonly

  Returns the value of attribute description.

• #id ⇒ Object readonly

  Returns the value of attribute id.

• #name ⇒ Object readonly

  Returns the value of attribute name.

• #number ⇒ Object readonly

  Returns the value of attribute number.

Instance Method Summary

• #copy(incoming = {}) ⇒ Object
• #initialize(incoming = {}) ⇒ HarmonizedItem constructor

  A new instance of HarmonizedItem.

• #to_hash ⇒ Object
• #to_json ⇒ Object

Constructor Details

#initialize(incoming = {}) ⇒ HarmonizedItem

Returns a new instance of HarmonizedItem.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16085

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :number, :name], 'HarmonizedItem')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @number = HttpClient::Preconditions.assert_class('number', opts.delete(:number), String)
  @name = HttpClient::Preconditions.assert_class('name', opts.delete(:name), String)
  @categories = HttpClient::Preconditions.assert_class('categories', (x = opts.delete(:categories); x.nil? ? [] : x), Array).map { |v| HttpClient::Preconditions.assert_class('categories', v, String) }
  @attributes = HttpClient::Preconditions.assert_class('attributes', (x = opts.delete(:attributes); x.nil? ? {} : x), Hash).inject({}) { |h, d| h[d[0]] = HttpClient::Preconditions.assert_class('attributes', d[1], String); h }
  @description = (x = opts.delete(:description); x.nil? ? nil : HttpClient::Preconditions.assert_class('description', x, String))
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16083

def attributes
  @attributes
end

#categories ⇒ Object (readonly)

Returns the value of attribute categories.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16083

def categories
  @categories
end

#description ⇒ Object (readonly)

Returns the value of attribute description.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16083

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16083

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16083

def name
  @name
end

#number ⇒ Object (readonly)

Returns the value of attribute number.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16083

def number
  @number
end

Instance Method Details

#copy(incoming = {}) ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16100

def copy(incoming={})
  HarmonizedItem.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hash ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16104

def to_hash
  {
    :id => id,
    :number => number,
    :name => name,
    :categories => categories,
    :attributes => attributes,
    :description => description
  }
end

#to_json ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16096

def to_json
  JSON.dump(to_hash)
end