docspring-ts 1.0.0 → 1.0.2

package/dist/models/Submission.d.ts

@@ -0,0 +1,158 @@
+/**
+ * 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 type { SubmissionAction } from './SubmissionAction';
+import type { SubmissionDataRequest } from './SubmissionDataRequest';
+/**
+ *
+ * @export
+ * @interface Submission
+ */
+export interface Submission {
+    /**
+     *
+     * @type {string}
+     * @memberof Submission
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Submission
+     */
+    templateId?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Submission
+     */
+    test: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Submission
+     */
+    editable?: boolean | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Submission
+     */
+    expired: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof Submission
+     */
+    expiresAt?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Submission
+     */
+    processedAt?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Submission
+     */
+    state: SubmissionStateEnum;
+    /**
+     *
+     * @type {object}
+     * @memberof Submission
+     */
+    data?: object | null;
+    /**
+     *
+     * @type {object}
+     * @memberof Submission
+     */
+    metadata?: object;
+    /**
+     *
+     * @type {object}
+     * @memberof Submission
+     */
+    truncatedText?: object;
+    /**
+     *
+     * @type {string}
+     * @memberof Submission
+     */
+    pdfHash?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Submission
+     */
+    downloadUrl?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Submission
+     */
+    permanentDownloadUrl?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Submission
+     */
+    batchId?: string | null;
+    /**
+     *
+     * @type {Array<SubmissionDataRequest>}
+     * @memberof Submission
+     */
+    dataRequests?: Array<SubmissionDataRequest>;
+    /**
+     *
+     * @type {Array<SubmissionAction>}
+     * @memberof Submission
+     */
+    actions?: Array<SubmissionAction>;
+    /**
+     *
+     * @type {string}
+     * @memberof Submission
+     */
+    source?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Submission
+     */
+    referrer?: string | null;
+}
+/**
+ * @export
+ */
+export declare const SubmissionStateEnum: {
+    readonly Pending: "pending";
+    readonly Processed: "processed";
+    readonly InvalidData: "invalid_data";
+    readonly Error: "error";
+    readonly ImageDownloadFailed: "image_download_failed";
+    readonly ImageProcessingFailed: "image_processing_failed";
+    readonly WaitingForDataRequests: "waiting_for_data_requests";
+    readonly SyntaxError: "syntax_error";
+    readonly AccountSuspended: "account_suspended";
+    readonly LicenseRevoked: "license_revoked";
+    readonly Accidental: "accidental";
+};
+export type SubmissionStateEnum = typeof SubmissionStateEnum[keyof typeof SubmissionStateEnum];
+/**
+ * Check if a given object implements the Submission interface.
+ */
+export declare function instanceOfSubmission(value: object): boolean;
+export declare function SubmissionFromJSON(json: any): Submission;
+export declare function SubmissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): Submission;
+export declare function SubmissionToJSON(value?: Submission | null): any;

package/dist/models/Submission.js

