crisphive 0.2.0 → 0.3.0

data/lib/crisphive/models/skill_update_request.rb

@@ -0,0 +1,281 @@
+=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 SkillUpdateRequest
+    # nil = keep; \"\" clears the description.
+    attr_accessor :description
+
+    attr_accessor :is_active
+
+    # nil = keep; min=1 rejects an explicit \"\".
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'is_active' => :'is_active',
+        :'name' => :'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
+      {
+        :'description' => :'String',
+        :'is_active' => :'Boolean',
+        :'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::SkillUpdateRequest` 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::SkillUpdateRequest`. 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?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'is_active')
+        self.is_active = attributes[:'is_active']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'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
+      if !@description.nil? && @description.to_s.length > 4000
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 4000.')
+      end
+
+      if !@name.nil? && @name.to_s.length > 200
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
+      end
+
+      if !@name.nil? && @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      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'
+      return false if !@description.nil? && @description.to_s.length > 4000
+      return false if !@name.nil? && @name.to_s.length > 200
+      return false if !@name.nil? && @name.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 4000
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 4000.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 200
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 200.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      @name = name
+    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 &&
+          description == o.description &&
+          is_active == o.is_active &&
+          name == o.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
+      [description, is_active, 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

data/lib/crisphive/models/technician.rb

@@ -30,6 +30,15 @@ module Crisphive
     # UUID of the business this technician belongs to.
     attr_accessor :business_id
 
+    # Precomputed deadline for the single calendar-connect nudge -- CalendarRequestedAt plus the sweep's three-day window -- so the dashboard never has to add three days and guess (the `is_fallback` / `token_stale` convention: the server computes the table state). Omitted, never null, whenever nothing is due: never requested, or already nudged.
+    attr_accessor :calendar_nudge_due_at
+
+    # Set (RFC3339) once the one-time unanswered-request reminder has been sent (calendarsync.nudge_sweep); omitted otherwise -- either because the technician answered, or because the three-day window has not elapsed yet. The sweep never nudges twice.
+    attr_accessor :calendar_nudged_at
+
+    # Set (RFC3339) when the business asked this technician to connect a personal calendar (calendarsync's invite flow, CALENDAR_SYNC_DESIGN.md §5); omitted if never asked. This is the ONLY surface that reports it for a technician who has not yet connected -- calendarsync's own connections list has no row for them at all.
+    attr_accessor :calendar_requested_at
+
     # When the technician record was created (RFC3339).
     attr_accessor :created_at
 
@@ -57,12 +66,18 @@ module Crisphive
     # Leads this technician is a buddy of (id + name).
     attr_accessor :leads
 
+    # Set (RFC3339) only when the member RESIGNED themselves; null otherwise.  It is what separates the two meanings of `status: \"deactive\"`: with `left_at` set the member chose to leave (\"Đã nghỉ việc\"), with it null the business suspended them (\"Tạm khoá\"). Render them differently — the roster otherwise shows somebody who resigned exactly like somebody who was disciplined. Cleared when they are reactivated.
+    attr_accessor :left_at
+
     # Phone number in the form it was supplied; null if not set.
     attr_accessor :phone
 
-    # Resolved role/group name (e.g. \"Technician\", \"Owner\").
+    # Resolved role/group name, localized to the request locale (e.g. \"Technician\", \"기술자\").
     attr_accessor :role
 
+    # Stable machine key of the role for SYSTEM groups; empty for custom (business-authored) groups. Compare role-specific client behavior against THIS, never against the localized role name.
+    attr_accessor :role_key
+
     # Service areas this technician is assigned to (id + name).
     attr_accessor :service_areas
 
@@ -117,6 +132,9 @@ module Crisphive
         :'buddy_ids' => :'buddy_ids',
         :'business_group_id' => :'business_group_id',
         :'business_id' => :'business_id',
+        :'calendar_nudge_due_at' => :'calendar_nudge_due_at',
+        :'calendar_nudged_at' => :'calendar_nudged_at',
+        :'calendar_requested_at' => :'calendar_requested_at',
         :'created_at' => :'created_at',
         :'deleted_at' => :'deleted_at',
         :'email' => :'email',
@@ -126,8 +144,10 @@ module Crisphive
         :'join_date' => :'join_date',
         :'last_login_at' => :'last_login_at',
         :'leads' => :'leads',
+        :'left_at' => :'left_at',
         :'phone' => :'phone',
         :'role' => :'role',
+        :'role_key' => :'role_key',
         :'service_areas' => :'service_areas',
         :'start_location_lat' => :'start_location_lat',
         :'start_location_long' => :'start_location_long',
@@ -152,6 +172,9 @@ module Crisphive
         :'buddy_ids' => :'Array<String>',
         :'business_group_id' => :'String',
         :'business_id' => :'String',
+        :'calendar_nudge_due_at' => :'Time',
+        :'calendar_nudged_at' => :'Time',
+        :'calendar_requested_at' => :'Time',
         :'created_at' => :'Time',
         :'deleted_at' => :'Time',
         :'email' => :'String',
@@ -161,8 +184,10 @@ module Crisphive
         :'join_date' => :'Date',
         :'last_login_at' => :'Time',
         :'leads' => :'Array<TechnicianLeadRef>',
+        :'left_at' => :'Time',
         :'phone' => :'String',
         :'role' => :'String',
+        :'role_key' => :'String',
         :'service_areas' => :'Array<TechnicianServiceAreaRef>',
         :'start_location_lat' => :'Float',
         :'start_location_long' => :'Float',
@@ -217,6 +242,18 @@ module Crisphive
         self.business_id = attributes[:'business_id']
       end
 
+      if attributes.key?(:'calendar_nudge_due_at')
+        self.calendar_nudge_due_at = attributes[:'calendar_nudge_due_at']
+      end
+
+      if attributes.key?(:'calendar_nudged_at')
+        self.calendar_nudged_at = attributes[:'calendar_nudged_at']
+      end
+
+      if attributes.key?(:'calendar_requested_at')
+        self.calendar_requested_at = attributes[:'calendar_requested_at']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -255,6 +292,10 @@ module Crisphive
         end
       end
 
+      if attributes.key?(:'left_at')
+        self.left_at = attributes[:'left_at']
+      end
+
       if attributes.key?(:'phone')
         self.phone = attributes[:'phone']
       end
@@ -263,6 +304,10 @@ module Crisphive
         self.role = attributes[:'role']
       end
 
+      if attributes.key?(:'role_key')
+        self.role_key = attributes[:'role_key']
+      end
+
       if attributes.key?(:'service_areas')
         if (value = attributes[:'service_areas']).is_a?(Array)
           self.service_areas = value
@@ -314,6 +359,8 @@ module Crisphive
       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)
+      role_key_validator = EnumAttributeValidator.new('String', ["owner", "administrator", "booking_coordinator", "supervisor", "technician"])
+      return false unless role_key_validator.valid?(@role_key)
       start_location_type_validator = EnumAttributeValidator.new('String', ["home", "office"])
       return false unless start_location_type_validator.valid?(@start_location_type)
       true
@@ -329,6 +376,16 @@ module Crisphive
       @assignment_tier = assignment_tier
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] role_key Object to be assigned
+    def role_key=(role_key)
+      validator = EnumAttributeValidator.new('String', ["owner", "administrator", "booking_coordinator", "supervisor", "technician"])
+      unless validator.valid?(role_key)
+        fail ArgumentError, "invalid value for \"role_key\", must be one of #{validator.allowable_values}."
+      end
+      @role_key = role_key
+    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)
@@ -349,6 +406,9 @@ module Crisphive
           buddy_ids == o.buddy_ids &&
           business_group_id == o.business_group_id &&
           business_id == o.business_id &&
