Uses of Class
com.docspring.ApiException

Packages that use ApiException

Package	Description
com.docspring
com.docspring.auth

Uses of ApiException in com.docspring

Methods in com.docspring that throw ApiException

Modifier and Type	Method	Description
TemplateAddFieldsResponse	Client.addFieldsToTemplate(String templateId, AddFieldsData data)	Add new fields to a Template Adds fields to a PDF template.
ApiResponse<TemplateAddFieldsResponse>	Client.addFieldsToTemplateWithHttpInfo(String templateId, AddFieldsData data)	Add new fields to a Template Adds fields to a PDF template.
BatchGeneratePdfs201Response	Client.batchGeneratePdfs(SubmissionBatchData data, Boolean wait)	Generate multiple PDFs Generates up to 50 PDFs in a single request.
ApiResponse<BatchGeneratePdfs201Response>	Client.batchGeneratePdfsWithHttpInfo(SubmissionBatchData data, Boolean wait)	Generate multiple PDFs Generates up to 50 PDFs in a single request.
CreateCombinedSubmissionResponse	Client.combinePdfs(CombinePdfsData data)	Merge submission PDFs, template PDFs, or custom files Combines multiple PDFs from various sources into a single PDF file.
ApiResponse<CreateCombinedSubmissionResponse>	Client.combinePdfsWithHttpInfo(CombinePdfsData data)	Merge submission PDFs, template PDFs, or custom files Combines multiple PDFs from various sources into a single PDF file.
TemplatePreview	Client.copyTemplate(String templateId, CopyTemplateOptions options)	Copy a template Creates a copy of an existing template with all its fields and configuration.
ApiResponse<TemplatePreview>	Client.copyTemplateWithHttpInfo(String templateId, CopyTemplateOptions options)	Copy a template Creates a copy of an existing template with all its fields and configuration.
CreateCustomFileResponse	Client.createCustomFileFromUpload(CreateCustomFileData data)	Create a new custom file from a cached S3 upload The Custom Files API endpoint allows you to upload PDFs to DocSpring and then merge them with other PDFs.
ApiResponse<CreateCustomFileResponse>	Client.createCustomFileFromUploadWithHttpInfo(CreateCustomFileData data)	Create a new custom file from a cached S3 upload The Custom Files API endpoint allows you to upload PDFs to DocSpring and then merge them with other PDFs.
CreateSubmissionDataRequestEventResponse	Client.createDataRequestEvent(String dataRequestId, CreateSubmissionDataRequestEventRequest event)	Create a new event for emailing a signee a request for signature Records user notification events for data requests.
ApiResponse<CreateSubmissionDataRequestEventResponse>	Client.createDataRequestEventWithHttpInfo(String dataRequestId, CreateSubmissionDataRequestEventRequest event)	Create a new event for emailing a signee a request for signature Records user notification events for data requests.
CreateSubmissionDataRequestTokenResponse	Client.createDataRequestToken(String dataRequestId, String type)	Create a new data request token for form authentication Creates an authentication token for accessing a data request form.
ApiResponse<CreateSubmissionDataRequestTokenResponse>	Client.createDataRequestTokenWithHttpInfo(String dataRequestId, String type)	Create a new data request token for form authentication Creates an authentication token for accessing a data request form.
Folder	Client.createFolder(CreateFolderData data)	Create a folder Creates a new folder for organizing templates.
ApiResponse<Folder>	Client.createFolderWithHttpInfo(CreateFolderData data)	Create a folder Creates a new folder for organizing templates.
TemplatePreview	Client.createHtmlTemplate(CreateHtmlTemplate data)	Create a new HTML template Creates a new HTML template using HTML, CSS/SCSS, and Liquid templating.
ApiResponse<TemplatePreview>	Client.createHtmlTemplateWithHttpInfo(CreateHtmlTemplate data)	Create a new HTML template Creates a new HTML template using HTML, CSS/SCSS, and Liquid templating.
TemplatePreview	Client.createPdfTemplate(File templateDocument, String templateName, Boolean wait, String templateDescription, String templateParentFolderId)	Create a new PDF template with a form POST file upload Creates a new PDF template by uploading a PDF file.
TemplatePreview	Client.createPdfTemplateFromUpload(CreatePdfTemplate data)	Create a new PDF template from a cached S3 file upload Creates a new PDF template from a file previously uploaded to S3 using a presigned URL.
ApiResponse<TemplatePreview>	Client.createPdfTemplateFromUploadWithHttpInfo(CreatePdfTemplate data)	Create a new PDF template from a cached S3 file upload Creates a new PDF template from a file previously uploaded to S3 using a presigned URL.
ApiResponse<TemplatePreview>	Client.createPdfTemplateWithHttpInfo(File templateDocument, String templateName, Boolean wait, String templateDescription, String templateParentFolderId)	Create a new PDF template with a form POST file upload Creates a new PDF template by uploading a PDF file.
Folder	Client.deleteFolder(String folderId)	Delete a folder Deletes an empty folder.
ApiResponse<Folder>	Client.deleteFolderWithHttpInfo(String folderId)	Delete a folder Deletes an empty folder.
TemplateDeleteResponse	Client.deleteTemplate(String templateId, String version)	Delete a template Deletes a template or a specific template version.
ApiResponse<TemplateDeleteResponse>	Client.deleteTemplateWithHttpInfo(String templateId, String version)	Delete a template Deletes a template or a specific template version.
<T> T	ApiClient.deserialize(javax.ws.rs.core.Response response, javax.ws.rs.core.GenericType<T> returnType)	Deserialize response body to Java object according to the Content-Type.
File	ApiClient.downloadFileFromResponse(javax.ws.rs.core.Response response)	Download file from the given response.
CombinedSubmission	Client.expireCombinedSubmission(String combinedSubmissionId)	Expire a combined submission Expiring a combined submission deletes the PDF from our system.
ApiResponse<CombinedSubmission>	Client.expireCombinedSubmissionWithHttpInfo(String combinedSubmissionId)	Expire a combined submission Expiring a combined submission deletes the PDF from our system.
SubmissionPreview	Client.expireSubmission(String submissionId)	Expire a PDF submission Expiring a PDF submission deletes the PDF and removes the data from our database.
ApiResponse<SubmissionPreview>	Client.expireSubmissionWithHttpInfo(String submissionId)	Expire a PDF submission Expiring a PDF submission deletes the PDF and removes the data from our database.
CreateSubmissionResponse	Client.generatePdf(String templateId, CreatePdfSubmissionData submission, Boolean wait)	Generate a PDF Creates a PDF submission by filling in a template with data.
ApiResponse<CreateSubmissionResponse>	Client.generatePdfWithHttpInfo(String templateId, CreatePdfSubmissionData submission, Boolean wait)	Generate a PDF Creates a PDF submission by filling in a template with data.
SuccessErrorResponse	Client.generatePreview(String submissionId)	Generate a preview PDF for partially completed data requests Generates a preview PDF for a submission with partially completed data requests.
ApiResponse<SuccessErrorResponse>	Client.generatePreviewWithHttpInfo(String submissionId)	Generate a preview PDF for partially completed data requests Generates a preview PDF for a submission with partially completed data requests.
CombinedSubmission	Client.getCombinedSubmission(String combinedSubmissionId)	Check the status of a combined submission (merged PDFs) Retrieves the details and status of a combined submission.
ApiResponse<CombinedSubmission>	Client.getCombinedSubmissionWithHttpInfo(String combinedSubmissionId)	Check the status of a combined submission (merged PDFs) Retrieves the details and status of a combined submission.
SubmissionDataRequestShow	Client.getDataRequest(String dataRequestId)	Look up a submission data request Retrieves the details and status of a data request.
ApiResponse<SubmissionDataRequestShow>	Client.getDataRequestWithHttpInfo(String dataRequestId)	Look up a submission data request Retrieves the details and status of a data request.
Template	Client.getFullTemplate(String templateId)	Fetch the full attributes for a PDF template Retrieves complete template information including fields, defaults, settings, and HTML/SCSS content.
ApiResponse<Template>	Client.getFullTemplateWithHttpInfo(String templateId)	Fetch the full attributes for a PDF template Retrieves complete template information including fields, defaults, settings, and HTML/SCSS content.
UploadPresignResponse	Client.getPresignUrl()	Get a presigned S3 URL for direct file upload Returns a presigned S3 URL for uploading files directly to our S3 bucket.
ApiResponse<UploadPresignResponse>	Client.getPresignUrlWithHttpInfo()	Get a presigned S3 URL for direct file upload Returns a presigned S3 URL for uploading files directly to our S3 bucket.
Submission	Client.getSubmission(String submissionId, Boolean includeData)	Check the status of a PDF Retrieves the details and status of a PDF submission.
SubmissionBatchWithSubmissions	Client.getSubmissionBatch(String submissionBatchId, Boolean includeSubmissions)	Check the status of a submission batch job Retrieves the status and results of a batch PDF generation job.
ApiResponse<SubmissionBatchWithSubmissions>	Client.getSubmissionBatchWithHttpInfo(String submissionBatchId, Boolean includeSubmissions)	Check the status of a submission batch job Retrieves the status and results of a batch PDF generation job.
ApiResponse<Submission>	Client.getSubmissionWithHttpInfo(String submissionId, Boolean includeData)	Check the status of a PDF Retrieves the details and status of a PDF submission.
TemplatePreview	Client.getTemplate(String templateId)	Check the status of an uploaded template Retrieves information about a template including processing status and document URL.
JsonSchema	Client.getTemplateSchema(String templateId)	Fetch the JSON schema for a template Retrieves the JSON Schema definition for a template's fields.
ApiResponse<JsonSchema>	Client.getTemplateSchemaWithHttpInfo(String templateId)	Fetch the JSON schema for a template Retrieves the JSON Schema definition for a template's fields.
ApiResponse<TemplatePreview>	Client.getTemplateWithHttpInfo(String templateId)	Check the status of an uploaded template Retrieves information about a template including processing status and document URL.
<T> ApiResponse<T>	ApiClient.invokeAPI(String operation, String path, String method, List<Pair> queryParams, Object body, Map<String,String> headerParams, Map<String,String> cookieParams, Map<String,Object> formParams, String accept, String contentType, String[] authNames, javax.ws.rs.core.GenericType<T> returnType, boolean isBodyNullable)	Invoke API by sending HTTP request with the given options.
<T> ApiResponse<T>	ApiClient.invokeAPI(String path, String method, List<Pair> queryParams, Object body, Map<String,String> headerParams, Map<String,String> cookieParams, Map<String,Object> formParams, String accept, String contentType, String[] authNames, javax.ws.rs.core.GenericType<T> returnType, boolean isBodyNullable)	Deprecated. Add qualified name of the operation as a first parameter.
List<CombinedSubmission>	Client.listCombinedSubmissions(Integer page, Integer perPage)	Get a list of all combined submissions Returns a paginated list of combined submissions (merged PDFs) for your account.
ApiResponse<List<CombinedSubmission>>	Client.listCombinedSubmissionsWithHttpInfo(Integer page, Integer perPage)	Get a list of all combined submissions Returns a paginated list of combined submissions (merged PDFs) for your account.
List<Folder>	Client.listFolders(String parentFolderId)	Get a list of all folders Returns a list of folders in your account.
ApiResponse<List<Folder>>	Client.listFoldersWithHttpInfo(String parentFolderId)	Get a list of all folders Returns a list of folders in your account.
ListSubmissionsResponse	Client.listSubmissions(String cursor, Integer limit, String createdAfter, String createdBefore, String type, Boolean includeData)	List all submissions Returns a paginated list of all PDF submissions across all templates in your account.
ApiResponse<ListSubmissionsResponse>	Client.listSubmissionsWithHttpInfo(String cursor, Integer limit, String createdAfter, String createdBefore, String type, Boolean includeData)	List all submissions Returns a paginated list of all PDF submissions across all templates in your account.
List<TemplatePreview>	Client.listTemplates(String query, String parentFolderId, Integer page, Integer perPage)	Get a list of all templates Retrieves a list of your templates with search, filtering, and pagination options.
ListSubmissionsResponse	Client.listTemplateSubmissions(String templateId, String cursor, Integer limit, String createdAfter, String createdBefore, String type, Boolean includeData)	List all submissions for a given template Returns a paginated list of all submissions for a specific template.
ApiResponse<ListSubmissionsResponse>	Client.listTemplateSubmissionsWithHttpInfo(String templateId, String cursor, Integer limit, String createdAfter, String createdBefore, String type, Boolean includeData)	List all submissions for a given template Returns a paginated list of all submissions for a specific template.
ApiResponse<List<TemplatePreview>>	Client.listTemplatesWithHttpInfo(String query, String parentFolderId, Integer page, Integer perPage)	Get a list of all templates Retrieves a list of your templates with search, filtering, and pagination options.
Folder	Client.moveFolderToFolder(String folderId, MoveFolderData data)	Move a folder Moves a folder to a new parent folder or to the root level.
ApiResponse<Folder>	Client.moveFolderToFolderWithHttpInfo(String folderId, MoveFolderData data)	Move a folder Moves a folder to a new parent folder or to the root level.
TemplatePreview	Client.moveTemplateToFolder(String templateId, MoveTemplateData data)	Move Template to folder Moves a template to a different folder or to the root level.
ApiResponse<TemplatePreview>	Client.moveTemplateToFolderWithHttpInfo(String templateId, MoveTemplateData data)	Move Template to folder Moves a template to a different folder or to the root level.
TemplatePublishVersionResponse	Client.publishTemplateVersion(String templateId, PublishVersionData data)	Publish a template version Publishes the current draft version of a template and creates a new immutable version with semantic versioning (major.minor.patch).
ApiResponse<TemplatePublishVersionResponse>	Client.publishTemplateVersionWithHttpInfo(String templateId, PublishVersionData data)	Publish a template version Publishes the current draft version of a template and creates a new immutable version with semantic versioning (major.minor.patch).
Folder	Client.renameFolder(String folderId, RenameFolderData data)	Rename a folder Renames an existing folder.
ApiResponse<Folder>	Client.renameFolderWithHttpInfo(String folderId, RenameFolderData data)	Rename a folder Renames an existing folder.
SuccessErrorResponse	Client.restoreTemplateVersion(String templateId, RestoreVersionData data)	Restore a template version Restores your template to a previously published version, copying that version's content and configuration to the current draft.
ApiResponse<SuccessErrorResponse>	Client.restoreTemplateVersionWithHttpInfo(String templateId, RestoreVersionData data)	Restore a template version Restores your template to a previously published version, copying that version's content and configuration to the current draft.
javax.ws.rs.client.Entity<?>	ApiClient.serialize(Object obj, Map<String,Object> formParams, String contentType, boolean isBodyNullable)	Serialize the given Java object into string entity according the given Content-Type (only JSON is supported for now).
String	ApiClient.serializeToString(Object obj, Map<String,Object> formParams, String contentType, boolean isBodyNullable)	Serialize the given Java object into string according the given Content-Type (only JSON, HTTP form is supported for now).
SuccessErrorResponse	Client.testAuthentication()	Test authentication Checks whether your API token is valid by making an authenticated request.
ApiResponse<SuccessErrorResponse>	Client.testAuthenticationWithHttpInfo()	Test authentication Checks whether your API token is valid by making an authenticated request.
CreateSubmissionDataRequestResponse	Client.updateDataRequest(String dataRequestId, UpdateSubmissionDataRequestData data)	Update a submission data request Updates authentication details for a data request.
ApiResponse<CreateSubmissionDataRequestResponse>	Client.updateDataRequestWithHttpInfo(String dataRequestId, UpdateSubmissionDataRequestData data)	Update a submission data request Updates authentication details for a data request.
protected void	ApiClient.updateParamsForAuth(String[] authNames, List<Pair> queryParams, Map<String,String> headerParams, Map<String,String> cookieParams, String payload, String method, URI uri)	Update query and header parameters based on authentication settings.
SuccessMultipleErrorsResponse	Client.updateTemplate(String templateId, UpdateHtmlTemplate data)	Update a Template Updates template content and properties.
SuccessMultipleErrorsResponse	Client.updateTemplateDocument(String templateId, File templateDocument, String templateName)	Update a template's document with a form POST file upload Upload a new PDF file to update a PDF template's document.
SuccessMultipleErrorsResponse	Client.updateTemplateDocumentFromUpload(String templateId, UpdatePdfTemplate data)	Update a template's document with a cached S3 file upload Updates a PDF template's document using a cached file upload.
ApiResponse<SuccessMultipleErrorsResponse>	Client.updateTemplateDocumentFromUploadWithHttpInfo(String templateId, UpdatePdfTemplate data)	Update a template's document with a cached S3 file upload Updates a PDF template's document using a cached file upload.
ApiResponse<SuccessMultipleErrorsResponse>	Client.updateTemplateDocumentWithHttpInfo(String templateId, File templateDocument, String templateName)	Update a template's document with a form POST file upload Upload a new PDF file to update a PDF template's document.
ApiResponse<SuccessMultipleErrorsResponse>	Client.updateTemplateWithHttpInfo(String templateId, UpdateHtmlTemplate data)	Update a Template Updates template content and properties.

Uses of ApiException in com.docspring.auth

Methods in com.docspring.auth that throw ApiException

Modifier and Type	Method	Description
void	ApiKeyAuth.applyToParams(List<Pair> queryParams, Map<String,String> headerParams, Map<String,String> cookieParams, String payload, String method, URI uri)
void	Authentication.applyToParams(List<Pair> queryParams, Map<String,String> headerParams, Map<String,String> cookieParams, String payload, String method, URI uri)	Apply authentication settings to header and query params.
void	HttpBasicAuth.applyToParams(List<Pair> queryParams, Map<String,String> headerParams, Map<String,String> cookieParams, String payload, String method, URI uri)
void	HttpBearerAuth.applyToParams(List<Pair> queryParams, Map<String,String> headerParams, Map<String,String> cookieParams, String payload, String method, URI uri)