docspring-ts 4.1.0 → 4.2.0

package/dist/WebhookSignature.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WEBHOOK_SIGNATURE_TOLERANCE = void 0;
+exports.verifyWebhookSignature = verifyWebhookSignature;
+var crypto = require("crypto");
+exports.WEBHOOK_SIGNATURE_TOLERANCE = 300;
+function verifyWebhookSignature(payload, signatureHeader, secret, options) {
+    var _a, _b;
+    if (options === void 0) { options = {}; }
+    var tolerance = (_a = options.tolerance) !== null && _a !== void 0 ? _a : exports.WEBHOOK_SIGNATURE_TOLERANCE;
+    var body;
+    if (typeof payload === "string") {
+        body = Buffer.from(payload, "utf8");
+    }
+    else if (payload instanceof Uint8Array) {
+        body = Buffer.from(payload);
+    }
+    else {
+        return false;
+    }
+    if (typeof signatureHeader !== "string" || typeof secret !== "string" || secret === "")
+        return false;
+    var parts = signatureHeader.split(",").map(function (part) {
+        var trimmed = part.trim();
+        var separator = trimmed.indexOf("=");
+        return separator === -1 ? [trimmed, ""] : [trimmed.slice(0, separator), trimmed.slice(separator + 1)];
+    });
+    var timestampPart = parts.find(function (_a) {
+        var key = _a[0];
+        return key === "t";
+    });
+    var signatures = parts.filter(function (_a) {
+        var key = _a[0], value = _a[1];
+        return key === "v1" && value !== "";
+    }).map(function (_a) {
+        var value = _a[1];
+        return value;
+    });
+    if (!timestampPart || !/^[0-9]+$/.test(timestampPart[1]) || signatures.length === 0)
+        return false;
+    var timestamp = timestampPart[1];
+    var now = (_b = options.now) !== null && _b !== void 0 ? _b : Math.floor(Date.now() / 1000);
+    if (Math.abs(now - Number(timestamp)) > tolerance)
+        return false;
+    var hmac = crypto.createHmac("sha256", secret);
+    hmac.update("".concat(timestamp, "."), "utf8");
+    hmac.update(body);
+    var expected = Buffer.from(hmac.digest("hex"), "utf8");
+    return signatures.some(function (signature) {
+        var actual = Buffer.from(signature, "utf8");
+        return actual.length === expected.length && crypto.timingSafeEqual(actual, expected);
+    });
+}
+//# sourceMappingURL=WebhookSignature.js.map

package/dist/WebhookSignature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebhookSignature.js","sourceRoot":"","sources":["../WebhookSignature.ts"],"names":[],"mappings":";;;AAyBA,wDAuCC;AA7DD,+BAAiC;AAGpB,QAAA,2BAA2B,GAAG,GAAG,CAAC;AAmB/C,SAAgB,sBAAsB,CAClC,OAA4B,EAC5B,eAA0C,EAC1C,MAAc,EACd,OAA2C;;IAA3C,wBAAA,EAAA,YAA2C;IAE3C,IAAM,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,mCAA2B,CAAC;IACnE,IAAI,IAAY,CAAC;IACjB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC;SAAM,IAAI,OAAO,YAAY,UAAU,EAAE,CAAC;QACvC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;SAAM,CAAC;QACJ,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,IAAI,OAAO,eAAe,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,EAAE;QAAE,OAAO,KAAK,CAAC;IAErG,IAAM,KAAK,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,UAAC,IAAI;QAC9C,IAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACvC,OAAO,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC;IAC1G,CAAC,CAAC,CAAC;IACH,IAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,UAAC,EAAK;YAAJ,GAAG,QAAA;QAAM,OAAA,GAAG,KAAK,GAAG;IAAX,CAAW,CAAC,CAAC;IACzD,IAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAC,EAAY;YAAX,GAAG,QAAA,EAAE,KAAK,QAAA;QAAM,OAAA,GAAG,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE;IAA5B,CAA4B,CAAC,CAAC,GAAG,CAAC,UAAC,EAAS;YAAN,KAAK,QAAA;QAAM,OAAA,KAAK;IAAL,CAAK,CAAC,CAAC;IAC1G,IAAI,CAAC,aAAa,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAClG,IAAM,SAAS,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IAEnC,IAAM,GAAG,GAAG,MAAA,OAAO,CAAC,GAAG,mCAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IACzD,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IAEhE,IAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACjD,IAAI,CAAC,MAAM,CAAC,UAAG,SAAS,MAAG,EAAE,MAAM,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAClB,IAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IAEzD,OAAO,UAAU,CAAC,IAAI,CAAC,UAAC,SAAS;QAC7B,IAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC9C,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,IAAI,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/apis/Client.d.ts

