Skip to content

Latest commit

 

History

History
2864 lines (1837 loc) · 78.6 KB

ClientAPI.md

File metadata and controls

2864 lines (1837 loc) · 78.6 KB

\ClientAPI

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

Method HTTP request Description
AddFieldsToTemplate Put /templates/{template_id}/add_fields Add new fields to a Template
BatchGeneratePdfs Post /submissions/batches Generate multiple PDFs
CombinePdfs Post /combined_submissions Merge submission PDFs, template PDFs, or custom files
CopyTemplate Post /templates/{template_id}/copy Copy a template
CreateCustomFileFromUpload Post /custom_files Create a new custom file from a cached S3 upload
CreateDataRequestEvent Post /data_requests/{data_request_id}/events Create a new event for emailing a signee a request for signature
CreateDataRequestToken Post /data_requests/{data_request_id}/tokens Create a new data request token for form authentication
CreateFolder Post /folders/ Create a folder
CreateHtmlTemplate Post /templates?endpoint_variant=create_html_template Create a new HTML template
CreatePdfTemplate Post /templates Create a new PDF template with a form POST file upload
CreatePdfTemplateFromUpload Post /templates?endpoint_variant=create_template_from_cached_upload Create a new PDF template from a cached S3 file upload
DeleteFolder Delete /folders/{folder_id} Delete a folder
DeleteTemplate Delete /templates/{template_id} Delete a template
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 Generate a PDF
GeneratePreview Post /submissions/{submission_id}/generate_preview Generate a preview PDF for partially completed data requests
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 attributes for a PDF template
GetPresignUrl Get /uploads/presign Get a presigned S3 URL for direct file upload
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
ListCombinedSubmissions Get /combined_submissions Get a list of all combined submissions
ListFolders Get /folders/ Get a list of all folders
ListSubmissions Get /submissions List all submissions
ListTemplateSubmissions 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
PublishTemplateVersion Post /templates/{template_id}/publish_version Publish a template version
RenameFolder Post /folders/{folder_id}/rename Rename a folder
RestoreTemplateVersion Post /templates/{template_id}/restore_version Restore a template version
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
UpdateTemplateDocument Put /templates/{template_id}?endpoint_variant=update_template_pdf_with_form_post Update a template's document with a form POST file upload
UpdateTemplateDocumentFromUpload Put /templates/{template_id}?endpoint_variant=update_template_pdf_with_cached_upload Update a template's document with a cached S3 file upload

AddFieldsToTemplate

TemplateAddFieldsResponse AddFieldsToTemplate(ctx, templateId).Data(data).Execute()

Add new fields to a Template

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef02" // string | 
	data := *openapiclient.NewAddFieldsData([]map[string]interface{}{map[string]interface{}(123)}) // AddFieldsData | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.AddFieldsToTemplate(context.Background(), templateId).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.AddFieldsToTemplate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AddFieldsToTemplate`: TemplateAddFieldsResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.AddFieldsToTemplate`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiAddFieldsToTemplateRequest struct via the builder pattern

Name Type Description Notes

data | AddFieldsData | |

Return type

TemplateAddFieldsResponse

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

BatchGeneratePdfs201Response BatchGeneratePdfs(ctx).Data(data).Wait(wait).Execute()

