crisphive 0.2.0 → 0.3.0

data/lib/crisphive/models/create_vehicle200_response.rb

@@ -0,0 +1,253 @@
+=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 CreateVehicle200Response
+    attr_accessor :data
+
+    # 0 on success; a stable string error code (e.g. \"VALIDATION_ERROR\") on failure.
+    attr_accessor :error_code
+
+    # Field-level validation details; present only for VALIDATION_ERROR responses.
+    attr_accessor :errors
+
+    # Human-readable message (\"Success\" or an error description), localized via the X-Locale header.
+    attr_accessor :message
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'error_code' => :'error_code',
+        :'errors' => :'errors',
+        :'message' => :'message'
+      }
+    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
+      {
+        :'data' => :'VehicleCreateResponse',
+        :'error_code' => :'Object',
+        :'errors' => :'Object',
+        :'message' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'error_code',
+        :'errors',
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'ResponseEnvelope'
+      ]
+    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::CreateVehicle200Response` 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::CreateVehicle200Response`. 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?(:'data')
+        self.data = attributes[:'data']
+      end
+
+      if attributes.key?(:'error_code')
+        self.error_code = attributes[:'error_code']
+      end
+
+      if attributes.key?(:'errors')
+        self.errors = attributes[:'errors']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      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 &&
+          data == o.data &&
+          error_code == o.error_code &&
+          errors == o.errors &&
+          message == o.message
+    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
+      [data, error_code, errors, message].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/create_webhook_endpoint200_response.rb

@@ -0,0 +1,253 @@
+=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 CreateWebhookEndpoint200Response
+    attr_accessor :data
+
+    # 0 on success; a stable string error code (e.g. \"VALIDATION_ERROR\") on failure.
+    attr_accessor :error_code
+
+    # Field-level validation details; present only for VALIDATION_ERROR responses.
+    attr_accessor :errors
+
+    # Human-readable message (\"Success\" or an error description), localized via the X-Locale header.
+    attr_accessor :message
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'error_code' => :'error_code',
+        :'errors' => :'errors',
+        :'message' => :'message'
+      }
+    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
+      {
+        :'data' => :'WebhookCreateResponse',
+        :'error_code' => :'Object',
+        :'errors' => :'Object',
+        :'message' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'error_code',
+        :'errors',
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'ResponseEnvelope'
+      ]
+    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::CreateWebhookEndpoint200Response` 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::CreateWebhookEndpoint200Response`. 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?(:'data')
+        self.data = attributes[:'data']
+      end
+
+      if attributes.key?(:'error_code')
+        self.error_code = attributes[:'error_code']
+      end
+
+      if attributes.key?(:'errors')
+        self.errors = attributes[:'errors']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      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 &&
+          data == o.data &&
+          error_code == o.error_code &&
+          errors == o.errors &&
+          message == o.message
+    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
+      [data, error_code, errors, message].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.rb

@@ -21,6 +21,9 @@ module Crisphive
     # Core identity and lifecycle fields.
     attr_accessor :profile
 
+    # The customer's QuickBooks Online counterpart; null when this customer is not linked to one, and for every business without the integration.
+    attr_accessor :quickbooks
+
     # Spending aggregates over the trailing 12 months.
     attr_accessor :spending
 
@@ -29,6 +32,7 @@ module Crisphive
       {
         :'contact' => :'contact',
         :'profile' => :'profile',
+        :'quickbooks' => :'quickbooks',
         :'spending' => :'spending'
       }
     end
@@ -43,6 +47,7 @@ module Crisphive
       {
         :'contact' => :'CustomerContact',
         :'profile' => :'CustomerProfile',
+        :'quickbooks' => :'CustomerQuickBooksLink',
         :'spending' => :'CustomerSpending'
       }
     end
@@ -76,6 +81,10 @@ module Crisphive
         self.profile = attributes[:'profile']
       end
 
+      if attributes.key?(:'quickbooks')
+        self.quickbooks = attributes[:'quickbooks']
+      end
+
       if attributes.key?(:'spending')
         self.spending = attributes[:'spending']
       end
@@ -103,6 +112,7 @@ module Crisphive
       self.class == o.class &&
           contact == o.contact &&
           profile == o.profile &&
+          quickbooks == o.quickbooks &&
           spending == o.spending
     end
 
@@ -115,7 +125,7 @@ module Crisphive
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [contact, profile, spending].hash
+      [contact, profile, quickbooks, spending].hash
     end
 
     # Builds the object from hash

data/lib/crisphive/models/customer_contact.rb

