docspring 3.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. docspring/__init__.py +250 -0
  2. docspring/api/__init__.py +20 -0
  3. docspring/api/client.py +13430 -0
  4. docspring/api_client.py +805 -0
  5. docspring/api_response.py +21 -0
  6. docspring/configuration.py +598 -0
  7. docspring/exceptions.py +217 -0
  8. docspring/models/__init__.py +146 -0
  9. docspring/models/add_fields_data.py +88 -0
  10. docspring/models/batch_generate_pdfs201_response.py +111 -0
  11. docspring/models/combine_pdfs_data.py +98 -0
  12. docspring/models/combined_submission.py +173 -0
  13. docspring/models/combined_submission_action.py +156 -0
  14. docspring/models/copy_template_options.py +92 -0
  15. docspring/models/create_combined_submission_response.py +107 -0
  16. docspring/models/create_custom_file_data.py +89 -0
  17. docspring/models/create_custom_file_response.py +107 -0
  18. docspring/models/create_folder_data.py +88 -0
  19. docspring/models/create_html_template.py +88 -0
  20. docspring/models/create_pdf_submission_data.py +112 -0
  21. docspring/models/create_pdf_template.py +88 -0
  22. docspring/models/create_submission_data_request_data.py +187 -0
  23. docspring/models/create_submission_data_request_event_request.py +134 -0
  24. docspring/models/create_submission_data_request_event_response.py +107 -0
  25. docspring/models/create_submission_data_request_response.py +107 -0
  26. docspring/models/create_submission_data_request_token_response.py +107 -0
  27. docspring/models/create_submission_response.py +107 -0
  28. docspring/models/create_webhook_data.py +88 -0
  29. docspring/models/custom_file.py +100 -0
  30. docspring/models/error_or_multiple_errors_response.py +103 -0
  31. docspring/models/error_response.py +101 -0
  32. docspring/models/folder.py +114 -0
  33. docspring/models/json_schema.py +110 -0
  34. docspring/models/list_submissions_response.py +105 -0
  35. docspring/models/move_folder_data.py +93 -0
  36. docspring/models/move_template_data.py +95 -0
  37. docspring/models/multiple_errors_response.py +101 -0
  38. docspring/models/publish_version_data.py +90 -0
  39. docspring/models/rename_folder_data.py +88 -0
  40. docspring/models/restore_version_data.py +88 -0
  41. docspring/models/submission.py +287 -0
  42. docspring/models/submission422_response.py +109 -0
  43. docspring/models/submission_action.py +148 -0
  44. docspring/models/submission_batch.py +123 -0
  45. docspring/models/submission_batch_data.py +106 -0
  46. docspring/models/submission_batch_with_submissions.py +133 -0
  47. docspring/models/submission_data_request.py +253 -0
  48. docspring/models/submission_data_request_event.py +155 -0
  49. docspring/models/submission_data_request_show.py +260 -0
  50. docspring/models/submission_data_request_token.py +109 -0
  51. docspring/models/submission_preview.py +257 -0
  52. docspring/models/success_error_response.py +101 -0
  53. docspring/models/success_multiple_errors_response.py +101 -0
  54. docspring/models/template.py +402 -0
  55. docspring/models/template_add_fields_response.py +103 -0
  56. docspring/models/template_delete_response.py +110 -0
  57. docspring/models/template_model_code_response.py +103 -0
  58. docspring/models/template_preview.py +356 -0
  59. docspring/models/template_publish_version_response.py +103 -0
  60. docspring/models/update_html_template.py +88 -0
  61. docspring/models/update_pdf_template.py +88 -0
  62. docspring/models/update_submission_data_request_data.py +185 -0
  63. docspring/models/update_webhook_data.py +88 -0
  64. docspring/models/upload_presign_response.py +108 -0
  65. docspring/models/webhook.py +185 -0
  66. docspring/py.typed +0 -0
  67. docspring/rest.py +259 -0
  68. docspring-3.1.0.dist-info/METADATA +245 -0
  69. docspring-3.1.0.dist-info/RECORD +72 -0
  70. docspring-3.1.0.dist-info/WHEEL +5 -0
  71. docspring-3.1.0.dist-info/licenses/LICENSE +7 -0
  72. docspring-3.1.0.dist-info/top_level.txt +1 -0
