templatefox 1.0.0

data/lib/templatefox/models/validation_error.rb

@@ -0,0 +1,218 @@
+=begin
+#TemplateFox API
+
+#Generate PDFs from HTML templates via API. Design once, generate thousands.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TemplateFox
+  class ValidationError < ApiModelBase
+    attr_accessor :loc
+
+    attr_accessor :msg
+
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'loc' => :'loc',
+        :'msg' => :'msg',
+        :'type' => :'type'
+      }
+    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
+      {
+        :'loc' => :'Array<LocationInner>',
+        :'msg' => :'String',
+        :'type' => :'String'
+      }
+    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::ValidationError` 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::ValidationError`. 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?(:'loc')
+        if (value = attributes[:'loc']).is_a?(Array)
+          self.loc = value
+        end
+      else
+        self.loc = nil
+      end
+
+      if attributes.key?(:'msg')
+        self.msg = attributes[:'msg']
+      else
+        self.msg = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = 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 @loc.nil?
+        invalid_properties.push('invalid value for "loc", loc cannot be nil.')
+      end
+
+      if @msg.nil?
+        invalid_properties.push('invalid value for "msg", msg cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type 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 @loc.nil?
+      return false if @msg.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] loc Value to be assigned
+    def loc=(loc)
+      if loc.nil?
+        fail ArgumentError, 'loc cannot be nil'
+      end
+
+      @loc = loc
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] msg Value to be assigned
+    def msg=(msg)
+      if msg.nil?
+        fail ArgumentError, 'msg cannot be nil'
+      end
+
+      @msg = msg
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type Value to be assigned
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'type cannot be nil'
+      end
+
+      @type = type
+    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 &&
+          loc == o.loc &&
+          msg == o.msg &&
+          type == o.type
+    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
+      [loc, msg, type].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

@@ -0,0 +1,15 @@
+=begin
+#TemplateFox API
+
+#Generate PDFs from HTML templates via API. Design once, generate thousands.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+module TemplateFox
+  VERSION = '1.0.0'
+end

data/lib/templatefox.rb

@@ -0,0 +1,60 @@
+=begin
+#TemplateFox API
+
+#Generate PDFs from HTML templates via API. Design once, generate thousands.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+# Common files
+require 'templatefox/api_client'
+require 'templatefox/api_error'
+require 'templatefox/api_model_base'
+require 'templatefox/version'
+require 'templatefox/configuration'
+
+# Models
+require 'templatefox/models/account_info_response'
+require 'templatefox/models/create_pdf_request'
+require 'templatefox/models/create_pdf_response'
+require 'templatefox/models/export_type'
+require 'templatefox/models/http_validation_error'
+require 'templatefox/models/location_inner'
+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/template_field'
+require 'templatefox/models/template_list_item'
+require 'templatefox/models/templates_list_response'
+require 'templatefox/models/transaction'
+require 'templatefox/models/transactions_response'
+require 'templatefox/models/validation_error'
+
+# APIs
+require 'templatefox/api/account_api'
+require 'templatefox/api/integrations_api'
+require 'templatefox/api/pdf_api'
+require 'templatefox/api/templates_api'
+
+module TemplateFox
+  class << self
+    # Customize default settings for the SDK using block.
+    #   TemplateFox.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/account_api_spec.rb

@@ -0,0 +1,59 @@
+=begin
+#TemplateFox API
+
+#Generate PDFs from HTML templates via API. Design once, generate thousands.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for TemplateFox::AccountApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AccountApi' do
+  before do
+    # run before each test
+    @api_instance = TemplateFox::AccountApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountApi' do
+    it 'should create an instance of AccountApi' do
+      expect(@api_instance).to be_instance_of(TemplateFox::AccountApi)
+    end
+  end
+
+  # unit tests for get_account
+  # Get account info
+  # Get account information including remaining credits.  **Authentication:** API Key required (`x-api-key` header) or JWT token  **Usage:** Check credit balance before performing operations.  **No credits consumed:** This is a read-only endpoint.
+  # @param [Hash] opts the optional parameters
+  # @return [AccountInfoResponse]
+  describe 'get_account 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_transactions
+  # List transactions
+  # List transaction history for the authenticated user.  **Authentication:** API Key required (`x-api-key` header) or JWT token  **Pagination:** Use `limit` and `offset` query parameters.  **Transaction types:** - `PDFGEN`: PDF generation (consumes credits) - `REFUND`: Credit refund (on failed generation) - `PURCHASE`: Credit purchase - `BONUS`: Bonus credits  **Credits field:** - Positive value = credits consumed - Negative value = credits added  **No credits consumed:** This is a read-only endpoint.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Number of records to return
+  # @option opts [Integer] :offset Number of records to skip
+  # @return [TransactionsResponse]
+  describe 'list_transactions 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

