docspring-ts 1.0.0

package/api/apis.ts

@@ -0,0 +1,14 @@
+export * from './PDFApi';
+import { PDFApi } from './PDFApi';
+import * as http from 'http';
+
+export class HttpError extends Error {
+    constructor (public response: http.IncomingMessage, public body: any, public statusCode?: number) {
+        super('HTTP request failed');
+        this.name = 'HttpError';
+    }
+}
+
+export { RequestFile } from '../model/models';
+
+export const APIS = [PDFApi];

package/api.ts

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

package/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

package/model/addFieldsData.ts

@@ -0,0 +1,31 @@
+/**
+ * API v1
+ * DocSpring is a service that helps you fill out and sign PDF templates.
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class AddFieldsData {
+    'fields': Array<object>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "fields",
+            "baseName": "fields",
+            "type": "Array<object>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return AddFieldsData.attributeTypeMap;
+    }
+}
+

package/model/addFieldsTemplateResponse.ts

@@ -0,0 +1,49 @@
+/**
+ * API v1
+ * DocSpring is a service that helps you fill out and sign PDF templates.
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class AddFieldsTemplateResponse {
+    'status': AddFieldsTemplateResponse.StatusEnum;
+    'errors'?: Array<string>;
+    'newFieldIds'?: Array<number>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "AddFieldsTemplateResponse.StatusEnum"
+        },
+        {
+            "name": "errors",
+            "baseName": "errors",
+            "type": "Array<string>"
+        },
+        {
+            "name": "newFieldIds",
+            "baseName": "new_field_ids",
+            "type": "Array<number>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return AddFieldsTemplateResponse.attributeTypeMap;
+    }
+}
+
+export namespace AddFieldsTemplateResponse {
+    export enum StatusEnum {
+        Success = <any> 'success',
+        Error = <any> 'error'
+    }
+}

package/model/authenticationError.ts

@@ -0,0 +1,42 @@
+/**
+ * API v1
+ * DocSpring is a service that helps you fill out and sign PDF templates.
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class AuthenticationError {
+    'status'?: AuthenticationError.StatusEnum;
+    'error': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "AuthenticationError.StatusEnum"
+        },
+        {
+            "name": "error",
+            "baseName": "error",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return AuthenticationError.attributeTypeMap;
+    }
+}
+
+export namespace AuthenticationError {
+    export enum StatusEnum {
+        Error = <any> 'error'
+    }
+}

package/model/authenticationSuccessResponse.ts

@@ -0,0 +1,36 @@
+/**
+ * API v1
+ * DocSpring is a service that helps you fill out and sign PDF templates.
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class AuthenticationSuccessResponse {
+    'status': AuthenticationSuccessResponse.StatusEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "AuthenticationSuccessResponse.StatusEnum"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return AuthenticationSuccessResponse.attributeTypeMap;
+    }
+}
+
+export namespace AuthenticationSuccessResponse {
+    export enum StatusEnum {
+        Success = <any> 'success'
+    }
+}

package/model/combinedSubmission.ts

@@ -0,0 +1,111 @@
+/**
+ * API v1
+ * DocSpring is a service that helps you fill out and sign PDF templates.
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+import { CombinedSubmissionAction } from './combinedSubmissionAction';
+
+export class CombinedSubmission {
+    'id': string;
+    'expired': boolean;
+    'expiresIn'?: number | null;
+    'expiresAt'?: string | null;
+    'state': CombinedSubmission.StateEnum;
+    'errorMessage'?: string | null;
+    'metadata'?: object;
+    'password'?: string | null;
+    'submissionIds': Array<string>;
+    'sourcePdfs': Array<object>;
+    'downloadUrl'?: string | null;
+    'pdfHash'?: string | null;
+    'actions'?: Array<CombinedSubmissionAction>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "expired",
+            "baseName": "expired",
+            "type": "boolean"
+        },
+        {
+            "name": "expiresIn",
+            "baseName": "expires_in",
+            "type": "number"
+        },
+        {
+            "name": "expiresAt",
+            "baseName": "expires_at",
+            "type": "string"
+        },
+        {
+            "name": "state",
+            "baseName": "state",
+            "type": "CombinedSubmission.StateEnum"
+        },
+        {
+            "name": "errorMessage",
+            "baseName": "error_message",
+            "type": "string"
+        },
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "object"
+        },
+        {
+            "name": "password",
+            "baseName": "password",
+            "type": "string"
+        },
+        {
+            "name": "submissionIds",
+            "baseName": "submission_ids",
+            "type": "Array<string>"
+        },
+        {
+            "name": "sourcePdfs",
+            "baseName": "source_pdfs",
+            "type": "Array<object>"
+        },
+        {
+            "name": "downloadUrl",
+            "baseName": "download_url",
+            "type": "string"
+        },
+        {
+            "name": "pdfHash",
+            "baseName": "pdf_hash",
+            "type": "string"
+        },
+        {
+            "name": "actions",
+            "baseName": "actions",
+            "type": "Array<CombinedSubmissionAction>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CombinedSubmission.attributeTypeMap;
+    }
+}
+
+export namespace CombinedSubmission {
+    export enum StateEnum {
+        Pending = <any> 'pending',
+        Processed = <any> 'processed',
+        Error = <any> 'error'
+    }
+}

package/model/combinedSubmissionAction.ts

@@ -0,0 +1,79 @@
+/**
+ * API v1
+ * DocSpring is a service that helps you fill out and sign PDF templates.
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class CombinedSubmissionAction {
+    'id': string;
+    'integrationId': string | null;
+    'state': CombinedSubmissionAction.StateEnum;
+    'actionCategory': CombinedSubmissionAction.ActionCategoryEnum;
+    'actionType': CombinedSubmissionAction.ActionTypeEnum;
+    'resultData': object;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "integrationId",
+            "baseName": "integration_id",
+            "type": "string"
+        },
+        {
+            "name": "state",
+            "baseName": "state",
+            "type": "CombinedSubmissionAction.StateEnum"
+        },
+        {
+            "name": "actionCategory",
+            "baseName": "action_category",
+            "type": "CombinedSubmissionAction.ActionCategoryEnum"
+        },
+        {
+            "name": "actionType",
+            "baseName": "action_type",
+            "type": "CombinedSubmissionAction.ActionTypeEnum"
+        },
+        {
+            "name": "resultData",
+            "baseName": "result_data",
+            "type": "object"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CombinedSubmissionAction.attributeTypeMap;
+    }
+}
+
+export namespace CombinedSubmissionAction {
+    export enum StateEnum {
+        Pending = <any> 'pending',
+        Processed = <any> 'processed',
+        Failed = <any> 'failed',
+        Error = <any> 'error'
+    }
+    export enum ActionCategoryEnum {
+        Notification = <any> 'notification',
+        FileUpload = <any> 'file_upload'
+    }
+    export enum ActionTypeEnum {
+        Webhook = <any> 'webhook',
+        SlackWebhook = <any> 'slack_webhook',
+        Email = <any> 'email',
+        AwsS3Upload = <any> 'aws_s3_upload'
+    }
+}

package/model/combinedSubmissionData.ts

@@ -0,0 +1,55 @@
+/**
+ * API v1
+ * DocSpring is a service that helps you fill out and sign PDF templates.
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class CombinedSubmissionData {
+    'expiresIn'?: number;
+    'metadata'?: object;
+    'password'?: string;
+    'submissionIds': Array<string>;
+    'test'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "expiresIn",
+            "baseName": "expires_in",
+            "type": "number"
+        },
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "object"
+        },
+        {
+            "name": "password",
+            "baseName": "password",
+            "type": "string"
+        },
+        {
+            "name": "submissionIds",
+            "baseName": "submission_ids",
+            "type": "Array<string>"
+        },
+        {
+            "name": "test",
+            "baseName": "test",
+            "type": "boolean"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CombinedSubmissionData.attributeTypeMap;
+    }
+}
+

package/model/copyTemplateData.ts

@@ -0,0 +1,37 @@
+/**
+ * API v1
+ * DocSpring is a service that helps you fill out and sign PDF templates.
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class CopyTemplateData {
+    'name'?: string;
+    'parentFolderId': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "parentFolderId",
+            "baseName": "parent_folder_id",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CopyTemplateData.attributeTypeMap;
+    }
+}
+

package/model/createCombinedSubmissionResponse.ts

@@ -0,0 +1,50 @@
+/**
+ * API v1
+ * DocSpring is a service that helps you fill out and sign PDF templates.
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+import { CombinedSubmission } from './combinedSubmission';
+
+export class CreateCombinedSubmissionResponse {
+    'status': CreateCombinedSubmissionResponse.StatusEnum;
+    'errors'?: Array<string>;
+    'combinedSubmission': CombinedSubmission;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "CreateCombinedSubmissionResponse.StatusEnum"
+        },
+        {
+            "name": "errors",
+            "baseName": "errors",
+            "type": "Array<string>"
+        },
+        {
+            "name": "combinedSubmission",
+            "baseName": "combined_submission",
+            "type": "CombinedSubmission"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateCombinedSubmissionResponse.attributeTypeMap;
+    }
+}
+
+export namespace CreateCombinedSubmissionResponse {
+    export enum StatusEnum {
+        Success = <any> 'success',
+        Error = <any> 'error'
+    }
+}

package/model/createCustomFileResponse.ts

@@ -0,0 +1,49 @@
+/**
+ * API v1
+ * DocSpring is a service that helps you fill out and sign PDF templates.
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class CreateCustomFileResponse {
+    'status': CreateCustomFileResponse.StatusEnum;
+    'errors'?: Array<string>;
+    'customFile': object;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "CreateCustomFileResponse.StatusEnum"
+        },
+        {
+            "name": "errors",
+            "baseName": "errors",
+            "type": "Array<string>"
+        },
+        {
+            "name": "customFile",
+            "baseName": "custom_file",
+            "type": "object"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateCustomFileResponse.attributeTypeMap;
+    }
+}
+
+export namespace CreateCustomFileResponse {
+    export enum StatusEnum {
+        Success = <any> 'success',
+        Error = <any> 'error'
+    }
+}

package/model/createFolderData.ts

@@ -0,0 +1,32 @@
+/**
+ * API v1
+ * DocSpring is a service that helps you fill out and sign PDF templates.
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+import { CreateFolderDataFolder } from './createFolderDataFolder';
+
+export class CreateFolderData {
+    'folder': CreateFolderDataFolder;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "folder",
+            "baseName": "folder",
+            "type": "CreateFolderDataFolder"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateFolderData.attributeTypeMap;
+    }
+}
+