Class: Io::Flow::V0::Clients::Users

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Users

Returns a new instance of Users.



5468
5469
5470
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5468

def initialize(client)
  @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client)
end

Instance Method Details

#delete_passwords_by_id(id) ⇒ Object

Deletes a password for the given user.



5542
5543
5544
5545
5546
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5542

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 = {}) ⇒ Object

Search users. Always paginated.



5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5473

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) ⇒ Object

Returns information about a specific user.



5519
5520
5521
5522
5523
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5519

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

#get_versions(incoming = {}) ⇒ Object

Provides visibility into recent changes of each object, including deletion



5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5505

def get_versions(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) }),
    :user_id => (x = opts.delete(:user_id); x.nil? ? nil : HttpClient::Preconditions.assert_class('user_id', x, Array).map { |v| HttpClient::Preconditions.assert_class('user_id', 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? ? "journal_timestamp" : x), String)
  }.delete_if { |k, v| v.nil? }
  r = @client.request("/users/versions").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::UserVersion.new(x) }
end

#patch_passwords_by_id(id, password_change_form) ⇒ Object

Update the password for a user.



5534
5535
5536
5537
5538
5539
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5534

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) ⇒ Object

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.



5490
5491
5492
5493
5494
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5490

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) ⇒ Object

Authenticates a user by email / password. Note only users that have a status of active will be authorized.



5498
5499
5500
5501
5502
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5498

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) ⇒ Object

Update a user.



5526
5527
5528
5529
5530
5531
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5526

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