docspring-ts 1.0.1 → 1.0.2

package/src/models/CombinedSubmissionAction.ts

@@ -0,0 +1,144 @@
+/* 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 CombinedSubmissionAction
+ */
+export interface CombinedSubmissionAction {
+    /**
+     * 
+     * @type {string}
+     * @memberof CombinedSubmissionAction
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CombinedSubmissionAction
+     */
+    integrationId: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CombinedSubmissionAction
+     */
+    state: CombinedSubmissionActionStateEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CombinedSubmissionAction
+     */
+    actionCategory: CombinedSubmissionActionActionCategoryEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CombinedSubmissionAction
+     */
+    actionType: CombinedSubmissionActionActionTypeEnum;
+    /**
+     * 
+     * @type {object}
+     * @memberof CombinedSubmissionAction
+     */
+    resultData: object;
+}
+
+
+/**
+ * @export
+ */
+export const CombinedSubmissionActionStateEnum = {
+    Pending: 'pending',
+    Processed: 'processed',
+    Failed: 'failed',
+    Error: 'error'
+} as const;
+export type CombinedSubmissionActionStateEnum = typeof CombinedSubmissionActionStateEnum[keyof typeof CombinedSubmissionActionStateEnum];
+
+/**
+ * @export
+ */
+export const CombinedSubmissionActionActionCategoryEnum = {
+    Notification: 'notification',
+    FileUpload: 'file_upload'
+} as const;
+export type CombinedSubmissionActionActionCategoryEnum = typeof CombinedSubmissionActionActionCategoryEnum[keyof typeof CombinedSubmissionActionActionCategoryEnum];
+
+/**
+ * @export
+ */
+export const CombinedSubmissionActionActionTypeEnum = {
+    Webhook: 'webhook',
+    SlackWebhook: 'slack_webhook',
+    Email: 'email',
+    AwsS3Upload: 'aws_s3_upload'
+} as const;
+export type CombinedSubmissionActionActionTypeEnum = typeof CombinedSubmissionActionActionTypeEnum[keyof typeof CombinedSubmissionActionActionTypeEnum];
+
+
+/**
+ * Check if a given object implements the CombinedSubmissionAction interface.
+ */
+export function instanceOfCombinedSubmissionAction(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 CombinedSubmissionActionFromJSON(json: any): CombinedSubmissionAction {
+    return CombinedSubmissionActionFromJSONTyped(json, false);
+}
+
+export function CombinedSubmissionActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CombinedSubmissionAction {
+    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 CombinedSubmissionActionToJSON(value?: CombinedSubmissionAction | 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/CombinedSubmissionData.ts

@@ -0,0 +1,98 @@
+/* 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 CombinedSubmissionData
+ */
+export interface CombinedSubmissionData {
+    /**
+     * 
+     * @type {number}
+     * @memberof CombinedSubmissionData
+     */
+    expiresIn?: number;
+    /**
+     * 
+     * @type {object}
+     * @memberof CombinedSubmissionData
+     */
+    metadata?: object;
+    /**
+     * 
+     * @type {string}
+     * @memberof CombinedSubmissionData
+     */
+    password?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CombinedSubmissionData
+     */
+    submissionIds: Array<string>;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CombinedSubmissionData
+     */
+    test?: boolean;
+}
+
+/**
+ * Check if a given object implements the CombinedSubmissionData interface.
+ */
+export function instanceOfCombinedSubmissionData(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "submissionIds" in value;
+
+    return isInstance;
+}
+
+export function CombinedSubmissionDataFromJSON(json: any): CombinedSubmissionData {
+    return CombinedSubmissionDataFromJSONTyped(json, false);
+}
+
+export function CombinedSubmissionDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): CombinedSubmissionData {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'expiresIn': !exists(json, 'expires_in') ? undefined : json['expires_in'],
+        'metadata': !exists(json, 'metadata') ? undefined : json['metadata'],
+        'password': !exists(json, 'password') ? undefined : json['password'],
+        'submissionIds': json['submission_ids'],
+        'test': !exists(json, 'test') ? undefined : json['test'],
+    };
+}
+
+export function CombinedSubmissionDataToJSON(value?: CombinedSubmissionData | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'expires_in': value.expiresIn,
+        'metadata': value.metadata,
+        'password': value.password,
+        'submission_ids': value.submissionIds,
+        'test': value.test,
+    };
+}
+

package/src/models/CopyTemplateData.ts

@@ -0,0 +1,74 @@
+/* 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 CopyTemplateData
+ */
+export interface CopyTemplateData {
+    /**
+     * 
+     * @type {string}
+     * @memberof CopyTemplateData
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CopyTemplateData
+     */
+    parentFolderId: string;
+}
+
+/**
+ * Check if a given object implements the CopyTemplateData interface.
+ */
+export function instanceOfCopyTemplateData(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "parentFolderId" in value;
+
+    return isInstance;
+}
+
+export function CopyTemplateDataFromJSON(json: any): CopyTemplateData {
+    return CopyTemplateDataFromJSONTyped(json, false);
+}
+
+export function CopyTemplateDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): CopyTemplateData {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'parentFolderId': json['parent_folder_id'],
+    };
+}
+
+export function CopyTemplateDataToJSON(value?: CopyTemplateData | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'parent_folder_id': value.parentFolderId,
+    };
+}
+

package/src/models/CreateCombinedSubmissionResponse.ts

