subtain-apimatic-sdk 4.1.1 → 9.1.2

data/lib/advanced_billing/models/invoice_refund.rb

@@ -0,0 +1,113 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoiceRefund Model.
+  class InvoiceRefund < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :transaction_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :payment_id
+
+    # 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
+
+    # The transaction ID for the refund 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_id'] = 'transaction_id'
+      @_hash['payment_id'] = 'payment_id'
+      @_hash['memo'] = 'memo'
+      @_hash['original_amount'] = 'original_amount'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash['gateway_transaction_id'] = 'gateway_transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_id
+        payment_id
+        memo
+        original_amount
+        applied_amount
+        gateway_transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        gateway_transaction_id
+      ]
+    end
+
+    def initialize(transaction_id = SKIP, payment_id = SKIP, memo = SKIP,
+                   original_amount = SKIP, applied_amount = SKIP,
+                   gateway_transaction_id = SKIP)
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @payment_id = payment_id unless payment_id == SKIP
+      @memo = memo unless memo == SKIP
+      @original_amount = original_amount unless original_amount == SKIP
+      @applied_amount = applied_amount unless applied_amount == 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_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : SKIP
+      payment_id = hash.key?('payment_id') ? hash['payment_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
+      gateway_transaction_id =
+        hash.key?('gateway_transaction_id') ? hash['gateway_transaction_id'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceRefund.new(transaction_id,
+                        payment_id,
+                        memo,
+                        original_amount,
+                        applied_amount,
+                        gateway_transaction_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceRefund | 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_response.rb

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

data/lib/advanced_billing/models/invoice_seller.rb

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

@@ -0,0 +1,41 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Invoice Sort Field.
+  class InvoiceSortField
+    INVOICE_SORT_FIELD = [
+      # TODO: Write general description for STATUS
+      STATUS = 'status'.freeze,
+
+      # TODO: Write general description for TOTAL_AMOUNT
+      TOTAL_AMOUNT = 'total_amount'.freeze,
+
+      # TODO: Write general description for DUE_AMOUNT
+      DUE_AMOUNT = 'due_amount'.freeze,
+
+      # TODO: Write general description for CREATED_AT
+      CREATED_AT = 'created_at'.freeze,
+
+      # TODO: Write general description for UPDATED_AT
+      UPDATED_AT = 'updated_at'.freeze,
+
+      # TODO: Write general description for ISSUE_DATE
+      ISSUE_DATE = 'issue_date'.freeze,
+
+      # TODO: Write general description for DUE_DATE
+      DUE_DATE = 'due_date'.freeze,
+
+      # TODO: Write general description for NUMBER
+      NUMBER = 'number'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_SORT_FIELD.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_tax.rb

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

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

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

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