Class: Io::Flow::V0::Clients::Customers
- Inherits:
-
Object
- Object
- Io::Flow::V0::Clients::Customers
- Defined in:
- lib/flow_commerce/flow_api_v0_client.rb
Instance Method Summary collapse
-
#delete_by_number(organization, number) ⇒ Object
Delete the customer with this number.
-
#get(organization, incoming = {}) ⇒ Object
Search customers.
-
#get_by_number(organization, number) ⇒ Object
Returns information about a specific customer.
-
#initialize(client) ⇒ Customers
constructor
A new instance of Customers.
-
#post(organization, customer_form) ⇒ Object
Create a customer.
-
#post_client_and_tokens(organization, customer_client_token) ⇒ Object
Returns information about a specific customer given a client token.
-
#put_by_number(organization, number, customer_put_form) ⇒ Object
Update or create a customer with the specified number.
Constructor Details
#initialize(client) ⇒ Customers
Returns a new instance of Customers.
6366 6367 6368 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6366 def initialize(client) @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client) end |
Instance Method Details
#delete_by_number(organization, number) ⇒ Object
Delete the customer with this number.
6421 6422 6423 6424 6425 6426 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6421 def delete_by_number(organization, number) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('number', number, String) r = @client.request("/#{CGI.escape(organization)}/customers/#{CGI.escape(number)}").delete nil end |
#get(organization, incoming = {}) ⇒ Object
Search customers. Always paginated.
6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6371 def get(organization, incoming={}) HttpClient::Preconditions.assert_class('organization', organization, String) opts = HttpClient::Helper.symbolize_keys(incoming) query = { :id => (x = opts.delete(:id); x.nil? ? nil : HttpClient::Preconditions.assert_class('id', x, Array).map { |v| HttpClient::Preconditions.assert_class('id', v, String) }), :number => (x = opts.delete(:number); x.nil? ? nil : HttpClient::Preconditions.assert_class('number', x, Array).map { |v| HttpClient::Preconditions.assert_class('number', v, String) }), :email => (x = opts.delete(:email); x.nil? ? nil : HttpClient::Preconditions.assert_class('email', x, Array).map { |v| HttpClient::Preconditions.assert_class('email', v, String) }), :phone => (x = opts.delete(:phone); x.nil? ? nil : HttpClient::Preconditions.assert_class('phone', x, Array).map { |v| HttpClient::Preconditions.assert_class('phone', v, String) }), :limit => HttpClient::Preconditions.assert_class('limit', (x = opts.delete(:limit); x.nil? ? 25 : x), Integer), :offset => HttpClient::Preconditions.assert_class('offset', (x = opts.delete(:offset); x.nil? ? 0 : x), Integer), :sort => HttpClient::Preconditions.assert_class('sort', (x = opts.delete(:sort); x.nil? ? "-created_at" : x), String) }.delete_if { |k, v| v.nil? } r = @client.request("/#{CGI.escape(organization)}/customers").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::Customer.new(x) } end |
#get_by_number(organization, number) ⇒ Object
Returns information about a specific customer.
6404 6405 6406 6407 6408 6409 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6404 def get_by_number(organization, number) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('number', number, String) r = @client.request("/#{CGI.escape(organization)}/customers/#{CGI.escape(number)}").get ::Io::Flow::V0::Models::Customer.new(r) end |
#post(organization, customer_form) ⇒ Object
Create a customer.
6388 6389 6390 6391 6392 6393 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6388 def post(organization, customer_form) HttpClient::Preconditions.assert_class('organization', organization, String) (x = customer_form; x.is_a?(::Io::Flow::V0::Models::CustomerForm) ? x : ::Io::Flow::V0::Models::CustomerForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/customers").with_json(customer_form.to_json).post ::Io::Flow::V0::Models::Customer.new(r) end |
#post_client_and_tokens(organization, customer_client_token) ⇒ Object
Returns information about a specific customer given a client token.
6396 6397 6398 6399 6400 6401 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6396 def post_client_and_tokens(organization, customer_client_token) HttpClient::Preconditions.assert_class('organization', organization, String) (x = customer_client_token; x.is_a?(::Io::Flow::V0::Models::CustomerClientToken) ? x : ::Io::Flow::V0::Models::CustomerClientToken.new(x)) r = @client.request("/#{CGI.escape(organization)}/customers/client/tokens").with_json(customer_client_token.to_json).post ::Io::Flow::V0::Models::Customer.new(r) end |
#put_by_number(organization, number, customer_put_form) ⇒ Object
Update or create a customer with the specified number.
6412 6413 6414 6415 6416 6417 6418 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6412 def put_by_number(organization, number, customer_put_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('number', number, String) (x = customer_put_form; x.is_a?(::Io::Flow::V0::Models::CustomerPutForm) ? x : ::Io::Flow::V0::Models::CustomerPutForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/customers/#{CGI.escape(number)}").with_json(customer_put_form.to_json).put ::Io::Flow::V0::Models::Customer.new(r) end |