ultracart_api 4.1.177 → 4.1.179

data/lib/ultracart_api/api/sfvb_api.rb

@@ -2930,6 +2930,225 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get a screen recording
+    # One recorded visitor session and its page views, with each page view's named events such as rage clicks, script errors and checkout errors, but without the replay data.  Fetch a page view's replay events separately.  Find recordings to look at from the heatmaps or the analytics warehouse.  The visitor's email, IP address and visitor id are not returned, nor what they typed into form fields.  Reading a recording does not mark it watched. 
+    # @param storefront_oid [Integer] 
+    # @param screen_recording_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbRecordingResponse]
+    def get_sfvb_recording(storefront_oid, screen_recording_uuid, opts = {})
+      data, _status_code, _headers = get_sfvb_recording_with_http_info(storefront_oid, screen_recording_uuid, opts)
+      data
+    end
+
+    # Get a screen recording
+    # One recorded visitor session and its page views, with each page view's named events such as rage clicks, script errors and checkout errors, but without the replay data.  Fetch a page view's replay events separately.  Find recordings to look at from the heatmaps or the analytics warehouse.  The visitor's email, IP address and visitor id are not returned, nor what they typed into form fields.  Reading a recording does not mark it watched. 
+    # @param storefront_oid [Integer] 
+    # @param screen_recording_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbRecordingResponse, Integer, Hash)>] SfvbRecordingResponse data, response status code and response headers
+    def get_sfvb_recording_with_http_info(storefront_oid, screen_recording_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_recording ...'
+      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.get_sfvb_recording"
+      end
+      # verify the required parameter 'screen_recording_uuid' is set
+      if @api_client.config.client_side_validation && screen_recording_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling SfvbApi.get_sfvb_recording"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_uuid' + '}', CGI.escape(screen_recording_uuid.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbRecordingResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.get_sfvb_recording",
+        :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: SfvbApi#get_sfvb_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get one recorded page view's replay events
+    # The rrweb events for one page view, as a JSON array in a string, for replaying on the caller's own machine.  Card fields are masked by the recorder, but other text the visitor typed can appear.  Limited per account to 30 page views a minute, 300 an hour and 1000 a day.  Reading the events does not mark the recording watched. 
+    # @param storefront_oid [Integer] 
+    # @param screen_recording_uuid [String] 
+    # @param screen_recording_page_view_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbRecordingEventsResponse]
+    def get_sfvb_recording_page_view_events(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts = {})
+      data, _status_code, _headers = get_sfvb_recording_page_view_events_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts)
+      data
+    end
+
+    # Get one recorded page view&#39;s replay events
+    # The rrweb events for one page view, as a JSON array in a string, for replaying on the caller&#39;s own machine.  Card fields are masked by the recorder, but other text the visitor typed can appear.  Limited per account to 30 page views a minute, 300 an hour and 1000 a day.  Reading the events does not mark the recording watched. 
+    # @param storefront_oid [Integer] 
+    # @param screen_recording_uuid [String] 
+    # @param screen_recording_page_view_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbRecordingEventsResponse, Integer, Hash)>] SfvbRecordingEventsResponse data, response status code and response headers
+    def get_sfvb_recording_page_view_events_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_recording_page_view_events ...'
+      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.get_sfvb_recording_page_view_events"
+      end
+      # verify the required parameter 'screen_recording_uuid' is set
+      if @api_client.config.client_side_validation && screen_recording_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling SfvbApi.get_sfvb_recording_page_view_events"
+      end
+      # verify the required parameter 'screen_recording_page_view_uuid' is set
+      if @api_client.config.client_side_validation && screen_recording_page_view_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'screen_recording_page_view_uuid' when calling SfvbApi.get_sfvb_recording_page_view_events"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_uuid' + '}', CGI.escape(screen_recording_uuid.to_s)).sub('{' + 'screen_recording_page_view_uuid' + '}', CGI.escape(screen_recording_page_view_uuid.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbRecordingEventsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.get_sfvb_recording_page_view_events",
+        :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: SfvbApi#get_sfvb_recording_page_view_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get one storefront render log
+    # One render's server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug. 
+    # @param storefront_oid [Integer] 
+    # @param log_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :min_level 
+    # @return [SfvbServerLogDetail]
+    def get_sfvb_server_log(storefront_oid, log_id, opts = {})
+      data, _status_code, _headers = get_sfvb_server_log_with_http_info(storefront_oid, log_id, opts)
+      data
+    end
+
+    # Get one storefront render log
+    # One render&#39;s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug. 
+    # @param storefront_oid [Integer] 
+    # @param log_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :min_level 
+    # @return [Array<(SfvbServerLogDetail, Integer, Hash)>] SfvbServerLogDetail data, response status code and response headers
+    def get_sfvb_server_log_with_http_info(storefront_oid, log_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_server_log ...'
+      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.get_sfvb_server_log"
+      end
+      # verify the required parameter 'log_id' is set
+      if @api_client.config.client_side_validation && log_id.nil?
+        fail ArgumentError, "Missing the required parameter 'log_id' when calling SfvbApi.get_sfvb_server_log"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/logs/{log_id}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'log_id' + '}', CGI.escape(log_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'min_level'] = opts[:'min_level'] if !opts[:'min_level'].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] || 'SfvbServerLogDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.get_sfvb_server_log",
+        :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: SfvbApi#get_sfvb_server_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Read a storefront's site attributes
     # The values the siteattribute element and $site.attr render.  These are not in any file or theme.  Attributes a template declares but nothing has set are included with the template's default, so the response describes what the templates can render rather than only what has been saved.  Credentials stored as site attributes are never included. 
     # @param storefront_oid [Integer] 
