visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/invoice_details1.rb

@@ -0,0 +1,62 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # invoice Details
+  class InvoiceDetails1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Barcode ID scanned from the Payment Application.
+    # @return [String]
+    attr_accessor :barcode_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['barcode_number'] = 'barcodeNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        barcode_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(barcode_number = SKIP)
+      @barcode_number = barcode_number unless barcode_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.
+      barcode_number = hash.key?('barcodeNumber') ? hash['barcodeNumber'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceDetails1.new(barcode_number)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} barcode_number: #{@barcode_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} barcode_number: #{@barcode_number.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/invoice_details12.rb

@@ -0,0 +1,74 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # InvoiceDetails12 Model.
+  class InvoiceDetails12 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Cost centre of the merchant.
+    # @return [String]
+    attr_accessor :cost_center
+
+    # Brief description of item.
+    # @return [String]
+    attr_accessor :product_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cost_center'] = 'costCenter'
+      @_hash['product_description'] = 'productDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cost_center
+        product_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cost_center = SKIP, product_description = SKIP)
+      @cost_center = cost_center unless cost_center == SKIP
+      @product_description = product_description unless product_description == 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.
+      cost_center = hash.key?('costCenter') ? hash['costCenter'] : SKIP
+      product_description =
+        hash.key?('productDescription') ? hash['productDescription'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceDetails12.new(cost_center,
+                           product_description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cost_center: #{@cost_center}, product_description:"\
+      " #{@product_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cost_center: #{@cost_center.inspect}, product_description:"\
+      " #{@product_description.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/invoice_details14.rb

@@ -0,0 +1,63 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # InvoiceDetails14 Model.
+  class InvoiceDetails14 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Brief description of item.
+    # @return [String]
+    attr_accessor :product_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_description'] = 'productDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_description = SKIP)
+      @product_description = product_description unless product_description == 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.
+      product_description =
+        hash.key?('productDescription') ? hash['productDescription'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceDetails14.new(product_description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_description: #{@product_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_description: #{@product_description.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/invoice_details16.rb

@@ -0,0 +1,78 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # InvoiceDetails16 Model.
+  class InvoiceDetails16 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Transaction identifier that is generated. You have the option of printing
+    # the sales slip number on the receipt.
+    # This field is supported only on Visa Acceptance through Visanet and JCN
+    # gateway.
+    # Optional field.
+    # #### Card Present processing message
+    # If you included this field in the request, the returned value is the value
+    # that you sent in the request.
+    # If you did not include this field in the request, the system generated
+    # this value for you.
+    # The difference between this reply field and the
+    # `processorInformation.systemTraceAuditNumber` field is that the
+    # system generates the system trace audit number (STAN), and you must print
+    # the receipt number on the receipt;
+    # whereas you can generate the sales slip number, and you can choose to
+    # print the sales slip number on the receipt.
+    # @return [Integer]
+    attr_accessor :sales_slip_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['sales_slip_number'] = 'salesSlipNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sales_slip_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(sales_slip_number = SKIP)
+      @sales_slip_number = sales_slip_number unless sales_slip_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.
+      sales_slip_number =
+        hash.key?('salesSlipNumber') ? hash['salesSlipNumber'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceDetails16.new(sales_slip_number)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sales_slip_number: #{@sales_slip_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sales_slip_number: #{@sales_slip_number.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/invoice_details2.rb

@@ -0,0 +1,101 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # InvoiceDetails2 Model.
+  class InvoiceDetails2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether Visa Acceptance sent the Level III information to the
+    # processor. The possible values are:
+    # If your account is not enabled for Level III data or if you did not
+    # include the purchasing level field in your
+    # request, Visa Acceptance does not include the Level III data in the
+    # request sent to the processor.
+    # Possible values:
+    # - **true**
+    # - **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :level3_transmission_status
+
+    # Transaction identifier that is generated. You have the option of printing
+    # the sales slip number on the receipt.
+    # This field is supported only on Visa Acceptance through Visanet and JCN
+    # gateway.
+    # Optional field.
+    # #### Card Present processing message
+    # If you included this field in the request, the returned value is the value
+    # that you sent in the request.
+    # If you did not include this field in the request, the system generated
+    # this value for you.
+    # The difference between this reply field and the
+    # `processorInformation.systemTraceAuditNumber` field is that the
+    # system generates the system trace audit number (STAN), and you must print
+    # the receipt number on the receipt;
+    # whereas you can generate the sales slip number, and you can choose to
+    # print the sales slip number on the receipt.
+    # @return [Integer]
+    attr_accessor :sales_slip_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['level3_transmission_status'] = 'level3TransmissionStatus'
+      @_hash['sales_slip_number'] = 'salesSlipNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        level3_transmission_status
+        sales_slip_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(level3_transmission_status = SKIP, sales_slip_number = SKIP)
+      unless level3_transmission_status == SKIP
+        @level3_transmission_status =
+          level3_transmission_status
+      end
+      @sales_slip_number = sales_slip_number unless sales_slip_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.
+      level3_transmission_status =
+        hash.key?('level3TransmissionStatus') ? hash['level3TransmissionStatus'] : SKIP
+      sales_slip_number =
+        hash.key?('salesSlipNumber') ? hash['salesSlipNumber'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceDetails2.new(level3_transmission_status,
+                          sales_slip_number)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} level3_transmission_status: #{@level3_transmission_status},"\
+      " sales_slip_number: #{@sales_slip_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} level3_transmission_status: #{@level3_transmission_status.inspect},"\
+      " sales_slip_number: #{@sales_slip_number.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/invoice_details3.rb

@@ -0,0 +1,63 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # InvoiceDetails3 Model.
+  class InvoiceDetails3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Product identifier code. Also known as the Stock Keeping Unit (SKU) code
+    # for the product.
+    # @return [String]
+    attr_accessor :product_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'productId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_id = SKIP)
+      @product_id = product_id unless product_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.
+      product_id = hash.key?('productId') ? hash['productId'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceDetails3.new(product_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/invoice_details4.rb

@@ -0,0 +1,161 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # InvoiceDetails4 Model.
+  class InvoiceDetails4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Value used by your customer to identify the order. This value is typically
+    # a purchase order number. Visa Acceptance
+    # recommends that you do not populate the field with all zeros or nines.
+    # @return [String]
+    attr_accessor :purchase_order_number
+
+    # Date the order was processed. `Format: YYYY-MM-DD`.
+    # @return [String]
+    attr_accessor :purchase_order_date
+
+    # The name of the individual or the company contacted for company authorized
+    # purchases.
+    # @return [String]
+    attr_accessor :purchase_contact_name
+
+    # Flag that indicates whether an order is taxable. This value must be true
+    # if the sum of all _lineItems[].taxAmount_ values > 0.
+    # If you do not include any `lineItems[].taxAmount` values in your request,
+    # Visa Acceptance does not include
+    # `invoiceDetails.taxable` in the data it sends to the processor.
+    # Possible values:
+    #  - **true**
+    #  - **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :taxable
+
+    # VAT invoice number associated with the transaction.
+    # @return [String]
+    attr_accessor :vat_invoice_reference_number
+
+    # International description code of the overall order’s goods or services or
+    # the Categorizes purchases for VAT
+    # reporting. Contact your acquirer for a list of codes.
+    # @return [String]
+    attr_accessor :commodity_code
+
+    # International description code of the overall order’s goods or services or
+    # the Categorizes purchases for VAT
+    # reporting. Contact your acquirer for a list of codes.
+    # @return [Array[TransactionAdviceAddendum]]
+    attr_accessor :transaction_advice_addendum
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['purchase_order_number'] = 'purchaseOrderNumber'
+      @_hash['purchase_order_date'] = 'purchaseOrderDate'
+      @_hash['purchase_contact_name'] = 'purchaseContactName'
+      @_hash['taxable'] = 'taxable'
+      @_hash['vat_invoice_reference_number'] = 'vatInvoiceReferenceNumber'
+      @_hash['commodity_code'] = 'commodityCode'
+      @_hash['transaction_advice_addendum'] = 'transactionAdviceAddendum'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        purchase_order_number
+        purchase_order_date
+        purchase_contact_name
+        taxable
+        vat_invoice_reference_number
+        commodity_code
+        transaction_advice_addendum
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(purchase_order_number = SKIP, purchase_order_date = SKIP,
+                   purchase_contact_name = SKIP, taxable = SKIP,
+                   vat_invoice_reference_number = SKIP, commodity_code = SKIP,
+                   transaction_advice_addendum = SKIP)
+      @purchase_order_number = purchase_order_number unless purchase_order_number == SKIP
+      @purchase_order_date = purchase_order_date unless purchase_order_date == SKIP
+      @purchase_contact_name = purchase_contact_name unless purchase_contact_name == SKIP
+      @taxable = taxable unless taxable == SKIP
+      unless vat_invoice_reference_number == SKIP
+        @vat_invoice_reference_number =
+          vat_invoice_reference_number
+      end
+      @commodity_code = commodity_code unless commodity_code == SKIP
+      unless transaction_advice_addendum == SKIP
+        @transaction_advice_addendum =
+          transaction_advice_addendum
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      purchase_order_number =
+        hash.key?('purchaseOrderNumber') ? hash['purchaseOrderNumber'] : SKIP
+      purchase_order_date =
+        hash.key?('purchaseOrderDate') ? hash['purchaseOrderDate'] : SKIP
+      purchase_contact_name =
+        hash.key?('purchaseContactName') ? hash['purchaseContactName'] : SKIP
+      taxable = hash.key?('taxable') ? hash['taxable'] : SKIP
+      vat_invoice_reference_number =
+        hash.key?('vatInvoiceReferenceNumber') ? hash['vatInvoiceReferenceNumber'] : SKIP
+      commodity_code = hash.key?('commodityCode') ? hash['commodityCode'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      transaction_advice_addendum = nil
+      unless hash['transactionAdviceAddendum'].nil?
+        transaction_advice_addendum = []
+        hash['transactionAdviceAddendum'].each do |structure|
+          transaction_advice_addendum << (TransactionAdviceAddendum.from_hash(structure) if structure)
+        end
+      end
+
+      transaction_advice_addendum = SKIP unless hash.key?('transactionAdviceAddendum')
+
+      # Create object from extracted values.
+      InvoiceDetails4.new(purchase_order_number,
+                          purchase_order_date,
+                          purchase_contact_name,
+                          taxable,
+                          vat_invoice_reference_number,
+                          commodity_code,
+                          transaction_advice_addendum)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} purchase_order_number: #{@purchase_order_number}, purchase_order_date:"\
+      " #{@purchase_order_date}, purchase_contact_name: #{@purchase_contact_name}, taxable:"\
+      " #{@taxable}, vat_invoice_reference_number: #{@vat_invoice_reference_number},"\
+      " commodity_code: #{@commodity_code}, transaction_advice_addendum:"\
+      " #{@transaction_advice_addendum}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} purchase_order_number: #{@purchase_order_number.inspect},"\
+      " purchase_order_date: #{@purchase_order_date.inspect}, purchase_contact_name:"\
+      " #{@purchase_contact_name.inspect}, taxable: #{@taxable.inspect},"\
+      " vat_invoice_reference_number: #{@vat_invoice_reference_number.inspect}, commodity_code:"\
+      " #{@commodity_code.inspect}, transaction_advice_addendum:"\
+      " #{@transaction_advice_addendum.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/invoice_details5.rb

@@ -0,0 +1,74 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # InvoiceDetails5 Model.
+  class InvoiceDetails5 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether Visa Acceptance sent the Level III information to the
+    # processor. The possible values are:
+    # If your account is not enabled for Level III data or if you did not
+    # include the purchasing level field in your
+    # request, Visa Acceptance does not include the Level III data in the
+    # request sent to the processor.
+    # Possible values:
+    # - **true**
+    # - **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :level3_transmission_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['level3_transmission_status'] = 'level3TransmissionStatus'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        level3_transmission_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(level3_transmission_status = SKIP)
+      unless level3_transmission_status == SKIP
+        @level3_transmission_status =
+          level3_transmission_status
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      level3_transmission_status =
+        hash.key?('level3TransmissionStatus') ? hash['level3TransmissionStatus'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceDetails5.new(level3_transmission_status)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} level3_transmission_status: #{@level3_transmission_status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} level3_transmission_status: #{@level3_transmission_status.inspect}>"
+    end
+  end
+end