docuseal

package module
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Jul 17, 2026 License: MIT Imports: 11 Imported by: 0

README

DocuSeal Go

The DocuSeal Go library provides seamless integration with the DocuSeal API, allowing developers to interact with DocuSeal's electronic signature and document management features directly within Go applications. This library is designed to simplify API interactions and provide tools for efficient implementation.

Documentation

Detailed documentation is available at DocuSeal API Docs.

Installation

To install the library, run:

go get github.com/docusealco/docuseal-go

Usage

Configuration

Set up the library with your DocuSeal API key based on your deployment. Retrieve your API key from the appropriate location:

Global Cloud

API keys for the global cloud can be obtained from your Global DocuSeal Console.

import (
	"os"

	"github.com/docusealco/docuseal-go"
)

ds := docuseal.NewClient(os.Getenv("DOCUSEAL_API_KEY"))
EU Cloud

API keys for the EU cloud can be obtained from your EU DocuSeal Console.

ds := docuseal.NewClient(
	os.Getenv("DOCUSEAL_API_KEY"),
	docuseal.WithBaseURL(docuseal.Environments.EU),
)
On-Premises

For on-premises installations, API keys can be retrieved from the API settings page of your deployed application, e.g., https://yourdocusealapp.com/settings/api.

ds := docuseal.NewClient(
	os.Getenv("DOCUSEAL_API_KEY"),
	docuseal.WithBaseURL("https://yourdocusealapp.com/api"),
)

API Methods

GetSubmissions(params)

Documentation

Provides the ability to retrieve a list of available submissions.

submissions, err := ds.GetSubmissions(context.Background(), &docuseal.GetSubmissionsParams{Limit: docuseal.Int(10)})
GetSubmission(id)

Documentation

Provides the functionality to retrieve information about a submission.

submission, err := ds.GetSubmission(context.Background(), 1001)
GetSubmissionDocuments(id)

Documentation

This endpoint returns a list of partially filled documents for a submission. If the submission has been completed, the final signed documents are returned.

submission, err := ds.GetSubmissionDocuments(context.Background(), 1001, nil)
CreateSubmission(data)

Documentation

This API endpoint allows you to create signature requests (submissions) for a document template and send them to the specified submitters (signers).

Related Guides:
Send documents for signature via API Pre-fill PDF document form fields with API

submission, err := ds.CreateSubmission(context.Background(), &docuseal.CreateSubmissionParams{
	TemplateID: 1000001,
	SendEmail: docuseal.Bool(true),
	Submitters: []*docuseal.CreateSubmissionSubmitterParams{
		{
			Role: "First Party",
			Email: "john.doe@example.com",
		},
	},
})
CreateSubmissionFromPdf(data)

Documentation

Provides the functionality to create one-off submission request from a PDF. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.pdf for more text tag formats. Or specify the exact pixel coordinates of the document fields using fields param.

Related Guides:
Use embedded text field tags to create a fillable form

submission, err := ds.CreateSubmissionFromPdf(context.Background(), &docuseal.CreateSubmissionFromPdfParams{
	Name: "Test Submission Document",
	Documents: []*docuseal.CreateSubmissionFromPdfDocumentParams{
		{
			Name: "string",
			File: "base64",
			Fields: []*docuseal.CreateSubmissionDocumentFieldParams{
				{
					Name: "string",
					Areas: []*docuseal.CreateSubmissionDocumentFieldAreaParams{
						{
							X: 0,
							Y: 0,
							W: 0,
							H: 0,
							Page: 1,
						},
					},
				},
			},
		},
	},
	Submitters: []*docuseal.CreateSubmissionSubmitterParams{
		{
			Role: "First Party",
			Email: "john.doe@example.com",
		},
	},
})
CreateSubmissionFromDocx(data)

Documentation

Provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.docuseal.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and lists. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.

Related Guides:
Use dynamic content variables in DOCX to create personalized documents

submission, err := ds.CreateSubmissionFromDocx(context.Background(), &docuseal.CreateSubmissionFromDocxParams{
	Name: "Test Submission Document",
	Variables: map[string]any{"variable_name": "value"},
	Documents: []*docuseal.CreateSubmissionFromDocxDocumentParams{
		{
			Name: "string",
			File: "base64",
		},
	},
	Submitters: []*docuseal.CreateSubmissionSubmitterParams{
		{
			Role: "First Party",
			Email: "john.doe@example.com",
		},
	},
})
CreateSubmissionFromHtml(data)

Documentation

This API endpoint allows you to create a one-off submission request document using the provided HTML content, with special field tags rendered as a fillable and signable form.

Related Guides:
Create PDF document fillable form with HTML

submission, err := ds.CreateSubmissionFromHtml(context.Background(), &docuseal.CreateSubmissionFromHtmlParams{
	Name: "Test Submission Document",
	Documents: []*docuseal.CreateSubmissionFromHtmlDocumentParams{
		{
			Name: "Test Document",
			Html: `<p>Lorem Ipsum is simply dummy text of the
<text-field
  name="Industry"
  role="First Party"
  required="false"
  style="width: 80px; height: 16px; display: inline-block; margin-bottom: -4px">
</text-field>
and typesetting industry</p>
`,
		},
	},
	Submitters: []*docuseal.CreateSubmissionSubmitterParams{
		{
			Role: "First Party",
			Email: "john.doe@example.com",
		},
	},
})
UpdateSubmission(id, data)

Documentation

Allows you to update a submission: change its name, expiration date, and archive or unarchive it.

submission, err := ds.UpdateSubmission(context.Background(), 1001, &docuseal.UpdateSubmissionParams{
	Name: "New Submission Name",
	ExpireAt: "2024-09-01 12:00:00 UTC",
	Archived: docuseal.Bool(true),
})
ArchiveSubmission(id)

Documentation

Allows you to archive a submission.

_, err := ds.ArchiveSubmission(context.Background(), 1001)
GetSubmitters(params)

Documentation

Provides the ability to retrieve a list of submitters.

submitters, err := ds.GetSubmitters(context.Background(), &docuseal.GetSubmittersParams{Limit: docuseal.Int(10)})
GetSubmitter(id)

Documentation

Provides functionality to retrieve information about a submitter, along with the submitter documents and field values.

submitter, err := ds.GetSubmitter(context.Background(), 500001)
UpdateSubmitter(id, data)

Documentation

Allows you to update submitter details, pre-fill or update field values and re-send emails.

Related Guides:
Automatically sign documents via API

submitter, err := ds.UpdateSubmitter(context.Background(), 500001, &docuseal.UpdateSubmitterParams{
	Email: "john.doe@example.com",
	Fields: []*docuseal.UpdateSubmitterFieldParams{
		{
			Name: "First Name",
			Value: "Acme",
		},
	},
})
GetTemplates(params)

Documentation

Provides the ability to retrieve a list of available document templates.

templates, err := ds.GetTemplates(context.Background(), &docuseal.GetTemplatesParams{Limit: docuseal.Int(10)})
GetTemplate(id)

Documentation

Provides the functionality to retrieve information about a document template.

template, err := ds.GetTemplate(context.Background(), 1000001)
CreateTemplateFromPdf(data)

Documentation

Provides the functionality to create a fillable document template for a PDF file. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.pdf for more text tag formats. Or specify the exact pixel coordinates of the document fields using fields param.

Related Guides:
Use embedded text field tags to create a fillable form

template, err := ds.CreateTemplateFromPdf(context.Background(), &docuseal.CreateTemplateFromPdfParams{
	Name: "Test PDF",
	Documents: []*docuseal.CreateTemplateFromPdfDocumentParams{
		{
			Name: "string",
			File: "base64",
			Fields: []*docuseal.CreateTemplateDocumentFieldParams{
				{
					Name: "string",
					Areas: []*docuseal.CreateTemplateDocumentFieldAreaParams{
						{
							X: 0,
							Y: 0,
							W: 0,
							H: 0,
							Page: 1,
						},
					},
				},
			},
		},
	},
})
CreateTemplateFromDocx(data)

Documentation

Provides the functionality to create a fillable document template for an existing Microsoft Word document. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.docuseal.com/examples/fieldtags.docx for more text tag formats. Or specify the exact pixel coordinates of the document fields using fields param.

Related Guides:
Use embedded text field tags to create a fillable form

template, err := ds.CreateTemplateFromDocx(context.Background(), &docuseal.CreateTemplateFromDocxParams{
	Name: "Test DOCX",
	Documents: []*docuseal.CreateTemplateFromDocxDocumentParams{
		{
			Name: "string",
			File: "base64",
		},
	},
})
CreateTemplateFromHtml(data)

Documentation

Provides the functionality to seamlessly generate a PDF document template by utilizing the provided HTML content while incorporating pre-defined fields.

Related Guides:
Create PDF document fillable form with HTML

template, err := ds.CreateTemplateFromHtml(context.Background(), &docuseal.CreateTemplateFromHtmlParams{
	Html: `<p>Lorem Ipsum is simply dummy text of the
<text-field
  name="Industry"
  role="First Party"
  required="false"
  style="width: 80px; height: 16px; display: inline-block; margin-bottom: -4px">
</text-field>
and typesetting industry</p>
`,
	Name: "Test Template",
})
CloneTemplate(id, data)

Documentation

Allows you to clone an existing template into a new template.

template, err := ds.CloneTemplate(context.Background(), 1000001, &docuseal.CloneTemplateParams{
	Name: "Cloned Template",
})
MergeTemplate(data)

Documentation

Allows you to merge multiple templates with documents and fields into a new combined template.

template, err := ds.MergeTemplate(context.Background(), &docuseal.MergeTemplateParams{
	TemplateIDs: []int{321, 432},
	Name: "Merged Template",
})
UpdateTemplate(id, data)

Documentation

Provides the functionality to move a document template to a different folder and update the name of the template.

template, err := ds.UpdateTemplate(context.Background(), 1000001, &docuseal.UpdateTemplateParams{
	Name: "New Document Name",
	FolderName: "New Folder",
})
UpdateTemplateDocuments(id, data)

Documentation

Allows you to add, remove or replace documents in the template with provided PDF/DOCX file or HTML content.

template, err := ds.UpdateTemplateDocuments(context.Background(), 1000001, &docuseal.UpdateTemplateDocumentsParams{
	Documents: []*docuseal.UpdateTemplateDocumentsDocumentParams{
		{
			File: "string",
		},
	},
})
ArchiveTemplate(id)

Documentation

Allows you to archive a document template.

_, err := ds.ArchiveTemplate(context.Background(), 1000001)
Configuring Timeouts

Set timeouts to avoid hanging requests:

ds := docuseal.NewClient(
	os.Getenv("DOCUSEAL_API_KEY"),
	docuseal.WithHTTPClient(&http.Client{Timeout: 30 * time.Second}),
)

Support

For feature requests or bug reports, visit our GitHub Issues page.

License

The library is available as open source under the terms of the MIT License.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Environments = struct {
	Default string
	EU      string
}{
	Default: "https://api.docuseal.com",
	EU:      "https://api.docuseal.eu",
}

Environments defines all of the API environments. These values can be used with the WithBaseURL RequestOption to override the client's default environment, if any.

View Source 
var ErrorCodes internal.ErrorCodes = internal.ErrorCodes{}

Functions

func Bool 

func Bool(b bool) *bool

Bool returns a pointer to the given bool value.

func Byte 

func Byte(b byte) *byte

Byte returns a pointer to the given byte value.

func Bytes 

func Bytes(b []byte) *[]byte

Bytes returns a pointer to the given []byte value.

func Complex64 

func Complex64(c complex64) *complex64

Complex64 returns a pointer to the given complex64 value.

func Complex128 

func Complex128(c complex128) *complex128

Complex128 returns a pointer to the given complex128 value.

func Float32 

func Float32(f float32) *float32

Float32 returns a pointer to the given float32 value.

func Float64 

func Float64(f float64) *float64

Float64 returns a pointer to the given float64 value.

func Int 

func Int(i int) *int

Int returns a pointer to the given int value.

func Int8 

func Int8(i int8) *int8

Int8 returns a pointer to the given int8 value.

func Int16 

func Int16(i int16) *int16

Int16 returns a pointer to the given int16 value.

func Int32 

func Int32(i int32) *int32

Int32 returns a pointer to the given int32 value.

func Int64 

func Int64(i int64) *int64

Int64 returns a pointer to the given int64 value.

func MustParseDate 

func MustParseDate(date string) time.Time

MustParseDate attempts to parse the given string as a date time.Time, and panics upon failure.

func MustParseDateTime 

func MustParseDateTime(datetime string) time.Time

MustParseDateTime attempts to parse the given string as a datetime time.Time, and panics upon failure.

func Rune 

func Rune(r rune) *rune

Rune returns a pointer to the given rune value.

func String 

func String(s string) *string

String returns a pointer to the given string value.

func Time 

func Time(t time.Time) *time.Time

Time returns a pointer to the given time.Time value.

func UUID 

func UUID(u uuid.UUID) *uuid.UUID

UUID returns a pointer to the given uuid.UUID value.

func Uint 

func Uint(u uint) *uint

Uint returns a pointer to the given uint value.

func Uint8 

func Uint8(u uint8) *uint8

Uint8 returns a pointer to the given uint8 value.

func Uint16 

func Uint16(u uint16) *uint16

Uint16 returns a pointer to the given uint16 value.

func Uint32 

func Uint32(u uint32) *uint32

Uint32 returns a pointer to the given uint32 value.

func Uint64 

func Uint64(u uint64) *uint64

Uint64 returns a pointer to the given uint64 value.

func Uintptr 

func Uintptr(u uintptr) *uintptr

Uintptr returns a pointer to the given uintptr value.

func WithAPIKey 

func WithAPIKey(apiKey string) *core.APIKeyOption

WithAPIKey sets the apiKey auth request header.

func WithBaseURL 

func WithBaseURL(baseURL string) *core.BaseURLOption

WithBaseURL sets the base URL, overriding the default environment, if any.

func WithBodyProperties 

func WithBodyProperties(bodyProperties map[string]interface{}) *core.BodyPropertiesOption

WithBodyProperties adds the given body properties to the request.

func WithHTTPClient 

func WithHTTPClient(httpClient core.HTTPClient) *core.HTTPClientOption

WithHTTPClient uses the given HTTPClient to issue the request.

func WithHTTPHeader 

func WithHTTPHeader(httpHeader http.Header) *core.HTTPHeaderOption

WithHTTPHeader adds the given http.Header to the request.

func WithMaxAttempts 

func WithMaxAttempts(attempts uint) *core.MaxAttemptsOption

WithMaxAttempts configures the maximum number of retry attempts.

func WithMaxStreamBufSize 

func WithMaxStreamBufSize(size int) *core.MaxBufSizeOption

WithMaxStreamBufSize configures the maximum buffer size for streaming responses. This controls the maximum size of a single message (in bytes) that the stream can process. By default, this is set to 1MB.

func WithMaxStreamReconnectAttempts 

func WithMaxStreamReconnectAttempts(attempts uint) *core.MaxStreamReconnectAttemptsOption

WithMaxStreamReconnectAttempts caps the number of transparent mid-stream reconnect attempts on streaming endpoints that support resumption. The reconnect loop honors Last-Event-ID and any server-sent `retry:` directives. Has no effect on endpoints that don't support resumption.

func WithQueryParameters 

func WithQueryParameters(queryParameters url.Values) *core.QueryParametersOption

WithQueryParameters adds the given query parameters to the request.

func WithoutRetries 

func WithoutRetries() *core.WithoutRetriesOption

WithoutRetries disables HTTP-level retry attempts for the request. Use this instead of WithMaxAttempts(0), which falls through to the default of 2 attempts.

func WithoutStreamReconnection 

func WithoutStreamReconnection() *core.WithoutStreamReconnectionOption

WithoutStreamReconnection disables transparent mid-stream reconnection on resumable SSE endpoints. Has no effect on non-resumable endpoints.

Types

type Client 

type Client struct {
	WithRawResponse *RawClient
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(apiKey string, opts ...RequestOption) *Client

func (*Client) ArchiveSubmission 

func (c *Client) ArchiveSubmission(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*SubmissionArchiveResult, error)

The API endpoint allows you to archive a submission.

func (*Client) ArchiveTemplate 

func (c *Client) ArchiveTemplate(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*TemplateArchiveResult, error)

The API endpoint allows you to archive a document template.

func (*Client) CloneTemplate 

func (c *Client) CloneTemplate(
	ctx context.Context,

	id int,
	request *CloneTemplateParams,
	opts ...RequestOption,
) (*Template, error)

The API endpoint allows you to clone an existing template into a new template.

func (*Client) CreateSubmission 

func (c *Client) CreateSubmission(
	ctx context.Context,
	request *CreateSubmissionParams,
	opts ...RequestOption,
) (*SubmissionCreateResult, error)

This API endpoint allows you to create signature requests (submissions) for a document template and send them to the specified submitters (signers).<br><b>Related Guides</b><br><a href="https://www.docuseal.com/guides/send-documents-for-signature-via-api" class="link">Send documents for signature via API</a><br><a href="https://www.docuseal.com/guides/pre-fill-pdf-document-form-fields-with-api" class="link">Pre-fill PDF document form fields with API</a>

func (*Client) CreateSubmissionFromDocx 

func (c *Client) CreateSubmissionFromDocx(
	ctx context.Context,
	request *CreateSubmissionFromDocxParams,
	opts ...RequestOption,
) (*SubmissionCreateOneoffResult, error)

The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use <code>[[variable_name]]</code> text tags to define dynamic content variables in the document. See <a href="https://www.docuseal.com/examples/demo_template.docx" target="_blank" class="link font-bold">https://www.docuseal.com/examples/demo_template.docx</a> for the specific text variable syntax, including dynamic content tables and lists. You can also use the <code>{{signature}}</code> field syntax to define fillable fields, as in a PDF.<br><b>Related Guides</b><br><a href="https://www.docuseal.com/guides/use-dynamic-content-variables-in-docx-to-create-personalized-documents" class="link">Use dynamic content variables in DOCX to create personalized documents</a>

func (*Client) CreateSubmissionFromHtml 

func (c *Client) CreateSubmissionFromHtml(
	ctx context.Context,
	request *CreateSubmissionFromHtmlParams,
	opts ...RequestOption,
) (*SubmissionCreateOneoffResult, error)

This API endpoint allows you to create a one-off submission request document using the provided HTML content, with special field tags rendered as a fillable and signable form.<br><b>Related Guides</b><br><a href="https://www.docuseal.com/guides/create-pdf-document-fillable-form-with-html-api" class="link">Create PDF document fillable form with HTML</a>

func (*Client) CreateSubmissionFromPdf 

func (c *Client) CreateSubmissionFromPdf(
	ctx context.Context,
	request *CreateSubmissionFromPdfParams,
	opts ...RequestOption,
) (*SubmissionCreateOneoffResult, error)

The API endpoint provides the functionality to create one-off submission request from a PDF. Use <code>{{Field Name;role=Signer1;type=date}}</code> text tags to define fillable fields in the document. See <a href="https://www.docuseal.com/examples/fieldtags.pdf" target="_blank" class="link font-bold">https://www.docuseal.com/examples/fieldtags.pdf</a> for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.<br><b>Related Guides</b><br><a href="https://www.docuseal.com/guides/use-embedded-text-field-tags-in-the-pdf-to-create-a-fillable-form" class="link">Use embedded text field tags to create a fillable form</a>

func (*Client) CreateTemplateFromDocx 

func (c *Client) CreateTemplateFromDocx(
	ctx context.Context,
	request *CreateTemplateFromDocxParams,
	opts ...RequestOption,
) (*Template, error)

The API endpoint provides the functionality to create a fillable document template for an existing Microsoft Word document. Use <code>{{Field Name;role=Signer1;type=date}}</code> text tags to define fillable fields in the document. See <a href="https://www.docuseal.com/examples/fieldtags.docx" target="_blank" class="link font-bold" >https://www.docuseal.com/examples/fieldtags.docx</a> for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.<br><b>Related Guides</b><br><a href="https://www.docuseal.com/guides/use-embedded-text-field-tags-in-the-pdf-to-create-a-fillable-form" class="link">Use embedded text field tags to create a fillable form</a>

func (*Client) CreateTemplateFromHtml 

func (c *Client) CreateTemplateFromHtml(
	ctx context.Context,
	request *CreateTemplateFromHtmlParams,
	opts ...RequestOption,
) (*Template, error)

The API endpoint provides the functionality to seamlessly generate a PDF document template by utilizing the provided HTML content while incorporating pre-defined fields.<br><b>Related Guides</b><br><a href="https://www.docuseal.com/guides/create-pdf-document-fillable-form-with-html-api" class="link">Create PDF document fillable form with HTML</a>

func (*Client) CreateTemplateFromPdf 

func (c *Client) CreateTemplateFromPdf(
	ctx context.Context,
	request *CreateTemplateFromPdfParams,
	opts ...RequestOption,
) (*Template, error)

The API endpoint provides the functionality to create a fillable document template for a PDF file. Use <code>{{Field Name;role=Signer1;type=date}}</code> text tags to define fillable fields in the document. See <a href="https://www.docuseal.com/examples/fieldtags.pdf" target="_blank" class="link font-bold">https://www.docuseal.com/examples/fieldtags.pdf</a> for more text tag formats. Or specify the exact pixel coordinates of the document fields using `fields` param.<br><b>Related Guides</b><br><a href="https://www.docuseal.com/guides/use-embedded-text-field-tags-in-the-pdf-to-create-a-fillable-form" class="link">Use embedded text field tags to create a fillable form</a>

func (*Client) GetSubmission 

func (c *Client) GetSubmission(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*Submission, error)

The API endpoint provides the functionality to retrieve information about a submission.

func (*Client) GetSubmissionDocuments 

func (c *Client) GetSubmissionDocuments(
	ctx context.Context,

	id int,
	request *GetSubmissionDocumentsParams,
	opts ...RequestOption,
) (*SubmissionDocuments, error)

This endpoint returns a list of partially filled documents for a submission. If the submission has been completed, the final signed documents are returned.

func (*Client) GetSubmissions 

func (c *Client) GetSubmissions(
	ctx context.Context,
	request *GetSubmissionsParams,
	opts ...RequestOption,
) (*SubmissionList, error)

The API endpoint provides the ability to retrieve a list of available submissions.

func (*Client) GetSubmitter 

func (c *Client) GetSubmitter(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*Submitter, error)

The API endpoint provides functionality to retrieve information about a submitter, along with the submitter documents and field values.

func (*Client) GetSubmitters 

func (c *Client) GetSubmitters(
	ctx context.Context,
	request *GetSubmittersParams,
	opts ...RequestOption,
) (*SubmitterList, error)

The API endpoint provides the ability to retrieve a list of submitters.

func (*Client) GetTemplate 

func (c *Client) GetTemplate(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*Template, error)

The API endpoint provides the functionality to retrieve information about a document template.

func (*Client) GetTemplates 

func (c *Client) GetTemplates(
	ctx context.Context,
	request *GetTemplatesParams,
	opts ...RequestOption,
) (*TemplateList, error)

The API endpoint provides the ability to retrieve a list of available document templates.

func (*Client) MergeTemplate 

func (c *Client) MergeTemplate(
	ctx context.Context,
	request *MergeTemplateParams,
	opts ...RequestOption,
) (*Template, error)

The API endpoint allows you to merge multiple templates with documents and fields into a new combined template.

func (*Client) PermanentlyDeleteSubmission 

func (c *Client) PermanentlyDeleteSubmission(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*SubmissionPermanentlyDeleteResult, error)

The API endpoint allows you to permanently delete a submission and all of its submitters and documents.

func (*Client) PermanentlyDeleteTemplate 

func (c *Client) PermanentlyDeleteTemplate(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*TemplatePermanentlyDeleteResult, error)

The API endpoint allows you to permanently delete a document template and all of its submissions.

func (*Client) UpdateSubmission 

func (c *Client) UpdateSubmission(
	ctx context.Context,

	id int,
	request *UpdateSubmissionParams,
	opts ...RequestOption,
) (*SubmissionUpdateResult, error)

The API endpoint allows you to update a submission: change its name, expiration date, and archive or unarchive it.

func (*Client) UpdateSubmitter 

func (c *Client) UpdateSubmitter(
	ctx context.Context,

	id int,
	request *UpdateSubmitterParams,
	opts ...RequestOption,
) (*SubmitterUpdateResult, error)

The API endpoint allows you to update submitter details, pre-fill or update field values and re-send emails.<br><b>Related Guides</b><br><a href="https://www.docuseal.com/guides/pre-fill-pdf-document-form-fields-with-api#automatically_sign_documents_via_api" class="link">Automatically sign documents via API</a>

func (*Client) UpdateTemplate 

func (c *Client) UpdateTemplate(
	ctx context.Context,

	id int,
	request *UpdateTemplateParams,
	opts ...RequestOption,
) (*TemplateUpdateResult, error)

The API endpoint provides the functionality to move a document template to a different folder and update the name of the template.

func (*Client) UpdateTemplateDocuments 

func (c *Client) UpdateTemplateDocuments(
	ctx context.Context,

	id int,
	request *UpdateTemplateDocumentsParams,
	opts ...RequestOption,
) (*Template, error)

The API endpoint allows you to add, remove or replace documents in the template with provided PDF/DOCX file or HTML content.

type CloneTemplateParams 

type CloneTemplateParams struct {
	// Template name. Existing name with (Clone) suffix will be used if not specified.
	Name string `json:"name,omitempty" url:"-"`
	// The folder's name to which the template should be cloned.
	FolderName string `json:"folder_name,omitempty" url:"-"`
	// Your application-specific unique string key to identify this template within your app.
	ExternalID string `json:"external_id,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*CloneTemplateParams) MarshalJSON 

func (c *CloneTemplateParams) MarshalJSON() ([]byte, error)

func (*CloneTemplateParams) SetExternalID 

func (c *CloneTemplateParams) SetExternalID(externalID string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CloneTemplateParams) SetFolderName 

func (c *CloneTemplateParams) SetFolderName(folderName string)

SetFolderName sets the FolderName field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CloneTemplateParams) SetName 

func (c *CloneTemplateParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CloneTemplateParams) UnmarshalJSON 

func (c *CloneTemplateParams) UnmarshalJSON(data []byte) error

type CreateSubmissionDocumentFieldAreaParams 

type CreateSubmissionDocumentFieldAreaParams struct {
	// X-coordinate of the field area.
	X float64 `json:"x" url:"x"`
	// Y-coordinate of the field area.
	Y float64 `json:"y" url:"y"`
	// Width of the field area.
	W float64 `json:"w" url:"w"`
	// Height of the field area.
	H float64 `json:"h" url:"h"`
	// Page number of the field area. Starts from 1.
	Page int `json:"page" url:"page"`
	// Option string value for 'radio' and 'multiple' select field types.
	Option string `json:"option,omitempty" url:"option,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionDocumentFieldAreaParams) GetExtraProperties 

func (c *CreateSubmissionDocumentFieldAreaParams) GetExtraProperties() map[string]interface{}

func (*CreateSubmissionDocumentFieldAreaParams) GetH 

func (c *CreateSubmissionDocumentFieldAreaParams) GetH() float64

func (*CreateSubmissionDocumentFieldAreaParams) GetOption 

func (c *CreateSubmissionDocumentFieldAreaParams) GetOption() string

func (*CreateSubmissionDocumentFieldAreaParams) GetPage 

func (c *CreateSubmissionDocumentFieldAreaParams) GetPage() int

func (*CreateSubmissionDocumentFieldAreaParams) GetW 

func (c *CreateSubmissionDocumentFieldAreaParams) GetW() float64

func (*CreateSubmissionDocumentFieldAreaParams) GetX 

func (c *CreateSubmissionDocumentFieldAreaParams) GetX() float64

func (*CreateSubmissionDocumentFieldAreaParams) GetY 

func (c *CreateSubmissionDocumentFieldAreaParams) GetY() float64

func (*CreateSubmissionDocumentFieldAreaParams) MarshalJSON 

func (c *CreateSubmissionDocumentFieldAreaParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionDocumentFieldAreaParams) SetH 

func (c *CreateSubmissionDocumentFieldAreaParams) SetH(h float64)

SetH sets the H field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldAreaParams) SetOption 

func (c *CreateSubmissionDocumentFieldAreaParams) SetOption(option string)

SetOption sets the Option field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldAreaParams) SetPage 

func (c *CreateSubmissionDocumentFieldAreaParams) SetPage(page int)

SetPage sets the Page field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldAreaParams) SetW 

func (c *CreateSubmissionDocumentFieldAreaParams) SetW(w float64)

SetW sets the W field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldAreaParams) SetX 

func (c *CreateSubmissionDocumentFieldAreaParams) SetX(x float64)

SetX sets the X field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldAreaParams) SetY 

func (c *CreateSubmissionDocumentFieldAreaParams) SetY(y float64)

SetY sets the Y field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldAreaParams) String 

func (c *CreateSubmissionDocumentFieldAreaParams) String() string

func (*CreateSubmissionDocumentFieldAreaParams) UnmarshalJSON 

func (c *CreateSubmissionDocumentFieldAreaParams) UnmarshalJSON(data []byte) error

type CreateSubmissionDocumentFieldParams 

type CreateSubmissionDocumentFieldParams struct {
	// Name of the field.
	Name string `json:"name,omitempty" url:"name,omitempty"`
	// Type of the field (e.g., text, signature, date, initials).
	Type FieldType `json:"type,omitempty" url:"type,omitempty"`
	// Role name of the signer.
	Role string `json:"role,omitempty" url:"role,omitempty"`
	// Indicates if the field is required.
	Required *bool `json:"required,omitempty" url:"required,omitempty"`
	// Field title displayed to the user instead of the name, shown on the signing form. Supports Markdown.
	Title string `json:"title,omitempty" url:"title,omitempty"`
	// Field description displayed on the signing form. Supports Markdown.
	Description string `json:"description,omitempty" url:"description,omitempty"`
	// List of areas where the field is located in the document.
	Areas []*CreateSubmissionDocumentFieldAreaParams `json:"areas,omitempty" url:"areas,omitempty"`
	// An array of option values for 'select' field type.
	Options []string `json:"options,omitempty" url:"options,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionDocumentFieldParams) GetAreas 

func (c *CreateSubmissionDocumentFieldParams) GetAreas() []*CreateSubmissionDocumentFieldAreaParams

func (*CreateSubmissionDocumentFieldParams) GetDescription 

func (c *CreateSubmissionDocumentFieldParams) GetDescription() string

func (*CreateSubmissionDocumentFieldParams) GetExtraProperties 

func (c *CreateSubmissionDocumentFieldParams) GetExtraProperties() map[string]interface{}

func (*CreateSubmissionDocumentFieldParams) GetName 

func (c *CreateSubmissionDocumentFieldParams) GetName() string

func (*CreateSubmissionDocumentFieldParams) GetOptions 

func (c *CreateSubmissionDocumentFieldParams) GetOptions() []string

func (*CreateSubmissionDocumentFieldParams) GetRequired 

func (c *CreateSubmissionDocumentFieldParams) GetRequired() *bool

func (*CreateSubmissionDocumentFieldParams) GetRole 

func (c *CreateSubmissionDocumentFieldParams) GetRole() string

func (*CreateSubmissionDocumentFieldParams) GetTitle 

func (c *CreateSubmissionDocumentFieldParams) GetTitle() string

func (*CreateSubmissionDocumentFieldParams) GetType 

func (c *CreateSubmissionDocumentFieldParams) GetType() FieldType

func (*CreateSubmissionDocumentFieldParams) MarshalJSON 

func (c *CreateSubmissionDocumentFieldParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionDocumentFieldParams) SetAreas 

func (c *CreateSubmissionDocumentFieldParams) SetAreas(areas []*CreateSubmissionDocumentFieldAreaParams)

SetAreas sets the Areas field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldParams) SetDescription 

func (c *CreateSubmissionDocumentFieldParams) SetDescription(description string)

SetDescription sets the Description field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldParams) SetName 

func (c *CreateSubmissionDocumentFieldParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldParams) SetOptions 

func (c *CreateSubmissionDocumentFieldParams) SetOptions(options []string)

SetOptions sets the Options field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldParams) SetRequired 

func (c *CreateSubmissionDocumentFieldParams) SetRequired(required *bool)

SetRequired sets the Required field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldParams) SetRole 

func (c *CreateSubmissionDocumentFieldParams) SetRole(role string)

SetRole sets the Role field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldParams) SetTitle 

func (c *CreateSubmissionDocumentFieldParams) SetTitle(title string)

SetTitle sets the Title field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldParams) SetType 

func (c *CreateSubmissionDocumentFieldParams) SetType(type_ FieldType)

SetType sets the Type field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionDocumentFieldParams) String 

func (c *CreateSubmissionDocumentFieldParams) String() string

func (*CreateSubmissionDocumentFieldParams) UnmarshalJSON 

func (c *CreateSubmissionDocumentFieldParams) UnmarshalJSON(data []byte) error

type CreateSubmissionFromDocxDocumentParams 

type CreateSubmissionFromDocxDocumentParams struct {
	// Name of the document.
	Name string `json:"name" url:"name"`
	// Base64-encoded content of the PDF or DOCX file or downloadable file URL.
	File string `json:"file" url:"file"`
	// Document position in the submission. If not specified, the document will be added in the order it appears in the documents array.
	Position *int `json:"position,omitempty" url:"position,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionFromDocxDocumentParams) GetExtraProperties 

func (c *CreateSubmissionFromDocxDocumentParams) GetExtraProperties() map[string]interface{}

func (*CreateSubmissionFromDocxDocumentParams) GetFile 

func (c *CreateSubmissionFromDocxDocumentParams) GetFile() string

func (*CreateSubmissionFromDocxDocumentParams) GetName 

func (c *CreateSubmissionFromDocxDocumentParams) GetName() string

func (*CreateSubmissionFromDocxDocumentParams) GetPosition 

func (c *CreateSubmissionFromDocxDocumentParams) GetPosition() *int

func (*CreateSubmissionFromDocxDocumentParams) MarshalJSON 

func (c *CreateSubmissionFromDocxDocumentParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionFromDocxDocumentParams) SetFile 

func (c *CreateSubmissionFromDocxDocumentParams) SetFile(file string)

SetFile sets the File field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxDocumentParams) SetName 

func (c *CreateSubmissionFromDocxDocumentParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxDocumentParams) SetPosition 

func (c *CreateSubmissionFromDocxDocumentParams) SetPosition(position *int)

SetPosition sets the Position field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxDocumentParams) String 

func (c *CreateSubmissionFromDocxDocumentParams) String() string

func (*CreateSubmissionFromDocxDocumentParams) UnmarshalJSON 

func (c *CreateSubmissionFromDocxDocumentParams) UnmarshalJSON(data []byte) error

type CreateSubmissionFromDocxParams 

type CreateSubmissionFromDocxParams struct {
	// Name of the document submission.
	Name string `json:"name,omitempty" url:"-"`
	// Set `false` to disable signature request emails sending.
	SendEmail *bool `json:"send_email,omitempty" url:"-"`
	// Set `true` to send signature request via phone number and SMS.
	SendSms *bool `json:"send_sms,omitempty" url:"-"`
	// Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.
	Variables map[string]any `json:"variables,omitempty" url:"-"`
	// Pass 'random' to send signature request emails to all parties right away. The order is 'preserved' by default so the second party will receive a signature request email only after the document is signed by the first party.
	Order SubmittersOrder `json:"order,omitempty" url:"-"`
	// Specify URL to redirect to after the submission completion.
	CompletedRedirectURL string `json:"completed_redirect_url,omitempty" url:"-"`
	// Specify BCC address to send signed documents to after the completion.
	BccCompleted string `json:"bcc_completed,omitempty" url:"-"`
	// Specify Reply-To address to use in the notification emails.
	ReplyTo string `json:"reply_to,omitempty" url:"-"`
	// Specify the expiration date and time after which the submission becomes unavailable for signature.
	ExpireAt string `json:"expire_at,omitempty" url:"-"`
	// An optional array of template IDs to use in the submission along with the provided documents. This can be used to create multi-document submissions when some of the required documents exist within templates.
	TemplateIDs []int `json:"template_ids,omitempty" url:"-"`
	// An array of DOCX documents to create a submission.
	Documents []*CreateSubmissionFromDocxDocumentParams `json:"documents" url:"-"`
	// The list of submitters for the submission.
	Submitters []*CreateSubmissionSubmitterParams `json:"submitters" url:"-"`
	Message    *CreateSubmissionMessageParams     `json:"message,omitempty" url:"-"`
	// Set `true` to merge the documents into a single PDF file.
	MergeDocuments *bool `json:"merge_documents,omitempty" url:"-"`
	// Pass `false` to disable the removal of {{text}} tags from the document. This can be used along with transparent text tags for faster and more robust document processing.
	RemoveTags *bool `json:"remove_tags,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionFromDocxParams) MarshalJSON 

func (c *CreateSubmissionFromDocxParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionFromDocxParams) SetBccCompleted 

func (c *CreateSubmissionFromDocxParams) SetBccCompleted(bccCompleted string)

SetBccCompleted sets the BccCompleted field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetCompletedRedirectURL 

func (c *CreateSubmissionFromDocxParams) SetCompletedRedirectURL(completedRedirectURL string)

SetCompletedRedirectURL sets the CompletedRedirectURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetDocuments 

func (c *CreateSubmissionFromDocxParams) SetDocuments(documents []*CreateSubmissionFromDocxDocumentParams)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetExpireAt 

func (c *CreateSubmissionFromDocxParams) SetExpireAt(expireAt string)

SetExpireAt sets the ExpireAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetMergeDocuments 

func (c *CreateSubmissionFromDocxParams) SetMergeDocuments(mergeDocuments *bool)

SetMergeDocuments sets the MergeDocuments field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetMessage 

func (c *CreateSubmissionFromDocxParams) SetMessage(message *CreateSubmissionMessageParams)

SetMessage sets the Message field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetName 

func (c *CreateSubmissionFromDocxParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetOrder 

func (c *CreateSubmissionFromDocxParams) SetOrder(order SubmittersOrder)

SetOrder sets the Order field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetRemoveTags 

func (c *CreateSubmissionFromDocxParams) SetRemoveTags(removeTags *bool)

SetRemoveTags sets the RemoveTags field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetReplyTo 

func (c *CreateSubmissionFromDocxParams) SetReplyTo(replyTo string)

SetReplyTo sets the ReplyTo field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetSendEmail 

func (c *CreateSubmissionFromDocxParams) SetSendEmail(sendEmail *bool)

SetSendEmail sets the SendEmail field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetSendSms 

func (c *CreateSubmissionFromDocxParams) SetSendSms(sendSms *bool)

SetSendSms sets the SendSms field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetSubmitters 

func (c *CreateSubmissionFromDocxParams) SetSubmitters(submitters []*CreateSubmissionSubmitterParams)

SetSubmitters sets the Submitters field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetTemplateIDs 

func (c *CreateSubmissionFromDocxParams) SetTemplateIDs(templateIDs []int)

SetTemplateIDs sets the TemplateIDs field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) SetVariables 

func (c *CreateSubmissionFromDocxParams) SetVariables(variables map[string]any)

SetVariables sets the Variables field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromDocxParams) UnmarshalJSON 

func (c *CreateSubmissionFromDocxParams) UnmarshalJSON(data []byte) error

type CreateSubmissionFromHtmlDocumentParams 

type CreateSubmissionFromHtmlDocumentParams struct {
	// Document name. Random uuid will be assigned when not specified.
	Name string `json:"name,omitempty" url:"name,omitempty"`
	// HTML document content with field tags.
	Html string `json:"html" url:"html"`
	// HTML document content of the header to be displayed on every page.
	HtmlHeader string `json:"html_header,omitempty" url:"html_header,omitempty"`
	// HTML document content of the footer to be displayed on every page.
	HtmlFooter string `json:"html_footer,omitempty" url:"html_footer,omitempty"`
	// Page size. Letter 8.5 x 11 will be assigned when not specified.
	Size PageSize `json:"size,omitempty" url:"size,omitempty"`
	// Document position in the submission. If not specified, the document will be added in the order it appears in the documents array.
	Position *int `json:"position,omitempty" url:"position,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionFromHtmlDocumentParams) GetExtraProperties 

func (c *CreateSubmissionFromHtmlDocumentParams) GetExtraProperties() map[string]interface{}

func (*CreateSubmissionFromHtmlDocumentParams) GetHtml 

func (c *CreateSubmissionFromHtmlDocumentParams) GetHtml() string

func (*CreateSubmissionFromHtmlDocumentParams) GetHtmlFooter 

func (c *CreateSubmissionFromHtmlDocumentParams) GetHtmlFooter() string

func (*CreateSubmissionFromHtmlDocumentParams) GetHtmlHeader 

func (c *CreateSubmissionFromHtmlDocumentParams) GetHtmlHeader() string

func (*CreateSubmissionFromHtmlDocumentParams) GetName 

func (c *CreateSubmissionFromHtmlDocumentParams) GetName() string

func (*CreateSubmissionFromHtmlDocumentParams) GetPosition 

func (c *CreateSubmissionFromHtmlDocumentParams) GetPosition() *int

func (*CreateSubmissionFromHtmlDocumentParams) GetSize 

func (c *CreateSubmissionFromHtmlDocumentParams) GetSize() PageSize

func (*CreateSubmissionFromHtmlDocumentParams) MarshalJSON 

func (c *CreateSubmissionFromHtmlDocumentParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionFromHtmlDocumentParams) SetHtml 

func (c *CreateSubmissionFromHtmlDocumentParams) SetHtml(html string)

SetHtml sets the Html field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlDocumentParams) SetHtmlFooter 

