docspring-ts 1.0.1 → 1.0.2

package/dist/apis/index.d.ts

@@ -0,0 +1 @@
+export * from './PDFApi';

package/dist/{api.js → apis/index.js}

@@ -14,6 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./api/apis"), exports);
-__exportStar(require("./model/models"), exports);
-//# sourceMappingURL=api.js.map
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./PDFApi"), exports);

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./runtime"), exports);
+__exportStar(require("./apis/index"), exports);
+__exportStar(require("./models/index"), exports);

package/dist/models/AddFieldsData.d.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.
+ */
+/**
+ *
+ * @export
+ * @interface AddFieldsData
+ */
+export interface AddFieldsData {
+    /**
+     *
+     * @type {Array<object>}
+     * @memberof AddFieldsData
+     */
+    fields: Array<object>;
+}
+/**
+ * Check if a given object implements the AddFieldsData interface.
+ */
+export declare function instanceOfAddFieldsData(value: object): boolean;
+export declare function AddFieldsDataFromJSON(json: any): AddFieldsData;
+export declare function AddFieldsDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddFieldsData;
+export declare function AddFieldsDataToJSON(value?: AddFieldsData | null): any;

package/dist/models/AddFieldsData.js

@@ -0,0 +1,50 @@
+"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.AddFieldsDataToJSON = exports.AddFieldsDataFromJSONTyped = exports.AddFieldsDataFromJSON = exports.instanceOfAddFieldsData = void 0;
+/**
+ * Check if a given object implements the AddFieldsData interface.
+ */
+function instanceOfAddFieldsData(value) {
+    var isInstance = true;
+    isInstance = isInstance && "fields" in value;
+    return isInstance;
+}
+exports.instanceOfAddFieldsData = instanceOfAddFieldsData;
+function AddFieldsDataFromJSON(json) {
+    return AddFieldsDataFromJSONTyped(json, false);
+}
+exports.AddFieldsDataFromJSON = AddFieldsDataFromJSON;
+function AddFieldsDataFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'fields': json['fields'],
+    };
+}
+exports.AddFieldsDataFromJSONTyped = AddFieldsDataFromJSONTyped;
+function AddFieldsDataToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'fields': value.fields,
+    };
+}
+exports.AddFieldsDataToJSON = AddFieldsDataToJSON;

package/dist/models/AddFieldsTemplateResponse.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 AddFieldsTemplateResponse
+ */
+export interface AddFieldsTemplateResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof AddFieldsTemplateResponse
+     */
+    status: AddFieldsTemplateResponseStatusEnum;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof AddFieldsTemplateResponse
+     */
+    errors?: Array<string>;
+    /**
+     *
+     * @type {Array<number>}
+     * @memberof AddFieldsTemplateResponse
+     */
+    newFieldIds?: Array<number>;
+}
+/**
+ * @export
+ */
+export declare const AddFieldsTemplateResponseStatusEnum: {
+    readonly Success: "success";
+    readonly Error: "error";
+};
+export type AddFieldsTemplateResponseStatusEnum = typeof AddFieldsTemplateResponseStatusEnum[keyof typeof AddFieldsTemplateResponseStatusEnum];
+/**
+ * Check if a given object implements the AddFieldsTemplateResponse interface.
+ */
+export declare function instanceOfAddFieldsTemplateResponse(value: object): boolean;
+export declare function AddFieldsTemplateResponseFromJSON(json: any): AddFieldsTemplateResponse;
+export declare function AddFieldsTemplateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddFieldsTemplateResponse;
+export declare function AddFieldsTemplateResponseToJSON(value?: AddFieldsTemplateResponse | null): any;

package/dist/models/AddFieldsTemplateResponse.js

