docspring-ts 1.0.0 → 1.0.2

package/src/models/Template.ts

@@ -0,0 +1,249 @@
+/* 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 Template
+ */
+export interface Template {
+    /**
+     * 
+     * @type {string}
+     * @memberof Template
+     */
+    name: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Template
+     */
+    description: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Template
+     */
+    publicWebForm: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Template
+     */
+    publicSubmissions: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Template
+     */
+    expireSubmissions: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof Template
+     */
+    expireAfter: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof Template
+     */
+    expirationInterval: TemplateExpirationIntervalEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Template
+     */
+    allowAdditionalProperties: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Template
+     */
+    editableSubmissions: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Template
+     */
+    locked: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof Template
+     */
+    webhookUrl: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Template
+     */
+    slackWebhookUrl: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Template
+     */
+    redirectUrl: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Template
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Template
+     */
+    templateType: string;
+    /**
+     * 
+     * @type {Array<Array<number>>}
+     * @memberof Template
+     */
+    pageDimensions: Array<Array<number>> | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Template
+     */
+    documentUrl: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Template
+     */
+    permanentDocumentUrl: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Template
+     */
+    path: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Template
+     */
+    parentFolderId: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const TemplateExpirationIntervalEnum = {
+    Minutes: 'minutes',
+    Hours: 'hours',
+    Days: 'days'
+} as const;
+export type TemplateExpirationIntervalEnum = typeof TemplateExpirationIntervalEnum[keyof typeof TemplateExpirationIntervalEnum];
+
+
+/**
+ * Check if a given object implements the Template interface.
+ */
+export function instanceOfTemplate(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "publicWebForm" in value;
+    isInstance = isInstance && "publicSubmissions" in value;
+    isInstance = isInstance && "expireSubmissions" in value;
+    isInstance = isInstance && "expireAfter" in value;
+    isInstance = isInstance && "expirationInterval" in value;
+    isInstance = isInstance && "allowAdditionalProperties" in value;
+    isInstance = isInstance && "editableSubmissions" in value;
+    isInstance = isInstance && "locked" in value;
+    isInstance = isInstance && "webhookUrl" in value;
+    isInstance = isInstance && "slackWebhookUrl" in value;
+    isInstance = isInstance && "redirectUrl" in value;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "templateType" in value;
+    isInstance = isInstance && "pageDimensions" in value;
+    isInstance = isInstance && "documentUrl" in value;
+    isInstance = isInstance && "permanentDocumentUrl" in value;
+    isInstance = isInstance && "path" in value;
+    isInstance = isInstance && "parentFolderId" in value;
+
+    return isInstance;
+}
+
+export function TemplateFromJSON(json: any): Template {
+    return TemplateFromJSONTyped(json, false);
+}
+
+export function TemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): Template {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'],
+        'publicWebForm': json['public_web_form'],
+        'publicSubmissions': json['public_submissions'],
+        'expireSubmissions': json['expire_submissions'],
+        'expireAfter': json['expire_after'],
+        'expirationInterval': json['expiration_interval'],
+        'allowAdditionalProperties': json['allow_additional_properties'],
+        'editableSubmissions': json['editable_submissions'],
+        'locked': json['locked'],
+        'webhookUrl': json['webhook_url'],
+        'slackWebhookUrl': json['slack_webhook_url'],
+        'redirectUrl': json['redirect_url'],
+        'id': json['id'],
+        'templateType': json['template_type'],
+        'pageDimensions': json['page_dimensions'],
+        'documentUrl': json['document_url'],
+        'permanentDocumentUrl': json['permanent_document_url'],
+        'path': json['path'],
+        'parentFolderId': json['parent_folder_id'],
+    };
+}
+
+export function TemplateToJSON(value?: Template | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'description': value.description,
+        'public_web_form': value.publicWebForm,
+        'public_submissions': value.publicSubmissions,
+        'expire_submissions': value.expireSubmissions,
+        'expire_after': value.expireAfter,
+        'expiration_interval': value.expirationInterval,
+        'allow_additional_properties': value.allowAdditionalProperties,
+        'editable_submissions': value.editableSubmissions,
+        'locked': value.locked,
+        'webhook_url': value.webhookUrl,
+        'slack_webhook_url': value.slackWebhookUrl,
+        'redirect_url': value.redirectUrl,
+        'id': value.id,
+        'template_type': value.templateType,
+        'page_dimensions': value.pageDimensions,
+        'document_url': value.documentUrl,
+        'permanent_document_url': value.permanentDocumentUrl,
+        'path': value.path,
+        'parent_folder_id': value.parentFolderId,
+    };
+}
+

package/src/models/TemplateData.ts

