Class: Io::Flow::V0::Clients::Invitations

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Invitations

Returns a new instance of Invitations.



4005
4006
4007
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4005

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

Instance Method Details

#delete_by_id(id) ⇒ Object 



4044
4045
4046
4047
4048
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4044

def delete_by_id(id)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/invitations/#{CGI.escape(id)}").delete
  nil
end

#get(incoming = {}) ⇒ Object

Search invitations. Always paginated.



4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4010

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) }),
    :organization => (x = opts.delete(:organization); x.nil? ? nil : HttpClient::Preconditions.assert_class('organization', x, String)),
    :email => (x = opts.delete(:email); x.nil? ? nil : HttpClient::Preconditions.assert_class('email', x, String)),
    :token => (x = opts.delete(:token); x.nil? ? nil : HttpClient::Preconditions.assert_class('token', x, 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),
    :expand => (x = opts.delete(:expand); x.nil? ? nil : HttpClient::Preconditions.assert_class('expand', x, Array).map { |v| HttpClient::Preconditions.assert_class('expand', v, String) })
  }.delete_if { |k, v| v.nil? }
  r = @client.request("/invitations").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::Invitation.new(x) }
end

#get_by_id(id, incoming = {}) ⇒ Object

Returns information about a specific invitation.



4034
4035
4036
4037
4038
4039
4040
4041
4042
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4034

def get_by_id(id, incoming={})
  HttpClient::Preconditions.assert_class('id', id, String)
  opts = HttpClient::Helper.symbolize_keys(incoming)
  query = {
    :expand => (x = opts.delete(:expand); x.nil? ? nil : HttpClient::Preconditions.assert_class('expand', x, Array).map { |v| HttpClient::Preconditions.assert_class('expand', v, String) })
  }.delete_if { |k, v| v.nil? }
  r = @client.request("/invitations/#{CGI.escape(id)}").with_query(query).get
  ::Io::Flow::V0::Models::Invitation.new(r)
end

#get_tokens_by_token(token, incoming = {}) ⇒ Object

Lookup an invitation by its token.



4051
4052
4053
4054
4055
4056
4057
4058
4059
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4051

def get_tokens_by_token(token, incoming={})
  HttpClient::Preconditions.assert_class('token', token, String)
  opts = HttpClient::Helper.symbolize_keys(incoming)
  query = {
    :expand => (x = opts.delete(:expand); x.nil? ? nil : HttpClient::Preconditions.assert_class('expand', x, Array).map { |v| HttpClient::Preconditions.assert_class('expand', v, String) })
  }.delete_if { |k, v| v.nil? }
  r = @client.request("/invitations/tokens/#{CGI.escape(token)}").with_query(query).get
  ::Io::Flow::V0::Models::Invitation.new(r)
end

#get_versions(incoming = {}) ⇒ Object 



4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4073

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) }),
    :invitation => (x = opts.delete(:invitation); x.nil? ? nil : HttpClient::Preconditions.assert_class('invitation', x, Array).map { |v| HttpClient::Preconditions.assert_class('invitation', 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("/invitations/versions").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::InvitationVersion.new(x) }
end

#post(invitation_form) ⇒ Object

Create a new invitation.



4027
4028
4029
4030
4031
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4027

def post(invitation_form)
  (x = invitation_form; x.is_a?(::Io::Flow::V0::Models::InvitationForm) ? x : ::Io::Flow::V0::Models::InvitationForm.new(x))
  r = @client.request("/invitations").with_json(invitation_form.to_json).post
  ::Io::Flow::V0::Models::Invitation.new(r)
end

#put_tokens_by_token(token, hash) ⇒ Object

Accepts the invitation w/ the specified token and the authenticated user. Creating a membership record for this user within this organization. Invitations are one time use only - you will get a validation error if the invitation has previously been accepted or if the user’s email addresses do not match the email on the invite.



4066
4067
4068
4069
4070
4071
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4066

def put_tokens_by_token(token, hash)
  HttpClient::Preconditions.assert_class('token', token, String)
  HttpClient::Preconditions.assert_class('hash', hash, Hash)
  r = @client.request("/invitations/tokens/#{CGI.escape(token)}").with_json(hash.to_json).put
  ::Io::Flow::V0::Models::Membership.new(r)
end