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.



5278
5279
5280
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5278

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.



5330
5331
5332
5333
5334
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5330

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.



5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5283

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.



5307
5308
5309
5310
5311
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5307

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



5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5345

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.



5322
5323
5324
5325
5326
5327
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5322

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.



5300
5301
5302
5303
5304
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5300

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.



5338
5339
5340
5341
5342
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5338

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.



5314
5315
5316
5317
5318
5319
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5314

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