Skip to content

Commit afa29a8

Browse files
committed
Updated response codes and response values
1 parent 2101c70 commit afa29a8

File tree

74 files changed

+478
-429
lines changed

Some content is hidden

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

74 files changed

+478
-429
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,24 @@ Response headers contain additional values:
6161
| X-RateLimit-Remaining | The requests remaining in the current minute |
6262
| Retry-After | How many seconds you need to wait until you are allowed to make requests |
6363

64+
* * * * *
65+
66+
# Libraries and SDKs
6467
## Postman Collection
6568
We have created a [Postman](https://www.postman.com) Collection so you can easily test all the API endpoints without developing and code. You can download the collection [here](https://god.gw.postman.com/run-collection/11578263-c6546175-de49-4b35-904b-29bb52a5a69a?action=collection%2Ffork&collection-url=entityId%3D11578263-c6546175-de49-4b35-904b-29bb52a5a69a%26entityType%3Dcollection%26workspaceId%3D5900d75f-c45d-4e61-9fb7-63aca23580df) or just click the button below.
6669

67-
[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/11578263-c6546175-de49-4b35-904b-29bb52a5a69a?action=collection%2Ffork&collection-url=entityId%3D11578263-c6546175-de49-4b35-904b-29bb52a5a69a%26entityType%3Dcollection%26workspaceId%3D5900d75f-c45d-4e61-9fb7-63aca23580df)
70+
[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/11578263-c6546175-de49-4b35-904b-29bb52a5a69a?action=collection%2Ffork&collection-url=entityId%3D11578263-c6546175-de49-4b35-904b-29bb52a5a69a%26entityType%3Dcollection%26workspaceId%3D5900d75f-c45d-4e61-9fb7-63aca23580df)
71+
72+
## Client Libraries
73+
All our Client Libraries are auto-generated using [OpenAPI Generator](https://openapi-generator.tech/) which uses the OpenAPI v3 specification to automatically generate a client library in specific programming language.
74+
75+
* [PHP Client](https://github.com/pdfgeneratorapi/php-client)
76+
* [Java Client](https://github.com/pdfgeneratorapi/java-client)
77+
* [Ruby Client](https://github.com/pdfgeneratorapi/ruby-client)
78+
* [Python Client](https://github.com/pdfgeneratorapi/python-client)
79+
* [Javascript Client](https://github.com/pdfgeneratorapi/javascript-client)
6880

81+
We have validated the generated libraries, but let us know if you find any anomalies in the client code.
6982
* * * * *
7083

7184
# Authentication
@@ -198,7 +211,7 @@ You can also use [jwt.io](https://jwt.io/) to generate test tokens for your API
198211

199212
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
200213

201-
- API version: 4.0.2
214+
- API version: 4.0.3
202215
- Package version: 1.0.0
203216
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
204217
For more information, please visit [https://support.pdfgeneratorapi.com](https://support.pdfgeneratorapi.com)

docs/apis/tags/ConversionApi.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Key | Input Type | Accessed Type | Description | Notes
9595
Code | Class | Description
9696
------------- | ------------- | -------------
9797
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
98-
200 | [ApiResponseFor200](#convert_html2_pdf.ApiResponseFor200) | Document data
98+
201 | [ApiResponseFor201](#convert_html2_pdf.ApiResponseFor201) | Document data
9999
401 | [ApiResponseFor401](#convert_html2_pdf.ApiResponseFor401) | Unauthorized
100100
402 | [ApiResponseFor402](#convert_html2_pdf.ApiResponseFor402) | Account Suspended
101101
403 | [ApiResponseFor403](#convert_html2_pdf.ApiResponseFor403) | Forbidden
@@ -104,14 +104,14 @@ n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization i
104104
429 | [ApiResponseFor429](#convert_html2_pdf.ApiResponseFor429) | Too Many Requests
105105
500 | [ApiResponseFor500](#convert_html2_pdf.ApiResponseFor500) | Internal Server Error
106106

107-
#### convert_html2_pdf.ApiResponseFor200
107+
#### convert_html2_pdf.ApiResponseFor201
108108
Name | Type | Description | Notes
109109
------------- | ------------- | ------------- | -------------
110110
response | urllib3.HTTPResponse | Raw response |
111-
body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | |
111+
body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | |
112112
headers | Unset | headers were not defined |
113113

114-
# SchemaFor200ResponseBodyApplicationJson
114+
# SchemaFor201ResponseBodyApplicationJson
115115

116116
## Model Type Info
117117
Input Type | Accessed Type | Description | Notes
@@ -384,7 +384,7 @@ Key | Input Type | Accessed Type | Description | Notes
384384
Code | Class | Description
385385
------------- | ------------- | -------------
386386
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
387-
200 | [ApiResponseFor200](#convert_url2_pdf.ApiResponseFor200) | Document data
387+
201 | [ApiResponseFor201](#convert_url2_pdf.ApiResponseFor201) | Document data
388388
401 | [ApiResponseFor401](#convert_url2_pdf.ApiResponseFor401) | Unauthorized
389389
402 | [ApiResponseFor402](#convert_url2_pdf.ApiResponseFor402) | Account Suspended
390390
403 | [ApiResponseFor403](#convert_url2_pdf.ApiResponseFor403) | Forbidden
@@ -393,14 +393,14 @@ n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization i
393393
429 | [ApiResponseFor429](#convert_url2_pdf.ApiResponseFor429) | Too Many Requests
394394
500 | [ApiResponseFor500](#convert_url2_pdf.ApiResponseFor500) | Internal Server Error
395395

396-
#### convert_url2_pdf.ApiResponseFor200
396+
#### convert_url2_pdf.ApiResponseFor201
397397
Name | Type | Description | Notes
398398
------------- | ------------- | ------------- | -------------
399399
response | urllib3.HTTPResponse | Raw response |
400-
body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | |
400+
body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | |
401401
headers | Unset | headers were not defined |
402402

403-
# SchemaFor200ResponseBodyApplicationJson
403+
# SchemaFor201ResponseBodyApplicationJson
404404

405405
## Model Type Info
406406
Input Type | Accessed Type | Description | Notes

docs/apis/tags/DocumentsApi.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Key | Input Type | Accessed Type | Description | Notes
102102
Code | Class | Description
103103
------------- | ------------- | -------------
104104
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
105-
200 | [ApiResponseFor200](#generate_document.ApiResponseFor200) | Document data
105+
201 | [ApiResponseFor201](#generate_document.ApiResponseFor201) | Document data
106106
401 | [ApiResponseFor401](#generate_document.ApiResponseFor401) | Unauthorized
107107
402 | [ApiResponseFor402](#generate_document.ApiResponseFor402) | Account Suspended
108108
403 | [ApiResponseFor403](#generate_document.ApiResponseFor403) | Forbidden
@@ -111,14 +111,14 @@ n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization i
111111
429 | [ApiResponseFor429](#generate_document.ApiResponseFor429) | Too Many Requests
112112
500 | [ApiResponseFor500](#generate_document.ApiResponseFor500) | Internal Server Error
113113

114-
#### generate_document.ApiResponseFor200
114+
#### generate_document.ApiResponseFor201
115115
Name | Type | Description | Notes
116116
------------- | ------------- | ------------- | -------------
117117
response | urllib3.HTTPResponse | Raw response |
118-
body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | |
118+
body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | |
119119
headers | Unset | headers were not defined |
120120

121-
# SchemaFor200ResponseBodyApplicationJson
121+
# SchemaFor201ResponseBodyApplicationJson
122122

123123
## Model Type Info
124124
Input Type | Accessed Type | Description | Notes
@@ -401,7 +401,7 @@ Key | Input Type | Accessed Type | Description | Notes
401401
Code | Class | Description
402402
------------- | ------------- | -------------
403403
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
404-
200 | [ApiResponseFor200](#generate_document_asynchronous.ApiResponseFor200) | Async job response
404+
201 | [ApiResponseFor201](#generate_document_asynchronous.ApiResponseFor201) | Async job response
405405
401 | [ApiResponseFor401](#generate_document_asynchronous.ApiResponseFor401) | Unauthorized
406406
402 | [ApiResponseFor402](#generate_document_asynchronous.ApiResponseFor402) | Account Suspended
407407
403 | [ApiResponseFor403](#generate_document_asynchronous.ApiResponseFor403) | Forbidden
@@ -410,14 +410,14 @@ n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization i
410410
429 | [ApiResponseFor429](#generate_document_asynchronous.ApiResponseFor429) | Too Many Requests
411411
500 | [ApiResponseFor500](#generate_document_asynchronous.ApiResponseFor500) | Internal Server Error
412412

413-
#### generate_document_asynchronous.ApiResponseFor200
413+
#### generate_document_asynchronous.ApiResponseFor201
414414
Name | Type | Description | Notes
415415
------------- | ------------- | ------------- | -------------
416416
response | urllib3.HTTPResponse | Raw response |
417-
body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | |
417+
body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | |
418418
headers | Unset | headers were not defined |
419419

420-
# SchemaFor200ResponseBodyApplicationJson
420+
# SchemaFor201ResponseBodyApplicationJson
421421

422422
## Model Type Info
423423
Input Type | Accessed Type | Description | Notes
@@ -704,7 +704,7 @@ Class Name | Input Type | Accessed Type | Description | Notes
704704
Code | Class | Description
705705
------------- | ------------- | -------------
706706
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
707-
200 | [ApiResponseFor200](#generate_document_batch.ApiResponseFor200) | Document data
707+
201 | [ApiResponseFor201](#generate_document_batch.ApiResponseFor201) | Document data
708708
401 | [ApiResponseFor401](#generate_document_batch.ApiResponseFor401) | Unauthorized
709709
402 | [ApiResponseFor402](#generate_document_batch.ApiResponseFor402) | Account Suspended
710710
403 | [ApiResponseFor403](#generate_document_batch.ApiResponseFor403) | Forbidden
@@ -713,14 +713,14 @@ n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization i
713713
429 | [ApiResponseFor429](#generate_document_batch.ApiResponseFor429) | Too Many Requests
714714
500 | [ApiResponseFor500](#generate_document_batch.ApiResponseFor500) | Internal Server Error
715715

716-
#### generate_document_batch.ApiResponseFor200
716+
#### generate_document_batch.ApiResponseFor201
717717
Name | Type | Description | Notes
718718
------------- | ------------- | ------------- | -------------
719719
response | urllib3.HTTPResponse | Raw response |
720-
body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | |
720+
body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | |
721721
headers | Unset | headers were not defined |
722722

723-
# SchemaFor200ResponseBodyApplicationJson
723+
# SchemaFor201ResponseBodyApplicationJson
724724

725725
## Model Type Info
726726
Input Type | Accessed Type | Description | Notes
@@ -1017,7 +1017,7 @@ Class Name | Input Type | Accessed Type | Description | Notes
10171017
Code | Class | Description
10181018
------------- | ------------- | -------------
10191019
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
1020-
200 | [ApiResponseFor200](#generate_document_batch_asynchronous.ApiResponseFor200) | Async job response
1020+
201 | [ApiResponseFor201](#generate_document_batch_asynchronous.ApiResponseFor201) | Async job response
10211021
401 | [ApiResponseFor401](#generate_document_batch_asynchronous.ApiResponseFor401) | Unauthorized
10221022
402 | [ApiResponseFor402](#generate_document_batch_asynchronous.ApiResponseFor402) | Account Suspended
10231023
403 | [ApiResponseFor403](#generate_document_batch_asynchronous.ApiResponseFor403) | Forbidden
@@ -1026,14 +1026,14 @@ n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization i
10261026
429 | [ApiResponseFor429](#generate_document_batch_asynchronous.ApiResponseFor429) | Too Many Requests
10271027
500 | [ApiResponseFor500](#generate_document_batch_asynchronous.ApiResponseFor500) | Internal Server Error
10281028

1029-
#### generate_document_batch_asynchronous.ApiResponseFor200
1029+
#### generate_document_batch_asynchronous.ApiResponseFor201
10301030
Name | Type | Description | Notes
10311031
------------- | ------------- | ------------- | -------------
10321032
response | urllib3.HTTPResponse | Raw response |
1033-
body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | |
1033+
body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | |
10341034
headers | Unset | headers were not defined |
10351035

1036-
# SchemaFor200ResponseBodyApplicationJson
1036+
# SchemaFor201ResponseBodyApplicationJson
10371037

10381038
## Model Type Info
10391039
Input Type | Accessed Type | Description | Notes

docs/apis/tags/TemplatesApi.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ decimal.Decimal, int, | decimal.Decimal, | |
126126
Code | Class | Description
127127
------------- | ------------- | -------------
128128
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
129-
200 | [ApiResponseFor200](#copy_template.ApiResponseFor200) | Template configuration and example data structure
129+
201 | [ApiResponseFor201](#copy_template.ApiResponseFor201) | Template configuration and example data structure
130130
401 | [ApiResponseFor401](#copy_template.ApiResponseFor401) | Unauthorized
131131
402 | [ApiResponseFor402](#copy_template.ApiResponseFor402) | Account Suspended
132132
403 | [ApiResponseFor403](#copy_template.ApiResponseFor403) | Forbidden
@@ -135,14 +135,14 @@ n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization i
135135
429 | [ApiResponseFor429](#copy_template.ApiResponseFor429) | Too Many Requests
136136
500 | [ApiResponseFor500](#copy_template.ApiResponseFor500) | Internal Server Error
137137

138-
#### copy_template.ApiResponseFor200
138+
#### copy_template.ApiResponseFor201
139139
Name | Type | Description | Notes
140140
------------- | ------------- | ------------- | -------------
141141
response | urllib3.HTTPResponse | Raw response |
142-
body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | |
142+
body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | |
143143
headers | Unset | headers were not defined |
144144

145-
# SchemaFor200ResponseBodyApplicationJson
145+
# SchemaFor201ResponseBodyApplicationJson
146146

147147
## Model Type Info
148148
Input Type | Accessed Type | Description | Notes
@@ -430,7 +430,7 @@ Type | Description | Notes
430430
Code | Class | Description
431431
------------- | ------------- | -------------
432432
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
433-
200 | [ApiResponseFor200](#create_template.ApiResponseFor200) | Template configuration and example data structure
433+
201 | [ApiResponseFor201](#create_template.ApiResponseFor201) | Template configuration and example data structure
434434
401 | [ApiResponseFor401](#create_template.ApiResponseFor401) | Unauthorized
435435
402 | [ApiResponseFor402](#create_template.ApiResponseFor402) | Account Suspended
436436
403 | [ApiResponseFor403](#create_template.ApiResponseFor403) | Forbidden
@@ -439,14 +439,14 @@ n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization i
439439
429 | [ApiResponseFor429](#create_template.ApiResponseFor429) | Too Many Requests
440440
500 | [ApiResponseFor500](#create_template.ApiResponseFor500) | Internal Server Error
441441

442-
#### create_template.ApiResponseFor200
442+
#### create_template.ApiResponseFor201
443443
Name | Type | Description | Notes
444444
------------- | ------------- | ------------- | -------------
445445
response | urllib3.HTTPResponse | Raw response |
446-
body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | |
446+
body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | |
447447
headers | Unset | headers were not defined |
448448

449-
# SchemaFor200ResponseBodyApplicationJson
449+
# SchemaFor201ResponseBodyApplicationJson
450450

451451
## Model Type Info
452452
Input Type | Accessed Type | Description | Notes

docs/apis/tags/WorkspacesApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Key | Input Type | Accessed Type | Description | Notes
9090
Code | Class | Description
9191
------------- | ------------- | -------------
9292
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
93-
200 | [ApiResponseFor200](#create_workspace.ApiResponseFor200) | Workspace information
93+
201 | [ApiResponseFor201](#create_workspace.ApiResponseFor201) | Workspace information
9494
401 | [ApiResponseFor401](#create_workspace.ApiResponseFor401) | Unauthorized
9595
402 | [ApiResponseFor402](#create_workspace.ApiResponseFor402) | Account Suspended
9696
403 | [ApiResponseFor403](#create_workspace.ApiResponseFor403) | Forbidden
@@ -99,14 +99,14 @@ n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization i
9999
429 | [ApiResponseFor429](#create_workspace.ApiResponseFor429) | Too Many Requests
100100
500 | [ApiResponseFor500](#create_workspace.ApiResponseFor500) | Internal Server Error
101101

102-
#### create_workspace.ApiResponseFor200
102+
#### create_workspace.ApiResponseFor201
103103
Name | Type | Description | Notes
104104
------------- | ------------- | ------------- | -------------
105105
response | urllib3.HTTPResponse | Raw response |
106-
body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | |
106+
body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | |
107107
headers | Unset | headers were not defined |
108108

109-
# SchemaFor200ResponseBodyApplicationJson
109+
# SchemaFor201ResponseBodyApplicationJson
110110

111111
## Model Type Info
112112
Input Type | Accessed Type | Description | Notes

docs/models/Component.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ dict, frozendict.frozendict, | frozendict.frozendict, | Template component def
1010
### Dictionary Keys
1111
Key | Input Type | Accessed Type | Description | Notes
1212
------------ | ------------- | ------------- | ------------- | -------------
13-
**cls** | str, | str, | Defines component class/type | [optional] must be one of ["labelComponent", "tableComponent", "compositeComponent", "chartComponent", "barcodeComponent", "qrcodeComponent", "imageComponent", "headerComponent", "footerComponent", "rectangleComponent", "vlineComponent", "hlineComponent", "pagenumberComponent", "symbolComponent", "checkboxComponent", "radioComponent", "signatureComponent", ]
13+
**cls** | str, | str, | Defines component class/type | [optional] must be one of ["labelComponent", "textComponent", "dateComponent", "numberComponent", "htmlblockComponent", "tableComponent", "compositeComponent", "chartComponent", "barcodeComponent", "qrcodeComponent", "imageComponent", "headerComponent", "footerComponent", "rectangleComponent", "vlineComponent", "hlineComponent", "pagenumberComponent", "symbolComponent", "checkboxComponent", "radioComponent", "signatureComponent", ]
1414
**id** | str, | str, | Component id | [optional]
1515
**width** | decimal.Decimal, int, float, | decimal.Decimal, | Width in units | [optional]
1616
**height** | decimal.Decimal, int, float, | decimal.Decimal, | Height in units | [optional]

0 commit comments

Comments
 (0)