@@ -0,0 +1,62 @@
+"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.AddFieldsTemplateResponseToJSON = exports.AddFieldsTemplateResponseFromJSONTyped = exports.AddFieldsTemplateResponseFromJSON = exports.instanceOfAddFieldsTemplateResponse = exports.AddFieldsTemplateResponseStatusEnum = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.AddFieldsTemplateResponseStatusEnum = {
+    Success: 'success',
+    Error: 'error'
+};
+/**
+ * Check if a given object implements the AddFieldsTemplateResponse interface.
+ */
+function instanceOfAddFieldsTemplateResponse(value) {
+    var isInstance = true;
+    isInstance = isInstance && "status" in value;
+    return isInstance;
+}
+exports.instanceOfAddFieldsTemplateResponse = instanceOfAddFieldsTemplateResponse;
+function AddFieldsTemplateResponseFromJSON(json) {
+    return AddFieldsTemplateResponseFromJSONTyped(json, false);
+}
+exports.AddFieldsTemplateResponseFromJSON = AddFieldsTemplateResponseFromJSON;
+function AddFieldsTemplateResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'status': json['status'],
+        'errors': !(0, runtime_1.exists)(json, 'errors') ? undefined : json['errors'],
+        'newFieldIds': !(0, runtime_1.exists)(json, 'new_field_ids') ? undefined : json['new_field_ids'],
+    };
+}
+exports.AddFieldsTemplateResponseFromJSONTyped = AddFieldsTemplateResponseFromJSONTyped;
+function AddFieldsTemplateResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'status': value.status,
+        'errors': value.errors,
+        'new_field_ids': value.newFieldIds,
+    };
+}
+exports.AddFieldsTemplateResponseToJSON = AddFieldsTemplateResponseToJSON;

package/dist/models/AuthenticationError.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 AuthenticationError
+ */
+export interface AuthenticationError {
+    /**
+     *
+     * @type {string}
+     * @memberof AuthenticationError
+     */
+    status?: AuthenticationErrorStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthenticationError
+     */
+    error: string;
+}
+/**
+ * @export
+ */
+export declare const AuthenticationErrorStatusEnum: {
+    readonly Error: "error";
+};
+export type AuthenticationErrorStatusEnum = typeof AuthenticationErrorStatusEnum[keyof typeof AuthenticationErrorStatusEnum];
+/**
+ * Check if a given object implements the AuthenticationError interface.
+ */
+export declare function instanceOfAuthenticationError(value: object): boolean;
+export declare function AuthenticationErrorFromJSON(json: any): AuthenticationError;
+export declare function AuthenticationErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthenticationError;
+export declare function AuthenticationErrorToJSON(value?: AuthenticationError | null): any;

package/dist/models/AuthenticationError.js

@@ -0,0 +1,59 @@
+"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.AuthenticationErrorToJSON = exports.AuthenticationErrorFromJSONTyped = exports.AuthenticationErrorFromJSON = exports.instanceOfAuthenticationError = exports.AuthenticationErrorStatusEnum = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.AuthenticationErrorStatusEnum = {
+    Error: 'error'
+};
+/**
+ * Check if a given object implements the AuthenticationError interface.
+ */
+function instanceOfAuthenticationError(value) {
+    var isInstance = true;
+    isInstance = isInstance && "error" in value;
+    return isInstance;
+}
+exports.instanceOfAuthenticationError = instanceOfAuthenticationError;
+function AuthenticationErrorFromJSON(json) {
+    return AuthenticationErrorFromJSONTyped(json, false);
+}
+exports.AuthenticationErrorFromJSON = AuthenticationErrorFromJSON;
+function AuthenticationErrorFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
+        'error': json['error'],
+    };
+}
+exports.AuthenticationErrorFromJSONTyped = AuthenticationErrorFromJSONTyped;
+function AuthenticationErrorToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'status': value.status,
+        'error': value.error,
+    };
+}
+exports.AuthenticationErrorToJSON = AuthenticationErrorToJSON;

