first_data_gateway 1.0.3 → 1.1.0

data/lib/openapi_client/models/payment_schedules_error_response.rb

@@ -0,0 +1,281 @@
+=begin
+#Payment Gateway API Specification.
+
+#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+
+OpenAPI spec version: 6.4.0.20181018.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  # Payment schedules response with error field included.
+  class PaymentSchedulesErrorResponse
+    # Echoes back the value in the request header for tracking.
+    attr_accessor :client_request_id
+
+    # Request identifier in API, can be used to request logs from the support team.
+    attr_accessor :api_trace_id
+
+    attr_accessor :response_type
+
+    # Result of requested operation. If it's anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details.
+    attr_accessor :request_status
+
+    # Client order ID if supplied by client, otherwise the order ID.
+    attr_accessor :order_id
+
+    attr_accessor :transaction_response
+
+    attr_accessor :error
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'client_request_id' => :'clientRequestId',
+        :'api_trace_id' => :'apiTraceId',
+        :'response_type' => :'responseType',
+        :'request_status' => :'requestStatus',
+        :'order_id' => :'orderId',
+        :'transaction_response' => :'transactionResponse',
+        :'error' => :'error'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'client_request_id' => :'String',
+        :'api_trace_id' => :'String',
+        :'response_type' => :'ResponseType',
+        :'request_status' => :'String',
+        :'order_id' => :'String',
+        :'transaction_response' => :'TransactionResponse',
+        :'error' => :'Error'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'clientRequestId')
+        self.client_request_id = attributes[:'clientRequestId']
+      end
+
+      if attributes.has_key?(:'apiTraceId')
+        self.api_trace_id = attributes[:'apiTraceId']
+      end
+
+      if attributes.has_key?(:'responseType')
+        self.response_type = attributes[:'responseType']
+      end
+
+      if attributes.has_key?(:'requestStatus')
+        self.request_status = attributes[:'requestStatus']
+      end
+
+      if attributes.has_key?(:'orderId')
+        self.order_id = attributes[:'orderId']
+      end
+
+      if attributes.has_key?(:'transactionResponse')
+        self.transaction_response = attributes[:'transactionResponse']
+      end
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      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
+      if @response_type.nil?
+        invalid_properties.push('invalid value for "response_type", response_type cannot be nil.')
+      end
+
+      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?
+      return false if @response_type.nil?
+      request_status_validator = EnumAttributeValidator.new('String', ['SUCCESS', 'VALIDATION_FAILED', 'PROCESSING_FAILED', 'FAILURE', 'DECLINED'])
+      return false unless request_status_validator.valid?(@request_status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] request_status Object to be assigned
+    def request_status=(request_status)
+      validator = EnumAttributeValidator.new('String', ['SUCCESS', 'VALIDATION_FAILED', 'PROCESSING_FAILED', 'FAILURE', 'DECLINED'])
+      unless validator.valid?(request_status)
+        fail ArgumentError, 'invalid value for "request_status", must be one of #{validator.allowable_values}.'
+      end
+      @request_status = request_status
+    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_request_id == o.client_request_id &&
+          api_trace_id == o.api_trace_id &&
+          response_type == o.response_type &&
+          request_status == o.request_status &&
+          order_id == o.order_id &&
+          transaction_response == o.transaction_response &&
+          error == o.error
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [client_request_id, api_trace_id, response_type, request_status, order_id, transaction_response, error].hash
+    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 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
+        temp_model = OpenapiClient.const_get(type).new
+        temp_model.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/{swagger_client → openapi_client}/models/payment_schedules_request.rb

@@ -1,30 +1,30 @@
 =begin
-#Payment Gateway API Specification
+#Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. 
+#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
 
-OpenAPI spec version: 0.0.1
+OpenAPI spec version: 6.4.0.20181018.001
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
 
 =end
 
 require 'date'
 
-module SwaggerClient
-  # Request to create a gateway scheduler.
+module OpenapiClient
+  # Request to create a gateway schedule.
   class PaymentSchedulesRequest
     # Store ID number.
     attr_accessor :store_id
 
     # Order ID used to create recurring payment from existing transaction.
-    attr_accessor :reference_order_id
+    attr_accessor :referenced_order_id
 
     # Date of mandate signature.
     attr_accessor :start_date
 
-    # Number of times the recurring payment will process.
+    # Number of times the recurring pament will process.
     attr_accessor :number_of_payments
 
     # Number of failures that can be encountered before re-tries cease.
@@ -34,12 +34,11 @@ module SwaggerClient
     attr_accessor :invoice_number
 
     # Purchase order number.
-    attr_accessor :po_number
+    attr_accessor :purchase_order_number
 
-    # The source of the transaction. The possible values are ECI (if the order was received via email or Internet), MOTO (mail order / telephone order) and RETAIL (face to face).
     attr_accessor :transaction_origin
 
-    # Dynamic merchant name for the cardholder‘s statement.
+    # Dynamic merchant name for the cardholder's statement.
     attr_accessor :dynamic_merchant_name
 
     attr_accessor :frequency