@@ -0,0 +1,80 @@
+=begin
+#TemplateFox API
+
+#Generate PDFs from HTML templates via API. Design once, generate thousands.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for TemplateFox::IntegrationsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'IntegrationsApi' do
+  before do
+    # run before each test
+    @api_instance = TemplateFox::IntegrationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of IntegrationsApi' do
+    it 'should create an instance of IntegrationsApi' do
+      expect(@api_instance).to be_instance_of(TemplateFox::IntegrationsApi)
+    end
+  end
+
+  # unit tests for delete_s3_config
+  # Delete S3 configuration
+  # Delete S3 storage configuration.  **Authentication:** API Key required (`x-api-key` header) with admin privileges  **Usage:** Remove your S3 integration. Generated PDFs will use the default CDN storage after deletion.  **Warning:** This action is irreversible. You'll need to reconfigure S3 to use it again.  **No credits consumed:** This is a configuration endpoint.
+  # @param [Hash] opts the optional parameters
+  # @return [S3SuccessResponse]
+  describe 'delete_s3_config 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_s3_config
+  # Get S3 configuration
+  # Get current S3 storage configuration.  **Authentication:** API Key required (`x-api-key` header) with admin privileges  **Usage:** Retrieve your S3 integration settings. Secret access key is masked for security.  **Returns 404** if S3 is not configured.  **No credits consumed:** This is a read-only endpoint.
+  # @param [Hash] opts the optional parameters
+  # @return [S3ConfigResponse]
+  describe 'get_s3_config 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 save_s3_config
+  # Save S3 configuration
+  # Save or update S3-compatible storage configuration.  **Authentication:** API Key required (`x-api-key` header) with admin privileges  **Usage:** Configure your S3-compatible storage to receive generated PDFs directly in your own bucket instead of the default CDN.  **Supported providers:** - Amazon S3 - DigitalOcean Spaces - Cloudflare R2 - MinIO - Any S3-compatible storage  **Secret key behavior:** - For new configuration: `secret_access_key` is required - For updates: Omit `secret_access_key` to keep existing value  **No credits consumed:** This is a configuration endpoint.
+  # @param s3_config_request 
+  # @param [Hash] opts the optional parameters
+  # @return [S3SuccessResponse]
+  describe 'save_s3_config 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 test_s3_connection
+  # Test S3 connection
+  # Test S3 connection with stored credentials.  **Authentication:** API Key required (`x-api-key` header) with admin privileges  **Usage:** Verify your S3 configuration is working correctly. The test will: 1. Connect to the endpoint 2. Verify bucket access 3. Check write permissions by uploading a small test file  **Prerequisite:** S3 must be configured first using `POST /v1/integrations/s3`  **No credits consumed:** This is a diagnostic endpoint.
+  # @param [Hash] opts the optional parameters
+  # @return [S3TestResponse]
+  describe 'test_s3_connection 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/pdf_api_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#TemplateFox API
+
+#Generate PDFs from HTML templates via API. Design once, generate thousands.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for TemplateFox::PDFApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PDFApi' do
+  before do
+    # run before each test
+    @api_instance = TemplateFox::PDFApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PDFApi' do
+    it 'should create an instance of PDFApi' do
+      expect(@api_instance).to be_instance_of(TemplateFox::PDFApi)
+    end
+  end
+
+  # unit tests for create_pdf
+  # Generate PDF from template
+  # Generate a PDF from a saved template with dynamic data.  **Authentication:** API Key required (`x-api-key` header)  ## Request Body  | Field | Type | Required | Description | |-------|------|----------|-------------| | `template_id` | string | ✅ Yes | Template short ID (12 characters) | | `data` | object | ✅ Yes | Key-value data to render in template | | `export_type` | string | No | `url` (default) or `binary` | | `expiration` | integer | No | URL expiration in seconds (60-604800, default: 86400) |  ## Export Types - `url` (default): PDF is uploaded to CDN, returns JSON with URL - `binary`: Returns raw PDF bytes directly  **Credits:** 1 credit deducted per successful generation.
+  # @param create_pdf_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CreatePdfResponse]
+  describe 'create_pdf 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/templates_api_spec.rb

@@ -0,0 +1,58 @@
+=begin
+#TemplateFox API
+
+#Generate PDFs from HTML templates via API. Design once, generate thousands.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for TemplateFox::TemplatesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TemplatesApi' do
+  before do
+    # run before each test
+    @api_instance = TemplateFox::TemplatesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TemplatesApi' do
+    it 'should create an instance of TemplatesApi' do
+      expect(@api_instance).to be_instance_of(TemplateFox::TemplatesApi)
+    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 Zapier Dynamic Fields integration. It returns an array of field definitions that Zapier uses to dynamically generate input forms.  **Response format:** Array of objects compatible with Zapier InputFieldsSchema. Each field has: `key`, `label`, `type`, `required`, and optional `helpText`.  **Field types:** - `string`: Text input (also used for JSON arrays/objects) - `integer`: Integer number - `number`: Decimal number - `boolean`: True/False checkbox  **Arrays and objects:** Complex types are returned as `string` type with a `helpText` showing the expected JSON format.  **No credits consumed:** This is a read-only endpoint.
+  # @param template_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<TemplateField>]
+  describe 'get_template_fields 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.
+  # @param [Hash] opts the optional parameters
+  # @return [TemplatesListResponse]
+  describe 'list_templates 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

@@ -0,0 +1,42 @@
+=begin
+#TemplateFox API
+
+#Generate PDFs from HTML templates via API. Design once, generate thousands.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for TemplateFox::AccountInfoResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe TemplateFox::AccountInfoResponse do
+  #let(:instance) { TemplateFox::AccountInfoResponse.new }
+
+  describe 'test an instance of AccountInfoResponse' do
+    it 'should create an instance of AccountInfoResponse' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(TemplateFox::AccountInfoResponse)
+    end
+  end
+
+  describe 'test attribute "credits"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "email"' 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/create_pdf_request_spec.rb

@@ -0,0 +1,78 @@
+=begin
+#TemplateFox API
+
+#Generate PDFs from HTML templates via API. Design once, generate thousands.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for TemplateFox::CreatePdfRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe TemplateFox::CreatePdfRequest do
+  #let(:instance) { TemplateFox::CreatePdfRequest.new }
+
+  describe 'test an instance of CreatePdfRequest' do
+    it 'should create an instance of CreatePdfRequest' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(TemplateFox::CreatePdfRequest)
+    end
+  end
+
+  describe 'test attribute "template_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "data"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "export_type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "expiration"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "filename"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "store_s3"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "s3_filepath"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "s3_bucket"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end