docspring-ts 1.0.0 → 1.0.1

package/.openapi-generator/FILES

@@ -7,11 +7,13 @@ model/addFieldsData.ts
 model/addFieldsTemplateResponse.ts
 model/authenticationError.ts
 model/authenticationSuccessResponse.ts
+model/combinePdfsData.ts
 model/combinedSubmission.ts
 model/combinedSubmissionAction.ts
 model/combinedSubmissionData.ts
 model/copyTemplateData.ts
 model/createCombinedSubmissionResponse.ts
+model/createCustomFileData.ts
 model/createCustomFileResponse.ts
 model/createFolderData.ts
 model/createFolderDataFolder.ts

package/CHANGELOG.md

@@ -0,0 +1,4 @@
+### 1.0.1 [August 30, 2023]
+
+- Commit dist directory
+

package/api/PDFApi.ts

@@ -19,10 +19,12 @@ import { AddFieldsData } from '../model/addFieldsData';
 import { AddFieldsTemplateResponse } from '../model/addFieldsTemplateResponse';
 import { AuthenticationError } from '../model/authenticationError';
 import { AuthenticationSuccessResponse } from '../model/authenticationSuccessResponse';
+import { CombinePdfsData } from '../model/combinePdfsData';
 import { CombinedSubmission } from '../model/combinedSubmission';
 import { CombinedSubmissionData } from '../model/combinedSubmissionData';
 import { CopyTemplateData } from '../model/copyTemplateData';
 import { CreateCombinedSubmissionResponse } from '../model/createCombinedSubmissionResponse';
+import { CreateCustomFileData } from '../model/createCustomFileData';
 import { CreateCustomFileResponse } from '../model/createCustomFileResponse';
 import { CreateFolderData } from '../model/createFolderData';
 import { CreateHtmlTemplateData } from '../model/createHtmlTemplateData';
