Class: Merge::Filestorage::Folder

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

Overview

# The Folder Object

### Description
The `Folder` object is used to represent a collection of files and/or folders in
the workspace. Could be within a drive, if it exists.
### Usage Example
Fetch from the `GET /api/filestorage/v1/folders` endpoint and view their
folders.

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, name: OMIT, folder_url: OMIT, size: OMIT, description: OMIT, parent_folder: OMIT, drive: OMIT, permissions: OMIT, remote_created_at: OMIT, remote_updated_at: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Filestorage::Folder

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 folder’s name.

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

    The URL to access the folder.

  • size (Long) (defaults to: OMIT) —

    The folder’s size, in bytes.

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

    The folder’s description.

  • parent_folder (Merge::Filestorage::FolderParentFolder) (defaults to: OMIT) —

    The folder that the folder belongs to.

  • drive (Merge::Filestorage::FolderDrive) (defaults to: OMIT) —

    The drive that the folder belongs to.

  • permissions (Merge::Filestorage::FolderPermissions) (defaults to: OMIT) —

    The Permission object is used to represent a user’s or group’s access to a File or Folder. Permissions are unexpanded by default. Use the query param ‘expand=permissions` to see more details under `GET /folders`.

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

    When the third party’s folder was created.

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

    When the third party’s folder was updated.

  • 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



89
90
91
92
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
123
124
125
126
127
128
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 89

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, folder_url: OMIT,
               size: OMIT, description: OMIT, parent_folder: OMIT, drive: OMIT, permissions: OMIT, remote_created_at: OMIT, remote_updated_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
  @name = name if name != OMIT
  @folder_url = folder_url if folder_url != OMIT
  @size = size if size != OMIT
  @description = description if description != OMIT
  @parent_folder = parent_folder if parent_folder != OMIT
  @drive = drive if drive != OMIT
  @permissions = permissions if permissions != OMIT
  @remote_created_at = remote_created_at if remote_created_at != OMIT
  @remote_updated_at = remote_updated_at if remote_updated_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,
    "name": name,
    "folder_url": folder_url,
    "size": size,
    "description": description,
    "parent_folder": parent_folder,
    "drive": drive,
    "permissions": permissions,
    "remote_created_at": remote_created_at,
    "remote_updated_at": remote_updated_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

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



59
60
61
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 59

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.



26
27
28
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 26

def created_at
  @created_at
end

#description ⇒ String (readonly)

Returns The folder’s description.

Returns:

  • (String) —

    The folder’s description.



36
37
38
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 36

def description
  @description
end

#drive ⇒ Merge::Filestorage::FolderDrive (readonly)

Returns The drive that the folder belongs to.

Returns:



40
41
42
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 40

def drive
  @drive
end

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

Returns:

  • (Hash{String => Object}) 


55
56
57
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 55

def field_mappings
  @field_mappings
end

#folder_url ⇒ String (readonly)

Returns The URL to access the folder.

Returns:

  • (String) —

    The URL to access the folder.



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

def folder_url
  @folder_url
end

#id ⇒ String (readonly)

Returns:

  • (String) 


22
23
24
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 22

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.



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

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The folder’s name.

Returns:

  • (String) —

    The folder’s name.



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

def name
  @name
end

#parent_folder ⇒ Merge::Filestorage::FolderParentFolder (readonly)

Returns The folder that the folder belongs to.

Returns:



38
39
40
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 38

def parent_folder
  @parent_folder
end

#permissions ⇒ Merge::Filestorage::FolderPermissions (readonly)

Returns The Permission object is used to represent a user’s or group’s access to a File or Folder. Permissions are unexpanded by default. Use the query param ‘expand=permissions` to see more details under `GET /folders`.

Returns:

  • (Merge::Filestorage::FolderPermissions) —

    The Permission object is used to represent a user’s or group’s access to a File or Folder. Permissions are unexpanded by default. Use the query param ‘expand=permissions` to see more details under `GET /folders`.



44
45
46
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 44

def permissions
  @permissions
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the third party’s folder was created.

Returns:

  • (DateTime) —

    When the third party’s folder was created.



46
47
48
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 46

def remote_created_at
  @remote_created_at
end

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

Returns:



57
58
59
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 57

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.



24
25
26
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 24

def remote_id
  @remote_id
end

#remote_updated_at ⇒ DateTime (readonly)

Returns When the third party’s folder was updated.

Returns:

  • (DateTime) —

    When the third party’s folder was updated.



48
49
50
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 48

def remote_updated_at
  @remote_updated_at
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/).



53
54
55
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 53

def remote_was_deleted
  @remote_was_deleted
end

#size ⇒ Long (readonly)

Returns The folder’s size, in bytes.

Returns:

  • (Long) —

    The folder’s size, in bytes.



34
35
36
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 34

def size
  @size
end

Class Method Details

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

Deserialize a JSON object to an instance of Folder

Parameters:

  • json_object (String)

Returns:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 134

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"]
  folder_url = parsed_json["folder_url"]
  size = parsed_json["size"]
  description = parsed_json["description"]
  if parsed_json["parent_folder"].nil?
    parent_folder = nil
  else
    parent_folder = parsed_json["parent_folder"].to_json
    parent_folder = Merge::Filestorage::FolderParentFolder.from_json(json_object: parent_folder)
  end
  if parsed_json["drive"].nil?
    drive = nil
  else
    drive = parsed_json["drive"].to_json
    drive = Merge::Filestorage::FolderDrive.from_json(json_object: drive)
  end
  if parsed_json["permissions"].nil?
    permissions = nil
  else
    permissions = parsed_json["permissions"].to_json
    permissions = Merge::Filestorage::FolderPermissions.from_json(json_object: permissions)
  end
  remote_created_at = unless parsed_json["remote_created_at"].nil?
                        DateTime.parse(parsed_json["remote_created_at"])
                      end
  remote_updated_at = unless parsed_json["remote_updated_at"].nil?
                        DateTime.parse(parsed_json["remote_updated_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::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,
    folder_url: folder_url,
    size: size,
    description: description,
    parent_folder: parent_folder,
    drive: drive,
    permissions: permissions,
    remote_created_at: remote_created_at,
    remote_updated_at: remote_updated_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) 


209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 209

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.folder_url&.is_a?(String) != false || raise("Passed value for field obj.folder_url is not the expected type, validation failed.")
  obj.size&.is_a?(Long) != false || raise("Passed value for field obj.size is not the expected type, validation failed.")
  obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
  obj.parent_folder.nil? || Merge::Filestorage::FolderParentFolder.validate_raw(obj: obj.parent_folder)
  obj.drive.nil? || Merge::Filestorage::FolderDrive.validate_raw(obj: obj.drive)
  obj.permissions.nil? || Merge::Filestorage::FolderPermissions.validate_raw(obj: obj.permissions)
  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_updated_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_updated_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 Folder to a JSON object

Returns:

  • (String) 


199
200
201
 
# File 'lib/merge_ruby_client/filestorage/types/folder.rb', line 199

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