docspring

package module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 27, 2021 License: MIT Imports: 21 Imported by: 0

README

Go API client for docspring

DocSpring is a service that helps you fill out and sign PDF templates.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: v1
  • Package version: 1.0.1
  • Build package: com.docspring.codegen.DocSpringGoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./docspring"

Documentation for API Endpoints

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

Class Method HTTP request Description
PDFApi AddFieldsToTemplate Put /templates/{template_id}/add_fields Add new fields to a Template
PDFApi BatchGeneratePdfV1 Post /templates/{template_id}/submissions/batch Generates multiple PDFs
PDFApi BatchGeneratePdfs Post /submissions/batches Generates multiple PDFs
PDFApi CombinePdfs Post /combined_submissions?v=2 Merge submission PDFs, template PDFs, or custom files
PDFApi CombineSubmissions Post /combined_submissions Merge generated PDFs together
PDFApi CopyTemplate Post /templates/{template_id}/copy Copy a Template
PDFApi CreateCustomFileFromUpload Post /custom_files Create a new custom file from a cached presign upload
PDFApi CreateDataRequestToken Post /data_requests/{data_request_id}/tokens Creates a new data request token for form authentication
PDFApi CreateFolder Post /folders/ Create a folder
PDFApi CreateHTMLTemplate Post /templates?desc=html Create a new HTML template
PDFApi CreatePDFTemplate Post /templates Create a new PDF template with a form POST file upload
PDFApi CreatePDFTemplateFromUpload Post /templates?desc=cached_upload Create a new PDF template from a cached presign upload
PDFApi DeleteFolder Delete /folders/{folder_id} Delete a folder
PDFApi ExpireCombinedSubmission Delete /combined_submissions/{combined_submission_id} Expire a combined submission
PDFApi ExpireSubmission Delete /submissions/{submission_id} Expire a PDF submission
PDFApi GeneratePDF Post /templates/{template_id}/submissions Generates a new PDF
PDFApi GetCombinedSubmission Get /combined_submissions/{combined_submission_id} Check the status of a combined submission (merged PDFs)
PDFApi GetDataRequest Get /data_requests/{data_request_id} Look up a submission data request
PDFApi GetFullTemplate Get /templates/{template_id}?full=true Fetch the full template attributes
PDFApi GetPresignUrl Get /uploads/presign Get a presigned URL so that you can upload a file to our AWS S3 bucket
PDFApi GetSubmission Get /submissions/{submission_id} Check the status of a PDF
PDFApi GetSubmissionBatch Get /submissions/batches/{submission_batch_id} Check the status of a submission batch job
PDFApi GetTemplate Get /templates/{template_id} Check the status of an uploaded template
PDFApi GetTemplateSchema Get /templates/{template_id}/schema Fetch the JSON schema for a template
PDFApi ListFolders Get /folders/ Get a list of all folders
PDFApi ListSubmissions Get /submissions List all submissions
PDFApi ListSubmissions_0 Get /templates/{template_id}/submissions List all submissions for a given template
PDFApi ListTemplates Get /templates Get a list of all templates
PDFApi MoveFolderToFolder Post /folders/{folder_id}/move Move a folder
PDFApi MoveTemplateToFolder Post /templates/{template_id}/move Move Template to folder
PDFApi RenameFolder Post /folders/{folder_id}/rename Rename a folder
PDFApi TestAuthentication Get /authentication Test Authentication
PDFApi UpdateDataRequest Put /data_requests/{data_request_id} Update a submission data request
PDFApi UpdateTemplate Put /templates/{template_id} Update a Template

Documentation For Models

Documentation For Authorization

api_token_basic

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	PDFApi *PDFApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the API v1 API vv1 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AddFieldsData 

type AddFieldsData struct {
	Fields []TemplatestemplateIdaddFieldsFields `json:"fields"`
}

type AddFieldsTemplateResponse 

type AddFieldsTemplateResponse struct {
	NewFieldIds []int32  `json:"new_field_ids,omitempty"`
	Errors      []string `json:"errors,omitempty"`
	Status      string   `json:"status,omitempty"`
}

type AuthenticationError 

type AuthenticationError struct {
	Status string `json:"status,omitempty"`
	Error  string `json:"error"`
}

type AuthenticationSuccessResponse 

type AuthenticationSuccessResponse struct {
	Status string `json:"status,omitempty"`
}

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CombinePdfsData 

type CombinePdfsData struct {
	DeleteCustomFiles bool                     `json:"delete_custom_files,omitempty"`
	ExpiresIn         int32                    `json:"expires_in,omitempty"`
	Metadata          map[string]interface{}   `json:"metadata,omitempty"`
	Password          string                   `json:"password,omitempty"`
	SourcePdfs        []map[string]interface{} `json:"source_pdfs"`
	Test              bool                     `json:"test,omitempty"`
}

type CombinedSubmission 

type CombinedSubmission struct {
	Metadata      map[string]interface{}     `json:"metadata,omitempty"`
	Password      string                     `json:"password,omitempty"`
	Expired       bool                       `json:"expired,omitempty"`
	ExpiresAt     string                     `json:"expires_at,omitempty"`
	SourcePdfs    []map[string]interface{}   `json:"source_pdfs,omitempty"`
	PdfHash       string                     `json:"pdf_hash,omitempty"`
	DownloadUrl   string                     `json:"download_url,omitempty"`
	SubmissionIds []string                   `json:"submission_ids,omitempty"`
	Id            string                     `json:"id,omitempty"`
	State         string                     `json:"state,omitempty"`
	Actions       []CombinedSubmissionAction `json:"actions,omitempty"`
}

type CombinedSubmissionAction 

