vrpayment-ruby-sdk 5.0.1

data/lib/vrpayment-ruby-sdk/models/subscription_charge_create.rb

@@ -0,0 +1,329 @@
+=begin
+The VR Payment API allows an easy interaction with the VR Payment 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 VRPayment
+  # The subscription charge represents a single charge carried out for a particular subscription.
+  class SubscriptionChargeCreate
+    # A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
+    attr_accessor :external_id
+
+    # The URL to redirect the customer back to after they canceled or failed to authenticated their payment.
+    attr_accessor :failed_url
+
+    # The date and time when the execution of the charge is planned.
+    attr_accessor :planned_execution_date
+
+    # The processing type specifies how the charge is to be processed.
+    attr_accessor :processing_type
+
+    # The merchant's reference used to identify the charge.
+    attr_accessor :reference
+
+    # The subscription that the charge belongs to.
+    attr_accessor :subscription
+
+    # The URL to redirect the customer back to after they successfully authenticated their payment.
+    attr_accessor :success_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'external_id' => :'externalId',
+        :'failed_url' => :'failedUrl',
+        :'planned_execution_date' => :'plannedExecutionDate',
+        :'processing_type' => :'processingType',
+        :'reference' => :'reference',
+        :'subscription' => :'subscription',
+        :'success_url' => :'successUrl'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'external_id' => :'String',
+        :'failed_url' => :'String',
+        :'planned_execution_date' => :'DateTime',
+        :'processing_type' => :'SubscriptionChargeProcessingType',
+        :'reference' => :'String',
+        :'subscription' => :'Integer',
+        :'success_url' => :'String'
+      }
+    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?(:'externalId')
+        self.external_id = attributes[:'externalId']
+      end
+
+      if attributes.has_key?(:'failedUrl')
+        self.failed_url = attributes[:'failedUrl']
+      end
+
+      if attributes.has_key?(:'plannedExecutionDate')
+        self.planned_execution_date = attributes[:'plannedExecutionDate']
+      end
+
+      if attributes.has_key?(:'processingType')
+        self.processing_type = attributes[:'processingType']
+      end
+
+      if attributes.has_key?(:'reference')
+        self.reference = attributes[:'reference']
+      end
+
+      if attributes.has_key?(:'subscription')
+        self.subscription = attributes[:'subscription']
+      end
+
+      if attributes.has_key?(:'successUrl')
+        self.success_url = attributes[:'successUrl']
+      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 @external_id.nil?
+        invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
+      end
+
+      if !@failed_url.nil? && @failed_url.to_s.length > 500
+        invalid_properties.push('invalid value for "failed_url", the character length must be smaller than or equal to 500.')
+      end
+
+      if !@failed_url.nil? && @failed_url.to_s.length < 9
+        invalid_properties.push('invalid value for "failed_url", the character length must be great than or equal to 9.')
+      end
+
+      if @processing_type.nil?
+        invalid_properties.push('invalid value for "processing_type", processing_type cannot be nil.')
+      end
+
+      if !@reference.nil? && @reference.to_s.length > 100
+        invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 100.')
+      end
+
+      if @subscription.nil?
+        invalid_properties.push('invalid value for "subscription", subscription cannot be nil.')
+      end
+
+      if !@success_url.nil? && @success_url.to_s.length > 500
+        invalid_properties.push('invalid value for "success_url", the character length must be smaller than or equal to 500.')
+      end
+
+      if !@success_url.nil? && @success_url.to_s.length < 9
+        invalid_properties.push('invalid value for "success_url", the character length must be great than or equal to 9.')
+      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 @external_id.nil?
+      return false if !@failed_url.nil? && @failed_url.to_s.length > 500
+      return false if !@failed_url.nil? && @failed_url.to_s.length < 9
+      return false if @processing_type.nil?
+      return false if !@reference.nil? && @reference.to_s.length > 100
+      return false if @subscription.nil?
+      return false if !@success_url.nil? && @success_url.to_s.length > 500
+      return false if !@success_url.nil? && @success_url.to_s.length < 9
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] failed_url Value to be assigned
+    def failed_url=(failed_url)
+      if !failed_url.nil? && failed_url.to_s.length > 500
+        fail ArgumentError, 'invalid value for "failed_url", the character length must be smaller than or equal to 500.'
+      end
+
+      if !failed_url.nil? && failed_url.to_s.length < 9
+        fail ArgumentError, 'invalid value for "failed_url", the character length must be great than or equal to 9.'
+      end
+
+      @failed_url = failed_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reference Value to be assigned
+    def reference=(reference)
+      if !reference.nil? && reference.to_s.length > 100
+        fail ArgumentError, 'invalid value for "reference", the character length must be smaller than or equal to 100.'
+      end
+
+      @reference = reference
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] success_url Value to be assigned
+    def success_url=(success_url)
+      if !success_url.nil? && success_url.to_s.length > 500
+        fail ArgumentError, 'invalid value for "success_url", the character length must be smaller than or equal to 500.'
+      end
+
+      if !success_url.nil? && success_url.to_s.length < 9
+        fail ArgumentError, 'invalid value for "success_url", the character length must be great than or equal to 9.'
+      end
+
+      @success_url = success_url
+    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 &&
+          external_id == o.external_id &&
+          failed_url == o.failed_url &&
+          planned_execution_date == o.planned_execution_date &&
+          processing_type == o.processing_type &&
+          reference == o.reference &&
+          subscription == o.subscription &&
+          success_url == o.success_url
+    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
+      [external_id, failed_url, planned_execution_date, processing_type, reference, subscription, success_url].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 = VRPayment.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/vrpayment-ruby-sdk/models/subscription_charge_processing_type.rb

