crisphive 0.1.0 → 0.3.0

data/lib/crisphive/models/job_request.rb

@@ -1,7 +1,7 @@
 =begin
-#CrispHive Developer API
+#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> }`.
+#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
 
@@ -30,6 +30,9 @@ module Crisphive
     # Who/what is assigned to the job.
     attr_accessor :assignment
 
+    # Attention is the dispatch-board \"needs attention\" marker (exception tray); null when the job needs no attention.
+    attr_accessor :attention
+
     # UUID of the owning business.
     attr_accessor :business_id
 
@@ -60,6 +63,9 @@ module Crisphive
     # Free-text job description; null if none.
     attr_accessor :description
 
+    # Driving distance from the technician's start location to the job site, in kilometres. Detail reads only — omitted when unknown. Named _km to match distance_km on the nearby-technician and emergency-candidate DTOs.
+    attr_accessor :distance_km
+
     # Job request UUID.
     attr_accessor :id
 
@@ -72,7 +78,7 @@ module Crisphive
     # The action(s) the job is currently waiting on. Omitted in a terminal status.
     attr_accessor :next_actions
 
-    # Job priority.
+    # Scheduling priority. p0=emergency (interrupt-driven), p1=top (displaced only by p0), p2=standard, p3=deferrable (first candidate for displacement).
     attr_accessor :priority
 
     # The time-bundle quoted for the job.
@@ -90,6 +96,15 @@ module Crisphive
     # Desired skills for the job (resolved id+name).
     attr_accessor :skills
 
+    # SLA deadline (UTC) armed on a p1 job; omitted when no SLA.
+    attr_accessor :sla_deadline
+
+    # When the SLA sweep auto-escalated this job to p0 (UTC); omitted if never.
+    attr_accessor :sla_escalated_at
+
+    # When the sweep fired the one-shot pre-escalation warning (UTC); omitted if never.
+    attr_accessor :sla_warned_at
+
     # Optimistic-lock version; pass back as status_version on transitions to avoid races.
     attr_accessor :status_version
 
@@ -132,6 +147,7 @@ module Crisphive
         :'archive' => :'archive',
         :'assigned_vehicle' => :'assigned_vehicle',
         :'assignment' => :'assignment',
+        :'attention' => :'attention',
         :'business_id' => :'business_id',
         :'completed_at' => :'completed_at',
         :'completed_by_user_id' => :'completed_by_user_id',
@@ -142,6 +158,7 @@ module Crisphive
         :'customer_url' => :'customer_url',
         :'deleted_at' => :'deleted_at',
         :'description' => :'description',
+        :'distance_km' => :'distance_km',
         :'id' => :'id',
         :'job_type_id' => :'job_type_id',
         :'job_type_name' => :'job_type_name',
@@ -152,6 +169,9 @@ module Crisphive
         :'schedule' => :'schedule',
         :'short_code' => :'short_code',
         :'skills' => :'skills',
+        :'sla_deadline' => :'sla_deadline',
+        :'sla_escalated_at' => :'sla_escalated_at',
+        :'sla_warned_at' => :'sla_warned_at',
         :'status_version' => :'status_version',
         :'updated_at' => :'updated_at',
         :'workflow_id' => :'workflow_id',
@@ -172,6 +192,7 @@ module Crisphive
         :'archive' => :'JobRequestArchiveSummary',
         :'assigned_vehicle' => :'JobRequestAssignedVehicle',
         :'assignment' => :'JobRequestAssignmentSummary',
+        :'attention' => :'JobRequestAttentionSummary',
         :'business_id' => :'String',
         :'completed_at' => :'Time',
         :'completed_by_user_id' => :'String',
@@ -182,6 +203,7 @@ module Crisphive
         :'customer_url' => :'String',
         :'deleted_at' => :'Time',
         :'description' => :'String',
+        :'distance_km' => :'Float',
         :'id' => :'String',
         :'job_type_id' => :'String',
         :'job_type_name' => :'String',
@@ -192,6 +214,9 @@ module Crisphive
         :'schedule' => :'JobRequestSchedule',
         :'short_code' => :'String',
         :'skills' => :'Array<JobRequestSkillSummary>',
+        :'sla_deadline' => :'Time',
+        :'sla_escalated_at' => :'Time',
+        :'sla_warned_at' => :'Time',
         :'status_version' => :'Integer',
         :'updated_at' => :'Time',
         :'workflow_id' => :'String',
