DocSpring.Client.Api.PDFApi

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

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

AddFieldsToTemplate

AddFieldsTemplateResponse AddFieldsToTemplate (string templateId, AddFieldsData addFieldsData)

Add new fields to a Template

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class AddFieldsToTemplateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var templateId = tpl_000000000000000002;  // string | 
            var addFieldsData = new AddFieldsData(); // AddFieldsData | 

            try
            {
                // Add new fields to a Template
                AddFieldsTemplateResponse result = apiInstance.AddFieldsToTemplate(templateId, addFieldsData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.AddFieldsToTemplate: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
templateId	string
addFieldsData	AddFieldsData

Return type

AddFieldsTemplateResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BatchGeneratePdfV1

List BatchGeneratePdfV1 (string templateId, List requestBody)

Generates multiple PDFs

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class BatchGeneratePdfV1Example
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var templateId = tpl_000000000000000001;  // string | 
            var requestBody = new List<Object>(); // List<Object> | 

            try
            {
                // Generates multiple PDFs
                List&lt;CreateSubmissionResponse&gt; result = apiInstance.BatchGeneratePdfV1(templateId, requestBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.BatchGeneratePdfV1: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
templateId	string
requestBody	List<Object>

Return type

List

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BatchGeneratePdfs

CreateSubmissionBatchResponse BatchGeneratePdfs (SubmissionBatchData submissionBatchData)

Generates multiple PDFs

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class BatchGeneratePdfsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var submissionBatchData = new SubmissionBatchData(); // SubmissionBatchData | 

            try
            {
                // Generates multiple PDFs
                CreateSubmissionBatchResponse result = apiInstance.BatchGeneratePdfs(submissionBatchData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.BatchGeneratePdfs: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
submissionBatchData	SubmissionBatchData

Return type

CreateSubmissionBatchResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CombinePdfs

CreateCombinedSubmissionResponse CombinePdfs (CombinePdfsData combinePdfsData)

Merge submission PDFs, template PDFs, or custom files

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class CombinePdfsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var combinePdfsData = new CombinePdfsData(); // CombinePdfsData | 

            try
            {
                // Merge submission PDFs, template PDFs, or custom files
                CreateCombinedSubmissionResponse result = apiInstance.CombinePdfs(combinePdfsData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.CombinePdfs: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
combinePdfsData	CombinePdfsData

Return type

CreateCombinedSubmissionResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CombineSubmissions

CreateCombinedSubmissionResponse CombineSubmissions (CombinedSubmissionData combinedSubmissionData)

Merge generated PDFs together

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class CombineSubmissionsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var combinedSubmissionData = new CombinedSubmissionData(); // CombinedSubmissionData | 

            try
            {
                // Merge generated PDFs together
                CreateCombinedSubmissionResponse result = apiInstance.CombineSubmissions(combinedSubmissionData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.CombineSubmissions: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
combinedSubmissionData	CombinedSubmissionData

Return type

CreateCombinedSubmissionResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CopyTemplate

Template CopyTemplate (string templateId, CopyTemplateData copyTemplateData)

Copy a Template

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class CopyTemplateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var templateId = tpl_000000000000000001;  // string | 
            var copyTemplateData = new CopyTemplateData(); // CopyTemplateData | 

            try
            {
                // Copy a Template
                Template result = apiInstance.CopyTemplate(templateId, copyTemplateData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.CopyTemplate: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
templateId	string
copyTemplateData	CopyTemplateData

Return type

Template

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateCustomFileFromUpload

CreateCustomFileResponse CreateCustomFileFromUpload (CreateCustomFileData createCustomFileData)

Create a new custom file from a cached presign upload

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class CreateCustomFileFromUploadExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var createCustomFileData = new CreateCustomFileData(); // CreateCustomFileData | 

            try
            {
                // Create a new custom file from a cached presign upload
                CreateCustomFileResponse result = apiInstance.CreateCustomFileFromUpload(createCustomFileData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.CreateCustomFileFromUpload: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
createCustomFileData	CreateCustomFileData

Return type

CreateCustomFileResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateDataRequestToken

CreateSubmissionDataRequestTokenResponse CreateDataRequestToken (string dataRequestId)

Creates a new data request token for form authentication

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class CreateDataRequestTokenExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var dataRequestId = drq_000000000000000001;  // string | 

            try
            {
                // Creates a new data request token for form authentication
                CreateSubmissionDataRequestTokenResponse result = apiInstance.CreateDataRequestToken(dataRequestId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.CreateDataRequestToken: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
dataRequestId	string

Return type

CreateSubmissionDataRequestTokenResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateFolder

Folder CreateFolder (CreateFolderData createFolderData)

Create a folder

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class CreateFolderExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var createFolderData = new CreateFolderData(); // CreateFolderData | 

            try
            {
                // Create a folder
                Folder result = apiInstance.CreateFolder(createFolderData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.CreateFolder: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
createFolderData	CreateFolderData

Return type

Folder

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateHTMLTemplate

PendingTemplate CreateHTMLTemplate (CreateHtmlTemplateData createHtmlTemplateData)

Create a new HTML template

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class CreateHTMLTemplateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var createHtmlTemplateData = new CreateHtmlTemplateData(); // CreateHtmlTemplateData | 

            try
            {
                // Create a new HTML template
                PendingTemplate result = apiInstance.CreateHTMLTemplate(createHtmlTemplateData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.CreateHTMLTemplate: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
createHtmlTemplateData	CreateHtmlTemplateData

Return type

PendingTemplate

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreatePDFTemplate

PendingTemplate CreatePDFTemplate (System.IO.Stream templateDocument, string templateName, string templateParentFolderId = null)

Create a new PDF template with a form POST file upload

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class CreatePDFTemplateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var templateDocument = BINARY_DATA_HERE;  // System.IO.Stream | 
            var templateName = templateName_example;  // string | 
            var templateParentFolderId = templateParentFolderId_example;  // string |  (optional) 

            try
            {
                // Create a new PDF template with a form POST file upload
                PendingTemplate result = apiInstance.CreatePDFTemplate(templateDocument, templateName, templateParentFolderId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.CreatePDFTemplate: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
templateDocument	System.IO.Stream
templateName	string
templateParentFolderId	string	[optional]

Return type

PendingTemplate

Authorization

api_token_basic

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreatePDFTemplateFromUpload

PendingTemplate CreatePDFTemplateFromUpload (CreateTemplateFromUploadData createTemplateFromUploadData)

Create a new PDF template from a cached presign upload

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class CreatePDFTemplateFromUploadExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var createTemplateFromUploadData = new CreateTemplateFromUploadData(); // CreateTemplateFromUploadData | 

            try
            {
                // Create a new PDF template from a cached presign upload
                PendingTemplate result = apiInstance.CreatePDFTemplateFromUpload(createTemplateFromUploadData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.CreatePDFTemplateFromUpload: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
createTemplateFromUploadData	CreateTemplateFromUploadData

Return type

PendingTemplate

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteFolder

Folder DeleteFolder (string folderId)

Delete a folder

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class DeleteFolderExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var folderId = fld_000000000000000001;  // string | 

            try
            {
                // Delete a folder
                Folder result = apiInstance.DeleteFolder(folderId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.DeleteFolder: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
folderId	string

Return type

Folder

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ExpireCombinedSubmission

CombinedSubmission ExpireCombinedSubmission (string combinedSubmissionId)

Expire a combined submission

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class ExpireCombinedSubmissionExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var combinedSubmissionId = com_000000000000000001;  // string | 

            try
            {
                // Expire a combined submission
                CombinedSubmission result = apiInstance.ExpireCombinedSubmission(combinedSubmissionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.ExpireCombinedSubmission: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
combinedSubmissionId	string

Return type

CombinedSubmission

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ExpireSubmission

Submission ExpireSubmission (string submissionId)

Expire a PDF submission

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class ExpireSubmissionExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var submissionId = sub_000000000000000001;  // string | 

            try
            {
                // Expire a PDF submission
                Submission result = apiInstance.ExpireSubmission(submissionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.ExpireSubmission: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
submissionId	string

Return type

Submission

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GeneratePDF

CreateSubmissionResponse GeneratePDF (string templateId, SubmissionData submissionData)

Generates a new PDF

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class GeneratePDFExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var templateId = tpl_000000000000000001;  // string | 
            var submissionData = new SubmissionData(); // SubmissionData | 

            try
            {
                // Generates a new PDF
                CreateSubmissionResponse result = apiInstance.GeneratePDF(templateId, submissionData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.GeneratePDF: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
templateId	string
submissionData	SubmissionData

Return type

CreateSubmissionResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCombinedSubmission

CombinedSubmission GetCombinedSubmission (string combinedSubmissionId)

Check the status of a combined submission (merged PDFs)

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class GetCombinedSubmissionExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var combinedSubmissionId = com_000000000000000001;  // string | 

            try
            {
                // Check the status of a combined submission (merged PDFs)
                CombinedSubmission result = apiInstance.GetCombinedSubmission(combinedSubmissionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.GetCombinedSubmission: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
combinedSubmissionId	string

Return type

CombinedSubmission

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDataRequest

SubmissionDataRequest GetDataRequest (string dataRequestId)

Look up a submission data request

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class GetDataRequestExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var dataRequestId = drq_000000000000000001;  // string | 

            try
            {
                // Look up a submission data request
                SubmissionDataRequest result = apiInstance.GetDataRequest(dataRequestId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.GetDataRequest: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
dataRequestId	string

Return type

SubmissionDataRequest

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetFullTemplate

Template1 GetFullTemplate (string templateId)

Fetch the full template attributes

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class GetFullTemplateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var templateId = tpl_000000000000000001;  // string | 

            try
            {
                // Fetch the full template attributes
                Template1 result = apiInstance.GetFullTemplate(templateId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.GetFullTemplate: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
templateId	string

Return type

Template1

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPresignUrl

Dictionary<string, Object> GetPresignUrl ()

Get a presigned URL so that you can upload a file to our AWS S3 bucket

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class GetPresignUrlExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();

            try
            {
                // Get a presigned URL so that you can upload a file to our AWS S3 bucket
                Dictionary&lt;string, Object&gt; result = apiInstance.GetPresignUrl();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.GetPresignUrl: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Dictionary<string, Object>

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSubmission

Submission GetSubmission (string submissionId, bool? includeData = null)

Check the status of a PDF

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class GetSubmissionExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var submissionId = sub_000000000000000001;  // string | 
            var includeData = true;  // bool? |  (optional) 

            try
            {
                // Check the status of a PDF
                Submission result = apiInstance.GetSubmission(submissionId, includeData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.GetSubmission: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
submissionId	string
includeData	bool?		[optional]

Return type

Submission

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSubmissionBatch

SubmissionBatch GetSubmissionBatch (string submissionBatchId, bool? includeSubmissions = null)

Check the status of a submission batch job

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class GetSubmissionBatchExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var submissionBatchId = sbb_000000000000000001;  // string | 
            var includeSubmissions = true;  // bool? |  (optional) 

            try
            {
                // Check the status of a submission batch job
                SubmissionBatch result = apiInstance.GetSubmissionBatch(submissionBatchId, includeSubmissions);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.GetSubmissionBatch: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
submissionBatchId	string
includeSubmissions	bool?		[optional]

Return type

SubmissionBatch

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTemplate

Template GetTemplate (string templateId)

Check the status of an uploaded template

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class GetTemplateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var templateId = tpl_000000000000000001;  // string | 

            try
            {
                // Check the status of an uploaded template
                Template result = apiInstance.GetTemplate(templateId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.GetTemplate: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
templateId	string

Return type

Template

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTemplateSchema

Dictionary<string, Object> GetTemplateSchema (string templateId)

Fetch the JSON schema for a template

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class GetTemplateSchemaExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var templateId = tpl_000000000000000001;  // string | 

            try
            {
                // Fetch the JSON schema for a template
                Dictionary&lt;string, Object&gt; result = apiInstance.GetTemplateSchema(templateId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.GetTemplateSchema: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
templateId	string

Return type

Dictionary<string, Object>

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListFolders

List ListFolders (string parentFolderId = null)

Get a list of all folders

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class ListFoldersExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var parentFolderId = fld_000000000000000002;  // string | Filter By Folder Id (optional) 

            try
            {
                // Get a list of all folders
                List&lt;Folder&gt; result = apiInstance.ListFolders(parentFolderId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.ListFolders: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
parentFolderId	string	Filter By Folder Id	[optional]

Return type

List

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListSubmissions

ListSubmissionsResponse ListSubmissions (string cursor = null, decimal? limit = null, string createdAfter = null, string createdBefore = null, string type = null, bool? includeData = null)

List all submissions

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class ListSubmissionsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var cursor = sub_list_000012;  // string |  (optional) 
            var limit = 3;  // decimal? |  (optional) 
            var createdAfter = 2019-01-01T09:00:00-05:00;  // string |  (optional) 
            var createdBefore = 2020-01-01T09:00:00-05:00;  // string |  (optional) 
            var type = test;  // string |  (optional) 
            var includeData = true;  // bool? |  (optional) 

            try
            {
                // List all submissions
                ListSubmissionsResponse result = apiInstance.ListSubmissions(cursor, limit, createdAfter, createdBefore, type, includeData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.ListSubmissions: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
cursor	string	[optional]
limit	decimal?	[optional]
createdAfter	string	[optional]
createdBefore	string	[optional]
type	string	[optional]
includeData	bool?	[optional]

Return type

ListSubmissionsResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListSubmissions_0

ListSubmissionsResponse ListSubmissions_0 (string templateId, string cursor = null, decimal? limit = null, string createdAfter = null, string createdBefore = null, string type = null, bool? includeData = null)

List all submissions for a given template

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class ListSubmissions_0Example
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var templateId = tpl_000000000000000002;  // string | 
            var cursor = cursor_example;  // string |  (optional) 
            var limit = 8.14;  // decimal? |  (optional) 
            var createdAfter = createdAfter_example;  // string |  (optional) 
            var createdBefore = createdBefore_example;  // string |  (optional) 
            var type = type_example;  // string |  (optional) 
            var includeData = true;  // bool? |  (optional) 

            try
            {
                // List all submissions for a given template
                ListSubmissionsResponse result = apiInstance.ListSubmissions_0(templateId, cursor, limit, createdAfter, createdBefore, type, includeData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.ListSubmissions_0: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
templateId	string
cursor	string	[optional]
limit	decimal?	[optional]
createdAfter	string	[optional]
createdBefore	string	[optional]
type	string	[optional]
includeData	bool?	[optional]

Return type

ListSubmissionsResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListTemplates

List ListTemplates (string query = null, string parentFolderId = null, int? page = null, int? perPage = null)

Get a list of all templates

Example

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class ListTemplatesExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: api_token_basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PDFApi();
            var query = 2;  // string | Search By Name (optional) 
            var parentFolderId = fld_000000000000000001;  // string | Filter By Folder Id (optional) 
            var page = 2;  // int? | Default: 1 (optional) 
            var perPage = 1;  // int? | Default: 50 (optional) 

            try
            {
                // Get a list of all templates
                List&lt;Template&gt; result = apiInstance.ListTemplates(query, parentFolderId, page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDFApi.ListTemplates: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
query	string	Search By Name	[optional]
parentFolderId	string	Filter By Folder Id	[optional]
page	int?	Default: 1	[optional]
perPage	int?	Default: 50	[optional]

Return type

List

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined

Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MoveFolderToFolder

Folder MoveFolderToFolder (string folderId, MoveFolderData moveFolderData)

Move a folder

Example

using System; using System.Diagnostics; using DocSpring.Client.Api; using DocSpring.Client.Client; using DocSpring.Client.Model; namespace Example { public class MoveFolderToFolderExample { public void main() { // Configure HTTP basic authorization: api_token_basic Configuration.Default.Username = "YOUR_USERNAME"; Configuration.Default.Password = "YOUR_PASSWORD"; var apiInstance = new PDFApi(); var folderId = fld_000000000000000001; // string | var moveFolderData = new MoveFolderData(); // MoveFolderData | try { // Move a folder Folder result = apiInstance.MoveFolderToFolder(folderId, moveFolderData); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling PDFApi.MoveFolderToFolder: " + e.Message ); } } } }

Parameters

Name Type Description Notes

folderId string

moveFolderData MoveFolderData

Return type

Folder

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json

Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MoveTemplateToFolder

Template MoveTemplateToFolder (string templateId, MoveTemplateData moveTemplateData)

Move Template to folder

Example

using System; using System.Diagnostics; using DocSpring.Client.Api; using DocSpring.Client.Client; using DocSpring.Client.Model; namespace Example { public class MoveTemplateToFolderExample { public void main() { // Configure HTTP basic authorization: api_token_basic Configuration.Default.Username = "YOUR_USERNAME"; Configuration.Default.Password = "YOUR_PASSWORD"; var apiInstance = new PDFApi(); var templateId = tpl_000000000000000001; // string | var moveTemplateData = new MoveTemplateData(); // MoveTemplateData | try { // Move Template to folder Template result = apiInstance.MoveTemplateToFolder(templateId, moveTemplateData); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling PDFApi.MoveTemplateToFolder: " + e.Message ); } } } }

Parameters

Name Type Description Notes

templateId string

moveTemplateData MoveTemplateData

Return type

Template

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json

Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RenameFolder

void RenameFolder (string folderId, RenameFolderData renameFolderData)

Rename a folder

Example

using System; using System.Diagnostics; using DocSpring.Client.Api; using DocSpring.Client.Client; using DocSpring.Client.Model; namespace Example { public class RenameFolderExample { public void main() { // Configure HTTP basic authorization: api_token_basic Configuration.Default.Username = "YOUR_USERNAME"; Configuration.Default.Password = "YOUR_PASSWORD"; var apiInstance = new PDFApi(); var folderId = fld_000000000000000001; // string | var renameFolderData = new RenameFolderData(); // RenameFolderData | try { // Rename a folder apiInstance.RenameFolder(folderId, renameFolderData); } catch (Exception e) { Debug.Print("Exception when calling PDFApi.RenameFolder: " + e.Message ); } } } }

Parameters

Name Type Description Notes

folderId string

renameFolderData RenameFolderData

Return type

void (empty response body)

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json

Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TestAuthentication

AuthenticationSuccessResponse TestAuthentication ()

Test Authentication

Example

using System; using System.Diagnostics; using DocSpring.Client.Api; using DocSpring.Client.Client; using DocSpring.Client.Model; namespace Example { public class TestAuthenticationExample { public void main() { // Configure HTTP basic authorization: api_token_basic Configuration.Default.Username = "YOUR_USERNAME"; Configuration.Default.Password = "YOUR_PASSWORD"; var apiInstance = new PDFApi(); try { // Test Authentication AuthenticationSuccessResponse result = apiInstance.TestAuthentication(); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling PDFApi.TestAuthentication: " + e.Message ); } } } }

Parameters

This endpoint does not need any parameter.

Return type

AuthenticationSuccessResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined

Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateDataRequest

UpdateDataRequestResponse UpdateDataRequest (string dataRequestId, UpdateSubmissionDataRequestData updateSubmissionDataRequestData)

Update a submission data request

Example

using System; using System.Diagnostics; using DocSpring.Client.Api; using DocSpring.Client.Client; using DocSpring.Client.Model; namespace Example { public class UpdateDataRequestExample { public void main() { // Configure HTTP basic authorization: api_token_basic Configuration.Default.Username = "YOUR_USERNAME"; Configuration.Default.Password = "YOUR_PASSWORD"; var apiInstance = new PDFApi(); var dataRequestId = drq_000000000000000001; // string | var updateSubmissionDataRequestData = new UpdateSubmissionDataRequestData(); // UpdateSubmissionDataRequestData | try { // Update a submission data request UpdateDataRequestResponse result = apiInstance.UpdateDataRequest(dataRequestId, updateSubmissionDataRequestData); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling PDFApi.UpdateDataRequest: " + e.Message ); } } } }

Parameters

Name Type Description Notes

dataRequestId string

updateSubmissionDataRequestData UpdateSubmissionDataRequestData

Return type

UpdateDataRequestResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json

Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTemplate

UpdateTemplateResponse UpdateTemplate (string templateId, UpdateTemplateData updateTemplateData)

Update a Template

Example

using System; using System.Diagnostics; using DocSpring.Client.Api; using DocSpring.Client.Client; using DocSpring.Client.Model; namespace Example { public class UpdateTemplateExample { public void main() { // Configure HTTP basic authorization: api_token_basic Configuration.Default.Username = "YOUR_USERNAME"; Configuration.Default.Password = "YOUR_PASSWORD"; var apiInstance = new PDFApi(); var templateId = tpl_000000000000000003; // string | var updateTemplateData = new UpdateTemplateData(); // UpdateTemplateData | try { // Update a Template UpdateTemplateResponse result = apiInstance.UpdateTemplate(templateId, updateTemplateData); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling PDFApi.UpdateTemplate: " + e.Message ); } } } }

Parameters

Name Type Description Notes

templateId string

updateTemplateData UpdateTemplateData

Return type

UpdateTemplateResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: application/json

Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Name	Type	Description	Notes
templateId	string
moveTemplateData	MoveTemplateData

Name	Type	Description	Notes
folderId	string
renameFolderData	RenameFolderData

Name	Type	Description	Notes
dataRequestId	string
updateSubmissionDataRequestData	UpdateSubmissionDataRequestData

Name	Type	Description	Notes
templateId	string
updateTemplateData	UpdateTemplateData

Files

PDFApi.md

Latest commit

History

PDFApi.md

File metadata and controls

DocSpring.Client.Api.PDFApi

AddFieldsToTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

BatchGeneratePdfV1

Example

Parameters

Return type

Authorization

HTTP request headers

BatchGeneratePdfs

Example

Parameters

Return type

Authorization

HTTP request headers

CombinePdfs

Example

Parameters

Return type

Authorization

HTTP request headers

CombineSubmissions

Example

Parameters

Return type

Authorization

HTTP request headers

CopyTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

CreateCustomFileFromUpload

Example

Parameters

Return type

Authorization

HTTP request headers

CreateDataRequestToken

Example

Parameters

Return type

Authorization

HTTP request headers

CreateFolder

Example

Parameters

Return type

Authorization

HTTP request headers

CreateHTMLTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

CreatePDFTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

CreatePDFTemplateFromUpload

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteFolder