Class: LockstepSdk::PublicCompanyProfileModel

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/models/public_company_profile_model.rb

Overview

Contains Public Company Profile data.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ PublicCompanyProfileModel

Initialize the PublicCompanyProfileModel using the provided prototype



25
26
27
28
29
30
31
32
 
# File 'lib/lockstep_sdk/models/public_company_profile_model.rb', line 25

def initialize(params = {})
    @company_id = params.dig(:company_id)
    @company_name = params.dig(:company_name)
    @company_logo_url = params.dig(:company_logo_url)
    @website = params.dig(:website)
    @description = params.dig(:description)
    @public_url_slug = params.dig(:public_url_slug)
end

Instance Attribute Details

#company_id ⇒ Uuid

Returns The unique ID of the company associated with this profile.

Returns:

  • (Uuid) —

    The unique ID of the company associated with this profile.



36
37
38
 
# File 'lib/lockstep_sdk/models/public_company_profile_model.rb', line 36

def company_id
  @company_id
end

#company_logo_url ⇒ String

Returns The URL of this company’s logo, if known.

Returns:

  • (String) —

    The URL of this company’s logo, if known.



44
45
46
 
# File 'lib/lockstep_sdk/models/public_company_profile_model.rb', line 44

def company_logo_url
  @company_logo_url
end

#company_name ⇒ String

Returns The short name of the company associated with this profile.

Returns:

  • (String) —

    The short name of the company associated with this profile.



40
41
42
 
# File 'lib/lockstep_sdk/models/public_company_profile_model.rb', line 40

def company_name
  @company_name
end

#description ⇒ String

Returns Description of the company associated with this profile.

Returns:

  • (String) —

    Description of the company associated with this profile.



52
53
54
 
# File 'lib/lockstep_sdk/models/public_company_profile_model.rb', line 52

def description
  @description
end

#public_url_slug ⇒ String

Returns The public url slug for this Public Company Profile.

Returns:

  • (String) —

    The public url slug for this Public Company Profile.



56
57
58
 
# File 'lib/lockstep_sdk/models/public_company_profile_model.rb', line 56

def public_url_slug
  @public_url_slug
end

#website ⇒ String

Returns Website URL for the company associated with this profile.

Returns:

  • (String) —

    Website URL for the company associated with this profile.



48
49
50
 
# File 'lib/lockstep_sdk/models/public_company_profile_model.rb', line 48

def website
  @website
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object) —

    This object as a JSON key-value structure



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/lockstep_sdk/models/public_company_profile_model.rb', line 60

def as_json(options={})
    {
        'companyId' => @company_id,
        'companyName' => @company_name,
        'companyLogoUrl' => @company_logo_url,
        'website' => @website,
        'description' => @description,
        'publicUrlSlug' => @public_url_slug,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



73
74
75
 
# File 'lib/lockstep_sdk/models/public_company_profile_model.rb', line 73

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end