Class: Gusto::Contractor::ContractorOnboardingStatusOnboardingStepsItem

Inherits:
Object
  • Object
show all
Defined in:
lib/fern_gusto/contractor/types/contractor_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, requirements: OMIT, additional_properties: nil) ⇒ Gusto::Contractor::ContractorOnboardingStatusOnboardingStepsItem

Parameters:

  • title (String) (defaults to: OMIT) —

    User-friendly description of the onboarding step.

  • id (String) (defaults to: OMIT) —

    String identifier for the onboarding step.

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

    When true, this step is required.

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

    When true, this step has been completed.

  • requirements (Array<String>) (defaults to: OMIT) —

    A list of onboarding steps required to begin this step.

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

    Additional properties unmapped to the current class definition



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/fern_gusto/contractor/types/contractor_onboarding_status_onboarding_steps_item.rb', line 33

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



19
20
21
 
# File 'lib/fern_gusto/contractor/types/contractor_onboarding_status_onboarding_steps_item.rb', line 19

def additional_properties
  @additional_properties
end

#completed ⇒ Boolean (readonly)

Returns When true, this step has been completed.

Returns:

  • (Boolean) —

    When true, this step has been completed.



15
16
17
 
# File 'lib/fern_gusto/contractor/types/contractor_onboarding_status_onboarding_steps_item.rb', line 15

def completed
  @completed
end

#id ⇒ String (readonly)

Returns String identifier for the onboarding step.

Returns:

  • (String) —

    String identifier for the onboarding step.



11
12
13
 
# File 'lib/fern_gusto/contractor/types/contractor_onboarding_status_onboarding_steps_item.rb', line 11

def id
  @id
end

#required ⇒ Boolean (readonly)

Returns When true, this step is required.

Returns:

  • (Boolean) —

    When true, this step is required.



13
14
15
 
# File 'lib/fern_gusto/contractor/types/contractor_onboarding_status_onboarding_steps_item.rb', line 13

def required
  @required
end

#requirements ⇒ Array<String> (readonly)

Returns A list of onboarding steps required to begin this step.

Returns:

  • (Array<String>) —

    A list of onboarding steps required to begin this step.



17
18
19
 
# File 'lib/fern_gusto/contractor/types/contractor_onboarding_status_onboarding_steps_item.rb', line 17

def requirements
  @requirements
end

#title ⇒ String (readonly)

Returns User-friendly description of the onboarding step.

Returns:

  • (String) —

    User-friendly description of the onboarding step.



9
10
11
 
# File 'lib/fern_gusto/contractor/types/contractor_onboarding_status_onboarding_steps_item.rb', line 9

def title
  @title
end

Class Method Details

.from_json(json_object:) ⇒ Gusto::Contractor::ContractorOnboardingStatusOnboardingStepsItem

Parameters:

  • json_object (String)

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/fern_gusto/contractor/types/contractor_onboarding_status_onboarding_steps_item.rb', line 49

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"]
  requirements = parsed_json["requirements"]
  new(
    title: title,
    id: id,
    required: required,
    completed: completed,
    requirements: requirements,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


79
80
81
82
83
84
85
 
# File 'lib/fern_gusto/contractor/types/contractor_onboarding_status_onboarding_steps_item.rb', line 79

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.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) 


70
71
72
 
# File 'lib/fern_gusto/contractor/types/contractor_onboarding_status_onboarding_steps_item.rb', line 70

def to_json
  @_field_set&.to_json
end