docspring-ts 1.0.2 → 2.0.0

package/src/models/Submission.ts

@@ -1,246 +0,0 @@
-/* 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 { SubmissionAction } from './SubmissionAction';
-import {
-    SubmissionActionFromJSON,
-    SubmissionActionFromJSONTyped,
-    SubmissionActionToJSON,
-} from './SubmissionAction';
-import type { SubmissionDataRequest } from './SubmissionDataRequest';
-import {
-    SubmissionDataRequestFromJSON,
-    SubmissionDataRequestFromJSONTyped,
-    SubmissionDataRequestToJSON,
-} 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 const 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'
-} as const;
-export type SubmissionStateEnum = typeof SubmissionStateEnum[keyof typeof SubmissionStateEnum];
-
-
-/**
- * Check if a given object implements the Submission interface.
- */
-export function instanceOfSubmission(value: object): boolean {
-    let isInstance = true;
-    isInstance = isInstance && "id" in value;
-    isInstance = isInstance && "test" in value;
-    isInstance = isInstance && "expired" in value;
-    isInstance = isInstance && "state" in value;
-
-    return isInstance;
-}
-
-export function SubmissionFromJSON(json: any): Submission {
-    return SubmissionFromJSONTyped(json, false);
-}
-
-export function SubmissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): Submission {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'id': json['id'],
-        'templateId': !exists(json, 'template_id') ? undefined : json['template_id'],
-        'test': json['test'],
-        'editable': !exists(json, 'editable') ? undefined : json['editable'],
-        'expired': json['expired'],
-        'expiresAt': !exists(json, 'expires_at') ? undefined : json['expires_at'],
-        'processedAt': !exists(json, 'processed_at') ? undefined : json['processed_at'],
-        'state': json['state'],
-        'data': !exists(json, 'data') ? undefined : json['data'],
-        'metadata': !exists(json, 'metadata') ? undefined : json['metadata'],
-        'truncatedText': !exists(json, 'truncated_text') ? undefined : json['truncated_text'],
-        'pdfHash': !exists(json, 'pdf_hash') ? undefined : json['pdf_hash'],
-        'downloadUrl': !exists(json, 'download_url') ? undefined : json['download_url'],
-        'permanentDownloadUrl': !exists(json, 'permanent_download_url') ? undefined : json['permanent_download_url'],
-        'batchId': !exists(json, 'batch_id') ? undefined : json['batch_id'],
-        'dataRequests': !exists(json, 'data_requests') ? undefined : ((json['data_requests'] as Array<any>).map(SubmissionDataRequestFromJSON)),
-        'actions': !exists(json, 'actions') ? undefined : ((json['actions'] as Array<any>).map(SubmissionActionFromJSON)),
-        'source': !exists(json, 'source') ? undefined : json['source'],
-        'referrer': !exists(json, 'referrer') ? undefined : json['referrer'],
-    };
-}
-
-export function SubmissionToJSON(value?: Submission | null): any {
-    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 as Array<any>).map(SubmissionDataRequestToJSON)),
-        'actions': value.actions === undefined ? undefined : ((value.actions as Array<any>).map(SubmissionActionToJSON)),
-        'source': value.source,
-        'referrer': value.referrer,
-    };
-}
-

package/src/models/SubmissionAction.ts

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

package/src/models/SubmissionBatch.ts

@@ -1,156 +0,0 @@
-/* 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 { Submission } from './Submission';
-import {
-    SubmissionFromJSON,
-    SubmissionFromJSONTyped,
-    SubmissionToJSON,
-} 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 const SubmissionBatchStateEnum = {
-    Pending: 'pending',
-    Processed: 'processed',
-    Error: 'error'
-} as const;
-export type SubmissionBatchStateEnum = typeof SubmissionBatchStateEnum[keyof typeof SubmissionBatchStateEnum];
-
-
-/**
- * Check if a given object implements the SubmissionBatch interface.
- */
-export function instanceOfSubmissionBatch(value: object): boolean {
-    let 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;
-}
-
-export function SubmissionBatchFromJSON(json: any): SubmissionBatch {
-    return SubmissionBatchFromJSONTyped(json, false);
-}
-
-export function SubmissionBatchFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmissionBatch {
-    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': !exists(json, 'submissions') ? undefined : ((json['submissions'] as Array<any>).map(SubmissionFromJSON)),
-    };
-}
-
-export function SubmissionBatchToJSON(value?: SubmissionBatch | null): any {
-    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 as Array<any>).map(SubmissionToJSON)),
-    };
-}
-

package/src/models/SubmissionBatchData.ts

@@ -1,97 +0,0 @@
-/* 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 { SubmissionDataBatchRequest } from './SubmissionDataBatchRequest';
-import {
-    SubmissionDataBatchRequestFromJSON,
-    SubmissionDataBatchRequestFromJSONTyped,
-    SubmissionDataBatchRequestToJSON,
-} 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 function instanceOfSubmissionBatchData(value: object): boolean {
-    let isInstance = true;
-    isInstance = isInstance && "submissions" in value;
-
-    return isInstance;
-}
-
-export function SubmissionBatchDataFromJSON(json: any): SubmissionBatchData {
-    return SubmissionBatchDataFromJSONTyped(json, false);
-}
-
-export function SubmissionBatchDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmissionBatchData {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'metadata': !exists(json, 'metadata') ? undefined : json['metadata'],
-        'submissions': ((json['submissions'] as Array<any>).map(SubmissionDataBatchRequestFromJSON)),
-        'templateId': !exists(json, 'template_id') ? undefined : json['template_id'],
-        'test': !exists(json, 'test') ? undefined : json['test'],
-    };
-}
-
-export function SubmissionBatchDataToJSON(value?: SubmissionBatchData | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'metadata': value.metadata,
-        'submissions': ((value.submissions as Array<any>).map(SubmissionDataBatchRequestToJSON)),
-        'template_id': value.templateId,
-        'test': value.test,
-    };
-}
-