templatefox 1.0.0 → 1.6.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: templatefox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.6.0
 platform: ruby
 authors:
 - TemplateFox
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-05 00:00:00.000000000 Z
+date: 2026-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -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,47 +61,34 @@ 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
 - lib/templatefox/api/pdf_api.rb
+- lib/templatefox/api/pdf_async_api.rb
 - lib/templatefox/api/templates_api.rb
 - lib/templatefox/api_client.rb
 - lib/templatefox/api_error.rb
 - lib/templatefox/api_model_base.rb
 - lib/templatefox/configuration.rb
 - lib/templatefox/models/account_info_response.rb
+- lib/templatefox/models/app_routers_v1_pdf_async_export_type.rb
+- lib/templatefox/models/app_routers_v1_pdf_export_type.rb
+- lib/templatefox/models/create_async_pdf_request.rb
+- lib/templatefox/models/create_async_pdf_response.rb
 - lib/templatefox/models/create_pdf_request.rb
 - lib/templatefox/models/create_pdf_response.rb
-- lib/templatefox/models/export_type.rb
 - lib/templatefox/models/http_validation_error.rb
+- lib/templatefox/models/job_list_response.rb
+- lib/templatefox/models/job_status.rb
+- lib/templatefox/models/job_status_response.rb
 - lib/templatefox/models/location_inner.rb
 - lib/templatefox/models/s3_config_request.rb
 - lib/templatefox/models/s3_config_response.rb
 - lib/templatefox/models/s3_success_response.rb
 - lib/templatefox/models/s3_test_response.rb
 - lib/templatefox/models/template_field.rb
+- lib/templatefox/models/template_field_spec.rb
 - lib/templatefox/models/template_list_item.rb
 - lib/templatefox/models/templates_list_response.rb
 - lib/templatefox/models/transaction.rb
@@ -111,18 +98,26 @@ files:
 - spec/api/account_api_spec.rb
 - spec/api/integrations_api_spec.rb
 - spec/api/pdf_api_spec.rb
+- spec/api/pdf_async_api_spec.rb
 - spec/api/templates_api_spec.rb
 - spec/models/account_info_response_spec.rb
+- spec/models/app_routers_v1_pdf_async_export_type_spec.rb
+- spec/models/app_routers_v1_pdf_export_type_spec.rb
+- spec/models/create_async_pdf_request_spec.rb
+- spec/models/create_async_pdf_response_spec.rb
 - spec/models/create_pdf_request_spec.rb
 - spec/models/create_pdf_response_spec.rb
-- spec/models/export_type_spec.rb
 - spec/models/http_validation_error_spec.rb
+- spec/models/job_list_response_spec.rb
+- spec/models/job_status_response_spec.rb
+- spec/models/job_status_spec.rb
 - spec/models/location_inner_spec.rb
 - spec/models/s3_config_request_spec.rb
 - spec/models/s3_config_response_spec.rb
 - spec/models/s3_success_response_spec.rb
 - spec/models/s3_test_response_spec.rb
 - spec/models/template_field_spec.rb
+- spec/models/template_field_spec_spec.rb
 - spec/models/template_list_item_spec.rb
 - spec/models/templates_list_response_spec.rb
 - spec/models/transaction_spec.rb
@@ -130,11 +125,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 +148,37 @@ 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/pdf_async_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/s3_config_request_spec.rb
+- spec/models/transactions_response_spec.rb
+- spec/models/job_status_spec.rb
+- spec/models/templates_list_response_spec.rb
+- spec/models/template_field_spec.rb
+- spec/models/job_status_response_spec.rb
+- spec/models/create_pdf_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/create_async_pdf_response_spec.rb
+- spec/models/app_routers_v1_pdf_async_export_type_spec.rb
+- spec/models/s3_test_response_spec.rb
+- spec/models/create_async_pdf_request_spec.rb
+- spec/models/job_list_response_spec.rb
+- spec/models/s3_success_response_spec.rb
 - spec/models/location_inner_spec.rb
 - spec/models/http_validation_error_spec.rb
+- spec/models/validation_error_spec.rb
+- spec/models/transaction_spec.rb
+- spec/models/app_routers_v1_pdf_export_type_spec.rb
+- spec/models/s3_config_response_spec.rb
+- spec/models/template_field_spec_spec.rb
 - spec/models/account_info_response_spec.rb
-- spec/models/create_pdf_response_spec.rb
-- spec/models/templates_list_response_spec.rb
-- spec/models/template_field_spec.rb
-- spec/models/s3_success_response_spec.rb
-- spec/models/transactions_response_spec.rb
-- spec/models/s3_config_request_spec.rb
+- spec/models/create_pdf_request_spec.rb
 - spec/spec_helper.rb

data/docs/AccountApi.md

@@ -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

@@ -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

@@ -1,32 +0,0 @@
-# TemplateFox::CreatePdfRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **template_id** | **String** | **Required.** Template short ID (12 characters) |  |
-| **data** | **Hash<String, Object>** | **Required.** Key-value data to render in the template. Keys must match template variables. |  |
-| **export_type** | [**ExportType**](ExportType.md) | Export format: `url` uploads to CDN and returns URL, `binary` returns raw PDF bytes | [optional] |
-| **expiration** | **Integer** | URL expiration in seconds. Min: 60 (1 min), Max: 604800 (7 days). Only applies to `url` 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

@@ -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

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

data/docs/HTTPValidationError.md

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