docspring-ts 1.0.0 → 1.0.2

package/src/models/TemplateDocumentMetadata.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 TemplateDocumentMetadata
+ */
+export interface TemplateDocumentMetadata {
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateDocumentMetadata
+     */
+    filename: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateDocumentMetadata
+     */
+    mimeType: TemplateDocumentMetadataMimeTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof TemplateDocumentMetadata
+     */
+    size: number;
+}
+
+
+/**
+ * @export
+ */
+export const TemplateDocumentMetadataMimeTypeEnum = {
+    ApplicationPdf: 'application/pdf'
+} as const;
+export type TemplateDocumentMetadataMimeTypeEnum = typeof TemplateDocumentMetadataMimeTypeEnum[keyof typeof TemplateDocumentMetadataMimeTypeEnum];
+
+
+/**
+ * Check if a given object implements the TemplateDocumentMetadata interface.
+ */
+export function instanceOfTemplateDocumentMetadata(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "filename" in value;
+    isInstance = isInstance && "mimeType" in value;
+    isInstance = isInstance && "size" in value;
+
+    return isInstance;
+}
+
+export function TemplateDocumentMetadataFromJSON(json: any): TemplateDocumentMetadata {
+    return TemplateDocumentMetadataFromJSONTyped(json, false);
+}
+
+export function TemplateDocumentMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemplateDocumentMetadata {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'filename': json['filename'],
+        'mimeType': json['mime_type'],
+        'size': json['size'],
+    };
+}
+
+export function TemplateDocumentMetadataToJSON(value?: TemplateDocumentMetadata | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'filename': value.filename,
+        'mime_type': value.mimeType,
+        'size': value.size,
+    };
+}
+

package/src/models/UpdateDataRequestResponse.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 { SubmissionDataRequest } from './SubmissionDataRequest';
+import {
+    SubmissionDataRequestFromJSON,
+    SubmissionDataRequestFromJSONTyped,
+    SubmissionDataRequestToJSON,
+} from './SubmissionDataRequest';
+
+/**
+ * 
+ * @export
+ * @interface UpdateDataRequestResponse
+ */
+export interface UpdateDataRequestResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateDataRequestResponse
+     */
+    status: UpdateDataRequestResponseStatusEnum;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof UpdateDataRequestResponse
+     */
+    errors?: Array<string>;
+    /**
+     * 
+     * @type {SubmissionDataRequest}
+     * @memberof UpdateDataRequestResponse
+     */
+    dataRequest: SubmissionDataRequest;
+}
+
+
+/**
+ * @export
+ */
+export const UpdateDataRequestResponseStatusEnum = {
+    Success: 'success',
+    Error: 'error'
+} as const;
+export type UpdateDataRequestResponseStatusEnum = typeof UpdateDataRequestResponseStatusEnum[keyof typeof UpdateDataRequestResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the UpdateDataRequestResponse interface.
+ */
+export function instanceOfUpdateDataRequestResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "status" in value;
+    isInstance = isInstance && "dataRequest" in value;
+
+    return isInstance;
+}
+
+export function UpdateDataRequestResponseFromJSON(json: any): UpdateDataRequestResponse {
+    return UpdateDataRequestResponseFromJSONTyped(json, false);
+}
+
+export function UpdateDataRequestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateDataRequestResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+        'errors': !exists(json, 'errors') ? undefined : json['errors'],
+        'dataRequest': SubmissionDataRequestFromJSON(json['data_request']),
+    };
+}
+
+export function UpdateDataRequestResponseToJSON(value?: UpdateDataRequestResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'status': value.status,
+        'errors': value.errors,
+        'data_request': SubmissionDataRequestToJSON(value.dataRequest),
+    };
+}
+

package/src/models/UpdateSubmissionDataRequestData.ts

