visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/client_reference_information1.rb

@@ -0,0 +1,115 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ClientReferenceInformation1 Model.
+  class ClientReferenceInformation1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant-generated order reference or tracking number. It is recommended
+    # that you send a unique value for each
+    # transaction so that you can perform meaningful searches for the
+    # transaction.
+    # #### Used by
+    # **Authorization**
+    # Required field.
+    # #### PIN Debit
+    # Requests for PIN debit reversals need to use the same merchant reference
+    # number that was used in the transaction that is being
+    # reversed.
+    # Required field for all PIN Debit requests (purchase, credit, and
+    # reversal).
+    # #### FDC Nashville Global
+    # Certain circumstances can cause the processor to truncate this value to 15
+    # or 17 characters for Level II and Level III processing, which can cause a
+    # discrepancy between the value you submit and the value included in some
+    # processor reports.
+    # @return [String]
+    attr_accessor :code
+
+    # Date and time at your physical location.
+    # Format: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh =
+    # hour, mm = minutes ss = seconds
+    # #### PIN Debit
+    # Optional field for PIN Debit purchase and credit requests.
+    # @return [String]
+    attr_accessor :submit_local_date_time
+
+    # Merchant ID that was used to create the subscription or customer profile
+    # for which the service was requested.
+    # If your Visa Acceptance account is enabled for Recurring Billing, this
+    # field is returned only if you are using
+    # subscription sharing and if your merchant ID is in the same merchant ID
+    # pool as the owner merchant ID.
+    # If your Visa Acceptance account is enabled for Payment Tokenization, this
+    # field is returned only if you are using
+    # profile sharing and if your merchant ID is in the same merchant ID pool as
+    # the owner merchant ID.
+    # @return [String]
+    attr_accessor :owner_merchant_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['submit_local_date_time'] = 'submitLocalDateTime'
+      @_hash['owner_merchant_id'] = 'ownerMerchantId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        submit_local_date_time
+        owner_merchant_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP, submit_local_date_time = SKIP,
+                   owner_merchant_id = SKIP)
+      @code = code unless code == SKIP
+      @submit_local_date_time = submit_local_date_time unless submit_local_date_time == SKIP
+      @owner_merchant_id = owner_merchant_id unless owner_merchant_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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      submit_local_date_time =
+        hash.key?('submitLocalDateTime') ? hash['submitLocalDateTime'] : SKIP
+      owner_merchant_id =
+        hash.key?('ownerMerchantId') ? hash['ownerMerchantId'] : SKIP
+
+      # Create object from extracted values.
+      ClientReferenceInformation1.new(code,
+                                      submit_local_date_time,
+                                      owner_merchant_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, submit_local_date_time: #{@submit_local_date_time},"\
+      " owner_merchant_id: #{@owner_merchant_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, submit_local_date_time:"\
+      " #{@submit_local_date_time.inspect}, owner_merchant_id: #{@owner_merchant_id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/client_reference_information10.rb

@@ -0,0 +1,204 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ClientReferenceInformation10 Model.
+  class ClientReferenceInformation10 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant-generated order reference or tracking number. It is recommended
+    # that you send a unique value for each
+    # transaction so that you can perform meaningful searches for the
+    # transaction.
+    # #### Used by
+    # **Authorization**
+    # Required field.
+    # #### PIN Debit
+    # Requests for PIN debit reversals need to use the same merchant reference
+    # number that was used in the transaction that is being
+    # reversed.
+    # Required field for all PIN Debit requests (purchase, credit, and
+    # reversal).
+    # #### FDC Nashville Global
+    # Certain circumstances can cause the processor to truncate this value to 15
+    # or 17 characters for Level II and Level III processing, which can cause a
+    # discrepancy between the value you submit and the value included in some
+    # processor reports.
+    # @return [String]
+    attr_accessor :code
+
+    # Reference number for the transaction.
+    # Depending on how your Visa Acceptance account is configured, this value
+    # could either be provided in the API request or generated by Visa
+    # Acceptance.
+    # The actual value used in the request to the processor is provided back to
+    # you by Visa Acceptance in the response.
+    # @return [String]
+    attr_accessor :reconciliation_id
+
+    # A new ID which is created for refund
+    # @return [String]
+    attr_accessor :return_reconciliation_id
+
+    # Used to resume a transaction that was paused for an order modification
+    # rule to allow for payer authentication to complete. To resume and continue
+    # with the authorization/decision service flow, call the services and
+    # include the request id from the prior decision call.
+    # @return [String]
+    attr_accessor :paused_request_id
+
+    # Identifier that you assign to the transaction. Normally generated by a
+    # client server to identify a unique API request.
+    # **Note** Use this field only if you want to support merchant-initiated
+    # reversal and void operations.
+    # #### Used by
+    # **Authorization, Authorization Reversal, Capture, Credit, and Void**
+    # Optional field.
+    # #### PIN Debit
+    # For a PIN debit reversal, your request must include a request ID or a
+    # merchant transaction identifier.
+    # Optional field for PIN debit purchase or credit requests.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Brief description of the order or any comment you wish to add to the
+    # order.
+    # @return [String]
+    attr_accessor :comments
+
+    # Brief description of the order or any comment you wish to add to the
+    # order.
+    # @return [Partner]
+    attr_accessor :partner
+
+    # The name of the Connection Method client (such as Virtual Terminal or SOAP
+    # Toolkit API) that the merchant uses to send a transaction request to Visa
+    # Acceptance.
+    # @return [String]
+    attr_accessor :application_name
+
+    # Version of the Visa Acceptance application or integration used for a
+    # transaction.
+    # @return [String]
+    attr_accessor :application_version
+
+    # The entity that is responsible for running the transaction and submitting
+    # the processing request to Visa Acceptance. This could be a person, a
+    # system, or a connection method.
+    # @return [String]
+    attr_accessor :application_user
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['reconciliation_id'] = 'reconciliationId'
+      @_hash['return_reconciliation_id'] = 'returnReconciliationId'
+      @_hash['paused_request_id'] = 'pausedRequestId'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['comments'] = 'comments'
+      @_hash['partner'] = 'partner'
+      @_hash['application_name'] = 'applicationName'
+      @_hash['application_version'] = 'applicationVersion'
+      @_hash['application_user'] = 'applicationUser'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        reconciliation_id
+        return_reconciliation_id
+        paused_request_id
+        transaction_id
+        comments
+        partner
+        application_name
+        application_version
+        application_user
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP, reconciliation_id = SKIP,
+                   return_reconciliation_id = SKIP, paused_request_id = SKIP,
+                   transaction_id = SKIP, comments = SKIP, partner = SKIP,
+                   application_name = SKIP, application_version = SKIP,
+                   application_user = SKIP)
+      @code = code unless code == SKIP
+      @reconciliation_id = reconciliation_id unless reconciliation_id == SKIP
+      @return_reconciliation_id = return_reconciliation_id unless return_reconciliation_id == SKIP
+      @paused_request_id = paused_request_id unless paused_request_id == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @comments = comments unless comments == SKIP
+      @partner = partner unless partner == SKIP
+      @application_name = application_name unless application_name == SKIP
+      @application_version = application_version unless application_version == SKIP
+      @application_user = application_user unless application_user == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      reconciliation_id =
+        hash.key?('reconciliationId') ? hash['reconciliationId'] : SKIP
+      return_reconciliation_id =
+        hash.key?('returnReconciliationId') ? hash['returnReconciliationId'] : SKIP
+      paused_request_id =
+        hash.key?('pausedRequestId') ? hash['pausedRequestId'] : SKIP
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      comments = hash.key?('comments') ? hash['comments'] : SKIP
+      partner = Partner.from_hash(hash['partner']) if hash['partner']
+      application_name =
+        hash.key?('applicationName') ? hash['applicationName'] : SKIP
+      application_version =
+        hash.key?('applicationVersion') ? hash['applicationVersion'] : SKIP
+      application_user =
+        hash.key?('applicationUser') ? hash['applicationUser'] : SKIP
+
+      # Create object from extracted values.
+      ClientReferenceInformation10.new(code,
+                                       reconciliation_id,
+                                       return_reconciliation_id,
+                                       paused_request_id,
+                                       transaction_id,
+                                       comments,
+                                       partner,
+                                       application_name,
+                                       application_version,
+                                       application_user)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, reconciliation_id: #{@reconciliation_id},"\
+      " return_reconciliation_id: #{@return_reconciliation_id}, paused_request_id:"\
+      " #{@paused_request_id}, transaction_id: #{@transaction_id}, comments: #{@comments},"\
+      " partner: #{@partner}, application_name: #{@application_name}, application_version:"\
+      " #{@application_version}, application_user: #{@application_user}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, reconciliation_id: #{@reconciliation_id.inspect},"\
+      " return_reconciliation_id: #{@return_reconciliation_id.inspect}, paused_request_id:"\
+      " #{@paused_request_id.inspect}, transaction_id: #{@transaction_id.inspect}, comments:"\
+      " #{@comments.inspect}, partner: #{@partner.inspect}, application_name:"\
+      " #{@application_name.inspect}, application_version: #{@application_version.inspect},"\
+      " application_user: #{@application_user.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/client_reference_information11.rb

