ultracart_api 4.1.233 → 4.1.234

data/lib/ultracart_api/api/sfvb_api.rb

@@ -2966,11 +2966,13 @@ module UltracartClient
     end
 
     # Clear one tracking provider
-    # Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway.  The provider stops being sent anything.  An OAuth connection is left alone, and notes say to disconnect it in the admin.  Send the provider's hash_sha256 as If-Match.  Needs sfvb_publish.  No approval. 
+    # Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway.  An OAuth connection is left alone, and notes say to disconnect it in the admin.  Send the provider's hash_sha256 as If-Match.  Needs sfvb_publish.  dry_run=true reports the changes, and approval_needed, without clearing.  No approval, except when the clear removes a consent gate while something outside the provider's fields still fires it (Google Ads for an affiliate's own Google conversion id, Commission Junction for an affiliate network of its type): that needs an approved tracking_provider.clear request for the provider (Approval-Id). 
     # @param storefront_oid [Integer] 
     # @param provider [String] 
     # @param if_match [String] The provider's hash_sha256 from the last read.  428 when absent, 412 when stale.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :dry_run 
+    # @option opts [String] :approval_id When the clear removes a consent gate while something else still fires the provider, the approval_id of an approved tracking_provider.clear request for it.  See POST /sfvb/approvals.
     # @return [SfvbTrackingProvider]
     def delete_sfvb_tracking_provider(storefront_oid, provider, if_match, opts = {})
       data, _status_code, _headers = delete_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match, opts)
@@ -2978,11 +2980,13 @@ module UltracartClient
     end
 
     # Clear one tracking provider
-    # Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway.  The provider stops being sent anything.  An OAuth connection is left alone, and notes say to disconnect it in the admin.  Send the provider's hash_sha256 as If-Match.  Needs sfvb_publish.  No approval. 
+    # Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway.  An OAuth connection is left alone, and notes say to disconnect it in the admin.  Send the provider's hash_sha256 as If-Match.  Needs sfvb_publish.  dry_run=true reports the changes, and approval_needed, without clearing.  No approval, except when the clear removes a consent gate while something outside the provider's fields still fires it (Google Ads for an affiliate's own Google conversion id, Commission Junction for an affiliate network of its type): that needs an approved tracking_provider.clear request for the provider (Approval-Id). 
     # @param storefront_oid [Integer] 
     # @param provider [String] 
     # @param if_match [String] The provider's hash_sha256 from the last read.  428 when absent, 412 when stale.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :dry_run 
+    # @option opts [String] :approval_id When the clear removes a consent gate while something else still fires the provider, the approval_id of an approved tracking_provider.clear request for it.  See POST /sfvb/approvals.
     # @return [Array<(SfvbTrackingProvider, Integer, Hash)>] SfvbTrackingProvider data, response status code and response headers
     def delete_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match, opts = {})
       if @api_client.config.debugging
@@ -3005,6 +3009,7 @@ module UltracartClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'dry_run'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -3012,6 +3017,7 @@ module UltracartClient
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       header_params[:'If-Match'] = if_match
+      header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -5834,7 +5840,7 @@ module UltracartClient
     end
 
     # Find which storefront a communications uuid lives on
-    # Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account's storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it.  A uuid nothing on this account has, another account's included, is 404.  Read only. 
+    # Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account's storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it.  An archived campaign or flow is found too, with archived true, and owner.archived is true when what was found belongs to one.  A uuid nothing on this account has, another account's included, and a deleted step, email, postcard, list or segment, is 404.  Read only. 
     # @param uuid [String] The uuid to find.
     # @param [Hash] opts the optional parameters
     # @return [SfvbCommsLookupResponse]
@@ -5844,7 +5850,7 @@ module UltracartClient
     end
 
     # Find which storefront a communications uuid lives on