func (c *CreateSubmissionFromHtmlDocumentParams) SetHtmlFooter(htmlFooter string)

SetHtmlFooter sets the HtmlFooter field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlDocumentParams) SetHtmlHeader 

func (c *CreateSubmissionFromHtmlDocumentParams) SetHtmlHeader(htmlHeader string)

SetHtmlHeader sets the HtmlHeader field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlDocumentParams) SetName 

func (c *CreateSubmissionFromHtmlDocumentParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlDocumentParams) SetPosition 

func (c *CreateSubmissionFromHtmlDocumentParams) SetPosition(position *int)

SetPosition sets the Position field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlDocumentParams) SetSize 

func (c *CreateSubmissionFromHtmlDocumentParams) SetSize(size PageSize)

SetSize sets the Size field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlDocumentParams) String 

func (c *CreateSubmissionFromHtmlDocumentParams) String() string

func (*CreateSubmissionFromHtmlDocumentParams) UnmarshalJSON 

func (c *CreateSubmissionFromHtmlDocumentParams) UnmarshalJSON(data []byte) error

type CreateSubmissionFromHtmlParams 

type CreateSubmissionFromHtmlParams struct {
	// Name of the document submission.
	Name string `json:"name,omitempty" url:"-"`
	// Set `false` to disable signature request emails sending.
	SendEmail *bool `json:"send_email,omitempty" url:"-"`
	// Set `true` to send signature request via phone number and SMS.
	SendSms *bool `json:"send_sms,omitempty" url:"-"`
	// Pass 'random' to send signature request emails to all parties right away. The order is 'preserved' by default so the second party will receive a signature request email only after the document is signed by the first party.
	Order SubmittersOrder `json:"order,omitempty" url:"-"`
	// Specify URL to redirect to after the submission completion.
	CompletedRedirectURL string `json:"completed_redirect_url,omitempty" url:"-"`
	// Specify BCC address to send signed documents to after the completion.
	BccCompleted string `json:"bcc_completed,omitempty" url:"-"`
	// Specify Reply-To address to use in the notification emails.
	ReplyTo string `json:"reply_to,omitempty" url:"-"`
	// Specify the expiration date and time after which the submission becomes unavailable for signature.
	ExpireAt string `json:"expire_at,omitempty" url:"-"`
	// An optional array of template IDs to use in the submission along with the provided documents. This can be used to create multi-document submissions when some of the required documents exist within templates.
	TemplateIDs []int `json:"template_ids,omitempty" url:"-"`
	// The list of documents built from HTML. Can be used to create a submission with multiple documents.
	Documents []*CreateSubmissionFromHtmlDocumentParams `json:"documents" url:"-"`
	// The list of submitters for the submission.
	Submitters []*CreateSubmissionSubmitterParams `json:"submitters" url:"-"`
	Message    *CreateSubmissionMessageParams     `json:"message,omitempty" url:"-"`
	// Set `true` to merge the documents into a single PDF file.
	MergeDocuments *bool `json:"merge_documents,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionFromHtmlParams) MarshalJSON 

func (c *CreateSubmissionFromHtmlParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionFromHtmlParams) SetBccCompleted 

func (c *CreateSubmissionFromHtmlParams) SetBccCompleted(bccCompleted string)

SetBccCompleted sets the BccCompleted field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlParams) SetCompletedRedirectURL 

func (c *CreateSubmissionFromHtmlParams) SetCompletedRedirectURL(completedRedirectURL string)

SetCompletedRedirectURL sets the CompletedRedirectURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlParams) SetDocuments 

func (c *CreateSubmissionFromHtmlParams) SetDocuments(documents []*CreateSubmissionFromHtmlDocumentParams)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlParams) SetExpireAt 

func (c *CreateSubmissionFromHtmlParams) SetExpireAt(expireAt string)

SetExpireAt sets the ExpireAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlParams) SetMergeDocuments 

func (c *CreateSubmissionFromHtmlParams) SetMergeDocuments(mergeDocuments *bool)

SetMergeDocuments sets the MergeDocuments field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlParams) SetMessage 

func (c *CreateSubmissionFromHtmlParams) SetMessage(message *CreateSubmissionMessageParams)

SetMessage sets the Message field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlParams) SetName 

func (c *CreateSubmissionFromHtmlParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlParams) SetOrder 

func (c *CreateSubmissionFromHtmlParams) SetOrder(order SubmittersOrder)

SetOrder sets the Order field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlParams) SetReplyTo 

func (c *CreateSubmissionFromHtmlParams) SetReplyTo(replyTo string)

SetReplyTo sets the ReplyTo field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlParams) SetSendEmail 

func (c *CreateSubmissionFromHtmlParams) SetSendEmail(sendEmail *bool)

SetSendEmail sets the SendEmail field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlParams) SetSendSms 

func (c *CreateSubmissionFromHtmlParams) SetSendSms(sendSms *bool)

SetSendSms sets the SendSms field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlParams) SetSubmitters 

func (c *CreateSubmissionFromHtmlParams) SetSubmitters(submitters []*CreateSubmissionSubmitterParams)

SetSubmitters sets the Submitters field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlParams) SetTemplateIDs 

func (c *CreateSubmissionFromHtmlParams) SetTemplateIDs(templateIDs []int)

SetTemplateIDs sets the TemplateIDs field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromHtmlParams) UnmarshalJSON 

func (c *CreateSubmissionFromHtmlParams) UnmarshalJSON(data []byte) error

type CreateSubmissionFromPdfDocumentParams 

type CreateSubmissionFromPdfDocumentParams struct {
	// Name of the document.
	Name string `json:"name" url:"name"`
	// Base64-encoded content of the PDF file or downloadable file URL.
	File string `json:"file" url:"file"`
	// Fields are optional if you use {{...}} text tags to define fields in the document.
	Fields []*CreateSubmissionDocumentFieldParams `json:"fields,omitempty" url:"fields,omitempty"`
	// Document position in the submission. If not specified, the document will be added in the order it appears in the documents array.
	Position *int `json:"position,omitempty" url:"position,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionFromPdfDocumentParams) GetExtraProperties 

func (c *CreateSubmissionFromPdfDocumentParams) GetExtraProperties() map[string]interface{}

func (*CreateSubmissionFromPdfDocumentParams) GetFields 

func (c *CreateSubmissionFromPdfDocumentParams) GetFields() []*CreateSubmissionDocumentFieldParams

func (*CreateSubmissionFromPdfDocumentParams) GetFile 

func (c *CreateSubmissionFromPdfDocumentParams) GetFile() string

func (*CreateSubmissionFromPdfDocumentParams) GetName 

func (c *CreateSubmissionFromPdfDocumentParams) GetName() string

func (*CreateSubmissionFromPdfDocumentParams) GetPosition 

func (c *CreateSubmissionFromPdfDocumentParams) GetPosition() *int

func (*CreateSubmissionFromPdfDocumentParams) MarshalJSON 

func (c *CreateSubmissionFromPdfDocumentParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionFromPdfDocumentParams) SetFields 

func (c *CreateSubmissionFromPdfDocumentParams) SetFields(fields []*CreateSubmissionDocumentFieldParams)

SetFields sets the Fields field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfDocumentParams) SetFile 

func (c *CreateSubmissionFromPdfDocumentParams) SetFile(file string)

SetFile sets the File field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfDocumentParams) SetName 

func (c *CreateSubmissionFromPdfDocumentParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfDocumentParams) SetPosition 

func (c *CreateSubmissionFromPdfDocumentParams) SetPosition(position *int)

SetPosition sets the Position field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfDocumentParams) String 

func (c *CreateSubmissionFromPdfDocumentParams) String() string

func (*CreateSubmissionFromPdfDocumentParams) UnmarshalJSON 

func (c *CreateSubmissionFromPdfDocumentParams) UnmarshalJSON(data []byte) error

type CreateSubmissionFromPdfParams 

type CreateSubmissionFromPdfParams struct {
	// Name of the document submission.
	Name string `json:"name,omitempty" url:"-"`
	// Set `false` to disable signature request emails sending.
	SendEmail *bool `json:"send_email,omitempty" url:"-"`
	// Set `true` to send signature request via phone number and SMS.
	SendSms *bool `json:"send_sms,omitempty" url:"-"`
	// Pass 'random' to send signature request emails to all parties right away. The order is 'preserved' by default so the second party will receive a signature request email only after the document is signed by the first party.
	Order SubmittersOrder `json:"order,omitempty" url:"-"`
	// Specify URL to redirect to after the submission completion.
	CompletedRedirectURL string `json:"completed_redirect_url,omitempty" url:"-"`
	// Specify BCC address to send signed documents to after the completion.
	BccCompleted string `json:"bcc_completed,omitempty" url:"-"`
	// Specify Reply-To address to use in the notification emails.
	ReplyTo string `json:"reply_to,omitempty" url:"-"`
	// Specify the expiration date and time after which the submission becomes unavailable for signature.
	ExpireAt string `json:"expire_at,omitempty" url:"-"`
	// An optional array of template IDs to use in the submission along with the provided documents. This can be used to create multi-document submissions when some of the required documents exist within templates.
	TemplateIDs []int `json:"template_ids,omitempty" url:"-"`
	// An array of PDF documents to create a submission.
	Documents []*CreateSubmissionFromPdfDocumentParams `json:"documents" url:"-"`
	// The list of submitters for the submission.
	Submitters []*CreateSubmissionSubmitterParams `json:"submitters" url:"-"`
	Message    *CreateSubmissionMessageParams     `json:"message,omitempty" url:"-"`
	// Remove PDF form fields from the documents.
	Flatten *bool `json:"flatten,omitempty" url:"-"`
	// Set `true` to merge the documents into a single PDF file.
	MergeDocuments *bool `json:"merge_documents,omitempty" url:"-"`
	// Pass `false` to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.
	RemoveTags *bool `json:"remove_tags,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionFromPdfParams) MarshalJSON 

func (c *CreateSubmissionFromPdfParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionFromPdfParams) SetBccCompleted 

func (c *CreateSubmissionFromPdfParams) SetBccCompleted(bccCompleted string)

SetBccCompleted sets the BccCompleted field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetCompletedRedirectURL 

func (c *CreateSubmissionFromPdfParams) SetCompletedRedirectURL(completedRedirectURL string)

SetCompletedRedirectURL sets the CompletedRedirectURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetDocuments 

func (c *CreateSubmissionFromPdfParams) SetDocuments(documents []*CreateSubmissionFromPdfDocumentParams)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetExpireAt 

func (c *CreateSubmissionFromPdfParams) SetExpireAt(expireAt string)

SetExpireAt sets the ExpireAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetFlatten 

func (c *CreateSubmissionFromPdfParams) SetFlatten(flatten *bool)

SetFlatten sets the Flatten field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetMergeDocuments 

func (c *CreateSubmissionFromPdfParams) SetMergeDocuments(mergeDocuments *bool)

SetMergeDocuments sets the MergeDocuments field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetMessage 

func (c *CreateSubmissionFromPdfParams) SetMessage(message *CreateSubmissionMessageParams)

SetMessage sets the Message field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetName 

func (c *CreateSubmissionFromPdfParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetOrder 

func (c *CreateSubmissionFromPdfParams) SetOrder(order SubmittersOrder)

SetOrder sets the Order field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetRemoveTags 

func (c *CreateSubmissionFromPdfParams) SetRemoveTags(removeTags *bool)

SetRemoveTags sets the RemoveTags field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetReplyTo 

func (c *CreateSubmissionFromPdfParams) SetReplyTo(replyTo string)

SetReplyTo sets the ReplyTo field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetSendEmail 

func (c *CreateSubmissionFromPdfParams) SetSendEmail(sendEmail *bool)

SetSendEmail sets the SendEmail field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetSendSms 

func (c *CreateSubmissionFromPdfParams) SetSendSms(sendSms *bool)

SetSendSms sets the SendSms field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetSubmitters 

func (c *CreateSubmissionFromPdfParams) SetSubmitters(submitters []*CreateSubmissionSubmitterParams)

SetSubmitters sets the Submitters field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) SetTemplateIDs 

func (c *CreateSubmissionFromPdfParams) SetTemplateIDs(templateIDs []int)

SetTemplateIDs sets the TemplateIDs field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionFromPdfParams) UnmarshalJSON 

func (c *CreateSubmissionFromPdfParams) UnmarshalJSON(data []byte) error

type CreateSubmissionMessageParams 

type CreateSubmissionMessageParams struct {
	// Custom signature request email subject.
	Subject string `json:"subject,omitempty" url:"subject,omitempty"`
	// Custom signature request email body. Can include variables such as {{template.name}}, {{submission.name}}, {{submitter.link}}, {{account.name}}.
	Body string `json:"body,omitempty" url:"body,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionMessageParams) GetBody 

func (c *CreateSubmissionMessageParams) GetBody() string

func (*CreateSubmissionMessageParams) GetExtraProperties 

func (c *CreateSubmissionMessageParams) GetExtraProperties() map[string]interface{}

func (*CreateSubmissionMessageParams) GetSubject 

func (c *CreateSubmissionMessageParams) GetSubject() string

func (*CreateSubmissionMessageParams) MarshalJSON 

func (c *CreateSubmissionMessageParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionMessageParams) SetBody 

func (c *CreateSubmissionMessageParams) SetBody(body string)

SetBody sets the Body field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionMessageParams) SetSubject 

func (c *CreateSubmissionMessageParams) SetSubject(subject string)

SetSubject sets the Subject field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionMessageParams) String 

func (c *CreateSubmissionMessageParams) String() string

func (*CreateSubmissionMessageParams) UnmarshalJSON 

func (c *CreateSubmissionMessageParams) UnmarshalJSON(data []byte) error

type CreateSubmissionParams 

type CreateSubmissionParams struct {
	// The unique identifier of the template. Document template forms can be created via the Web UI, <a href="https://www.docuseal.com/guides/use-embedded-text-field-tags-in-the-pdf-to-create-a-fillable-form" class="link">PDF and DOCX API</a>, or <a href="https://www.docuseal.com/guides/create-pdf-document-fillable-form-with-html-api" class="link">HTML API</a>.
	TemplateID int `json:"template_id" url:"-"`
	// Set `false` to disable signature request emails sending.
	SendEmail *bool `json:"send_email,omitempty" url:"-"`
	// Set `true` to send signature request via phone number and SMS.
	SendSms *bool `json:"send_sms,omitempty" url:"-"`
	// Pass 'random' to send signature request emails to all parties right away. The order is 'preserved' by default so the second party will receive a signature request email only after the document is signed by the first party.
	Order SubmittersOrder `json:"order,omitempty" url:"-"`
	// Specify URL to redirect to after the submission completion.
	CompletedRedirectURL string `json:"completed_redirect_url,omitempty" url:"-"`
	// Specify BCC address to send signed documents to after the completion.
	BccCompleted string `json:"bcc_completed,omitempty" url:"-"`
	// Specify Reply-To address to use in the notification emails.
	ReplyTo string `json:"reply_to,omitempty" url:"-"`
	// Specify the expiration date and time after which the submission becomes unavailable for signature.
	ExpireAt string `json:"expire_at,omitempty" url:"-"`
	// Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in dynamic template documents.
	Variables map[string]any                 `json:"variables,omitempty" url:"-"`
	Message   *CreateSubmissionMessageParams `json:"message,omitempty" url:"-"`
	// The list of submitters for the submission.
	Submitters []*CreateSubmissionSubmitterParams `json:"submitters" url:"-"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionParams) MarshalJSON 

func (c *CreateSubmissionParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionParams) SetBccCompleted 

func (c *CreateSubmissionParams) SetBccCompleted(bccCompleted string)

SetBccCompleted sets the BccCompleted field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionParams) SetCompletedRedirectURL 

func (c *CreateSubmissionParams) SetCompletedRedirectURL(completedRedirectURL string)

SetCompletedRedirectURL sets the CompletedRedirectURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionParams) SetExpireAt 

func (c *CreateSubmissionParams) SetExpireAt(expireAt string)

SetExpireAt sets the ExpireAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionParams) SetMessage 

func (c *CreateSubmissionParams) SetMessage(message *CreateSubmissionMessageParams)

SetMessage sets the Message field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionParams) SetOrder 

func (c *CreateSubmissionParams) SetOrder(order SubmittersOrder)

SetOrder sets the Order field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionParams) SetReplyTo 

func (c *CreateSubmissionParams) SetReplyTo(replyTo string)

SetReplyTo sets the ReplyTo field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionParams) SetSendEmail 

func (c *CreateSubmissionParams) SetSendEmail(sendEmail *bool)

SetSendEmail sets the SendEmail field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionParams) SetSendSms 

func (c *CreateSubmissionParams) SetSendSms(sendSms *bool)

SetSendSms sets the SendSms field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionParams) SetSubmitters 

func (c *CreateSubmissionParams) SetSubmitters(submitters []*CreateSubmissionSubmitterParams)

SetSubmitters sets the Submitters field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionParams) SetTemplateID 

func (c *CreateSubmissionParams) SetTemplateID(templateID int)

SetTemplateID sets the TemplateID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionParams) SetVariables 

func (c *CreateSubmissionParams) SetVariables(variables map[string]any)

SetVariables sets the Variables field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionParams) UnmarshalJSON 

func (c *CreateSubmissionParams) UnmarshalJSON(data []byte) error

type CreateSubmissionSubmitterFieldParams 

type CreateSubmissionSubmitterFieldParams struct {
	// Document template field name.
	Name         string        `json:"name" url:"name"`
	DefaultValue *DefaultValue `json:"default_value,omitempty" url:"default_value,omitempty"`
	// Default value of the field as a plain string. Alias of `default_value` that takes precedence when both are provided.
	Value string `json:"value,omitempty" url:"value,omitempty"`
	// Set `true` to make it impossible for the submitter to edit predefined field value.
	Readonly *bool `json:"readonly,omitempty" url:"readonly,omitempty"`
	// Set `true` to make the field required.
	Required *bool `json:"required,omitempty" url:"required,omitempty"`
	// Field title displayed to the user instead of the name, shown on the signing form. Supports Markdown.
	Title string `json:"title,omitempty" url:"title,omitempty"`
	// Field description displayed on the signing form. Supports Markdown.
	Description string                                           `json:"description,omitempty" url:"description,omitempty"`
	Validation  *CreateSubmissionSubmitterFieldValidationParams  `json:"validation,omitempty" url:"validation,omitempty"`
	Preferences *CreateSubmissionSubmitterFieldPreferencesParams `json:"preferences,omitempty" url:"preferences,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionSubmitterFieldParams) GetDefaultValue 

func (c *CreateSubmissionSubmitterFieldParams) GetDefaultValue() *DefaultValue

func (*CreateSubmissionSubmitterFieldParams) GetDescription 

func (c *CreateSubmissionSubmitterFieldParams) GetDescription() string

func (*CreateSubmissionSubmitterFieldParams) GetExtraProperties 

func (c *CreateSubmissionSubmitterFieldParams) GetExtraProperties() map[string]interface{}

func (*CreateSubmissionSubmitterFieldParams) GetName 

func (c *CreateSubmissionSubmitterFieldParams) GetName() string

func (*CreateSubmissionSubmitterFieldParams) GetPreferences 

func (c *CreateSubmissionSubmitterFieldParams) GetPreferences() *CreateSubmissionSubmitterFieldPreferencesParams

func (*CreateSubmissionSubmitterFieldParams) GetReadonly 

func (c *CreateSubmissionSubmitterFieldParams) GetReadonly() *bool

func (*CreateSubmissionSubmitterFieldParams) GetRequired 

func (c *CreateSubmissionSubmitterFieldParams) GetRequired() *bool

func (*CreateSubmissionSubmitterFieldParams) GetTitle 

func (c *CreateSubmissionSubmitterFieldParams) GetTitle() string

func (*CreateSubmissionSubmitterFieldParams) GetValidation 

func (c *CreateSubmissionSubmitterFieldParams) GetValidation() *CreateSubmissionSubmitterFieldValidationParams

func (*CreateSubmissionSubmitterFieldParams) GetValue 

func (c *CreateSubmissionSubmitterFieldParams) GetValue() string

func (*CreateSubmissionSubmitterFieldParams) MarshalJSON 

func (c *CreateSubmissionSubmitterFieldParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionSubmitterFieldParams) SetDefaultValue 

func (c *CreateSubmissionSubmitterFieldParams) SetDefaultValue(defaultValue *DefaultValue)

SetDefaultValue sets the DefaultValue field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldParams) SetDescription 

func (c *CreateSubmissionSubmitterFieldParams) SetDescription(description string)

SetDescription sets the Description field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldParams) SetName 

func (c *CreateSubmissionSubmitterFieldParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldParams) SetPreferences 

func (c *CreateSubmissionSubmitterFieldParams) SetPreferences(preferences *CreateSubmissionSubmitterFieldPreferencesParams)

SetPreferences sets the Preferences field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldParams) SetReadonly 

func (c *CreateSubmissionSubmitterFieldParams) SetReadonly(readonly *bool)

SetReadonly sets the Readonly field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldParams) SetRequired 

func (c *CreateSubmissionSubmitterFieldParams) SetRequired(required *bool)

SetRequired sets the Required field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldParams) SetTitle 

func (c *CreateSubmissionSubmitterFieldParams) SetTitle(title string)

SetTitle sets the Title field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldParams) SetValidation 

func (c *CreateSubmissionSubmitterFieldParams) SetValidation(validation *CreateSubmissionSubmitterFieldValidationParams)

SetValidation sets the Validation field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldParams) SetValue 

func (c *CreateSubmissionSubmitterFieldParams) SetValue(value string)

SetValue sets the Value field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldParams) String 

func (c *CreateSubmissionSubmitterFieldParams) String() string

func (*CreateSubmissionSubmitterFieldParams) UnmarshalJSON 

func (c *CreateSubmissionSubmitterFieldParams) UnmarshalJSON(data []byte) error

type CreateSubmissionSubmitterFieldPreferencesParams 

type CreateSubmissionSubmitterFieldPreferencesParams struct {
	// Font size of the field value in pixels.
	FontSize *int `json:"font_size,omitempty" url:"font_size,omitempty"`
	// Font type of the field value.
	FontType FieldFontType `json:"font_type,omitempty" url:"font_type,omitempty"`
	// Font family of the field value.
	Font FieldFont `json:"font,omitempty" url:"font,omitempty"`
	// Font color of the field value.
	Color string `json:"color,omitempty" url:"color,omitempty"`
	// Field box background color.
	Background string `json:"background,omitempty" url:"background,omitempty"`
	// Horizontal alignment of the field text value.
	Align FieldAlign `json:"align,omitempty" url:"align,omitempty"`
	// Vertical alignment of the field text value.
	Valign FieldValign `json:"valign,omitempty" url:"valign,omitempty"`
	// The data format for different field types.<br>- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).<br>- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.<br>- Number field: accepts currency formats such as usd, eur, gbp.
	Format string `json:"format,omitempty" url:"format,omitempty"`
	// Price value of the payment field. Only for payment fields.
	Price *float64 `json:"price,omitempty" url:"price,omitempty"`
	// Currency value of the payment field. Only for payment fields.
	Currency Currency `json:"currency,omitempty" url:"currency,omitempty"`
	// Set `true` to make sensitive data masked on the document.
	Mask *CreateSubmissionSubmitterFieldPreferencesParamsMask `json:"mask,omitempty" url:"mask,omitempty"`
	// An array of signature reasons to choose from.
	Reasons []string `json:"reasons,omitempty" url:"reasons,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionSubmitterFieldPreferencesParams) GetAlign 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) GetAlign() FieldAlign

func (*CreateSubmissionSubmitterFieldPreferencesParams) GetBackground 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) GetBackground() string

func (*CreateSubmissionSubmitterFieldPreferencesParams) GetColor 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) GetColor() string

func (*CreateSubmissionSubmitterFieldPreferencesParams) GetCurrency 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) GetCurrency() Currency

func (*CreateSubmissionSubmitterFieldPreferencesParams) GetExtraProperties 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) GetExtraProperties() map[string]interface{}

func (*CreateSubmissionSubmitterFieldPreferencesParams) GetFont 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) GetFont() FieldFont

func (*CreateSubmissionSubmitterFieldPreferencesParams) GetFontSize 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) GetFontSize() *int

func (*CreateSubmissionSubmitterFieldPreferencesParams) GetFontType 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) GetFontType() FieldFontType

func (*CreateSubmissionSubmitterFieldPreferencesParams) GetFormat 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) GetFormat() string

func (*CreateSubmissionSubmitterFieldPreferencesParams) GetMask 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) GetMask() *CreateSubmissionSubmitterFieldPreferencesParamsMask

func (*CreateSubmissionSubmitterFieldPreferencesParams) GetPrice 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) GetPrice() *float64

func (*CreateSubmissionSubmitterFieldPreferencesParams) GetReasons 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) GetReasons() []string

func (*CreateSubmissionSubmitterFieldPreferencesParams) GetValign 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) GetValign() FieldValign

func (*CreateSubmissionSubmitterFieldPreferencesParams) MarshalJSON 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionSubmitterFieldPreferencesParams) SetAlign 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) SetAlign(align FieldAlign)

SetAlign sets the Align field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldPreferencesParams) SetBackground 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) SetBackground(background string)

SetBackground sets the Background field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldPreferencesParams) SetColor 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) SetColor(color string)

SetColor sets the Color field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldPreferencesParams) SetCurrency 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) SetCurrency(currency Currency)

SetCurrency sets the Currency field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldPreferencesParams) SetFont 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) SetFont(font FieldFont)

SetFont sets the Font field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldPreferencesParams) SetFontSize 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) SetFontSize(fontSize *int)

SetFontSize sets the FontSize field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldPreferencesParams) SetFontType 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) SetFontType(fontType FieldFontType)

SetFontType sets the FontType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldPreferencesParams) SetFormat 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) SetFormat(format string)

SetFormat sets the Format field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldPreferencesParams) SetMask 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) SetMask(mask *CreateSubmissionSubmitterFieldPreferencesParamsMask)

SetMask sets the Mask field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldPreferencesParams) SetPrice 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) SetPrice(price *float64)

SetPrice sets the Price field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldPreferencesParams) SetReasons 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) SetReasons(reasons []string)

SetReasons sets the Reasons field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldPreferencesParams) SetValign 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) SetValign(valign FieldValign)

SetValign sets the Valign field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldPreferencesParams) String 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) String() string

func (*CreateSubmissionSubmitterFieldPreferencesParams) UnmarshalJSON 

func (c *CreateSubmissionSubmitterFieldPreferencesParams) UnmarshalJSON(data []byte) error

type CreateSubmissionSubmitterFieldPreferencesParamsMask 

type CreateSubmissionSubmitterFieldPreferencesParamsMask struct {
	Integer int
	Boolean bool
	// contains filtered or unexported fields
}

Set `true` to make sensitive data masked on the document.

func (*CreateSubmissionSubmitterFieldPreferencesParamsMask) Accept 

func (c *CreateSubmissionSubmitterFieldPreferencesParamsMask) Accept(visitor CreateSubmissionSubmitterFieldPreferencesParamsMaskVisitor) error

func (*CreateSubmissionSubmitterFieldPreferencesParamsMask) GetBoolean 

func (c *CreateSubmissionSubmitterFieldPreferencesParamsMask) GetBoolean() bool

func (*CreateSubmissionSubmitterFieldPreferencesParamsMask) GetInteger 

func (c *CreateSubmissionSubmitterFieldPreferencesParamsMask) GetInteger() int

func (CreateSubmissionSubmitterFieldPreferencesParamsMask) MarshalJSON 

func (c CreateSubmissionSubmitterFieldPreferencesParamsMask) MarshalJSON() ([]byte, error)

func (*CreateSubmissionSubmitterFieldPreferencesParamsMask) UnmarshalJSON 

func (c *CreateSubmissionSubmitterFieldPreferencesParamsMask) UnmarshalJSON(data []byte) error

type CreateSubmissionSubmitterFieldPreferencesParamsMaskVisitor 

type CreateSubmissionSubmitterFieldPreferencesParamsMaskVisitor interface {
	VisitInteger(int) error
	VisitBoolean(bool) error
}

type CreateSubmissionSubmitterFieldValidationParams 

type CreateSubmissionSubmitterFieldValidationParams struct {
	// HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.
	Pattern string `json:"pattern,omitempty" url:"pattern,omitempty"`
	// A custom error message to display on validation failure.
	Message string `json:"message,omitempty" url:"message,omitempty"`
	// Minimum allowed number value or date depending on field type.
	Min *CreateSubmissionSubmitterFieldValidationParamsMin `json:"min,omitempty" url:"min,omitempty"`
	// Maximum allowed number value or date depending on field type.
	Max *CreateSubmissionSubmitterFieldValidationParamsMax `json:"max,omitempty" url:"max,omitempty"`
	// Increment step for number field. Pass 1 to accept only integers, or 0.01 to accept decimal currency.
	Step *float64 `json:"step,omitempty" url:"step,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionSubmitterFieldValidationParams) GetExtraProperties 

func (c *CreateSubmissionSubmitterFieldValidationParams) GetExtraProperties() map[string]interface{}

func (*CreateSubmissionSubmitterFieldValidationParams) GetMax 

func (c *CreateSubmissionSubmitterFieldValidationParams) GetMax() *CreateSubmissionSubmitterFieldValidationParamsMax

func (*CreateSubmissionSubmitterFieldValidationParams) GetMessage 

func (c *CreateSubmissionSubmitterFieldValidationParams) GetMessage() string

func (*CreateSubmissionSubmitterFieldValidationParams) GetMin 

func (c *CreateSubmissionSubmitterFieldValidationParams) GetMin() *CreateSubmissionSubmitterFieldValidationParamsMin

func (*CreateSubmissionSubmitterFieldValidationParams) GetPattern 

func (c *CreateSubmissionSubmitterFieldValidationParams) GetPattern() string

func (*CreateSubmissionSubmitterFieldValidationParams) GetStep 

func (c *CreateSubmissionSubmitterFieldValidationParams) GetStep() *float64

func (*CreateSubmissionSubmitterFieldValidationParams) MarshalJSON 

func (c *CreateSubmissionSubmitterFieldValidationParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionSubmitterFieldValidationParams) SetMax 

func (c *CreateSubmissionSubmitterFieldValidationParams) SetMax(max *CreateSubmissionSubmitterFieldValidationParamsMax)

SetMax sets the Max field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldValidationParams) SetMessage 

func (c *CreateSubmissionSubmitterFieldValidationParams) SetMessage(message string)

SetMessage sets the Message field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldValidationParams) SetMin 

func (c *CreateSubmissionSubmitterFieldValidationParams) SetMin(min *CreateSubmissionSubmitterFieldValidationParamsMin)

SetMin sets the Min field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldValidationParams) SetPattern 

func (c *CreateSubmissionSubmitterFieldValidationParams) SetPattern(pattern string)

SetPattern sets the Pattern field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldValidationParams) SetStep 

func (c *CreateSubmissionSubmitterFieldValidationParams) SetStep(step *float64)

SetStep sets the Step field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterFieldValidationParams) String 

func (c *CreateSubmissionSubmitterFieldValidationParams) String() string

func (*CreateSubmissionSubmitterFieldValidationParams) UnmarshalJSON 

func (c *CreateSubmissionSubmitterFieldValidationParams) UnmarshalJSON(data []byte) error

type CreateSubmissionSubmitterFieldValidationParamsMax 

type CreateSubmissionSubmitterFieldValidationParamsMax struct {
	Double float64
	String string
	// contains filtered or unexported fields
}

Maximum allowed number value or date depending on field type.

func (*CreateSubmissionSubmitterFieldValidationParamsMax) Accept 

func (c *CreateSubmissionSubmitterFieldValidationParamsMax) Accept(visitor CreateSubmissionSubmitterFieldValidationParamsMaxVisitor) error

func (*CreateSubmissionSubmitterFieldValidationParamsMax) GetDouble 

func (c *CreateSubmissionSubmitterFieldValidationParamsMax) GetDouble() float64

func (*CreateSubmissionSubmitterFieldValidationParamsMax) GetString 

func (c *CreateSubmissionSubmitterFieldValidationParamsMax) GetString() string

func (CreateSubmissionSubmitterFieldValidationParamsMax) MarshalJSON 

func (c CreateSubmissionSubmitterFieldValidationParamsMax) MarshalJSON() ([]byte, error)

func (*CreateSubmissionSubmitterFieldValidationParamsMax) UnmarshalJSON 

func (c *CreateSubmissionSubmitterFieldValidationParamsMax) UnmarshalJSON(data []byte) error

type CreateSubmissionSubmitterFieldValidationParamsMaxVisitor 

type CreateSubmissionSubmitterFieldValidationParamsMaxVisitor interface {
	VisitDouble(float64) error
	VisitString(string) error
}

type CreateSubmissionSubmitterFieldValidationParamsMin 

type CreateSubmissionSubmitterFieldValidationParamsMin struct {
	Double float64
	String string
	// contains filtered or unexported fields
}

Minimum allowed number value or date depending on field type.

func (*CreateSubmissionSubmitterFieldValidationParamsMin) Accept 

func (c *CreateSubmissionSubmitterFieldValidationParamsMin) Accept(visitor CreateSubmissionSubmitterFieldValidationParamsMinVisitor) error

func (*CreateSubmissionSubmitterFieldValidationParamsMin) GetDouble 

func (c *CreateSubmissionSubmitterFieldValidationParamsMin) GetDouble() float64

func (*CreateSubmissionSubmitterFieldValidationParamsMin) GetString 

func (c *CreateSubmissionSubmitterFieldValidationParamsMin) GetString() string

func (CreateSubmissionSubmitterFieldValidationParamsMin) MarshalJSON 

func (c CreateSubmissionSubmitterFieldValidationParamsMin) MarshalJSON() ([]byte, error)

func (*CreateSubmissionSubmitterFieldValidationParamsMin) UnmarshalJSON 

func (c *CreateSubmissionSubmitterFieldValidationParamsMin) UnmarshalJSON(data []byte) error

type CreateSubmissionSubmitterFieldValidationParamsMinVisitor 

type CreateSubmissionSubmitterFieldValidationParamsMinVisitor interface {
	VisitDouble(float64) error
	VisitString(string) error
}

type CreateSubmissionSubmitterMessageParams 