@@ -0,0 +1,101 @@
+/* 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 { CombinedSubmission } from './CombinedSubmission';
+import {
+    CombinedSubmissionFromJSON,
+    CombinedSubmissionFromJSONTyped,
+    CombinedSubmissionToJSON,
+} from './CombinedSubmission';
+
+/**
+ * 
+ * @export
+ * @interface CreateCombinedSubmissionResponse
+ */
+export interface CreateCombinedSubmissionResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateCombinedSubmissionResponse
+     */
+    status: CreateCombinedSubmissionResponseStatusEnum;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CreateCombinedSubmissionResponse
+     */
+    errors?: Array<string>;
+    /**
+     * 
+     * @type {CombinedSubmission}
+     * @memberof CreateCombinedSubmissionResponse
+     */
+    combinedSubmission: CombinedSubmission;
+}
+
+
+/**
+ * @export
+ */
+export const CreateCombinedSubmissionResponseStatusEnum = {
+    Success: 'success',
+    Error: 'error'
+} as const;
+export type CreateCombinedSubmissionResponseStatusEnum = typeof CreateCombinedSubmissionResponseStatusEnum[keyof typeof CreateCombinedSubmissionResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the CreateCombinedSubmissionResponse interface.
+ */
+export function instanceOfCreateCombinedSubmissionResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "status" in value;
+    isInstance = isInstance && "combinedSubmission" in value;
+
+    return isInstance;
+}
+
+export function CreateCombinedSubmissionResponseFromJSON(json: any): CreateCombinedSubmissionResponse {
+    return CreateCombinedSubmissionResponseFromJSONTyped(json, false);
+}
+
+export function CreateCombinedSubmissionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCombinedSubmissionResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+        'errors': !exists(json, 'errors') ? undefined : json['errors'],
+        'combinedSubmission': CombinedSubmissionFromJSON(json['combined_submission']),
+    };
+}
+
+export function CreateCombinedSubmissionResponseToJSON(value?: CreateCombinedSubmissionResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'status': value.status,
+        'errors': value.errors,
+        'combined_submission': CombinedSubmissionToJSON(value.combinedSubmission),
+    };
+}
+

package/src/models/CreateCustomFileData.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 CreateCustomFileData
+ */
+export interface CreateCustomFileData {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateCustomFileData
+     */
+    cacheId: string;
+}
+
+/**
+ * Check if a given object implements the CreateCustomFileData interface.
+ */
+export function instanceOfCreateCustomFileData(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "cacheId" in value;
+
+    return isInstance;
+}
+
+export function CreateCustomFileDataFromJSON(json: any): CreateCustomFileData {
+    return CreateCustomFileDataFromJSONTyped(json, false);
+}
+
+export function CreateCustomFileDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCustomFileData {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'cacheId': json['cache_id'],
+    };
+}
+
+export function CreateCustomFileDataToJSON(value?: CreateCustomFileData | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'cache_id': value.cacheId,
+    };
+}
+

package/src/models/CreateCustomFileResponse.ts

@@ -0,0 +1,94 @@
+/* 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 CreateCustomFileResponse
+ */
+export interface CreateCustomFileResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateCustomFileResponse
+     */
+    status: CreateCustomFileResponseStatusEnum;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CreateCustomFileResponse
+     */
+    errors?: Array<string>;
+    /**
+     * 
+     * @type {object}
+     * @memberof CreateCustomFileResponse
+     */
+    customFile: object;
+}
+
+
+/**
+ * @export
+ */
+export const CreateCustomFileResponseStatusEnum = {
+    Success: 'success',
+    Error: 'error'
+} as const;
+export type CreateCustomFileResponseStatusEnum = typeof CreateCustomFileResponseStatusEnum[keyof typeof CreateCustomFileResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the CreateCustomFileResponse interface.
+ */
+export function instanceOfCreateCustomFileResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "status" in value;
+    isInstance = isInstance && "customFile" in value;
+
+    return isInstance;
+}
+
+export function CreateCustomFileResponseFromJSON(json: any): CreateCustomFileResponse {
+    return CreateCustomFileResponseFromJSONTyped(json, false);
+}
+
+export function CreateCustomFileResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCustomFileResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+        'errors': !exists(json, 'errors') ? undefined : json['errors'],
+        'customFile': json['custom_file'],
+    };
+}
+
+export function CreateCustomFileResponseToJSON(value?: CreateCustomFileResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'status': value.status,
+        'errors': value.errors,
+        'custom_file': value.customFile,
+    };
+}
+

package/src/models/CreateFolderAttributes.ts

@@ -0,0 +1,74 @@
+/* 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 CreateFolderAttributes
+ */
+export interface CreateFolderAttributes {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateFolderAttributes
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateFolderAttributes
+     */
+    parentFolderId?: string;
+}
+
+/**
+ * Check if a given object implements the CreateFolderAttributes interface.
+ */
+export function instanceOfCreateFolderAttributes(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+
+    return isInstance;
+}
+
+export function CreateFolderAttributesFromJSON(json: any): CreateFolderAttributes {
+    return CreateFolderAttributesFromJSONTyped(json, false);
+}
+
+export function CreateFolderAttributesFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateFolderAttributes {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'parentFolderId': !exists(json, 'parent_folder_id') ? undefined : json['parent_folder_id'],
+    };
+}
+
+export function CreateFolderAttributesToJSON(value?: CreateFolderAttributes | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'parent_folder_id': value.parentFolderId,
+    };
+}
+