@@ -0,0 +1,127 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ClientReferenceInformation11 Model.
+  class ClientReferenceInformation11 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant-generated order reference or tracking number. It is recommended
+    # that you send a unique value for each
+    # transaction so that you can perform meaningful searches for the
+    # transaction.
+    # #### Used by
+    # **Authorization**
+    # Required field.
+    # #### PIN Debit
+    # Requests for PIN debit reversals need to use the same merchant reference
+    # number that was used in the transaction that is being
+    # reversed.
+    # Required field for all PIN Debit requests (purchase, credit, and
+    # reversal).
+    # #### FDC Nashville Global
+    # Certain circumstances can cause the processor to truncate this value to 15
+    # or 17 characters for Level II and Level III processing, which can cause a
+    # discrepancy between the value you submit and the value included in some
+    # processor reports.
+    # @return [String]
+    attr_accessor :code
+
+    # Date and time at your physical location.
+    # Format: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh =
+    # hour, mm = minutes ss = seconds
+    # #### PIN Debit
+    # Optional field for PIN Debit purchase and credit requests.
+    # @return [String]
+    attr_accessor :submit_local_date_time
+
+    # Merchant ID that was used to create the subscription or customer profile
+    # for which the service was requested.
+    # If your Visa Acceptance account is enabled for Recurring Billing, this
+    # field is returned only if you are using
+    # subscription sharing and if your merchant ID is in the same merchant ID
+    # pool as the owner merchant ID.
+    # If your Visa Acceptance account is enabled for Payment Tokenization, this
+    # field is returned only if you are using
+    # profile sharing and if your merchant ID is in the same merchant ID pool as
+    # the owner merchant ID.
+    # @return [String]
+    attr_accessor :owner_merchant_id
+
+    # A new ID which is created for refund
+    # @return [String]
+    attr_accessor :return_reconciliation_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['submit_local_date_time'] = 'submitLocalDateTime'
+      @_hash['owner_merchant_id'] = 'ownerMerchantId'
+      @_hash['return_reconciliation_id'] = 'returnReconciliationId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        submit_local_date_time
+        owner_merchant_id
+        return_reconciliation_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP, submit_local_date_time = SKIP,
+                   owner_merchant_id = SKIP, return_reconciliation_id = SKIP)
+      @code = code unless code == SKIP
+      @submit_local_date_time = submit_local_date_time unless submit_local_date_time == SKIP
+      @owner_merchant_id = owner_merchant_id unless owner_merchant_id == SKIP
+      @return_reconciliation_id = return_reconciliation_id unless return_reconciliation_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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      submit_local_date_time =
+        hash.key?('submitLocalDateTime') ? hash['submitLocalDateTime'] : SKIP
+      owner_merchant_id =
+        hash.key?('ownerMerchantId') ? hash['ownerMerchantId'] : SKIP
+      return_reconciliation_id =
+        hash.key?('returnReconciliationId') ? hash['returnReconciliationId'] : SKIP
+
+      # Create object from extracted values.
+      ClientReferenceInformation11.new(code,
+                                       submit_local_date_time,
+                                       owner_merchant_id,
+                                       return_reconciliation_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, submit_local_date_time: #{@submit_local_date_time},"\
+      " owner_merchant_id: #{@owner_merchant_id}, return_reconciliation_id:"\
+      " #{@return_reconciliation_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, submit_local_date_time:"\
+      " #{@submit_local_date_time.inspect}, owner_merchant_id: #{@owner_merchant_id.inspect},"\
+      " return_reconciliation_id: #{@return_reconciliation_id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/client_reference_information2.rb

@@ -0,0 +1,166 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ClientReferenceInformation2 Model.
+  class ClientReferenceInformation2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant-generated order reference or tracking number. It is recommended
+    # that you send a unique value for each
+    # transaction so that you can perform meaningful searches for the
+    # transaction.
+    # #### Used by
+    # **Authorization**
+    # Required field.
+    # #### PIN Debit
+    # Requests for PIN debit reversals need to use the same merchant reference
+    # number that was used in the transaction that is being
+    # reversed.
+    # Required field for all PIN Debit requests (purchase, credit, and
+    # reversal).
+    # #### FDC Nashville Global
+    # Certain circumstances can cause the processor to truncate this value to 15
+    # or 17 characters for Level II and Level III processing, which can cause a
+    # discrepancy between the value you submit and the value included in some
+    # processor reports.
+    # @return [String]
+    attr_accessor :code
+
+    # Merchant-generated order reference or tracking number. It is recommended
+    # that you send a unique value for each
+    # transaction so that you can perform meaningful searches for the
+    # transaction.
+    # #### Used by
+    # **Authorization**
+    # Required field.
+    # #### PIN Debit
+    # Requests for PIN debit reversals need to use the same merchant reference
+    # number that was used in the transaction that is being
+    # reversed.
+    # Required field for all PIN Debit requests (purchase, credit, and
+    # reversal).
+    # #### FDC Nashville Global
+    # Certain circumstances can cause the processor to truncate this value to 15
+    # or 17 characters for Level II and Level III processing, which can cause a
+    # discrepancy between the value you submit and the value included in some
+    # processor reports.
+    # @return [Partner1]
+    attr_accessor :partner
+
+    # The name of the Connection Method client (such as Virtual Terminal or SOAP
+    # Toolkit API) that the merchant uses to send a transaction request to Visa
+    # Acceptance.
+    # @return [String]
+    attr_accessor :application_name
+
+    # Version of the Visa Acceptance application or integration used for a
+    # transaction.
+    # @return [String]
+    attr_accessor :application_version
+
+    # The entity that is responsible for running the transaction and submitting
+    # the processing request to Visa Acceptance. This could be a person, a
+    # system, or a connection method.
+    # @return [String]
+    attr_accessor :application_user
+
+    # Identifier that you assign to the transaction. Normally generated by a
+    # client server to identify a unique API request.
+    # **Note** Use this field only if you want to support merchant-initiated
+    # reversal and void operations.
+    # #### Used by
+    # **Authorization, Authorization Reversal, Capture, Credit, and Void**
+    # Optional field.
+    # #### PIN Debit
+    # For a PIN debit reversal, your request must include a request ID or a
+    # merchant transaction identifier.
+    # Optional field for PIN debit purchase or credit requests.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['partner'] = 'partner'
+      @_hash['application_name'] = 'applicationName'
+      @_hash['application_version'] = 'applicationVersion'
+      @_hash['application_user'] = 'applicationUser'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        partner
+        application_name
+        application_version
+        application_user
+        transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP, partner = SKIP, application_name = SKIP,
+                   application_version = SKIP, application_user = SKIP,
+                   transaction_id = SKIP)
+      @code = code unless code == SKIP
+      @partner = partner unless partner == SKIP
+      @application_name = application_name unless application_name == SKIP
+      @application_version = application_version unless application_version == SKIP
+      @application_user = application_user unless application_user == SKIP
+      @transaction_id = transaction_id unless 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      partner = Partner1.from_hash(hash['partner']) if hash['partner']
+      application_name =
+        hash.key?('applicationName') ? hash['applicationName'] : SKIP
+      application_version =
+        hash.key?('applicationVersion') ? hash['applicationVersion'] : SKIP
+      application_user =
+        hash.key?('applicationUser') ? hash['applicationUser'] : SKIP
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+
+      # Create object from extracted values.
+      ClientReferenceInformation2.new(code,
+                                      partner,
+                                      application_name,
+                                      application_version,
+                                      application_user,
+                                      transaction_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, partner: #{@partner}, application_name:"\
+      " #{@application_name}, application_version: #{@application_version}, application_user:"\
+      " #{@application_user}, transaction_id: #{@transaction_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, partner: #{@partner.inspect}, application_name:"\
+      " #{@application_name.inspect}, application_version: #{@application_version.inspect},"\
+      " application_user: #{@application_user.inspect}, transaction_id:"\
+      " #{@transaction_id.inspect}>"
+    end
+  end
+end