type CreateSubmissionSubmitterMessageParams struct {
	// Custom signature request email subject for the submitter.
	Subject string `json:"subject,omitempty" url:"subject,omitempty"`
	// Custom signature request email body for the submitter. Can include variables such as {{template.name}}, {{submission.name}}, {{submitter.link}}, {{account.name}}.
	Body string `json:"body,omitempty" url:"body,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionSubmitterMessageParams) GetBody 

func (c *CreateSubmissionSubmitterMessageParams) GetBody() string

func (*CreateSubmissionSubmitterMessageParams) GetExtraProperties 

func (c *CreateSubmissionSubmitterMessageParams) GetExtraProperties() map[string]interface{}

func (*CreateSubmissionSubmitterMessageParams) GetSubject 

func (c *CreateSubmissionSubmitterMessageParams) GetSubject() string

func (*CreateSubmissionSubmitterMessageParams) MarshalJSON 

func (c *CreateSubmissionSubmitterMessageParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionSubmitterMessageParams) SetBody 

func (c *CreateSubmissionSubmitterMessageParams) SetBody(body string)

SetBody sets the Body field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterMessageParams) SetSubject 

func (c *CreateSubmissionSubmitterMessageParams) SetSubject(subject string)

SetSubject sets the Subject field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterMessageParams) String 

func (c *CreateSubmissionSubmitterMessageParams) String() string

func (*CreateSubmissionSubmitterMessageParams) UnmarshalJSON 

func (c *CreateSubmissionSubmitterMessageParams) UnmarshalJSON(data []byte) error

type CreateSubmissionSubmitterParams 

type CreateSubmissionSubmitterParams struct {
	// The name of the submitter.
	Name string `json:"name,omitempty" url:"name,omitempty"`
	// The role name or title of the submitter.
	Role string `json:"role,omitempty" url:"role,omitempty"`
	// The email address of the submitter.
	Email string `json:"email,omitempty" url:"email,omitempty"`
	// The phone number of the submitter, formatted according to the E.164 standard.
	Phone string `json:"phone,omitempty" url:"phone,omitempty"`
	// An object with pre-filled values for the submission. Use field names for keys of the object. For more configurations see `fields` param.
	Values map[string]any `json:"values,omitempty" url:"values,omitempty"`
	// Your application-specific unique string key to identify this submitter within your app.
	ExternalID string `json:"external_id,omitempty" url:"external_id,omitempty"`
	// Pass `true` to mark submitter as completed and auto-signed via API.
	Completed *bool `json:"completed,omitempty" url:"completed,omitempty"`
	// Metadata object with additional submitter information.
	Metadata map[string]any `json:"metadata,omitempty" url:"metadata,omitempty"`
	// Set `false` to disable signature request emails sending only for this submitter.
	SendEmail *bool `json:"send_email,omitempty" url:"send_email,omitempty"`
	// Set `true` to send signature request via phone number and SMS.
	SendSms *bool `json:"send_sms,omitempty" url:"send_sms,omitempty"`
	// Specify Reply-To address to use in the notification emails for this submitter.
	ReplyTo string `json:"reply_to,omitempty" url:"reply_to,omitempty"`
	// Submitter specific URL to redirect to after the submission completion.
	CompletedRedirectURL string `json:"completed_redirect_url,omitempty" url:"completed_redirect_url,omitempty"`
	// The order of the submitter in the workflow (e.g., 0 for the first signer, 1 for the second, etc.). Use the same order number to create order groups. By default, submitters are ordered as in the submitters array.
	Order *int `json:"order,omitempty" url:"order,omitempty"`
	// Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.
	RequirePhone2Fa *bool `json:"require_phone_2fa,omitempty" url:"require_phone_2fa,omitempty"`
	// Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.
	RequireEmail2Fa *bool `json:"require_email_2fa,omitempty" url:"require_email_2fa,omitempty"`
	// Set the role name of the previous party that should invite this party via email.
	InviteBy string                                  `json:"invite_by,omitempty" url:"invite_by,omitempty"`
	Message  *CreateSubmissionSubmitterMessageParams `json:"message,omitempty" url:"message,omitempty"`
	// A list of configurations for template document form fields.
	Fields []*CreateSubmissionSubmitterFieldParams `json:"fields,omitempty" url:"fields,omitempty"`
	// A list of roles for the submitter. Use this param to merge multiple roles into one submitter.
	Roles []string `json:"roles,omitempty" url:"roles,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSubmissionSubmitterParams) GetCompleted 

func (c *CreateSubmissionSubmitterParams) GetCompleted() *bool

func (*CreateSubmissionSubmitterParams) GetCompletedRedirectURL 

func (c *CreateSubmissionSubmitterParams) GetCompletedRedirectURL() string

func (*CreateSubmissionSubmitterParams) GetEmail 

func (c *CreateSubmissionSubmitterParams) GetEmail() string

func (*CreateSubmissionSubmitterParams) GetExternalID 

func (c *CreateSubmissionSubmitterParams) GetExternalID() string

func (*CreateSubmissionSubmitterParams) GetExtraProperties 

func (c *CreateSubmissionSubmitterParams) GetExtraProperties() map[string]interface{}

func (*CreateSubmissionSubmitterParams) GetFields 

func (c *CreateSubmissionSubmitterParams) GetFields() []*CreateSubmissionSubmitterFieldParams

func (*CreateSubmissionSubmitterParams) GetInviteBy 

func (c *CreateSubmissionSubmitterParams) GetInviteBy() string

func (*CreateSubmissionSubmitterParams) GetMessage 

func (c *CreateSubmissionSubmitterParams) GetMessage() *CreateSubmissionSubmitterMessageParams

func (*CreateSubmissionSubmitterParams) GetMetadata 

func (c *CreateSubmissionSubmitterParams) GetMetadata() map[string]any

func (*CreateSubmissionSubmitterParams) GetName 

func (c *CreateSubmissionSubmitterParams) GetName() string

func (*CreateSubmissionSubmitterParams) GetOrder 

func (c *CreateSubmissionSubmitterParams) GetOrder() *int

func (*CreateSubmissionSubmitterParams) GetPhone 

func (c *CreateSubmissionSubmitterParams) GetPhone() string

func (*CreateSubmissionSubmitterParams) GetReplyTo 

func (c *CreateSubmissionSubmitterParams) GetReplyTo() string

func (*CreateSubmissionSubmitterParams) GetRequireEmail2Fa 

func (c *CreateSubmissionSubmitterParams) GetRequireEmail2Fa() *bool

func (*CreateSubmissionSubmitterParams) GetRequirePhone2Fa 

func (c *CreateSubmissionSubmitterParams) GetRequirePhone2Fa() *bool

func (*CreateSubmissionSubmitterParams) GetRole 

func (c *CreateSubmissionSubmitterParams) GetRole() string

func (*CreateSubmissionSubmitterParams) GetRoles 

func (c *CreateSubmissionSubmitterParams) GetRoles() []string

func (*CreateSubmissionSubmitterParams) GetSendEmail 

func (c *CreateSubmissionSubmitterParams) GetSendEmail() *bool

func (*CreateSubmissionSubmitterParams) GetSendSms 

func (c *CreateSubmissionSubmitterParams) GetSendSms() *bool

func (*CreateSubmissionSubmitterParams) GetValues 

func (c *CreateSubmissionSubmitterParams) GetValues() map[string]any

func (*CreateSubmissionSubmitterParams) MarshalJSON 

func (c *CreateSubmissionSubmitterParams) MarshalJSON() ([]byte, error)

func (*CreateSubmissionSubmitterParams) SetCompleted 

func (c *CreateSubmissionSubmitterParams) SetCompleted(completed *bool)

SetCompleted sets the Completed field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetCompletedRedirectURL 

func (c *CreateSubmissionSubmitterParams) SetCompletedRedirectURL(completedRedirectURL string)

SetCompletedRedirectURL sets the CompletedRedirectURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetEmail 

func (c *CreateSubmissionSubmitterParams) SetEmail(email string)

SetEmail sets the Email field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetExternalID 

func (c *CreateSubmissionSubmitterParams) SetExternalID(externalID string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetFields 

func (c *CreateSubmissionSubmitterParams) SetFields(fields []*CreateSubmissionSubmitterFieldParams)

SetFields sets the Fields field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetInviteBy 

func (c *CreateSubmissionSubmitterParams) SetInviteBy(inviteBy string)

SetInviteBy sets the InviteBy field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetMessage 

func (c *CreateSubmissionSubmitterParams) SetMessage(message *CreateSubmissionSubmitterMessageParams)

SetMessage sets the Message field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetMetadata 

func (c *CreateSubmissionSubmitterParams) SetMetadata(metadata map[string]any)

SetMetadata sets the Metadata field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetName 

func (c *CreateSubmissionSubmitterParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetOrder 

func (c *CreateSubmissionSubmitterParams) SetOrder(order *int)

SetOrder sets the Order field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetPhone 

func (c *CreateSubmissionSubmitterParams) SetPhone(phone string)

SetPhone sets the Phone field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetReplyTo 

func (c *CreateSubmissionSubmitterParams) SetReplyTo(replyTo string)

SetReplyTo sets the ReplyTo field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetRequireEmail2Fa 

func (c *CreateSubmissionSubmitterParams) SetRequireEmail2Fa(requireEmail2Fa *bool)

SetRequireEmail2Fa sets the RequireEmail2Fa field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetRequirePhone2Fa 

func (c *CreateSubmissionSubmitterParams) SetRequirePhone2Fa(requirePhone2Fa *bool)

SetRequirePhone2Fa sets the RequirePhone2Fa field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetRole 

func (c *CreateSubmissionSubmitterParams) SetRole(role string)

SetRole sets the Role field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetRoles 

func (c *CreateSubmissionSubmitterParams) SetRoles(roles []string)

SetRoles sets the Roles field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetSendEmail 

func (c *CreateSubmissionSubmitterParams) SetSendEmail(sendEmail *bool)

SetSendEmail sets the SendEmail field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetSendSms 

func (c *CreateSubmissionSubmitterParams) SetSendSms(sendSms *bool)

SetSendSms sets the SendSms field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) SetValues 

func (c *CreateSubmissionSubmitterParams) SetValues(values map[string]any)

SetValues sets the Values field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateSubmissionSubmitterParams) String 

func (c *CreateSubmissionSubmitterParams) String() string

func (*CreateSubmissionSubmitterParams) UnmarshalJSON 

func (c *CreateSubmissionSubmitterParams) UnmarshalJSON(data []byte) error

type CreateTemplateDocumentFieldAreaParams 

type CreateTemplateDocumentFieldAreaParams struct {
	// X-coordinate of the field area.
	X float64 `json:"x" url:"x"`
	// Y-coordinate of the field area.
	Y float64 `json:"y" url:"y"`
	// Width of the field area.
	W float64 `json:"w" url:"w"`
	// Height of the field area.
	H float64 `json:"h" url:"h"`
	// Page number of the field area. Starts from 1.
	Page int `json:"page" url:"page"`
	// Option string value for 'radio' and 'multiple' select field types.
	Option string `json:"option,omitempty" url:"option,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTemplateDocumentFieldAreaParams) GetExtraProperties 

func (c *CreateTemplateDocumentFieldAreaParams) GetExtraProperties() map[string]interface{}

func (*CreateTemplateDocumentFieldAreaParams) GetH 

func (c *CreateTemplateDocumentFieldAreaParams) GetH() float64

func (*CreateTemplateDocumentFieldAreaParams) GetOption 

func (c *CreateTemplateDocumentFieldAreaParams) GetOption() string

func (*CreateTemplateDocumentFieldAreaParams) GetPage 

func (c *CreateTemplateDocumentFieldAreaParams) GetPage() int

func (*CreateTemplateDocumentFieldAreaParams) GetW 

func (c *CreateTemplateDocumentFieldAreaParams) GetW() float64

func (*CreateTemplateDocumentFieldAreaParams) GetX 

func (c *CreateTemplateDocumentFieldAreaParams) GetX() float64

func (*CreateTemplateDocumentFieldAreaParams) GetY 

func (c *CreateTemplateDocumentFieldAreaParams) GetY() float64

func (*CreateTemplateDocumentFieldAreaParams) MarshalJSON 

func (c *CreateTemplateDocumentFieldAreaParams) MarshalJSON() ([]byte, error)

func (*CreateTemplateDocumentFieldAreaParams) SetH 

func (c *CreateTemplateDocumentFieldAreaParams) SetH(h float64)

SetH sets the H field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldAreaParams) SetOption 

func (c *CreateTemplateDocumentFieldAreaParams) SetOption(option string)

SetOption sets the Option field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldAreaParams) SetPage 

func (c *CreateTemplateDocumentFieldAreaParams) SetPage(page int)

SetPage sets the Page field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldAreaParams) SetW 

func (c *CreateTemplateDocumentFieldAreaParams) SetW(w float64)

SetW sets the W field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldAreaParams) SetX 

func (c *CreateTemplateDocumentFieldAreaParams) SetX(x float64)

SetX sets the X field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldAreaParams) SetY 

func (c *CreateTemplateDocumentFieldAreaParams) SetY(y float64)

SetY sets the Y field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldAreaParams) String 

func (c *CreateTemplateDocumentFieldAreaParams) String() string

func (*CreateTemplateDocumentFieldAreaParams) UnmarshalJSON 

func (c *CreateTemplateDocumentFieldAreaParams) UnmarshalJSON(data []byte) error

type CreateTemplateDocumentFieldParams 

type CreateTemplateDocumentFieldParams struct {
	// Name of the field.
	Name string `json:"name,omitempty" url:"name,omitempty"`
	// Type of the field (e.g., text, signature, date, initials).
	Type FieldType `json:"type,omitempty" url:"type,omitempty"`
	// Role name of the signer.
	Role string `json:"role,omitempty" url:"role,omitempty"`
	// Indicates if the field is required.
	Required *bool `json:"required,omitempty" url:"required,omitempty"`
	// Field title displayed to the user instead of the name, shown on the signing form. Supports Markdown.
	Title string `json:"title,omitempty" url:"title,omitempty"`
	// Field description displayed on the signing form. Supports Markdown.
	Description string `json:"description,omitempty" url:"description,omitempty"`
	// List of areas where the field is located in the document.
	Areas []*CreateTemplateDocumentFieldAreaParams `json:"areas,omitempty" url:"areas,omitempty"`
	// An array of option values for 'select' field type.
	Options     []string                                      `json:"options,omitempty" url:"options,omitempty"`
	Validation  *CreateTemplateDocumentFieldValidationParams  `json:"validation,omitempty" url:"validation,omitempty"`
	Preferences *CreateTemplateDocumentFieldPreferencesParams `json:"preferences,omitempty" url:"preferences,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTemplateDocumentFieldParams) GetAreas 

func (c *CreateTemplateDocumentFieldParams) GetAreas() []*CreateTemplateDocumentFieldAreaParams

func (*CreateTemplateDocumentFieldParams) GetDescription 

func (c *CreateTemplateDocumentFieldParams) GetDescription() string

func (*CreateTemplateDocumentFieldParams) GetExtraProperties 

func (c *CreateTemplateDocumentFieldParams) GetExtraProperties() map[string]interface{}

func (*CreateTemplateDocumentFieldParams) GetName 

func (c *CreateTemplateDocumentFieldParams) GetName() string

func (*CreateTemplateDocumentFieldParams) GetOptions 

func (c *CreateTemplateDocumentFieldParams) GetOptions() []string

func (*CreateTemplateDocumentFieldParams) GetPreferences 

func (c *CreateTemplateDocumentFieldParams) GetPreferences() *CreateTemplateDocumentFieldPreferencesParams

func (*CreateTemplateDocumentFieldParams) GetRequired 

func (c *CreateTemplateDocumentFieldParams) GetRequired() *bool

func (*CreateTemplateDocumentFieldParams) GetRole 

func (c *CreateTemplateDocumentFieldParams) GetRole() string

func (*CreateTemplateDocumentFieldParams) GetTitle 

func (c *CreateTemplateDocumentFieldParams) GetTitle() string

func (*CreateTemplateDocumentFieldParams) GetType 

func (c *CreateTemplateDocumentFieldParams) GetType() FieldType

func (*CreateTemplateDocumentFieldParams) GetValidation 

func (c *CreateTemplateDocumentFieldParams) GetValidation() *CreateTemplateDocumentFieldValidationParams

func (*CreateTemplateDocumentFieldParams) MarshalJSON 

func (c *CreateTemplateDocumentFieldParams) MarshalJSON() ([]byte, error)

func (*CreateTemplateDocumentFieldParams) SetAreas 

func (c *CreateTemplateDocumentFieldParams) SetAreas(areas []*CreateTemplateDocumentFieldAreaParams)

SetAreas sets the Areas field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldParams) SetDescription 

func (c *CreateTemplateDocumentFieldParams) SetDescription(description string)

SetDescription sets the Description field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldParams) SetName 

func (c *CreateTemplateDocumentFieldParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldParams) SetOptions 

func (c *CreateTemplateDocumentFieldParams) SetOptions(options []string)

SetOptions sets the Options field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldParams) SetPreferences 

func (c *CreateTemplateDocumentFieldParams) SetPreferences(preferences *CreateTemplateDocumentFieldPreferencesParams)

SetPreferences sets the Preferences field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldParams) SetRequired 

func (c *CreateTemplateDocumentFieldParams) SetRequired(required *bool)

SetRequired sets the Required field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldParams) SetRole 

func (c *CreateTemplateDocumentFieldParams) SetRole(role string)

SetRole sets the Role field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldParams) SetTitle 

func (c *CreateTemplateDocumentFieldParams) SetTitle(title string)

SetTitle sets the Title field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldParams) SetType 

func (c *CreateTemplateDocumentFieldParams) SetType(type_ FieldType)

SetType sets the Type field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldParams) SetValidation 

func (c *CreateTemplateDocumentFieldParams) SetValidation(validation *CreateTemplateDocumentFieldValidationParams)

SetValidation sets the Validation field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldParams) String 

func (c *CreateTemplateDocumentFieldParams) String() string

func (*CreateTemplateDocumentFieldParams) UnmarshalJSON 

func (c *CreateTemplateDocumentFieldParams) UnmarshalJSON(data []byte) error

type CreateTemplateDocumentFieldPreferencesParams 

type CreateTemplateDocumentFieldPreferencesParams struct {
	// Font size of the field value in pixels.
	FontSize *int `json:"font_size,omitempty" url:"font_size,omitempty"`
	// Font type of the field value.
	FontType FieldFontType `json:"font_type,omitempty" url:"font_type,omitempty"`
	// Font family of the field value.
	Font FieldFont `json:"font,omitempty" url:"font,omitempty"`
	// Font color of the field value.
	Color string `json:"color,omitempty" url:"color,omitempty"`
	// Field box background color.
	Background string `json:"background,omitempty" url:"background,omitempty"`
	// Horizontal alignment of the field text value.
	Align FieldAlign `json:"align,omitempty" url:"align,omitempty"`
	// Vertical alignment of the field text value.
	Valign FieldValign `json:"valign,omitempty" url:"valign,omitempty"`
	// The data format for different field types.<br>- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).<br>- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.<br>- Number field: accepts currency formats such as usd, eur, gbp.
	Format string `json:"format,omitempty" url:"format,omitempty"`
	// Price value of the payment field. Only for payment fields.
	Price *float64 `json:"price,omitempty" url:"price,omitempty"`
	// Currency value of the payment field. Only for payment fields.
	Currency Currency `json:"currency,omitempty" url:"currency,omitempty"`
	// Set `true` to make sensitive data masked on the document.
	Mask *CreateTemplateDocumentFieldPreferencesParamsMask `json:"mask,omitempty" url:"mask,omitempty"`
	// An array of signature reasons to choose from.
	Reasons []string `json:"reasons,omitempty" url:"reasons,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTemplateDocumentFieldPreferencesParams) GetAlign 

func (c *CreateTemplateDocumentFieldPreferencesParams) GetAlign() FieldAlign

func (*CreateTemplateDocumentFieldPreferencesParams) GetBackground 

func (c *CreateTemplateDocumentFieldPreferencesParams) GetBackground() string

func (*CreateTemplateDocumentFieldPreferencesParams) GetColor 

func (c *CreateTemplateDocumentFieldPreferencesParams) GetColor() string

func (*CreateTemplateDocumentFieldPreferencesParams) GetCurrency 

func (c *CreateTemplateDocumentFieldPreferencesParams) GetCurrency() Currency

func (*CreateTemplateDocumentFieldPreferencesParams) GetExtraProperties 

func (c *CreateTemplateDocumentFieldPreferencesParams) GetExtraProperties() map[string]interface{}

func (*CreateTemplateDocumentFieldPreferencesParams) GetFont 

func (c *CreateTemplateDocumentFieldPreferencesParams) GetFont() FieldFont

func (*CreateTemplateDocumentFieldPreferencesParams) GetFontSize 

func (c *CreateTemplateDocumentFieldPreferencesParams) GetFontSize() *int

func (*CreateTemplateDocumentFieldPreferencesParams) GetFontType 

func (c *CreateTemplateDocumentFieldPreferencesParams) GetFontType() FieldFontType

func (*CreateTemplateDocumentFieldPreferencesParams) GetFormat 

func (c *CreateTemplateDocumentFieldPreferencesParams) GetFormat() string

func (*CreateTemplateDocumentFieldPreferencesParams) GetMask 

func (c *CreateTemplateDocumentFieldPreferencesParams) GetMask() *CreateTemplateDocumentFieldPreferencesParamsMask

func (*CreateTemplateDocumentFieldPreferencesParams) GetPrice 

func (c *CreateTemplateDocumentFieldPreferencesParams) GetPrice() *float64

func (*CreateTemplateDocumentFieldPreferencesParams) GetReasons 

func (c *CreateTemplateDocumentFieldPreferencesParams) GetReasons() []string

func (*CreateTemplateDocumentFieldPreferencesParams) GetValign 

func (c *CreateTemplateDocumentFieldPreferencesParams) GetValign() FieldValign

func (*CreateTemplateDocumentFieldPreferencesParams) MarshalJSON 

func (c *CreateTemplateDocumentFieldPreferencesParams) MarshalJSON() ([]byte, error)

func (*CreateTemplateDocumentFieldPreferencesParams) SetAlign 

func (c *CreateTemplateDocumentFieldPreferencesParams) SetAlign(align FieldAlign)

SetAlign sets the Align field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldPreferencesParams) SetBackground 

func (c *CreateTemplateDocumentFieldPreferencesParams) SetBackground(background string)

SetBackground sets the Background field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldPreferencesParams) SetColor 

func (c *CreateTemplateDocumentFieldPreferencesParams) SetColor(color string)

SetColor sets the Color field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldPreferencesParams) SetCurrency 

func (c *CreateTemplateDocumentFieldPreferencesParams) SetCurrency(currency Currency)

SetCurrency sets the Currency field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldPreferencesParams) SetFont 

func (c *CreateTemplateDocumentFieldPreferencesParams) SetFont(font FieldFont)

SetFont sets the Font field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldPreferencesParams) SetFontSize 

func (c *CreateTemplateDocumentFieldPreferencesParams) SetFontSize(fontSize *int)

SetFontSize sets the FontSize field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldPreferencesParams) SetFontType 

func (c *CreateTemplateDocumentFieldPreferencesParams) SetFontType(fontType FieldFontType)

SetFontType sets the FontType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldPreferencesParams) SetFormat 

func (c *CreateTemplateDocumentFieldPreferencesParams) SetFormat(format string)

SetFormat sets the Format field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldPreferencesParams) SetMask 

func (c *CreateTemplateDocumentFieldPreferencesParams) SetMask(mask *CreateTemplateDocumentFieldPreferencesParamsMask)

SetMask sets the Mask field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldPreferencesParams) SetPrice 

func (c *CreateTemplateDocumentFieldPreferencesParams) SetPrice(price *float64)

SetPrice sets the Price field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldPreferencesParams) SetReasons 

func (c *CreateTemplateDocumentFieldPreferencesParams) SetReasons(reasons []string)

SetReasons sets the Reasons field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldPreferencesParams) SetValign 

func (c *CreateTemplateDocumentFieldPreferencesParams) SetValign(valign FieldValign)

SetValign sets the Valign field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldPreferencesParams) String 

func (c *CreateTemplateDocumentFieldPreferencesParams) String() string

func (*CreateTemplateDocumentFieldPreferencesParams) UnmarshalJSON 

func (c *CreateTemplateDocumentFieldPreferencesParams) UnmarshalJSON(data []byte) error

type CreateTemplateDocumentFieldPreferencesParamsMask 

type CreateTemplateDocumentFieldPreferencesParamsMask struct {
	Integer int
	Boolean bool
	// contains filtered or unexported fields
}

Set `true` to make sensitive data masked on the document.

func (*CreateTemplateDocumentFieldPreferencesParamsMask) Accept 

func (c *CreateTemplateDocumentFieldPreferencesParamsMask) Accept(visitor CreateTemplateDocumentFieldPreferencesParamsMaskVisitor) error

func (*CreateTemplateDocumentFieldPreferencesParamsMask) GetBoolean 

func (c *CreateTemplateDocumentFieldPreferencesParamsMask) GetBoolean() bool

func (*CreateTemplateDocumentFieldPreferencesParamsMask) GetInteger 

func (c *CreateTemplateDocumentFieldPreferencesParamsMask) GetInteger() int

func (CreateTemplateDocumentFieldPreferencesParamsMask) MarshalJSON 

func (c CreateTemplateDocumentFieldPreferencesParamsMask) MarshalJSON() ([]byte, error)

func (*CreateTemplateDocumentFieldPreferencesParamsMask) UnmarshalJSON 

func (c *CreateTemplateDocumentFieldPreferencesParamsMask) UnmarshalJSON(data []byte) error

type CreateTemplateDocumentFieldPreferencesParamsMaskVisitor 

type CreateTemplateDocumentFieldPreferencesParamsMaskVisitor interface {
	VisitInteger(int) error
	VisitBoolean(bool) error
}

type CreateTemplateDocumentFieldValidationParams 

type CreateTemplateDocumentFieldValidationParams struct {
	// HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.
	Pattern string `json:"pattern,omitempty" url:"pattern,omitempty"`
	// A custom error message to display on validation failure.
	Message string `json:"message,omitempty" url:"message,omitempty"`
	// Minimum allowed number value or date depending on field type.
	Min *CreateTemplateDocumentFieldValidationParamsMin `json:"min,omitempty" url:"min,omitempty"`
	// Maximum allowed number value or date depending on field type.
	Max *CreateTemplateDocumentFieldValidationParamsMax `json:"max,omitempty" url:"max,omitempty"`
	// Increment step for number field. Pass 1 to accept only integers, or 0.01 to accept decimal currency.
	Step *float64 `json:"step,omitempty" url:"step,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTemplateDocumentFieldValidationParams) GetExtraProperties 

func (c *CreateTemplateDocumentFieldValidationParams) GetExtraProperties() map[string]interface{}

func (*CreateTemplateDocumentFieldValidationParams) GetMax 

func (c *CreateTemplateDocumentFieldValidationParams) GetMax() *CreateTemplateDocumentFieldValidationParamsMax

func (*CreateTemplateDocumentFieldValidationParams) GetMessage 

func (c *CreateTemplateDocumentFieldValidationParams) GetMessage() string

func (*CreateTemplateDocumentFieldValidationParams) GetMin 

func (c *CreateTemplateDocumentFieldValidationParams) GetMin() *CreateTemplateDocumentFieldValidationParamsMin

func (*CreateTemplateDocumentFieldValidationParams) GetPattern 

func (c *CreateTemplateDocumentFieldValidationParams) GetPattern() string

func (*CreateTemplateDocumentFieldValidationParams) GetStep 

func (c *CreateTemplateDocumentFieldValidationParams) GetStep() *float64

func (*CreateTemplateDocumentFieldValidationParams) MarshalJSON 

func (c *CreateTemplateDocumentFieldValidationParams) MarshalJSON() ([]byte, error)

func (*CreateTemplateDocumentFieldValidationParams) SetMax 

func (c *CreateTemplateDocumentFieldValidationParams) SetMax(max *CreateTemplateDocumentFieldValidationParamsMax)

SetMax sets the Max field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldValidationParams) SetMessage 

func (c *CreateTemplateDocumentFieldValidationParams) SetMessage(message string)

SetMessage sets the Message field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldValidationParams) SetMin 

func (c *CreateTemplateDocumentFieldValidationParams) SetMin(min *CreateTemplateDocumentFieldValidationParamsMin)

SetMin sets the Min field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldValidationParams) SetPattern 

func (c *CreateTemplateDocumentFieldValidationParams) SetPattern(pattern string)

SetPattern sets the Pattern field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldValidationParams) SetStep 

func (c *CreateTemplateDocumentFieldValidationParams) SetStep(step *float64)

SetStep sets the Step field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateDocumentFieldValidationParams) String 

func (c *CreateTemplateDocumentFieldValidationParams) String() string

func (*CreateTemplateDocumentFieldValidationParams) UnmarshalJSON 

func (c *CreateTemplateDocumentFieldValidationParams) UnmarshalJSON(data []byte) error

type CreateTemplateDocumentFieldValidationParamsMax 

type CreateTemplateDocumentFieldValidationParamsMax struct {
	Double float64
	String string
	// contains filtered or unexported fields
}

Maximum allowed number value or date depending on field type.

func (*CreateTemplateDocumentFieldValidationParamsMax) Accept 

func (c *CreateTemplateDocumentFieldValidationParamsMax) Accept(visitor CreateTemplateDocumentFieldValidationParamsMaxVisitor) error

func (*CreateTemplateDocumentFieldValidationParamsMax) GetDouble 

func (c *CreateTemplateDocumentFieldValidationParamsMax) GetDouble() float64

func (*CreateTemplateDocumentFieldValidationParamsMax) GetString 

func (c *CreateTemplateDocumentFieldValidationParamsMax) GetString() string

func (CreateTemplateDocumentFieldValidationParamsMax) MarshalJSON 

func (c CreateTemplateDocumentFieldValidationParamsMax) MarshalJSON() ([]byte, error)

func (*CreateTemplateDocumentFieldValidationParamsMax) UnmarshalJSON 

func (c *CreateTemplateDocumentFieldValidationParamsMax) UnmarshalJSON(data []byte) error

type CreateTemplateDocumentFieldValidationParamsMaxVisitor 

type CreateTemplateDocumentFieldValidationParamsMaxVisitor interface {
	VisitDouble(float64) error
	VisitString(string) error
}

type CreateTemplateDocumentFieldValidationParamsMin 

type CreateTemplateDocumentFieldValidationParamsMin struct {
	Double float64
	String string
	// contains filtered or unexported fields
}

Minimum allowed number value or date depending on field type.

func (*CreateTemplateDocumentFieldValidationParamsMin) Accept 

func (c *CreateTemplateDocumentFieldValidationParamsMin) Accept(visitor CreateTemplateDocumentFieldValidationParamsMinVisitor) error

func (*CreateTemplateDocumentFieldValidationParamsMin) GetDouble 

func (c *CreateTemplateDocumentFieldValidationParamsMin) GetDouble() float64

func (*CreateTemplateDocumentFieldValidationParamsMin) GetString 

func (c *CreateTemplateDocumentFieldValidationParamsMin) GetString() string

func (CreateTemplateDocumentFieldValidationParamsMin) MarshalJSON 

func (c CreateTemplateDocumentFieldValidationParamsMin) MarshalJSON() ([]byte, error)

func (*CreateTemplateDocumentFieldValidationParamsMin) UnmarshalJSON 

func (c *CreateTemplateDocumentFieldValidationParamsMin) UnmarshalJSON(data []byte) error

type CreateTemplateDocumentFieldValidationParamsMinVisitor 

type CreateTemplateDocumentFieldValidationParamsMinVisitor interface {
	VisitDouble(float64) error
	VisitString(string) error
}

type CreateTemplateFromDocxDocumentParams 

type CreateTemplateFromDocxDocumentParams struct {
	// Name of the document.
	Name string `json:"name" url:"name"`
	// Base64-encoded content of the DOCX file or downloadable file URL.
	File string `json:"file" url:"file"`
	// Set to `true` to make the document dynamic. When enabled, the DOCX document content can be edited or use [[variables]] in the template editor.
	Dynamic *bool `json:"dynamic,omitempty" url:"dynamic,omitempty"`
	// Fields are optional if you use {{...}} text tags to define fields in the document.
	Fields []*CreateTemplateDocumentFieldParams `json:"fields,omitempty" url:"fields,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTemplateFromDocxDocumentParams) GetDynamic 

func (c *CreateTemplateFromDocxDocumentParams) GetDynamic() *bool

func (*CreateTemplateFromDocxDocumentParams) GetExtraProperties 

func (c *CreateTemplateFromDocxDocumentParams) GetExtraProperties() map[string]interface{}

func (*CreateTemplateFromDocxDocumentParams) GetFields 

func (c *CreateTemplateFromDocxDocumentParams) GetFields() []*CreateTemplateDocumentFieldParams

func (*CreateTemplateFromDocxDocumentParams) GetFile 

func (c *CreateTemplateFromDocxDocumentParams) GetFile() string

func (*CreateTemplateFromDocxDocumentParams) GetName 

func (c *CreateTemplateFromDocxDocumentParams) GetName() string

func (*CreateTemplateFromDocxDocumentParams) MarshalJSON 

func (c *CreateTemplateFromDocxDocumentParams) MarshalJSON() ([]byte, error)

func (*CreateTemplateFromDocxDocumentParams) SetDynamic 

func (c *CreateTemplateFromDocxDocumentParams) SetDynamic(dynamic *bool)

SetDynamic sets the Dynamic field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromDocxDocumentParams) SetFields 

func (c *CreateTemplateFromDocxDocumentParams) SetFields(fields []*CreateTemplateDocumentFieldParams)

SetFields sets the Fields field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromDocxDocumentParams) SetFile 

func (c *CreateTemplateFromDocxDocumentParams) SetFile(file string)

SetFile sets the File field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromDocxDocumentParams) SetName 

func (c *CreateTemplateFromDocxDocumentParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromDocxDocumentParams) String 

func (c *CreateTemplateFromDocxDocumentParams) String() string

func (*CreateTemplateFromDocxDocumentParams) UnmarshalJSON 

func (c *CreateTemplateFromDocxDocumentParams) UnmarshalJSON(data []byte) error

type CreateTemplateFromDocxParams 

type CreateTemplateFromDocxParams struct {
	// Name of the template.
	Name string `json:"name,omitempty" url:"-"`
	// Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new document.
	ExternalID string `json:"external_id,omitempty" url:"-"`
	// The folder's name in which the template should be created.
	FolderName string `json:"folder_name,omitempty" url:"-"`
	// Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.
	SharedLink *bool `json:"shared_link,omitempty" url:"-"`
	// An array of DOCX documents to create a template.
	Documents []*CreateTemplateFromDocxDocumentParams `json:"documents" url:"-"`
	// contains filtered or unexported fields
}

func (*CreateTemplateFromDocxParams) MarshalJSON 

func (c *CreateTemplateFromDocxParams) MarshalJSON() ([]byte, error)

func (*CreateTemplateFromDocxParams) SetDocuments 

func (c *CreateTemplateFromDocxParams) SetDocuments(documents []*CreateTemplateFromDocxDocumentParams)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromDocxParams) SetExternalID 

func (c *CreateTemplateFromDocxParams) SetExternalID(externalID string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromDocxParams) SetFolderName 

func (c *CreateTemplateFromDocxParams) SetFolderName(folderName string)

SetFolderName sets the FolderName field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromDocxParams) SetName 

func (c *CreateTemplateFromDocxParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization. 

func (c *CreateTemplateFromDocxParams) SetSharedLink(sharedLink *bool)

SetSharedLink sets the SharedLink field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromDocxParams) UnmarshalJSON 

func (c *CreateTemplateFromDocxParams) UnmarshalJSON(data []byte) error

type CreateTemplateFromHtmlDocumentParams 

type CreateTemplateFromHtmlDocumentParams struct {
	// HTML template with field tags.
	Html string `json:"html" url:"html"`
	// Document name. Random uuid will be assigned when not specified.
	Name string `json:"name,omitempty" url:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTemplateFromHtmlDocumentParams) GetExtraProperties 

func (c *CreateTemplateFromHtmlDocumentParams) GetExtraProperties() map[string]interface{}

func (*CreateTemplateFromHtmlDocumentParams) GetHtml 

func (c *CreateTemplateFromHtmlDocumentParams) GetHtml() string

func (*CreateTemplateFromHtmlDocumentParams) GetName 

func (c *CreateTemplateFromHtmlDocumentParams) GetName() string

func (*CreateTemplateFromHtmlDocumentParams) MarshalJSON 

func (c *CreateTemplateFromHtmlDocumentParams) MarshalJSON() ([]byte, error)

func (*CreateTemplateFromHtmlDocumentParams) SetHtml 

func (c *CreateTemplateFromHtmlDocumentParams) SetHtml(html string)

SetHtml sets the Html field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromHtmlDocumentParams) SetName 

func (c *CreateTemplateFromHtmlDocumentParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromHtmlDocumentParams) String 

func (c *CreateTemplateFromHtmlDocumentParams) String() string

func (*CreateTemplateFromHtmlDocumentParams) UnmarshalJSON 

func (c *CreateTemplateFromHtmlDocumentParams) UnmarshalJSON(data []byte) error

type CreateTemplateFromHtmlParams 

