crisphive 0.2.0 → 0.3.0

data/lib/crisphive/models/job_request_move_preview_req.rb

@@ -15,6 +15,9 @@ require 'time'
 
 module Crisphive
   class JobRequestMovePreviewReq
+    # AfterHoursOverride — drop the non-working-day rejection for a P0 whose technician the coordinator has already phoned. P0 only (JOB_REQUEST_AFTER_HOURS_REQUIRES_P0 otherwise), and the preview then carries an AFTER_HOURS warning. Commit must repeat what the preview was run with.
+    attr_accessor :after_hours_override
+
     # Cascade mode for displaced jobs: overtime = stay same-day (tech works late); next_day = overflow rolls to the next working day.
     attr_accessor :mode
 
@@ -49,6 +52,7 @@ module Crisphive
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'after_hours_override' => :'after_hours_override',
         :'mode' => :'mode',
         :'start_at' => :'start_at',
         :'technician_id' => :'technician_id'
@@ -63,6 +67,7 @@ module Crisphive
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'after_hours_override' => :'Boolean',
         :'mode' => :'String',
         :'start_at' => :'String',
         :'technician_id' => :'String'
@@ -90,6 +95,10 @@ module Crisphive
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'after_hours_override')
+        self.after_hours_override = attributes[:'after_hours_override']
+      end
+
       if attributes.key?(:'mode')
         self.mode = attributes[:'mode']
       else
@@ -156,6 +165,7 @@ module Crisphive
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          after_hours_override == o.after_hours_override &&
           mode == o.mode &&
           start_at == o.start_at &&
           technician_id == o.technician_id
@@ -170,7 +180,7 @@ module Crisphive
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [mode, start_at, technician_id].hash
+      [after_hours_override, mode, start_at, technician_id].hash
     end
 
     # Builds the object from hash

data/lib/crisphive/models/job_request_move_warning.rb

@@ -15,13 +15,19 @@ require 'time'
 
 module Crisphive
   class JobRequestMoveWarning
-    # Warning kind: TECH_NOT_FEASIBLE | PUSHED_OUTSIDE_WINDOW | OVERTIME | TIME_OFF_OVERLAP | VEHICLE_CONFLICT.
+    # Every hard filter that refused the technician, most-structural first (TECH_NOT_FEASIBLE only). blockers[0] is the row Reason is derived from.
+    attr_accessor :blockers
+
+    # Warning kind: MOVED_OUTSIDE_WINDOW | TECH_NOT_FEASIBLE | PUSHED_OUTSIDE_WINDOW | OVERTIME | TIME_OFF_OVERLAP | CALENDAR_OVERLAP | VEHICLE_CONFLICT | AFTER_HOURS.  CALENDAR_OVERLAP is a SEPARATE value from TIME_OFF_OVERLAP on purpose: approved time off is a record the coordinator can open, a personal calendar event is one we cannot see at all.
     attr_accessor :code
 
+    # MOVED_OUTSIDE_WINDOW only: the customer-confirmed business-local ranges the job was booked into, so the board can show what the customer requested next to the override warning.
+    attr_accessor :customer_window
+
     # First same-day time the target technician CAN be on site (UTC) — only with reason=cannot_arrive_in_time; suggest it as the drop slot.
     attr_accessor :earliest_feasible_at
 
-    # The displaced job this warning is about (per-job warnings only).
+    # The job this warning is about (per-job warnings only).
     attr_accessor :job_id
 
     # Human-readable explanation.
@@ -30,7 +36,7 @@ module Crisphive
     # OVERTIME only: the largest overrun in minutes past the working-day end. Omitted otherwise.
     attr_accessor :minutes
 
-    # Machine cause, TECH_NOT_FEASIBLE only: cannot_arrive_in_time (see earliest_feasible_at) | missing_required_skills | not_available_today | not_lead_tier.
+    # Machine cause, TECH_NOT_FEASIBLE only. Blockers[0].kind, or not_available_today when the diagnosis was unavailable. EXTEND-ONLY: a client switching on this MUST carry a default branch.  calendar_conflict is the one value NOT in smartassign.BlockerKind: it is raised by the crew-assign path, never by ExplainInfeasibility, so it never appears in Blockers. A busy window on the technician's own PERSONAL calendar covers the visit. It is kept separate from on_time_off because approved leave is a record the coordinator can open and weigh, while this one is the obstacle we deliberately cannot see, so the action is a phone call. It may arrive alongside earliest_feasible_at.
     attr_accessor :reason
 
     class EnumAttributeValidator
@@ -58,7 +64,9 @@ module Crisphive
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'blockers' => :'blockers',
         :'code' => :'code',
