maxio-advanced-billing-sdk 2.0.0 → 3.0.0

data/lib/advanced_billing/models/applied_credit_note_data.rb

@@ -66,5 +66,15 @@ module AdvancedBilling
                                 number,
                                 hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [AppliedCreditNoteData | 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/apply_credit_note_event.rb

@@ -0,0 +1,139 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # ApplyCreditNoteEvent Model.
+  class ApplyCreditNoteEvent < 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 [DateTime]
+    attr_accessor :timestamp
+
+    # TODO: Write general description for this method
+    # @return [Invoice]
+    attr_accessor :invoice
+
+    # TODO: Write general description for this method
+    # @return [InvoiceEventType]
+    attr_accessor :event_type
+
+    # Example schema for an `apply_credit_note` event
+    # @return [ApplyCreditNoteEventData]
+    attr_accessor :event_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['invoice'] = 'invoice'
+      @_hash['event_type'] = 'event_type'
+      @_hash['event_data'] = 'event_data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   timestamp = nil,
+                   invoice = nil,
+                   event_type = InvoiceEventType::APPLY_CREDIT_NOTE,
+                   event_data = nil,
+                   additional_properties = {})
+      @id = id
+      @timestamp = timestamp
+      @invoice = invoice
+      @event_type = event_type
+      @event_data = event_data
+
+      # 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.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      invoice = Invoice.from_hash(hash['invoice']) if hash['invoice']
+      event_type = hash['event_type'] ||= InvoiceEventType::APPLY_CREDIT_NOTE
+      event_data = ApplyCreditNoteEventData.from_hash(hash['event_data']) if hash['event_data']
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      ApplyCreditNoteEvent.new(id,
+                               timestamp,
+                               invoice,
+                               event_type,
+                               event_data,
+                               hash)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ApplyCreditNoteEvent | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.timestamp,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.invoice,
+                                  ->(val) { Invoice.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.event_type,
+                                  ->(val) { InvoiceEventType.validate(val) }) and
+            APIHelper.valid_type?(value.event_data,
+                                  ->(val) { ApplyCreditNoteEventData.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['timestamp'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['invoice'],
+                                ->(val) { Invoice.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['event_type'],
+                                ->(val) { InvoiceEventType.validate(val) }) and
+          APIHelper.valid_type?(value['event_data'],
+                                ->(val) { ApplyCreditNoteEventData.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/apply_credit_note_event_data.rb

@@ -85,7 +85,9 @@ module AdvancedBilling
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        memo
+      ]
     end
 
     def initialize(uid = nil,

data/lib/advanced_billing/models/apply_debit_note_event.rb

@@ -0,0 +1,139 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # ApplyDebitNoteEvent Model.
+  class ApplyDebitNoteEvent < 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 [DateTime]
+    attr_accessor :timestamp
+
+    # TODO: Write general description for this method
+    # @return [Invoice]
+    attr_accessor :invoice
+
+    # TODO: Write general description for this method
+    # @return [InvoiceEventType]
+    attr_accessor :event_type
+
+    # Example schema for an `apply_debit_note` event
+    # @return [ApplyDebitNoteEventData]
+    attr_accessor :event_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['invoice'] = 'invoice'
+      @_hash['event_type'] = 'event_type'
+      @_hash['event_data'] = 'event_data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   timestamp = nil,
+                   invoice = nil,
+                   event_type = InvoiceEventType::APPLY_DEBIT_NOTE,
+                   event_data = nil,
+                   additional_properties = {})
+      @id = id
+      @timestamp = timestamp
+      @invoice = invoice
+      @event_type = event_type
+      @event_data = event_data
+
+      # 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.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      invoice = Invoice.from_hash(hash['invoice']) if hash['invoice']
+      event_type = hash['event_type'] ||= InvoiceEventType::APPLY_DEBIT_NOTE
+      event_data = ApplyDebitNoteEventData.from_hash(hash['event_data']) if hash['event_data']
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      ApplyDebitNoteEvent.new(id,
+                              timestamp,
+                              invoice,
+                              event_type,
+                              event_data,
+                              hash)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ApplyDebitNoteEvent | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.timestamp,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.invoice,
+                                  ->(val) { Invoice.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.event_type,
+                                  ->(val) { InvoiceEventType.validate(val) }) and
+            APIHelper.valid_type?(value.event_data,
+                                  ->(val) { ApplyDebitNoteEventData.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['timestamp'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['invoice'],
+                                ->(val) { Invoice.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['event_type'],
+                                ->(val) { InvoiceEventType.validate(val) }) and
+          APIHelper.valid_type?(value['event_data'],
+                                ->(val) { ApplyDebitNoteEventData.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/apply_debit_note_event_data.rb

@@ -3,6 +3,7 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'date'
 module AdvancedBilling
   # Example schema for an `apply_debit_note` event
   class ApplyDebitNoteEventData < BaseModel
@@ -27,6 +28,15 @@ module AdvancedBilling
     # @return [String]
     attr_accessor :applied_amount
 
+    # The debit note memo.
+    # @return [String]
+    attr_accessor :memo
+
+    # The time the debit note was applied, in ISO 8601 format, i.e.
+    # "2019-06-07T17:20:06Z"
+    # @return [DateTime]
+    attr_accessor :transaction_time
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -34,28 +44,40 @@ module AdvancedBilling
       @_hash['debit_note_uid'] = 'debit_note_uid'
       @_hash['original_amount'] = 'original_amount'
       @_hash['applied_amount'] = 'applied_amount'
+      @_hash['memo'] = 'memo'
+      @_hash['transaction_time'] = 'transaction_time'
       @_hash
     end
 
     # An array for optional fields
     def self.optionals
-      []
+      %w[
+        memo
+        transaction_time
+      ]
     end
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        memo
+        transaction_time
+      ]
     end
 
     def initialize(debit_note_number = nil,
                    debit_note_uid = nil,
                    original_amount = nil,
                    applied_amount = nil,
+                   memo = SKIP,
+                   transaction_time = SKIP,
                    additional_properties = {})
       @debit_note_number = debit_note_number
       @debit_note_uid = debit_note_uid
       @original_amount = original_amount
       @applied_amount = applied_amount
+      @memo = memo unless memo == SKIP
+      @transaction_time = transaction_time unless transaction_time == SKIP
 
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
@@ -76,6 +98,12 @@ module AdvancedBilling
         hash.key?('original_amount') ? hash['original_amount'] : nil
       applied_amount =
         hash.key?('applied_amount') ? hash['applied_amount'] : nil
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      transaction_time = if hash.key?('transaction_time')
+                           (DateTimeHelper.from_rfc3339(hash['transaction_time']) if hash['transaction_time'])
+                         else
+                           SKIP
+                         end
 
       # Clean out expected properties from Hash.
       names.each_value { |k| hash.delete(k) }
@@ -85,9 +113,15 @@ module AdvancedBilling
                                   debit_note_uid,
                                   original_amount,
                                   applied_amount,
+                                  memo,
+                                  transaction_time,
                                   hash)
     end
 
+    def to_custom_transaction_time
+      DateTimeHelper.to_rfc3339(transaction_time)
+    end
+
     # Validates an instance of the object from a given value.
     # @param [ApplyDebitNoteEventData | Hash] The value against the validation is performed.
     def self.validate(value)

data/lib/advanced_billing/models/apply_payment_event.rb

@@ -0,0 +1,139 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # ApplyPaymentEvent Model.
+  class ApplyPaymentEvent < 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 [DateTime]
+    attr_accessor :timestamp
+
+    # TODO: Write general description for this method
+    # @return [Invoice]
+    attr_accessor :invoice
+
+    # TODO: Write general description for this method
+    # @return [InvoiceEventType]
+    attr_accessor :event_type
+
+    # Example schema for an `apply_payment` event
+    # @return [ApplyPaymentEventData]
+    attr_accessor :event_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['invoice'] = 'invoice'
+      @_hash['event_type'] = 'event_type'
+      @_hash['event_data'] = 'event_data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   timestamp = nil,
+                   invoice = nil,
+                   event_type = InvoiceEventType::APPLY_PAYMENT,
+                   event_data = nil,
+                   additional_properties = {})
+      @id = id
+      @timestamp = timestamp
+      @invoice = invoice
+      @event_type = event_type
+      @event_data = event_data
+
+      # 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.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      invoice = Invoice.from_hash(hash['invoice']) if hash['invoice']
+      event_type = hash['event_type'] ||= InvoiceEventType::APPLY_PAYMENT
+      event_data = ApplyPaymentEventData.from_hash(hash['event_data']) if hash['event_data']
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      ApplyPaymentEvent.new(id,
+                            timestamp,
+                            invoice,
+                            event_type,
+                            event_data,
+                            hash)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ApplyPaymentEvent | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.timestamp,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.invoice,
+                                  ->(val) { Invoice.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.event_type,
+                                  ->(val) { InvoiceEventType.validate(val) }) and
+            APIHelper.valid_type?(value.event_data,
+                                  ->(val) { ApplyPaymentEventData.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['timestamp'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['invoice'],
+                                ->(val) { Invoice.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['event_type'],
+                                ->(val) { InvoiceEventType.validate(val) }) and
+          APIHelper.valid_type?(value['event_data'],
+                                ->(val) { ApplyPaymentEventData.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/apply_payment_event_data.rb

@@ -10,6 +10,10 @@ module AdvancedBilling
     SKIP = Object.new
     private_constant :SKIP
 
+    # TODO: Write general description for this method
+    # @return [InvoiceConsolidationLevel]
+    attr_accessor :consolidation_level
+
     # The payment memo
     # @return [String]
     attr_accessor :memo
@@ -36,7 +40,7 @@ module AdvancedBilling
     attr_accessor :transaction_time
 
     # A nested data structure detailing the method of payment
-    # @return [InvoiceEventPayment]
+    # @return [Object]
     attr_accessor :payment_method
 
     # The Chargify id of the original payment
@@ -62,6 +66,7 @@ module AdvancedBilling
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
+      @_hash['consolidation_level'] = 'consolidation_level'
       @_hash['memo'] = 'memo'
       @_hash['original_amount'] = 'original_amount'
       @_hash['applied_amount'] = 'applied_amount'
@@ -94,7 +99,8 @@ module AdvancedBilling
       ]
     end
 
-    def initialize(memo = nil,
+    def initialize(consolidation_level = nil,
+                   memo = nil,
                    original_amount = nil,
                    applied_amount = nil,
                    transaction_time = nil,
@@ -105,6 +111,7 @@ module AdvancedBilling
                    prepayment = SKIP,
                    external = SKIP,
                    additional_properties = {})
+      @consolidation_level = consolidation_level
       @memo = memo
       @original_amount = original_amount
       @applied_amount = applied_amount
@@ -130,6 +137,8 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
+      consolidation_level =
+        hash.key?('consolidation_level') ? hash['consolidation_level'] : nil
       memo = hash.key?('memo') ? hash['memo'] : nil
       original_amount =
         hash.key?('original_amount') ? hash['original_amount'] : nil
@@ -154,7 +163,8 @@ module AdvancedBilling
       names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
-      ApplyPaymentEventData.new(memo,
+      ApplyPaymentEventData.new(consolidation_level,
+                                memo,
                                 original_amount,
                                 applied_amount,
                                 transaction_time,
@@ -176,8 +186,10 @@ module AdvancedBilling
     def self.validate(value)
       if value.instance_of? self
         return (
-          APIHelper.valid_type?(value.memo,
-                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value.consolidation_level,
+                                ->(val) { InvoiceConsolidationLevel.validate(val) }) and
+            APIHelper.valid_type?(value.memo,
+                                  ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.original_amount,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.applied_amount,
@@ -192,8 +204,10 @@ module AdvancedBilling
       return false unless value.instance_of? Hash
 
       (
-        APIHelper.valid_type?(value['memo'],
-                              ->(val) { val.instance_of? String }) and
+        APIHelper.valid_type?(value['consolidation_level'],
+                              ->(val) { InvoiceConsolidationLevel.validate(val) }) and
+          APIHelper.valid_type?(value['memo'],
+                                ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['original_amount'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['applied_amount'],