docspring-ts 1.0.0

package/model/submission.ts

@@ -0,0 +1,156 @@
+/**
+ * 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 { SubmissionAction } from './submissionAction';
+import { SubmissionDataRequest } from './submissionDataRequest';
+
+export class Submission {
+    'id': string;
+    'templateId'?: string;
+    'test': boolean;
+    'editable'?: boolean | null;
+    'expired': boolean;
+    'expiresAt'?: string | null;
+    'processedAt'?: string | null;
+    'state': Submission.StateEnum;
+    'data'?: object | null;
+    'metadata'?: object;
+    'truncatedText'?: object;
+    'pdfHash'?: string | null;
+    'downloadUrl'?: string | null;
+    'permanentDownloadUrl'?: string | null;
+    'batchId'?: string | null;
+    'dataRequests'?: Array<SubmissionDataRequest>;
+    'actions'?: Array<SubmissionAction>;
+    'source'?: string | null;
+    'referrer'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "templateId",
+            "baseName": "template_id",
+            "type": "string"
+        },
+        {
+            "name": "test",
+            "baseName": "test",
+            "type": "boolean"
+        },
+        {
+            "name": "editable",
+            "baseName": "editable",
+            "type": "boolean"
+        },
+        {
+            "name": "expired",
+            "baseName": "expired",
+            "type": "boolean"
+        },
+        {
+            "name": "expiresAt",
+            "baseName": "expires_at",
+            "type": "string"
+        },
+        {
+            "name": "processedAt",
+            "baseName": "processed_at",
+            "type": "string"
+        },
+        {
+            "name": "state",
+            "baseName": "state",
+            "type": "Submission.StateEnum"
+        },
+        {
+            "name": "data",
+            "baseName": "data",
+            "type": "object"
+        },
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "object"
+        },
+        {
+            "name": "truncatedText",
+            "baseName": "truncated_text",
+            "type": "object"
+        },
+        {
+            "name": "pdfHash",
+            "baseName": "pdf_hash",
+            "type": "string"
+        },
+        {
+            "name": "downloadUrl",
+            "baseName": "download_url",
+            "type": "string"
+        },
+        {
+            "name": "permanentDownloadUrl",
+            "baseName": "permanent_download_url",
+            "type": "string"
+        },
+        {
+            "name": "batchId",
+            "baseName": "batch_id",
+            "type": "string"
+        },
+        {
+            "name": "dataRequests",
+            "baseName": "data_requests",
+            "type": "Array<SubmissionDataRequest>"
+        },
+        {
+            "name": "actions",
+            "baseName": "actions",
+            "type": "Array<SubmissionAction>"
+        },
+        {
+            "name": "source",
+            "baseName": "source",
+            "type": "string"
+        },
+        {
+            "name": "referrer",
+            "baseName": "referrer",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Submission.attributeTypeMap;
+    }
+}
+
+export namespace Submission {
+    export enum StateEnum {
+        Pending = <any> 'pending',
+        Processed = <any> 'processed',
+        InvalidData = <any> 'invalid_data',
+        Error = <any> 'error',
+        ImageDownloadFailed = <any> 'image_download_failed',
+        ImageProcessingFailed = <any> 'image_processing_failed',
+        WaitingForDataRequests = <any> 'waiting_for_data_requests',
+        SyntaxError = <any> 'syntax_error',
+        AccountSuspended = <any> 'account_suspended',
+        LicenseRevoked = <any> 'license_revoked',
+        Accidental = <any> 'accidental'
+    }
+}

package/model/submissionAction.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 SubmissionAction {
+    'id': string;
+    'integrationId': string | null;
+    'state': SubmissionAction.StateEnum;
+    'actionCategory': SubmissionAction.ActionCategoryEnum;
+    'actionType': SubmissionAction.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": "SubmissionAction.StateEnum"
+        },
+        {
+            "name": "actionCategory",
+            "baseName": "action_category",
+            "type": "SubmissionAction.ActionCategoryEnum"
+        },
+        {
+            "name": "actionType",
+            "baseName": "action_type",
+            "type": "SubmissionAction.ActionTypeEnum"
+        },
+        {
+            "name": "resultData",
+            "baseName": "result_data",
+            "type": "object"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SubmissionAction.attributeTypeMap;
+    }
+}
+
+export namespace SubmissionAction {
+    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/submissionBatch.ts

@@ -0,0 +1,87 @@
+/**
+ * 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 { Submission } from './submission';
+
+export class SubmissionBatch {
+    'id': string;
+    'totalCount': number;
+    'pendingCount': number;
+    'errorCount': number;
+    'completionPercentage': number;
+    'state': SubmissionBatch.StateEnum;
+    'processedAt': string | null;
+    'metadata': object;
+    'submissions'?: Array<Submission>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "totalCount",
+            "baseName": "total_count",
+            "type": "number"
+        },
+        {
+            "name": "pendingCount",
+            "baseName": "pending_count",
+            "type": "number"
+        },
+        {
+            "name": "errorCount",
+            "baseName": "error_count",
+            "type": "number"
+        },
+        {
+            "name": "completionPercentage",
+            "baseName": "completion_percentage",
+            "type": "number"
+        },
+        {
+            "name": "state",
+            "baseName": "state",
+            "type": "SubmissionBatch.StateEnum"
+        },
+        {
+            "name": "processedAt",
+            "baseName": "processed_at",
+            "type": "string"
+        },
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "object"
+        },
+        {
+            "name": "submissions",
+            "baseName": "submissions",
+            "type": "Array<Submission>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SubmissionBatch.attributeTypeMap;
+    }
+}
+
+export namespace SubmissionBatch {
+    export enum StateEnum {
+        Pending = <any> 'pending',
+        Processed = <any> 'processed',
+        Error = <any> 'error'
+    }
+}

package/model/submissionBatchData.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 { SubmissionDataBatchRequest } from './submissionDataBatchRequest';
+
+export class SubmissionBatchData {
+    'metadata'?: object;
+    'submissions': Array<SubmissionDataBatchRequest>;
+    'templateId'?: string | null;
+    'test'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "object"
+        },
+        {
+            "name": "submissions",
+            "baseName": "submissions",
+            "type": "Array<SubmissionDataBatchRequest>"
+        },
+        {
+            "name": "templateId",
+            "baseName": "template_id",
+            "type": "string"
+        },
+        {
+            "name": "test",
+            "baseName": "test",
+            "type": "boolean"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SubmissionBatchData.attributeTypeMap;
+    }
+}
+

package/model/submissionData.ts

@@ -0,0 +1,80 @@
+/**
+ * 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 { CreateSubmissionDataRequestData } from './createSubmissionDataRequestData';
+
+export class SubmissionData {
+    'css'?: string;
+    'data': object;
+    'dataRequests'?: Array<CreateSubmissionDataRequestData>;
+    'expiresIn'?: number;
+    'fieldOverrides'?: object;
+    'html'?: string;
+    'metadata'?: object;
+    'password'?: string;
+    'test'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "css",
+            "baseName": "css",
+            "type": "string"
+        },
+        {
+            "name": "data",
+            "baseName": "data",
+            "type": "object"
+        },
+        {
+            "name": "dataRequests",
+            "baseName": "data_requests",
+            "type": "Array<CreateSubmissionDataRequestData>"
+        },
+        {
+            "name": "expiresIn",
+            "baseName": "expires_in",
+            "type": "number"
+        },
+        {
+            "name": "fieldOverrides",
+            "baseName": "field_overrides",
+            "type": "object"
+        },
+        {
+            "name": "html",
+            "baseName": "html",
+            "type": "string"
+        },
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "object"
+        },
+        {
+            "name": "password",
+            "baseName": "password",
+            "type": "string"
+        },
+        {
+            "name": "test",
+            "baseName": "test",
+            "type": "boolean"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SubmissionData.attributeTypeMap;
+    }
+}
+

package/model/submissionDataBatchRequest.ts

@@ -0,0 +1,61 @@
+/**
+ * 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 SubmissionDataBatchRequest {
+    'css'?: string;
+    'data': object;
+    'html'?: string;
+    'metadata'?: object;
+    'templateId': string | null;
+    'test'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "css",
+            "baseName": "css",
+            "type": "string"
+        },
+        {
+            "name": "data",
+            "baseName": "data",
+            "type": "object"
+        },
+        {
+            "name": "html",
+            "baseName": "html",
+            "type": "string"
+        },
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "object"
+        },
+        {
+            "name": "templateId",
+            "baseName": "template_id",
+            "type": "string"
+        },
+        {
+            "name": "test",
+            "baseName": "test",
+            "type": "boolean"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SubmissionDataBatchRequest.attributeTypeMap;
+    }
+}
+

package/model/submissionDataRequest.ts

@@ -0,0 +1,174 @@
+/**
+ * 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 SubmissionDataRequest {
+    'id': string;
+    'submissionId'?: string;
+    'name': string | null;
+    'email': string | null;
+    'order': number;
+    'sortOrder': number;
+    'fields': Array<string> | null;
+    'metadata': object;
+    'state': SubmissionDataRequest.StateEnum;
+    'viewedAt'?: string | null;
+    'completedAt'?: string | null;
+    'authType'?: SubmissionDataRequest.AuthTypeEnum;
+    'authSecondFactorType'?: SubmissionDataRequest.AuthSecondFactorTypeEnum;
+    'authProvider'?: string | null;
+    'authSessionStartedAt'?: string | null;
+    'authSessionIdHash'?: string | null;
+    'authUserIdHash'?: string | null;
+    'authUsernameHash'?: string | null;
+    'authPhoneNumberHash'?: string | null;
+    'ipAddress'?: string | null;
+    'userAgent'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "submissionId",
+            "baseName": "submission_id",
+            "type": "string"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        },
+        {
+            "name": "order",
+            "baseName": "order",
+            "type": "number"
+        },
+        {
+            "name": "sortOrder",
+            "baseName": "sort_order",
+            "type": "number"
+        },
+        {
+            "name": "fields",
+            "baseName": "fields",
+            "type": "Array<string>"
+        },
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "object"
+        },
+        {
+            "name": "state",
+            "baseName": "state",
+            "type": "SubmissionDataRequest.StateEnum"
+        },
+        {
+            "name": "viewedAt",
+            "baseName": "viewed_at",
+            "type": "string"
+        },
+        {
+            "name": "completedAt",
+            "baseName": "completed_at",
+            "type": "string"
+        },
+        {
+            "name": "authType",
+            "baseName": "auth_type",
+            "type": "SubmissionDataRequest.AuthTypeEnum"
+        },
+        {
+            "name": "authSecondFactorType",
+            "baseName": "auth_second_factor_type",
+            "type": "SubmissionDataRequest.AuthSecondFactorTypeEnum"
+        },
+        {
+            "name": "authProvider",
+            "baseName": "auth_provider",
+            "type": "string"
+        },
+        {
+            "name": "authSessionStartedAt",
+            "baseName": "auth_session_started_at",
+            "type": "string"
+        },
+        {
+            "name": "authSessionIdHash",
+            "baseName": "auth_session_id_hash",
+            "type": "string"
+        },
+        {
+            "name": "authUserIdHash",
+            "baseName": "auth_user_id_hash",
+            "type": "string"
+        },
+        {
+            "name": "authUsernameHash",
+            "baseName": "auth_username_hash",
+            "type": "string"
+        },
+        {
+            "name": "authPhoneNumberHash",
+            "baseName": "auth_phone_number_hash",
+            "type": "string"
+        },
+        {
+            "name": "ipAddress",
+            "baseName": "ip_address",
+            "type": "string"
+        },
+        {
+            "name": "userAgent",
+            "baseName": "user_agent",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SubmissionDataRequest.attributeTypeMap;
+    }
+}
+
+export namespace SubmissionDataRequest {
+    export enum StateEnum {
+        Pending = <any> 'pending',
+        Completed = <any> 'completed'
+    }
+    export enum AuthTypeEnum {
+        None = <any> 'none',
+        Password = <any> 'password',
+        Oauth = <any> 'oauth',
+        EmailLink = <any> 'email_link',
+        PhoneNumber = <any> 'phone_number',
+        Ldap = <any> 'ldap',
+        Saml = <any> 'saml'
+    }
+    export enum AuthSecondFactorTypeEnum {
+        None = <any> 'none',
+        PhoneNumber = <any> 'phone_number',
+        Totp = <any> 'totp',
+        MobilePush = <any> 'mobile_push',
+        SecurityKey = <any> 'security_key',
+        Fingerprint = <any> 'fingerprint'
+    }
+}