maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/apply_credit_note_event_data.rb

@@ -0,0 +1,198 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # Example schema for an `apply_credit_note` event
+  class ApplyCreditNoteEventData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the credit note application. It is generated
+    # automatically by Chargify and has the prefix "cdt_" followed by
+    # alphanumeric characters.
+    # @return [String]
+    attr_accessor :uid
+
+    # A unique, identifying string that appears on the credit note and in places
+    # it is referenced.
+    # @return [String]
+    attr_accessor :credit_note_number
+
+    # Unique identifier for the credit note. It is generated automatically by
+    # Chargify and has the prefix "cn_" followed by alphanumeric characters.
+    # @return [String]
+    attr_accessor :credit_note_uid
+
+    # The full, original amount of the credit note.
+    # @return [String]
+    attr_accessor :original_amount
+
+    # The amount of the credit note applied to invoice.
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # The time the credit note was applied, in ISO 8601 format, i.e.
+    # "2019-06-07T17:20:06Z"
+    # @return [DateTime]
+    attr_accessor :transaction_time
+
+    # The credit note memo.
+    # @return [String]
+    attr_accessor :memo
+
+    # The role of the credit note (e.g. 'general')
+    # @return [String]
+    attr_accessor :role
+
+    # Shows whether it was applied to consolidated invoice or not
+    # @return [TrueClass | FalseClass]
+    attr_accessor :consolidated_invoice
+
+    # List of credit notes applied to children invoices (if consolidated
+    # invoice)
+    # @return [Array[AppliedCreditNoteData]]
+    attr_accessor :applied_credit_notes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['credit_note_number'] = 'credit_note_number'
+      @_hash['credit_note_uid'] = 'credit_note_uid'
+      @_hash['original_amount'] = 'original_amount'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash['transaction_time'] = 'transaction_time'
+      @_hash['memo'] = 'memo'
+      @_hash['role'] = 'role'
+      @_hash['consolidated_invoice'] = 'consolidated_invoice'
+      @_hash['applied_credit_notes'] = 'applied_credit_notes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_time
+        memo
+        role
+        consolidated_invoice
+        applied_credit_notes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = nil,
+                   credit_note_number = nil,
+                   credit_note_uid = nil,
+                   original_amount = nil,
+                   applied_amount = nil,
+                   transaction_time = SKIP,
+                   memo = SKIP,
+                   role = SKIP,
+                   consolidated_invoice = SKIP,
+                   applied_credit_notes = SKIP)
+      @uid = uid
+      @credit_note_number = credit_note_number
+      @credit_note_uid = credit_note_uid
+      @original_amount = original_amount
+      @applied_amount = applied_amount
+      @transaction_time = transaction_time unless transaction_time == SKIP
+      @memo = memo unless memo == SKIP
+      @role = role unless role == SKIP
+      @consolidated_invoice = consolidated_invoice unless consolidated_invoice == SKIP
+      @applied_credit_notes = applied_credit_notes unless applied_credit_notes == 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'] : nil
+      credit_note_number =
+        hash.key?('credit_note_number') ? hash['credit_note_number'] : nil
+      credit_note_uid =
+        hash.key?('credit_note_uid') ? hash['credit_note_uid'] : nil
+      original_amount =
+        hash.key?('original_amount') ? hash['original_amount'] : nil
+      applied_amount =
+        hash.key?('applied_amount') ? hash['applied_amount'] : nil
+      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
+      role = hash.key?('role') ? hash['role'] : SKIP
+      consolidated_invoice =
+        hash.key?('consolidated_invoice') ? hash['consolidated_invoice'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      applied_credit_notes = nil
+      unless hash['applied_credit_notes'].nil?
+        applied_credit_notes = []
+        hash['applied_credit_notes'].each do |structure|
+          applied_credit_notes << (AppliedCreditNoteData.from_hash(structure) if structure)
+        end
+      end
+
+      applied_credit_notes = SKIP unless hash.key?('applied_credit_notes')
+
+      # Create object from extracted values.
+      ApplyCreditNoteEventData.new(uid,
+                                   credit_note_number,
+                                   credit_note_uid,
+                                   original_amount,
+                                   applied_amount,
+                                   transaction_time,
+                                   memo,
+                                   role,
+                                   consolidated_invoice,
+                                   applied_credit_notes)
+    end
+
+    def to_custom_transaction_time
+      DateTimeHelper.to_rfc3339(transaction_time)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ApplyCreditNoteEventData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.uid,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.credit_note_number,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.credit_note_uid,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.original_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.applied_amount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['uid'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['credit_note_number'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['credit_note_uid'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['original_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['applied_amount'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/apply_debit_note_event_data.rb

@@ -0,0 +1,111 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Example schema for an `apply_debit_note` event
+  class ApplyDebitNoteEventData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique, identifying string that appears on the debit note and in places
+    # it is referenced.
+    # @return [String]
+    attr_accessor :debit_note_number
+
+    # Unique identifier for the debit note. It is generated automatically by
+    # Chargify and has the prefix "db_" followed by alphanumeric characters.
+    # @return [String]
+    attr_accessor :debit_note_uid
+
+    # The full, original amount of the debit note.
+    # @return [String]
+    attr_accessor :original_amount
+
+    # The amount of the debit note applied to invoice.
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['debit_note_number'] = 'debit_note_number'
+      @_hash['debit_note_uid'] = 'debit_note_uid'
+      @_hash['original_amount'] = 'original_amount'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(debit_note_number = nil,
+                   debit_note_uid = nil,
+                   original_amount = nil,
+                   applied_amount = nil)
+      @debit_note_number = debit_note_number
+      @debit_note_uid = debit_note_uid
+      @original_amount = original_amount
+      @applied_amount = applied_amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      debit_note_number =
+        hash.key?('debit_note_number') ? hash['debit_note_number'] : nil
+      debit_note_uid =
+        hash.key?('debit_note_uid') ? hash['debit_note_uid'] : nil
+      original_amount =
+        hash.key?('original_amount') ? hash['original_amount'] : nil
+      applied_amount =
+        hash.key?('applied_amount') ? hash['applied_amount'] : nil
+
+      # Create object from extracted values.
+      ApplyDebitNoteEventData.new(debit_note_number,
+                                  debit_note_uid,
+                                  original_amount,
+                                  applied_amount)
+    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)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.debit_note_number,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.debit_note_uid,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.original_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.applied_amount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['debit_note_number'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['debit_note_uid'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['original_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['applied_amount'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/apply_payment_event_data.rb

@@ -0,0 +1,150 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # Example schema for an `apply_payment` event
+  class ApplyPaymentEventData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment memo
+    # @return [String]
+    attr_accessor :memo
+
+    # The full, original amount of the payment transaction as a string in full
+    # units. Incoming payments can be split amongst several invoices, which will
+    # result in a `applied_amount` less than the `original_amount`. Example: A
+    # $100.99 payment, of which $40.11 is applied to this invoice, will have an
+    # `original_amount` of `"100.99"`.
+    # @return [String]
+    attr_accessor :original_amount
+
+    # The amount of the payment applied to this invoice. Incoming payments can
+    # be split amongst several invoices, which will result in a `applied_amount`
+    # less than the `original_amount`. Example: A $100.99 payment, of which
+    # $40.11 is applied to this invoice, will have an `applied_amount` of
+    # `"40.11"`.
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # The time the payment was applied, in ISO 8601 format, i.e.
+    # "2019-06-07T17:20:06Z"
+    # @return [DateTime]
+    attr_accessor :transaction_time
+
+    # A nested data structure detailing the method of payment
+    # @return [PaymentMethodNestedData]
+    attr_accessor :payment_method
+
+    # The Chargify id of the original payment
+    # @return [Integer]
+    attr_accessor :transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['memo'] = 'memo'
+      @_hash['original_amount'] = 'original_amount'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash['transaction_time'] = 'transaction_time'
+      @_hash['payment_method'] = 'payment_method'
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(memo = nil,
+                   original_amount = nil,
+                   applied_amount = nil,
+                   transaction_time = nil,
+                   payment_method = nil,
+                   transaction_id = SKIP)
+      @memo = memo
+      @original_amount = original_amount
+      @applied_amount = applied_amount
+      @transaction_time = transaction_time
+      @payment_method = payment_method
+      @transaction_id = transaction_id unless transaction_id == 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.
+      memo = hash.key?('memo') ? hash['memo'] : nil
+      original_amount =
+        hash.key?('original_amount') ? hash['original_amount'] : nil
+      applied_amount =
+        hash.key?('applied_amount') ? hash['applied_amount'] : nil
+      transaction_time = if hash.key?('transaction_time')
+                           (DateTimeHelper.from_rfc3339(hash['transaction_time']) if hash['transaction_time'])
+                         end
+      payment_method = hash.key?('payment_method') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:ApplyPaymentEventDataPaymentMethod), hash['payment_method']
+      ) : nil
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : SKIP
+
+      # Create object from extracted values.
+      ApplyPaymentEventData.new(memo,
+                                original_amount,
+                                applied_amount,
+                                transaction_time,
+                                payment_method,
+                                transaction_id)
+    end
+
+    def to_custom_transaction_time
+      DateTimeHelper.to_rfc3339(transaction_time)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ApplyPaymentEventData | Hash] The value against the validation is performed.
+    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.original_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.applied_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.transaction_time,
+                                  ->(val) { val.instance_of? DateTime }) and
+            UnionTypeLookUp.get(:ApplyPaymentEventDataPaymentMethod)
+                           .validate(value.payment_method)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        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'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['transaction_time'],
+                                ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:ApplyPaymentEventDataPaymentMethod)
+                         .validate(value['payment_method'])
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/attribute_error.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # AttributeError Model.
+  class AttributeError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :attribute
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['attribute'] = 'attribute'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(attribute = nil)
+      @attribute = attribute
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      attribute = hash.key?('attribute') ? hash['attribute'] : nil
+
+      # Create object from extracted values.
+      AttributeError.new(attribute)
+    end
+  end
+end

data/lib/advanced_billing/models/auto_invite.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Auto Invite.
+  class AutoInvite
+    AUTO_INVITE = [
+      # Do not send the invitation email.
+      NO = 0,
+
+      # Automatically send the invitation email.
+      YES = 1
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AUTO_INVITE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/auto_resume.rb

@@ -0,0 +1,61 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # AutoResume Model.
+  class AutoResume < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :automatically_resume_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['automatically_resume_at'] = 'automatically_resume_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        automatically_resume_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        automatically_resume_at
+      ]
+    end
+
+    def initialize(automatically_resume_at = SKIP)
+      @automatically_resume_at = automatically_resume_at unless automatically_resume_at == 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.
+      automatically_resume_at = if hash.key?('automatically_resume_at')
+                                  (DateTimeHelper.from_rfc3339(hash['automatically_resume_at']) if hash['automatically_resume_at'])
+                                else
+                                  SKIP
+                                end
+
+      # Create object from extracted values.
+      AutoResume.new(automatically_resume_at)
+    end
+
+    def to_custom_automatically_resume_at
+      DateTimeHelper.to_rfc3339(automatically_resume_at)
+    end
+  end
+end