type CombinedSubmissionAction struct {
	Id             string                 `json:"id"`
	IntegrationId  string                 `json:"integration_id"`
	State          string                 `json:"state"`
	ActionCategory string                 `json:"action_category"`
	ActionType     string                 `json:"action_type"`
	ResultData     map[string]interface{} `json:"result_data"`
}

type CombinedSubmissionData 

type CombinedSubmissionData struct {
	ExpiresIn     int32                  `json:"expires_in,omitempty"`
	Metadata      map[string]interface{} `json:"metadata,omitempty"`
	Password      string                 `json:"password,omitempty"`
	SubmissionIds []string               `json:"submission_ids"`
	Test          bool                   `json:"test,omitempty"`
}

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type CopyTemplateData 

type CopyTemplateData struct {
	Name           string `json:"name,omitempty"`
	ParentFolderId string `json:"parent_folder_id"`
}

type CreateCombinedSubmissionResponse 

type CreateCombinedSubmissionResponse struct {
	CombinedSubmission CombinedSubmission `json:"combined_submission,omitempty"`
	Errors             []string           `json:"errors,omitempty"`
	Status             string             `json:"status,omitempty"`
}

type CreateCustomFileData 

type CreateCustomFileData struct {
	CacheId string `json:"cache_id"`
}

type CreateCustomFileResponse 

type CreateCustomFileResponse struct {
	CustomFile CustomFile `json:"custom_file,omitempty"`
	Errors     []string   `json:"errors,omitempty"`
	Status     string     `json:"status,omitempty"`
}

type CreateFolderData 

type CreateFolderData struct {
	Folder FoldersFolder `json:"folder"`
}

type CreateHtmlTemplateData 

type CreateHtmlTemplateData struct {
	Template HtmlTemplateData `json:"template"`
}

type CreatePDFTemplateOpts 

type CreatePDFTemplateOpts struct {
	TemplateParentFolderId optional.String
}

type CreateSubmissionBatchResponse 

type CreateSubmissionBatchResponse struct {
	SubmissionBatch SubmissionBatch                            `json:"submission_batch,omitempty"`
	Submissions     []CreateSubmissionBatchSubmissionsResponse `json:"submissions,omitempty"`
	Error           string                                     `json:"error,omitempty"`
	Errors          []string                                   `json:"errors,omitempty"`
	Status          string                                     `json:"status,omitempty"`
}

type CreateSubmissionBatchSubmissionsResponse 

type CreateSubmissionBatchSubmissionsResponse struct {
	Submission Submission `json:"submission,omitempty"`
	Errors     []string   `json:"errors,omitempty"`
	Status     string     `json:"status,omitempty"`
}

type CreateSubmissionDataRequestData 

type CreateSubmissionDataRequestData struct {
	AuthType             string                 `json:"auth_type,omitempty"`
	Metadata             map[string]interface{} `json:"metadata,omitempty"`
	AuthSecondFactorType string                 `json:"auth_second_factor_type,omitempty"`
	AuthPhoneNumberHash  string                 `json:"auth_phone_number_hash,omitempty"`
	AuthSessionStartedAt string                 `json:"auth_session_started_at,omitempty"`
	AuthUserIdHash       string                 `json:"auth_user_id_hash,omitempty"`
	AuthSessionIdHash    string                 `json:"auth_session_id_hash,omitempty"`
	AuthUsernameHash     string                 `json:"auth_username_hash,omitempty"`
	Name                 string                 `json:"name,omitempty"`
	Fields               []string               `json:"fields,omitempty"`
	AuthProvider         string                 `json:"auth_provider,omitempty"`
	Email                string                 `json:"email,omitempty"`
	Order                int32                  `json:"order,omitempty"`
}

type CreateSubmissionDataRequestTokenResponse 

type CreateSubmissionDataRequestTokenResponse struct {
	Errors []string                                      `json:"errors,omitempty"`
	Status string                                        `json:"status,omitempty"`
	Token  CreateSubmissionDataRequestTokenResponseToken `json:"token,omitempty"`
}

type CreateSubmissionDataRequestTokenResponseToken 

type CreateSubmissionDataRequestTokenResponseToken struct {
	ExpiresAt      string `json:"expires_at,omitempty"`
	Id             string `json:"id,omitempty"`
	Secret         string `json:"secret,omitempty"`
	DataRequestUrl string `json:"data_request_url,omitempty"`
}

type CreateSubmissionResponse 

type CreateSubmissionResponse struct {
	Submission Submission `json:"submission,omitempty"`
	Errors     []string   `json:"errors,omitempty"`
	Status     string     `json:"status,omitempty"`
}

type CreateTemplateFromUploadData 

type CreateTemplateFromUploadData struct {
	Template UploadTemplateData `json:"template"`
}

type CustomFile 

type CustomFile struct {
	Id  string `json:"id,omitempty"`
	Url string `json:"url,omitempty"`
}

type Folder 

type Folder struct {
	Path           string `json:"path,omitempty"`
	ParentFolderId string `json:"parent_folder_id,omitempty"`
	Name           string `json:"name,omitempty"`
	Id             string `json:"id,omitempty"`
}

type FoldersFolder 

type FoldersFolder struct {
	ParentFolderId string `json:"parent_folder_id,omitempty"`
	Name           string `json:"name,omitempty"`
}

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetSubmissionBatchOpts 

type GetSubmissionBatchOpts struct {
	IncludeSubmissions optional.Bool
}

type GetSubmissionOpts 

type GetSubmissionOpts struct {
	IncludeData optional.Bool
}

type HtmlTemplateData 

