RubyGems - templatefox - Versions diffs - 1.0.0 → 1.0.1 - Mend

templatefox 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (25) hide show

checksums.yaml +4 -4
data/lib/templatefox/version.rb +1 -1
data/templatefox.gemspec +7 -2
metadata +29 -46
data/docs/AccountApi.md +0 -152
data/docs/AccountInfoResponse.md +0 -20
data/docs/CreatePdfRequest.md +0 -32
data/docs/CreatePdfResponse.md +0 -24
data/docs/ExportType.md +0 -15
data/docs/HTTPValidationError.md +0 -18
data/docs/IntegrationsApi.md +0 -286
data/docs/LocationInner.md +0 -15
data/docs/PDFApi.md +0 -79
data/docs/S3ConfigRequest.md +0 -26
data/docs/S3ConfigResponse.md +0 -28
data/docs/S3SuccessResponse.md +0 -18
data/docs/S3TestResponse.md +0 -20
data/docs/TemplateField.md +0 -26
data/docs/TemplateListItem.md +0 -24
data/docs/TemplatesApi.md +0 -148
data/docs/TemplatesListResponse.md +0 -18
data/docs/Transaction.md +0 -28
data/docs/TransactionsResponse.md +0 -24
data/docs/ValidationError.md +0 -22
data/git_push.sh +0 -57

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f13c971118753912fec80249e281bd9626bdd7def6aed8262ac20dc9d5743898
-  data.tar.gz: a8517386bda455fcab289a7c3a5c26ade53957f9023488da5a31092afb558aeb
+  metadata.gz: fff8ad4c1d9086b53e3642668c5121f43b026b6decbaa58ddd0698bc71318227
+  data.tar.gz: 2f6f35486b49c29a44a641f6c8293e808a1ce73bad704480c20a724dd7f62084
 SHA512:
-  metadata.gz: 5dbf4e06a398eb74463480ef86c7e67849656da385d6cc56fe277f1008617a03eaca736831794cbce96fabf316cc7e3ef402049f92068acf5eb3906809fd3db5
-  data.tar.gz: 77205cb17f8d2e5fcbd07ece7eff9d4cbe3d8f81a4db72f68f62c5ea2d512ce9bc85dd0f7bac62d3b7afee4d62fb78e44d6952f8d81fb4691c6ef2416145ed6a
+  metadata.gz: c2be2b40850b1398c3d279554fcd3cf10196bb42ff551414d010d2afd982c0d6721ce094b72bd5e7ae4d554e1d962c607f29bf8bd5df5c9b171acf4763ef838f
+  data.tar.gz: b2f78c4dff74f6316d0cee0487a825c27c6fdfb44763017d8c06465a0733423e6beda86a4a7b4a29e8e4ffe84ee93fe24ddf00d5a02ab282dea391bf73ab8925

data/lib/templatefox/version.rb CHANGED Viewed

@@ -11,5 +11,5 @@ Generator version: 7.19.0
 =end
 module TemplateFox
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/templatefox.gemspec CHANGED Viewed

@@ -21,12 +21,17 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["TemplateFox"]
   s.email       = ["support@pdftemplateapi.com"]
-  s.homepage    = "https://github.com/TemplateFoxPDF/rubysdk"
+  s.homepage    = "https://pdftemplateapi.com"
   s.summary     = "Official TemplateFox Ruby SDK"
   s.description = "Ruby SDK for TemplateFox - Generate PDFs from HTML templates via API"
   s.license     = "MIT"
   s.required_ruby_version = ">= 2.7"
-  s.metadata    = {}
+  s.metadata    = {
+    "source_code_uri"   => "https://github.com/TemplateFoxPDF/rubysdk",
+    "bug_tracker_uri"   => "https://github.com/TemplateFoxPDF/rubysdk/issues",
+    "documentation_uri" => "https://pdftemplateapi.com/docs",
+    "homepage_uri"      => "https://pdftemplateapi.com"
+  }
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'