package/dist/models/AuthenticationSuccessResponse.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 AuthenticationSuccessResponse
+ */
+export interface AuthenticationSuccessResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof AuthenticationSuccessResponse
+     */
+    status: AuthenticationSuccessResponseStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const AuthenticationSuccessResponseStatusEnum: {
+    readonly Success: "success";
+};
+export type AuthenticationSuccessResponseStatusEnum = typeof AuthenticationSuccessResponseStatusEnum[keyof typeof AuthenticationSuccessResponseStatusEnum];
+/**
+ * Check if a given object implements the AuthenticationSuccessResponse interface.
+ */
+export declare function instanceOfAuthenticationSuccessResponse(value: object): boolean;
+export declare function AuthenticationSuccessResponseFromJSON(json: any): AuthenticationSuccessResponse;
+export declare function AuthenticationSuccessResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthenticationSuccessResponse;
+export declare function AuthenticationSuccessResponseToJSON(value?: AuthenticationSuccessResponse | null): any;

package/dist/models/AuthenticationSuccessResponse.js

@@ -0,0 +1,56 @@
+"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.AuthenticationSuccessResponseToJSON = exports.AuthenticationSuccessResponseFromJSONTyped = exports.AuthenticationSuccessResponseFromJSON = exports.instanceOfAuthenticationSuccessResponse = exports.AuthenticationSuccessResponseStatusEnum = void 0;
+/**
+ * @export
+ */
+exports.AuthenticationSuccessResponseStatusEnum = {
+    Success: 'success'
+};
+/**
+ * Check if a given object implements the AuthenticationSuccessResponse interface.
+ */
+function instanceOfAuthenticationSuccessResponse(value) {
+    var isInstance = true;
+    isInstance = isInstance && "status" in value;
+    return isInstance;
+}
+exports.instanceOfAuthenticationSuccessResponse = instanceOfAuthenticationSuccessResponse;
+function AuthenticationSuccessResponseFromJSON(json) {
+    return AuthenticationSuccessResponseFromJSONTyped(json, false);
+}
+exports.AuthenticationSuccessResponseFromJSON = AuthenticationSuccessResponseFromJSON;
+function AuthenticationSuccessResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'status': json['status'],
+    };
+}
+exports.AuthenticationSuccessResponseFromJSONTyped = AuthenticationSuccessResponseFromJSONTyped;
+function AuthenticationSuccessResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'status': value.status,
+    };
+}
+exports.AuthenticationSuccessResponseToJSON = AuthenticationSuccessResponseToJSON;

package/dist/models/CombinePdfsData.d.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.
+ */
+/**
+ *
+ * @export
+ * @interface CombinePdfsData
+ */
+export interface CombinePdfsData {
+    /**
+     *
+     * @type {boolean}
+     * @memberof CombinePdfsData
+     */
+    deleteCustomFiles?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof CombinePdfsData
+     */
+    expiresIn?: number;
+    /**
+     *
+     * @type {object}
+     * @memberof CombinePdfsData
+     */
+    metadata?: object;
+    /**
+     *
+     * @type {string}
+     * @memberof CombinePdfsData
+     */
+    password?: string;
+    /**
+     *
+     * @type {Array<object>}
+     * @memberof CombinePdfsData
+     */
+    sourcePdfs: Array<object>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CombinePdfsData
+     */
+    test?: boolean;
+}
+/**
+ * Check if a given object implements the CombinePdfsData interface.
+ */
+export declare function instanceOfCombinePdfsData(value: object): boolean;
+export declare function CombinePdfsDataFromJSON(json: any): CombinePdfsData;
+export declare function CombinePdfsDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): CombinePdfsData;
+export declare function CombinePdfsDataToJSON(value?: CombinePdfsData | null): any;

package/dist/models/CombinePdfsData.js

