templatefox 1.11.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32e924b5c4d595bb2d6a01470815bf3f8265a35c4146ee69bd17292ed15515bc
-  data.tar.gz: 137bcef6d27ef8752d43a5368af77e755e87d412bd60346f82663a150f6bcc7f
+  metadata.gz: fc47542a2310895261806bc35ca01fa7b64979e66102cd458daa25f032e5c9d7
+  data.tar.gz: f719747a2cc567d04191a92604054bab887fda22d05150955d0759bd1a96f09f
 SHA512:
-  metadata.gz: e2aee76a65f43feffbd88668e3c7843f5984d2bc8a860c5b925444fe9c60ee301286777d9652b94ea1312b822b3547bc8c9c7b8b8a152f0fca0354ffd6efced0
-  data.tar.gz: 4eaad36edc36ae5f64da2c67758c6034ceeddbac1d9cfdec0a2cbab1d71e8d98a8fe355bdec11be4114488225fd444d00532c6e3c9c57ea6a374836d7ac41f9f
+  metadata.gz: 542a2e8dd8eba7baf68630854da0fd85dbd57aede360c794a3b71035cdc128fdfe8f3eefb14b15c61ad44f1bdd378491a9889552d67212ad0b68da8127174066
+  data.tar.gz: 0eb54f9a0bb497315b4d2ccd9df4021ebd69c601bb1c3720f8fdc884a4c9d9e9fbe604ee86f78e306cd2e599ce0cdf4e37a719310b5d4e1f95dbd442be4e8260

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.11.0
+The version of the OpenAPI document: 1.13.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/api/agent_api.rb

