Class PdfApi

java.lang.Object
com.docspring.PdfApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.11.0") public class PdfApi extends Object

  • Constructor Details

    • PdfApi

      public PdfApi()

    • PdfApi

      public PdfApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()
      Get the API client
      Returns:
      API client

    • setApiClient

      public void setApiClient(ApiClient apiClient)
      Set the API client
      Parameters:
      apiClient - an instance of API client

    • addFieldsToTemplate

      public TemplateAddFieldsResponse addFieldsToTemplate(String templateId, AddFieldsData data) throws ApiException
      Add new fields to a Template
      Parameters:
      templateId - (required)
      data - (required)
      Returns:
      TemplateAddFieldsResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 add fields success -
      422 add fields error -

    • addFieldsToTemplateWithHttpInfo

      public ApiResponse<TemplateAddFieldsResponse> addFieldsToTemplateWithHttpInfo(String templateId, AddFieldsData data) throws ApiException
      Add new fields to a Template
      Parameters:
      templateId - (required)
      data - (required)
      Returns:
      ApiResponse<TemplateAddFieldsResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 add fields success -
      422 add fields error -

    • batchGeneratePdfs

      public BatchGeneratePdfs201Response batchGeneratePdfs(SubmissionBatchData data, Boolean wait) throws ApiException
      Generates multiple PDFs
      Parameters:
      data - (required)
      wait - Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional, default to true)
      Returns:
      BatchGeneratePdfs201Response
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 submissions created -
      200 some PDFs with invalid data -
      401 authentication failed -
      422 array of arrays -
      400 invalid JSON -

    • batchGeneratePdfsWithHttpInfo

      public ApiResponse<BatchGeneratePdfs201Response> batchGeneratePdfsWithHttpInfo(SubmissionBatchData data, Boolean wait) throws ApiException
      Generates multiple PDFs
      Parameters:
      data - (required)
      wait - Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional, default to true)
      Returns:
      ApiResponse<BatchGeneratePdfs201Response>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 submissions created -
      200 some PDFs with invalid data -
      401 authentication failed -
      422 array of arrays -
      400 invalid JSON -

    • combinePdfs

      public CreateCombinedSubmissionResponse combinePdfs(CombinePdfsData data) throws ApiException
      Merge submission PDFs, template PDFs, or custom files
      Parameters:
      data - (required)
      Returns:
      CreateCombinedSubmissionResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 combined submission created -
      422 invalid request -
      400 invalid JSON -
      401 authentication failed -

    • combinePdfsWithHttpInfo

      public ApiResponse<CreateCombinedSubmissionResponse> combinePdfsWithHttpInfo(CombinePdfsData data) throws ApiException
      Merge submission PDFs, template PDFs, or custom files
      Parameters:
      data - (required)
      Returns:
      ApiResponse<CreateCombinedSubmissionResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 combined submission created -
      422 invalid request -
      400 invalid JSON -
      401 authentication failed -

    • combineSubmissions

      public CreateCombinedSubmissionResponse combineSubmissions(CombinedSubmissionData data, Boolean wait) throws ApiException
      Merge generated PDFs together
      Parameters:
      data - (required)
      wait - Wait for combined submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional, default to true)
      Returns:
      CreateCombinedSubmissionResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 combined submission created -
      422 invalid request -
      400 invalid JSON -
      401 authentication failed -

    • combineSubmissionsWithHttpInfo

      public ApiResponse<CreateCombinedSubmissionResponse> combineSubmissionsWithHttpInfo(CombinedSubmissionData data, Boolean wait) throws ApiException
      Merge generated PDFs together
      Parameters:
      data - (required)
      wait - Wait for combined submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional, default to true)
      Returns:
      ApiResponse<CreateCombinedSubmissionResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 combined submission created -
      422 invalid request -
      400 invalid JSON -
      401 authentication failed -

    • copyTemplate

      public TemplatePreview copyTemplate(String templateId, CopyTemplateOptions options) throws ApiException
      Copy a Template
      Parameters:
      templateId - (required)
      options - (optional)
      Returns:
      TemplatePreview
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 copy template success -
      404 folder not found -

    • copyTemplateWithHttpInfo

      public ApiResponse<TemplatePreview> copyTemplateWithHttpInfo(String templateId, CopyTemplateOptions options) throws ApiException
      Copy a Template
      Parameters:
      templateId - (required)
      options - (optional)
      Returns:
      ApiResponse<TemplatePreview>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 copy template success -
      404 folder not found -

    • createCustomFileFromUpload

      public CreateCustomFileResponse createCustomFileFromUpload(CreateCustomFileData data) throws ApiException
      Create a new custom file from a cached presign upload
      Parameters:
      data - (required)
      Returns:
      CreateCustomFileResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 returns the custom file -
      401 authentication failed -

    • createCustomFileFromUploadWithHttpInfo

      public ApiResponse<CreateCustomFileResponse> createCustomFileFromUploadWithHttpInfo(CreateCustomFileData data) throws ApiException
      Create a new custom file from a cached presign upload
      Parameters:
      data - (required)
      Returns:
      ApiResponse<CreateCustomFileResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 returns the custom file -
      401 authentication failed -

    • createDataRequestEvent

      public CreateSubmissionDataRequestEventResponse createDataRequestEvent(String dataRequestId, CreateSubmissionDataRequestEventRequest event) throws ApiException
      Creates a new event for emailing a signee a request for signature
      Parameters:
      dataRequestId - (required)
      event - (required)
      Returns:
      CreateSubmissionDataRequestEventResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 event created -
      401 authentication failed -
      422 message recipient must not be blank -

    • createDataRequestEventWithHttpInfo

      public ApiResponse<CreateSubmissionDataRequestEventResponse> createDataRequestEventWithHttpInfo(String dataRequestId, CreateSubmissionDataRequestEventRequest event) throws ApiException
      Creates a new event for emailing a signee a request for signature
      Parameters:
      dataRequestId - (required)
      event - (required)
      Returns:
      ApiResponse<CreateSubmissionDataRequestEventResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 event created -
      401 authentication failed -
      422 message recipient must not be blank -

    • createDataRequestToken

      public CreateSubmissionDataRequestTokenResponse createDataRequestToken(String dataRequestId, String type) throws ApiException
      Creates a new data request token for form authentication
      Parameters:
      dataRequestId - (required)
      type - (optional)
      Returns:
      CreateSubmissionDataRequestTokenResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 token created -
      401 authentication failed -
      422 invalid request -

    • createDataRequestTokenWithHttpInfo

      public ApiResponse<CreateSubmissionDataRequestTokenResponse> createDataRequestTokenWithHttpInfo(String dataRequestId, String type) throws ApiException
      Creates a new data request token for form authentication
      Parameters:
      dataRequestId - (required)
      type - (optional)
      Returns:
      ApiResponse<CreateSubmissionDataRequestTokenResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 token created -
      401 authentication failed -
      422 invalid request -

    • createFolder

      public Folder createFolder(CreateFolderData data) throws ApiException
      Create a folder
      Parameters:
      data - (required)
      Returns:
      Folder
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      422 name already exist -
      404 parent folder doesn't exist -
      200 folder created inside another folder -
      401 authentication failed -

    • createFolderWithHttpInfo

      public ApiResponse<Folder> createFolderWithHttpInfo(CreateFolderData data) throws ApiException
      Create a folder
      Parameters:
      data - (required)
      Returns:
      ApiResponse<Folder>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      422 name already exist -
      404 parent folder doesn't exist -
      200 folder created inside another folder -
      401 authentication failed -

    • createHTMLTemplate

      public TemplatePreview createHTMLTemplate(CreateHtmlTemplate data) throws ApiException
      Create a new HTML template
      Parameters:
      data - (required)
      Returns:
      TemplatePreview
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 returns a created template -
      401 authentication failed -

    • createHTMLTemplateWithHttpInfo

      public ApiResponse<TemplatePreview> createHTMLTemplateWithHttpInfo(CreateHtmlTemplate data) throws ApiException
      Create a new HTML template
      Parameters:
      data - (required)
      Returns:
      ApiResponse<TemplatePreview>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 returns a created template -
      401 authentication failed -

    • createPDFTemplate

      public TemplatePreview createPDFTemplate(File templateDocument, String templateName, Boolean wait, String templateDescription, String templateParentFolderId) throws ApiException
      Create a new PDF template with a form POST file upload
      Parameters:
      templateDocument - (required)
      templateName - (required)
      wait - Wait for template document to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional, default to true)
      templateDescription - (optional)
      templateParentFolderId - (optional)
      Returns:
      TemplatePreview
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 returns a pending template -
      401 authentication failed -

    • createPDFTemplateWithHttpInfo

      public ApiResponse<TemplatePreview> createPDFTemplateWithHttpInfo(File templateDocument, String templateName, Boolean wait, String templateDescription, String templateParentFolderId) throws ApiException
      Create a new PDF template with a form POST file upload
      Parameters:
      templateDocument - (required)
      templateName - (required)
      wait - Wait for template document to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional, default to true)
      templateDescription - (optional)
      templateParentFolderId - (optional)
      Returns:
      ApiResponse<TemplatePreview>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 returns a pending template -
      401 authentication failed -

    • createPDFTemplateFromUpload

      public TemplatePreview createPDFTemplateFromUpload(CreatePdfTemplate data) throws ApiException
      Create a new PDF template from a cached presign upload
      Parameters:
      data - (required)
      Returns:
      TemplatePreview
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 returns a pending template -
      401 authentication failed -

    • createPDFTemplateFromUploadWithHttpInfo

      public ApiResponse<TemplatePreview> createPDFTemplateFromUploadWithHttpInfo(CreatePdfTemplate data) throws ApiException
      Create a new PDF template from a cached presign upload
      Parameters:
      data - (required)
      Returns:
      ApiResponse<TemplatePreview>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 returns a pending template -
      401 authentication failed -

    • deleteFolder

      public Folder deleteFolder(String folderId) throws ApiException
      Delete a folder
      Parameters:
      folderId - (required)
      Returns:
      Folder
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      404 folder doesn't exist -
      422 folder has contents -
      200 folder is empty -
      401 authentication failed -

    • deleteFolderWithHttpInfo

      public ApiResponse<Folder> deleteFolderWithHttpInfo(String folderId) throws ApiException
      Delete a folder
      Parameters:
      folderId - (required)
      Returns:
      ApiResponse<Folder>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      404 folder doesn't exist -
      422 folder has contents -
      200 folder is empty -
      401 authentication failed -

    • deleteTemplate

      public TemplateDeleteResponse deleteTemplate(String templateId, String version) throws ApiException
      Delete a template
      Parameters:
      templateId - (required)
      version - (optional)
      Returns:
      TemplateDeleteResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 template version deleted successfully -
      404 template not found -
      401 authentication failed -

    • deleteTemplateWithHttpInfo

      public ApiResponse<TemplateDeleteResponse> deleteTemplateWithHttpInfo(String templateId, String version) throws ApiException
      Delete a template
      Parameters:
      templateId - (required)
      version - (optional)
      Returns:
      ApiResponse<TemplateDeleteResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 template version deleted successfully -
      404 template not found -
      401 authentication failed -

    • expireCombinedSubmission

      public CombinedSubmission expireCombinedSubmission(String combinedSubmissionId) throws ApiException
      Expire a combined submission
      Parameters:
      combinedSubmissionId - (required)
      Returns:
      CombinedSubmission
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 submission was expired -
      404 combined submission not found -
      403 test API token used -
      401 authentication failed -

    • expireCombinedSubmissionWithHttpInfo

      public ApiResponse<CombinedSubmission> expireCombinedSubmissionWithHttpInfo(String combinedSubmissionId) throws ApiException
      Expire a combined submission
      Parameters:
      combinedSubmissionId - (required)
      Returns:
      ApiResponse<CombinedSubmission>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 submission was expired -
      404 combined submission not found -
      403 test API token used -
      401 authentication failed -

    • expireSubmission

      public SubmissionPreview expireSubmission(String submissionId) throws ApiException
      Expire a PDF submission
      Parameters:
      submissionId - (required)
      Returns:
      SubmissionPreview
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 submission was expired -
      404 submission not found -
      401 authentication failed -
      403 test API token used -

    • expireSubmissionWithHttpInfo

      public ApiResponse<SubmissionPreview> expireSubmissionWithHttpInfo(String submissionId) throws ApiException
      Expire a PDF submission
      Parameters:
      submissionId - (required)
      Returns:
      ApiResponse<SubmissionPreview>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 submission was expired -
      404 submission not found -
      401 authentication failed -
      403 test API token used -

    • generatePdf

      public CreateSubmissionResponse generatePdf(String templateId, CreatePdfSubmissionData submission, Boolean wait) throws ApiException
      Generates a new PDF
      Parameters:
      templateId - (required)
      submission - (required)
      wait - Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional, default to true)
      Returns:
      CreateSubmissionResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 submission created -
      422 invalid request -
      401 authentication failed -

    • generatePdfWithHttpInfo

      public ApiResponse<CreateSubmissionResponse> generatePdfWithHttpInfo(String templateId, CreatePdfSubmissionData submission, Boolean wait) throws ApiException
      Generates a new PDF
      Parameters:
      templateId - (required)
      submission - (required)
      wait - Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional, default to true)
      Returns:
      ApiResponse<CreateSubmissionResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 submission created -
      422 invalid request -
      401 authentication failed -

    • generatePdfForHtmlTemplate

      public CreateSubmissionResponse generatePdfForHtmlTemplate(String templateId, CreateHtmlSubmissionData submission, Boolean wait) throws ApiException
      Generates a new PDF for an HTML template
      Parameters:
      templateId - (required)
      submission - (required)
      wait - Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional, default to true)
      Returns:
      CreateSubmissionResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 submission created -

    • generatePdfForHtmlTemplateWithHttpInfo

      public ApiResponse<CreateSubmissionResponse> generatePdfForHtmlTemplateWithHttpInfo(String templateId, CreateHtmlSubmissionData submission, Boolean wait) throws ApiException
      Generates a new PDF for an HTML template
      Parameters:
      templateId - (required)
      submission - (required)
      wait - Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional, default to true)
      Returns:
      ApiResponse<CreateSubmissionResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 submission created -

    • generatePreview

      public SuccessErrorResponse generatePreview(String submissionId) throws ApiException
      Generated a preview PDF for partially completed data requests
      Parameters:
      submissionId - (required)
      Returns:
      SuccessErrorResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 preview was successfully requested -
      404 submission not found -
      422 error requesting preview -

    • generatePreviewWithHttpInfo

      public ApiResponse<SuccessErrorResponse> generatePreviewWithHttpInfo(String submissionId) throws ApiException
      Generated a preview PDF for partially completed data requests
      Parameters:
      submissionId - (required)
      Returns:
      ApiResponse<SuccessErrorResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 preview was successfully requested -
      404 submission not found -
      422 error requesting preview -

    • getCombinedSubmission

      public CombinedSubmission getCombinedSubmission(String combinedSubmissionId) throws ApiException
      Check the status of a combined submission (merged PDFs)
      Parameters:
      combinedSubmissionId - (required)
      Returns:
      CombinedSubmission
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 processed combined submission found -
      404 combined submission not found -
      401 authentication failed -

    • getCombinedSubmissionWithHttpInfo

      public ApiResponse<CombinedSubmission> getCombinedSubmissionWithHttpInfo(String combinedSubmissionId) throws ApiException
      Check the status of a combined submission (merged PDFs)
      Parameters:
      combinedSubmissionId - (required)
      Returns:
      ApiResponse<CombinedSubmission>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 processed combined submission found -
      404 combined submission not found -
      401 authentication failed -

    • getDataRequest

      public SubmissionDataRequestShow getDataRequest(String dataRequestId) throws ApiException
      Look up a submission data request
      Parameters:
      dataRequestId - (required)
      Returns:
      SubmissionDataRequestShow
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 completed submission data request found -
      404 submission data request not found -
      401 authentication failed -

    • getDataRequestWithHttpInfo

      public ApiResponse<SubmissionDataRequestShow> getDataRequestWithHttpInfo(String dataRequestId) throws ApiException
      Look up a submission data request
      Parameters:
      dataRequestId - (required)
      Returns:
      ApiResponse<SubmissionDataRequestShow>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 completed submission data request found -
      404 submission data request not found -
      401 authentication failed -

    • getFullTemplate

      public Template getFullTemplate(String templateId) throws ApiException
      Fetch the full attributes for a PDF template
      Parameters:
      templateId - (required)
      Returns:
      Template
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 template found -
      404 template not found -
      401 authentication failed -

    • getFullTemplateWithHttpInfo

      public ApiResponse<Template> getFullTemplateWithHttpInfo(String templateId) throws ApiException
      Fetch the full attributes for a PDF template
      Parameters:
      templateId - (required)
      Returns:
      ApiResponse<Template>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 template found -
      404 template not found -
      401 authentication failed -

    • getPresignUrl

      public UploadPresignResponse getPresignUrl() throws ApiException
      Get a presigned URL so that you can upload a file to our AWS S3 bucket
      Returns:
      UploadPresignResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 presign URL generated -
      401 authentication failed -

    • getPresignUrlWithHttpInfo

      public ApiResponse<UploadPresignResponse> getPresignUrlWithHttpInfo() throws ApiException
      Get a presigned URL so that you can upload a file to our AWS S3 bucket
      Returns:
      ApiResponse<UploadPresignResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 presign URL generated -
      401 authentication failed -

    • getSubmission

      public Submission getSubmission(String submissionId, Boolean includeData) throws ApiException
      Check the status of a PDF
      Parameters:
      submissionId - (required)
      includeData - (optional)
      Returns:
      Submission
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 processed submission found -
      404 submission not found -
      401 authentication failed -

    • getSubmissionWithHttpInfo

      public ApiResponse<Submission> getSubmissionWithHttpInfo(String submissionId, Boolean includeData) throws ApiException
      Check the status of a PDF
      Parameters:
      submissionId - (required)
      includeData - (optional)
      Returns:
      ApiResponse<Submission>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 processed submission found -
      404 submission not found -
      401 authentication failed -

    • getSubmissionBatch

      public SubmissionBatchWithSubmissions getSubmissionBatch(String submissionBatchId, Boolean includeSubmissions) throws ApiException
      Check the status of a submission batch job
      Parameters:
      submissionBatchId - (required)
      includeSubmissions - (optional)
      Returns:
      SubmissionBatchWithSubmissions
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 processed submission batch found -
      404 submission batch not found -
      401 authentication failed -

    • getSubmissionBatchWithHttpInfo

      public ApiResponse<SubmissionBatchWithSubmissions> getSubmissionBatchWithHttpInfo(String submissionBatchId, Boolean includeSubmissions) throws ApiException
      Check the status of a submission batch job
      Parameters:
      submissionBatchId - (required)
      includeSubmissions - (optional)
      Returns:
      ApiResponse<SubmissionBatchWithSubmissions>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 processed submission batch found -
      404 submission batch not found -
      401 authentication failed -

    • getTemplate

      public TemplatePreview getTemplate(String templateId) throws ApiException
      Check the status of an uploaded template
      Parameters:
      templateId - (required)
      Returns:
      TemplatePreview
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 template found -
      404 template not found -
      401 authentication failed -

    • getTemplateWithHttpInfo

      public ApiResponse<TemplatePreview> getTemplateWithHttpInfo(String templateId) throws ApiException
      Check the status of an uploaded template
      Parameters:
      templateId - (required)
      Returns:
      ApiResponse<TemplatePreview>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 template found -
      404 template not found -
      401 authentication failed -

    • getTemplateSchema

      public JsonSchema getTemplateSchema(String templateId) throws ApiException
      Fetch the JSON schema for a template
      Parameters:
      templateId - (required)
      Returns:
      JsonSchema
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 template found -
      404 template not found -
      401 authentication failed -

    • getTemplateSchemaWithHttpInfo

      public ApiResponse<JsonSchema> getTemplateSchemaWithHttpInfo(String templateId) throws ApiException
      Fetch the JSON schema for a template
      Parameters:
      templateId - (required)
      Returns:
      ApiResponse<JsonSchema>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 template found -
      404 template not found -
      401 authentication failed -

    • listCombinedSubmissions

      public List<CombinedSubmission> listCombinedSubmissions(Integer page, Integer perPage) throws ApiException
      Get a list of all combined submissions
      Parameters:
      page - Default: 1 (optional)
      perPage - Default: 50 (optional)
      Returns:
      List<CombinedSubmission>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 enumerate all combined submissions -
      401 authentication failed -

    • listCombinedSubmissionsWithHttpInfo

      public ApiResponse<List<CombinedSubmission>> listCombinedSubmissionsWithHttpInfo(Integer page, Integer perPage) throws ApiException
      Get a list of all combined submissions
      Parameters:
      page - Default: 1 (optional)
      perPage - Default: 50 (optional)
      Returns:
      ApiResponse<List<CombinedSubmission>>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 enumerate all combined submissions -
      401 authentication failed -

    • listFolders

      public List<Folder> listFolders(String parentFolderId) throws ApiException
      Get a list of all folders
      Parameters:
      parentFolderId - Filter By Folder Id (optional)
      Returns:
      List<Folder>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 enumerate all folders -
      401 authentication failed -

    • listFoldersWithHttpInfo

      public ApiResponse<List<Folder>> listFoldersWithHttpInfo(String parentFolderId) throws ApiException
      Get a list of all folders
      Parameters:
      parentFolderId - Filter By Folder Id (optional)
      Returns:
      ApiResponse<List<Folder>>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 enumerate all folders -
      401 authentication failed -

    • listSubmissions

      public ListSubmissionsResponse listSubmissions(String cursor, BigDecimal limit, String createdAfter, String createdBefore, String type, Boolean includeData) throws ApiException
      List all submissions
      Parameters:
      cursor - (optional)
      limit - (optional)
      createdAfter - (optional)
      createdBefore - (optional)
      type - (optional)
      includeData - (optional)
      Returns:
      ListSubmissionsResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 listing submissions -
      422 invalid type -
      401 authentication failed -

    • listSubmissionsWithHttpInfo

      public ApiResponse<ListSubmissionsResponse> listSubmissionsWithHttpInfo(String cursor, BigDecimal limit, String createdAfter, String createdBefore, String type, Boolean includeData) throws ApiException
      List all submissions
      Parameters:
      cursor - (optional)
      limit - (optional)
      createdAfter - (optional)
      createdBefore - (optional)
      type - (optional)
      includeData - (optional)
      Returns:
      ApiResponse<ListSubmissionsResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 listing submissions -
      422 invalid type -
      401 authentication failed -

    • listTemplateSubmissions

      public ListSubmissionsResponse listTemplateSubmissions(String templateId, String cursor, BigDecimal limit, String createdAfter, String createdBefore, String type, Boolean includeData) throws ApiException
      List all submissions for a given template
      Parameters:
      templateId - (required)
      cursor - (optional)
      limit - (optional)
      createdAfter - (optional)
      createdBefore - (optional)
      type - (optional)
      includeData - (optional)
      Returns:
      ListSubmissionsResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 listing submissions -
      404 invalid template id -

    • listTemplateSubmissionsWithHttpInfo

      public ApiResponse<ListSubmissionsResponse> listTemplateSubmissionsWithHttpInfo(String templateId, String cursor, BigDecimal limit, String createdAfter, String createdBefore, String type, Boolean includeData) throws ApiException
      List all submissions for a given template
      Parameters:
      templateId - (required)
      cursor - (optional)
      limit - (optional)
      createdAfter - (optional)
      createdBefore - (optional)
      type - (optional)
      includeData - (optional)
      Returns:
      ApiResponse<ListSubmissionsResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 listing submissions -
      404 invalid template id -

    • listTemplates

      public List<TemplatePreview> listTemplates(String query, String parentFolderId, Integer page, Integer perPage) throws ApiException
      Get a list of all templates
      Parameters:
      query - Search By Name (optional)
      parentFolderId - Filter By Folder Id (optional)
      page - Default: 1 (optional)
      perPage - Default: 50 (optional)
      Returns:
      List<TemplatePreview>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 enumerate all templates -
      404 filter templates by invalid folder id -
      401 authentication failed -

    • listTemplatesWithHttpInfo

      public ApiResponse<List<TemplatePreview>> listTemplatesWithHttpInfo(String query, String parentFolderId, Integer page, Integer perPage) throws ApiException
      Get a list of all templates
      Parameters:
      query - Search By Name (optional)
      parentFolderId - Filter By Folder Id (optional)
      page - Default: 1 (optional)
      perPage - Default: 50 (optional)
      Returns:
      ApiResponse<List<TemplatePreview>>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 enumerate all templates -
      404 filter templates by invalid folder id -
      401 authentication failed -

    • moveFolderToFolder

      public Folder moveFolderToFolder(String folderId, MoveFolderData data) throws ApiException
      Move a folder
      Parameters:
      folderId - (required)
      data - (required)
      Returns:
      Folder
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      404 parent folder doesn't exist -
      200 move to root folder -
      401 authentication failed -

    • moveFolderToFolderWithHttpInfo

      public ApiResponse<Folder> moveFolderToFolderWithHttpInfo(String folderId, MoveFolderData data) throws ApiException
      Move a folder
      Parameters:
      folderId - (required)
      data - (required)
      Returns:
      ApiResponse<Folder>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      404 parent folder doesn't exist -
      200 move to root folder -
      401 authentication failed -

    • moveTemplateToFolder

      public TemplatePreview moveTemplateToFolder(String templateId, MoveTemplateData data) throws ApiException
      Move Template to folder
      Parameters:
      templateId - (required)
      data - (required)
      Returns:
      TemplatePreview
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 move template success -
      404 folder not found -

    • moveTemplateToFolderWithHttpInfo

      public ApiResponse<TemplatePreview> moveTemplateToFolderWithHttpInfo(String templateId, MoveTemplateData data) throws ApiException
      Move Template to folder
      Parameters:
      templateId - (required)
      data - (required)
      Returns:
      ApiResponse<TemplatePreview>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 move template success -
      404 folder not found -

    • publishTemplateVersion

      public TemplatePublishVersionResponse publishTemplateVersion(String templateId, PublishVersionData data) throws ApiException
      Publish a template version
      Parameters:
      templateId - (required)
      data - (required)
      Returns:
      TemplatePublishVersionResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 version published successfully -
      422 invalid version type -
      404 template not found -
      401 authentication failed -

    • publishTemplateVersionWithHttpInfo

      public ApiResponse<TemplatePublishVersionResponse> publishTemplateVersionWithHttpInfo(String templateId, PublishVersionData data) throws ApiException
      Publish a template version
      Parameters:
      templateId - (required)
      data - (required)
      Returns:
      ApiResponse<TemplatePublishVersionResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 version published successfully -
      422 invalid version type -
      404 template not found -
      401 authentication failed -

    • renameFolder

      public Folder renameFolder(String folderId, RenameFolderData data) throws ApiException
      Rename a folder
      Parameters:
      folderId - (required)
      data - (required)
      Returns:
      Folder
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      422 name already exist -
      404 folder doesn't belong to me -
      200 successful rename -
      401 authentication failed -

    • renameFolderWithHttpInfo

      public ApiResponse<Folder> renameFolderWithHttpInfo(String folderId, RenameFolderData data) throws ApiException
      Rename a folder
      Parameters:
      folderId - (required)
      data - (required)
      Returns:
      ApiResponse<Folder>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      422 name already exist -
      404 folder doesn't belong to me -
      200 successful rename -
      401 authentication failed -

    • restoreTemplateVersion

      public SuccessErrorResponse restoreTemplateVersion(String templateId, RestoreVersionData data) throws ApiException
      Restore a template version
      Parameters:
      templateId - (required)
      data - (required)
      Returns:
      SuccessErrorResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 version restored successfully -
      422 draft version not allowed -
      404 template version not found -
      401 authentication failed -

    • restoreTemplateVersionWithHttpInfo

      public ApiResponse<SuccessErrorResponse> restoreTemplateVersionWithHttpInfo(String templateId, RestoreVersionData data) throws ApiException
      Restore a template version
      Parameters:
      templateId - (required)
      data - (required)
      Returns:
      ApiResponse<SuccessErrorResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 version restored successfully -
      422 draft version not allowed -
      404 template version not found -
      401 authentication failed -

    • testAuthentication

      public SuccessErrorResponse testAuthentication() throws ApiException
      Test Authentication
      Returns:
      SuccessErrorResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 authentication succeeded -
      401 authentication failed -

    • testAuthenticationWithHttpInfo

      public ApiResponse<SuccessErrorResponse> testAuthenticationWithHttpInfo() throws ApiException
      Test Authentication
      Returns:
      ApiResponse<SuccessErrorResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 authentication succeeded -
      401 authentication failed -

    • updateDataRequest

      public CreateSubmissionDataRequestResponse updateDataRequest(String dataRequestId, UpdateSubmissionDataRequestData data) throws ApiException
      Update a submission data request
      Parameters:
      dataRequestId - (required)
      data - (required)
      Returns:
      CreateSubmissionDataRequestResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 submission data request updated -
      422 invalid request -
      404 submission data request not found -
      401 authentication failed -

    • updateDataRequestWithHttpInfo

      public ApiResponse<CreateSubmissionDataRequestResponse> updateDataRequestWithHttpInfo(String dataRequestId, UpdateSubmissionDataRequestData data) throws ApiException
      Update a submission data request
      Parameters:
      dataRequestId - (required)
      data - (required)
      Returns:
      ApiResponse<CreateSubmissionDataRequestResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 submission data request updated -
      422 invalid request -
      404 submission data request not found -
      401 authentication failed -

    • updateTemplate

      public SuccessMultipleErrorsResponse updateTemplate(String templateId, UpdateHtmlTemplate data) throws ApiException
      Update a Template
      Parameters:
      templateId - (required)
      data - (required)
      Returns:
      SuccessMultipleErrorsResponse
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 update template success -

    • updateTemplateWithHttpInfo

      public ApiResponse<SuccessMultipleErrorsResponse> updateTemplateWithHttpInfo(String templateId, UpdateHtmlTemplate data) throws ApiException
      Update a Template
      Parameters:
      templateId - (required)
      data - (required)
      Returns:
      ApiResponse<SuccessMultipleErrorsResponse>
      Throws:
      ApiException - if fails to make API call
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 update template success -