docspring

Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: 3.1.0
• Generator version: 7.16.0-DOCSPRING
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/DocSpring/docspring-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/DocSpring/docspring-python.git)

Then import the package:

import docspring

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import docspring

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import docspring
from docspring.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://sync.api.docspring.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = docspring.Configuration(
    host = "https://sync.api.docspring.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: api_token_basic
configuration = docspring.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
with docspring.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = docspring.Client(api_client)
    template_id = 'tpl_1234567890abcdef02' # str | 
    data = docspring.AddFieldsData() # AddFieldsData | 

    try:
        # Add new fields to a Template
        api_response = api_instance.add_fields_to_template(template_id, data)
        print("The response of Client->add_fields_to_template:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling Client->add_fields_to_template: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://sync.api.docspring.com/api/v1

Documentation For Models

• AddFieldsData
• BatchGeneratePdfs201Response
• CombinePdfsData
• CombinedSubmission
• CombinedSubmissionAction
• CopyTemplateOptions
• CreateCombinedSubmissionResponse
• CreateCustomFileData
• CreateCustomFileResponse
• CreateFolderData
• CreateHtmlTemplate
• CreatePdfSubmissionData
• CreatePdfTemplate
• CreateSubmissionDataRequestData
• CreateSubmissionDataRequestEventRequest
• CreateSubmissionDataRequestEventResponse
• CreateSubmissionDataRequestResponse
• CreateSubmissionDataRequestTokenResponse
• CreateSubmissionResponse
• CreateWebhookData
• CustomFile
• ErrorOrMultipleErrorsResponse
• ErrorResponse
• Folder
• JsonSchema
• ListSubmissionsResponse
• MoveFolderData
• MoveTemplateData
• MultipleErrorsResponse
• PublishVersionData
• RenameFolderData
• RestoreVersionData
• Submission
• Submission422Response
• SubmissionAction
• SubmissionBatch
• SubmissionBatchData
• SubmissionBatchWithSubmissions
• SubmissionDataRequest
• SubmissionDataRequestEvent
• SubmissionDataRequestShow
• SubmissionDataRequestToken
• SubmissionPreview
• SuccessErrorResponse
• SuccessMultipleErrorsResponse
• Template
• TemplateAddFieldsResponse
• TemplateDeleteResponse
• TemplateModelCodeResponse
• TemplatePreview
• TemplatePublishVersionResponse
• UpdateHtmlTemplate
• UpdatePdfTemplate
• UpdateSubmissionDataRequestData
• UpdateWebhookData
• UploadPresignResponse
• Webhook

Documentation For Authorization

Authentication schemes defined for the API:

api_token_basic

• Type: HTTP basic authentication

Author

support@docspring.com