Skip to content

Commit 3b10509

Browse files
github-actions[bot]github-actions[bot]
committed
feat: update API client methods
API changes: - Update API client - Update API client - Update API client - Update API client - Update API client - ... and 6 more API files Model changes: - Update API client - Update account_info_response model - Update create_pdf_request model - Update create_pdf_response model - Update export_type model - ... and 30 more model files Generated from OpenAPI spec v1.4.0
1 parent c1000a4 commit 3b10509

50 files changed

Lines changed: 77 additions & 77 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎lib/templatefox.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
#Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
55
6-
The version of the OpenAPI document: 1.3.0
6+
The version of the OpenAPI document: 1.4.0
77
88
Generated by: https://openapi-generator.tech
99
Generator version: 7.19.0

‎lib/templatefox/api/account_api.rb‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
#Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
55
6-
The version of the OpenAPI document: 1.3.0
6+
The version of the OpenAPI document: 1.4.0
77
88
Generated by: https://openapi-generator.tech
99
Generator version: 7.19.0
@@ -20,7 +20,7 @@ def initialize(api_client = ApiClient.default)
2020
@api_client = api_client
2121
end
2222
# Get account info
23-
# 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.
23+
# 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. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
2424
# @param [Hash] opts the optional parameters
2525
# @return [AccountInfoResponse]
2626
def get_account(opts = {})
@@ -29,7 +29,7 @@ def get_account(opts = {})
2929
end
3030

3131
# Get account info
32-
# 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.
32+
# 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. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
3333
# @param [Hash] opts the optional parameters
3434
# @return [Array<(AccountInfoResponse, Integer, Hash)>] AccountInfoResponse data, response status code and response headers
3535
def get_account_with_http_info(opts = {})
@@ -77,7 +77,7 @@ def get_account_with_http_info(opts = {})
7777
end
7878

7979
# List transactions
80-
# 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.
80+
# 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. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
8181
# @param [Hash] opts the optional parameters
8282
# @option opts [Integer] :limit Number of records to return (default to 300)
8383
# @option opts [Integer] :offset Number of records to skip (default to 0)
@@ -88,7 +88,7 @@ def list_transactions(opts = {})
8888
end
8989

9090
# List transactions
91-
# List transaction history for the authenticated user. **Authentication:** API Key required (&#x60;x-api-key&#x60; header) or JWT token **Pagination:** Use &#x60;limit&#x60; and &#x60;offset&#x60; query parameters. **Transaction types:** - &#x60;PDFGEN&#x60;: PDF generation (consumes credits) - &#x60;REFUND&#x60;: Credit refund (on failed generation) - &#x60;PURCHASE&#x60;: Credit purchase - &#x60;BONUS&#x60;: Bonus credits **Credits field:** - Positive value &#x3D; credits consumed - Negative value &#x3D; credits added **No credits consumed:** This is a read-only endpoint.
91+
# List transaction history for the authenticated user. **Authentication:** API Key required (&#x60;x-api-key&#x60; header) or JWT token **Pagination:** Use &#x60;limit&#x60; and &#x60;offset&#x60; query parameters. **Transaction types:** - &#x60;PDFGEN&#x60;: PDF generation (consumes credits) - &#x60;REFUND&#x60;: Credit refund (on failed generation) - &#x60;PURCHASE&#x60;: Credit purchase - &#x60;BONUS&#x60;: Bonus credits **Credits field:** - Positive value &#x3D; credits consumed - Negative value &#x3D; credits added **No credits consumed:** This is a read-only endpoint. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
9292
# @param [Hash] opts the optional parameters
9393
# @option opts [Integer] :limit Number of records to return (default to 300)
9494
# @option opts [Integer] :offset Number of records to skip (default to 0)