@@ -0,0 +1,108 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubmissionToJSON = exports.SubmissionFromJSONTyped = exports.SubmissionFromJSON = exports.instanceOfSubmission = exports.SubmissionStateEnum = void 0;
+var runtime_1 = require("../runtime");
+var SubmissionAction_1 = require("./SubmissionAction");
+var SubmissionDataRequest_1 = require("./SubmissionDataRequest");
+/**
+ * @export
+ */
+exports.SubmissionStateEnum = {
+    Pending: 'pending',
+    Processed: 'processed',
+    InvalidData: 'invalid_data',
+    Error: 'error',
+    ImageDownloadFailed: 'image_download_failed',
+    ImageProcessingFailed: 'image_processing_failed',
+    WaitingForDataRequests: 'waiting_for_data_requests',
+    SyntaxError: 'syntax_error',
+    AccountSuspended: 'account_suspended',
+    LicenseRevoked: 'license_revoked',
+    Accidental: 'accidental'
+};
+/**
+ * Check if a given object implements the Submission interface.
+ */
+function instanceOfSubmission(value) {
+    var isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "test" in value;
+    isInstance = isInstance && "expired" in value;
+    isInstance = isInstance && "state" in value;
+    return isInstance;
+}
+exports.instanceOfSubmission = instanceOfSubmission;
+function SubmissionFromJSON(json) {
+    return SubmissionFromJSONTyped(json, false);
+}
+exports.SubmissionFromJSON = SubmissionFromJSON;
+function SubmissionFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'templateId': !(0, runtime_1.exists)(json, 'template_id') ? undefined : json['template_id'],
+        'test': json['test'],
+        'editable': !(0, runtime_1.exists)(json, 'editable') ? undefined : json['editable'],
+        'expired': json['expired'],
+        'expiresAt': !(0, runtime_1.exists)(json, 'expires_at') ? undefined : json['expires_at'],
+        'processedAt': !(0, runtime_1.exists)(json, 'processed_at') ? undefined : json['processed_at'],
+        'state': json['state'],
+        'data': !(0, runtime_1.exists)(json, 'data') ? undefined : json['data'],
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : json['metadata'],
+        'truncatedText': !(0, runtime_1.exists)(json, 'truncated_text') ? undefined : json['truncated_text'],
+        'pdfHash': !(0, runtime_1.exists)(json, 'pdf_hash') ? undefined : json['pdf_hash'],
+        'downloadUrl': !(0, runtime_1.exists)(json, 'download_url') ? undefined : json['download_url'],
+        'permanentDownloadUrl': !(0, runtime_1.exists)(json, 'permanent_download_url') ? undefined : json['permanent_download_url'],
+        'batchId': !(0, runtime_1.exists)(json, 'batch_id') ? undefined : json['batch_id'],
+        'dataRequests': !(0, runtime_1.exists)(json, 'data_requests') ? undefined : (json['data_requests'].map(SubmissionDataRequest_1.SubmissionDataRequestFromJSON)),
+        'actions': !(0, runtime_1.exists)(json, 'actions') ? undefined : (json['actions'].map(SubmissionAction_1.SubmissionActionFromJSON)),
+        'source': !(0, runtime_1.exists)(json, 'source') ? undefined : json['source'],
+        'referrer': !(0, runtime_1.exists)(json, 'referrer') ? undefined : json['referrer'],
+    };
+}
+exports.SubmissionFromJSONTyped = SubmissionFromJSONTyped;
+function SubmissionToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'template_id': value.templateId,
+        'test': value.test,
+        'editable': value.editable,
+        'expired': value.expired,
+        'expires_at': value.expiresAt,
+        'processed_at': value.processedAt,
+        'state': value.state,
+        'data': value.data,
+        'metadata': value.metadata,
+        'truncated_text': value.truncatedText,
+        'pdf_hash': value.pdfHash,
+        'download_url': value.downloadUrl,
+        'permanent_download_url': value.permanentDownloadUrl,
+        'batch_id': value.batchId,
+        'data_requests': value.dataRequests === undefined ? undefined : (value.dataRequests.map(SubmissionDataRequest_1.SubmissionDataRequestToJSON)),
+        'actions': value.actions === undefined ? undefined : (value.actions.map(SubmissionAction_1.SubmissionActionToJSON)),
+        'source': value.source,
+        'referrer': value.referrer,
+    };
+}
+exports.SubmissionToJSON = SubmissionToJSON;

package/dist/models/SubmissionAction.d.ts

@@ -0,0 +1,89 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface SubmissionAction
+ */
+export interface SubmissionAction {
+    /**
+     *
+     * @type {string}
+     * @memberof SubmissionAction
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmissionAction
+     */
+    integrationId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmissionAction
+     */
+    state: SubmissionActionStateEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmissionAction
+     */
+    actionCategory: SubmissionActionActionCategoryEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmissionAction
+     */
+    actionType: SubmissionActionActionTypeEnum;
+    /**
+     *
+     * @type {object}
+     * @memberof SubmissionAction
+     */
+    resultData: object;
+}
+/**
+ * @export
+ */
+export declare const SubmissionActionStateEnum: {
+    readonly Pending: "pending";
+    readonly Processed: "processed";
+    readonly Failed: "failed";
+    readonly Error: "error";
+};
+export type SubmissionActionStateEnum = typeof SubmissionActionStateEnum[keyof typeof SubmissionActionStateEnum];
+/**
+ * @export
+ */
+export declare const SubmissionActionActionCategoryEnum: {
+    readonly Notification: "notification";
+    readonly FileUpload: "file_upload";
+};
+export type SubmissionActionActionCategoryEnum = typeof SubmissionActionActionCategoryEnum[keyof typeof SubmissionActionActionCategoryEnum];
+/**
+ * @export
+ */
+export declare const SubmissionActionActionTypeEnum: {
+    readonly Webhook: "webhook";
+    readonly SlackWebhook: "slack_webhook";
+    readonly Email: "email";
+    readonly AwsS3Upload: "aws_s3_upload";
+};
+export type SubmissionActionActionTypeEnum = typeof SubmissionActionActionTypeEnum[keyof typeof SubmissionActionActionTypeEnum];
+/**
+ * Check if a given object implements the SubmissionAction interface.
+ */
+export declare function instanceOfSubmissionAction(value: object): boolean;
+export declare function SubmissionActionFromJSON(json: any): SubmissionAction;
+export declare function SubmissionActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmissionAction;
+export declare function SubmissionActionToJSON(value?: SubmissionAction | null): any;

