@verdocs/js-sdk 6.2.0-beta.5 → 6.2.0-beta.8

package/dist/index.d.mts

@@ -161,8 +161,6 @@ interface ISigningSession {
     // @deprecated
     ["https://verdocs.com/session_type"]: "signing";
     // @deprecated
-    ["https://verdocs.com/key_type"]: TAccessKeyType;
-    // @deprecated
     ["https://verdocs.com/envelope_id"]: string;
     // @deprecated
     ["https://verdocs.com/role_name"]: string;
@@ -1814,6 +1812,7 @@ declare const getEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesP
  */
 declare const getEnvelopesZip: (endpoint: VerdocsEndpoint, envelope_ids: string[]) => Promise<import("axios").AxiosResponse<any, any, {}>>;
 declare const isFieldFilled: (field: IEnvelopeField, allRecipientFields: IEnvelopeField[]) => boolean | "" | null;
+// TODO: Only allow !required to bypass validation if the field is empty.
 declare const isFieldValid: (field: IEnvelopeField, allRecipientFields: IEnvelopeField[]) => boolean | "" | null;
 /**
  * Create an initials block. In a typical signing workflow, the user is asked at the beginning of the process to
@@ -3527,12 +3526,13 @@ declare const toggleTemplateStar: (endpoint: VerdocsEndpoint, templateId: string
  * ```typescript
  * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
  *
- * await TemplateDocument.createDocument((VerdocsEndpoint.getDefault(), templateID, params);
+ * await TemplateDocument.createDocument(VerdocsEndpoint.getDefault(), templateID, params);
  * ```
  *
  * @group Template Documents
  * @api POST /v2/templates/:template_id/documents Attach a document to a template
  * @apiBody string(format:binary) file Document file to attach. The file name will automatically be used as the document name.
+ * @apiBody string(format:uuid) template_id Template ID to attach the document to
  * @apiSuccess ITemplateDocument . Template document
  */
 declare const createTemplateDocument: (endpoint: VerdocsEndpoint, template_id: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<ITemplateDocument>;
@@ -3540,16 +3540,16 @@ declare const createTemplateDocument: (endpoint: VerdocsEndpoint, template_id: s
  * Delete a specific Document.
  *
  * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ * import {deleteTemplateDocument} from '@verdocs/js-sdk/Templates';
  *
- * await TemplateDocument.deleteDocument((VerdocsEndpoint.getDefault(), templateID, documentID);
+ * await deleteTemplateDocument(VerdocsEndpoint.getDefault(), documentID);
  * ```
  *
  * @group Template Documents
- * @api DELETE /v2/templates/:temlate_id/documents/:document_id Delete a template document
+ * @api DELETE /v2/template-documents/:document_id Delete a template document
  * @apiSuccess string . Success
  */
-declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<ITemplate>;
+declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<ITemplate>;
 /**
  * Get all metadata for a template document. Note that when called by non-creators (e.g. Org Collaborators)
  * this will return only the **metadata** the caller is allowed to view.

package/dist/index.d.ts

@@ -161,8 +161,6 @@ interface ISigningSession {
     // @deprecated
     ["https://verdocs.com/session_type"]: "signing";
     // @deprecated
-    ["https://verdocs.com/key_type"]: TAccessKeyType;
-    // @deprecated
     ["https://verdocs.com/envelope_id"]: string;
     // @deprecated
     ["https://verdocs.com/role_name"]: string;
@@ -1814,6 +1812,7 @@ declare const getEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesP
  */
 declare const getEnvelopesZip: (endpoint: VerdocsEndpoint, envelope_ids: string[]) => Promise<import("axios").AxiosResponse<any, any, {}>>;
 declare const isFieldFilled: (field: IEnvelopeField, allRecipientFields: IEnvelopeField[]) => boolean | "" | null;
+// TODO: Only allow !required to bypass validation if the field is empty.
 declare const isFieldValid: (field: IEnvelopeField, allRecipientFields: IEnvelopeField[]) => boolean | "" | null;
 /**
  * Create an initials block. In a typical signing workflow, the user is asked at the beginning of the process to
@@ -3527,12 +3526,13 @@ declare const toggleTemplateStar: (endpoint: VerdocsEndpoint, templateId: string
  * ```typescript
  * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
  *
- * await TemplateDocument.createDocument((VerdocsEndpoint.getDefault(), templateID, params);
+ * await TemplateDocument.createDocument(VerdocsEndpoint.getDefault(), templateID, params);
  * ```
  *
  * @group Template Documents
  * @api POST /v2/templates/:template_id/documents Attach a document to a template
  * @apiBody string(format:binary) file Document file to attach. The file name will automatically be used as the document name.
+ * @apiBody string(format:uuid) template_id Template ID to attach the document to
  * @apiSuccess ITemplateDocument . Template document
  */
 declare const createTemplateDocument: (endpoint: VerdocsEndpoint, template_id: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<ITemplateDocument>;
@@ -3540,16 +3540,16 @@ declare const createTemplateDocument: (endpoint: VerdocsEndpoint, template_id: s
  * Delete a specific Document.
  *
  * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ * import {deleteTemplateDocument} from '@verdocs/js-sdk/Templates';
  *
- * await TemplateDocument.deleteDocument((VerdocsEndpoint.getDefault(), templateID, documentID);
+ * await deleteTemplateDocument(VerdocsEndpoint.getDefault(), documentID);
  * ```
  *
  * @group Template Documents
- * @api DELETE /v2/templates/:temlate_id/documents/:document_id Delete a template document
+ * @api DELETE /v2/template-documents/:document_id Delete a template document
  * @apiSuccess string . Success
  */
-declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<ITemplate>;
+declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<ITemplate>;
 /**
  * Get all metadata for a template document. Note that when called by non-creators (e.g. Org Collaborators)
  * this will return only the **metadata** the caller is allowed to view.

package/dist/index.js

@@ -2440,17 +2440,18 @@ const toggleTemplateStar = (endpoint, templateId) => endpoint.api //
  * ```typescript
  * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
  *
- * await TemplateDocument.createDocument((VerdocsEndpoint.getDefault(), templateID, params);
+ * await TemplateDocument.createDocument(VerdocsEndpoint.getDefault(), templateID, params);
  * ```
  *
  * @group Template Documents
  * @api POST /v2/templates/:template_id/documents Attach a document to a template
  * @apiBody string(format:binary) file Document file to attach. The file name will automatically be used as the document name.
+ * @apiBody string(format:uuid) template_id Template ID to attach the document to
  * @apiSuccess ITemplateDocument . Template document
  */
 const createTemplateDocument = (endpoint, template_id, file, onUploadProgress) => {
     const formData = new FormData();
-    formData.append('document', file, file.name);
+    formData.append('file', file, file.name);
     formData.append('template_id', template_id);
     return endpoint.api //
         .post(`/v2/template-documents`, formData, {
@@ -2467,17 +2468,17 @@ const createTemplateDocument = (endpoint, template_id, file, onUploadProgress) =
  * Delete a specific Document.
  *
  * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ * import {deleteTemplateDocument} from '@verdocs/js-sdk/Templates';
  *
- * await TemplateDocument.deleteDocument((VerdocsEndpoint.getDefault(), templateID, documentID);
+ * await deleteTemplateDocument(VerdocsEndpoint.getDefault(), documentID);
  * ```
  *
  * @group Template Documents
- * @api DELETE /v2/templates/:temlate_id/documents/:document_id Delete a template document
+ * @api DELETE /v2/template-documents/:document_id Delete a template document
  * @apiSuccess string . Success
  */
-const deleteTemplateDocument = (endpoint, templateId, documentId) => endpoint.api //
-    .delete(`/v2/templates/${templateId}/documents/${documentId}`)
+const deleteTemplateDocument = (endpoint, documentId) => endpoint.api //
+    .delete(`/v2/template-documents/${documentId}`)
     .then((r) => r.data);
 /**
  * Get all metadata for a template document. Note that when called by non-creators (e.g. Org Collaborators)
@@ -2610,6 +2611,7 @@ const isFieldFilled = (field, allRecipientFields) => {
             return false;
     }
 };
+// TODO: Only allow !required to bypass validation if the field is empty.
 const isFieldValid = (field, allRecipientFields) => {
     return !field.required || isFieldFilled(field, allRecipientFields);
 };