wallee-ruby-sdk 2.2.5 → 3.0.0

data/lib/wallee-ruby-sdk/api/web_app_service_api.rb

@@ -0,0 +1,200 @@
+=begin
+The wallee API allows an easy interaction with the wallee web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require "uri"
+
+module Wallee
+  class WebAppService
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Check Installation
+    # This operation returns true when the app is installed in given space. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.
+    # @param space_id This parameter identifies the space which should be checked if the web app is installed.
+    # @param [Hash] opts the optional parameters
+    # @return [BOOLEAN]
+    def check_installation(space_id, opts = {})
+      data, _status_code, _headers = check_installation_with_http_info(space_id, opts)
+      return data
+    end
+
+    # Check Installation
+    # This operation returns true when the app is installed in given space. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.
+    # @param space_id This parameter identifies the space which should be checked if the web app is installed.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BOOLEAN, Fixnum, Hash)>] BOOLEAN data, response status code and response headers
+    def check_installation_with_http_info(space_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: WebAppService.check_installation ..."
+      end
+      # verify the required parameter 'space_id' is set
+      fail ArgumentError, "Missing the required parameter 'space_id' when calling WebAppService.check_installation" if space_id.nil?
+      # resource path
+      local_var_path = "/web-app/check-installation".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'spaceId'] = space_id
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'BOOLEAN')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebAppService#check_installation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Confirm
+    # This operation confirms the app installation. This method has to be invoked after the user returns to the web app. The request of the user will contain the code as a request parameter. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [WebAppConfirmationResponse]
+    def confirm(request, opts = {})
+      data, _status_code, _headers = confirm_with_http_info(request, opts)
+      return data
+    end
+
+    # Confirm
+    # This operation confirms the app installation. This method has to be invoked after the user returns to the web app. The request of the user will contain the code as a request parameter. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebAppConfirmationResponse, Fixnum, Hash)>] WebAppConfirmationResponse data, response status code and response headers
+    def confirm_with_http_info(request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: WebAppService.confirm ..."
+      end
+      # verify the required parameter 'request' is set
+      fail ArgumentError, "Missing the required parameter 'request' when calling WebAppService.confirm" if request.nil?
+      # resource path
+      local_var_path = "/web-app/confirm".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'WebAppConfirmationResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebAppService#confirm\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Uninstall
+    # This operation uninstalls the web app from the provided space. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.
+    # @param space_id This parameter identifies the space within which the web app should be uninstalled.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def uninstall(space_id, opts = {})
+      uninstall_with_http_info(space_id, opts)
+      return nil
+    end
+
+    # Uninstall
+    # This operation uninstalls the web app from the provided space. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.
+    # @param space_id This parameter identifies the space within which the web app should be uninstalled.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def uninstall_with_http_info(space_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: WebAppService.uninstall ..."
+      end
+      # verify the required parameter 'space_id' is set
+      fail ArgumentError, "Missing the required parameter 'space_id' when calling WebAppService.uninstall" if space_id.nil?
+      # resource path
+      local_var_path = "/web-app/uninstall".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'spaceId'] = space_id
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = []
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebAppService#uninstall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/wallee-ruby-sdk/models/authenticated_card_data.rb

@@ -0,0 +1,221 @@
+=begin
+The wallee API allows an easy interaction with the wallee web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'date'
+
+module Wallee
+  # This model holds the card data and optional cardholder authentication details.
+  class AuthenticatedCardData
+    # The additional authentication value used to secure the tokenized card transactions.
+    attr_accessor :cryptogram
+
+    # 
+    attr_accessor :recurring_indicator
+
+    # 
+    attr_accessor :token_requestor_id
+
+    # The cardholder authentication information. The authentication is optional and can be provided if the cardholder has been already authenticated (e.g. in 3-D Secure system).
+    attr_accessor :cardholder_authentication
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cryptogram' => :'cryptogram',
+        :'recurring_indicator' => :'recurringIndicator',
+        :'token_requestor_id' => :'tokenRequestorId',
+        :'cardholder_authentication' => :'cardholderAuthentication'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'cryptogram' => :'CardCryptogram',
+        :'recurring_indicator' => :'RecurringIndicator',
+        :'token_requestor_id' => :'String',
+        :'cardholder_authentication' => :'CardholderAuthentication'
+      }
+    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?(:'cryptogram')
+        self.cryptogram = attributes[:'cryptogram']
+      end
+
+      if attributes.has_key?(:'recurringIndicator')
+        self.recurring_indicator = attributes[:'recurringIndicator']
+      end
+
+      if attributes.has_key?(:'tokenRequestorId')
+        self.token_requestor_id = attributes[:'tokenRequestorId']
+      end
+
+      if attributes.has_key?(:'cardholderAuthentication')
+        self.cardholder_authentication = attributes[:'cardholderAuthentication']
+      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 &&
+          cryptogram == o.cryptogram &&
+          recurring_indicator == o.recurring_indicator &&
+          token_requestor_id == o.token_requestor_id &&
+          cardholder_authentication == o.cardholder_authentication
+    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
+      [cryptogram, recurring_indicator, token_requestor_id, cardholder_authentication].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.swagger_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
+        temp_model = Wallee.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/wallee-ruby-sdk/models/{unencrypted_card_data.rb → authenticated_card_data_create.rb}