@@ -14,6 +14,7 @@ import { CreateSignatureRequestEventRequest } from '../models/CreateSignatureReq
 import { CreateSignatureRequestTokenRequest } from '../models/CreateSignatureRequestTokenRequest';
 import { CreateSubmissionBatchRequest } from '../models/CreateSubmissionBatchRequest';
 import { CreateSubmissionRequest } from '../models/CreateSubmissionRequest';
+import { CreateTemplatePreviewRequest } from '../models/CreateTemplatePreviewRequest';
 import { CreateTemplateRequest } from '../models/CreateTemplateRequest';
 import { CreateWebhookRequest } from '../models/CreateWebhookRequest';
 import { CustomFile } from '../models/CustomFile';
@@ -38,12 +39,14 @@ import { SignatureRequestToken } from '../models/SignatureRequestToken';
 import { Submission } from '../models/Submission';
 import { SubmissionBatch } from '../models/SubmissionBatch';
 import { SubmissionList } from '../models/SubmissionList';
+import { SubmissionState } from '../models/SubmissionState';
 import { SubmissionValidation } from '../models/SubmissionValidation';
 import { Template } from '../models/Template';
 import { TemplateDiff } from '../models/TemplateDiff';
 import { TemplateFields } from '../models/TemplateFields';
 import { TemplateModelCode } from '../models/TemplateModelCode';
 import { TemplatePageImages } from '../models/TemplatePageImages';
+import { TemplatePreview } from '../models/TemplatePreview';
 import { TemplateSummaryList } from '../models/TemplateSummaryList';
 import { TemplateVersion } from '../models/TemplateVersion';
 import { UpdateSignatureRequestRequest } from '../models/UpdateSignatureRequestRequest';
