Class: Merge::Ticketing::Role

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

Overview

# The Role Object

### Description
The `Role` object is used to represent the set of actions & access that a user
with this role is allowed to perform.
### 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, ticket_actions: OMIT, ticket_access: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Ticketing::Role

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 name of the Role.

  • ticket_actions (Array<Merge::Ticketing::TicketActionsEnum>) (defaults to: OMIT) —

    The set of actions that a User with this Role can perform. Possible enum values include: ‘VIEW`, `CREATE`, `EDIT`, `DELETE`, `CLOSE`, and `ASSIGN`.

  • ticket_access (Merge::Ticketing::TicketAccessEnum) (defaults to: OMIT) —

    The level of Ticket access that a User with this Role can perform.

    • ‘ALL` - ALL

    • ‘ASSIGNED_ONLY` - ASSIGNED_ONLY

    • ‘TEAM_ONLY` - TEAM_ONLY

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

    Indicates whether or not this object has been deleted in the third party platform.

  • 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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/merge_ruby_client/ticketing/types/role.rb', line 69

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



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

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.



24
25
26
 
# File 'lib/merge_ruby_client/ticketing/types/role.rb', line 24

def created_at
  @created_at
end

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

Returns:

  • (Hash{String => Object}) 


41
42
43
 
# File 'lib/merge_ruby_client/ticketing/types/role.rb', line 41

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


20
21
22
 
# File 'lib/merge_ruby_client/ticketing/types/role.rb', line 20

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.



26
27
28
 
# File 'lib/merge_ruby_client/ticketing/types/role.rb', line 26

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The name of the Role.

Returns:

  • (String) —

    The name of the Role.



28
29
30
 
# File 'lib/merge_ruby_client/ticketing/types/role.rb', line 28

def name
  @name
end

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

Returns:



43
44
45
 
# File 'lib/merge_ruby_client/ticketing/types/role.rb', line 43

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.



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

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.

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform.



39
40
41
 
# File 'lib/merge_ruby_client/ticketing/types/role.rb', line 39

def remote_was_deleted
  @remote_was_deleted
end

#ticket_access ⇒ Merge::Ticketing::TicketAccessEnum (readonly)

Returns The level of Ticket access that a User with this Role can perform.

  • ‘ALL` - ALL

  • ‘ASSIGNED_ONLY` - ASSIGNED_ONLY

  • ‘TEAM_ONLY` - TEAM_ONLY.

Returns:

  • (Merge::Ticketing::TicketAccessEnum) —

    The level of Ticket access that a User with this Role can perform.

    • ‘ALL` - ALL

    • ‘ASSIGNED_ONLY` - ASSIGNED_ONLY

    • ‘TEAM_ONLY` - TEAM_ONLY



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

def ticket_access
  @ticket_access
end

#ticket_actions ⇒ Array<Merge::Ticketing::TicketActionsEnum> (readonly)

Returns The set of actions that a User with this Role can perform. Possible enum values include: ‘VIEW`, `CREATE`, `EDIT`, `DELETE`, `CLOSE`, and `ASSIGN`.

Returns:

  • (Array<Merge::Ticketing::TicketActionsEnum>) —

    The set of actions that a User with this Role can perform. Possible enum values include: ‘VIEW`, `CREATE`, `EDIT`, `DELETE`, `CLOSE`, and `ASSIGN`.



31
32
33
 
# File 'lib/merge_ruby_client/ticketing/types/role.rb', line 31

def ticket_actions
  @ticket_actions
end

Class Method Details

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

Deserialize a JSON object to an instance of Role

Parameters:

  • json_object (String)

Returns:



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
 
# File 'lib/merge_ruby_client/ticketing/types/role.rb', line 102

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


146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/merge_ruby_client/ticketing/types/role.rb', line 146

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.ticket_actions&.is_a?(Array) != false || raise("Passed value for field obj.ticket_actions is not the expected type, validation failed.")
  obj.ticket_access&.is_a?(Merge::Ticketing::TicketAccessEnum) != false || raise("Passed value for field obj.ticket_access 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 Role to a JSON object

Returns:

  • (String) 


136
137
138
 
# File 'lib/merge_ruby_client/ticketing/types/role.rb', line 136

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