vrpayment-ruby-sdk 5.1.0 → 6.0.0

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

@@ -1,233 +1,388 @@
-=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
+# VR Payment Ruby SDK
+#
+# This library allows to interact with the VR Payment payment service.
+#
+# Copyright owner: Wallee AG
+# Website: https://www.vr-payment.de
+# Developer email: ecosystem-team@wallee.com
+#
+# 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.
 
 require 'date'
+require 'time'
 
-module VRPayment
-  # 
+module VrpaymentRubySdk
   class Scope
-    # The domain name that belongs to the scope.
-    attr_accessor :domain_name
+    # The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
+    attr_accessor :planned_purge_date
 
-    # The list of features that are active in the scope.
-    attr_accessor :features
+    # Whether the scope supports SSL.
+    attr_accessor :ssl_active
 
-    # A unique identifier for the object.
-    attr_accessor :id
+    # The version is used for optimistic locking and incremented whenever the object is updated.
+    attr_accessor :version
 
     # The name identifying the scope in e.g. URLs.
     attr_accessor :machine_name
 
-    # The name used to identify the scope.
-    attr_accessor :name
+    # The URL where the scope can be accessed.
+    attr_accessor :url
 
-    # The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
-    attr_accessor :planned_purge_date
+    # The list of features that are active in the scope.
+    attr_accessor :features
+
+    # The themes that determine the look and feel of the scope's user interface. A fall-through strategy is applied when building the actual theme.
+    attr_accessor :themes
 
     # The port where the scope can be accessed.
     attr_accessor :port
 
-    # Whether the scope supports SSL.
-    attr_accessor :ssl_active
+    # The preprod domain name that belongs to the scope.
+    attr_accessor :preprod_domain_name
 
-    # The object's current state.
-    attr_accessor :state
+    # The domain name that belongs to the scope.
+    attr_accessor :domain_name
 
-    # The themes that determine the look and feel of the scope's user interface. A fall-through strategy is applied when building the actual theme.
-    attr_accessor :themes
+    # The name used to identify the scope.
+    attr_accessor :name
 
-    # The URL where the scope can be accessed.
-    attr_accessor :url
+    # A unique identifier for the object.
+    attr_accessor :id
 
-    # The version is used for optimistic locking and incremented whenever the object is updated.
-    attr_accessor :version
+    attr_accessor :state
+
+    # The sandbox domain name that belongs to the scope.
+    attr_accessor :sandbox_domain_name
+
+    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
       {
-        :'domain_name' => :'domainName',
-        :'features' => :'features',
-        :'id' => :'id',
-        :'machine_name' => :'machineName',
-        :'name' => :'name',
         :'planned_purge_date' => :'plannedPurgeDate',
-        :'port' => :'port',
         :'ssl_active' => :'sslActive',
-        :'state' => :'state',
-        :'themes' => :'themes',
+        :'version' => :'version',
+        :'machine_name' => :'machineName',
         :'url' => :'url',
-        :'version' => :'version'
+        :'features' => :'features',
+        :'themes' => :'themes',
+        :'port' => :'port',
+        :'preprod_domain_name' => :'preprodDomainName',
+        :'domain_name' => :'domainName',
+        :'name' => :'name',
+        :'id' => :'id',
+        :'state' => :'state',
+        :'sandbox_domain_name' => :'sandboxDomainName'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
-        :'domain_name' => :'String',
-        :'features' => :'Array<Feature>',
-        :'id' => :'Integer',
+        :'planned_purge_date' => :'Time',
+        :'ssl_active' => :'Boolean',
+        :'version' => :'Integer',
         :'machine_name' => :'String',
-        :'name' => :'String',
-        :'planned_purge_date' => :'DateTime',
+        :'url' => :'String',
+        :'features' => :'Array<Feature>',
+        :'themes' => :'Array<String>',
         :'port' => :'Integer',
-        :'ssl_active' => :'BOOLEAN',
+        :'preprod_domain_name' => :'String',
+        :'domain_name' => :'String',
+        :'name' => :'String',
+        :'id' => :'Integer',
         :'state' => :'CreationEntityState',
-        :'themes' => :'Array<String>',
-        :'url' => :'String',
-        :'version' => :'Integer'
+        :'sandbox_domain_name' => :'String'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      unless attributes.is_a?(Hash)
+        fail ArgumentError, "The input argument (attributes) must be a hash in `VrpaymentRubySdk::Scope` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        unless self.class.attribute_map.key?(k.to_sym)
+          fail ArgumentError, "`#{k}` is not a valid attribute in `VrpaymentRubySdk::Scope`. 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.has_key?(:'domainName')
-        self.domain_name = attributes[:'domainName']
+      if attributes.key?(:'planned_purge_date')
+        self.planned_purge_date = attributes[:'planned_purge_date']
       end
 
-      if attributes.has_key?(:'features')
-        if (value = attributes[:'features']).is_a?(Array)
-          self.features = value
-        end
+      if attributes.key?(:'ssl_active')
+        self.ssl_active = attributes[:'ssl_active']
       end
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
       end
 
-      if attributes.has_key?(:'machineName')
-        self.machine_name = attributes[:'machineName']
+      if attributes.key?(:'machine_name')
+        self.machine_name = attributes[:'machine_name']
       end
 
-      if attributes.has_key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'features')
+        if (value = attributes[:'features']).is_a?(Array)
+          self.features = value
+        end
       end
 
