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.



19407
19408
19409
19410
19411
19412
19413
19414
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19407

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :organization, :user, :role], '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.is_a?(::Io::Flow::V0::Models::Role) ? x : ::Io::Flow::V0::Models::Role.apply(x))
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



19405
19406
19407
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19405

def id
  @id
end

#organization ⇒ Object (readonly)

Returns the value of attribute organization.



19405
19406
19407
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19405

def organization
  @organization
end

#role ⇒ Object (readonly)

Returns the value of attribute role.



19405
19406
19407
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19405

def role
  @role
end

#user ⇒ Object (readonly)

Returns the value of attribute user.



19405
19406
19407
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19405

def user
  @user
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



19420
19421
19422
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19420

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

#to_hash ⇒ Object 



19424
19425
19426
19427
19428
19429
19430
19431
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19424

def to_hash
  {
    :id => id,
    :organization => organization.to_hash,
    :user => user.to_hash,
    :role => role.value
  }
end

#to_json ⇒ Object 



19416
19417
19418
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19416

def to_json
  JSON.dump(to_hash)
end