type CreateTemplateFromHtmlParams struct {
	// HTML template with field tags.
	Html string `json:"html,omitempty" url:"-"`
	// HTML template of the header to be displayed on every page.
	HtmlHeader string `json:"html_header,omitempty" url:"-"`
	// HTML template of the footer to be displayed on every page.
	HtmlFooter string `json:"html_footer,omitempty" url:"-"`
	// Template name. Random uuid will be assigned when not specified.
	Name string `json:"name,omitempty" url:"-"`
	// Page size. Letter 8.5 x 11 will be assigned when not specified.
	Size PageSize `json:"size,omitempty" url:"-"`
	// Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new HTML.
	ExternalID string `json:"external_id,omitempty" url:"-"`
	// The folder's name in which the template should be created.
	FolderName string `json:"folder_name,omitempty" url:"-"`
	// Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.
	SharedLink *bool `json:"shared_link,omitempty" url:"-"`
	// The list of documents built from HTML. Can be used to create a template with multiple documents. Leave `documents` param empty when using a top-level `html` param for a template with a single document.
	Documents []*CreateTemplateFromHtmlDocumentParams `json:"documents,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*CreateTemplateFromHtmlParams) MarshalJSON 

func (c *CreateTemplateFromHtmlParams) MarshalJSON() ([]byte, error)

func (*CreateTemplateFromHtmlParams) SetDocuments 

func (c *CreateTemplateFromHtmlParams) SetDocuments(documents []*CreateTemplateFromHtmlDocumentParams)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromHtmlParams) SetExternalID 

func (c *CreateTemplateFromHtmlParams) SetExternalID(externalID string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromHtmlParams) SetFolderName 

func (c *CreateTemplateFromHtmlParams) SetFolderName(folderName string)

SetFolderName sets the FolderName field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromHtmlParams) SetHtml 

func (c *CreateTemplateFromHtmlParams) SetHtml(html string)

SetHtml sets the Html field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromHtmlParams) SetHtmlFooter 

func (c *CreateTemplateFromHtmlParams) SetHtmlFooter(htmlFooter string)

SetHtmlFooter sets the HtmlFooter field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromHtmlParams) SetHtmlHeader 

func (c *CreateTemplateFromHtmlParams) SetHtmlHeader(htmlHeader string)

SetHtmlHeader sets the HtmlHeader field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromHtmlParams) SetName 

func (c *CreateTemplateFromHtmlParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization. 

func (c *CreateTemplateFromHtmlParams) SetSharedLink(sharedLink *bool)

SetSharedLink sets the SharedLink field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromHtmlParams) SetSize 

func (c *CreateTemplateFromHtmlParams) SetSize(size PageSize)

SetSize sets the Size field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromHtmlParams) UnmarshalJSON 

func (c *CreateTemplateFromHtmlParams) UnmarshalJSON(data []byte) error

type CreateTemplateFromPdfDocumentParams 

type CreateTemplateFromPdfDocumentParams struct {
	// Name of the document.
	Name string `json:"name" url:"name"`
	// Base64-encoded content of the PDF file or downloadable file URL.
	File string `json:"file" url:"file"`
	// Fields are optional if you use {{...}} text tags to define fields in the document.
	Fields []*CreateTemplateDocumentFieldParams `json:"fields,omitempty" url:"fields,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTemplateFromPdfDocumentParams) GetExtraProperties 

func (c *CreateTemplateFromPdfDocumentParams) GetExtraProperties() map[string]interface{}

func (*CreateTemplateFromPdfDocumentParams) GetFields 

func (c *CreateTemplateFromPdfDocumentParams) GetFields() []*CreateTemplateDocumentFieldParams

func (*CreateTemplateFromPdfDocumentParams) GetFile 

func (c *CreateTemplateFromPdfDocumentParams) GetFile() string

func (*CreateTemplateFromPdfDocumentParams) GetName 

func (c *CreateTemplateFromPdfDocumentParams) GetName() string

func (*CreateTemplateFromPdfDocumentParams) MarshalJSON 

func (c *CreateTemplateFromPdfDocumentParams) MarshalJSON() ([]byte, error)

func (*CreateTemplateFromPdfDocumentParams) SetFields 

func (c *CreateTemplateFromPdfDocumentParams) SetFields(fields []*CreateTemplateDocumentFieldParams)

SetFields sets the Fields field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromPdfDocumentParams) SetFile 

func (c *CreateTemplateFromPdfDocumentParams) SetFile(file string)

SetFile sets the File field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromPdfDocumentParams) SetName 

func (c *CreateTemplateFromPdfDocumentParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromPdfDocumentParams) String 

func (c *CreateTemplateFromPdfDocumentParams) String() string

func (*CreateTemplateFromPdfDocumentParams) UnmarshalJSON 

func (c *CreateTemplateFromPdfDocumentParams) UnmarshalJSON(data []byte) error

type CreateTemplateFromPdfParams 

type CreateTemplateFromPdfParams struct {
	// Name of the template.
	Name string `json:"name,omitempty" url:"-"`
	// The folder's name in which the template should be created.
	FolderName string `json:"folder_name,omitempty" url:"-"`
	// Your application-specific unique string key to identify this template within your app. Existing template with specified `external_id` will be updated with a new PDF.
	ExternalID string `json:"external_id,omitempty" url:"-"`
	// Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.
	SharedLink *bool `json:"shared_link,omitempty" url:"-"`
	// An array of PDF documents to create a template.
	Documents []*CreateTemplateFromPdfDocumentParams `json:"documents" url:"-"`
	// Remove PDF form fields from the documents.
	Flatten *bool `json:"flatten,omitempty" url:"-"`
	// Pass `false` to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.
	RemoveTags *bool `json:"remove_tags,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*CreateTemplateFromPdfParams) MarshalJSON 

func (c *CreateTemplateFromPdfParams) MarshalJSON() ([]byte, error)

func (*CreateTemplateFromPdfParams) SetDocuments 

func (c *CreateTemplateFromPdfParams) SetDocuments(documents []*CreateTemplateFromPdfDocumentParams)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromPdfParams) SetExternalID 

func (c *CreateTemplateFromPdfParams) SetExternalID(externalID string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromPdfParams) SetFlatten 

func (c *CreateTemplateFromPdfParams) SetFlatten(flatten *bool)

SetFlatten sets the Flatten field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromPdfParams) SetFolderName 

func (c *CreateTemplateFromPdfParams) SetFolderName(folderName string)

SetFolderName sets the FolderName field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromPdfParams) SetName 

func (c *CreateTemplateFromPdfParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromPdfParams) SetRemoveTags 

func (c *CreateTemplateFromPdfParams) SetRemoveTags(removeTags *bool)

SetRemoveTags sets the RemoveTags field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization. 

func (c *CreateTemplateFromPdfParams) SetSharedLink(sharedLink *bool)

SetSharedLink sets the SharedLink field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateTemplateFromPdfParams) UnmarshalJSON 

func (c *CreateTemplateFromPdfParams) UnmarshalJSON(data []byte) error

type Currency 

type Currency string
const (
	CurrencyUsd Currency = "USD"
	CurrencyEur Currency = "EUR"
	CurrencyGbp Currency = "GBP"
	CurrencyCad Currency = "CAD"
	CurrencyAud Currency = "AUD"
	CurrencyChf Currency = "CHF"
	CurrencySek Currency = "SEK"
)

func NewCurrencyFromString 

func NewCurrencyFromString(s string) (Currency, error)

func (Currency) Ptr 

func (c Currency) Ptr() *Currency

type DefaultValue 

type DefaultValue struct {
	String               string
	Integer              int
	Double               float64
	Boolean              bool
	DefaultValueItemList []*DefaultValueItem
	// contains filtered or unexported fields
}

Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.

func (*DefaultValue) Accept 

func (d *DefaultValue) Accept(visitor DefaultValueVisitor) error

func (*DefaultValue) GetBoolean 

func (d *DefaultValue) GetBoolean() bool

func (*DefaultValue) GetDefaultValueItemList 

func (d *DefaultValue) GetDefaultValueItemList() []*DefaultValueItem

func (*DefaultValue) GetDouble 

func (d *DefaultValue) GetDouble() float64

func (*DefaultValue) GetInteger 

func (d *DefaultValue) GetInteger() int

func (*DefaultValue) GetString 

func (d *DefaultValue) GetString() string

func (DefaultValue) MarshalJSON 

func (d DefaultValue) MarshalJSON() ([]byte, error)

func (*DefaultValue) UnmarshalJSON 

func (d *DefaultValue) UnmarshalJSON(data []byte) error

type DefaultValueItem 

type DefaultValueItem struct {
	String  string
	Integer int
	Double  float64
	Boolean bool
	// contains filtered or unexported fields
}

func (*DefaultValueItem) Accept 

func (d *DefaultValueItem) Accept(visitor DefaultValueItemVisitor) error

func (*DefaultValueItem) GetBoolean 

func (d *DefaultValueItem) GetBoolean() bool

func (*DefaultValueItem) GetDouble 

func (d *DefaultValueItem) GetDouble() float64

func (*DefaultValueItem) GetInteger 

func (d *DefaultValueItem) GetInteger() int

func (*DefaultValueItem) GetString 

func (d *DefaultValueItem) GetString() string

func (DefaultValueItem) MarshalJSON 

func (d DefaultValueItem) MarshalJSON() ([]byte, error)

func (*DefaultValueItem) UnmarshalJSON 

func (d *DefaultValueItem) UnmarshalJSON(data []byte) error

type DefaultValueItemVisitor 

type DefaultValueItemVisitor interface {
	VisitString(string) error
	VisitInteger(int) error
	VisitDouble(float64) error
	VisitBoolean(bool) error
}

type DefaultValueVisitor 

type DefaultValueVisitor interface {
	VisitString(string) error
	VisitInteger(int) error
	VisitDouble(float64) error
	VisitBoolean(bool) error
	VisitDefaultValueItemList([]*DefaultValueItem) error
}

type Document 

type Document struct {
	// Document name.
	Name string `json:"name" url:"name"`
	// Document URL.
	URL string `json:"url" url:"url"`
	// contains filtered or unexported fields
}

func (*Document) GetExtraProperties 

func (d *Document) GetExtraProperties() map[string]interface{}

func (*Document) GetName 

func (d *Document) GetName() string

func (*Document) GetURL 

func (d *Document) GetURL() string

func (*Document) MarshalJSON 

func (d *Document) MarshalJSON() ([]byte, error)

func (*Document) SetName 

func (d *Document) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Document) SetURL 

func (d *Document) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Document) String 

func (d *Document) String() string

func (*Document) UnmarshalJSON 

func (d *Document) UnmarshalJSON(data []byte) error

type EventType 

type EventType string
const (
	EventTypeFormViewed          EventType = "form.viewed"
	EventTypeFormStarted         EventType = "form.started"
	EventTypeFormCompleted       EventType = "form.completed"
	EventTypeFormDeclined        EventType = "form.declined"
	EventTypeSubmissionCreated   EventType = "submission.created"
	EventTypeSubmissionCompleted EventType = "submission.completed"
	EventTypeSubmissionExpired   EventType = "submission.expired"
	EventTypeSubmissionArchived  EventType = "submission.archived"
	EventTypeTemplateCreated     EventType = "template.created"
	EventTypeTemplateUpdated     EventType = "template.updated"
	EventTypeTemplateArchived    EventType = "template.archived"
)

func NewEventTypeFromString 

func NewEventTypeFromString(s string) (EventType, error)

func (EventType) Ptr 

func (e EventType) Ptr() *EventType

type Field 

type Field struct {
	// Unique identifier of the field.
	UUID string `json:"uuid" url:"uuid"`
	// Unique identifier of the submitter that filled the field.
	SubmitterUUID string `json:"submitter_uuid" url:"submitter_uuid"`
	// Field name.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// Type of the field (e.g., text, signature, date, initials).
	Type FieldType `json:"type" url:"type"`
	// Indicates if the field is required.
	Required    *bool             `json:"required,omitempty" url:"required,omitempty"`
	Preferences *FieldPreferences `json:"preferences,omitempty" url:"preferences,omitempty"`
	// List of areas where the field is located in the document.
	Areas []*FieldArea `json:"areas,omitempty" url:"areas,omitempty"`
	// contains filtered or unexported fields
}

func (*Field) GetAreas 

func (f *Field) GetAreas() []*FieldArea

func (*Field) GetExtraProperties 

func (f *Field) GetExtraProperties() map[string]interface{}

func (*Field) GetName 

func (f *Field) GetName() *string

func (*Field) GetPreferences 

func (f *Field) GetPreferences() *FieldPreferences

func (*Field) GetRequired 

func (f *Field) GetRequired() *bool

func (*Field) GetSubmitterUUID 

func (f *Field) GetSubmitterUUID() string

func (*Field) GetType 

func (f *Field) GetType() FieldType

func (*Field) GetUUID 

func (f *Field) GetUUID() string

func (*Field) MarshalJSON 

func (f *Field) MarshalJSON() ([]byte, error)

func (*Field) SetAreas 

func (f *Field) SetAreas(areas []*FieldArea)

SetAreas sets the Areas field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Field) SetName 

func (f *Field) SetName(name *string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Field) SetPreferences 

func (f *Field) SetPreferences(preferences *FieldPreferences)

SetPreferences sets the Preferences field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Field) SetRequired 

func (f *Field) SetRequired(required *bool)

SetRequired sets the Required field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Field) SetSubmitterUUID 

func (f *Field) SetSubmitterUUID(submitterUUID string)

SetSubmitterUUID sets the SubmitterUUID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Field) SetType 

func (f *Field) SetType(type_ FieldType)

SetType sets the Type field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Field) SetUUID 

func (f *Field) SetUUID(uuid string)

SetUUID sets the UUID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Field) String 

func (f *Field) String() string

func (*Field) UnmarshalJSON 

func (f *Field) UnmarshalJSON(data []byte) error

type FieldAlign 

type FieldAlign string
const (
	FieldAlignLeft   FieldAlign = "left"
	FieldAlignCenter FieldAlign = "center"
	FieldAlignRight  FieldAlign = "right"
)

func NewFieldAlignFromString 

func NewFieldAlignFromString(s string) (FieldAlign, error)

func (FieldAlign) Ptr 

func (f FieldAlign) Ptr() *FieldAlign

type FieldArea 

type FieldArea struct {
	// X coordinate of the area where the field is located in the document.
	X float64 `json:"x" url:"x"`
	// Y coordinate of the area where the field is located in the document.
	Y float64 `json:"y" url:"y"`
	// Width of the area where the field is located in the document.
	W float64 `json:"w" url:"w"`
	// Height of the area where the field is located in the document.
	H float64 `json:"h" url:"h"`
	// Unique identifier of the attached document where the field is located.
	AttachmentUUID string `json:"attachment_uuid" url:"attachment_uuid"`
	// Page number of the attached document where the field is located.
	Page int `json:"page" url:"page"`
	// contains filtered or unexported fields
}

func (*FieldArea) GetAttachmentUUID 

func (f *FieldArea) GetAttachmentUUID() string

func (*FieldArea) GetExtraProperties 

func (f *FieldArea) GetExtraProperties() map[string]interface{}

func (*FieldArea) GetH 

func (f *FieldArea) GetH() float64

func (*FieldArea) GetPage 

func (f *FieldArea) GetPage() int

func (*FieldArea) GetW 

func (f *FieldArea) GetW() float64

func (*FieldArea) GetX 

func (f *FieldArea) GetX() float64

func (*FieldArea) GetY 

func (f *FieldArea) GetY() float64

func (*FieldArea) MarshalJSON 

func (f *FieldArea) MarshalJSON() ([]byte, error)

func (*FieldArea) SetAttachmentUUID 

func (f *FieldArea) SetAttachmentUUID(attachmentUUID string)

SetAttachmentUUID sets the AttachmentUUID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldArea) SetH 

func (f *FieldArea) SetH(h float64)

SetH sets the H field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldArea) SetPage 

func (f *FieldArea) SetPage(page int)

SetPage sets the Page field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldArea) SetW 

func (f *FieldArea) SetW(w float64)

SetW sets the W field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldArea) SetX 

func (f *FieldArea) SetX(x float64)

SetX sets the X field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldArea) SetY 

func (f *FieldArea) SetY(y float64)

SetY sets the Y field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldArea) String 

func (f *FieldArea) String() string

func (*FieldArea) UnmarshalJSON 

func (f *FieldArea) UnmarshalJSON(data []byte) error

type FieldFont 

type FieldFont string
const (
	FieldFontTimes     FieldFont = "Times"
	FieldFontHelvetica FieldFont = "Helvetica"
	FieldFontCourier   FieldFont = "Courier"
)

func NewFieldFontFromString 

func NewFieldFontFromString(s string) (FieldFont, error)

func (FieldFont) Ptr 

func (f FieldFont) Ptr() *FieldFont

type FieldFontType 

type FieldFontType string
const (
	FieldFontTypeBold       FieldFontType = "bold"
	FieldFontTypeItalic     FieldFontType = "italic"
	FieldFontTypeBoldItalic FieldFontType = "bold_italic"
)

func NewFieldFontTypeFromString 

func NewFieldFontTypeFromString(s string) (FieldFontType, error)

func (FieldFontType) Ptr 

func (f FieldFontType) Ptr() *FieldFontType

type FieldPreferences 

type FieldPreferences struct {
	// Font size of the field value in pixels.
	FontSize *int `json:"font_size,omitempty" url:"font_size,omitempty"`
	// Font type of the field value.
	FontType *string `json:"font_type,omitempty" url:"font_type,omitempty"`
	// Font family of the field value.
	Font *string `json:"font,omitempty" url:"font,omitempty"`
	// Font color of the field value.
	Color *string `json:"color,omitempty" url:"color,omitempty"`
	// Field box background color.
	Background *string `json:"background,omitempty" url:"background,omitempty"`
	// Horizontal alignment of the field text value.
	Align *string `json:"align,omitempty" url:"align,omitempty"`
	// Vertical alignment of the field text value.
	Valign *string `json:"valign,omitempty" url:"valign,omitempty"`
	// The data format for different field types.
	Format *string `json:"format,omitempty" url:"format,omitempty"`
	// Price value of the payment field. Only for payment fields.
	Price *float64 `json:"price,omitempty" url:"price,omitempty"`
	// Currency value of the payment field. Only for payment fields.
	Currency *string `json:"currency,omitempty" url:"currency,omitempty"`
	// Indicates if the field is masked on the document.
	Mask *bool `json:"mask,omitempty" url:"mask,omitempty"`
	// An array of signature reasons to choose from.
	Reasons []string `json:"reasons,omitempty" url:"reasons,omitempty"`
	// contains filtered or unexported fields
}

func (*FieldPreferences) GetAlign 

func (f *FieldPreferences) GetAlign() *string

func (*FieldPreferences) GetBackground 

func (f *FieldPreferences) GetBackground() *string

func (*FieldPreferences) GetColor 

func (f *FieldPreferences) GetColor() *string

func (*FieldPreferences) GetCurrency 

func (f *FieldPreferences) GetCurrency() *string

func (*FieldPreferences) GetExtraProperties 

func (f *FieldPreferences) GetExtraProperties() map[string]interface{}

func (*FieldPreferences) GetFont 

func (f *FieldPreferences) GetFont() *string

func (*FieldPreferences) GetFontSize 

func (f *FieldPreferences) GetFontSize() *int

func (*FieldPreferences) GetFontType 

func (f *FieldPreferences) GetFontType() *string

func (*FieldPreferences) GetFormat 

func (f *FieldPreferences) GetFormat() *string

func (*FieldPreferences) GetMask 

func (f *FieldPreferences) GetMask() *bool

func (*FieldPreferences) GetPrice 

func (f *FieldPreferences) GetPrice() *float64

func (*FieldPreferences) GetReasons 

func (f *FieldPreferences) GetReasons() []string

func (*FieldPreferences) GetValign 

func (f *FieldPreferences) GetValign() *string

func (*FieldPreferences) MarshalJSON 

func (f *FieldPreferences) MarshalJSON() ([]byte, error)

func (*FieldPreferences) SetAlign 

func (f *FieldPreferences) SetAlign(align *string)

SetAlign sets the Align field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldPreferences) SetBackground 

func (f *FieldPreferences) SetBackground(background *string)

SetBackground sets the Background field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldPreferences) SetColor 

func (f *FieldPreferences) SetColor(color *string)

SetColor sets the Color field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldPreferences) SetCurrency 

func (f *FieldPreferences) SetCurrency(currency *string)

SetCurrency sets the Currency field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldPreferences) SetFont 

func (f *FieldPreferences) SetFont(font *string)

SetFont sets the Font field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldPreferences) SetFontSize 

func (f *FieldPreferences) SetFontSize(fontSize *int)

SetFontSize sets the FontSize field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldPreferences) SetFontType 

func (f *FieldPreferences) SetFontType(fontType *string)

SetFontType sets the FontType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldPreferences) SetFormat 

func (f *FieldPreferences) SetFormat(format *string)

SetFormat sets the Format field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldPreferences) SetMask 

func (f *FieldPreferences) SetMask(mask *bool)

SetMask sets the Mask field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldPreferences) SetPrice 

func (f *FieldPreferences) SetPrice(price *float64)

SetPrice sets the Price field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldPreferences) SetReasons 

func (f *FieldPreferences) SetReasons(reasons []string)

SetReasons sets the Reasons field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldPreferences) SetValign 

func (f *FieldPreferences) SetValign(valign *string)

SetValign sets the Valign field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldPreferences) String 

func (f *FieldPreferences) String() string

func (*FieldPreferences) UnmarshalJSON 

func (f *FieldPreferences) UnmarshalJSON(data []byte) error

type FieldType 

type FieldType string
const (
	FieldTypeHeading       FieldType = "heading"
	FieldTypeText          FieldType = "text"
	FieldTypeSignature     FieldType = "signature"
	FieldTypeInitials      FieldType = "initials"
	FieldTypeDate          FieldType = "date"
	FieldTypeNumber        FieldType = "number"
	FieldTypeImage         FieldType = "image"
	FieldTypeCheckbox      FieldType = "checkbox"
	FieldTypeMultiple      FieldType = "multiple"
	FieldTypeFile          FieldType = "file"
	FieldTypeRadio         FieldType = "radio"
	FieldTypeSelect        FieldType = "select"
	FieldTypeCells         FieldType = "cells"
	FieldTypeStamp         FieldType = "stamp"
	FieldTypePayment       FieldType = "payment"
	FieldTypePhone         FieldType = "phone"
	FieldTypeVerification  FieldType = "verification"
	FieldTypeKba           FieldType = "kba"
	FieldTypeStrikethrough FieldType = "strikethrough"
)

func NewFieldTypeFromString 

func NewFieldTypeFromString(s string) (FieldType, error)

func (FieldType) Ptr 

func (f FieldType) Ptr() *FieldType

type FieldValign 

type FieldValign string
const (
	FieldValignTop    FieldValign = "top"
	FieldValignCenter FieldValign = "center"
	FieldValignBottom FieldValign = "bottom"
)

func NewFieldValignFromString 

func NewFieldValignFromString(s string) (FieldValign, error)

func (FieldValign) Ptr 

func (f FieldValign) Ptr() *FieldValign

type FieldValue 

type FieldValue struct {
	// Document template field name.
	Field string `json:"field" url:"field"`
	// Pre-filled value of the field.
	Value *FieldValueValue `json:"value,omitempty" url:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*FieldValue) GetExtraProperties 

func (f *FieldValue) GetExtraProperties() map[string]interface{}

func (*FieldValue) GetField 

func (f *FieldValue) GetField() string

func (*FieldValue) GetValue 

func (f *FieldValue) GetValue() *FieldValueValue

func (*FieldValue) MarshalJSON 

func (f *FieldValue) MarshalJSON() ([]byte, error)

func (*FieldValue) SetField 

func (f *FieldValue) SetField(field string)

SetField sets the Field field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldValue) SetValue 

func (f *FieldValue) SetValue(value *FieldValueValue)

SetValue sets the Value field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FieldValue) String 

func (f *FieldValue) String() string

func (*FieldValue) UnmarshalJSON 

func (f *FieldValue) UnmarshalJSON(data []byte) error

type FieldValueValue 

type FieldValueValue struct {
	String                      string
	Integer                     int
	Double                      float64
	Boolean                     bool
	FieldValueValueFourItemList []*FieldValueValueFourItem
	// contains filtered or unexported fields
}

Pre-filled value of the field.

func (*FieldValueValue) Accept 

func (f *FieldValueValue) Accept(visitor FieldValueValueVisitor) error

func (*FieldValueValue) GetBoolean 

func (f *FieldValueValue) GetBoolean() bool

func (*FieldValueValue) GetDouble 

func (f *FieldValueValue) GetDouble() float64

func (*FieldValueValue) GetFieldValueValueFourItemList 

func (f *FieldValueValue) GetFieldValueValueFourItemList() []*FieldValueValueFourItem

func (*FieldValueValue) GetInteger 

func (f *FieldValueValue) GetInteger() int

func (*FieldValueValue) GetString 

func (f *FieldValueValue) GetString() string

func (FieldValueValue) MarshalJSON 

func (f FieldValueValue) MarshalJSON() ([]byte, error)

func (*FieldValueValue) UnmarshalJSON 

func (f *FieldValueValue) UnmarshalJSON(data []byte) error

type FieldValueValueFourItem 

type FieldValueValueFourItem struct {
	String  string
	Integer int
	Double  float64
	Boolean bool
	// contains filtered or unexported fields
}

func (*FieldValueValueFourItem) Accept 

func (f *FieldValueValueFourItem) Accept(visitor FieldValueValueFourItemVisitor) error

func (*FieldValueValueFourItem) GetBoolean 

func (f *FieldValueValueFourItem) GetBoolean() bool

func (*FieldValueValueFourItem) GetDouble 

func (f *FieldValueValueFourItem) GetDouble() float64

func (*FieldValueValueFourItem) GetInteger 

func (f *FieldValueValueFourItem) GetInteger() int

func (*FieldValueValueFourItem) GetString 

func (f *FieldValueValueFourItem) GetString() string

func (FieldValueValueFourItem) MarshalJSON 

func (f FieldValueValueFourItem) MarshalJSON() ([]byte, error)

func (*FieldValueValueFourItem) UnmarshalJSON 

func (f *FieldValueValueFourItem) UnmarshalJSON(data []byte) error

type FieldValueValueFourItemVisitor 

type FieldValueValueFourItemVisitor interface {
	VisitString(string) error
	VisitInteger(int) error
	VisitDouble(float64) error
	VisitBoolean(bool) error
}

type FieldValueValueVisitor 

type FieldValueValueVisitor interface {
	VisitString(string) error
	VisitInteger(int) error
	VisitDouble(float64) error
	VisitBoolean(bool) error
	VisitFieldValueValueFourItemList([]*FieldValueValueFourItem) error
}

type FileParam 

type FileParam struct {
	io.Reader
	// contains filtered or unexported fields
}

FileParam is a file type suitable for multipart/form-data uploads.

func NewFileParam 

func NewFileParam(
	reader io.Reader,
	filename string,
	contentType string,
	opts ...FileParamOption,
) *FileParam

NewFileParam returns a *FileParam type suitable for multipart/form-data uploads. All file upload endpoints accept a simple io.Reader, which is usually created by opening a file via os.Open.

However, some endpoints require additional metadata about the file such as a specific Content-Type or custom filename. FileParam makes it easier to create the correct type signature for these endpoints.

func (*FileParam) ContentType 

func (f *FileParam) ContentType() string

func (*FileParam) Name 

func (f *FileParam) Name() string

type FileParamOption 

type FileParamOption interface {
	// contains filtered or unexported methods
}

FileParamOption adapts the behavior of the FileParam. No options are implemented yet, but this interface allows for future extensibility.

type FormCompletedEvent 

type FormCompletedEvent struct {
	// The event type.
	EventType EventType `json:"event_type" url:"event_type"`
	// The event timestamp.
	Timestamp time.Time `json:"timestamp" url:"timestamp"`
	Data      *FormData `json:"data" url:"data"`
	// contains filtered or unexported fields
}

func (*FormCompletedEvent) GetData 

func (f *FormCompletedEvent) GetData() *FormData

func (*FormCompletedEvent) GetEventType 

func (f *FormCompletedEvent) GetEventType() EventType

func (*FormCompletedEvent) GetExtraProperties 

func (f *FormCompletedEvent) GetExtraProperties() map[string]interface{}

func (*FormCompletedEvent) GetTimestamp 

func (f *FormCompletedEvent) GetTimestamp() time.Time

func (*FormCompletedEvent) MarshalJSON 

func (f *FormCompletedEvent) MarshalJSON() ([]byte, error)

func (*FormCompletedEvent) SetData 

func (f *FormCompletedEvent) SetData(data *FormData)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormCompletedEvent) SetEventType 

func (f *FormCompletedEvent) SetEventType(eventType EventType)

SetEventType sets the EventType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormCompletedEvent) SetTimestamp 

func (f *FormCompletedEvent) SetTimestamp(timestamp time.Time)

SetTimestamp sets the Timestamp field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormCompletedEvent) String 

func (f *FormCompletedEvent) String() string

func (*FormCompletedEvent) UnmarshalJSON 

func (f *FormCompletedEvent) UnmarshalJSON(data []byte) error

type FormData 

type FormData struct {
	// The submitter's unique identifier.
	ID int `json:"id" url:"id"`
	// The unique submission identifier.
	SubmissionID int `json:"submission_id" url:"submission_id"`
	// The submitter's email address.
	Email *string `json:"email,omitempty" url:"email,omitempty"`
	// The submitter's phone number, formatted according to the E.164 standard.
	Phone *string `json:"phone,omitempty" url:"phone,omitempty"`
	// The submitter's name.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// The user agent string that provides information about the submitter's web browser.
	Ua *string `json:"ua,omitempty" url:"ua,omitempty"`
	// The submitter's IP address.
	IP *string `json:"ip,omitempty" url:"ip,omitempty"`
	// The date and time when the signing request was sent to the submitter.
	SentAt *string `json:"sent_at,omitempty" url:"sent_at,omitempty"`
	// The date and time when the submitter opened the signing form.
	OpenedAt *string `json:"opened_at,omitempty" url:"opened_at,omitempty"`
	// The date and time when the submitter completed the signing form.
	CompletedAt *string `json:"completed_at,omitempty" url:"completed_at,omitempty"`
	// The date and time when the submitter declined the signing form.
	DeclinedAt *string `json:"declined_at,omitempty" url:"declined_at,omitempty"`
	// The reason provided by the submitter for declining the signing form.
	DeclineReason *string `json:"decline_reason,omitempty" url:"decline_reason,omitempty"`
	// The date and time when the submitter was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// The date and time when the submitter was last updated.
	UpdatedAt string `json:"updated_at" url:"updated_at"`
	// Your application-specific unique string key to identify the submitter.
	ExternalID *string         `json:"external_id,omitempty" url:"external_id,omitempty"`
	Status     SubmitterStatus `json:"status" url:"status"`
	// The role name of the submitter.
	Role string `json:"role" url:"role"`
	// Metadata object with additional submitter information.
	Metadata map[string]any `json:"metadata,omitempty" url:"metadata,omitempty"`
	// Submitter preferences.
	Preferences map[string]any `json:"preferences" url:"preferences"`
	// An array of the filled values submitted by the submitter.
	Values []*FieldValue `json:"values" url:"values"`
	// An array of the completed documents.
	Documents []*Document `json:"documents" url:"documents"`
	// Audit log file URL.
	AuditLogURL *string `json:"audit_log_url,omitempty" url:"audit_log_url,omitempty"`
	// The submission URL.
	SubmissionURL string           `json:"submission_url" url:"submission_url"`
	Template      *TemplateSummary `json:"template" url:"template"`
	Submission    *FormSubmission  `json:"submission" url:"submission"`
	// contains filtered or unexported fields
}

func (*FormData) GetAuditLogURL 

func (f *FormData) GetAuditLogURL() *string

func (*FormData) GetCompletedAt 

func (f *FormData) GetCompletedAt() *string

func (*FormData) GetCreatedAt 

func (f *FormData) GetCreatedAt() string

func (*FormData) GetDeclineReason 

func (f *FormData) GetDeclineReason() *string

func (*FormData) GetDeclinedAt 

func (f *FormData) GetDeclinedAt() *string

func (*FormData) GetDocuments 

func (f *FormData) GetDocuments() []*Document

func (*FormData) GetEmail 

func (f *FormData) GetEmail() *string

func (*FormData) GetExternalID 

func (f *FormData) GetExternalID() *string

func (*FormData) GetExtraProperties 

func (f *FormData) GetExtraProperties() map[string]interface{}

func (*FormData) GetID 

func (f *FormData) GetID() int

func (*FormData) GetIP 

func (f *FormData) GetIP() *string

func (*FormData) GetMetadata 

func (f *FormData) GetMetadata() map[string]any

func (*FormData) GetName 

func (f *FormData) GetName() *string

func (*FormData) GetOpenedAt 

func (f *FormData) GetOpenedAt() *string

func (*FormData) GetPhone 

func (f *FormData) GetPhone() *string

func (*FormData) GetPreferences 

func (f *FormData) GetPreferences() map[string]any

func (*FormData) GetRole 

func (f *FormData) GetRole() string

func (*FormData) GetSentAt 

func (f *FormData) GetSentAt() *string

func (*FormData) GetStatus 

func (f *FormData) GetStatus() SubmitterStatus

func (*FormData) GetSubmission 

func (f *FormData) GetSubmission() *FormSubmission

func (*FormData) GetSubmissionID 

func (f *FormData) GetSubmissionID() int

func (*FormData) GetSubmissionURL 

func (f *FormData) GetSubmissionURL() string

func (*FormData) GetTemplate 

func (f *FormData) GetTemplate() *TemplateSummary

func (*FormData) GetUa 

func (f *FormData) GetUa() *string

func (*FormData) GetUpdatedAt 

func (f *FormData) GetUpdatedAt() string

func (*FormData) GetValues 

func (f *FormData) GetValues() []*FieldValue

func (*FormData) MarshalJSON 

func (f *FormData) MarshalJSON() ([]byte, error)

func (*FormData) SetAuditLogURL 

func (f *FormData) SetAuditLogURL(auditLogURL *string)

SetAuditLogURL sets the AuditLogURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetCompletedAt 

func (f *FormData) SetCompletedAt(completedAt *string)

SetCompletedAt sets the CompletedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetCreatedAt 

func (f *FormData) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetDeclineReason 

func (f *FormData) SetDeclineReason(declineReason *string)

SetDeclineReason sets the DeclineReason field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetDeclinedAt 

func (f *FormData) SetDeclinedAt(declinedAt *string)

SetDeclinedAt sets the DeclinedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetDocuments 

func (f *FormData) SetDocuments(documents []*Document)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetEmail 

func (f *FormData) SetEmail(email *string)

SetEmail sets the Email field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetExternalID 

func (f *FormData) SetExternalID(externalID *string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetID 

func (f *FormData) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetIP 

func (f *FormData) SetIP(ip *string)

SetIP sets the IP field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetMetadata 

func (f *FormData) SetMetadata(metadata map[string]any)

SetMetadata sets the Metadata field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetName 

func (f *FormData) SetName(name *string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetOpenedAt 

func (f *FormData) SetOpenedAt(openedAt *string)

SetOpenedAt sets the OpenedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetPhone 

func (f *FormData) SetPhone(phone *string)

SetPhone sets the Phone field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetPreferences 

func (f *FormData) SetPreferences(preferences map[string]any)

SetPreferences sets the Preferences field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetRole 

func (f *FormData) SetRole(role string)

SetRole sets the Role field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetSentAt 

func (f *FormData) SetSentAt(sentAt *string)

SetSentAt sets the SentAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetStatus 

func (f *FormData) SetStatus(status SubmitterStatus)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetSubmission 

func (f *FormData) SetSubmission(submission *FormSubmission)

SetSubmission sets the Submission field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetSubmissionID 

func (f *FormData) SetSubmissionID(submissionID int)

SetSubmissionID sets the SubmissionID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetSubmissionURL 

func (f *FormData) SetSubmissionURL(submissionURL string)

SetSubmissionURL sets the SubmissionURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetTemplate 

func (f *FormData) SetTemplate(template *TemplateSummary)

SetTemplate sets the Template field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetUa 

func (f *FormData) SetUa(ua *string)

SetUa sets the Ua field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetUpdatedAt 

func (f *FormData) SetUpdatedAt(updatedAt string)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) SetValues 

func (f *FormData) SetValues(values []*FieldValue)

SetValues sets the Values field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormData) String 

func (f *FormData) String() string

func (*FormData) UnmarshalJSON 

func (f *FormData) UnmarshalJSON(data []byte) error

type FormDeclinedEvent 

type FormDeclinedEvent struct {
	// The event type.
	EventType EventType `json:"event_type" url:"event_type"`
	// The event timestamp.
	Timestamp time.Time `json:"timestamp" url:"timestamp"`
	Data      *FormData `json:"data" url:"data"`
	// contains filtered or unexported fields
}

func (*FormDeclinedEvent) GetData 

func (f *FormDeclinedEvent) GetData() *FormData

func (*FormDeclinedEvent) GetEventType 

func (f *FormDeclinedEvent) GetEventType() EventType

func (*FormDeclinedEvent) GetExtraProperties 

func (f *FormDeclinedEvent) GetExtraProperties() map[string]interface{}

func (*FormDeclinedEvent) GetTimestamp 

func (f *FormDeclinedEvent) GetTimestamp() time.Time

func (*FormDeclinedEvent) MarshalJSON 

func (f *FormDeclinedEvent) MarshalJSON() ([]byte, error)

func (*FormDeclinedEvent) SetData 

func (f *FormDeclinedEvent) SetData(data *FormData)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormDeclinedEvent) SetEventType 

func (f *FormDeclinedEvent) SetEventType(eventType EventType)

SetEventType sets the EventType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormDeclinedEvent) SetTimestamp 

func (f *FormDeclinedEvent) SetTimestamp(timestamp time.Time)

SetTimestamp sets the Timestamp field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormDeclinedEvent) String 

func (f *FormDeclinedEvent) String() string

func (*FormDeclinedEvent) UnmarshalJSON 

func (f *FormDeclinedEvent) UnmarshalJSON(data []byte) error

type FormStartedEvent 

type FormStartedEvent struct {
	// The event type.
	EventType EventType `json:"event_type" url:"event_type"`
	// The event timestamp.
	Timestamp time.Time `json:"timestamp" url:"timestamp"`
	Data      *FormData `json:"data" url:"data"`
	// contains filtered or unexported fields
}

func (*FormStartedEvent) GetData 

func (f *FormStartedEvent) GetData() *FormData

func (*FormStartedEvent) GetEventType 

func (f *FormStartedEvent) GetEventType() EventType

func (*FormStartedEvent) GetExtraProperties 

func (f *FormStartedEvent) GetExtraProperties() map[string]interface{}

func (*FormStartedEvent) GetTimestamp 

func (f *FormStartedEvent) GetTimestamp() time.Time

func (*FormStartedEvent) MarshalJSON 

func (f *FormStartedEvent) MarshalJSON() ([]byte, error)

func (*FormStartedEvent) SetData 

func (f *FormStartedEvent) SetData(data *FormData)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormStartedEvent) SetEventType 

func (f *FormStartedEvent) SetEventType(eventType EventType)

SetEventType sets the EventType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormStartedEvent) SetTimestamp 

func (f *FormStartedEvent) SetTimestamp(timestamp time.Time)

SetTimestamp sets the Timestamp field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormStartedEvent) String 

func (f *FormStartedEvent) String() string

func (*FormStartedEvent) UnmarshalJSON 

func (f *FormStartedEvent) UnmarshalJSON(data []byte) error

type FormSubmission 

