Class: Io::Flow::V0::Models::Invitation

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

Overview

An invitation via email to a user to join this organization. The user will then walk through a user login/registration process and will immediately become a member of the organization.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ Invitation

Returns a new instance of Invitation.



18816
18817
18818
18819
18820
18821
18822
18823
18824
18825
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18816

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :organization, :email, :name, :role, :expiration], 'Invitation')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @organization = (x = opts.delete(:organization); x.is_a?(::Io::Flow::V0::Models::ExpandableOrganization) ? x : ::Io::Flow::V0::Models::ExpandableOrganization.from_json(x))
  @email = HttpClient::Preconditions.assert_class('email', opts.delete(:email), String)
  @name = (x = opts.delete(:name); x.is_a?(::Io::Flow::V0::Models::Name) ? x : ::Io::Flow::V0::Models::Name.new(x))
  @role = (x = opts.delete(:role); x.is_a?(::Io::Flow::V0::Models::Role) ? x : ::Io::Flow::V0::Models::Role.apply(x))
  @expiration = HttpClient::Preconditions.assert_class('expiration', HttpClient::Helper.to_date_time_iso8601(opts.delete(:expiration)), DateTime)
end

Instance Attribute Details

#email ⇒ Object (readonly)

Returns the value of attribute email.



18814
18815
18816
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18814

def email
  @email
end

#expiration ⇒ Object (readonly)

Returns the value of attribute expiration.



18814
18815
18816
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18814

def expiration
  @expiration
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



18814
18815
18816
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18814

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



18814
18815
18816
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18814

def name
  @name
end

#organization ⇒ Object (readonly)

Returns the value of attribute organization.



18814
18815
18816
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18814

def organization
  @organization
end

#role ⇒ Object (readonly)

Returns the value of attribute role.



18814
18815
18816
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18814

def role
  @role
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



18831
18832
18833
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18831

def copy(incoming={})
  Invitation.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hash ⇒ Object 



18835
18836
18837
18838
18839
18840
18841
18842
18843
18844
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18835

def to_hash
  {
    :id => id,
    :organization => organization.to_hash,
    :email => email,
    :name => name.to_hash,
    :role => role.value,
    :expiration => expiration
  }
end

#to_json ⇒ Object 



18827
18828
18829
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18827

def to_json
  JSON.dump(to_hash)
end