Class: Gusto::Companies::CompanyOnboardingStatusOnboardingStepsItem

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(title: OMIT, id: OMIT, required: OMIT, completed: OMIT, skippable: OMIT, requirements: OMIT, additional_properties: nil) ⇒ Gusto::Companies::CompanyOnboardingStatusOnboardingStepsItem

Parameters:

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

    Additional properties unmapped to the current class definition



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status_onboarding_steps_item.rb', line 38

def initialize(title: OMIT, id: OMIT, required: OMIT, completed: OMIT, skippable: OMIT, requirements: OMIT, additional_properties: nil)
  @title = title if title != OMIT
  @id = id if id != OMIT
  @required = required if required != OMIT
  @completed = completed if completed != OMIT
  @skippable = skippable if skippable != OMIT
  @requirements = requirements if requirements != OMIT
  @additional_properties = additional_properties
  @_field_set = { "title": title, "id": id, "required": required, "completed": completed, "skippable": skippable, "requirements": requirements }.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



22
23
24
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status_onboarding_steps_item.rb', line 22

def additional_properties
  @additional_properties
end

#completed ⇒ Boolean (readonly)

Returns The boolean flag indicating whether the step is completed or not.

Returns:

  • (Boolean) —

    The boolean flag indicating whether the step is completed or not.



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

def completed
  @completed
end

#id ⇒ String (readonly)

Returns The string identifier for each onboarding step.

Returns:

  • (String) —

    The string identifier for each onboarding step



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

def id
  @id
end

#required ⇒ Boolean (readonly)

Returns The boolean flag indicating whether the step is required or optional.

Returns:

  • (Boolean) —

    The boolean flag indicating whether the step is required or optional



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

def required
  @required
end

#requirements ⇒ Object (readonly)

with the current onboarding step.



20
21
22
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status_onboarding_steps_item.rb', line 20

def requirements
  @requirements
end

#skippable ⇒ Boolean (readonly)

Returns The boolean flag indicating whether the step can be skipped or not.

Returns:

  • (Boolean) —

    The boolean flag indicating whether the step can be skipped or not.



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

def skippable
  @skippable
end

#title ⇒ String (readonly)

Returns The display name of the onboarding step.

Returns:

  • (String) —

    The display name of the onboarding step



9
10
11
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status_onboarding_steps_item.rb', line 9

def title
  @title
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status_onboarding_steps_item.rb', line 55

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  title = parsed_json["title"]
  id = parsed_json["id"]
  required = parsed_json["required"]
  completed = parsed_json["completed"]
  skippable = parsed_json["skippable"]
  requirements = parsed_json["requirements"]
  new(
    title: title,
    id: id,
    required: required,
    completed: completed,
    skippable: skippable,
    requirements: requirements,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


87
88
89
90
91
92
93
94
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status_onboarding_steps_item.rb', line 87

def self.validate_raw(obj:)
  obj.title&.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.required&.is_a?(Boolean) != false || raise("Passed value for field obj.required is not the expected type, validation failed.")
  obj.completed&.is_a?(Boolean) != false || raise("Passed value for field obj.completed is not the expected type, validation failed.")
  obj.skippable&.is_a?(Boolean) != false || raise("Passed value for field obj.skippable is not the expected type, validation failed.")
  obj.requirements&.is_a?(Array) != false || raise("Passed value for field obj.requirements is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


78
79
80
 
# File 'lib/fern_gusto/companies/types/company_onboarding_status_onboarding_steps_item.rb', line 78

def to_json
  @_field_set&.to_json
end