crisphive 0.1.0 → 0.3.0

data/lib/crisphive/models/technician_create_request.rb

@@ -0,0 +1,603 @@
+=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 TechnicianCreateRequest
+    # Home address (the day-start point when start_location_type=home).
+    attr_accessor :address
+
+    # Crew tier the matching engine assigns by: lead (can head a job), buddy (crew helper), float (excluded from auto crew-assign). IGNORED — stored empty, no error — when the role is Booking Coordinator, Administrator or Viewer: office roles are never assigned jobs. Technician, Owner, Supervisor and custom roles keep the tier.
+    attr_accessor :assignment_tier
+
+    # Buddies of this technician (set when creating a lead). Optional; max 50 technician ids.
+    attr_accessor :buddy_ids
+
+    # Role group for the new member. Optional: omitted or empty assigns the business's Technician group. To assign another group, copy its ID from the dashboard (Settings → Permissions) or from an existing member's `business_group_id`. Owner/Administrator groups are rejected in sandbox mode and for API-key callers.
+    attr_accessor :business_group_id
+
+    # Email address. At least one of phone/email is required (identity resolution key).
+    attr_accessor :email
+
+    # The person's full display name. Required; max 255 chars.
+    attr_accessor :full_name
+
+    # Display title (e.g. \"Senior HVAC Technician\").
+    attr_accessor :job_title
+
+    # First working day (YYYY-MM-DD).
+    attr_accessor :join_date
+
+    # Leads this technician is a buddy of (set when creating a buddy; the technician is appended to each lead's buddy list). Optional; max 50 technician ids.
+    attr_accessor :lead_ids
+
+    # Whether to send the new member the \"you have been added to {business}\" message (email when an email was supplied, SMS when a phone was, both when both). Omitted or true sends it; false stays silent. Set false for bulk imports so seeding a roster does not text everybody at once.
+    attr_accessor :notify
+
+    # Phone number in E.164 international format: a leading `+` and the country code, e.g. `+16135550188`. A bare national number (`6135550188`) is REJECTED with PHONE_INVALID — there is no default region to guess the country from. At least one of phone/email is required (identity resolution key).
+    attr_accessor :phone
+
+    # Service areas to assign the technician to. Optional; max 50. Discover via GET /service-areas.
+    attr_accessor :service_area_ids
+
+    # Explicit day-start latitude in decimal degrees (-90..90); when set it wins over the address geocode.
+    attr_accessor :start_location_lat
+
+    # Explicit day-start longitude in decimal degrees (-180..180); when set it wins over the address geocode.
+    attr_accessor :start_location_long
+
+    # Where the technician starts their day: home (their address) or office (the business location). Drives the engine's travel estimates.
+    attr_accessor :start_location_type
+
+    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
+      {
+        :'address' => :'address',
+        :'assignment_tier' => :'assignment_tier',
+        :'buddy_ids' => :'buddy_ids',
+        :'business_group_id' => :'business_group_id',
+        :'email' => :'email',
+        :'full_name' => :'full_name',
+        :'job_title' => :'job_title',
+        :'join_date' => :'join_date',
+        :'lead_ids' => :'lead_ids',
+        :'notify' => :'notify',
+        :'phone' => :'phone',
+        :'service_area_ids' => :'service_area_ids',
+        :'start_location_lat' => :'start_location_lat',
+        :'start_location_long' => :'start_location_long',
+        :'start_location_type' => :'start_location_type'
+      }
+    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
+      {
+        :'address' => :'TechnicianAddressInput',
+        :'assignment_tier' => :'String',
+        :'buddy_ids' => :'Array<String>',
+        :'business_group_id' => :'String',
+        :'email' => :'String',
+        :'full_name' => :'String',
+        :'job_title' => :'String',
+        :'join_date' => :'Date',
+        :'lead_ids' => :'Array<String>',
+        :'notify' => :'Boolean',
+        :'phone' => :'String',
+        :'service_area_ids' => :'Array<String>',
+        :'start_location_lat' => :'Float',
+        :'start_location_long' => :'Float',
+        :'start_location_type' => :'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::TechnicianCreateRequest` 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::TechnicianCreateRequest`. 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?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.key?(:'assignment_tier')
+        self.assignment_tier = attributes[:'assignment_tier']
+      end
+
+      if attributes.key?(:'buddy_ids')
+        if (value = attributes[:'buddy_ids']).is_a?(Array)
+          self.buddy_ids = value
+        end
+      end
+
+      if attributes.key?(:'business_group_id')
+        self.business_group_id = attributes[:'business_group_id']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      else
+        self.full_name = nil
+      end
+
+      if attributes.key?(:'job_title')
+        self.job_title = attributes[:'job_title']
+      end
+
+      if attributes.key?(:'join_date')
+        self.join_date = attributes[:'join_date']
+      end
+
+      if attributes.key?(:'lead_ids')
+        if (value = attributes[:'lead_ids']).is_a?(Array)
+          self.lead_ids = value
+        end
+      end
+
+      if attributes.key?(:'notify')
+        self.notify = attributes[:'notify']
+      end
+
+      if attributes.key?(:'phone')
+        self.phone = attributes[:'phone']
+      end
+
+      if attributes.key?(:'service_area_ids')
+        if (value = attributes[:'service_area_ids']).is_a?(Array)
+          self.service_area_ids = value
+        end
+      end
+
+      if attributes.key?(:'start_location_lat')
+        self.start_location_lat = attributes[:'start_location_lat']
+      end
+
+      if attributes.key?(:'start_location_long')
+        self.start_location_long = attributes[:'start_location_long']
+      end
+
+      if attributes.key?(:'start_location_type')
+        self.start_location_type = attributes[:'start_location_type']
+      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 !@buddy_ids.nil? && @buddy_ids.length > 50
+        invalid_properties.push('invalid value for "buddy_ids", number of items must be less than or equal to 50.')
+      end
+
+      if !@email.nil? && @email.to_s.length > 255
+        invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 255.')
+      end
+
+      if @full_name.nil?
+        invalid_properties.push('invalid value for "full_name", full_name cannot be nil.')
+      end
+
+      if @full_name.to_s.length > 255
+        invalid_properties.push('invalid value for "full_name", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@job_title.nil? && @job_title.to_s.length > 255
+        invalid_properties.push('invalid value for "job_title", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@lead_ids.nil? && @lead_ids.length > 50
+        invalid_properties.push('invalid value for "lead_ids", number of items must be less than or equal to 50.')
+      end
+
+      if !@phone.nil? && @phone.to_s.length > 50
+        invalid_properties.push('invalid value for "phone", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@service_area_ids.nil? && @service_area_ids.length > 50
+        invalid_properties.push('invalid value for "service_area_ids", number of items must be less than or equal to 50.')
+      end
+
+      if !@start_location_lat.nil? && @start_location_lat > 90
+        invalid_properties.push('invalid value for "start_location_lat", must be smaller than or equal to 90.')
+      end
+
+      if !@start_location_lat.nil? && @start_location_lat < -90
+        invalid_properties.push('invalid value for "start_location_lat", must be greater than or equal to -90.')
+      end
+
+      if !@start_location_long.nil? && @start_location_long > 180
+        invalid_properties.push('invalid value for "start_location_long", must be smaller than or equal to 180.')
+      end
+
+      if !@start_location_long.nil? && @start_location_long < -180
+        invalid_properties.push('invalid value for "start_location_long", must be greater than or equal to -180.')
+      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'
+      assignment_tier_validator = EnumAttributeValidator.new('String', ["lead", "buddy", "float"])
+      return false unless assignment_tier_validator.valid?(@assignment_tier)
+      return false if !@buddy_ids.nil? && @buddy_ids.length > 50
+      return false if !@email.nil? && @email.to_s.length > 255
+      return false if @full_name.nil?
+      return false if @full_name.to_s.length > 255
+      return false if !@job_title.nil? && @job_title.to_s.length > 255
+      return false if !@lead_ids.nil? && @lead_ids.length > 50
+      return false if !@phone.nil? && @phone.to_s.length > 50
+      return false if !@service_area_ids.nil? && @service_area_ids.length > 50
+      return false if !@start_location_lat.nil? && @start_location_lat > 90
+      return false if !@start_location_lat.nil? && @start_location_lat < -90
+      return false if !@start_location_long.nil? && @start_location_long > 180
+      return false if !@start_location_long.nil? && @start_location_long < -180
+      start_location_type_validator = EnumAttributeValidator.new('String', ["home", "office"])
+      return false unless start_location_type_validator.valid?(@start_location_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] assignment_tier Object to be assigned
+    def assignment_tier=(assignment_tier)
+      validator = EnumAttributeValidator.new('String', ["lead", "buddy", "float"])
+      unless validator.valid?(assignment_tier)
+        fail ArgumentError, "invalid value for \"assignment_tier\", must be one of #{validator.allowable_values}."
+      end
+      @assignment_tier = assignment_tier
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] buddy_ids Value to be assigned
+    def buddy_ids=(buddy_ids)
+      if buddy_ids.nil?
+        fail ArgumentError, 'buddy_ids cannot be nil'
+      end
+
+      if buddy_ids.length > 50
+        fail ArgumentError, 'invalid value for "buddy_ids", number of items must be less than or equal to 50.'
+      end
+
+      @buddy_ids = buddy_ids
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if email.nil?
+        fail ArgumentError, 'email cannot be nil'
+      end
+
+      if email.to_s.length > 255
+        fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 255.'
+      end
+
+      @email = email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] full_name Value to be assigned
+    def full_name=(full_name)
+      if full_name.nil?
+        fail ArgumentError, 'full_name cannot be nil'
+      end
+
+      if full_name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "full_name", the character length must be smaller than or equal to 255.'
+      end
+
+      @full_name = full_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] job_title Value to be assigned
+    def job_title=(job_title)
+      if job_title.nil?
+        fail ArgumentError, 'job_title cannot be nil'
+      end
+
+      if job_title.to_s.length > 255
+        fail ArgumentError, 'invalid value for "job_title", the character length must be smaller than or equal to 255.'
+      end
+
+      @job_title = job_title
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] lead_ids Value to be assigned
+    def lead_ids=(lead_ids)
+      if lead_ids.nil?
+        fail ArgumentError, 'lead_ids cannot be nil'
+      end
+
+      if lead_ids.length > 50
+        fail ArgumentError, 'invalid value for "lead_ids", number of items must be less than or equal to 50.'
+      end
+
+      @lead_ids = lead_ids
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] phone Value to be assigned
+    def phone=(phone)
+      if phone.nil?
+        fail ArgumentError, 'phone cannot be nil'
+      end
+
+      if phone.to_s.length > 50
+        fail ArgumentError, 'invalid value for "phone", the character length must be smaller than or equal to 50.'
+      end
+
+      @phone = phone
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] service_area_ids Value to be assigned
+    def service_area_ids=(service_area_ids)
+      if service_area_ids.nil?
+        fail ArgumentError, 'service_area_ids cannot be nil'
+      end
+
+      if service_area_ids.length > 50
+        fail ArgumentError, 'invalid value for "service_area_ids", number of items must be less than or equal to 50.'
+      end
+
+      @service_area_ids = service_area_ids
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] start_location_lat Value to be assigned
+    def start_location_lat=(start_location_lat)
+      if start_location_lat.nil?
+        fail ArgumentError, 'start_location_lat cannot be nil'
+      end
+
+      if start_location_lat > 90
+        fail ArgumentError, 'invalid value for "start_location_lat", must be smaller than or equal to 90.'
+      end
+
+      if start_location_lat < -90
+        fail ArgumentError, 'invalid value for "start_location_lat", must be greater than or equal to -90.'
+      end
+
+      @start_location_lat = start_location_lat
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] start_location_long Value to be assigned
+    def start_location_long=(start_location_long)
+      if start_location_long.nil?
+        fail ArgumentError, 'start_location_long cannot be nil'
+      end
+
+      if start_location_long > 180
+        fail ArgumentError, 'invalid value for "start_location_long", must be smaller than or equal to 180.'
+      end
+
+      if start_location_long < -180
+        fail ArgumentError, 'invalid value for "start_location_long", must be greater than or equal to -180.'
+      end
+
+      @start_location_long = start_location_long
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] start_location_type Object to be assigned
+    def start_location_type=(start_location_type)
+      validator = EnumAttributeValidator.new('String', ["home", "office"])
+      unless validator.valid?(start_location_type)
+        fail ArgumentError, "invalid value for \"start_location_type\", must be one of #{validator.allowable_values}."
+      end
+      @start_location_type = start_location_type
+    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 &&
+          address == o.address &&
+          assignment_tier == o.assignment_tier &&
+          buddy_ids == o.buddy_ids &&
+          business_group_id == o.business_group_id &&
+          email == o.email &&
+          full_name == o.full_name &&
+          job_title == o.job_title &&
+          join_date == o.join_date &&
+          lead_ids == o.lead_ids &&
+          notify == o.notify &&
+          phone == o.phone &&
+          service_area_ids == o.service_area_ids &&
+          start_location_lat == o.start_location_lat &&
+          start_location_long == o.start_location_long &&
+          start_location_type == o.start_location_type
+    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
+      [address, assignment_tier, buddy_ids, business_group_id, email, full_name, job_title, join_date, lead_ids, notify, phone, service_area_ids, start_location_lat, start_location_long, start_location_type].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