maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/credit_note_line_item.rb

@@ -0,0 +1,245 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreditNoteLineItem Model.
+  class CreditNoteLineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the line item.  Useful when cross-referencing the
+    # line against individual discounts in the `discounts` or `taxes` lists.
+    # @return [String]
+    attr_accessor :uid
+
+    # A short descriptor for the credit given by this line.
+    # @return [String]
+    attr_accessor :title
+
+    # Detailed description for the credit given by this line.  May include
+    # proration details in plain text.
+    # Note: this string may contain line breaks that are hints for the best
+    # display format on the credit note.
+    # @return [String]
+    attr_accessor :description
+
+    # The quantity or count of units credited by the line item.
+    # This is a decimal number represented as a string. (See "About Decimal
+    # Numbers".)
+    # @return [String]
+    attr_accessor :quantity
+
+    # The price per unit for the line item.
+    # When tiered pricing was used (i.e. not every unit was actually priced at
+    # the same price) this will be the blended average cost per unit and the
+    # `tiered_unit_price` field will be set to `true`.
+    # @return [String]
+    attr_accessor :unit_price
+
+    # The line subtotal, generally calculated as `quantity * unit_price`. This
+    # is the canonical amount of record for the line - when rounding differences
+    # are in play, `subtotal_amount` takes precedence over the value derived
+    # from `quantity * unit_price` (which may not have the proper precision to
+    # exactly equal this amount).
+    # @return [String]
+    attr_accessor :subtotal_amount
+
+    # The approximate discount of just this line.
+    # The value is approximated in cases where rounding errors make it difficult
+    # to apportion exactly a total discount among many lines. Several lines may
+    # have been summed prior to applying the discount to arrive at
+    # `discount_amount` for the invoice - backing that out to the discount on a
+    # single line may introduce rounding or precision errors.
+    # @return [String]
+    attr_accessor :discount_amount
+
+    # The approximate tax of just this line.
+    # The value is approximated in cases where rounding errors make it difficult
+    # to apportion exactly a total tax among many lines. Several lines may have
+    # been summed prior to applying the tax rate to arrive at `tax_amount` for
+    # the invoice - backing that out to the tax on a single line may introduce
+    # rounding or precision errors.
+    # @return [String]
+    attr_accessor :tax_amount
+
+    # The non-canonical total amount for the line.
+    # `subtotal_amount` is the canonical amount for a line. The invoice
+    # `total_amount` is derived from the sum of the line `subtotal_amount`s and
+    # discounts or taxes applied thereafter.  Therefore, due to rounding or
+    # precision errors, the sum of line `total_amount`s may not equal the
+    # invoice `total_amount`.
+    # @return [String]
+    attr_accessor :total_amount
+
+    # When `true`, indicates that the actual pricing scheme for the line was
+    # tiered, so the `unit_price` shown is the blended average for all units.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tiered_unit_price
+
+    # Start date for the period credited by this line. The format is
+    # `"YYYY-MM-DD"`.
+    # @return [String]
+    attr_accessor :period_range_start
+
+    # End date for the period credited by this line. The format is
+    # `"YYYY-MM-DD"`.
+    # @return [String]
+    attr_accessor :period_range_end
+
+    # The ID of the product being credited.
+    # This may be set even for component credits, so true product-only
+    # (non-component) credits will also have a nil `component_id`.
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # The version of the product being credited.
+    # @return [Integer]
+    attr_accessor :product_version
+
+    # The ID of the component being credited. Will be `nil` for non-component
+    # credits.
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # The price point ID of the component being credited. Will be `nil` for
+    # non-component credits.
+    # @return [Integer]
+    attr_accessor :price_point_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['title'] = 'title'
+      @_hash['description'] = 'description'
+      @_hash['quantity'] = 'quantity'
+      @_hash['unit_price'] = 'unit_price'
+      @_hash['subtotal_amount'] = 'subtotal_amount'
+      @_hash['discount_amount'] = 'discount_amount'
+      @_hash['tax_amount'] = 'tax_amount'
+      @_hash['total_amount'] = 'total_amount'
+      @_hash['tiered_unit_price'] = 'tiered_unit_price'
+      @_hash['period_range_start'] = 'period_range_start'
+      @_hash['period_range_end'] = 'period_range_end'
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_version'] = 'product_version'
+      @_hash['component_id'] = 'component_id'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        title
+        description
+        quantity
+        unit_price
+        subtotal_amount
+        discount_amount
+        tax_amount
+        total_amount
+        tiered_unit_price
+        period_range_start
+        period_range_end
+        product_id
+        product_version
+        component_id
+        price_point_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        component_id
+        price_point_id
+      ]
+    end
+
+    def initialize(uid = SKIP,
+                   title = SKIP,
+                   description = SKIP,
+                   quantity = SKIP,
+                   unit_price = SKIP,
+                   subtotal_amount = SKIP,
+                   discount_amount = SKIP,
+                   tax_amount = SKIP,
+                   total_amount = SKIP,
+                   tiered_unit_price = SKIP,
+                   period_range_start = SKIP,
+                   period_range_end = SKIP,
+                   product_id = SKIP,
+                   product_version = SKIP,
+                   component_id = SKIP,
+                   price_point_id = SKIP)
+      @uid = uid unless uid == SKIP
+      @title = title unless title == SKIP
+      @description = description unless description == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @unit_price = unit_price unless unit_price == SKIP
+      @subtotal_amount = subtotal_amount unless subtotal_amount == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @total_amount = total_amount unless total_amount == SKIP
+      @tiered_unit_price = tiered_unit_price unless tiered_unit_price == SKIP
+      @period_range_start = period_range_start unless period_range_start == SKIP
+      @period_range_end = period_range_end unless period_range_end == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @product_version = product_version unless product_version == SKIP
+      @component_id = component_id unless component_id == SKIP
+      @price_point_id = price_point_id unless price_point_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.
+      uid = hash.key?('uid') ? hash['uid'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      unit_price = hash.key?('unit_price') ? hash['unit_price'] : SKIP
+      subtotal_amount =
+        hash.key?('subtotal_amount') ? hash['subtotal_amount'] : SKIP
+      discount_amount =
+        hash.key?('discount_amount') ? hash['discount_amount'] : SKIP
+      tax_amount = hash.key?('tax_amount') ? hash['tax_amount'] : SKIP
+      total_amount = hash.key?('total_amount') ? hash['total_amount'] : SKIP
+      tiered_unit_price =
+        hash.key?('tiered_unit_price') ? hash['tiered_unit_price'] : SKIP
+      period_range_start =
+        hash.key?('period_range_start') ? hash['period_range_start'] : SKIP
+      period_range_end =
+        hash.key?('period_range_end') ? hash['period_range_end'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      product_version =
+        hash.key?('product_version') ? hash['product_version'] : SKIP
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      price_point_id =
+        hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
+
+      # Create object from extracted values.
+      CreditNoteLineItem.new(uid,
+                             title,
+                             description,
+                             quantity,
+                             unit_price,
+                             subtotal_amount,
+                             discount_amount,
+                             tax_amount,
+                             total_amount,
+                             tiered_unit_price,
+                             period_range_start,
+                             period_range_end,
+                             product_id,
+                             product_version,
+                             component_id,
+                             price_point_id)
+    end
+  end
+end

data/lib/advanced_billing/models/credit_note_status.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Current status of the credit note.
+  class CreditNoteStatus
+    CREDIT_NOTE_STATUS = [
+      # TODO: Write general description for OPEN
+      OPEN = 'open'.freeze,
+
+      # TODO: Write general description for APPLIED
+      APPLIED = 'applied'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CREDIT_NOTE_STATUS.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/credit_scheme.rb

@@ -0,0 +1,26 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Credit Scheme.
+  class CreditScheme
+    CREDIT_SCHEME = [
+      # TODO: Write general description for NONE
+      NONE = 'none'.freeze,
+
+      # TODO: Write general description for CREDIT
+      CREDIT = 'credit'.freeze,
+
+      # TODO: Write general description for REFUND
+      REFUND = 'refund'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CREDIT_SCHEME.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/credit_scheme_request.rb

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

data/lib/advanced_billing/models/credit_type.rb

@@ -0,0 +1,28 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The type of credit to be created when upgrading/downgrading. Defaults to the
+  # component and then site setting if one is not provided. Available values:
+  # `full`, `prorated`, `none`.
+  class CreditType
+    CREDIT_TYPE = [
+      # TODO: Write general description for FULL
+      FULL = 'full'.freeze,
+
+      # TODO: Write general description for PRORATED
+      PRORATED = 'prorated'.freeze,
+
+      # TODO: Write general description for NONE
+      NONE = 'none'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CREDIT_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/currency_price.rb

@@ -0,0 +1,102 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CurrencyPrice Model.
+  class CurrencyPrice < 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 :currency
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :price
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :formatted_price
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_price_point_id
+
+    # Role for the price.
+    # @return [CurrencyPriceRole]
+    attr_accessor :role
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['currency'] = 'currency'
+      @_hash['price'] = 'price'
+      @_hash['formatted_price'] = 'formatted_price'
+      @_hash['product_price_point_id'] = 'product_price_point_id'
+      @_hash['role'] = 'role'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        currency
+        price
+        formatted_price
+        product_price_point_id
+        role
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   currency = SKIP,
+                   price = SKIP,
+                   formatted_price = SKIP,
+                   product_price_point_id = SKIP,
+                   role = SKIP)
+      @id = id unless id == SKIP
+      @currency = currency unless currency == SKIP
+      @price = price unless price == SKIP
+      @formatted_price = formatted_price unless formatted_price == SKIP
+      @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
+      @role = role unless role == 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
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      price = hash.key?('price') ? hash['price'] : SKIP
+      formatted_price =
+        hash.key?('formatted_price') ? hash['formatted_price'] : SKIP
+      product_price_point_id =
+        hash.key?('product_price_point_id') ? hash['product_price_point_id'] : SKIP
+      role = hash.key?('role') ? hash['role'] : SKIP
+
+      # Create object from extracted values.
+      CurrencyPrice.new(id,
+                        currency,
+                        price,
+                        formatted_price,
+                        product_price_point_id,
+                        role)
+    end
+  end
+end

data/lib/advanced_billing/models/currency_price_role.rb

@@ -0,0 +1,26 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Role for the price.
+  class CurrencyPriceRole
+    CURRENCY_PRICE_ROLE = [
+      # TODO: Write general description for BASELINE
+      BASELINE = 'baseline'.freeze,
+
+      # TODO: Write general description for TRIAL
+      TRIAL = 'trial'.freeze,
+
+      # TODO: Write general description for INITIAL
+      INITIAL = 'initial'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CURRENCY_PRICE_ROLE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/currency_prices_response.rb

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

data/lib/advanced_billing/models/current_vault.rb

@@ -0,0 +1,99 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The vault that stores the payment profile with the provided `vault_token`.
+  # Use `bogus` for testing.
+  class CurrentVault
+    CURRENT_VAULT = [
+      # TODO: Write general description for ADYEN
+      ADYEN = 'adyen'.freeze,
+
+      # TODO: Write general description for AUTHORIZENET
+      AUTHORIZENET = 'authorizenet'.freeze,
+
+      # TODO: Write general description for AVALARA
+      AVALARA = 'avalara'.freeze,
+
+      # TODO: Write general description for BEANSTREAM
+      BEANSTREAM = 'beanstream'.freeze,
+
+      # TODO: Write general description for BLUE_SNAP
+      BLUE_SNAP = 'blue_snap'.freeze,
+
+      # TODO: Write general description for BOGUS
+      BOGUS = 'bogus'.freeze,
+
+      # TODO: Write general description for BRAINTREE_BLUE
+      BRAINTREE_BLUE = 'braintree_blue'.freeze,
+
+      # TODO: Write general description for CHECKOUT
+      CHECKOUT = 'checkout'.freeze,
+
+      # TODO: Write general description for CYBERSOURCE
+      CYBERSOURCE = 'cybersource'.freeze,
+
+      # TODO: Write general description for ELAVON
+      ELAVON = 'elavon'.freeze,
+
+      # TODO: Write general description for EWAY
+      EWAY = 'eway'.freeze,
+
+      # TODO: Write general description for EWAY_RAPID_STD
+      EWAY_RAPID_STD = 'eway_rapid_std'.freeze,
+
+      # TODO: Write general description for FIRSTDATA
+      FIRSTDATA = 'firstdata'.freeze,
+
+      # TODO: Write general description for FORTE
+      FORTE = 'forte'.freeze,
+
+      # TODO: Write general description for GOCARDLESS
+      GOCARDLESS = 'gocardless'.freeze,
+
+      # TODO: Write general description for LITLE
+      LITLE = 'litle'.freeze,
+
+      # TODO: Write general description for MAXIO_PAYMENTS
+      MAXIO_PAYMENTS = 'maxio_payments'.freeze,
+
+      # TODO: Write general description for MODUSLINK
+      MODUSLINK = 'moduslink'.freeze,
+
+      # TODO: Write general description for MONERIS
+      MONERIS = 'moneris'.freeze,
+
+      # TODO: Write general description for NMI
+      NMI = 'nmi'.freeze,
+
+      # TODO: Write general description for ORBITAL
+      ORBITAL = 'orbital'.freeze,
+
+      # TODO: Write general description for PAYMENT_EXPRESS
+      PAYMENT_EXPRESS = 'payment_express'.freeze,
+
+      # TODO: Write general description for PIN
+      PIN = 'pin'.freeze,
+
+      # TODO: Write general description for SQUARE
+      SQUARE = 'square'.freeze,
+
+      # TODO: Write general description for STRIPE_CONNECT
+      STRIPE_CONNECT = 'stripe_connect'.freeze,
+
+      # TODO: Write general description for TRUST_COMMERCE
+      TRUST_COMMERCE = 'trust_commerce'.freeze,
+
+      # TODO: Write general description for UNIPAAS
+      UNIPAAS = 'unipaas'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CURRENT_VAULT.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/custom_field_owner.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Custom Field Owner.
+  class CustomFieldOwner
+    CUSTOM_FIELD_OWNER = [
+      # TODO: Write general description for CUSTOMER
+      CUSTOMER = 'Customer'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION
+      SUBSCRIPTION = 'Subscription'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CUSTOM_FIELD_OWNER.include?(value)
+    end
+  end
+end