Class: Gusto::Employees::Forms::FormsGenerateW2Response

Inherits:
Object
  • Object
show all
Defined in:
lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(employee_uuid: OMIT, uuid:, name: OMIT, title: OMIT, description: OMIT, draft: OMIT, year: OMIT, quarter: OMIT, requires_signing: OMIT, additional_properties: nil) ⇒ Gusto::Employees::Forms::FormsGenerateW2Response

Parameters:

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

    Additional properties unmapped to the current class definition



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 62

def initialize(employee_uuid: OMIT, uuid:, name: OMIT, title: OMIT, description: OMIT, draft: OMIT, year: OMIT, quarter: OMIT, requires_signing: OMIT, additional_properties: nil)
  @employee_uuid = employee_uuid if employee_uuid != OMIT
  @uuid = uuid
  @name = name if name != OMIT
  @title = title if title != OMIT
  @description = description if description != OMIT
  @draft = draft if draft != OMIT
  @year = year if year != OMIT
  @quarter = quarter if quarter != OMIT
  @requires_signing = requires_signing if requires_signing != OMIT
  @additional_properties = additional_properties
  @_field_set = { "employee_uuid": employee_uuid, "uuid": uuid, "name": name, "title": title, "description": description, "draft": draft, "year": year, "quarter": quarter, "requires_signing": requires_signing }.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



36
37
38
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 36

def additional_properties
  @additional_properties
end

#description ⇒ String (readonly)

Returns The description of the form.

Returns:

  • (String) —

    The description of the form



18
19
20
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 18

def description
  @description
end

#draft ⇒ Object (readonly)

draft state prior to being finalized.



21
22
23
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 21

def draft
  @draft
end

#employee_uuid ⇒ String (readonly)

Returns The UUID of the employee.

Returns:

  • (String) —

    The UUID of the employee



10
11
12
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 10

def employee_uuid
  @employee_uuid
end

#name ⇒ String (readonly)

Returns The type identifier of the form.

Returns:

  • (String) —

    The type identifier of the form



14
15
16
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 14

def name
  @name
end

#quarter ⇒ Object (readonly)

value of 2022). This value is nullable and will not be present on all forms.



31
32
33
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 31

def quarter
  @quarter
end

#requires_signing ⇒ Object (readonly)

this value will change after the form is signed.



34
35
36
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 34

def requires_signing
  @requires_signing
end

#title ⇒ String (readonly)

Returns The title of the form.

Returns:

  • (String) —

    The title of the form



16
17
18
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 16

def title
  @title
end

#uuid ⇒ String (readonly)

Returns The UUID of the form.

Returns:

  • (String) —

    The UUID of the form



12
13
14
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 12

def uuid
  @uuid
end

#year ⇒ Object (readonly)

be present on all forms.



26
27
28
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 26

def year
  @year
end

Class Method Details

.from_json(json_object:) ⇒ Gusto::Employees::Forms::FormsGenerateW2Response

Parameters:

  • json_object (String)

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 81

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  employee_uuid = parsed_json["employee_uuid"]
  uuid = parsed_json["uuid"]
  name = parsed_json["name"]
  title = parsed_json["title"]
  description = parsed_json["description"]
  draft = parsed_json["draft"]
  year = parsed_json["year"]
  quarter = parsed_json["quarter"]
  requires_signing = parsed_json["requires_signing"]
  new(
    employee_uuid: employee_uuid,
    uuid: uuid,
    name: name,
    title: title,
    description: description,
    draft: draft,
    year: year,
    quarter: quarter,
    requires_signing: requires_signing,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 118

def self.validate_raw(obj:)
  obj.employee_uuid&.is_a?(String) != false || raise("Passed value for field obj.employee_uuid is not the expected type, validation failed.")
  obj.uuid.is_a?(String) != false || raise("Passed value for field obj.uuid is not the expected type, validation failed.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.title&.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
  obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
  obj.draft&.is_a?(Boolean) != false || raise("Passed value for field obj.draft is not the expected type, validation failed.")
  obj.year&.is_a?(Integer) != false || raise("Passed value for field obj.year is not the expected type, validation failed.")
  obj.quarter&.is_a?(Integer) != false || raise("Passed value for field obj.quarter is not the expected type, validation failed.")
  obj.requires_signing&.is_a?(Boolean) != false || raise("Passed value for field obj.requires_signing is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


109
110
111
 
# File 'lib/fern_gusto/employees/forms/types/forms_generate_w2response.rb', line 109

def to_json
  @_field_set&.to_json
end