togai_client 1.0.1 → 1.0.2

data/lib/togai_client/models/price_plan_list_data.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 Contact: engg@togai.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0
+Generator version: 7.10.0
 
 =end
 
@@ -16,24 +16,34 @@ require 'time'
 module TogaiClient
   # Data of price plan list
   class PricePlanListData
+    # Identifier of price plan
+    attr_accessor :id
+
     # Name of the price plan
     attr_accessor :name
 
+    # Version of the price plan
+    attr_accessor :version
+
     # Description of price plan
     attr_accessor :description
 
     # Status of Price plan
     attr_accessor :status
 
-    # Usage meters name linked to the price plan
+    # Usage meters id linked to the price plan
     attr_accessor :usage_meters
 
     attr_accessor :price_plan_details
 
+    attr_accessor :pricing_rules
+
     attr_accessor :created_at
 
     attr_accessor :updated_at
 
+    attr_accessor :type
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -59,13 +69,17 @@ module TogaiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'id' => :'id',
         :'name' => :'name',
+        :'version' => :'version',
         :'description' => :'description',
         :'status' => :'status',
         :'usage_meters' => :'usageMeters',
         :'price_plan_details' => :'pricePlanDetails',
+        :'pricing_rules' => :'pricingRules',
         :'created_at' => :'createdAt',
-        :'updated_at' => :'updatedAt'
+        :'updated_at' => :'updatedAt',
+        :'type' => :'type'
       }
     end
 
@@ -77,13 +91,17 @@ module TogaiClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'id' => :'String',
         :'name' => :'String',
+        :'version' => :'Integer',
         :'description' => :'String',
         :'status' => :'String',
         :'usage_meters' => :'Array<String>',
         :'price_plan_details' => :'PricePlanDetails',
+        :'pricing_rules' => :'Array<PricingRule>',
         :'created_at' => :'Time',
-        :'updated_at' => :'Time'
+        :'updated_at' => :'Time',
+        :'type' => :'PricePlanType'
       }
     end
 
@@ -108,8 +126,22 @@ module TogaiClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      else
+        self.version = nil
       end
 
       if attributes.key?(:'description')
@@ -118,31 +150,62 @@ module TogaiClient
 
       if attributes.key?(:'status')
         self.status = attributes[:'status']
+      else
+        self.status = nil
       end
 
       if attributes.key?(:'usage_meters')
         if (value = attributes[:'usage_meters']).is_a?(Array)
           self.usage_meters = value
         end
+      else
+        self.usage_meters = nil
       end
 
       if attributes.key?(:'price_plan_details')
         self.price_plan_details = attributes[:'price_plan_details']
+      else
+        self.price_plan_details = nil
+      end
+
+      if attributes.key?(:'pricing_rules')
+        if (value = attributes[:'pricing_rules']).is_a?(Array)
+          self.pricing_rules = value
+        end
       end
 
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
       end
 
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
       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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @id.to_s.length > 50
+        invalid_properties.push('invalid value for "id", the character length must be smaller than or equal to 50.')
+      end
+
       if @name.nil?
         invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
@@ -151,6 +214,10 @@ module TogaiClient
         invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 50.')
       end
 
+      if @version.nil?
+        invalid_properties.push('invalid value for "version", version cannot be nil.')
+      end
+
       if !@description.nil? && @description.to_s.length > 255
         invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
       end
@@ -175,14 +242,22 @@ module TogaiClient
         invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
       end
 
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @id.to_s.length > 50
       return false if @name.nil?
       return false if @name.to_s.length > 50
+      return false if @version.nil?
       return false if !@description.nil? && @description.to_s.length > 255
       return false if @status.nil?
       status_validator = EnumAttributeValidator.new('String', ["DRAFT", "ACTIVE", "ARCHIVED"])
@@ -191,9 +266,24 @@ module TogaiClient
       return false if @price_plan_details.nil?
       return false if @created_at.nil?
       return false if @updated_at.nil?
