io.formapi

Interface PdfApi

public interface PdfApi

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<CreateSubmissionBatchResponse>	batchGeneratePdfs(SubmissionBatchData submissionBatchData) Generates multiple PDFs
retrofit2.Call<List<CreateSubmissionResponse>>	batchGeneratePdfV1(String templateId, List<Object> requestBody) Generates multiple PDFs
retrofit2.Call<CreateCombinedSubmissionResponse>	combinePdfs(CombinePdfsData combinePdfsData) Merge submission PDFs, template PDFs, or custom files
retrofit2.Call<CreateCombinedSubmissionResponse>	combineSubmissions(CombinedSubmissionData combinedSubmissionData) Merge generated PDFs together
retrofit2.Call<CreateCustomFileResponse>	createCustomFileFromUpload(CreateCustomFileData createCustomFileData) Create a new custom file from a cached presign upload
retrofit2.Call<CreateSubmissionDataRequestTokenResponse>	createDataRequestToken(String dataRequestId) Creates a new data request token for form authentication
retrofit2.Call<PendingTemplate>	createTemplate(okhttp3.MultipartBody.Part templateDocument, String templateName) Upload a new PDF template with a file upload
retrofit2.Call<PendingTemplate>	createTemplateFromUpload(CreateTemplateData createTemplateData) Create a new PDF template from a cached presign upload
retrofit2.Call<CombinedSubmission>	expireCombinedSubmission(String combinedSubmissionId) Expire a combined submission
retrofit2.Call<Submission>	expireSubmission(String submissionId) Expire a PDF submission
retrofit2.Call<CreateSubmissionResponse>	generatePDF(String templateId, SubmissionData submissionData) Generates a new PDF
retrofit2.Call<CombinedSubmission>	getCombinedSubmission(String combinedSubmissionId) Check the status of a combined submission (merged PDFs)
retrofit2.Call<SubmissionDataRequest>	getDataRequest(String dataRequestId) Look up a submission data request
retrofit2.Call<Map<String,Object>>	getPresignUrl() Get a presigned URL so that you can upload a file to our AWS S3 bucket
retrofit2.Call<Submission>	getSubmission(String submissionId, Boolean includeData) Check the status of a PDF
retrofit2.Call<SubmissionBatch>	getSubmissionBatch(String submissionBatchId, Boolean includeSubmissions) Check the status of a submission batch job
retrofit2.Call<Template>	getTemplate(String templateId) Check the status of an uploaded template
retrofit2.Call<List<Template>>	getTemplates(Integer page, Integer perPage) Get a list of all templates
retrofit2.Call<Map<String,Object>>	getTemplateSchema(String templateId) Fetch the JSON schema for a template
retrofit2.Call<AuthenticationSuccessResponse>	testAuthentication() Test Authentication
retrofit2.Call<UpdateDataRequestResponse>	updateDataRequest(String dataRequestId, UpdateSubmissionDataRequestData updateSubmissionDataRequestData) Update a submission data request

Method Detail

batchGeneratePdfV1

@Headers(value="Content-Type:application/json")
 @POST(value="templates/{template_id}/submissions/batch")
retrofit2.Call<List<CreateSubmissionResponse>> batchGeneratePdfV1(@Path(value="template_id")
                                                                                                                                                                            String templateId,
                                                                                                                                                                            @Body
                                                                                                                                                                            List<Object> requestBody)

Generates multiple PDFs

Parameters:

templateId - (required)

requestBody - (required)

Returns:

Call<List<CreateSubmissionResponse>>

batchGeneratePdfs

@Headers(value="Content-Type:application/json")
 @POST(value="submissions/batches")
retrofit2.Call<CreateSubmissionBatchResponse> batchGeneratePdfs(@Body
                                                                                                                                                    SubmissionBatchData submissionBatchData)

Generates multiple PDFs

Parameters:

submissionBatchData - (required)

Returns:

Call<CreateSubmissionBatchResponse>

combinePdfs

@Headers(value="Content-Type:application/json")
 @POST(value="combined_submissions?v=2")
retrofit2.Call<CreateCombinedSubmissionResponse> combinePdfs(@Body
                                                                                                                                                      CombinePdfsData combinePdfsData)

Merge submission PDFs, template PDFs, or custom files

Parameters:

combinePdfsData - (required)

Returns:

Call<CreateCombinedSubmissionResponse>

combineSubmissions

@Headers(value="Content-Type:application/json")
 @POST(value="combined_submissions")
retrofit2.Call<CreateCombinedSubmissionResponse> combineSubmissions(@Body
                                                                                                                                                         CombinedSubmissionData combinedSubmissionData)

Merge generated PDFs together

Parameters:

combinedSubmissionData - (required)

Returns:

Call<CreateCombinedSubmissionResponse>

createCustomFileFromUpload

@Headers(value="Content-Type:application/json")
 @POST(value="custom_files")
retrofit2.Call<CreateCustomFileResponse> createCustomFileFromUpload(@Body
                                                                                                                                                 CreateCustomFileData createCustomFileData)

Create a new custom file from a cached presign upload

Parameters:

createCustomFileData - (required)

Returns:

Call<CreateCustomFileResponse>

createDataRequestToken

@POST(value="data_requests/{data_request_id}/tokens")
retrofit2.Call<CreateSubmissionDataRequestTokenResponse> createDataRequestToken(@Path(value="data_request_id")
                                                                                                                                      String dataRequestId)

Creates a new data request token for form authentication

Parameters:

