Class: Merge::Hris::BankInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/hris/types/bank_info.rb,
lib/merge_ruby_client/hris/bank_info/types/bank_info_list_request_order_by.rb,
lib/merge_ruby_client/hris/bank_info/types/bank_info_list_request_account_type.rb

Overview

# The BankInfo Object

### Description
The `BankInfo` object is used to represent the Bank Account information for an
Employee.
### Usage Example
Fetch from the `LIST BankInfo` endpoint and filter by `ID` to show all bank
information.

Defined Under Namespace

Classes: BankInfoListRequestAccountType, BankInfoListRequestOrderBy

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, employee: OMIT, account_number: OMIT, routing_number: OMIT, bank_name: OMIT, account_type: OMIT, remote_created_at: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Hris::BankInfo

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.

  • employee (Merge::Hris::BankInfoEmployee) (defaults to: OMIT) —

    The employee with this bank account.

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

    The account number.

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

    The routing number.

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

    The bank name.

  • account_type (Merge::Hris::AccountTypeEnum) (defaults to: OMIT) —

    The bank account type

    • ‘SAVINGS` - SAVINGS

    • ‘CHECKING` - CHECKING

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

    When the matching bank object was created in the third party system.

  • 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



75
76
77
78
79
80
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
106
107
108
 
# File 'lib/merge_ruby_client/hris/types/bank_info.rb', line 75

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, employee: OMIT,
               account_number: OMIT, routing_number: OMIT, bank_name: OMIT, account_type: OMIT, remote_created_at: 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
  @employee = employee if employee != OMIT
  @account_number =  if  != OMIT
  @routing_number = routing_number if routing_number != OMIT
  @bank_name = bank_name if bank_name != OMIT
  @account_type =  if  != OMIT
  @remote_created_at = remote_created_at if remote_created_at != 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,
    "employee": employee,
    "account_number": ,
    "routing_number": routing_number,
    "bank_name": bank_name,
    "account_type": ,
    "remote_created_at": remote_created_at,
    "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

#account_number ⇒ String (readonly)

Returns The account number.

Returns:

  • (String) —

    The account number.



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

def 
  @account_number
end

#account_type ⇒ Merge::Hris::AccountTypeEnum (readonly)

Returns The bank account type

  • ‘SAVINGS` - SAVINGS

  • ‘CHECKING` - CHECKING.

Returns:



39
40
41
 
# File 'lib/merge_ruby_client/hris/types/bank_info.rb', line 39

def 
  @account_type
end

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



50
51
52
 
# File 'lib/merge_ruby_client/hris/types/bank_info.rb', line 50

def additional_properties
  @additional_properties
end

#bank_name ⇒ String (readonly)

Returns The bank name.

Returns:

  • (String) —

    The bank name.



35
36
37
 
# File 'lib/merge_ruby_client/hris/types/bank_info.rb', line 35

def bank_name
  @bank_name
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.



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

def created_at
  @created_at
end

#employee ⇒ Merge::Hris::BankInfoEmployee (readonly)

Returns The employee with this bank account.

Returns:



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

def employee
  @employee
end

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

Returns:

  • (Hash{String => Object}) 


46
47
48
 
# File 'lib/merge_ruby_client/hris/types/bank_info.rb', line 46

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

def id
  @id
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.



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

def modified_at
  @modified_at
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the matching bank object was created in the third party system.

Returns:

  • (DateTime) —

    When the matching bank object was created in the third party system.



41
42
43
 
# File 'lib/merge_ruby_client/hris/types/bank_info.rb', line 41

def remote_created_at
  @remote_created_at
end

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

Returns:



48
49
50
 
# File 'lib/merge_ruby_client/hris/types/bank_info.rb', line 48

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.



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

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.



44
45
46
 
# File 'lib/merge_ruby_client/hris/types/bank_info.rb', line 44

def remote_was_deleted
  @remote_was_deleted
end

#routing_number ⇒ String (readonly)

Returns The routing number.

Returns:

  • (String) —

    The routing number.



33
34
35
 
# File 'lib/merge_ruby_client/hris/types/bank_info.rb', line 33

def routing_number
  @routing_number
end

Class Method Details

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

Deserialize a JSON object to an instance of BankInfo

Parameters:

  • json_object (String)

Returns:



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
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/merge_ruby_client/hris/types/bank_info.rb', line 114

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?)
  if parsed_json["employee"].nil?
    employee = nil
  else
    employee = parsed_json["employee"].to_json
    employee = Merge::Hris::BankInfoEmployee.from_json(json_object: employee)
  end
   = parsed_json["account_number"]
  routing_number = parsed_json["routing_number"]
  bank_name = parsed_json["bank_name"]
   = parsed_json["account_type"]
  remote_created_at = unless parsed_json["remote_created_at"].nil?
                        DateTime.parse(parsed_json["remote_created_at"])
                      end
  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,
    employee: employee,
    account_number: ,
    routing_number: routing_number,
    bank_name: bank_name,
    account_type: ,
    remote_created_at: remote_created_at,
    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) 


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/merge_ruby_client/hris/types/bank_info.rb', line 171

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.employee.nil? || Merge::Hris::BankInfoEmployee.validate_raw(obj: obj.employee)
  obj.&.is_a?(String) != false || raise("Passed value for field obj.account_number is not the expected type, validation failed.")
  obj.routing_number&.is_a?(String) != false || raise("Passed value for field obj.routing_number is not the expected type, validation failed.")
  obj.bank_name&.is_a?(String) != false || raise("Passed value for field obj.bank_name is not the expected type, validation failed.")
  obj.&.is_a?(Merge::Hris::AccountTypeEnum) != false || raise("Passed value for field obj.account_type is not the expected type, validation failed.")
  obj.remote_created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_created_at 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 BankInfo to a JSON object

Returns:

  • (String) 


161
162
163
 
# File 'lib/merge_ruby_client/hris/types/bank_info.rb', line 161

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