@@ -0,0 +1,190 @@
+/* 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 UpdateSubmissionDataRequestData
+ */
+export interface UpdateSubmissionDataRequestData {
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSubmissionDataRequestData
+     */
+    authPhoneNumberHash?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSubmissionDataRequestData
+     */
+    authProvider?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSubmissionDataRequestData
+     */
+    authSecondFactorType?: UpdateSubmissionDataRequestDataAuthSecondFactorTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSubmissionDataRequestData
+     */
+    authSessionIdHash?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSubmissionDataRequestData
+     */
+    authSessionStartedAt?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSubmissionDataRequestData
+     */
+    authType?: UpdateSubmissionDataRequestDataAuthTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSubmissionDataRequestData
+     */
+    authUserIdHash?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSubmissionDataRequestData
+     */
+    authUsernameHash?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSubmissionDataRequestData
+     */
+    email?: string | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof UpdateSubmissionDataRequestData
+     */
+    fields?: Array<string>;
+    /**
+     * 
+     * @type {object}
+     * @memberof UpdateSubmissionDataRequestData
+     */
+    metadata?: object;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSubmissionDataRequestData
+     */
+    name?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof UpdateSubmissionDataRequestData
+     */
+    order?: number;
+}
+
+
+/**
+ * @export
+ */
+export const UpdateSubmissionDataRequestDataAuthSecondFactorTypeEnum = {
+    None: 'none',
+    PhoneNumber: 'phone_number',
+    Totp: 'totp',
+    MobilePush: 'mobile_push',
+    SecurityKey: 'security_key',
+    Fingerprint: 'fingerprint'
+} as const;
+export type UpdateSubmissionDataRequestDataAuthSecondFactorTypeEnum = typeof UpdateSubmissionDataRequestDataAuthSecondFactorTypeEnum[keyof typeof UpdateSubmissionDataRequestDataAuthSecondFactorTypeEnum];
+
+/**
+ * @export
+ */
+export const UpdateSubmissionDataRequestDataAuthTypeEnum = {
+    None: 'none',
+    Password: 'password',
+    Oauth: 'oauth',
+    EmailLink: 'email_link',
+    PhoneNumber: 'phone_number',
+    Ldap: 'ldap',
+    Saml: 'saml'
+} as const;
+export type UpdateSubmissionDataRequestDataAuthTypeEnum = typeof UpdateSubmissionDataRequestDataAuthTypeEnum[keyof typeof UpdateSubmissionDataRequestDataAuthTypeEnum];
+
+
+/**
+ * Check if a given object implements the UpdateSubmissionDataRequestData interface.
+ */
+export function instanceOfUpdateSubmissionDataRequestData(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function UpdateSubmissionDataRequestDataFromJSON(json: any): UpdateSubmissionDataRequestData {
+    return UpdateSubmissionDataRequestDataFromJSONTyped(json, false);
+}
+
+export function UpdateSubmissionDataRequestDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSubmissionDataRequestData {
+    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': !exists(json, 'auth_type') ? undefined : 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': !exists(json, 'email') ? undefined : 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 UpdateSubmissionDataRequestDataToJSON(value?: UpdateSubmissionDataRequestData | 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,
+    };
+}
+

package/src/models/UpdateTemplateData.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 { TemplateData } from './TemplateData';
+import {
+    TemplateDataFromJSON,
+    TemplateDataFromJSONTyped,
+    TemplateDataToJSON,
+} from './TemplateData';
+
+/**
+ * 
+ * @export
+ * @interface UpdateTemplateData
+ */
+export interface UpdateTemplateData {
+    /**
+     * 
+     * @type {TemplateData}
+     * @memberof UpdateTemplateData
+     */
+    template: TemplateData;
+}
+
+/**
+ * Check if a given object implements the UpdateTemplateData interface.
+ */
+export function instanceOfUpdateTemplateData(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "template" in value;
+
+    return isInstance;
+}
+
+export function UpdateTemplateDataFromJSON(json: any): UpdateTemplateData {
+    return UpdateTemplateDataFromJSONTyped(json, false);
+}
+
+export function UpdateTemplateDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateTemplateData {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'template': TemplateDataFromJSON(json['template']),
+    };
+}
+
+export function UpdateTemplateDataToJSON(value?: UpdateTemplateData | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'template': TemplateDataToJSON(value.template),
+    };
+}
+

package/src/models/UpdateTemplateResponse.ts

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