maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/invoice_event_payment1.rb

@@ -0,0 +1,150 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # A nested data structure detailing the method of payment
+  class InvoiceEventPayment1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :masked_account_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :masked_routing_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :card_brand
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :card_expiration
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :last_four
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :masked_card_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :details
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :kind
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :memo
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['masked_account_number'] = 'masked_account_number'
+      @_hash['masked_routing_number'] = 'masked_routing_number'
+      @_hash['card_brand'] = 'card_brand'
+      @_hash['card_expiration'] = 'card_expiration'
+      @_hash['last_four'] = 'last_four'
+      @_hash['masked_card_number'] = 'masked_card_number'
+      @_hash['details'] = 'details'
+      @_hash['kind'] = 'kind'
+      @_hash['memo'] = 'memo'
+      @_hash['email'] = 'email'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        card_expiration
+        last_four
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        last_four
+        details
+        memo
+      ]
+    end
+
+    def initialize(masked_account_number = nil,
+                   masked_routing_number = nil,
+                   card_brand = nil,
+                   masked_card_number = nil,
+                   details = nil,
+                   kind = nil,
+                   memo = nil,
+                   email = nil,
+                   type = 'Invoice Event Payment1',
+                   card_expiration = SKIP,
+                   last_four = SKIP)
+      @type = type unless type == SKIP
+      @masked_account_number = masked_account_number
+      @masked_routing_number = masked_routing_number
+      @card_brand = card_brand
+      @card_expiration = card_expiration unless card_expiration == SKIP
+      @last_four = last_four unless last_four == SKIP
+      @masked_card_number = masked_card_number
+      @details = details
+      @kind = kind
+      @memo = memo
+      @email = email
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      masked_account_number =
+        hash.key?('masked_account_number') ? hash['masked_account_number'] : nil
+      masked_routing_number =
+        hash.key?('masked_routing_number') ? hash['masked_routing_number'] : nil
+      card_brand = hash.key?('card_brand') ? hash['card_brand'] : nil
+      masked_card_number =
+        hash.key?('masked_card_number') ? hash['masked_card_number'] : nil
+      details = hash.key?('details') ? hash['details'] : nil
+      kind = hash.key?('kind') ? hash['kind'] : nil
+      memo = hash.key?('memo') ? hash['memo'] : nil
+      email = hash.key?('email') ? hash['email'] : nil
+      type = hash['type'] ||= 'Invoice Event Payment1'
+      card_expiration =
+        hash.key?('card_expiration') ? hash['card_expiration'] : SKIP
+      last_four = hash.key?('last_four') ? hash['last_four'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceEventPayment1.new(masked_account_number,
+                               masked_routing_number,
+                               card_brand,
+                               masked_card_number,
+                               details,
+                               kind,
+                               memo,
+                               email,
+                               type,
+                               card_expiration,
+                               last_four)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_event_payment_method.rb

@@ -0,0 +1,32 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Invoice Event Payment Method.
+  class InvoiceEventPaymentMethod
+    INVOICE_EVENT_PAYMENT_METHOD = [
+      # TODO: Write general description for APPLE_PAY
+      APPLE_PAY = 'apple_pay'.freeze,
+
+      # TODO: Write general description for BANK_ACCOUNT
+      BANK_ACCOUNT = 'bank_account'.freeze,
+
+      # TODO: Write general description for CREDIT_CARD
+      CREDIT_CARD = 'credit_card'.freeze,
+
+      # TODO: Write general description for EXTERNAL
+      EXTERNAL = 'external'.freeze,
+
+      # TODO: Write general description for PAYPAL_ACCOUNT
+      PAYPAL_ACCOUNT = 'paypal_account'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_EVENT_PAYMENT_METHOD.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_event_type.rb

@@ -0,0 +1,59 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Invoice Event Type
+  class InvoiceEventType
+    INVOICE_EVENT_TYPE = [
+      # TODO: Write general description for ISSUE_INVOICE
+      ISSUE_INVOICE = 'issue_invoice'.freeze,
+
+      # TODO: Write general description for APPLY_CREDIT_NOTE
+      APPLY_CREDIT_NOTE = 'apply_credit_note'.freeze,
+
+      # TODO: Write general description for CREATE_CREDIT_NOTE
+      CREATE_CREDIT_NOTE = 'create_credit_note'.freeze,
+
+      # TODO: Write general description for APPLY_PAYMENT
+      APPLY_PAYMENT = 'apply_payment'.freeze,
+
+      # TODO: Write general description for APPLY_DEBIT_NOTE
+      APPLY_DEBIT_NOTE = 'apply_debit_note'.freeze,
+
+      # TODO: Write general description for REFUND_INVOICE
+      REFUND_INVOICE = 'refund_invoice'.freeze,
+
+      # TODO: Write general description for VOID_INVOICE
+      VOID_INVOICE = 'void_invoice'.freeze,
+
+      # TODO: Write general description for VOID_REMAINDER
+      VOID_REMAINDER = 'void_remainder'.freeze,
+
+      # TODO: Write general description for BACKPORT_INVOICE
+      BACKPORT_INVOICE = 'backport_invoice'.freeze,
+
+      # TODO: Write general description for CHANGE_INVOICE_STATUS
+      CHANGE_INVOICE_STATUS = 'change_invoice_status'.freeze,
+
+      # TODO: Write general description for CHANGE_INVOICE_COLLECTION_METHOD
+      CHANGE_INVOICE_COLLECTION_METHOD = 'change_invoice_collection_method'.freeze,
+
+      # TODO: Write general description for REMOVE_PAYMENT
+      REMOVE_PAYMENT = 'remove_payment'.freeze,
+
+      # TODO: Write general description for FAILED_PAYMENT
+      FAILED_PAYMENT = 'failed_payment'.freeze,
+
+      # TODO: Write general description for CHANGE_CHARGEBACK_STATUS
+      CHANGE_CHARGEBACK_STATUS = 'change_chargeback_status'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_EVENT_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_issued.rb

@@ -0,0 +1,258 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoiceIssued Model.
+  class InvoiceIssued < 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 :number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :role
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :due_date
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :issue_date
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :paid_date
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :due_amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :paid_amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tax_amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :refund_amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :total_amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status_amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :consolidation_level
+
+    # TODO: Write general description for this method
+    # @return [Array[InvoiceLineItemEventData]]
+    attr_accessor :line_items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['number'] = 'number'
+      @_hash['role'] = 'role'
+      @_hash['due_date'] = 'due_date'
+      @_hash['issue_date'] = 'issue_date'
+      @_hash['paid_date'] = 'paid_date'
+      @_hash['due_amount'] = 'due_amount'
+      @_hash['paid_amount'] = 'paid_amount'
+      @_hash['tax_amount'] = 'tax_amount'
+      @_hash['refund_amount'] = 'refund_amount'
+      @_hash['total_amount'] = 'total_amount'
+      @_hash['status_amount'] = 'status_amount'
+      @_hash['product_name'] = 'product_name'
+      @_hash['consolidation_level'] = 'consolidation_level'
+      @_hash['line_items'] = 'line_items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = nil,
+                   number = nil,
+                   role = nil,
+                   due_date = nil,
+                   issue_date = nil,
+                   paid_date = nil,
+                   due_amount = nil,
+                   paid_amount = nil,
+                   tax_amount = nil,
+                   refund_amount = nil,
+                   total_amount = nil,
+                   status_amount = nil,
+                   product_name = nil,
+                   consolidation_level = nil,
+                   line_items = nil)
+      @uid = uid
+      @number = number
+      @role = role
+      @due_date = due_date
+      @issue_date = issue_date
+      @paid_date = paid_date
+      @due_amount = due_amount
+      @paid_amount = paid_amount
+      @tax_amount = tax_amount
+      @refund_amount = refund_amount
+      @total_amount = total_amount
+      @status_amount = status_amount
+      @product_name = product_name
+      @consolidation_level = consolidation_level
+      @line_items = line_items
+    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
+      number = hash.key?('number') ? hash['number'] : nil
+      role = hash.key?('role') ? hash['role'] : nil
+      due_date = hash.key?('due_date') ? hash['due_date'] : nil
+      issue_date = hash.key?('issue_date') ? hash['issue_date'] : nil
+      paid_date = hash.key?('paid_date') ? hash['paid_date'] : nil
+      due_amount = hash.key?('due_amount') ? hash['due_amount'] : nil
+      paid_amount = hash.key?('paid_amount') ? hash['paid_amount'] : nil
+      tax_amount = hash.key?('tax_amount') ? hash['tax_amount'] : nil
+      refund_amount = hash.key?('refund_amount') ? hash['refund_amount'] : nil
+      total_amount = hash.key?('total_amount') ? hash['total_amount'] : nil
+      status_amount = hash.key?('status_amount') ? hash['status_amount'] : nil
+      product_name = hash.key?('product_name') ? hash['product_name'] : nil
+      consolidation_level =
+        hash.key?('consolidation_level') ? hash['consolidation_level'] : nil
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (InvoiceLineItemEventData.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = nil unless hash.key?('line_items')
+
+      # Create object from extracted values.
+      InvoiceIssued.new(uid,
+                        number,
+                        role,
+                        due_date,
+                        issue_date,
+                        paid_date,
+                        due_amount,
+                        paid_amount,
+                        tax_amount,
+                        refund_amount,
+                        total_amount,
+                        status_amount,
+                        product_name,
+                        consolidation_level,
+                        line_items)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceIssued | 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.number,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.role,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.due_date,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.issue_date,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.paid_date,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.due_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.paid_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.tax_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.refund_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.total_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.status_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.product_name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.consolidation_level,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.line_items,
+                                  ->(val) { InvoiceLineItemEventData.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['uid'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['number'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['role'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['due_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['issue_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['paid_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['due_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['paid_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['tax_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['refund_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['total_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['status_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['product_name'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['consolidation_level'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['line_items'],
+                                ->(val) { InvoiceLineItemEventData.validate(val) })
+      )
+    end
+  end
+end