Class: Merge::Filestorage::User

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

Overview

# The User Object

### Description
The `User` object is used to represent a user within the File Storage account.
### Usage Example
Fetch from the `GET /api/filestorage/v1/users` endpoint and view their users.

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, email_address: OMIT, is_me: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Filestorage::User

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

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

    The user’s email address. This is typically used to identify a user across linked accounts.

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

    Whether the user is the one who linked this account.

  • 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



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

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, email_address: OMIT,
               is_me: 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
  @email_address = email_address if email_address != OMIT
  @is_me = is_me if is_me != 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,
    "email_address": email_address,
    "is_me": is_me,
    "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/user.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.



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

def created_at
  @created_at
end

#email_address ⇒ String (readonly)

Returns The user’s email address. This is typically used to identify a user across linked accounts.

Returns:

  • (String) —

    The user’s email address. This is typically used to identify a user across linked accounts.



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

def email_address
  @email_address
end

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

Returns:

  • (Hash{String => Object}) 


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

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

def id
  @id
end

#is_me ⇒ Boolean (readonly)

Returns Whether the user is the one who linked this account.

Returns:

  • (Boolean) —

    Whether the user is the one who linked this account.



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

def is_me
  @is_me
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/user.rb', line 23

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The user’s name.

Returns:

  • (String) —

    The user’s name.



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

def name
  @name
end

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

Returns:



39
40
41
 
# File 'lib/merge_ruby_client/filestorage/types/user.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.



19
20
21
 
# File 'lib/merge_ruby_client/filestorage/types/user.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. 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/user.rb', line 35

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

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

Deserialize a JSON object to an instance of User

Parameters:

  • json_object (String)

Returns:



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

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"]
  email_address = parsed_json["email_address"]
  is_me = parsed_json["is_me"]
  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,
    email_address: email_address,
    is_me: is_me,
    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) 


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

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

Returns:

  • (String) 


131
132
133
 
# File 'lib/merge_ruby_client/filestorage/types/user.rb', line 131

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