docspring-ts 1.0.0 → 1.0.2

package/src/apis/index.ts

@@ -0,0 +1,3 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './PDFApi';

package/src/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/models/AddFieldsData.ts

@@ -0,0 +1,66 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface AddFieldsData
+ */
+export interface AddFieldsData {
+    /**
+     * 
+     * @type {Array<object>}
+     * @memberof AddFieldsData
+     */
+    fields: Array<object>;
+}
+
+/**
+ * Check if a given object implements the AddFieldsData interface.
+ */
+export function instanceOfAddFieldsData(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "fields" in value;
+
+    return isInstance;
+}
+
+export function AddFieldsDataFromJSON(json: any): AddFieldsData {
+    return AddFieldsDataFromJSONTyped(json, false);
+}
+
+export function AddFieldsDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddFieldsData {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'fields': json['fields'],
+    };
+}
+
+export function AddFieldsDataToJSON(value?: AddFieldsData | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'fields': value.fields,
+    };
+}
+

package/src/models/AddFieldsTemplateResponse.ts

@@ -0,0 +1,93 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @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 const AddFieldsTemplateResponseStatusEnum = {
+    Success: 'success',
+    Error: 'error'
+} as const;
+export type AddFieldsTemplateResponseStatusEnum = typeof AddFieldsTemplateResponseStatusEnum[keyof typeof AddFieldsTemplateResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the AddFieldsTemplateResponse interface.
+ */
+export function instanceOfAddFieldsTemplateResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "status" in value;
+
+    return isInstance;
+}
+
+export function AddFieldsTemplateResponseFromJSON(json: any): AddFieldsTemplateResponse {
+    return AddFieldsTemplateResponseFromJSONTyped(json, false);
+}
+
+export function AddFieldsTemplateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddFieldsTemplateResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+        'errors': !exists(json, 'errors') ? undefined : json['errors'],
+        'newFieldIds': !exists(json, 'new_field_ids') ? undefined : json['new_field_ids'],
+    };
+}
+
+export function AddFieldsTemplateResponseToJSON(value?: AddFieldsTemplateResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'status': value.status,
+        'errors': value.errors,
+        'new_field_ids': value.newFieldIds,
+    };
+}
+

package/src/models/AuthenticationError.ts

@@ -0,0 +1,84 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface AuthenticationError
+ */
+export interface AuthenticationError {
+    /**
+     * 
+     * @type {string}
+     * @memberof AuthenticationError
+     */
+    status?: AuthenticationErrorStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof AuthenticationError
+     */
+    error: string;
+}
+
+
+/**
+ * @export
+ */
+export const AuthenticationErrorStatusEnum = {
+    Error: 'error'
+} as const;
+export type AuthenticationErrorStatusEnum = typeof AuthenticationErrorStatusEnum[keyof typeof AuthenticationErrorStatusEnum];
+
+
+/**
+ * Check if a given object implements the AuthenticationError interface.
+ */
+export function instanceOfAuthenticationError(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "error" in value;
+
+    return isInstance;
+}
+
+export function AuthenticationErrorFromJSON(json: any): AuthenticationError {
+    return AuthenticationErrorFromJSONTyped(json, false);
+}
+
+export function AuthenticationErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthenticationError {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'status': !exists(json, 'status') ? undefined : json['status'],
+        'error': json['error'],
+    };
+}
+
+export function AuthenticationErrorToJSON(value?: AuthenticationError | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'status': value.status,
+        'error': value.error,
+    };
+}
+

package/src/models/AuthenticationSuccessResponse.ts

@@ -0,0 +1,76 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface AuthenticationSuccessResponse
+ */
+export interface AuthenticationSuccessResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof AuthenticationSuccessResponse
+     */
+    status: AuthenticationSuccessResponseStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const AuthenticationSuccessResponseStatusEnum = {
+    Success: 'success'
+} as const;
+export type AuthenticationSuccessResponseStatusEnum = typeof AuthenticationSuccessResponseStatusEnum[keyof typeof AuthenticationSuccessResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the AuthenticationSuccessResponse interface.
+ */
+export function instanceOfAuthenticationSuccessResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "status" in value;
+
+    return isInstance;
+}
+
+export function AuthenticationSuccessResponseFromJSON(json: any): AuthenticationSuccessResponse {
+    return AuthenticationSuccessResponseFromJSONTyped(json, false);
+}
+
+export function AuthenticationSuccessResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthenticationSuccessResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+    };
+}
+
+export function AuthenticationSuccessResponseToJSON(value?: AuthenticationSuccessResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'status': value.status,
+    };
+}
+