+        :'customer_window' => :'customer_window',
         :'earliest_feasible_at' => :'earliest_feasible_at',
         :'job_id' => :'job_id',
         :'message' => :'message',
@@ -75,7 +83,9 @@ module Crisphive
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'blockers' => :'Array<JobRequestBlocker>',
         :'code' => :'String',
+        :'customer_window' => :'Array<JobDateBusinessRange>',
         :'earliest_feasible_at' => :'Time',
         :'job_id' => :'String',
         :'message' => :'String',
@@ -105,10 +115,22 @@ module Crisphive
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'blockers')
+        if (value = attributes[:'blockers']).is_a?(Array)
+          self.blockers = value
+        end
+      end
+
       if attributes.key?(:'code')
         self.code = attributes[:'code']
       end
 
+      if attributes.key?(:'customer_window')
+        if (value = attributes[:'customer_window']).is_a?(Array)
+          self.customer_window = value
+        end
+      end
+
       if attributes.key?(:'earliest_feasible_at')
         self.earliest_feasible_at = attributes[:'earliest_feasible_at']
       end
@@ -142,9 +164,9 @@ module Crisphive
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      code_validator = EnumAttributeValidator.new('String', ["TECH_NOT_FEASIBLE", "PUSHED_OUTSIDE_WINDOW", "OVERTIME", "TIME_OFF_OVERLAP", "VEHICLE_CONFLICT"])
+      code_validator = EnumAttributeValidator.new('String', ["MOVED_OUTSIDE_WINDOW", "TECH_NOT_FEASIBLE", "PUSHED_OUTSIDE_WINDOW", "OVERTIME", "TIME_OFF_OVERLAP", "CALENDAR_OVERLAP", "VEHICLE_CONFLICT", "AFTER_HOURS"])
       return false unless code_validator.valid?(@code)
-      reason_validator = EnumAttributeValidator.new('String', ["cannot_arrive_in_time", "missing_required_skills", "not_available_today", "not_lead_tier"])
+      reason_validator = EnumAttributeValidator.new('String', ["outside_service_area", "missing_required_skills", "not_lead_tier", "no_working_day", "on_time_off", "off_shift", "occupied", "visit_too_long", "cannot_arrive_in_time", "calendar_conflict", "not_available_today"])
       return false unless reason_validator.valid?(@reason)
       true
     end
@@ -152,7 +174,7 @@ module Crisphive
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] code Object to be assigned
     def code=(code)
-      validator = EnumAttributeValidator.new('String', ["TECH_NOT_FEASIBLE", "PUSHED_OUTSIDE_WINDOW", "OVERTIME", "TIME_OFF_OVERLAP", "VEHICLE_CONFLICT"])
+      validator = EnumAttributeValidator.new('String', ["MOVED_OUTSIDE_WINDOW", "TECH_NOT_FEASIBLE", "PUSHED_OUTSIDE_WINDOW", "OVERTIME", "TIME_OFF_OVERLAP", "CALENDAR_OVERLAP", "VEHICLE_CONFLICT", "AFTER_HOURS"])
       unless validator.valid?(code)
         fail ArgumentError, "invalid value for \"code\", must be one of #{validator.allowable_values}."
       end
@@ -162,7 +184,7 @@ module Crisphive
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] reason Object to be assigned
     def reason=(reason)
-      validator = EnumAttributeValidator.new('String', ["cannot_arrive_in_time", "missing_required_skills", "not_available_today", "not_lead_tier"])
+      validator = EnumAttributeValidator.new('String', ["outside_service_area", "missing_required_skills", "not_lead_tier", "no_working_day", "on_time_off", "off_shift", "occupied", "visit_too_long", "cannot_arrive_in_time", "calendar_conflict", "not_available_today"])
       unless validator.valid?(reason)
         fail ArgumentError, "invalid value for \"reason\", must be one of #{validator.allowable_values}."
       end
@@ -174,7 +196,9 @@ module Crisphive
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          blockers == o.blockers &&
           code == o.code &&
+          customer_window == o.customer_window &&
           earliest_feasible_at == o.earliest_feasible_at &&
           job_id == o.job_id &&
           message == o.message &&
@@ -191,7 +215,7 @@ module Crisphive
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [code, earliest_feasible_at, job_id, message, minutes, reason].hash
+      [blockers, code, customer_window, earliest_feasible_at, job_id, message, minutes, reason].hash
     end
 
     # Builds the object from hash

data/lib/crisphive/models/job_request_priority_update_result.rb

