crisphive 0.1.0

data/lib/crisphive/models/job_request.rb

@@ -0,0 +1,537 @@
+=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 JobRequest
+    # ActionAudit is the per-action audit log keyed by action_key. `complete` fixed action không xuất hiện ở đây — actor lookup qua CompletedByUserID.
+    attr_accessor :action_audit
+
+    # The job's service address snapshot.
+    attr_accessor :address
+
+    # The job's archive state.
+    attr_accessor :archive
+
+    # AssignedVehicle is the carpool vehicle (the lead drives). Omitted when the job has no vehicle.
+    attr_accessor :assigned_vehicle
+
+    # Who/what is assigned to the job.
+    attr_accessor :assignment
+
+    # UUID of the owning business.
+    attr_accessor :business_id
+
+    # When the job was completed (UTC); null until completed.
+    attr_accessor :completed_at
+
+    # UUID of the user who fired complete; null until completed.
+    attr_accessor :completed_by_user_id
+
+    # When the job was created (UTC).
+    attr_accessor :created_at
+
+    # Crew is the multi-person crew on the job (lead first). A single-person job has one member. Omitted when no session plan exists.
+    attr_accessor :crew
+
+    # The job's current workflow status.
+    attr_accessor :current_status
+
+    # The job's customer contact snapshot.
+    attr_accessor :customer
+
+    # Ready-to-share customer URL embedding the magic token. Omitted if not issued.
+    attr_accessor :customer_url
+
+    # When the job was soft-deleted (UTC); omitted unless deleted.
+    attr_accessor :deleted_at
+
+    # Free-text job description; null if none.
+    attr_accessor :description
+
+    # Job request UUID.
+    attr_accessor :id
+
+    # UUID of the job type, or null if unclassified.
+    attr_accessor :job_type_id
+
+    # Job type display name (resolved to locale). Omitted if unclassified.
+    attr_accessor :job_type_name
+
+    # The action(s) the job is currently waiting on. Omitted in a terminal status.
+    attr_accessor :next_actions
+
+    # Job priority.
+    attr_accessor :priority
+
+    # The time-bundle quoted for the job.
+    attr_accessor :quote
+
+    # The customer's rating of the completed job.
+    attr_accessor :rating
+
+    # When/how the job is scheduled and its per-day plan.
+    attr_accessor :schedule
+
+    # Human-friendly short code. Omitted if not assigned.
+    attr_accessor :short_code
+
+    # Desired skills for the job (resolved id+name).
+    attr_accessor :skills
+
+    # Optimistic-lock version; pass back as status_version on transitions to avoid races.
+    attr_accessor :status_version
+
+    # When the job was last modified (UTC).
+    attr_accessor :updated_at
+
+    # UUID of the workflow snapshot driving this job's state machine.
+    attr_accessor :workflow_id
+
+    # Workflow display name.
+    attr_accessor :workflow_name
+
+    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
+      {
+        :'action_audit' => :'action_audit',
+        :'address' => :'address',
+        :'archive' => :'archive',
+        :'assigned_vehicle' => :'assigned_vehicle',
+        :'assignment' => :'assignment',
+        :'business_id' => :'business_id',
+        :'completed_at' => :'completed_at',
+        :'completed_by_user_id' => :'completed_by_user_id',
+        :'created_at' => :'created_at',
+        :'crew' => :'crew',
+        :'current_status' => :'current_status',
+        :'customer' => :'customer',
+        :'customer_url' => :'customer_url',
+        :'deleted_at' => :'deleted_at',
+        :'description' => :'description',
+        :'id' => :'id',
+        :'job_type_id' => :'job_type_id',
+        :'job_type_name' => :'job_type_name',
+        :'next_actions' => :'next_actions',
+        :'priority' => :'priority',
+        :'quote' => :'quote',
+        :'rating' => :'rating',
+        :'schedule' => :'schedule',
+        :'short_code' => :'short_code',
+        :'skills' => :'skills',
+        :'status_version' => :'status_version',
+        :'updated_at' => :'updated_at',
+        :'workflow_id' => :'workflow_id',
+        :'workflow_name' => :'workflow_name'
+      }
+    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
+      {
+        :'action_audit' => :'Hash<String, JobRequestActionAuditEntry>',
+        :'address' => :'JobRequestAddressSummary',
+        :'archive' => :'JobRequestArchiveSummary',
+        :'assigned_vehicle' => :'JobRequestAssignedVehicle',
+        :'assignment' => :'JobRequestAssignmentSummary',
+        :'business_id' => :'String',
+        :'completed_at' => :'Time',
+        :'completed_by_user_id' => :'String',
+        :'created_at' => :'Time',
+        :'crew' => :'Array<JobRequestCrewMember>',
+        :'current_status' => :'JobRequestStatusSummary',
+        :'customer' => :'JobRequestCustomerSummary',
+        :'customer_url' => :'String',
+        :'deleted_at' => :'Time',
+        :'description' => :'String',
+        :'id' => :'String',
+        :'job_type_id' => :'String',
+        :'job_type_name' => :'String',
+        :'next_actions' => :'Array<JobRequestActionSummary>',
+        :'priority' => :'String',
+        :'quote' => :'JobRequestQuoteSummary',
+        :'rating' => :'JobRequestRatingSummary',
+        :'schedule' => :'JobRequestSchedule',
+        :'short_code' => :'String',
+        :'skills' => :'Array<JobRequestSkillSummary>',
+        :'status_version' => :'Integer',
+        :'updated_at' => :'Time',
+        :'workflow_id' => :'String',
+        :'workflow_name' => :'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::JobRequest` 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::JobRequest`. 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?(:'action_audit')
+        if (value = attributes[:'action_audit']).is_a?(Hash)
+          self.action_audit = value
+        end
+      end
+
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.key?(:'archive')
+        self.archive = attributes[:'archive']
+      end
+
+      if attributes.key?(:'assigned_vehicle')
+        self.assigned_vehicle = attributes[:'assigned_vehicle']
+      end
+
+      if attributes.key?(:'assignment')
+        self.assignment = attributes[:'assignment']
+      end
+
+      if attributes.key?(:'business_id')
+        self.business_id = attributes[:'business_id']
+      end
+
+      if attributes.key?(:'completed_at')
+        self.completed_at = attributes[:'completed_at']
+      end
+
+      if attributes.key?(:'completed_by_user_id')
+        self.completed_by_user_id = attributes[:'completed_by_user_id']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'crew')
+        if (value = attributes[:'crew']).is_a?(Array)
+          self.crew = value
+        end
+      end
+
+      if attributes.key?(:'current_status')
+        self.current_status = attributes[:'current_status']
+      end
+
+      if attributes.key?(:'customer')
+        self.customer = attributes[:'customer']
+      end
+
+      if attributes.key?(:'customer_url')
+        self.customer_url = attributes[:'customer_url']
+      end
+
+      if attributes.key?(:'deleted_at')
+        self.deleted_at = attributes[:'deleted_at']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'job_type_id')
+        self.job_type_id = attributes[:'job_type_id']
+      end
+
+      if attributes.key?(:'job_type_name')
+        self.job_type_name = attributes[:'job_type_name']
+      end
+
+      if attributes.key?(:'next_actions')
+        if (value = attributes[:'next_actions']).is_a?(Array)
+          self.next_actions = value
+        end
+      end
+
+      if attributes.key?(:'priority')
+        self.priority = attributes[:'priority']
+      end
+
+      if attributes.key?(:'quote')
+        self.quote = attributes[:'quote']
+      end
+
+      if attributes.key?(:'rating')
+        self.rating = attributes[:'rating']
+      end
+
+      if attributes.key?(:'schedule')
+        self.schedule = attributes[:'schedule']
+      end
+
+      if attributes.key?(:'short_code')
+        self.short_code = attributes[:'short_code']
+      end
+
+      if attributes.key?(:'skills')
+        if (value = attributes[:'skills']).is_a?(Array)
+          self.skills = value
+        end
+      end
+
+      if attributes.key?(:'status_version')
+        self.status_version = attributes[:'status_version']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'workflow_id')
+        self.workflow_id = attributes[:'workflow_id']
+      end
+
+      if attributes.key?(:'workflow_name')
+        self.workflow_name = attributes[:'workflow_name']
+      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'
+      priority_validator = EnumAttributeValidator.new('String', ["normal", "emergency"])
+      return false unless priority_validator.valid?(@priority)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] priority Object to be assigned
+    def priority=(priority)
+      validator = EnumAttributeValidator.new('String', ["normal", "emergency"])
+      unless validator.valid?(priority)
+        fail ArgumentError, "invalid value for \"priority\", must be one of #{validator.allowable_values}."
+      end
+      @priority = priority
+    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 &&
+          action_audit == o.action_audit &&
+          address == o.address &&
+          archive == o.archive &&
+          assigned_vehicle == o.assigned_vehicle &&
+          assignment == o.assignment &&
+          business_id == o.business_id &&
+          completed_at == o.completed_at &&
+          completed_by_user_id == o.completed_by_user_id &&
+          created_at == o.created_at &&
+          crew == o.crew &&
+          current_status == o.current_status &&
+          customer == o.customer &&
+          customer_url == o.customer_url &&
+          deleted_at == o.deleted_at &&
+          description == o.description &&
+          id == o.id &&
+          job_type_id == o.job_type_id &&
+          job_type_name == o.job_type_name &&
+          next_actions == o.next_actions &&
+          priority == o.priority &&
+          quote == o.quote &&
+          rating == o.rating &&
+          schedule == o.schedule &&
+          short_code == o.short_code &&
+          skills == o.skills &&
+          status_version == o.status_version &&
+          updated_at == o.updated_at &&
+          workflow_id == o.workflow_id &&
+          workflow_name == o.workflow_name
+    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
+      [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
+    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