‎lib/templatefox/api/integrations_api.rb‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
#Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
55
6-
The version of the OpenAPI document: 1.3.0
6+
The version of the OpenAPI document: 1.4.0
77
88
Generated by: https://openapi-generator.tech
99
Generator version: 7.19.0
@@ -20,7 +20,7 @@ def initialize(api_client = ApiClient.default)
2020
@api_client = api_client
2121
end
2222
# Delete S3 configuration
23-
# Delete S3 storage configuration. **Authentication:** API Key required (`x-api-key` header) **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.
23+
# Delete S3 storage configuration. **Authentication:** API Key required (`x-api-key` header) **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. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
2424
# @param [Hash] opts the optional parameters
2525
# @return [S3SuccessResponse]
2626
def delete_s3_config(opts = {})
@@ -29,7 +29,7 @@ def delete_s3_config(opts = {})
2929
end
3030

3131
# Delete S3 configuration
32-
# Delete S3 storage configuration. **Authentication:** API Key required (&#x60;x-api-key&#x60; header) **Usage:** Remove your S3 integration. Generated PDFs will use the default CDN storage after deletion. **Warning:** This action is irreversible. You&#39;ll need to reconfigure S3 to use it again. **No credits consumed:** This is a configuration endpoint.
32+
# Delete S3 storage configuration. **Authentication:** API Key required (&#x60;x-api-key&#x60; header) **Usage:** Remove your S3 integration. Generated PDFs will use the default CDN storage after deletion. **Warning:** This action is irreversible. You&#39;ll need to reconfigure S3 to use it again. **No credits consumed:** This is a configuration endpoint. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
3333
# @param [Hash] opts the optional parameters
3434
# @return [Array<(S3SuccessResponse, Integer, Hash)>] S3SuccessResponse data, response status code and response headers
3535
def delete_s3_config_with_http_info(opts = {})
@@ -77,7 +77,7 @@ def delete_s3_config_with_http_info(opts = {})
7777
end
7878

7979
# Get S3 configuration
80-
# Get current S3 storage configuration. **Authentication:** API Key required (`x-api-key` header) **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.
80+
# Get current S3 storage configuration. **Authentication:** API Key required (`x-api-key` header) **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. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
8181
# @param [Hash] opts the optional parameters
8282
# @return [S3ConfigResponse]
8383
def get_s3_config(opts = {})
@@ -86,7 +86,7 @@ def get_s3_config(opts = {})
8686
end
8787

8888
# Get S3 configuration
89-
# Get current S3 storage configuration. **Authentication:** API Key required (&#x60;x-api-key&#x60; header) **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.
89+
# Get current S3 storage configuration. **Authentication:** API Key required (&#x60;x-api-key&#x60; header) **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. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
9090
# @param [Hash] opts the optional parameters
9191
# @return [Array<(S3ConfigResponse, Integer, Hash)>] S3ConfigResponse data, response status code and response headers
9292
def get_s3_config_with_http_info(opts = {})
@@ -134,7 +134,7 @@ def get_s3_config_with_http_info(opts = {})
134134
end
135135

136136
# Save S3 configuration
137-
# Save or update S3-compatible storage configuration. **Authentication:** API Key required (`x-api-key` header) **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.
137+
# Save or update S3-compatible storage configuration. **Authentication:** API Key required (`x-api-key` header) **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. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
138138
# @param s3_config_request [S3ConfigRequest]
139139
# @param [Hash] opts the optional parameters
140140
# @return [S3SuccessResponse]
@@ -144,7 +144,7 @@ def save_s3_config(s3_config_request, opts = {})
144144
end
145145

146146
# Save S3 configuration
147-
# Save or update S3-compatible storage configuration. **Authentication:** API Key required (&#x60;x-api-key&#x60; header) **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: &#x60;secret_access_key&#x60; is required - For updates: Omit &#x60;secret_access_key&#x60; to keep existing value **No credits consumed:** This is a configuration endpoint.
147+
# Save or update S3-compatible storage configuration. **Authentication:** API Key required (&#x60;x-api-key&#x60; header) **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: &#x60;secret_access_key&#x60; is required - For updates: Omit &#x60;secret_access_key&#x60; to keep existing value **No credits consumed:** This is a configuration endpoint. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
148148
# @param s3_config_request [S3ConfigRequest]
149149
# @param [Hash] opts the optional parameters
150150
# @return [Array<(S3SuccessResponse, Integer, Hash)>] S3SuccessResponse data, response status code and response headers
@@ -202,7 +202,7 @@ def save_s3_config_with_http_info(s3_config_request, opts = {})
202202
end
203203

