templatefox 1.0.0

data/docs/IntegrationsApi.md

@@ -0,0 +1,286 @@
+# TemplateFox::IntegrationsApi
+
+All URIs are relative to *https://api.pdftemplateapi.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_s3_config**](IntegrationsApi.md#delete_s3_config) | **DELETE** /v1/integrations/s3 | Delete S3 configuration |
+| [**get_s3_config**](IntegrationsApi.md#get_s3_config) | **GET** /v1/integrations/s3 | Get S3 configuration |
+| [**save_s3_config**](IntegrationsApi.md#save_s3_config) | **POST** /v1/integrations/s3 | Save S3 configuration |
+| [**test_s3_connection**](IntegrationsApi.md#test_s3_connection) | **POST** /v1/integrations/s3/test | Test S3 connection |
+
+
+## delete_s3_config
+
+> <S3SuccessResponse> 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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'templatefox'
+# setup authorization
+TemplateFox.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = TemplateFox::IntegrationsApi.new
+
+begin
+  # Delete S3 configuration
+  result = api_instance.delete_s3_config
+  p result
+rescue TemplateFox::ApiError => e
+  puts "Error when calling IntegrationsApi->delete_s3_config: #{e}"
+end
+```
+
+#### Using the delete_s3_config_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<S3SuccessResponse>, Integer, Hash)> delete_s3_config_with_http_info
+
+```ruby
+begin
+  # Delete S3 configuration
+  data, status_code, headers = api_instance.delete_s3_config_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <S3SuccessResponse>
+rescue TemplateFox::ApiError => e
+  puts "Error when calling IntegrationsApi->delete_s3_config_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**S3SuccessResponse**](S3SuccessResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_s3_config
+
+> <S3ConfigResponse> 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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'templatefox'
+# setup authorization
+TemplateFox.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = TemplateFox::IntegrationsApi.new
+
+begin
+  # Get S3 configuration
+  result = api_instance.get_s3_config
+  p result
+rescue TemplateFox::ApiError => e
+  puts "Error when calling IntegrationsApi->get_s3_config: #{e}"
+end
+```
+
+#### Using the get_s3_config_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<S3ConfigResponse>, Integer, Hash)> get_s3_config_with_http_info
+
+```ruby
+begin
+  # Get S3 configuration
+  data, status_code, headers = api_instance.get_s3_config_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <S3ConfigResponse>
+rescue TemplateFox::ApiError => e
+  puts "Error when calling IntegrationsApi->get_s3_config_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**S3ConfigResponse**](S3ConfigResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## save_s3_config
+
+> <S3SuccessResponse> save_s3_config(s3_config_request)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'templatefox'
+# setup authorization
+TemplateFox.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = TemplateFox::IntegrationsApi.new
+s3_config_request = TemplateFox::S3ConfigRequest.new({endpoint_url: 'endpoint_url_example', access_key_id: 'access_key_id_example', bucket_name: 'bucket_name_example'}) # S3ConfigRequest | 
+
+begin
+  # Save S3 configuration
+  result = api_instance.save_s3_config(s3_config_request)
+  p result
+rescue TemplateFox::ApiError => e
+  puts "Error when calling IntegrationsApi->save_s3_config: #{e}"
+end
+```
+
+#### Using the save_s3_config_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<S3SuccessResponse>, Integer, Hash)> save_s3_config_with_http_info(s3_config_request)
+
+```ruby
+begin
+  # Save S3 configuration
+  data, status_code, headers = api_instance.save_s3_config_with_http_info(s3_config_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <S3SuccessResponse>
+rescue TemplateFox::ApiError => e
+  puts "Error when calling IntegrationsApi->save_s3_config_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **s3_config_request** | [**S3ConfigRequest**](S3ConfigRequest.md) |  |  |
+
+### Return type
+
+[**S3SuccessResponse**](S3SuccessResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## test_s3_connection
+
+> <S3TestResponse> 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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'templatefox'
+# setup authorization
+TemplateFox.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = TemplateFox::IntegrationsApi.new
+
+begin
+  # Test S3 connection
+  result = api_instance.test_s3_connection
+  p result
+rescue TemplateFox::ApiError => e
+  puts "Error when calling IntegrationsApi->test_s3_connection: #{e}"
+end
+```
+
+#### Using the test_s3_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<S3TestResponse>, Integer, Hash)> test_s3_connection_with_http_info
+
+```ruby
+begin
+  # Test S3 connection
+  data, status_code, headers = api_instance.test_s3_connection_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <S3TestResponse>
+rescue TemplateFox::ApiError => e
+  puts "Error when calling IntegrationsApi->test_s3_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**S3TestResponse**](S3TestResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/LocationInner.md

@@ -0,0 +1,15 @@
+# TemplateFox::LocationInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'templatefox'
+
+instance = TemplateFox::LocationInner.new()
+```
+

data/docs/PDFApi.md

@@ -0,0 +1,79 @@
+# TemplateFox::PDFApi
+
+All URIs are relative to *https://api.pdftemplateapi.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_pdf**](PDFApi.md#create_pdf) | **POST** /v1/pdf/create | Generate PDF from template |
+
+
+## create_pdf
+
+> <CreatePdfResponse> create_pdf(create_pdf_request)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'templatefox'
+# setup authorization
+TemplateFox.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = TemplateFox::PDFApi.new
+create_pdf_request = TemplateFox::CreatePdfRequest.new({template_id: 'template_id_example', data: { key: 3.56}}) # CreatePdfRequest | 
+
+begin
+  # Generate PDF from template
+  result = api_instance.create_pdf(create_pdf_request)
+  p result
+rescue TemplateFox::ApiError => e
+  puts "Error when calling PDFApi->create_pdf: #{e}"
+end
+```
+
+#### Using the create_pdf_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreatePdfResponse>, Integer, Hash)> create_pdf_with_http_info(create_pdf_request)
+
+```ruby
+begin
+  # Generate PDF from template
+  data, status_code, headers = api_instance.create_pdf_with_http_info(create_pdf_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreatePdfResponse>
+rescue TemplateFox::ApiError => e
+  puts "Error when calling PDFApi->create_pdf_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_pdf_request** | [**CreatePdfRequest**](CreatePdfRequest.md) |  |  |
+
+### Return type
+
+[**CreatePdfResponse**](CreatePdfResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/pdf
+

data/docs/S3ConfigRequest.md

@@ -0,0 +1,26 @@
+# TemplateFox::S3ConfigRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **endpoint_url** | **String** | S3-compatible endpoint URL. Must start with https:// |  |
+| **access_key_id** | **String** | Access key ID for S3 authentication |  |
+| **secret_access_key** | **String** |  | [optional] |
+| **bucket_name** | **String** | S3 bucket name. Must follow S3 naming conventions (lowercase, no underscores) |  |
+| **default_prefix** | **String** | Default path prefix for uploaded files. Can include slashes for folder structure | [optional][default to ''] |
+
+## Example
+
+```ruby
+require 'templatefox'
+
+instance = TemplateFox::S3ConfigRequest.new(
+  endpoint_url: null,
+  access_key_id: null,
+  secret_access_key: null,
+  bucket_name: null,
+  default_prefix: null
+)
+```
+

data/docs/S3ConfigResponse.md

@@ -0,0 +1,28 @@
+# TemplateFox::S3ConfigResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **configured** | **Boolean** | Whether S3 is configured |  |
+| **endpoint_url** | **String** | S3-compatible endpoint URL |  |
+| **access_key_id** | **String** | Access key ID |  |
+| **secret_access_key_masked** | **String** | Masked secret access key (shows first 4 and last 4 characters) |  |
+| **bucket_name** | **String** | S3 bucket name |  |
+| **default_prefix** | **String** | Default path prefix for uploads |  |
+
+## Example
+
+```ruby
+require 'templatefox'
+
+instance = TemplateFox::S3ConfigResponse.new(
+  configured: null,
+  endpoint_url: null,
+  access_key_id: null,
+  secret_access_key_masked: null,
+  bucket_name: null,
+  default_prefix: null
+)
+```
+

data/docs/S3SuccessResponse.md

@@ -0,0 +1,18 @@
+# TemplateFox::S3SuccessResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Whether the operation succeeded |  |
+
+## Example
+
+```ruby
+require 'templatefox'
+
+instance = TemplateFox::S3SuccessResponse.new(
+  success: null
+)
+```
+

data/docs/S3TestResponse.md

@@ -0,0 +1,20 @@
+# TemplateFox::S3TestResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Whether the connection test succeeded |  |
+| **message** | **String** | Test result message |  |
+
+## Example
+
+```ruby
+require 'templatefox'
+
+instance = TemplateFox::S3TestResponse.new(
+  success: null,
+  message: null
+)
+```
+

data/docs/TemplateField.md

@@ -0,0 +1,26 @@
+# TemplateFox::TemplateField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | Field key/identifier |  |
+| **label** | **String** | Human-readable label |  |
+| **type** | **String** | Field type: string, integer, number, boolean | [optional][default to 'string'] |
+| **required** | **Boolean** | Whether the field is required | [optional][default to false] |
+| **help_text** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'templatefox'
+
+instance = TemplateFox::TemplateField.new(
+  key: null,
+  label: null,
+  type: null,
+  required: null,
+  help_text: null
+)
+```
+

data/docs/TemplateListItem.md

@@ -0,0 +1,24 @@
+# TemplateFox::TemplateListItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Template short ID (12 characters) |  |
+| **name** | **String** | Template name |  |
+| **created_at** | **String** | ISO 8601 timestamp |  |
+| **updated_at** | **String** | ISO 8601 timestamp |  |
+
+## Example
+
+```ruby
+require 'templatefox'
+
+instance = TemplateFox::TemplateListItem.new(
+  id: null,
+  name: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/TemplatesApi.md

@@ -0,0 +1,148 @@
+# TemplateFox::TemplatesApi
+
+All URIs are relative to *https://api.pdftemplateapi.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_template_fields**](TemplatesApi.md#get_template_fields) | **GET** /v1/templates/{template_id}/fields | Get template fields |
+| [**list_templates**](TemplatesApi.md#list_templates) | **GET** /v1/templates | List templates |
+
+
+## get_template_fields
+
+> <Array<TemplateField>> get_template_fields(template_id)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'templatefox'
+# setup authorization
+TemplateFox.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = TemplateFox::TemplatesApi.new
+template_id = 'template_id_example' # String | 
+
+begin
+  # Get template fields
+  result = api_instance.get_template_fields(template_id)
+  p result
+rescue TemplateFox::ApiError => e
+  puts "Error when calling TemplatesApi->get_template_fields: #{e}"
+end
+```
+
+#### Using the get_template_fields_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<TemplateField>>, Integer, Hash)> get_template_fields_with_http_info(template_id)
+
+```ruby
+begin
+  # Get template fields
+  data, status_code, headers = api_instance.get_template_fields_with_http_info(template_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<TemplateField>>
+rescue TemplateFox::ApiError => e
+  puts "Error when calling TemplatesApi->get_template_fields_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;TemplateField&gt;**](TemplateField.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_templates
+
+> <TemplatesListResponse> list_templates
+
+List templates
+
+List all templates for the authenticated user.  **Authentication:** API Key required (`x-api-key` header) or JWT token  **Usage:** This endpoint is designed for no-code tools (Zapier, Make, n8n) to populate template selection dropdowns.  **No credits consumed:** This is a read-only endpoint.
+
+### Examples
+
+```ruby
+require 'time'
+require 'templatefox'
+# setup authorization
+TemplateFox.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = TemplateFox::TemplatesApi.new
+
+begin
+  # List templates
+  result = api_instance.list_templates
+  p result
+rescue TemplateFox::ApiError => e
+  puts "Error when calling TemplatesApi->list_templates: #{e}"
+end
+```
+
+#### Using the list_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TemplatesListResponse>, Integer, Hash)> list_templates_with_http_info
+
+```ruby
+begin
+  # List templates
+  data, status_code, headers = api_instance.list_templates_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TemplatesListResponse>
+rescue TemplateFox::ApiError => e
+  puts "Error when calling TemplatesApi->list_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**TemplatesListResponse**](TemplatesListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TemplatesListResponse.md

@@ -0,0 +1,18 @@
+# TemplateFox::TemplatesListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **templates** | [**Array<TemplateListItem>**](TemplateListItem.md) |  |  |
+
+## Example
+
+```ruby
+require 'templatefox'
+
+instance = TemplateFox::TemplatesListResponse.new(
+  templates: null
+)
+```
+