metadata CHANGED Viewed

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: templatefox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - TemplateFox
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2026-02-05 00:00:00.000000000 Z
@@ -34,22 +34,22 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
 description: Ruby SDK for TemplateFox - Generate PDFs from HTML templates via API
 email:
 - support@pdftemplateapi.com
@@ -61,27 +61,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- docs/AccountApi.md
-- docs/AccountInfoResponse.md
-- docs/CreatePdfRequest.md
-- docs/CreatePdfResponse.md
-- docs/ExportType.md
-- docs/HTTPValidationError.md
-- docs/IntegrationsApi.md
-- docs/LocationInner.md
-- docs/PDFApi.md
-- docs/S3ConfigRequest.md
-- docs/S3ConfigResponse.md
-- docs/S3SuccessResponse.md
-- docs/S3TestResponse.md
-- docs/TemplateField.md
-- docs/TemplateListItem.md
-- docs/TemplatesApi.md
-- docs/TemplatesListResponse.md
-- docs/Transaction.md
-- docs/TransactionsResponse.md
-- docs/ValidationError.md
-- git_push.sh
 - lib/templatefox.rb
 - lib/templatefox/api/account_api.rb
 - lib/templatefox/api/integrations_api.rb
@@ -130,11 +109,15 @@ files:
 - spec/models/validation_error_spec.rb
 - spec/spec_helper.rb
 - templatefox.gemspec
-homepage: https://github.com/TemplateFoxPDF/rubysdk
+homepage: https://pdftemplateapi.com
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  source_code_uri: https://github.com/TemplateFoxPDF/rubysdk
+  bug_tracker_uri: https://github.com/TemplateFoxPDF/rubysdk/issues
+  documentation_uri: https://pdftemplateapi.com/docs
+  homepage_uri: https://pdftemplateapi.com
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,29 +132,29 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key:
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Official TemplateFox Ruby SDK
 test_files:
+- spec/api/templates_api_spec.rb
 - spec/api/integrations_api_spec.rb
 - spec/api/account_api_spec.rb
 - spec/api/pdf_api_spec.rb
-- spec/api/templates_api_spec.rb
-- spec/models/export_type_spec.rb
-- spec/models/s3_test_response_spec.rb
-- spec/models/template_list_item_spec.rb
-- spec/models/validation_error_spec.rb
-- spec/models/s3_config_response_spec.rb
-- spec/models/create_pdf_request_spec.rb
-- spec/models/transaction_spec.rb
 - spec/models/location_inner_spec.rb
-- spec/models/http_validation_error_spec.rb
 - spec/models/account_info_response_spec.rb
+- spec/models/template_list_item_spec.rb
+- spec/models/http_validation_error_spec.rb
+- spec/models/export_type_spec.rb
 - spec/models/create_pdf_response_spec.rb
-- spec/models/templates_list_response_spec.rb
-- spec/models/template_field_spec.rb
+- spec/models/validation_error_spec.rb
+- spec/models/s3_config_request_spec.rb
+- spec/models/s3_test_response_spec.rb
 - spec/models/s3_success_response_spec.rb
+- spec/models/templates_list_response_spec.rb
 - spec/models/transactions_response_spec.rb
-- spec/models/s3_config_request_spec.rb
+- spec/models/template_field_spec.rb
+- spec/models/s3_config_response_spec.rb
+- spec/models/create_pdf_request_spec.rb
+- spec/models/transaction_spec.rb
 - spec/spec_helper.rb

data/docs/AccountApi.md DELETED Viewed