-      if attributes.has_key?(:'plannedPurgeDate')
-        self.planned_purge_date = attributes[:'plannedPurgeDate']
+      if attributes.key?(:'themes')
+        if (value = attributes[:'themes']).is_a?(Array)
+          self.themes = value
+        end
       end
 
-      if attributes.has_key?(:'port')
+      if attributes.key?(:'port')
         self.port = attributes[:'port']
       end
 
-      if attributes.has_key?(:'sslActive')
-        self.ssl_active = attributes[:'sslActive']
+      if attributes.key?(:'preprod_domain_name')
+        self.preprod_domain_name = attributes[:'preprod_domain_name']
       end
 
-      if attributes.has_key?(:'state')
-        self.state = attributes[:'state']
+      if attributes.key?(:'domain_name')
+        self.domain_name = attributes[:'domain_name']
       end
 
-      if attributes.has_key?(:'themes')
-        if (value = attributes[:'themes']).is_a?(Array)
-          self.themes = value
-        end
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
 
-      if attributes.has_key?(:'url')
-        self.url = attributes[:'url']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'version')
-        self.version = attributes[:'version']
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'sandbox_domain_name')
+        self.sandbox_domain_name = attributes[:'sandbox_domain_name']
       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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if !@domain_name.nil? && @domain_name.to_s.length > 40
-        invalid_properties.push('invalid value for "domain_name", the character length must be smaller than or equal to 40.')
-      end
-
       if !@machine_name.nil? && @machine_name.to_s.length > 50
         invalid_properties.push('invalid value for "machine_name", the character length must be smaller than or equal to 50.')
       end
 
+      pattern = Regexp.new(/([A-Z][A-Za-z0-9]+)(_([A-Z][A-Za-z0-9]+))*/)
+      if !@machine_name.nil? && @machine_name !~ pattern
+        invalid_properties.push("invalid value for \"machine_name\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@port.nil? && @port < 1
+        invalid_properties.push('invalid value for "port", must be greater than or equal to 1.')
+      end
+
+      if !@preprod_domain_name.nil? && @preprod_domain_name.to_s.length > 40
+        invalid_properties.push('invalid value for "preprod_domain_name", the character length must be smaller than or equal to 40.')
+      end
+
+      if !@domain_name.nil? && @domain_name.to_s.length > 40
+        invalid_properties.push('invalid value for "domain_name", the character length must be smaller than or equal to 40.')
+      end
+
       if !@name.nil? && @name.to_s.length > 50
         invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 50.')
       end
 
+      if !@sandbox_domain_name.nil? && @sandbox_domain_name.to_s.length > 40
+        invalid_properties.push('invalid value for "sandbox_domain_name", the character length must be smaller than or equal to 40.')
+      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 !@domain_name.nil? && @domain_name.to_s.length > 40
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@machine_name.nil? && @machine_name.to_s.length > 50
+      pattern = Regexp.new(/([A-Z][A-Za-z0-9]+)(_([A-Z][A-Za-z0-9]+))*/)
+      return false if !@machine_name.nil? && @machine_name !~ pattern
+      return false if !@port.nil? && @port < 1
+      return false if !@preprod_domain_name.nil? && @preprod_domain_name.to_s.length > 40
+      return false if !@domain_name.nil? && @domain_name.to_s.length > 40
       return false if !@name.nil? && @name.to_s.length > 50
+      return false if !@sandbox_domain_name.nil? && @sandbox_domain_name.to_s.length > 40
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] domain_name Value to be assigned
-    def domain_name=(domain_name)
-      if !domain_name.nil? && domain_name.to_s.length > 40
-        fail ArgumentError, 'invalid value for "domain_name", the character length must be smaller than or equal to 40.'
+    # @param [Object] machine_name Value to be assigned
+    def machine_name=(machine_name)
+      if machine_name.nil?
+        fail ArgumentError, 'machine_name cannot be nil'
       end
 
