class Io::Flow::V0::Clients::Customers

Public Class Methods

new(client) click to toggle source
# 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

Public Instance Methods

delete_by_number(organization, number) click to toggle source

Delete the customer with this number.

# 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={}) click to toggle source

Search customers. Always paginated.

# 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) click to toggle source

Returns information about a specific customer.

# 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) click to toggle source

Create a customer.

# 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) click to toggle source

Returns information about a specific customer given a client token.

# 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) click to toggle source

Update or create a customer with the specified number.

# 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