@@ -366,9 +368,9 @@ export class PDFApi {
     /**
      * 
      * @summary Merge submission PDFs, template PDFs, or custom files
-     * @param UNKNOWN_PARAM_NAME 
+     * @param data 
      */
-    public async combinePdfs (UNKNOWN_PARAM_NAME: , options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: CreateCombinedSubmissionResponse;  }> {
+    public async combinePdfs (data: CombinePdfsData, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: CreateCombinedSubmissionResponse;  }> {
         const localVarPath = this.basePath + '/combined_submissions?v=2';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -381,9 +383,9 @@ export class PDFApi {
         }
         let localVarFormParams: any = {};
 
-        // verify required parameter 'UNKNOWN_PARAM_NAME' is not null or undefined
-        if (UNKNOWN_PARAM_NAME === null || UNKNOWN_PARAM_NAME === undefined) {
-            throw new Error('Required parameter UNKNOWN_PARAM_NAME was null or undefined when calling combinePdfs.');
+        // verify required parameter 'data' is not null or undefined
+        if (data === null || data === undefined) {
+            throw new Error('Required parameter data was null or undefined when calling combinePdfs.');
         }
 
         (<any>Object).assign(localVarHeaderParams, options.headers);
@@ -397,7 +399,7 @@ export class PDFApi {
             uri: localVarPath,
             useQuerystring: this._useQuerystring,
             json: true,
-            body: ObjectSerializer.serialize(UNKNOWN_PARAM_NAME, "")
+            body: ObjectSerializer.serialize(data, "CombinePdfsData")
         };
 
         let authenticationPromise = Promise.resolve();
@@ -584,9 +586,9 @@ export class PDFApi {
     /**
      * 
      * @summary Create a new custom file from a cached presign upload
-     * @param UNKNOWN_PARAM_NAME 
+     * @param data 
      */
-    public async createCustomFileFromUpload (UNKNOWN_PARAM_NAME: , options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: CreateCustomFileResponse;  }> {
+    public async createCustomFileFromUpload (data: CreateCustomFileData, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: CreateCustomFileResponse;  }> {
         const localVarPath = this.basePath + '/custom_files';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -599,9 +601,9 @@ export class PDFApi {
         }
         let localVarFormParams: any = {};
 
-        // verify required parameter 'UNKNOWN_PARAM_NAME' is not null or undefined
-        if (UNKNOWN_PARAM_NAME === null || UNKNOWN_PARAM_NAME === undefined) {
-            throw new Error('Required parameter UNKNOWN_PARAM_NAME was null or undefined when calling createCustomFileFromUpload.');
+        // verify required parameter 'data' is not null or undefined
+        if (data === null || data === undefined) {
+            throw new Error('Required parameter data was null or undefined when calling createCustomFileFromUpload.');
         }
 
         (<any>Object).assign(localVarHeaderParams, options.headers);
@@ -615,7 +617,7 @@ export class PDFApi {
             uri: localVarPath,
             useQuerystring: this._useQuerystring,
             json: true,
-            body: ObjectSerializer.serialize(UNKNOWN_PARAM_NAME, "")
+            body: ObjectSerializer.serialize(data, "CreateCustomFileData")
         };
 
         let authenticationPromise = Promise.resolve();

package/api/apis.ts

@@ -1,5 +1,6 @@
 export * from './PDFApi';
 import { PDFApi } from './PDFApi';
+//import { Client } from './Client';
 import * as http from 'http';
 
 export class HttpError extends Error {
@@ -11,4 +12,5 @@ export class HttpError extends Error {
 
 export { RequestFile } from '../model/models';
 
+//export const APIS = [Client, PDFApi];
 export const APIS = [PDFApi];

package/api.ts

@@ -1,3 +1,4 @@
 // This is the entrypoint for the package
 export * from './api/apis';
+//export * from './api/Client';
 export * from './model/models';

package/dist/api/PDFApi.d.ts

@@ -0,0 +1,351 @@
+/// <reference types="node" />
+import http from 'http';
+import { AddFieldsData } from '../model/addFieldsData';
+import { AddFieldsTemplateResponse } from '../model/addFieldsTemplateResponse';
+import { AuthenticationSuccessResponse } from '../model/authenticationSuccessResponse';
+import { CombinePdfsData } from '../model/combinePdfsData';
+import { CombinedSubmission } from '../model/combinedSubmission';
+import { CombinedSubmissionData } from '../model/combinedSubmissionData';
+import { CopyTemplateData } from '../model/copyTemplateData';
+import { CreateCombinedSubmissionResponse } from '../model/createCombinedSubmissionResponse';
+import { CreateCustomFileData } from '../model/createCustomFileData';
+import { CreateCustomFileResponse } from '../model/createCustomFileResponse';
+import { CreateFolderData } from '../model/createFolderData';
+import { CreateHtmlTemplateData } from '../model/createHtmlTemplateData';
+import { CreateSubmissionBatchResponse } from '../model/createSubmissionBatchResponse';
+import { CreateSubmissionDataRequestTokenResponse } from '../model/createSubmissionDataRequestTokenResponse';
+import { CreateSubmissionResponse } from '../model/createSubmissionResponse';
+import { CreateTemplateFromUploadData } from '../model/createTemplateFromUploadData';
+import { DeleteTemplateResponse } from '../model/deleteTemplateResponse';
+import { Folder } from '../model/folder';
+import { FullTemplate } from '../model/fullTemplate';
+import { ListSubmissionsResponse } from '../model/listSubmissionsResponse';
+import { MoveFolderData } from '../model/moveFolderData';
+import { MoveTemplateData } from '../model/moveTemplateData';
+import { PendingTemplate } from '../model/pendingTemplate';
+import { RenameFolderData } from '../model/renameFolderData';
+import { Submission } from '../model/submission';
+import { SubmissionBatch } from '../model/submissionBatch';
+import { SubmissionBatchData } from '../model/submissionBatchData';
+import { SubmissionData } from '../model/submissionData';
+import { SubmissionDataRequest } from '../model/submissionDataRequest';
+import { Template } from '../model/template';
+import { UpdateDataRequestResponse } from '../model/updateDataRequestResponse';
+import { UpdateSubmissionDataRequestData } from '../model/updateSubmissionDataRequestData';
+import { UpdateTemplateData } from '../model/updateTemplateData';
+import { UpdateTemplateResponse } from '../model/updateTemplateResponse';
+import { Authentication, Interceptor } from '../model/models';
+import { HttpBasicAuth } from '../model/models';
+import { RequestFile } from './apis';
+export declare enum PDFApiApiKeys {
+}
+export declare class PDFApi {
+    protected _basePath: string;
+    protected _defaultHeaders: any;
+    protected _useQuerystring: boolean;
+    protected authentications: {
+        default: Authentication;
+        api_token_basic: HttpBasicAuth;
+    };
+    protected interceptors: Interceptor[];
+    constructor(basePath?: string);
+    constructor(username: string, password: string, basePath?: string);
+    set useQuerystring(value: boolean);
+    set basePath(basePath: string);
+    set defaultHeaders(defaultHeaders: any);
+    get defaultHeaders(): any;
+    get basePath(): string;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: PDFApiApiKeys, value: string): void;
+    set username(username: string);
+    set password(password: string);
+    addInterceptor(interceptor: Interceptor): void;
+    addFieldsToTemplate(templateId: string, data: AddFieldsData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: AddFieldsTemplateResponse;
+    }>;
+    batchGeneratePdfV1(templateId: string, data: Array<object>, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Array<CreateSubmissionResponse>;
+    }>;
+    batchGeneratePdfs(data: SubmissionBatchData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: CreateSubmissionBatchResponse;
+    }>;
+    combinePdfs(data: CombinePdfsData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: CreateCombinedSubmissionResponse;
+    }>;
+    combineSubmissions(data: CombinedSubmissionData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: CreateCombinedSubmissionResponse;
+    }>;
+    copyTemplate(templateId: string, data?: CopyTemplateData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Template;
+    }>;
+    createCustomFileFromUpload(data: CreateCustomFileData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: CreateCustomFileResponse;
+    }>;
+    createDataRequestToken(dataRequestId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: CreateSubmissionDataRequestTokenResponse;
+    }>;
+    createFolder(data: CreateFolderData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Folder;
+    }>;
+    createHTMLTemplate(data: CreateHtmlTemplateData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: PendingTemplate;
+    }>;
+    createPDFTemplate(templateDocument: RequestFile, templateName: string, templateParentFolderId?: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: PendingTemplate;
+    }>;
+    createPDFTemplateFromUpload(data: CreateTemplateFromUploadData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: PendingTemplate;
+    }>;
+    deleteFolder(folderId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Folder;
+    }>;
+    deleteTemplate(templateId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: DeleteTemplateResponse;
+    }>;
+    expireCombinedSubmission(combinedSubmissionId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: CombinedSubmission;
+    }>;
+    expireSubmission(submissionId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Submission;
+    }>;
+    generatePDF(templateId: string, data: SubmissionData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: CreateSubmissionResponse;
+    }>;
+    getCombinedSubmission(combinedSubmissionId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: CombinedSubmission;
+    }>;
+    getDataRequest(dataRequestId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: SubmissionDataRequest;
+    }>;
+    getFullTemplate(templateId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: FullTemplate;
+    }>;
+    getPresignUrl(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: object;
+    }>;
+    getSubmission(submissionId: string, includeData?: boolean, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Submission;
+    }>;
+    getSubmissionBatch(submissionBatchId: string, includeSubmissions?: boolean, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: SubmissionBatch;
+    }>;
+    getTemplate(templateId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Template;
+    }>;
+    getTemplateSchema(templateId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: object;
+    }>;
+    listCombinedSubmissions(page?: number, perPage?: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Array<CombinedSubmission>;
+    }>;
+    listFolders(parentFolderId?: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Array<Folder>;
+    }>;
+    listSubmissions(cursor?: string, limit?: number, createdAfter?: string, createdBefore?: string, type?: string, includeData?: boolean, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: ListSubmissionsResponse;
+    }>;
+    listSubmissions_1(templateId: string, cursor?: string, limit?: number, createdAfter?: string, createdBefore?: string, type?: string, includeData?: boolean, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: ListSubmissionsResponse;
+    }>;
+    listTemplates(query?: string, parentFolderId?: string, page?: number, perPage?: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Array<Template>;
+    }>;
+    moveFolderToFolder(folderId: string, data: MoveFolderData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Folder;
+    }>;
+    moveTemplateToFolder(templateId: string, data: MoveTemplateData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Template;
+    }>;
+    renameFolder(folderId: string, data: RenameFolderData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body?: any;
+    }>;
+    testAuthentication(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: AuthenticationSuccessResponse;
+    }>;
+    updateDataRequest(dataRequestId: string, data: UpdateSubmissionDataRequestData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: UpdateDataRequestResponse;
+    }>;
+    updateTemplate(templateId: string, data: UpdateTemplateData, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: UpdateTemplateResponse;
+    }>;
+}