docspring-ts 1.0.0 → 1.0.2

package/dist/models/UploadTemplateData.d.ts

@@ -0,0 +1,151 @@
+/**
+ * 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 type { TemplateDocument } from './TemplateDocument';
+/**
+ *
+ * @export
+ * @interface UploadTemplateData
+ */
+export interface UploadTemplateData {
+    /**
+     *
+     * @type {boolean}
+     * @memberof UploadTemplateData
+     */
+    allowAdditionalProperties?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof UploadTemplateData
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {TemplateDocument}
+     * @memberof UploadTemplateData
+     */
+    document?: TemplateDocument;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UploadTemplateData
+     */
+    editableSubmissions?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof UploadTemplateData
+     */
+    expirationInterval?: UploadTemplateDataExpirationIntervalEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof UploadTemplateData
+     */
+    expireAfter?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UploadTemplateData
+     */
+    expireSubmissions?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof UploadTemplateData
+     */
+    footerHtml?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UploadTemplateData
+     */
+    headerHtml?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UploadTemplateData
+     */
+    html?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UploadTemplateData
+     */
+    name: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UploadTemplateData
+     */
+    publicSubmissions?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UploadTemplateData
+     */
+    publicWebForm?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof UploadTemplateData
+     */
+    redirectUrl?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UploadTemplateData
+     */
+    scss?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UploadTemplateData
+     */
+    slackWebhookUrl?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UploadTemplateData
+     */
+    templateType?: UploadTemplateDataTemplateTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof UploadTemplateData
+     */
+    webhookUrl?: string | null;
+}
+/**
+ * @export
+ */
+export declare const UploadTemplateDataExpirationIntervalEnum: {
+    readonly Minutes: "minutes";
+    readonly Hours: "hours";
+    readonly Days: "days";
+};
+export type UploadTemplateDataExpirationIntervalEnum = typeof UploadTemplateDataExpirationIntervalEnum[keyof typeof UploadTemplateDataExpirationIntervalEnum];
+/**
+ * @export
+ */
+export declare const UploadTemplateDataTemplateTypeEnum: {
+    readonly Pdf: "pdf";
+    readonly Html: "html";
+};
+export type UploadTemplateDataTemplateTypeEnum = typeof UploadTemplateDataTemplateTypeEnum[keyof typeof UploadTemplateDataTemplateTypeEnum];
+/**
+ * Check if a given object implements the UploadTemplateData interface.
+ */
+export declare function instanceOfUploadTemplateData(value: object): boolean;
+export declare function UploadTemplateDataFromJSON(json: any): UploadTemplateData;
+export declare function UploadTemplateDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadTemplateData;
+export declare function UploadTemplateDataToJSON(value?: UploadTemplateData | null): any;

package/dist/models/UploadTemplateData.js

