visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/authorization_options1.rb

@@ -0,0 +1,67 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AuthorizationOptions1 Model.
+  class AuthorizationOptions1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # #### Visa Platform Connect
+    # The field contains the PAN translation indicator for American Express
+    # Contactless Transaction. Valid value is 
+    # 1- Expresspay Translation, PAN request
+    # 2- Expresspay Translation, PAN and Expiry date request
+    # @return [String]
+    attr_accessor :pan_return_indicator
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pan_return_indicator'] = 'panReturnIndicator'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pan_return_indicator
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pan_return_indicator = SKIP)
+      @pan_return_indicator = pan_return_indicator unless pan_return_indicator == 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.
+      pan_return_indicator =
+        hash.key?('panReturnIndicator') ? hash['panReturnIndicator'] : SKIP
+
+      # Create object from extracted values.
+      AuthorizationOptions1.new(pan_return_indicator)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pan_return_indicator: #{@pan_return_indicator}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pan_return_indicator: #{@pan_return_indicator.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/authorization_options2.rb

@@ -0,0 +1,79 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AuthorizationOptions2 Model.
+  class AuthorizationOptions2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Field is used for back-to-back funding transaction and can be defined as a
+    # payment flow that automatically transfers funds through a real-time 
+    # funding or a live-load. This type of transaction can also be connected to
+    # a purchase. 
+    # In back-to-back funding of general purpose card that is used to make a
+    # purchase, two separate accounts are involved: 
+    # - account one is used to make the purchase
+    # - account two is used to automatically fund or reimburse account one
+    # Possible values:
+    # - 0B = back to back funding transaction
+    # - 00 = normal transaction
+    # - 01 = originator hold
+    # - 02 = Visa deferred OCT hold, default interval
+    # - 03 = Visa deferred OCT hold, user-defined interval
+    # - 09 = Cancel pending deferred OCT request
+    # - 0I = Visa Direct custom program 1
+    # - 0Q = uery the status of the deferred OCT
+    # - A0 = Alias Directory 2
+    # @return [String]
+    attr_accessor :service_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['service_type'] = 'serviceType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        service_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(service_type = SKIP)
+      @service_type = service_type unless service_type == 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.
+      service_type = hash.key?('serviceType') ? hash['serviceType'] : SKIP
+
+      # Create object from extracted values.
+      AuthorizationOptions2.new(service_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} service_type: #{@service_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} service_type: #{@service_type.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/authorization_options3.rb

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

data/lib/visa_acceptance_merged_spec/models/authorization_options4.rb

