subtain-apimatic-sdk 2.4.69 → 3.1.0

data/lib/advanced_billing/models/referral_code.rb

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

data/lib/advanced_billing/models/referral_validation_response.rb

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

data/lib/advanced_billing/models/refund.rb

@@ -1,128 +0,0 @@
-# advanced_billing
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module AdvancedBilling
-  # Refund Model.
-  class Refund < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # The amount to be refunded in decimal format as a string. Example: "10.50".
-    # Must not exceed the remaining refundable balance of the payment.
-    # @return [String]
-    attr_accessor :amount
-
-    # A description that will be attached to the refund
-    # @return [String]
-    attr_accessor :memo
-
-    # The ID of the payment to be refunded
-    # @return [Integer]
-    attr_accessor :payment_id
-
-    # Flag that marks refund as external (no money is returned to the customer).
-    # Defaults to `false`.
-    # @return [TrueClass | FalseClass]
-    attr_accessor :external
-
-    # If set to true, creates credit and applies it to an invoice. Defaults to
-    # `false`.
-    # @return [TrueClass | FalseClass]
-    attr_accessor :apply_credit
-
-    # If `apply_credit` set to false and refunding full amount, if
-    # `void_invoice` set to true, invoice will be voided after refund. Defaults
-    # to `false`.
-    # @return [TrueClass | FalseClass]
-    attr_accessor :void_invoice
-
-    # An array of segment uids to refund or the string 'all' to indicate that
-    # all segments should be refunded
-    # @return [Object]
-    attr_accessor :segment_uids
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['amount'] = 'amount'
-      @_hash['memo'] = 'memo'
-      @_hash['payment_id'] = 'payment_id'
-      @_hash['external'] = 'external'
-      @_hash['apply_credit'] = 'apply_credit'
-      @_hash['void_invoice'] = 'void_invoice'
-      @_hash['segment_uids'] = 'segment_uids'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        amount
-        memo
-        payment_id
-        external
-        apply_credit
-        void_invoice
-        segment_uids
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(amount = SKIP,
-                   memo = SKIP,
-                   payment_id = SKIP,
-                   external = SKIP,
-                   apply_credit = SKIP,
-                   void_invoice = SKIP,
-                   segment_uids = SKIP)
-      @amount = amount unless amount == SKIP
-      @memo = memo unless memo == SKIP
-      @payment_id = payment_id unless payment_id == SKIP
-      @external = external unless external == SKIP
-      @apply_credit = apply_credit unless apply_credit == SKIP
-      @void_invoice = void_invoice unless void_invoice == SKIP
-      @segment_uids = segment_uids unless segment_uids == 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 = hash.key?('amount') ? hash['amount'] : SKIP
-      memo = hash.key?('memo') ? hash['memo'] : SKIP
-      payment_id = hash.key?('payment_id') ? hash['payment_id'] : SKIP
-      external = hash.key?('external') ? hash['external'] : SKIP
-      apply_credit = hash.key?('apply_credit') ? hash['apply_credit'] : SKIP
-      void_invoice = hash.key?('void_invoice') ? hash['void_invoice'] : SKIP
-      segment_uids = hash.key?('segment_uids') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:RefundSegmentUids), hash['segment_uids']
-      ) : SKIP
-
-      # Create object from extracted values.
-      Refund.new(amount,
-                 memo,
-                 payment_id,
-                 external,
-                 apply_credit,
-                 void_invoice,
-                 segment_uids)
-    end
-
-    # Validates an instance of the object from a given value.
-    # @param [Refund | 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/refund_consolidated_invoice.rb