@@ -18,27 +18,47 @@ limitations under the License.
 require 'date'
 
 module Wallee
-  # This model holds the card data in plain.
-  class UnencryptedCardData
+  # This model holds the card data and optional cardholder authentication details.
+  class AuthenticatedCardDataCreate
     # The card holder name is the name printed onto the card. It identifies the person who owns the card.
     attr_accessor :card_holder_name
 
     # The card verification code (CVC) is a 3 to 4 digit code typically printed on the back of the card. It helps to ensure that the card holder is authorizing the transaction. For card not-present transactions this field is optional.
     attr_accessor :card_verification_code
 
+    # The cardholder authentication information. The authentication is optional and can be provided if the cardholder has been already authenticated (e.g. in 3-D Secure system).
+    attr_accessor :cardholder_authentication
+
+    # The additional authentication value used to secure the tokenized card transactions.
+    attr_accessor :cryptogram
+
     # The card expiry date indicates when the card expires. The format is the format yyyy-mm where yyyy is the year (e.g. 2019) and the mm is the month (e.g. 09).
     attr_accessor :expiry_date
 
     # The primary account number (PAN) identifies the card. The number is numeric and typically printed on the front of the card.
     attr_accessor :primary_account_number
 
+    # 
+    attr_accessor :recurring_indicator
+
+    # 
+    attr_accessor :scheme_transaction_reference
+
+    # 
+    attr_accessor :token_requestor_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'card_holder_name' => :'cardHolderName',
         :'card_verification_code' => :'cardVerificationCode',
+        :'cardholder_authentication' => :'cardholderAuthentication',
+        :'cryptogram' => :'cryptogram',
         :'expiry_date' => :'expiryDate',
-        :'primary_account_number' => :'primaryAccountNumber'
+        :'primary_account_number' => :'primaryAccountNumber',
+        :'recurring_indicator' => :'recurringIndicator',
+        :'scheme_transaction_reference' => :'schemeTransactionReference',
+        :'token_requestor_id' => :'tokenRequestorId'
       }
     end
 
@@ -47,8 +67,13 @@ module Wallee
       {
         :'card_holder_name' => :'String',
         :'card_verification_code' => :'String',
+        :'cardholder_authentication' => :'CardholderAuthenticationCreate',
+        :'cryptogram' => :'CardCryptogramCreate',
         :'expiry_date' => :'String',
-        :'primary_account_number' => :'String'
+        :'primary_account_number' => :'String',
+        :'recurring_indicator' => :'RecurringIndicator',
+        :'scheme_transaction_reference' => :'String',
+        :'token_requestor_id' => :'String'
       }
     end
 
@@ -68,6 +93,14 @@ module Wallee
         self.card_verification_code = attributes[:'cardVerificationCode']
       end
 
+      if attributes.has_key?(:'cardholderAuthentication')
+        self.cardholder_authentication = attributes[:'cardholderAuthentication']
+      end
+
+      if attributes.has_key?(:'cryptogram')
+        self.cryptogram = attributes[:'cryptogram']
+      end
+
       if attributes.has_key?(:'expiryDate')
         self.expiry_date = attributes[:'expiryDate']
       end
@@ -75,6 +108,18 @@ module Wallee
       if attributes.has_key?(:'primaryAccountNumber')
         self.primary_account_number = attributes[:'primaryAccountNumber']
       end
