maxio-advanced-billing-sdk 5.2.0 → 6.0.0

data/lib/advanced_billing/models/invoice.rb

@@ -221,6 +221,11 @@ module AdvancedBilling
     # @return [String]
     attr_accessor :credit_amount
 
+    # The amount of credit (from credit notes) applied to this invoice.
+    # Credits offset the amount due from the customer.
+    # @return [String]
+    attr_accessor :debit_amount
+
     # The amount of credit (from credit notes) applied to this invoice.
     # Credits offset the amount due from the customer.
     # @return [String]
@@ -251,6 +256,10 @@ module AdvancedBilling
     # @return [Array[InvoiceCredit]]
     attr_accessor :credits
 
+    # Line items on the invoice.
+    # @return [Array[InvoiceDebit]]
+    attr_accessor :debits
+
     # Line items on the invoice.
     # @return [Array[InvoiceRefund]]
     attr_accessor :refunds
@@ -267,6 +276,10 @@ module AdvancedBilling
     # @return [InvoiceDisplaySettings]
     attr_accessor :display_settings
 
+    # Line items on the invoice.
+    # @return [InvoiceAvataxDetails]
+    attr_accessor :avatax_details
+
     # The public URL of the invoice
     # @return [String]
     attr_accessor :public_url
@@ -322,6 +335,7 @@ module AdvancedBilling
       @_hash['tax_amount'] = 'tax_amount'
       @_hash['total_amount'] = 'total_amount'
       @_hash['credit_amount'] = 'credit_amount'
+      @_hash['debit_amount'] = 'debit_amount'
       @_hash['refund_amount'] = 'refund_amount'
       @_hash['paid_amount'] = 'paid_amount'
       @_hash['due_amount'] = 'due_amount'
@@ -329,10 +343,12 @@ module AdvancedBilling
       @_hash['discounts'] = 'discounts'
       @_hash['taxes'] = 'taxes'
       @_hash['credits'] = 'credits'
+      @_hash['debits'] = 'debits'
       @_hash['refunds'] = 'refunds'
       @_hash['payments'] = 'payments'
       @_hash['custom_fields'] = 'custom_fields'
       @_hash['display_settings'] = 'display_settings'
+      @_hash['avatax_details'] = 'avatax_details'
       @_hash['public_url'] = 'public_url'
       @_hash['previous_balance_data'] = 'previous_balance_data'
       @_hash['public_url_expires_on'] = 'public_url_expires_on'
@@ -381,6 +397,7 @@ module AdvancedBilling
         tax_amount
         total_amount
         credit_amount
+        debit_amount
         refund_amount
         paid_amount
         due_amount
@@ -388,10 +405,12 @@ module AdvancedBilling
         discounts
         taxes
         credits
+        debits
         refunds
         payments
         custom_fields
         display_settings
+        avatax_details
         public_url
         previous_balance_data
         public_url_expires_on
@@ -425,12 +444,18 @@ module AdvancedBilling
                    memo: SKIP, billing_address: SKIP, shipping_address: SKIP,
                    subtotal_amount: SKIP, discount_amount: SKIP,
                    tax_amount: SKIP, total_amount: SKIP, credit_amount: SKIP,
-                   refund_amount: SKIP, paid_amount: SKIP, due_amount: SKIP,
-                   line_items: SKIP, discounts: SKIP, taxes: SKIP,
-                   credits: SKIP, refunds: SKIP, payments: SKIP,
-                   custom_fields: SKIP, display_settings: SKIP,
-                   public_url: SKIP, previous_balance_data: SKIP,
-                   public_url_expires_on: SKIP, additional_properties: {})
+                   debit_amount: SKIP, refund_amount: SKIP, paid_amount: SKIP,
+                   due_amount: SKIP, line_items: SKIP, discounts: SKIP,
+                   taxes: SKIP, credits: SKIP, debits: SKIP, refunds: SKIP,
+                   payments: SKIP, custom_fields: SKIP, display_settings: SKIP,
+                   avatax_details: SKIP, public_url: SKIP,
+                   previous_balance_data: SKIP, public_url_expires_on: SKIP,
+                   additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @id = id unless id == SKIP
       @uid = uid unless uid == SKIP
       @site_id = site_id unless site_id == SKIP
@@ -473,6 +498,7 @@ module AdvancedBilling
       @tax_amount = tax_amount unless tax_amount == SKIP
       @total_amount = total_amount unless total_amount == SKIP
       @credit_amount = credit_amount unless credit_amount == SKIP
+      @debit_amount = debit_amount unless debit_amount == SKIP
       @refund_amount = refund_amount unless refund_amount == SKIP
       @paid_amount = paid_amount unless paid_amount == SKIP
       @due_amount = due_amount unless due_amount == SKIP