Generate multiple PDFs

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	data := *openapiclient.NewSubmissionBatchData([]map[string]interface{}{map[string]interface{}(123)}) // SubmissionBatchData | 
	wait := true // bool | Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional) (default to true)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.BatchGeneratePdfs(context.Background()).Data(data).Wait(wait).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.BatchGeneratePdfs``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `BatchGeneratePdfs`: BatchGeneratePdfs201Response
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.BatchGeneratePdfs`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiBatchGeneratePdfsRequest struct via the builder pattern

Name Type Description Notes
data SubmissionBatchData
wait bool Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) [default to true]

Return type

BatchGeneratePdfs201Response

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(ctx).Data(data).Execute()

Merge submission PDFs, template PDFs, or custom files

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	data := *openapiclient.NewCombinePdfsData([]map[string]interface{}{map[string]interface{}(123)}) // CombinePdfsData | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.CombinePdfs(context.Background()).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.CombinePdfs``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CombinePdfs`: CreateCombinedSubmissionResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.CombinePdfs`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCombinePdfsRequest struct via the builder pattern

Name Type Description Notes
data 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]

CopyTemplate

TemplatePreview CopyTemplate(ctx, templateId).Options(options).Execute()

Copy a template

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef01" // string | 
	options := *openapiclient.NewCopyTemplateOptions("ParentFolderId_example") // CopyTemplateOptions |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.CopyTemplate(context.Background(), templateId).Options(options).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.CopyTemplate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CopyTemplate`: TemplatePreview
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.CopyTemplate`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiCopyTemplateRequest struct via the builder pattern

Name Type Description Notes

options | CopyTemplateOptions | |

Return type

TemplatePreview

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(ctx).Data(data).Execute()

Create a new custom file from a cached S3 upload

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	data := *openapiclient.NewCreateCustomFileData("CacheId_example") // CreateCustomFileData | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.CreateCustomFileFromUpload(context.Background()).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.CreateCustomFileFromUpload``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateCustomFileFromUpload`: CreateCustomFileResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.CreateCustomFileFromUpload`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateCustomFileFromUploadRequest struct via the builder pattern

Name Type Description Notes
data 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]

CreateDataRequestEvent

CreateSubmissionDataRequestEventResponse CreateDataRequestEvent(ctx, dataRequestId).Event(event).Execute()

Create a new event for emailing a signee a request for signature

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	dataRequestId := "drq_1234567890abcdef01" // string | 
	event := *openapiclient.NewCreateSubmissionDataRequestEventRequest("EventType_example") // CreateSubmissionDataRequestEventRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.CreateDataRequestEvent(context.Background(), dataRequestId).Event(event).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.CreateDataRequestEvent``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateDataRequestEvent`: CreateSubmissionDataRequestEventResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.CreateDataRequestEvent`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dataRequestId string

Other Parameters

Other parameters are passed through a pointer to a apiCreateDataRequestEventRequest struct via the builder pattern

Name Type Description Notes

event | CreateSubmissionDataRequestEventRequest | |

Return type

CreateSubmissionDataRequestEventResponse

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(ctx, dataRequestId).Type_(type_).Execute()

Create a new data request token for form authentication

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	dataRequestId := "drq_1234567890abcdef01" // string | 
	type_ := "api" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.CreateDataRequestToken(context.Background(), dataRequestId).Type_(type_).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.CreateDataRequestToken``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateDataRequestToken`: CreateSubmissionDataRequestTokenResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.CreateDataRequestToken`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dataRequestId string

Other Parameters

Other parameters are passed through a pointer to a apiCreateDataRequestTokenRequest struct via the builder pattern

Name Type Description Notes

type_ | 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(ctx).Data(data).Execute()

Create a folder

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	data := *openapiclient.NewCreateFolderData(map[string]interface{}(123)) // CreateFolderData | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.CreateFolder(context.Background()).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.CreateFolder``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateFolder`: Folder
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.CreateFolder`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateFolderRequest struct via the builder pattern

Name Type Description Notes
data 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

TemplatePreview CreateHtmlTemplate(ctx).Data(data).Execute()

Create a new HTML template

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	data := *openapiclient.NewCreateHtmlTemplate(map[string]interface{}(123)) // CreateHtmlTemplate | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.CreateHtmlTemplate(context.Background()).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.CreateHtmlTemplate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateHtmlTemplate`: TemplatePreview
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.CreateHtmlTemplate`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateHtmlTemplateRequest struct via the builder pattern

Name Type Description Notes
data CreateHtmlTemplate

Return type

TemplatePreview

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

TemplatePreview CreatePdfTemplate(ctx).TemplateDocument(templateDocument).TemplateName(templateName).Wait(wait).TemplateDescription(templateDescription).TemplateParentFolderId(templateParentFolderId).Execute()

Create a new PDF template with a form POST file upload

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateDocument := os.NewFile(1234, "some_file") // *os.File | 
	templateName := "templateName_example" // string | 
	wait := true // bool | 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 := "templateDescription_example" // string |  (optional)
	templateParentFolderId := "templateParentFolderId_example" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.CreatePdfTemplate(context.Background()).TemplateDocument(templateDocument).TemplateName(templateName).Wait(wait).TemplateDescription(templateDescription).TemplateParentFolderId(templateParentFolderId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.CreatePdfTemplate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreatePdfTemplate`: TemplatePreview
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.CreatePdfTemplate`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreatePdfTemplateRequest struct via the builder pattern

Name Type Description Notes
templateDocument *os.File
templateName string
wait bool Wait for template document to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) [default to true]
templateDescription string
templateParentFolderId string

Return type

TemplatePreview

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

TemplatePreview CreatePdfTemplateFromUpload(ctx).Data(data).Execute()

Create a new PDF template from a cached S3 file upload

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	data := *openapiclient.NewCreatePdfTemplate(map[string]interface{}(123)) // CreatePdfTemplate | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.CreatePdfTemplateFromUpload(context.Background()).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.CreatePdfTemplateFromUpload``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreatePdfTemplateFromUpload`: TemplatePreview
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.CreatePdfTemplateFromUpload`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreatePdfTemplateFromUploadRequest struct via the builder pattern

Name Type Description Notes
data CreatePdfTemplate

Return type

TemplatePreview

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(ctx, folderId).Execute()

Delete a folder

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	folderId := "fld_1234567890abcdef01" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.DeleteFolder(context.Background(), folderId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.DeleteFolder``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteFolder`: Folder
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.DeleteFolder`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
folderId string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteFolderRequest struct via the builder pattern

Name Type Description Notes

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]

DeleteTemplate

TemplateDeleteResponse DeleteTemplate(ctx, templateId).Version(version).Execute()

Delete a template

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef01" // string | 
	version := "0.1.0" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.DeleteTemplate(context.Background(), templateId).Version(version).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.DeleteTemplate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteTemplate`: TemplateDeleteResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.DeleteTemplate`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteTemplateRequest struct via the builder pattern

Name Type Description Notes

version | string | |

Return type

TemplateDeleteResponse

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(ctx, combinedSubmissionId).Execute()

Expire a combined submission

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	combinedSubmissionId := "com_1234567890abcdef01" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.ExpireCombinedSubmission(context.Background(), combinedSubmissionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.ExpireCombinedSubmission``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ExpireCombinedSubmission`: CombinedSubmission
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.ExpireCombinedSubmission`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
combinedSubmissionId string

Other Parameters

Other parameters are passed through a pointer to a apiExpireCombinedSubmissionRequest struct via the builder pattern

Name Type Description Notes

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

SubmissionPreview ExpireSubmission(ctx, submissionId).Execute()

Expire a PDF submission

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	submissionId := "sub_1234567890abcdef01" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.ExpireSubmission(context.Background(), submissionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.ExpireSubmission``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ExpireSubmission`: SubmissionPreview
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.ExpireSubmission`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
submissionId string

Other Parameters

Other parameters are passed through a pointer to a apiExpireSubmissionRequest struct via the builder pattern

Name Type Description Notes

Return type

SubmissionPreview

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(ctx, templateId).Submission(submission).Wait(wait).Execute()

Generate a PDF

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef01" // string | 
	submission := *openapiclient.NewCreatePdfSubmissionData(map[string]interface{}(123)) // CreatePdfSubmissionData | 
	wait := true // bool | Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional) (default to true)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.GeneratePdf(context.Background(), templateId).Submission(submission).Wait(wait).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.GeneratePdf``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GeneratePdf`: CreateSubmissionResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.GeneratePdf`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiGeneratePdfRequest struct via the builder pattern

Name Type Description Notes

submission | CreatePdfSubmissionData | | wait | bool | Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) | [default to true]

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]

GeneratePreview

SuccessErrorResponse GeneratePreview(ctx, submissionId).Execute()

Generate a preview PDF for partially completed data requests

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	submissionId := "sub_1234567890abcdef01" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.GeneratePreview(context.Background(), submissionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.GeneratePreview``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GeneratePreview`: SuccessErrorResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.GeneratePreview`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
submissionId string

Other Parameters

Other parameters are passed through a pointer to a apiGeneratePreviewRequest struct via the builder pattern

Name Type Description Notes

Return type

SuccessErrorResponse

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]

GetCombinedSubmission

CombinedSubmission GetCombinedSubmission(ctx, combinedSubmissionId).Execute()

Check the status of a combined submission (merged PDFs)

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	combinedSubmissionId := "com_1234567890abcdef01" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.GetCombinedSubmission(context.Background(), combinedSubmissionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.GetCombinedSubmission``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetCombinedSubmission`: CombinedSubmission
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.GetCombinedSubmission`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
combinedSubmissionId string

Other Parameters

Other parameters are passed through a pointer to a apiGetCombinedSubmissionRequest struct via the builder pattern

Name Type Description Notes

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

SubmissionDataRequestShow GetDataRequest(ctx, dataRequestId).Execute()

Look up a submission data request

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	dataRequestId := "drq_1234567890abcdef01" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.GetDataRequest(context.Background(), dataRequestId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.GetDataRequest``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDataRequest`: SubmissionDataRequestShow
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.GetDataRequest`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dataRequestId string

Other Parameters

Other parameters are passed through a pointer to a apiGetDataRequestRequest struct via the builder pattern

Name Type Description Notes

Return type

SubmissionDataRequestShow

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

Template GetFullTemplate(ctx, templateId).Execute()

Fetch the full attributes for a PDF template

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef01" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.GetFullTemplate(context.Background(), templateId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.GetFullTemplate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetFullTemplate`: Template
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.GetFullTemplate`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiGetFullTemplateRequest struct via the builder pattern

Name Type Description Notes

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]

GetPresignUrl

UploadPresignResponse GetPresignUrl(ctx).Execute()

Get a presigned S3 URL for direct file upload

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.GetPresignUrl(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.GetPresignUrl``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetPresignUrl`: UploadPresignResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.GetPresignUrl`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetPresignUrlRequest struct via the builder pattern

Return type

UploadPresignResponse

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(ctx, submissionId).IncludeData(includeData).Execute()

Check the status of a PDF

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	submissionId := "sub_1234567890abcdef01" // string | 
	includeData := true // bool |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.GetSubmission(context.Background(), submissionId).IncludeData(includeData).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.GetSubmission``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSubmission`: Submission
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.GetSubmission`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
submissionId string

Other Parameters

Other parameters are passed through a pointer to a apiGetSubmissionRequest struct via the builder pattern

Name Type Description Notes

includeData | bool | |

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

SubmissionBatchWithSubmissions GetSubmissionBatch(ctx, submissionBatchId).IncludeSubmissions(includeSubmissions).Execute()

Check the status of a submission batch job

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	submissionBatchId := "sbb_1234567890abcdef01" // string | 
	includeSubmissions := true // bool |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.GetSubmissionBatch(context.Background(), submissionBatchId).IncludeSubmissions(includeSubmissions).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.GetSubmissionBatch``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSubmissionBatch`: SubmissionBatchWithSubmissions
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.GetSubmissionBatch`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
submissionBatchId string

Other Parameters

Other parameters are passed through a pointer to a apiGetSubmissionBatchRequest struct via the builder pattern

Name Type Description Notes

includeSubmissions | bool | |

Return type

SubmissionBatchWithSubmissions

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

TemplatePreview GetTemplate(ctx, templateId).Execute()

Check the status of an uploaded template

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef01" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.GetTemplate(context.Background(), templateId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.GetTemplate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTemplate`: TemplatePreview
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.GetTemplate`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiGetTemplateRequest struct via the builder pattern

Name Type Description Notes

Return type

TemplatePreview

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

JsonSchema GetTemplateSchema(ctx, templateId).Execute()

Fetch the JSON schema for a template

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef01" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.GetTemplateSchema(context.Background(), templateId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.GetTemplateSchema``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTemplateSchema`: JsonSchema
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.GetTemplateSchema`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiGetTemplateSchemaRequest struct via the builder pattern

Name Type Description Notes

Return type

JsonSchema

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]

ListCombinedSubmissions

[]CombinedSubmission ListCombinedSubmissions(ctx).Page(page).PerPage(perPage).Execute()

Get a list of all combined submissions

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	page := int32(3) // int32 | Default: 1 (optional)
	perPage := int32(1) // int32 | Default: 50 (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.ListCombinedSubmissions(context.Background()).Page(page).PerPage(perPage).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.ListCombinedSubmissions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListCombinedSubmissions`: []CombinedSubmission
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.ListCombinedSubmissions`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListCombinedSubmissionsRequest struct via the builder pattern

Name Type Description Notes
page int32 Default: 1
perPage int32 Default: 50

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]

ListFolders

[]Folder ListFolders(ctx).ParentFolderId(parentFolderId).Execute()

Get a list of all folders

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	parentFolderId := "fld_1234567890abcdef02" // string | Filter By Folder Id (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.ListFolders(context.Background()).ParentFolderId(parentFolderId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.ListFolders``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListFolders`: []Folder
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.ListFolders`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListFoldersRequest struct via the builder pattern

Name Type Description Notes
parentFolderId string Filter By Folder Id

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]

ListSubmissions

ListSubmissionsResponse ListSubmissions(ctx).Cursor(cursor).Limit(limit).CreatedAfter(createdAfter).CreatedBefore(createdBefore).Type_(type_).IncludeData(includeData).Execute()

List all submissions

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	cursor := "sub_1234567890abcdef12" // string |  (optional)
	limit := int32(3) // int32 |  (optional)
	createdAfter := "2019-01-01T09:00:00-05:00" // string |  (optional)
	createdBefore := "2020-01-01T09:00:00.000+0200" // string |  (optional)
	type_ := "test" // string |  (optional)
	includeData := true // bool |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.ListSubmissions(context.Background()).Cursor(cursor).Limit(limit).CreatedAfter(createdAfter).CreatedBefore(createdBefore).Type_(type_).IncludeData(includeData).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.ListSubmissions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListSubmissions`: ListSubmissionsResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.ListSubmissions`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListSubmissionsRequest struct via the builder pattern

Name Type Description Notes
cursor string
limit int32
createdAfter string
createdBefore string
type_ string
includeData bool

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]

ListTemplateSubmissions

ListSubmissionsResponse ListTemplateSubmissions(ctx, templateId).Cursor(cursor).Limit(limit).CreatedAfter(createdAfter).CreatedBefore(createdBefore).Type_(type_).IncludeData(includeData).Execute()

List all submissions for a given template

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef02" // string | 
	cursor := "cursor_example" // string |  (optional)
	limit := int32(56) // int32 |  (optional)
	createdAfter := "createdAfter_example" // string |  (optional)
	createdBefore := "createdBefore_example" // string |  (optional)
	type_ := "type__example" // string |  (optional)
	includeData := true // bool |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.ListTemplateSubmissions(context.Background(), templateId).Cursor(cursor).Limit(limit).CreatedAfter(createdAfter).CreatedBefore(createdBefore).Type_(type_).IncludeData(includeData).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.ListTemplateSubmissions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListTemplateSubmissions`: ListSubmissionsResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.ListTemplateSubmissions`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiListTemplateSubmissionsRequest struct via the builder pattern

Name Type Description Notes

cursor | string | | limit | int32 | | createdAfter | string | | createdBefore | string | | type_ | string | | includeData | bool | |

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

[]TemplatePreview ListTemplates(ctx).Query(query).ParentFolderId(parentFolderId).Page(page).PerPage(perPage).Execute()

Get a list of all templates

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	query := "2" // string | Search By Name (optional)
	parentFolderId := "fld_1234567890abcdef01" // string | Filter By Folder Id (optional)
	page := int32(2) // int32 | Default: 1 (optional)
	perPage := int32(1) // int32 | Default: 50 (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.ListTemplates(context.Background()).Query(query).ParentFolderId(parentFolderId).Page(page).PerPage(perPage).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.ListTemplates``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListTemplates`: []TemplatePreview
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.ListTemplates`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListTemplatesRequest struct via the builder pattern

Name Type Description Notes
query string Search By Name
parentFolderId string Filter By Folder Id
page int32 Default: 1
perPage int32 Default: 50

Return type

[]TemplatePreview

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(ctx, folderId).Data(data).Execute()

Move a folder

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	folderId := "fld_1234567890abcdef01" // string | 
	data := *openapiclient.NewMoveFolderData() // MoveFolderData | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.MoveFolderToFolder(context.Background(), folderId).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.MoveFolderToFolder``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `MoveFolderToFolder`: Folder
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.MoveFolderToFolder`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
folderId string

