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, 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.

  • 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<Hash{String => Object}>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 57

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



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

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.



21
22
23
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 21

def created_at
  @created_at
end

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

Returns:

  • (Hash{String => Object}) 


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

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


17
18
19
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 17

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.



23
24
25
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 23

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The group’s name.

Returns:

  • (String) —

    The group’s name.



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

def name
  @name
end

#remote_data ⇒ Array<Hash{String => Object}> (readonly)

Returns:

  • (Array<Hash{String => Object}>) 


35
36
37
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 35

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.



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

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.



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

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.



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

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:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 88

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"]
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    name: name,
    users: users,
    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) 


127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 127

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.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) 


117
118
119
 
# File 'lib/merge_ruby_client/filestorage/types/group.rb', line 117

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