type FormSubmission struct {
	// The submission unique identifier.
	ID int `json:"id" url:"id"`
	// Audit log file URL.
	AuditLogURL *string `json:"audit_log_url,omitempty" url:"audit_log_url,omitempty"`
	// Combined PDF file URL with documents and Audit Log.
	CombinedDocumentURL *string          `json:"combined_document_url,omitempty" url:"combined_document_url,omitempty"`
	Status              SubmissionStatus `json:"status" url:"status"`
	// The submission URL.
	URL string `json:"url" url:"url"`
	// Dynamic document content variables of the submission.
	Variables map[string]any `json:"variables,omitempty" url:"variables,omitempty"`
	// The date and time when the submission was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// contains filtered or unexported fields
}

func (*FormSubmission) GetAuditLogURL 

func (f *FormSubmission) GetAuditLogURL() *string

func (*FormSubmission) GetCombinedDocumentURL 

func (f *FormSubmission) GetCombinedDocumentURL() *string

func (*FormSubmission) GetCreatedAt 

func (f *FormSubmission) GetCreatedAt() string

func (*FormSubmission) GetExtraProperties 

func (f *FormSubmission) GetExtraProperties() map[string]interface{}

func (*FormSubmission) GetID 

func (f *FormSubmission) GetID() int

func (*FormSubmission) GetStatus 

func (f *FormSubmission) GetStatus() SubmissionStatus

func (*FormSubmission) GetURL 

func (f *FormSubmission) GetURL() string

func (*FormSubmission) GetVariables 

func (f *FormSubmission) GetVariables() map[string]any

func (*FormSubmission) MarshalJSON 

func (f *FormSubmission) MarshalJSON() ([]byte, error)

func (*FormSubmission) SetAuditLogURL 

func (f *FormSubmission) SetAuditLogURL(auditLogURL *string)

SetAuditLogURL sets the AuditLogURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormSubmission) SetCombinedDocumentURL 

func (f *FormSubmission) SetCombinedDocumentURL(combinedDocumentURL *string)

SetCombinedDocumentURL sets the CombinedDocumentURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormSubmission) SetCreatedAt 

func (f *FormSubmission) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormSubmission) SetID 

func (f *FormSubmission) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormSubmission) SetStatus 

func (f *FormSubmission) SetStatus(status SubmissionStatus)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormSubmission) SetURL 

func (f *FormSubmission) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormSubmission) SetVariables 

func (f *FormSubmission) SetVariables(variables map[string]any)

SetVariables sets the Variables field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormSubmission) String 

func (f *FormSubmission) String() string

func (*FormSubmission) UnmarshalJSON 

func (f *FormSubmission) UnmarshalJSON(data []byte) error

type FormViewedEvent 

type FormViewedEvent struct {
	// The event type.
	EventType EventType `json:"event_type" url:"event_type"`
	// The event timestamp.
	Timestamp time.Time `json:"timestamp" url:"timestamp"`
	Data      *FormData `json:"data" url:"data"`
	// contains filtered or unexported fields
}

func (*FormViewedEvent) GetData 

func (f *FormViewedEvent) GetData() *FormData

func (*FormViewedEvent) GetEventType 

func (f *FormViewedEvent) GetEventType() EventType

func (*FormViewedEvent) GetExtraProperties 

func (f *FormViewedEvent) GetExtraProperties() map[string]interface{}

func (*FormViewedEvent) GetTimestamp 

func (f *FormViewedEvent) GetTimestamp() time.Time

func (*FormViewedEvent) MarshalJSON 

func (f *FormViewedEvent) MarshalJSON() ([]byte, error)

func (*FormViewedEvent) SetData 

func (f *FormViewedEvent) SetData(data *FormData)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormViewedEvent) SetEventType 

func (f *FormViewedEvent) SetEventType(eventType EventType)

SetEventType sets the EventType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormViewedEvent) SetTimestamp 

func (f *FormViewedEvent) SetTimestamp(timestamp time.Time)

SetTimestamp sets the Timestamp field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*FormViewedEvent) String 

func (f *FormViewedEvent) String() string

func (*FormViewedEvent) UnmarshalJSON 

func (f *FormViewedEvent) UnmarshalJSON(data []byte) error

type GetSubmissionDocumentsParams 

type GetSubmissionDocumentsParams struct {
	// When `true`, merges all documents into a single PDF.
	Merge *bool `json:"-" url:"merge,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSubmissionDocumentsParams) SetMerge 

func (g *GetSubmissionDocumentsParams) SetMerge(merge *bool)

SetMerge sets the Merge field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

type GetSubmissionsParams 

type GetSubmissionsParams struct {
	// The template ID allows you to receive only the submissions created from that specific template.
	TemplateID *int `json:"-" url:"template_id,omitempty"`
	// Filter submissions by status.
	Status SubmissionStatus `json:"-" url:"status,omitempty"`
	// Filter submissions based on submitter's name, email or phone partial match.
	Q string `json:"-" url:"q,omitempty"`
	// Filter submissions by unique slug.
	Slug string `json:"-" url:"slug,omitempty"`
	// Filter submissions by template folder name.
	TemplateFolder string `json:"-" url:"template_folder,omitempty"`
	// Returns only archived submissions when `true` and only active submissions when `false`.
	Archived *bool `json:"-" url:"archived,omitempty"`
	// The number of submissions to return. Default value is 10. Maximum value is 100.
	Limit *int `json:"-" url:"limit,omitempty"`
	// The unique identifier of the submission to start the list from. It allows you to receive only submissions with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submissions.
	After *int `json:"-" url:"after,omitempty"`
	// The unique identifier of the submission that marks the end of the list. It allows you to receive only submissions with an ID less than the specified value.
	Before *int `json:"-" url:"before,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSubmissionsParams) SetAfter 

func (g *GetSubmissionsParams) SetAfter(after *int)

SetAfter sets the After field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmissionsParams) SetArchived 

func (g *GetSubmissionsParams) SetArchived(archived *bool)

SetArchived sets the Archived field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmissionsParams) SetBefore 

func (g *GetSubmissionsParams) SetBefore(before *int)

SetBefore sets the Before field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmissionsParams) SetLimit 

func (g *GetSubmissionsParams) SetLimit(limit *int)

SetLimit sets the Limit field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmissionsParams) SetQ 

func (g *GetSubmissionsParams) SetQ(q string)

SetQ sets the Q field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmissionsParams) SetSlug 

func (g *GetSubmissionsParams) SetSlug(slug string)

SetSlug sets the Slug field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmissionsParams) SetStatus 

func (g *GetSubmissionsParams) SetStatus(status SubmissionStatus)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmissionsParams) SetTemplateFolder 

func (g *GetSubmissionsParams) SetTemplateFolder(templateFolder string)

SetTemplateFolder sets the TemplateFolder field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmissionsParams) SetTemplateID 

func (g *GetSubmissionsParams) SetTemplateID(templateID *int)

SetTemplateID sets the TemplateID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

type GetSubmittersParams 

type GetSubmittersParams struct {
	// The submission ID allows you to receive only the submitters related to that specific submission.
	SubmissionID *int `json:"-" url:"submission_id,omitempty"`
	// Filter submitters on name, email or phone partial match.
	Q string `json:"-" url:"q,omitempty"`
	// Filter submitters by unique slug.
	Slug string `json:"-" url:"slug,omitempty"`
	// The date and time string value to filter submitters that completed the submission after the specified date and time.
	CompletedAfter *time.Time `json:"-" url:"completed_after,omitempty"`
	// The date and time string value to filter submitters that completed the submission before the specified date and time.
	CompletedBefore *time.Time `json:"-" url:"completed_before,omitempty"`
	// The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID.
	ExternalID string `json:"-" url:"external_id,omitempty"`
	// The number of submitters to return. Default value is 10. Maximum value is 100.
	Limit *int `json:"-" url:"limit,omitempty"`
	// The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters.
	After *int `json:"-" url:"after,omitempty"`
	// The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value.
	Before *int `json:"-" url:"before,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSubmittersParams) SetAfter 

func (g *GetSubmittersParams) SetAfter(after *int)

SetAfter sets the After field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmittersParams) SetBefore 

func (g *GetSubmittersParams) SetBefore(before *int)

SetBefore sets the Before field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmittersParams) SetCompletedAfter 

func (g *GetSubmittersParams) SetCompletedAfter(completedAfter *time.Time)

SetCompletedAfter sets the CompletedAfter field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmittersParams) SetCompletedBefore 

func (g *GetSubmittersParams) SetCompletedBefore(completedBefore *time.Time)

SetCompletedBefore sets the CompletedBefore field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmittersParams) SetExternalID 

func (g *GetSubmittersParams) SetExternalID(externalID string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmittersParams) SetLimit 

func (g *GetSubmittersParams) SetLimit(limit *int)

SetLimit sets the Limit field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmittersParams) SetQ 

func (g *GetSubmittersParams) SetQ(q string)

SetQ sets the Q field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmittersParams) SetSlug 

func (g *GetSubmittersParams) SetSlug(slug string)

SetSlug sets the Slug field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetSubmittersParams) SetSubmissionID 

func (g *GetSubmittersParams) SetSubmissionID(submissionID *int)

SetSubmissionID sets the SubmissionID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

type GetTemplatesParams 

type GetTemplatesParams struct {
	// Filter templates based on the name partial match.
	Q string `json:"-" url:"q,omitempty"`
	// Filter templates by unique slug.
	Slug string `json:"-" url:"slug,omitempty"`
	// The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID.
	ExternalID string `json:"-" url:"external_id,omitempty"`
	// Filter templates by folder name.
	Folder string `json:"-" url:"folder,omitempty"`
	// List only archived templates instead of active ones.
	Archived *bool `json:"-" url:"archived,omitempty"`
	// List templates shared with test mode.
	Shared *bool `json:"-" url:"shared,omitempty"`
	// The number of templates to return. Default value is 10. Maximum value is 100.
	Limit *int `json:"-" url:"limit,omitempty"`
	// The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates.
	After *int `json:"-" url:"after,omitempty"`
	// The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value.
	Before *int `json:"-" url:"before,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTemplatesParams) SetAfter 

func (g *GetTemplatesParams) SetAfter(after *int)

SetAfter sets the After field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetTemplatesParams) SetArchived 

func (g *GetTemplatesParams) SetArchived(archived *bool)

SetArchived sets the Archived field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetTemplatesParams) SetBefore 

func (g *GetTemplatesParams) SetBefore(before *int)

SetBefore sets the Before field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetTemplatesParams) SetExternalID 

func (g *GetTemplatesParams) SetExternalID(externalID string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetTemplatesParams) SetFolder 

func (g *GetTemplatesParams) SetFolder(folder string)

SetFolder sets the Folder field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetTemplatesParams) SetLimit 

func (g *GetTemplatesParams) SetLimit(limit *int)

SetLimit sets the Limit field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetTemplatesParams) SetQ 

func (g *GetTemplatesParams) SetQ(q string)

SetQ sets the Q field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetTemplatesParams) SetShared 

func (g *GetTemplatesParams) SetShared(shared *bool)

SetShared sets the Shared field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetTemplatesParams) SetSlug 

func (g *GetTemplatesParams) SetSlug(slug string)

SetSlug sets the Slug field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

type MergeTemplateParams 

type MergeTemplateParams struct {
	// An array of template ids to merge into a new template.
	TemplateIDs []int `json:"template_ids" url:"-"`
	// Template name. Existing name with (Merged) suffix will be used if not specified.
	Name string `json:"name,omitempty" url:"-"`
	// The name of the folder in which the merged template should be placed.
	FolderName string `json:"folder_name,omitempty" url:"-"`
	// Your application-specific unique string key to identify this template within your app.
	ExternalID string `json:"external_id,omitempty" url:"-"`
	// Set to `true` to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.
	SharedLink *bool `json:"shared_link,omitempty" url:"-"`
	// An array of submitter role names to be used in the merged template.
	Roles []string `json:"roles,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*MergeTemplateParams) MarshalJSON 

func (m *MergeTemplateParams) MarshalJSON() ([]byte, error)

func (*MergeTemplateParams) SetExternalID 

func (m *MergeTemplateParams) SetExternalID(externalID string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MergeTemplateParams) SetFolderName 

func (m *MergeTemplateParams) SetFolderName(folderName string)

SetFolderName sets the FolderName field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MergeTemplateParams) SetName 

func (m *MergeTemplateParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MergeTemplateParams) SetRoles 

func (m *MergeTemplateParams) SetRoles(roles []string)

SetRoles sets the Roles field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization. 

func (m *MergeTemplateParams) SetSharedLink(sharedLink *bool)

SetSharedLink sets the SharedLink field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MergeTemplateParams) SetTemplateIDs 

func (m *MergeTemplateParams) SetTemplateIDs(templateIDs []int)

SetTemplateIDs sets the TemplateIDs field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MergeTemplateParams) UnmarshalJSON 

func (m *MergeTemplateParams) UnmarshalJSON(data []byte) error

type PageSize 

type PageSize string
const (
	PageSizeLetter  PageSize = "Letter"
	PageSizeLegal   PageSize = "Legal"
	PageSizeTabloid PageSize = "Tabloid"
	PageSizeLedger  PageSize = "Ledger"
	PageSizeA0      PageSize = "A0"
	PageSizeA1      PageSize = "A1"
	PageSizeA2      PageSize = "A2"
	PageSizeA3      PageSize = "A3"
	PageSizeA4      PageSize = "A4"
	PageSizeA5      PageSize = "A5"
	PageSizeA6      PageSize = "A6"
)

func NewPageSizeFromString 

func NewPageSizeFromString(s string) (PageSize, error)

func (PageSize) Ptr 

func (p PageSize) Ptr() *PageSize

type Pagination 

type Pagination struct {
	// Items count.
	Count int `json:"count" url:"count"`
	// The ID of the item after which the next page starts.
	Next *int `json:"next,omitempty" url:"next,omitempty"`
	// The ID of the item before which the previous page ends.
	Prev *int `json:"prev,omitempty" url:"prev,omitempty"`
	// contains filtered or unexported fields
}

func (*Pagination) GetCount 

func (p *Pagination) GetCount() int

func (*Pagination) GetExtraProperties 

func (p *Pagination) GetExtraProperties() map[string]interface{}

func (*Pagination) GetNext 

func (p *Pagination) GetNext() *int

func (*Pagination) GetPrev 

func (p *Pagination) GetPrev() *int

func (*Pagination) MarshalJSON 

func (p *Pagination) MarshalJSON() ([]byte, error)

func (*Pagination) SetCount 

func (p *Pagination) SetCount(count int)

SetCount sets the Count field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Pagination) SetNext 

func (p *Pagination) SetNext(next *int)

SetNext sets the Next field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Pagination) SetPrev 

func (p *Pagination) SetPrev(prev *int)

SetPrev sets the Prev field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Pagination) String 

func (p *Pagination) String() string

func (*Pagination) UnmarshalJSON 

func (p *Pagination) UnmarshalJSON(data []byte) error

type RawClient 

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

func NewRawClient 

func NewRawClient(options *core.RequestOptions) *RawClient

func (*RawClient) ArchiveSubmission 

func (r *RawClient) ArchiveSubmission(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*core.Response[*SubmissionArchiveResult], error)

func (*RawClient) ArchiveTemplate 

func (r *RawClient) ArchiveTemplate(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*core.Response[*TemplateArchiveResult], error)

func (*RawClient) CloneTemplate 

func (r *RawClient) CloneTemplate(
	ctx context.Context,

	id int,
	request *CloneTemplateParams,
	opts ...RequestOption,
) (*core.Response[*Template], error)

func (*RawClient) CreateSubmission 

func (r *RawClient) CreateSubmission(
	ctx context.Context,
	request *CreateSubmissionParams,
	opts ...RequestOption,
) (*core.Response[*SubmissionCreateResult], error)

func (*RawClient) CreateSubmissionFromDocx 

func (r *RawClient) CreateSubmissionFromDocx(
	ctx context.Context,
	request *CreateSubmissionFromDocxParams,
	opts ...RequestOption,
) (*core.Response[*SubmissionCreateOneoffResult], error)

func (*RawClient) CreateSubmissionFromHtml 

func (r *RawClient) CreateSubmissionFromHtml(
	ctx context.Context,
	request *CreateSubmissionFromHtmlParams,
	opts ...RequestOption,
) (*core.Response[*SubmissionCreateOneoffResult], error)

func (*RawClient) CreateSubmissionFromPdf 

func (r *RawClient) CreateSubmissionFromPdf(
	ctx context.Context,
	request *CreateSubmissionFromPdfParams,
	opts ...RequestOption,
) (*core.Response[*SubmissionCreateOneoffResult], error)

func (*RawClient) CreateTemplateFromDocx 

func (r *RawClient) CreateTemplateFromDocx(
	ctx context.Context,
	request *CreateTemplateFromDocxParams,
	opts ...RequestOption,
) (*core.Response[*Template], error)

func (*RawClient) CreateTemplateFromHtml 

func (r *RawClient) CreateTemplateFromHtml(
	ctx context.Context,
	request *CreateTemplateFromHtmlParams,
	opts ...RequestOption,
) (*core.Response[*Template], error)

func (*RawClient) CreateTemplateFromPdf 

func (r *RawClient) CreateTemplateFromPdf(
	ctx context.Context,
	request *CreateTemplateFromPdfParams,
	opts ...RequestOption,
) (*core.Response[*Template], error)

func (*RawClient) GetSubmission 

func (r *RawClient) GetSubmission(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*core.Response[*Submission], error)

func (*RawClient) GetSubmissionDocuments 

func (r *RawClient) GetSubmissionDocuments(
	ctx context.Context,

	id int,
	request *GetSubmissionDocumentsParams,
	opts ...RequestOption,
) (*core.Response[*SubmissionDocuments], error)

func (*RawClient) GetSubmissions 

func (r *RawClient) GetSubmissions(
	ctx context.Context,
	request *GetSubmissionsParams,
	opts ...RequestOption,
) (*core.Response[*SubmissionList], error)

func (*RawClient) GetSubmitter 

func (r *RawClient) GetSubmitter(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*core.Response[*Submitter], error)

func (*RawClient) GetSubmitters 

func (r *RawClient) GetSubmitters(
	ctx context.Context,
	request *GetSubmittersParams,
	opts ...RequestOption,
) (*core.Response[*SubmitterList], error)

func (*RawClient) GetTemplate 

func (r *RawClient) GetTemplate(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*core.Response[*Template], error)

func (*RawClient) GetTemplates 

func (r *RawClient) GetTemplates(
	ctx context.Context,
	request *GetTemplatesParams,
	opts ...RequestOption,
) (*core.Response[*TemplateList], error)

func (*RawClient) MergeTemplate 

func (r *RawClient) MergeTemplate(
	ctx context.Context,
	request *MergeTemplateParams,
	opts ...RequestOption,
) (*core.Response[*Template], error)

func (*RawClient) PermanentlyDeleteSubmission 

func (r *RawClient) PermanentlyDeleteSubmission(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*core.Response[*SubmissionPermanentlyDeleteResult], error)

func (*RawClient) PermanentlyDeleteTemplate 

func (r *RawClient) PermanentlyDeleteTemplate(
	ctx context.Context,

	id int,
	opts ...RequestOption,
) (*core.Response[*TemplatePermanentlyDeleteResult], error)

func (*RawClient) UpdateSubmission 

func (r *RawClient) UpdateSubmission(
	ctx context.Context,

	id int,
	request *UpdateSubmissionParams,
	opts ...RequestOption,
) (*core.Response[*SubmissionUpdateResult], error)

func (*RawClient) UpdateSubmitter 

func (r *RawClient) UpdateSubmitter(
	ctx context.Context,

	id int,
	request *UpdateSubmitterParams,
	opts ...RequestOption,
) (*core.Response[*SubmitterUpdateResult], error)

func (*RawClient) UpdateTemplate 

func (r *RawClient) UpdateTemplate(
	ctx context.Context,

	id int,
	request *UpdateTemplateParams,
	opts ...RequestOption,
) (*core.Response[*TemplateUpdateResult], error)

func (*RawClient) UpdateTemplateDocuments 

func (r *RawClient) UpdateTemplateDocuments(
	ctx context.Context,

	id int,
	request *UpdateTemplateDocumentsParams,
	opts ...RequestOption,
) (*core.Response[*Template], error)

type RequestOption 

type RequestOption = core.RequestOption

RequestOption adapts the behavior of an individual request.

type SchemaDocument 

type SchemaDocument struct {
	// Unique identifier of the attached document.
	AttachmentUUID string `json:"attachment_uuid" url:"attachment_uuid"`
	// Name of the attached document.
	Name string `json:"name" url:"name"`
	// contains filtered or unexported fields
}

func (*SchemaDocument) GetAttachmentUUID 

func (s *SchemaDocument) GetAttachmentUUID() string

func (*SchemaDocument) GetExtraProperties 

func (s *SchemaDocument) GetExtraProperties() map[string]interface{}

func (*SchemaDocument) GetName 

func (s *SchemaDocument) GetName() string

func (*SchemaDocument) MarshalJSON 

func (s *SchemaDocument) MarshalJSON() ([]byte, error)

func (*SchemaDocument) SetAttachmentUUID 

func (s *SchemaDocument) SetAttachmentUUID(attachmentUUID string)

SetAttachmentUUID sets the AttachmentUUID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SchemaDocument) SetName 

func (s *SchemaDocument) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SchemaDocument) String 

func (s *SchemaDocument) String() string

func (*SchemaDocument) UnmarshalJSON 

func (s *SchemaDocument) UnmarshalJSON(data []byte) error

type Submission 

type Submission struct {
	// Submission unique ID number.
	ID int `json:"id" url:"id"`
	// Name of the document submission.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// Unique slug of the submission.
	Slug string `json:"slug" url:"slug"`
	// The source of the submission.
	Source SubmissionSource `json:"source" url:"source"`
	// The order of submitters.
	SubmittersOrder SubmittersOrder `json:"submitters_order" url:"submitters_order"`
	// Audit log file URL.
	AuditLogURL *string `json:"audit_log_url,omitempty" url:"audit_log_url,omitempty"`
	// Combined PDF file URL with documents and Audit Log.
	CombinedDocumentURL *string `json:"combined_document_url,omitempty" url:"combined_document_url,omitempty"`
	// The date and time when the submission was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// The date and time when the submission was last updated.
	UpdatedAt string `json:"updated_at" url:"updated_at"`
	// The date and time when the submission was archived.
	ArchivedAt *string `json:"archived_at,omitempty" url:"archived_at,omitempty"`
	// The date and time when the submission will expire and no longer be available for signing.
	ExpireAt *string `json:"expire_at,omitempty" url:"expire_at,omitempty"`
	// Dynamic content variables object used in dynamic template documents.
	Variables map[string]any `json:"variables" url:"variables"`
	// The list of submitters.
	Submitters    []*SubmissionSubmitter `json:"submitters" url:"submitters"`
	Template      *TemplateSummary       `json:"template,omitempty" url:"template,omitempty"`
	CreatedByUser *User                  `json:"created_by_user,omitempty" url:"created_by_user,omitempty"`
	// An array of events related to the submission.
	SubmissionEvents []*SubmissionEvent `json:"submission_events" url:"submission_events"`
	// An array of completed or signed documents of the submission.
	Documents []*Document `json:"documents" url:"documents"`
	// The status of the submission.
	Status SubmissionStatus `json:"status" url:"status"`
	// The date and time when the submission was completed.
	CompletedAt *string `json:"completed_at,omitempty" url:"completed_at,omitempty"`
	// contains filtered or unexported fields
}

func (*Submission) GetArchivedAt 

func (s *Submission) GetArchivedAt() *string

func (*Submission) GetAuditLogURL 

func (s *Submission) GetAuditLogURL() *string

func (*Submission) GetCombinedDocumentURL 

func (s *Submission) GetCombinedDocumentURL() *string

func (*Submission) GetCompletedAt 

func (s *Submission) GetCompletedAt() *string

func (*Submission) GetCreatedAt 

func (s *Submission) GetCreatedAt() string

func (*Submission) GetCreatedByUser 

func (s *Submission) GetCreatedByUser() *User

func (*Submission) GetDocuments 

func (s *Submission) GetDocuments() []*Document

func (*Submission) GetExpireAt 

func (s *Submission) GetExpireAt() *string

func (*Submission) GetExtraProperties 

func (s *Submission) GetExtraProperties() map[string]interface{}

func (*Submission) GetID 

func (s *Submission) GetID() int

func (*Submission) GetName 

func (s *Submission) GetName() *string

func (*Submission) GetSlug 

func (s *Submission) GetSlug() string

func (*Submission) GetSource 

func (s *Submission) GetSource() SubmissionSource

func (*Submission) GetStatus 

func (s *Submission) GetStatus() SubmissionStatus

func (*Submission) GetSubmissionEvents 

func (s *Submission) GetSubmissionEvents() []*SubmissionEvent

func (*Submission) GetSubmitters 

func (s *Submission) GetSubmitters() []*SubmissionSubmitter

func (*Submission) GetSubmittersOrder 

func (s *Submission) GetSubmittersOrder() SubmittersOrder

func (*Submission) GetTemplate 

func (s *Submission) GetTemplate() *TemplateSummary

func (*Submission) GetUpdatedAt 

func (s *Submission) GetUpdatedAt() string

func (*Submission) GetVariables 

func (s *Submission) GetVariables() map[string]any

func (*Submission) MarshalJSON 

func (s *Submission) MarshalJSON() ([]byte, error)

func (*Submission) SetArchivedAt 

func (s *Submission) SetArchivedAt(archivedAt *string)

SetArchivedAt sets the ArchivedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetAuditLogURL 

func (s *Submission) SetAuditLogURL(auditLogURL *string)

SetAuditLogURL sets the AuditLogURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetCombinedDocumentURL 

func (s *Submission) SetCombinedDocumentURL(combinedDocumentURL *string)

SetCombinedDocumentURL sets the CombinedDocumentURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetCompletedAt 

func (s *Submission) SetCompletedAt(completedAt *string)

SetCompletedAt sets the CompletedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetCreatedAt 

func (s *Submission) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetCreatedByUser 

func (s *Submission) SetCreatedByUser(createdByUser *User)

SetCreatedByUser sets the CreatedByUser field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetDocuments 

func (s *Submission) SetDocuments(documents []*Document)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetExpireAt 

func (s *Submission) SetExpireAt(expireAt *string)

SetExpireAt sets the ExpireAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetID 

func (s *Submission) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetName 

func (s *Submission) SetName(name *string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetSlug 

func (s *Submission) SetSlug(slug string)

SetSlug sets the Slug field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetSource 

func (s *Submission) SetSource(source SubmissionSource)

SetSource sets the Source field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetStatus 

func (s *Submission) SetStatus(status SubmissionStatus)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetSubmissionEvents 

func (s *Submission) SetSubmissionEvents(submissionEvents []*SubmissionEvent)

SetSubmissionEvents sets the SubmissionEvents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetSubmitters 

func (s *Submission) SetSubmitters(submitters []*SubmissionSubmitter)

SetSubmitters sets the Submitters field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetSubmittersOrder 

func (s *Submission) SetSubmittersOrder(submittersOrder SubmittersOrder)

SetSubmittersOrder sets the SubmittersOrder field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetTemplate 

func (s *Submission) SetTemplate(template *TemplateSummary)

SetTemplate sets the Template field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetUpdatedAt 

func (s *Submission) SetUpdatedAt(updatedAt string)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) SetVariables 

func (s *Submission) SetVariables(variables map[string]any)

SetVariables sets the Variables field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submission) String 

func (s *Submission) String() string

func (*Submission) UnmarshalJSON 

func (s *Submission) UnmarshalJSON(data []byte) error

type SubmissionArchiveResult 

type SubmissionArchiveResult struct {
	// Submission unique ID number.
	ID int `json:"id" url:"id"`
	// Date and time when the submission was archived.
	ArchivedAt *string `json:"archived_at,omitempty" url:"archived_at,omitempty"`
	// contains filtered or unexported fields
}

func (*SubmissionArchiveResult) GetArchivedAt 

func (s *SubmissionArchiveResult) GetArchivedAt() *string

func (*SubmissionArchiveResult) GetExtraProperties 

func (s *SubmissionArchiveResult) GetExtraProperties() map[string]interface{}

func (*SubmissionArchiveResult) GetID 

func (s *SubmissionArchiveResult) GetID() int

func (*SubmissionArchiveResult) MarshalJSON 

func (s *SubmissionArchiveResult) MarshalJSON() ([]byte, error)

func (*SubmissionArchiveResult) SetArchivedAt 

func (s *SubmissionArchiveResult) SetArchivedAt(archivedAt *string)

SetArchivedAt sets the ArchivedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionArchiveResult) SetID 

func (s *SubmissionArchiveResult) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionArchiveResult) String 

func (s *SubmissionArchiveResult) String() string

func (*SubmissionArchiveResult) UnmarshalJSON 

func (s *SubmissionArchiveResult) UnmarshalJSON(data []byte) error

type SubmissionArchivedEvent 

type SubmissionArchivedEvent struct {
	// The event type.
	EventType EventType `json:"event_type" url:"event_type"`
	// The event timestamp.
	Timestamp time.Time                `json:"timestamp" url:"timestamp"`
	Data      *SubmissionArchiveResult `json:"data" url:"data"`
	// contains filtered or unexported fields
}

func (*SubmissionArchivedEvent) GetData 

func (s *SubmissionArchivedEvent) GetData() *SubmissionArchiveResult

func (*SubmissionArchivedEvent) GetEventType 

func (s *SubmissionArchivedEvent) GetEventType() EventType

func (*SubmissionArchivedEvent) GetExtraProperties 

func (s *SubmissionArchivedEvent) GetExtraProperties() map[string]interface{}

func (*SubmissionArchivedEvent) GetTimestamp 

func (s *SubmissionArchivedEvent) GetTimestamp() time.Time

func (*SubmissionArchivedEvent) MarshalJSON 

func (s *SubmissionArchivedEvent) MarshalJSON() ([]byte, error)

func (*SubmissionArchivedEvent) SetData 

func (s *SubmissionArchivedEvent) SetData(data *SubmissionArchiveResult)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionArchivedEvent) SetEventType 

func (s *SubmissionArchivedEvent) SetEventType(eventType EventType)

SetEventType sets the EventType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionArchivedEvent) SetTimestamp 

func (s *SubmissionArchivedEvent) SetTimestamp(timestamp time.Time)

SetTimestamp sets the Timestamp field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionArchivedEvent) String 

func (s *SubmissionArchivedEvent) String() string

func (*SubmissionArchivedEvent) UnmarshalJSON 

func (s *SubmissionArchivedEvent) UnmarshalJSON(data []byte) error

type SubmissionCompletedEvent 

type SubmissionCompletedEvent struct {
	// The event type.
	EventType EventType `json:"event_type" url:"event_type"`
	// The event timestamp.
	Timestamp time.Time   `json:"timestamp" url:"timestamp"`
	Data      *Submission `json:"data" url:"data"`
	// contains filtered or unexported fields
}

func (*SubmissionCompletedEvent) GetData 

func (s *SubmissionCompletedEvent) GetData() *Submission

func (*SubmissionCompletedEvent) GetEventType 

func (s *SubmissionCompletedEvent) GetEventType() EventType

func (*SubmissionCompletedEvent) GetExtraProperties 

func (s *SubmissionCompletedEvent) GetExtraProperties() map[string]interface{}

func (*SubmissionCompletedEvent) GetTimestamp 

func (s *SubmissionCompletedEvent) GetTimestamp() time.Time

func (*SubmissionCompletedEvent) MarshalJSON 

func (s *SubmissionCompletedEvent) MarshalJSON() ([]byte, error)

func (*SubmissionCompletedEvent) SetData 

func (s *SubmissionCompletedEvent) SetData(data *Submission)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCompletedEvent) SetEventType 

func (s *SubmissionCompletedEvent) SetEventType(eventType EventType)

SetEventType sets the EventType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCompletedEvent) SetTimestamp 

func (s *SubmissionCompletedEvent) SetTimestamp(timestamp time.Time)

SetTimestamp sets the Timestamp field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCompletedEvent) String 

func (s *SubmissionCompletedEvent) String() string

func (*SubmissionCompletedEvent) UnmarshalJSON 

func (s *SubmissionCompletedEvent) UnmarshalJSON(data []byte) error

type SubmissionCreateOneoffResult 

type SubmissionCreateOneoffResult struct {
	// Submission unique ID number.
	ID int `json:"id" url:"id"`
	// Submission name.
	Name string `json:"name" url:"name"`
	// The list of submitters.
	Submitters []*SubmitterCreateResult `json:"submitters" url:"submitters"`
	// The source of the submission.
	Source SubmissionSource `json:"source" url:"source"`
	// The order of submitters.
	SubmittersOrder SubmittersOrder `json:"submitters_order" url:"submitters_order"`
	// The status of the submission.
	Status SubmissionStatus `json:"status" url:"status"`
	// The one-off submission document files.
	Schema []*SchemaDocument `json:"schema,omitempty" url:"schema,omitempty"`
	// List of fields to be filled in the one-off submission.
	Fields []*Field `json:"fields,omitempty" url:"fields,omitempty"`
	// The date and time when the submission will expire and no longer be available for signing.
	ExpireAt *string `json:"expire_at,omitempty" url:"expire_at,omitempty"`
	// The date and time when the submission was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// contains filtered or unexported fields
}

func (*SubmissionCreateOneoffResult) GetCreatedAt 

func (s *SubmissionCreateOneoffResult) GetCreatedAt() string

func (*SubmissionCreateOneoffResult) GetExpireAt 

func (s *SubmissionCreateOneoffResult) GetExpireAt() *string

func (*SubmissionCreateOneoffResult) GetExtraProperties 

func (s *SubmissionCreateOneoffResult) GetExtraProperties() map[string]interface{}

func (*SubmissionCreateOneoffResult) GetFields 

func (s *SubmissionCreateOneoffResult) GetFields() []*Field

func (*SubmissionCreateOneoffResult) GetID 

func (s *SubmissionCreateOneoffResult) GetID() int

func (*SubmissionCreateOneoffResult) GetName 

func (s *SubmissionCreateOneoffResult) GetName() string

func (*SubmissionCreateOneoffResult) GetSchema 

func (s *SubmissionCreateOneoffResult) GetSchema() []*SchemaDocument

func (*SubmissionCreateOneoffResult) GetSource 

func (s *SubmissionCreateOneoffResult) GetSource() SubmissionSource

func (*SubmissionCreateOneoffResult) GetStatus 

func (s *SubmissionCreateOneoffResult) GetStatus() SubmissionStatus

func (*SubmissionCreateOneoffResult) GetSubmitters 

func (s *SubmissionCreateOneoffResult) GetSubmitters() []*SubmitterCreateResult

func (*SubmissionCreateOneoffResult) GetSubmittersOrder 

func (s *SubmissionCreateOneoffResult) GetSubmittersOrder() SubmittersOrder

func (*SubmissionCreateOneoffResult) MarshalJSON 

func (s *SubmissionCreateOneoffResult) MarshalJSON() ([]byte, error)

func (*SubmissionCreateOneoffResult) SetCreatedAt 

func (s *SubmissionCreateOneoffResult) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateOneoffResult) SetExpireAt 

func (s *SubmissionCreateOneoffResult) SetExpireAt(expireAt *string)

SetExpireAt sets the ExpireAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateOneoffResult) SetFields 

func (s *SubmissionCreateOneoffResult) SetFields(fields []*Field)

SetFields sets the Fields field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateOneoffResult) SetID 

func (s *SubmissionCreateOneoffResult) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateOneoffResult) SetName 

func (s *SubmissionCreateOneoffResult) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateOneoffResult) SetSchema 

func (s *SubmissionCreateOneoffResult) SetSchema(schema []*SchemaDocument)

SetSchema sets the Schema field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateOneoffResult) SetSource 

func (s *SubmissionCreateOneoffResult) SetSource(source SubmissionSource)

SetSource sets the Source field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateOneoffResult) SetStatus 

func (s *SubmissionCreateOneoffResult) SetStatus(status SubmissionStatus)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateOneoffResult) SetSubmitters 

func (s *SubmissionCreateOneoffResult) SetSubmitters(submitters []*SubmitterCreateResult)

SetSubmitters sets the Submitters field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateOneoffResult) SetSubmittersOrder 

func (s *SubmissionCreateOneoffResult) SetSubmittersOrder(submittersOrder SubmittersOrder)

SetSubmittersOrder sets the SubmittersOrder field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateOneoffResult) String 

func (s *SubmissionCreateOneoffResult) String() string

func (*SubmissionCreateOneoffResult) UnmarshalJSON 

func (s *SubmissionCreateOneoffResult) UnmarshalJSON(data []byte) error

type SubmissionCreateResult 

type SubmissionCreateResult struct {
	// Submission unique ID number.
	ID int `json:"id" url:"id"`
	// The list of created submitters.
	Submitters []*SubmitterCreateResult `json:"submitters" url:"submitters"`
	// The date and time when the submission expires.
	ExpireAt *string `json:"expire_at,omitempty" url:"expire_at,omitempty"`
	// The date and time when the submission was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// contains filtered or unexported fields
}

func (*SubmissionCreateResult) GetCreatedAt 

func (s *SubmissionCreateResult) GetCreatedAt() string

func (*SubmissionCreateResult) GetExpireAt 

func (s *SubmissionCreateResult) GetExpireAt() *string

func (*SubmissionCreateResult) GetExtraProperties 

func (s *SubmissionCreateResult) GetExtraProperties() map[string]interface{}

func (*SubmissionCreateResult) GetID 

func (s *SubmissionCreateResult) GetID() int

func (*SubmissionCreateResult) GetSubmitters 

func (s *SubmissionCreateResult) GetSubmitters() []*SubmitterCreateResult

func (*SubmissionCreateResult) MarshalJSON 

func (s *SubmissionCreateResult) MarshalJSON() ([]byte, error)

func (*SubmissionCreateResult) SetCreatedAt 

func (s *SubmissionCreateResult) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateResult) SetExpireAt 

func (s *SubmissionCreateResult) SetExpireAt(expireAt *string)

SetExpireAt sets the ExpireAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateResult) SetID 

func (s *SubmissionCreateResult) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateResult) SetSubmitters 

func (s *SubmissionCreateResult) SetSubmitters(submitters []*SubmitterCreateResult)

SetSubmitters sets the Submitters field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreateResult) String 

func (s *SubmissionCreateResult) String() string

func (*SubmissionCreateResult) UnmarshalJSON 

func (s *SubmissionCreateResult) UnmarshalJSON(data []byte) error

type SubmissionCreatedEvent 

type SubmissionCreatedEvent struct {
	// The event type.
	EventType EventType `json:"event_type" url:"event_type"`
	// The event timestamp.
	Timestamp time.Time   `json:"timestamp" url:"timestamp"`
	Data      *Submission `json:"data" url:"data"`
	// contains filtered or unexported fields
}

func (*SubmissionCreatedEvent) GetData 

func (s *SubmissionCreatedEvent) GetData() *Submission

func (*SubmissionCreatedEvent) GetEventType 

func (s *SubmissionCreatedEvent) GetEventType() EventType

func (*SubmissionCreatedEvent) GetExtraProperties 

func (s *SubmissionCreatedEvent) GetExtraProperties() map[string]interface{}

func (*SubmissionCreatedEvent) GetTimestamp 

func (s *SubmissionCreatedEvent) GetTimestamp() time.Time

func (*SubmissionCreatedEvent) MarshalJSON 

func (s *SubmissionCreatedEvent) MarshalJSON() ([]byte, error)

func (*SubmissionCreatedEvent) SetData 

func (s *SubmissionCreatedEvent) SetData(data *Submission)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreatedEvent) SetEventType 

func (s *SubmissionCreatedEvent) SetEventType(eventType EventType)

SetEventType sets the EventType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreatedEvent) SetTimestamp 

func (s *SubmissionCreatedEvent) SetTimestamp(timestamp time.Time)

SetTimestamp sets the Timestamp field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionCreatedEvent) String 

func (s *SubmissionCreatedEvent) String() string

func (*SubmissionCreatedEvent) UnmarshalJSON 

func (s *SubmissionCreatedEvent) UnmarshalJSON(data []byte) error

type SubmissionDocuments 

type SubmissionDocuments struct {
	// Submission unique ID number.
	ID int `json:"id" url:"id"`
	// An array of completed or signed documents of the submission.
	Documents []*Document `json:"documents" url:"documents"`
	// contains filtered or unexported fields
}

func (*SubmissionDocuments) GetDocuments 

func (s *SubmissionDocuments) GetDocuments() []*Document

func (*SubmissionDocuments) GetExtraProperties 

func (s *SubmissionDocuments) GetExtraProperties() map[string]interface{}

func (*SubmissionDocuments) GetID 

func (s *SubmissionDocuments) GetID() int

func (*SubmissionDocuments) MarshalJSON 

func (s *SubmissionDocuments) MarshalJSON() ([]byte, error)

func (*SubmissionDocuments) SetDocuments 

func (s *SubmissionDocuments) SetDocuments(documents []*Document)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionDocuments) SetID 

func (s *SubmissionDocuments) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionDocuments) String 

func (s *SubmissionDocuments) String() string

func (*SubmissionDocuments) UnmarshalJSON 

func (s *SubmissionDocuments) UnmarshalJSON(data []byte) error

type SubmissionEvent 

type SubmissionEvent struct {
	// Submission event unique ID number.
	ID int `json:"id" url:"id"`
	// Unique identifier of the submitter that triggered the event.
	SubmitterID int `json:"submitter_id" url:"submitter_id"`
	// Event type.
	EventType SubmissionEventType `json:"event_type" url:"event_type"`
	// Date and time when the event was triggered.
	EventTimestamp string `json:"event_timestamp" url:"event_timestamp"`
	// Additional event details object.
	Data map[string]any `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*SubmissionEvent) GetData 