@@ -1,152 +0,0 @@
-# TemplateFox::AccountApi
-All URIs are relative to *https://api.pdftemplateapi.com*
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_account**](AccountApi.md#get_account) | **GET** /v1/account | Get account info |
-| [**list_transactions**](AccountApi.md#list_transactions) | **GET** /v1/account/transactions | List transactions |
-## get_account
-> <AccountInfoResponse> 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.
-### 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::AccountApi.new
-begin
-  # Get account info
-  result = api_instance.get_account
-  p result
-rescue TemplateFox::ApiError => e
-  puts "Error when calling AccountApi->get_account: #{e}"
-end
-```
-#### Using the get_account_with_http_info variant
-This returns an Array which contains the response data, status code and headers.
-> <Array(<AccountInfoResponse>, Integer, Hash)> get_account_with_http_info
-```ruby
-begin
-  # Get account info
-  data, status_code, headers = api_instance.get_account_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <AccountInfoResponse>
-rescue TemplateFox::ApiError => e
-  puts "Error when calling AccountApi->get_account_with_http_info: #{e}"
-end
-```
-### Parameters
-This endpoint does not need any parameter.
-### Return type
-[**AccountInfoResponse**](AccountInfoResponse.md)
-### Authorization
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## list_transactions
-> <TransactionsResponse> list_transactions(opts)
-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.
-### 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::AccountApi.new
-opts = {
-  limit: 56, # Integer | Number of records to return
-  offset: 56 # Integer | Number of records to skip
-}
-begin
-  # List transactions
-  result = api_instance.list_transactions(opts)
-  p result
-rescue TemplateFox::ApiError => e
-  puts "Error when calling AccountApi->list_transactions: #{e}"
-end
-```
-#### Using the list_transactions_with_http_info variant
-This returns an Array which contains the response data, status code and headers.
-> <Array(<TransactionsResponse>, Integer, Hash)> list_transactions_with_http_info(opts)
-```ruby
-begin
-  # List transactions
-  data, status_code, headers = api_instance.list_transactions_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <TransactionsResponse>
-rescue TemplateFox::ApiError => e
-  puts "Error when calling AccountApi->list_transactions_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **limit** | **Integer** | Number of records to return | [optional][default to 300] |
-| **offset** | **Integer** | Number of records to skip | [optional][default to 0] |
-### Return type
-[**TransactionsResponse**](TransactionsResponse.md)
-### Authorization
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json

data/docs/AccountInfoResponse.md DELETED Viewed

@@ -1,20 +0,0 @@
-# TemplateFox::AccountInfoResponse
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **credits** | **Integer** | Remaining credits |  |
-| **email** | **String** |  | [optional] |
-## Example
-```ruby
-require 'templatefox'
-instance = TemplateFox::AccountInfoResponse.new(
-  credits: null,
-  email: null
-)
-```

data/docs/CreatePdfRequest.md DELETED Viewed

@@ -1,32 +0,0 @@
-# TemplateFox::CreatePdfRequest
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **template_id** | **String** | **Required.** Template short ID (12 characters) |  |
-| **data** | **Hash&lt;String, Object&gt;** | **Required.** Key-value data to render in the template. Keys must match template variables. |  |
-| **export_type** | [**ExportType**](ExportType.md) | Export format: &#x60;url&#x60; uploads to CDN and returns URL, &#x60;binary&#x60; returns raw PDF bytes | [optional] |
-| **expiration** | **Integer** | URL expiration in seconds. Min: 60 (1 min), Max: 604800 (7 days). Only applies to &#x60;url&#x60; export type. | [optional][default to 86400] |
-| **filename** | **String** |  | [optional] |
-| **store_s3** | **Boolean** | Upload to your configured S3 bucket instead of CDN | [optional][default to false] |
-| **s3_filepath** | **String** |  | [optional] |
-| **s3_bucket** | **String** |  | [optional] |
-## Example
-```ruby
-require 'templatefox'
-instance = TemplateFox::CreatePdfRequest.new(
-  template_id: null,
-  data: null,
-  export_type: null,
-  expiration: null,
-  filename: null,
-  store_s3: null,
-  s3_filepath: null,
-  s3_bucket: null
-)
-```

data/docs/CreatePdfResponse.md DELETED Viewed

@@ -1,24 +0,0 @@
-# TemplateFox::CreatePdfResponse
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **url** | **String** | Signed URL to download the PDF (expires after specified time) |  |
-| **filename** | **String** | Filename of the generated PDF |  |
-| **credits_remaining** | **Integer** | Remaining credits after this request |  |
-| **expires_in** | **Integer** | Seconds until URL expires |  |
-## Example
-```ruby
-require 'templatefox'
-instance = TemplateFox::CreatePdfResponse.new(
-  url: null,
-  filename: null,
-  credits_remaining: null,
-  expires_in: null
-)
-```

data/docs/ExportType.md DELETED Viewed

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

data/docs/HTTPValidationError.md DELETED Viewed

@@ -1,18 +0,0 @@
-# TemplateFox::HTTPValidationError
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **detail** | [**Array&lt;ValidationError&gt;**](ValidationError.md) |  | [optional] |
-## Example
-```ruby
-require 'templatefox'
-instance = TemplateFox::HTTPValidationError.new(
-  detail: null
-)
-```

data/docs/IntegrationsApi.md DELETED Viewed

@@ -1,286 +0,0 @@
-# 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 DELETED Viewed

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

data/docs/PDFApi.md DELETED Viewed

@@ -1,79 +0,0 @@
-# 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 DELETED Viewed

@@ -1,26 +0,0 @@
-# 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 &#39;&#39;] |
-## 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 DELETED Viewed

@@ -1,28 +0,0 @@
-# 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 DELETED Viewed

@@ -1,18 +0,0 @@
-# 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 DELETED Viewed

@@ -1,20 +0,0 @@
-# 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 DELETED Viewed

@@ -1,26 +0,0 @@
-# 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 &#39;string&#39;] |
-| **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 DELETED Viewed

@@ -1,24 +0,0 @@
-# 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 DELETED Viewed

@@ -1,148 +0,0 @@
-# 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 DELETED Viewed

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

data/docs/Transaction.md DELETED Viewed

@@ -1,28 +0,0 @@
-# TemplateFox::Transaction
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **transaction_ref** | **String** | Unique transaction reference (UUID) |  |
-| **transaction_type** | **String** | Transaction type: PDFGEN, PURCHASE, REFUND, BONUS |  |
-| **template_id** | **String** |  | [optional] |
-| **exec_tm** | **Integer** |  | [optional] |
-| **credits** | **Integer** | Credits consumed (positive) or added (negative) |  |
-| **created_at** | **String** | ISO 8601 timestamp |  |
-## Example
-```ruby
-require 'templatefox'
-instance = TemplateFox::Transaction.new(
-  transaction_ref: null,
-  transaction_type: null,
-  template_id: null,
-  exec_tm: null,
-  credits: null,
-  created_at: null
-)
-```

data/docs/TransactionsResponse.md DELETED Viewed

@@ -1,24 +0,0 @@
-# TemplateFox::TransactionsResponse
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **transactions** | [**Array&lt;Transaction&gt;**](Transaction.md) |  |  |
-| **total** | **Integer** | Total number of transactions |  |
-| **limit** | **Integer** | Number of records returned |  |
-| **offset** | **Integer** | Number of records skipped |  |
-## Example
-```ruby
-require 'templatefox'
-instance = TemplateFox::TransactionsResponse.new(
-  transactions: null,
-  total: null,
-  limit: null,
-  offset: null
-)
-```

data/docs/ValidationError.md DELETED Viewed

@@ -1,22 +0,0 @@
-# TemplateFox::ValidationError
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **loc** | [**Array&lt;LocationInner&gt;**](LocationInner.md) |  |  |
-| **msg** | **String** |  |  |
-| **type** | **String** |  |  |
-## Example
-```ruby
-require 'templatefox'
-instance = TemplateFox::ValidationError.new(
-  loc: null,
-  msg: null,
-  type: null
-)
-```

data/git_push.sh DELETED Viewed

@@ -1,57 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-git_host=$4
-if [ "$git_host" = "" ]; then
-    git_host="github.com"
-    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
-fi
-if [ "$git_user_id" = "" ]; then
-    git_user_id="TemplateFoxPDF"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="rubysdk"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-# Initialize the local directory as a Git repository
-git init
-# Adds the files in the local repository and stages them for commit.
-git add .
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
-    fi
-fi
-git pull origin master
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'