@@ -0,0 +1,35 @@
+=begin
+The VR Payment API allows an easy interaction with the VR Payment 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 VRPayment
+  class SubscriptionChargeProcessingType
+    
+    SYNCHRONOUS = 'SYNCHRONOUS'.freeze
+    CHARGE_FLOW = 'CHARGE_FLOW'.freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = SubscriptionChargeProcessingType.constants.select { |c| SubscriptionChargeProcessingType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #SubscriptionChargeProcessingType" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/vrpayment-ruby-sdk/models/subscription_charge_state.rb

@@ -0,0 +1,38 @@
+=begin
+The VR Payment API allows an easy interaction with the VR Payment 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 VRPayment
+  class SubscriptionChargeState
+    
+    SCHEDULED = 'SCHEDULED'.freeze
+    DISCARDED = 'DISCARDED'.freeze
+    PROCESSING = 'PROCESSING'.freeze
+    SUCCESSFUL = 'SUCCESSFUL'.freeze
+    FAILED = 'FAILED'.freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = SubscriptionChargeState.constants.select { |c| SubscriptionChargeState::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #SubscriptionChargeState" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/vrpayment-ruby-sdk/models/subscription_charge_type.rb

@@ -0,0 +1,35 @@
+=begin
+The VR Payment API allows an easy interaction with the VR Payment 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 VRPayment
+  class SubscriptionChargeType
+    
+    MANUAL = 'MANUAL'.freeze
+    AUTOMATIC = 'AUTOMATIC'.freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = SubscriptionChargeType.constants.select { |c| SubscriptionChargeType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #SubscriptionChargeType" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/vrpayment-ruby-sdk/models/subscription_component_configuration.rb

@@ -0,0 +1,231 @@
+=begin
+The VR Payment API allows an easy interaction with the VR Payment 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 VRPayment
+  # 
+  class SubscriptionComponentConfiguration
+    # The component that is being configured.
+    attr_accessor :component
+
+    # A unique identifier for the object.
+    attr_accessor :id
+
+    # The ID of the space this object belongs to.
+    attr_accessor :linked_space_id
+
+    # The quantity that should be applied to the component.
+    attr_accessor :quantity
+
+    # The version is used for optimistic locking and incremented whenever the object is updated.
+    attr_accessor :version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'component' => :'component',
+        :'id' => :'id',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'quantity' => :'quantity',
+        :'version' => :'version'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'component' => :'Integer',
+        :'id' => :'Integer',
+        :'linked_space_id' => :'Integer',
+        :'quantity' => :'Float',
+        :'version' => :'Integer'
+      }
+    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?(:'component')
+        self.component = attributes[:'component']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'linkedSpaceId')
+        self.linked_space_id = attributes[:'linkedSpaceId']
+      end
+
+      if attributes.has_key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      end
+
+      if attributes.has_key?(:'version')
+        self.version = attributes[:'version']
+      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 &&
+          component == o.component &&
+          id == o.id &&
+          linked_space_id == o.linked_space_id &&
+          quantity == o.quantity &&
+          version == o.version
+    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
+      [component, id, linked_space_id, quantity, version].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 = VRPayment.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