docspring-ts 1.0.1 → 1.0.2

package/src/models/CreateFolderData.ts

@@ -0,0 +1,73 @@
+/* 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 { CreateFolderAttributes } from './CreateFolderAttributes';
+import {
+    CreateFolderAttributesFromJSON,
+    CreateFolderAttributesFromJSONTyped,
+    CreateFolderAttributesToJSON,
+} from './CreateFolderAttributes';
+
+/**
+ * 
+ * @export
+ * @interface CreateFolderData
+ */
+export interface CreateFolderData {
+    /**
+     * 
+     * @type {CreateFolderAttributes}
+     * @memberof CreateFolderData
+     */
+    folder: CreateFolderAttributes;
+}
+
+/**
+ * Check if a given object implements the CreateFolderData interface.
+ */
+export function instanceOfCreateFolderData(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "folder" in value;
+
+    return isInstance;
+}
+
+export function CreateFolderDataFromJSON(json: any): CreateFolderData {
+    return CreateFolderDataFromJSONTyped(json, false);
+}
+
+export function CreateFolderDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateFolderData {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'folder': CreateFolderAttributesFromJSON(json['folder']),
+    };
+}
+
+export function CreateFolderDataToJSON(value?: CreateFolderData | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'folder': CreateFolderAttributesToJSON(value.folder),
+    };
+}
+

package/src/models/CreateHtmlTemplateData.ts

@@ -0,0 +1,73 @@
+/* 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 { HtmlTemplateData } from './HtmlTemplateData';
+import {
+    HtmlTemplateDataFromJSON,
+    HtmlTemplateDataFromJSONTyped,
+    HtmlTemplateDataToJSON,
+} from './HtmlTemplateData';
+
+/**
+ * 
+ * @export
+ * @interface CreateHtmlTemplateData
+ */
+export interface CreateHtmlTemplateData {
+    /**
+     * 
+     * @type {HtmlTemplateData}
+     * @memberof CreateHtmlTemplateData
+     */
+    template: HtmlTemplateData;
+}
+
+/**
+ * Check if a given object implements the CreateHtmlTemplateData interface.
+ */
+export function instanceOfCreateHtmlTemplateData(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "template" in value;
+
+    return isInstance;
+}
+
+export function CreateHtmlTemplateDataFromJSON(json: any): CreateHtmlTemplateData {
+    return CreateHtmlTemplateDataFromJSONTyped(json, false);
+}
+
+export function CreateHtmlTemplateDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateHtmlTemplateData {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'template': HtmlTemplateDataFromJSON(json['template']),
+    };
+}
+
+export function CreateHtmlTemplateDataToJSON(value?: CreateHtmlTemplateData | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'template': HtmlTemplateDataToJSON(value.template),
+    };
+}
+

package/src/models/CreateSubmissionBatchResponse.ts

