templatefox 1.10.0 → 1.11.0

data/lib/templatefox/models/modification.rb

@@ -0,0 +1,305 @@
+=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.11.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TemplateFox
+  # A single element modification, addressed by layer name.
+  class Modification < ApiModelBase
+    # Name of the layer to modify (set via the editor's Layers panel). Matched against the element's `data-layer-name`, falling back to its `id`.
+    attr_accessor :name
+
+    attr_accessor :text
+
+    attr_accessor :image_url
+
+    attr_accessor :color
+
+    attr_accessor :background
+
+    attr_accessor :hidden
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'text' => :'text',
+        :'image_url' => :'image_url',
+        :'color' => :'color',
+        :'background' => :'background',
+        :'hidden' => :'hidden'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'text' => :'String',
+        :'image_url' => :'String',
+        :'color' => :'String',
+        :'background' => :'String',
+        :'hidden' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'text',
+        :'image_url',
+        :'color',
+        :'background',
+        :'hidden'
+      ])
+    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::Modification` 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::Modification`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.key?(:'image_url')
+        self.image_url = attributes[:'image_url']
+      end
+
+      if attributes.key?(:'color')
+        self.color = attributes[:'color']
+      end
+
+      if attributes.key?(:'background')
+        self.background = attributes[:'background']
+      end
+
+      if attributes.key?(:'hidden')
+        self.hidden = attributes[:'hidden']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 200
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
+      end
+
+      if !@text.nil? && @text.to_s.length > 10000
+        invalid_properties.push('invalid value for "text", the character length must be smaller than or equal to 10000.')
+      end
+
+      if !@image_url.nil? && @image_url.to_s.length > 2000
+        invalid_properties.push('invalid value for "image_url", the character length must be smaller than or equal to 2000.')
+      end
+
+      pattern = Regexp.new(/^https?:\/\//)
+      if !@image_url.nil? && @image_url !~ pattern
+        invalid_properties.push("invalid value for \"image_url\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@color.nil? && @color.to_s.length > 100
+        invalid_properties.push('invalid value for "color", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@background.nil? && @background.to_s.length > 100
+        invalid_properties.push('invalid value for "background", the character length must be smaller than or equal to 100.')
+      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 @name.nil?
+      return false if @name.to_s.length > 200
+      return false if @name.to_s.length < 1
+      return false if !@text.nil? && @text.to_s.length > 10000
+      return false if !@image_url.nil? && @image_url.to_s.length > 2000
+      return false if !@image_url.nil? && @image_url !~ Regexp.new(/^https?:\/\//)
+      return false if !@color.nil? && @color.to_s.length > 100
+      return false if !@background.nil? && @background.to_s.length > 100
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 200
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 200.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] text Value to be assigned
+    def text=(text)
+      if !text.nil? && text.to_s.length > 10000
+        fail ArgumentError, 'invalid value for "text", the character length must be smaller than or equal to 10000.'
+      end
+
+      @text = text
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] image_url Value to be assigned
+    def image_url=(image_url)
+      if !image_url.nil? && image_url.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "image_url", the character length must be smaller than or equal to 2000.'
+      end
+
+      pattern = Regexp.new(/^https?:\/\//)
+      if !image_url.nil? && image_url !~ pattern
+        fail ArgumentError, "invalid value for \"image_url\", must conform to the pattern #{pattern}."
+      end
+
+      @image_url = image_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] color Value to be assigned
+    def color=(color)
+      if !color.nil? && color.to_s.length > 100
+        fail ArgumentError, 'invalid value for "color", the character length must be smaller than or equal to 100.'
+      end
+
+      @color = color
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] background Value to be assigned
+    def background=(background)
+      if !background.nil? && background.to_s.length > 100
+        fail ArgumentError, 'invalid value for "background", the character length must be smaller than or equal to 100.'
+      end
+
+      @background = background
+    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 &&
+          name == o.name &&
+          text == o.text &&
+          image_url == o.image_url &&
+          color == o.color &&
+          background == o.background &&
+          hidden == o.hidden
+    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
+      [name, text, image_url, color, background, hidden].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/pdf_input.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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/pdf_tools_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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/pdf_variant.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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/rotate_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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/s3_config_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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/s3_config_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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/s3_success_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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/s3_test_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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/template_field.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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/template_field_spec.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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/template_list_item.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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0
@@ -22,6 +22,9 @@ module TemplateFox
     # Template name
     attr_accessor :name
 
+    # Template product kind: `pdf` or `image`
+    attr_accessor :kind
+
     # ISO 8601 timestamp
     attr_accessor :created_at
 
@@ -33,6 +36,7 @@ module TemplateFox
       {
         :'id' => :'id',
         :'name' => :'name',
+        :'kind' => :'kind',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at'
       }
@@ -53,6 +57,7 @@ module TemplateFox
       {
         :'id' => :'String',
         :'name' => :'String',
+        :'kind' => :'String',
         :'created_at' => :'String',
         :'updated_at' => :'String'
       }
@@ -92,6 +97,12 @@ module TemplateFox
         self.name = nil
       end
 
+      if attributes.key?(:'kind')
+        self.kind = attributes[:'kind']
+      else
+        self.kind = 'pdf'
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       else
@@ -187,6 +198,7 @@ module TemplateFox
       self.class == o.class &&
           id == o.id &&
           name == o.name &&
+          kind == o.kind &&
           created_at == o.created_at &&
           updated_at == o.updated_at
     end
@@ -200,7 +212,7 @@ module TemplateFox
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, created_at, updated_at].hash
+      [id, name, kind, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/templatefox/models/templates_list_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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/transaction.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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/transactions_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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/update_version_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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/validation_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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/version_item.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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/models/versions_list_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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/lib/templatefox/version.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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0
@@ -11,5 +11,5 @@ Generator version: 7.21.0
 =end
 
 module TemplateFox
-  VERSION = '1.10.0'
+  VERSION = '1.11.0'
 end

data/lib/templatefox.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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0
@@ -19,21 +19,25 @@ require 'templatefox/configuration'
 
 # Models
 require 'templatefox/models/account_info_response'
+require 'templatefox/models/app_routers_v1_delivery_export_type'
 require 'templatefox/models/app_routers_v1_pdf_async_export_type'
-require 'templatefox/models/app_routers_v1_pdf_export_type'
 require 'templatefox/models/app_routers_v1_pdf_tools_export_type'
 require 'templatefox/models/create_async_pdf_request'
 require 'templatefox/models/create_async_pdf_response'
+require 'templatefox/models/create_image_request'
+require 'templatefox/models/create_image_response'
 require 'templatefox/models/create_pdf_request'
 require 'templatefox/models/create_pdf_response'
 require 'templatefox/models/create_version_request'
 require 'templatefox/models/extract_pdf_pages_request'
 require 'templatefox/models/http_validation_error'
+require 'templatefox/models/image_format'
 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/merge_pdf_request'
+require 'templatefox/models/modification'
 require 'templatefox/models/pdf_input'
 require 'templatefox/models/pdf_tools_response'
 require 'templatefox/models/pdf_variant'
@@ -55,6 +59,7 @@ require 'templatefox/models/versions_list_response'
 
 # APIs
 require 'templatefox/api/account_api'
+require 'templatefox/api/image_api'
 require 'templatefox/api/integrations_api'
 require 'templatefox/api/pdf_api'
 require 'templatefox/api/pdf_async_api'

data/spec/api/account_api_spec.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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0

data/spec/api/image_api_spec.rb

@@ -0,0 +1,47 @@
+=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.11.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for TemplateFox::ImageApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ImageApi' do
+  before do
+    # run before each test
+    @api_instance = TemplateFox::ImageApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ImageApi' do
+    it 'should create an instance of ImageApi' do
+      expect(@api_instance).to be_instance_of(TemplateFox::ImageApi)
+    end
+  end
+
+  # unit tests for create_image
+  # 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 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateImageResponse]
+  describe 'create_image 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/api/integrations_api_spec.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.11.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.21.0