@verdocs/js-sdk 4.2.26 → 4.2.28

package/dist/index.d.ts

@@ -847,8 +847,6 @@ interface ITemplateField {
     placeholder: string | null;
     /** For fields that support grouping (radio buttons and check boxes) the value selected will be stored under this name. */
     group: string | null;
-    // @deprecated. Use settings instead.
-    setting?: ITemplateFieldSetting | null;
 }
 interface ITextFieldSetting {
     x: number;
@@ -892,7 +890,11 @@ type THistoryEvent = "recipient:signed" | "recipient:opened" | "recipient:submit
 type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "preparer" | "manual" | "in_person_link" | "guest" | "email" | "" | string; // Modification events have a string description
 // Modification events have a string description
 type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
-type TFieldType = "signature" | "initial" | "checkbox_group" | "radio_button_group" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
+type TFieldType = "signature" | "initial" | "checkbox_group" | "checkbox" | "radio_button_group" | "radio" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
+declare const FIELD_TYPES: TFieldType[];
+declare const DEFAULT_FIELD_WIDTHS: Record<TFieldType, number>;
+declare const DEFAULT_FIELD_HEIGHTS: Record<TFieldType, number>;
+declare const DEFAULT_FIELD_SETTINGS: Record<TFieldType, ITemplateFieldSetting>;
 type TEnvironment = "verdocs" | "verdocs-stage";
 type TSessionChangedListener = (endpoint: VerdocsEndpoint, session: TSession, profile: IProfile | null) => void;
 interface VerdocsEndpointOptions {
@@ -2107,16 +2109,34 @@ declare const canPerformTemplateAction: (profile: IProfile | null | undefined, a
 declare const hasRequiredPermissions: (profile: IProfile | null | undefined, permissions: TPermission[]) => boolean;
 /**
  * Add a field to a template.
+ *
+ * ```typescript
+ * import {createField} from '@verdocs/js-sdk/Templates';
+ *
+ * await createField((VerdocsEndpoint.getDefault(), template_id, { ... });
+ * ```
  */
 declare const createField: (endpoint: VerdocsEndpoint, templateId: string, params: ITemplateField) => Promise<ITemplateField>;
 /**
  * Update a template field.
+ *
+ * ```typescript
+ * import {updateField} from '@verdocs/js-sdk/Templates';
+ *
+ * await updateField((VerdocsEndpoint.getDefault(), template_id, field_name, { ... });
+ * ```
  */
-declare const updateField: (endpoint: VerdocsEndpoint, templateId: string, fieldName: string, params: Partial<ITemplateField>) => Promise<ITemplateField>;
+declare const updateField: (endpoint: VerdocsEndpoint, templateId: string, name: string, params: Partial<ITemplateField>) => Promise<ITemplateField>;
 /**
- * REmove a field from a template.
+ * Remove a field from a template.
+ *
+ * ```typescript
+ * import {deleteField} from '@verdocs/js-sdk/Templates';
+ *
+ * await deleteField((VerdocsEndpoint.getDefault(), template_id, field_name);
+ * ```
  */
-declare const deleteField: (endpoint: VerdocsEndpoint, templateId: string, fieldName: string) => Promise<any>;
+declare const deleteField: (endpoint: VerdocsEndpoint, templateId: string, name: string) => Promise<any>;
 /**
  * Check to see if the user created the template.
  */
@@ -2235,6 +2255,58 @@ declare const updateTemplateRole: (endpoint: VerdocsEndpoint, template_id: strin
  * ```
  */
 declare const deleteTemplateRole: (endpoint: VerdocsEndpoint, template_id: string, name: string) => Promise<any>;
+interface ITemplateTag {
+    tag_name: string;
+    template_id: string;
+}
+interface ITag {
+    name: string;
+    featured?: boolean;
+    organization_id?: string;
+    created_at?: string;
+}
+interface IStar {
+    template_id: string;
+    profile_id: string;
+}
+interface ITemplateSearchResult {
+    page: number;
+    row: number;
+    total: number;
+    result: ITemplate[];
+}
+/**
+ * Get the template stars for a template.
+ */
+declare const getStars: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IStar[]>;
+/**
+ * Toggle the template star for a template.
+ */
+declare const toggleStar: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
+/**
+ * Apply a tag to a template.
+ */
+declare const addTemplateTag: (endpoint: VerdocsEndpoint, templateId: string, params: ITag) => Promise<ITemplateTag>;
+/**
+ * Get all tags for a template.
+ */
+declare const getTemplateTags: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateTag[]>;
+/**
+ * Remove a tag from a template.
+ */
+declare const deleteTemplateTag: (endpoint: VerdocsEndpoint, templateId: string, tagName: string) => Promise<any>;
+/**
+ * Create an Organization-wide tag.
+ */
+declare const createTag: (endpoint: VerdocsEndpoint, name: string) => Promise<ITag>;
+/**
+ * Get an Organization-wide tag.
+ */
+declare const getTag: (endpoint: VerdocsEndpoint, name: string) => Promise<ITag>;
+/**
+ * Get all tags available for use by an Organization.
+ */
+declare const getAllTags: (endpoint: VerdocsEndpoint) => Promise<ITag[]>;
 /**
  * Given a `rgba(r,g,b,a)` string value, returns the hex equivalent, dropping the alpha channel.
  */
@@ -2341,77 +2413,6 @@ declare const decodeJWTBody: (token: string) => any;
  * the presence of the `document_id` field, which will only be present for signing sessions.
  */
 declare const decodeAccessTokenBody: (token: string) => TSession;
-interface ITemplateSearchParams {
-    id?: string;
-    name?: string;
-    sender?: string;
-    description?: string;
-    profile_id?: string;
-    organization_id?: string;
-    updated_at?: ITimePeriod;
-    created_at?: ITimePeriod;
-    last_used_at?: ITimePeriod;
-    is_personal?: boolean;
-    is_public?: boolean;
-    tags?: string[];
-    document_name?: string;
-    sort_by?: TSortTemplateBy;
-    ascending?: boolean;
-    row?: number;
-    page?: number;
-}
-interface ITemplateTag {
-    tag_name: string;
-    template_id: string;
-}
-interface ITag {
-    name: string;
-    featured?: boolean;
-    organization_id?: string;
-    created_at?: string;
-}
-interface IStar {
-    template_id: string;
-    profile_id: string;
-}
-interface ITemplateSearchResult {
-    page: number;
-    row: number;
-    total: number;
-    result: ITemplate[];
-}
-/**
- * Get the template stars for a template.
- */
-declare const getStars: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IStar[]>;
-/**
- * Toggle the template star for a template.
- */
-declare const toggleStar: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
-/**
- * Apply a tag to a template.
- */
-declare const addTemplateTag: (endpoint: VerdocsEndpoint, templateId: string, params: ITag) => Promise<ITemplateTag>;
-/**
- * Get all tags for a template.
- */
-declare const getTemplateTags: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateTag[]>;
-/**
- * Remove a tag from a template.
- */
-declare const deleteTemplateTag: (endpoint: VerdocsEndpoint, templateId: string, tagName: string) => Promise<any>;
-/**
- * Create an Organization-wide tag.
- */
-declare const createTag: (endpoint: VerdocsEndpoint, name: string) => Promise<ITag>;
-/**
- * Get an Organization-wide tag.
- */
-declare const getTag: (endpoint: VerdocsEndpoint, name: string) => Promise<ITag>;
-/**
- * Get all tags available for use by an Organization.
- */
-declare const getAllTags: (endpoint: VerdocsEndpoint) => Promise<ITag[]>;
 interface IGetTemplatesParams {
     is_starred?: boolean;
     is_creator?: boolean;
@@ -2421,12 +2422,12 @@ interface IGetTemplatesParams {
  * Get all templates accessible by the caller, with optional filters.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {getTemplates} from '@verdocs/js-sdk/Templates';
  *
- * await Templates.getTemplates((VerdocsEndpoint.getDefault());
- * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_starred: true });
- * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_creator: true });
- * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_organization: true });
+ * await getTemplates((VerdocsEndpoint.getDefault());
+ * await getTemplates((VerdocsEndpoint.getDefault(), { is_starred: true });
+ * await getTemplates((VerdocsEndpoint.getDefault(), { is_creator: true });
+ * await getTemplates((VerdocsEndpoint.getDefault(), { is_organization: true });
  * ```
  */
 declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemplatesParams) => Promise<ITemplate[]>;
@@ -2443,9 +2444,9 @@ declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemplatesPa
  * Lists all templates accessible by the caller, with optional filters.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {listTemplates} from '@verdocs/js-sdk/Templates';
  *
- * await Templates.listTemplates((VerdocsEndpoint.getDefault(), { sharing: 'personal', sort: 'last_used_at' });
+ * await listTemplates((VerdocsEndpoint.getDefault(), { sharing: 'personal', sort: 'last_used_at' });
  * ```
  */
 // export const listTemplates = (endpoint: VerdocsEndpoint, params?: IListTemplatesParams) =>
@@ -2456,9 +2457,9 @@ declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemplatesPa
  * Get one template by its ID.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {getTemplate} from '@verdocs/js-sdk/Templates';
  *
- * const template = await Templates.getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
+ * const template = await getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  */
 declare const getTemplate: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
@@ -2520,9 +2521,9 @@ interface ITemplateCreateParams {
  * Create a template.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {createTemplate} from '@verdocs/js-sdk/Templates';
  *
- * const newTemplate = await Templates.createTemplatev2((VerdocsEndpoint.getDefault(), {...});
+ * const newTemplate = await createTemplate((VerdocsEndpoint.getDefault(), {...});
  * ```
  */
 declare const createTemplate: (endpoint: VerdocsEndpoint, params: ITemplateCreateParams, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<ITemplate>;
@@ -2544,9 +2545,9 @@ interface ITemplateCreateFromSharepointParams {
  * Create a template from a Sharepoint asset.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {createTemplateFromSharepoint} from '@verdocs/js-sdk/Templates';
  *
- * const newTemplate = await Templates.createTemplateFromSharepoint((VerdocsEndpoint.getDefault(), {...});
+ * const newTemplate = await createTemplateFromSharepoint((VerdocsEndpoint.getDefault(), {...});
  * ```
  */
 declare const createTemplateFromSharepoint: (endpoint: VerdocsEndpoint, params: ITemplateCreateFromSharepointParams) => Promise<ITemplate>;
@@ -2554,9 +2555,9 @@ declare const createTemplateFromSharepoint: (endpoint: VerdocsEndpoint, params:
  * Update a template.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {updateTemplate} from '@verdocs/js-sdk/Templates';
  *
- * const updatedTemplate = await Templates.updateTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
+ * const updatedTemplate = await updateTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
  * ```
  */
 declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, params: Partial<ITemplateCreateParams>) => Promise<ITemplate>;
@@ -2564,22 +2565,12 @@ declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, pa
  * Delete a template.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {deleteTemplate} from '@verdocs/js-sdk/Templates';
  *
- * await Templates.deleteTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
+ * await deleteTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  */
 declare const deleteTemplate: (endpoint: VerdocsEndpoint, templateId: string) => Promise<any>;
-/**
- * Search for templates matching various criteria.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const {result, page, total} = await Templates.search((VerdocsEndpoint.getDefault(), { ... });
- * ```
- */
-declare const searchTemplates: (endpoint: VerdocsEndpoint, params: ITemplateSearchParams) => Promise<ITemplateSearchResult>;
 interface ISearchTimeRange {
     start_time: string;
     end_time: string;
@@ -2615,12 +2606,12 @@ interface ITemplateListParams {
     page?: number;
 }
 /**
- * List templates.
+ * List
  *
  * ```typescript
  * import {Templates} from '@verdocs/js-sdk/Templates';
  *
- * const {totals, templates} = await Templates.listTemplates((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' }); * ```
+ * const {totals, templates} = await listTemplates((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' }); * ```
  */
 declare const listTemplates: (endpoint: VerdocsEndpoint, params?: ITemplateListParams) => Promise<{
     total: number;
@@ -2706,4 +2697,4 @@ declare const isValidEmail: (email: string | undefined) => boolean;
 declare const isValidPhone: (phone: string | undefined) => boolean;
 declare const isValidRoleName: (value: string, roles: IRole[]) => boolean;
 declare const isValidTag: (value: string, tags: string[]) => boolean;
-export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelopesSummary, getEnvelopeRecipients, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, ISignerTokenResponse, getSigningSession, getSignerToken, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IEnvelopesSummary, IDocumentSearchOptions, ICreateEnvelopeRole, IEnvelopeSummaries, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getGroups, getGroup, createGroup, addGroupMember, deleteGroupMember, updateGroup, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, updateOrganization, updateOrganizationLogo, updateOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, createTemplateRole, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, searchTemplates, ISearchTimeRange, IGetTemplateSummarySortBy, IGetTemplateSummaryParams, ITemplateListParams, listTemplates, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateSearchParams, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, timePeriod, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry, ITimePeriod };
+export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_SETTINGS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelopesSummary, getEnvelopeRecipients, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, ISignerTokenResponse, getSigningSession, getSignerToken, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IEnvelopesSummary, IDocumentSearchOptions, ICreateEnvelopeRole, IEnvelopeSummaries, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getGroups, getGroup, createGroup, addGroupMember, deleteGroupMember, updateGroup, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, updateOrganization, updateOrganizationLogo, updateOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, createTemplateRole, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, ISearchTimeRange, IGetTemplateSummarySortBy, IGetTemplateSummaryParams, ITemplateListParams, listTemplates, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, timePeriod, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry, ITimePeriod };

package/dist/index.js

@@ -2,6 +2,81 @@
 
 var axios = require('axios');
 
+const FIELD_TYPES = [
+    'textbox',
+    'signature',
+    'initial',
+    'date',
+    'dropdown',
+    'timestamp',
+    'textarea',
+    'checkbox',
+    'radio',
+    'attachment',
+    'payment',
+];
+const DEFAULT_FIELD_WIDTHS = {
+    signature: 71,
+    initial: 71,
+    date: 75,
+    timestamp: 130,
+    textbox: 150,
+    textarea: 150,
+    checkbox: 14,
+    checkbox_group: 14,
+    radio_button_group: 14,
+    radio: 14,
+    dropdown: 85,
+    attachment: 24,
+    payment: 24,
+};
+const DEFAULT_FIELD_HEIGHTS = {
+    signature: 36,
+    initial: 36,
+    date: 15,
+    timestamp: 15,
+    textbox: 15,
+    textarea: 41,
+    checkbox: 14,
+    checkbox_group: 14,
+    radio_button_group: 14,
+    radio: 14,
+    dropdown: 20,
+    attachment: 24,
+    payment: 24,
+};
+const DEFAULT_FIELD_SETTINGS = {
+    signature: { result: '' },
+    initial: { result: '' },
+    date: { width: 75, height: 15, result: '' },
+    timestamp: { width: 130, height: 15 },
+    textbox: { width: 150, height: 15, result: '', leading: 0, alignment: 0, upperCase: false },
+    textarea: { width: 150, height: 15, result: '', leading: 16, alignment: 0, upperCase: false },
+    checkbox: {},
+    checkbox_group: {
+        minimum_checked: 0,
+        maximum_checked: 1000,
+        options: [
+        // { id: `${field.name}-1`, value: 'Option 1', checked: false, x, y },
+        ],
+    },
+    radio_button_group: {
+        options: [
+        // { id: `${field.name}-1`, value: 'Option 1', selected: false, x, y }
+        ],
+    },
+    radio: {},
+    dropdown: {
+        width: 85,
+        height: 20,
+        value: null,
+        placeholder: 'Choose',
+        options: [{ id: 'option-1', value: 'Option 1' }],
+    },
+    attachment: {},
+    payment: {},
+};
+
 /**
  * Given a `rgba(r,g,b,a)` string value, returns the hex equivalent, dropping the alpha channel.
  */
@@ -2299,21 +2374,39 @@ const hasRequiredPermissions = (profile, permissions) => permissions.every((perm
 
 /**
  * Add a field to a template.
+ *
+ * ```typescript
+ * import {createField} from '@verdocs/js-sdk/Templates';
+ *
+ * await createField((VerdocsEndpoint.getDefault(), template_id, { ... });
+ * ```
  */
 const createField = (endpoint, templateId, params) => endpoint.api //
-    .post(`/templates/${templateId}/fields`, params)
+    .post(`/v2/fields/${templateId}`, params)
     .then((r) => r.data);
 /**
  * Update a template field.
+ *
+ * ```typescript
+ * import {updateField} from '@verdocs/js-sdk/Templates';
+ *
+ * await updateField((VerdocsEndpoint.getDefault(), template_id, field_name, { ... });
+ * ```
  */
-const updateField = (endpoint, templateId, fieldName, params) => endpoint.api //
-    .put(`/templates/${templateId}/fields/${fieldName}`, params)
+const updateField = (endpoint, templateId, name, params) => endpoint.api //
+    .patch(`/fields/${templateId}/${name}`, params)
     .then((r) => r.data);
 /**
- * REmove a field from a template.
+ * Remove a field from a template.
+ *
+ * ```typescript
+ * import {deleteField} from '@verdocs/js-sdk/Templates';
+ *
+ * await deleteField((VerdocsEndpoint.getDefault(), template_id, field_name);
+ * ```
  */
-const deleteField = (endpoint, templateId, fieldName) => endpoint.api //
-    .delete(`/templates/${templateId}/fields/${fieldName}`)
+const deleteField = (endpoint, templateId, name) => endpoint.api //
+    .delete(`/fields/${templateId}/${name}`)
     .then((r) => r.data);
 
 /**
@@ -2560,12 +2653,12 @@ const getAllTags = (endpoint) => endpoint.api //
  * Get all templates accessible by the caller, with optional filters.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {getTemplates} from '@verdocs/js-sdk/Templates';
  *
- * await Templates.getTemplates((VerdocsEndpoint.getDefault());
- * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_starred: true });
- * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_creator: true });
- * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_organization: true });
+ * await getTemplates((VerdocsEndpoint.getDefault());
+ * await getTemplates((VerdocsEndpoint.getDefault(), { is_starred: true });
+ * await getTemplates((VerdocsEndpoint.getDefault(), { is_creator: true });
+ * await getTemplates((VerdocsEndpoint.getDefault(), { is_organization: true });
  * ```
  */
 const getTemplates = (endpoint, params) => endpoint.api //
@@ -2584,9 +2677,9 @@ const getTemplates = (endpoint, params) => endpoint.api //
  * Lists all templates accessible by the caller, with optional filters.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {listTemplates} from '@verdocs/js-sdk/Templates';
  *
- * await Templates.listTemplates((VerdocsEndpoint.getDefault(), { sharing: 'personal', sort: 'last_used_at' });
+ * await listTemplates((VerdocsEndpoint.getDefault(), { sharing: 'personal', sort: 'last_used_at' });
  * ```
  */
 // export const listTemplates = (endpoint: VerdocsEndpoint, params?: IListTemplatesParams) =>
@@ -2597,9 +2690,9 @@ const getTemplates = (endpoint, params) => endpoint.api //
  * Get one template by its ID.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {getTemplate} from '@verdocs/js-sdk/Templates';
  *
- * const template = await Templates.getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
+ * const template = await getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  */
 const getTemplate = (endpoint, templateId) => endpoint.api //
@@ -2619,6 +2712,7 @@ const getTemplate = (endpoint, templateId) => endpoint.api //
             document.pages = document.page_numbers;
         }
     });
+    // Temporary upgrade from legacy app
     template.fields?.forEach((field) => {
         if (field.setting) {
             field.settings = field.setting;
@@ -2639,9 +2733,9 @@ const ALLOWED_CREATE_FIELDS = [
  * Create a template.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {createTemplate} from '@verdocs/js-sdk/Templates';
  *
- * const newTemplate = await Templates.createTemplatev2((VerdocsEndpoint.getDefault(), {...});
+ * const newTemplate = await createTemplate((VerdocsEndpoint.getDefault(), {...});
  * ```
  */
 const createTemplate = (endpoint, params, onUploadProgress) => {
@@ -2673,9 +2767,9 @@ const createTemplate = (endpoint, params, onUploadProgress) => {
  * Create a template from a Sharepoint asset.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {createTemplateFromSharepoint} from '@verdocs/js-sdk/Templates';
  *
- * const newTemplate = await Templates.createTemplateFromSharepoint((VerdocsEndpoint.getDefault(), {...});
+ * const newTemplate = await createTemplateFromSharepoint((VerdocsEndpoint.getDefault(), {...});
  * ```
  */
 const createTemplateFromSharepoint = (endpoint, params) => {
@@ -2688,9 +2782,9 @@ const createTemplateFromSharepoint = (endpoint, params) => {
  * Update a template.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {updateTemplate} from '@verdocs/js-sdk/Templates';
  *
- * const updatedTemplate = await Templates.updateTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
+ * const updatedTemplate = await updateTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
  * ```
  */
 const updateTemplate = (endpoint, templateId, params) => endpoint.api //
@@ -2700,33 +2794,21 @@ const updateTemplate = (endpoint, templateId, params) => endpoint.api //
  * Delete a template.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {deleteTemplate} from '@verdocs/js-sdk/Templates';
  *
- * await Templates.deleteTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
+ * await deleteTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  */
 const deleteTemplate = (endpoint, templateId) => endpoint.api //
     .delete(`/templates/${templateId}`)
     .then((r) => r.data);
 /**
- * Search for templates matching various criteria.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const {result, page, total} = await Templates.search((VerdocsEndpoint.getDefault(), { ... });
- * ```
- */
-const searchTemplates = async (endpoint, params) => endpoint.api //
-    .post('/templates/search', params)
-    .then((r) => r.data);
-/**
- * List templates.
+ * List
  *
  * ```typescript
  * import {Templates} from '@verdocs/js-sdk/Templates';
  *
- * const {totals, templates} = await Templates.listTemplates((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' }); * ```
+ * const {totals, templates} = await listTemplates((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' }); * ```
  */
 const listTemplates = async (endpoint, params = {}) => endpoint.api //
     .post('/templates/list', params)
@@ -2846,6 +2928,10 @@ const isValidTag = (value, tags) => TagRegEx.test(value) || tags.findIndex((tag)
 
 exports.AtoB = AtoB;
 exports.Countries = Countries;
+exports.DEFAULT_FIELD_HEIGHTS = DEFAULT_FIELD_HEIGHTS;
+exports.DEFAULT_FIELD_SETTINGS = DEFAULT_FIELD_SETTINGS;
+exports.DEFAULT_FIELD_WIDTHS = DEFAULT_FIELD_WIDTHS;
+exports.FIELD_TYPES = FIELD_TYPES;
 exports.RolePermissions = RolePermissions;
 exports.VerdocsEndpoint = VerdocsEndpoint;
 exports.acceptOrganizationInvitation = acceptOrganizationInvitation;
@@ -2984,7 +3070,6 @@ exports.resendOrganizationInvitation = resendOrganizationInvitation;
 exports.resendVerification = resendVerification;
 exports.resetPassword = resetPassword;
 exports.rotateApiKey = rotateApiKey;
-exports.searchTemplates = searchTemplates;
 exports.sendDelegate = sendDelegate;
 exports.setWebhooks = setWebhooks;
 exports.submitKbaChallengeResponse = submitKbaChallengeResponse;