Class: Merge::Ticketing::Collection

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

Overview

# The Collection Object

### Description
The `Collection` object is used to represent one or more `Tickets`. There can be
a hierarchy of `Collections`, in which a sub-collection belongs to a
parent-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, description: OMIT, access_level: OMIT, collection_type: OMIT, parent_collection: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Ticketing::Collection

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

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

    The collection’s description.

  • access_level (Merge::Ticketing::CollectionAccessLevelEnum) (defaults to: OMIT) —

    The level of access a User has to the Collection and its sub-objects.

    • ‘PRIVATE` - PRIVATE

    • ‘COMPANY` - COMPANY

    • ‘PUBLIC` - PUBLIC

    • ‘PARENT_COLLECTION` - PARENT_COLLECTION

  • collection_type (Merge::Ticketing::CollectionTypeEnum) (defaults to: OMIT) —

    The collection’s type.

    • ‘LIST` - LIST

    • ‘PROJECT` - PROJECT

  • parent_collection (Merge::Ticketing::CollectionParentCollection) (defaults to: OMIT) —

    The parent collection for this collection.

  • 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



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
110
111
112
113
114
115
116
 
# File 'lib/merge_ruby_client/ticketing/types/collection.rb', line 85

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

#access_level ⇒ Merge::Ticketing::CollectionAccessLevelEnum (readonly)

Returns The level of access a User has to the Collection and its sub-objects.

  • ‘PRIVATE` - PRIVATE

  • ‘COMPANY` - COMPANY

  • ‘PUBLIC` - PUBLIC

  • ‘PARENT_COLLECTION` - PARENT_COLLECTION.

Returns:

  • (Merge::Ticketing::CollectionAccessLevelEnum) —

    The level of access a User has to the Collection and its sub-objects.

    • ‘PRIVATE` - PRIVATE

    • ‘COMPANY` - COMPANY

    • ‘PUBLIC` - PUBLIC

    • ‘PARENT_COLLECTION` - PARENT_COLLECTION



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

def access_level
  @access_level
end

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



55
56
57
 
# File 'lib/merge_ruby_client/ticketing/types/collection.rb', line 55

def additional_properties
  @additional_properties
end

#collection_type ⇒ Merge::Ticketing::CollectionTypeEnum (readonly)

Returns The collection’s type.

  • ‘LIST` - LIST

  • ‘PROJECT` - PROJECT.

Returns:



42
43
44
 
# File 'lib/merge_ruby_client/ticketing/types/collection.rb', line 42

def collection_type
  @collection_type
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/collection.rb', line 26

def created_at
  @created_at
end

#description ⇒ String (readonly)

Returns The collection’s description.

Returns:

  • (String) —

    The collection’s description.



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

def description
  @description
end

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

Returns:

  • (Hash{String => Object}) 


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

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

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.



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

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The collection’s name.

Returns:

  • (String) —

    The collection’s name.



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

def name
  @name
end

#parent_collection ⇒ Merge::Ticketing::CollectionParentCollection (readonly)

Returns The parent collection for this collection.

Returns:



44
45
46
 
# File 'lib/merge_ruby_client/ticketing/types/collection.rb', line 44

def parent_collection
  @parent_collection
end

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

Returns:



53
54
55
 
# File 'lib/merge_ruby_client/ticketing/types/collection.rb', line 53

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



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

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

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

Deserialize a JSON object to an instance of Collection

Parameters:

  • json_object (String)

Returns:



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
157
158
159
160
 
# File 'lib/merge_ruby_client/ticketing/types/collection.rb', line 122

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"]
  description = parsed_json["description"]
  access_level = parsed_json["access_level"]
  collection_type = parsed_json["collection_type"]
  if parsed_json["parent_collection"].nil?
    parent_collection = nil
  else
    parent_collection = parsed_json["parent_collection"].to_json
    parent_collection = Merge::Ticketing::CollectionParentCollection.from_json(json_object: parent_collection)
  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::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,
    description: description,
    access_level: access_level,
    collection_type: collection_type,
    parent_collection: parent_collection,
    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) 


175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/merge_ruby_client/ticketing/types/collection.rb', line 175

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.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
  obj.access_level&.is_a?(Merge::Ticketing::CollectionAccessLevelEnum) != false || raise("Passed value for field obj.access_level is not the expected type, validation failed.")
  obj.collection_type&.is_a?(Merge::Ticketing::CollectionTypeEnum) != false || raise("Passed value for field obj.collection_type is not the expected type, validation failed.")
  obj.parent_collection.nil? || Merge::Ticketing::CollectionParentCollection.validate_raw(obj: obj.parent_collection)
  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 Collection to a JSON object

Returns:

  • (String) 


165
166
167
 
# File 'lib/merge_ruby_client/ticketing/types/collection.rb', line 165

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