type HtmlTemplateData struct {
	ExpirationInterval        string  `json:"expiration_interval,omitempty"`
	WebhookUrl                string  `json:"webhook_url,omitempty"`
	Scss                      string  `json:"scss,omitempty"`
	AllowAdditionalProperties bool    `json:"allow_additional_properties,omitempty"`
	ExpireAfter               float32 `json:"expire_after,omitempty"`
	Description               string  `json:"description,omitempty"`
	PublicSubmissions         bool    `json:"public_submissions,omitempty"`
	SlackWebhookUrl           string  `json:"slack_webhook_url,omitempty"`
	HeaderHtml                string  `json:"header_html,omitempty"`
	PublicWebForm             bool    `json:"public_web_form,omitempty"`
	EditableSubmissions       bool    `json:"editable_submissions,omitempty"`
	ExpireSubmissions         bool    `json:"expire_submissions,omitempty"`
	Name                      string  `json:"name,omitempty"`
	FooterHtml                string  `json:"footer_html,omitempty"`
	Html                      string  `json:"html,omitempty"`
	TemplateType              string  `json:"template_type,omitempty"`
	RedirectUrl               string  `json:"redirect_url,omitempty"`
}

type InvalidRequest 

type InvalidRequest struct {
	Status string   `json:"status"`
	Errors []string `json:"errors"`
}

type ListFoldersOpts 

type ListFoldersOpts struct {
	ParentFolderId optional.String
}

type ListSubmissionsOpts 

type ListSubmissionsOpts struct {
	Cursor        optional.String
	Limit         optional.Float32
	CreatedAfter  optional.String
	CreatedBefore optional.String
	Type_         optional.String
	IncludeData   optional.Bool
}

type ListSubmissionsResponse 

type ListSubmissionsResponse struct {
	NextCursor  string       `json:"next_cursor,omitempty"`
	Submissions []Submission `json:"submissions,omitempty"`
	Limit       float32      `json:"limit,omitempty"`
}

type ListSubmissions_1Opts 

type ListSubmissions_1Opts struct {
	Cursor        optional.String
	Limit         optional.Float32
	CreatedAfter  optional.String
	CreatedBefore optional.String
	Type_         optional.String
	IncludeData   optional.Bool
}

type ListTemplatesOpts 

type ListTemplatesOpts struct {
	Query          optional.String
	ParentFolderId optional.String
	Page           optional.Int32
	PerPage        optional.Int32
}

type ModelError 

type ModelError struct {
	Status string `json:"status"`
	Error  string `json:"error"`
}

type MoveFolderData 

type MoveFolderData struct {
	ParentFolderId string `json:"parent_folder_id,omitempty"`
}

type MoveTemplateData 

type MoveTemplateData struct {
	ParentFolderId string `json:"parent_folder_id"`
}

type PDFApiService 

type PDFApiService service

func (*PDFApiService) AddFieldsToTemplate 

func (a *PDFApiService) AddFieldsToTemplate(ctx context.Context, templateId string, addFieldsData AddFieldsData) (AddFieldsTemplateResponse, *http.Response, error)

PDFApiService Add new fields to a Template

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId
  • @param addFieldsData

@return AddFieldsTemplateResponse

func (*PDFApiService) BatchGeneratePdfV1 

func (a *PDFApiService) BatchGeneratePdfV1(ctx context.Context, templateId string, mapStringinterface []map[string]interface{}) ([]CreateSubmissionResponse, *http.Response, error)

PDFApiService Generates multiple PDFs

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId
  • @param mapStringinterface

@return []CreateSubmissionResponse

func (*PDFApiService) BatchGeneratePdfs 

func (a *PDFApiService) BatchGeneratePdfs(ctx context.Context, submissionBatchData SubmissionBatchData) (CreateSubmissionBatchResponse, *http.Response, error)

PDFApiService Generates multiple PDFs

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param submissionBatchData

@return CreateSubmissionBatchResponse

func (*PDFApiService) CombinePdfs 

func (a *PDFApiService) CombinePdfs(ctx context.Context, combinePdfsData CombinePdfsData) (CreateCombinedSubmissionResponse, *http.Response, error)

PDFApiService Merge submission PDFs, template PDFs, or custom files

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param combinePdfsData

@return CreateCombinedSubmissionResponse

func (*PDFApiService) CombineSubmissions 

func (a *PDFApiService) CombineSubmissions(ctx context.Context, combinedSubmissionData CombinedSubmissionData) (CreateCombinedSubmissionResponse, *http.Response, error)

PDFApiService Merge generated PDFs together

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param combinedSubmissionData

@return CreateCombinedSubmissionResponse

func (*PDFApiService) CopyTemplate 

func (a *PDFApiService) CopyTemplate(ctx context.Context, templateId string, copyTemplateData CopyTemplateData) (Template, *http.Response, error)

PDFApiService Copy a Template

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId
  • @param copyTemplateData

@return Template

func (*PDFApiService) CreateCustomFileFromUpload 

func (a *PDFApiService) CreateCustomFileFromUpload(ctx context.Context, createCustomFileData CreateCustomFileData) (CreateCustomFileResponse, *http.Response, error)

PDFApiService Create a new custom file from a cached presign upload

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createCustomFileData

@return CreateCustomFileResponse

func (*PDFApiService) CreateDataRequestToken 

func (a *PDFApiService) CreateDataRequestToken(ctx context.Context, dataRequestId string) (CreateSubmissionDataRequestTokenResponse, *http.Response, error)

PDFApiService Creates a new data request token for form authentication

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dataRequestId

@return CreateSubmissionDataRequestTokenResponse

func (*PDFApiService) CreateFolder 

func (a *PDFApiService) CreateFolder(ctx context.Context, createFolderData CreateFolderData) (Folder, *http.Response, error)

PDFApiService Create a folder

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createFolderData

@return Folder

