Class: Merge::Accounting::AccountingAttachment

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/accounting/types/accounting_attachment.rb

Overview

The Accounting Attachment Object

Description

The AccountingAttachment object is used to represent a company's attachments.

Usage Example

Fetch from the LIST AccountingAttachments endpoint and view a company's attachments.

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, file_url: OMIT, company: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Accounting::AccountingAttachment 



63
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
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 63

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



41
42
43
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 41

def additional_properties
  @additional_properties
end

#company ⇒ String (readonly) 



30
31
32
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 30

def company
  @company
end

#created_at ⇒ DateTime (readonly) 



22
23
24
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 22

def created_at
  @created_at
end

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



37
38
39
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 37

def field_mappings
  @field_mappings
end

#file_name ⇒ String (readonly) 



26
27
28
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 26

def file_name
  @file_name
end

#file_url ⇒ String (readonly) 



28
29
30
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 28

def file_url
  @file_url
end

#id ⇒ String (readonly) 



18
19
20
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 18

def id
  @id
end

#modified_at ⇒ DateTime (readonly) 



24
25
26
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 24

def modified_at
  @modified_at
end

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



39
40
41
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 39

def remote_data
  @remote_data
end

#remote_id ⇒ String (readonly) 



20
21
22
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 20

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly) 



35
36
37
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 35

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Accounting::AccountingAttachment

Deserialize a JSON object to an instance of AccountingAttachment



96
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
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 96

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"]
  file_url = parsed_json["file_url"]
  company = parsed_json["company"]
  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::Accounting::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,
    file_url: file_url,
    company: company,
    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.



140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 140

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



130
131
132
 
# File 'lib/merge_ruby_client/accounting/types/accounting_attachment.rb', line 130

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