Class: Merge::Hris::Company

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/hris/types/company.rb

Overview

# The Company Object

### Description
The `Company` object is used to represent a company within the HRIS / Payroll
system.
### Usage Example
Fetch from the `LIST Companies` endpoint and filter by `ID` to show all
companies.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, legal_name: OMIT, display_name: OMIT, eins: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Hris::Company

Parameters:

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

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was modified by Merge.

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

    The company’s legal name.

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

    The company’s display name.

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

    The company’s Employer Identification Numbers.

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

    Indicates whether or not this object has been deleted in the third party platform.

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Merge::Hris::RemoteData>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 60

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, legal_name: OMIT,
               display_name: OMIT, eins: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @legal_name = legal_name if legal_name != OMIT
  @display_name = display_name if display_name != OMIT
  @eins = eins if eins != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "legal_name": legal_name,
    "display_name": display_name,
    "eins": eins,
    "remote_was_deleted": remote_was_deleted,
    "field_mappings": field_mappings,
    "remote_data": remote_data
  }.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



40
41
42
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 40

def additional_properties
  @additional_properties
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



23
24
25
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 23

def created_at
  @created_at
end

#display_name ⇒ String (readonly)

Returns The company’s display name.

Returns:

  • (String) —

    The company’s display name.



29
30
31
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 29

def display_name
  @display_name
end

#eins ⇒ Array<String> (readonly)

Returns The company’s Employer Identification Numbers.

Returns:

  • (Array<String>) —

    The company’s Employer Identification Numbers.



31
32
33
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 31

def eins
  @eins
end

#field_mappings ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


36
37
38
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 36

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


19
20
21
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 19

def id
  @id
end

#legal_name ⇒ String (readonly)

Returns The company’s legal name.

Returns:

  • (String) —

    The company’s legal name.



27
28
29
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 27

def legal_name
  @legal_name
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



25
26
27
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 25

def modified_at
  @modified_at
end

#remote_data ⇒ Array<Merge::Hris::RemoteData> (readonly)

Returns:



38
39
40
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 38

def remote_data
  @remote_data
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



21
22
23
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 21

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform.

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform.



34
35
36
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 34

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Hris::Company

Deserialize a JSON object to an instance of Company

Parameters:

  • json_object (String)

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 93

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  legal_name = parsed_json["legal_name"]
  display_name = parsed_json["display_name"]
  eins = parsed_json["eins"]
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]&.map do |item|
    item = item.to_json
    Merge::Hris::RemoteData.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    legal_name: legal_name,
    display_name: display_name,
    eins: eins,
    remote_was_deleted: remote_was_deleted,
    field_mappings: field_mappings,
    remote_data: remote_data,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 137

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.legal_name&.is_a?(String) != false || raise("Passed value for field obj.legal_name is not the expected type, validation failed.")
  obj.display_name&.is_a?(String) != false || raise("Passed value for field obj.display_name is not the expected type, validation failed.")
  obj.eins&.is_a?(Array) != false || raise("Passed value for field obj.eins is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of Company to a JSON object

Returns:

  • (String) 


127
128
129
 
# File 'lib/merge_ruby_client/hris/types/company.rb', line 127

def to_json(*_args)
  @_field_set&.to_json
end