You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
template_id =19375# int | Template unique identifier
270
-
data = Data(
271
-
id=12312,
272
-
name="Sample Data",
273
-
) # Data | Data used to generate the PDF. This can be JSON encoded string or a public URL to your JSON file.
276
+
body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Data used to generate the PDF. This can be JSON encoded string or a public URL to your JSON file.
274
277
name ="My document"# str | Document name, returned in the meta data. (optional)
275
278
format="pdf"# str | Document format. The zip option will return a ZIP file with PDF files. (optional) (default to "pdf")
276
-
output ="base64"# str | Response format. With the url option, the document is stored for 30 days and automatically deleted. (optional) (default to "base64")
279
+
output ="base64"# str | Response format. "I" is used to return the file inline. With the url option, the document is stored for 30 days and automatically deleted. (optional) (default to "base64")
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
9
+
10
+
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
template_id =19375# int | Template unique identifier
54
-
data = Data(
55
-
id=12312,
56
-
name="Sample Data",
57
-
) # Data | Data used to generate the PDF. This can be JSON encoded string or a public URL to your JSON file.
54
+
body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Data used to generate the PDF. This can be JSON encoded string or a public URL to your JSON file.
58
55
name ="My document"# str | Document name, returned in the meta data. (optional)
59
56
format="pdf"# str | Document format. The zip option will return a ZIP file with PDF files. (optional) if omitted the server will use the default value of "pdf"
60
-
output ="base64"# str | Response format. With the url option, the document is stored for 30 days and automatically deleted. (optional) if omitted the server will use the default value of "base64"
57
+
output ="base64"# str | Response format. \"I\" is used to return the file inline. With the url option, the document is stored for 30 days and automatically deleted. (optional) if omitted the server will use the default value of "base64"
61
58
62
59
# example passing only required values which don't have defaults set
**data** | [**Data**](Data.md)| Data used to generate the PDF. This can be JSON encoded string or a public URL to your JSON file. |
83
+
**body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Data used to generate the PDF. This can be JSON encoded string or a public URL to your JSON file. |
87
84
**name** | **str**| Document name, returned in the meta data. | [optional]
88
85
**format** | **str**| Document format. The zip option will return a ZIP file with PDF files. | [optional] if omitted the server will use the default value of "pdf"
89
-
**output** | **str**| Response format. With the url option, the document is stored for 30 days and automatically deleted. | [optional] if omitted the server will use the default value of "base64"
86
+
**output** | **str**| Response format. \"I\" is used to return the file inline. With the url option, the document is stored for 30 days and automatically deleted. | [optional] if omitted the server will use the default value of "base64"
90
87
91
88
### Return type
92
89
@@ -107,6 +104,7 @@ Name | Type | Description | Notes
107
104
|-------------|-------------|------------------|
108
105
**200** | Document data | - |
109
106
**401** | Unauthorized | - |
107
+
**402** | Account Suspended | - |
110
108
**403** | Forbidden | - |
111
109
**404** | Not Found | - |
112
110
**422** | Unprocessable Entity | - |
@@ -119,7 +117,7 @@ Name | Type | Description | Notes
119
117
120
118
Generate document (multiple templates)
121
119
122
-
Allows to merge multiple templated with data and returns base64 encoded document or public URL to a document. NB! When the public URL option is used, the document is stored for 30 days and automatically deleted.
120
+
Allows to merge multiple templates with data and returns base64 encoded document or public URL to a document. NB! When the public URL option is used, the document is stored for 30 days and automatically deleted.
123
121
124
122
### Example
125
123
@@ -131,6 +129,7 @@ from pdf_generator_api_client.api import documents_api
131
129
from pdf_generator_api_client.model.inline_response401 import InlineResponse401
132
130
from pdf_generator_api_client.model.inline_response422 import InlineResponse422
133
131
from pdf_generator_api_client.model.inline_response404 import InlineResponse404
132
+
from pdf_generator_api_client.model.inline_response402 import InlineResponse402
134
133
from pdf_generator_api_client.model.inline_response500 import InlineResponse500
135
134
from pdf_generator_api_client.model.batch_data import BatchData
136
135
from pdf_generator_api_client.model.inline_response403 import InlineResponse403
@@ -159,7 +158,7 @@ with pdf_generator_api_client.ApiClient(configuration) as api_client:
159
158
batch_data = BatchData([{"template":52272,"data":{"key":"value"}},{"template":52273,"data":{"key2":"value2"}}]) # BatchData | Data used to specify templates and data objects which are used to merge the template
160
159
name ="My document"# str | Document name, returned in the meta data. (optional)
161
160
format="pdf"# str | Document format. The zip option will return a ZIP file with PDF files. (optional) if omitted the server will use the default value of "pdf"
162
-
output ="base64"# str | Response format. With the url option, the document is stored for 30 days and automatically deleted. (optional) if omitted the server will use the default value of "base64"
161
+
output ="base64"# str | Response format. \"I\" is used to return the file inline. With the url option, the document is stored for 30 days and automatically deleted. (optional) if omitted the server will use the default value of "base64"
163
162
164
163
# example passing only required values which don't have defaults set
165
164
try:
@@ -187,7 +186,7 @@ Name | Type | Description | Notes
187
186
**batch_data** | [**BatchData**](BatchData.md)| Data used to specify templates and data objects which are used to merge the template |
188
187
**name** | **str**| Document name, returned in the meta data. | [optional]
189
188
**format** | **str**| Document format. The zip option will return a ZIP file with PDF files. | [optional] if omitted the server will use the default value of "pdf"
190
-
**output** | **str**| Response format. With the url option, the document is stored for 30 days and automatically deleted. | [optional] if omitted the server will use the default value of "base64"
189
+
**output** | **str**| Response format. \"I\" is used to return the file inline. With the url option, the document is stored for 30 days and automatically deleted. | [optional] if omitted the server will use the default value of "base64"
191
190
192
191
### Return type
193
192
@@ -208,6 +207,7 @@ Name | Type | Description | Notes
**error** | **str** | Error description | [optional] if omitted the server will use the default value of "Your account is suspended, please upgrade your account or contact [email protected]"
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
10
+
11
+
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
0 commit comments