maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/refund_invoice_event_data.rb

@@ -0,0 +1,195 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # Example schema for an `refund_invoice` event
+  class RefundInvoiceEventData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If true, credit was created and applied it to the invoice.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :apply_credit
+
+    # Consolidation level of the invoice, which is applicable to invoice
+    # consolidation.  It will hold one of the following values:
+    # * "none": A normal invoice with no consolidation.
+    # * "child": An invoice segment which has been combined into a consolidated
+    # invoice.
+    # * "parent": A consolidated invoice, whose contents are composed of invoice
+    # segments.
+    # "Parent" invoices do not have lines of their own, but they have subtotals
+    # and totals which aggregate the member invoice segments.
+    # See also the [invoice consolidation
+    # documentation](https://chargify.zendesk.com/hc/en-us/articles/440774639183
+    # 5).
+    # @return [InvoiceConsolidationLevel]
+    attr_accessor :consolidation_level
+
+    # Consolidation level of the invoice, which is applicable to invoice
+    # consolidation.  It will hold one of the following values:
+    # * "none": A normal invoice with no consolidation.
+    # * "child": An invoice segment which has been combined into a consolidated
+    # invoice.
+    # * "parent": A consolidated invoice, whose contents are composed of invoice
+    # segments.
+    # "Parent" invoices do not have lines of their own, but they have subtotals
+    # and totals which aggregate the member invoice segments.
+    # See also the [invoice consolidation
+    # documentation](https://chargify.zendesk.com/hc/en-us/articles/440774639183
+    # 5).
+    # @return [CreditNote]
+    attr_accessor :credit_note_attributes
+
+    # The refund memo.
+    # @return [String]
+    attr_accessor :memo
+
+    # The full, original amount of the refund.
+    # @return [String]
+    attr_accessor :original_amount
+
+    # The ID of the payment transaction to be refunded.
+    # @return [Integer]
+    attr_accessor :payment_id
+
+    # The amount of the refund.
+    # @return [String]
+    attr_accessor :refund_amount
+
+    # The ID of the refund transaction.
+    # @return [Integer]
+    attr_accessor :refund_id
+
+    # The time the refund was applied, in ISO 8601 format, i.e.
+    # "2019-06-07T17:20:06Z"
+    # @return [DateTime]
+    attr_accessor :transaction_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['apply_credit'] = 'apply_credit'
+      @_hash['consolidation_level'] = 'consolidation_level'
+      @_hash['credit_note_attributes'] = 'credit_note_attributes'
+      @_hash['memo'] = 'memo'
+      @_hash['original_amount'] = 'original_amount'
+      @_hash['payment_id'] = 'payment_id'
+      @_hash['refund_amount'] = 'refund_amount'
+      @_hash['refund_id'] = 'refund_id'
+      @_hash['transaction_time'] = 'transaction_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        consolidation_level
+        memo
+        original_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(apply_credit = nil,
+                   credit_note_attributes = nil,
+                   payment_id = nil,
+                   refund_amount = nil,
+                   refund_id = nil,
+                   transaction_time = nil,
+                   consolidation_level = SKIP,
+                   memo = SKIP,
+                   original_amount = SKIP)
+      @apply_credit = apply_credit
+      @consolidation_level = consolidation_level unless consolidation_level == SKIP
+      @credit_note_attributes = credit_note_attributes
+      @memo = memo unless memo == SKIP
+      @original_amount = original_amount unless original_amount == SKIP
+      @payment_id = payment_id
+      @refund_amount = refund_amount
+      @refund_id = refund_id
+      @transaction_time = transaction_time
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      apply_credit = hash.key?('apply_credit') ? hash['apply_credit'] : nil
+      credit_note_attributes = CreditNote.from_hash(hash['credit_note_attributes']) if
+        hash['credit_note_attributes']
+      payment_id = hash.key?('payment_id') ? hash['payment_id'] : nil
+      refund_amount = hash.key?('refund_amount') ? hash['refund_amount'] : nil
+      refund_id = hash.key?('refund_id') ? hash['refund_id'] : nil
+      transaction_time = if hash.key?('transaction_time')
+                           (DateTimeHelper.from_rfc3339(hash['transaction_time']) if hash['transaction_time'])
+                         end
+      consolidation_level =
+        hash.key?('consolidation_level') ? hash['consolidation_level'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      original_amount =
+        hash.key?('original_amount') ? hash['original_amount'] : SKIP
+
+      # Create object from extracted values.
+      RefundInvoiceEventData.new(apply_credit,
+                                 credit_note_attributes,
+                                 payment_id,
+                                 refund_amount,
+                                 refund_id,
+                                 transaction_time,
+                                 consolidation_level,
+                                 memo,
+                                 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 [RefundInvoiceEventData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.apply_credit,
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+            APIHelper.valid_type?(value.credit_note_attributes,
+                                  ->(val) { CreditNote.validate(val) }) and
+            APIHelper.valid_type?(value.payment_id,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.refund_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.refund_id,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.transaction_time,
+                                  ->(val) { val.instance_of? DateTime })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['apply_credit'],
+                              ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+          APIHelper.valid_type?(value['credit_note_attributes'],
+                                ->(val) { CreditNote.validate(val) }) and
+          APIHelper.valid_type?(value['payment_id'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['refund_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['refund_id'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['transaction_time'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/refund_invoice_request.rb

@@ -0,0 +1,64 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # RefundInvoiceRequest Model.
+  class RefundInvoiceRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Refund]
+    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 = hash.key?('refund') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:RefundInvoiceRequestRefund), hash['refund']
+      ) : nil
+
+      # Create object from extracted values.
+      RefundInvoiceRequest.new(refund)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RefundInvoiceRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return UnionTypeLookUp.get(:RefundInvoiceRequestRefund)
+                              .validate(value.refund)
+      end
+
+      return false unless value.instance_of? Hash
+
+      UnionTypeLookUp.get(:RefundInvoiceRequestRefund)
+                     .validate(value['refund'])
+    end
+  end
+end

data/lib/advanced_billing/models/refund_prepayment.rb

@@ -0,0 +1,108 @@
+# 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 [Integer]
+    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? Integer }) 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? Integer }) 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,93 @@
+# 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