@@ -1,129 +0,0 @@
-# advanced_billing
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module AdvancedBilling
-  # Refund consolidated invoice
-  class RefundConsolidatedInvoice < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # A description for the refund
-    # @return [String]
-    attr_accessor :memo
-
-    # The ID of the payment to be refunded
-    # @return [Integer]
-    attr_accessor :payment_id
-
-    # An array of segment uids to refund or the string 'all' to indicate that
-    # all segments should be refunded
-    # @return [Object]
-    attr_accessor :segment_uids
-
-    # Flag that marks refund as external (no money is returned to the customer).
-    # Defaults to `false`.
-    # @return [TrueClass | FalseClass]
-    attr_accessor :external
-
-    # If set to true, creates credit and applies it to an invoice. Defaults to
-    # `false`.
-    # @return [TrueClass | FalseClass]
-    attr_accessor :apply_credit
-
-    # The amount of payment to be refunded in decimal format. Example: "10.50".
-    # This will default to the full amount of the payment if not provided.
-    # @return [String]
-    attr_accessor :amount
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['memo'] = 'memo'
-      @_hash['payment_id'] = 'payment_id'
-      @_hash['segment_uids'] = 'segment_uids'
-      @_hash['external'] = 'external'
-      @_hash['apply_credit'] = 'apply_credit'
-      @_hash['amount'] = 'amount'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        external
-        apply_credit
-        amount
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(memo = nil,
-                   payment_id = nil,
-                   segment_uids = nil,
-                   external = SKIP,
-                   apply_credit = SKIP,
-                   amount = SKIP)
-      @memo = memo
-      @payment_id = payment_id
-      @segment_uids = segment_uids
-      @external = external unless external == SKIP
-      @apply_credit = apply_credit unless apply_credit == SKIP
-      @amount = amount unless amount == 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.
-      memo = hash.key?('memo') ? hash['memo'] : nil
-      payment_id = hash.key?('payment_id') ? hash['payment_id'] : nil
-      segment_uids = hash.key?('segment_uids') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:RefundConsolidatedInvoiceSegmentUids), hash['segment_uids']
-      ) : nil
-      external = hash.key?('external') ? hash['external'] : SKIP
-      apply_credit = hash.key?('apply_credit') ? hash['apply_credit'] : SKIP
-      amount = hash.key?('amount') ? hash['amount'] : SKIP
-
-      # Create object from extracted values.
-      RefundConsolidatedInvoice.new(memo,
-                                    payment_id,
-                                    segment_uids,
-                                    external,
-                                    apply_credit,
-                                    amount)
-    end
-
-    # Validates an instance of the object from a given value.
-    # @param [RefundConsolidatedInvoice | Hash] The value against the validation is performed.
-    def self.validate(value)
-      if value.instance_of? self
-        return (
-          APIHelper.valid_type?(value.memo,
-                                ->(val) { val.instance_of? String }) and
-            APIHelper.valid_type?(value.payment_id,
-                                  ->(val) { val.instance_of? Integer }) and
-            UnionTypeLookUp.get(:RefundConsolidatedInvoiceSegmentUids)
-                           .validate(value.segment_uids)
-        )
-      end
-
-      return false unless value.instance_of? Hash
-
-      (
-        APIHelper.valid_type?(value['memo'],
-                              ->(val) { val.instance_of? String }) and
-          APIHelper.valid_type?(value['payment_id'],
-                                ->(val) { val.instance_of? Integer }) and
-          UnionTypeLookUp.get(:RefundConsolidatedInvoiceSegmentUids)
-                         .validate(value['segment_uids'])
-      )
-    end
-  end
-end

data/lib/advanced_billing/models/refund_invoice.rb