package/dist/models/SubmissionAction.js

@@ -0,0 +1,90 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubmissionActionToJSON = exports.SubmissionActionFromJSONTyped = exports.SubmissionActionFromJSON = exports.instanceOfSubmissionAction = exports.SubmissionActionActionTypeEnum = exports.SubmissionActionActionCategoryEnum = exports.SubmissionActionStateEnum = void 0;
+/**
+ * @export
+ */
+exports.SubmissionActionStateEnum = {
+    Pending: 'pending',
+    Processed: 'processed',
+    Failed: 'failed',
+    Error: 'error'
+};
+/**
+ * @export
+ */
+exports.SubmissionActionActionCategoryEnum = {
+    Notification: 'notification',
+    FileUpload: 'file_upload'
+};
+/**
+ * @export
+ */
+exports.SubmissionActionActionTypeEnum = {
+    Webhook: 'webhook',
+    SlackWebhook: 'slack_webhook',
+    Email: 'email',
+    AwsS3Upload: 'aws_s3_upload'
+};
+/**
+ * Check if a given object implements the SubmissionAction interface.
+ */
+function instanceOfSubmissionAction(value) {
+    var isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "integrationId" in value;
+    isInstance = isInstance && "state" in value;
+    isInstance = isInstance && "actionCategory" in value;
+    isInstance = isInstance && "actionType" in value;
+    isInstance = isInstance && "resultData" in value;
+    return isInstance;
+}
+exports.instanceOfSubmissionAction = instanceOfSubmissionAction;
+function SubmissionActionFromJSON(json) {
+    return SubmissionActionFromJSONTyped(json, false);
+}
+exports.SubmissionActionFromJSON = SubmissionActionFromJSON;
+function SubmissionActionFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'integrationId': json['integration_id'],
+        'state': json['state'],
+        'actionCategory': json['action_category'],
+        'actionType': json['action_type'],
+        'resultData': json['result_data'],
+    };
+}
+exports.SubmissionActionFromJSONTyped = SubmissionActionFromJSONTyped;
+function SubmissionActionToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'integration_id': value.integrationId,
+        'state': value.state,
+        'action_category': value.actionCategory,
+        'action_type': value.actionType,
+        'result_data': value.resultData,
+    };
+}
+exports.SubmissionActionToJSON = SubmissionActionToJSON;

package/dist/models/SubmissionBatch.d.ts

@@ -0,0 +1,89 @@
+/**
+ * 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 type { Submission } from './Submission';
+/**
+ *
+ * @export
+ * @interface SubmissionBatch
+ */
+export interface SubmissionBatch {
+    /**
+     *
+     * @type {string}
+     * @memberof SubmissionBatch
+     */
+    id: string;
+    /**
+     *
+     * @type {number}
+     * @memberof SubmissionBatch
+     */
+    totalCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SubmissionBatch
+     */
+    pendingCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SubmissionBatch
+     */
+    errorCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SubmissionBatch
+     */
+    completionPercentage: number;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmissionBatch
+     */
+    state: SubmissionBatchStateEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmissionBatch
+     */
+    processedAt: string | null;
+    /**
+     *
+     * @type {object}
+     * @memberof SubmissionBatch
+     */
+    metadata: object;
+    /**
+     *
+     * @type {Array<Submission>}
+     * @memberof SubmissionBatch
+     */
+    submissions?: Array<Submission>;
+}
+/**
+ * @export
+ */
+export declare const SubmissionBatchStateEnum: {
+    readonly Pending: "pending";
+    readonly Processed: "processed";
+    readonly Error: "error";
+};
+export type SubmissionBatchStateEnum = typeof SubmissionBatchStateEnum[keyof typeof SubmissionBatchStateEnum];
+/**
+ * Check if a given object implements the SubmissionBatch interface.
+ */
+export declare function instanceOfSubmissionBatch(value: object): boolean;
+export declare function SubmissionBatchFromJSON(json: any): SubmissionBatch;
+export declare function SubmissionBatchFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmissionBatch;
+export declare function SubmissionBatchToJSON(value?: SubmissionBatch | null): any;

