Class: Io::Flow::V0::Models::ExclusionRule

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

Overview

A global exclusion rule allows the user to select 1 or more items by query and to globally exclude those items from sale in one or more regions.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ ExclusionRule

Returns a new instance of ExclusionRule.



38021
38022
38023
38024
38025
38026
38027
38028
38029
38030
38031
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38021

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :q, :query, :regions, :status, :statistics], 'ExclusionRule')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @q = HttpClient::Preconditions.assert_class('q', opts.delete(:q), String)
  @query = (x = opts.delete(:query); x.is_a?(::Io::Flow::V0::Models::Query) ? x : ::Io::Flow::V0::Models::Query.new(x))
  @regions = HttpClient::Preconditions.assert_class('regions', opts.delete(:regions), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::Region) ? x : ::Io::Flow::V0::Models::Region.new(x)) }
  @status = (x = opts.delete(:status); x.is_a?(::Io::Flow::V0::Models::SubcatalogItemStatus) ? x : ::Io::Flow::V0::Models::SubcatalogItemStatus.apply(x))
  @description = (x = opts.delete(:description); x.nil? ? nil : HttpClient::Preconditions.assert_class('description', x, String))
  @statistics = (x = opts.delete(:statistics); x.is_a?(::Io::Flow::V0::Models::ExclusionRuleStatistic) ? x : ::Io::Flow::V0::Models::ExclusionRuleStatistic.new(x))
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



38019
38020
38021
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38019

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



38019
38020
38021
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38019

def id
  @id
end

#q ⇒ Object (readonly)

Returns the value of attribute q.



38019
38020
38021
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38019

def q
  @q
end

#query ⇒ Object (readonly)

Returns the value of attribute query.



38019
38020
38021
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38019

def query
  @query
end

#regions ⇒ Object (readonly)

Returns the value of attribute regions.



38019
38020
38021
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38019

def regions
  @regions
end

#statistics ⇒ Object (readonly)

Returns the value of attribute statistics.



38019
38020
38021
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38019

def statistics
  @statistics
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



38019
38020
38021
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38019

def status
  @status
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



38037
38038
38039
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38037

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

#to_hash ⇒ Object 



38041
38042
38043
38044
38045
38046
38047
38048
38049
38050
38051
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38041

def to_hash
  {
    :id => id,
    :q => q,
    :query => query.to_hash,
    :regions => regions.map { |o| o.to_hash },
    :status => status.value,
    :description => description,
    :statistics => statistics.to_hash
  }
end

#to_json ⇒ Object 



38033
38034
38035
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38033

def to_json
  JSON.dump(to_hash)
end