docspring/__init__.py ADDED
@@ -0,0 +1,250 @@
1
+ # coding: utf-8
2
+
3
+ # flake8: noqa
4
+
5
+ """
6
+ DocSpring API
7
+
8
+ Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
9
+
10
+ The version of the OpenAPI document: v1
11
+ Contact: support@docspring.com
12
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
13
+
14
+ Do not edit the class manually.
15
+ """ # noqa: E501
16
+
17
+
18
+ __version__ = "3.1.0"
19
+
20
+ # Define package exports
21
+ __all__ = [
22
+ "Client",
23
+ "ApiResponse",
24
+ "ApiClient",
25
+ "Configuration",
26
+ "OpenApiException",
27
+ "ApiTypeError",
28
+ "ApiValueError",
29
+ "ApiKeyError",
30
+ "ApiAttributeError",
31
+ "ApiException",
32
+ "AddFieldsData",
33
+ "BatchGeneratePdfs201Response",
34
+ "CombinePdfsData",
35
+ "CombinedSubmission",
36
+ "CombinedSubmissionAction",
37
+ "CopyTemplateOptions",
38
+ "CreateCombinedSubmissionResponse",
39
+ "CreateCustomFileData",
40
+ "CreateCustomFileResponse",
41
+ "CreateFolderData",
42
+ "CreateHtmlTemplate",
43
+ "CreatePdfSubmissionData",
44
+ "CreatePdfTemplate",
45
+ "CreateSubmissionDataRequestData",
46
+ "CreateSubmissionDataRequestEventRequest",
47
+ "CreateSubmissionDataRequestEventResponse",
48
+ "CreateSubmissionDataRequestResponse",
49
+ "CreateSubmissionDataRequestTokenResponse",
50
+ "CreateSubmissionResponse",
51
+ "CreateWebhookData",
52
+ "CustomFile",
53
+ "ErrorOrMultipleErrorsResponse",
54
+ "ErrorResponse",
55
+ "Folder",
56
+ "JsonSchema",
57
+ "ListSubmissionsResponse",
58
+ "MoveFolderData",
59
+ "MoveTemplateData",
60
+ "MultipleErrorsResponse",
61
+ "PublishVersionData",
62
+ "RenameFolderData",
63
+ "RestoreVersionData",
64
+ "Submission",
65
+ "Submission422Response",
66
+ "SubmissionAction",
67
+ "SubmissionBatch",
68
+ "SubmissionBatchData",
69
+ "SubmissionBatchWithSubmissions",
70
+ "SubmissionDataRequest",
71
+ "SubmissionDataRequestEvent",
72
+ "SubmissionDataRequestShow",
73
+ "SubmissionDataRequestToken",
74
+ "SubmissionPreview",
75
+ "SuccessErrorResponse",
76
+ "SuccessMultipleErrorsResponse",
77
+ "Template",
78
+ "TemplateAddFieldsResponse",
79
+ "TemplateDeleteResponse",
80
+ "TemplateModelCodeResponse",
81
+ "TemplatePreview",
82
+ "TemplatePublishVersionResponse",
83
+ "UpdateHtmlTemplate",
84
+ "UpdatePdfTemplate",
85
+ "UpdateSubmissionDataRequestData",
86
+ "UpdateWebhookData",
87
+ "UploadPresignResponse",
88
+ "Webhook",
89
+ ]
90
+
91
+ if __import__("typing").TYPE_CHECKING:
92
+ # import apis into sdk package
93
+ from docspring.api.client import Client as Client
94
+
95
+ # import ApiClient
96
+ from docspring.api_response import ApiResponse as ApiResponse
97
+ from docspring.api_client import ApiClient as ApiClient
98
+ from docspring.configuration import Configuration as Configuration
99
+ from docspring.exceptions import OpenApiException as OpenApiException
100
+ from docspring.exceptions import ApiTypeError as ApiTypeError
101
+ from docspring.exceptions import ApiValueError as ApiValueError
102
+ from docspring.exceptions import ApiKeyError as ApiKeyError
103
+ from docspring.exceptions import ApiAttributeError as ApiAttributeError
104
+ from docspring.exceptions import ApiException as ApiException
105
+
106
+ # import models into sdk package
107
+ from docspring.models.add_fields_data import AddFieldsData as AddFieldsData
108
+ from docspring.models.batch_generate_pdfs201_response import BatchGeneratePdfs201Response as BatchGeneratePdfs201Response
109
+ from docspring.models.combine_pdfs_data import CombinePdfsData as CombinePdfsData
110
+ from docspring.models.combined_submission import CombinedSubmission as CombinedSubmission
111
+ from docspring.models.combined_submission_action import CombinedSubmissionAction as CombinedSubmissionAction
112
+ from docspring.models.copy_template_options import CopyTemplateOptions as CopyTemplateOptions
113
+ from docspring.models.create_combined_submission_response import CreateCombinedSubmissionResponse as CreateCombinedSubmissionResponse
114
+ from docspring.models.create_custom_file_data import CreateCustomFileData as CreateCustomFileData
115
+ from docspring.models.create_custom_file_response import CreateCustomFileResponse as CreateCustomFileResponse
116
+ from docspring.models.create_folder_data import CreateFolderData as CreateFolderData
117
+ from docspring.models.create_html_template import CreateHtmlTemplate as CreateHtmlTemplate
118
+ from docspring.models.create_pdf_submission_data import CreatePdfSubmissionData as CreatePdfSubmissionData
119
+ from docspring.models.create_pdf_template import CreatePdfTemplate as CreatePdfTemplate
120
+ from docspring.models.create_submission_data_request_data import CreateSubmissionDataRequestData as CreateSubmissionDataRequestData
121
+ from docspring.models.create_submission_data_request_event_request import CreateSubmissionDataRequestEventRequest as CreateSubmissionDataRequestEventRequest
122
+ from docspring.models.create_submission_data_request_event_response import CreateSubmissionDataRequestEventResponse as CreateSubmissionDataRequestEventResponse
123
+ from docspring.models.create_submission_data_request_response import CreateSubmissionDataRequestResponse as CreateSubmissionDataRequestResponse
124
+ from docspring.models.create_submission_data_request_token_response import CreateSubmissionDataRequestTokenResponse as CreateSubmissionDataRequestTokenResponse
125
+ from docspring.models.create_submission_response import CreateSubmissionResponse as CreateSubmissionResponse
126
+ from docspring.models.create_webhook_data import CreateWebhookData as CreateWebhookData
127
+ from docspring.models.custom_file import CustomFile as CustomFile
128
+ from docspring.models.error_or_multiple_errors_response import ErrorOrMultipleErrorsResponse as ErrorOrMultipleErrorsResponse
129
+ from docspring.models.error_response import ErrorResponse as ErrorResponse
130
+ from docspring.models.folder import Folder as Folder
131
+ from docspring.models.json_schema import JsonSchema as JsonSchema
132
+ from docspring.models.list_submissions_response import ListSubmissionsResponse as ListSubmissionsResponse
133
+ from docspring.models.move_folder_data import MoveFolderData as MoveFolderData
134
+ from docspring.models.move_template_data import MoveTemplateData as MoveTemplateData
135
+ from docspring.models.multiple_errors_response import MultipleErrorsResponse as MultipleErrorsResponse
136
+ from docspring.models.publish_version_data import PublishVersionData as PublishVersionData
137
+ from docspring.models.rename_folder_data import RenameFolderData as RenameFolderData
138
+ from docspring.models.restore_version_data import RestoreVersionData as RestoreVersionData
139
+ from docspring.models.submission import Submission as Submission
140
+ from docspring.models.submission422_response import Submission422Response as Submission422Response
141
+ from docspring.models.submission_action import SubmissionAction as SubmissionAction
142
+ from docspring.models.submission_batch import SubmissionBatch as SubmissionBatch
143
+ from docspring.models.submission_batch_data import SubmissionBatchData as SubmissionBatchData
144
+ from docspring.models.submission_batch_with_submissions import SubmissionBatchWithSubmissions as SubmissionBatchWithSubmissions
145
+ from docspring.models.submission_data_request import SubmissionDataRequest as SubmissionDataRequest
146
+ from docspring.models.submission_data_request_event import SubmissionDataRequestEvent as SubmissionDataRequestEvent
147
+ from docspring.models.submission_data_request_show import SubmissionDataRequestShow as SubmissionDataRequestShow
148
+ from docspring.models.submission_data_request_token import SubmissionDataRequestToken as SubmissionDataRequestToken
149
+ from docspring.models.submission_preview import SubmissionPreview as SubmissionPreview
150
+ from docspring.models.success_error_response import SuccessErrorResponse as SuccessErrorResponse
151
+ from docspring.models.success_multiple_errors_response import SuccessMultipleErrorsResponse as SuccessMultipleErrorsResponse
152
+ from docspring.models.template import Template as Template
153
+ from docspring.models.template_add_fields_response import TemplateAddFieldsResponse as TemplateAddFieldsResponse
154
+ from docspring.models.template_delete_response import TemplateDeleteResponse as TemplateDeleteResponse
155
+ from docspring.models.template_model_code_response import TemplateModelCodeResponse as TemplateModelCodeResponse
156
+ from docspring.models.template_preview import TemplatePreview as TemplatePreview
157
+ from docspring.models.template_publish_version_response import TemplatePublishVersionResponse as TemplatePublishVersionResponse
158
+ from docspring.models.update_html_template import UpdateHtmlTemplate as UpdateHtmlTemplate
159
+ from docspring.models.update_pdf_template import UpdatePdfTemplate as UpdatePdfTemplate
160
+ from docspring.models.update_submission_data_request_data import UpdateSubmissionDataRequestData as UpdateSubmissionDataRequestData
161
+ from docspring.models.update_webhook_data import UpdateWebhookData as UpdateWebhookData
162
+ from docspring.models.upload_presign_response import UploadPresignResponse as UploadPresignResponse
163
+ from docspring.models.webhook import Webhook as Webhook
164
+
165
+ else:
166
+ from lazy_imports import LazyModule, as_package, load
167
+
168
+ load(
169
+ LazyModule(
170
+ *as_package(__file__),
171
+ ("__version__", __version__),
172
+ ("__all__", __all__),
173
+ """# import apis into sdk package
174
+ from docspring.api.client import Client as Client
175
+
176
+ # import ApiClient
177
+ from docspring.api_response import ApiResponse as ApiResponse
178
+ from docspring.api_client import ApiClient as ApiClient
179
+ from docspring.configuration import Configuration as Configuration
180
+ from docspring.exceptions import OpenApiException as OpenApiException
181
+ from docspring.exceptions import ApiTypeError as ApiTypeError
182
+ from docspring.exceptions import ApiValueError as ApiValueError
183
+ from docspring.exceptions import ApiKeyError as ApiKeyError
184
+ from docspring.exceptions import ApiAttributeError as ApiAttributeError
185
+ from docspring.exceptions import ApiException as ApiException
186
+
187
+ # import models into sdk package
188
+ from docspring.models.add_fields_data import AddFieldsData as AddFieldsData
189
+ from docspring.models.batch_generate_pdfs201_response import BatchGeneratePdfs201Response as BatchGeneratePdfs201Response
190
+ from docspring.models.combine_pdfs_data import CombinePdfsData as CombinePdfsData
191
+ from docspring.models.combined_submission import CombinedSubmission as CombinedSubmission
192
+ from docspring.models.combined_submission_action import CombinedSubmissionAction as CombinedSubmissionAction
193
+ from docspring.models.copy_template_options import CopyTemplateOptions as CopyTemplateOptions
194
+ from docspring.models.create_combined_submission_response import CreateCombinedSubmissionResponse as CreateCombinedSubmissionResponse
195
+ from docspring.models.create_custom_file_data import CreateCustomFileData as CreateCustomFileData
196
+ from docspring.models.create_custom_file_response import CreateCustomFileResponse as CreateCustomFileResponse
197
+ from docspring.models.create_folder_data import CreateFolderData as CreateFolderData
198
+ from docspring.models.create_html_template import CreateHtmlTemplate as CreateHtmlTemplate
199
+ from docspring.models.create_pdf_submission_data import CreatePdfSubmissionData as CreatePdfSubmissionData
200
+ from docspring.models.create_pdf_template import CreatePdfTemplate as CreatePdfTemplate
201
+ from docspring.models.create_submission_data_request_data import CreateSubmissionDataRequestData as CreateSubmissionDataRequestData
202
+ from docspring.models.create_submission_data_request_event_request import CreateSubmissionDataRequestEventRequest as CreateSubmissionDataRequestEventRequest
203
+ from docspring.models.create_submission_data_request_event_response import CreateSubmissionDataRequestEventResponse as CreateSubmissionDataRequestEventResponse
204
+ from docspring.models.create_submission_data_request_response import CreateSubmissionDataRequestResponse as CreateSubmissionDataRequestResponse
205
+ from docspring.models.create_submission_data_request_token_response import CreateSubmissionDataRequestTokenResponse as CreateSubmissionDataRequestTokenResponse
206
+ from docspring.models.create_submission_response import CreateSubmissionResponse as CreateSubmissionResponse
207
+ from docspring.models.create_webhook_data import CreateWebhookData as CreateWebhookData
208
+ from docspring.models.custom_file import CustomFile as CustomFile
209
+ from docspring.models.error_or_multiple_errors_response import ErrorOrMultipleErrorsResponse as ErrorOrMultipleErrorsResponse
210
+ from docspring.models.error_response import ErrorResponse as ErrorResponse
211
+ from docspring.models.folder import Folder as Folder
212
+ from docspring.models.json_schema import JsonSchema as JsonSchema
213
+ from docspring.models.list_submissions_response import ListSubmissionsResponse as ListSubmissionsResponse
214
+ from docspring.models.move_folder_data import MoveFolderData as MoveFolderData
215
+ from docspring.models.move_template_data import MoveTemplateData as MoveTemplateData
216
+ from docspring.models.multiple_errors_response import MultipleErrorsResponse as MultipleErrorsResponse
217
+ from docspring.models.publish_version_data import PublishVersionData as PublishVersionData
218
+ from docspring.models.rename_folder_data import RenameFolderData as RenameFolderData
219
+ from docspring.models.restore_version_data import RestoreVersionData as RestoreVersionData
220
+ from docspring.models.submission import Submission as Submission
221
+ from docspring.models.submission422_response import Submission422Response as Submission422Response
222
+ from docspring.models.submission_action import SubmissionAction as SubmissionAction
223
+ from docspring.models.submission_batch import SubmissionBatch as SubmissionBatch
224
+ from docspring.models.submission_batch_data import SubmissionBatchData as SubmissionBatchData
225
+ from docspring.models.submission_batch_with_submissions import SubmissionBatchWithSubmissions as SubmissionBatchWithSubmissions
226
+ from docspring.models.submission_data_request import SubmissionDataRequest as SubmissionDataRequest
227
+ from docspring.models.submission_data_request_event import SubmissionDataRequestEvent as SubmissionDataRequestEvent
228
+ from docspring.models.submission_data_request_show import SubmissionDataRequestShow as SubmissionDataRequestShow
229
+ from docspring.models.submission_data_request_token import SubmissionDataRequestToken as SubmissionDataRequestToken
230
+ from docspring.models.submission_preview import SubmissionPreview as SubmissionPreview
231
+ from docspring.models.success_error_response import SuccessErrorResponse as SuccessErrorResponse
232
+ from docspring.models.success_multiple_errors_response import SuccessMultipleErrorsResponse as SuccessMultipleErrorsResponse
233
+ from docspring.models.template import Template as Template
234
+ from docspring.models.template_add_fields_response import TemplateAddFieldsResponse as TemplateAddFieldsResponse
235
+ from docspring.models.template_delete_response import TemplateDeleteResponse as TemplateDeleteResponse
236
+ from docspring.models.template_model_code_response import TemplateModelCodeResponse as TemplateModelCodeResponse
237
+ from docspring.models.template_preview import TemplatePreview as TemplatePreview
238
+ from docspring.models.template_publish_version_response import TemplatePublishVersionResponse as TemplatePublishVersionResponse
239
+ from docspring.models.update_html_template import UpdateHtmlTemplate as UpdateHtmlTemplate
240
+ from docspring.models.update_pdf_template import UpdatePdfTemplate as UpdatePdfTemplate
241
+ from docspring.models.update_submission_data_request_data import UpdateSubmissionDataRequestData as UpdateSubmissionDataRequestData
242
+ from docspring.models.update_webhook_data import UpdateWebhookData as UpdateWebhookData
243
+ from docspring.models.upload_presign_response import UploadPresignResponse as UploadPresignResponse
244
+ from docspring.models.webhook import Webhook as Webhook
245
+
246
+ """,
247
+ name=__name__,
248
+ doc=__doc__,
249
+ )
250
+ )
@@ -0,0 +1,20 @@
1
+ # flake8: noqa
2
+
3
+ if __import__("typing").TYPE_CHECKING:
4
+ # import apis into api package
5
+ from docspring.api.client import Client
6
+
7
+ else:
8
+ from lazy_imports import LazyModule, as_package, load
9
+
10
+ load(
11
+ LazyModule(
12
+ *as_package(__file__),
13
+ """# import apis into api package
14
+ from docspring.api.client import Client
15
+
16
+ """,
17
+ name=__name__,
18
+ doc=__doc__,
19
+ )
20
+ )