@@ -0,0 +1,101 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadTemplateDataToJSON = exports.UploadTemplateDataFromJSONTyped = exports.UploadTemplateDataFromJSON = exports.instanceOfUploadTemplateData = exports.UploadTemplateDataTemplateTypeEnum = exports.UploadTemplateDataExpirationIntervalEnum = void 0;
+var runtime_1 = require("../runtime");
+var TemplateDocument_1 = require("./TemplateDocument");
+/**
+ * @export
+ */
+exports.UploadTemplateDataExpirationIntervalEnum = {
+    Minutes: 'minutes',
+    Hours: 'hours',
+    Days: 'days'
+};
+/**
+ * @export
+ */
+exports.UploadTemplateDataTemplateTypeEnum = {
+    Pdf: 'pdf',
+    Html: 'html'
+};
+/**
+ * Check if a given object implements the UploadTemplateData interface.
+ */
+function instanceOfUploadTemplateData(value) {
+    var isInstance = true;
+    isInstance = isInstance && "name" in value;
+    return isInstance;
+}
+exports.instanceOfUploadTemplateData = instanceOfUploadTemplateData;
+function UploadTemplateDataFromJSON(json) {
+    return UploadTemplateDataFromJSONTyped(json, false);
+}
+exports.UploadTemplateDataFromJSON = UploadTemplateDataFromJSON;
+function UploadTemplateDataFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'allowAdditionalProperties': !(0, runtime_1.exists)(json, 'allow_additional_properties') ? undefined : json['allow_additional_properties'],
+        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
+        'document': !(0, runtime_1.exists)(json, 'document') ? undefined : (0, TemplateDocument_1.TemplateDocumentFromJSON)(json['document']),
+        'editableSubmissions': !(0, runtime_1.exists)(json, 'editable_submissions') ? undefined : json['editable_submissions'],
+        'expirationInterval': !(0, runtime_1.exists)(json, 'expiration_interval') ? undefined : json['expiration_interval'],
+        'expireAfter': !(0, runtime_1.exists)(json, 'expire_after') ? undefined : json['expire_after'],
+        'expireSubmissions': !(0, runtime_1.exists)(json, 'expire_submissions') ? undefined : json['expire_submissions'],
+        'footerHtml': !(0, runtime_1.exists)(json, 'footer_html') ? undefined : json['footer_html'],
+        'headerHtml': !(0, runtime_1.exists)(json, 'header_html') ? undefined : json['header_html'],
+        'html': !(0, runtime_1.exists)(json, 'html') ? undefined : json['html'],
+        'name': json['name'],
+        'publicSubmissions': !(0, runtime_1.exists)(json, 'public_submissions') ? undefined : json['public_submissions'],
+        'publicWebForm': !(0, runtime_1.exists)(json, 'public_web_form') ? undefined : json['public_web_form'],
+        'redirectUrl': !(0, runtime_1.exists)(json, 'redirect_url') ? undefined : json['redirect_url'],
+        'scss': !(0, runtime_1.exists)(json, 'scss') ? undefined : json['scss'],
+        'slackWebhookUrl': !(0, runtime_1.exists)(json, 'slack_webhook_url') ? undefined : json['slack_webhook_url'],
+        'templateType': !(0, runtime_1.exists)(json, 'template_type') ? undefined : json['template_type'],
+        'webhookUrl': !(0, runtime_1.exists)(json, 'webhook_url') ? undefined : json['webhook_url'],
+    };
+}
+exports.UploadTemplateDataFromJSONTyped = UploadTemplateDataFromJSONTyped;
+function UploadTemplateDataToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'allow_additional_properties': value.allowAdditionalProperties,
+        'description': value.description,
+        'document': (0, TemplateDocument_1.TemplateDocumentToJSON)(value.document),
+        '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,
+        'template_type': value.templateType,
+        'webhook_url': value.webhookUrl,
+    };
+}
+exports.UploadTemplateDataToJSON = UploadTemplateDataToJSON;

package/dist/models/index.d.ts

@@ -0,0 +1,51 @@
+export * from './AddFieldsData';
+export * from './AddFieldsTemplateResponse';
+export * from './AuthenticationError';
+export * from './AuthenticationSuccessResponse';
+export * from './CombinePdfsData';
+export * from './CombinedSubmission';
+export * from './CombinedSubmissionAction';
+export * from './CombinedSubmissionData';
+export * from './CopyTemplateData';
+export * from './CreateCombinedSubmissionResponse';
+export * from './CreateCustomFileData';
+export * from './CreateCustomFileResponse';
+export * from './CreateFolderAttributes';
+export * from './CreateFolderData';
+export * from './CreateHtmlTemplateData';
+export * from './CreateSubmissionBatchResponse';
+export * from './CreateSubmissionBatchSubmissionsResponse';
+export * from './CreateSubmissionData';
+export * from './CreateSubmissionDataRequestData';
+export * from './CreateSubmissionDataRequestTokenResponse';
+export * from './CreateSubmissionResponse';
+export * from './CreateTemplateFromUploadData';
+export * from './DataRequestToken';
+export * from './DeleteTemplateResponse';
+export * from './ErrorResponse';
+export * from './Folder';
+export * from './FullTemplate';
+export * from './HtmlTemplateData';
+export * from './InvalidRequest';
+export * from './ListSubmissionsResponse';
+export * from './MoveFolderData';
+export * from './MoveTemplateData';
+export * from './PendingTemplate';
+export * from './RenameFolderData';
+export * from './Submission';
+export * from './SubmissionAction';
+export * from './SubmissionBatch';
+export * from './SubmissionBatchData';
+export * from './SubmissionData';
+export * from './SubmissionDataBatchRequest';
+export * from './SubmissionDataRequest';
+export * from './Template';
+export * from './TemplateData';
+export * from './TemplateDefaults';
+export * from './TemplateDocument';
+export * from './TemplateDocumentMetadata';
+export * from './UpdateDataRequestResponse';
+export * from './UpdateSubmissionDataRequestData';
+export * from './UpdateTemplateData';
+export * from './UpdateTemplateResponse';
+export * from './UploadTemplateData';

