Skip to content

Commit ec08ea5

Browse files
actualreportsactualreports
committed
Updated to reflect updated response strcture
1 parent afa29a8 commit ec08ea5

Some content is hidden

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

61 files changed

+713
-420
lines changed

‎README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,7 @@ Response headers contain additional values:
6565

6666
# Libraries and SDKs
6767
## Postman Collection
68-
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.
69-
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)
68+
We have created a [Postman Collection](https://www.postman.com/pdfgeneratorapi/workspace/pdf-generator-api-public-workspace/overview) so you can easily test all the API endpoints without developing and code. You can download the collection [here](https://www.postman.com/pdfgeneratorapi/workspace/pdf-generator-api-public-workspace/collection/11578263-42fed446-af7e-4266-84e1-69e8c1752e93).
7169

7270
## Client Libraries
7371
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.
@@ -211,7 +209,7 @@ You can also use [jwt.io](https://jwt.io/) to generate test tokens for your API
211209

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

214-
- API version: 4.0.3
212+
- API version: 4.0.4
215213
- Package version: 1.0.0
216214
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
217215
For more information, please visit [https://support.pdfgeneratorapi.com](https://support.pdfgeneratorapi.com)

‎docs/apis/tags/ConversionApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ dict, frozendict.frozendict, | frozendict.frozendict, | |
8484
Key | Input Type | Accessed Type | Description | Notes
8585
------------ | ------------- | ------------- | ------------- | -------------
8686
**content** | str, | str, | HTML content | [optional]
87-
**paper_size** | str, | str, | PDF page size | [optional] must be one of ["a0", "a1", "a2", "a3", "a4", "legal", "tabloid", ] if omitted the server will use the default value of "a4"
87+
**paper_size** | str, | str, | PDF page size | [optional] must be one of ["a0", "a1", "a2", "a3", "a4", "legal", "tabloid", "letter", ] if omitted the server will use the default value of "a4"
8888
**orientation** | str, | str, | | [optional] must be one of ["portrait", "landscape", ] if omitted the server will use the default value of "portrait"
8989
**output** | str, | str, | Output | [optional] must be one of ["base64", "file", ] if omitted the server will use the default value of "base64"
9090
**filename** | str, | str, | Document name | [optional]
@@ -373,7 +373,7 @@ dict, frozendict.frozendict, | frozendict.frozendict, | |
373373
Key | Input Type | Accessed Type | Description | Notes
374374
------------ | ------------- | ------------- | ------------- | -------------
375375
**url** | str, | str, | Public URL | [optional]
376-
**paper_size** | str, | str, | PDF page size | [optional] must be one of ["a0", "a1", "a2", "a3", "a4", "legal", "tabloid", ] if omitted the server will use the default value of "a4"
376+
**paper_size** | str, | str, | PDF page size | [optional] must be one of ["a0", "a1", "a2", "a3", "a4", "legal", "tabloid", "letter", ] if omitted the server will use the default value of "a4"
377377
**orientation** | str, | str, | | [optional] must be one of ["portrait", "landscape", ] if omitted the server will use the default value of "portrait"
378378
**output** | str, | str, | Output | [optional] must be one of ["base64", "file", ] if omitted the server will use the default value of "base64"
379379
**filename** | str, | str, | Document name | [optional]

‎docs/apis/tags/TemplatesApi.md‎

Lines changed: 55 additions & 56 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-
201 | [ApiResponseFor201](#copy_template.ApiResponseFor201) | Template configuration and example data structure
129+
201 | [ApiResponseFor201](#copy_template.ApiResponseFor201) | Template configuration
130130
401 | [ApiResponseFor401](#copy_template.ApiResponseFor401) | Unauthorized
131131
402 | [ApiResponseFor402](#copy_template.ApiResponseFor402) | Account Suspended
132132
403 | [ApiResponseFor403](#copy_template.ApiResponseFor403) | Forbidden
@@ -153,8 +153,16 @@ dict, frozendict.frozendict, | frozendict.frozendict, | |
153153
Key | Input Type | Accessed Type | Description | Notes
154154
------------ | ------------- | ------------- | ------------- | -------------
155155
**response** | [**TemplateDefinition**]({{complexTypePrefix}}TemplateDefinition.md) | [**TemplateDefinition**]({{complexTypePrefix}}TemplateDefinition.md) | | [optional]
156+
**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
156157
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
157158

159+
# meta
160+
161+
## Model Type Info
162+
Input Type | Accessed Type | Description | Notes
163+
------------ | ------------- | ------------- | -------------
164+
dict, frozendict.frozendict, | frozendict.frozendict, | |
165+
158166
#### copy_template.ApiResponseFor401
159167
Name | Type | Description | Notes
160168
------------- | ------------- | ------------- | -------------
@@ -382,20 +390,17 @@ with pdf_generator_api_client.ApiClient(configuration) as api_client:
382390
bottom=0.5,
383391
),
384392
components=[
385-
Component(
386-
cls="labelComponent",
387-
id="component-12313",
388-
width=3.5,
389-
height=1,
390-
top=4.2,
391-
left=2.5,
392-
zindex=102,
393-
value="${price}",
394-
data_index="line_items",
395-
)
393+
dict()
396394
],
397395
)
398396
],
397+
data_settings=dict(
398+
,
399+
,
400+
),
401+
editor=dict(
402+
height_multiplier=2,
403+
),
399404
)
400405
try:
401406
# Create template
@@ -430,7 +435,7 @@ Type | Description | Notes
430435
Code | Class | Description
431436
------------- | ------------- | -------------
432437
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
433-
201 | [ApiResponseFor201](#create_template.ApiResponseFor201) | Template configuration and example data structure
438+
201 | [ApiResponseFor201](#create_template.ApiResponseFor201) | Template configuration
434439
401 | [ApiResponseFor401](#create_template.ApiResponseFor401) | Unauthorized
435440
402 | [ApiResponseFor402](#create_template.ApiResponseFor402) | Account Suspended
436441
403 | [ApiResponseFor403](#create_template.ApiResponseFor403) | Forbidden
@@ -457,8 +462,16 @@ dict, frozendict.frozendict, | frozendict.frozendict, | |
457462
Key | Input Type | Accessed Type | Description | Notes
458463
------------ | ------------- | ------------- | ------------- | -------------
459464
**response** | [**TemplateDefinition**]({{complexTypePrefix}}TemplateDefinition.md) | [**TemplateDefinition**]({{complexTypePrefix}}TemplateDefinition.md) | | [optional]
465+
**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
460466
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
461467

468+
# meta
469+
470+
## Model Type Info
471+
Input Type | Accessed Type | Description | Notes
472+
------------ | ------------- | ------------- | -------------
473+
dict, frozendict.frozendict, | frozendict.frozendict, | |
474+
462475
#### create_template.ApiResponseFor401
463476
Name | Type | Description | Notes
464477
------------- | ------------- | ------------- | -------------
@@ -617,7 +630,7 @@ Key | Input Type | Accessed Type | Description | Notes
617630

618631
# **delete_template**
619632
<a name="delete_template"></a>
620-
> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_template(template_id)
633+
> delete_template(template_id)
621634
622635
Delete template
623636

@@ -659,7 +672,6 @@ with pdf_generator_api_client.ApiClient(configuration) as api_client:
659672
api_response = api_instance.delete_template(
660673
path_params=path_params,
661674
)
662-
pprint(api_response)
663675
except pdf_generator_api_client.ApiException as e:
664676
print("Exception when calling TemplatesApi->delete_template: %s\n" % e)
665677
```
@@ -692,7 +704,7 @@ decimal.Decimal, int, | decimal.Decimal, | |
692704
Code | Class | Description
693705
------------- | ------------- | -------------
694706
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
695-
204 | [ApiResponseFor204](#delete_template.ApiResponseFor204) | The request was successfully executed.
707+
204 | [ApiResponseFor204](#delete_template.ApiResponseFor204) | The resource was deleted successfully.
696708
401 | [ApiResponseFor401](#delete_template.ApiResponseFor401) | Unauthorized
697709
402 | [ApiResponseFor402](#delete_template.ApiResponseFor402) | Account Suspended
698710
403 | [ApiResponseFor403](#delete_template.ApiResponseFor403) | Forbidden
@@ -705,35 +717,9 @@ n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization i
705717
Name | Type | Description | Notes
706718
------------- | ------------- | ------------- | -------------
707719
response | urllib3.HTTPResponse | Raw response |
708-
body | typing.Union[SchemaFor204ResponseBodyApplicationJson, ] | |
720+
body | Unset | body was not defined |
709721
headers | Unset | headers were not defined |
710722

711-
# SchemaFor204ResponseBodyApplicationJson
712-
713-
## Model Type Info
714-
Input Type | Accessed Type | Description | Notes
715-
------------ | ------------- | ------------- | -------------
716-
dict, frozendict.frozendict, | frozendict.frozendict, | |
717-
718-
### Dictionary Keys
719-
Key | Input Type | Accessed Type | Description | Notes
720-
------------ | ------------- | ------------- | ------------- | -------------
721-
**[response](#response)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
722-
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
723-
724-
# response
725-
726-
## Model Type Info
727-
Input Type | Accessed Type | Description | Notes
728-
------------ | ------------- | ------------- | -------------
729-
dict, frozendict.frozendict, | frozendict.frozendict, | |
730-
731-
### Dictionary Keys
732-
Key | Input Type | Accessed Type | Description | Notes
733-
------------ | ------------- | ------------- | ------------- | -------------
734-
**success** | bool, | BoolClass, | | [optional]
735-
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
736-
737723
#### delete_template.ApiResponseFor401
738724
Name | Type | Description | Notes
739725
------------- | ------------- | ------------- | -------------
@@ -968,7 +954,7 @@ decimal.Decimal, int, | decimal.Decimal, | |
968954
Code | Class | Description
969955
------------- | ------------- | -------------
970956
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
971-
200 | [ApiResponseFor200](#get_template.ApiResponseFor200) | Template configuration and example data structure
957+
200 | [ApiResponseFor200](#get_template.ApiResponseFor200) | Template configuration
972958
401 | [ApiResponseFor401](#get_template.ApiResponseFor401) | Unauthorized
973959
402 | [ApiResponseFor402](#get_template.ApiResponseFor402) | Account Suspended
974960
403 | [ApiResponseFor403](#get_template.ApiResponseFor403) | Forbidden
@@ -995,8 +981,16 @@ dict, frozendict.frozendict, | frozendict.frozendict, | |
995981
Key | Input Type | Accessed Type | Description | Notes
996982
------------ | ------------- | ------------- | ------------- | -------------
997983
**response** | [**TemplateDefinition**]({{complexTypePrefix}}TemplateDefinition.md) | [**TemplateDefinition**]({{complexTypePrefix}}TemplateDefinition.md) | | [optional]
984+
**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
998985
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
999986

987+
# meta
988+
989+
## Model Type Info
990+
Input Type | Accessed Type | Description | Notes
991+
------------ | ------------- | ------------- | -------------
992+
dict, frozendict.frozendict, | frozendict.frozendict, | |
993+
1000994
#### get_template.ApiResponseFor401
1001995
Name | Type | Description | Notes
1002996
------------- | ------------- | ------------- | -------------
@@ -2121,20 +2115,17 @@ with pdf_generator_api_client.ApiClient(configuration) as api_client:
21212115
bottom=0.5,
21222116
),
21232117
components=[
2124-
Component(
2125-
cls="labelComponent",
2126-
id="component-12313",
2127-
width=3.5,
2128-
height=1,
2129-
top=4.2,
2130-
left=2.5,
2131-
zindex=102,
2132-
value="${price}",
2133-
data_index="line_items",
2134-
)
2118+
dict()
21352119
],
21362120
)
21372121
],
2122+
data_settings=dict(
2123+
,
2124+
,
2125+
),
2126+
editor=dict(
2127+
height_multiplier=2,
2128+
),
21382129
)
21392130
try:
21402131
# Update template
@@ -2185,7 +2176,7 @@ decimal.Decimal, int, | decimal.Decimal, | |
21852176
Code | Class | Description
21862177
------------- | ------------- | -------------
21872178
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
2188-
200 | [ApiResponseFor200](#update_template.ApiResponseFor200) | Template configuration and example data structure
2179+
200 | [ApiResponseFor200](#update_template.ApiResponseFor200) | Template configuration
21892180
401 | [ApiResponseFor401](#update_template.ApiResponseFor401) | Unauthorized
21902181
402 | [ApiResponseFor402](#update_template.ApiResponseFor402) | Account Suspended
21912182
403 | [ApiResponseFor403](#update_template.ApiResponseFor403) | Forbidden
@@ -2212,8 +2203,16 @@ dict, frozendict.frozendict, | frozendict.frozendict, | |
22122203
Key | Input Type | Accessed Type | Description | Notes
22132204
------------ | ------------- | ------------- | ------------- | -------------
22142205
**response** | [**TemplateDefinition**]({{complexTypePrefix}}TemplateDefinition.md) | [**TemplateDefinition**]({{complexTypePrefix}}TemplateDefinition.md) | | [optional]
2206+
**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
22152207
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
22162208

2209+
# meta
2210+
2211+
## Model Type Info
2212+
Input Type | Accessed Type | Description | Notes
2213+
------------ | ------------- | ------------- | -------------
2214+
dict, frozendict.frozendict, | frozendict.frozendict, | |
2215+
22172216
#### update_template.ApiResponseFor401
22182217
Name | Type | Description | Notes
22192218
------------- | ------------- | ------------- | -------------

‎docs/models/TemplateDefinition.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@ dict, frozendict.frozendict, | frozendict.frozendict, | Defines template layou
4444
### Dictionary Keys
4545
Key | Input Type | Accessed Type | Description | Notes
4646
------------ | ------------- | ------------- | ------------- | -------------
47-
**format** | str, | str, | Defines template page size | [optional] must be one of ["A4", "letter", "custom", ]
47+
**format** | str, | str, | Defines template page size | [optional] must be one of ["A4", "letter", "custom", ] if omitted the server will use the default value of "A4"
4848
**width** | decimal.Decimal, int, float, | decimal.Decimal, | Page width in units | [optional]
4949
**height** | decimal.Decimal, int, float, | decimal.Decimal, | Page height in units | [optional]
50-
**unit** | str, | str, | Measure unit | [optional] must be one of ["cm", "in", ]
50+
**unit** | str, | str, | Measure unit | [optional] must be one of ["cm", "in", ] if omitted the server will use the default value of "cm"
5151
**orientation** | str, | str, | Page orientation | [optional] must be one of ["portrait", "landscape", ]
5252
**rotation** | decimal.Decimal, int, | decimal.Decimal, | Page rotation in degrees | [optional] must be one of [0, 90, 180, 270, ]
5353
**[margins](#margins)** | dict, frozendict.frozendict, | frozendict.frozendict, | Page margins in units | [optional]
5454
**[repeatLayout](#repeatLayout)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Defines page size if layout is repeated on the page e.g sheet labels | [optional]
55-
**emptyLabels** | decimal.Decimal, int, | decimal.Decimal, | Defines how many pages or labels should be empty | [optional]
55+
**emptyLabels** | decimal.Decimal, int, | decimal.Decimal, | Specifies how many blank lables to add to sheet label. | [optional] if omitted the server will use the default value of 0
5656
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
5757

5858
# margins
@@ -144,7 +144,14 @@ list, tuple, | tuple, | |
144144
### Tuple Items
145145
Class Name | Input Type | Accessed Type | Description | Notes
146146
------------- | ------------- | ------------- | ------------- | -------------
147-
[**Component**](Component.md) | [**Component**](Component.md) | [**Component**](Component.md) | |
147+
[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | |
148+
149+
# items
150+
151+
## Model Type Info
152+
Input Type | Accessed Type | Description | Notes
153+
------------ | ------------- | ------------- | -------------
154+
dict, frozendict.frozendict, | frozendict.frozendict, | |
148155

149156
# dataSettings
150157

0 commit comments

Comments
 (0)