dataRequestId - (required)

Returns:

Call<CreateSubmissionDataRequestTokenResponse>

createTemplate

@Multipart
 @POST(value="templates")
retrofit2.Call<PendingTemplate> createTemplate(@Part(value="template[document]")
                                                                                    okhttp3.MultipartBody.Part templateDocument,
                                                                                    @Part(value="template[name]")
                                                                                    String templateName)

Upload a new PDF template with a file upload

Parameters:

templateDocument - (required)

templateName - (required)

Returns:

Call<PendingTemplate>

createTemplateFromUpload

@Headers(value="Content-Type:application/json")
 @POST(value="templates?v=2")
retrofit2.Call<PendingTemplate> createTemplateFromUpload(@Body
                                                                                                                                       CreateTemplateData createTemplateData)

Create a new PDF template from a cached presign upload

Parameters:

createTemplateData - (required)

Returns:

Call<PendingTemplate>

expireCombinedSubmission

@DELETE(value="combined_submissions/{combined_submission_id}")
retrofit2.Call<CombinedSubmission> expireCombinedSubmission(@Path(value="combined_submission_id")
                                                                                                                           String combinedSubmissionId)

Expire a combined submission

Parameters:

combinedSubmissionId - (required)

Returns:

Call<CombinedSubmission>

expireSubmission

@DELETE(value="submissions/{submission_id}")
retrofit2.Call<Submission> expireSubmission(@Path(value="submission_id")
                                                                                         String submissionId)

Expire a PDF submission

Parameters:

submissionId - (required)

Returns:

Call<Submission>

generatePDF

@Headers(value="Content-Type:application/json")
 @POST(value="templates/{template_id}/submissions")
retrofit2.Call<CreateSubmissionResponse> generatePDF(@Path(value="template_id")
                                                                                                                                                         String templateId,
                                                                                                                                                         @Body
                                                                                                                                                         SubmissionData submissionData)

Generates a new PDF

Parameters:

templateId - (required)

submissionData - (required)

Returns:

Call<CreateSubmissionResponse>

getCombinedSubmission

@GET(value="combined_submissions/{combined_submission_id}")
retrofit2.Call<CombinedSubmission> getCombinedSubmission(@Path(value="combined_submission_id")
                                                                                                                     String combinedSubmissionId)

Check the status of a combined submission (merged PDFs)

Parameters:

combinedSubmissionId - (required)

Returns:

Call<CombinedSubmission>

getDataRequest

@GET(value="data_requests/{data_request_id}")
retrofit2.Call<SubmissionDataRequest> getDataRequest(@Path(value="data_request_id")
                                                                                                   String dataRequestId)

Look up a submission data request

Parameters:

dataRequestId - (required)

Returns:

Call<SubmissionDataRequest>

getPresignUrl

@GET(value="uploads/presign")
retrofit2.Call<Map<String,Object>> getPresignUrl()

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

Returns:

Call<Map<String, Object>>

getSubmission

@GET(value="submissions/{submission_id}")
retrofit2.Call<Submission> getSubmission(@Path(value="submission_id")
                                                                                   String submissionId,
                                                                                   @Query(value="include_data")
                                                                                   Boolean includeData)

Check the status of a PDF

Parameters:

submissionId - (required)

includeData - (optional)

Returns:

Call<Submission>

getSubmissionBatch

@GET(value="submissions/batches/{submission_batch_id}")
retrofit2.Call<SubmissionBatch> getSubmissionBatch(@Path(value="submission_batch_id")
                                                                                                           String submissionBatchId,
                                                                                                           @Query(value="include_submissions")
                                                                                                           Boolean includeSubmissions)

Check the status of a submission batch job

Parameters:

submissionBatchId - (required)

includeSubmissions - (optional)

Returns:

Call<SubmissionBatch>

getTemplate

@GET(value="templates/{template_id}")
retrofit2.Call<Template> getTemplate(@Path(value="template_id")
                                                                           String templateId)

Check the status of an uploaded template

Parameters:

templateId - (required)

Returns:

Call<Template>

getTemplateSchema

@GET(value="templates/{template_id}/schema")
retrofit2.Call<Map<String,Object>> getTemplateSchema(@Path(value="template_id")
                                                                                                  String templateId)

Fetch the JSON schema for a template

Parameters:

templateId - (required)

Returns:

Call<Map<String, Object>>

getTemplates

@GET(value="templates")
retrofit2.Call<List<Template>> getTemplates(@Query(value="page")
                                                                    Integer page,
                                                                    @Query(value="per_page")
                                                                    Integer perPage)

Get a list of all templates

Parameters:

page - Default: 1 (optional)

perPage - Default: 50 (optional)

Returns:

Call<List<Template>>

testAuthentication

@GET(value="authentication")
retrofit2.Call<AuthenticationSuccessResponse> testAuthentication()

Test Authentication

Returns:

Call<AuthenticationSuccessResponse>

updateDataRequest

@Headers(value="Content-Type:application/json")
 @PUT(value="data_requests/{data_request_id}")
retrofit2.Call<UpdateDataRequestResponse> updateDataRequest(@Path(value="data_request_id")
                                                                                                                                                           String dataRequestId,
                                                                                                                                                           @Body
                                                                                                                                                           UpdateSubmissionDataRequestData updateSubmissionDataRequestData)

Update a submission data request

Parameters:

dataRequestId - (required)

updateSubmissionDataRequestData - (required)

Returns:

Call<UpdateDataRequestResponse>