templatefox 1.10.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b86cf16f04ca4e5709627c3a2b54c2989d8dfd04ad78462fcfe73de5e63843c9
-  data.tar.gz: e6d77ea2b23610c270d3a462640dd2ee850d6778f7a79268816e4d5dd545526f
+  metadata.gz: 42dc0ce544bf90f71ac18d64a94339a35bcd59431c27e56de46c898824ed932d
+  data.tar.gz: 7dcfea9371304d68c5f6ba5c1d86fe0bb11ffd973cb2dc092daa9ca1602d7dd9
 SHA512:
-  metadata.gz: 76267ec11f05779b3ec7f886d06482873eba5b70306a8a9aba26c18ae471742321a0c50b9ecd5dc070ee3588e734fea357408df75b80f5e4fd2463a3125972d9
-  data.tar.gz: 721003e4271027db5146bb28201490ccc1ac76f273f01c1d411c61e4999fe304470ca6121f201540a6d1e904072520154b342ceda040b9c963df1dec5b4d5dc9
+  metadata.gz: eff5e1fe81c002c3149f57ac3290adeb41da7a942faa64c9bce10c32de28968b36641947672c8d1814a0bd6d2478d47a913ba825ef256c720ec8108f6311fe05
+  data.tar.gz: 3162b8287e54db1c45d0291dee035c730b9dbad048bb10c699f261753d6309ca96a6f1da7d34aaa5619c2deb661b42d6083d2e3f4809263f6ad11ca515f70738

data/lib/templatefox/api/account_api.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/api/image_api.rb

@@ -0,0 +1,90 @@
+=begin
+#TemplateFox API
+
+#Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
+
+The version of the OpenAPI document: 1.12.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'cgi'
+
+module TemplateFox
+  class ImageApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Generate image from template
+    # Generate an image (PNG, JPEG or WebP) from an image template.  **Authentication:** API Key required (`x-api-key` header)  ## Request Body  | Field | Type | Required | Description | |-------|------|----------|-------------| | `template_id` | string | ✅ Yes | Template short ID (12 characters) | | `modifications` | array | No | Modify elements by layer name (see below) | | `format` | string | No | `png` (default), `jpeg` or `webp` | | `width` | integer | No | Output width in pixels (defaults to the template's native width) | | `export_type` | string | No | `url` (default) or `binary` |  ## Modifications  Each modification targets a layer by the `name` you set in the editor's Layers panel:  | Property | Description | |----------|-------------| | `name` | Layer name to modify (required) | | `text` | Replace the layer's text | | `image_url` | Set the layer's image (`src` for images, `background-image` otherwise) | | `color` | Text color | | `background` | Background color | | `hidden` | Hide (`true`) or show (`false`) the layer |  Unknown layer names are skipped and listed in the response `warnings`. A name that matches several layers is applied to all of them.  ## Export Types - `url` (default): image is uploaded to CDN, returns JSON with URL - `binary`: returns raw image bytes directly  **Note:** This endpoint only accepts image templates. Use `/v1/pdf/create` for PDF templates.  **Credits:** 1 credit deducted per successful generation.  **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
+    # @param create_image_request [CreateImageRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateImageResponse]
+    def create_image(create_image_request, opts = {})
+      data, _status_code, _headers = create_image_with_http_info(create_image_request, opts)
+      data
+    end
+
+    # Generate image from template
+    # Generate an image (PNG, JPEG or WebP) from an image template.  **Authentication:** API Key required (`x-api-key` header)  ## Request Body  | Field | Type | Required | Description | |-------|------|----------|-------------| | `template_id` | string | ✅ Yes | Template short ID (12 characters) | | `modifications` | array | No | Modify elements by layer name (see below) | | `format` | string | No | `png` (default), `jpeg` or `webp` | | `width` | integer | No | Output width in pixels (defaults to the template's native width) | | `export_type` | string | No | `url` (default) or `binary` |  ## Modifications  Each modification targets a layer by the `name` you set in the editor's Layers panel:  | Property | Description | |----------|-------------| | `name` | Layer name to modify (required) | | `text` | Replace the layer's text | | `image_url` | Set the layer's image (`src` for images, `background-image` otherwise) | | `color` | Text color | | `background` | Background color | | `hidden` | Hide (`true`) or show (`false`) the layer |  Unknown layer names are skipped and listed in the response `warnings`. A name that matches several layers is applied to all of them.  ## Export Types - `url` (default): image is uploaded to CDN, returns JSON with URL - `binary`: returns raw image bytes directly  **Note:** This endpoint only accepts image templates. Use `/v1/pdf/create` for PDF templates.  **Credits:** 1 credit deducted per successful generation.  **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
+    # @param create_image_request [CreateImageRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateImageResponse, Integer, Hash)>] CreateImageResponse data, response status code and response headers
+    def create_image_with_http_info(create_image_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ImageApi.create_image ...'
+      end
+      # verify the required parameter 'create_image_request' is set
+      if @api_client.config.client_side_validation && create_image_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_image_request' when calling ImageApi.create_image"
+      end
+      # resource path
+      local_var_path = '/v1/image/create'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'image/png']) unless header_params['Accept']
+      # 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(create_image_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateImageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ImageApi.create_image",
+        :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: ImageApi#create_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/templatefox/api/integrations_api.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/api/pdf_api.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/api/pdf_async_api.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/api/pdf_tools_api.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/api/templates_api.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0
@@ -225,6 +225,69 @@ module TemplateFox
       return data, status_code, headers
     end
 