+
+      if attributes.has_key?(:'recurringIndicator')
+        self.recurring_indicator = attributes[:'recurringIndicator']
+      end
+
+      if attributes.has_key?(:'schemeTransactionReference')
+        self.scheme_transaction_reference = attributes[:'schemeTransactionReference']
+      end
+
+      if attributes.has_key?(:'tokenRequestorId')
+        self.token_requestor_id = attributes[:'tokenRequestorId']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -93,14 +138,22 @@ module Wallee
         invalid_properties.push('invalid value for "card_verification_code", the character length must be great than or equal to 3.')
       end
 
-      if !@primary_account_number.nil? && @primary_account_number.to_s.length > 30
+      if @primary_account_number.nil?
+        invalid_properties.push('invalid value for "primary_account_number", primary_account_number cannot be nil.')
+      end
+
+      if @primary_account_number.to_s.length > 30
         invalid_properties.push('invalid value for "primary_account_number", the character length must be smaller than or equal to 30.')
       end
 
-      if !@primary_account_number.nil? && @primary_account_number.to_s.length < 10
+      if @primary_account_number.to_s.length < 10
         invalid_properties.push('invalid value for "primary_account_number", the character length must be great than or equal to 10.')
       end
 
+      if !@scheme_transaction_reference.nil? && @scheme_transaction_reference.to_s.length > 100
+        invalid_properties.push('invalid value for "scheme_transaction_reference", the character length must be smaller than or equal to 100.')
+      end
+
       invalid_properties
     end
 
@@ -110,8 +163,10 @@ module Wallee
       return false if !@card_holder_name.nil? && @card_holder_name.to_s.length > 100
       return false if !@card_verification_code.nil? && @card_verification_code.to_s.length > 4
       return false if !@card_verification_code.nil? && @card_verification_code.to_s.length < 3
-      return false if !@primary_account_number.nil? && @primary_account_number.to_s.length > 30
-      return false if !@primary_account_number.nil? && @primary_account_number.to_s.length < 10
+      return false if @primary_account_number.nil?
+      return false if @primary_account_number.to_s.length > 30
+      return false if @primary_account_number.to_s.length < 10
+      return false if !@scheme_transaction_reference.nil? && @scheme_transaction_reference.to_s.length > 100
       true
     end
 
@@ -142,17 +197,31 @@ module Wallee
     # Custom attribute writer method with validation
     # @param [Object] primary_account_number Value to be assigned
     def primary_account_number=(primary_account_number)
-      if !primary_account_number.nil? && primary_account_number.to_s.length > 30
+      if primary_account_number.nil?
+        fail ArgumentError, 'primary_account_number cannot be nil'
+      end
+
+      if primary_account_number.to_s.length > 30
         fail ArgumentError, 'invalid value for "primary_account_number", the character length must be smaller than or equal to 30.'
       end
 
-      if !primary_account_number.nil? && primary_account_number.to_s.length < 10
+      if primary_account_number.to_s.length < 10
         fail ArgumentError, 'invalid value for "primary_account_number", the character length must be great than or equal to 10.'
       end
 
       @primary_account_number = primary_account_number
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] scheme_transaction_reference Value to be assigned
+    def scheme_transaction_reference=(scheme_transaction_reference)
+      if !scheme_transaction_reference.nil? && scheme_transaction_reference.to_s.length > 100
+        fail ArgumentError, 'invalid value for "scheme_transaction_reference", the character length must be smaller than or equal to 100.'
+      end
+
+      @scheme_transaction_reference = scheme_transaction_reference
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -160,8 +229,13 @@ module Wallee
       self.class == o.class &&
           card_holder_name == o.card_holder_name &&
           card_verification_code == o.card_verification_code &&
+          cardholder_authentication == o.cardholder_authentication &&
+          cryptogram == o.cryptogram &&
           expiry_date == o.expiry_date &&
-          primary_account_number == o.primary_account_number
+          primary_account_number == o.primary_account_number &&
+          recurring_indicator == o.recurring_indicator &&
+          scheme_transaction_reference == o.scheme_transaction_reference &&
+          token_requestor_id == o.token_requestor_id
     end
 
     # @see the `==` method
@@ -173,7 +247,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [card_holder_name, card_verification_code, expiry_date, primary_account_number].hash
+      [card_holder_name, card_verification_code, cardholder_authentication, cryptogram, expiry_date, primary_account_number, recurring_indicator, scheme_transaction_reference, token_requestor_id].hash
     end
 
     # Builds the object from hash