@@ -1,128 +0,0 @@
-# advanced_billing
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module AdvancedBilling
-  # Refund an invoice or a segment of a consolidated invoice.
-  class RefundInvoice < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # The amount to be refunded in decimal format as a string. Example: "10.50".
-    # Must not exceed the remaining refundable balance of the payment.
-    # @return [String]
-    attr_accessor :amount
-
-    # A description that will be attached to the refund
-    # @return [String]
-    attr_accessor :memo
-
-    # The ID of the payment to be refunded
-    # @return [Integer]
-    attr_accessor :payment_id
-
-    # Flag that marks refund as external (no money is returned to the customer).
-    # Defaults to `false`.
-    # @return [TrueClass | FalseClass]
-    attr_accessor :external
-
-    # If set to true, creates credit and applies it to an invoice. Defaults to
-    # `false`.
-    # @return [TrueClass | FalseClass]
-    attr_accessor :apply_credit
-
-    # If `apply_credit` set to false and refunding full amount, if
-    # `void_invoice` set to true, invoice will be voided after refund. Defaults
-    # to `false`.
-    # @return [TrueClass | FalseClass]
-    attr_accessor :void_invoice
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['amount'] = 'amount'
-      @_hash['memo'] = 'memo'
-      @_hash['payment_id'] = 'payment_id'
-      @_hash['external'] = 'external'
-      @_hash['apply_credit'] = 'apply_credit'
-      @_hash['void_invoice'] = 'void_invoice'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        external
-        apply_credit
-        void_invoice
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(amount = nil,
-                   memo = nil,
-                   payment_id = nil,
-                   external = SKIP,
-                   apply_credit = SKIP,
-                   void_invoice = SKIP)
-      @amount = amount
-      @memo = memo
-      @payment_id = payment_id
-      @external = external unless external == SKIP
-      @apply_credit = apply_credit unless apply_credit == SKIP
-      @void_invoice = void_invoice unless void_invoice == 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 = hash.key?('amount') ? hash['amount'] : nil
-      memo = hash.key?('memo') ? hash['memo'] : nil
-      payment_id = hash.key?('payment_id') ? hash['payment_id'] : nil
-      external = hash.key?('external') ? hash['external'] : SKIP
-      apply_credit = hash.key?('apply_credit') ? hash['apply_credit'] : SKIP
-      void_invoice = hash.key?('void_invoice') ? hash['void_invoice'] : SKIP
-
-      # Create object from extracted values.
-      RefundInvoice.new(amount,
-                        memo,
-                        payment_id,
-                        external,
-                        apply_credit,
-                        void_invoice)
-    end
-
-    # Validates an instance of the object from a given value.
-    # @param [RefundInvoice | Hash] The value against the validation is performed.
-    def self.validate(value)
-      if value.instance_of? self
-        return (
-          APIHelper.valid_type?(value.amount,
-                                ->(val) { val.instance_of? String }) and
-            APIHelper.valid_type?(value.memo,
-                                  ->(val) { val.instance_of? String }) and
-            APIHelper.valid_type?(value.payment_id,
-                                  ->(val) { val.instance_of? Integer })
-        )
-      end
-
-      return false unless value.instance_of? Hash
-
-      (
-        APIHelper.valid_type?(value['amount'],
-                              ->(val) { val.instance_of? String }) and
-          APIHelper.valid_type?(value['memo'],
-                                ->(val) { val.instance_of? String }) and
-          APIHelper.valid_type?(value['payment_id'],
-                                ->(val) { val.instance_of? Integer })
-      )
-    end
-  end
-end

data/lib/advanced_billing/models/refund_invoice_event_data.rb

@@ -1,175 +0,0 @@
-# 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[
-        apply_credit
-        consolidation_level
-        credit_note_attributes
-        memo
-        original_amount
-        payment_id
-        refund_amount
-        refund_id
-        transaction_time
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(apply_credit = SKIP,
-                   consolidation_level = SKIP,
-                   credit_note_attributes = SKIP,
-                   memo = SKIP,
-                   original_amount = SKIP,
-                   payment_id = SKIP,
-                   refund_amount = SKIP,
-                   refund_id = SKIP,
-                   transaction_time = SKIP)
-      @apply_credit = apply_credit unless apply_credit == SKIP
-      @consolidation_level = consolidation_level unless consolidation_level == SKIP
-      @credit_note_attributes = credit_note_attributes unless credit_note_attributes == SKIP
-      @memo = memo unless memo == SKIP
-      @original_amount = original_amount unless original_amount == SKIP
-      @payment_id = payment_id unless payment_id == SKIP
-      @refund_amount = refund_amount unless refund_amount == SKIP
-      @refund_id = refund_id unless refund_id == SKIP
-      @transaction_time = transaction_time unless transaction_time == 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.
-      apply_credit = hash.key?('apply_credit') ? hash['apply_credit'] : SKIP
-      consolidation_level =
-        hash.key?('consolidation_level') ? hash['consolidation_level'] : SKIP
-      credit_note_attributes = CreditNote.from_hash(hash['credit_note_attributes']) if
-        hash['credit_note_attributes']
-      memo = hash.key?('memo') ? hash['memo'] : SKIP
-      original_amount =
-        hash.key?('original_amount') ? hash['original_amount'] : SKIP
-      payment_id = hash.key?('payment_id') ? hash['payment_id'] : SKIP
-      refund_amount = hash.key?('refund_amount') ? hash['refund_amount'] : SKIP
-      refund_id = hash.key?('refund_id') ? hash['refund_id'] : SKIP
-      transaction_time = if hash.key?('transaction_time')
-                           (DateTimeHelper.from_rfc3339(hash['transaction_time']) if hash['transaction_time'])
-                         else
-                           SKIP
-                         end
-
-      # Create object from extracted values.
-      RefundInvoiceEventData.new(apply_credit,
-                                 consolidation_level,
-                                 credit_note_attributes,
-                                 memo,
-                                 original_amount,
-                                 payment_id,
-                                 refund_amount,
-                                 refund_id,
-                                 transaction_time)
-    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)
-      return true if value.instance_of? self
-
-      return false unless value.instance_of? Hash
-
-      true
-    end
-  end
-end