class Io::Flow::V0::Clients::Users
Public Class Methods
new(client)
click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 9162 def initialize(client) @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client) end
Public Instance Methods
delete_passwords_by_id(id)
click to toggle source
Deletes a password for the given user.
# File lib/flow_commerce/flow_api_v0_client.rb, line 9222 def delete_passwords_by_id(id) HttpClient::Preconditions.assert_class('id', id, String) r = @client.request("/users/#{CGI.escape(id)}/passwords").delete nil end
get(incoming={})
click to toggle source
Search users. Must specify an id or email.
# File lib/flow_commerce/flow_api_v0_client.rb, line 9167 def get(incoming={}) 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) }), :email => (x = opts.delete(:email); x.nil? ? nil : HttpClient::Preconditions.assert_class('email', x, String)), :status => (x = opts.delete(:status); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::UserStatus) ? x : ::Io::Flow::V0::Models::UserStatus.apply(x)).value), :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("/users").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::User.new(x) } end
get_by_id(id)
click to toggle source
Returns
information about a specific user.
# File lib/flow_commerce/flow_api_v0_client.rb, line 9199 def get_by_id(id) HttpClient::Preconditions.assert_class('id', id, String) r = @client.request("/users/#{CGI.escape(id)}").get ::Io::Flow::V0::Models::User.new(r) end
patch_passwords_by_id(id, password_change_form)
click to toggle source
Update the password for a user.
# File lib/flow_commerce/flow_api_v0_client.rb, line 9214 def patch_passwords_by_id(id, password_change_form) HttpClient::Preconditions.assert_class('id', id, String) (x = password_change_form; x.is_a?(::Io::Flow::V0::Models::PasswordChangeForm) ? x : ::Io::Flow::V0::Models::PasswordChangeForm.new(x)) r = @client.request("/users/#{CGI.escape(id)}/passwords").with_json(password_change_form.to_json).patch nil end
post(user_form)
click to toggle source
Create a new user. Note that new users will be created with a status of pending and will not be able to authenticate until approved by a member of the Flow
team.
# File lib/flow_commerce/flow_api_v0_client.rb, line 9184 def post(user_form) (x = user_form; x.is_a?(::Io::Flow::V0::Models::UserForm) ? x : ::Io::Flow::V0::Models::UserForm.new(x)) r = @client.request("/users").with_json(user_form.to_json).post ::Io::Flow::V0::Models::User.new(r) end
post_authenticate(authentication_form)
click to toggle source
Authenticates a user by email / password. Note only users that have a status of active will be authorized.
# File lib/flow_commerce/flow_api_v0_client.rb, line 9192 def post_authenticate(authentication_form) (x = authentication_form; x.is_a?(::Io::Flow::V0::Models::AuthenticationForm) ? x : ::Io::Flow::V0::Models::AuthenticationForm.new(x)) r = @client.request("/users/authenticate").with_json(authentication_form.to_json).post ::Io::Flow::V0::Models::User.new(r) end
put_by_id(id, user_put_form)
click to toggle source
Update a user.
# File lib/flow_commerce/flow_api_v0_client.rb, line 9206 def put_by_id(id, user_put_form) HttpClient::Preconditions.assert_class('id', id, String) (x = user_put_form; x.is_a?(::Io::Flow::V0::Models::UserPutForm) ? x : ::Io::Flow::V0::Models::UserPutForm.new(x)) r = @client.request("/users/#{CGI.escape(id)}").with_json(user_put_form.to_json).put ::Io::Flow::V0::Models::User.new(r) end