Class: Rallio::AccountOwnership

Inherits:
OwnershipsBase show all
Defined in:
lib/rallio/account_ownership.rb

Overview

Represents an account ownership object as it comes from Rallio.

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from OwnershipsBase

create, destroy, for

Methods inherited from Base

app_credentials

Instance Attribute Details

#account_franchisor_id ⇒ Integer

Returns unique id for franchisor.

Returns:

  • (Integer) —

    unique id for franchisor



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/rallio/account_ownership.rb', line 14

class AccountOwnership < OwnershipsBase
  attribute :user_id, Integer
  attribute :account_id, Integer
  attribute :account_name, String
  attribute :account_franchisor_id, Integer
  attribute :account_franchisor_name, String

  # (see Rallio::FranchisorOwnership.url_segment)
  def self.url_segment
    'account_ownerships'
  end

  # (see Rallio::FranchisorOwnership.response_key)
  def self.response_key
    'account_ownership'
  end
end

#account_franchisor_name ⇒ String

Returns franchisor name.

Returns:

  • (String) —

    franchisor name



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/rallio/account_ownership.rb', line 14

class AccountOwnership < OwnershipsBase
  attribute :user_id, Integer
  attribute :account_id, Integer
  attribute :account_name, String
  attribute :account_franchisor_id, Integer
  attribute :account_franchisor_name, String

  # (see Rallio::FranchisorOwnership.url_segment)
  def self.url_segment
    'account_ownerships'
  end

  # (see Rallio::FranchisorOwnership.response_key)
  def self.response_key
    'account_ownership'
  end
end

#account_id ⇒ Integer

Returns unique id for account.

Returns:

  • (Integer) —

    unique id for account



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/rallio/account_ownership.rb', line 14

class AccountOwnership < OwnershipsBase
  attribute :user_id, Integer
  attribute :account_id, Integer
  attribute :account_name, String
  attribute :account_franchisor_id, Integer
  attribute :account_franchisor_name, String

  # (see Rallio::FranchisorOwnership.url_segment)
  def self.url_segment
    'account_ownerships'
  end

  # (see Rallio::FranchisorOwnership.response_key)
  def self.response_key
    'account_ownership'
  end
end

#account_name ⇒ String

Returns account name.

Returns:

  • (String) —

    account name



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/rallio/account_ownership.rb', line 14

class AccountOwnership < OwnershipsBase
  attribute :user_id, Integer
  attribute :account_id, Integer
  attribute :account_name, String
  attribute :account_franchisor_id, Integer
  attribute :account_franchisor_name, String

  # (see Rallio::FranchisorOwnership.url_segment)
  def self.url_segment
    'account_ownerships'
  end

  # (see Rallio::FranchisorOwnership.response_key)
  def self.response_key
    'account_ownership'
  end
end

#user_id ⇒ Integer

Returns unique id for user.

Returns:

  • (Integer) —

    unique id for user



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/rallio/account_ownership.rb', line 14

class AccountOwnership < OwnershipsBase
  attribute :user_id, Integer
  attribute :account_id, Integer
  attribute :account_name, String
  attribute :account_franchisor_id, Integer
  attribute :account_franchisor_name, String

  # (see Rallio::FranchisorOwnership.url_segment)
  def self.url_segment
    'account_ownerships'
  end

  # (see Rallio::FranchisorOwnership.response_key)
  def self.response_key
    'account_ownership'
  end
end

Class Method Details

.response_key ⇒ String

Key used to extract response object from API response hash.

Returns:

  • (String) 


27
28
29
 
# File 'lib/rallio/account_ownership.rb', line 27

def self.response_key
  'account_ownership'
end

.url_segment ⇒ String

Url segment used by base class to build correct endpoint.

Returns:

  • (String) 


22
23
24
 
# File 'lib/rallio/account_ownership.rb', line 22

def self.url_segment
  'account_ownerships'
end