crisphive 0.2.0 → 0.3.0

data/lib/crisphive/models/vehicle_update_request.rb

@@ -0,0 +1,440 @@
+=begin
+#Crisphive Developer API
+
+#Public REST API for integrating Crisphive from your own backend. Authenticate every request with a secret API key as a Bearer token (`Authorization: Bearer chsk_live_…`). The key prefix selects the data environment: `chsk_live_…` → production (live), `chsk_test_…` → sandbox (isolated test).  **Key scopes (restricted keys).** A key is either *full-access* (can call every endpoint below) or *restricted* to a set of permission codes chosen at creation — the same codes as the dashboard permission grid (e.g. `customers_view`, `job_create`, `team_manage`). A restricted key calling an endpoint outside its scope gets `403`. The full code list is the permission catalog (`GET /permission/modules` on the dashboard API). Create, scope, and revoke keys from the business dashboard.  Every response is wrapped in the envelope `{ \"error_code\": 0, \"message\": \"Success\", \"data\": <payload> }`.
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Crisphive
+  class VehicleUpdateRequest
+    # nil = keep; \"\" clears the field.
+    attr_accessor :brand
+
+    attr_accessor :current_mileage
+
+    attr_accessor :model
+
+    # nil = keep. min=1 rejects an explicit \"\" (a vehicle needs a name); omitempty is what lets a nil pointer skip validation entirely.
+    attr_accessor :name
+
+    # nil = keep the current owner; \"\" clears it; a UUID sets it.
+    attr_accessor :owner_id
+
+    attr_accessor :plate_number
+
+    attr_accessor :status
+
+    # nil = keep; a non-nil value must be a known enum member.
+    attr_accessor :vehicle_type
+
+    attr_accessor :year
+
+    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
+      {
+        :'brand' => :'brand',
+        :'current_mileage' => :'current_mileage',
+        :'model' => :'model',
+        :'name' => :'name',
+        :'owner_id' => :'owner_id',
+        :'plate_number' => :'plate_number',
+        :'status' => :'status',
+        :'vehicle_type' => :'vehicle_type',
+        :'year' => :'year'
+      }
+    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
+      {
+        :'brand' => :'String',
+        :'current_mileage' => :'Integer',
+        :'model' => :'String',
+        :'name' => :'String',
+        :'owner_id' => :'String',
+        :'plate_number' => :'String',
+        :'status' => :'String',
+        :'vehicle_type' => :'String',
+        :'year' => :'Integer'
+      }
+    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 `Crisphive::VehicleUpdateRequest` 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 `Crisphive::VehicleUpdateRequest`. 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?(:'brand')
+        self.brand = attributes[:'brand']
+      end
+
+      if attributes.key?(:'current_mileage')
+        self.current_mileage = attributes[:'current_mileage']
+      end
+
+      if attributes.key?(:'model')
+        self.model = attributes[:'model']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'owner_id')
+        self.owner_id = attributes[:'owner_id']
+      end
+
+      if attributes.key?(:'plate_number')
+        self.plate_number = attributes[:'plate_number']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'vehicle_type')
+        self.vehicle_type = attributes[:'vehicle_type']
+      end
+
+      if attributes.key?(:'year')
+        self.year = attributes[:'year']
+      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 !@brand.nil? && @brand.to_s.length > 50
+        invalid_properties.push('invalid value for "brand", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@current_mileage.nil? && @current_mileage < 0
+        invalid_properties.push('invalid value for "current_mileage", must be greater than or equal to 0.')
+      end
+
+      if !@model.nil? && @model.to_s.length > 50
+        invalid_properties.push('invalid value for "model", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@name.nil? && @name.to_s.length > 100
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@name.nil? && @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      if !@plate_number.nil? && @plate_number.to_s.length > 20
+        invalid_properties.push('invalid value for "plate_number", the character length must be smaller than or equal to 20.')
+      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 !@brand.nil? && @brand.to_s.length > 50
+      return false if !@current_mileage.nil? && @current_mileage < 0
+      return false if !@model.nil? && @model.to_s.length > 50
+      return false if !@name.nil? && @name.to_s.length > 100
+      return false if !@name.nil? && @name.to_s.length < 1
+      return false if !@plate_number.nil? && @plate_number.to_s.length > 20
+      status_validator = EnumAttributeValidator.new('String', ["inactive", "idle", "on_job", "maintenance"])
+      return false unless status_validator.valid?(@status)
+      vehicle_type_validator = EnumAttributeValidator.new('String', ["van", "truck", "car"])
+      return false unless vehicle_type_validator.valid?(@vehicle_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] brand Value to be assigned
+    def brand=(brand)
+      if brand.nil?
+        fail ArgumentError, 'brand cannot be nil'
+      end
+
+      if brand.to_s.length > 50
+        fail ArgumentError, 'invalid value for "brand", the character length must be smaller than or equal to 50.'
+      end
+
+      @brand = brand
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] current_mileage Value to be assigned
+    def current_mileage=(current_mileage)
+      if current_mileage.nil?
+        fail ArgumentError, 'current_mileage cannot be nil'
+      end
+
+      if current_mileage < 0
+        fail ArgumentError, 'invalid value for "current_mileage", must be greater than or equal to 0.'
+      end
+
+      @current_mileage = current_mileage
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] model Value to be assigned
+    def model=(model)
+      if model.nil?
+        fail ArgumentError, 'model cannot be nil'
+      end
+
+      if model.to_s.length > 50
+        fail ArgumentError, 'invalid value for "model", the character length must be smaller than or equal to 50.'
+      end
+
+      @model = model
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] plate_number Value to be assigned
+    def plate_number=(plate_number)
+      if plate_number.nil?
+        fail ArgumentError, 'plate_number cannot be nil'
+      end
+
+      if plate_number.to_s.length > 20
+        fail ArgumentError, 'invalid value for "plate_number", the character length must be smaller than or equal to 20.'
+      end
+
+      @plate_number = plate_number
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["inactive", "idle", "on_job", "maintenance"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] vehicle_type Object to be assigned
+    def vehicle_type=(vehicle_type)
+      validator = EnumAttributeValidator.new('String', ["van", "truck", "car"])
+      unless validator.valid?(vehicle_type)
+        fail ArgumentError, "invalid value for \"vehicle_type\", must be one of #{validator.allowable_values}."
+      end
+      @vehicle_type = vehicle_type
+    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 &&
+          brand == o.brand &&
+          current_mileage == o.current_mileage &&
+          model == o.model &&
+          name == o.name &&
+          owner_id == o.owner_id &&
+          plate_number == o.plate_number &&
+          status == o.status &&
+          vehicle_type == o.vehicle_type &&
+          year == o.year
+    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
+      [brand, current_mileage, model, name, owner_id, plate_number, status, vehicle_type, year].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 = Crisphive.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