Class: Merge::Filestorage::File

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

Overview

# The File Object

### Description
The `File` object is used to represent a file in the workspace. The Object
typically exists under a folder or drive, if it exists.
### Usage Example
Fetch from the `GET /api/filestorage/v1/files` endpoint and view their files.

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, file_url: OMIT, file_thumbnail_url: OMIT, size: OMIT, mime_type: OMIT, description: OMIT, folder: OMIT, checksum: OMIT, permissions: OMIT, drive: OMIT, remote_created_at: OMIT, remote_updated_at: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Filestorage::File

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

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

    The URL to access the file.

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

    The URL that produces a thumbnail preview of the file. Typically an image.

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

    The file’s size, in bytes.

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

    The file’s mime type.

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

    The file’s description.

  • folder (Merge::Filestorage::FileFolder) (defaults to: OMIT) —

    The folder that the file belongs to.

  • checksum (Hash{String => Object}) (defaults to: OMIT) —

    This field stores file checksum data. ‘type’ indicates the algorithm (e.g. crc_32, sha1, sha256, quickXor, or md5), and ‘content_hash’ is the unique hash used to verify file integrity and detect alterations.

  • permissions (Merge::Filestorage::FilePermissions) (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 /files`.

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

    The drive that the file belongs to.

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

    When the third party’s file was created.

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

    When the third party’s file 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



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/merge_ruby_client/filestorage/types/file.rb', line 101

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, file_url: OMIT,
               file_thumbnail_url: OMIT, size: OMIT, mime_type: OMIT, description: OMIT, folder: OMIT, checksum: OMIT, permissions: OMIT, drive: 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
  @file_url = file_url if file_url != OMIT
  @file_thumbnail_url = file_thumbnail_url if file_thumbnail_url != OMIT
  @size = size if size != OMIT
  @mime_type = mime_type if mime_type != OMIT
  @description = description if description != OMIT
  @folder = folder if folder != OMIT
  @checksum = checksum if checksum != OMIT
  @permissions = permissions if permissions != OMIT
  @drive = drive if drive != 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,
    "file_url": file_url,
    "file_thumbnail_url": file_thumbnail_url,
    "size": size,
    "mime_type": mime_type,
    "description": description,
    "folder": folder,
    "checksum": checksum,
    "permissions": permissions,
    "drive": drive,
    "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



66
67
68
 
# File 'lib/merge_ruby_client/filestorage/types/file.rb', line 66

def additional_properties
  @additional_properties
end

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

Returns This field stores file checksum data. ‘type’ indicates the algorithm (e.g. crc_32, sha1, sha256, quickXor, or md5), and ‘content_hash’ is the unique hash used to verify file integrity and detect alterations.

Returns:

  • (Hash{String => Object}) —

    This field stores file checksum data. ‘type’ indicates the algorithm (e.g. crc_32, sha1, sha256, quickXor, or md5), and ‘content_hash’ is the unique hash used to verify file integrity and detect alterations.



45
46
47
 
# File 'lib/merge_ruby_client/filestorage/types/file.rb', line 45

def checksum
  @checksum
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/filestorage/types/file.rb', line 25

def created_at
  @created_at
end

#description ⇒ String (readonly)

Returns The file’s description.

Returns:

  • (String) —

    The file’s description.



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

def description
  @description
end

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

Returns The drive that the file belongs to.

Returns:



51
52
53
 
# File 'lib/merge_ruby_client/filestorage/types/file.rb', line 51

def drive
  @drive
end

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

Returns:

  • (Hash{String => Object}) 


62
63
64
 
# File 'lib/merge_ruby_client/filestorage/types/file.rb', line 62

def field_mappings
  @field_mappings
end

#file_thumbnail_url ⇒ String (readonly)

Returns The URL that produces a thumbnail preview of the file. Typically an image.

Returns:

  • (String) —

    The URL that produces a thumbnail preview of the file. Typically an image.



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

def file_thumbnail_url
  @file_thumbnail_url
end

#file_url ⇒ String (readonly)

Returns The URL to access the file.

Returns:

  • (String) —

    The URL to access the file.



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

def file_url
  @file_url
end

#folder ⇒ Merge::Filestorage::FileFolder (readonly)

Returns The folder that the file belongs to.

Returns:



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

def folder
  @folder
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

def id
  @id
end

#mime_type ⇒ String (readonly)

Returns The file’s mime type.

Returns:

  • (String) —

    The file’s mime type.



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

def mime_type
  @mime_type
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/filestorage/types/file.rb', line 27

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The file’s name.

Returns:

  • (String) —

    The file’s name.



29
30
31
 
# File 'lib/merge_ruby_client/filestorage/types/file.rb', line 29

def name
  @name
end

#permissions ⇒ Merge::Filestorage::FilePermissions (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 /files`.

Returns:

  • (Merge::Filestorage::FilePermissions) —

    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 /files`.



49
50
51
 
# File 'lib/merge_ruby_client/filestorage/types/file.rb', line 49

def permissions
  @permissions
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the third party’s file was created.

Returns:

  • (DateTime) —

    When the third party’s file was created.



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

def remote_created_at
  @remote_created_at
end

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

Returns:



64
65
66
 
# File 'lib/merge_ruby_client/filestorage/types/file.rb', line 64

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/filestorage/types/file.rb', line 23

def remote_id
  @remote_id
end

#remote_updated_at ⇒ DateTime (readonly)

Returns When the third party’s file was updated.

Returns:

  • (DateTime) —

    When the third party’s file was updated.



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

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



60
61
62
 
# File 'lib/merge_ruby_client/filestorage/types/file.rb', line 60

def remote_was_deleted
  @remote_was_deleted
end

#size ⇒ Long (readonly)

Returns The file’s size, in bytes.

Returns:

  • (Long) —

    The file’s size, in bytes.



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

def size
  @size
end

Class Method Details

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

Deserialize a JSON object to an instance of File

Parameters:

  • json_object (String)

Returns:



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/merge_ruby_client/filestorage/types/file.rb', line 152

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"]
  file_url = parsed_json["file_url"]
  file_thumbnail_url = parsed_json["file_thumbnail_url"]
  size = parsed_json["size"]
  mime_type = parsed_json["mime_type"]
  description = parsed_json["description"]
  if parsed_json["folder"].nil?
    folder = nil
  else
    folder = parsed_json["folder"].to_json
    folder = Merge::Filestorage::FileFolder.from_json(json_object: folder)
  end
  checksum = parsed_json["checksum"]
  if parsed_json["permissions"].nil?
    permissions = nil
  else
    permissions = parsed_json["permissions"].to_json
    permissions = Merge::Filestorage::FilePermissions.from_json(json_object: permissions)
  end
  if parsed_json["drive"].nil?
    drive = nil
  else
    drive = parsed_json["drive"].to_json
    drive = Merge::Filestorage::FileDrive.from_json(json_object: drive)
  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,
    file_url: file_url,
    file_thumbnail_url: file_thumbnail_url,
    size: size,
    mime_type: mime_type,
    description: description,
    folder: folder,
    checksum: checksum,
    permissions: permissions,
    drive: drive,
    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) 


233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/merge_ruby_client/filestorage/types/file.rb', line 233

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.file_url&.is_a?(String) != false || raise("Passed value for field obj.file_url is not the expected type, validation failed.")
  obj.file_thumbnail_url&.is_a?(String) != false || raise("Passed value for field obj.file_thumbnail_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.mime_type&.is_a?(String) != false || raise("Passed value for field obj.mime_type 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.folder.nil? || Merge::Filestorage::FileFolder.validate_raw(obj: obj.folder)
  obj.checksum&.is_a?(Hash) != false || raise("Passed value for field obj.checksum is not the expected type, validation failed.")
  obj.permissions.nil? || Merge::Filestorage::FilePermissions.validate_raw(obj: obj.permissions)
  obj.drive.nil? || Merge::Filestorage::FileDrive.validate_raw(obj: obj.drive)
  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 File to a JSON object

Returns:

  • (String) 


223
224
225
 
# File 'lib/merge_ruby_client/filestorage/types/file.rb', line 223

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