-      @domain_name = domain_name
+      if machine_name.to_s.length > 50
+        fail ArgumentError, 'invalid value for "machine_name", the character length must be smaller than or equal to 50.'
+      end
+
+      pattern = Regexp.new(/([A-Z][A-Za-z0-9]+)(_([A-Z][A-Za-z0-9]+))*/)
+      if machine_name !~ pattern
+        fail ArgumentError, "invalid value for \"machine_name\", must conform to the pattern #{pattern}."
+      end
+
+      @machine_name = machine_name
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] machine_name Value to be assigned
-    def machine_name=(machine_name)
-      if !machine_name.nil? && machine_name.to_s.length > 50
-        fail ArgumentError, 'invalid value for "machine_name", the character length must be smaller than or equal to 50.'
+    # @param [Object] features Value to be assigned
+    def features=(features)
+      if features.nil?
+        fail ArgumentError, 'features cannot be nil'
       end
 
-      @machine_name = machine_name
+      @features = features
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] port Value to be assigned
+    def port=(port)
+      if port.nil?
+        fail ArgumentError, 'port cannot be nil'
+      end
+
+      if port < 1
+        fail ArgumentError, 'invalid value for "port", must be greater than or equal to 1.'
+      end
+
+      @port = port
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] preprod_domain_name Value to be assigned
+    def preprod_domain_name=(preprod_domain_name)
+      if preprod_domain_name.nil?
+        fail ArgumentError, 'preprod_domain_name cannot be nil'
+      end
+
+      if preprod_domain_name.to_s.length > 40
+        fail ArgumentError, 'invalid value for "preprod_domain_name", the character length must be smaller than or equal to 40.'
+      end
+
+      @preprod_domain_name = preprod_domain_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] domain_name Value to be assigned
+    def domain_name=(domain_name)
+      if domain_name.nil?
+        fail ArgumentError, 'domain_name cannot be nil'
+      end
+
+      if domain_name.to_s.length > 40
+        fail ArgumentError, 'invalid value for "domain_name", the character length must be smaller than or equal to 40.'
+      end
+
+      @domain_name = domain_name
     end
 
     # Custom attribute writer method with validation
     # @param [Object] name Value to be assigned
     def name=(name)
-      if !name.nil? && name.to_s.length > 50
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 50
         fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 50.'
       end
 
       @name = name
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] sandbox_domain_name Value to be assigned
+    def sandbox_domain_name=(sandbox_domain_name)
+      if sandbox_domain_name.nil?
+        fail ArgumentError, 'sandbox_domain_name cannot be nil'
+      end
+
+      if sandbox_domain_name.to_s.length > 40
+        fail ArgumentError, 'invalid value for "sandbox_domain_name", the character length must be smaller than or equal to 40.'
+      end
+
+      @sandbox_domain_name = sandbox_domain_name
+    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 &&
-          domain_name == o.domain_name &&
-          features == o.features &&
-          id == o.id &&
-          machine_name == o.machine_name &&
-          name == o.name &&
           planned_purge_date == o.planned_purge_date &&
-          port == o.port &&
           ssl_active == o.ssl_active &&
-          state == o.state &&
-          themes == o.themes &&
+          version == o.version &&
+          machine_name == o.machine_name &&
           url == o.url &&
-          version == o.version
+          features == o.features &&
+          themes == o.themes &&
+          port == o.port &&
+          preprod_domain_name == o.preprod_domain_name &&
+          domain_name == o.domain_name &&
+          name == o.name &&
+          id == o.id &&
+          state == o.state &&
+          sandbox_domain_name == o.sandbox_domain_name
     end
 
     # @see the `==` method
@@ -237,39 +392,40 @@ module VRPayment
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [domain_name, features, id, machine_name, name, planned_purge_date, port, ssl_active, state, themes, url, version].hash
-    end
-
-    # Builds the object from hash
+      [planned_purge_date, ssl_active, version, machine_name, url, features, themes, port, preprod_domain_name, domain_name, name, id, state, sandbox_domain_name].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)
+    def self.build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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) } )
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -278,7 +434,7 @@ module VRPayment
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -299,8 +455,9 @@ module VRPayment
           end
         end
       else # model
-        temp_model = VRPayment.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = VrpaymentRubySdk.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -322,7 +479,11 @@ module VRPayment
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
         hash[param] = _to_hash(value)
       end
       hash
@@ -334,7 +495,7 @@ module VRPayment
     # @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) }
@@ -345,6 +506,5 @@ module VRPayment
         value
       end
     end
-
   end
 end