docspring-ts 1.0.0

package/model/template.ts

@@ -0,0 +1,152 @@
+/**
+ * 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 Template {
+    'name': string | null;
+    'description': string | null;
+    'publicWebForm': boolean;
+    'publicSubmissions': boolean;
+    'expireSubmissions': boolean;
+    'expireAfter': number;
+    'expirationInterval': Template.ExpirationIntervalEnum;
+    'allowAdditionalProperties': boolean;
+    'editableSubmissions': boolean;
+    'locked': boolean;
+    'webhookUrl': string | null;
+    'slackWebhookUrl': string | null;
+    'redirectUrl': string | null;
+    'id': string;
+    'templateType': string;
+    'pageDimensions': Array<Array<number>> | null;
+    'documentUrl': string | null;
+    'permanentDocumentUrl': string | null;
+    'path': string;
+    'parentFolderId': string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "description",
+            "baseName": "description",
+            "type": "string"
+        },
+        {
+            "name": "publicWebForm",
+            "baseName": "public_web_form",
+            "type": "boolean"
+        },
+        {
+            "name": "publicSubmissions",
+            "baseName": "public_submissions",
+            "type": "boolean"
+        },
+        {
+            "name": "expireSubmissions",
+            "baseName": "expire_submissions",
+            "type": "boolean"
+        },
+        {
+            "name": "expireAfter",
+            "baseName": "expire_after",
+            "type": "number"
+        },
+        {
+            "name": "expirationInterval",
+            "baseName": "expiration_interval",
+            "type": "Template.ExpirationIntervalEnum"
+        },
+        {
+            "name": "allowAdditionalProperties",
+            "baseName": "allow_additional_properties",
+            "type": "boolean"
+        },
+        {
+            "name": "editableSubmissions",
+            "baseName": "editable_submissions",
+            "type": "boolean"
+        },
+        {
+            "name": "locked",
+            "baseName": "locked",
+            "type": "boolean"
+        },
+        {
+            "name": "webhookUrl",
+            "baseName": "webhook_url",
+            "type": "string"
+        },
+        {
+            "name": "slackWebhookUrl",
+            "baseName": "slack_webhook_url",
+            "type": "string"
+        },
+        {
+            "name": "redirectUrl",
+            "baseName": "redirect_url",
+            "type": "string"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "templateType",
+            "baseName": "template_type",
+            "type": "string"
+        },
+        {
+            "name": "pageDimensions",
+            "baseName": "page_dimensions",
+            "type": "Array<Array<number>>"
+        },
+        {
+            "name": "documentUrl",
+            "baseName": "document_url",
+            "type": "string"
+        },
+        {
+            "name": "permanentDocumentUrl",
+            "baseName": "permanent_document_url",
+            "type": "string"
+        },
+        {
+            "name": "path",
+            "baseName": "path",
+            "type": "string"
+        },
+        {
+            "name": "parentFolderId",
+            "baseName": "parent_folder_id",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Template.attributeTypeMap;
+    }
+}
+
+export namespace Template {
+    export enum ExpirationIntervalEnum {
+        Minutes = <any> 'minutes',
+        Hours = <any> 'hours',
+        Days = <any> 'days'
+    }
+}

package/model/templateData.ts

@@ -0,0 +1,128 @@
+/**
+ * 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 TemplateData {
+    'allowAdditionalProperties'?: boolean;
+    'description'?: string | null;
+    'editableSubmissions'?: boolean;
+    'expirationInterval'?: TemplateData.ExpirationIntervalEnum;
+    'expireAfter'?: number;
+    'expireSubmissions'?: boolean;
+    'footerHtml'?: string | null;
+    'headerHtml'?: string | null;
+    'html'?: string | null;
+    'name'?: string | null;
+    'publicSubmissions'?: boolean;
+    'publicWebForm'?: boolean;
+    'redirectUrl'?: string | null;
+    'scss'?: string | null;
+    'slackWebhookUrl'?: string | null;
+    'webhookUrl'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "allowAdditionalProperties",
+            "baseName": "allow_additional_properties",
+            "type": "boolean"
+        },
+        {
+            "name": "description",
+            "baseName": "description",
+            "type": "string"
+        },
+        {
+            "name": "editableSubmissions",
+            "baseName": "editable_submissions",
+            "type": "boolean"
+        },
+        {
+            "name": "expirationInterval",
+            "baseName": "expiration_interval",
+            "type": "TemplateData.ExpirationIntervalEnum"
+        },
+        {
+            "name": "expireAfter",
+            "baseName": "expire_after",
+            "type": "number"
+        },
+        {
+            "name": "expireSubmissions",
+            "baseName": "expire_submissions",
+            "type": "boolean"
+        },
+        {
+            "name": "footerHtml",
+            "baseName": "footer_html",
+            "type": "string"
+        },
+        {
+            "name": "headerHtml",
+            "baseName": "header_html",
+            "type": "string"
+        },
+        {
+            "name": "html",
+            "baseName": "html",
+            "type": "string"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "publicSubmissions",
+            "baseName": "public_submissions",
+            "type": "boolean"
+        },
+        {
+            "name": "publicWebForm",
+            "baseName": "public_web_form",
+            "type": "boolean"
+        },
+        {
+            "name": "redirectUrl",
+            "baseName": "redirect_url",
+            "type": "string"
+        },
+        {
+            "name": "scss",
+            "baseName": "scss",
+            "type": "string"
+        },
+        {
+            "name": "slackWebhookUrl",
+            "baseName": "slack_webhook_url",
+            "type": "string"
+        },
+        {
+            "name": "webhookUrl",
+            "baseName": "webhook_url",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return TemplateData.attributeTypeMap;
+    }
+}
+
+export namespace TemplateData {
+    export enum ExpirationIntervalEnum {
+        Minutes = <any> 'minutes',
+        Hours = <any> 'hours',
+        Days = <any> 'days'
+    }
+}

package/model/updateDataRequestResponse.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 { SubmissionDataRequest } from './submissionDataRequest';
+
+export class UpdateDataRequestResponse {
+    'status': UpdateDataRequestResponse.StatusEnum;
+    'errors'?: Array<string>;
+    'dataRequest': SubmissionDataRequest;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "UpdateDataRequestResponse.StatusEnum"
+        },
+        {
+            "name": "errors",
+            "baseName": "errors",
+            "type": "Array<string>"
+        },
+        {
+            "name": "dataRequest",
+            "baseName": "data_request",
+            "type": "SubmissionDataRequest"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UpdateDataRequestResponse.attributeTypeMap;
+    }
+}
+
+export namespace UpdateDataRequestResponse {
+    export enum StatusEnum {
+        Success = <any> 'success',
+        Error = <any> 'error'
+    }
+}

package/model/updateSubmissionDataRequestData.ts

@@ -0,0 +1,122 @@
+/**
+ * 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 UpdateSubmissionDataRequestData {
+    'authPhoneNumberHash'?: string | null;
+    'authProvider'?: string | null;
+    'authSecondFactorType'?: UpdateSubmissionDataRequestData.AuthSecondFactorTypeEnum;
+    'authSessionIdHash'?: string | null;
+    'authSessionStartedAt'?: string | null;
+    'authType'?: UpdateSubmissionDataRequestData.AuthTypeEnum;
+    'authUserIdHash'?: string | null;
+    'authUsernameHash'?: string | null;
+    'email'?: string | null;
+    'fields'?: Array<string>;
+    'metadata'?: object;
+    'name'?: string | null;
+    'order'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "authPhoneNumberHash",
+            "baseName": "auth_phone_number_hash",
+            "type": "string"
+        },
+        {
+            "name": "authProvider",
+            "baseName": "auth_provider",
+            "type": "string"
+        },
+        {
+            "name": "authSecondFactorType",
+            "baseName": "auth_second_factor_type",
+            "type": "UpdateSubmissionDataRequestData.AuthSecondFactorTypeEnum"
+        },
+        {
+            "name": "authSessionIdHash",
+            "baseName": "auth_session_id_hash",
+            "type": "string"
+        },
+        {
+            "name": "authSessionStartedAt",
+            "baseName": "auth_session_started_at",
+            "type": "string"
+        },
+        {
+            "name": "authType",
+            "baseName": "auth_type",
+            "type": "UpdateSubmissionDataRequestData.AuthTypeEnum"
+        },
+        {
+            "name": "authUserIdHash",
+            "baseName": "auth_user_id_hash",
+            "type": "string"
+        },
+        {
+            "name": "authUsernameHash",
+            "baseName": "auth_username_hash",
+            "type": "string"
+        },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        },
+        {
+            "name": "fields",
+            "baseName": "fields",
+            "type": "Array<string>"
+        },
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "object"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "order",
+            "baseName": "order",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UpdateSubmissionDataRequestData.attributeTypeMap;
+    }
+}
+
+export namespace UpdateSubmissionDataRequestData {
+    export enum AuthSecondFactorTypeEnum {
+        None = <any> 'none',
+        PhoneNumber = <any> 'phone_number',
+        Totp = <any> 'totp',
+        MobilePush = <any> 'mobile_push',
+        SecurityKey = <any> 'security_key',
+        Fingerprint = <any> 'fingerprint'
+    }
+    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'
+    }
+}

package/model/updateTemplateData.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 { TemplateData } from './templateData';
+
+export class UpdateTemplateData {
+    'template': TemplateData;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "template",
+            "baseName": "template",
+            "type": "TemplateData"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UpdateTemplateData.attributeTypeMap;
+    }
+}
+

package/model/updateTemplateResponse.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 UpdateTemplateResponse {
+    'status': UpdateTemplateResponse.StatusEnum;
+    'errors'?: Array<string>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "UpdateTemplateResponse.StatusEnum"
+        },
+        {
+            "name": "errors",
+            "baseName": "errors",
+            "type": "Array<string>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UpdateTemplateResponse.attributeTypeMap;
+    }
+}
+
+export namespace UpdateTemplateResponse {
+    export enum StatusEnum {
+        Success = <any> 'success',
+        Error = <any> 'error'
+    }
+}

package/model/uploadTemplateData.ts

@@ -0,0 +1,145 @@
+/**
+ * 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 { UploadTemplateDataDocument } from './uploadTemplateDataDocument';
+
+export class UploadTemplateData {
+    'allowAdditionalProperties'?: boolean;
+    'description'?: string | null;
+    'document'?: UploadTemplateDataDocument;
+    'editableSubmissions'?: boolean;
+    'expirationInterval'?: UploadTemplateData.ExpirationIntervalEnum;
+    'expireAfter'?: number;
+    'expireSubmissions'?: boolean;
+    'footerHtml'?: string | null;
+    'headerHtml'?: string | null;
+    'html'?: string | null;
+    'name': string | null;
+    'publicSubmissions'?: boolean;
+    'publicWebForm'?: boolean;
+    'redirectUrl'?: string | null;
+    'scss'?: string | null;
+    'slackWebhookUrl'?: string | null;
+    'templateType'?: UploadTemplateData.TemplateTypeEnum;
+    'webhookUrl'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "allowAdditionalProperties",
+            "baseName": "allow_additional_properties",
+            "type": "boolean"
+        },
+        {
+            "name": "description",
+            "baseName": "description",
+            "type": "string"
+        },
+        {
+            "name": "document",
+            "baseName": "document",
+            "type": "UploadTemplateDataDocument"
+        },
+        {
+            "name": "editableSubmissions",
+            "baseName": "editable_submissions",
+            "type": "boolean"
+        },
+        {
+            "name": "expirationInterval",
+            "baseName": "expiration_interval",
+            "type": "UploadTemplateData.ExpirationIntervalEnum"
+        },
+        {
+            "name": "expireAfter",
+            "baseName": "expire_after",
+            "type": "number"
+        },
+        {
+            "name": "expireSubmissions",
+            "baseName": "expire_submissions",
+            "type": "boolean"
+        },
+        {
+            "name": "footerHtml",
+            "baseName": "footer_html",
+            "type": "string"
+        },
+        {
+            "name": "headerHtml",
+            "baseName": "header_html",
+            "type": "string"
+        },
+        {
+            "name": "html",
+            "baseName": "html",
+            "type": "string"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "publicSubmissions",
+            "baseName": "public_submissions",
+            "type": "boolean"
+        },
+        {
+            "name": "publicWebForm",
+            "baseName": "public_web_form",
+            "type": "boolean"
+        },
+        {
+            "name": "redirectUrl",
+            "baseName": "redirect_url",
+            "type": "string"
+        },
+        {
+            "name": "scss",
+            "baseName": "scss",
+            "type": "string"
+        },
+        {
+            "name": "slackWebhookUrl",
+            "baseName": "slack_webhook_url",
+            "type": "string"
+        },
+        {
+            "name": "templateType",
+            "baseName": "template_type",
+            "type": "UploadTemplateData.TemplateTypeEnum"
+        },
+        {
+            "name": "webhookUrl",
+            "baseName": "webhook_url",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UploadTemplateData.attributeTypeMap;
+    }
+}
+
+export namespace UploadTemplateData {
+    export enum ExpirationIntervalEnum {
+        Minutes = <any> 'minutes',
+        Hours = <any> 'hours',
+        Days = <any> 'days'
+    }
+    export enum TemplateTypeEnum {
+        Pdf = <any> 'pdf',
+        Html = <any> 'html'
+    }
+}