Class: Io::Flow::V0::Models::Membership

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

Overview

Represents the users that are part of this organization. Primary purpose is to manage which users have access to the organization’s data and to provide a simple user interface to assign roles and permissions to each member of the organization

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ Membership

Returns a new instance of Membership.



38506
38507
38508
38509
38510
38511
38512
38513
38514
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38506

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :organization, :user, :roles], 'Membership')
  @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))
  @user = (x = opts.delete(:user); x.is_a?(::Io::Flow::V0::Models::ExpandableUser) ? x : ::Io::Flow::V0::Models::ExpandableUser.from_json(x))
  @role = (x = opts.delete(:role); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::Role) ? x : ::Io::Flow::V0::Models::Role.apply(x)))
  @roles = HttpClient::Preconditions.assert_class('roles', opts.delete(:roles), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::FlowRole) ? x : ::Io::Flow::V0::Models::FlowRole.apply(x)) }
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



38504
38505
38506
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38504

def id
  @id
end

#organization ⇒ Object (readonly)

Returns the value of attribute organization.



38504
38505
38506
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38504

def organization
  @organization
end

#role ⇒ Object (readonly)

Returns the value of attribute role.



38504
38505
38506
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38504

def role
  @role
end

#roles ⇒ Object (readonly)

Returns the value of attribute roles.



38504
38505
38506
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38504

def roles
  @roles
end

#user ⇒ Object (readonly)

Returns the value of attribute user.



38504
38505
38506
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38504

def user
  @user
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



38520
38521
38522
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38520

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

#to_hash ⇒ Object 



38524
38525
38526
38527
38528
38529
38530
38531
38532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38524

def to_hash
  {
    :id => id,
    :organization => organization.to_hash,
    :user => user.to_hash,
    :role => role.nil? ? nil : role.value,
    :roles => roles.map { |o| o.value }
  }
end

#to_json ⇒ Object 



38516
38517
38518
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 38516

def to_json
  JSON.dump(to_hash)
end