+      return false if @type.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      if id.to_s.length > 50
+        fail ArgumentError, 'invalid value for "id", the character length must be smaller than or equal to 50.'
+      end
+
+      @id = id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] name Value to be assigned
     def name=(name)
@@ -211,7 +301,11 @@ module TogaiClient
     # Custom attribute writer method with validation
     # @param [Object] description Value to be assigned
     def description=(description)
-      if !description.nil? && description.to_s.length > 255
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 255
         fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 255.'
       end
 
@@ -233,13 +327,17 @@ module TogaiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          id == o.id &&
           name == o.name &&
+          version == o.version &&
           description == o.description &&
           status == o.status &&
           usage_meters == o.usage_meters &&
           price_plan_details == o.price_plan_details &&
+          pricing_rules == o.pricing_rules &&
           created_at == o.created_at &&
-          updated_at == o.updated_at
+          updated_at == o.updated_at &&
+          type == o.type
     end
 
     # @see the `==` method
@@ -251,44 +349,37 @@ module TogaiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, status, usage_meters, price_plan_details, created_at, updated_at].hash
+      [id, name, version, description, status, usage_meters, price_plan_details, pricing_rules, created_at, updated_at, type].hash
     end
 
     # Builds the object from hash
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    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)
       attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      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]]))
+        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 :Time
         Time.parse(value)
@@ -323,7 +414,7 @@ module TogaiClient
       else # model
         # models (e.g. Pet) or oneOf
         klass = TogaiClient.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/togai_client/models/price_plan_migration_config.rb