@@ -0,0 +1,61 @@
+"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.CombinePdfsDataToJSON = exports.CombinePdfsDataFromJSONTyped = exports.CombinePdfsDataFromJSON = exports.instanceOfCombinePdfsData = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the CombinePdfsData interface.
+ */
+function instanceOfCombinePdfsData(value) {
+    var isInstance = true;
+    isInstance = isInstance && "sourcePdfs" in value;
+    return isInstance;
+}
+exports.instanceOfCombinePdfsData = instanceOfCombinePdfsData;
+function CombinePdfsDataFromJSON(json) {
+    return CombinePdfsDataFromJSONTyped(json, false);
+}
+exports.CombinePdfsDataFromJSON = CombinePdfsDataFromJSON;
+function CombinePdfsDataFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'deleteCustomFiles': !(0, runtime_1.exists)(json, 'delete_custom_files') ? undefined : json['delete_custom_files'],
+        'expiresIn': !(0, runtime_1.exists)(json, 'expires_in') ? undefined : json['expires_in'],
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : json['metadata'],
+        'password': !(0, runtime_1.exists)(json, 'password') ? undefined : json['password'],
+        'sourcePdfs': json['source_pdfs'],
+        'test': !(0, runtime_1.exists)(json, 'test') ? undefined : json['test'],
+    };
+}
+exports.CombinePdfsDataFromJSONTyped = CombinePdfsDataFromJSONTyped;
+function CombinePdfsDataToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'delete_custom_files': value.deleteCustomFiles,
+        'expires_in': value.expiresIn,
+        'metadata': value.metadata,
+        'password': value.password,
+        'source_pdfs': value.sourcePdfs,
+        'test': value.test,
+    };
+}
+exports.CombinePdfsDataToJSON = CombinePdfsDataToJSON;

package/dist/models/CombinedSubmission.d.ts

@@ -0,0 +1,113 @@
+/**
+ * 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 { CombinedSubmissionAction } from './CombinedSubmissionAction';
+/**
+ *
+ * @export
+ * @interface CombinedSubmission
+ */
+export interface CombinedSubmission {
+    /**
+     *
+     * @type {string}
+     * @memberof CombinedSubmission
+     */
+    id: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CombinedSubmission
+     */
+    expired: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof CombinedSubmission
+     */
+    expiresIn?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CombinedSubmission
+     */
+    expiresAt?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CombinedSubmission
+     */
+    state: CombinedSubmissionStateEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof CombinedSubmission
+     */
+    errorMessage?: string | null;
+    /**
+     *
+     * @type {object}
+     * @memberof CombinedSubmission
+     */
+    metadata?: object;
+    /**
+     *
+     * @type {string}
+     * @memberof CombinedSubmission
+     */
+    password?: string | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof CombinedSubmission
+     */
+    submissionIds: Array<string>;
+    /**
+     *
+     * @type {Array<object>}
+     * @memberof CombinedSubmission
+     */
+    sourcePdfs: Array<object>;
+    /**
+     *
+     * @type {string}
+     * @memberof CombinedSubmission
+     */
+    downloadUrl?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CombinedSubmission
+     */
+    pdfHash?: string | null;
+    /**
+     *
+     * @type {Array<CombinedSubmissionAction>}
+     * @memberof CombinedSubmission
+     */
+    actions?: Array<CombinedSubmissionAction>;
+}
+/**
+ * @export
+ */
+export declare const CombinedSubmissionStateEnum: {
+    readonly Pending: "pending";
+    readonly Processed: "processed";
+    readonly Error: "error";
+};
+export type CombinedSubmissionStateEnum = typeof CombinedSubmissionStateEnum[keyof typeof CombinedSubmissionStateEnum];
+/**
+ * Check if a given object implements the CombinedSubmission interface.
+ */
+export declare function instanceOfCombinedSubmission(value: object): boolean;
+export declare function CombinedSubmissionFromJSON(json: any): CombinedSubmission;
+export declare function CombinedSubmissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CombinedSubmission;
+export declare function CombinedSubmissionToJSON(value?: CombinedSubmission | null): any;