@@ -50,68 +49,59 @@ module SwaggerClient
 
     attr_accessor :client_locale
 
-    # Client Order ID if supplied by client.
+    # Client order ID if supplied by client.
     attr_accessor :order_id
 
-    class EnumAttributeValidator
-      attr_reader :datatype
-      attr_reader :allowable_values
-
-      def initialize(datatype, allowable_values)
-        @allowable_values = allowable_values.map do |value|
-          case datatype.to_s
-          when /Integer/i
-            value.to_i
-          when /Float/i
-            value.to_f
-          else
-            value
-          end
-        end
-      end
+    attr_accessor :billing
 
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
+    attr_accessor :shipping
+
+    # User supplied comments.
+    attr_accessor :comments
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'store_id' => :'storeId',
-        :'reference_order_id' => :'referenceOrderId',
+        :'referenced_order_id' => :'referencedOrderId',
         :'start_date' => :'startDate',
         :'number_of_payments' => :'numberOfPayments',
         :'maximum_failures' => :'maximumFailures',
         :'invoice_number' => :'invoiceNumber',
-        :'po_number' => :'poNumber',
+        :'purchase_order_number' => :'purchaseOrderNumber',
         :'transaction_origin' => :'transactionOrigin',
         :'dynamic_merchant_name' => :'dynamicMerchantName',
         :'frequency' => :'frequency',
         :'payment_method' => :'paymentMethod',
         :'amount' => :'amount',
         :'client_locale' => :'clientLocale',
-        :'order_id' => :'orderId'
+        :'order_id' => :'orderId',
+        :'billing' => :'billing',
+        :'shipping' => :'shipping',
+        :'comments' => :'comments'
       }
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'store_id' => :'String',
-        :'reference_order_id' => :'String',
+        :'referenced_order_id' => :'String',
         :'start_date' => :'Date',
         :'number_of_payments' => :'Integer',
         :'maximum_failures' => :'Integer',
         :'invoice_number' => :'String',
-        :'po_number' => :'String',
-        :'transaction_origin' => :'String',
+        :'purchase_order_number' => :'String',
+        :'transaction_origin' => :'TransactionOrigin',
         :'dynamic_merchant_name' => :'String',
         :'frequency' => :'Frequency',
         :'payment_method' => :'PaymentMethod',
         :'amount' => :'Amount',
         :'client_locale' => :'ClientLocale',
-        :'order_id' => :'String'
+        :'order_id' => :'String',
+        :'billing' => :'Billing',
+        :'shipping' => :'Shipping',
+        :'comments' => :'String'
       }
     end
 
@@ -121,14 +111,14 @@ module SwaggerClient
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'storeId')
         self.store_id = attributes[:'storeId']
       end
 
-      if attributes.has_key?(:'referenceOrderId')
-        self.reference_order_id = attributes[:'referenceOrderId']
+      if attributes.has_key?(:'referencedOrderId')
+        self.referenced_order_id = attributes[:'referencedOrderId']
       end
 
       if attributes.has_key?(:'startDate')
@@ -147,8 +137,8 @@ module SwaggerClient
         self.invoice_number = attributes[:'invoiceNumber']
       end
 
-      if attributes.has_key?(:'poNumber')
-        self.po_number = attributes[:'poNumber']
+      if attributes.has_key?(:'purchaseOrderNumber')
+        self.purchase_order_number = attributes[:'purchaseOrderNumber']
       end
 
       if attributes.has_key?(:'transactionOrigin')
@@ -179,53 +169,76 @@ module SwaggerClient
         self.order_id = attributes[:'orderId']
       end
 
+      if attributes.has_key?(:'billing')
+        self.billing = attributes[:'billing']
+      end
+
+      if attributes.has_key?(:'shipping')
+        self.shipping = attributes[:'shipping']
+      end
+
+      if attributes.has_key?(:'comments')
+        self.comments = attributes[:'comments']
+      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
+      if !@store_id.nil? && @store_id.to_s.length > 20
+        invalid_properties.push('invalid value for "store_id", the character length must be smaller than or equal to 20.')
+      end
+
       if !@number_of_payments.nil? && @number_of_payments > 999
-        invalid_properties.push("invalid value for 'number_of_payments', must be smaller than or equal to 999.")
+        invalid_properties.push('invalid value for "number_of_payments", must be smaller than or equal to 999.')
       end
 
       if !@number_of_payments.nil? && @number_of_payments < 1
-        invalid_properties.push("invalid value for 'number_of_payments', must be greater than or equal to 1.")
+        invalid_properties.push('invalid value for "number_of_payments", must be greater than or equal to 1.')
       end
 
       if !@maximum_failures.nil? && @maximum_failures > 999
-        invalid_properties.push("invalid value for 'maximum_failures', must be smaller than or equal to 999.")
+        invalid_properties.push('invalid value for "maximum_failures", must be smaller than or equal to 999.')
       end
 
       if !@maximum_failures.nil? && @maximum_failures < 1