package/src/models/CombinePdfsData.ts

@@ -0,0 +1,106 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @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 function instanceOfCombinePdfsData(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "sourcePdfs" in value;
+
+    return isInstance;
+}
+
+export function CombinePdfsDataFromJSON(json: any): CombinePdfsData {
+    return CombinePdfsDataFromJSONTyped(json, false);
+}
+
+export function CombinePdfsDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): CombinePdfsData {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'deleteCustomFiles': !exists(json, 'delete_custom_files') ? undefined : json['delete_custom_files'],
+        'expiresIn': !exists(json, 'expires_in') ? undefined : json['expires_in'],
+        'metadata': !exists(json, 'metadata') ? undefined : json['metadata'],
+        'password': !exists(json, 'password') ? undefined : json['password'],
+        'sourcePdfs': json['source_pdfs'],
+        'test': !exists(json, 'test') ? undefined : json['test'],
+    };
+}
+
+export function CombinePdfsDataToJSON(value?: CombinePdfsData | null): any {
+    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,
+    };
+}
+

package/src/models/CombinedSubmission.ts

@@ -0,0 +1,185 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { CombinedSubmissionAction } from './CombinedSubmissionAction';
+import {
+    CombinedSubmissionActionFromJSON,
+    CombinedSubmissionActionFromJSONTyped,
+    CombinedSubmissionActionToJSON,
+} 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 const CombinedSubmissionStateEnum = {
+    Pending: 'pending',
+    Processed: 'processed',
+    Error: 'error'
+} as const;
+export type CombinedSubmissionStateEnum = typeof CombinedSubmissionStateEnum[keyof typeof CombinedSubmissionStateEnum];
+
+
+/**
+ * Check if a given object implements the CombinedSubmission interface.
+ */
+export function instanceOfCombinedSubmission(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "expired" in value;
+    isInstance = isInstance && "state" in value;
+    isInstance = isInstance && "submissionIds" in value;
+    isInstance = isInstance && "sourcePdfs" in value;
+
+    return isInstance;
+}
+
+export function CombinedSubmissionFromJSON(json: any): CombinedSubmission {
+    return CombinedSubmissionFromJSONTyped(json, false);
+}
+
+export function CombinedSubmissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CombinedSubmission {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'expired': json['expired'],
+        'expiresIn': !exists(json, 'expires_in') ? undefined : json['expires_in'],
+        'expiresAt': !exists(json, 'expires_at') ? undefined : json['expires_at'],
+        'state': json['state'],
+        'errorMessage': !exists(json, 'error_message') ? undefined : json['error_message'],
+        'metadata': !exists(json, 'metadata') ? undefined : json['metadata'],
+        'password': !exists(json, 'password') ? undefined : json['password'],
+        'submissionIds': json['submission_ids'],
+        'sourcePdfs': json['source_pdfs'],
+        'downloadUrl': !exists(json, 'download_url') ? undefined : json['download_url'],
+        'pdfHash': !exists(json, 'pdf_hash') ? undefined : json['pdf_hash'],
+        'actions': !exists(json, 'actions') ? undefined : ((json['actions'] as Array<any>).map(CombinedSubmissionActionFromJSON)),
+    };
+}
+
+export function CombinedSubmissionToJSON(value?: CombinedSubmission | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'expired': value.expired,
+        'expires_in': value.expiresIn,
+        'expires_at': value.expiresAt,
+        'state': value.state,
+        'error_message': value.errorMessage,
+        'metadata': value.metadata,
+        'password': value.password,
+        'submission_ids': value.submissionIds,
+        'source_pdfs': value.sourcePdfs,
+        'download_url': value.downloadUrl,
+        'pdf_hash': value.pdfHash,
+        'actions': value.actions === undefined ? undefined : ((value.actions as Array<any>).map(CombinedSubmissionActionToJSON)),
+    };
+}
+