+          calendar_nudge_due_at == o.calendar_nudge_due_at &&
+          calendar_nudged_at == o.calendar_nudged_at &&
+          calendar_requested_at == o.calendar_requested_at &&
           created_at == o.created_at &&
           deleted_at == o.deleted_at &&
           email == o.email &&
@@ -358,8 +418,10 @@ module Crisphive
           join_date == o.join_date &&
           last_login_at == o.last_login_at &&
           leads == o.leads &&
+          left_at == o.left_at &&
           phone == o.phone &&
           role == o.role &&
+          role_key == o.role_key &&
           service_areas == o.service_areas &&
           start_location_lat == o.start_location_lat &&
           start_location_long == o.start_location_long &&
@@ -379,7 +441,7 @@ module Crisphive
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [address, assignment_tier, buddy_ids, business_group_id, business_id, created_at, deleted_at, email, full_name, id, job_title, join_date, last_login_at, leads, phone, role, service_areas, start_location_lat, start_location_long, start_location_type, status, updated_at, user_id, vehicle_ids].hash
+      [address, assignment_tier, buddy_ids, business_group_id, business_id, calendar_nudge_due_at, calendar_nudged_at, calendar_requested_at, created_at, deleted_at, email, full_name, id, job_title, join_date, last_login_at, leads, left_at, phone, role, role_key, service_areas, start_location_lat, start_location_long, start_location_type, status, updated_at, user_id, vehicle_ids].hash
     end
 
     # Builds the object from hash

data/lib/crisphive/models/technician_create_request.rb

@@ -18,13 +18,13 @@ module Crisphive
     # 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).
+    # 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. Discover IDs via GET /permission/groups (Owner/Administrator groups are rejected in sandbox mode).
+    # 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).
@@ -42,7 +42,10 @@ module Crisphive
     # 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
 
-    # At least one of phone/email is required (identity resolution key).
+    # 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.
@@ -91,6 +94,7 @@ module Crisphive
         :'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',
@@ -116,6 +120,7 @@ module Crisphive
         :'job_title' => :'String',
         :'join_date' => :'Date',
         :'lead_ids' => :'Array<String>',
+        :'notify' => :'Boolean',
         :'phone' => :'String',
         :'service_area_ids' => :'Array<String>',
         :'start_location_lat' => :'Float',
@@ -161,8 +166,6 @@ module Crisphive
 
       if attributes.key?(:'business_group_id')
         self.business_group_id = attributes[:'business_group_id']
-      else
-        self.business_group_id = nil
       end
 
       if attributes.key?(:'email')
@@ -189,6 +192,10 @@ module Crisphive
         end
       end
 
+      if attributes.key?(:'notify')
+        self.notify = attributes[:'notify']
+      end
+
       if attributes.key?(:'phone')
         self.phone = attributes[:'phone']
       end
@@ -221,10 +228,6 @@ module Crisphive
         invalid_properties.push('invalid value for "buddy_ids", number of items must be less than or equal to 50.')
       end
 
-      if @business_group_id.nil?
-        invalid_properties.push('invalid value for "business_group_id", business_group_id cannot be nil.')
-      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
@@ -279,7 +282,6 @@ module Crisphive
       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 @business_group_id.nil?
       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
@@ -464,6 +466,7 @@ module Crisphive
           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 &&
@@ -480,7 +483,7 @@ module Crisphive
     # 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, phone, service_area_ids, start_location_lat, start_location_long, start_location_type].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