-    # Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account&#39;s storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it.  A uuid nothing on this account has, another account&#39;s included, is 404.  Read only. 
+    # Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account&#39;s storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it.  An archived campaign or flow is found too, with archived true, and owner.archived is true when what was found belongs to one.  A uuid nothing on this account has, another account&#39;s included, and a deleted step, email, postcard, list or segment, is 404.  Read only. 
     # @param uuid [String] The uuid to find.
     # @param [Hash] opts the optional parameters
     # @return [Array<(SfvbCommsLookupResponse, Integer, Hash)>] SfvbCommsLookupResponse data, response status code and response headers
@@ -16265,6 +16271,87 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Stage custom tracking HTML in a preview session
+    # Runs Tracking HTML, Conversion HTML or both instead of the storefront's live slots, only in a browser that opened this session's preview access link, so a page can be checked before the write is approved.  Staged Conversion HTML runs only on a test order's receipt.  Each slot gets the same checks as a write.  An empty string unstages a slot; a slot left out is left as it is.  Containers pushed to the session later keep what is staged.  Needs sfvb_write and a token that resolves to a user; no approval, since nothing durable is written and only that user's own session runs it. 
+    # @param storefront_oid [Integer] 
+    # @param preview_session_id [String] 
+    # @param preview_tracking_html [SfvbPreviewTrackingHtmlRequest] The HTML to stage
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbTrackingHtmlResponse]
+    def put_sfvb_preview_tracking_html(storefront_oid, preview_session_id, preview_tracking_html, opts = {})
+      data, _status_code, _headers = put_sfvb_preview_tracking_html_with_http_info(storefront_oid, preview_session_id, preview_tracking_html, opts)
+      data
+    end
+
+    # Stage custom tracking HTML in a preview session
+    # Runs Tracking HTML, Conversion HTML or both instead of the storefront&#39;s live slots, only in a browser that opened this session&#39;s preview access link, so a page can be checked before the write is approved.  Staged Conversion HTML runs only on a test order&#39;s receipt.  Each slot gets the same checks as a write.  An empty string unstages a slot; a slot left out is left as it is.  Containers pushed to the session later keep what is staged.  Needs sfvb_write and a token that resolves to a user; no approval, since nothing durable is written and only that user&#39;s own session runs it. 
+    # @param storefront_oid [Integer] 
+    # @param preview_session_id [String] 
+    # @param preview_tracking_html [SfvbPreviewTrackingHtmlRequest] The HTML to stage
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbTrackingHtmlResponse, Integer, Hash)>] SfvbTrackingHtmlResponse data, response status code and response headers
+    def put_sfvb_preview_tracking_html_with_http_info(storefront_oid, preview_session_id, preview_tracking_html, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.put_sfvb_preview_tracking_html ...'
+      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 SfvbApi.put_sfvb_preview_tracking_html"
+      end
+      # verify the required parameter 'preview_session_id' is set
+      if @api_client.config.client_side_validation && preview_session_id.nil?
+        fail ArgumentError, "Missing the required parameter 'preview_session_id' when calling SfvbApi.put_sfvb_preview_tracking_html"
+      end
+      # verify the required parameter 'preview_tracking_html' is set
+      if @api_client.config.client_side_validation && preview_tracking_html.nil?
+        fail ArgumentError, "Missing the required parameter 'preview_tracking_html' when calling SfvbApi.put_sfvb_preview_tracking_html"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/tracking_html'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'preview_session_id' + '}', CGI.escape(preview_session_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(preview_tracking_html)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbTrackingHtmlResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.put_sfvb_preview_tracking_html",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#put_sfvb_preview_tracking_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Turn the storefront's screen recording on or off
     # Turning it on records real shoppers' sessions from that moment, with no history before it.  The first time starts a 14 day free trial, after which recorded sessions are billed per 1,000.  Only change it when the merchant has asked for it.  Asking for the state it is already in changes nothing, and changed comes back false.  Always needs sfvb_publish, in both directions, because it decides whether live shoppers are recorded.  Limited per storefront to 5 changes a minute, 20 an hour and 50 a day. 
     # @param storefront_oid [Integer] 