func (*PDFApiService) CreateHTMLTemplate 

func (a *PDFApiService) CreateHTMLTemplate(ctx context.Context, createHtmlTemplateData CreateHtmlTemplateData) (PendingTemplate, *http.Response, error)

PDFApiService Create a new HTML template

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createHtmlTemplateData

@return PendingTemplate

func (*PDFApiService) CreatePDFTemplate 

func (a *PDFApiService) CreatePDFTemplate(ctx context.Context, templateDocument *os.File, templateName string, localVarOptionals *CreatePDFTemplateOpts) (PendingTemplate, *http.Response, error)

func (*PDFApiService) CreatePDFTemplateFromUpload 

func (a *PDFApiService) CreatePDFTemplateFromUpload(ctx context.Context, createTemplateFromUploadData CreateTemplateFromUploadData) (PendingTemplate, *http.Response, error)

PDFApiService Create a new PDF template from a cached presign upload

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createTemplateFromUploadData

@return PendingTemplate

func (*PDFApiService) DeleteFolder 

func (a *PDFApiService) DeleteFolder(ctx context.Context, folderId string) (Folder, *http.Response, error)

PDFApiService Delete a folder

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId

@return Folder

func (*PDFApiService) ExpireCombinedSubmission 

func (a *PDFApiService) ExpireCombinedSubmission(ctx context.Context, combinedSubmissionId string) (CombinedSubmission, *http.Response, error)

PDFApiService Expire a combined submission

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param combinedSubmissionId

@return CombinedSubmission

func (*PDFApiService) ExpireSubmission 

func (a *PDFApiService) ExpireSubmission(ctx context.Context, submissionId string) (Submission, *http.Response, error)

PDFApiService Expire a PDF submission

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param submissionId

@return Submission

func (*PDFApiService) GeneratePDF 

func (a *PDFApiService) GeneratePDF(ctx context.Context, templateId string, submissionData SubmissionData) (CreateSubmissionResponse, *http.Response, error)

PDFApiService Generates a new PDF

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId
  • @param submissionData

@return CreateSubmissionResponse

func (*PDFApiService) GetCombinedSubmission 

func (a *PDFApiService) GetCombinedSubmission(ctx context.Context, combinedSubmissionId string) (CombinedSubmission, *http.Response, error)

PDFApiService Check the status of a combined submission (merged PDFs)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param combinedSubmissionId

@return CombinedSubmission

func (*PDFApiService) GetDataRequest 

func (a *PDFApiService) GetDataRequest(ctx context.Context, dataRequestId string) (SubmissionDataRequest, *http.Response, error)

PDFApiService Look up a submission data request

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dataRequestId

@return SubmissionDataRequest

func (*PDFApiService) GetFullTemplate 

func (a *PDFApiService) GetFullTemplate(ctx context.Context, templateId string) (Template1, *http.Response, error)

PDFApiService Fetch the full template attributes

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId

@return Template1

func (*PDFApiService) GetPresignUrl 

func (a *PDFApiService) GetPresignUrl(ctx context.Context) (map[string]map[string]interface{}, *http.Response, error)

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

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]map[string]interface{}

func (*PDFApiService) GetSubmission 

func (a *PDFApiService) GetSubmission(ctx context.Context, submissionId string, localVarOptionals *GetSubmissionOpts) (Submission, *http.Response, error)

func (*PDFApiService) GetSubmissionBatch 

func (a *PDFApiService) GetSubmissionBatch(ctx context.Context, submissionBatchId string, localVarOptionals *GetSubmissionBatchOpts) (SubmissionBatch, *http.Response, error)

func (*PDFApiService) GetTemplate 

func (a *PDFApiService) GetTemplate(ctx context.Context, templateId string) (Template, *http.Response, error)

PDFApiService Check the status of an uploaded template

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId

@return Template

func (*PDFApiService) GetTemplateSchema 

func (a *PDFApiService) GetTemplateSchema(ctx context.Context, templateId string) (map[string]map[string]interface{}, *http.Response, error)

PDFApiService Fetch the JSON schema for a template

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId

@return map[string]map[string]interface{}

func (*PDFApiService) ListFolders 

func (a *PDFApiService) ListFolders(ctx context.Context, localVarOptionals *ListFoldersOpts) ([]Folder, *http.Response, error)

func (*PDFApiService) ListSubmissions 

func (a *PDFApiService) ListSubmissions(ctx context.Context, localVarOptionals *ListSubmissionsOpts) (ListSubmissionsResponse, *http.Response, error)

func (*PDFApiService) ListSubmissions_1 

func (a *PDFApiService) ListSubmissions_1(ctx context.Context, templateId string, localVarOptionals *ListSubmissions_1Opts) (ListSubmissionsResponse, *http.Response, error)

func (*PDFApiService) ListTemplates 

func (a *PDFApiService) ListTemplates(ctx context.Context, localVarOptionals *ListTemplatesOpts) ([]Template, *http.Response, error)

func (*PDFApiService) MoveFolderToFolder 

func (a *PDFApiService) MoveFolderToFolder(ctx context.Context, folderId string, moveFolderData MoveFolderData) (Folder, *http.Response, error)

PDFApiService Move a folder

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId
  • @param moveFolderData

@return Folder

func (*PDFApiService) MoveTemplateToFolder 

func (a *PDFApiService) MoveTemplateToFolder(ctx context.Context, templateId string, moveTemplateData MoveTemplateData) (Template, *http.Response, error)

PDFApiService Move Template to folder

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId
  • @param moveTemplateData

@return Template

func (*PDFApiService) RenameFolder 

func (a *PDFApiService) RenameFolder(ctx context.Context, folderId string, renameFolderData RenameFolderData) (*http.Response, error)

