maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/invoice_payment_method.rb

@@ -0,0 +1,124 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoicePaymentMethod Model.
+  class InvoicePaymentMethod < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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 :type
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['details'] = 'details'
+      @_hash['kind'] = 'kind'
+      @_hash['memo'] = 'memo'
+      @_hash['type'] = 'type'
+      @_hash['card_brand'] = 'card_brand'
+      @_hash['card_expiration'] = 'card_expiration'
+      @_hash['last_four'] = 'last_four'
+      @_hash['masked_card_number'] = 'masked_card_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        details
+        kind
+        memo
+        type
+        card_brand
+        card_expiration
+        last_four
+        masked_card_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        last_four
+      ]
+    end
+
+    def initialize(details = SKIP,
+                   kind = SKIP,
+                   memo = SKIP,
+                   type = SKIP,
+                   card_brand = SKIP,
+                   card_expiration = SKIP,
+                   last_four = SKIP,
+                   masked_card_number = SKIP)
+      @details = details unless details == SKIP
+      @kind = kind unless kind == SKIP
+      @memo = memo unless memo == SKIP
+      @type = type unless type == SKIP
+      @card_brand = card_brand unless card_brand == SKIP
+      @card_expiration = card_expiration unless card_expiration == SKIP
+      @last_four = last_four unless last_four == SKIP
+      @masked_card_number = masked_card_number unless masked_card_number == 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.
+      details = hash.key?('details') ? hash['details'] : SKIP
+      kind = hash.key?('kind') ? hash['kind'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      card_brand = hash.key?('card_brand') ? hash['card_brand'] : SKIP
+      card_expiration =
+        hash.key?('card_expiration') ? hash['card_expiration'] : SKIP
+      last_four = hash.key?('last_four') ? hash['last_four'] : SKIP
+      masked_card_number =
+        hash.key?('masked_card_number') ? hash['masked_card_number'] : SKIP
+
+      # Create object from extracted values.
+      InvoicePaymentMethod.new(details,
+                               kind,
+                               memo,
+                               type,
+                               card_brand,
+                               card_expiration,
+                               last_four,
+                               masked_card_number)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_payment_method_type.rb

@@ -0,0 +1,35 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The type of payment method used.
+  class InvoicePaymentMethodType
+    INVOICE_PAYMENT_METHOD_TYPE = [
+      # TODO: Write general description for CREDIT_CARD
+      CREDIT_CARD = 'credit_card'.freeze,
+
+      # TODO: Write general description for CHECK
+      CHECK = 'check'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'cash'.freeze,
+
+      # TODO: Write general description for MONEY_ORDER
+      MONEY_ORDER = 'money_order'.freeze,
+
+      # TODO: Write general description for ACH
+      ACH = 'ach'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_PAYMENT_METHOD_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_payment_type.rb

@@ -0,0 +1,29 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The type of payment to be applied to an Invoice.
+  class InvoicePaymentType
+    INVOICE_PAYMENT_TYPE = [
+      # TODO: Write general description for EXTERNAL
+      EXTERNAL = 'external'.freeze,
+
+      # TODO: Write general description for PREPAYMENT
+      PREPAYMENT = 'prepayment'.freeze,
+
+      # TODO: Write general description for SERVICE_CREDIT
+      SERVICE_CREDIT = 'service_credit'.freeze,
+
+      # TODO: Write general description for PAYMENT
+      PAYMENT = 'payment'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_PAYMENT_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_pre_payment.rb

@@ -0,0 +1,75 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoicePrePayment Model.
+  class InvoicePrePayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The subscription id for the prepayment account
+    # @return [String]
+    attr_accessor :subscription_id
+
+    # The amount in cents of the prepayment that was created as a result of this
+    # payment.
+    # @return [String]
+    attr_accessor :amount_in_cents
+
+    # The total balance of the prepayment account for this subscription
+    # including any prior prepayments
+    # @return [String]
+    attr_accessor :ending_balance_in_cents
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['ending_balance_in_cents'] = 'ending_balance_in_cents'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        subscription_id
+        amount_in_cents
+        ending_balance_in_cents
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subscription_id = SKIP,
+                   amount_in_cents = SKIP,
+                   ending_balance_in_cents = SKIP)
+      @subscription_id = subscription_id unless subscription_id == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      @ending_balance_in_cents = ending_balance_in_cents unless ending_balance_in_cents == 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.
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : SKIP
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      ending_balance_in_cents =
+        hash.key?('ending_balance_in_cents') ? hash['ending_balance_in_cents'] : SKIP
+
+      # Create object from extracted values.
+      InvoicePrePayment.new(subscription_id,
+                            amount_in_cents,
+                            ending_balance_in_cents)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_previous_balance.rb

@@ -0,0 +1,78 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # InvoicePreviousBalance Model.
+  class InvoicePreviousBalance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :captured_at
+
+    # TODO: Write general description for this method
+    # @return [Array[InvoiceBalanceItem]]
+    attr_accessor :invoices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['captured_at'] = 'captured_at'
+      @_hash['invoices'] = 'invoices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        captured_at
+        invoices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(captured_at = SKIP,
+                   invoices = SKIP)
+      @captured_at = captured_at unless captured_at == SKIP
+      @invoices = invoices unless invoices == 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.
+      captured_at = if hash.key?('captured_at')
+                      (DateTimeHelper.from_rfc3339(hash['captured_at']) if hash['captured_at'])
+                    else
+                      SKIP
+                    end
+      # Parameter is an array, so we need to iterate through it
+      invoices = nil
+      unless hash['invoices'].nil?
+        invoices = []
+        hash['invoices'].each do |structure|
+          invoices << (InvoiceBalanceItem.from_hash(structure) if structure)
+        end
+      end
+
+      invoices = SKIP unless hash.key?('invoices')
+
+      # Create object from extracted values.
+      InvoicePreviousBalance.new(captured_at,
+                                 invoices)
+    end
+
+    def to_custom_captured_at
+      DateTimeHelper.to_rfc3339(captured_at)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_refund.rb

@@ -0,0 +1,106 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoiceRefund Model.
+  class InvoiceRefund < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :transaction_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :payment_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :memo
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :original_amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # The transaction ID for the refund as returned from the payment gateway
+    # @return [String]
+    attr_accessor :gateway_transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash['payment_id'] = 'payment_id'
+      @_hash['memo'] = 'memo'
+      @_hash['original_amount'] = 'original_amount'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash['gateway_transaction_id'] = 'gateway_transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_id
+        payment_id
+        memo
+        original_amount
+        applied_amount
+        gateway_transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        gateway_transaction_id
+      ]
+    end
+
+    def initialize(transaction_id = SKIP,
+                   payment_id = SKIP,
+                   memo = SKIP,
+                   original_amount = SKIP,
+                   applied_amount = SKIP,
+                   gateway_transaction_id = SKIP)
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @payment_id = payment_id unless payment_id == SKIP
+      @memo = memo unless memo == SKIP
+      @original_amount = original_amount unless original_amount == SKIP
+      @applied_amount = applied_amount unless applied_amount == SKIP
+      @gateway_transaction_id = gateway_transaction_id unless gateway_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.
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : SKIP
+      payment_id = hash.key?('payment_id') ? hash['payment_id'] : SKIP
+      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
+      gateway_transaction_id =
+        hash.key?('gateway_transaction_id') ? hash['gateway_transaction_id'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceRefund.new(transaction_id,
+                        payment_id,
+                        memo,
+                        original_amount,
+                        applied_amount,
+                        gateway_transaction_id)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_response.rb

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

data/lib/advanced_billing/models/invoice_role.rb

@@ -0,0 +1,47 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Invoice Role.
+  class InvoiceRole
+    INVOICE_ROLE = [
+      # TODO: Write general description for UNSET
+      UNSET = 'unset'.freeze,
+
+      # TODO: Write general description for SIGNUP
+      SIGNUP = 'signup'.freeze,
+
+      # TODO: Write general description for RENEWAL
+      RENEWAL = 'renewal'.freeze,
+
+      # TODO: Write general description for USAGE
+      USAGE = 'usage'.freeze,
+
+      # TODO: Write general description for REACTIVATION
+      REACTIVATION = 'reactivation'.freeze,
+
+      # TODO: Write general description for PRORATION
+      PRORATION = 'proration'.freeze,
+
+      # TODO: Write general description for MIGRATION
+      MIGRATION = 'migration'.freeze,
+
+      # TODO: Write general description for ADHOC
+      ADHOC = 'adhoc'.freeze,
+
+      # TODO: Write general description for BACKPORT
+      BACKPORT = 'backport'.freeze,
+
+      # TODO: Write general description for BACKPORTBALANCERECONCILIATION
+      BACKPORTBALANCERECONCILIATION = 'backport-balance-reconciliation'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_ROLE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_seller.rb

@@ -0,0 +1,83 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Information about the seller (merchant) listed on the masthead of the
+  # invoice.
+  class InvoiceSeller < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [InvoiceAddress]
+    attr_accessor :address
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :phone
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :logo_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['address'] = 'address'
+      @_hash['phone'] = 'phone'
+      @_hash['logo_url'] = 'logo_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        address
+        phone
+        logo_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        logo_url
+      ]
+    end
+
+    def initialize(name = SKIP,
+                   address = SKIP,
+                   phone = SKIP,
+                   logo_url = SKIP)
+      @name = name unless name == SKIP
+      @address = address unless address == SKIP
+      @phone = phone unless phone == SKIP
+      @logo_url = logo_url unless logo_url == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      address = InvoiceAddress.from_hash(hash['address']) if hash['address']
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      logo_url = hash.key?('logo_url') ? hash['logo_url'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceSeller.new(name,
+                        address,
+                        phone,
+                        logo_url)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_sort_field.rb

@@ -0,0 +1,41 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Invoice Sort Field.
+  class InvoiceSortField
+    INVOICE_SORT_FIELD = [
+      # TODO: Write general description for STATUS
+      STATUS = 'status'.freeze,
+
+      # TODO: Write general description for TOTAL_AMOUNT
+      TOTAL_AMOUNT = 'total_amount'.freeze,
+
+      # TODO: Write general description for DUE_AMOUNT
+      DUE_AMOUNT = 'due_amount'.freeze,
+
+      # TODO: Write general description for CREATED_AT
+      CREATED_AT = 'created_at'.freeze,
+
+      # TODO: Write general description for UPDATED_AT
+      UPDATED_AT = 'updated_at'.freeze,
+
+      # TODO: Write general description for ISSUE_DATE
+      ISSUE_DATE = 'issue_date'.freeze,
+
+      # TODO: Write general description for DUE_DATE
+      DUE_DATE = 'due_date'.freeze,
+
+      # TODO: Write general description for NUMBER
+      NUMBER = 'number'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_SORT_FIELD.include?(value)
+    end
+  end
+end