crisphive 0.1.0 → 0.2.0

data/lib/crisphive/models/job_request_time_segments_slot.rb

@@ -0,0 +1,375 @@
+=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 JobRequestTimeSegmentsSlot
+    # Technicians feasible for this slot, engine-ranked best first, each with its score breakdown.
+    attr_accessor :available_workers
+
+    # True on the first slot of each day — the suggested \"BEST\" pick (UI hint).
+    attr_accessor :best_time
+
+    # The same arrival window expressed in BUSINESS-local time; its naive datetime is the value to send back on confirm.
+    attr_accessor :business_time
+
+    # Window start as an RFC3339 customer-local instant (with UTC offset).
+    attr_accessor :datetime
+
+    # Span end (UTC) of a multi-day visit — render in business/customer timezone. Omitted for single-day slots.
+    attr_accessor :ends_at
+
+    # MultiDay flags a slot whose visit cannot finish in one day and spans consecutive days. EndsAt + Sessions are then populated (for the best-ranked candidate — the one auto-assign would pick) so the picker can show the customer \"this start runs until <EndsAt>, over N days\" BEFORE they confirm. Single-day slots leave these empty (the slot itself is the visit).
+    attr_accessor :multi_day
+
+    # Per-day session plan of a multi-day visit (for the best-ranked candidate). Omitted for single-day slots.
+    attr_accessor :sessions
+
+    # Arrival-window start, HH:MM customer-local.
+    attr_accessor :time
+
+    # Arrival-window end, HH:MM customer-local (= time + time_slot_step_minutes).
+    attr_accessor :time_end
+
+    # Period bucket of the window start: 1=morning, 2=afternoon, 3=evening.
+    attr_accessor :time_period
+
+    # Localized label for time_period.
+    attr_accessor :time_period_label
+
+    # Number of entries in available_workers.
+    attr_accessor :workers_count
+
+    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
+      {
+        :'available_workers' => :'available_workers',
+        :'best_time' => :'best_time',
+        :'business_time' => :'business_time',
+        :'datetime' => :'datetime',
+        :'ends_at' => :'ends_at',
+        :'multi_day' => :'multi_day',
+        :'sessions' => :'sessions',
+        :'time' => :'time',
+        :'time_end' => :'time_end',
+        :'time_period' => :'time_period',
+        :'time_period_label' => :'time_period_label',
+        :'workers_count' => :'workers_count'
+      }
+    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
+      {
+        :'available_workers' => :'Array<JobRequestTimeSegmentsWorker>',
+        :'best_time' => :'Boolean',
+        :'business_time' => :'JobRequestTimeSegmentsBusinessTime',
+        :'datetime' => :'Time',
+        :'ends_at' => :'Time',
+        :'multi_day' => :'Boolean',
+        :'sessions' => :'Array<JobRequestSession>',
+        :'time' => :'String',
+        :'time_end' => :'String',
+        :'time_period' => :'Integer',
+        :'time_period_label' => :'String',
+        :'workers_count' => :'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::JobRequestTimeSegmentsSlot` 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::JobRequestTimeSegmentsSlot`. 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?(:'available_workers')
+        if (value = attributes[:'available_workers']).is_a?(Array)
+          self.available_workers = value
+        end
+      end
+
+      if attributes.key?(:'best_time')
+        self.best_time = attributes[:'best_time']
+      end
+
+      if attributes.key?(:'business_time')
+        self.business_time = attributes[:'business_time']
+      end
+
+      if attributes.key?(:'datetime')
+        self.datetime = attributes[:'datetime']
+      end
+
+      if attributes.key?(:'ends_at')
+        self.ends_at = attributes[:'ends_at']
+      end
+
+      if attributes.key?(:'multi_day')
+        self.multi_day = attributes[:'multi_day']
+      end
+
+      if attributes.key?(:'sessions')
+        if (value = attributes[:'sessions']).is_a?(Array)
+          self.sessions = value
+        end
+      end
+
+      if attributes.key?(:'time')
+        self.time = attributes[:'time']
+      end
+
+      if attributes.key?(:'time_end')
+        self.time_end = attributes[:'time_end']
+      end
+
+      if attributes.key?(:'time_period')
+        self.time_period = attributes[:'time_period']
+      end
+
+      if attributes.key?(:'time_period_label')
+        self.time_period_label = attributes[:'time_period_label']
+      end
+
+      if attributes.key?(:'workers_count')
+        self.workers_count = attributes[:'workers_count']
+      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'
+      time_period_validator = EnumAttributeValidator.new('Integer', [1, 2, 3])
+      return false unless time_period_validator.valid?(@time_period)
+      time_period_label_validator = EnumAttributeValidator.new('String', ["Morning", "Afternoon", "Evening"])
+      return false unless time_period_label_validator.valid?(@time_period_label)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] time_period Object to be assigned
+    def time_period=(time_period)
+      validator = EnumAttributeValidator.new('Integer', [1, 2, 3])
+      unless validator.valid?(time_period)
+        fail ArgumentError, "invalid value for \"time_period\", must be one of #{validator.allowable_values}."
+      end
+      @time_period = time_period
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] time_period_label Object to be assigned
+    def time_period_label=(time_period_label)
+      validator = EnumAttributeValidator.new('String', ["Morning", "Afternoon", "Evening"])
+      unless validator.valid?(time_period_label)
+        fail ArgumentError, "invalid value for \"time_period_label\", must be one of #{validator.allowable_values}."
+      end
+      @time_period_label = time_period_label
+    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 &&
+          available_workers == o.available_workers &&
+          best_time == o.best_time &&
+          business_time == o.business_time &&
+          datetime == o.datetime &&
+          ends_at == o.ends_at &&
+          multi_day == o.multi_day &&
+          sessions == o.sessions &&
+          time == o.time &&
+          time_end == o.time_end &&
+          time_period == o.time_period &&
+          time_period_label == o.time_period_label &&
+          workers_count == o.workers_count
+    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
+      [available_workers, best_time, business_time, datetime, ends_at, multi_day, sessions, time, time_end, time_period, time_period_label, workers_count].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_time_segments_worker.rb

