ultracart_api 4.1.152 → 4.1.154

data/lib/ultracart_api/api/sfvb_api.rb

@@ -239,6 +239,83 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Detach an image from a page
+    # Name exactly one of code or default.  Removes the page's copy of the image; the source file in the page folder is left alone.  Always needs sfvb_publish. 
+    # @param storefront_oid [Integer] 
+    # @param path [String] Page path, for example /catalog/dispensers/
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :code Image code to detach
+    # @option opts [Boolean] :default True to detach the default image
+    # @return [SfvbPageResponse]
+    def delete_sfvb_page_multimedia(storefront_oid, path, opts = {})
+      data, _status_code, _headers = delete_sfvb_page_multimedia_with_http_info(storefront_oid, path, opts)
+      data
+    end
+
+    # Detach an image from a page
+    # Name exactly one of code or default.  Removes the page's copy of the image; the source file in the page folder is left alone.  Always needs sfvb_publish. 
+    # @param storefront_oid [Integer] 
+    # @param path [String] Page path, for example /catalog/dispensers/
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :code Image code to detach
+    # @option opts [Boolean] :default True to detach the default image
+    # @return [Array<(SfvbPageResponse, Integer, Hash)>] SfvbPageResponse data, response status code and response headers
+    def delete_sfvb_page_multimedia_with_http_info(storefront_oid, path, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.delete_sfvb_page_multimedia ...'
+      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.delete_sfvb_page_multimedia"
+      end
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        fail ArgumentError, "Missing the required parameter 'path' when calling SfvbApi.delete_sfvb_page_multimedia"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/pages/multimedia'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'path'] = path
+      query_params[:'code'] = opts[:'code'] if !opts[:'code'].nil?
+      query_params[:'default'] = opts[:'default'] if !opts[:'default'].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] || 'SfvbPageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.delete_sfvb_page_multimedia",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#delete_sfvb_page_multimedia\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete a preview session
     # Releases the session before its eight hour expiry.  Without this the only way to free one is to wait, which is a poor answer for a tool that may open a dozen in an afternoon. 
     # @param storefront_oid [Integer] 
@@ -682,7 +759,8 @@ module UltracartClient
       return data, status_code, headers
     end
 
-    # Configuration schema for one element type
+    # Configuration schema and field card for one element type
+    # schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here. 
     # @param element_type [String] 
     # @param [Hash] opts the optional parameters
     # @return [SfvbElementSchemaResponse]
@@ -691,7 +769,8 @@ module UltracartClient
       data
     end
 
-    # Configuration schema for one element type
+    # Configuration schema and field card for one element type
+    # schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here. 
     # @param element_type [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SfvbElementSchemaResponse, Integer, Hash)>] SfvbElementSchemaResponse data, response status code and response headers