@@ -0,0 +1,124 @@
+/* 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 { CreateSubmissionBatchSubmissionsResponse } from './CreateSubmissionBatchSubmissionsResponse';
+import {
+    CreateSubmissionBatchSubmissionsResponseFromJSON,
+    CreateSubmissionBatchSubmissionsResponseFromJSONTyped,
+    CreateSubmissionBatchSubmissionsResponseToJSON,
+} from './CreateSubmissionBatchSubmissionsResponse';
+import type { SubmissionBatch } from './SubmissionBatch';
+import {
+    SubmissionBatchFromJSON,
+    SubmissionBatchFromJSONTyped,
+    SubmissionBatchToJSON,
+} from './SubmissionBatch';
+
+/**
+ * 
+ * @export
+ * @interface CreateSubmissionBatchResponse
+ */
+export interface CreateSubmissionBatchResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionBatchResponse
+     */
+    status: CreateSubmissionBatchResponseStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionBatchResponse
+     */
+    error?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CreateSubmissionBatchResponse
+     */
+    errors?: Array<string>;
+    /**
+     * 
+     * @type {SubmissionBatch}
+     * @memberof CreateSubmissionBatchResponse
+     */
+    submissionBatch: SubmissionBatch;
+    /**
+     * 
+     * @type {Array<CreateSubmissionBatchSubmissionsResponse>}
+     * @memberof CreateSubmissionBatchResponse
+     */
+    submissions: Array<CreateSubmissionBatchSubmissionsResponse>;
+}
+
+
+/**
+ * @export
+ */
+export const CreateSubmissionBatchResponseStatusEnum = {
+    Success: 'success',
+    Error: 'error'
+} as const;
+export type CreateSubmissionBatchResponseStatusEnum = typeof CreateSubmissionBatchResponseStatusEnum[keyof typeof CreateSubmissionBatchResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the CreateSubmissionBatchResponse interface.
+ */
+export function instanceOfCreateSubmissionBatchResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "status" in value;
+    isInstance = isInstance && "submissionBatch" in value;
+    isInstance = isInstance && "submissions" in value;
+
+    return isInstance;
+}
+
+export function CreateSubmissionBatchResponseFromJSON(json: any): CreateSubmissionBatchResponse {
+    return CreateSubmissionBatchResponseFromJSONTyped(json, false);
+}
+
+export function CreateSubmissionBatchResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSubmissionBatchResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+        'error': !exists(json, 'error') ? undefined : json['error'],
+        'errors': !exists(json, 'errors') ? undefined : json['errors'],
+        'submissionBatch': SubmissionBatchFromJSON(json['submission_batch']),
+        'submissions': ((json['submissions'] as Array<any>).map(CreateSubmissionBatchSubmissionsResponseFromJSON)),
+    };
+}
+
+export function CreateSubmissionBatchResponseToJSON(value?: CreateSubmissionBatchResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'status': value.status,
+        'error': value.error,
+        'errors': value.errors,
+        'submission_batch': SubmissionBatchToJSON(value.submissionBatch),
+        'submissions': ((value.submissions as Array<any>).map(CreateSubmissionBatchSubmissionsResponseToJSON)),
+    };
+}
+

package/src/models/CreateSubmissionBatchSubmissionsResponse.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 { Submission } from './Submission';
+import {
+    SubmissionFromJSON,
+    SubmissionFromJSONTyped,
+    SubmissionToJSON,
+} from './Submission';
+
+/**
+ * 
+ * @export
+ * @interface CreateSubmissionBatchSubmissionsResponse
+ */
+export interface CreateSubmissionBatchSubmissionsResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionBatchSubmissionsResponse
+     */
+    status: CreateSubmissionBatchSubmissionsResponseStatusEnum;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CreateSubmissionBatchSubmissionsResponse
+     */
+    errors?: Array<string>;
+    /**
+     * 
+     * @type {Submission}
+     * @memberof CreateSubmissionBatchSubmissionsResponse
+     */
+    submission?: Submission;
+}
+
+
+/**
+ * @export
+ */
+export const CreateSubmissionBatchSubmissionsResponseStatusEnum = {
+    Success: 'success',
+    Error: 'error',
+    ValidButNotSaved: 'valid_but_not_saved'
+} as const;
+export type CreateSubmissionBatchSubmissionsResponseStatusEnum = typeof CreateSubmissionBatchSubmissionsResponseStatusEnum[keyof typeof CreateSubmissionBatchSubmissionsResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the CreateSubmissionBatchSubmissionsResponse interface.
+ */
+export function instanceOfCreateSubmissionBatchSubmissionsResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "status" in value;
+
+    return isInstance;
+}
+
+export function CreateSubmissionBatchSubmissionsResponseFromJSON(json: any): CreateSubmissionBatchSubmissionsResponse {
+    return CreateSubmissionBatchSubmissionsResponseFromJSONTyped(json, false);
+}
+
+export function CreateSubmissionBatchSubmissionsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSubmissionBatchSubmissionsResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+        'errors': !exists(json, 'errors') ? undefined : json['errors'],
+        'submission': !exists(json, 'submission') ? undefined : SubmissionFromJSON(json['submission']),
+    };
+}
+
+export function CreateSubmissionBatchSubmissionsResponseToJSON(value?: CreateSubmissionBatchSubmissionsResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'status': value.status,
+        'errors': value.errors,
+        'submission': SubmissionToJSON(value.submission),
+    };
+}
+

