yapstone-payments 1.0.0

data/lib/yapstone-payments/models/verify_instrument_request.rb

@@ -0,0 +1,215 @@
+=begin
+#Payments Orchestrator
+
+#\"REST API for Payments Orchestrator\"
+
+The version of the OpenAPI document: 1.6.4-SNAPSHOT
+Contact: test@yapstone.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module Yapstone
+  # This schema is used to request verification of a method of payment. 
+  class VerifyInstrumentRequest
+    attr_accessor :client_correlation_id
+
+    attr_accessor :client_unique_transaction_id
+
+    attr_accessor :payment_instrument
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'client_correlation_id' => :'clientCorrelationId',
+        :'client_unique_transaction_id' => :'clientUniqueTransactionId',
+        :'payment_instrument' => :'paymentInstrument'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'client_correlation_id' => :'String',
+        :'client_unique_transaction_id' => :'String',
+        :'payment_instrument' => :'PaymentInstrumentCard'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::VerifyInstrumentRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Yapstone::VerifyInstrumentRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'client_correlation_id')
+        self.client_correlation_id = attributes[:'client_correlation_id']
+      end
+
+      if attributes.key?(:'client_unique_transaction_id')
+        self.client_unique_transaction_id = attributes[:'client_unique_transaction_id']
+      end
+
+      if attributes.key?(:'payment_instrument')
+        self.payment_instrument = attributes[:'payment_instrument']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          client_correlation_id == o.client_correlation_id &&
+          client_unique_transaction_id == o.client_unique_transaction_id &&
+          payment_instrument == o.payment_instrument
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [client_correlation_id, client_unique_transaction_id, payment_instrument].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Yapstone.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/yapstone-payments/version.rb

@@ -0,0 +1,15 @@
+=begin
+#Payments Orchestrator
+
+#\"REST API for Payments Orchestrator\"
+
+The version of the OpenAPI document: 1.6.4-SNAPSHOT
+Contact: test@yapstone.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.0-SNAPSHOT
+
+=end
+
+module Yapstone
+  VERSION = '1.0.0'
+end

data/spec/api/authentication_api_spec.rb

@@ -0,0 +1,48 @@
+=begin
+#Payments Orchestrator
+
+#\"REST API for Payments Orchestrator\"
+
+The version of the OpenAPI document: 1.6.4-SNAPSHOT
+Contact: test@yapstone.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Yapstone::AuthenticationApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AuthenticationApi' do
+  before do
+    # run before each test
+    @api_instance = Yapstone::AuthenticationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AuthenticationApi' do
+    it 'should create an instance of AuthenticationApi' do
+      expect(@api_instance).to be_instance_of(Yapstone::AuthenticationApi)
+    end
+  end
+
+  # unit tests for authenticate_partner
+  # Authenticate Partner
+  # Get an access token. It is OAuth2, and you must use the client credentials grant type. The token will allow you to authenticate with the other internal payments API endpoints. 
+  # @param grant_type To do OAuth2 authentication, you must indicate the grant type, then adhere to it structurally. Yapstone API endpoints authenticate with OAuth2 and the grant type client credentials. This type of authentication is used to access resources on your own system rather than access a user's resources. 
+  # @param authorization Provide client_id:client_secret as base64 encoded basic auth. 
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse200]
+  describe 'authenticate_partner test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/disbursements_api_spec.rb