204204
# Test S3 connection
205-
# Test S3 connection with stored credentials. **Authentication:** API Key required (`x-api-key` header) **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.
205+
# Test S3 connection with stored credentials. **Authentication:** API Key required (`x-api-key` header) **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. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
206206
# @param [Hash] opts the optional parameters
207207
# @return [S3TestResponse]
208208
def test_s3_connection(opts = {})
@@ -211,7 +211,7 @@ def test_s3_connection(opts = {})
211211
end
212212

213213
# Test S3 connection
214-
# Test S3 connection with stored credentials. **Authentication:** API Key required (&#x60;x-api-key&#x60; header) **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 &#x60;POST /v1/integrations/s3&#x60; **No credits consumed:** This is a diagnostic endpoint.
214+
# Test S3 connection with stored credentials. **Authentication:** API Key required (&#x60;x-api-key&#x60; header) **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 &#x60;POST /v1/integrations/s3&#x60; **No credits consumed:** This is a diagnostic endpoint. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
215215
# @param [Hash] opts the optional parameters
216216
# @return [Array<(S3TestResponse, Integer, Hash)>] S3TestResponse data, response status code and response headers
217217
def test_s3_connection_with_http_info(opts = {})

‎lib/templatefox/api/pdf_api.rb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
#Generate beautiful PDFs from HTML/CSS templates with Jinja2 via API. Design once, generate thousands.
55
6-
The version of the OpenAPI document: 1.3.0
6+
The version of the OpenAPI document: 1.4.0
77
88
Generated by: https://openapi-generator.tech
99
Generator version: 7.19.0
@@ -20,7 +20,7 @@ def initialize(api_client = ApiClient.default)
2020
@api_client = api_client
2121
end
2222
# Generate PDF from template
23-
# 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.
23+
# 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. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
2424
# @param create_pdf_request [CreatePdfRequest]
2525
# @param [Hash] opts the optional parameters
2626
# @return [CreatePdfResponse]
@@ -30,7 +30,7 @@ def create_pdf(create_pdf_request, opts = {})
3030
end
3131

3232
# Generate PDF from template
33-
# Generate a PDF from a saved template with dynamic data. **Authentication:** API Key required (&#x60;x-api-key&#x60; header) ## Request Body | Field | Type | Required | Description | |-------|------|----------|-------------| | &#x60;template_id&#x60; | string | ✅ Yes | Template short ID (12 characters) | | &#x60;data&#x60; | object | ✅ Yes | Key-value data to render in template | | &#x60;export_type&#x60; | string | No | &#x60;url&#x60; (default) or &#x60;binary&#x60; | | &#x60;expiration&#x60; | integer | No | URL expiration in seconds (60-604800, default: 86400) | ## Export Types - &#x60;url&#x60; (default): PDF is uploaded to CDN, returns JSON with URL - &#x60;binary&#x60;: Returns raw PDF bytes directly **Credits:** 1 credit deducted per successful generation.
33+
# Generate a PDF from a saved template with dynamic data. **Authentication:** API Key required (&#x60;x-api-key&#x60; header) ## Request Body | Field | Type | Required | Description | |-------|------|----------|-------------| | &#x60;template_id&#x60; | string | ✅ Yes | Template short ID (12 characters) | | &#x60;data&#x60; | object | ✅ Yes | Key-value data to render in template | | &#x60;export_type&#x60; | string | No | &#x60;url&#x60; (default) or &#x60;binary&#x60; | | &#x60;expiration&#x60; | integer | No | URL expiration in seconds (60-604800, default: 86400) | ## Export Types - &#x60;url&#x60; (default): PDF is uploaded to CDN, returns JSON with URL - &#x60;binary&#x60;: Returns raw PDF bytes directly **Credits:** 1 credit deducted per successful generation. **Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.
3434
# @param create_pdf_request [CreatePdfRequest]
3535
# @param [Hash] opts the optional parameters
3636
# @return [Array<(CreatePdfResponse, Integer, Hash)>] CreatePdfResponse data, response status code and response headers

0 commit comments

Comments
 (0)