@@ -480,18 +506,15 @@ module AdvancedBilling
       @discounts = discounts unless discounts == SKIP
       @taxes = taxes unless taxes == SKIP
       @credits = credits unless credits == SKIP
+      @debits = debits unless debits == SKIP
       @refunds = refunds unless refunds == SKIP
       @payments = payments unless payments == SKIP
       @custom_fields = custom_fields unless custom_fields == SKIP
       @display_settings = display_settings unless display_settings == SKIP
+      @avatax_details = avatax_details unless avatax_details == SKIP
       @public_url = public_url unless public_url == SKIP
       @previous_balance_data = previous_balance_data unless previous_balance_data == SKIP
       @public_url_expires_on = public_url_expires_on unless public_url_expires_on == SKIP
-
-      # Add additional model properties to the instance.
-      additional_properties.each do |_name, _value|
-        instance_variable_set("@#{_name}", _value)
-      end
     end
 
     # Creates an instance of the object from a hash.
@@ -566,6 +589,7 @@ module AdvancedBilling
       tax_amount = hash.key?('tax_amount') ? hash['tax_amount'] : SKIP
       total_amount = hash.key?('total_amount') ? hash['total_amount'] : SKIP
       credit_amount = hash.key?('credit_amount') ? hash['credit_amount'] : SKIP
+      debit_amount = hash.key?('debit_amount') ? hash['debit_amount'] : SKIP
       refund_amount = hash.key?('refund_amount') ? hash['refund_amount'] : SKIP
       paid_amount = hash.key?('paid_amount') ? hash['paid_amount'] : SKIP
       due_amount = hash.key?('due_amount') ? hash['due_amount'] : SKIP
@@ -610,6 +634,16 @@ module AdvancedBilling
 
       credits = SKIP unless hash.key?('credits')
       # Parameter is an array, so we need to iterate through it
+      debits = nil
+      unless hash['debits'].nil?
+        debits = []
+        hash['debits'].each do |structure|
+          debits << (InvoiceDebit.from_hash(structure) if structure)
+        end
+      end
+
+      debits = SKIP unless hash.key?('debits')
+      # Parameter is an array, so we need to iterate through it
       refunds = nil
       unless hash['refunds'].nil?
         refunds = []
@@ -641,6 +675,8 @@ module AdvancedBilling
       custom_fields = SKIP unless hash.key?('custom_fields')
       display_settings = InvoiceDisplaySettings.from_hash(hash['display_settings']) if
         hash['display_settings']
+      avatax_details = InvoiceAvataxDetails.from_hash(hash['avatax_details']) if
+        hash['avatax_details']
       public_url = hash.key?('public_url') ? hash['public_url'] : SKIP
       previous_balance_data = InvoicePreviousBalance.from_hash(hash['previous_balance_data']) if
         hash['previous_balance_data']
@@ -648,7 +684,7 @@ module AdvancedBilling
         hash.key?('public_url_expires_on') ? hash['public_url_expires_on'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       Invoice.new(id: id,
@@ -690,6 +726,7 @@ module AdvancedBilling
                   tax_amount: tax_amount,
                   total_amount: total_amount,
                   credit_amount: credit_amount,
+                  debit_amount: debit_amount,
                   refund_amount: refund_amount,
                   paid_amount: paid_amount,
                   due_amount: due_amount,
@@ -697,14 +734,16 @@ module AdvancedBilling
                   discounts: discounts,
                   taxes: taxes,
                   credits: credits,
+                  debits: debits,
                   refunds: refunds,
                   payments: payments,
                   custom_fields: custom_fields,
                   display_settings: display_settings,
+                  avatax_details: avatax_details,
                   public_url: public_url,
                   previous_balance_data: previous_balance_data,
                   public_url_expires_on: public_url_expires_on,
-                  additional_properties: hash)
+                  additional_properties: additional_properties)
     end
 
     def to_custom_transaction_time

data/lib/advanced_billing/models/invoice_address.rb

