templatefox 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f13c971118753912fec80249e281bd9626bdd7def6aed8262ac20dc9d5743898
+  data.tar.gz: a8517386bda455fcab289a7c3a5c26ade53957f9023488da5a31092afb558aeb
+SHA512:
+  metadata.gz: 5dbf4e06a398eb74463480ef86c7e67849656da385d6cc56fe277f1008617a03eaca736831794cbce96fabf316cc7e3ef402049f92068acf5eb3906809fd3db5
+  data.tar.gz: 77205cb17f8d2e5fcbd07ece7eff9d4cbe3d8f81a4db72f68f62c5ea2d512ce9bc85dd0f7bac62d3b7afee4d62fb78e44d6952f8d81fb4691c6ef2416145ed6a

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 TemplateFox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,206 @@
+# TemplateFox Ruby SDK
+
+Official Ruby SDK for [TemplateFox](https://pdftemplateapi.com) - Generate PDFs from HTML templates via API.
+
+[![Gem Version](https://badge.fury.io/rb/templatefox.svg)](https://rubygems.org/gems/templatefox)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'templatefox'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install templatefox
+```
+
+## Quick Start
+
+```ruby
+require 'templatefox'
+
+# Initialize the client
+TemplateFox.configure do |config|
+  config.api_key['ApiKeyAuth'] = 'your-api-key'
+end
+
+api = TemplateFox::PDFApi.new
+
+# Generate a PDF
+request = TemplateFox::CreatePdfRequest.new(
+  template_id: 'YOUR_TEMPLATE_ID',
+  data: {
+    name: 'John Doe',
+    invoice_number: 'INV-001',
+    total_amount: 150.00
+  }
+)
+
+begin
+  response = api.create_pdf(request)
+  puts "PDF URL: #{response.url}"
+  puts "Credits remaining: #{response.credits_remaining}"
+rescue TemplateFox::ApiError => e
+  puts "Error: #{e.message}"
+end
+```
+
+## Features
+
+- **Template-based PDF generation** - Create templates with dynamic variables, generate PDFs with your data
+- **Multiple export options** - Get a signed URL (default) or raw binary PDF
+- **S3 integration** - Upload generated PDFs directly to your own S3-compatible storage
+- **Ruby 2.7+** - Compatible with Ruby 2.7 and above
+
+## API Methods
+
+### PDF Generation
+
+```ruby
+request = TemplateFox::CreatePdfRequest.new(
+  template_id: 'TEMPLATE_ID',
+  data: { name: 'John Doe' },
+  export_type: 'url',        # 'url' or 'binary'
+  expiration: 86400,         # URL expiration in seconds
+  filename: 'invoice-001'    # Custom filename
+)
+
+response = api.create_pdf(request)
+```
+
+### Templates
+
+```ruby
+templates_api = TemplateFox::TemplatesApi.new
+
+# List all templates
+templates = templates_api.list_templates
+templates.templates.each do |template|
+  puts "#{template.id}: #{template.name}"
+end
+
+# Get template fields
+fields = templates_api.get_template_fields('TEMPLATE_ID')
+fields.each do |field|
+  puts "#{field.key}: #{field.type} (required: #{field.required})"
+end
+```
+
+### Account
+
+```ruby
+account_api = TemplateFox::AccountApi.new
+
+# Get account info
+account = account_api.get_account
+puts "Credits: #{account.credits}"
+puts "Email: #{account.email}"
+
+# List transactions
+transactions = account_api.list_transactions(limit: 100, offset: 0)
+transactions.transactions.each do |tx|
+  puts "#{tx.transaction_type}: #{tx.credits} credits"
+end
+```
+
+### S3 Integration
+
+```ruby
+integrations_api = TemplateFox::IntegrationsApi.new
+
+# Save S3 configuration
+s3_config = TemplateFox::S3ConfigRequest.new(
+  endpoint_url: 'https://s3.amazonaws.com',
+  access_key_id: 'AKIAIOSFODNN7EXAMPLE',
+  secret_access_key: 'your-secret-key',
+  bucket_name: 'my-pdf-bucket',
+  default_prefix: 'generated/pdfs/'
+)
+
+integrations_api.save_s3_config(s3_config)
+
+# Test connection
+test = integrations_api.test_s3_connection
+puts "Connection: #{test.success ? 'OK' : 'Failed'}"
+```
+
+## Configuration
+
+```ruby
+TemplateFox.configure do |config|
+  config.host = 'https://api.pdftemplateapi.com'  # Default API URL
+  config.api_key['ApiKeyAuth'] = ENV['TEMPLATEFOX_API_KEY']
+
+  # Optional: Enable debugging
+  config.debugging = true
+end
+```
+
+## Error Handling
+
+```ruby
+begin
+  response = api.create_pdf(request)
+rescue TemplateFox::ApiError => e
+  case e.code
+  when 402
+    puts 'Insufficient credits'
+  when 403
+    puts 'Access denied - check your API key'
+  when 404
+    puts 'Template not found'
+  else
+    puts "Error: #{e.message}"
+  end
+end
+```
+
+## Rails Integration
+
+```ruby
+# config/initializers/templatefox.rb
+TemplateFox.configure do |config|
+  config.api_key['ApiKeyAuth'] = Rails.application.credentials.templatefox_api_key
+end
+
+# app/services/pdf_generator.rb
+class PdfGenerator
+  def initialize
+    @api = TemplateFox::PDFApi.new
+  end
+
+  def generate_invoice(invoice)
+    request = TemplateFox::CreatePdfRequest.new(
+      template_id: ENV['INVOICE_TEMPLATE_ID'],
+      data: invoice.to_template_data
+    )
+    @api.create_pdf(request)
+  end
+end
+```
+
+## Documentation
+
+- [API Documentation](https://pdftemplateapi.com/docs)
+- [Swagger UI](https://api.pdftemplateapi.com/docs)
+- [Dashboard](https://pdftemplateapi.com/dashboard)
+
+## Support
+
+- Email: support@pdftemplateapi.com
+- Issues: [GitHub Issues](https://github.com/TemplateFoxPDF/rubysdk/issues)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AccountApi.md

@@ -0,0 +1,152 @@
+# 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

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

@@ -0,0 +1,32 @@
+# 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

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

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

data/docs/HTTPValidationError.md

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