Class: Merge::Ticketing::User

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

Overview

# The User Object

### Description
The `User` object is used to represent a user with a login to the ticketing
system.
Users are either assignees who are directly responsible or a viewer on a
`Ticket`/ `Collection`.
### Usage Example
TODO

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_active: OMIT, teams: OMIT, roles: OMIT, avatar: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Ticketing::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.

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

    Whether or not the user is active.

  • teams (Array<Merge::Ticketing::UserTeamsItem>) (defaults to: OMIT)
  • roles (Array<Merge::Ticketing::UserRolesItem>) (defaults to: OMIT)
  • avatar (String) (defaults to: OMIT) —

    The user’s avatar picture.

  • 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::Ticketing::RemoteData>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 76

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, email_address: OMIT,
               is_active: OMIT, teams: OMIT, roles: OMIT, avatar: 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_active = is_active if is_active != OMIT
  @teams = teams if teams != OMIT
  @roles = roles if roles != OMIT
  @avatar = avatar if avatar != 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_active": is_active,
    "teams": teams,
    "roles": roles,
    "avatar": avatar,
    "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



51
52
53
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 51

def additional_properties
  @additional_properties
end

#avatar ⇒ String (readonly)

Returns The user’s avatar picture.

Returns:

  • (String) —

    The user’s avatar picture.



40
41
42
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 40

def avatar
  @avatar
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/ticketing/types/user.rb', line 26

def created_at
  @created_at
end

#email_address ⇒ String (readonly)

Returns The user’s email address.

Returns:

  • (String) —

    The user’s email address.



32
33
34
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 32

def email_address
  @email_address
end

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

Returns:

  • (Hash{String => Object}) 


47
48
49
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 47

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


22
23
24
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 22

def id
  @id
end

#is_active ⇒ Boolean (readonly)

Returns Whether or not the user is active.

Returns:

  • (Boolean) —

    Whether or not the user is active.



34
35
36
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 34

def is_active
  @is_active
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/ticketing/types/user.rb', line 28

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The user’s name.

Returns:

  • (String) —

    The user’s name.



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

def name
  @name
end

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

Returns:



49
50
51
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 49

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/ticketing/types/user.rb', line 24

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



45
46
47
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 45

def remote_was_deleted
  @remote_was_deleted
end

#roles ⇒ Array<Merge::Ticketing::UserRolesItem> (readonly)

Returns:



38
39
40
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 38

def roles
  @roles
end

#teams ⇒ Array<Merge::Ticketing::UserTeamsItem> (readonly)

Returns:



36
37
38
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 36

def teams
  @teams
end

Class Method Details

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

Deserialize a JSON object to an instance of User

Parameters:

  • json_object (String)

Returns:



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
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 115

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_active = parsed_json["is_active"]
  teams = parsed_json["teams"]&.map do |item|
    item = item.to_json
    Merge::Ticketing::UserTeamsItem.from_json(json_object: item)
  end
  roles = parsed_json["roles"]&.map do |item|
    item = item.to_json
    Merge::Ticketing::UserRolesItem.from_json(json_object: item)
  end
  avatar = parsed_json["avatar"]
  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::Ticketing::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_active: is_active,
    teams: teams,
    roles: roles,
    avatar: avatar,
    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) 


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 171

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_active&.is_a?(Boolean) != false || raise("Passed value for field obj.is_active is not the expected type, validation failed.")
  obj.teams&.is_a?(Array) != false || raise("Passed value for field obj.teams is not the expected type, validation failed.")
  obj.roles&.is_a?(Array) != false || raise("Passed value for field obj.roles is not the expected type, validation failed.")
  obj.avatar&.is_a?(String) != false || raise("Passed value for field obj.avatar 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) 


161
162
163
 
# File 'lib/merge_ruby_client/ticketing/types/user.rb', line 161

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