PDFApiService Rename a folder

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId
  • @param renameFolderData

func (*PDFApiService) TestAuthentication 

func (a *PDFApiService) TestAuthentication(ctx context.Context) (AuthenticationSuccessResponse, *http.Response, error)

PDFApiService Test Authentication

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return AuthenticationSuccessResponse

func (*PDFApiService) UpdateDataRequest 

func (a *PDFApiService) UpdateDataRequest(ctx context.Context, dataRequestId string, updateSubmissionDataRequestData UpdateSubmissionDataRequestData) (UpdateDataRequestResponse, *http.Response, error)

PDFApiService Update a submission data request

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dataRequestId
  • @param updateSubmissionDataRequestData

@return UpdateDataRequestResponse

func (*PDFApiService) UpdateTemplate 

func (a *PDFApiService) UpdateTemplate(ctx context.Context, templateId string, updateTemplateData UpdateTemplateData) (UpdateTemplateResponse, *http.Response, error)

PDFApiService Update a Template

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId
  • @param updateTemplateData

@return UpdateTemplateResponse

type PendingTemplate 

type PendingTemplate struct {
	ExpirationInterval        string  `json:"expiration_interval,omitempty"`
	WebhookUrl                string  `json:"webhook_url,omitempty"`
	ParentFolderId            string  `json:"parent_folder_id,omitempty"`
	ExpireAfter               float32 `json:"expire_after,omitempty"`
	AllowAdditionalProperties bool    `json:"allow_additional_properties,omitempty"`
	Description               string  `json:"description,omitempty"`
	PublicSubmissions         bool    `json:"public_submissions,omitempty"`
	SlackWebhookUrl           string  `json:"slack_webhook_url,omitempty"`
	Path                      string  `json:"path,omitempty"`
	PublicWebForm             bool    `json:"public_web_form,omitempty"`
	EditableSubmissions       bool    `json:"editable_submissions,omitempty"`
	ExpireSubmissions         bool    `json:"expire_submissions,omitempty"`
	Name                      string  `json:"name,omitempty"`
	TemplateType              string  `json:"template_type,omitempty"`
	Id                        string  `json:"id,omitempty"`
	Locked                    bool    `json:"locked,omitempty"`
	RedirectUrl               string  `json:"redirect_url,omitempty"`
}

type RenameFolderData 

type RenameFolderData struct {
	Name string `json:"name"`
}

type Submission 

type Submission struct {
	Id                   string                  `json:"id"`
	TemplateId           string                  `json:"template_id,omitempty"`
	Test                 bool                    `json:"test"`
	Editable             bool                    `json:"editable,omitempty"`
	Expired              bool                    `json:"expired"`
	ExpiresAt            string                  `json:"expires_at,omitempty"`
	ProcessedAt          string                  `json:"processed_at,omitempty"`
	State                string                  `json:"state"`
	Data                 map[string]interface{}  `json:"data,omitempty"`
	Metadata             map[string]interface{}  `json:"metadata,omitempty"`
	TruncatedText        map[string]interface{}  `json:"truncated_text,omitempty"`
	PdfHash              string                  `json:"pdf_hash,omitempty"`
	DownloadUrl          string                  `json:"download_url,omitempty"`
	PermanentDownloadUrl string                  `json:"permanent_download_url,omitempty"`
	BatchId              string                  `json:"batch_id,omitempty"`
	DataRequests         []SubmissionDataRequest `json:"data_requests,omitempty"`
	Actions              []SubmissionAction      `json:"actions,omitempty"`
	Source               string                  `json:"source,omitempty"`
	Referrer             string                  `json:"referrer,omitempty"`
}

type SubmissionAction 

type SubmissionAction struct {
	Id             string                 `json:"id"`
	IntegrationId  string                 `json:"integration_id"`
	State          string                 `json:"state"`
	ActionCategory string                 `json:"action_category"`
	ActionType     string                 `json:"action_type"`
	ResultData     map[string]interface{} `json:"result_data"`
}

type SubmissionBatch 

type SubmissionBatch struct {
	PendingCount         int32                  `json:"pending_count,omitempty"`
	CompletionPercentage int32                  `json:"completion_percentage,omitempty"`
	Metadata             map[string]interface{} `json:"metadata,omitempty"`
	TotalCount           int32                  `json:"total_count,omitempty"`
	Submissions          []Submission           `json:"submissions,omitempty"`
	ProcessedAt          string                 `json:"processed_at,omitempty"`
	Id                   string                 `json:"id,omitempty"`
	State                string                 `json:"state,omitempty"`
	ErrorCount           int32                  `json:"error_count,omitempty"`
}

type SubmissionBatchData 

type SubmissionBatchData struct {
	Metadata    map[string]interface{}       `json:"metadata,omitempty"`
	Submissions []SubmissionDataBatchRequest `json:"submissions"`
	TemplateId  string                       `json:"template_id,omitempty"`
	Test        bool                         `json:"test,omitempty"`
}

type SubmissionData 

type SubmissionData struct {
	Css            string                            `json:"css,omitempty"`
	Data           map[string]interface{}            `json:"data"`
	DataRequests   []CreateSubmissionDataRequestData `json:"data_requests,omitempty"`
	FieldOverrides map[string]interface{}            `json:"field_overrides,omitempty"`
	Html           string                            `json:"html,omitempty"`
	Metadata       map[string]interface{}            `json:"metadata,omitempty"`
	Password       string                            `json:"password,omitempty"`
	Test           bool                              `json:"test,omitempty"`
}

type SubmissionDataBatchRequest 

