acceptance-api-sdk 0.0.1

data/lib/visa_acceptance_merged_spec/models/ancillary_information.rb

@@ -0,0 +1,177 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AncillaryInformation Model.
+  class AncillaryInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Ticket number, which consists of the carrier code, form, and serial
+    # number, without the check digit.
+    # **Important** This field is required in the U.S. in order for you to
+    # qualify for either the
+    # custom payment service (CPS) or the electronic interchange reimbursement
+    # fee (EIRF) program.
+    # Format: English characters only.
+    # Optional field for ancillary services.
+    # @return [String]
+    attr_accessor :ticket_number
+
+    # Name of the passenger. If the passenger’s name is not available, this
+    # value is the cardholder’s name. If neither the passenger’s name nor the
+    # cardholder’s name is available,
+    # this value is a description of the ancillary purchase.
+    # **Important** This field is required in the U.S. in order for you to
+    # qualify for either the custom payment service (CPS) or the electronic
+    # interchange reimbursement fee (EIRF)
+    # program.
+    # Format: English characters only.
+    # Optional field for ancillary service.
+    # @return [String]
+    attr_accessor :passenger_name
+
+    # Number for the airline ticket to which the ancillary purchase is
+    # connected.
+    # If this purchase has a connection or relationship to another purchase such
+    # as a baggage fee for a passenger transport ticket, this field must contain
+    # the ticket number for the other purchase.
+    # For a stand-alone purchase, the value for this field must be the same as
+    # the value for the
+    # `travelInformation.transit.airline.ancillaryInformation.ticketNumber`
+    # field.
+    # **Important** This field is required in the U.S. in order for you to
+    # qualify for either the custom payment service (CPS) or the electronic
+    # interchange reimbursement fee (EIRF)
+    # program.
+    # Format: English characters only.
+    # Optional request field for ancillary services.
+    # @return [String]
+    attr_accessor :connected_ticket_number
+
+    # Reason for the credit.
+    # Possible values:
+    # - `A`: Cancellation of the ancillary passenger transport purchase.
+    # - `B`: Cancellation of the airline ticket and the passenger transport
+    # ancillary purchase.
+    # - `C`: Cancellation of the airline ticket.
+    # - `O`: Other.
+    # - `P`: Partial refund of the airline ticket.
+    # Format: English characters only.
+    # Optional field for ancillary services.
+    # @return [String]
+    attr_accessor :credit_reason_indicator
+
+    # Reason for the credit.
+    # Possible values:
+    # - `A`: Cancellation of the ancillary passenger transport purchase.
+    # - `B`: Cancellation of the airline ticket and the passenger transport
+    # ancillary purchase.
+    # - `C`: Cancellation of the airline ticket.
+    # - `O`: Other.
+    # - `P`: Partial refund of the airline ticket.
+    # Format: English characters only.
+    # Optional field for ancillary services.
+    # @return [Array[Service]]
+    attr_accessor :service
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ticket_number'] = 'ticketNumber'
+      @_hash['passenger_name'] = 'passengerName'
+      @_hash['connected_ticket_number'] = 'connectedTicketNumber'
+      @_hash['credit_reason_indicator'] = 'creditReasonIndicator'
+      @_hash['service'] = 'service'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ticket_number
+        passenger_name
+        connected_ticket_number
+        credit_reason_indicator
+        service
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ticket_number: SKIP, passenger_name: SKIP,
+                   connected_ticket_number: SKIP, credit_reason_indicator: SKIP,
+                   service: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @ticket_number = ticket_number unless ticket_number == SKIP
+      @passenger_name = passenger_name unless passenger_name == SKIP
+      @connected_ticket_number = connected_ticket_number unless connected_ticket_number == SKIP
+      @credit_reason_indicator = credit_reason_indicator unless credit_reason_indicator == SKIP
+      @service = service unless service == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      ticket_number = hash.key?('ticketNumber') ? hash['ticketNumber'] : SKIP
+      passenger_name = hash.key?('passengerName') ? hash['passengerName'] : SKIP
+      connected_ticket_number =
+        hash.key?('connectedTicketNumber') ? hash['connectedTicketNumber'] : SKIP
+      credit_reason_indicator =
+        hash.key?('creditReasonIndicator') ? hash['creditReasonIndicator'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      service = nil
+      unless hash['service'].nil?
+        service = []
+        hash['service'].each do |structure|
+          service << (Service.from_hash(structure) if structure)
+        end
+      end
+
+      service = SKIP unless hash.key?('service')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AncillaryInformation.new(ticket_number: ticket_number,
+                               passenger_name: passenger_name,
+                               connected_ticket_number: connected_ticket_number,
+                               credit_reason_indicator: credit_reason_indicator,
+                               service: service,
+                               additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ticket_number: #{@ticket_number}, passenger_name: #{@passenger_name},"\
+      " connected_ticket_number: #{@connected_ticket_number}, credit_reason_indicator:"\
+      " #{@credit_reason_indicator}, service: #{@service}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ticket_number: #{@ticket_number.inspect}, passenger_name:"\
+      " #{@passenger_name.inspect}, connected_ticket_number: #{@connected_ticket_number.inspect},"\
+      " credit_reason_indicator: #{@credit_reason_indicator.inspect}, service:"\
+      " #{@service.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/ap_capture.rb

@@ -0,0 +1,110 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ApCapture Model.
+  class ApCapture < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason why the captured payment status is PENDING or DENIED.
+    # BUYER_COMPLAINT	The payer initiated a dispute for this captured payment
+    # with processor.
+    # CHARGEBACK	The captured funds were reversed in response to the payer
+    # disputing this captured payment with the issuer of the financial
+    # instrument used to pay for this captured payment.
+    # ECHECK	The payer paid by an eCheck that has not yet cleared.
+    # INTERNATIONAL_WITHDRAWAL	Visit your online account. In your Account
+    # Overview, accept and deny this payment.
+    # OTHER	No additional specific reason can be provided. For more information
+    # about this captured payment, visit your account online or contact
+    # processor.
+    # PENDING_REVIEW	The captured payment is pending manual review.
+    # RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION	The payee has not yet set up
+    # appropriate receiving preferences for their account. For more information
+    # about how to accept or deny this payment, visit your account online. This
+    # reason is typically offered in scenarios such as when the currency of the
+    # captured payment is different from the primary holding currency of the
+    # payee.
+    # REFUNDED	The captured funds were refunded.
+    # TRANSACTION_APPROVED_AWAITING_FUNDING	The payer must send the funds for
+    # this captured payment. This code generally appears for manual EFTs.
+    # UNILATERAL	The payee does not have a processor account.
+    # VERIFICATION_REQUIRED	The payee's processor account is not verified.
+    # String with values,
+    #  `BUYER_COMPLAINT`
+    #  `CHARGEBACK`
+    #  `ECHECK`
+    #  `INTERNATIONAL_WITHDRAWAL`
+    #  `OTHER`
+    #  `PENDING_REVIEW`
+    #  `RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION`
+    #  `REFUNDED`
+    #  `TRANSACTION_APPROVED_AWAITING_FUNDING`
+    #  `UNILATERAL`
+    #  `VERIFICATION_REQUIRED`
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @reason = reason unless reason == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ApCapture.new(reason: reason,
+                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/application.rb

@@ -0,0 +1,156 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Application Model.
+  class Application < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the Visa Acceptance transaction type (such as CC settlement or
+    # CC authorization) that the merchant wants to process in a transaction
+    # request. More than one transaction type can included in a transaction
+    # request. Each transaction type separately returns their own status,
+    # reasonCode, rCode, and rFlag messages.
+    # @return [String]
+    attr_accessor :name
+
+    # The description for this field is not available.
+    # @return [String]
+    attr_accessor :status
+
+    # 3-digit reason code that indicates why the customer profile payment
+    # succeeded or failed.
+    # @return [String]
+    attr_accessor :reason_code
+
+    # Indicates whether the service request was successful.
+    # Possible values:
+    # - `-1`: An error occurred.
+    # - `0`: The request was declined.
+    # - `1`: The request was successful.
+    # @return [String]
+    attr_accessor :r_code
+
+    # One-word description of the result of the application.
+    # @return [String]
+    attr_accessor :r_flag
+
+    # Reference number that you use to reconcile your Visa Acceptance reports
+    # with your processor reports.
+    # @return [String]
+    attr_accessor :reconciliation_id
+
+    # Message that explains the reply flag for the application.
+    # @return [String]
+    attr_accessor :r_message
+
+    # The description for this field is not available.
+    # @return [Integer]
+    attr_accessor :return_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['status'] = 'status'
+      @_hash['reason_code'] = 'reasonCode'
+      @_hash['r_code'] = 'rCode'
+      @_hash['r_flag'] = 'rFlag'
+      @_hash['reconciliation_id'] = 'reconciliationId'
+      @_hash['r_message'] = 'rMessage'
+      @_hash['return_code'] = 'returnCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        status
+        reason_code
+        r_code
+        r_flag
+        reconciliation_id
+        r_message
+        return_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, status: SKIP, reason_code: SKIP, r_code: SKIP,
+                   r_flag: SKIP, reconciliation_id: SKIP, r_message: SKIP,
+                   return_code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @status = status unless status == SKIP
+      @reason_code = reason_code unless reason_code == SKIP
+      @r_code = r_code unless r_code == SKIP
+      @r_flag = r_flag unless r_flag == SKIP
+      @reconciliation_id = reconciliation_id unless reconciliation_id == SKIP
+      @r_message = r_message unless r_message == SKIP
+      @return_code = return_code unless return_code == SKIP
+      @additional_properties = additional_properties
+    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
+      status = hash.key?('status') ? hash['status'] : SKIP
+      reason_code = hash.key?('reasonCode') ? hash['reasonCode'] : SKIP
+      r_code = hash.key?('rCode') ? hash['rCode'] : SKIP
+      r_flag = hash.key?('rFlag') ? hash['rFlag'] : SKIP
+      reconciliation_id =
+        hash.key?('reconciliationId') ? hash['reconciliationId'] : SKIP
+      r_message = hash.key?('rMessage') ? hash['rMessage'] : SKIP
+      return_code = hash.key?('returnCode') ? hash['returnCode'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Application.new(name: name,
+                      status: status,
+                      reason_code: reason_code,
+                      r_code: r_code,
+                      r_flag: r_flag,
+                      reconciliation_id: reconciliation_id,
+                      r_message: r_message,
+                      return_code: return_code,
+                      additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, status: #{@status}, reason_code: #{@reason_code}, r_code:"\
+      " #{@r_code}, r_flag: #{@r_flag}, reconciliation_id: #{@reconciliation_id}, r_message:"\
+      " #{@r_message}, return_code: #{@return_code}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, status: #{@status.inspect}, reason_code:"\
+      " #{@reason_code.inspect}, r_code: #{@r_code.inspect}, r_flag: #{@r_flag.inspect},"\
+      " reconciliation_id: #{@reconciliation_id.inspect}, r_message: #{@r_message.inspect},"\
+      " return_code: #{@return_code.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/application_information.rb

@@ -0,0 +1,131 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ApplicationInformation Model.
+  class ApplicationInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status of the submitted transaction.
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates the reason why a request succeeded or failed and possible action
+    # to take if a request fails.
+    # For details, see the appendix of reason codes in the documentation for the
+    # relevant payment method.
+    # @return [String]
+    attr_accessor :reason_code
+
+    # Indicates whether the service request was successful.
+    # Possible values:
+    # - `-1`: An error occurred.
+    # - `0`: The request was declined.
+    # - `1`: The request was successful.
+    # @return [String]
+    attr_accessor :r_code
+
+    # One-word description of the result of the application.
+    # @return [String]
+    attr_accessor :r_flag
+
+    # One-word description of the result of the application.
+    # @return [Array[Application]]
+    attr_accessor :applications
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['reason_code'] = 'reasonCode'
+      @_hash['r_code'] = 'rCode'
+      @_hash['r_flag'] = 'rFlag'
+      @_hash['applications'] = 'applications'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        reason_code
+        r_code
+        r_flag
+        applications
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, reason_code: SKIP, r_code: SKIP, r_flag: SKIP,
+                   applications: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @status = status unless status == SKIP
+      @reason_code = reason_code unless reason_code == SKIP
+      @r_code = r_code unless r_code == SKIP
+      @r_flag = r_flag unless r_flag == SKIP
+      @applications = applications unless applications == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      reason_code = hash.key?('reasonCode') ? hash['reasonCode'] : SKIP
+      r_code = hash.key?('rCode') ? hash['rCode'] : SKIP
+      r_flag = hash.key?('rFlag') ? hash['rFlag'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      applications = nil
+      unless hash['applications'].nil?
+        applications = []
+        hash['applications'].each do |structure|
+          applications << (Application.from_hash(structure) if structure)
+        end
+      end
+
+      applications = SKIP unless hash.key?('applications')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ApplicationInformation.new(status: status,
+                                 reason_code: reason_code,
+                                 r_code: r_code,
+                                 r_flag: r_flag,
+                                 applications: applications,
+                                 additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, reason_code: #{@reason_code}, r_code: #{@r_code},"\
+      " r_flag: #{@r_flag}, applications: #{@applications}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, reason_code: #{@reason_code.inspect}, r_code:"\
+      " #{@r_code.inspect}, r_flag: #{@r_flag.inspect}, applications: #{@applications.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/asset_type.rb

@@ -0,0 +1,44 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # assetType.
+  class AssetType
+    ASSET_TYPE = [
+      # TODO: Write general description for CARDARTCOMBINED
+      CARDARTCOMBINED = 'card-art-combined'.freeze,
+
+      # TODO: Write general description for BRANDLOGO
+      BRANDLOGO = 'brand-logo'.freeze,
+
+      # TODO: Write general description for ISSUERLOGO
+      ISSUERLOGO = 'issuer-logo'.freeze,
+
+      # TODO: Write general description for ICONLOGO
+      ICONLOGO = 'icon-logo'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CARDARTCOMBINED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cardartcombined' then CARDARTCOMBINED
+      when 'brandlogo' then BRANDLOGO
+      when 'issuerlogo' then ISSUERLOGO
+      when 'iconlogo' then ICONLOGO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/asset_type1.rb

@@ -0,0 +1,44 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # The type of asset.
+  class AssetType1
+    ASSET_TYPE1 = [
+      # TODO: Write general description for CARDARTCOMBINED
+      CARDARTCOMBINED = 'card-art-combined'.freeze,
+
+      # TODO: Write general description for BRANDLOGO
+      BRANDLOGO = 'brand-logo'.freeze,
+
+      # TODO: Write general description for ISSUERLOGO
+      ISSUERLOGO = 'issuer-logo'.freeze,
+
+      # TODO: Write general description for ICONLOGO
+      ICONLOGO = 'icon-logo'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CARDARTCOMBINED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cardartcombined' then CARDARTCOMBINED
+      when 'brandlogo' then BRANDLOGO
+      when 'issuerlogo' then ISSUERLOGO
+      when 'iconlogo' then ICONLOGO
+      else
+        default_value
+      end
+    end
+  end
+end