box-node-sdk/lib/schemas/templateSignerInput.d.ts

Official SDK for Box Platform APIs

import { SignRequestPrefillTag } from './signRequestPrefillTag';
import { SignRequestSignerInputValidation } from './signRequestSignerInputValidation';
import { SerializedData } from '../serialization/json';
export type TemplateSignerInputTypeField = 'signature' | 'date' | 'text' | 'checkbox' | 'attachment' | 'radio' | 'dropdown';
export type TemplateSignerInputContentTypeField = 'signature' | 'initial' | 'stamp' | 'date' | 'checkbox' | 'text' | 'full_name' | 'first_name' | 'last_name' | 'company' | 'title' | 'email' | 'attachment' | 'radio' | 'dropdown' | string;
export interface TemplateSignerInputCoordinatesField {
    /**
     * Relative x coordinate to the page the input is on, ranging from 0 to 1. */
    readonly x?: number;
    /**
     * Relative y coordinate to the page the input is on, ranging from 0 to 1. */
    readonly y?: number;
    readonly rawData?: SerializedData;
}
export interface TemplateSignerInputDimensionsField {
    /**
     * Relative width to the page the input is on, ranging from 0 to 1. */
    readonly width?: number;
    /**
     * Relative height to the page the input is on, ranging from 0 to 1. */
    readonly height?: number;
    readonly rawData?: SerializedData;
}
export type TemplateSignerInput = SignRequestPrefillTag & {
    /**
     * Type of input. */
    readonly type?: TemplateSignerInputTypeField;
    /**
     * Content type of input. */
    readonly contentType?: TemplateSignerInputContentTypeField;
    /**
     * Whether or not the input is required. */
    readonly isRequired?: boolean;
    /**
     * Index of page that the input is on. */
    readonly pageIndex: number;
    /**
     * Document identifier. */
    readonly documentId?: string | null;
    /**
     * When the input is of the type `dropdown` this
     * values will be filled with all the
     * dropdown options. */
    readonly dropdownChoices?: readonly string[] | null;
    /**
     * When the input is of type `radio` they can be
     * grouped to gather with this identifier. */
    readonly groupId?: string | null;
    /**
     * Where the input is located on a page. */
    readonly coordinates?: TemplateSignerInputCoordinatesField;
    /**
     * The size of the input. */
    readonly dimensions?: TemplateSignerInputDimensionsField;
    /**
     * The label field is used especially for text, attachment, radio, and checkbox type inputs. */
    readonly label?: string | null;
    /**
     * Indicates whether this input is read-only (cannot be modified by signers). */
    readonly readOnly?: boolean;
    /**
     * Specifies the formatting rules that signers must follow for text field inputs.
     * If set, this validation is mandatory. */
    readonly validation?: SignRequestSignerInputValidation;
};
export declare function serializeTemplateSignerInputTypeField(val: TemplateSignerInputTypeField): SerializedData;
export declare function deserializeTemplateSignerInputTypeField(val: SerializedData): TemplateSignerInputTypeField;
export declare function serializeTemplateSignerInputContentTypeField(val: TemplateSignerInputContentTypeField): SerializedData;
export declare function deserializeTemplateSignerInputContentTypeField(val: SerializedData): TemplateSignerInputContentTypeField;
export declare function serializeTemplateSignerInputCoordinatesField(val: TemplateSignerInputCoordinatesField): SerializedData;
export declare function deserializeTemplateSignerInputCoordinatesField(val: SerializedData): TemplateSignerInputCoordinatesField;
export declare function serializeTemplateSignerInputDimensionsField(val: TemplateSignerInputDimensionsField): SerializedData;
export declare function deserializeTemplateSignerInputDimensionsField(val: SerializedData): TemplateSignerInputDimensionsField;
export declare function serializeTemplateSignerInput(val: TemplateSignerInput): SerializedData;
export declare function deserializeTemplateSignerInput(val: SerializedData): TemplateSignerInput;
//# sourceMappingURL=templateSignerInput.d.ts.map