Skip to content

DocSpring/docspring-python

BranchesTags

Repository files navigation

docspring

DocSpring provides an API that helps you fill out and sign PDF templates.

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

  • API version: v1
  • Package version: 2.0.0
  • Generator version: 7.11.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

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

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.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.PDFApi(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 PDFApi->add_fields_to_template:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PDFApi->add_fields_to_template: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
PDFApi add_fields_to_template PUT /templates/{template_id}/add_fields Add new fields to a Template
PDFApi batch_generate_pdfs POST /submissions/batches Generates multiple PDFs
PDFApi combine_pdfs POST /combined_submissions?v=2 Merge submission PDFs, template PDFs, or custom files
PDFApi combine_submissions POST /combined_submissions Merge generated PDFs together
PDFApi copy_template POST /templates/{template_id}/copy Copy a Template
PDFApi create_custom_file_from_upload POST /custom_files Create a new custom file from a cached presign upload
PDFApi create_data_request_event POST /data_requests/{data_request_id}/events Creates a new event for emailing a signee a request for signature
PDFApi create_data_request_token POST /data_requests/{data_request_id}/tokens Creates a new data request token for form authentication
PDFApi create_folder POST /folders/ Create a folder
PDFApi create_html_template POST /templates?endpoint_description=html Create a new HTML template
PDFApi create_pdf_template POST /templates Create a new PDF template with a form POST file upload
PDFApi create_pdf_template_from_upload POST /templates?endpoint_description=cached_upload Create a new PDF template from a cached presign upload
PDFApi delete_folder DELETE /folders/{folder_id} Delete a folder
PDFApi delete_template DELETE /templates/{template_id} Delete a template
PDFApi expire_combined_submission DELETE /combined_submissions/{combined_submission_id} Expire a combined submission
PDFApi expire_submission DELETE /submissions/{submission_id} Expire a PDF submission
PDFApi generate_pdf POST /templates/{template_id}/submissions Generates a new PDF
PDFApi generate_pdf_for_html_template POST /templates/{template_id}/submissions?endpoint_description=html_templates Generates a new PDF for an HTML template
PDFApi generate_preview POST /submissions/{submission_id}/generate_preview Generated a preview PDF for partially completed data requests
PDFApi get_combined_submission GET /combined_submissions/{combined_submission_id} Check the status of a combined submission (merged PDFs)
PDFApi get_data_request GET /data_requests/{data_request_id} Look up a submission data request
PDFApi get_full_template GET /templates/{template_id}?full=true Fetch the full template attributes
PDFApi get_presign_url GET /uploads/presign Get a presigned URL so that you can upload a file to our AWS S3 bucket
PDFApi get_submission GET /submissions/{submission_id} Check the status of a PDF
PDFApi get_submission_batch GET /submissions/batches/{submission_batch_id} Check the status of a submission batch job
PDFApi get_template GET /templates/{template_id} Check the status of an uploaded template
PDFApi get_template_schema GET /templates/{template_id}/schema Fetch the JSON schema for a template
PDFApi list_combined_submissions GET /combined_submissions Get a list of all combined submissions
PDFApi list_folders GET /folders/ Get a list of all folders
PDFApi list_submissions GET /submissions List all submissions
PDFApi list_template_submissions GET /templates/{template_id}/submissions List all submissions for a given template
PDFApi list_templates GET /templates Get a list of all templates
PDFApi move_folder_to_folder POST /folders/{folder_id}/move Move a folder
PDFApi move_template_to_folder POST /templates/{template_id}/move Move Template to folder
PDFApi rename_folder POST /folders/{folder_id}/rename Rename a folder
PDFApi test_authentication GET /authentication Test Authentication
PDFApi update_data_request PUT /data_requests/{data_request_id} Update a submission data request
PDFApi update_template PUT /templates/{template_id} Update a Template

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

api_token_basic

  • Type: HTTP basic authentication

Author

About

Python API Client for DocSpring

pypi.org/project/docspring/

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

3 watching

Forks

2 forks
Report repository

Releases

7 tags

Packages

No packages published

Languages