Other Parameters

Other parameters are passed through a pointer to a apiMoveFolderToFolderRequest struct via the builder pattern

Name Type Description Notes

data | 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

TemplatePreview MoveTemplateToFolder(ctx, templateId).Data(data).Execute()

Move Template to folder

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef01" // string | 
	data := *openapiclient.NewMoveTemplateData("ParentFolderId_example") // MoveTemplateData | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.MoveTemplateToFolder(context.Background(), templateId).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.MoveTemplateToFolder``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `MoveTemplateToFolder`: TemplatePreview
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.MoveTemplateToFolder`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiMoveTemplateToFolderRequest struct via the builder pattern

Name Type Description Notes

data | MoveTemplateData | |

Return type

TemplatePreview

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]

PublishTemplateVersion

TemplatePublishVersionResponse PublishTemplateVersion(ctx, templateId).Data(data).Execute()

Publish a template version

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef01" // string | 
	data := *openapiclient.NewPublishVersionData("VersionType_example") // PublishVersionData | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.PublishTemplateVersion(context.Background(), templateId).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.PublishTemplateVersion``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PublishTemplateVersion`: TemplatePublishVersionResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.PublishTemplateVersion`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiPublishTemplateVersionRequest struct via the builder pattern

Name Type Description Notes

data | PublishVersionData | |

Return type

TemplatePublishVersionResponse

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

Folder RenameFolder(ctx, folderId).Data(data).Execute()

Rename a folder

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	folderId := "fld_1234567890abcdef01" // string | 
	data := *openapiclient.NewRenameFolderData("Name_example") // RenameFolderData | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.RenameFolder(context.Background(), folderId).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.RenameFolder``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RenameFolder`: Folder
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.RenameFolder`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
folderId string

Other Parameters

Other parameters are passed through a pointer to a apiRenameFolderRequest struct via the builder pattern

Name Type Description Notes

data | RenameFolderData | |

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]

RestoreTemplateVersion

SuccessErrorResponse RestoreTemplateVersion(ctx, templateId).Data(data).Execute()

Restore a template version

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef01" // string | 
	data := *openapiclient.NewRestoreVersionData("Version_example") // RestoreVersionData | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.RestoreTemplateVersion(context.Background(), templateId).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.RestoreTemplateVersion``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RestoreTemplateVersion`: SuccessErrorResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.RestoreTemplateVersion`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiRestoreTemplateVersionRequest struct via the builder pattern

Name Type Description Notes

data | RestoreVersionData | |

Return type

SuccessErrorResponse

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

SuccessErrorResponse TestAuthentication(ctx).Execute()

Test authentication

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.TestAuthentication(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.TestAuthentication``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `TestAuthentication`: SuccessErrorResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.TestAuthentication`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiTestAuthenticationRequest struct via the builder pattern

