crisphive 0.2.0 → 0.3.0

data/lib/crisphive/models/service_area_update_request.rb

@@ -0,0 +1,451 @@
+=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
+  # Service area update request
+  class ServiceAreaUpdateRequest
+    # GeoJSON polygon boundary. Omit to KEEP the stored polygon; send one to replace it.
+    attr_accessor :boundary
+
+    attr_accessor :city
+
+    attr_accessor :country
+
+    attr_accessor :county
+
+    # nil = keep; \"\" clears it.
+    attr_accessor :description
+
+    attr_accessor :district
+
+    # nil = keep; min=1 rejects an explicit \"\".
+    attr_accessor :name
+
+    attr_accessor :postal_code
+
+    attr_accessor :state_province
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'boundary' => :'boundary',
+        :'city' => :'city',
+        :'country' => :'country',
+        :'county' => :'county',
+        :'description' => :'description',
+        :'district' => :'district',
+        :'name' => :'name',
+        :'postal_code' => :'postal_code',
+        :'state_province' => :'state_province'
+      }
+    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
+      {
+        :'boundary' => :'Object',
+        :'city' => :'String',
+        :'country' => :'String',
+        :'county' => :'String',
+        :'description' => :'String',
+        :'district' => :'String',
+        :'name' => :'String',
+        :'postal_code' => :'String',
+        :'state_province' => :'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 = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Crisphive::ServiceAreaUpdateRequest` 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::ServiceAreaUpdateRequest`. 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?(:'boundary')
+        self.boundary = attributes[:'boundary']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'county')
+        self.county = attributes[:'county']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'district')
+        self.district = attributes[:'district']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'state_province')
+        self.state_province = attributes[:'state_province']
+      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 !@city.nil? && @city.to_s.length > 100
+        invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@country.nil? && @country.to_s.length > 100
+        invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@county.nil? && @county.to_s.length > 100
+        invalid_properties.push('invalid value for "county", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@description.nil? && @description.to_s.length > 1000
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 1000.')
+      end
+
+      if !@district.nil? && @district.to_s.length > 100
+        invalid_properties.push('invalid value for "district", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@name.nil? && @name.to_s.length > 255
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
+      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 !@postal_code.nil? && @postal_code.to_s.length > 20
+        invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 20.')
+      end
+
+      if !@state_province.nil? && @state_province.to_s.length > 100
+        invalid_properties.push('invalid value for "state_province", the character length must be smaller than or equal to 100.')
+      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 !@city.nil? && @city.to_s.length > 100
+      return false if !@country.nil? && @country.to_s.length > 100
+      return false if !@county.nil? && @county.to_s.length > 100
+      return false if !@description.nil? && @description.to_s.length > 1000
+      return false if !@district.nil? && @district.to_s.length > 100
+      return false if !@name.nil? && @name.to_s.length > 255
+      return false if !@name.nil? && @name.to_s.length < 1
+      return false if !@postal_code.nil? && @postal_code.to_s.length > 20
+      return false if !@state_province.nil? && @state_province.to_s.length > 100
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] city Value to be assigned
+    def city=(city)
+      if city.nil?
+        fail ArgumentError, 'city cannot be nil'
+      end
+
+      if city.to_s.length > 100
+        fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 100.'
+      end
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      if country.nil?
+        fail ArgumentError, 'country cannot be nil'
+      end
+
+      if country.to_s.length > 100
+        fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 100.'
+      end
+
+      @country = country
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] county Value to be assigned
+    def county=(county)
+      if county.nil?
+        fail ArgumentError, 'county cannot be nil'
+      end
+
+      if county.to_s.length > 100
+        fail ArgumentError, 'invalid value for "county", the character length must be smaller than or equal to 100.'
+      end
+
+      @county = county
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 1000.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] district Value to be assigned
+    def district=(district)
+      if district.nil?
+        fail ArgumentError, 'district cannot be nil'
+      end
+
+      if district.to_s.length > 100
+        fail ArgumentError, 'invalid value for "district", the character length must be smaller than or equal to 100.'
+      end
+
+      @district = district
+    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 > 255
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
+      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] postal_code Value to be assigned
+    def postal_code=(postal_code)
+      if postal_code.nil?
+        fail ArgumentError, 'postal_code cannot be nil'
+      end
+
+      if postal_code.to_s.length > 20
+        fail ArgumentError, 'invalid value for "postal_code", the character length must be smaller than or equal to 20.'
+      end
+
+      @postal_code = postal_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state_province Value to be assigned
+    def state_province=(state_province)
+      if state_province.nil?
+        fail ArgumentError, 'state_province cannot be nil'
+      end
+
+      if state_province.to_s.length > 100
+        fail ArgumentError, 'invalid value for "state_province", the character length must be smaller than or equal to 100.'
+      end
+
+      @state_province = state_province
+    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 &&
+          boundary == o.boundary &&
+          city == o.city &&
+          country == o.country &&
+          county == o.county &&
+          description == o.description &&
+          district == o.district &&
+          name == o.name &&
+          postal_code == o.postal_code &&
+          state_province == o.state_province
+    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
+      [boundary, city, country, county, description, district, name, postal_code, state_province].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