Class: Gusto::Companies::CompanyOnboardingStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/fern_gusto/companies/types/company_onboarding_status.rb

Overview

The representation of a company’s onboarding status

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uuid:, onboarding_completed: OMIT, onboarding_steps: OMIT, additional_properties: nil) ⇒ Gusto::Companies::CompanyOnboardingStatus

Parameters:

  • uuid (String) —

    the UUID of the company

  • onboarding_completed (Boolean) (defaults to: OMIT) —

    a boolean flag for the company’s onboarding status

  • onboarding_steps (Array<Gusto::Companies::CompanyOnboardingStatusOnboardingStepsItem>) (defaults to: OMIT) —

    a list of company onboarding steps

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



29
30
31
32
33
34
35
36
37
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status.rb', line 29

def initialize(uuid:, onboarding_completed: OMIT, onboarding_steps: OMIT, additional_properties: nil)
  @uuid = uuid
  @onboarding_completed = onboarding_completed if onboarding_completed != OMIT
  @onboarding_steps = onboarding_steps if onboarding_steps != OMIT
  @additional_properties = additional_properties
  @_field_set = { "uuid": uuid, "onboarding_completed": onboarding_completed, "onboarding_steps": onboarding_steps }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



17
18
19
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status.rb', line 17

def additional_properties
  @additional_properties
end

#onboarding_completed ⇒ Boolean (readonly)

Returns a boolean flag for the company’s onboarding status.

Returns:

  • (Boolean) —

    a boolean flag for the company’s onboarding status



13
14
15
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status.rb', line 13

def onboarding_completed
  @onboarding_completed
end

#onboarding_steps ⇒ Array<Gusto::Companies::CompanyOnboardingStatusOnboardingStepsItem> (readonly)

Returns a list of company onboarding steps.

Returns:



15
16
17
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status.rb', line 15

def onboarding_steps
  @onboarding_steps
end

#uuid ⇒ String (readonly)

Returns the UUID of the company.

Returns:

  • (String) —

    the UUID of the company



11
12
13
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status.rb', line 11

def uuid
  @uuid
end

Class Method Details

.from_json(json_object:) ⇒ Gusto::Companies::CompanyOnboardingStatus

Parameters:

  • json_object (String)

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status.rb', line 42

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  uuid = parsed_json["uuid"]
  onboarding_completed = parsed_json["onboarding_completed"]
  onboarding_steps = parsed_json["onboarding_steps"]&.map do | item |
  item = item.to_json
  Gusto::Companies::CompanyOnboardingStatusOnboardingStepsItem.from_json(json_object: item)
end
  new(
    uuid: uuid,
    onboarding_completed: onboarding_completed,
    onboarding_steps: onboarding_steps,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


70
71
72
73
74
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status.rb', line 70

def self.validate_raw(obj:)
  obj.uuid.is_a?(String) != false || raise("Passed value for field obj.uuid is not the expected type, validation failed.")
  obj.onboarding_completed&.is_a?(Boolean) != false || raise("Passed value for field obj.onboarding_completed is not the expected type, validation failed.")
  obj.onboarding_steps&.is_a?(Array) != false || raise("Passed value for field obj.onboarding_steps is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


61
62
63
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status.rb', line 61

def to_json
  @_field_set&.to_json
end