Class: ModernTreasury::PaymentReference

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/modern_treasury/models/payment_reference.rb

Overview

PaymentReference Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(id:, object:, live_mode:, created_at:, updated_at:, reference_number:, reference_number_type:) ⇒ PaymentReference

Returns a new instance of PaymentReference.



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 67

def initialize(id:, object:, live_mode:, created_at:, updated_at:,
               reference_number:, reference_number_type:)
  @id = id
  @object = object
  @live_mode = live_mode
  @created_at = created_at
  @updated_at = updated_at
  @reference_number = reference_number
  @reference_number_type = reference_number_type
end

Instance Attribute Details

#created_at ⇒ DateTime

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Returns:

  • (DateTime) 


29
30
31
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 29

def created_at
  @created_at
end

#id ⇒ UUID | String

TODO: Write general description for this method

Returns:

  • (UUID | String) 


15
16
17
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 15

def id
  @id
end

#live_mode ⇒ TrueClass | FalseClass

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Returns:

  • (TrueClass | FalseClass) 


24
25
26
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 24

def live_mode
  @live_mode
end

#object ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


19
20
21
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 19

def object
  @object
end

#reference_number ⇒ String

The vendor reference number.

Returns:

  • (String) 


38
39
40
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 38

def reference_number
  @reference_number
end

#reference_number_type ⇒ ReferenceNumberType

The type of the reference number. Referring to the vendor payment id.

Returns:



42
43
44
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 42

def reference_number_type
  @reference_number_type
end

#updated_at ⇒ DateTime

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Returns:

  • (DateTime) 


34
35
36
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 34

def updated_at
  @updated_at
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
104
105
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 79

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : nil
  object = hash.key?('object') ? hash['object'] : nil
  live_mode = hash.key?('live_mode') ? hash['live_mode'] : nil
  created_at = if hash.key?('created_at')
                 (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
               end
  updated_at = if hash.key?('updated_at')
                 (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
               end
  reference_number =
    hash.key?('reference_number') ? hash['reference_number'] : nil
  reference_number_type =
    hash.key?('reference_number_type') ? hash['reference_number_type'] : nil

  # Create object from extracted values.
  PaymentReference.new(id: id,
                       object: object,
                       live_mode: live_mode,
                       created_at: created_at,
                       updated_at: updated_at,
                       reference_number: reference_number,
                       reference_number_type: reference_number_type)
end

.names ⇒ Object

A mapping from model property names to API property names.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 45

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['object'] = 'object'
  @_hash['live_mode'] = 'live_mode'
  @_hash['created_at'] = 'created_at'
  @_hash['updated_at'] = 'updated_at'
  @_hash['reference_number'] = 'reference_number'
  @_hash['reference_number_type'] = 'reference_number_type'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



63
64
65
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 63

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



58
59
60
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 58

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



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
152
153
154
155
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 117

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.id,
                            ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.object,
                              ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.live_mode,
                              ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
        APIHelper.valid_type?(value.created_at,
                              ->(val) { val.instance_of? DateTime }) and
        APIHelper.valid_type?(value.updated_at,
                              ->(val) { val.instance_of? DateTime }) and
        APIHelper.valid_type?(value.reference_number,
                              ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.reference_number_type,
                              ->(val) { ReferenceNumberType.validate(val) })
    )
  end

  return false unless value.instance_of? Hash

  (
    APIHelper.valid_type?(value['id'],
                          ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['object'],
                            ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['live_mode'],
                            ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
      APIHelper.valid_type?(value['created_at'],
                            ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['updated_at'],
                            ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['reference_number'],
                            ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['reference_number_type'],
                            ->(val) { ReferenceNumberType.validate(val) })
  )
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



166
167
168
169
170
171
172
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 166

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id.inspect}, object: #{@object.inspect}, live_mode:"\
  " #{@live_mode.inspect}, created_at: #{@created_at.inspect}, updated_at:"\
  " #{@updated_at.inspect}, reference_number: #{@reference_number.inspect},"\
  " reference_number_type: #{@reference_number_type.inspect}>"
end

#to_custom_created_at ⇒ Object 



107
108
109
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 107

def to_custom_created_at
  DateTimeHelper.to_rfc3339(created_at)
end

#to_custom_updated_at ⇒ Object 



111
112
113
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 111

def to_custom_updated_at
  DateTimeHelper.to_rfc3339(updated_at)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



158
159
160
161
162
163
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 158

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id}, object: #{@object}, live_mode: #{@live_mode}, created_at:"\
  " #{@created_at}, updated_at: #{@updated_at}, reference_number: #{@reference_number},"\
  " reference_number_type: #{@reference_number_type}>"
end