@@ -30,6 +30,12 @@ module Crisphive
     # The service area this customer falls in, if resolved; otherwise null.
     attr_accessor :service_area
 
+    # True when the customer has explicitly consented to receive SMS. SMS notifications to this customer are suppressed while false.
+    attr_accessor :sms_opt_in
+
+    # When SMS consent was granted (RFC3339); null when sms_opt_in is false.
+    attr_accessor :sms_opt_in_at
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -37,7 +43,9 @@ module Crisphive
         :'email' => :'email',
         :'phone' => :'phone',
         :'preferred_technician' => :'preferred_technician',
-        :'service_area' => :'service_area'
+        :'service_area' => :'service_area',
+        :'sms_opt_in' => :'sms_opt_in',
+        :'sms_opt_in_at' => :'sms_opt_in_at'
       }
     end
 
@@ -52,8 +60,10 @@ module Crisphive
         :'address' => :'CustomerAddress',
         :'email' => :'String',
         :'phone' => :'String',
-        :'preferred_technician' => :'Technician',
-        :'service_area' => :'ServiceArea'
+        :'preferred_technician' => :'CustomerTechnicianRef',
+        :'service_area' => :'CustomerServiceAreaRef',
+        :'sms_opt_in' => :'Boolean',
+        :'sms_opt_in_at' => :'Time'
       }
     end
 
@@ -97,6 +107,14 @@ module Crisphive
       if attributes.key?(:'service_area')
         self.service_area = attributes[:'service_area']
       end
+
+      if attributes.key?(:'sms_opt_in')
+        self.sms_opt_in = attributes[:'sms_opt_in']
+      end
+
+      if attributes.key?(:'sms_opt_in_at')
+        self.sms_opt_in_at = attributes[:'sms_opt_in_at']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -123,7 +141,9 @@ module Crisphive
           email == o.email &&
           phone == o.phone &&
           preferred_technician == o.preferred_technician &&
-          service_area == o.service_area
+          service_area == o.service_area &&
+          sms_opt_in == o.sms_opt_in &&
+          sms_opt_in_at == o.sms_opt_in_at
     end
 
     # @see the `==` method
@@ -135,7 +155,7 @@ module Crisphive
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [address, email, phone, preferred_technician, service_area].hash
+      [address, email, phone, preferred_technician, service_area, sms_opt_in, sms_opt_in_at].hash
     end
 
     # Builds the object from hash

data/lib/crisphive/models/customer_create_request.rb

@@ -24,7 +24,7 @@ module Crisphive
     # Customer's full name. Required; max 255 chars.
     attr_accessor :full_name
 
-    # Phone number. Optional, but at least one of phone/email is required; 10–20 chars.
+    # 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. Separators (spaces, dashes, parentheses) are stripped before validation. Optional, but at least one of phone/email is required; 10–20 chars.
     attr_accessor :phone
 
     # UUID of the technician this customer prefers. Must belong to this business.
@@ -33,6 +33,9 @@ module Crisphive
     # UUID of the service area for this customer. Must belong to this business.
     attr_accessor :service_area_id
 
+    # SMS consent: set true ONLY when the customer explicitly agreed to receive SMS (e.g. ticked a non-pre-checked consent box, or gave verbal/written consent you keep a record of). SMS notifications are suppressed while false.
+    attr_accessor :sms_opt_in
+
     # Loyalty tier. Defaults to \"regular\" if omitted.
     attr_accessor :tier
 
@@ -70,6 +73,7 @@ module Crisphive
         :'phone' => :'phone',
         :'preferred_technician_id' => :'preferred_technician_id',
         :'service_area_id' => :'service_area_id',
+        :'sms_opt_in' => :'sms_opt_in',
         :'tier' => :'tier',
         :'uid' => :'uid'
       }
@@ -89,6 +93,7 @@ module Crisphive
         :'phone' => :'String',
         :'preferred_technician_id' => :'String',
         :'service_area_id' => :'String',
+        :'sms_opt_in' => :'Boolean',
         :'tier' => :'String',
         :'uid' => :'String'
       }
@@ -141,6 +146,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?(:'tier')
         self.tier = attributes[:'tier']
       end
@@ -250,6 +259,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 &&
           tier == o.tier &&
           uid == o.uid
     end
@@ -263,7 +273,7 @@ module Crisphive
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [address, email, full_name, phone, preferred_technician_id, service_area_id, tier, uid].hash
+      [address, email, full_name, phone, preferred_technician_id, service_area_id, sms_opt_in, tier, uid].hash
     end
 
     # Builds the object from hash