type SubmissionDataBatchRequest struct {
	Css        string                 `json:"css,omitempty"`
	Metadata   map[string]interface{} `json:"metadata,omitempty"`
	Data       map[string]interface{} `json:"data,omitempty"`
	Test       bool                   `json:"test,omitempty"`
	Html       string                 `json:"html,omitempty"`
	TemplateId string                 `json:"template_id,omitempty"`
}

type SubmissionDataRequest 

type SubmissionDataRequest struct {
	Id                   string                 `json:"id"`
	Name                 string                 `json:"name"`
	Email                string                 `json:"email"`
	Order                int32                  `json:"order"`
	SortOrder            int32                  `json:"sort_order"`
	Fields               []string               `json:"fields"`
	Metadata             map[string]interface{} `json:"metadata"`
	State                string                 `json:"state"`
	ViewedAt             string                 `json:"viewed_at,omitempty"`
	CompletedAt          string                 `json:"completed_at,omitempty"`
	AuthType             string                 `json:"auth_type,omitempty"`
	AuthSecondFactorType string                 `json:"auth_second_factor_type,omitempty"`
	AuthProvider         string                 `json:"auth_provider,omitempty"`
	AuthSessionStartedAt string                 `json:"auth_session_started_at,omitempty"`
	AuthSessionIdHash    string                 `json:"auth_session_id_hash,omitempty"`
	AuthUserIdHash       string                 `json:"auth_user_id_hash,omitempty"`
	AuthUsernameHash     string                 `json:"auth_username_hash,omitempty"`
	AuthPhoneNumberHash  string                 `json:"auth_phone_number_hash,omitempty"`
	IpAddress            string                 `json:"ip_address,omitempty"`
	UserAgent            string                 `json:"user_agent,omitempty"`
}

type Template 

type Template struct {
	ExpirationInterval        string      `json:"expiration_interval,omitempty"`
	WebhookUrl                string      `json:"webhook_url,omitempty"`
	ParentFolderId            string      `json:"parent_folder_id,omitempty"`
	ExpireAfter               float32     `json:"expire_after,omitempty"`
	AllowAdditionalProperties bool        `json:"allow_additional_properties,omitempty"`
	Description               string      `json:"description,omitempty"`
	PublicSubmissions         bool        `json:"public_submissions,omitempty"`
	SlackWebhookUrl           string      `json:"slack_webhook_url,omitempty"`
	Path                      string      `json:"path,omitempty"`
	PublicWebForm             bool        `json:"public_web_form,omitempty"`
	EditableSubmissions       bool        `json:"editable_submissions,omitempty"`
	ExpireSubmissions         bool        `json:"expire_submissions,omitempty"`
	Name                      string      `json:"name,omitempty"`
	PermanentDocumentUrl      string      `json:"permanent_document_url,omitempty"`
	TemplateType              string      `json:"template_type,omitempty"`
	Id                        string      `json:"id,omitempty"`
	PageDimensions            [][]float32 `json:"page_dimensions,omitempty"`
	Locked                    bool        `json:"locked,omitempty"`
	RedirectUrl               string      `json:"redirect_url,omitempty"`
	DocumentUrl               string      `json:"document_url,omitempty"`
}

type Template1 

type Template1 struct {
	DocumentProcessed         bool                   `json:"document_processed,omitempty"`
	ExpirationInterval        string                 `json:"expiration_interval,omitempty"`
	Scss                      string                 `json:"scss,omitempty"`
	DocumentState             string                 `json:"document_state,omitempty"`
	ExpireAfter               float32                `json:"expire_after,omitempty"`
	Description               string                 `json:"description,omitempty"`
	SlackWebhookUrl           string                 `json:"slack_webhook_url,omitempty"`
	Demo                      bool                   `json:"demo,omitempty"`
	Path                      string                 `json:"path,omitempty"`
	HeaderHtml                string                 `json:"header_html,omitempty"`
	PublicWebForm             bool                   `json:"public_web_form,omitempty"`
	FieldOrder                [][]float32            `json:"field_order,omitempty"`
	PermanentDocumentUrl      string                 `json:"permanent_document_url,omitempty"`
	Html                      string                 `json:"html,omitempty"`
	TemplateType              string                 `json:"template_type,omitempty"`
	Id                        string                 `json:"id,omitempty"`
	PageDimensions            [][]float32            `json:"page_dimensions,omitempty"`
	Locked                    bool                   `json:"locked,omitempty"`
	PageCount                 float32                `json:"page_count,omitempty"`
	EncryptPdfs               bool                   `json:"encrypt_pdfs,omitempty"`
	WebhookUrl                string                 `json:"webhook_url,omitempty"`
	EmbedDomains              []string               `json:"embed_domains,omitempty"`
	ParentFolderId            string                 `json:"parent_folder_id,omitempty"`
	AllowAdditionalProperties bool                   `json:"allow_additional_properties,omitempty"`
	EncryptPdfsPassword       string                 `json:"encrypt_pdfs_password,omitempty"`
	PublicSubmissions         bool                   `json:"public_submissions,omitempty"`
	SharedFieldData           map[string]interface{} `json:"shared_field_data,omitempty"`
	DocumentMd5               string                 `json:"document_md5,omitempty"`
	FirstTemplate             bool                   `json:"first_template,omitempty"`
	Defaults                  Template1Defaults      `json:"defaults,omitempty"`
	EditableSubmissions       bool                   `json:"editable_submissions,omitempty"`
	ExpireSubmissions         bool                   `json:"expire_submissions,omitempty"`
	Name                      string                 `json:"name,omitempty"`
	FooterHtml                string                 `json:"footer_html,omitempty"`
	DocumentParseError        bool                   `json:"document_parse_error,omitempty"`
	Fields                    map[string]interface{} `json:"fields,omitempty"`
	DocumentFilename          string                 `json:"document_filename,omitempty"`
	RedirectUrl               string                 `json:"redirect_url,omitempty"`
	DocumentUrl               string                 `json:"document_url,omitempty"`
}

