Versions in this module Expand all Collapse all v1 v1.0.1 Nov 27, 2021 Changes in this version + var ContextAPIKey = contextKey("apikey") + var ContextAccessToken = contextKey("accesstoken") + var ContextBasicAuth = contextKey("basic") + var ContextOAuth2 = contextKey("token") + func CacheExpires(r *http.Response) time.Time + type APIClient struct + PDFApi *PDFApiService + func NewAPIClient(cfg *Configuration) *APIClient + func (c *APIClient) ChangeBasePath(path string) + type APIKey struct + Key string + Prefix string + type APIResponse struct + Message string + Method string + Operation string + Payload []byte + RequestURL string + func NewAPIResponse(r *http.Response) *APIResponse + func NewAPIResponseWithError(errorMessage string) *APIResponse + type AddFieldsData struct + Fields []TemplatestemplateIdaddFieldsFields + type AddFieldsTemplateResponse struct + Errors []string + NewFieldIds []int32 + Status string + type AuthenticationError struct + Error string + Status string + type AuthenticationSuccessResponse struct + Status string + type BasicAuth struct + Password string + UserName string + type CombinePdfsData struct + DeleteCustomFiles bool + ExpiresIn int32 + Metadata map[string]interface{} + Password string + SourcePdfs []map[string]interface{} + Test bool + type CombinedSubmission struct + Actions []CombinedSubmissionAction + DownloadUrl string + Expired bool + ExpiresAt string + Id string + Metadata map[string]interface{} + Password string + PdfHash string + SourcePdfs []map[string]interface{} + State string + SubmissionIds []string + type CombinedSubmissionAction struct + ActionCategory string + ActionType string + Id string + IntegrationId string + ResultData map[string]interface{} + State string + type CombinedSubmissionData struct + ExpiresIn int32 + Metadata map[string]interface{} + Password string + SubmissionIds []string + Test bool + type Configuration struct + BasePath string + DefaultHeader map[string]string + HTTPClient *http.Client + Host string + Scheme string + UserAgent string + func NewConfiguration() *Configuration + func (c *Configuration) AddDefaultHeader(key string, value string) + type CopyTemplateData struct + Name string + ParentFolderId string + type CreateCombinedSubmissionResponse struct + CombinedSubmission CombinedSubmission + Errors []string + Status string + type CreateCustomFileData struct + CacheId string + type CreateCustomFileResponse struct + CustomFile CustomFile + Errors []string + Status string + type CreateFolderData struct + Folder FoldersFolder + type CreateHtmlTemplateData struct + Template HtmlTemplateData + type CreatePDFTemplateOpts struct + TemplateParentFolderId optional.String + type CreateSubmissionBatchResponse struct + Error string + Errors []string + Status string + SubmissionBatch SubmissionBatch + Submissions []CreateSubmissionBatchSubmissionsResponse + type CreateSubmissionBatchSubmissionsResponse struct + Errors []string + Status string + Submission Submission + type CreateSubmissionDataRequestData struct + AuthPhoneNumberHash string + AuthProvider string + AuthSecondFactorType string + AuthSessionIdHash string + AuthSessionStartedAt string + AuthType string + AuthUserIdHash string + AuthUsernameHash string + Email string + Fields []string + Metadata map[string]interface{} + Name string + Order int32 + type CreateSubmissionDataRequestTokenResponse struct + Errors []string + Status string + Token CreateSubmissionDataRequestTokenResponseToken + type CreateSubmissionDataRequestTokenResponseToken struct + DataRequestUrl string + ExpiresAt string + Id string + Secret string + type CreateSubmissionResponse struct + Errors []string + Status string + Submission Submission + type CreateTemplateFromUploadData struct + Template UploadTemplateData + type CustomFile struct + Id string + Url string + type Folder struct + Id string + Name string + ParentFolderId string + Path string + type FoldersFolder struct + Name string + ParentFolderId string + type GenericOpenAPIError struct + func (e GenericOpenAPIError) Body() []byte + func (e GenericOpenAPIError) Error() string + func (e GenericOpenAPIError) Model() interface{} + type GetSubmissionBatchOpts struct + IncludeSubmissions optional.Bool + type GetSubmissionOpts struct + IncludeData optional.Bool + type HtmlTemplateData struct + AllowAdditionalProperties bool + Description string + EditableSubmissions bool + ExpirationInterval string + ExpireAfter float32 + ExpireSubmissions bool + FooterHtml string + HeaderHtml string + Html string + Name string + PublicSubmissions bool + PublicWebForm bool + RedirectUrl string + Scss string + SlackWebhookUrl string + TemplateType string + WebhookUrl string + type InvalidRequest struct + Errors []string + Status string + type ListFoldersOpts struct + ParentFolderId optional.String + type ListSubmissionsOpts struct + CreatedAfter optional.String + CreatedBefore optional.String + Cursor optional.String + IncludeData optional.Bool + Limit optional.Float32 + Type_ optional.String + type ListSubmissionsResponse struct + Limit float32 + NextCursor string + Submissions []Submission + type ListSubmissions_1Opts struct + CreatedAfter optional.String + CreatedBefore optional.String + Cursor optional.String + IncludeData optional.Bool + Limit optional.Float32 + Type_ optional.String + type ListTemplatesOpts struct + Page optional.Int32 + ParentFolderId optional.String + PerPage optional.Int32 + Query optional.String + type ModelError struct + Error string + Status string + type MoveFolderData struct + ParentFolderId string + type MoveTemplateData struct + ParentFolderId string + type PDFApiService service + func (a *PDFApiService) AddFieldsToTemplate(ctx context.Context, templateId string, addFieldsData AddFieldsData) (AddFieldsTemplateResponse, *http.Response, error) + func (a *PDFApiService) BatchGeneratePdfV1(ctx context.Context, templateId string, ...) ([]CreateSubmissionResponse, *http.Response, error) + func (a *PDFApiService) BatchGeneratePdfs(ctx context.Context, submissionBatchData SubmissionBatchData) (CreateSubmissionBatchResponse, *http.Response, error) + func (a *PDFApiService) CombinePdfs(ctx context.Context, combinePdfsData CombinePdfsData) (CreateCombinedSubmissionResponse, *http.Response, error) + func (a *PDFApiService) CombineSubmissions(ctx context.Context, combinedSubmissionData CombinedSubmissionData) (CreateCombinedSubmissionResponse, *http.Response, error) + func (a *PDFApiService) CopyTemplate(ctx context.Context, templateId string, copyTemplateData CopyTemplateData) (Template, *http.Response, error) + func (a *PDFApiService) CreateCustomFileFromUpload(ctx context.Context, createCustomFileData CreateCustomFileData) (CreateCustomFileResponse, *http.Response, error) + func (a *PDFApiService) CreateDataRequestToken(ctx context.Context, dataRequestId string) (CreateSubmissionDataRequestTokenResponse, *http.Response, error) + func (a *PDFApiService) CreateFolder(ctx context.Context, createFolderData CreateFolderData) (Folder, *http.Response, error) + func (a *PDFApiService) CreateHTMLTemplate(ctx context.Context, createHtmlTemplateData CreateHtmlTemplateData) (PendingTemplate, *http.Response, error) + func (a *PDFApiService) CreatePDFTemplate(ctx context.Context, templateDocument *os.File, templateName string, ...) (PendingTemplate, *http.Response, error) + func (a *PDFApiService) CreatePDFTemplateFromUpload(ctx context.Context, createTemplateFromUploadData CreateTemplateFromUploadData) (PendingTemplate, *http.Response, error) + func (a *PDFApiService) DeleteFolder(ctx context.Context, folderId string) (Folder, *http.Response, error) + func (a *PDFApiService) ExpireCombinedSubmission(ctx context.Context, combinedSubmissionId string) (CombinedSubmission, *http.Response, error) + func (a *PDFApiService) ExpireSubmission(ctx context.Context, submissionId string) (Submission, *http.Response, error) + func (a *PDFApiService) GeneratePDF(ctx context.Context, templateId string, submissionData SubmissionData) (CreateSubmissionResponse, *http.Response, error) + func (a *PDFApiService) GetCombinedSubmission(ctx context.Context, combinedSubmissionId string) (CombinedSubmission, *http.Response, error) + func (a *PDFApiService) GetDataRequest(ctx context.Context, dataRequestId string) (SubmissionDataRequest, *http.Response, error) + func (a *PDFApiService) GetFullTemplate(ctx context.Context, templateId string) (Template1, *http.Response, error) + func (a *PDFApiService) GetPresignUrl(ctx context.Context) (map[string]map[string]interface{}, *http.Response, error) + func (a *PDFApiService) GetSubmission(ctx context.Context, submissionId string, localVarOptionals *GetSubmissionOpts) (Submission, *http.Response, error) + func (a *PDFApiService) GetSubmissionBatch(ctx context.Context, submissionBatchId string, ...) (SubmissionBatch, *http.Response, error) + func (a *PDFApiService) GetTemplate(ctx context.Context, templateId string) (Template, *http.Response, error) + func (a *PDFApiService) GetTemplateSchema(ctx context.Context, templateId string) (map[string]map[string]interface{}, *http.Response, error) + func (a *PDFApiService) ListFolders(ctx context.Context, localVarOptionals *ListFoldersOpts) ([]Folder, *http.Response, error) + func (a *PDFApiService) ListSubmissions(ctx context.Context, localVarOptionals *ListSubmissionsOpts) (ListSubmissionsResponse, *http.Response, error) + func (a *PDFApiService) ListSubmissions_1(ctx context.Context, templateId string, ...) (ListSubmissionsResponse, *http.Response, error) + func (a *PDFApiService) ListTemplates(ctx context.Context, localVarOptionals *ListTemplatesOpts) ([]Template, *http.Response, error) + func (a *PDFApiService) MoveFolderToFolder(ctx context.Context, folderId string, moveFolderData MoveFolderData) (Folder, *http.Response, error) + func (a *PDFApiService) MoveTemplateToFolder(ctx context.Context, templateId string, moveTemplateData MoveTemplateData) (Template, *http.Response, error) + func (a *PDFApiService) RenameFolder(ctx context.Context, folderId string, renameFolderData RenameFolderData) (*http.Response, error) + func (a *PDFApiService) TestAuthentication(ctx context.Context) (AuthenticationSuccessResponse, *http.Response, error) + func (a *PDFApiService) UpdateDataRequest(ctx context.Context, dataRequestId string, ...) (UpdateDataRequestResponse, *http.Response, error) + func (a *PDFApiService) UpdateTemplate(ctx context.Context, templateId string, updateTemplateData UpdateTemplateData) (UpdateTemplateResponse, *http.Response, error) + type PendingTemplate struct + AllowAdditionalProperties bool + Description string + EditableSubmissions bool + ExpirationInterval string + ExpireAfter float32 + ExpireSubmissions bool + Id string + Locked bool + Name string + ParentFolderId string + Path string + PublicSubmissions bool + PublicWebForm bool + RedirectUrl string + SlackWebhookUrl string + TemplateType string + WebhookUrl string + type RenameFolderData struct + Name string + type Submission struct + Actions []SubmissionAction + BatchId string + Data map[string]interface{} + DataRequests []SubmissionDataRequest + DownloadUrl string + Editable bool + Expired bool + ExpiresAt string + Id string + Metadata map[string]interface{} + PdfHash string + PermanentDownloadUrl string + ProcessedAt string + Referrer string + Source string + State string + TemplateId string + Test bool + TruncatedText map[string]interface{} + type SubmissionAction struct + ActionCategory string + ActionType string + Id string + IntegrationId string + ResultData map[string]interface{} + State string + type SubmissionBatch struct + CompletionPercentage int32 + ErrorCount int32 + Id string + Metadata map[string]interface{} + PendingCount int32 + ProcessedAt string + State string + Submissions []Submission + TotalCount int32 + type SubmissionBatchData struct + Metadata map[string]interface{} + Submissions []SubmissionDataBatchRequest + TemplateId string + Test bool + type SubmissionData struct + Css string + Data map[string]interface{} + DataRequests []CreateSubmissionDataRequestData + FieldOverrides map[string]interface{} + Html string + Metadata map[string]interface{} + Password string + Test bool + type SubmissionDataBatchRequest struct + Css string + Data map[string]interface{} + Html string + Metadata map[string]interface{} + TemplateId string + Test bool + type SubmissionDataRequest struct + AuthPhoneNumberHash string + AuthProvider string + AuthSecondFactorType string + AuthSessionIdHash string + AuthSessionStartedAt string + AuthType string + AuthUserIdHash string + AuthUsernameHash string + CompletedAt string + Email string + Fields []string + Id string + IpAddress string + Metadata map[string]interface{} + Name string + Order int32 + SortOrder int32 + State string + UserAgent string + ViewedAt string + type Template struct + AllowAdditionalProperties bool + Description string + DocumentUrl string + EditableSubmissions bool + ExpirationInterval string + ExpireAfter float32 + ExpireSubmissions bool + Id string + Locked bool + Name string + PageDimensions [][]float32 + ParentFolderId string + Path string + PermanentDocumentUrl string + PublicSubmissions bool + PublicWebForm bool + RedirectUrl string + SlackWebhookUrl string + TemplateType string + WebhookUrl string + type Template1 struct + AllowAdditionalProperties bool + Defaults Template1Defaults + Demo bool + Description string + DocumentFilename string + DocumentMd5 string + DocumentParseError bool + DocumentProcessed bool + DocumentState string + DocumentUrl string + EditableSubmissions bool + EmbedDomains []string + EncryptPdfs bool + EncryptPdfsPassword string + ExpirationInterval string + ExpireAfter float32 + ExpireSubmissions bool + FieldOrder [][]float32 + Fields map[string]interface{} + FirstTemplate bool + FooterHtml string + HeaderHtml string + Html string + Id string + Locked bool + Name string + PageCount float32 + PageDimensions [][]float32 + ParentFolderId string + Path string + PermanentDocumentUrl string + PublicSubmissions bool + PublicWebForm bool + RedirectUrl string + Scss string + SharedFieldData map[string]interface{} + SlackWebhookUrl string + TemplateType string + WebhookUrl string + type Template1Defaults struct + Color string + FontSize float32 + Typeface string + type TemplateData struct + AllowAdditionalProperties bool + Description string + EditableSubmissions bool + ExpirationInterval string + ExpireAfter float32 + ExpireSubmissions bool + FooterHtml string + HeaderHtml string + Html string + Name string + PublicSubmissions bool + PublicWebForm bool + RedirectUrl string + Scss string + SlackWebhookUrl string + WebhookUrl string + type TemplatestemplateIdaddFieldsFields struct + Alignment string + AutoCalculateMaxLength bool + BackgroundColor string + BackgroundColorFieldName string + BackgroundColorFieldRequired bool + BarcodeSymbology string + Bold bool + CharacterSpacing float32 + CheckCharacter string + CheckColor string + CheckColorFieldName string + CheckColorFieldRequired bool + Color string + ColorFieldName string + ColorFieldRequired bool + Comb bool + CombNumberOfCells float32 + CombValueOffset float32 + CombinedFieldFormat string + CombinedFieldNames string + CombinedFieldSeparator string + CombinedFieldType string + Condition string + Currency bool + DateTimeFormat string + DecimalPlaces float32 + Default string + Description string + DisplayType string + ExclusiveMaximum bool + ExclusiveMinimum bool + FalseText string + FontSize float32 + Height float32 + Hidden bool + Id float32 + ImageGravity string + ImageScaleType string + IncludeTime bool + Integer bool + InvertBooleanCondition bool + MaxLength float32 + Maximum float32 + Metadata string + MinLength float32 + Minimum float32 + Multiline bool + MultilineLines float32 + Name string + NumberConditionRangeExclusiveMax bool + NumberConditionRangeExclusiveMin bool + NumberConditionRangeMax float32 + NumberConditionRangeMin float32 + NumberConditionType string + Opacity float32 + OptionList string + Overflow string + Page float32 + QrcodeColor string + QrcodeColorFieldName string + QrcodeColorFieldRequired bool + Required bool + Rotation float32 + ShapeBorderColor string + ShapeBorderColorFieldName string + ShapeBorderColorFieldRequired bool + ShapeBorderWidth float32 + ShapeFillColor string + ShapeFillColorFieldName string + ShapeFillColorFieldRequired bool + ShapeType string + SignatureAllowDraw bool + SignatureAllowType bool + Static bool + Strikethrough bool + StringConditionType string + Title string + TrueText string + Type string + Typeface string + Uppercase bool + VAlignment string + Width float32 + X float32 + Y float32 + type UpdateDataRequestResponse struct + DataRequest SubmissionDataRequest + Errors []string + Status string + type UpdateSubmissionDataRequestData struct + AuthPhoneNumberHash string + AuthProvider string + AuthSecondFactorType string + AuthSessionIdHash string + AuthSessionStartedAt string + AuthType string + AuthUserIdHash string + AuthUsernameHash string + Email string + Fields []string + Metadata map[string]interface{} + Name string + Order int32 + type UpdateTemplateData struct + Template TemplateData + type UpdateTemplateResponse struct + Errors []string + Status string + type UploadTemplateData struct + AllowAdditionalProperties bool + Description string + Document UploadTemplateDataDocument + EditableSubmissions bool + ExpirationInterval string + ExpireAfter float32 + ExpireSubmissions bool + FooterHtml string + HeaderHtml string + Html string + Name string + PublicSubmissions bool + PublicWebForm bool + RedirectUrl string + Scss string + SlackWebhookUrl string + TemplateType string + WebhookUrl string + type UploadTemplateDataDocument struct + Id string + Metadata UploadTemplateDataDocumentMetadata + Storage string + type UploadTemplateDataDocumentMetadata struct + Filename string + MimeType string + Size int32