+    # Get template layers
+    # List the addressable layers of a template.  **Authentication:** API Key required (`x-api-key` header) or JWT token  **Usage:** The image API (`/v1/image/create`) targets elements by layer name via its `modifications` array. This endpoint returns every named layer of the template — the counterpart of `/fields` for `{{ }}` variables — so a caller (or an agent) can discover what is modifiable without opening the editor.  **The reserved `background` layer** is always present: every image template has a background slot, whether it is an explicit element or the page itself.  **No credits consumed:** This is a read-only endpoint.  **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
+    # @param template_id [String] Template short ID (12 characters)
+    # @param [Hash] opts the optional parameters
+    # @return [TemplateLayersResponse]
+    def get_template_layers(template_id, opts = {})
+      data, _status_code, _headers = get_template_layers_with_http_info(template_id, opts)
+      data
+    end
+
+    # Get template layers
+    # List the addressable layers of a template.  **Authentication:** API Key required (`x-api-key` header) or JWT token  **Usage:** The image API (`/v1/image/create`) targets elements by layer name via its `modifications` array. This endpoint returns every named layer of the template — the counterpart of `/fields` for `{{ }}` variables — so a caller (or an agent) can discover what is modifiable without opening the editor.  **The reserved `background` layer** is always present: every image template has a background slot, whether it is an explicit element or the page itself.  **No credits consumed:** This is a read-only endpoint.  **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
+    # @param template_id [String] Template short ID (12 characters)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TemplateLayersResponse, Integer, Hash)>] TemplateLayersResponse data, response status code and response headers
+    def get_template_layers_with_http_info(template_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TemplatesApi.get_template_layers ...'
+      end
+      # verify the required parameter 'template_id' is set
+      if @api_client.config.client_side_validation && template_id.nil?
+        fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_template_layers"
+      end
+      # resource path
+      local_var_path = '/v1/templates/{template_id}/layers'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TemplateLayersResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"TemplatesApi.get_template_layers",
+        :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: TemplatesApi#get_template_layers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List template versions
     # List all snapshot versions for a template (excludes the working draft).
     # @param template_id [String] Template short ID (12 characters)
@@ -291,6 +354,7 @@ module TemplateFox
     # List templates
     # List all templates for the authenticated user.  **Authentication:** API Key required (`x-api-key` header) or JWT token  **Usage:** This endpoint is designed for no-code tools (Zapier, Make, n8n) to populate template selection dropdowns.  **No credits consumed:** This is a read-only endpoint.  **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :kind Filter by product kind: &#x60;pdf&#x60; or &#x60;image&#x60;
     # @return [TemplatesListResponse]
     def list_templates(opts = {})
       data, _status_code, _headers = list_templates_with_http_info(opts)
@@ -300,16 +364,23 @@ module TemplateFox
     # List templates
     # List all templates for the authenticated user.  **Authentication:** API Key required (&#x60;x-api-key&#x60; header) or JWT token  **Usage:** This endpoint is designed for no-code tools (Zapier, Make, n8n) to populate template selection dropdowns.  **No credits consumed:** This is a read-only endpoint.  **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :kind Filter by product kind: &#x60;pdf&#x60; or &#x60;image&#x60;
     # @return [Array<(TemplatesListResponse, Integer, Hash)>] TemplatesListResponse data, response status code and response headers
     def list_templates_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TemplatesApi.list_templates ...'
       end
+      pattern = Regexp.new(/^(pdf|image)$/)
+      if @api_client.config.client_side_validation && !opts[:'kind'].nil? && opts[:'kind'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"kind\"]' when calling TemplatesApi.list_templates, must conform to the pattern #{pattern}."
+      end
+
       # resource path
       local_var_path = '/v1/templates'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'kind'] = opts[:'kind'] if !opts[:'kind'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/templatefox/api_client.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/api_error.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/api_model_base.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/configuration.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/account_info_response.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/{app_routers_v1_pdf_export_type.rb → app_routers_v1_delivery_export_type.rb}

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module TemplateFox
-  class AppRoutersV1PdfExportType
+  class AppRoutersV1DeliveryExportType
     URL = "url".freeze
     BINARY = "binary".freeze
 
@@ -33,8 +33,8 @@ module TemplateFox
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if AppRoutersV1PdfExportType.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #AppRoutersV1PdfExportType"
+      return value if AppRoutersV1DeliveryExportType.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #AppRoutersV1DeliveryExportType"
     end
   end
 end

data/lib/templatefox/models/app_routers_v1_pdf_async_export_type.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/app_routers_v1_pdf_tools_export_type.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/create_async_pdf_request.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/create_async_pdf_response.rb

@@ -3,7 +3,7 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.10.0
+The version of the OpenAPI document: 1.12.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0