@@ -242,6 +267,10 @@ module Crisphive
         self.assignment = attributes[:'assignment']
       end
 
+      if attributes.key?(:'attention')
+        self.attention = attributes[:'attention']
+      end
+
       if attributes.key?(:'business_id')
         self.business_id = attributes[:'business_id']
       end
@@ -284,6 +313,10 @@ module Crisphive
         self.description = attributes[:'description']
       end
 
+      if attributes.key?(:'distance_km')
+        self.distance_km = attributes[:'distance_km']
+      end
+
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
@@ -328,6 +361,18 @@ module Crisphive
         end
       end
 
+      if attributes.key?(:'sla_deadline')
+        self.sla_deadline = attributes[:'sla_deadline']
+      end
+
+      if attributes.key?(:'sla_escalated_at')
+        self.sla_escalated_at = attributes[:'sla_escalated_at']
+      end
+
+      if attributes.key?(:'sla_warned_at')
+        self.sla_warned_at = attributes[:'sla_warned_at']
+      end
+
       if attributes.key?(:'status_version')
         self.status_version = attributes[:'status_version']
       end
@@ -357,7 +402,7 @@ module Crisphive
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      priority_validator = EnumAttributeValidator.new('String', ["normal", "emergency"])
+      priority_validator = EnumAttributeValidator.new('String', ["p0", "p1", "p2", "p3"])
       return false unless priority_validator.valid?(@priority)
       true
     end
@@ -365,7 +410,7 @@ module Crisphive
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] priority Object to be assigned
     def priority=(priority)
-      validator = EnumAttributeValidator.new('String', ["normal", "emergency"])
+      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
@@ -382,6 +427,7 @@ module Crisphive
           archive == o.archive &&
           assigned_vehicle == o.assigned_vehicle &&
           assignment == o.assignment &&
+          attention == o.attention &&
           business_id == o.business_id &&
           completed_at == o.completed_at &&
           completed_by_user_id == o.completed_by_user_id &&
@@ -392,6 +438,7 @@ module Crisphive
           customer_url == o.customer_url &&
           deleted_at == o.deleted_at &&
           description == o.description &&
+          distance_km == o.distance_km &&
           id == o.id &&
           job_type_id == o.job_type_id &&
           job_type_name == o.job_type_name &&
@@ -402,6 +449,9 @@ module Crisphive
           schedule == o.schedule &&
           short_code == o.short_code &&
           skills == o.skills &&
+          sla_deadline == o.sla_deadline &&
+          sla_escalated_at == o.sla_escalated_at &&
+          sla_warned_at == o.sla_warned_at &&
           status_version == o.status_version &&
           updated_at == o.updated_at &&
           workflow_id == o.workflow_id &&
@@ -417,7 +467,7 @@ module Crisphive
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action_audit, address, archive, assigned_vehicle, assignment, business_id, completed_at, completed_by_user_id, created_at, crew, current_status, customer, customer_url, deleted_at, description, id, job_type_id, job_type_name, next_actions, priority, quote, rating, schedule, short_code, skills, status_version, updated_at, workflow_id, workflow_name].hash
+      [action_audit, address, archive, assigned_vehicle, assignment, attention, business_id, completed_at, completed_by_user_id, created_at, crew, current_status, customer, customer_url, deleted_at, description, distance_km, id, job_type_id, job_type_name, next_actions, priority, quote, rating, schedule, short_code, skills, sla_deadline, sla_escalated_at, sla_warned_at, status_version, updated_at, workflow_id, workflow_name].hash
     end
 
     # Builds the object from hash

data/lib/crisphive/models/job_request_absence_alternative.rb