package/src/models/CreateSubmissionData.ts

@@ -0,0 +1,137 @@
+/* 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 { CreateSubmissionDataRequestData } from './CreateSubmissionDataRequestData';
+import {
+    CreateSubmissionDataRequestDataFromJSON,
+    CreateSubmissionDataRequestDataFromJSONTyped,
+    CreateSubmissionDataRequestDataToJSON,
+} from './CreateSubmissionDataRequestData';
+
+/**
+ * 
+ * @export
+ * @interface CreateSubmissionData
+ */
+export interface CreateSubmissionData {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionData
+     */
+    css?: string;
+    /**
+     * 
+     * @type {object}
+     * @memberof CreateSubmissionData
+     */
+    data: object;
+    /**
+     * 
+     * @type {Array<CreateSubmissionDataRequestData>}
+     * @memberof CreateSubmissionData
+     */
+    dataRequests?: Array<CreateSubmissionDataRequestData>;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateSubmissionData
+     */
+    expiresIn?: number;
+    /**
+     * 
+     * @type {object}
+     * @memberof CreateSubmissionData
+     */
+    fieldOverrides?: object;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionData
+     */
+    html?: string;
+    /**
+     * 
+     * @type {object}
+     * @memberof CreateSubmissionData
+     */
+    metadata?: object;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionData
+     */
+    password?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CreateSubmissionData
+     */
+    test?: boolean;
+}
+
+/**
+ * Check if a given object implements the CreateSubmissionData interface.
+ */
+export function instanceOfCreateSubmissionData(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "data" in value;
+
+    return isInstance;
+}
+
+export function CreateSubmissionDataFromJSON(json: any): CreateSubmissionData {
+    return CreateSubmissionDataFromJSONTyped(json, false);
+}
+
+export function CreateSubmissionDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSubmissionData {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'css': !exists(json, 'css') ? undefined : json['css'],
+        'data': json['data'],
+        'dataRequests': !exists(json, 'data_requests') ? undefined : ((json['data_requests'] as Array<any>).map(CreateSubmissionDataRequestDataFromJSON)),
+        'expiresIn': !exists(json, 'expires_in') ? undefined : json['expires_in'],
+        'fieldOverrides': !exists(json, 'field_overrides') ? undefined : json['field_overrides'],
+        'html': !exists(json, 'html') ? undefined : json['html'],
+        'metadata': !exists(json, 'metadata') ? undefined : json['metadata'],
+        'password': !exists(json, 'password') ? undefined : json['password'],
+        'test': !exists(json, 'test') ? undefined : json['test'],
+    };
+}
+
+export function CreateSubmissionDataToJSON(value?: CreateSubmissionData | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'css': value.css,
+        'data': value.data,
+        'data_requests': value.dataRequests === undefined ? undefined : ((value.dataRequests as Array<any>).map(CreateSubmissionDataRequestDataToJSON)),
+        'expires_in': value.expiresIn,
+        'field_overrides': value.fieldOverrides,
+        'html': value.html,
+        'metadata': value.metadata,
+        'password': value.password,
+        'test': value.test,
+    };
+}
+

package/src/models/CreateSubmissionDataRequestData.ts

