crisphive 0.2.0 → 0.3.0

data/lib/crisphive/models/customer_technician_ref.rb

@@ -0,0 +1,225 @@
+=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 CustomerTechnicianRef
+    # Technician UUID.
+    attr_accessor :id
+
+    # Technician display name.
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'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
+      {
+        :'id' => :'String',
+        :'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::CustomerTechnicianRef` 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::CustomerTechnicianRef`. 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?(:'id')
+        self.id = attributes[:'id']
+      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
+      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 &&
+          id == o.id &&
+          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
+      [id, 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/customer_update_request.rb

@@ -15,34 +15,37 @@ require 'time'
 
 module Crisphive
   class CustomerUpdateRequest
-    # Postal address and coordinates.
+    # Postal address and coordinates. Omit the whole object to leave the stored address untouched; when present it REPLACES the address block.
     attr_accessor :address
 
-    # Email address.
+    # Email address. Omit to leave unchanged, \"\" to clear.
     attr_accessor :email
 
-    # Customer's full name. Required; max 255 chars.
+    # Customer's full name. Omit to leave unchanged; an empty or blank value is ignored (a customer cannot be left nameless). Max 255 chars.
     attr_accessor :full_name
 
-    # Free-form internal notes about the customer; max 4000 chars.
+    # Free-form internal notes about the customer. Omit to leave unchanged, \"\" to clear; max 4000 chars.
     attr_accessor :notes
 
-    # Phone number. 10–20 chars.
+    # Phone number in E.164 international format (`+16135550188`); a bare national number is rejected with PHONE_INVALID — see createCustomerReq.Phone. Omit to leave unchanged, \"\" to clear. 10–20 chars.
     attr_accessor :phone
 
-    # UUID of the technician this customer prefers. Must belong to this business.
+    # UUID of the technician this customer prefers. Omit to leave unchanged, \"\" to clear. Must belong to this business.
     attr_accessor :preferred_technician_id
 
-    # UUID of the service area for this customer. Must belong to this business.
+    # UUID of the service area for this customer. Omit to leave unchanged, \"\" to clear. Must belong to this business.
     attr_accessor :service_area_id
 
-    # Lifecycle status.
+    # SMS consent, tri-state: omit/null = leave unchanged; true = grant (only when the customer explicitly consented — the original consent timestamp is preserved); false = revoke (opt-out, stops SMS immediately).
+    attr_accessor :sms_opt_in
+
+    # Lifecycle status. Omit to leave unchanged; \"\" is ignored.
     attr_accessor :status
 
-    # Loyalty tier.
+    # Loyalty tier. Omit to leave unchanged; \"\" is ignored (an enum has no empty member).
     attr_accessor :tier
 
-    # Your external reference for this customer. Optional; max 32 chars.
+    # Your external reference for this customer. Omit to leave unchanged, \"\" to clear. Max 32 chars.
     attr_accessor :uid
 
     class EnumAttributeValidator
@@ -77,6 +80,7 @@ module Crisphive
         :'phone' => :'phone',
         :'preferred_technician_id' => :'preferred_technician_id',
         :'service_area_id' => :'service_area_id',
+        :'sms_opt_in' => :'sms_opt_in',
         :'status' => :'status',
         :'tier' => :'tier',
         :'uid' => :'uid'
@@ -98,6 +102,7 @@ module Crisphive
         :'phone' => :'String',
         :'preferred_technician_id' => :'String',
         :'service_area_id' => :'String',
+        :'sms_opt_in' => :'Boolean',
         :'status' => :'String',
         :'tier' => :'String',
         :'uid' => :'String'
@@ -135,8 +140,6 @@ module Crisphive
 
       if attributes.key?(:'full_name')
         self.full_name = attributes[:'full_name']
-      else
-        self.full_name = nil
       end
 
       if attributes.key?(:'notes')
@@ -155,6 +158,10 @@ module Crisphive
         self.service_area_id = attributes[:'service_area_id']
       end
 
+      if attributes.key?(:'sms_opt_in')
+        self.sms_opt_in = attributes[:'sms_opt_in']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -173,11 +180,7 @@ module Crisphive
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      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
+      if !@full_name.nil? && @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
 
@@ -200,8 +203,7 @@ module Crisphive
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @full_name.nil?
-      return false if @full_name.to_s.length > 255
+      return false if !@full_name.nil? && @full_name.to_s.length > 255
       return false if !@notes.nil? && @notes.to_s.length > 4000
       return false if !@phone.nil? && @phone.to_s.length > 20
       status_validator = EnumAttributeValidator.new('String', ["active", "inactive"])
@@ -300,6 +302,7 @@ module Crisphive
           phone == o.phone &&
           preferred_technician_id == o.preferred_technician_id &&
           service_area_id == o.service_area_id &&
+          sms_opt_in == o.sms_opt_in &&
           status == o.status &&
           tier == o.tier &&
           uid == o.uid
@@ -314,7 +317,7 @@ module Crisphive
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [address, email, full_name, notes, phone, preferred_technician_id, service_area_id, status, tier, uid].hash
+      [address, email, full_name, notes, phone, preferred_technician_id, service_area_id, sms_opt_in, status, tier, uid].hash
     end
 
     # Builds the object from hash