-        invalid_properties.push("invalid value for 'maximum_failures', must be greater than or equal to 1.")
+        invalid_properties.push('invalid value for "maximum_failures", must be greater than or equal to 1.')
       end
 
-      return invalid_properties
+      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?
+      return false if !@store_id.nil? && @store_id.to_s.length > 20
       return false if !@number_of_payments.nil? && @number_of_payments > 999
       return false if !@number_of_payments.nil? && @number_of_payments < 1
       return false if !@maximum_failures.nil? && @maximum_failures > 999
       return false if !@maximum_failures.nil? && @maximum_failures < 1
-      transaction_origin_validator = EnumAttributeValidator.new('String', ["ECI", "MOTO", "RETAIL"])
-      return false unless transaction_origin_validator.valid?(@transaction_origin)
-      return true
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] store_id Value to be assigned
+    def store_id=(store_id)
+      if !store_id.nil? && store_id.to_s.length > 20
+        fail ArgumentError, 'invalid value for "store_id", the character length must be smaller than or equal to 20.'
+      end
+
+      @store_id = store_id
     end
 
     # Custom attribute writer method with validation
     # @param [Object] number_of_payments Value to be assigned
     def number_of_payments=(number_of_payments)
-
       if !number_of_payments.nil? && number_of_payments > 999
-        fail ArgumentError, "invalid value for 'number_of_payments', must be smaller than or equal to 999."
+        fail ArgumentError, 'invalid value for "number_of_payments", must be smaller than or equal to 999.'
       end
 
       if !number_of_payments.nil? && number_of_payments < 1
-        fail ArgumentError, "invalid value for 'number_of_payments', must be greater than or equal to 1."
+        fail ArgumentError, 'invalid value for "number_of_payments", must be greater than or equal to 1.'
       end
 
       @number_of_payments = number_of_payments
@@ -234,47 +247,39 @@ module SwaggerClient
     # Custom attribute writer method with validation
     # @param [Object] maximum_failures Value to be assigned
     def maximum_failures=(maximum_failures)
-
       if !maximum_failures.nil? && maximum_failures > 999
-        fail ArgumentError, "invalid value for 'maximum_failures', must be smaller than or equal to 999."
+        fail ArgumentError, 'invalid value for "maximum_failures", must be smaller than or equal to 999.'
       end
 
       if !maximum_failures.nil? && maximum_failures < 1
-        fail ArgumentError, "invalid value for 'maximum_failures', must be greater than or equal to 1."
+        fail ArgumentError, 'invalid value for "maximum_failures", must be greater than or equal to 1.'
       end
 
       @maximum_failures = maximum_failures
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] transaction_origin Object to be assigned
-    def transaction_origin=(transaction_origin)
-      validator = EnumAttributeValidator.new('String', ["ECI", "MOTO", "RETAIL"])
-      unless validator.valid?(transaction_origin)
-        fail ArgumentError, "invalid value for 'transaction_origin', must be one of #{validator.allowable_values}."
-      end
-      @transaction_origin = transaction_origin
-    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 &&
           store_id == o.store_id &&
-          reference_order_id == o.reference_order_id &&
+          referenced_order_id == o.referenced_order_id &&
           start_date == o.start_date &&
           number_of_payments == o.number_of_payments &&
           maximum_failures == o.maximum_failures &&
           invoice_number == o.invoice_number &&
-          po_number == o.po_number &&
+          purchase_order_number == o.purchase_order_number &&
           transaction_origin == o.transaction_origin &&
           dynamic_merchant_name == o.dynamic_merchant_name &&
           frequency == o.frequency &&
           payment_method == o.payment_method &&
           amount == o.amount &&
           client_locale == o.client_locale &&
-          order_id == o.order_id
+          order_id == o.order_id &&
+          billing == o.billing &&
+          shipping == o.shipping &&
+          comments == o.comments
     end
 
     # @see the `==` method
@@ -286,7 +291,7 @@ module SwaggerClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [store_id, reference_order_id, start_date, number_of_payments, maximum_failures, invoice_number, po_number, transaction_origin, dynamic_merchant_name, frequency, payment_method, amount, client_locale, order_id].hash
+      [store_id, referenced_order_id, start_date, number_of_payments, maximum_failures, invoice_number, purchase_order_number, transaction_origin, dynamic_merchant_name, frequency, payment_method, amount, client_locale, order_id, billing, shipping, comments].hash
     end
 
     # Builds the object from hash
@@ -294,12 +299,12 @@ module SwaggerClient
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
+      self.class.openapi_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the 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) } )
+            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]]))
@@ -346,7 +351,7 @@ module SwaggerClient
           end
         end
       else # model
-        temp_model = SwaggerClient.const_get(type).new
+        temp_model = OpenapiClient.const_get(type).new
         temp_model.build_from_hash(value)
       end
     end
@@ -381,7 +386,7 @@ module SwaggerClient
     # @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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -392,7 +397,5 @@ module SwaggerClient
         value
       end
     end
-
   end
-
 end