@@ -0,0 +1,197 @@
+/* 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 TemplateData
+ */
+export interface TemplateData {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof TemplateData
+     */
+    allowAdditionalProperties?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateData
+     */
+    description?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof TemplateData
+     */
+    editableSubmissions?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateData
+     */
+    expirationInterval?: TemplateDataExpirationIntervalEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof TemplateData
+     */
+    expireAfter?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof TemplateData
+     */
+    expireSubmissions?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateData
+     */
+    footerHtml?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateData
+     */
+    headerHtml?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateData
+     */
+    html?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateData
+     */
+    name?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof TemplateData
+     */
+    publicSubmissions?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof TemplateData
+     */
+    publicWebForm?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateData
+     */
+    redirectUrl?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateData
+     */
+    scss?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateData
+     */
+    slackWebhookUrl?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateData
+     */
+    webhookUrl?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const TemplateDataExpirationIntervalEnum = {
+    Minutes: 'minutes',
+    Hours: 'hours',
+    Days: 'days'
+} as const;
+export type TemplateDataExpirationIntervalEnum = typeof TemplateDataExpirationIntervalEnum[keyof typeof TemplateDataExpirationIntervalEnum];
+
+
+/**
+ * Check if a given object implements the TemplateData interface.
+ */
+export function instanceOfTemplateData(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function TemplateDataFromJSON(json: any): TemplateData {
+    return TemplateDataFromJSONTyped(json, false);
+}
+
+export function TemplateDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemplateData {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'allowAdditionalProperties': !exists(json, 'allow_additional_properties') ? undefined : json['allow_additional_properties'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
+        'editableSubmissions': !exists(json, 'editable_submissions') ? undefined : json['editable_submissions'],
+        'expirationInterval': !exists(json, 'expiration_interval') ? undefined : json['expiration_interval'],
+        'expireAfter': !exists(json, 'expire_after') ? undefined : json['expire_after'],
+        'expireSubmissions': !exists(json, 'expire_submissions') ? undefined : json['expire_submissions'],
+        'footerHtml': !exists(json, 'footer_html') ? undefined : json['footer_html'],
+        'headerHtml': !exists(json, 'header_html') ? undefined : json['header_html'],
+        'html': !exists(json, 'html') ? undefined : json['html'],
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'publicSubmissions': !exists(json, 'public_submissions') ? undefined : json['public_submissions'],
+        'publicWebForm': !exists(json, 'public_web_form') ? undefined : json['public_web_form'],
+        'redirectUrl': !exists(json, 'redirect_url') ? undefined : json['redirect_url'],
+        'scss': !exists(json, 'scss') ? undefined : json['scss'],
+        'slackWebhookUrl': !exists(json, 'slack_webhook_url') ? undefined : json['slack_webhook_url'],
+        'webhookUrl': !exists(json, 'webhook_url') ? undefined : json['webhook_url'],
+    };
+}
+
+export function TemplateDataToJSON(value?: TemplateData | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'allow_additional_properties': value.allowAdditionalProperties,
+        'description': value.description,
+        'editable_submissions': value.editableSubmissions,
+        'expiration_interval': value.expirationInterval,
+        'expire_after': value.expireAfter,
+        'expire_submissions': value.expireSubmissions,
+        'footer_html': value.footerHtml,
+        'header_html': value.headerHtml,
+        'html': value.html,
+        'name': value.name,
+        'public_submissions': value.publicSubmissions,
+        'public_web_form': value.publicWebForm,
+        'redirect_url': value.redirectUrl,
+        'scss': value.scss,
+        'slack_webhook_url': value.slackWebhookUrl,
+        'webhook_url': value.webhookUrl,
+    };
+}
+

package/src/models/TemplateDefaults.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 TemplateDefaults
+ */
+export interface TemplateDefaults {
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateDefaults
+     */
+    color: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof TemplateDefaults
+     */
+    fontSize: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateDefaults
+     */
+    typeface: string;
+}
+
+/**
+ * Check if a given object implements the TemplateDefaults interface.
+ */
+export function instanceOfTemplateDefaults(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "color" in value;
+    isInstance = isInstance && "fontSize" in value;
+    isInstance = isInstance && "typeface" in value;
+
+    return isInstance;
+}
+
+export function TemplateDefaultsFromJSON(json: any): TemplateDefaults {
+    return TemplateDefaultsFromJSONTyped(json, false);
+}
+
+export function TemplateDefaultsFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemplateDefaults {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'color': json['color'],
+        'fontSize': json['fontSize'],
+        'typeface': json['typeface'],
+    };
+}
+
+export function TemplateDefaultsToJSON(value?: TemplateDefaults | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'color': value.color,
+        'fontSize': value.fontSize,
+        'typeface': value.typeface,
+    };
+}
+

package/src/models/TemplateDocument.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 { TemplateDocumentMetadata } from './TemplateDocumentMetadata';
+import {
+    TemplateDocumentMetadataFromJSON,
+    TemplateDocumentMetadataFromJSONTyped,
+    TemplateDocumentMetadataToJSON,
+} from './TemplateDocumentMetadata';
+
+/**
+ * 
+ * @export
+ * @interface TemplateDocument
+ */
+export interface TemplateDocument {
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateDocument
+     */
+    id: string;
+    /**
+     * 
+     * @type {TemplateDocumentMetadata}
+     * @memberof TemplateDocument
+     */
+    metadata: TemplateDocumentMetadata;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateDocument
+     */
+    storage: TemplateDocumentStorageEnum;
+}
+
+
+/**
+ * @export
+ */
+export const TemplateDocumentStorageEnum = {
+    Cache: 'cache'
+} as const;
+export type TemplateDocumentStorageEnum = typeof TemplateDocumentStorageEnum[keyof typeof TemplateDocumentStorageEnum];
+
+
+/**
+ * Check if a given object implements the TemplateDocument interface.
+ */
+export function instanceOfTemplateDocument(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "metadata" in value;
+    isInstance = isInstance && "storage" in value;
+
+    return isInstance;
+}
+
+export function TemplateDocumentFromJSON(json: any): TemplateDocument {
+    return TemplateDocumentFromJSONTyped(json, false);
+}
+
+export function TemplateDocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemplateDocument {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'metadata': TemplateDocumentMetadataFromJSON(json['metadata']),
+        'storage': json['storage'],
+    };
+}
+
+export function TemplateDocumentToJSON(value?: TemplateDocument | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'metadata': TemplateDocumentMetadataToJSON(value.metadata),
+        'storage': value.storage,
+    };
+}
+