Class: Merge::Hris::Group

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

Overview

# The Group Object

### Description
The `Group` object is used to represent any subset of employees across, for
example, `DEPARTMENT` or `TEAM`. Employees can be in multiple Groups.
### Usage Example
Fetch from the `LIST Employee` endpoint and expand groups to view an employee's
groups.

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, parent_group: OMIT, name: OMIT, type: OMIT, remote_was_deleted: OMIT, is_commonly_used_as_team: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Hris::Group

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.

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

    The parent group for this group.

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

    The group name.

  • type (Merge::Hris::GroupTypeEnum) (defaults to: OMIT) —

    The Group type returned directly from the third-party.

    • ‘TEAM` - TEAM

    • ‘DEPARTMENT` - DEPARTMENT

    • ‘COST_CENTER` - COST_CENTER

    • ‘BUSINESS_UNIT` - BUSINESS_UNIT

    • ‘GROUP` - GROUP

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

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

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

    Indicates whether the Group refers to a team in the third party platform. Note that this is an opinionated view based on how Merge observes most organizations representing teams in each third party platform. If your customer uses a platform different from most, there is a chance this will not be correct.

  • 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



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
109
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 80

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, parent_group: OMIT, name: OMIT,
               type: OMIT, remote_was_deleted: OMIT, is_commonly_used_as_team: 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
  @parent_group = parent_group if parent_group != OMIT
  @name = name if name != OMIT
  @type = type if type != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @is_commonly_used_as_team = is_commonly_used_as_team if is_commonly_used_as_team != 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,
    "parent_group": parent_group,
    "name": name,
    "type": type,
    "remote_was_deleted": remote_was_deleted,
    "is_commonly_used_as_team": is_commonly_used_as_team,
    "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



51
52
53
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 51

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.



24
25
26
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 24

def created_at
  @created_at
end

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

Returns:

  • (Hash{String => Object}) 


47
48
49
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 47

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


20
21
22
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 20

def id
  @id
end

#is_commonly_used_as_team ⇒ Boolean (readonly)

Returns Indicates whether the Group refers to a team in the third party platform. Note that this is an opinionated view based on how Merge observes most organizations representing teams in each third party platform. If your customer uses a platform different from most, there is a chance this will not be correct.

Returns:

  • (Boolean) —

    Indicates whether the Group refers to a team in the third party platform. Note that this is an opinionated view based on how Merge observes most organizations representing teams in each third party platform. If your customer uses a platform different from most, there is a chance this will not be correct.



45
46
47
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 45

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



26
27
28
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 26

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The group name.

Returns:

  • (String) —

    The group name.



30
31
32
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 30

def name
  @name
end

#parent_group ⇒ String (readonly)

Returns The parent group for this group.

Returns:

  • (String) —

    The parent group for this group.



28
29
30
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 28

def parent_group
  @parent_group
end

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

Returns:



49
50
51
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 49

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.



22
23
24
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 22

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.



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

def remote_was_deleted
  @remote_was_deleted
end

#type ⇒ Merge::Hris::GroupTypeEnum (readonly)

Returns The Group type returned directly from the third-party.

  • ‘TEAM` - TEAM

  • ‘DEPARTMENT` - DEPARTMENT

  • ‘COST_CENTER` - COST_CENTER

  • ‘BUSINESS_UNIT` - BUSINESS_UNIT

  • ‘GROUP` - GROUP.

Returns:

  • (Merge::Hris::GroupTypeEnum) —

    The Group type returned directly from the third-party.

    • ‘TEAM` - TEAM

    • ‘DEPARTMENT` - DEPARTMENT

    • ‘COST_CENTER` - COST_CENTER

    • ‘BUSINESS_UNIT` - BUSINESS_UNIT

    • ‘GROUP` - GROUP



37
38
39
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 37

def type
  @type
end

Class Method Details

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

Deserialize a JSON object to an instance of Group

Parameters:

  • json_object (String)

Returns:



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/merge_ruby_client/hris/types/group.rb', line 115

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?)
  parent_group = parsed_json["parent_group"]
  name = parsed_json["name"]
  type = parsed_json["type"]
  remote_was_deleted = parsed_json["remote_was_deleted"]
  is_commonly_used_as_team = parsed_json["is_commonly_used_as_team"]
  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,
    parent_group: parent_group,
    name: name,
    type: type,
    remote_was_deleted: remote_was_deleted,
    is_commonly_used_as_team: is_commonly_used_as_team,
    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) 


161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 161

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.parent_group&.is_a?(String) != false || raise("Passed value for field obj.parent_group 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.type&.is_a?(Merge::Hris::GroupTypeEnum) != false || raise("Passed value for field obj.type 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.is_commonly_used_as_team&.is_a?(Boolean) != false || raise("Passed value for field obj.is_commonly_used_as_team 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 Group to a JSON object

Returns:

  • (String) 


151
152
153
 
# File 'lib/merge_ruby_client/hris/types/group.rb', line 151

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