ultracart_api 4.1.110 → 4.1.111

data/lib/ultracart_api/api/storefront_api.rb

@@ -3601,6 +3601,91 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get a customer's dispatch-log journey across all flows/campaigns
+    # Paginated, date-boundable journey of every flow/campaign step a customer moved through (AP1/AP2), time-sorted. Rows are lean; fetch a row's detail via getEmailStepDispatchLogDetail. scanForward=false (default) returns recent-first; true returns chronological progression. Page forward until 'more' is false. 
+    # @param storefront_oid [Integer] 
+    # @param email_customer_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :since 
+    # @option opts [String] :_until 
+    # @option opts [Integer] :page_number 
+    # @option opts [Integer] :page_size 
+    # @option opts [Boolean] :scan_forward 
+    # @return [EmailDispatchLogsResponse]
+    def get_email_customer_dispatch_logs(storefront_oid, email_customer_uuid, opts = {})
+      data, _status_code, _headers = get_email_customer_dispatch_logs_with_http_info(storefront_oid, email_customer_uuid, opts)
+      data
+    end
+
+    # Get a customer's dispatch-log journey across all flows/campaigns
+    # Paginated, date-boundable journey of every flow/campaign step a customer moved through (AP1/AP2), time-sorted. Rows are lean; fetch a row's detail via getEmailStepDispatchLogDetail. scanForward=false (default) returns recent-first; true returns chronological progression. Page forward until 'more' is false. 
+    # @param storefront_oid [Integer] 
+    # @param email_customer_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :since 
+    # @option opts [String] :_until 
+    # @option opts [Integer] :page_number 
+    # @option opts [Integer] :page_size 
+    # @option opts [Boolean] :scan_forward 
+    # @return [Array<(EmailDispatchLogsResponse, Integer, Hash)>] EmailDispatchLogsResponse data, response status code and response headers
+    def get_email_customer_dispatch_logs_with_http_info(storefront_oid, email_customer_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_customer_dispatch_logs ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_customer_dispatch_logs"
+      end
+      # verify the required parameter 'email_customer_uuid' is set
+      if @api_client.config.client_side_validation && email_customer_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'email_customer_uuid' when calling StorefrontApi.get_email_customer_dispatch_logs"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/customers/{email_customer_uuid}/dispatch_logs'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_customer_uuid' + '}', CGI.escape(email_customer_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
+      query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'scanForward'] = opts[:'scan_forward'] if !opts[:'scan_forward'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailDispatchLogsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.get_email_customer_dispatch_logs",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_email_customer_dispatch_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get customers editor URL
     # @param storefront_oid [Integer] 
     # @param email_customer_uuid [String] 
@@ -3870,6 +3955,73 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Resolve a customer email to its ESP customer UUID
+    # Entry-hop resolver for the customer-journey screen (AP0). Returns the esp_customer_uuid for a merchant's customer email, or a null uuid when the email is not on file. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :email 
+    # @return [EmailCustomerLookupResponse]
+    def get_email_dispatch_log_customer_lookup(storefront_oid, opts = {})
+      data, _status_code, _headers = get_email_dispatch_log_customer_lookup_with_http_info(storefront_oid, opts)
+      data
+    end
+
+    # Resolve a customer email to its ESP customer UUID
+    # Entry-hop resolver for the customer-journey screen (AP0). Returns the esp_customer_uuid for a merchant&#39;s customer email, or a null uuid when the email is not on file. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :email 
+    # @return [Array<(EmailCustomerLookupResponse, Integer, Hash)>] EmailCustomerLookupResponse data, response status code and response headers
+    def get_email_dispatch_log_customer_lookup_with_http_info(storefront_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_dispatch_log_customer_lookup ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_dispatch_log_customer_lookup"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/dispatch_logs/customer_lookup'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailCustomerLookupResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.get_email_dispatch_log_customer_lookup",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_email_dispatch_log_customer_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get email dispatch logs
     # @param storefront_oid [Integer] 
     # @param commseq_uuid [String] 
@@ -6103,6 +6255,176 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get the full detail of a single dispatch-log record
+    # Fetches and gunzips the full detail payload of one dispatch-log record (AP5 drill-down), identified by its step plus the log_dts and esp_customer_uuid shown on the list row. 
+    # @param storefront_oid [Integer] 
+    # @param commseq_uuid [String] 
+    # @param commseq_step_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :log_dts 
+    # @option opts [String] :esp_customer_uuid 
+    # @return [EmailDispatchLogDetailResponse]
+    def get_email_step_dispatch_log_detail(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
+      data, _status_code, _headers = get_email_step_dispatch_log_detail_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
+      data
+    end
+
+    # Get the full detail of a single dispatch-log record
+    # Fetches and gunzips the full detail payload of one dispatch-log record (AP5 drill-down), identified by its step plus the log_dts and esp_customer_uuid shown on the list row. 
+    # @param storefront_oid [Integer] 
+    # @param commseq_uuid [String] 
+    # @param commseq_step_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :log_dts 
+    # @option opts [String] :esp_customer_uuid 
+    # @return [Array<(EmailDispatchLogDetailResponse, Integer, Hash)>] EmailDispatchLogDetailResponse data, response status code and response headers
+    def get_email_step_dispatch_log_detail_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_step_dispatch_log_detail ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_step_dispatch_log_detail"
+      end
+      # verify the required parameter 'commseq_uuid' is set
+      if @api_client.config.client_side_validation && commseq_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_step_dispatch_log_detail"
+      end
+      # verify the required parameter 'commseq_step_uuid' is set
+      if @api_client.config.client_side_validation && commseq_step_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.get_email_step_dispatch_log_detail"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/dispatch_logs/detail'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'commseq_step_uuid' + '}', CGI.escape(commseq_step_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'log_dts'] = opts[:'log_dts'] if !opts[:'log_dts'].nil?
+      query_params[:'esp_customer_uuid'] = opts[:'esp_customer_uuid'] if !opts[:'esp_customer_uuid'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailDispatchLogDetailResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.get_email_step_dispatch_log_detail",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_email_step_dispatch_log_detail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a paginated, date-boundable dispatch-log feed for a step
+    # Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
+    # @param storefront_oid [Integer] 
+    # @param commseq_uuid [String] 
+    # @param commseq_step_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :since 
+    # @option opts [String] :_until 
+    # @option opts [Integer] :page_number 
+    # @option opts [Integer] :page_size 
+    # @return [EmailDispatchLogsResponse]
+    def get_email_step_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
+      data, _status_code, _headers = get_email_step_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
+      data
+    end
+
+    # Get a paginated, date-boundable dispatch-log feed for a step
+    # Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row&#39;s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response &#39;more&#39; flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
+    # @param storefront_oid [Integer] 
+    # @param commseq_uuid [String] 
+    # @param commseq_step_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :since 
+    # @option opts [String] :_until 
+    # @option opts [Integer] :page_number 
+    # @option opts [Integer] :page_size 
+    # @return [Array<(EmailDispatchLogsResponse, Integer, Hash)>] EmailDispatchLogsResponse data, response status code and response headers
+    def get_email_step_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_step_dispatch_logs ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_step_dispatch_logs"
+      end
+      # verify the required parameter 'commseq_uuid' is set
+      if @api_client.config.client_side_validation && commseq_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_step_dispatch_logs"
+      end
+      # verify the required parameter 'commseq_step_uuid' is set
+      if @api_client.config.client_side_validation && commseq_step_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.get_email_step_dispatch_logs"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/dispatch_logs'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'commseq_step_uuid' + '}', CGI.escape(commseq_step_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
+      query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailDispatchLogsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.get_email_step_dispatch_logs",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_email_step_dispatch_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get email template
     # @param storefront_oid [Integer] 
     # @param email_template_oid [Integer] 

data/lib/ultracart_api/models/email_customer_lookup_response.rb

@@ -0,0 +1,267 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class EmailCustomerLookupResponse
+    # The email that was looked up
+    attr_accessor :email
+
+    attr_accessor :error
+
+    # ESP customer UUID, or null when the email is not on file
+    attr_accessor :esp_customer_uuid
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'error' => :'error',
+        :'esp_customer_uuid' => :'esp_customer_uuid',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    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
+      {
+        :'email' => :'String',
+        :'error' => :'Error',
+        :'esp_customer_uuid' => :'String',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'Boolean',
+        :'warning' => :'Warning'
+      }
+    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 `UltracartClient::EmailCustomerLookupResponse` 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 `UltracartClient::EmailCustomerLookupResponse`. 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?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'esp_customer_uuid')
+        self.esp_customer_uuid = attributes[:'esp_customer_uuid']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      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
+      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?
+      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 &&
+          email == o.email &&
+          error == o.error &&
+          esp_customer_uuid == o.esp_customer_uuid &&
+          metadata == o.metadata &&
+          success == o.success &&
+          warning == o.warning
+    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
+      [email, error, esp_customer_uuid, metadata, success, warning].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _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 = UltracartClient.const_get(type)
+        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