@@ -954,6 +1033,77 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Read a page's attributes and images
+    # What the pageattribute and pageimage elements render for this page.  These are not in any file, which is why a page folder can be empty and its elements still render something.  Attributes and image codes a template declares but nothing has set are included, so the response describes what the page can show rather than only what has been saved. 
+    # @param storefront_oid [Integer] 
+    # @param path [String] Page path, for example /catalog/dispensers/
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbPageResponse]
+    def get_sfvb_page(storefront_oid, path, opts = {})
+      data, _status_code, _headers = get_sfvb_page_with_http_info(storefront_oid, path, opts)
+      data
+    end
+
+    # Read a page&#39;s attributes and images
+    # What the pageattribute and pageimage elements render for this page.  These are not in any file, which is why a page folder can be empty and its elements still render something.  Attributes and image codes a template declares but nothing has set are included, so the response describes what the page can show rather than only what has been saved. 
+    # @param storefront_oid [Integer] 
+    # @param path [String] Page path, for example /catalog/dispensers/
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbPageResponse, Integer, Hash)>] SfvbPageResponse data, response status code and response headers
+    def get_sfvb_page_with_http_info(storefront_oid, path, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_page ...'
+      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_page"
+      end
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        fail ArgumentError, "Missing the required parameter 'path' when calling SfvbApi.get_sfvb_page"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/pages'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'path'] = path
+
+      # 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] || 'SfvbPageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.get_sfvb_page",
+        :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_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # URL that renders a preview session
     # Refuses a session that does not exist, so a URL you receive is for a session that was really there.  expires_in_seconds is the time actually remaining, not the configured lifetime.  Needs a token that resolves to a user, because a preview session belongs to the person who created it. 
     # @param storefront_oid [Integer] 
@@ -2059,6 +2209,170 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Change a page's attributes
+    # A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, slider, item set, page collection and video list attributes are refused - edit those in the page editor.  Always needs sfvb_publish, because a page's attributes are shared by every theme and there is no dormant copy to change instead. 
+    # @param storefront_oid [Integer] 
+    # @param path [String] Page path, for example /catalog/dispensers/
+    # @param page_attribute_update_request [SfvbPageAttributeUpdateRequest] Attributes to change
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbPageResponse]
+    def put_sfvb_page_attributes(storefront_oid, path, page_attribute_update_request, opts = {})
+      data, _status_code, _headers = put_sfvb_page_attributes_with_http_info(storefront_oid, path, page_attribute_update_request, opts)
+      data
+    end
+
+    # Change a page&#39;s attributes
+    # A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, slider, item set, page collection and video list attributes are refused - edit those in the page editor.  Always needs sfvb_publish, because a page&#39;s attributes are shared by every theme and there is no dormant copy to change instead. 
+    # @param storefront_oid [Integer] 
+    # @param path [String] Page path, for example /catalog/dispensers/
+    # @param page_attribute_update_request [SfvbPageAttributeUpdateRequest] Attributes to change
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbPageResponse, Integer, Hash)>] SfvbPageResponse data, response status code and response headers
+    def put_sfvb_page_attributes_with_http_info(storefront_oid, path, page_attribute_update_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.put_sfvb_page_attributes ...'
+      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_page_attributes"
+      end
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        fail ArgumentError, "Missing the required parameter 'path' when calling SfvbApi.put_sfvb_page_attributes"
+      end
+      # verify the required parameter 'page_attribute_update_request' is set
+      if @api_client.config.client_side_validation && page_attribute_update_request.nil?
+        fail ArgumentError, "Missing the required parameter 'page_attribute_update_request' when calling SfvbApi.put_sfvb_page_attributes"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/pages/attributes'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'path'] = path
+
+      # 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'])
+      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(page_attribute_update_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbPageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.put_sfvb_page_attributes",
+        :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_page_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Attach an image to a page
+    # Upload the image with files/upload to the page path followed by a filename first, then name that filename here as either the default image or an image code.  The default image is what a pageimage element with no pageImageCode renders, and what a subgroup tile shows.  Replaces whatever that slot held.  Always needs sfvb_publish. 
+    # @param storefront_oid [Integer] 
+    # @param path [String] Page path, for example /catalog/dispensers/
+    # @param page_multimedia_request [SfvbPageMultimediaRequest] Image to attach
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbPageResponse]
+    def put_sfvb_page_multimedia(storefront_oid, path, page_multimedia_request, opts = {})
+      data, _status_code, _headers = put_sfvb_page_multimedia_with_http_info(storefront_oid, path, page_multimedia_request, opts)
+      data
+    end
+
+    # Attach an image to a page
+    # Upload the image with files/upload to the page path followed by a filename first, then name that filename here as either the default image or an image code.  The default image is what a pageimage element with no pageImageCode renders, and what a subgroup tile shows.  Replaces whatever that slot held.  Always needs sfvb_publish. 
+    # @param storefront_oid [Integer] 
+    # @param path [String] Page path, for example /catalog/dispensers/
+    # @param page_multimedia_request [SfvbPageMultimediaRequest] Image to attach
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbPageResponse, Integer, Hash)>] SfvbPageResponse data, response status code and response headers
+    def put_sfvb_page_multimedia_with_http_info(storefront_oid, path, page_multimedia_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.put_sfvb_page_multimedia ...'
+      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_page_multimedia"
+      end
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        fail ArgumentError, "Missing the required parameter 'path' when calling SfvbApi.put_sfvb_page_multimedia"
+      end
+      # verify the required parameter 'page_multimedia_request' is set
+      if @api_client.config.client_side_validation && page_multimedia_request.nil?
+        fail ArgumentError, "Missing the required parameter 'page_multimedia_request' when calling SfvbApi.put_sfvb_page_multimedia"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/pages/multimedia'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'path'] = path
+
+      # 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'])
+      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(page_multimedia_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbPageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.put_sfvb_page_multimedia",
+        :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_page_multimedia\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Push containers into a preview session
     # Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
     # @param storefront_oid [Integer] 

data/lib/ultracart_api/models/sfvb_element.rb

@@ -15,6 +15,9 @@ require 'time'
 
 module UltracartClient
   class SfvbElement
+    # True when a markdown field card for this element is available from elements/{element_type}.
+    attr_accessor :doc_available
+
     # True when a per element configuration schema is available from elements/{element_type}.
     attr_accessor :schema_available
 
@@ -24,6 +27,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'doc_available' => :'doc_available',
         :'schema_available' => :'schema_available',
         :'type' => :'type'
       }
@@ -37,6 +41,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'doc_available' => :'Boolean',
         :'schema_available' => :'Boolean',
         :'type' => :'String'
       }
@@ -63,6 +68,10 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'doc_available')
+        self.doc_available = attributes[:'doc_available']
+      end
+
       if attributes.key?(:'schema_available')
         self.schema_available = attributes[:'schema_available']
       end
@@ -90,6 +99,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          doc_available == o.doc_available &&
           schema_available == o.schema_available &&
           type == o.type
     end
@@ -103,7 +113,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [schema_available, type].hash
+      [doc_available, schema_available, type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_element_schema_response.rb

@@ -15,7 +15,10 @@ require 'time'
 
 module UltracartClient
   class SfvbElementSchemaResponse
-    # JSON schema for this element's config object, as a JSON string.  Null when no schema has been published for this element yet.
+    # Markdown field card for this element, as a string.  Omitted when no field card has been published for this element.
+    attr_accessor :doc
+
+    # Draft-07 JSON schema for this element's config object, as a JSON string.  Omitted when no schema has been published for this element.
     attr_accessor :schema
 
     # The element type.
@@ -24,6 +27,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'doc' => :'doc',
         :'schema' => :'schema',
         :'type' => :'type'
       }
@@ -37,6 +41,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'doc' => :'String',
         :'schema' => :'String',
         :'type' => :'String'
       }
@@ -63,6 +68,10 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'doc')
+        self.doc = attributes[:'doc']
+      end
+
       if attributes.key?(:'schema')
         self.schema = attributes[:'schema']
       end
@@ -90,6 +99,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          doc == o.doc &&
           schema == o.schema &&
           type == o.type
     end
@@ -103,7 +113,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [schema, type].hash
+      [doc, schema, type].hash
     end
 
     # Builds the object from hash