@@ -16880,6 +16967,87 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Render the Conversion HTML against a test order
+    # The Conversion HTML as the receipt of that order would inject it: order tokens filled, then Velocity run with $order, $conversion and $formatHelper.  Renders the stored slot, or content when it is sent (a draft, checked as a write is).  Only a test order on this account may be used; a real or unknown order is refused the same way.  Nothing is saved, injected or sent: the receipt's provider pixels, analytics and postbacks do not run, and a token that would write something ([CouponForNewAffiliate=...]) is left as written.  Only the conversion slot renders; tracking HTML is checked by staging it in a preview session. 
+    # @param storefront_oid [Integer] 
+    # @param slot [String] conversion
+    # @param tracking_html_render_request [SfvbTrackingHtmlRenderRequest] The test order, and optionally a draft
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbTrackingHtmlRenderResponse]
+    def render_sfvb_tracking_html(storefront_oid, slot, tracking_html_render_request, opts = {})
+      data, _status_code, _headers = render_sfvb_tracking_html_with_http_info(storefront_oid, slot, tracking_html_render_request, opts)
+      data
+    end
+
+    # Render the Conversion HTML against a test order
+    # The Conversion HTML as the receipt of that order would inject it: order tokens filled, then Velocity run with $order, $conversion and $formatHelper.  Renders the stored slot, or content when it is sent (a draft, checked as a write is).  Only a test order on this account may be used; a real or unknown order is refused the same way.  Nothing is saved, injected or sent: the receipt&#39;s provider pixels, analytics and postbacks do not run, and a token that would write something ([CouponForNewAffiliate&#x3D;...]) is left as written.  Only the conversion slot renders; tracking HTML is checked by staging it in a preview session. 
+    # @param storefront_oid [Integer] 
+    # @param slot [String] conversion
+    # @param tracking_html_render_request [SfvbTrackingHtmlRenderRequest] The test order, and optionally a draft
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbTrackingHtmlRenderResponse, Integer, Hash)>] SfvbTrackingHtmlRenderResponse data, response status code and response headers
+    def render_sfvb_tracking_html_with_http_info(storefront_oid, slot, tracking_html_render_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.render_sfvb_tracking_html ...'
+      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 SfvbApi.render_sfvb_tracking_html"
+      end
+      # verify the required parameter 'slot' is set
+      if @api_client.config.client_side_validation && slot.nil?
+        fail ArgumentError, "Missing the required parameter 'slot' when calling SfvbApi.render_sfvb_tracking_html"
+      end
+      # verify the required parameter 'tracking_html_render_request' is set
+      if @api_client.config.client_side_validation && tracking_html_render_request.nil?
+        fail ArgumentError, "Missing the required parameter 'tracking_html_render_request' when calling SfvbApi.render_sfvb_tracking_html"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/tracking/html/{slot}/render'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'slot' + '}', CGI.escape(slot.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(tracking_html_render_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbTrackingHtmlRenderResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.render_sfvb_tracking_html",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#render_sfvb_tracking_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Render a transactional email without sending it
     # Renders a transactional email, such as the order receipt, exactly as it is sent, and returns the subject, HTML and text.  Nothing is sent or saved.  file_name is the template file, such as receipt_html.vm, or the display name.  Give cjson to render an unsaved draft of the email's body container in place of the saved one.  The order must be a test order.  Without one the email renders with a made up order. 
     # @param storefront_oid [Integer] 

data/lib/ultracart_api/models/sfvb_approval_params.rb

@@ -75,7 +75,7 @@ module UltracartClient
     # The step to remove, for sequence_step.delete, to move, for sequence_step.move, or to turn on, for sequence_step.enable_postcard.
     attr_accessor :step_uuid
 
-    # The tracking provider key, for tracking_provider.change.
+    # The tracking provider key, for tracking_provider.change and tracking_provider.clear.
     attr_accessor :tracking_provider
 
     # For upsell.enable, what to switch on.

data/lib/ultracart_api/models/sfvb_comms_lookup_owner.rb

@@ -15,6 +15,9 @@ require 'time'
 
 module UltracartClient
   class SfvbCommsLookupOwner