type Template1Defaults 

type Template1Defaults struct {
	Color    string  `json:"color,omitempty"`
	FontSize float32 `json:"fontSize,omitempty"`
	Typeface string  `json:"typeface,omitempty"`
}

type TemplateData 

type TemplateData struct {
	ExpirationInterval        string  `json:"expiration_interval,omitempty"`
	WebhookUrl                string  `json:"webhook_url,omitempty"`
	Scss                      string  `json:"scss,omitempty"`
	AllowAdditionalProperties bool    `json:"allow_additional_properties,omitempty"`
	ExpireAfter               float32 `json:"expire_after,omitempty"`
	Description               string  `json:"description,omitempty"`
	PublicSubmissions         bool    `json:"public_submissions,omitempty"`
	SlackWebhookUrl           string  `json:"slack_webhook_url,omitempty"`
	HeaderHtml                string  `json:"header_html,omitempty"`
	PublicWebForm             bool    `json:"public_web_form,omitempty"`
	EditableSubmissions       bool    `json:"editable_submissions,omitempty"`
	ExpireSubmissions         bool    `json:"expire_submissions,omitempty"`
	Name                      string  `json:"name,omitempty"`
	FooterHtml                string  `json:"footer_html,omitempty"`
	Html                      string  `json:"html,omitempty"`
	RedirectUrl               string  `json:"redirect_url,omitempty"`
}

type TemplatestemplateIdaddFieldsFields 

type TemplatestemplateIdaddFieldsFields struct {
	BackgroundColorFieldName         string  `json:"backgroundColorFieldName,omitempty"`
	Uppercase                        bool    `json:"uppercase,omitempty"`
	Metadata                         string  `json:"metadata,omitempty"`
	BarcodeSymbology                 string  `json:"barcodeSymbology,omitempty"`
	MinLength                        float32 `json:"minLength,omitempty"`
	Integer                          bool    `json:"integer,omitempty"`
	Type                             string  `json:"type,omitempty"`
	Required                         bool    `json:"required,omitempty"`
	CombValueOffset                  float32 `json:"combValueOffset,omitempty"`
	ImageGravity                     string  `json:"imageGravity,omitempty"`
	Overflow                         string  `json:"overflow,omitempty"`
	QrcodeColor                      string  `json:"qrcodeColor,omitempty"`
	ColorFieldRequired               bool    `json:"colorFieldRequired,omitempty"`
	BackgroundColorFieldRequired     bool    `json:"backgroundColorFieldRequired,omitempty"`
	Id                               float32 `json:"id,omitempty"`
	ImageScaleType                   string  `json:"imageScaleType,omitempty"`
	ExclusiveMinimum                 bool    `json:"exclusiveMinimum,omitempty"`
	Height                           float32 `json:"height,omitempty"`
	NumberConditionRangeExclusiveMax bool    `json:"numberConditionRangeExclusiveMax,omitempty"`
	InvertBooleanCondition           bool    `json:"invertBooleanCondition,omitempty"`
	ShapeFillColorFieldName          string  `json:"shapeFillColorFieldName,omitempty"`
	Static                           bool    `json:"static,omitempty"`
	ShapeBorderColorFieldName        string  `json:"shapeBorderColorFieldName,omitempty"`
	VAlignment                       string  `json:"vAlignment,omitempty"`
	Bold                             bool    `json:"bold,omitempty"`
	ShapeBorderWidth                 float32 `json:"shapeBorderWidth,omitempty"`
	CombNumberOfCells                float32 `json:"combNumberOfCells,omitempty"`
	ShapeBorderColor                 string  `json:"shapeBorderColor,omitempty"`
	Comb                             bool    `json:"comb,omitempty"`
	Typeface                         string  `json:"typeface,omitempty"`
	ShapeType                        string  `json:"shapeType,omitempty"`
	Condition                        string  `json:"condition,omitempty"`
	DisplayType                      string  `json:"displayType,omitempty"`
	CheckColor                       string  `json:"checkColor,omitempty"`
	MultilineLines                   float32 `json:"multilineLines,omitempty"`
	Multiline                        bool    `json:"multiline,omitempty"`
	TrueText                         string  `json:"trueText,omitempty"`
	Name                             string  `json:"name,omitempty"`
	FontSize                         float32 `json:"fontSize,omitempty"`
	Page                             float32 `json:"page,omitempty"`
	Alignment                        string  `json:"alignment,omitempty"`
	MaxLength                        float32 `json:"maxLength,omitempty"`
	AutoCalculateMaxLength           bool    `json:"autoCalculateMaxLength,omitempty"`
	ColorFieldName                   string  `json:"colorFieldName,omitempty"`
	QrcodeColorFieldName             string  `json:"qrcodeColorFieldName,omitempty"`
	NumberConditionRangeMin          float32 `json:"numberConditionRangeMin,omitempty"`
	Color                            string  `json:"color,omitempty"`
	Hidden                           bool    `json:"hidden,omitempty"`
	CheckColorFieldRequired          bool    `json:"checkColorFieldRequired,omitempty"`
	CombinedFieldFormat              string  `json:"combinedFieldFormat,omitempty"`
	Description                      string  `json:"description,omitempty"`
	ShapeBorderColorFieldRequired    bool    `json:"shapeBorderColorFieldRequired,omitempty"`
	CombinedFieldNames               string  `json:"combinedFieldNames,omitempty"`
	Title                            string  `json:"title,omitempty"`
	NumberConditionRangeExclusiveMin bool    `json:"numberConditionRangeExclusiveMin,omitempty"`
	CombinedFieldSeparator           string  `json:"combinedFieldSeparator,omitempty"`
	ExclusiveMaximum                 bool    `json:"exclusiveMaximum,omitempty"`
	Default                          string  `json:"default,omitempty"`
	CombinedFieldType                string  `json:"combinedFieldType,omitempty"`
	DateTimeFormat                   string  `json:"dateTimeFormat,omitempty"`
	QrcodeColorFieldRequired         bool    `json:"qrcodeColorFieldRequired,omitempty"`
	Currency                         bool    `json:"currency,omitempty"`
	FalseText                        string  `json:"falseText,omitempty"`
	Strikethrough                    bool    `json:"strikethrough,omitempty"`
	CharacterSpacing                 float32 `json:"characterSpacing,omitempty"`
	NumberConditionRangeMax          float32 `json:"numberConditionRangeMax,omitempty"`
	BackgroundColor                  string  `json:"backgroundColor,omitempty"`
	CheckColorFieldName              string  `json:"checkColorFieldName,omitempty"`
	CheckCharacter                   string  `json:"checkCharacter,omitempty"`
	Rotation                         float32 `json:"rotation,omitempty"`
	OptionList                       string  `json:"optionList,omitempty"`
	ShapeFillColor                   string  `json:"shapeFillColor,omitempty"`
	StringConditionType              string  `json:"stringConditionType,omitempty"`
	ShapeFillColorFieldRequired      bool    `json:"shapeFillColorFieldRequired,omitempty"`
	DecimalPlaces                    float32 `json:"decimalPlaces,omitempty"`
	IncludeTime                      bool    `json:"includeTime,omitempty"`
	Width                            float32 `json:"width,omitempty"`
	X                                float32 `json:"x,omitempty"`
	Maximum                          float32 `json:"maximum,omitempty"`
	Y                                float32 `json:"y,omitempty"`
	SignatureAllowDraw               bool    `json:"signatureAllowDraw,omitempty"`
	NumberConditionType              string  `json:"numberConditionType,omitempty"`
	Opacity                          float32 `json:"opacity,omitempty"`
	Minimum                          float32 `json:"minimum,omitempty"`
	SignatureAllowType               bool    `json:"signatureAllowType,omitempty"`
}