@@ -0,0 +1,129 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AuthorizationOptions4 Model.
+  class AuthorizationOptions4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Authorization type. Possible values:
+    #  - `AUTOCAPTURE`: automatic capture.
+    #  - `STANDARDCAPTURE`: standard capture.
+    #  - `VERBAL`: forced capture. Include it in the payment request for a
+    # forced capture. Include it in the capture request for a verbal payment.
+    # #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and
+    # Visa Acceptance Latin American Processing
+    # Set this field to `AUTOCAPTURE` and include it in a bundled request to
+    # indicate that you are requesting an automatic capture. If your account is
+    # configured to enable automatic captures, set this field to
+    # `STANDARDCAPTURE` and include it in a standard authorization or bundled
+    # request to indicate that you are overriding an automatic capture.
+    # #### Forced Capture
+    # Set this field to `VERBAL` and include it in the authorization request to
+    # indicate that you are performing a forced capture; therefore, you receive
+    # the authorization code outside the Visa Acceptance system.
+    # #### Verbal Authorization
+    # Set this field to `VERBAL` and include it in the capture request to
+    # indicate that the request is for a verbal authorization.
+    # #### for PayPal ptsV2CreateOrderPost400Response
+    # Set this field to 'AUTHORIZE' or 'CAPTURE' depending on whether you want
+    # to invoke delayed capture or sale respectively.
+    # @return [String]
+    attr_accessor :auth_type
+
+    # Authorization code.
+    # #### Forced Capture
+    # Use this field to send the authorization code you received from a payment
+    # that you authorized
+    # outside the Visa Acceptance system.
+    # #### PIN debit
+    # Authorization code that is returned by the processor.
+    # Returned by PIN debit purchase.
+    # #### Verbal Authorization
+    # Use this field in CAPTURE API to send the verbally received authorization
+    # code.
+    # @return [String]
+    attr_accessor :verbal_auth_code
+
+    # Transaction ID (TID).
+    # #### FDMS South
+    # This field is required for verbal authorizations and forced captures with
+    # the American Express card type to comply
+    # with the CAPN requirements:
+    # - Forced capture: Obtain the value for this field from the authorization
+    # response.
+    # - Verbal authorization: You cannot obtain a value for this field so Visa
+    # Acceptance uses the default value of `000000000000000` (15
+    # zeros).
+    # @return [String]
+    attr_accessor :verbal_auth_transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auth_type'] = 'authType'
+      @_hash['verbal_auth_code'] = 'verbalAuthCode'
+      @_hash['verbal_auth_transaction_id'] = 'verbalAuthTransactionId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auth_type
+        verbal_auth_code
+        verbal_auth_transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(auth_type = SKIP, verbal_auth_code = SKIP,
+                   verbal_auth_transaction_id = SKIP)
+      @auth_type = auth_type unless auth_type == SKIP
+      @verbal_auth_code = verbal_auth_code unless verbal_auth_code == SKIP
+      unless verbal_auth_transaction_id == SKIP
+        @verbal_auth_transaction_id =
+          verbal_auth_transaction_id
+      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.
+      auth_type = hash.key?('authType') ? hash['authType'] : SKIP
+      verbal_auth_code =
+        hash.key?('verbalAuthCode') ? hash['verbalAuthCode'] : SKIP
+      verbal_auth_transaction_id =
+        hash.key?('verbalAuthTransactionId') ? hash['verbalAuthTransactionId'] : SKIP
+
+      # Create object from extracted values.
+      AuthorizationOptions4.new(auth_type,
+                                verbal_auth_code,
+                                verbal_auth_transaction_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auth_type: #{@auth_type}, verbal_auth_code: #{@verbal_auth_code},"\
+      " verbal_auth_transaction_id: #{@verbal_auth_transaction_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auth_type: #{@auth_type.inspect}, verbal_auth_code:"\
+      " #{@verbal_auth_code.inspect}, verbal_auth_transaction_id:"\
+      " #{@verbal_auth_transaction_id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/authorization_options5.rb

@@ -0,0 +1,83 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AuthorizationOptions5 Model.
+  class AuthorizationOptions5 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Authorization type. Possible values:
+    #  - `AUTOCAPTURE`: automatic capture.
+    #  - `STANDARDCAPTURE`: standard capture.
+    #  - `VERBAL`: forced capture. Include it in the payment request for a
+    # forced capture. Include it in the capture request for a verbal payment.
+    # #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and
+    # Visa Acceptance Latin American Processing
+    # Set this field to `AUTOCAPTURE` and include it in a bundled request to
+    # indicate that you are requesting an automatic capture. If your account is
+    # configured to enable automatic captures, set this field to
+    # `STANDARDCAPTURE` and include it in a standard authorization or bundled
+    # request to indicate that you are overriding an automatic capture.
+    # #### Forced Capture
+    # Set this field to `VERBAL` and include it in the authorization request to
+    # indicate that you are performing a forced capture; therefore, you receive
+    # the authorization code outside the Visa Acceptance system.
+    # #### Verbal Authorization
+    # Set this field to `VERBAL` and include it in the capture request to
+    # indicate that the request is for a verbal authorization.
+    # #### for PayPal ptsV2CreateOrderPost400Response
+    # Set this field to 'AUTHORIZE' or 'CAPTURE' depending on whether you want
+    # to invoke delayed capture or sale respectively.
+    # @return [String]
+    attr_accessor :auth_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auth_type'] = 'authType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auth_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(auth_type = SKIP)
+      @auth_type = auth_type unless auth_type == 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.
+      auth_type = hash.key?('authType') ? hash['authType'] : SKIP
+
+      # Create object from extracted values.
+      AuthorizationOptions5.new(auth_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auth_type: #{@auth_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auth_type: #{@auth_type.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/authorization_options6.rb

@@ -0,0 +1,160 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AuthorizationOptions6 Model.
+  class AuthorizationOptions6 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Authorization type. Possible values:
+    #  - `AUTOCAPTURE`: automatic capture.
+    #  - `STANDARDCAPTURE`: standard capture.
+    #  - `VERBAL`: forced capture. Include it in the payment request for a
+    # forced capture. Include it in the capture request for a verbal payment.
+    # #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and
+    # Visa Acceptance Latin American Processing
+    # Set this field to `AUTOCAPTURE` and include it in a bundled request to
+    # indicate that you are requesting an automatic capture. If your account is
+    # configured to enable automatic captures, set this field to
+    # `STANDARDCAPTURE` and include it in a standard authorization or bundled
+    # request to indicate that you are overriding an automatic capture.
+    # #### Forced Capture
+    # Set this field to `VERBAL` and include it in the authorization request to
+    # indicate that you are performing a forced capture; therefore, you receive
+    # the authorization code outside the Visa Acceptance system.
+    # #### Verbal Authorization
+    # Set this field to `VERBAL` and include it in the capture request to
+    # indicate that the request is for a verbal authorization.
+    # #### for PayPal ptsV2CreateOrderPost400Response
+    # Set this field to 'AUTHORIZE' or 'CAPTURE' depending on whether you want
+    # to invoke delayed capture or sale respectively.
+    # @return [String]
+    attr_accessor :auth_type
+
+    # Flag that specifies the purpose of the authorization.
+    # Possible values:
+    #  - **0**: Preauthorization
+    #  - **1**: Final authorization
+    # To set the default for this field, contact Visa Acceptance Customer
+    # Support.
+    # #### Barclays and Elavon
+    # The default for Barclays and Elavon is 1 (final authorization). To change
+    # the default for this field, contact Visa Acceptance Customer Support.
+    # #### Visa Acceptance through VisaNet
+    # When the value for this field is 0, it corresponds to the following data
+    # in the TC 33 capture file:
+    #  - Record: CP01 TCR0
+    #  - Position: 164
+    #  - Field: Additional Authorization Indicators
+    # When the value for this field is 1, it does not correspond to any data in
+    # the TC 33 capture file.
+    # @return [String]
+    attr_accessor :auth_indicator
+
+    # Indicates Authorization extension transaction. Extension transaction is
+    # used to prolong the settlement period by one additional settlement cycle
+    # period.
+    # Possible values:
+    # - true: Transaction is an Authorization Extension transaction. 
+    # - false: Transaction is not an Authorization Extension transaction.
+    # @return [String]
+    attr_accessor :extend_auth_indicator
+
+    # This API field will indicate whether a card verification check is being
+    # performed during the transaction
+    # Possible values:
+    #   - `true`
+    #   - `false` (default value)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :card_verification_indicator
+
+    # This API field will indicate whether a card verification check is being
+    # performed during the transaction
+    # Possible values:
+    #   - `true`
+    #   - `false` (default value)
+    # @return [Initiator26]
+    attr_accessor :initiator
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auth_type'] = 'authType'
+      @_hash['auth_indicator'] = 'authIndicator'
+      @_hash['extend_auth_indicator'] = 'extendAuthIndicator'
+      @_hash['card_verification_indicator'] = 'cardVerificationIndicator'
+      @_hash['initiator'] = 'initiator'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auth_type
+        auth_indicator
+        extend_auth_indicator
+        card_verification_indicator
+        initiator
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(auth_type = SKIP, auth_indicator = SKIP,
+                   extend_auth_indicator = SKIP,
+                   card_verification_indicator = SKIP, initiator = SKIP)
+      @auth_type = auth_type unless auth_type == SKIP
+      @auth_indicator = auth_indicator unless auth_indicator == SKIP
+      @extend_auth_indicator = extend_auth_indicator unless extend_auth_indicator == SKIP
+      unless card_verification_indicator == SKIP
+        @card_verification_indicator =
+          card_verification_indicator
+      end
+      @initiator = initiator unless initiator == 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.
+      auth_type = hash.key?('authType') ? hash['authType'] : SKIP
+      auth_indicator = hash.key?('authIndicator') ? hash['authIndicator'] : SKIP
+      extend_auth_indicator =
+        hash.key?('extendAuthIndicator') ? hash['extendAuthIndicator'] : SKIP
+      card_verification_indicator =
+        hash.key?('cardVerificationIndicator') ? hash['cardVerificationIndicator'] : SKIP
+      initiator = Initiator26.from_hash(hash['initiator']) if hash['initiator']
+
+      # Create object from extracted values.
+      AuthorizationOptions6.new(auth_type,
+                                auth_indicator,
+                                extend_auth_indicator,
+                                card_verification_indicator,
+                                initiator)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auth_type: #{@auth_type}, auth_indicator: #{@auth_indicator},"\
+      " extend_auth_indicator: #{@extend_auth_indicator}, card_verification_indicator:"\
+      " #{@card_verification_indicator}, initiator: #{@initiator}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auth_type: #{@auth_type.inspect}, auth_indicator:"\
+      " #{@auth_indicator.inspect}, extend_auth_indicator: #{@extend_auth_indicator.inspect},"\
+      " card_verification_indicator: #{@card_verification_indicator.inspect}, initiator:"\
+      " #{@initiator.inspect}>"
+    end
+  end
+end