Class: Merge::Ticketing::Attachment

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

Overview

# The Attachment Object

### Description
The `Attachment` object is used to represent an attachment for a ticket.
### 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, file_name: OMIT, ticket: OMIT, file_url: OMIT, content_type: OMIT, uploaded_by: OMIT, remote_created_at: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Ticketing::Attachment

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.

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

    The attachment’s name. It is required to include the file extension in the attachment’s name.

  • ticket (Merge::Ticketing::AttachmentTicket) (defaults to: OMIT) —

    The ticket associated with the attachment.

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

    The attachment’s url. It is required to include the file extension in the file’s URL.

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

    The attachment’s file format.

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

    The user who uploaded the attachment.

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

    When the third party’s attachment was created.

  • remote_was_deleted (Boolean) (defaults to: OMIT)
  • 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



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
97
98
99
100
101
102
103
 
# File 'lib/merge_ruby_client/ticketing/types/attachment.rb', line 70

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, file_name: OMIT, ticket: OMIT,
               file_url: OMIT, content_type: OMIT, uploaded_by: OMIT, remote_created_at: 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
  @file_name = file_name if file_name != OMIT
  @ticket = ticket if ticket != OMIT
  @file_url = file_url if file_url != OMIT
  @content_type = content_type if content_type != OMIT
  @uploaded_by = uploaded_by if uploaded_by != OMIT
  @remote_created_at = remote_created_at if remote_created_at != 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,
    "file_name": file_name,
    "ticket": ticket,
    "file_url": file_url,
    "content_type": content_type,
    "uploaded_by": uploaded_by,
    "remote_created_at": remote_created_at,
    "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



46
47
48
 
# File 'lib/merge_ruby_client/ticketing/types/attachment.rb', line 46

def additional_properties
  @additional_properties
end

#content_type ⇒ String (readonly)

Returns The attachment’s file format.

Returns:

  • (String) —

    The attachment’s file format.



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

def content_type
  @content_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.



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

def created_at
  @created_at
end

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

Returns:

  • (Hash{String => Object}) 


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

def field_mappings
  @field_mappings
end

#file_name ⇒ String (readonly)

Returns The attachment’s name. It is required to include the file extension in the attachment’s name.

Returns:

  • (String) —

    The attachment’s name. It is required to include the file extension in the attachment’s name.



27
28
29
 
# File 'lib/merge_ruby_client/ticketing/types/attachment.rb', line 27

def file_name
  @file_name
end

#file_url ⇒ String (readonly)

Returns The attachment’s url. It is required to include the file extension in the file’s URL.

Returns:

  • (String) —

    The attachment’s url. It is required to include the file extension in the file’s URL.



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

def file_url
  @file_url
end

#id ⇒ String (readonly)

Returns:

  • (String) 


18
19
20
 
# File 'lib/merge_ruby_client/ticketing/types/attachment.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/ticketing/types/attachment.rb', line 24

def modified_at
  @modified_at
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the third party’s attachment was created.

Returns:

  • (DateTime) —

    When the third party’s attachment was created.



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

def remote_created_at
  @remote_created_at
end

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

Returns:



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

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

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


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

def remote_was_deleted
  @remote_was_deleted
end

#ticket ⇒ Merge::Ticketing::AttachmentTicket (readonly)

Returns The ticket associated with the attachment.

Returns:



29
30
31
 
# File 'lib/merge_ruby_client/ticketing/types/attachment.rb', line 29

def ticket
  @ticket
end

#uploaded_by ⇒ String (readonly)

Returns The user who uploaded the attachment.

Returns:

  • (String) —

    The user who uploaded the attachment.



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

def uploaded_by
  @uploaded_by
end

Class Method Details

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

Deserialize a JSON object to an instance of Attachment

Parameters:

  • json_object (String)

Returns:



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

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?)
  file_name = parsed_json["file_name"]
  if parsed_json["ticket"].nil?
    ticket = nil
  else
    ticket = parsed_json["ticket"].to_json
    ticket = Merge::Ticketing::AttachmentTicket.from_json(json_object: ticket)
  end
  file_url = parsed_json["file_url"]
  content_type = parsed_json["content_type"]
  uploaded_by = parsed_json["uploaded_by"]
  remote_created_at = unless parsed_json["remote_created_at"].nil?
                        DateTime.parse(parsed_json["remote_created_at"])
                      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,
    file_name: file_name,
    ticket: ticket,
    file_url: file_url,
    content_type: content_type,
    uploaded_by: uploaded_by,
    remote_created_at: remote_created_at,
    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) 


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/merge_ruby_client/ticketing/types/attachment.rb', line 166

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.file_name&.is_a?(String) != false || raise("Passed value for field obj.file_name is not the expected type, validation failed.")
  obj.ticket.nil? || Merge::Ticketing::AttachmentTicket.validate_raw(obj: obj.ticket)
  obj.file_url&.is_a?(String) != false || raise("Passed value for field obj.file_url is not the expected type, validation failed.")
  obj.content_type&.is_a?(String) != false || raise("Passed value for field obj.content_type is not the expected type, validation failed.")
  obj.uploaded_by&.is_a?(String) != false || raise("Passed value for field obj.uploaded_by 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.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 Attachment to a JSON object

Returns:

  • (String) 


156
157
158
 
# File 'lib/merge_ruby_client/ticketing/types/attachment.rb', line 156

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