Class: Io::Flow::V0::Models::QueryBuilder
- Inherits:
-
Object
- Object
- Io::Flow::V0::Models::QueryBuilder
- Defined in:
- lib/flow_commerce/flow_api_v0_client.rb
Overview
The query builder model is used to build a query using structured filters. The end result is a single ‘q’ string - e.g. ‘category:jewelry and brand:Flow’
Instance Attribute Summary collapse
-
#available ⇒ Object
readonly
Returns the value of attribute available.
-
#filters ⇒ Object
readonly
Returns the value of attribute filters.
-
#q ⇒ Object
readonly
Returns the value of attribute q.
Instance Method Summary collapse
- #copy(incoming = {}) ⇒ Object
-
#initialize(incoming = {}) ⇒ QueryBuilder
constructor
A new instance of QueryBuilder.
- #to_hash ⇒ Object
- #to_json ⇒ Object
Constructor Details
#initialize(incoming = {}) ⇒ QueryBuilder
Returns a new instance of QueryBuilder.
61160 61161 61162 61163 61164 61165 61166 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 61160 def initialize(incoming={}) opts = HttpClient::Helper.symbolize_keys(incoming) HttpClient::Preconditions.require_keys(opts, [:q, :filters, :available], 'QueryBuilder') @q = HttpClient::Preconditions.assert_class('q', opts.delete(:q), String) @filters = HttpClient::Preconditions.assert_class('filters', opts.delete(:filters), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::QueryFilter) ? x : ::Io::Flow::V0::Models::QueryFilter.from_json(x)) } @available = HttpClient::Preconditions.assert_class('available', opts.delete(:available), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::AvailableFilter) ? x : ::Io::Flow::V0::Models::AvailableFilter.from_json(x)) } end |
Instance Attribute Details
#available ⇒ Object (readonly)
Returns the value of attribute available.
61158 61159 61160 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 61158 def available @available end |
#filters ⇒ Object (readonly)
Returns the value of attribute filters.
61158 61159 61160 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 61158 def filters @filters end |
#q ⇒ Object (readonly)
Returns the value of attribute q.
61158 61159 61160 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 61158 def q @q end |
Instance Method Details
#copy(incoming = {}) ⇒ Object
61172 61173 61174 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 61172 def copy(incoming={}) QueryBuilder.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming))) end |
#to_hash ⇒ Object
61176 61177 61178 61179 61180 61181 61182 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 61176 def to_hash { :q => q, :filters => filters.map { |o| o.to_hash }, :available => available.map { |o| o.to_hash } } end |
#to_json ⇒ Object
61168 61169 61170 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 61168 def to_json JSON.dump(to_hash) end |