package/dist/models/SubmissionBatch.js

@@ -0,0 +1,83 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubmissionBatchToJSON = exports.SubmissionBatchFromJSONTyped = exports.SubmissionBatchFromJSON = exports.instanceOfSubmissionBatch = exports.SubmissionBatchStateEnum = void 0;
+var runtime_1 = require("../runtime");
+var Submission_1 = require("./Submission");
+/**
+ * @export
+ */
+exports.SubmissionBatchStateEnum = {
+    Pending: 'pending',
+    Processed: 'processed',
+    Error: 'error'
+};
+/**
+ * Check if a given object implements the SubmissionBatch interface.
+ */
+function instanceOfSubmissionBatch(value) {
+    var isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "totalCount" in value;
+    isInstance = isInstance && "pendingCount" in value;
+    isInstance = isInstance && "errorCount" in value;
+    isInstance = isInstance && "completionPercentage" in value;
+    isInstance = isInstance && "state" in value;
+    isInstance = isInstance && "processedAt" in value;
+    isInstance = isInstance && "metadata" in value;
+    return isInstance;
+}
+exports.instanceOfSubmissionBatch = instanceOfSubmissionBatch;
+function SubmissionBatchFromJSON(json) {
+    return SubmissionBatchFromJSONTyped(json, false);
+}
+exports.SubmissionBatchFromJSON = SubmissionBatchFromJSON;
+function SubmissionBatchFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'totalCount': json['total_count'],
+        'pendingCount': json['pending_count'],
+        'errorCount': json['error_count'],
+        'completionPercentage': json['completion_percentage'],
+        'state': json['state'],
+        'processedAt': json['processed_at'],
+        'metadata': json['metadata'],
+        'submissions': !(0, runtime_1.exists)(json, 'submissions') ? undefined : (json['submissions'].map(Submission_1.SubmissionFromJSON)),
+    };
+}
+exports.SubmissionBatchFromJSONTyped = SubmissionBatchFromJSONTyped;
+function SubmissionBatchToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'total_count': value.totalCount,
+        'pending_count': value.pendingCount,
+        'error_count': value.errorCount,
+        'completion_percentage': value.completionPercentage,
+        'state': value.state,
+        'processed_at': value.processedAt,
+        'metadata': value.metadata,
+        'submissions': value.submissions === undefined ? undefined : (value.submissions.map(Submission_1.SubmissionToJSON)),
+    };
+}
+exports.SubmissionBatchToJSON = SubmissionBatchToJSON;

package/dist/models/SubmissionBatchData.d.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 type { SubmissionDataBatchRequest } from './SubmissionDataBatchRequest';
+/**
+ *
+ * @export
+ * @interface SubmissionBatchData
+ */
+export interface SubmissionBatchData {
+    /**
+     *
+     * @type {object}
+     * @memberof SubmissionBatchData
+     */
+    metadata?: object;
+    /**
+     *
+     * @type {Array<SubmissionDataBatchRequest>}
+     * @memberof SubmissionBatchData
+     */
+    submissions: Array<SubmissionDataBatchRequest>;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmissionBatchData
+     */
+    templateId?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SubmissionBatchData
+     */
+    test?: boolean;
+}
+/**
+ * Check if a given object implements the SubmissionBatchData interface.
+ */
+export declare function instanceOfSubmissionBatchData(value: object): boolean;
+export declare function SubmissionBatchDataFromJSON(json: any): SubmissionBatchData;
+export declare function SubmissionBatchDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmissionBatchData;
+export declare function SubmissionBatchDataToJSON(value?: SubmissionBatchData | null): any;