vrpayment-ruby-sdk 5.0.1

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

@@ -0,0 +1,373 @@
+=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 SubscriptionVersion
+    # The date and time when the subscription version was activated.
+    attr_accessor :activated_on
+
+    # The three-letter code (ISO 4217 format) of the currency used to invoice the customer. Must be one of the currencies supported by the product.
+    attr_accessor :billing_currency
+
+    # 
+    attr_accessor :billing_cycle_model
+
+    # The configurations of the subscription's components.
+    attr_accessor :component_configurations
+
+    # The date and time when the subscription version was created.
+    attr_accessor :created_on
+
+    # The date and time when the last period is expected to end.
+    attr_accessor :expected_last_period_end
+
+    # The date and time when the subscription version failed.
+    attr_accessor :failed_on
+
+    # A unique identifier for the object.
+    attr_accessor :id
+
+    # The language that is linked to the object.
+    attr_accessor :language
+
+    # The ID of the space this object belongs to.
+    attr_accessor :linked_space_id
+
+    # 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 date and time when the termination of the subscription version is planned.
+    attr_accessor :planned_termination_date
+
+    # The product version that is subscribed to.
+    attr_accessor :product_version
+
+    # The object's current state.
+    attr_accessor :state
+
+    # The subscription that this version belongs to.
+    attr_accessor :subscription
+
+    # The date and time when the subscription version was terminated.
+    attr_accessor :terminated_on
+
+    # The date and time when the termination of the subscription version started.
+    attr_accessor :terminating_on
+
+    # The date and time when the termination of the subscription version was issued.
+    attr_accessor :termination_issued_on
+
+    # 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
+      {
+        :'activated_on' => :'activatedOn',
+        :'billing_currency' => :'billingCurrency',
+        :'billing_cycle_model' => :'billingCycleModel',
+        :'component_configurations' => :'componentConfigurations',
+        :'created_on' => :'createdOn',
+        :'expected_last_period_end' => :'expectedLastPeriodEnd',
+        :'failed_on' => :'failedOn',
+        :'id' => :'id',
+        :'language' => :'language',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'planned_purge_date' => :'plannedPurgeDate',
+        :'planned_termination_date' => :'plannedTerminationDate',
+        :'product_version' => :'productVersion',
+        :'state' => :'state',
+        :'subscription' => :'subscription',
+        :'terminated_on' => :'terminatedOn',
+        :'terminating_on' => :'terminatingOn',
+        :'termination_issued_on' => :'terminationIssuedOn',
+        :'version' => :'version'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'activated_on' => :'DateTime',
+        :'billing_currency' => :'String',
+        :'billing_cycle_model' => :'BillingCycleModel',
+        :'component_configurations' => :'Array<SubscriptionComponentConfiguration>',
+        :'created_on' => :'DateTime',
+        :'expected_last_period_end' => :'DateTime',
+        :'failed_on' => :'DateTime',
+        :'id' => :'Integer',
+        :'language' => :'String',
+        :'linked_space_id' => :'Integer',
+        :'planned_purge_date' => :'DateTime',
+        :'planned_termination_date' => :'DateTime',
+        :'product_version' => :'SubscriptionProductVersion',
+        :'state' => :'SubscriptionVersionState',
+        :'subscription' => :'Subscription',
+        :'terminated_on' => :'DateTime',
+        :'terminating_on' => :'DateTime',
+        :'termination_issued_on' => :'DateTime',
+        :'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?(:'activatedOn')
+        self.activated_on = attributes[:'activatedOn']
+      end
+
+      if attributes.has_key?(:'billingCurrency')
+        self.billing_currency = attributes[:'billingCurrency']
+      end
+
+      if attributes.has_key?(:'billingCycleModel')
+        self.billing_cycle_model = attributes[:'billingCycleModel']
+      end
+
+      if attributes.has_key?(:'componentConfigurations')
+        if (value = attributes[:'componentConfigurations']).is_a?(Array)
+          self.component_configurations = value
+        end
+      end
+
+      if attributes.has_key?(:'createdOn')
+        self.created_on = attributes[:'createdOn']
+      end
+
+      if attributes.has_key?(:'expectedLastPeriodEnd')
+        self.expected_last_period_end = attributes[:'expectedLastPeriodEnd']
+      end
+
+      if attributes.has_key?(:'failedOn')
+        self.failed_on = attributes[:'failedOn']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'language')
+        self.language = attributes[:'language']
+      end
+
+      if attributes.has_key?(:'linkedSpaceId')
+        self.linked_space_id = attributes[:'linkedSpaceId']
+      end
+
+      if attributes.has_key?(:'plannedPurgeDate')
+        self.planned_purge_date = attributes[:'plannedPurgeDate']
+      end
+
+      if attributes.has_key?(:'plannedTerminationDate')
+        self.planned_termination_date = attributes[:'plannedTerminationDate']
+      end
+
+      if attributes.has_key?(:'productVersion')
+        self.product_version = attributes[:'productVersion']
+      end
+
+      if attributes.has_key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.has_key?(:'subscription')
+        self.subscription = attributes[:'subscription']
+      end
+
+      if attributes.has_key?(:'terminatedOn')
+        self.terminated_on = attributes[:'terminatedOn']
+      end
+
+      if attributes.has_key?(:'terminatingOn')
+        self.terminating_on = attributes[:'terminatingOn']
+      end
+
+      if attributes.has_key?(:'terminationIssuedOn')
+        self.termination_issued_on = attributes[:'terminationIssuedOn']
+      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 &&
+          activated_on == o.activated_on &&
+          billing_currency == o.billing_currency &&
+          billing_cycle_model == o.billing_cycle_model &&
+          component_configurations == o.component_configurations &&
+          created_on == o.created_on &&
+          expected_last_period_end == o.expected_last_period_end &&
+          failed_on == o.failed_on &&
+          id == o.id &&
+          language == o.language &&
+          linked_space_id == o.linked_space_id &&
+          planned_purge_date == o.planned_purge_date &&
+          planned_termination_date == o.planned_termination_date &&
+          product_version == o.product_version &&
+          state == o.state &&
+          subscription == o.subscription &&
+          terminated_on == o.terminated_on &&
+          terminating_on == o.terminating_on &&
+          termination_issued_on == o.termination_issued_on &&
+          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
+      [activated_on, billing_currency, billing_cycle_model, component_configurations, created_on, expected_last_period_end, failed_on, id, language, linked_space_id, planned_purge_date, planned_termination_date, product_version, state, subscription, terminated_on, terminating_on, termination_issued_on, 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

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

@@ -0,0 +1,39 @@
+=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 SubscriptionVersionState
+    
+    PENDING = 'PENDING'.freeze
+    INITIALIZING = 'INITIALIZING'.freeze
+    FAILED = 'FAILED'.freeze
+    ACTIVE = 'ACTIVE'.freeze
+    TERMINATING = 'TERMINATING'.freeze
+    TERMINATED = 'TERMINATED'.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 = SubscriptionVersionState.constants.select { |c| SubscriptionVersionState::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #SubscriptionVersionState" if constantValues.empty?
+      value
+    end
+  end
+end

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

@@ -0,0 +1,225 @@
+=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 Tax
+    # The tax rate to be applied.
+    attr_accessor :rate
+
+    # The name of the tax.
+    attr_accessor :title
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'rate' => :'rate',
+        :'title' => :'title'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'rate' => :'Float',
+        :'title' => :'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?(:'rate')
+        self.rate = attributes[:'rate']
+      end
+
+      if attributes.has_key?(:'title')
+        self.title = attributes[:'title']
+      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 !@title.nil? && @title.to_s.length > 40
+        invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 40.')
+      end
+
+      if !@title.nil? && @title.to_s.length < 2
+        invalid_properties.push('invalid value for "title", the character length must be great than or equal to 2.')
+      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 !@title.nil? && @title.to_s.length > 40
+      return false if !@title.nil? && @title.to_s.length < 2
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if !title.nil? && title.to_s.length > 40
+        fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 40.'
+      end
+
+      if !title.nil? && title.to_s.length < 2
+        fail ArgumentError, 'invalid value for "title", the character length must be great than or equal to 2.'
+      end
+
+      @title = title
+    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 &&
+          rate == o.rate &&
+          title == o.title
+    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
+      [rate, title].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/tax_calculation.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 TaxCalculation
+    
+    TAX_INCLUDED = 'TAX_INCLUDED'.freeze
+    TAX_NOT_INCLUDED = 'TAX_NOT_INCLUDED'.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 = TaxCalculation.constants.select { |c| TaxCalculation::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #TaxCalculation" if constantValues.empty?
+      value
+    end
+  end
+end