Class: Io::Flow::V0::Models::ItemFunctionPostForm

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

Overview

Item Functions are javascript code used to calculate the localized price of an additional item. Each function can be associated with an optional query identifying the products to which the function applies. Flow selects the first function matching an item, then uses that function to calculate local prices whenever any data relevant to the item changes (e.g. on update in master catalog, on change in relevant exchange rate, etc.). Item functions are immutable once created.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ ItemFunctionPostForm

Returns a new instance of ItemFunctionPostForm.



26463
26464
26465
26466
26467
26468
26469
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26463

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:description, :code], 'ItemFunctionPostForm')
  @description = HttpClient::Preconditions.assert_class('description', opts.delete(:description), String)
  @code = HttpClient::Preconditions.assert_class('code', opts.delete(:code), String)
  @key = (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, String))
end

Instance Attribute Details

#codeObject (readonly)

Returns the value of attribute code.



26461
26462
26463
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26461

def code
  @code
end

#descriptionObject (readonly)

Returns the value of attribute description.



26461
26462
26463
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26461

def description
  @description
end

#keyObject (readonly)

Returns the value of attribute key.



26461
26462
26463
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26461

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object



26475
26476
26477
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26475

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

#to_hashObject



26479
26480
26481
26482
26483
26484
26485
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26479

def to_hash
  {
    :description => description,
    :code => code,
    :key => key
  }
end

#to_jsonObject



26471
26472
26473
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26471

def to_json
  JSON.dump(to_hash)
end