func (s *SubmissionEvent) GetData() map[string]any

func (*SubmissionEvent) GetEventTimestamp 

func (s *SubmissionEvent) GetEventTimestamp() string

func (*SubmissionEvent) GetEventType 

func (s *SubmissionEvent) GetEventType() SubmissionEventType

func (*SubmissionEvent) GetExtraProperties 

func (s *SubmissionEvent) GetExtraProperties() map[string]interface{}

func (*SubmissionEvent) GetID 

func (s *SubmissionEvent) GetID() int

func (*SubmissionEvent) GetSubmitterID 

func (s *SubmissionEvent) GetSubmitterID() int

func (*SubmissionEvent) MarshalJSON 

func (s *SubmissionEvent) MarshalJSON() ([]byte, error)

func (*SubmissionEvent) SetData 

func (s *SubmissionEvent) SetData(data map[string]any)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionEvent) SetEventTimestamp 

func (s *SubmissionEvent) SetEventTimestamp(eventTimestamp string)

SetEventTimestamp sets the EventTimestamp field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionEvent) SetEventType 

func (s *SubmissionEvent) SetEventType(eventType SubmissionEventType)

SetEventType sets the EventType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionEvent) SetID 

func (s *SubmissionEvent) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionEvent) SetSubmitterID 

func (s *SubmissionEvent) SetSubmitterID(submitterID int)

SetSubmitterID sets the SubmitterID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionEvent) String 

func (s *SubmissionEvent) String() string

func (*SubmissionEvent) UnmarshalJSON 

func (s *SubmissionEvent) UnmarshalJSON(data []byte) error

type SubmissionEventType 

type SubmissionEventType string
const (
	SubmissionEventTypeSendEmail            SubmissionEventType = "send_email"
	SubmissionEventTypeBounceEmail          SubmissionEventType = "bounce_email"
	SubmissionEventTypeComplaintEmail       SubmissionEventType = "complaint_email"
	SubmissionEventTypeSendReminderEmail    SubmissionEventType = "send_reminder_email"
	SubmissionEventTypeSendSms              SubmissionEventType = "send_sms"
	SubmissionEventTypeSend2FaSms           SubmissionEventType = "send_2fa_sms"
	SubmissionEventTypeOpenEmail            SubmissionEventType = "open_email"
	SubmissionEventTypeClickEmail           SubmissionEventType = "click_email"
	SubmissionEventTypeClickSms             SubmissionEventType = "click_sms"
	SubmissionEventTypePhoneVerified        SubmissionEventType = "phone_verified"
	SubmissionEventTypeStartForm            SubmissionEventType = "start_form"
	SubmissionEventTypeStartVerification    SubmissionEventType = "start_verification"
	SubmissionEventTypeCompleteVerification SubmissionEventType = "complete_verification"
	SubmissionEventTypeViewForm             SubmissionEventType = "view_form"
	SubmissionEventTypeInviteParty          SubmissionEventType = "invite_party"
	SubmissionEventTypeCompleteForm         SubmissionEventType = "complete_form"
	SubmissionEventTypeDeclineForm          SubmissionEventType = "decline_form"
	SubmissionEventTypeAPICompleteForm      SubmissionEventType = "api_complete_form"
)

func NewSubmissionEventTypeFromString 

func NewSubmissionEventTypeFromString(s string) (SubmissionEventType, error)

func (SubmissionEventType) Ptr 

func (s SubmissionEventType) Ptr() *SubmissionEventType

type SubmissionExpiredEvent 

type SubmissionExpiredEvent struct {
	// The event type.
	EventType EventType `json:"event_type" url:"event_type"`
	// The event timestamp.
	Timestamp time.Time   `json:"timestamp" url:"timestamp"`
	Data      *Submission `json:"data" url:"data"`
	// contains filtered or unexported fields
}

func (*SubmissionExpiredEvent) GetData 

func (s *SubmissionExpiredEvent) GetData() *Submission

func (*SubmissionExpiredEvent) GetEventType 

func (s *SubmissionExpiredEvent) GetEventType() EventType

func (*SubmissionExpiredEvent) GetExtraProperties 

func (s *SubmissionExpiredEvent) GetExtraProperties() map[string]interface{}

func (*SubmissionExpiredEvent) GetTimestamp 

func (s *SubmissionExpiredEvent) GetTimestamp() time.Time

func (*SubmissionExpiredEvent) MarshalJSON 

func (s *SubmissionExpiredEvent) MarshalJSON() ([]byte, error)

func (*SubmissionExpiredEvent) SetData 

func (s *SubmissionExpiredEvent) SetData(data *Submission)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionExpiredEvent) SetEventType 

func (s *SubmissionExpiredEvent) SetEventType(eventType EventType)

SetEventType sets the EventType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionExpiredEvent) SetTimestamp 

func (s *SubmissionExpiredEvent) SetTimestamp(timestamp time.Time)

SetTimestamp sets the Timestamp field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionExpiredEvent) String 

func (s *SubmissionExpiredEvent) String() string

func (*SubmissionExpiredEvent) UnmarshalJSON 

func (s *SubmissionExpiredEvent) UnmarshalJSON(data []byte) error

type SubmissionList 

type SubmissionList struct {
	Data       []*SubmissionListItem `json:"data" url:"data"`
	Pagination *Pagination           `json:"pagination" url:"pagination"`
	// contains filtered or unexported fields
}

func (*SubmissionList) GetData 

func (s *SubmissionList) GetData() []*SubmissionListItem

func (*SubmissionList) GetExtraProperties 

func (s *SubmissionList) GetExtraProperties() map[string]interface{}

func (*SubmissionList) GetPagination 

func (s *SubmissionList) GetPagination() *Pagination

func (*SubmissionList) MarshalJSON 

func (s *SubmissionList) MarshalJSON() ([]byte, error)

func (*SubmissionList) SetData 

func (s *SubmissionList) SetData(data []*SubmissionListItem)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionList) SetPagination 

func (s *SubmissionList) SetPagination(pagination *Pagination)

SetPagination sets the Pagination field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionList) String 

func (s *SubmissionList) String() string

func (*SubmissionList) UnmarshalJSON 

func (s *SubmissionList) UnmarshalJSON(data []byte) error

type SubmissionListItem 

type SubmissionListItem struct {
	// Submission unique ID number.
	ID int `json:"id" url:"id"`
	// Name of the document submission.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// The source of the submission.
	Source SubmissionSource `json:"source" url:"source"`
	// Unique slug of the submission.
	Slug string `json:"slug" url:"slug"`
	// The status of the submission.
	Status SubmissionStatus `json:"status" url:"status"`
	// The order of submitters.
	SubmittersOrder SubmittersOrder `json:"submitters_order" url:"submitters_order"`
	// Audit log file URL.
	AuditLogURL *string `json:"audit_log_url,omitempty" url:"audit_log_url,omitempty"`
	// Combined PDF file URL with documents and Audit Log.
	CombinedDocumentURL *string `json:"combined_document_url,omitempty" url:"combined_document_url,omitempty"`
	// The date and time when the submission was completed.
	CompletedAt *string `json:"completed_at,omitempty" url:"completed_at,omitempty"`
	// The date and time when the submission was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// The date and time when the submission was last updated.
	UpdatedAt string `json:"updated_at" url:"updated_at"`
	// The date and time when the submission was archived.
	ArchivedAt *string `json:"archived_at,omitempty" url:"archived_at,omitempty"`
	// The date and time when the submission will expire and no longer be available for signing.
	ExpireAt *string `json:"expire_at,omitempty" url:"expire_at,omitempty"`
	// Dynamic content variables object used in dynamic template documents.
	Variables map[string]any `json:"variables" url:"variables"`
	// The list of submitters.
	Submitters    []*SubmitterSummary `json:"submitters" url:"submitters"`
	Template      *TemplateSummary    `json:"template,omitempty" url:"template,omitempty"`
	CreatedByUser *User               `json:"created_by_user,omitempty" url:"created_by_user,omitempty"`
	// contains filtered or unexported fields
}

func (*SubmissionListItem) GetArchivedAt 

func (s *SubmissionListItem) GetArchivedAt() *string

func (*SubmissionListItem) GetAuditLogURL 

func (s *SubmissionListItem) GetAuditLogURL() *string

func (*SubmissionListItem) GetCombinedDocumentURL 

func (s *SubmissionListItem) GetCombinedDocumentURL() *string

func (*SubmissionListItem) GetCompletedAt 

func (s *SubmissionListItem) GetCompletedAt() *string

func (*SubmissionListItem) GetCreatedAt 

func (s *SubmissionListItem) GetCreatedAt() string

func (*SubmissionListItem) GetCreatedByUser 

func (s *SubmissionListItem) GetCreatedByUser() *User

func (*SubmissionListItem) GetExpireAt 

func (s *SubmissionListItem) GetExpireAt() *string

func (*SubmissionListItem) GetExtraProperties 

func (s *SubmissionListItem) GetExtraProperties() map[string]interface{}

func (*SubmissionListItem) GetID 

func (s *SubmissionListItem) GetID() int

func (*SubmissionListItem) GetName 

func (s *SubmissionListItem) GetName() *string

func (*SubmissionListItem) GetSlug 

func (s *SubmissionListItem) GetSlug() string

func (*SubmissionListItem) GetSource 

func (s *SubmissionListItem) GetSource() SubmissionSource

func (*SubmissionListItem) GetStatus 

func (s *SubmissionListItem) GetStatus() SubmissionStatus

func (*SubmissionListItem) GetSubmitters 

func (s *SubmissionListItem) GetSubmitters() []*SubmitterSummary

func (*SubmissionListItem) GetSubmittersOrder 

func (s *SubmissionListItem) GetSubmittersOrder() SubmittersOrder

func (*SubmissionListItem) GetTemplate 

func (s *SubmissionListItem) GetTemplate() *TemplateSummary

func (*SubmissionListItem) GetUpdatedAt 

func (s *SubmissionListItem) GetUpdatedAt() string

func (*SubmissionListItem) GetVariables 

func (s *SubmissionListItem) GetVariables() map[string]any

func (*SubmissionListItem) MarshalJSON 

func (s *SubmissionListItem) MarshalJSON() ([]byte, error)

func (*SubmissionListItem) SetArchivedAt 

func (s *SubmissionListItem) SetArchivedAt(archivedAt *string)

SetArchivedAt sets the ArchivedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetAuditLogURL 

func (s *SubmissionListItem) SetAuditLogURL(auditLogURL *string)

SetAuditLogURL sets the AuditLogURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetCombinedDocumentURL 

func (s *SubmissionListItem) SetCombinedDocumentURL(combinedDocumentURL *string)

SetCombinedDocumentURL sets the CombinedDocumentURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetCompletedAt 

func (s *SubmissionListItem) SetCompletedAt(completedAt *string)

SetCompletedAt sets the CompletedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetCreatedAt 

func (s *SubmissionListItem) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetCreatedByUser 

func (s *SubmissionListItem) SetCreatedByUser(createdByUser *User)

SetCreatedByUser sets the CreatedByUser field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetExpireAt 

func (s *SubmissionListItem) SetExpireAt(expireAt *string)

SetExpireAt sets the ExpireAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetID 

func (s *SubmissionListItem) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetName 

func (s *SubmissionListItem) SetName(name *string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetSlug 

func (s *SubmissionListItem) SetSlug(slug string)

SetSlug sets the Slug field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetSource 

func (s *SubmissionListItem) SetSource(source SubmissionSource)

SetSource sets the Source field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetStatus 

func (s *SubmissionListItem) SetStatus(status SubmissionStatus)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetSubmitters 

func (s *SubmissionListItem) SetSubmitters(submitters []*SubmitterSummary)

SetSubmitters sets the Submitters field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetSubmittersOrder 

func (s *SubmissionListItem) SetSubmittersOrder(submittersOrder SubmittersOrder)

SetSubmittersOrder sets the SubmittersOrder field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetTemplate 

func (s *SubmissionListItem) SetTemplate(template *TemplateSummary)

SetTemplate sets the Template field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetUpdatedAt 

func (s *SubmissionListItem) SetUpdatedAt(updatedAt string)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) SetVariables 

func (s *SubmissionListItem) SetVariables(variables map[string]any)

SetVariables sets the Variables field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionListItem) String 

func (s *SubmissionListItem) String() string

func (*SubmissionListItem) UnmarshalJSON 

func (s *SubmissionListItem) UnmarshalJSON(data []byte) error

type SubmissionPermanentlyDeleteResult 

type SubmissionPermanentlyDeleteResult struct {
	// Submission unique ID number.
	ID int `json:"id" url:"id"`
	// Date and time when the submission was archived.
	ArchivedAt *string `json:"archived_at,omitempty" url:"archived_at,omitempty"`
	// contains filtered or unexported fields
}

func (*SubmissionPermanentlyDeleteResult) GetArchivedAt 

func (s *SubmissionPermanentlyDeleteResult) GetArchivedAt() *string

func (*SubmissionPermanentlyDeleteResult) GetExtraProperties 

func (s *SubmissionPermanentlyDeleteResult) GetExtraProperties() map[string]interface{}

func (*SubmissionPermanentlyDeleteResult) GetID 

func (s *SubmissionPermanentlyDeleteResult) GetID() int

func (*SubmissionPermanentlyDeleteResult) MarshalJSON 

func (s *SubmissionPermanentlyDeleteResult) MarshalJSON() ([]byte, error)

func (*SubmissionPermanentlyDeleteResult) SetArchivedAt 

func (s *SubmissionPermanentlyDeleteResult) SetArchivedAt(archivedAt *string)

SetArchivedAt sets the ArchivedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionPermanentlyDeleteResult) SetID 

func (s *SubmissionPermanentlyDeleteResult) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionPermanentlyDeleteResult) String 

func (s *SubmissionPermanentlyDeleteResult) String() string

func (*SubmissionPermanentlyDeleteResult) UnmarshalJSON 

func (s *SubmissionPermanentlyDeleteResult) UnmarshalJSON(data []byte) error

type SubmissionSource 

type SubmissionSource string
const (
	SubmissionSourceInvite SubmissionSource = "invite"
	SubmissionSourceBulk   SubmissionSource = "bulk"
	SubmissionSourceAPI    SubmissionSource = "api"
	SubmissionSourceEmbed  SubmissionSource = "embed"
	SubmissionSourceLink   SubmissionSource = "link"
)

func NewSubmissionSourceFromString 

func NewSubmissionSourceFromString(s string) (SubmissionSource, error)

func (SubmissionSource) Ptr 

func (s SubmissionSource) Ptr() *SubmissionSource

type SubmissionStatus 

type SubmissionStatus string
const (
	SubmissionStatusCompleted SubmissionStatus = "completed"
	SubmissionStatusDeclined  SubmissionStatus = "declined"
	SubmissionStatusExpired   SubmissionStatus = "expired"
	SubmissionStatusPending   SubmissionStatus = "pending"
)

func NewSubmissionStatusFromString 

func NewSubmissionStatusFromString(s string) (SubmissionStatus, error)

func (SubmissionStatus) Ptr 

func (s SubmissionStatus) Ptr() *SubmissionStatus

type SubmissionSubmitter 

type SubmissionSubmitter struct {
	// Submitter unique ID number.
	ID int `json:"id" url:"id"`
	// Submission unique ID number.
	SubmissionID int `json:"submission_id" url:"submission_id"`
	// Submitter UUID.
	UUID string `json:"uuid" url:"uuid"`
	// The email address of the submitter.
	Email *string `json:"email,omitempty" url:"email,omitempty"`
	// Unique key to be used in the form signing link and embedded form.
	Slug string `json:"slug" url:"slug"`
	// The date and time when the signing request was sent to the submitter.
	SentAt *string `json:"sent_at,omitempty" url:"sent_at,omitempty"`
	// The date and time when the submitter opened the signing form.
	OpenedAt *string `json:"opened_at,omitempty" url:"opened_at,omitempty"`
	// The date and time when the submitter completed the signing form.
	CompletedAt *string `json:"completed_at,omitempty" url:"completed_at,omitempty"`
	// The date and time when the submitter declined the signing form.
	DeclinedAt *string `json:"declined_at,omitempty" url:"declined_at,omitempty"`
	// The date and time when the submitter was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// The date and time when the submitter was last updated.
	UpdatedAt string `json:"updated_at" url:"updated_at"`
	// The name of the submitter.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// The phone number of the submitter.
	Phone *string `json:"phone,omitempty" url:"phone,omitempty"`
	// Your application-specific unique string key to identify this submitter within your app.
	ExternalID *string `json:"external_id,omitempty" url:"external_id,omitempty"`
	// The status of signing request for the submitter.
	Status SubmitterStatus `json:"status" url:"status"`
	// An array of pre-filled values for the submitter.
	Values []*FieldValue `json:"values" url:"values"`
	// An array of completed or signed documents by the submitter.
	Documents []*Document `json:"documents" url:"documents"`
	// The role of the submitter in the signing process.
	Role string `json:"role" url:"role"`
	// Metadata object with additional submitter information.
	Metadata map[string]any `json:"metadata" url:"metadata"`
	// Submitter preferences.
	Preferences map[string]any `json:"preferences" url:"preferences"`
	// contains filtered or unexported fields
}

func (*SubmissionSubmitter) GetCompletedAt 

func (s *SubmissionSubmitter) GetCompletedAt() *string

func (*SubmissionSubmitter) GetCreatedAt 

func (s *SubmissionSubmitter) GetCreatedAt() string

func (*SubmissionSubmitter) GetDeclinedAt 

func (s *SubmissionSubmitter) GetDeclinedAt() *string

func (*SubmissionSubmitter) GetDocuments 

func (s *SubmissionSubmitter) GetDocuments() []*Document

func (*SubmissionSubmitter) GetEmail 

func (s *SubmissionSubmitter) GetEmail() *string

func (*SubmissionSubmitter) GetExternalID 

func (s *SubmissionSubmitter) GetExternalID() *string

func (*SubmissionSubmitter) GetExtraProperties 

func (s *SubmissionSubmitter) GetExtraProperties() map[string]interface{}

func (*SubmissionSubmitter) GetID 

func (s *SubmissionSubmitter) GetID() int

func (*SubmissionSubmitter) GetMetadata 

func (s *SubmissionSubmitter) GetMetadata() map[string]any

func (*SubmissionSubmitter) GetName 

func (s *SubmissionSubmitter) GetName() *string

func (*SubmissionSubmitter) GetOpenedAt 

func (s *SubmissionSubmitter) GetOpenedAt() *string

func (*SubmissionSubmitter) GetPhone 

func (s *SubmissionSubmitter) GetPhone() *string

func (*SubmissionSubmitter) GetPreferences 

func (s *SubmissionSubmitter) GetPreferences() map[string]any

func (*SubmissionSubmitter) GetRole 

func (s *SubmissionSubmitter) GetRole() string

func (*SubmissionSubmitter) GetSentAt 

func (s *SubmissionSubmitter) GetSentAt() *string

func (*SubmissionSubmitter) GetSlug 

func (s *SubmissionSubmitter) GetSlug() string

func (*SubmissionSubmitter) GetStatus 

func (s *SubmissionSubmitter) GetStatus() SubmitterStatus

func (*SubmissionSubmitter) GetSubmissionID 

func (s *SubmissionSubmitter) GetSubmissionID() int

func (*SubmissionSubmitter) GetUUID 

func (s *SubmissionSubmitter) GetUUID() string

func (*SubmissionSubmitter) GetUpdatedAt 

func (s *SubmissionSubmitter) GetUpdatedAt() string

func (*SubmissionSubmitter) GetValues 

func (s *SubmissionSubmitter) GetValues() []*FieldValue

func (*SubmissionSubmitter) MarshalJSON 

func (s *SubmissionSubmitter) MarshalJSON() ([]byte, error)

func (*SubmissionSubmitter) SetCompletedAt 

func (s *SubmissionSubmitter) SetCompletedAt(completedAt *string)

SetCompletedAt sets the CompletedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetCreatedAt 

func (s *SubmissionSubmitter) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetDeclinedAt 

func (s *SubmissionSubmitter) SetDeclinedAt(declinedAt *string)

SetDeclinedAt sets the DeclinedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetDocuments 

func (s *SubmissionSubmitter) SetDocuments(documents []*Document)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetEmail 

func (s *SubmissionSubmitter) SetEmail(email *string)

SetEmail sets the Email field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetExternalID 

func (s *SubmissionSubmitter) SetExternalID(externalID *string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetID 

func (s *SubmissionSubmitter) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetMetadata 

func (s *SubmissionSubmitter) SetMetadata(metadata map[string]any)

SetMetadata sets the Metadata field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetName 

func (s *SubmissionSubmitter) SetName(name *string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetOpenedAt 

func (s *SubmissionSubmitter) SetOpenedAt(openedAt *string)

SetOpenedAt sets the OpenedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetPhone 

func (s *SubmissionSubmitter) SetPhone(phone *string)

SetPhone sets the Phone field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetPreferences 

func (s *SubmissionSubmitter) SetPreferences(preferences map[string]any)

SetPreferences sets the Preferences field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetRole 

func (s *SubmissionSubmitter) SetRole(role string)

SetRole sets the Role field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetSentAt 

func (s *SubmissionSubmitter) SetSentAt(sentAt *string)

SetSentAt sets the SentAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetSlug 

func (s *SubmissionSubmitter) SetSlug(slug string)

SetSlug sets the Slug field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetStatus 

func (s *SubmissionSubmitter) SetStatus(status SubmitterStatus)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetSubmissionID 

func (s *SubmissionSubmitter) SetSubmissionID(submissionID int)

SetSubmissionID sets the SubmissionID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetUUID 

func (s *SubmissionSubmitter) SetUUID(uuid string)

SetUUID sets the UUID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetUpdatedAt 

func (s *SubmissionSubmitter) SetUpdatedAt(updatedAt string)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) SetValues 

func (s *SubmissionSubmitter) SetValues(values []*FieldValue)

SetValues sets the Values field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionSubmitter) String 

func (s *SubmissionSubmitter) String() string

func (*SubmissionSubmitter) UnmarshalJSON 

func (s *SubmissionSubmitter) UnmarshalJSON(data []byte) error

type SubmissionUpdateResult 

type SubmissionUpdateResult struct {
	// Submission unique ID number.
	ID int `json:"id" url:"id"`
	// Name of the document submission.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// Unique slug of the submission.
	Slug string `json:"slug" url:"slug"`
	// The source of the submission.
	Source SubmissionSource `json:"source" url:"source"`
	// The order of submitters.
	SubmittersOrder SubmittersOrder `json:"submitters_order" url:"submitters_order"`
	// Audit log file URL.
	AuditLogURL *string `json:"audit_log_url,omitempty" url:"audit_log_url,omitempty"`
	// Combined PDF file URL with documents and Audit Log.
	CombinedDocumentURL *string `json:"combined_document_url,omitempty" url:"combined_document_url,omitempty"`
	// The date and time when the submission was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// The date and time when the submission was last updated.
	UpdatedAt string `json:"updated_at" url:"updated_at"`
	// The date and time when the submission was archived.
	ArchivedAt *string `json:"archived_at,omitempty" url:"archived_at,omitempty"`
	// The date and time when the submission will expire and no longer be available for signing.
	ExpireAt *string `json:"expire_at,omitempty" url:"expire_at,omitempty"`
	// Dynamic content variables object used in dynamic template documents.
	Variables map[string]any `json:"variables" url:"variables"`
	// The list of submitters.
	Submitters    []*SubmissionSubmitter `json:"submitters" url:"submitters"`
	Template      *TemplateSummary       `json:"template,omitempty" url:"template,omitempty"`
	CreatedByUser *User                  `json:"created_by_user,omitempty" url:"created_by_user,omitempty"`
	// An array of completed or signed documents of the submission.
	Documents []*Document `json:"documents" url:"documents"`
	// The status of the submission.
	Status SubmissionStatus `json:"status" url:"status"`
	// The date and time when the submission was completed.
	CompletedAt *string `json:"completed_at,omitempty" url:"completed_at,omitempty"`
	// contains filtered or unexported fields
}

func (*SubmissionUpdateResult) GetArchivedAt 

func (s *SubmissionUpdateResult) GetArchivedAt() *string

func (*SubmissionUpdateResult) GetAuditLogURL 

func (s *SubmissionUpdateResult) GetAuditLogURL() *string

func (*SubmissionUpdateResult) GetCombinedDocumentURL 

func (s *SubmissionUpdateResult) GetCombinedDocumentURL() *string

func (*SubmissionUpdateResult) GetCompletedAt 

func (s *SubmissionUpdateResult) GetCompletedAt() *string

func (*SubmissionUpdateResult) GetCreatedAt 

func (s *SubmissionUpdateResult) GetCreatedAt() string

func (*SubmissionUpdateResult) GetCreatedByUser 

func (s *SubmissionUpdateResult) GetCreatedByUser() *User

func (*SubmissionUpdateResult) GetDocuments 

func (s *SubmissionUpdateResult) GetDocuments() []*Document

func (*SubmissionUpdateResult) GetExpireAt 

func (s *SubmissionUpdateResult) GetExpireAt() *string

func (*SubmissionUpdateResult) GetExtraProperties 

func (s *SubmissionUpdateResult) GetExtraProperties() map[string]interface{}

func (*SubmissionUpdateResult) GetID 

func (s *SubmissionUpdateResult) GetID() int

func (*SubmissionUpdateResult) GetName 

func (s *SubmissionUpdateResult) GetName() *string

func (*SubmissionUpdateResult) GetSlug 

func (s *SubmissionUpdateResult) GetSlug() string

func (*SubmissionUpdateResult) GetSource 

func (s *SubmissionUpdateResult) GetSource() SubmissionSource

func (*SubmissionUpdateResult) GetStatus 

func (s *SubmissionUpdateResult) GetStatus() SubmissionStatus

func (*SubmissionUpdateResult) GetSubmitters 

func (s *SubmissionUpdateResult) GetSubmitters() []*SubmissionSubmitter

func (*SubmissionUpdateResult) GetSubmittersOrder 

func (s *SubmissionUpdateResult) GetSubmittersOrder() SubmittersOrder

func (*SubmissionUpdateResult) GetTemplate 

func (s *SubmissionUpdateResult) GetTemplate() *TemplateSummary

func (*SubmissionUpdateResult) GetUpdatedAt 

func (s *SubmissionUpdateResult) GetUpdatedAt() string

func (*SubmissionUpdateResult) GetVariables 

func (s *SubmissionUpdateResult) GetVariables() map[string]any

func (*SubmissionUpdateResult) MarshalJSON 

func (s *SubmissionUpdateResult) MarshalJSON() ([]byte, error)

func (*SubmissionUpdateResult) SetArchivedAt 

func (s *SubmissionUpdateResult) SetArchivedAt(archivedAt *string)

SetArchivedAt sets the ArchivedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetAuditLogURL 

func (s *SubmissionUpdateResult) SetAuditLogURL(auditLogURL *string)

SetAuditLogURL sets the AuditLogURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetCombinedDocumentURL 

func (s *SubmissionUpdateResult) SetCombinedDocumentURL(combinedDocumentURL *string)

SetCombinedDocumentURL sets the CombinedDocumentURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetCompletedAt 

func (s *SubmissionUpdateResult) SetCompletedAt(completedAt *string)

SetCompletedAt sets the CompletedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetCreatedAt 

func (s *SubmissionUpdateResult) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetCreatedByUser 

func (s *SubmissionUpdateResult) SetCreatedByUser(createdByUser *User)

SetCreatedByUser sets the CreatedByUser field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetDocuments 

func (s *SubmissionUpdateResult) SetDocuments(documents []*Document)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetExpireAt 

func (s *SubmissionUpdateResult) SetExpireAt(expireAt *string)

SetExpireAt sets the ExpireAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetID 

func (s *SubmissionUpdateResult) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetName 

func (s *SubmissionUpdateResult) SetName(name *string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetSlug 

func (s *SubmissionUpdateResult) SetSlug(slug string)

SetSlug sets the Slug field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetSource 

func (s *SubmissionUpdateResult) SetSource(source SubmissionSource)

SetSource sets the Source field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetStatus 

func (s *SubmissionUpdateResult) SetStatus(status SubmissionStatus)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetSubmitters 

func (s *SubmissionUpdateResult) SetSubmitters(submitters []*SubmissionSubmitter)

SetSubmitters sets the Submitters field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetSubmittersOrder 

func (s *SubmissionUpdateResult) SetSubmittersOrder(submittersOrder SubmittersOrder)

SetSubmittersOrder sets the SubmittersOrder field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetTemplate 

func (s *SubmissionUpdateResult) SetTemplate(template *TemplateSummary)

SetTemplate sets the Template field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetUpdatedAt 

func (s *SubmissionUpdateResult) SetUpdatedAt(updatedAt string)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) SetVariables 

func (s *SubmissionUpdateResult) SetVariables(variables map[string]any)

SetVariables sets the Variables field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmissionUpdateResult) String 

func (s *SubmissionUpdateResult) String() string

func (*SubmissionUpdateResult) UnmarshalJSON 

func (s *SubmissionUpdateResult) UnmarshalJSON(data []byte) error

type Submitter 

type Submitter struct {
	// Submitter unique ID number.
	ID int `json:"id" url:"id"`
	// Submission unique ID number.
	SubmissionID int `json:"submission_id" url:"submission_id"`
	// Submitter UUID.
	UUID string `json:"uuid" url:"uuid"`
	// The email address of the submitter.
	Email *string `json:"email,omitempty" url:"email,omitempty"`
	// Unique key to be used in the form signing link and embedded form.
	Slug string `json:"slug" url:"slug"`
	// The date and time when the signing request was sent to the submitter.
	SentAt *string `json:"sent_at,omitempty" url:"sent_at,omitempty"`
	// The date and time when the submitter opened the signing form.
	OpenedAt *string `json:"opened_at,omitempty" url:"opened_at,omitempty"`
	// The date and time when the submitter completed the signing form.
	CompletedAt *string `json:"completed_at,omitempty" url:"completed_at,omitempty"`
	// The date and time when the submitter declined the signing form.
	DeclinedAt *string `json:"declined_at,omitempty" url:"declined_at,omitempty"`
	// The date and time when the submitter was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// The date and time when the submitter was last updated.
	UpdatedAt string `json:"updated_at" url:"updated_at"`
	// The name of the submitter.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// The phone number of the submitter.
	Phone *string `json:"phone,omitempty" url:"phone,omitempty"`
	// The status of signing request for the submitter.
	Status SubmitterStatus `json:"status" url:"status"`
	// Your application-specific unique string key to identify this submitter within your app.
	ExternalID *string `json:"external_id,omitempty" url:"external_id,omitempty"`
	// Metadata object with additional submitter information.
	Metadata map[string]any `json:"metadata" url:"metadata"`
	// Submitter preferences.
	Preferences map[string]any     `json:"preferences" url:"preferences"`
	Template    *SubmitterTemplate `json:"template,omitempty" url:"template,omitempty"`
	// An array of events related to the submission.
	SubmissionEvents []*SubmissionEvent `json:"submission_events" url:"submission_events"`
	// An array of pre-filled values for the submitter.
	Values []*FieldValue `json:"values" url:"values"`
	// An array of completed or signed documents by the submitter.
	Documents []*Document `json:"documents" url:"documents"`
	// The role of the submitter in the signing process.
	Role string `json:"role" url:"role"`
	// contains filtered or unexported fields
}

func (*Submitter) GetCompletedAt 

func (s *Submitter) GetCompletedAt() *string

func (*Submitter) GetCreatedAt 

func (s *Submitter) GetCreatedAt() string

func (*Submitter) GetDeclinedAt 

func (s *Submitter) GetDeclinedAt() *string

func (*Submitter) GetDocuments 

func (s *Submitter) GetDocuments() []*Document

func (*Submitter) GetEmail 

func (s *Submitter) GetEmail() *string

func (*Submitter) GetExternalID 

func (s *Submitter) GetExternalID() *string

func (*Submitter) GetExtraProperties 

func (s *Submitter) GetExtraProperties() map[string]interface{}

func (*Submitter) GetID 

func (s *Submitter) GetID() int

func (*Submitter) GetMetadata 

func (s *Submitter) GetMetadata() map[string]any

func (*Submitter) GetName 

func (s *Submitter) GetName() *string

func (*Submitter) GetOpenedAt 

func (s *Submitter) GetOpenedAt() *string

func (*Submitter) GetPhone 

func (s *Submitter) GetPhone() *string

func (*Submitter) GetPreferences 

func (s *Submitter) GetPreferences() map[string]any

func (*Submitter) GetRole 

func (s *Submitter) GetRole() string

func (*Submitter) GetSentAt 

func (s *Submitter) GetSentAt() *string

func (*Submitter) GetSlug 

func (s *Submitter) GetSlug() string

func (*Submitter) GetStatus 

func (s *Submitter) GetStatus() SubmitterStatus

func (*Submitter) GetSubmissionEvents 

func (s *Submitter) GetSubmissionEvents() []*SubmissionEvent

func (*Submitter) GetSubmissionID 

func (s *Submitter) GetSubmissionID() int

func (*Submitter) GetTemplate 

func (s *Submitter) GetTemplate() *SubmitterTemplate

func (*Submitter) GetUUID 

func (s *Submitter) GetUUID() string

func (*Submitter) GetUpdatedAt 

func (s *Submitter) GetUpdatedAt() string

func (*Submitter) GetValues 

func (s *Submitter) GetValues() []*FieldValue

func (*Submitter) MarshalJSON 

func (s *Submitter) MarshalJSON() ([]byte, error)

func (*Submitter) SetCompletedAt 

func (s *Submitter) SetCompletedAt(completedAt *string)

SetCompletedAt sets the CompletedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetCreatedAt 

func (s *Submitter) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetDeclinedAt 

func (s *Submitter) SetDeclinedAt(declinedAt *string)

SetDeclinedAt sets the DeclinedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetDocuments 

func (s *Submitter) SetDocuments(documents []*Document)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetEmail 

func (s *Submitter) SetEmail(email *string)

SetEmail sets the Email field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetExternalID 

func (s *Submitter) SetExternalID(externalID *string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetID 

func (s *Submitter) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetMetadata 

func (s *Submitter) SetMetadata(metadata map[string]any)

SetMetadata sets the Metadata field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetName 

func (s *Submitter) SetName(name *string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetOpenedAt 

func (s *Submitter) SetOpenedAt(openedAt *string)

SetOpenedAt sets the OpenedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetPhone 

func (s *Submitter) SetPhone(phone *string)

SetPhone sets the Phone field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetPreferences 

func (s *Submitter) SetPreferences(preferences map[string]any)

SetPreferences sets the Preferences field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetRole 

func (s *Submitter) SetRole(role string)

SetRole sets the Role field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetSentAt 

func (s *Submitter) SetSentAt(sentAt *string)

SetSentAt sets the SentAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetSlug 

func (s *Submitter) SetSlug(slug string)

SetSlug sets the Slug field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetStatus 

func (s *Submitter) SetStatus(status SubmitterStatus)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetSubmissionEvents 

func (s *Submitter) SetSubmissionEvents(submissionEvents []*SubmissionEvent)

SetSubmissionEvents sets the SubmissionEvents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetSubmissionID 

func (s *Submitter) SetSubmissionID(submissionID int)

SetSubmissionID sets the SubmissionID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetTemplate 

func (s *Submitter) SetTemplate(template *SubmitterTemplate)

SetTemplate sets the Template field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetUUID 

func (s *Submitter) SetUUID(uuid string)

SetUUID sets the UUID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetUpdatedAt 

func (s *Submitter) SetUpdatedAt(updatedAt string)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) SetValues 

func (s *Submitter) SetValues(values []*FieldValue)

SetValues sets the Values field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Submitter) String 

