Class: Gusto::Signatories::Signatory

Inherits:
Object
  • Object
show all
Defined in:
lib/fern_gusto/signatories/types/signatory.rb

Overview

The representation of a company’s signatory

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uuid:, first_name: OMIT, last_name: OMIT, title: OMIT, phone: OMIT, email: OMIT, birthday: OMIT, is_admin: OMIT, has_ssn: OMIT, version: OMIT, identity_verification_status: OMIT, home_address: OMIT, additional_properties: nil) ⇒ Gusto::Signatories::Signatory

Parameters:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 89

def initialize(uuid:, first_name: OMIT, last_name: OMIT, title: OMIT, phone: OMIT, email: OMIT, birthday: OMIT, is_admin: OMIT, has_ssn: OMIT, version: OMIT, identity_verification_status: OMIT, home_address: OMIT, additional_properties: nil)
  @uuid = uuid
  @first_name = first_name if first_name != OMIT
  @last_name = last_name if last_name != OMIT
  @title = title if title != OMIT
  @phone = phone if phone != OMIT
  @email = email if email != OMIT
  @birthday = birthday if birthday != OMIT
  @is_admin = is_admin if is_admin != OMIT
  @has_ssn = has_ssn if has_ssn != OMIT
  @version = version if version != OMIT
  @identity_verification_status = identity_verification_status if identity_verification_status != OMIT
  @home_address = home_address if home_address != OMIT
  @additional_properties = additional_properties
  @_field_set = { "uuid": uuid, "first_name": first_name, "last_name": last_name, "title": title, "phone": phone, "email": email, "birthday": birthday, "is_admin": is_admin, "has_ssn": has_ssn, "version": version, "identity_verification_status": identity_verification_status, "home_address": home_address }.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



52
53
54
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 52

def additional_properties
  @additional_properties
end

#birthday ⇒ String (readonly)

Returns:

  • (String) 


24
25
26
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 24

def birthday
  @birthday
end

#email ⇒ String (readonly)

Returns:

  • (String) 


22
23
24
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 22

def email
  @email
end

#first_name ⇒ String (readonly)

Returns:

  • (String) 


14
15
16
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 14

def first_name
  @first_name
end

#has_ssn ⇒ Boolean (readonly)

Returns Indicates whether the signatory has an SSN in Gusto.

Returns:

  • (Boolean) —

    Indicates whether the signatory has an SSN in Gusto.



28
29
30
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 28

def has_ssn
  @has_ssn
end

#home_address ⇒ Gusto::Signatories::SignatoryHomeAddress (readonly)

Returns:



50
51
52
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 50

def home_address
  @home_address
end

#identity_verification_status ⇒ Object (readonly)

|



48
49
50
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 48

def identity_verification_status
  @identity_verification_status
end

#is_admin ⇒ Boolean (readonly)

Returns Whether or not the signatory is also the payroll admin of the company.

Returns:

  • (Boolean) —

    Whether or not the signatory is also the payroll admin of the company.



26
27
28
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 26

def is_admin
  @is_admin
end

#last_name ⇒ String (readonly)

Returns:

  • (String) 


16
17
18
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 16

def last_name
  @last_name
end

#phone ⇒ String (readonly)

Returns:

  • (String) 


20
21
22
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 20

def phone
  @phone
end

#title ⇒ String (readonly)

Returns:

  • (String) 


18
19
20
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 18

def title
  @title
end

#uuid ⇒ String (readonly)

Returns:

  • (String) 


12
13
14
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 12

def uuid
  @uuid
end

#version ⇒ Object (readonly)

on how to use this field.



32
33
34
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 32

def version
  @version
end

Class Method Details

.from_json(json_object:) ⇒ Gusto::Signatories::Signatory

Parameters:

  • json_object (String)

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 111

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  uuid = parsed_json["uuid"]
  first_name = parsed_json["first_name"]
  last_name = parsed_json["last_name"]
  title = parsed_json["title"]
  phone = parsed_json["phone"]
  email = parsed_json["email"]
  birthday = parsed_json["birthday"]
  is_admin = parsed_json["is_admin"]
  has_ssn = parsed_json["has_ssn"]
  version = parsed_json["version"]
  identity_verification_status = parsed_json["identity_verification_status"]
  unless parsed_json["home_address"].nil?
    home_address = parsed_json["home_address"].to_json
    home_address = Gusto::Signatories::SignatoryHomeAddress.from_json(json_object: home_address)
  else
    home_address = nil
  end
  new(
    uuid: uuid,
    first_name: first_name,
    last_name: last_name,
    title: title,
    phone: phone,
    email: email,
    birthday: birthday,
    is_admin: is_admin,
    has_ssn: has_ssn,
    version: version,
    identity_verification_status: identity_verification_status,
    home_address: home_address,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 159

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.first_name&.is_a?(String) != false || raise("Passed value for field obj.first_name is not the expected type, validation failed.")
  obj.last_name&.is_a?(String) != false || raise("Passed value for field obj.last_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.phone&.is_a?(String) != false || raise("Passed value for field obj.phone is not the expected type, validation failed.")
  obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
  obj.birthday&.is_a?(String) != false || raise("Passed value for field obj.birthday is not the expected type, validation failed.")
  obj.is_admin&.is_a?(Boolean) != false || raise("Passed value for field obj.is_admin is not the expected type, validation failed.")
  obj.has_ssn&.is_a?(Boolean) != false || raise("Passed value for field obj.has_ssn is not the expected type, validation failed.")
  obj.version&.is_a?(String) != false || raise("Passed value for field obj.version is not the expected type, validation failed.")
  obj.identity_verification_status&.is_a?(Gusto::Signatories::SignatoryIdentityVerificationStatus) != false || raise("Passed value for field obj.identity_verification_status is not the expected type, validation failed.")
  obj.home_address.nil? || Gusto::Signatories::SignatoryHomeAddress.validate_raw(obj: obj.home_address)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


150
151
152
 
# File 'lib/fern_gusto/signatories/types/signatory.rb', line 150

def to_json
  @_field_set&.to_json
end