@@ -60,14 +63,15 @@ import { WebhookMode } from '../models/WebhookMode';
 export declare class ClientRequestFactory extends BaseAPIRequestFactory {
     addTemplateFields(templateId: string, body: AddTemplateFieldsRequest, _options?: Configuration): Promise<RequestContext>;
     copyTemplate(templateId: string, body?: CopyTemplateRequest, _options?: Configuration): Promise<RequestContext>;
-    createCombinedPdf(body: CreateCombinedPdfRequest, wait?: boolean, _options?: Configuration): Promise<RequestContext>;
+    createCombinedPdf(body: CreateCombinedPdfRequest, wait?: boolean, idempotencyKey?: string, _options?: Configuration): Promise<RequestContext>;
     createCustomFileFromUpload(body: CreateCustomFileFromUploadRequest, _options?: Configuration): Promise<RequestContext>;
     createFolder(body: CreateFolderRequest, _options?: Configuration): Promise<RequestContext>;
     createSignatureRequestEvent(signatureRequestId: string, body: CreateSignatureRequestEventRequest, _options?: Configuration): Promise<RequestContext>;
     createSignatureRequestToken(signatureRequestId: string, body?: CreateSignatureRequestTokenRequest, _options?: Configuration): Promise<RequestContext>;
-    createSubmission(templateId: string, body: CreateSubmissionRequest, version?: string, wait?: boolean, _options?: Configuration): Promise<RequestContext>;
-    createSubmissionBatch(body: CreateSubmissionBatchRequest, wait?: boolean, _options?: Configuration): Promise<RequestContext>;
+    createSubmission(templateId: string, body: CreateSubmissionRequest, version?: string, wait?: boolean, idempotencyKey?: string, _options?: Configuration): Promise<RequestContext>;
+    createSubmissionBatch(body: CreateSubmissionBatchRequest, wait?: boolean, idempotencyKey?: string, _options?: Configuration): Promise<RequestContext>;
     createTemplate(body: CreateTemplateRequest, wait?: boolean, _options?: Configuration): Promise<RequestContext>;
+    createTemplatePreview(templateId: string, body: CreateTemplatePreviewRequest, version?: string, _options?: Configuration): Promise<RequestContext>;
     createWebhook(body: CreateWebhookRequest, _options?: Configuration): Promise<RequestContext>;
     deleteCustomFile(customFileId: string, _options?: Configuration): Promise<RequestContext>;
     deleteFolder(folderId: string, _options?: Configuration): Promise<RequestContext>;
@@ -86,16 +90,17 @@ export declare class ClientRequestFactory extends BaseAPIRequestFactory {
     getSubmissionBatch(submissionBatchId: string, includeData?: boolean, _options?: Configuration): Promise<RequestContext>;
     getTemplate(templateId: string, version?: string, _options?: Configuration): Promise<RequestContext>;
     getTemplateDiff(templateId: string, version?: string, _options?: Configuration): Promise<RequestContext>;
-    getTemplateModelCode(templateId: string, lang: ModelCodeLanguage, version?: string, _options?: Configuration): Promise<RequestContext>;
+    getTemplateModelCode(templateId: string, lang: ModelCodeLanguage, version?: string, justTypes?: boolean, _options?: Configuration): Promise<RequestContext>;
     getTemplatePageImages(templateId: string, version?: string, _options?: Configuration): Promise<RequestContext>;
+    getTemplatePreview(templateId: string, previewId: string, _options?: Configuration): Promise<RequestContext>;
     getTemplateSchema(templateId: string, version?: string, _options?: Configuration): Promise<RequestContext>;
     getWebhook(webhookId: string, _options?: Configuration): Promise<RequestContext>;
     listCombinedPdfs(limit?: number, cursor?: string, _options?: Configuration): Promise<RequestContext>;
     listCustomFiles(limit?: number, cursor?: string, _options?: Configuration): Promise<RequestContext>;
     listFolders(parentFolderId?: string, limit?: number, cursor?: string, _options?: Configuration): Promise<RequestContext>;
-    listSubmissions(templateId?: string, test?: boolean, createdAfter?: Date, createdBefore?: Date, includeData?: boolean, limit?: number, cursor?: string, _options?: Configuration): Promise<RequestContext>;
+    listSubmissions(templateId?: string, test?: boolean, createdAfter?: Date, createdBefore?: Date, includeData?: boolean, limit?: number, cursor?: string, state?: SubmissionState, includeFiles?: boolean, _options?: Configuration): Promise<RequestContext>;
     listTemplateFields(templateId: string, version?: string, _options?: Configuration): Promise<RequestContext>;
-    listTemplateSubmissions(templateId: string, test?: boolean, createdAfter?: Date, createdBefore?: Date, includeData?: boolean, limit?: number, cursor?: string, _options?: Configuration): Promise<RequestContext>;
+    listTemplateSubmissions(templateId: string, test?: boolean, createdAfter?: Date, createdBefore?: Date, includeData?: boolean, limit?: number, cursor?: string, state?: SubmissionState, includeFiles?: boolean, _options?: Configuration): Promise<RequestContext>;
     listTemplates(query?: string, parentFolderId?: string, limit?: number, cursor?: string, _options?: Configuration): Promise<RequestContext>;
     listWebhooks(eventType?: WebhookEventType, mode?: WebhookMode, templateId?: string, folderId?: string, apiTokenId?: string, limit?: number, cursor?: string, _options?: Configuration): Promise<RequestContext>;
     moveFolder(folderId: string, body: MoveFolderRequest, _options?: Configuration): Promise<RequestContext>;
@@ -126,6 +131,7 @@ export declare class ClientResponseProcessor {
     createSubmissionWithHttpInfo(response: ResponseContext): Promise<HttpInfo<Submission>>;
     createSubmissionBatchWithHttpInfo(response: ResponseContext): Promise<HttpInfo<SubmissionBatch>>;
     createTemplateWithHttpInfo(response: ResponseContext): Promise<HttpInfo<Template>>;
+    createTemplatePreviewWithHttpInfo(response: ResponseContext): Promise<HttpInfo<TemplatePreview>>;
     createWebhookWithHttpInfo(response: ResponseContext): Promise<HttpInfo<Webhook>>;
     deleteCustomFileWithHttpInfo(response: ResponseContext): Promise<HttpInfo<CustomFile>>;
     deleteFolderWithHttpInfo(response: ResponseContext): Promise<HttpInfo<Folder>>;
@@ -146,6 +152,7 @@ export declare class ClientResponseProcessor {
     getTemplateDiffWithHttpInfo(response: ResponseContext): Promise<HttpInfo<TemplateDiff>>;
     getTemplateModelCodeWithHttpInfo(response: ResponseContext): Promise<HttpInfo<TemplateModelCode>>;
     getTemplatePageImagesWithHttpInfo(response: ResponseContext): Promise<HttpInfo<TemplatePageImages>>;
+    getTemplatePreviewWithHttpInfo(response: ResponseContext): Promise<HttpInfo<TemplatePreview>>;
     getTemplateSchemaWithHttpInfo(response: ResponseContext): Promise<HttpInfo<{
         [key: string]: any;
     }>>;