@@ -0,0 +1,192 @@
+/* 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 CreateSubmissionDataRequestData
+ */
+export interface CreateSubmissionDataRequestData {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionDataRequestData
+     */
+    authPhoneNumberHash?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionDataRequestData
+     */
+    authProvider?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionDataRequestData
+     */
+    authSecondFactorType?: CreateSubmissionDataRequestDataAuthSecondFactorTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionDataRequestData
+     */
+    authSessionIdHash?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionDataRequestData
+     */
+    authSessionStartedAt?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionDataRequestData
+     */
+    authType: CreateSubmissionDataRequestDataAuthTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionDataRequestData
+     */
+    authUserIdHash?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionDataRequestData
+     */
+    authUsernameHash?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionDataRequestData
+     */
+    email: string | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CreateSubmissionDataRequestData
+     */
+    fields?: Array<string> | null;
+    /**
+     * 
+     * @type {object}
+     * @memberof CreateSubmissionDataRequestData
+     */
+    metadata?: object;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubmissionDataRequestData
+     */
+    name?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateSubmissionDataRequestData
+     */
+    order?: number;
+}
+
+
+/**
+ * @export
+ */
+export const CreateSubmissionDataRequestDataAuthSecondFactorTypeEnum = {
+    None: 'none',
+    PhoneNumber: 'phone_number',
+    Totp: 'totp',
+    MobilePush: 'mobile_push',
+    SecurityKey: 'security_key',
+    Fingerprint: 'fingerprint'
+} as const;
+export type CreateSubmissionDataRequestDataAuthSecondFactorTypeEnum = typeof CreateSubmissionDataRequestDataAuthSecondFactorTypeEnum[keyof typeof CreateSubmissionDataRequestDataAuthSecondFactorTypeEnum];
+
+/**
+ * @export
+ */
+export const CreateSubmissionDataRequestDataAuthTypeEnum = {
+    None: 'none',
+    Password: 'password',
+    Oauth: 'oauth',
+    EmailLink: 'email_link',
+    PhoneNumber: 'phone_number',
+    Ldap: 'ldap',
+    Saml: 'saml'
+} as const;
+export type CreateSubmissionDataRequestDataAuthTypeEnum = typeof CreateSubmissionDataRequestDataAuthTypeEnum[keyof typeof CreateSubmissionDataRequestDataAuthTypeEnum];
+
+
+/**
+ * Check if a given object implements the CreateSubmissionDataRequestData interface.
+ */
+export function instanceOfCreateSubmissionDataRequestData(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "authType" in value;
+    isInstance = isInstance && "email" in value;
+
+    return isInstance;
+}
+
+export function CreateSubmissionDataRequestDataFromJSON(json: any): CreateSubmissionDataRequestData {
+    return CreateSubmissionDataRequestDataFromJSONTyped(json, false);
+}
+
+export function CreateSubmissionDataRequestDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSubmissionDataRequestData {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'authPhoneNumberHash': !exists(json, 'auth_phone_number_hash') ? undefined : json['auth_phone_number_hash'],
+        'authProvider': !exists(json, 'auth_provider') ? undefined : json['auth_provider'],
+        'authSecondFactorType': !exists(json, 'auth_second_factor_type') ? undefined : json['auth_second_factor_type'],
+        'authSessionIdHash': !exists(json, 'auth_session_id_hash') ? undefined : json['auth_session_id_hash'],
+        'authSessionStartedAt': !exists(json, 'auth_session_started_at') ? undefined : json['auth_session_started_at'],
+        'authType': json['auth_type'],
+        'authUserIdHash': !exists(json, 'auth_user_id_hash') ? undefined : json['auth_user_id_hash'],
+        'authUsernameHash': !exists(json, 'auth_username_hash') ? undefined : json['auth_username_hash'],
+        'email': json['email'],
+        'fields': !exists(json, 'fields') ? undefined : json['fields'],
+        'metadata': !exists(json, 'metadata') ? undefined : json['metadata'],
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'order': !exists(json, 'order') ? undefined : json['order'],
+    };
+}
+
+export function CreateSubmissionDataRequestDataToJSON(value?: CreateSubmissionDataRequestData | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'auth_phone_number_hash': value.authPhoneNumberHash,
+        'auth_provider': value.authProvider,
+        'auth_second_factor_type': value.authSecondFactorType,
+        'auth_session_id_hash': value.authSessionIdHash,
+        'auth_session_started_at': value.authSessionStartedAt,
+        'auth_type': value.authType,
+        'auth_user_id_hash': value.authUserIdHash,
+        'auth_username_hash': value.authUsernameHash,
+        'email': value.email,
+        'fields': value.fields,
+        'metadata': value.metadata,
+        'name': value.name,
+        'order': value.order,
+    };
+}
+