@@ -0,0 +1,356 @@
+=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 JobRequestAbsenceAlternative
+    # What accepting it costs.
+    attr_accessor :cost
+
+    attr_accessor :desired_skills
+
+    attr_accessor :end_at
+
+    # How many technicians the engine offered at that window under this option's relaxation.
+    attr_accessor :feasible_count
+
+    # What the option does to the customer's appointment. EXTEND-ONLY — carry a default branch. reassign_out_of_area keeps the window; reschedule_same_day / reschedule_later_day move it.
+    attr_accessor :kind
+
+    # Desired skills the technician holds / the job asks for.
+    attr_accessor :matched_skills
+
+    # The window the job would run in (UTC) — unchanged for a reassign kind, new for a reschedule kind.
+    attr_accessor :start_at
+
+    # The job's current status_version — copy it onto the commit assignment (the drift fence).
+    attr_accessor :status_version
+
+    attr_accessor :to_name
+
+    # UUID + full name of the technician who would take the job.
+    attr_accessor :to_technician_id
+
+    # Engine ranking score (0..1) — comparable within one option's candidate list only.
+    attr_accessor :total_score
+
+    # Convenience mirror of cost.window_moved.
+    attr_accessor :window_moved
+
+    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
+      {
+        :'cost' => :'cost',
+        :'desired_skills' => :'desired_skills',
+        :'end_at' => :'end_at',
+        :'feasible_count' => :'feasible_count',
+        :'kind' => :'kind',
+        :'matched_skills' => :'matched_skills',
+        :'start_at' => :'start_at',
+        :'status_version' => :'status_version',
+        :'to_name' => :'to_name',
+        :'to_technician_id' => :'to_technician_id',
+        :'total_score' => :'total_score',
+        :'window_moved' => :'window_moved'
+      }
+    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
+      {
+        :'cost' => :'JobRequestAbsenceAlternativeCost',
+        :'desired_skills' => :'Integer',
+        :'end_at' => :'Time',
+        :'feasible_count' => :'Integer',
+        :'kind' => :'String',
+        :'matched_skills' => :'Integer',
+        :'start_at' => :'Time',
+        :'status_version' => :'Integer',
+        :'to_name' => :'String',
+        :'to_technician_id' => :'String',
+        :'total_score' => :'Float',
+        :'window_moved' => :'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 `Crisphive::JobRequestAbsenceAlternative` 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::JobRequestAbsenceAlternative`. 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?(:'cost')
+        self.cost = attributes[:'cost']
+      end
+
+      if attributes.key?(:'desired_skills')
+        self.desired_skills = attributes[:'desired_skills']
+      end
+
+      if attributes.key?(:'end_at')
+        self.end_at = attributes[:'end_at']
+      end
+
+      if attributes.key?(:'feasible_count')
+        self.feasible_count = attributes[:'feasible_count']
+      end
+
+      if attributes.key?(:'kind')
+        self.kind = attributes[:'kind']
+      end
+
+      if attributes.key?(:'matched_skills')
+        self.matched_skills = attributes[:'matched_skills']
+      end
+
+      if attributes.key?(:'start_at')
+        self.start_at = attributes[:'start_at']
+      end
+
+      if attributes.key?(:'status_version')
+        self.status_version = attributes[:'status_version']
+      end
+
+      if attributes.key?(:'to_name')
+        self.to_name = attributes[:'to_name']
+      end
+
+      if attributes.key?(:'to_technician_id')
+        self.to_technician_id = attributes[:'to_technician_id']
+      end
+
+      if attributes.key?(:'total_score')
+        self.total_score = attributes[:'total_score']
+      end
+
+      if attributes.key?(:'window_moved')
+        self.window_moved = attributes[:'window_moved']
+      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'
+      kind_validator = EnumAttributeValidator.new('String', ["reassign_out_of_area", "reschedule_same_day", "reschedule_later_day"])
+      return false unless kind_validator.valid?(@kind)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] kind Object to be assigned
+    def kind=(kind)
+      validator = EnumAttributeValidator.new('String', ["reassign_out_of_area", "reschedule_same_day", "reschedule_later_day"])
+      unless validator.valid?(kind)
+        fail ArgumentError, "invalid value for \"kind\", must be one of #{validator.allowable_values}."
+      end
+      @kind = kind
+    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 &&
+          cost == o.cost &&
+          desired_skills == o.desired_skills &&
+          end_at == o.end_at &&
+          feasible_count == o.feasible_count &&
+          kind == o.kind &&
+          matched_skills == o.matched_skills &&
+          start_at == o.start_at &&
+          status_version == o.status_version &&
+          to_name == o.to_name &&
+          to_technician_id == o.to_technician_id &&
+          total_score == o.total_score &&
+          window_moved == o.window_moved
+    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
+      [cost, desired_skills, end_at, feasible_count, kind, matched_skills, start_at, status_version, to_name, to_technician_id, total_score, window_moved].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