@@ -0,0 +1,227 @@
+=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.13.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'cgi'
+
+module TemplateFox
+  class AgentApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a template with the authoring agent
+    # Describe the image template you want; the TemplateFox agent authors it for you — valid HTML that renders deterministically AND stays editable in the visual editor, with every layer named and drivable through `/v1/image/create` modifications.  The job is asynchronous: poll `GET /v1/agent/jobs/{job_id}`. When completed, the response always includes a **preview_url** (rendered PNG) plus the `template_id`. Iterate with `POST /v1/agent/templates/{template_id}/revise`.  **Authentication:** API Key required (`x-api-key` header)  ## Credits  Creation costs **25 credits**, deducted when the job is queued and fully refunded if the job fails.  ## Canvas  Pass a `preset` (instagram-square, instagram-story, og-image, twitter-card, pinterest-pin, square-512) or explicit `width` + `height` in px.  ## Rate Limits  Standard rate limits apply (60 req/min free, 120 req/min paid).
+    # @param create_agent_template_request [CreateAgentTemplateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AgentJobCreatedResponse]
+    def create_agent_template(create_agent_template_request, opts = {})
+      data, _status_code, _headers = create_agent_template_with_http_info(create_agent_template_request, opts)
+      data
+    end
+
+    # Create a template with the authoring agent
+    # Describe the image template you want; the TemplateFox agent authors it for you — valid HTML that renders deterministically AND stays editable in the visual editor, with every layer named and drivable through `/v1/image/create` modifications.  The job is asynchronous: poll `GET /v1/agent/jobs/{job_id}`. When completed, the response always includes a **preview_url** (rendered PNG) plus the `template_id`. Iterate with `POST /v1/agent/templates/{template_id}/revise`.  **Authentication:** API Key required (`x-api-key` header)  ## Credits  Creation costs **25 credits**, deducted when the job is queued and fully refunded if the job fails.  ## Canvas  Pass a `preset` (instagram-square, instagram-story, og-image, twitter-card, pinterest-pin, square-512) or explicit `width` + `height` in px.  ## Rate Limits  Standard rate limits apply (60 req/min free, 120 req/min paid).
+    # @param create_agent_template_request [CreateAgentTemplateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AgentJobCreatedResponse, Integer, Hash)>] AgentJobCreatedResponse data, response status code and response headers
+    def create_agent_template_with_http_info(create_agent_template_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentApi.create_agent_template ...'
+      end
+      # verify the required parameter 'create_agent_template_request' is set
+      if @api_client.config.client_side_validation && create_agent_template_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_agent_template_request' when calling AgentApi.create_agent_template"
+      end
+      # resource path
+      local_var_path = '/v1/agent/templates'
+
+      # 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']
+      # 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_agent_template_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AgentJobCreatedResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentApi.create_agent_template",
+        :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: AgentApi#create_agent_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get authoring-agent job status
+    # Poll the status of an authoring-agent job.  **Authentication:** API Key required (`x-api-key` header)  ## Status Values  | Status | Description | |--------|-------------| | `pending` | Job is queued | | `processing` | The agent is authoring (typically 30s-3min) | | `completed` | Done — `template_id` and `preview_url` are set | | `failed` | Job failed (see error_message); credits were refunded |  Poll every 2-5 seconds. A job stuck in `processing` for more than 10 minutes is failed automatically and its credits refunded.
+    # @param job_id [String] Job UUID
+    # @param [Hash] opts the optional parameters
+    # @return [AgentJobStatusResponse]
+    def get_agent_job(job_id, opts = {})
+      data, _status_code, _headers = get_agent_job_with_http_info(job_id, opts)
+      data
+    end
+
+    # Get authoring-agent job status
+    # Poll the status of an authoring-agent job.  **Authentication:** API Key required (&#x60;x-api-key&#x60; header)  ## Status Values  | Status | Description | |--------|-------------| | &#x60;pending&#x60; | Job is queued | | &#x60;processing&#x60; | The agent is authoring (typically 30s-3min) | | &#x60;completed&#x60; | Done — &#x60;template_id&#x60; and &#x60;preview_url&#x60; are set | | &#x60;failed&#x60; | Job failed (see error_message); credits were refunded |  Poll every 2-5 seconds. A job stuck in &#x60;processing&#x60; for more than 10 minutes is failed automatically and its credits refunded.
+    # @param job_id [String] Job UUID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AgentJobStatusResponse, Integer, Hash)>] AgentJobStatusResponse data, response status code and response headers
+    def get_agent_job_with_http_info(job_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentApi.get_agent_job ...'
+      end
+      # verify the required parameter 'job_id' is set
+      if @api_client.config.client_side_validation && job_id.nil?
+        fail ArgumentError, "Missing the required parameter 'job_id' when calling AgentApi.get_agent_job"
+      end
+      # resource path
+      local_var_path = '/v1/agent/jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_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] || 'AgentJobStatusResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentApi.get_agent_job",
+        :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: AgentApi#get_agent_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Revise a template with the authoring agent
+    # Send natural-language feedback on an existing image template; the agent revises the draft while keeping layer names stable. Asynchronous — poll `GET /v1/agent/jobs/{job_id}`; the completed job always includes a fresh **preview_url**.  **Authentication:** API Key required (`x-api-key` header)  ## Credits  A revision costs **10 credits**, deducted when the job is queued and fully refunded if the job fails.
+    # @param template_id [String] Template short ID (12 characters)
+    # @param revise_agent_template_request [ReviseAgentTemplateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AgentJobCreatedResponse]
+    def revise_agent_template(template_id, revise_agent_template_request, opts = {})
+      data, _status_code, _headers = revise_agent_template_with_http_info(template_id, revise_agent_template_request, opts)
+      data
+    end
+
+    # Revise a template with the authoring agent
+    # Send natural-language feedback on an existing image template; the agent revises the draft while keeping layer names stable. Asynchronous — poll &#x60;GET /v1/agent/jobs/{job_id}&#x60;; the completed job always includes a fresh **preview_url**.  **Authentication:** API Key required (&#x60;x-api-key&#x60; header)  ## Credits  A revision costs **10 credits**, deducted when the job is queued and fully refunded if the job fails.
+    # @param template_id [String] Template short ID (12 characters)
+    # @param revise_agent_template_request [ReviseAgentTemplateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AgentJobCreatedResponse, Integer, Hash)>] AgentJobCreatedResponse data, response status code and response headers
+    def revise_agent_template_with_http_info(template_id, revise_agent_template_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentApi.revise_agent_template ...'
+      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 AgentApi.revise_agent_template"
+      end
+      # verify the required parameter 'revise_agent_template_request' is set
+      if @api_client.config.client_side_validation && revise_agent_template_request.nil?
+        fail ArgumentError, "Missing the required parameter 'revise_agent_template_request' when calling AgentApi.revise_agent_template"
+      end
+      # resource path
+      local_var_path = '/v1/agent/templates/{template_id}/revise'.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']
+      # 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(revise_agent_template_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AgentJobCreatedResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentApi.revise_agent_template",
+        :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: AgentApi#revise_agent_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/templatefox/api/image_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.11.0
+The version of the OpenAPI document: 1.13.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

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.11.0
+The version of the OpenAPI document: 1.13.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.11.0
+The version of the OpenAPI document: 1.13.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.11.0
+The version of the OpenAPI document: 1.13.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0
@@ -155,7 +155,7 @@ module TemplateFox
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Maximum number of results to return (default to 20)
     # @option opts [Integer] :offset Number of results to skip (for pagination) (default to 0)
-    # @option opts [JobStatus] :status Filter jobs by status
+    # @option opts [AppRoutersV1PdfAsyncJobStatus] :status Filter jobs by status
     # @return [JobListResponse]
     def list_pdf_jobs(opts = {})
       data, _status_code, _headers = list_pdf_jobs_with_http_info(opts)
@@ -167,7 +167,7 @@ module TemplateFox
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Maximum number of results to return (default to 20)
     # @option opts [Integer] :offset Number of results to skip (for pagination) (default to 0)
-    # @option opts [JobStatus] :status Filter jobs by status
+    # @option opts [AppRoutersV1PdfAsyncJobStatus] :status Filter jobs by status
     # @return [Array<(JobListResponse, Integer, Hash)>] JobListResponse data, response status code and response headers
     def list_pdf_jobs_with_http_info(opts = {})
       if @api_client.config.debugging

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.11.0
+The version of the OpenAPI document: 1.13.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.11.0
+The version of the OpenAPI document: 1.13.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)

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.11.0
+The version of the OpenAPI document: 1.13.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.11.0
+The version of the OpenAPI document: 1.13.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.11.0
+The version of the OpenAPI document: 1.13.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.11.0
+The version of the OpenAPI document: 1.13.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.11.0
+The version of the OpenAPI document: 1.13.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0