Class: Io::Flow::V0::Models::OrderIdentifier

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Overview

Represents alternate identifiers that can be used to lookup an order. Common use cases are to support attaching a primary identifier (e.g. a nice order number) post order submission or attaching IDs that are used by the warehouse to ship the orders.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ OrderIdentifier

Returns a new instance of OrderIdentifier.



48143
48144
48145
48146
48147
48148
48149
48150
48151
48152
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 48143

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :order, :identifier, :primary], 'OrderIdentifier')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @order = (x = opts.delete(:order); x.is_a?(::Io::Flow::V0::Models::OrderReference) ? x : ::Io::Flow::V0::Models::OrderReference.new(x))
  @name = HttpClient::Preconditions.assert_class('name', (x = opts.delete(:name); x.nil? ? "external" : x), String)
  @identifier = HttpClient::Preconditions.assert_class('identifier', opts.delete(:identifier), String)
  @primary = HttpClient::Preconditions.assert_boolean('primary', opts.delete(:primary))
  @number = (x = opts.delete(:number); x.nil? ? nil : HttpClient::Preconditions.assert_class('number', x, String))
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



48141
48142
48143
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 48141

def id
  @id
end

#identifier ⇒ Object (readonly)

Returns the value of attribute identifier.



48141
48142
48143
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 48141

def identifier
  @identifier
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



48141
48142
48143
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 48141

def name
  @name
end

#number ⇒ Object (readonly)

Returns the value of attribute number.



48141
48142
48143
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 48141

def number
  @number
end

#order ⇒ Object (readonly)

Returns the value of attribute order.



48141
48142
48143
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 48141

def order
  @order
end

#primary ⇒ Object (readonly)

Returns the value of attribute primary.



48141
48142
48143
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 48141

def primary
  @primary
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



48158
48159
48160
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 48158

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

#to_hash ⇒ Object 



48162
48163
48164
48165
48166
48167
48168
48169
48170
48171
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 48162

def to_hash
  {
    :id => id,
    :order => order.to_hash,
    :name => name,
    :identifier => identifier,
    :primary => primary,
    :number => number
  }
end

#to_json ⇒ Object 



48154
48155
48156
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 48154

def to_json
  JSON.dump(to_hash)
end