Go API client for docspring

DocSpring is a service that helps you fill out and sign PDF templates.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: v1
• Package version: 1.0.1
• Build package: com.docspring.codegen.DocSpringGoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./docspring"

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
PDFApi	AddFieldsToTemplate	Put /templates/{template_id}/add_fields	Add new fields to a Template
PDFApi	BatchGeneratePdfV1	Post /templates/{template_id}/submissions/batch	Generates multiple PDFs
PDFApi	BatchGeneratePdfs	Post /submissions/batches	Generates multiple PDFs
PDFApi	CombinePdfs	Post /combined_submissions?v=2	Merge submission PDFs, template PDFs, or custom files
PDFApi	CombineSubmissions	Post /combined_submissions	Merge generated PDFs together
PDFApi	CopyTemplate	Post /templates/{template_id}/copy	Copy a Template
PDFApi	CreateCustomFileFromUpload	Post /custom_files	Create a new custom file from a cached presign upload
PDFApi	CreateDataRequestToken	Post /data_requests/{data_request_id}/tokens	Creates a new data request token for form authentication
PDFApi	CreateFolder	Post /folders/	Create a folder
PDFApi	CreateHTMLTemplate	Post /templates?desc=html	Create a new HTML template
PDFApi	CreatePDFTemplate	Post /templates	Create a new PDF template with a form POST file upload
PDFApi	CreatePDFTemplateFromUpload	Post /templates?desc=cached_upload	Create a new PDF template from a cached presign upload
PDFApi	DeleteFolder	Delete /folders/{folder_id}	Delete a folder
PDFApi	ExpireCombinedSubmission	Delete /combined_submissions/{combined_submission_id}	Expire a combined submission
PDFApi	ExpireSubmission	Delete /submissions/{submission_id}	Expire a PDF submission
PDFApi	GeneratePDF	Post /templates/{template_id}/submissions	Generates a new PDF
PDFApi	GetCombinedSubmission	Get /combined_submissions/{combined_submission_id}	Check the status of a combined submission (merged PDFs)
PDFApi	GetDataRequest	Get /data_requests/{data_request_id}	Look up a submission data request
PDFApi	GetFullTemplate	Get /templates/{template_id}?full=true	Fetch the full template attributes
PDFApi	GetPresignUrl	Get /uploads/presign	Get a presigned URL so that you can upload a file to our AWS S3 bucket
PDFApi	GetSubmission	Get /submissions/{submission_id}	Check the status of a PDF
PDFApi	GetSubmissionBatch	Get /submissions/batches/{submission_batch_id}	Check the status of a submission batch job
PDFApi	GetTemplate	Get /templates/{template_id}	Check the status of an uploaded template
PDFApi	GetTemplateSchema	Get /templates/{template_id}/schema	Fetch the JSON schema for a template
PDFApi	ListFolders	Get /folders/	Get a list of all folders
PDFApi	ListSubmissions	Get /submissions	List all submissions
PDFApi	ListSubmissions_0	Get /templates/{template_id}/submissions	List all submissions for a given template
PDFApi	ListTemplates	Get /templates	Get a list of all templates
PDFApi	MoveFolderToFolder	Post /folders/{folder_id}/move	Move a folder
PDFApi	MoveTemplateToFolder	Post /templates/{template_id}/move	Move Template to folder
PDFApi	RenameFolder	Post /folders/{folder_id}/rename	Rename a folder
PDFApi	TestAuthentication	Get /authentication	Test Authentication
PDFApi	UpdateDataRequest	Put /data_requests/{data_request_id}	Update a submission data request
PDFApi	UpdateTemplate	Put /templates/{template_id}	Update a Template

Documentation For Models

• AddFieldsData
• AddFieldsTemplateResponse
• AuthenticationError
• AuthenticationSuccessResponse
• CombinePdfsData
• CombinedSubmission
• CombinedSubmissionAction
• CombinedSubmissionData
• CopyTemplateData
• CreateCombinedSubmissionResponse
• CreateCustomFileData
• CreateCustomFileResponse
• CreateFolderData
• CreateHtmlTemplateData
• CreateSubmissionBatchResponse
• CreateSubmissionBatchSubmissionsResponse
• CreateSubmissionDataRequestData
• CreateSubmissionDataRequestTokenResponse
• CreateSubmissionDataRequestTokenResponseToken
• CreateSubmissionResponse
• CreateTemplateFromUploadData
• CustomFile
• Folder
• FoldersFolder
• HtmlTemplateData
• InvalidRequest
• ListSubmissionsResponse
• ModelError
• MoveFolderData
• MoveTemplateData
• PendingTemplate
• RenameFolderData
• Submission
• SubmissionAction
• SubmissionBatch
• SubmissionBatchData
• SubmissionData
• SubmissionDataBatchRequest
• SubmissionDataRequest
• Template
• Template1
• Template1Defaults
• TemplateData
• TemplatestemplateIdaddFieldsFields
• UpdateDataRequestResponse
• UpdateSubmissionDataRequestData
• UpdateTemplateData
• UpdateTemplateResponse
• UploadTemplateData
• UploadTemplateDataDocument
• UploadTemplateDataDocumentMetadata

Documentation For Authorization

api_token_basic

• Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author