maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/remove_payment_event_data.rb

@@ -0,0 +1,155 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # Example schema for an `remove_payment` event
+  class RemovePaymentEventData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Transaction ID of the original payment that was removed
+    # @return [Integer]
+    attr_accessor :transaction_id
+
+    # Memo of the original payment
+    # @return [String]
+    attr_accessor :memo
+
+    # Full amount of the original payment
+    # @return [String]
+    attr_accessor :original_amount
+
+    # Applied amount of the original payment
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # Transaction time of the original payment, 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 flag that shows whether the original payment was a prepayment or not
+    # @return [TrueClass | FalseClass]
+    attr_accessor :prepayment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash['memo'] = 'memo'
+      @_hash['original_amount'] = 'original_amount'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash['transaction_time'] = 'transaction_time'
+      @_hash['payment_method'] = 'payment_method'
+      @_hash['prepayment'] = 'prepayment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        original_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_id = nil,
+                   memo = nil,
+                   applied_amount = nil,
+                   transaction_time = nil,
+                   payment_method = nil,
+                   prepayment = nil,
+                   original_amount = SKIP)
+      @transaction_id = transaction_id
+      @memo = memo
+      @original_amount = original_amount unless original_amount == SKIP
+      @applied_amount = applied_amount
+      @transaction_time = transaction_time
+      @payment_method = payment_method
+      @prepayment = prepayment
+    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'] : nil
+      memo = hash.key?('memo') ? hash['memo'] : 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(:RemovePaymentEventDataPaymentMethod), hash['payment_method']
+      ) : nil
+      prepayment = hash.key?('prepayment') ? hash['prepayment'] : nil
+      original_amount =
+        hash.key?('original_amount') ? hash['original_amount'] : SKIP
+
+      # Create object from extracted values.
+      RemovePaymentEventData.new(transaction_id,
+                                 memo,
+                                 applied_amount,
+                                 transaction_time,
+                                 payment_method,
+                                 prepayment,
+                                 original_amount)
+    end
+
+    def to_custom_transaction_time
+      DateTimeHelper.to_rfc3339(transaction_time)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemovePaymentEventData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.transaction_id,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.memo,
+                                  ->(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(:RemovePaymentEventDataPaymentMethod)
+                           .validate(value.payment_method) and
+            APIHelper.valid_type?(value.prepayment,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['transaction_id'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['memo'],
+                                ->(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(:RemovePaymentEventDataPaymentMethod)
+                         .validate(value['payment_method']) and
+          APIHelper.valid_type?(value['prepayment'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/renewal_preview.rb

@@ -0,0 +1,161 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # RenewalPreview Model.
+  class RenewalPreview < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The timestamp for the subscription’s next renewal
+    # @return [String]
+    attr_accessor :next_assessment_at
+
+    # An integer representing the amount of the total pre-tax, pre-discount
+    # charges that will be assessed at the next renewal
+    # @return [Integer]
+    attr_accessor :subtotal_in_cents
+
+    # An integer representing the total tax charges that will be assessed at the
+    # next renewal
+    # @return [Integer]
+    attr_accessor :total_tax_in_cents
+
+    # An integer representing the amount of the coupon discounts that will be
+    # applied to the next renewal
+    # @return [Integer]
+    attr_accessor :total_discount_in_cents
+
+    # An integer representing the total amount owed, less any discounts, that
+    # will be assessed at the next renewal
+    # @return [Integer]
+    attr_accessor :total_in_cents
+
+    # An integer representing the amount of the subscription’s current balance
+    # @return [Integer]
+    attr_accessor :existing_balance_in_cents
+
+    # An integer representing the existing_balance_in_cents plus the
+    # total_in_cents
+    # @return [Integer]
+    attr_accessor :total_amount_due_in_cents
+
+    # A boolean indicating whether or not additional taxes will be calculated at
+    # the time of renewal. This will be true if you are using Avalara and the
+    # address of the subscription is in one of your defined taxable regions.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :uncalculated_taxes
+
+    # An array of objects representing the individual transactions that will be
+    # created at the next renewal
+    # @return [Array[RenewalPreviewLineItem]]
+    attr_accessor :line_items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['next_assessment_at'] = 'next_assessment_at'
+      @_hash['subtotal_in_cents'] = 'subtotal_in_cents'
+      @_hash['total_tax_in_cents'] = 'total_tax_in_cents'
+      @_hash['total_discount_in_cents'] = 'total_discount_in_cents'
+      @_hash['total_in_cents'] = 'total_in_cents'
+      @_hash['existing_balance_in_cents'] = 'existing_balance_in_cents'
+      @_hash['total_amount_due_in_cents'] = 'total_amount_due_in_cents'
+      @_hash['uncalculated_taxes'] = 'uncalculated_taxes'
+      @_hash['line_items'] = 'line_items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        next_assessment_at
+        subtotal_in_cents
+        total_tax_in_cents
+        total_discount_in_cents
+        total_in_cents
+        existing_balance_in_cents
+        total_amount_due_in_cents
+        uncalculated_taxes
+        line_items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(next_assessment_at = SKIP,
+                   subtotal_in_cents = SKIP,
+                   total_tax_in_cents = SKIP,
+                   total_discount_in_cents = SKIP,
+                   total_in_cents = SKIP,
+                   existing_balance_in_cents = SKIP,
+                   total_amount_due_in_cents = SKIP,
+                   uncalculated_taxes = SKIP,
+                   line_items = SKIP)
+      @next_assessment_at = next_assessment_at unless next_assessment_at == SKIP
+      @subtotal_in_cents = subtotal_in_cents unless subtotal_in_cents == SKIP
+      @total_tax_in_cents = total_tax_in_cents unless total_tax_in_cents == SKIP
+      @total_discount_in_cents = total_discount_in_cents unless total_discount_in_cents == SKIP
+      @total_in_cents = total_in_cents unless total_in_cents == SKIP
+      unless existing_balance_in_cents == SKIP
+        @existing_balance_in_cents =
+          existing_balance_in_cents
+      end
+      unless total_amount_due_in_cents == SKIP
+        @total_amount_due_in_cents =
+          total_amount_due_in_cents
+      end
+      @uncalculated_taxes = uncalculated_taxes unless uncalculated_taxes == SKIP
+      @line_items = line_items unless line_items == 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.
+      next_assessment_at =
+        hash.key?('next_assessment_at') ? hash['next_assessment_at'] : SKIP
+      subtotal_in_cents =
+        hash.key?('subtotal_in_cents') ? hash['subtotal_in_cents'] : SKIP
+      total_tax_in_cents =
+        hash.key?('total_tax_in_cents') ? hash['total_tax_in_cents'] : SKIP
+      total_discount_in_cents =
+        hash.key?('total_discount_in_cents') ? hash['total_discount_in_cents'] : SKIP
+      total_in_cents =
+        hash.key?('total_in_cents') ? hash['total_in_cents'] : SKIP
+      existing_balance_in_cents =
+        hash.key?('existing_balance_in_cents') ? hash['existing_balance_in_cents'] : SKIP
+      total_amount_due_in_cents =
+        hash.key?('total_amount_due_in_cents') ? hash['total_amount_due_in_cents'] : SKIP
+      uncalculated_taxes =
+        hash.key?('uncalculated_taxes') ? hash['uncalculated_taxes'] : SKIP
+      # 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 << (RenewalPreviewLineItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = SKIP unless hash.key?('line_items')
+
+      # Create object from extracted values.
+      RenewalPreview.new(next_assessment_at,
+                         subtotal_in_cents,
+                         total_tax_in_cents,
+                         total_discount_in_cents,
+                         total_in_cents,
+                         existing_balance_in_cents,
+                         total_amount_due_in_cents,
+                         uncalculated_taxes,
+                         line_items)
+    end
+  end
+end

data/lib/advanced_billing/models/renewal_preview_component.rb

@@ -0,0 +1,93 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # RenewalPreviewComponent Model.
+  class RenewalPreviewComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Either the component's Chargify id or its handle prefixed with `handle:`
+    # @return [Object]
+    attr_accessor :component_id
+
+    # The quantity for which you wish to preview billing. This is useful if you
+    # want to preview a predicted, higher usage value than is currently present
+    # on the subscription.
+    # This quantity represents:
+    # - Whether or not an on/off component is enabled - use 0 for disabled or 1
+    # for enabled
+    # - The desired allocated_quantity for a quantity-based component
+    # - The desired unit_balance for a metered component
+    # - The desired metric quantity for an events-based component
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # Either the component price point's Chargify id or its handle prefixed with
+    # `handle:`
+    # @return [Object]
+    attr_accessor :price_point_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['component_id'] = 'component_id'
+      @_hash['quantity'] = 'quantity'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        component_id
+        quantity
+        price_point_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(component_id = SKIP,
+                   quantity = SKIP,
+                   price_point_id = SKIP)
+      @component_id = component_id unless component_id == SKIP
+      @quantity = quantity unless quantity == 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.
+      component_id = hash.key?('component_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:RenewalPreviewComponentComponentId), hash['component_id']
+      ) : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      price_point_id = hash.key?('price_point_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:RenewalPreviewComponentPricePointId), hash['price_point_id']
+      ) : SKIP
+
+      # Create object from extracted values.
+      RenewalPreviewComponent.new(component_id,
+                                  quantity,
+                                  price_point_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RenewalPreviewComponent | 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/renewal_preview_line_item.rb

@@ -0,0 +1,189 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # RenewalPreviewLineItem Model.
+  class RenewalPreviewLineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A handle for the line item transaction type
+    # @return [LineItemTransactionType]
+    attr_accessor :transaction_type
+
+    # A handle for the line item kind
+    # @return [LineItemKind]
+    attr_accessor :kind
+
+    # A handle for the line item kind
+    # @return [Integer]
+    attr_accessor :amount_in_cents
+
+    # A handle for the line item kind
+    # @return [String]
+    attr_accessor :memo
+
+    # A handle for the line item kind
+    # @return [Integer]
+    attr_accessor :discount_amount_in_cents
+
+    # A handle for the line item kind
+    # @return [Integer]
+    attr_accessor :taxable_amount_in_cents
+
+    # A handle for the line item kind
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # A handle for the line item kind
+    # @return [String]
+    attr_accessor :product_name
+
+    # A handle for the line item kind
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # A handle for the line item kind
+    # @return [String]
+    attr_accessor :component_handle
+
+    # A handle for the line item kind
+    # @return [String]
+    attr_accessor :component_name
+
+    # A handle for the line item kind
+    # @return [String]
+    attr_accessor :product_handle
+
+    # A handle for the line item kind
+    # @return [String]
+    attr_accessor :period_range_start
+
+    # A handle for the line item kind
+    # @return [String]
+    attr_accessor :period_range_end
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_type'] = 'transaction_type'
+      @_hash['kind'] = 'kind'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['memo'] = 'memo'
+      @_hash['discount_amount_in_cents'] = 'discount_amount_in_cents'
+      @_hash['taxable_amount_in_cents'] = 'taxable_amount_in_cents'
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_name'] = 'product_name'
+      @_hash['component_id'] = 'component_id'
+      @_hash['component_handle'] = 'component_handle'
+      @_hash['component_name'] = 'component_name'
+      @_hash['product_handle'] = 'product_handle'
+      @_hash['period_range_start'] = 'period_range_start'
+      @_hash['period_range_end'] = 'period_range_end'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_type
+        kind
+        amount_in_cents
+        memo
+        discount_amount_in_cents
+        taxable_amount_in_cents
+        product_id
+        product_name
+        component_id
+        component_handle
+        component_name
+        product_handle
+        period_range_start
+        period_range_end
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_type = SKIP,
+                   kind = SKIP,
+                   amount_in_cents = SKIP,
+                   memo = SKIP,
+                   discount_amount_in_cents = SKIP,
+                   taxable_amount_in_cents = SKIP,
+                   product_id = SKIP,
+                   product_name = SKIP,
+                   component_id = SKIP,
+                   component_handle = SKIP,
+                   component_name = SKIP,
+                   product_handle = SKIP,
+                   period_range_start = SKIP,
+                   period_range_end = SKIP)
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @kind = kind unless kind == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      @memo = memo unless memo == SKIP
+      @discount_amount_in_cents = discount_amount_in_cents unless discount_amount_in_cents == SKIP
+      @taxable_amount_in_cents = taxable_amount_in_cents unless taxable_amount_in_cents == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @component_id = component_id unless component_id == SKIP
+      @component_handle = component_handle unless component_handle == SKIP
+      @component_name = component_name unless component_name == SKIP
+      @product_handle = product_handle unless product_handle == SKIP
+      @period_range_start = period_range_start unless period_range_start == SKIP
+      @period_range_end = period_range_end unless period_range_end == 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_type =
+        hash.key?('transaction_type') ? hash['transaction_type'] : SKIP
+      kind = hash.key?('kind') ? hash['kind'] : SKIP
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      discount_amount_in_cents =
+        hash.key?('discount_amount_in_cents') ? hash['discount_amount_in_cents'] : SKIP
+      taxable_amount_in_cents =
+        hash.key?('taxable_amount_in_cents') ? hash['taxable_amount_in_cents'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      product_name = hash.key?('product_name') ? hash['product_name'] : SKIP
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      component_handle =
+        hash.key?('component_handle') ? hash['component_handle'] : SKIP
+      component_name =
+        hash.key?('component_name') ? hash['component_name'] : SKIP
+      product_handle =
+        hash.key?('product_handle') ? hash['product_handle'] : 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
+
+      # Create object from extracted values.
+      RenewalPreviewLineItem.new(transaction_type,
+                                 kind,
+                                 amount_in_cents,
+                                 memo,
+                                 discount_amount_in_cents,
+                                 taxable_amount_in_cents,
+                                 product_id,
+                                 product_name,
+                                 component_id,
+                                 component_handle,
+                                 component_name,
+                                 product_handle,
+                                 period_range_start,
+                                 period_range_end)
+    end
+  end
+end

data/lib/advanced_billing/models/renewal_preview_request.rb

@@ -0,0 +1,62 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # RenewalPreviewRequest Model.
+  class RenewalPreviewRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An optional array of component definitions to preview. Providing any
+    # component definitions here will override the actual components on the
+    # subscription (and their quantities), and the billing preview will contain
+    # only these components (in addition to any product base fees).
+    # @return [Array[RenewalPreviewComponent]]
+    attr_accessor :components
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['components'] = 'components'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        components
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(components = SKIP)
+      @components = components unless components == 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.
+      # Parameter is an array, so we need to iterate through it
+      components = nil
+      unless hash['components'].nil?
+        components = []
+        hash['components'].each do |structure|
+          components << (RenewalPreviewComponent.from_hash(structure) if structure)
+        end
+      end
+
+      components = SKIP unless hash.key?('components')
+
+      # Create object from extracted values.
+      RenewalPreviewRequest.new(components)
+    end
+  end
+end