Class: Merge::Filestorage::Group

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

Overview

# The Group Object

### Description
The `Group` object is used to represent any subset of `Users`. This can extend
to company domains as well.
### Usage Example
Fetch from the `GET /api/filestorage/v1/groups` endpoint and view their groups.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(users:, id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, child_groups: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Filestorage::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.

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

    The group’s name.

  • users (Array<String>) —

    The users that belong in the group. If null, this typically means it’s either a domain or the third-party platform does not surface this information.

  • child_groups (Array<Merge::Filestorage::GroupChildGroupsItem>) (defaults to: OMIT) —

    Groups that inherit the permissions of the parent group.

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

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

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

    Additional properties unmapped to the current class definition



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 66

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



43
44
45
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 43

def additional_properties
  @additional_properties
end

#child_groups ⇒ Array<Merge::Filestorage::GroupChildGroupsItem> (readonly)

Returns Groups that inherit the permissions of the parent group.

Returns:



32
33
34
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 32

def child_groups
  @child_groups
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/filestorage/types/group.rb', line 23

def created_at
  @created_at
end

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

Returns:

  • (Hash{String => Object}) 


39
40
41
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 39

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


19
20
21
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 19

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.



25
26
27
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 25

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The group’s name.

Returns:

  • (String) —

    The group’s name.



27
28
29
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 27

def name
  @name
end

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

Returns:



41
42
43
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 41

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/filestorage/types/group.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. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).



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

def remote_was_deleted
  @remote_was_deleted
end

#users ⇒ Array<String> (readonly)

Returns The users that belong in the group. If null, this typically means it’s either a domain or the third-party platform does not surface this information.

Returns:

  • (Array<String>) —

    The users that belong in the group. If null, this typically means it’s either a domain or the third-party platform does not surface this information.



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

def users
  @users
end

Class Method Details

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

Deserialize a JSON object to an instance of Group

Parameters:

  • json_object (String)

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 99

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?)
  name = parsed_json["name"]
  users = parsed_json["users"]
  child_groups = parsed_json["child_groups"]&.map do |item|
    item = item.to_json
    Merge::Filestorage::GroupChildGroupsItem.from_json(json_object: item)
  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::Filestorage::RemoteData.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    name: name,
    users: users,
    child_groups: child_groups,
    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) 


146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 146

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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.users.is_a?(Array) != false || raise("Passed value for field obj.users is not the expected type, validation failed.")
  obj.child_groups&.is_a?(Array) != false || raise("Passed value for field obj.child_groups 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 Group to a JSON object

Returns:

  • (String) 


136
137
138
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 136

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