subtain-apimatic-sdk 4.1.1 → 9.1.2

data/lib/advanced_billing/models/refund_prepayment.rb

@@ -0,0 +1,106 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # RefundPrepayment Model.
+  class RefundPrepayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `amount` is not required if you pass `amount_in_cents`.
+    # @return [Float]
+    attr_accessor :amount_in_cents
+
+    # `amount_in_cents` is not required if you pass `amount`.
+    # @return [Object]
+    attr_accessor :amount
+
+    # `amount_in_cents` is not required if you pass `amount`.
+    # @return [String]
+    attr_accessor :memo
+
+    # Specify the type of refund you wish to initiate. When the prepayment is
+    # external, the `external` flag is optional. But if the prepayment was made
+    # through a payment profile, the `external` flag is required.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :external
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['amount'] = 'amount'
+      @_hash['memo'] = 'memo'
+      @_hash['external'] = 'external'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount_in_cents = nil, amount = nil, memo = nil,
+                   external = SKIP)
+      @amount_in_cents = amount_in_cents
+      @amount = amount
+      @memo = memo
+      @external = external unless external == 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.
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : nil
+      amount = hash.key?('amount') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:RefundPrepaymentAmount), hash['amount']
+      ) : nil
+      memo = hash.key?('memo') ? hash['memo'] : nil
+      external = hash.key?('external') ? hash['external'] : SKIP
+
+      # Create object from extracted values.
+      RefundPrepayment.new(amount_in_cents,
+                           amount,
+                           memo,
+                           external)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RefundPrepayment | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.amount_in_cents,
+                                ->(val) { val.instance_of? Float }) and
+            UnionTypeLookUp.get(:RefundPrepaymentAmount)
+                           .validate(value.amount) and
+            APIHelper.valid_type?(value.memo,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['amount_in_cents'],
+                              ->(val) { val.instance_of? Float }) and
+          UnionTypeLookUp.get(:RefundPrepaymentAmount)
+                         .validate(value['amount']) and
+          APIHelper.valid_type?(value['memo'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/refund_prepayment_aggregated_error.rb

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

data/lib/advanced_billing/models/refund_prepayment_base_refund_error.rb

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

data/lib/advanced_billing/models/refund_prepayment_request.rb

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

data/lib/advanced_billing/models/refund_success.rb

@@ -0,0 +1,92 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # RefundSuccess Model.
+  class RefundSuccess < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :refund_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :gateway_transaction_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['refund_id'] = 'refund_id'
+      @_hash['gateway_transaction_id'] = 'gateway_transaction_id'
+      @_hash['product_id'] = 'product_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(refund_id = nil, gateway_transaction_id = nil,
+                   product_id = nil)
+      @refund_id = refund_id
+      @gateway_transaction_id = gateway_transaction_id
+      @product_id = product_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      refund_id = hash.key?('refund_id') ? hash['refund_id'] : nil
+      gateway_transaction_id =
+        hash.key?('gateway_transaction_id') ? hash['gateway_transaction_id'] : nil
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+
+      # Create object from extracted values.
+      RefundSuccess.new(refund_id,
+                        gateway_transaction_id,
+                        product_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RefundSuccess | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.refund_id,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.gateway_transaction_id,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.product_id,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['refund_id'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['gateway_transaction_id'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['product_id'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/remove_payment_event_data.rb

@@ -0,0 +1,131 @@
+# 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 [Object]
+    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[
+        transaction_id
+        memo
+        original_amount
+        applied_amount
+        transaction_time
+        payment_method
+        prepayment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_id = SKIP, memo = SKIP, original_amount = SKIP,
+                   applied_amount = SKIP, transaction_time = SKIP,
+                   payment_method = SKIP, prepayment = SKIP)
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @memo = memo unless memo == SKIP
+      @original_amount = original_amount unless original_amount == SKIP
+      @applied_amount = applied_amount unless applied_amount == SKIP
+      @transaction_time = transaction_time unless transaction_time == SKIP
+      @payment_method = payment_method unless payment_method == SKIP
+      @prepayment = prepayment unless prepayment == 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
+      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
+      transaction_time = if hash.key?('transaction_time')
+                           (DateTimeHelper.from_rfc3339(hash['transaction_time']) if hash['transaction_time'])
+                         else
+                           SKIP
+                         end
+      payment_method = hash.key?('payment_method') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:RemovePaymentEventDataPaymentMethod), hash['payment_method']
+      ) : SKIP
+      prepayment = hash.key?('prepayment') ? hash['prepayment'] : SKIP
+
+      # Create object from extracted values.
+      RemovePaymentEventData.new(transaction_id,
+                                 memo,
+                                 original_amount,
+                                 applied_amount,
+                                 transaction_time,
+                                 payment_method,
+                                 prepayment)
+    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)
+      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.rb

@@ -0,0 +1,157 @@
+# 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