package/dist/models/index.js

@@ -0,0 +1,69 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./AddFieldsData"), exports);
+__exportStar(require("./AddFieldsTemplateResponse"), exports);
+__exportStar(require("./AuthenticationError"), exports);
+__exportStar(require("./AuthenticationSuccessResponse"), exports);
+__exportStar(require("./CombinePdfsData"), exports);
+__exportStar(require("./CombinedSubmission"), exports);
+__exportStar(require("./CombinedSubmissionAction"), exports);
+__exportStar(require("./CombinedSubmissionData"), exports);
+__exportStar(require("./CopyTemplateData"), exports);
+__exportStar(require("./CreateCombinedSubmissionResponse"), exports);
+__exportStar(require("./CreateCustomFileData"), exports);
+__exportStar(require("./CreateCustomFileResponse"), exports);
+__exportStar(require("./CreateFolderAttributes"), exports);
+__exportStar(require("./CreateFolderData"), exports);
+__exportStar(require("./CreateHtmlTemplateData"), exports);
+__exportStar(require("./CreateSubmissionBatchResponse"), exports);
+__exportStar(require("./CreateSubmissionBatchSubmissionsResponse"), exports);
+__exportStar(require("./CreateSubmissionData"), exports);
+__exportStar(require("./CreateSubmissionDataRequestData"), exports);
+__exportStar(require("./CreateSubmissionDataRequestTokenResponse"), exports);
+__exportStar(require("./CreateSubmissionResponse"), exports);
+__exportStar(require("./CreateTemplateFromUploadData"), exports);
+__exportStar(require("./DataRequestToken"), exports);
+__exportStar(require("./DeleteTemplateResponse"), exports);
+__exportStar(require("./ErrorResponse"), exports);
+__exportStar(require("./Folder"), exports);
+__exportStar(require("./FullTemplate"), exports);
+__exportStar(require("./HtmlTemplateData"), exports);
+__exportStar(require("./InvalidRequest"), exports);
+__exportStar(require("./ListSubmissionsResponse"), exports);
+__exportStar(require("./MoveFolderData"), exports);
+__exportStar(require("./MoveTemplateData"), exports);
+__exportStar(require("./PendingTemplate"), exports);
+__exportStar(require("./RenameFolderData"), exports);
+__exportStar(require("./Submission"), exports);
+__exportStar(require("./SubmissionAction"), exports);
+__exportStar(require("./SubmissionBatch"), exports);
+__exportStar(require("./SubmissionBatchData"), exports);
+__exportStar(require("./SubmissionData"), exports);
+__exportStar(require("./SubmissionDataBatchRequest"), exports);
+__exportStar(require("./SubmissionDataRequest"), exports);
+__exportStar(require("./Template"), exports);
+__exportStar(require("./TemplateData"), exports);
+__exportStar(require("./TemplateDefaults"), exports);
+__exportStar(require("./TemplateDocument"), exports);
+__exportStar(require("./TemplateDocumentMetadata"), exports);
+__exportStar(require("./UpdateDataRequestResponse"), exports);
+__exportStar(require("./UpdateSubmissionDataRequestData"), exports);
+__exportStar(require("./UpdateTemplateData"), exports);
+__exportStar(require("./UpdateTemplateResponse"), exports);
+__exportStar(require("./UploadTemplateData"), exports);

package/dist/runtime.d.ts

@@ -0,0 +1,182 @@
+/**
+ * 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.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | ((name: string) => string);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function exists(json: any, key: string): boolean;
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function mapValues(data: any, fn: (item: any) => any): {};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}