@@ -0,0 +1,69 @@
+=begin
+#Payments Orchestrator
+
+#\"REST API for Payments Orchestrator\"
+
+The version of the OpenAPI document: 1.6.4-SNAPSHOT
+Contact: test@yapstone.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Yapstone::DisbursementsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DisbursementsApi' do
+  before do
+    # run before each test
+    @api_instance = Yapstone::DisbursementsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DisbursementsApi' do
+    it 'should create an instance of DisbursementsApi' do
+      expect(@api_instance).to be_instance_of(Yapstone::DisbursementsApi)
+    end
+  end
+
+  # unit tests for disburse_payment_by_id
+  # Change payment from \"Hold payout\" state to be ready for disbursement
+  # Disburse payment
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param payment_id 
+  # @param disbursement_requests 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @option opts [String] :x_yapstone_fpsid Device Finger Print Id
+  # @return [PaymentResponse]
+  describe 'disburse_payment_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for disburse_transaction_by_id
+  # Change transaction from \"Hold payout\" state to be ready for disbursement (payout)
+  # Provide the transaction ID for the transaction where you want to shift state so that money can finally be paid out (disbursed). 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param transaction_id The identification number for the transaction you want to disburse. 
+  # @param disburse_transaction_req 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @option opts [String] :x_yapstone_fpsid Device Finger Print Id
+  # @return [PaymentResponse]
+  describe 'disburse_transaction_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/payments_api_spec.rb

@@ -0,0 +1,146 @@
+=begin
+#Payments Orchestrator
+
+#\"REST API for Payments Orchestrator\"
+
+The version of the OpenAPI document: 1.6.4-SNAPSHOT
+Contact: test@yapstone.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Yapstone::PaymentsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PaymentsApi' do
+  before do
+    # run before each test
+    @api_instance = Yapstone::PaymentsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PaymentsApi' do
+    it 'should create an instance of PaymentsApi' do
+      expect(@api_instance).to be_instance_of(Yapstone::PaymentsApi)
+    end
+  end
+
+  # unit tests for cancel_payment
+  # Cancel Payment by payment Id
+  # Use a DELETE request to send a payment ID to this endpoint in order to cancel the payment. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address Ip Address of the client
+  # @param payment_id paymentId
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @option opts [String] :x_yapstone_fpsid Device Finger Print Id
+  # @return [PaymentCancelResponse]
+  describe 'cancel_payment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for cancel_transaction
+  # Cancel Transaction by TransactionId
+  # Use a transaction identifier to cancel a transaction. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address Ip Address of the client
+  # @param transaction_id The transaction ID for the transaction you would like to cancel. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @option opts [String] :x_yapstone_fpsid Device Finger Print Id
+  # @return [PaymentCancelTransactionResponse]
+  describe 'cancel_transaction test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for capture_payment
+  # Capture a prior authorized payment
+  # Capture a prior authorized payment. This endpoint is used after a payment is authorized. Once a payment is authorized, you must capture it so that money can be transferred from the customer's account to the merchant's account. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address Ip Address of the client
+  # @param payment_id The payment ID associated with the payment. You can use this to retrieve a payment or chance its status. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @option opts [String] :x_yapstone_fpsid Device Finger Print Id
+  # @option opts [CapturePaymentRequest] :capture_payment_request 
+  # @return [PaymentResponse]
+  describe 'capture_payment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_payment
+  # Process Payment
+  # The payment endpoint lets you create a payment and send information identifying the customer device the payment comes from. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address This is the IP address of the client. 
+  # @param process_payment processPayment
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @option opts [String] :x_yapstone_fpsid A device fingerprint is information gathered about the hardware and software of a website visitor combined with browser information. The fingerprint can be used to help retrieve particular sessions later, and it provides details about whoever is making a payment. 
+  # @return [PaymentResponse]
+  describe 'create_payment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_payment
+  # Get with Payment Id
+  # This endpoint lets you send a GET request containing a payment ID. The associated payment is returned to you in the response. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param payment_id paymentId
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @return [PaymentResponse]
+  describe 'get_payment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_transaction
+  # Get Transaction by Transaction Id
+  # Retrieve information about a specific transaction. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param transaction_id The transaction identifier for the transaction you want to retrieve details about. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @return [OrderTransactions]
+  describe 'get_transaction test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for verify_payment_instrument
+  # Verify payment instrument
+  # Use this endpoint to verify that a customer's payment instrument is valid and associated with them. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param verify_instrument_request verifyInstrumentRequest
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @option opts [String] :x_yapstone_fpsid Device Finger Print Id
+  # @return [InstrumentVerificationResponse]
+  describe 'verify_payment_instrument test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end