Class: Rallio::FranchisorOwnership

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

Overview

Represents a franchisor ownership 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

#franchisor_idInteger

Returns unique id for franchisor

Returns:

  • (Integer)

    unique id for franchisor


10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# File 'lib/rallio/franchisor_ownership.rb', line 10

class FranchisorOwnership < OwnershipsBase
  attribute :user_id, Integer
  attribute :franchisor_id, Integer
  attribute :franchisor_name, String

  # Url segment used by base class to build correct endpoint.
  #
  # @return [String]
  def self.url_segment
    'franchisor_ownerships'
  end

  # Key used to extract response object from API response hash.
  #
  # @return [String]
  def self.response_key
    'franchisor_ownership'
  end
end

#franchisor_nameString

Returns franchisor name

Returns:

  • (String)

    franchisor name


10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# File 'lib/rallio/franchisor_ownership.rb', line 10

class FranchisorOwnership < OwnershipsBase
  attribute :user_id, Integer
  attribute :franchisor_id, Integer
  attribute :franchisor_name, String

  # Url segment used by base class to build correct endpoint.
  #
  # @return [String]
  def self.url_segment
    'franchisor_ownerships'
  end

  # Key used to extract response object from API response hash.
  #
  # @return [String]
  def self.response_key
    'franchisor_ownership'
  end
end

#user_idInteger

Returns unique id for user

Returns:

  • (Integer)

    unique id for user


10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# File 'lib/rallio/franchisor_ownership.rb', line 10

class FranchisorOwnership < OwnershipsBase
  attribute :user_id, Integer
  attribute :franchisor_id, Integer
  attribute :franchisor_name, String

  # Url segment used by base class to build correct endpoint.
  #
  # @return [String]
  def self.url_segment
    'franchisor_ownerships'
  end

  # Key used to extract response object from API response hash.
  #
  # @return [String]
  def self.response_key
    'franchisor_ownership'
  end
end

Class Method Details

.response_keyString

Key used to extract response object from API response hash.

Returns:

  • (String)

25
26
27
# File 'lib/rallio/franchisor_ownership.rb', line 25

def self.response_key
  'franchisor_ownership'
end

.url_segmentString

Url segment used by base class to build correct endpoint.

Returns:

  • (String)

18
19
20
# File 'lib/rallio/franchisor_ownership.rb', line 18

def self.url_segment
  'franchisor_ownerships'
end