@@ -71,17 +71,17 @@ module AdvancedBilling
 
     def initialize(street: SKIP, line2: SKIP, city: SKIP, state: SKIP,
                    zip: SKIP, country: SKIP, additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @street = street unless street == SKIP
       @line2 = line2 unless line2 == SKIP
       @city = city unless city == SKIP
       @state = state unless state == SKIP
       @zip = zip unless zip == SKIP
       @country = country unless country == SKIP
-
-      # Add additional model properties to the instance.
-      additional_properties.each do |_name, _value|
-        instance_variable_set("@#{_name}", _value)
-      end
     end
 
     # Creates an instance of the object from a hash.
@@ -97,7 +97,7 @@ module AdvancedBilling
       country = hash.key?('country') ? hash['country'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       InvoiceAddress.new(street: street,
@@ -106,7 +106,7 @@ module AdvancedBilling
                          state: state,
                          zip: zip,
                          country: country,
-                         additional_properties: hash)
+                         additional_properties: additional_properties)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/invoice_avatax_details.rb

@@ -0,0 +1,130 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # InvoiceAvataxDetails Model.
+  class InvoiceAvataxDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :document_code
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :commit_date
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :modify_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['status'] = 'status'
+      @_hash['document_code'] = 'document_code'
+      @_hash['commit_date'] = 'commit_date'
+      @_hash['modify_date'] = 'modify_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        status
+        document_code
+        commit_date
+        modify_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        id
+        status
+        document_code
+        commit_date
+        modify_date
+      ]
+    end
+
+    def initialize(id: SKIP, status: SKIP, document_code: SKIP,
+                   commit_date: SKIP, modify_date: SKIP,
+                   additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @id = id unless id == SKIP
+      @status = status unless status == SKIP
+      @document_code = document_code unless document_code == SKIP
+      @commit_date = commit_date unless commit_date == SKIP
+      @modify_date = modify_date unless modify_date == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      document_code = hash.key?('document_code') ? hash['document_code'] : SKIP
+      commit_date = if hash.key?('commit_date')
+                      (DateTimeHelper.from_rfc3339(hash['commit_date']) if hash['commit_date'])
+                    else
+                      SKIP
+                    end
+      modify_date = if hash.key?('modify_date')
+                      (DateTimeHelper.from_rfc3339(hash['modify_date']) if hash['modify_date'])
+                    else
+                      SKIP
+                    end
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      InvoiceAvataxDetails.new(id: id,
+                               status: status,
+                               document_code: document_code,
+                               commit_date: commit_date,
+                               modify_date: modify_date,
+                               additional_properties: additional_properties)
+    end
+
+    def to_custom_commit_date
+      DateTimeHelper.to_rfc3339(commit_date)
+    end
+
+    def to_custom_modify_date
+      DateTimeHelper.to_rfc3339(modify_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceAvataxDetails | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_balance_item.rb

@@ -46,14 +46,14 @@ module AdvancedBilling
 
     def initialize(uid: SKIP, number: SKIP, outstanding_amount: SKIP,
                    additional_properties: {})
-      @uid = uid unless uid == SKIP
-      @number = number unless number == SKIP
-      @outstanding_amount = outstanding_amount unless outstanding_amount == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @uid = uid unless uid == SKIP
+      @number = number unless number == SKIP
+      @outstanding_amount = outstanding_amount unless outstanding_amount == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -67,13 +67,13 @@ module AdvancedBilling
         hash.key?('outstanding_amount') ? hash['outstanding_amount'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       InvoiceBalanceItem.new(uid: uid,
                              number: number,
                              outstanding_amount: outstanding_amount,
-                             additional_properties: hash)
+                             additional_properties: additional_properties)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/invoice_credit.rb

@@ -72,6 +72,11 @@ module AdvancedBilling
     def initialize(uid: SKIP, credit_note_number: SKIP, credit_note_uid: SKIP,
                    transaction_time: SKIP, memo: SKIP, original_amount: SKIP,
                    applied_amount: SKIP, additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @uid = uid unless uid == SKIP
       @credit_note_number = credit_note_number unless credit_note_number == SKIP
       @credit_note_uid = credit_note_uid unless credit_note_uid == SKIP
@@ -79,11 +84,6 @@ module AdvancedBilling
       @memo = memo unless memo == SKIP
       @original_amount = original_amount unless original_amount == SKIP
       @applied_amount = applied_amount unless applied_amount == SKIP
-
-      # Add additional model properties to the instance.
-      additional_properties.each do |_name, _value|
-        instance_variable_set("@#{_name}", _value)
-      end
     end
 
     # Creates an instance of the object from a hash.
@@ -108,7 +108,7 @@ module AdvancedBilling
         hash.key?('applied_amount') ? hash['applied_amount'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       InvoiceCredit.new(uid: uid,
@@ -118,7 +118,7 @@ module AdvancedBilling
                         memo: memo,
                         original_amount: original_amount,
                         applied_amount: applied_amount,
-                        additional_properties: hash)
+                        additional_properties: additional_properties)
     end
 
     def to_custom_transaction_time

data/lib/advanced_billing/models/invoice_custom_field.rb

@@ -58,16 +58,16 @@ module AdvancedBilling
 
     def initialize(owner_id: SKIP, owner_type: SKIP, name: SKIP, value: SKIP,
                    metadatum_id: SKIP, additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @owner_id = owner_id unless owner_id == SKIP
       @owner_type = owner_type unless owner_type == SKIP
       @name = name unless name == SKIP
       @value = value unless value == SKIP
       @metadatum_id = metadatum_id unless metadatum_id == SKIP
-
-      # Add additional model properties to the instance.
-      additional_properties.each do |_name, _value|
-        instance_variable_set("@#{_name}", _value)
-      end
     end
 
     # Creates an instance of the object from a hash.
@@ -82,7 +82,7 @@ module AdvancedBilling
       metadatum_id = hash.key?('metadatum_id') ? hash['metadatum_id'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       InvoiceCustomField.new(owner_id: owner_id,
@@ -90,7 +90,7 @@ module AdvancedBilling
                              name: name,
                              value: value,
                              metadatum_id: metadatum_id,
-                             additional_properties: hash)
+                             additional_properties: additional_properties)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/invoice_customer.rb

@@ -77,6 +77,11 @@ module AdvancedBilling
     def initialize(chargify_id: SKIP, first_name: SKIP, last_name: SKIP,
                    organization: SKIP, email: SKIP, vat_number: SKIP,
                    reference: SKIP, additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @chargify_id = chargify_id unless chargify_id == SKIP
       @first_name = first_name unless first_name == SKIP
       @last_name = last_name unless last_name == SKIP
@@ -84,11 +89,6 @@ module AdvancedBilling
       @email = email unless email == SKIP
       @vat_number = vat_number unless vat_number == SKIP
       @reference = reference unless reference == SKIP
-
-      # Add additional model properties to the instance.
-      additional_properties.each do |_name, _value|
-        instance_variable_set("@#{_name}", _value)
-      end
     end
 
     # Creates an instance of the object from a hash.
@@ -105,7 +105,7 @@ module AdvancedBilling
       reference = hash.key?('reference') ? hash['reference'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       InvoiceCustomer.new(chargify_id: chargify_id,
@@ -115,7 +115,7 @@ module AdvancedBilling
                           email: email,
                           vat_number: vat_number,
                           reference: reference,
-                          additional_properties: hash)
+                          additional_properties: additional_properties)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/invoice_debit.rb

@@ -0,0 +1,148 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # InvoiceDebit Model.
+  class InvoiceDebit < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :uid
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :debit_note_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :debit_note_uid
+
+    # The role of the debit note.
+    # @return [DebitNoteRole]
+    attr_accessor :role
+
+    # The role of the debit note.
+    # @return [DateTime]
+    attr_accessor :transaction_time
+
+    # The role of the debit note.
+    # @return [String]
+    attr_accessor :memo
+
+    # The role of the debit note.
+    # @return [String]
+    attr_accessor :original_amount
+
+    # The role of the debit note.
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['debit_note_number'] = 'debit_note_number'
+      @_hash['debit_note_uid'] = 'debit_note_uid'
+      @_hash['role'] = 'role'
+      @_hash['transaction_time'] = 'transaction_time'
+      @_hash['memo'] = 'memo'
+      @_hash['original_amount'] = 'original_amount'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        debit_note_number
+        debit_note_uid
+        role
+        transaction_time
+        memo
+        original_amount
+        applied_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid: SKIP, debit_note_number: SKIP, debit_note_uid: SKIP,
+                   role: SKIP, transaction_time: SKIP, memo: SKIP,
+                   original_amount: SKIP, applied_amount: SKIP,
+                   additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @uid = uid unless uid == SKIP
+      @debit_note_number = debit_note_number unless debit_note_number == SKIP
+      @debit_note_uid = debit_note_uid unless debit_note_uid == SKIP
+      @role = role unless role == SKIP
+      @transaction_time = transaction_time unless transaction_time == SKIP
+      @memo = memo unless memo == SKIP
+      @original_amount = original_amount unless original_amount == SKIP
+      @applied_amount = applied_amount unless applied_amount == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      uid = hash.key?('uid') ? hash['uid'] : SKIP
+      debit_note_number =
+        hash.key?('debit_note_number') ? hash['debit_note_number'] : SKIP
+      debit_note_uid =
+        hash.key?('debit_note_uid') ? hash['debit_note_uid'] : SKIP
+      role = hash.key?('role') ? hash['role'] : SKIP
+      transaction_time = if hash.key?('transaction_time')
+                           (DateTimeHelper.from_rfc3339(hash['transaction_time']) if hash['transaction_time'])
+                         else
+                           SKIP
+                         end
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      original_amount =
+        hash.key?('original_amount') ? hash['original_amount'] : SKIP
+      applied_amount =
+        hash.key?('applied_amount') ? hash['applied_amount'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      InvoiceDebit.new(uid: uid,
+                       debit_note_number: debit_note_number,
+                       debit_note_uid: debit_note_uid,
+                       role: role,
+                       transaction_time: transaction_time,
+                       memo: memo,
+                       original_amount: original_amount,
+                       applied_amount: applied_amount,
+                       additional_properties: additional_properties)
+    end
+
+    def to_custom_transaction_time
+      DateTimeHelper.to_rfc3339(transaction_time)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceDebit | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+  end
+end