Class: Merge::Accounting::VendorCreditApplyLineForVendorCreditRequest

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

Overview

The VendorCreditApplyLine Object

Description

The VendorCreditApplyLine object is used to represent a applied vendor credit.

Usage Example

Fetch from the GET VendorCredit endpoint and view the vendor credit's applied to lines.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(remote_id: OMIT, invoice: OMIT, applied_date: OMIT, applied_amount: OMIT, integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil) ⇒ Merge::Accounting::VendorCreditApplyLineForVendorCreditRequest 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_apply_line_for_vendor_credit_request.rb', line 45

def initialize(remote_id: OMIT, invoice: OMIT, applied_date: OMIT, applied_amount: OMIT,
               integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil)
  @remote_id = remote_id if remote_id != OMIT
  @invoice = invoice if invoice != OMIT
  @applied_date = applied_date if applied_date != OMIT
  @applied_amount = applied_amount if applied_amount != OMIT
  @integration_params = integration_params if integration_params != OMIT
   =  if  != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "remote_id": remote_id,
    "invoice": invoice,
    "applied_date": applied_date,
    "applied_amount": applied_amount,
    "integration_params": integration_params,
    "linked_account_params": 
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly) 



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

def additional_properties
  @additional_properties
end

#applied_amount ⇒ String (readonly) 



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

def applied_amount
  @applied_amount
end

#applied_date ⇒ DateTime (readonly) 



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

def applied_date
  @applied_date
end

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



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

def integration_params
  @integration_params
end

#invoice ⇒ Merge::Accounting::VendorCreditApplyLineForVendorCreditRequestInvoice (readonly) 



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

def invoice
  @invoice
end

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



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

def 
  
end

#remote_id ⇒ String (readonly) 



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

def remote_id
  @remote_id
end

Class Method Details

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

Deserialize a JSON object to an instance of VendorCreditApplyLineForVendorCreditRequest



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  remote_id = parsed_json["remote_id"]
  if parsed_json["invoice"].nil?
    invoice = nil
  else
    invoice = parsed_json["invoice"].to_json
    invoice = Merge::Accounting::VendorCreditApplyLineForVendorCreditRequestInvoice.from_json(json_object: invoice)
  end
  applied_date = (DateTime.parse(parsed_json["applied_date"]) unless parsed_json["applied_date"].nil?)
  applied_amount = parsed_json["applied_amount"]
  integration_params = parsed_json["integration_params"]
   = parsed_json["linked_account_params"]
  new(
    remote_id: remote_id,
    invoice: invoice,
    applied_date: applied_date,
    applied_amount: applied_amount,
    integration_params: integration_params,
    linked_account_params: ,
    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.



110
111
112
113
114
115
116
117
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_apply_line_for_vendor_credit_request.rb', line 110

def self.validate_raw(obj:)
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.invoice.nil? || Merge::Accounting::VendorCreditApplyLineForVendorCreditRequestInvoice.validate_raw(obj: obj.invoice)
  obj.applied_date&.is_a?(DateTime) != false || raise("Passed value for field obj.applied_date is not the expected type, validation failed.")
  obj.applied_amount&.is_a?(String) != false || raise("Passed value for field obj.applied_amount is not the expected type, validation failed.")
  obj.integration_params&.is_a?(Hash) != false || raise("Passed value for field obj.integration_params is not the expected type, validation failed.")
  obj.&.is_a?(Hash) != false || raise("Passed value for field obj.linked_account_params is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of VendorCreditApplyLineForVendorCreditRequest to a JSON object



100
101
102
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_apply_line_for_vendor_credit_request.rb', line 100

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