subtain-apimatic-sdk 4.1.1 → 9.1.2

data/lib/advanced_billing/models/invoice_line_item_pricing_detail.rb

@@ -0,0 +1,69 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoiceLineItemPricingDetail Model.
+  class InvoiceLineItemPricingDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :label
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['label'] = 'label'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        label
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(label = SKIP, amount = SKIP)
+      @label = label unless label == 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.
+      label = hash.key?('label') ? hash['label'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceLineItemPricingDetail.new(label,
+                                       amount)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceLineItemPricingDetail | 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/invoice_payer.rb

@@ -0,0 +1,109 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoicePayer Model.
+  class InvoicePayer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :chargify_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :first_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :last_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :organization
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :email
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :vat_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['chargify_id'] = 'chargify_id'
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['organization'] = 'organization'
+      @_hash['email'] = 'email'
+      @_hash['vat_number'] = 'vat_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        chargify_id
+        first_name
+        last_name
+        organization
+        email
+        vat_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        organization
+        vat_number
+      ]
+    end
+
+    def initialize(chargify_id = SKIP, first_name = SKIP, last_name = SKIP,
+                   organization = SKIP, email = SKIP, vat_number = SKIP)
+      @chargify_id = chargify_id unless chargify_id == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @organization = organization unless organization == SKIP
+      @email = email unless email == SKIP
+      @vat_number = vat_number unless vat_number == 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.
+      chargify_id = hash.key?('chargify_id') ? hash['chargify_id'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      organization = hash.key?('organization') ? hash['organization'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      vat_number = hash.key?('vat_number') ? hash['vat_number'] : SKIP
+
+      # Create object from extracted values.
+      InvoicePayer.new(chargify_id,
+                       first_name,
+                       last_name,
+                       organization,
+                       email,
+                       vat_number)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoicePayer | 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/invoice_payment.rb

@@ -0,0 +1,155 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoicePayment Model.
+  class InvoicePayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :transaction_time
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :memo
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :original_amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # TODO: Write general description for this method
+    # @return [InvoicePaymentMethod]
+    attr_accessor :payment_method
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :transaction_id
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :prepayment
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :gateway_handle
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :gateway_used
+
+    # The transaction ID for the payment as returned from the payment gateway
+    # @return [String]
+    attr_accessor :gateway_transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_time'] = 'transaction_time'
+      @_hash['memo'] = 'memo'
+      @_hash['original_amount'] = 'original_amount'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash['payment_method'] = 'payment_method'
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash['prepayment'] = 'prepayment'
+      @_hash['gateway_handle'] = 'gateway_handle'
+      @_hash['gateway_used'] = 'gateway_used'
+      @_hash['gateway_transaction_id'] = 'gateway_transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_time
+        memo
+        original_amount
+        applied_amount
+        payment_method
+        transaction_id
+        prepayment
+        gateway_handle
+        gateway_used
+        gateway_transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        gateway_handle
+        gateway_transaction_id
+      ]
+    end
+
+    def initialize(transaction_time = SKIP, memo = SKIP, original_amount = SKIP,
+                   applied_amount = SKIP, payment_method = SKIP,
+                   transaction_id = SKIP, prepayment = SKIP,
+                   gateway_handle = SKIP, gateway_used = SKIP,
+                   gateway_transaction_id = SKIP)
+      @transaction_time = transaction_time unless transaction_time == SKIP
+      @memo = memo unless memo == SKIP
+      @original_amount = original_amount unless original_amount == SKIP
+      @applied_amount = applied_amount unless applied_amount == SKIP
+      @payment_method = payment_method unless payment_method == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @prepayment = prepayment unless prepayment == SKIP
+      @gateway_handle = gateway_handle unless gateway_handle == SKIP
+      @gateway_used = gateway_used unless gateway_used == SKIP
+      @gateway_transaction_id = gateway_transaction_id unless gateway_transaction_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.
+      transaction_time =
+        hash.key?('transaction_time') ? hash['transaction_time'] : 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
+      payment_method = InvoicePaymentMethod.from_hash(hash['payment_method']) if
+        hash['payment_method']
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : SKIP
+      prepayment = hash.key?('prepayment') ? hash['prepayment'] : SKIP
+      gateway_handle =
+        hash.key?('gateway_handle') ? hash['gateway_handle'] : SKIP
+      gateway_used = hash.key?('gateway_used') ? hash['gateway_used'] : SKIP
+      gateway_transaction_id =
+        hash.key?('gateway_transaction_id') ? hash['gateway_transaction_id'] : SKIP
+
+      # Create object from extracted values.
+      InvoicePayment.new(transaction_time,
+                         memo,
+                         original_amount,
+                         applied_amount,
+                         payment_method,
+                         transaction_id,
+                         prepayment,
+                         gateway_handle,
+                         gateway_used,
+                         gateway_transaction_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoicePayment | 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/invoice_payment_application.rb

@@ -0,0 +1,73 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoicePaymentApplication Model.
+  class InvoicePaymentApplication < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the paid invoice. It has the prefix "inv_" followed
+    # by alphanumeric characters.
+    # @return [String]
+    attr_accessor :invoice_uid
+
+    # Unique identifier for the payment. It has the prefix "pmt_" followed by
+    # alphanumeric characters.
+    # @return [String]
+    attr_accessor :application_uid
+
+    # Dollar amount of the paid invoice.
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['invoice_uid'] = 'invoice_uid'
+      @_hash['application_uid'] = 'application_uid'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        invoice_uid
+        application_uid
+        applied_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(invoice_uid = SKIP, application_uid = SKIP,
+                   applied_amount = SKIP)
+      @invoice_uid = invoice_uid unless invoice_uid == SKIP
+      @application_uid = application_uid unless application_uid == SKIP
+      @applied_amount = applied_amount unless applied_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.
+      invoice_uid = hash.key?('invoice_uid') ? hash['invoice_uid'] : SKIP
+      application_uid =
+        hash.key?('application_uid') ? hash['application_uid'] : SKIP
+      applied_amount =
+        hash.key?('applied_amount') ? hash['applied_amount'] : SKIP
+
+      # Create object from extracted values.
+      InvoicePaymentApplication.new(invoice_uid,
+                                    application_uid,
+                                    applied_amount)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_payment_method.rb

@@ -0,0 +1,129 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoicePaymentMethod Model.
+  class InvoicePaymentMethod < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :details
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :kind
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :memo
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :card_brand
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :card_expiration
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :last_four
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :masked_card_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['details'] = 'details'
+      @_hash['kind'] = 'kind'
+      @_hash['memo'] = 'memo'
+      @_hash['type'] = 'type'
+      @_hash['card_brand'] = 'card_brand'
+      @_hash['card_expiration'] = 'card_expiration'
+      @_hash['last_four'] = 'last_four'
+      @_hash['masked_card_number'] = 'masked_card_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        details
+        kind
+        memo
+        type
+        card_brand
+        card_expiration
+        last_four
+        masked_card_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        last_four
+      ]
+    end
+
+    def initialize(details = SKIP, kind = SKIP, memo = SKIP, type = SKIP,
+                   card_brand = SKIP, card_expiration = SKIP, last_four = SKIP,
+                   masked_card_number = SKIP)
+      @details = details unless details == SKIP
+      @kind = kind unless kind == SKIP
+      @memo = memo unless memo == SKIP
+      @type = type unless type == SKIP
+      @card_brand = card_brand unless card_brand == SKIP
+      @card_expiration = card_expiration unless card_expiration == SKIP
+      @last_four = last_four unless last_four == SKIP
+      @masked_card_number = masked_card_number unless masked_card_number == 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.
+      details = hash.key?('details') ? hash['details'] : SKIP
+      kind = hash.key?('kind') ? hash['kind'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      card_brand = hash.key?('card_brand') ? hash['card_brand'] : SKIP
+      card_expiration =
+        hash.key?('card_expiration') ? hash['card_expiration'] : SKIP
+      last_four = hash.key?('last_four') ? hash['last_four'] : SKIP
+      masked_card_number =
+        hash.key?('masked_card_number') ? hash['masked_card_number'] : SKIP
+
+      # Create object from extracted values.
+      InvoicePaymentMethod.new(details,
+                               kind,
+                               memo,
+                               type,
+                               card_brand,
+                               card_expiration,
+                               last_four,
+                               masked_card_number)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoicePaymentMethod | 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/invoice_payment_method_type.rb

@@ -0,0 +1,35 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The type of payment method used.
+  class InvoicePaymentMethodType
+    INVOICE_PAYMENT_METHOD_TYPE = [
+      # TODO: Write general description for CREDIT_CARD
+      CREDIT_CARD = 'credit_card'.freeze,
+
+      # TODO: Write general description for CHECK
+      CHECK = 'check'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'cash'.freeze,
+
+      # TODO: Write general description for MONEY_ORDER
+      MONEY_ORDER = 'money_order'.freeze,
+
+      # TODO: Write general description for ACH
+      ACH = 'ach'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_PAYMENT_METHOD_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_payment_type.rb

@@ -0,0 +1,29 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The type of payment to be applied to an Invoice.
+  class InvoicePaymentType
+    INVOICE_PAYMENT_TYPE = [
+      # TODO: Write general description for EXTERNAL
+      EXTERNAL = 'external'.freeze,
+
+      # TODO: Write general description for PREPAYMENT
+      PREPAYMENT = 'prepayment'.freeze,
+
+      # TODO: Write general description for SERVICE_CREDIT
+      SERVICE_CREDIT = 'service_credit'.freeze,
+
+      # TODO: Write general description for PAYMENT
+      PAYMENT = 'payment'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_PAYMENT_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_previous_balance.rb

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