docspring-ts 1.0.1 → 2.0.0

package/README.md

@@ -0,0 +1,80 @@
+## docspring-ts@2.0.0
+
+This generator creates TypeScript/JavaScript client that utilizes fetch-api.
+
+### Building
+
+To build and compile the typescript sources to javascript use:
+```
+npm install
+npm run build
+```
+
+### Publishing
+
+First build the package then run ```npm publish```
+
+### Consuming
+
+Navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install docspring-ts@2.0.0 --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save
+```
+
+### Usage
+
+Below code snippet shows exemplary usage of the configuration and the API based 
+on the typical `PetStore` example used for OpenAPI. 
+
+```
+import * as your_api from 'your_api_package'
+
+// Covers all auth methods included in your OpenAPI yaml definition
+const authConfig: your_api.AuthMethodsConfiguration = {
+    "api_key": "YOUR_API_KEY"
+}
+
+// Implements a simple middleware to modify requests before (`pre`) they are sent
+// and after (`post`) they have been received 
+class Test implements your_api.Middleware {
+    pre(context: your_api.RequestContext): Promise<your_api.RequestContext> {
+        // Modify context here and return
+        return Promise.resolve(context);
+    }
+
+    post(context: your_api.ResponseContext): Promise<your_api.ResponseContext> {
+        return Promise.resolve(context);
+    }
+
+}
+
+// Create configuration parameter object
+const configurationParameters = {
+    httpApi: new your_api.JQueryHttpLibrary(), // Can also be ignored - default is usually fine
+    baseServer: your_api.servers[0], // First server is default
+    authMethods: authConfig, // No auth is default
+    promiseMiddleware: [new Test()],
+}
+
+// Convert to actual configuration
+const config = your_api.createConfiguration(configurationParameters);
+
+// Use configuration with your_api
+const api = new your_api.PetApi(config);
+your_api.Pet p = new your_api.Pet();
+p.name = "My new pet";
+p.photoUrls = [];
+p.tags = [];
+p.status = "available";
+Promise<your_api.Pet> createdPet = api.addPet(p);
+
+```

package/dist/apis/PDFApi.d.ts

@@ -0,0 +1,121 @@
+import { BaseAPIRequestFactory } from './baseapi';
+import { Configuration } from '../configuration';
+import { RequestContext, ResponseContext, HttpFile, HttpInfo } from '../http/http';
+import { AddFieldsData } from '../models/AddFieldsData';
+import { BatchGeneratePdfs201Response } from '../models/BatchGeneratePdfs201Response';
+import { CombinePdfsData } from '../models/CombinePdfsData';
+import { CombinedSubmission } from '../models/CombinedSubmission';
+import { CombinedSubmissionData } from '../models/CombinedSubmissionData';
+import { CopyTemplateOptions } from '../models/CopyTemplateOptions';
+import { CreateCombinedSubmissionResponse } from '../models/CreateCombinedSubmissionResponse';
+import { CreateCustomFileData } from '../models/CreateCustomFileData';
+import { CreateCustomFileResponse } from '../models/CreateCustomFileResponse';
+import { CreateFolderData } from '../models/CreateFolderData';
+import { CreateHtmlSubmissionData } from '../models/CreateHtmlSubmissionData';
+import { CreateHtmlTemplate } from '../models/CreateHtmlTemplate';
+import { CreatePdfSubmissionData } from '../models/CreatePdfSubmissionData';
+import { CreatePdfTemplate } from '../models/CreatePdfTemplate';
+import { CreateSubmissionDataRequestEventRequest } from '../models/CreateSubmissionDataRequestEventRequest';
+import { CreateSubmissionDataRequestEventResponse } from '../models/CreateSubmissionDataRequestEventResponse';
+import { CreateSubmissionDataRequestResponse } from '../models/CreateSubmissionDataRequestResponse';
+import { CreateSubmissionDataRequestTokenResponse } from '../models/CreateSubmissionDataRequestTokenResponse';
+import { CreateSubmissionResponse } from '../models/CreateSubmissionResponse';
+import { Folder } from '../models/Folder';
+import { JsonSchema } from '../models/JsonSchema';
+import { ListSubmissionsResponse } from '../models/ListSubmissionsResponse';
+import { MoveFolderData } from '../models/MoveFolderData';
+import { MoveTemplateData } from '../models/MoveTemplateData';
+import { RenameFolderData } from '../models/RenameFolderData';
+import { Submission } from '../models/Submission';
+import { SubmissionBatchData } from '../models/SubmissionBatchData';
+import { SubmissionBatchWithSubmissions } from '../models/SubmissionBatchWithSubmissions';
+import { SubmissionDataRequestShow } from '../models/SubmissionDataRequestShow';
+import { SubmissionPreview } from '../models/SubmissionPreview';
+import { SuccessErrorResponse } from '../models/SuccessErrorResponse';
+import { SuccessMultipleErrorsResponse } from '../models/SuccessMultipleErrorsResponse';
+import { Template } from '../models/Template';
+import { TemplateAddFieldsResponse } from '../models/TemplateAddFieldsResponse';
+import { TemplatePreview } from '../models/TemplatePreview';
+import { UpdateHtmlTemplate } from '../models/UpdateHtmlTemplate';
+import { UpdateSubmissionDataRequestData } from '../models/UpdateSubmissionDataRequestData';
+import { UploadPresignResponse } from '../models/UploadPresignResponse';
+export declare class PDFApiRequestFactory extends BaseAPIRequestFactory {
+    addFieldsToTemplate(templateId: string, data: AddFieldsData, _options?: Configuration): Promise<RequestContext>;
+    batchGeneratePdfs(data: SubmissionBatchData, wait?: boolean, _options?: Configuration): Promise<RequestContext>;
+    combinePdfs(data: CombinePdfsData, _options?: Configuration): Promise<RequestContext>;
+    combineSubmissions(data: CombinedSubmissionData, wait?: boolean, _options?: Configuration): Promise<RequestContext>;
+    copyTemplate(templateId: string, options?: CopyTemplateOptions, _options?: Configuration): Promise<RequestContext>;
+    createCustomFileFromUpload(data: CreateCustomFileData, _options?: Configuration): Promise<RequestContext>;
+    createDataRequestEvent(dataRequestId: string, event: CreateSubmissionDataRequestEventRequest, _options?: Configuration): Promise<RequestContext>;
+    createDataRequestToken(dataRequestId: string, type?: 'api' | 'email', _options?: Configuration): Promise<RequestContext>;
+    createFolder(data: CreateFolderData, _options?: Configuration): Promise<RequestContext>;
+    createHTMLTemplate(data: CreateHtmlTemplate, _options?: Configuration): Promise<RequestContext>;
+    createPDFTemplate(templateDocument: HttpFile, templateName: string, wait?: boolean, templateDescription?: string, templateParentFolderId?: string, _options?: Configuration): Promise<RequestContext>;
+    createPDFTemplateFromUpload(data: CreatePdfTemplate, _options?: Configuration): Promise<RequestContext>;
+    deleteFolder(folderId: string, _options?: Configuration): Promise<RequestContext>;
+    deleteTemplate(templateId: string, _options?: Configuration): Promise<RequestContext>;
+    expireCombinedSubmission(combinedSubmissionId: string, _options?: Configuration): Promise<RequestContext>;
+    expireSubmission(submissionId: string, _options?: Configuration): Promise<RequestContext>;
+    generatePdf(templateId: string, submission: CreatePdfSubmissionData, wait?: boolean, _options?: Configuration): Promise<RequestContext>;
+    generatePdfForHtmlTemplate(templateId: string, submission: CreateHtmlSubmissionData, wait?: boolean, _options?: Configuration): Promise<RequestContext>;
+    generatePreview(submissionId: string, _options?: Configuration): Promise<RequestContext>;
+    getCombinedSubmission(combinedSubmissionId: string, _options?: Configuration): Promise<RequestContext>;
+    getDataRequest(dataRequestId: string, _options?: Configuration): Promise<RequestContext>;
+    getFullTemplate(templateId: string, _options?: Configuration): Promise<RequestContext>;
+    getPresignUrl(_options?: Configuration): Promise<RequestContext>;
+    getSubmission(submissionId: string, includeData?: boolean, _options?: Configuration): Promise<RequestContext>;
+    getSubmissionBatch(submissionBatchId: string, includeSubmissions?: boolean, _options?: Configuration): Promise<RequestContext>;
+    getTemplate(templateId: string, _options?: Configuration): Promise<RequestContext>;
+    getTemplateSchema(templateId: string, _options?: Configuration): Promise<RequestContext>;
+    listCombinedSubmissions(page?: number, perPage?: number, _options?: Configuration): Promise<RequestContext>;
+    listFolders(parentFolderId?: string, _options?: Configuration): Promise<RequestContext>;
+    listSubmissions(cursor?: string, limit?: number, createdAfter?: string, createdBefore?: string, type?: string, includeData?: boolean, _options?: Configuration): Promise<RequestContext>;
+    listTemplateSubmissions(templateId: string, cursor?: string, limit?: number, createdAfter?: string, createdBefore?: string, type?: string, includeData?: boolean, _options?: Configuration): Promise<RequestContext>;
+    listTemplates(query?: string, parentFolderId?: string, page?: number, perPage?: number, _options?: Configuration): Promise<RequestContext>;
+    moveFolderToFolder(folderId: string, data: MoveFolderData, _options?: Configuration): Promise<RequestContext>;
+    moveTemplateToFolder(templateId: string, data: MoveTemplateData, _options?: Configuration): Promise<RequestContext>;
+    renameFolder(folderId: string, data: RenameFolderData, _options?: Configuration): Promise<RequestContext>;
+    testAuthentication(_options?: Configuration): Promise<RequestContext>;
+    updateDataRequest(dataRequestId: string, data: UpdateSubmissionDataRequestData, _options?: Configuration): Promise<RequestContext>;
+    updateTemplate(templateId: string, data: UpdateHtmlTemplate, _options?: Configuration): Promise<RequestContext>;
+}
+export declare class PDFApiResponseProcessor {
+    addFieldsToTemplateWithHttpInfo(response: ResponseContext): Promise<HttpInfo<TemplateAddFieldsResponse>>;
+    batchGeneratePdfsWithHttpInfo(response: ResponseContext): Promise<HttpInfo<BatchGeneratePdfs201Response>>;
+    combinePdfsWithHttpInfo(response: ResponseContext): Promise<HttpInfo<CreateCombinedSubmissionResponse>>;
+    combineSubmissionsWithHttpInfo(response: ResponseContext): Promise<HttpInfo<CreateCombinedSubmissionResponse>>;
+    copyTemplateWithHttpInfo(response: ResponseContext): Promise<HttpInfo<TemplatePreview>>;
+    createCustomFileFromUploadWithHttpInfo(response: ResponseContext): Promise<HttpInfo<CreateCustomFileResponse>>;
+    createDataRequestEventWithHttpInfo(response: ResponseContext): Promise<HttpInfo<CreateSubmissionDataRequestEventResponse>>;
+    createDataRequestTokenWithHttpInfo(response: ResponseContext): Promise<HttpInfo<CreateSubmissionDataRequestTokenResponse>>;
+    createFolderWithHttpInfo(response: ResponseContext): Promise<HttpInfo<Folder>>;
+    createHTMLTemplateWithHttpInfo(response: ResponseContext): Promise<HttpInfo<TemplatePreview>>;
+    createPDFTemplateWithHttpInfo(response: ResponseContext): Promise<HttpInfo<TemplatePreview>>;
+    createPDFTemplateFromUploadWithHttpInfo(response: ResponseContext): Promise<HttpInfo<TemplatePreview>>;
+    deleteFolderWithHttpInfo(response: ResponseContext): Promise<HttpInfo<Folder>>;
+    deleteTemplateWithHttpInfo(response: ResponseContext): Promise<HttpInfo<SuccessMultipleErrorsResponse>>;
+    expireCombinedSubmissionWithHttpInfo(response: ResponseContext): Promise<HttpInfo<CombinedSubmission>>;
+    expireSubmissionWithHttpInfo(response: ResponseContext): Promise<HttpInfo<SubmissionPreview>>;
+    generatePdfWithHttpInfo(response: ResponseContext): Promise<HttpInfo<CreateSubmissionResponse>>;
+    generatePdfForHtmlTemplateWithHttpInfo(response: ResponseContext): Promise<HttpInfo<CreateSubmissionResponse>>;
+    generatePreviewWithHttpInfo(response: ResponseContext): Promise<HttpInfo<SuccessErrorResponse>>;
+    getCombinedSubmissionWithHttpInfo(response: ResponseContext): Promise<HttpInfo<CombinedSubmission>>;
+    getDataRequestWithHttpInfo(response: ResponseContext): Promise<HttpInfo<SubmissionDataRequestShow>>;
+    getFullTemplateWithHttpInfo(response: ResponseContext): Promise<HttpInfo<Template>>;
+    getPresignUrlWithHttpInfo(response: ResponseContext): Promise<HttpInfo<UploadPresignResponse>>;
+    getSubmissionWithHttpInfo(response: ResponseContext): Promise<HttpInfo<Submission>>;
+    getSubmissionBatchWithHttpInfo(response: ResponseContext): Promise<HttpInfo<SubmissionBatchWithSubmissions>>;
+    getTemplateWithHttpInfo(response: ResponseContext): Promise<HttpInfo<TemplatePreview>>;
+    getTemplateSchemaWithHttpInfo(response: ResponseContext): Promise<HttpInfo<JsonSchema>>;
+    listCombinedSubmissionsWithHttpInfo(response: ResponseContext): Promise<HttpInfo<Array<CombinedSubmission>>>;
+    listFoldersWithHttpInfo(response: ResponseContext): Promise<HttpInfo<Array<Folder>>>;
+    listSubmissionsWithHttpInfo(response: ResponseContext): Promise<HttpInfo<ListSubmissionsResponse>>;
+    listTemplateSubmissionsWithHttpInfo(response: ResponseContext): Promise<HttpInfo<ListSubmissionsResponse>>;
+    listTemplatesWithHttpInfo(response: ResponseContext): Promise<HttpInfo<Array<TemplatePreview>>>;
+    moveFolderToFolderWithHttpInfo(response: ResponseContext): Promise<HttpInfo<Folder>>;
+    moveTemplateToFolderWithHttpInfo(response: ResponseContext): Promise<HttpInfo<TemplatePreview>>;
+    renameFolderWithHttpInfo(response: ResponseContext): Promise<HttpInfo<Folder>>;
+    testAuthenticationWithHttpInfo(response: ResponseContext): Promise<HttpInfo<SuccessErrorResponse>>;
+    updateDataRequestWithHttpInfo(response: ResponseContext): Promise<HttpInfo<CreateSubmissionDataRequestResponse>>;
+    updateTemplateWithHttpInfo(response: ResponseContext): Promise<HttpInfo<SuccessMultipleErrorsResponse>>;
+}