crisphive 0.1.0 → 0.3.0

data/lib/crisphive/models/job_request_absence_alternative_cost.rb

@@ -0,0 +1,275 @@
+=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 JobRequestAbsenceAlternativeCost
+    # The customer is told a NEW appointment time (job_rescheduled), not only a new technician name.
+    attr_accessor :customer_renotified
+
+    # Calendar days between the original and the new window's business-local dates (0 = same day / reassign).
+    attr_accessor :day_offset
+
+    # The technician's own driving distance to the site in km. ABSENT when the engine had no route — never render \"0 km\".
+    attr_accessor :distance_km
+
+    # The technician is not assigned to any service area covering the job (sent out of zone).
+    attr_accessor :outside_service_area
+
+    # The job carries an SLA deadline and the new window ends after it.
+    attr_accessor :sla_breached
+
+    # The technician's one-way commute estimate in minutes (rounded up). Absent when unknown.
+    attr_accessor :travel_minutes
+
+    # The customer's appointment changes (reschedule kinds).
+    attr_accessor :window_moved
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'customer_renotified' => :'customer_renotified',
+        :'day_offset' => :'day_offset',
+        :'distance_km' => :'distance_km',
+        :'outside_service_area' => :'outside_service_area',
+        :'sla_breached' => :'sla_breached',
+        :'travel_minutes' => :'travel_minutes',
+        :'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
+      {
+        :'customer_renotified' => :'Boolean',
+        :'day_offset' => :'Integer',
+        :'distance_km' => :'Float',
+        :'outside_service_area' => :'Boolean',
+        :'sla_breached' => :'Boolean',
+        :'travel_minutes' => :'Integer',
+        :'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::JobRequestAbsenceAlternativeCost` 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::JobRequestAbsenceAlternativeCost`. 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?(:'customer_renotified')
+        self.customer_renotified = attributes[:'customer_renotified']
+      end
+
+      if attributes.key?(:'day_offset')
+        self.day_offset = attributes[:'day_offset']
+      end
+
+      if attributes.key?(:'distance_km')
+        self.distance_km = attributes[:'distance_km']
+      end
+
+      if attributes.key?(:'outside_service_area')
+        self.outside_service_area = attributes[:'outside_service_area']
+      end
+
+      if attributes.key?(:'sla_breached')
+        self.sla_breached = attributes[:'sla_breached']
+      end
+
+      if attributes.key?(:'travel_minutes')
+        self.travel_minutes = attributes[:'travel_minutes']
+      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'
+      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 &&
+          customer_renotified == o.customer_renotified &&
+          day_offset == o.day_offset &&
+          distance_km == o.distance_km &&
+          outside_service_area == o.outside_service_area &&
+          sla_breached == o.sla_breached &&
+          travel_minutes == o.travel_minutes &&
+          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
+      [customer_renotified, day_offset, distance_km, outside_service_area, sla_breached, travel_minutes, 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

data/lib/crisphive/models/job_request_absence_assignment.rb

@@ -0,0 +1,319 @@
+=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 JobRequestAbsenceAssignment
+    # Accepting an alternative: its kind, copied from alternatives[].kind. Omit for a strict placement from resolved[]. An unknown kind is ABSENCE_RESOLVE_INVALID_INPUT reason=unknown_alternative_kind (checked in the usecase, not at the binder).
+    attr_accessor :alternative_kind
+
+    attr_accessor :end_at
+
+    # The job to re-staff (from preview.resolved[].job_id or preview.unresolved[].job_id).
+    attr_accessor :job_id
+
+    # REQUIRED for a reschedule kind: the new window, copied from alternatives[].start_at / end_at (RFC3339 UTC). Must be absent (or equal to the current window) for a strict or reassign_out_of_area placement.
+    attr_accessor :start_at
+
+    # The job's status_version at preview time — the drift fence.
+    attr_accessor :status_version
+
+    # The technician receiving the job (from preview.resolved[].to_technician_id or alternatives[].to_technician_id).
+    attr_accessor :to_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
+      {
+        :'alternative_kind' => :'alternative_kind',
+        :'end_at' => :'end_at',
+        :'job_id' => :'job_id',
+        :'start_at' => :'start_at',
+        :'status_version' => :'status_version',
+        :'to_technician_id' => :'to_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
+      {
+        :'alternative_kind' => :'String',
+        :'end_at' => :'Time',
+        :'job_id' => :'String',
+        :'start_at' => :'Time',
+        :'status_version' => :'Integer',
+        :'to_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::JobRequestAbsenceAssignment` 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::JobRequestAbsenceAssignment`. 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?(:'alternative_kind')
+        self.alternative_kind = attributes[:'alternative_kind']
+      end
+
+      if attributes.key?(:'end_at')
+        self.end_at = attributes[:'end_at']
+      end
+
+      if attributes.key?(:'job_id')
+        self.job_id = attributes[:'job_id']
+      else
+        self.job_id = nil
+      end
+
+      if attributes.key?(:'start_at')
+        self.start_at = attributes[:'start_at']
+      end
+
+      if attributes.key?(:'status_version')
+        self.status_version = attributes[:'status_version']
+      else
+        self.status_version = nil
+      end
+
+      if attributes.key?(:'to_technician_id')
+        self.to_technician_id = attributes[:'to_technician_id']
+      else
+        self.to_technician_id = nil
+      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 @job_id.nil?
+        invalid_properties.push('invalid value for "job_id", job_id cannot be nil.')
+      end
+
+      if @status_version.nil?
+        invalid_properties.push('invalid value for "status_version", status_version cannot be nil.')
+      end
+
+      if @to_technician_id.nil?
+        invalid_properties.push('invalid value for "to_technician_id", to_technician_id cannot be nil.')
+      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'
+      alternative_kind_validator = EnumAttributeValidator.new('String', ["reassign_out_of_area", "reschedule_same_day", "reschedule_later_day"])
+      return false unless alternative_kind_validator.valid?(@alternative_kind)
+      return false if @job_id.nil?
+      return false if @status_version.nil?
+      return false if @to_technician_id.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] alternative_kind Object to be assigned
+    def alternative_kind=(alternative_kind)
+      validator = EnumAttributeValidator.new('String', ["reassign_out_of_area", "reschedule_same_day", "reschedule_later_day"])
+      unless validator.valid?(alternative_kind)
+        fail ArgumentError, "invalid value for \"alternative_kind\", must be one of #{validator.allowable_values}."
+      end
+      @alternative_kind = alternative_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 &&
+          alternative_kind == o.alternative_kind &&
+          end_at == o.end_at &&
+          job_id == o.job_id &&
+          start_at == o.start_at &&
+          status_version == o.status_version &&
+          to_technician_id == o.to_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
+      [alternative_kind, end_at, job_id, start_at, status_version, to_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