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.



49696
49697
49698
49699
49700
49701
49702
49703
49704
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 49696

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

#idObject (readonly)

Returns the value of attribute id.



49694
49695
49696
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 49694

def id
  @id
end

#organizationObject (readonly)

Returns the value of attribute organization.



49694
49695
49696
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 49694

def organization
  @organization
end

#roleObject (readonly)

Returns the value of attribute role.



49694
49695
49696
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 49694

def role
  @role
end

#rolesObject (readonly)

Returns the value of attribute roles.



49694
49695
49696
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 49694

def roles
  @roles
end

#userObject (readonly)

Returns the value of attribute user.



49694
49695
49696
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 49694

def user
  @user
end

Instance Method Details

#copy(incoming = {}) ⇒ Object



49710
49711
49712
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 49710

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

#to_hashObject



49714
49715
49716
49717
49718
49719
49720
49721
49722
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 49714

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_jsonObject



49706
49707
49708
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 49706

def to_json
  JSON.dump(to_hash)
end