templatefox 1.6.1 → 1.8.0

data/lib/templatefox/models/version_item.rb

@@ -0,0 +1,225 @@
+=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.8.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TemplateFox
+  # Version item in list response
+  class VersionItem < ApiModelBase
+    # Version number
+    attr_accessor :version_number
+
+    attr_accessor :tag
+
+    attr_accessor :description
+
+    # Whether this is the default version used by the API
+    attr_accessor :is_default
+
+    # ISO 8601 timestamp
+    attr_accessor :created_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'version_number' => :'version_number',
+        :'tag' => :'tag',
+        :'description' => :'description',
+        :'is_default' => :'is_default',
+        :'created_at' => :'created_at'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'version_number' => :'Integer',
+        :'tag' => :'String',
+        :'description' => :'String',
+        :'is_default' => :'Boolean',
+        :'created_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'tag',
+        :'description',
+      ])
+    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 `TemplateFox::VersionItem` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TemplateFox::VersionItem`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'version_number')
+        self.version_number = attributes[:'version_number']
+      else
+        self.version_number = nil
+      end
+
+      if attributes.key?(:'tag')
+        self.tag = attributes[:'tag']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'is_default')
+        self.is_default = attributes[:'is_default']
+      else
+        self.is_default = false
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @version_number.nil?
+        invalid_properties.push('invalid value for "version_number", version_number cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @version_number.nil?
+      return false if @created_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] version_number Value to be assigned
+    def version_number=(version_number)
+      if version_number.nil?
+        fail ArgumentError, 'version_number cannot be nil'
+      end
+
+      @version_number = version_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    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 &&
+          version_number == o.version_number &&
+          tag == o.tag &&
+          description == o.description &&
+          is_default == o.is_default &&
+          created_at == o.created_at
+    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
+      [version_number, tag, description, is_default, created_at].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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
+
+  end
+
+end

data/lib/templatefox/models/versions_list_response.rb

@@ -0,0 +1,167 @@
+=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.8.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TemplateFox
+  # Response for versions list
+  class VersionsListResponse < ApiModelBase
+    attr_accessor :versions
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'versions' => :'versions'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'versions' => :'Array<VersionItem>'
+      }
+    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 `TemplateFox::VersionsListResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TemplateFox::VersionsListResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'versions')
+        if (value = attributes[:'versions']).is_a?(Array)
+          self.versions = value
+        end
+      else
+        self.versions = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @versions.nil?
+        invalid_properties.push('invalid value for "versions", versions cannot be nil.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @versions.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] versions Value to be assigned
+    def versions=(versions)
+      if versions.nil?
+        fail ArgumentError, 'versions cannot be nil'
+      end
+
+      @versions = versions
+    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 &&
+          versions == o.versions
+    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
+      [versions].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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
+
+  end
+
+end

data/lib/templatefox/version.rb

@@ -3,13 +3,13 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.6.1
+The version of the OpenAPI document: 1.8.0
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0
+Generator version: 7.21.0
 
 =end
 
 module TemplateFox
-  VERSION = '1.6.1'
+  VERSION = '1.8.0'
 end

data/lib/templatefox.rb

@@ -3,10 +3,10 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.6.1
+The version of the OpenAPI document: 1.8.0
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0
+Generator version: 7.21.0
 
 =end
 
@@ -25,22 +25,28 @@ require 'templatefox/models/create_async_pdf_request'
 require 'templatefox/models/create_async_pdf_response'
 require 'templatefox/models/create_pdf_request'
 require 'templatefox/models/create_pdf_response'
+require 'templatefox/models/create_version_request'
 require 'templatefox/models/http_validation_error'
 require 'templatefox/models/job_list_response'
 require 'templatefox/models/job_status'
 require 'templatefox/models/job_status_response'
 require 'templatefox/models/location_inner'
+require 'templatefox/models/pdf_variant'
 require 'templatefox/models/s3_config_request'
 require 'templatefox/models/s3_config_response'
 require 'templatefox/models/s3_success_response'
 require 'templatefox/models/s3_test_response'
+require 'templatefox/models/set_default_version_request'
 require 'templatefox/models/template_field'
 require 'templatefox/models/template_field_spec'
 require 'templatefox/models/template_list_item'
 require 'templatefox/models/templates_list_response'
 require 'templatefox/models/transaction'
 require 'templatefox/models/transactions_response'
+require 'templatefox/models/update_version_request'
 require 'templatefox/models/validation_error'
+require 'templatefox/models/version_item'
+require 'templatefox/models/versions_list_response'
 
 # APIs
 require 'templatefox/api/account_api'

data/spec/api/account_api_spec.rb

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

data/spec/api/integrations_api_spec.rb

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

data/spec/api/pdf_api_spec.rb

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

data/spec/api/pdf_async_api_spec.rb

@@ -3,10 +3,10 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.6.1
+The version of the OpenAPI document: 1.8.0
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0
+Generator version: 7.21.0
 
 =end
 
@@ -47,7 +47,7 @@ describe 'PDFAsyncApi' do
   # unit tests for get_pdf_job
   # Get PDF job status
   # Get the current status of an async PDF generation job.  **Authentication:** API Key required (`x-api-key` header)  ## Status Values  | Status | Description | |--------|-------------| | `pending` | Job is queued, waiting to be processed | | `processing` | Job is being processed | | `completed` | PDF generated successfully | | `failed` | Job failed (check error_message) |  ## Polling Recommendations  - Poll every 1-2 seconds for small documents - Poll every 5-10 seconds for large documents - Consider using webhooks instead of polling
-  # @param job_id 
+  # @param job_id Async job ID (UUID returned by the create-async endpoint)
   # @param [Hash] opts the optional parameters
   # @return [JobStatusResponse]
   describe 'get_pdf_job test' do
@@ -60,9 +60,9 @@ describe 'PDFAsyncApi' do
   # List PDF jobs
   # List async PDF generation jobs for your team.  **Authentication:** API Key required (`x-api-key` header)  Supports pagination and filtering by status.
   # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :limit 
-  # @option opts [Integer] :offset 
-  # @option opts [JobStatus] :status 
+  # @option opts [Integer] :limit Maximum number of results to return
+  # @option opts [Integer] :offset Number of results to skip (for pagination)
+  # @option opts [JobStatus] :status Filter jobs by status
   # @return [JobListResponse]
   describe 'list_pdf_jobs test' do
     it 'should work' do

data/spec/api/templates_api_spec.rb

@@ -3,10 +3,10 @@
 
 #Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
 
-The version of the OpenAPI document: 1.6.1
+The version of the OpenAPI document: 1.8.0
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0
+Generator version: 7.21.0
 
 =end
 
@@ -32,10 +32,36 @@ describe 'TemplatesApi' do
     end
   end
 
+  # unit tests for create_template_version
+  # Create a version snapshot
+  # Create an immutable snapshot of the current template draft.
+  # @param template_id Template short ID (12 characters)
+  # @param create_version_request 
+  # @param [Hash] opts the optional parameters
+  # @return [VersionItem]
+  describe 'create_template_version test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_template_version
+  # Delete a version
+  # Delete a specific version snapshot.
+  # @param template_id Template short ID
+  # @param version_number Version number to delete
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'delete_template_version test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for get_template_fields
   # Get template fields
   # Get the dynamic fields for a template.  **Authentication:** API Key required (`x-api-key` header) or JWT token  **Usage:** This endpoint is designed for no-code tool integrations (Zapier, Make.com). It returns an array of field definitions used to dynamically generate input forms.  **Response format:** Array of field objects with: `key`, `label`, `type`, `required`, optional `helpText`, and optional `spec` (for array fields).  **Field types:** - `string`: Text input - `integer`: Integer number - `number`: Decimal number - `boolean`: True/False checkbox - `array`: Array of items with nested `spec` defining item structure  **Array fields:** When a field is an array of objects, the response includes a `spec` array defining the structure of each item (name, label, type for each nested field).  **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 
+  # @param template_id Template short ID (12 characters)
   # @param [Hash] opts the optional parameters
   # @return [Array<TemplateField>]
   describe 'get_template_fields test' do
@@ -44,6 +70,18 @@ describe 'TemplatesApi' do
     end
   end
 
+  # unit tests for list_template_versions
+  # List template versions
+  # List all snapshot versions for a template (excludes the working draft).
+  # @param template_id Template short ID (12 characters)
+  # @param [Hash] opts the optional parameters
+  # @return [VersionsListResponse]
+  describe 'list_template_versions test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for list_templates
   # 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.
@@ -55,4 +93,43 @@ describe 'TemplatesApi' do
     end
   end
 
+  # unit tests for remove_default_version
+  # Remove default version
+  # Remove the default version setting. API will use the working draft.
+  # @param template_id Template short ID
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'remove_default_version test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for set_default_version
+  # Set default version
+  # Set which version the API uses by default when no version param is provided.
+  # @param template_id Template short ID
+  # @param set_default_version_request 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'set_default_version test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_template_version
+  # Update a version
+  # Update a version&#39;s tag or description.
+  # @param template_id Template short ID
+  # @param version_number Version number to update
+  # @param update_version_request 
+  # @param [Hash] opts the optional parameters
+  # @return [VersionItem]
+  describe 'update_template_version test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/models/account_info_response_spec.rb

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

data/spec/models/app_routers_v1_pdf_async_export_type_spec.rb

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

data/spec/models/app_routers_v1_pdf_export_type_spec.rb

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