@@ -0,0 +1,295 @@
+=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 JobRequestTimeSegmentsWorker
+    # Estimated one-way distance from the technician's start location to the job site, in km (routing-provider estimate, straight-line fallback). 0 when unknown or on the pre-quote fallback path.
+    attr_accessor :distance_km
+
+    # Distance sub-score (0-100; closer to the job = higher).
+    attr_accessor :distance_score
+
+    # Technician's email; empty when not on file.
+    attr_accessor :email
+
+    # Technician UUID.
+    attr_accessor :id
+
+    # Minutes of job work already booked on this technician's schedule around the offered window (feeds the wrench-time score; lower = more open capacity).
+    attr_accessor :job_duration_today_minutes
+
+    # Technician's full display name.
+    attr_accessor :name
+
+    # Overall ranking score (0-100): weighted blend of the distance, travel-time, wrench-time and skill sub-scores; workers are listed best-first. Placeholder values on the pre-quote fallback path.
+    attr_accessor :total_score
+
+    # Travel-time sub-score (0-100; shorter commute = higher).
+    attr_accessor :travel_time_score
+
+    # Wrench-time sub-score (0-100; more open capacity vs the daily booked-work goal = higher).
+    attr_accessor :wrench_time_score
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'distance_km' => :'distance_km',
+        :'distance_score' => :'distance_score',
+        :'email' => :'email',
+        :'id' => :'id',
+        :'job_duration_today_minutes' => :'job_duration_today_minutes',
+        :'name' => :'name',
+        :'total_score' => :'total_score',
+        :'travel_time_score' => :'travel_time_score',
+        :'wrench_time_score' => :'wrench_time_score'
+      }
+    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
+      {
+        :'distance_km' => :'Float',
+        :'distance_score' => :'Float',
+        :'email' => :'String',
+        :'id' => :'String',
+        :'job_duration_today_minutes' => :'Integer',
+        :'name' => :'String',
+        :'total_score' => :'Float',
+        :'travel_time_score' => :'Float',
+        :'wrench_time_score' => :'Float'
+      }
+    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::JobRequestTimeSegmentsWorker` 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::JobRequestTimeSegmentsWorker`. 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?(:'distance_km')
+        self.distance_km = attributes[:'distance_km']
+      end
+
+      if attributes.key?(:'distance_score')
+        self.distance_score = attributes[:'distance_score']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'job_duration_today_minutes')
+        self.job_duration_today_minutes = attributes[:'job_duration_today_minutes']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'total_score')
+        self.total_score = attributes[:'total_score']
+      end
+
+      if attributes.key?(:'travel_time_score')
+        self.travel_time_score = attributes[:'travel_time_score']
+      end
+
+      if attributes.key?(:'wrench_time_score')
+        self.wrench_time_score = attributes[:'wrench_time_score']
+      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 &&
+          distance_km == o.distance_km &&
+          distance_score == o.distance_score &&
+          email == o.email &&
+          id == o.id &&
+          job_duration_today_minutes == o.job_duration_today_minutes &&
+          name == o.name &&
+          total_score == o.total_score &&
+          travel_time_score == o.travel_time_score &&
+          wrench_time_score == o.wrench_time_score
+    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
+      [distance_km, distance_score, email, id, job_duration_today_minutes, name, total_score, travel_time_score, wrench_time_score].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_timeline.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
 

data/lib/crisphive/models/job_request_timeline_action.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