func (s *Submitter) String() string

func (*Submitter) UnmarshalJSON 

func (s *Submitter) UnmarshalJSON(data []byte) error

type SubmitterCreateResult 

type SubmitterCreateResult struct {
	// Submitter unique ID number.
	ID int `json:"id" url:"id"`
	// Submission unique ID number.
	SubmissionID int `json:"submission_id" url:"submission_id"`
	// Submitter UUID.
	UUID string `json:"uuid" url:"uuid"`
	// The email address of the submitter.
	Email *string `json:"email,omitempty" url:"email,omitempty"`
	// Unique key to be used in the form signing link and embedded form.
	Slug string `json:"slug" url:"slug"`
	// The status of signing request for the submitter.
	Status SubmitterStatus `json:"status" url:"status"`
	// An array of pre-filled values for the submitter.
	Values []*FieldValue `json:"values" url:"values"`
	// Metadata object with additional submitter information.
	Metadata map[string]any `json:"metadata" url:"metadata"`
	// The date and time when the signing request was sent to the submitter.
	SentAt *string `json:"sent_at,omitempty" url:"sent_at,omitempty"`
	// The date and time when the submitter opened the signing form.
	OpenedAt *string `json:"opened_at,omitempty" url:"opened_at,omitempty"`
	// The date and time when the submitter completed the signing form.
	CompletedAt *string `json:"completed_at,omitempty" url:"completed_at,omitempty"`
	// The date and time when the submitter declined the signing form.
	DeclinedAt *string `json:"declined_at,omitempty" url:"declined_at,omitempty"`
	// The date and time when the submitter was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// The date and time when the submitter was last updated.
	UpdatedAt string `json:"updated_at" url:"updated_at"`
	// The name of the submitter.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// The phone number of the submitter.
	Phone *string `json:"phone,omitempty" url:"phone,omitempty"`
	// Your application-specific unique string key to identify this submitter within your app.
	ExternalID *string `json:"external_id,omitempty" url:"external_id,omitempty"`
	// Submitter preferences.
	Preferences map[string]any `json:"preferences" url:"preferences"`
	// The role of the submitter in the signing process.
	Role string `json:"role" url:"role"`
	// The `src` URL value to embed the signing form or sign via a link.
	EmbedSrc string `json:"embed_src" url:"embed_src"`
	// contains filtered or unexported fields
}

func (*SubmitterCreateResult) GetCompletedAt 

func (s *SubmitterCreateResult) GetCompletedAt() *string

func (*SubmitterCreateResult) GetCreatedAt 

func (s *SubmitterCreateResult) GetCreatedAt() string

func (*SubmitterCreateResult) GetDeclinedAt 

func (s *SubmitterCreateResult) GetDeclinedAt() *string

func (*SubmitterCreateResult) GetEmail 

func (s *SubmitterCreateResult) GetEmail() *string

func (*SubmitterCreateResult) GetEmbedSrc 

func (s *SubmitterCreateResult) GetEmbedSrc() string

func (*SubmitterCreateResult) GetExternalID 

func (s *SubmitterCreateResult) GetExternalID() *string

func (*SubmitterCreateResult) GetExtraProperties 

func (s *SubmitterCreateResult) GetExtraProperties() map[string]interface{}

func (*SubmitterCreateResult) GetID 

func (s *SubmitterCreateResult) GetID() int

func (*SubmitterCreateResult) GetMetadata 

func (s *SubmitterCreateResult) GetMetadata() map[string]any

func (*SubmitterCreateResult) GetName 

func (s *SubmitterCreateResult) GetName() *string

func (*SubmitterCreateResult) GetOpenedAt 

func (s *SubmitterCreateResult) GetOpenedAt() *string

func (*SubmitterCreateResult) GetPhone 

func (s *SubmitterCreateResult) GetPhone() *string

func (*SubmitterCreateResult) GetPreferences 

func (s *SubmitterCreateResult) GetPreferences() map[string]any

func (*SubmitterCreateResult) GetRole 

func (s *SubmitterCreateResult) GetRole() string

func (*SubmitterCreateResult) GetSentAt 

func (s *SubmitterCreateResult) GetSentAt() *string

func (*SubmitterCreateResult) GetSlug 

func (s *SubmitterCreateResult) GetSlug() string

func (*SubmitterCreateResult) GetStatus 

func (s *SubmitterCreateResult) GetStatus() SubmitterStatus

func (*SubmitterCreateResult) GetSubmissionID 

func (s *SubmitterCreateResult) GetSubmissionID() int

func (*SubmitterCreateResult) GetUUID 

func (s *SubmitterCreateResult) GetUUID() string

func (*SubmitterCreateResult) GetUpdatedAt 

func (s *SubmitterCreateResult) GetUpdatedAt() string

func (*SubmitterCreateResult) GetValues 

func (s *SubmitterCreateResult) GetValues() []*FieldValue

func (*SubmitterCreateResult) MarshalJSON 

func (s *SubmitterCreateResult) MarshalJSON() ([]byte, error)

func (*SubmitterCreateResult) SetCompletedAt 

func (s *SubmitterCreateResult) SetCompletedAt(completedAt *string)

SetCompletedAt sets the CompletedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetCreatedAt 

func (s *SubmitterCreateResult) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetDeclinedAt 

func (s *SubmitterCreateResult) SetDeclinedAt(declinedAt *string)

SetDeclinedAt sets the DeclinedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetEmail 

func (s *SubmitterCreateResult) SetEmail(email *string)

SetEmail sets the Email field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetEmbedSrc 

func (s *SubmitterCreateResult) SetEmbedSrc(embedSrc string)

SetEmbedSrc sets the EmbedSrc field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetExternalID 

func (s *SubmitterCreateResult) SetExternalID(externalID *string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetID 

func (s *SubmitterCreateResult) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetMetadata 

func (s *SubmitterCreateResult) SetMetadata(metadata map[string]any)

SetMetadata sets the Metadata field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetName 

func (s *SubmitterCreateResult) SetName(name *string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetOpenedAt 

func (s *SubmitterCreateResult) SetOpenedAt(openedAt *string)

SetOpenedAt sets the OpenedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetPhone 

func (s *SubmitterCreateResult) SetPhone(phone *string)

SetPhone sets the Phone field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetPreferences 

func (s *SubmitterCreateResult) SetPreferences(preferences map[string]any)

SetPreferences sets the Preferences field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetRole 

func (s *SubmitterCreateResult) SetRole(role string)

SetRole sets the Role field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetSentAt 

func (s *SubmitterCreateResult) SetSentAt(sentAt *string)

SetSentAt sets the SentAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetSlug 

func (s *SubmitterCreateResult) SetSlug(slug string)

SetSlug sets the Slug field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetStatus 

func (s *SubmitterCreateResult) SetStatus(status SubmitterStatus)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetSubmissionID 

func (s *SubmitterCreateResult) SetSubmissionID(submissionID int)

SetSubmissionID sets the SubmissionID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetUUID 

func (s *SubmitterCreateResult) SetUUID(uuid string)

SetUUID sets the UUID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetUpdatedAt 

func (s *SubmitterCreateResult) SetUpdatedAt(updatedAt string)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) SetValues 

func (s *SubmitterCreateResult) SetValues(values []*FieldValue)

SetValues sets the Values field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterCreateResult) String 

func (s *SubmitterCreateResult) String() string

func (*SubmitterCreateResult) UnmarshalJSON 

func (s *SubmitterCreateResult) UnmarshalJSON(data []byte) error

type SubmitterList 

type SubmitterList struct {
	Data       []*Submitter `json:"data,omitempty" url:"data,omitempty"`
	Pagination *Pagination  `json:"pagination,omitempty" url:"pagination,omitempty"`
	// contains filtered or unexported fields
}

func (*SubmitterList) GetData 

func (s *SubmitterList) GetData() []*Submitter

func (*SubmitterList) GetExtraProperties 

func (s *SubmitterList) GetExtraProperties() map[string]interface{}

func (*SubmitterList) GetPagination 

func (s *SubmitterList) GetPagination() *Pagination

func (*SubmitterList) MarshalJSON 

func (s *SubmitterList) MarshalJSON() ([]byte, error)

func (*SubmitterList) SetData 

func (s *SubmitterList) SetData(data []*Submitter)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterList) SetPagination 

func (s *SubmitterList) SetPagination(pagination *Pagination)

SetPagination sets the Pagination field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterList) String 

func (s *SubmitterList) String() string

func (*SubmitterList) UnmarshalJSON 

func (s *SubmitterList) UnmarshalJSON(data []byte) error

type SubmitterStatus 

type SubmitterStatus string
const (
	SubmitterStatusCompleted SubmitterStatus = "completed"
	SubmitterStatusDeclined  SubmitterStatus = "declined"
	SubmitterStatusOpened    SubmitterStatus = "opened"
	SubmitterStatusSent      SubmitterStatus = "sent"
	SubmitterStatusAwaiting  SubmitterStatus = "awaiting"
)

func NewSubmitterStatusFromString 

func NewSubmitterStatusFromString(s string) (SubmitterStatus, error)

func (SubmitterStatus) Ptr 

func (s SubmitterStatus) Ptr() *SubmitterStatus

type SubmitterSummary 

type SubmitterSummary struct {
	// Submitter unique ID number.
	ID int `json:"id" url:"id"`
	// Submission unique ID number.
	SubmissionID int `json:"submission_id" url:"submission_id"`
	// Submitter UUID.
	UUID string `json:"uuid" url:"uuid"`
	// The email address of the submitter.
	Email *string `json:"email,omitempty" url:"email,omitempty"`
	// Unique key to be used in the form signing link and embedded form.
	Slug string `json:"slug" url:"slug"`
	// The date and time when the signing request was sent to the submitter.
	SentAt *string `json:"sent_at,omitempty" url:"sent_at,omitempty"`
	// The date and time when the submitter opened the signing form.
	OpenedAt *string `json:"opened_at,omitempty" url:"opened_at,omitempty"`
	// The date and time when the submitter completed the signing form.
	CompletedAt *string `json:"completed_at,omitempty" url:"completed_at,omitempty"`
	// The date and time when the submitter declined the signing form.
	DeclinedAt *string `json:"declined_at,omitempty" url:"declined_at,omitempty"`
	// The date and time when the submitter was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// The date and time when the submitter was last updated.
	UpdatedAt string `json:"updated_at" url:"updated_at"`
	// The name of the submitter.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// The phone number of the submitter.
	Phone *string `json:"phone,omitempty" url:"phone,omitempty"`
	// Your application-specific unique string key to identify this submitter within your app.
	ExternalID *string `json:"external_id,omitempty" url:"external_id,omitempty"`
	// The status of signing request for the submitter.
	Status SubmitterStatus `json:"status" url:"status"`
	// The role of the submitter in the signing process.
	Role string `json:"role" url:"role"`
	// Metadata object with additional submitter information.
	Metadata map[string]any `json:"metadata" url:"metadata"`
	// Submitter preferences.
	Preferences map[string]any `json:"preferences" url:"preferences"`
	// contains filtered or unexported fields
}

func (*SubmitterSummary) GetCompletedAt 

func (s *SubmitterSummary) GetCompletedAt() *string

func (*SubmitterSummary) GetCreatedAt 

func (s *SubmitterSummary) GetCreatedAt() string

func (*SubmitterSummary) GetDeclinedAt 

func (s *SubmitterSummary) GetDeclinedAt() *string

func (*SubmitterSummary) GetEmail 

func (s *SubmitterSummary) GetEmail() *string

func (*SubmitterSummary) GetExternalID 

func (s *SubmitterSummary) GetExternalID() *string

func (*SubmitterSummary) GetExtraProperties 

func (s *SubmitterSummary) GetExtraProperties() map[string]interface{}

func (*SubmitterSummary) GetID 

func (s *SubmitterSummary) GetID() int

func (*SubmitterSummary) GetMetadata 

func (s *SubmitterSummary) GetMetadata() map[string]any

func (*SubmitterSummary) GetName 

func (s *SubmitterSummary) GetName() *string

func (*SubmitterSummary) GetOpenedAt 

func (s *SubmitterSummary) GetOpenedAt() *string

func (*SubmitterSummary) GetPhone 

func (s *SubmitterSummary) GetPhone() *string

func (*SubmitterSummary) GetPreferences 

func (s *SubmitterSummary) GetPreferences() map[string]any

func (*SubmitterSummary) GetRole 

func (s *SubmitterSummary) GetRole() string

func (*SubmitterSummary) GetSentAt 

func (s *SubmitterSummary) GetSentAt() *string

func (*SubmitterSummary) GetSlug 

func (s *SubmitterSummary) GetSlug() string

func (*SubmitterSummary) GetStatus 

func (s *SubmitterSummary) GetStatus() SubmitterStatus

func (*SubmitterSummary) GetSubmissionID 

func (s *SubmitterSummary) GetSubmissionID() int

func (*SubmitterSummary) GetUUID 

func (s *SubmitterSummary) GetUUID() string

func (*SubmitterSummary) GetUpdatedAt 

func (s *SubmitterSummary) GetUpdatedAt() string

func (*SubmitterSummary) MarshalJSON 

func (s *SubmitterSummary) MarshalJSON() ([]byte, error)

func (*SubmitterSummary) SetCompletedAt 

func (s *SubmitterSummary) SetCompletedAt(completedAt *string)

SetCompletedAt sets the CompletedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetCreatedAt 

func (s *SubmitterSummary) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetDeclinedAt 

func (s *SubmitterSummary) SetDeclinedAt(declinedAt *string)

SetDeclinedAt sets the DeclinedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetEmail 

func (s *SubmitterSummary) SetEmail(email *string)

SetEmail sets the Email field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetExternalID 

func (s *SubmitterSummary) SetExternalID(externalID *string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetID 

func (s *SubmitterSummary) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetMetadata 

func (s *SubmitterSummary) SetMetadata(metadata map[string]any)

SetMetadata sets the Metadata field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetName 

func (s *SubmitterSummary) SetName(name *string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetOpenedAt 

func (s *SubmitterSummary) SetOpenedAt(openedAt *string)

SetOpenedAt sets the OpenedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetPhone 

func (s *SubmitterSummary) SetPhone(phone *string)

SetPhone sets the Phone field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetPreferences 

func (s *SubmitterSummary) SetPreferences(preferences map[string]any)

SetPreferences sets the Preferences field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetRole 

func (s *SubmitterSummary) SetRole(role string)

SetRole sets the Role field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetSentAt 

func (s *SubmitterSummary) SetSentAt(sentAt *string)

SetSentAt sets the SentAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetSlug 

func (s *SubmitterSummary) SetSlug(slug string)

SetSlug sets the Slug field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetStatus 

func (s *SubmitterSummary) SetStatus(status SubmitterStatus)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetSubmissionID 

func (s *SubmitterSummary) SetSubmissionID(submissionID int)

SetSubmissionID sets the SubmissionID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetUUID 

func (s *SubmitterSummary) SetUUID(uuid string)

SetUUID sets the UUID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) SetUpdatedAt 

func (s *SubmitterSummary) SetUpdatedAt(updatedAt string)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterSummary) String 

func (s *SubmitterSummary) String() string

func (*SubmitterSummary) UnmarshalJSON 

func (s *SubmitterSummary) UnmarshalJSON(data []byte) error

type SubmitterTemplate 

type SubmitterTemplate struct {
	// Unique identifier of the document template.
	ID int `json:"id" url:"id"`
	// The name of the template.
	Name string `json:"name" url:"name"`
	// The date and time when the template was created.
	CreatedAt time.Time `json:"created_at" url:"created_at"`
	// The date and time when the template was last updated.
	UpdatedAt time.Time `json:"updated_at" url:"updated_at"`
	// contains filtered or unexported fields
}

func (*SubmitterTemplate) GetCreatedAt 

func (s *SubmitterTemplate) GetCreatedAt() time.Time

func (*SubmitterTemplate) GetExtraProperties 

func (s *SubmitterTemplate) GetExtraProperties() map[string]interface{}

func (*SubmitterTemplate) GetID 

func (s *SubmitterTemplate) GetID() int

func (*SubmitterTemplate) GetName 

func (s *SubmitterTemplate) GetName() string

func (*SubmitterTemplate) GetUpdatedAt 

func (s *SubmitterTemplate) GetUpdatedAt() time.Time

func (*SubmitterTemplate) MarshalJSON 

func (s *SubmitterTemplate) MarshalJSON() ([]byte, error)

func (*SubmitterTemplate) SetCreatedAt 

func (s *SubmitterTemplate) SetCreatedAt(createdAt time.Time)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterTemplate) SetID 

func (s *SubmitterTemplate) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterTemplate) SetName 

func (s *SubmitterTemplate) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterTemplate) SetUpdatedAt 

func (s *SubmitterTemplate) SetUpdatedAt(updatedAt time.Time)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterTemplate) String 

func (s *SubmitterTemplate) String() string

func (*SubmitterTemplate) UnmarshalJSON 

func (s *SubmitterTemplate) UnmarshalJSON(data []byte) error

type SubmitterUpdateResult 

type SubmitterUpdateResult struct {
	// Submitter unique ID number.
	ID int `json:"id" url:"id"`
	// Submission unique ID number.
	SubmissionID int `json:"submission_id" url:"submission_id"`
	// Submitter UUID.
	UUID string `json:"uuid" url:"uuid"`
	// The email address of the submitter.
	Email *string `json:"email,omitempty" url:"email,omitempty"`
	// Unique key to be used in the form signing link and embedded form.
	Slug string `json:"slug" url:"slug"`
	// The date and time when the signing request was sent to the submitter.
	SentAt *string `json:"sent_at,omitempty" url:"sent_at,omitempty"`
	// The date and time when the submitter opened the signing form.
	OpenedAt *string `json:"opened_at,omitempty" url:"opened_at,omitempty"`
	// The date and time when the submitter completed the signing form.
	CompletedAt *string `json:"completed_at,omitempty" url:"completed_at,omitempty"`
	// The date and time when the submitter declined the signing form.
	DeclinedAt *string `json:"declined_at,omitempty" url:"declined_at,omitempty"`
	// The date and time when the submitter was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// The date and time when the submitter was last updated.
	UpdatedAt string `json:"updated_at" url:"updated_at"`
	// The name of the submitter.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// The phone number of the submitter.
	Phone *string `json:"phone,omitempty" url:"phone,omitempty"`
	// The status of signing request for the submitter.
	Status SubmitterStatus `json:"status" url:"status"`
	// Your application-specific unique string key to identify this submitter within your app.
	ExternalID *string `json:"external_id,omitempty" url:"external_id,omitempty"`
	// Metadata object with additional submitter information.
	Metadata map[string]any `json:"metadata" url:"metadata"`
	// Submitter preferences.
	Preferences map[string]any `json:"preferences" url:"preferences"`
	// An array of pre-filled values for the submitter.
	Values []*FieldValue `json:"values" url:"values"`
	// An array of completed or signed documents by the submitter.
	Documents []*Document `json:"documents" url:"documents"`
	// The role of the submitter in the signing process.
	Role string `json:"role" url:"role"`
	// The `src` URL value to embed the signing form or sign via a link.
	EmbedSrc string `json:"embed_src" url:"embed_src"`
	// contains filtered or unexported fields
}

func (*SubmitterUpdateResult) GetCompletedAt 

func (s *SubmitterUpdateResult) GetCompletedAt() *string

func (*SubmitterUpdateResult) GetCreatedAt 

func (s *SubmitterUpdateResult) GetCreatedAt() string

func (*SubmitterUpdateResult) GetDeclinedAt 

func (s *SubmitterUpdateResult) GetDeclinedAt() *string

func (*SubmitterUpdateResult) GetDocuments 

func (s *SubmitterUpdateResult) GetDocuments() []*Document

func (*SubmitterUpdateResult) GetEmail 

func (s *SubmitterUpdateResult) GetEmail() *string

func (*SubmitterUpdateResult) GetEmbedSrc 

func (s *SubmitterUpdateResult) GetEmbedSrc() string

func (*SubmitterUpdateResult) GetExternalID 

func (s *SubmitterUpdateResult) GetExternalID() *string

func (*SubmitterUpdateResult) GetExtraProperties 

func (s *SubmitterUpdateResult) GetExtraProperties() map[string]interface{}

func (*SubmitterUpdateResult) GetID 

func (s *SubmitterUpdateResult) GetID() int

func (*SubmitterUpdateResult) GetMetadata 

func (s *SubmitterUpdateResult) GetMetadata() map[string]any

func (*SubmitterUpdateResult) GetName 

func (s *SubmitterUpdateResult) GetName() *string

func (*SubmitterUpdateResult) GetOpenedAt 

func (s *SubmitterUpdateResult) GetOpenedAt() *string

func (*SubmitterUpdateResult) GetPhone 

func (s *SubmitterUpdateResult) GetPhone() *string

func (*SubmitterUpdateResult) GetPreferences 

func (s *SubmitterUpdateResult) GetPreferences() map[string]any

func (*SubmitterUpdateResult) GetRole 

func (s *SubmitterUpdateResult) GetRole() string

func (*SubmitterUpdateResult) GetSentAt 

func (s *SubmitterUpdateResult) GetSentAt() *string

func (*SubmitterUpdateResult) GetSlug 

func (s *SubmitterUpdateResult) GetSlug() string

func (*SubmitterUpdateResult) GetStatus 

func (s *SubmitterUpdateResult) GetStatus() SubmitterStatus

func (*SubmitterUpdateResult) GetSubmissionID 

func (s *SubmitterUpdateResult) GetSubmissionID() int

func (*SubmitterUpdateResult) GetUUID 

func (s *SubmitterUpdateResult) GetUUID() string

func (*SubmitterUpdateResult) GetUpdatedAt 

func (s *SubmitterUpdateResult) GetUpdatedAt() string

func (*SubmitterUpdateResult) GetValues 

func (s *SubmitterUpdateResult) GetValues() []*FieldValue

func (*SubmitterUpdateResult) MarshalJSON 

func (s *SubmitterUpdateResult) MarshalJSON() ([]byte, error)

func (*SubmitterUpdateResult) SetCompletedAt 

func (s *SubmitterUpdateResult) SetCompletedAt(completedAt *string)

SetCompletedAt sets the CompletedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetCreatedAt 

func (s *SubmitterUpdateResult) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetDeclinedAt 

func (s *SubmitterUpdateResult) SetDeclinedAt(declinedAt *string)

SetDeclinedAt sets the DeclinedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetDocuments 

func (s *SubmitterUpdateResult) SetDocuments(documents []*Document)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetEmail 

func (s *SubmitterUpdateResult) SetEmail(email *string)

SetEmail sets the Email field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetEmbedSrc 

func (s *SubmitterUpdateResult) SetEmbedSrc(embedSrc string)

SetEmbedSrc sets the EmbedSrc field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetExternalID 

func (s *SubmitterUpdateResult) SetExternalID(externalID *string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetID 

func (s *SubmitterUpdateResult) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetMetadata 

func (s *SubmitterUpdateResult) SetMetadata(metadata map[string]any)

SetMetadata sets the Metadata field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetName 

func (s *SubmitterUpdateResult) SetName(name *string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetOpenedAt 

func (s *SubmitterUpdateResult) SetOpenedAt(openedAt *string)

SetOpenedAt sets the OpenedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetPhone 

func (s *SubmitterUpdateResult) SetPhone(phone *string)

SetPhone sets the Phone field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetPreferences 

func (s *SubmitterUpdateResult) SetPreferences(preferences map[string]any)

SetPreferences sets the Preferences field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetRole 

func (s *SubmitterUpdateResult) SetRole(role string)

SetRole sets the Role field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetSentAt 

func (s *SubmitterUpdateResult) SetSentAt(sentAt *string)

SetSentAt sets the SentAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetSlug 

func (s *SubmitterUpdateResult) SetSlug(slug string)

SetSlug sets the Slug field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetStatus 

func (s *SubmitterUpdateResult) SetStatus(status SubmitterStatus)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetSubmissionID 

func (s *SubmitterUpdateResult) SetSubmissionID(submissionID int)

SetSubmissionID sets the SubmissionID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetUUID 

func (s *SubmitterUpdateResult) SetUUID(uuid string)

SetUUID sets the UUID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetUpdatedAt 

func (s *SubmitterUpdateResult) SetUpdatedAt(updatedAt string)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) SetValues 

func (s *SubmitterUpdateResult) SetValues(values []*FieldValue)

SetValues sets the Values field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SubmitterUpdateResult) String 

func (s *SubmitterUpdateResult) String() string

func (*SubmitterUpdateResult) UnmarshalJSON 

func (s *SubmitterUpdateResult) UnmarshalJSON(data []byte) error

type SubmittersOrder 

type SubmittersOrder string
const (
	SubmittersOrderRandom    SubmittersOrder = "random"
	SubmittersOrderPreserved SubmittersOrder = "preserved"
)

func NewSubmittersOrderFromString 

func NewSubmittersOrderFromString(s string) (SubmittersOrder, error)

func (SubmittersOrder) Ptr 

func (s SubmittersOrder) Ptr() *SubmittersOrder

type Template 

type Template struct {
	// Unique identifier of the document template.
	ID int `json:"id" url:"id"`
	// Unique slug of the document template.
	Slug string `json:"slug" url:"slug"`
	// The name of the template.
	Name string `json:"name" url:"name"`
	// Template preferences.
	Preferences map[string]any `json:"preferences" url:"preferences"`
	// List of documents attached to the template.
	Schema []*SchemaDocument `json:"schema" url:"schema"`
	// List of fields to be filled in the template.
	Fields []*Field `json:"fields" url:"fields"`
	// Schema of the dynamic document content variables used in the template.
	VariablesSchema map[string]any `json:"variables_schema" url:"variables_schema"`
	// The list of submitters for the template.
	Submitters []*TemplateSubmitter `json:"submitters" url:"submitters"`
	// Unique identifier of the author of the template.
	AuthorID int `json:"author_id" url:"author_id"`
	// Date and time when the template was archived.
	ArchivedAt *string `json:"archived_at,omitempty" url:"archived_at,omitempty"`
	// The date and time when the template was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// The date and time when the template was last updated.
	UpdatedAt string `json:"updated_at" url:"updated_at"`
	// Source of the template.
	Source TemplateSource `json:"source" url:"source"`
	// Your application-specific unique string key to identify this template within your app.
	ExternalID *string `json:"external_id,omitempty" url:"external_id,omitempty"`
	// Unique identifier of the folder where the template is located.
	FolderID int `json:"folder_id" url:"folder_id"`
	// Folder name where the template is located.
	FolderName string `json:"folder_name" url:"folder_name"`
	// Indicates if the template is accessible by link.
	SharedLink *bool `json:"shared_link,omitempty" url:"shared_link,omitempty"`
	Author     *User `json:"author" url:"author"`
	// List of documents attached to the template.
	Documents []*TemplateDocument `json:"documents" url:"documents"`
	// contains filtered or unexported fields
}

func (*Template) GetArchivedAt 

func (t *Template) GetArchivedAt() *string

func (*Template) GetAuthor 

func (t *Template) GetAuthor() *User

func (*Template) GetAuthorID 

func (t *Template) GetAuthorID() int

func (*Template) GetCreatedAt 

func (t *Template) GetCreatedAt() string

func (*Template) GetDocuments 

func (t *Template) GetDocuments() []*TemplateDocument

func (*Template) GetExternalID 

func (t *Template) GetExternalID() *string

func (*Template) GetExtraProperties 

func (t *Template) GetExtraProperties() map[string]interface{}

func (*Template) GetFields 

func (t *Template) GetFields() []*Field

func (*Template) GetFolderID 

func (t *Template) GetFolderID() int

func (*Template) GetFolderName 

func (t *Template) GetFolderName() string

func (*Template) GetID 

func (t *Template) GetID() int

func (*Template) GetName 

func (t *Template) GetName() string

func (*Template) GetPreferences 

func (t *Template) GetPreferences() map[string]any

func (*Template) GetSchema 

func (t *Template) GetSchema() []*SchemaDocument
func (t *Template) GetSharedLink() *bool

func (*Template) GetSlug 

func (t *Template) GetSlug() string

func (*Template) GetSource 

func (t *Template) GetSource() TemplateSource

func (*Template) GetSubmitters 

func (t *Template) GetSubmitters() []*TemplateSubmitter

func (*Template) GetUpdatedAt 

func (t *Template) GetUpdatedAt() string

func (*Template) GetVariablesSchema 

func (t *Template) GetVariablesSchema() map[string]any

func (*Template) MarshalJSON 

func (t *Template) MarshalJSON() ([]byte, error)

func (*Template) SetArchivedAt 

func (t *Template) SetArchivedAt(archivedAt *string)

SetArchivedAt sets the ArchivedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetAuthor 

func (t *Template) SetAuthor(author *User)

SetAuthor sets the Author field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetAuthorID 

func (t *Template) SetAuthorID(authorID int)

SetAuthorID sets the AuthorID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetCreatedAt 

func (t *Template) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetDocuments 

func (t *Template) SetDocuments(documents []*TemplateDocument)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetExternalID 

func (t *Template) SetExternalID(externalID *string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetFields 

func (t *Template) SetFields(fields []*Field)

SetFields sets the Fields field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetFolderID 

func (t *Template) SetFolderID(folderID int)

SetFolderID sets the FolderID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetFolderName 

func (t *Template) SetFolderName(folderName string)

SetFolderName sets the FolderName field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetID 

func (t *Template) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetName 

func (t *Template) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetPreferences 

func (t *Template) SetPreferences(preferences map[string]any)

SetPreferences sets the Preferences field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetSchema 

func (t *Template) SetSchema(schema []*SchemaDocument)

SetSchema sets the Schema field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization. 

func (t *Template) SetSharedLink(sharedLink *bool)

SetSharedLink sets the SharedLink field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetSlug 

func (t *Template) SetSlug(slug string)

SetSlug sets the Slug field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetSource 

func (t *Template) SetSource(source TemplateSource)

SetSource sets the Source field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetSubmitters 

func (t *Template) SetSubmitters(submitters []*TemplateSubmitter)

SetSubmitters sets the Submitters field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetUpdatedAt 

func (t *Template) SetUpdatedAt(updatedAt string)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) SetVariablesSchema 

func (t *Template) SetVariablesSchema(variablesSchema map[string]any)

SetVariablesSchema sets the VariablesSchema field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Template) String 

func (t *Template) String() string

func (*Template) UnmarshalJSON 

func (t *Template) UnmarshalJSON(data []byte) error

type TemplateArchiveResult 

type TemplateArchiveResult struct {
	// Template unique ID number.
	ID int `json:"id" url:"id"`
	// Date and time when the template was archived.
	ArchivedAt *string `json:"archived_at,omitempty" url:"archived_at,omitempty"`
	// contains filtered or unexported fields
}

func (*TemplateArchiveResult) GetArchivedAt 

func (t *TemplateArchiveResult) GetArchivedAt() *string

func (*TemplateArchiveResult) GetExtraProperties 

func (t *TemplateArchiveResult) GetExtraProperties() map[string]interface{}

func (*TemplateArchiveResult) GetID 

func (t *TemplateArchiveResult) GetID() int

func (*TemplateArchiveResult) MarshalJSON 

func (t *TemplateArchiveResult) MarshalJSON() ([]byte, error)

func (*TemplateArchiveResult) SetArchivedAt 

func (t *TemplateArchiveResult) SetArchivedAt(archivedAt *string)

SetArchivedAt sets the ArchivedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateArchiveResult) SetID 

func (t *TemplateArchiveResult) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateArchiveResult) String 

func (t *TemplateArchiveResult) String() string

func (*TemplateArchiveResult) UnmarshalJSON 

func (t *TemplateArchiveResult) UnmarshalJSON(data []byte) error

type TemplateArchivedEvent 

type TemplateArchivedEvent struct {
	// The event type.
	EventType EventType `json:"event_type" url:"event_type"`
	// The event timestamp.
	Timestamp time.Time              `json:"timestamp" url:"timestamp"`
	Data      *TemplateArchiveResult `json:"data" url:"data"`
	// contains filtered or unexported fields
}

func (*TemplateArchivedEvent) GetData 

func (t *TemplateArchivedEvent) GetData() *TemplateArchiveResult

func (*TemplateArchivedEvent) GetEventType 

func (t *TemplateArchivedEvent) GetEventType() EventType

func (*TemplateArchivedEvent) GetExtraProperties 

func (t *TemplateArchivedEvent) GetExtraProperties() map[string]interface{}

func (*TemplateArchivedEvent) GetTimestamp 

func (t *TemplateArchivedEvent) GetTimestamp() time.Time

func (*TemplateArchivedEvent) MarshalJSON 

func (t *TemplateArchivedEvent) MarshalJSON() ([]byte, error)

func (*TemplateArchivedEvent) SetData 

func (t *TemplateArchivedEvent) SetData(data *TemplateArchiveResult)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateArchivedEvent) SetEventType 

func (t *TemplateArchivedEvent) SetEventType(eventType EventType)

SetEventType sets the EventType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateArchivedEvent) SetTimestamp 

func (t *TemplateArchivedEvent) SetTimestamp(timestamp time.Time)

SetTimestamp sets the Timestamp field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateArchivedEvent) String 

func (t *TemplateArchivedEvent) String() string

func (*TemplateArchivedEvent) UnmarshalJSON 

func (t *TemplateArchivedEvent) UnmarshalJSON(data []byte) error

type TemplateCreatedEvent 

type TemplateCreatedEvent struct {
	// The event type.
	EventType EventType `json:"event_type" url:"event_type"`
	// The event timestamp.
	Timestamp time.Time `json:"timestamp" url:"timestamp"`
	Data      *Template `json:"data" url:"data"`
	// contains filtered or unexported fields
}

func (*TemplateCreatedEvent) GetData 

func (t *TemplateCreatedEvent) GetData() *Template

func (*TemplateCreatedEvent) GetEventType 

func (t *TemplateCreatedEvent) GetEventType() EventType

func (*TemplateCreatedEvent) GetExtraProperties 

func (t *TemplateCreatedEvent) GetExtraProperties() map[string]interface{}

func (*TemplateCreatedEvent) GetTimestamp 

func (t *TemplateCreatedEvent) GetTimestamp() time.Time

func (*TemplateCreatedEvent) MarshalJSON 

func (t *TemplateCreatedEvent) MarshalJSON() ([]byte, error)

func (*TemplateCreatedEvent) SetData 

func (t *TemplateCreatedEvent) SetData(data *Template)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateCreatedEvent) SetEventType 

func (t *TemplateCreatedEvent) SetEventType(eventType EventType)

SetEventType sets the EventType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateCreatedEvent) SetTimestamp 

func (t *TemplateCreatedEvent) SetTimestamp(timestamp time.Time)

SetTimestamp sets the Timestamp field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateCreatedEvent) String 

func (t *TemplateCreatedEvent) String() string

func (*TemplateCreatedEvent) UnmarshalJSON 

func (t *TemplateCreatedEvent) UnmarshalJSON(data []byte) error

type TemplateDocument 

type TemplateDocument struct {
	// Unique identifier of the document.
	ID int `json:"id" url:"id"`
	// Unique identifier of the document.
	UUID string `json:"uuid" url:"uuid"`
	// URL of the document.
	URL string `json:"url" url:"url"`
	// Document preview image URL.
	PreviewImageURL string `json:"preview_image_url" url:"preview_image_url"`
	// Document filename.
	Filename string `json:"filename" url:"filename"`
	// contains filtered or unexported fields
}

func (*TemplateDocument) GetExtraProperties 

func (t *TemplateDocument) GetExtraProperties() map[string]interface{}

func (*TemplateDocument) GetFilename 

func (t *TemplateDocument) GetFilename() string

func (*TemplateDocument) GetID 

func (t *TemplateDocument) GetID() int

func (*TemplateDocument) GetPreviewImageURL 

func (t *TemplateDocument) GetPreviewImageURL() string

func (*TemplateDocument) GetURL 

func (t *TemplateDocument) GetURL() string

func (*TemplateDocument) GetUUID 

func (t *TemplateDocument) GetUUID() string

func (*TemplateDocument) MarshalJSON 

func (t *TemplateDocument) MarshalJSON() ([]byte, error)

func (*TemplateDocument) SetFilename 

func (t *TemplateDocument) SetFilename(filename string)

SetFilename sets the Filename field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateDocument) SetID 

func (t *TemplateDocument) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateDocument) SetPreviewImageURL 

func (t *TemplateDocument) SetPreviewImageURL(previewImageURL string)

SetPreviewImageURL sets the PreviewImageURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateDocument) SetURL 

func (t *TemplateDocument) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateDocument) SetUUID 

func (t *TemplateDocument) SetUUID(uuid string)

SetUUID sets the UUID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateDocument) String 

func (t *TemplateDocument) String() string

func (*TemplateDocument) UnmarshalJSON 

func (t *TemplateDocument) UnmarshalJSON(data []byte) error

type TemplateList 

type TemplateList struct {
	// List of templates.
	Data       []*Template `json:"data" url:"data"`
	Pagination *Pagination `json:"pagination" url:"pagination"`
	// contains filtered or unexported fields
}

func (*TemplateList) GetData 

func (t *TemplateList) GetData() []*Template

func (*TemplateList) GetExtraProperties 

func (t *TemplateList) GetExtraProperties() map[string]interface{}

func (*TemplateList) GetPagination 

func (t *TemplateList) GetPagination() *Pagination

func (*TemplateList) MarshalJSON 

func (t *TemplateList) MarshalJSON() ([]byte, error)

func (*TemplateList) SetData 

func (t *TemplateList) SetData(data []*Template)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateList) SetPagination 

func (t *TemplateList) SetPagination(pagination *Pagination)

SetPagination sets the Pagination field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateList) String 

func (t *TemplateList) String() string

func (*TemplateList) UnmarshalJSON 

func (t *TemplateList) UnmarshalJSON(data []byte) error

type TemplatePermanentlyDeleteResult 

type TemplatePermanentlyDeleteResult struct {
	// Template unique ID number.
	ID int `json:"id" url:"id"`
	// Date and time when the template was archived.
	ArchivedAt *string `json:"archived_at,omitempty" url:"archived_at,omitempty"`
	// contains filtered or unexported fields
}

