crisphive 0.2.0 → 0.3.0

data/lib/crisphive/models/job_request_book_and_confirm_request.rb

@@ -0,0 +1,466 @@
+=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 JobRequestBookAndConfirmRequest
+    # Service address. REQUIRED with `customer`. OPTIONAL with `customer_id`: when sent it is used for THIS JOB and the stored customer address is only the fallback when it is omitted — it is never written back to the customer record. Missing coordinates are geocoded.
+    attr_accessor :address
+
+    # A caller who may or may not exist yet: matched by phone/email against the business's customers (no duplicate is created for a known caller), created otherwise. Send this OR `customer_id`.
+    attr_accessor :customer
+
+    # UUID of an existing customer. Send this OR `customer`, not both.
+    attr_accessor :customer_id
+
+    # Demobilization (teardown) minutes after the work, min 0 — same rules as mobilization_minutes.
+    attr_accessor :demobilization_minutes
+
+    # Free-text description of the work. Optional; max 2000 chars.
+    attr_accessor :description
+
+    # P0 dispatch. Present only with priority p0 (or a business whose default priority is p0). See the endpoint description.
+    attr_accessor :emergency
+
+    # Hands-on work minutes. Optional when the job type has a default_duration_minutes.
+    attr_accessor :job_duration_minutes
+
+    # UUID of the job type: it classifies the job and supplies default_duration_minutes when job_duration_minutes is omitted. Optional: omitted, the business's DEFAULT job type (is_default, the seeded \"General\", 60 min + 15 + 15 unless the business changed it) is used.
+    attr_accessor :job_type_id
+
+    # Mobilization (setup/travel-prep) minutes before the work, min 0 — same meaning as on quoteJobRequest. Optional: omitted, the job type's default_mobilization_minutes applies when job_duration_minutes is ALSO omitted, and 0 when you sent a duration (an explicit duration is never mixed with the type's buffers). A value you send always wins. Counted when checking whether a pinned technician_id is free.
+    attr_accessor :mobilization_minutes
+
+    # Scheduling priority p0–p3. Optional; omitted = the business default.
+    attr_accessor :priority
+
+    # Start time — a BUSINESS-LOCAL wall clock, same rule as confirmJobRequest: canonical `2026-09-30T10:00:00`, seconds optional, a space may replace the T; an offset is accepted only when it agrees with the business timezone. Must be in the future.
+    attr_accessor :scheduled_at
+
+    # UUIDs of skills the work needs. Optional; up to 20.
+    attr_accessor :skill_ids
+
+    # Force a specific lead technician (feasibility still enforced). Omit to let Crisphive pick.
+    attr_accessor :technician_id
+
+    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
+      {
+        :'address' => :'address',
+        :'customer' => :'customer',
+        :'customer_id' => :'customer_id',
+        :'demobilization_minutes' => :'demobilization_minutes',
+        :'description' => :'description',
+        :'emergency' => :'emergency',
+        :'job_duration_minutes' => :'job_duration_minutes',
+        :'job_type_id' => :'job_type_id',
+        :'mobilization_minutes' => :'mobilization_minutes',
+        :'priority' => :'priority',
+        :'scheduled_at' => :'scheduled_at',
+        :'skill_ids' => :'skill_ids',
+        :'technician_id' => :'technician_id'
+      }
+    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
+      {
+        :'address' => :'InternalJobrequestHttpAddressReq',
+        :'customer' => :'JobRequestBookAndConfirmCustomer',
+        :'customer_id' => :'String',
+        :'demobilization_minutes' => :'Integer',
+        :'description' => :'String',
+        :'emergency' => :'JobRequestBookAndConfirmEmergency',
+        :'job_duration_minutes' => :'Integer',
+        :'job_type_id' => :'String',
+        :'mobilization_minutes' => :'Integer',
+        :'priority' => :'String',
+        :'scheduled_at' => :'Time',
+        :'skill_ids' => :'Array<String>',
+        :'technician_id' => :'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::JobRequestBookAndConfirmRequest` 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::JobRequestBookAndConfirmRequest`. 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?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.key?(:'customer')
+        self.customer = attributes[:'customer']
+      end
+
+      if attributes.key?(:'customer_id')
+        self.customer_id = attributes[:'customer_id']
+      end
+
+      if attributes.key?(:'demobilization_minutes')
+        self.demobilization_minutes = attributes[:'demobilization_minutes']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'emergency')
+        self.emergency = attributes[:'emergency']
+      end
+
+      if attributes.key?(:'job_duration_minutes')
+        self.job_duration_minutes = attributes[:'job_duration_minutes']
+      end
+
+      if attributes.key?(:'job_type_id')
+        self.job_type_id = attributes[:'job_type_id']
+      end
+
+      if attributes.key?(:'mobilization_minutes')
+        self.mobilization_minutes = attributes[:'mobilization_minutes']
+      end
+
+      if attributes.key?(:'priority')
+        self.priority = attributes[:'priority']
+      end
+
+      if attributes.key?(:'scheduled_at')
+        self.scheduled_at = attributes[:'scheduled_at']
+      end
+
+      if attributes.key?(:'skill_ids')
+        if (value = attributes[:'skill_ids']).is_a?(Array)
+          self.skill_ids = value
+        end
+      end
+
+      if attributes.key?(:'technician_id')
+        self.technician_id = attributes[:'technician_id']
+      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 !@demobilization_minutes.nil? && @demobilization_minutes < 0
+        invalid_properties.push('invalid value for "demobilization_minutes", must be greater than or equal to 0.')
+      end
+
+      if !@description.nil? && @description.to_s.length > 2000
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 2000.')
+      end
+
+      if !@job_duration_minutes.nil? && @job_duration_minutes < 1
+        invalid_properties.push('invalid value for "job_duration_minutes", must be greater than or equal to 1.')
+      end
+
+      if !@mobilization_minutes.nil? && @mobilization_minutes < 0
+        invalid_properties.push('invalid value for "mobilization_minutes", must be greater than or equal to 0.')
+      end
+
+      if !@skill_ids.nil? && @skill_ids.length > 20
+        invalid_properties.push('invalid value for "skill_ids", number of items must be less 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 !@demobilization_minutes.nil? && @demobilization_minutes < 0
+      return false if !@description.nil? && @description.to_s.length > 2000
+      return false if !@job_duration_minutes.nil? && @job_duration_minutes < 1
+      return false if !@mobilization_minutes.nil? && @mobilization_minutes < 0
+      priority_validator = EnumAttributeValidator.new('String', ["p0", "p1", "p2", "p3"])
+      return false unless priority_validator.valid?(@priority)
+      return false if !@skill_ids.nil? && @skill_ids.length > 20
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] demobilization_minutes Value to be assigned
+    def demobilization_minutes=(demobilization_minutes)
+      if demobilization_minutes.nil?
+        fail ArgumentError, 'demobilization_minutes cannot be nil'
+      end
+
+      if demobilization_minutes < 0
+        fail ArgumentError, 'invalid value for "demobilization_minutes", must be greater than or equal to 0.'
+      end
+
+      @demobilization_minutes = demobilization_minutes
+    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 > 2000
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 2000.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] job_duration_minutes Value to be assigned
+    def job_duration_minutes=(job_duration_minutes)
+      if job_duration_minutes.nil?
+        fail ArgumentError, 'job_duration_minutes cannot be nil'
+      end
+
+      if job_duration_minutes < 1
+        fail ArgumentError, 'invalid value for "job_duration_minutes", must be greater than or equal to 1.'
+      end
+
+      @job_duration_minutes = job_duration_minutes
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mobilization_minutes Value to be assigned
+    def mobilization_minutes=(mobilization_minutes)
+      if mobilization_minutes.nil?
+        fail ArgumentError, 'mobilization_minutes cannot be nil'
+      end
+
+      if mobilization_minutes < 0
+        fail ArgumentError, 'invalid value for "mobilization_minutes", must be greater than or equal to 0.'
+      end
+
+      @mobilization_minutes = mobilization_minutes
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] priority Object to be assigned
+    def priority=(priority)
+      validator = EnumAttributeValidator.new('String', ["p0", "p1", "p2", "p3"])
+      unless validator.valid?(priority)
+        fail ArgumentError, "invalid value for \"priority\", must be one of #{validator.allowable_values}."
+      end
+      @priority = priority
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] skill_ids Value to be assigned
+    def skill_ids=(skill_ids)
+      if skill_ids.nil?
+        fail ArgumentError, 'skill_ids cannot be nil'
+      end
+
+      if skill_ids.length > 20
+        fail ArgumentError, 'invalid value for "skill_ids", number of items must be less than or equal to 20.'
+      end
+
+      @skill_ids = skill_ids
+    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 &&
+          address == o.address &&
+          customer == o.customer &&
+          customer_id == o.customer_id &&
+          demobilization_minutes == o.demobilization_minutes &&
+          description == o.description &&
+          emergency == o.emergency &&
+          job_duration_minutes == o.job_duration_minutes &&
+          job_type_id == o.job_type_id &&
+          mobilization_minutes == o.mobilization_minutes &&
+          priority == o.priority &&
+          scheduled_at == o.scheduled_at &&
+          skill_ids == o.skill_ids &&
+          technician_id == o.technician_id
+    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
+      [address, customer, customer_id, demobilization_minutes, description, emergency, job_duration_minutes, job_type_id, mobilization_minutes, priority, scheduled_at, skill_ids, technician_id].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