@@ -0,0 +1,217 @@
+=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 JobRequestPriorityUpdateResult
+    # AFTER_HOURS entries, one per session that sits outside the business's working hours after a change to p1/p2/p3. The priority change itself has already succeeded; the job was NOT moved. Typically a job placed on a closed day while it was p0, through the after-hours override: offer to move it back to a working day. Never present for p0.
+    attr_accessor :warnings
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'warnings' => :'warnings'
+      }
+    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
+      {
+        :'warnings' => :'Array<JobRequestMoveWarning>'
+      }
+    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::JobRequestPriorityUpdateResult` 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::JobRequestPriorityUpdateResult`. 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?(:'warnings')
+        if (value = attributes[:'warnings']).is_a?(Array)
+          self.warnings = value
+        end
+      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
+      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'
+      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 &&
+          warnings == o.warnings
+    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
+      [warnings].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

data/lib/crisphive/models/job_request_quote_request.rb

@@ -21,7 +21,10 @@ module Crisphive
     # Demobilization (teardown) minutes added after the work. Optional, min 0.
     attr_accessor :demobilization_minutes
 
-    # Hands-on work duration in minutes (man-minutes for a crew job). Required, min 1.
+    # Schedule the job even when no technician can take it in ANY window the customer asked for (outside working hours, outside every service area, nobody free). Without it that case answers 409 JOB_REQUEST_QUOTE_NOT_SCHEDULABLE with the reason, so the coordinator can agree a different time with the customer first. Send true only after that conversation; the override is recorded in the activity feed. A p0 (emergency) job is EXEMPT: the check never runs for one, because a p0 is placed by the dispatcher (force-assign, displacement, after_hours_override) and never offered through the customer's slot picker — so `force` is neither needed nor recorded there.
+    attr_accessor :force
+
+    # Hands-on work duration in minutes (man-minutes for a crew job), min 1. On POST /quote it may be OMITTED when the job's job type carries a default_duration_minutes: the quote then uses the type's default duration and its default buffers (a buffer you send still wins). No duration and no default answers 400 JOB_REQUEST_QUOTE_INVALID. PATCH /quote always requires it.
     attr_accessor :job_duration_minutes
 
     # Mobilization (setup/travel-prep) minutes added before the work. Optional, min 0.
@@ -35,6 +38,7 @@ module Crisphive
       {
         :'crew' => :'crew',
         :'demobilization_minutes' => :'demobilization_minutes',
+        :'force' => :'force',
         :'job_duration_minutes' => :'job_duration_minutes',
         :'mobilization_minutes' => :'mobilization_minutes',
         :'status_version' => :'status_version'
@@ -51,6 +55,7 @@ module Crisphive
       {
         :'crew' => :'Array<JobRequestCrewMemberInput>',
         :'demobilization_minutes' => :'Integer',
+        :'force' => :'Boolean',
         :'job_duration_minutes' => :'Integer',
         :'mobilization_minutes' => :'Integer',
         :'status_version' => :'Integer'
@@ -88,10 +93,12 @@ module Crisphive
         self.demobilization_minutes = attributes[:'demobilization_minutes']
       end
 
+      if attributes.key?(:'force')
+        self.force = attributes[:'force']
+      end
+
       if attributes.key?(:'job_duration_minutes')
         self.job_duration_minutes = attributes[:'job_duration_minutes']
-      else
-        self.job_duration_minutes = nil
       end
 
       if attributes.key?(:'mobilization_minutes')
@@ -116,11 +123,7 @@ module Crisphive
         invalid_properties.push('invalid value for "demobilization_minutes", must be greater than or equal to 0.')
       end
 
-      if @job_duration_minutes.nil?
-        invalid_properties.push('invalid value for "job_duration_minutes", job_duration_minutes cannot be nil.')
-      end
-
-      if @job_duration_minutes < 1
+      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
 
@@ -137,8 +140,7 @@ module Crisphive
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@crew.nil? && @crew.length > 20
       return false if !@demobilization_minutes.nil? && @demobilization_minutes < 0
-      return false if @job_duration_minutes.nil?
-      return false if @job_duration_minutes < 1
+      return false if !@job_duration_minutes.nil? && @job_duration_minutes < 1
       return false if !@mobilization_minutes.nil? && @mobilization_minutes < 0
       true
     end
@@ -206,6 +208,7 @@ module Crisphive
       self.class == o.class &&
           crew == o.crew &&
           demobilization_minutes == o.demobilization_minutes &&
+          force == o.force &&
           job_duration_minutes == o.job_duration_minutes &&
           mobilization_minutes == o.mobilization_minutes &&
           status_version == o.status_version
@@ -220,7 +223,7 @@ module Crisphive
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [crew, demobilization_minutes, job_duration_minutes, mobilization_minutes, status_version].hash
+      [crew, demobilization_minutes, force, job_duration_minutes, mobilization_minutes, status_version].hash
     end
 
     # Builds the object from hash