@@ -0,0 +1,368 @@
+=begin
+#Togai Apis
+
+#APIs for Togai App
+
+The version of the OpenAPI document: 1.0
+Contact: engg@togai.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TogaiClient
+  # Migrate all account associations of a price plan to another price plan
+  class PricePlanMigrationConfig
+    # Id of source price plan
+    attr_accessor :source_id
+
+    # Version of the source price plan
+    attr_accessor :source_version
+
+    # Id of target price plan
+    attr_accessor :target_id
+
+    # Version of the target price plan
+    attr_accessor :target_version
+
+    attr_accessor :migration_mode
+
+    # If this flag is true, current pricing cycle of the account on the date of association will continue rather  than the configurations of the newly associated price plan. Pricing cycle overrides specified  using  `pricePlanDetailsOverride` will take precedence over the pricing cycle configurations of  the new price plan that the account needs to migrate to. PricingCycleInterval of the existing plan and  the new plan must be same for this to work. We'll return a `400 BadRequest` otherwise. Examples:   - Ongoing plan (1st Oct to 30th Oct) - {dayOffset: 1, monthOffset: NIL}     New association (15th Oct to 15th Nov) of different price plan with retainStartOffsets option true      will use the same pricing cycle configuration {dayOffset: 1, monthOffset: NIL} rather than using the     pricing cycle configuration of the new price plan that the account needs to migrate to.   - Ongoing plan (1st Oct to 30th Oct) - {dayOffset: 1, monthOffset: NIL}     New association (1st Nov to 30th Nov) of different price plan with retainStartOffsets option true will     throw a `400 BadRequest` as no existing price plan configuration found on date of association 
+    attr_accessor :retain_start_offsets
+
+    # If this flag is true, the migration will be done for price plan v2. Default value is false 
+    attr_accessor :is_price_plan_v2_migration
+
+    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
+      {
+        :'source_id' => :'sourceId',
+        :'source_version' => :'sourceVersion',
+        :'target_id' => :'targetId',
+        :'target_version' => :'targetVersion',
+        :'migration_mode' => :'migrationMode',
+        :'retain_start_offsets' => :'retainStartOffsets',
+        :'is_price_plan_v2_migration' => :'isPricePlanV2Migration'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'source_id' => :'String',
+        :'source_version' => :'Integer',
+        :'target_id' => :'String',
+        :'target_version' => :'Integer',
+        :'migration_mode' => :'String',
+        :'retain_start_offsets' => :'Boolean',
+        :'is_price_plan_v2_migration' => :'Boolean'
+      }
+    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 = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TogaiClient::PricePlanMigrationConfig` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TogaiClient::PricePlanMigrationConfig`. 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.key?(:'source_id')
+        self.source_id = attributes[:'source_id']
+      else
+        self.source_id = nil
+      end
+
+      if attributes.key?(:'source_version')
+        self.source_version = attributes[:'source_version']
+      else
+        self.source_version = nil
+      end
+
+      if attributes.key?(:'target_id')
+        self.target_id = attributes[:'target_id']
+      end
+
+      if attributes.key?(:'target_version')
+        self.target_version = attributes[:'target_version']
+      end
+
+      if attributes.key?(:'migration_mode')
+        self.migration_mode = attributes[:'migration_mode']
+      else
+        self.migration_mode = nil
+      end
+
+      if attributes.key?(:'retain_start_offsets')
+        self.retain_start_offsets = attributes[:'retain_start_offsets']
+      end
+
+      if attributes.key?(:'is_price_plan_v2_migration')
+        self.is_price_plan_v2_migration = attributes[:'is_price_plan_v2_migration']
+      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 @source_id.nil?
+        invalid_properties.push('invalid value for "source_id", source_id cannot be nil.')
+      end
+
+      if @source_id.to_s.length > 255
+        invalid_properties.push('invalid value for "source_id", the character length must be smaller than or equal to 255.')
+      end
+
+      if @source_version.nil?
+        invalid_properties.push('invalid value for "source_version", source_version cannot be nil.')
+      end
+
+      if !@target_id.nil? && @target_id.to_s.length > 255
+        invalid_properties.push('invalid value for "target_id", the character length must be smaller than or equal to 255.')
+      end
+
+      if @migration_mode.nil?
+        invalid_properties.push('invalid value for "migration_mode", migration_mode cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @source_id.nil?
+      return false if @source_id.to_s.length > 255
+      return false if @source_version.nil?
+      return false if !@target_id.nil? && @target_id.to_s.length > 255
+      return false if @migration_mode.nil?
+      migration_mode_validator = EnumAttributeValidator.new('String', ["IMMEDIATE", "IMMEDIATE_IGNORE_OVERRIDE", "NEXT_CYCLE", "NEXT_CYCLE_IGNORE_OVERRIDE", "START_OF_CURRENT_CYCLE"])
+      return false unless migration_mode_validator.valid?(@migration_mode)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] source_id Value to be assigned
+    def source_id=(source_id)
+      if source_id.nil?
+        fail ArgumentError, 'source_id cannot be nil'
+      end
+
+      if source_id.to_s.length > 255
+        fail ArgumentError, 'invalid value for "source_id", the character length must be smaller than or equal to 255.'
+      end
+
+      @source_id = source_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] target_id Value to be assigned
+    def target_id=(target_id)
+      if target_id.nil?
+        fail ArgumentError, 'target_id cannot be nil'
+      end
+
+      if target_id.to_s.length > 255
+        fail ArgumentError, 'invalid value for "target_id", the character length must be smaller than or equal to 255.'
+      end
+
+      @target_id = target_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] migration_mode Object to be assigned
+    def migration_mode=(migration_mode)
+      validator = EnumAttributeValidator.new('String', ["IMMEDIATE", "IMMEDIATE_IGNORE_OVERRIDE", "NEXT_CYCLE", "NEXT_CYCLE_IGNORE_OVERRIDE", "START_OF_CURRENT_CYCLE"])
+      unless validator.valid?(migration_mode)
+        fail ArgumentError, "invalid value for \"migration_mode\", must be one of #{validator.allowable_values}."
+      end
+      @migration_mode = migration_mode
+    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 &&
+          source_id == o.source_id &&
+          source_version == o.source_version &&
+          target_id == o.target_id &&
+          target_version == o.target_version &&
+          migration_mode == o.migration_mode &&
+          retain_start_offsets == o.retain_start_offsets &&
+          is_price_plan_v2_migration == o.is_price_plan_v2_migration
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [source_id, source_version, target_id, target_version, migration_mode, retain_start_offsets, is_price_plan_v2_migration].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      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 self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = TogaiClient.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
+
+    # 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)
+        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
+    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