Return type

SuccessErrorResponse

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

CreateSubmissionDataRequestResponse UpdateDataRequest(ctx, dataRequestId).Data(data).Execute()

Update a submission data request

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	dataRequestId := "drq_1234567890abcdef01" // string | 
	data := *openapiclient.NewUpdateSubmissionDataRequestData() // UpdateSubmissionDataRequestData | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.UpdateDataRequest(context.Background(), dataRequestId).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.UpdateDataRequest``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateDataRequest`: CreateSubmissionDataRequestResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.UpdateDataRequest`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dataRequestId string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateDataRequestRequest struct via the builder pattern

Name Type Description Notes

data | UpdateSubmissionDataRequestData | |

Return type

CreateSubmissionDataRequestResponse

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

SuccessMultipleErrorsResponse UpdateTemplate(ctx, templateId).Data(data).Execute()

Update a Template

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef03" // string | 
	data := *openapiclient.NewUpdateHtmlTemplate(map[string]interface{}(123)) // UpdateHtmlTemplate | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.UpdateTemplate(context.Background(), templateId).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.UpdateTemplate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateTemplate`: SuccessMultipleErrorsResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.UpdateTemplate`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateTemplateRequest struct via the builder pattern

Name Type Description Notes

data | UpdateHtmlTemplate | |

