Class: Merge::Accounting::PaymentMethod

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

Overview

# The PaymentMethod Object

### Description
The `PaymentMethod` object defines how a payment against an invoice is made.
### Usage Example
Fetch from the `GET PaymentMethod` endpoint and view payment method information.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method_type:, name:, id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, is_active: OMIT, remote_updated_at: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Accounting::PaymentMethod

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.

  • method_type (Merge::Accounting::MethodTypeEnum) —

    The type of the payment method.

    • ‘CREDIT_CARD` - CREDIT_CARD

    • ‘DEBIT_CARD` - DEBIT_CARD

    • ‘ACH` - ACH

    • ‘CASH` - CASH

    • ‘CHECK` - CHECK

  • name (String) —

    The payment method’s name

  • is_active (Boolean) (defaults to: OMIT) —

    ‘True` if the payment method is active, `False` if not.

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

    When the third party’s payment method was updated.

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Merge::Accounting::RemoteData>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



67
68
69
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
 
# File 'lib/merge_ruby_client/accounting/types/payment_method.rb', line 67

def initialize(method_type:, name:, id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT,
               is_active: OMIT, remote_updated_at: 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
  @method_type = method_type
  @name = name
  @is_active = is_active if is_active != OMIT
  @remote_updated_at = remote_updated_at if remote_updated_at != 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,
    "method_type": method_type,
    "name": name,
    "is_active": is_active,
    "remote_updated_at": remote_updated_at,
    "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



43
44
45
 
# File 'lib/merge_ruby_client/accounting/types/payment_method.rb', line 43

def additional_properties
  @additional_properties
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/accounting/types/payment_method.rb', line 22

def created_at
  @created_at
end

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

Returns:

  • (Hash{String => Object}) 


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

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

def id
  @id
end

#is_active ⇒ Boolean (readonly)

Returns ‘True` if the payment method is active, `False` if not.

Returns:

  • (Boolean) —

    ‘True` if the payment method is active, `False` if not.



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

def is_active
  @is_active
end

#method_type ⇒ Merge::Accounting::MethodTypeEnum (readonly)

Returns The type of the payment method.

  • ‘CREDIT_CARD` - CREDIT_CARD

  • ‘DEBIT_CARD` - DEBIT_CARD

  • ‘ACH` - ACH

  • ‘CASH` - CASH

  • ‘CHECK` - CHECK.

Returns:

  • (Merge::Accounting::MethodTypeEnum) —

    The type of the payment method.

    • ‘CREDIT_CARD` - CREDIT_CARD

    • ‘DEBIT_CARD` - DEBIT_CARD

    • ‘ACH` - ACH

    • ‘CASH` - CASH

    • ‘CHECK` - CHECK



31
32
33
 
# File 'lib/merge_ruby_client/accounting/types/payment_method.rb', line 31

def method_type
  @method_type
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/accounting/types/payment_method.rb', line 24

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The payment method’s name.

Returns:

  • (String) —

    The payment method’s name



33
34
35
 
# File 'lib/merge_ruby_client/accounting/types/payment_method.rb', line 33

def name
  @name
end

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

Returns:



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

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

def remote_id
  @remote_id
end

#remote_updated_at ⇒ DateTime (readonly)

Returns When the third party’s payment method was updated.

Returns:

  • (DateTime) —

    When the third party’s payment method was updated.



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

def remote_updated_at
  @remote_updated_at
end

Class Method Details

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

Deserialize a JSON object to an instance of PaymentMethod

Parameters:

  • json_object (String)

Returns:



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
126
127
128
129
130
131
 
# File 'lib/merge_ruby_client/accounting/types/payment_method.rb', line 100

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?)
  method_type = parsed_json["method_type"]
  name = parsed_json["name"]
  is_active = parsed_json["is_active"]
  remote_updated_at = unless parsed_json["remote_updated_at"].nil?
                        DateTime.parse(parsed_json["remote_updated_at"])
                      end
  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,
    method_type: method_type,
    name: name,
    is_active: is_active,
    remote_updated_at: remote_updated_at,
    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) 


146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/merge_ruby_client/accounting/types/payment_method.rb', line 146

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.method_type.is_a?(Merge::Accounting::MethodTypeEnum) != false || raise("Passed value for field obj.method_type 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.is_active&.is_a?(Boolean) != false || raise("Passed value for field obj.is_active is not the expected type, validation failed.")
  obj.remote_updated_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_updated_at 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 PaymentMethod to a JSON object

Returns:

  • (String) 


136
137
138
 
# File 'lib/merge_ruby_client/accounting/types/payment_method.rb', line 136

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