func (*TemplatePermanentlyDeleteResult) GetArchivedAt 

func (t *TemplatePermanentlyDeleteResult) GetArchivedAt() *string

func (*TemplatePermanentlyDeleteResult) GetExtraProperties 

func (t *TemplatePermanentlyDeleteResult) GetExtraProperties() map[string]interface{}

func (*TemplatePermanentlyDeleteResult) GetID 

func (t *TemplatePermanentlyDeleteResult) GetID() int

func (*TemplatePermanentlyDeleteResult) MarshalJSON 

func (t *TemplatePermanentlyDeleteResult) MarshalJSON() ([]byte, error)

func (*TemplatePermanentlyDeleteResult) SetArchivedAt 

func (t *TemplatePermanentlyDeleteResult) SetArchivedAt(archivedAt *string)

SetArchivedAt sets the ArchivedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplatePermanentlyDeleteResult) SetID 

func (t *TemplatePermanentlyDeleteResult) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplatePermanentlyDeleteResult) String 

func (t *TemplatePermanentlyDeleteResult) String() string

func (*TemplatePermanentlyDeleteResult) UnmarshalJSON 

func (t *TemplatePermanentlyDeleteResult) UnmarshalJSON(data []byte) error

type TemplateSource 

type TemplateSource string
const (
	TemplateSourceNative TemplateSource = "native"
	TemplateSourceAPI    TemplateSource = "api"
	TemplateSourceEmbed  TemplateSource = "embed"
)

func NewTemplateSourceFromString 

func NewTemplateSourceFromString(s string) (TemplateSource, error)

func (TemplateSource) Ptr 

func (t TemplateSource) Ptr() *TemplateSource

type TemplateSubmitter 

type TemplateSubmitter struct {
	// The name of the submitter.
	Name string `json:"name" url:"name"`
	// Unique identifier of the submitter.
	UUID string `json:"uuid" url:"uuid"`
	// contains filtered or unexported fields
}

func (*TemplateSubmitter) GetExtraProperties 

func (t *TemplateSubmitter) GetExtraProperties() map[string]interface{}

func (*TemplateSubmitter) GetName 

func (t *TemplateSubmitter) GetName() string

func (*TemplateSubmitter) GetUUID 

func (t *TemplateSubmitter) GetUUID() string

func (*TemplateSubmitter) MarshalJSON 

func (t *TemplateSubmitter) MarshalJSON() ([]byte, error)

func (*TemplateSubmitter) SetName 

func (t *TemplateSubmitter) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateSubmitter) SetUUID 

func (t *TemplateSubmitter) SetUUID(uuid string)

SetUUID sets the UUID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateSubmitter) String 

func (t *TemplateSubmitter) String() string

func (*TemplateSubmitter) UnmarshalJSON 

func (t *TemplateSubmitter) UnmarshalJSON(data []byte) error

type TemplateSummary 

type TemplateSummary struct {
	// Unique identifier of the document template.
	ID int `json:"id" url:"id"`
	// The name of the template.
	Name string `json:"name" url:"name"`
	// Your application-specific unique string key to identify this template within your app.
	ExternalID *string `json:"external_id,omitempty" url:"external_id,omitempty"`
	// Folder name where the template is located.
	FolderName string `json:"folder_name" url:"folder_name"`
	// The date and time when the template was created.
	CreatedAt string `json:"created_at" url:"created_at"`
	// The date and time when the template was last updated.
	UpdatedAt string `json:"updated_at" url:"updated_at"`
	// contains filtered or unexported fields
}

func (*TemplateSummary) GetCreatedAt 

func (t *TemplateSummary) GetCreatedAt() string

func (*TemplateSummary) GetExternalID 

func (t *TemplateSummary) GetExternalID() *string

func (*TemplateSummary) GetExtraProperties 

func (t *TemplateSummary) GetExtraProperties() map[string]interface{}

func (*TemplateSummary) GetFolderName 

func (t *TemplateSummary) GetFolderName() string

func (*TemplateSummary) GetID 

func (t *TemplateSummary) GetID() int

func (*TemplateSummary) GetName 

func (t *TemplateSummary) GetName() string

func (*TemplateSummary) GetUpdatedAt 

func (t *TemplateSummary) GetUpdatedAt() string

func (*TemplateSummary) MarshalJSON 

func (t *TemplateSummary) MarshalJSON() ([]byte, error)

func (*TemplateSummary) SetCreatedAt 

func (t *TemplateSummary) SetCreatedAt(createdAt string)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateSummary) SetExternalID 

func (t *TemplateSummary) SetExternalID(externalID *string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateSummary) SetFolderName 

func (t *TemplateSummary) SetFolderName(folderName string)

SetFolderName sets the FolderName field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateSummary) SetID 

func (t *TemplateSummary) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateSummary) SetName 

func (t *TemplateSummary) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateSummary) SetUpdatedAt 

func (t *TemplateSummary) SetUpdatedAt(updatedAt string)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateSummary) String 

func (t *TemplateSummary) String() string

func (*TemplateSummary) UnmarshalJSON 

func (t *TemplateSummary) UnmarshalJSON(data []byte) error

type TemplateUpdateResult 

type TemplateUpdateResult struct {
	// Template unique ID number.
	ID int `json:"id" url:"id"`
	// Date and time when the template was last updated.
	UpdatedAt string `json:"updated_at" url:"updated_at"`
	// contains filtered or unexported fields
}

func (*TemplateUpdateResult) GetExtraProperties 

func (t *TemplateUpdateResult) GetExtraProperties() map[string]interface{}

func (*TemplateUpdateResult) GetID 

func (t *TemplateUpdateResult) GetID() int

func (*TemplateUpdateResult) GetUpdatedAt 

func (t *TemplateUpdateResult) GetUpdatedAt() string

func (*TemplateUpdateResult) MarshalJSON 

func (t *TemplateUpdateResult) MarshalJSON() ([]byte, error)

func (*TemplateUpdateResult) SetID 

func (t *TemplateUpdateResult) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateUpdateResult) SetUpdatedAt 

func (t *TemplateUpdateResult) SetUpdatedAt(updatedAt string)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateUpdateResult) String 

func (t *TemplateUpdateResult) String() string

func (*TemplateUpdateResult) UnmarshalJSON 

func (t *TemplateUpdateResult) UnmarshalJSON(data []byte) error

type TemplateUpdatedEvent 

type TemplateUpdatedEvent struct {
	// The event type.
	EventType EventType `json:"event_type" url:"event_type"`
	// The event timestamp.
	Timestamp time.Time `json:"timestamp" url:"timestamp"`
	Data      *Template `json:"data" url:"data"`
	// contains filtered or unexported fields
}

func (*TemplateUpdatedEvent) GetData 

func (t *TemplateUpdatedEvent) GetData() *Template

func (*TemplateUpdatedEvent) GetEventType 

func (t *TemplateUpdatedEvent) GetEventType() EventType

func (*TemplateUpdatedEvent) GetExtraProperties 

func (t *TemplateUpdatedEvent) GetExtraProperties() map[string]interface{}

func (*TemplateUpdatedEvent) GetTimestamp 

func (t *TemplateUpdatedEvent) GetTimestamp() time.Time

func (*TemplateUpdatedEvent) MarshalJSON 

func (t *TemplateUpdatedEvent) MarshalJSON() ([]byte, error)

func (*TemplateUpdatedEvent) SetData 

func (t *TemplateUpdatedEvent) SetData(data *Template)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateUpdatedEvent) SetEventType 

func (t *TemplateUpdatedEvent) SetEventType(eventType EventType)

SetEventType sets the EventType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateUpdatedEvent) SetTimestamp 

func (t *TemplateUpdatedEvent) SetTimestamp(timestamp time.Time)

SetTimestamp sets the Timestamp field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TemplateUpdatedEvent) String 

func (t *TemplateUpdatedEvent) String() string

func (*TemplateUpdatedEvent) UnmarshalJSON 

func (t *TemplateUpdatedEvent) UnmarshalJSON(data []byte) error

type UpdateSubmissionParams 

type UpdateSubmissionParams struct {
	// The name of the submission.
	Name string `json:"name,omitempty" url:"-"`
	// The date and time when the submission will expire and no longer be available. Pass `null` to remove the expiration.
	ExpireAt string `json:"expire_at,omitempty" url:"-"`
	// Set `true` to archive the submission or `false` to unarchive it.
	Archived *bool `json:"archived,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*UpdateSubmissionParams) MarshalJSON 

func (u *UpdateSubmissionParams) MarshalJSON() ([]byte, error)

func (*UpdateSubmissionParams) SetArchived 

func (u *UpdateSubmissionParams) SetArchived(archived *bool)

SetArchived sets the Archived field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmissionParams) SetExpireAt 

func (u *UpdateSubmissionParams) SetExpireAt(expireAt string)

SetExpireAt sets the ExpireAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmissionParams) SetName 

func (u *UpdateSubmissionParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmissionParams) UnmarshalJSON 

func (u *UpdateSubmissionParams) UnmarshalJSON(data []byte) error

type UpdateSubmitterFieldParams 

type UpdateSubmitterFieldParams struct {
	// Document template field name.
	Name         string        `json:"name" url:"name"`
	DefaultValue *DefaultValue `json:"default_value,omitempty" url:"default_value,omitempty"`
	// Default value of the field as a plain string. Alias of `default_value` that takes precedence when both are provided.
	Value string `json:"value,omitempty" url:"value,omitempty"`
	// Set `true` to make it impossible for the submitter to edit predefined field value.
	Readonly *bool `json:"readonly,omitempty" url:"readonly,omitempty"`
	// Set `true` to make the field required.
	Required    *bool                                  `json:"required,omitempty" url:"required,omitempty"`
	Validation  *UpdateSubmitterFieldValidationParams  `json:"validation,omitempty" url:"validation,omitempty"`
	Preferences *UpdateSubmitterFieldPreferencesParams `json:"preferences,omitempty" url:"preferences,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateSubmitterFieldParams) GetDefaultValue 

func (u *UpdateSubmitterFieldParams) GetDefaultValue() *DefaultValue

func (*UpdateSubmitterFieldParams) GetExtraProperties 

func (u *UpdateSubmitterFieldParams) GetExtraProperties() map[string]interface{}

func (*UpdateSubmitterFieldParams) GetName 

func (u *UpdateSubmitterFieldParams) GetName() string

func (*UpdateSubmitterFieldParams) GetPreferences 

func (u *UpdateSubmitterFieldParams) GetPreferences() *UpdateSubmitterFieldPreferencesParams

func (*UpdateSubmitterFieldParams) GetReadonly 

func (u *UpdateSubmitterFieldParams) GetReadonly() *bool

func (*UpdateSubmitterFieldParams) GetRequired 

func (u *UpdateSubmitterFieldParams) GetRequired() *bool

func (*UpdateSubmitterFieldParams) GetValidation 

func (u *UpdateSubmitterFieldParams) GetValidation() *UpdateSubmitterFieldValidationParams

func (*UpdateSubmitterFieldParams) GetValue 

func (u *UpdateSubmitterFieldParams) GetValue() string

func (*UpdateSubmitterFieldParams) MarshalJSON 

func (u *UpdateSubmitterFieldParams) MarshalJSON() ([]byte, error)

func (*UpdateSubmitterFieldParams) SetDefaultValue 

func (u *UpdateSubmitterFieldParams) SetDefaultValue(defaultValue *DefaultValue)

SetDefaultValue sets the DefaultValue field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldParams) SetName 

func (u *UpdateSubmitterFieldParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldParams) SetPreferences 

func (u *UpdateSubmitterFieldParams) SetPreferences(preferences *UpdateSubmitterFieldPreferencesParams)

SetPreferences sets the Preferences field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldParams) SetReadonly 

func (u *UpdateSubmitterFieldParams) SetReadonly(readonly *bool)

SetReadonly sets the Readonly field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldParams) SetRequired 

func (u *UpdateSubmitterFieldParams) SetRequired(required *bool)

SetRequired sets the Required field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldParams) SetValidation 

func (u *UpdateSubmitterFieldParams) SetValidation(validation *UpdateSubmitterFieldValidationParams)

SetValidation sets the Validation field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldParams) SetValue 

func (u *UpdateSubmitterFieldParams) SetValue(value string)

SetValue sets the Value field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldParams) String 

func (u *UpdateSubmitterFieldParams) String() string

func (*UpdateSubmitterFieldParams) UnmarshalJSON 

func (u *UpdateSubmitterFieldParams) UnmarshalJSON(data []byte) error

type UpdateSubmitterFieldPreferencesParams 

type UpdateSubmitterFieldPreferencesParams struct {
	// Font size of the field value in pixels.
	FontSize *int `json:"font_size,omitempty" url:"font_size,omitempty"`
	// Font type of the field value.
	FontType FieldFontType `json:"font_type,omitempty" url:"font_type,omitempty"`
	// Font family of the field value.
	Font FieldFont `json:"font,omitempty" url:"font,omitempty"`
	// Font color of the field value.
	Color string `json:"color,omitempty" url:"color,omitempty"`
	// Field box background color.
	Background string `json:"background,omitempty" url:"background,omitempty"`
	// Horizontal alignment of the field text value.
	Align FieldAlign `json:"align,omitempty" url:"align,omitempty"`
	// Vertical alignment of the field text value.
	Valign FieldValign `json:"valign,omitempty" url:"valign,omitempty"`
	// The data format for different field types.<br>- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).<br>- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.<br>- Number field: accepts currency formats such as usd, eur, gbp.
	Format string `json:"format,omitempty" url:"format,omitempty"`
	// Price value of the payment field. Only for payment fields.
	Price *float64 `json:"price,omitempty" url:"price,omitempty"`
	// Currency value of the payment field. Only for payment fields.
	Currency Currency `json:"currency,omitempty" url:"currency,omitempty"`
	// Set `true` to make sensitive data masked on the document.
	Mask *UpdateSubmitterFieldPreferencesParamsMask `json:"mask,omitempty" url:"mask,omitempty"`
	// An array of signature reasons to choose from.
	Reasons []string `json:"reasons,omitempty" url:"reasons,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateSubmitterFieldPreferencesParams) GetAlign 

func (u *UpdateSubmitterFieldPreferencesParams) GetAlign() FieldAlign

func (*UpdateSubmitterFieldPreferencesParams) GetBackground 

func (u *UpdateSubmitterFieldPreferencesParams) GetBackground() string

func (*UpdateSubmitterFieldPreferencesParams) GetColor 

func (u *UpdateSubmitterFieldPreferencesParams) GetColor() string

func (*UpdateSubmitterFieldPreferencesParams) GetCurrency 

func (u *UpdateSubmitterFieldPreferencesParams) GetCurrency() Currency

func (*UpdateSubmitterFieldPreferencesParams) GetExtraProperties 

func (u *UpdateSubmitterFieldPreferencesParams) GetExtraProperties() map[string]interface{}

func (*UpdateSubmitterFieldPreferencesParams) GetFont 

func (u *UpdateSubmitterFieldPreferencesParams) GetFont() FieldFont

func (*UpdateSubmitterFieldPreferencesParams) GetFontSize 

func (u *UpdateSubmitterFieldPreferencesParams) GetFontSize() *int

func (*UpdateSubmitterFieldPreferencesParams) GetFontType 

func (u *UpdateSubmitterFieldPreferencesParams) GetFontType() FieldFontType

func (*UpdateSubmitterFieldPreferencesParams) GetFormat 

func (u *UpdateSubmitterFieldPreferencesParams) GetFormat() string

func (*UpdateSubmitterFieldPreferencesParams) GetMask 

func (u *UpdateSubmitterFieldPreferencesParams) GetMask() *UpdateSubmitterFieldPreferencesParamsMask

func (*UpdateSubmitterFieldPreferencesParams) GetPrice 

func (u *UpdateSubmitterFieldPreferencesParams) GetPrice() *float64

func (*UpdateSubmitterFieldPreferencesParams) GetReasons 

func (u *UpdateSubmitterFieldPreferencesParams) GetReasons() []string

func (*UpdateSubmitterFieldPreferencesParams) GetValign 

func (u *UpdateSubmitterFieldPreferencesParams) GetValign() FieldValign

func (*UpdateSubmitterFieldPreferencesParams) MarshalJSON 

func (u *UpdateSubmitterFieldPreferencesParams) MarshalJSON() ([]byte, error)

func (*UpdateSubmitterFieldPreferencesParams) SetAlign 

func (u *UpdateSubmitterFieldPreferencesParams) SetAlign(align FieldAlign)

SetAlign sets the Align field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldPreferencesParams) SetBackground 

func (u *UpdateSubmitterFieldPreferencesParams) SetBackground(background string)

SetBackground sets the Background field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldPreferencesParams) SetColor 

func (u *UpdateSubmitterFieldPreferencesParams) SetColor(color string)

SetColor sets the Color field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldPreferencesParams) SetCurrency 

func (u *UpdateSubmitterFieldPreferencesParams) SetCurrency(currency Currency)

SetCurrency sets the Currency field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldPreferencesParams) SetFont 

func (u *UpdateSubmitterFieldPreferencesParams) SetFont(font FieldFont)

SetFont sets the Font field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldPreferencesParams) SetFontSize 

func (u *UpdateSubmitterFieldPreferencesParams) SetFontSize(fontSize *int)

SetFontSize sets the FontSize field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldPreferencesParams) SetFontType 

func (u *UpdateSubmitterFieldPreferencesParams) SetFontType(fontType FieldFontType)

SetFontType sets the FontType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldPreferencesParams) SetFormat 

func (u *UpdateSubmitterFieldPreferencesParams) SetFormat(format string)

SetFormat sets the Format field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldPreferencesParams) SetMask 

func (u *UpdateSubmitterFieldPreferencesParams) SetMask(mask *UpdateSubmitterFieldPreferencesParamsMask)

SetMask sets the Mask field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldPreferencesParams) SetPrice 

func (u *UpdateSubmitterFieldPreferencesParams) SetPrice(price *float64)

SetPrice sets the Price field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldPreferencesParams) SetReasons 

func (u *UpdateSubmitterFieldPreferencesParams) SetReasons(reasons []string)

SetReasons sets the Reasons field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldPreferencesParams) SetValign 

func (u *UpdateSubmitterFieldPreferencesParams) SetValign(valign FieldValign)

SetValign sets the Valign field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldPreferencesParams) String 

func (u *UpdateSubmitterFieldPreferencesParams) String() string

func (*UpdateSubmitterFieldPreferencesParams) UnmarshalJSON 

func (u *UpdateSubmitterFieldPreferencesParams) UnmarshalJSON(data []byte) error

type UpdateSubmitterFieldPreferencesParamsMask 

type UpdateSubmitterFieldPreferencesParamsMask struct {
	Integer int
	Boolean bool
	// contains filtered or unexported fields
}

Set `true` to make sensitive data masked on the document.

func (*UpdateSubmitterFieldPreferencesParamsMask) Accept 

func (u *UpdateSubmitterFieldPreferencesParamsMask) Accept(visitor UpdateSubmitterFieldPreferencesParamsMaskVisitor) error

func (*UpdateSubmitterFieldPreferencesParamsMask) GetBoolean 

func (u *UpdateSubmitterFieldPreferencesParamsMask) GetBoolean() bool

func (*UpdateSubmitterFieldPreferencesParamsMask) GetInteger 

func (u *UpdateSubmitterFieldPreferencesParamsMask) GetInteger() int

func (UpdateSubmitterFieldPreferencesParamsMask) MarshalJSON 

func (u UpdateSubmitterFieldPreferencesParamsMask) MarshalJSON() ([]byte, error)

func (*UpdateSubmitterFieldPreferencesParamsMask) UnmarshalJSON 

func (u *UpdateSubmitterFieldPreferencesParamsMask) UnmarshalJSON(data []byte) error

type UpdateSubmitterFieldPreferencesParamsMaskVisitor 

type UpdateSubmitterFieldPreferencesParamsMaskVisitor interface {
	VisitInteger(int) error
	VisitBoolean(bool) error
}

type UpdateSubmitterFieldValidationParams 

type UpdateSubmitterFieldValidationParams struct {
	// HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.
	Pattern string `json:"pattern,omitempty" url:"pattern,omitempty"`
	// A custom error message to display on validation failure.
	Message string `json:"message,omitempty" url:"message,omitempty"`
	// Minimum allowed number value or date depending on field type.
	Min *UpdateSubmitterFieldValidationParamsMin `json:"min,omitempty" url:"min,omitempty"`
	// Maximum allowed number value or date depending on field type.
	Max *UpdateSubmitterFieldValidationParamsMax `json:"max,omitempty" url:"max,omitempty"`
	// Increment step for number field. Pass 1 to accept only integers, or 0.01 to accept decimal currency.
	Step *float64 `json:"step,omitempty" url:"step,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateSubmitterFieldValidationParams) GetExtraProperties 

func (u *UpdateSubmitterFieldValidationParams) GetExtraProperties() map[string]interface{}

func (*UpdateSubmitterFieldValidationParams) GetMax 

func (u *UpdateSubmitterFieldValidationParams) GetMax() *UpdateSubmitterFieldValidationParamsMax

func (*UpdateSubmitterFieldValidationParams) GetMessage 

func (u *UpdateSubmitterFieldValidationParams) GetMessage() string

func (*UpdateSubmitterFieldValidationParams) GetMin 

func (u *UpdateSubmitterFieldValidationParams) GetMin() *UpdateSubmitterFieldValidationParamsMin

func (*UpdateSubmitterFieldValidationParams) GetPattern 

func (u *UpdateSubmitterFieldValidationParams) GetPattern() string

func (*UpdateSubmitterFieldValidationParams) GetStep 

func (u *UpdateSubmitterFieldValidationParams) GetStep() *float64

func (*UpdateSubmitterFieldValidationParams) MarshalJSON 

func (u *UpdateSubmitterFieldValidationParams) MarshalJSON() ([]byte, error)

func (*UpdateSubmitterFieldValidationParams) SetMax 

func (u *UpdateSubmitterFieldValidationParams) SetMax(max *UpdateSubmitterFieldValidationParamsMax)

SetMax sets the Max field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldValidationParams) SetMessage 

func (u *UpdateSubmitterFieldValidationParams) SetMessage(message string)

SetMessage sets the Message field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldValidationParams) SetMin 

func (u *UpdateSubmitterFieldValidationParams) SetMin(min *UpdateSubmitterFieldValidationParamsMin)

SetMin sets the Min field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldValidationParams) SetPattern 

func (u *UpdateSubmitterFieldValidationParams) SetPattern(pattern string)

SetPattern sets the Pattern field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldValidationParams) SetStep 

func (u *UpdateSubmitterFieldValidationParams) SetStep(step *float64)

SetStep sets the Step field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterFieldValidationParams) String 

func (u *UpdateSubmitterFieldValidationParams) String() string

func (*UpdateSubmitterFieldValidationParams) UnmarshalJSON 

func (u *UpdateSubmitterFieldValidationParams) UnmarshalJSON(data []byte) error

type UpdateSubmitterFieldValidationParamsMax 

type UpdateSubmitterFieldValidationParamsMax struct {
	Double float64
	String string
	// contains filtered or unexported fields
}

Maximum allowed number value or date depending on field type.

func (*UpdateSubmitterFieldValidationParamsMax) Accept 

func (u *UpdateSubmitterFieldValidationParamsMax) Accept(visitor UpdateSubmitterFieldValidationParamsMaxVisitor) error

func (*UpdateSubmitterFieldValidationParamsMax) GetDouble 

func (u *UpdateSubmitterFieldValidationParamsMax) GetDouble() float64

func (*UpdateSubmitterFieldValidationParamsMax) GetString 

func (u *UpdateSubmitterFieldValidationParamsMax) GetString() string

func (UpdateSubmitterFieldValidationParamsMax) MarshalJSON 

func (u UpdateSubmitterFieldValidationParamsMax) MarshalJSON() ([]byte, error)

func (*UpdateSubmitterFieldValidationParamsMax) UnmarshalJSON 

func (u *UpdateSubmitterFieldValidationParamsMax) UnmarshalJSON(data []byte) error

type UpdateSubmitterFieldValidationParamsMaxVisitor 

type UpdateSubmitterFieldValidationParamsMaxVisitor interface {
	VisitDouble(float64) error
	VisitString(string) error
}

type UpdateSubmitterFieldValidationParamsMin 

type UpdateSubmitterFieldValidationParamsMin struct {
	Double float64
	String string
	// contains filtered or unexported fields
}

Minimum allowed number value or date depending on field type.

func (*UpdateSubmitterFieldValidationParamsMin) Accept 

func (u *UpdateSubmitterFieldValidationParamsMin) Accept(visitor UpdateSubmitterFieldValidationParamsMinVisitor) error

func (*UpdateSubmitterFieldValidationParamsMin) GetDouble 

func (u *UpdateSubmitterFieldValidationParamsMin) GetDouble() float64

func (*UpdateSubmitterFieldValidationParamsMin) GetString 

func (u *UpdateSubmitterFieldValidationParamsMin) GetString() string

func (UpdateSubmitterFieldValidationParamsMin) MarshalJSON 

func (u UpdateSubmitterFieldValidationParamsMin) MarshalJSON() ([]byte, error)

func (*UpdateSubmitterFieldValidationParamsMin) UnmarshalJSON 

func (u *UpdateSubmitterFieldValidationParamsMin) UnmarshalJSON(data []byte) error

type UpdateSubmitterFieldValidationParamsMinVisitor 

type UpdateSubmitterFieldValidationParamsMinVisitor interface {
	VisitDouble(float64) error
	VisitString(string) error
}

type UpdateSubmitterMessageParams 

type UpdateSubmitterMessageParams struct {
	// Custom signature request email subject.
	Subject string `json:"subject,omitempty" url:"subject,omitempty"`
	// Custom signature request email body. Can include the following variables: {{template.name}}, {{submitter.link}}, {{account.name}}.
	Body string `json:"body,omitempty" url:"body,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateSubmitterMessageParams) GetBody 

func (u *UpdateSubmitterMessageParams) GetBody() string

func (*UpdateSubmitterMessageParams) GetExtraProperties 

func (u *UpdateSubmitterMessageParams) GetExtraProperties() map[string]interface{}

func (*UpdateSubmitterMessageParams) GetSubject 

func (u *UpdateSubmitterMessageParams) GetSubject() string

func (*UpdateSubmitterMessageParams) MarshalJSON 

func (u *UpdateSubmitterMessageParams) MarshalJSON() ([]byte, error)

func (*UpdateSubmitterMessageParams) SetBody 

func (u *UpdateSubmitterMessageParams) SetBody(body string)

SetBody sets the Body field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterMessageParams) SetSubject 

func (u *UpdateSubmitterMessageParams) SetSubject(subject string)

SetSubject sets the Subject field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterMessageParams) String 

func (u *UpdateSubmitterMessageParams) String() string

func (*UpdateSubmitterMessageParams) UnmarshalJSON 

func (u *UpdateSubmitterMessageParams) UnmarshalJSON(data []byte) error

type UpdateSubmitterParams 

type UpdateSubmitterParams struct {
	// The name of the submitter.
	Name string `json:"name,omitempty" url:"-"`
	// The email address of the submitter.
	Email string `json:"email,omitempty" url:"-"`
	// The phone number of the submitter, formatted according to the E.164 standard.
	Phone string `json:"phone,omitempty" url:"-"`
	// An object with pre-filled values for the submission. Use field names for keys of the object. For more configurations see `fields` param.
	Values map[string]any `json:"values,omitempty" url:"-"`
	// Your application-specific unique string key to identify this submitter within your app.
	ExternalID string `json:"external_id,omitempty" url:"-"`
	// Set `true` to re-send signature request emails.
	SendEmail *bool `json:"send_email,omitempty" url:"-"`
	// Set `true` to re-send signature request via phone number SMS.
	SendSms *bool `json:"send_sms,omitempty" url:"-"`
	// Specify Reply-To address to use in the notification emails.
	ReplyTo string `json:"reply_to,omitempty" url:"-"`
	// Pass `true` to mark submitter as completed and auto-signed via API.
	Completed *bool `json:"completed,omitempty" url:"-"`
	// Metadata object with additional submitter information.
	Metadata map[string]any `json:"metadata,omitempty" url:"-"`
	// Submitter specific URL to redirect to after the submission completion.
	CompletedRedirectURL string `json:"completed_redirect_url,omitempty" url:"-"`
	// Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.
	RequirePhone2Fa *bool `json:"require_phone_2fa,omitempty" url:"-"`
	// Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.
	RequireEmail2Fa *bool                         `json:"require_email_2fa,omitempty" url:"-"`
	Message         *UpdateSubmitterMessageParams `json:"message,omitempty" url:"-"`
	// A list of configurations for template document form fields.
	Fields []*UpdateSubmitterFieldParams `json:"fields,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*UpdateSubmitterParams) MarshalJSON 

func (u *UpdateSubmitterParams) MarshalJSON() ([]byte, error)

func (*UpdateSubmitterParams) SetCompleted 

func (u *UpdateSubmitterParams) SetCompleted(completed *bool)

SetCompleted sets the Completed field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetCompletedRedirectURL 

func (u *UpdateSubmitterParams) SetCompletedRedirectURL(completedRedirectURL string)

SetCompletedRedirectURL sets the CompletedRedirectURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetEmail 

func (u *UpdateSubmitterParams) SetEmail(email string)

SetEmail sets the Email field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetExternalID 

func (u *UpdateSubmitterParams) SetExternalID(externalID string)

SetExternalID sets the ExternalID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetFields 

func (u *UpdateSubmitterParams) SetFields(fields []*UpdateSubmitterFieldParams)

SetFields sets the Fields field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetMessage 

func (u *UpdateSubmitterParams) SetMessage(message *UpdateSubmitterMessageParams)

SetMessage sets the Message field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetMetadata 

func (u *UpdateSubmitterParams) SetMetadata(metadata map[string]any)

SetMetadata sets the Metadata field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetName 

func (u *UpdateSubmitterParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetPhone 

func (u *UpdateSubmitterParams) SetPhone(phone string)

SetPhone sets the Phone field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetReplyTo 

func (u *UpdateSubmitterParams) SetReplyTo(replyTo string)

SetReplyTo sets the ReplyTo field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetRequireEmail2Fa 

func (u *UpdateSubmitterParams) SetRequireEmail2Fa(requireEmail2Fa *bool)

SetRequireEmail2Fa sets the RequireEmail2Fa field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetRequirePhone2Fa 

func (u *UpdateSubmitterParams) SetRequirePhone2Fa(requirePhone2Fa *bool)

SetRequirePhone2Fa sets the RequirePhone2Fa field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetSendEmail 

func (u *UpdateSubmitterParams) SetSendEmail(sendEmail *bool)

SetSendEmail sets the SendEmail field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetSendSms 

func (u *UpdateSubmitterParams) SetSendSms(sendSms *bool)

SetSendSms sets the SendSms field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) SetValues 

func (u *UpdateSubmitterParams) SetValues(values map[string]any)

SetValues sets the Values field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateSubmitterParams) UnmarshalJSON 

func (u *UpdateSubmitterParams) UnmarshalJSON(data []byte) error

type UpdateTemplateDocumentsDocumentParams 

type UpdateTemplateDocumentsDocumentParams struct {
	// Document name. Random uuid will be assigned when not specified.
	Name string `json:"name,omitempty" url:"name,omitempty"`
	// Base64-encoded content of the PDF or DOCX file or downloadable file URL. Leave it empty if you create a new document using HTML param.
	File string `json:"file,omitempty" url:"file,omitempty"`
	// HTML template with field tags. Leave it empty if you add a document via PDF or DOCX base64 encoded file param or URL.
	Html string `json:"html,omitempty" url:"html,omitempty"`
	// Position of the document. By default will be added as the last document in the template.
	Position *int `json:"position,omitempty" url:"position,omitempty"`
	// Set to `true` to replace existing document with a new file at `position`. Existing document fields will be transferred to the new document if it doesn't contain any fields.
	Replace *bool `json:"replace,omitempty" url:"replace,omitempty"`
	// Set to `true` to remove existing document at given `position` or with given `name`.
	Remove *bool `json:"remove,omitempty" url:"remove,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateTemplateDocumentsDocumentParams) GetExtraProperties 

func (u *UpdateTemplateDocumentsDocumentParams) GetExtraProperties() map[string]interface{}

func (*UpdateTemplateDocumentsDocumentParams) GetFile 

func (u *UpdateTemplateDocumentsDocumentParams) GetFile() string

func (*UpdateTemplateDocumentsDocumentParams) GetHtml 

func (u *UpdateTemplateDocumentsDocumentParams) GetHtml() string

func (*UpdateTemplateDocumentsDocumentParams) GetName 

func (u *UpdateTemplateDocumentsDocumentParams) GetName() string

func (*UpdateTemplateDocumentsDocumentParams) GetPosition 

func (u *UpdateTemplateDocumentsDocumentParams) GetPosition() *int

func (*UpdateTemplateDocumentsDocumentParams) GetRemove 

func (u *UpdateTemplateDocumentsDocumentParams) GetRemove() *bool

func (*UpdateTemplateDocumentsDocumentParams) GetReplace 

func (u *UpdateTemplateDocumentsDocumentParams) GetReplace() *bool

func (*UpdateTemplateDocumentsDocumentParams) MarshalJSON 

func (u *UpdateTemplateDocumentsDocumentParams) MarshalJSON() ([]byte, error)

func (*UpdateTemplateDocumentsDocumentParams) SetFile 

func (u *UpdateTemplateDocumentsDocumentParams) SetFile(file string)

SetFile sets the File field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateTemplateDocumentsDocumentParams) SetHtml 

func (u *UpdateTemplateDocumentsDocumentParams) SetHtml(html string)

SetHtml sets the Html field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateTemplateDocumentsDocumentParams) SetName 

func (u *UpdateTemplateDocumentsDocumentParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateTemplateDocumentsDocumentParams) SetPosition 

func (u *UpdateTemplateDocumentsDocumentParams) SetPosition(position *int)

SetPosition sets the Position field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateTemplateDocumentsDocumentParams) SetRemove 

func (u *UpdateTemplateDocumentsDocumentParams) SetRemove(remove *bool)

SetRemove sets the Remove field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateTemplateDocumentsDocumentParams) SetReplace 

func (u *UpdateTemplateDocumentsDocumentParams) SetReplace(replace *bool)

SetReplace sets the Replace field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateTemplateDocumentsDocumentParams) String 

func (u *UpdateTemplateDocumentsDocumentParams) String() string

func (*UpdateTemplateDocumentsDocumentParams) UnmarshalJSON 

func (u *UpdateTemplateDocumentsDocumentParams) UnmarshalJSON(data []byte) error

type UpdateTemplateDocumentsParams 

type UpdateTemplateDocumentsParams struct {
	// The list of documents to add or replace in the template.
	Documents []*UpdateTemplateDocumentsDocumentParams `json:"documents,omitempty" url:"-"`
	// Set to `true` to merge all existing and new documents into a single PDF document in the template.
	Merge *bool `json:"merge,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*UpdateTemplateDocumentsParams) MarshalJSON 

func (u *UpdateTemplateDocumentsParams) MarshalJSON() ([]byte, error)

func (*UpdateTemplateDocumentsParams) SetDocuments 

func (u *UpdateTemplateDocumentsParams) SetDocuments(documents []*UpdateTemplateDocumentsDocumentParams)

SetDocuments sets the Documents field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateTemplateDocumentsParams) SetMerge 

func (u *UpdateTemplateDocumentsParams) SetMerge(merge *bool)

SetMerge sets the Merge field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateTemplateDocumentsParams) UnmarshalJSON 

func (u *UpdateTemplateDocumentsParams) UnmarshalJSON(data []byte) error

type UpdateTemplateParams 

type UpdateTemplateParams struct {
	// The name of the template.
	Name string `json:"name,omitempty" url:"-"`
	// The folder's name to which the template should be moved.
	FolderName string `json:"folder_name,omitempty" url:"-"`
	// An array of submitter role names to update the template with.
	Roles []string `json:"roles,omitempty" url:"-"`
	// Set `false` to unarchive template.
	Archived *bool `json:"archived,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*UpdateTemplateParams) MarshalJSON 

func (u *UpdateTemplateParams) MarshalJSON() ([]byte, error)

func (*UpdateTemplateParams) SetArchived 

func (u *UpdateTemplateParams) SetArchived(archived *bool)

SetArchived sets the Archived field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateTemplateParams) SetFolderName 

func (u *UpdateTemplateParams) SetFolderName(folderName string)

SetFolderName sets the FolderName field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateTemplateParams) SetName 

func (u *UpdateTemplateParams) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateTemplateParams) SetRoles 

func (u *UpdateTemplateParams) SetRoles(roles []string)

SetRoles sets the Roles field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateTemplateParams) UnmarshalJSON 

func (u *UpdateTemplateParams) UnmarshalJSON(data []byte) error

type User 

type User struct {
	// Unique identifier of the user.
	ID int `json:"id" url:"id"`
	// The first name of the user.
	FirstName *string `json:"first_name,omitempty" url:"first_name,omitempty"`
	// The last name of the user.
	LastName *string `json:"last_name,omitempty" url:"last_name,omitempty"`
	// The email address of the user.
	Email string `json:"email" url:"email"`
	// contains filtered or unexported fields
}

func (*User) GetEmail 

func (u *User) GetEmail() string

func (*User) GetExtraProperties 

func (u *User) GetExtraProperties() map[string]interface{}

func (*User) GetFirstName 

func (u *User) GetFirstName() *string

func (*User) GetID 

func (u *User) GetID() int

func (*User) GetLastName 

func (u *User) GetLastName() *string

func (*User) MarshalJSON 

func (u *User) MarshalJSON() ([]byte, error)

func (*User) SetEmail 

func (u *User) SetEmail(email string)

SetEmail sets the Email field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*User) SetFirstName 

func (u *User) SetFirstName(firstName *string)

SetFirstName sets the FirstName field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*User) SetID 

func (u *User) SetID(id int)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*User) SetLastName 

func (u *User) SetLastName(lastName *string)

SetLastName sets the LastName field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*User) String 

func (u *User) String() string

func (*User) UnmarshalJSON 

func (u *User) UnmarshalJSON(data []byte) error

Source Files

View all Source files

Directories

Path Synopsis

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.