@@ -4418,6 +4637,82 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # List recent storefront render logs
+    # The server log the storefront Developer Tools panel shows, one per page render, newest first and without the log text.  Each carries counts of error and warning lines, including Velocity problems such as a null #set, so a failing render stands out without reading every log.  Filter by uri (a case insensitive contains match on the rendered address) and errors_only.  since is 15m, 2h or 1d, or an ISO-8601 time, default 1h; logs are kept for seven days and only the newest 1000.  With a filter the newest 200 logs in the window are searched, and more_available says whether older ones were left unread. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :uri 
+    # @option opts [String] :since 
+    # @option opts [Boolean] :errors_only 
+    # @option opts [Integer] :limit 
+    # @return [SfvbServerLogsResponse]
+    def list_sfvb_server_logs(storefront_oid, opts = {})
+      data, _status_code, _headers = list_sfvb_server_logs_with_http_info(storefront_oid, opts)
+      data
+    end
+
+    # List recent storefront render logs
+    # The server log the storefront Developer Tools panel shows, one per page render, newest first and without the log text.  Each carries counts of error and warning lines, including Velocity problems such as a null #set, so a failing render stands out without reading every log.  Filter by uri (a case insensitive contains match on the rendered address) and errors_only.  since is 15m, 2h or 1d, or an ISO-8601 time, default 1h; logs are kept for seven days and only the newest 1000.  With a filter the newest 200 logs in the window are searched, and more_available says whether older ones were left unread. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :uri 
+    # @option opts [String] :since 
+    # @option opts [Boolean] :errors_only 
+    # @option opts [Integer] :limit 
+    # @return [Array<(SfvbServerLogsResponse, Integer, Hash)>] SfvbServerLogsResponse data, response status code and response headers
+    def list_sfvb_server_logs_with_http_info(storefront_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.list_sfvb_server_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 SfvbApi.list_sfvb_server_logs"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/logs'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'uri'] = opts[:'uri'] if !opts[:'uri'].nil?
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'errors_only'] = opts[:'errors_only'] if !opts[:'errors_only'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'SfvbServerLogsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.list_sfvb_server_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: SfvbApi#list_sfvb_server_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List storefronts
     # @param [Hash] opts the optional parameters
     # @return [SfvbStorefrontsResponse]