type UpdateDataRequestResponse 

type UpdateDataRequestResponse struct {
	DataRequest SubmissionDataRequest `json:"data_request,omitempty"`
	Errors      []string              `json:"errors,omitempty"`
	Status      string                `json:"status,omitempty"`
}

type UpdateSubmissionDataRequestData 

type UpdateSubmissionDataRequestData struct {
	AuthPhoneNumberHash  string                 `json:"auth_phone_number_hash,omitempty"`
	AuthProvider         string                 `json:"auth_provider,omitempty"`
	AuthSecondFactorType string                 `json:"auth_second_factor_type,omitempty"`
	AuthSessionIdHash    string                 `json:"auth_session_id_hash,omitempty"`
	AuthSessionStartedAt string                 `json:"auth_session_started_at,omitempty"`
	AuthType             string                 `json:"auth_type,omitempty"`
	AuthUserIdHash       string                 `json:"auth_user_id_hash,omitempty"`
	AuthUsernameHash     string                 `json:"auth_username_hash,omitempty"`
	Email                string                 `json:"email,omitempty"`
	Fields               []string               `json:"fields,omitempty"`
	Metadata             map[string]interface{} `json:"metadata,omitempty"`
	Name                 string                 `json:"name,omitempty"`
	Order                int32                  `json:"order,omitempty"`
}

type UpdateTemplateData 

type UpdateTemplateData struct {
	Template TemplateData `json:"template"`
}

type UpdateTemplateResponse 

type UpdateTemplateResponse struct {
	Errors []string `json:"errors,omitempty"`
	Status string   `json:"status,omitempty"`
}

type UploadTemplateData 

type UploadTemplateData struct {
	ExpirationInterval        string                     `json:"expiration_interval,omitempty"`
	WebhookUrl                string                     `json:"webhook_url,omitempty"`
	Scss                      string                     `json:"scss,omitempty"`
	AllowAdditionalProperties bool                       `json:"allow_additional_properties,omitempty"`
	Document                  UploadTemplateDataDocument `json:"document,omitempty"`
	ExpireAfter               float32                    `json:"expire_after,omitempty"`
	Description               string                     `json:"description,omitempty"`
	PublicSubmissions         bool                       `json:"public_submissions,omitempty"`
	SlackWebhookUrl           string                     `json:"slack_webhook_url,omitempty"`
	HeaderHtml                string                     `json:"header_html,omitempty"`
	PublicWebForm             bool                       `json:"public_web_form,omitempty"`
	EditableSubmissions       bool                       `json:"editable_submissions,omitempty"`
	ExpireSubmissions         bool                       `json:"expire_submissions,omitempty"`
	Name                      string                     `json:"name,omitempty"`
	FooterHtml                string                     `json:"footer_html,omitempty"`
	Html                      string                     `json:"html,omitempty"`
	TemplateType              string                     `json:"template_type,omitempty"`
	RedirectUrl               string                     `json:"redirect_url,omitempty"`
}

type UploadTemplateDataDocument 

type UploadTemplateDataDocument struct {
	Metadata UploadTemplateDataDocumentMetadata `json:"metadata,omitempty"`
	Id       string                             `json:"id,omitempty"`
	Storage  string                             `json:"storage,omitempty"`
}

type UploadTemplateDataDocumentMetadata 

type UploadTemplateDataDocumentMetadata struct {
	Filename string `json:"filename,omitempty"`
	Size     int32  `json:"size,omitempty"`
	MimeType string `json:"mime_type,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.