+    # True when the campaign or flow is archived.  It sends nothing, and 'sf comms flows list' or 'campaigns list' shows it only with --include-deleted.
+    attr_accessor :archived
+
     # True when it is sending now, by the same rule the sequence read uses.
     attr_accessor :live
 
@@ -33,6 +36,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'archived' => :'archived',
         :'live' => :'live',
         :'name' => :'name',
         :'status' => :'status',
@@ -49,6 +53,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'archived' => :'Boolean',
         :'live' => :'Boolean',
         :'name' => :'String',
         :'status' => :'String',
@@ -78,6 +83,10 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'archived')
+        self.archived = attributes[:'archived']
+      end
+
       if attributes.key?(:'live')
         self.live = attributes[:'live']
       end
@@ -117,6 +126,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          archived == o.archived &&
           live == o.live &&
           name == o.name &&
           status == o.status &&
@@ -133,7 +143,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [live, name, status, type, uuid].hash
+      [archived, live, name, status, type, uuid].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_comms_lookup_response.rb

@@ -15,6 +15,9 @@ require 'time'
 
 module UltracartClient
   class SfvbCommsLookupResponse
+    # True when the uuid is an archived campaign or flow.  It is still on its storefront and can be read; it sends nothing.
+    attr_accessor :archived
+
     # The sequence it belongs to, when there is one.
     attr_accessor :communication_sequence_uuid
 
@@ -44,6 +47,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'archived' => :'archived',
         :'communication_sequence_uuid' => :'communication_sequence_uuid',
         :'kind' => :'kind',
         :'name' => :'name',
@@ -64,6 +68,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'archived' => :'Boolean',
         :'communication_sequence_uuid' => :'String',
         :'kind' => :'String',
         :'name' => :'String',
@@ -97,6 +102,10 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'archived')
+        self.archived = attributes[:'archived']
+      end
+
       if attributes.key?(:'communication_sequence_uuid')
         self.communication_sequence_uuid = attributes[:'communication_sequence_uuid']
       end
@@ -154,6 +163,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          archived == o.archived &&
           communication_sequence_uuid == o.communication_sequence_uuid &&
           kind == o.kind &&
           name == o.name &&
@@ -174,7 +184,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [communication_sequence_uuid, kind, name, _next, notes, owner, step_uuid, storefront_oid, uuid].hash
+      [archived, communication_sequence_uuid, kind, name, _next, notes, owner, step_uuid, storefront_oid, uuid].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_preview_tracking_html_request.rb

@@ -0,0 +1,230 @@
+=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 SfvbPreviewTrackingHtmlRequest
+    # Conversion HTML to run instead of the live slot on a test order's receipt opened through this session's preview access link.  Never on a real order's receipt.  An empty string unstages it.  The same checks as a write apply.
+    attr_accessor :conversion_html
+
+    # Tracking HTML to run instead of the live slot on pages opened through this session's preview access link.  An empty string unstages it.  The same checks as a write apply.
+    attr_accessor :tracking_html
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'conversion_html' => :'conversion_html',
+        :'tracking_html' => :'tracking_html'
+      }
+    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
+      {
+        :'conversion_html' => :'String',
+        :'tracking_html' => :'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 `UltracartClient::SfvbPreviewTrackingHtmlRequest` 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::SfvbPreviewTrackingHtmlRequest`. 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?(:'conversion_html')
+        self.conversion_html = attributes[:'conversion_html']
+      end
+
+      if attributes.key?(:'tracking_html')
+        self.tracking_html = attributes[:'tracking_html']
+      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 &&
+          conversion_html == o.conversion_html &&
+          tracking_html == o.tracking_html
+    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
+      [conversion_html, tracking_html].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

data/lib/ultracart_api/models/sfvb_server_log.rb

@@ -21,7 +21,7 @@ module UltracartClient
     # How long the render took in milliseconds.
     attr_accessor :duration_ms
 
-    # Error lines in the log, including Velocity problems such as a null
+    # Error lines in the log, including Velocity problems such as setting a variable to null.
     attr_accessor :error_count
 
     # Lines in the full log text.