Class: Merge::Filestorage::Drive

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

Overview

# The Drive Object

### Description
The `Drive` object is used to represent a drive that contains the folders and
files in the user's workspace.
### Usage Example
Fetch from the `GET /api/filestorage/v1/drives` endpoint and view their drives.

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, remote_created_at: OMIT, drive_url: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Filestorage::Drive

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

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

    When the third party’s drive was created.

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

    The drive’s url.

  • 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



63
64
65
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
 
# File 'lib/merge_ruby_client/filestorage/types/drive.rb', line 63

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



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

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.



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

def created_at
  @created_at
end

#drive_url ⇒ String (readonly)

Returns The drive’s url.

Returns:

  • (String) —

    The drive’s url.



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

def drive_url
  @drive_url
end

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

Returns:

  • (Hash{String => Object}) 


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

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


18
19
20
 
# File 'lib/merge_ruby_client/filestorage/types/drive.rb', line 18

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.



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

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The drive’s name.

Returns:

  • (String) —

    The drive’s name.



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

def name
  @name
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the third party’s drive was created.

Returns:

  • (DateTime) —

    When the third party’s drive was created.



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

def remote_created_at
  @remote_created_at
end

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

Returns:



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

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.



20
21
22
 
# File 'lib/merge_ruby_client/filestorage/types/drive.rb', line 20

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



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

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

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

Deserialize a JSON object to an instance of Drive

Parameters:

  • json_object (String)

Returns:



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
 
# File 'lib/merge_ruby_client/filestorage/types/drive.rb', line 96

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"]
  remote_created_at = unless parsed_json["remote_created_at"].nil?
                        DateTime.parse(parsed_json["remote_created_at"])
                      end
  drive_url = parsed_json["drive_url"]
  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,
    remote_created_at: remote_created_at,
    drive_url: drive_url,
    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) 


142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/merge_ruby_client/filestorage/types/drive.rb', line 142

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

Returns:

  • (String) 


132
133
134
 
# File 'lib/merge_ruby_client/filestorage/types/drive.rb', line 132

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