crisphive 0.1.0 → 0.3.0

data/lib/crisphive/models/job_request_emergency_plan.rb

@@ -0,0 +1,367 @@
+=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 JobRequestEmergencyPlan
+    # True on a PREVIEW onto a day the business does not work, sent without after_hours_override. The cascade is shown as the override would place it; to commit, confirm the coordinator has phoned the technician and send after_hours_override=true. Always false on a commit.
+    attr_accessor :after_hours_override_required
+
+    # IANA timezone the per-day groupings are rendered in.
+    attr_accessor :business_timezone
+
+    # Pushed jobs grouped per business-local calendar day.
+    attr_accessor :days
+
+    # Emergency visit window end (UTC) — start + the quoted visit duration (job + mobilization + demobilization).
+    attr_accessor :emergency_end
+
+    # ID of the inserted P0 job. Absent for a probe -- a `job` that does not exist yet.
+    attr_accessor :emergency_job_id
+
+    # Emergency visit window start (UTC).
+    attr_accessor :emergency_start
+
+    # Cascade mode the plan assumed (overtime | next_day).
+    attr_accessor :mode
+
+    # ReassignFallbacks: one entry per displaced job that reassign mode could NOT re-staff, and therefore left in days[].moves[] to be rescheduled. Empty in reschedule mode. Read this INSTEAD of inferring \"nobody was free\" from an empty reassignments[] — the two are different states (no fallbacks + empty reassignments means nothing was displaced at all).
+    attr_accessor :reassign_fallbacks
+
+    # Displaced jobs handed to an ALTERNATE technician at their original window (displacement_mode=reassign; empty otherwise). Jobs that could not be re-staffed remain in days/total_moves (reschedule fallback).
+    attr_accessor :reassignments
+
+    # Technician the emergency lands on.
+    attr_accessor :technician_id
+
+    # Number of displaced jobs pushed to a later window.
+    attr_accessor :total_moves
+
+    # Non-blocking consequences the coordinator accepts by committing (TIME_OFF_OVERLAP per displaced job landing in the tech's approved leave, CALENDAR_OVERLAP per displaced job landing on a personal calendar event).
+    attr_accessor :warnings
+
+    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
+      {
+        :'after_hours_override_required' => :'after_hours_override_required',
+        :'business_timezone' => :'business_timezone',
+        :'days' => :'days',
+        :'emergency_end' => :'emergency_end',
+        :'emergency_job_id' => :'emergency_job_id',
+        :'emergency_start' => :'emergency_start',
+        :'mode' => :'mode',
+        :'reassign_fallbacks' => :'reassign_fallbacks',
+        :'reassignments' => :'reassignments',
+        :'technician_id' => :'technician_id',
+        :'total_moves' => :'total_moves',
+        :'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
+      {
+        :'after_hours_override_required' => :'Boolean',
+        :'business_timezone' => :'String',
+        :'days' => :'Array<JobRequestRescheduleDay>',
+        :'emergency_end' => :'Time',
+        :'emergency_job_id' => :'String',
+        :'emergency_start' => :'Time',
+        :'mode' => :'String',
+        :'reassign_fallbacks' => :'Array<JobRequestReassignFallback>',
+        :'reassignments' => :'Array<JobRequestRescheduleReassignment>',
+        :'technician_id' => :'String',
+        :'total_moves' => :'Integer',
+        :'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::JobRequestEmergencyPlan` 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::JobRequestEmergencyPlan`. 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?(:'after_hours_override_required')
+        self.after_hours_override_required = attributes[:'after_hours_override_required']
+      end
+
+      if attributes.key?(:'business_timezone')
+        self.business_timezone = attributes[:'business_timezone']
+      end
+
+      if attributes.key?(:'days')
+        if (value = attributes[:'days']).is_a?(Array)
+          self.days = value
+        end
+      end
+
+      if attributes.key?(:'emergency_end')
+        self.emergency_end = attributes[:'emergency_end']
+      end
+
+      if attributes.key?(:'emergency_job_id')
+        self.emergency_job_id = attributes[:'emergency_job_id']
+      end
+
+      if attributes.key?(:'emergency_start')
+        self.emergency_start = attributes[:'emergency_start']
+      end
+
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      end
+
+      if attributes.key?(:'reassign_fallbacks')
+        if (value = attributes[:'reassign_fallbacks']).is_a?(Array)
+          self.reassign_fallbacks = value
+        end
+      end
+
+      if attributes.key?(:'reassignments')
+        if (value = attributes[:'reassignments']).is_a?(Array)
+          self.reassignments = value
+        end
+      end
+
+      if attributes.key?(:'technician_id')
+        self.technician_id = attributes[:'technician_id']
+      end
+
+      if attributes.key?(:'total_moves')
+        self.total_moves = attributes[:'total_moves']
+      end
+
+      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'
+      mode_validator = EnumAttributeValidator.new('String', ["overtime", "next_day"])
+      return false unless mode_validator.valid?(@mode)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] mode Object to be assigned
+    def mode=(mode)
+      validator = EnumAttributeValidator.new('String', ["overtime", "next_day"])
+      unless validator.valid?(mode)
+        fail ArgumentError, "invalid value for \"mode\", must be one of #{validator.allowable_values}."
+      end
+      @mode = mode
+    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 &&
+          after_hours_override_required == o.after_hours_override_required &&
+          business_timezone == o.business_timezone &&
+          days == o.days &&
+          emergency_end == o.emergency_end &&
+          emergency_job_id == o.emergency_job_id &&
+          emergency_start == o.emergency_start &&
+          mode == o.mode &&
+          reassign_fallbacks == o.reassign_fallbacks &&
+          reassignments == o.reassignments &&
+          technician_id == o.technician_id &&
+          total_moves == o.total_moves &&
+          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
+      [after_hours_override_required, business_timezone, days, emergency_end, emergency_job_id, emergency_start, mode, reassign_fallbacks, reassignments, technician_id, total_moves, 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