Return type

SuccessMultipleErrorsResponse

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]

UpdateTemplateDocument

SuccessMultipleErrorsResponse UpdateTemplateDocument(ctx, templateId).TemplateDocument(templateDocument).TemplateName(templateName).Execute()

Update a template's document with a form POST file upload

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef01" // string | 
	templateDocument := os.NewFile(1234, "some_file") // *os.File | 
	templateName := "templateName_example" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.UpdateTemplateDocument(context.Background(), templateId).TemplateDocument(templateDocument).TemplateName(templateName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.UpdateTemplateDocument``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateTemplateDocument`: SuccessMultipleErrorsResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.UpdateTemplateDocument`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateTemplateDocumentRequest struct via the builder pattern

Name Type Description Notes

templateDocument | *os.File | | templateName | string | |

Return type

SuccessMultipleErrorsResponse

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]

UpdateTemplateDocumentFromUpload

SuccessMultipleErrorsResponse UpdateTemplateDocumentFromUpload(ctx, templateId).Data(data).Execute()

Update a template's document with a cached S3 file upload

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	templateId := "tpl_1234567890abcdef01" // string | 
	data := *openapiclient.NewUpdatePdfTemplate(map[string]interface{}(123)) // UpdatePdfTemplate | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClientAPI.UpdateTemplateDocumentFromUpload(context.Background(), templateId).Data(data).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientAPI.UpdateTemplateDocumentFromUpload``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateTemplateDocumentFromUpload`: SuccessMultipleErrorsResponse
	fmt.Fprintf(os.Stdout, "Response from `ClientAPI.UpdateTemplateDocumentFromUpload`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateTemplateDocumentFromUploadRequest struct via the builder pattern

Name Type Description Notes

data | UpdatePdfTemplate | |

Return type

SuccessMultipleErrorsResponse

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]