@apideck/node
Version:
Apideck Node.js SDK
132 lines (131 loc) • 3.65 kB
TypeScript
/**
* Apideck
* The Apideck OpenAPI Spec: SDK Optimized
*
* The version of the OpenAPI document: 10.13.0
* Contact: support@apideck.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { FormFieldOption } from './FormFieldOption';
/**
*
* @export
* @interface FormField
*/
export interface FormField {
/**
* The unique identifier of the form field.
* @type {string}
* @memberof FormField
*/
id?: string;
/**
* The label of the field
* @type {string}
* @memberof FormField
*/
label?: string;
/**
* The placeholder for the form field
* @type {string}
* @memberof FormField
*/
placeholder?: string | null;
/**
* The description of the form field
* @type {string}
* @memberof FormField
*/
description?: string | null;
/**
*
* @type {string}
* @memberof FormField
*/
type?: FormFieldType;
/**
* Indicates if the form field is required, which means it must be filled in before the form can be submitted
* @type {boolean}
* @memberof FormField
*/
required?: boolean;
/**
*
* @type {boolean}
* @memberof FormField
*/
custom_field?: boolean;
/**
* Only applicable to select fields. Allow the user to add a custom value though the option select if the desired value is not in the option select list.
* @type {boolean}
* @memberof FormField
*/
allow_custom_values?: boolean;
/**
* Indicates if the form field is displayed in a “read-only” mode.
* @type {boolean}
* @memberof FormField
*/
disabled?: boolean | null;
/**
* Indicates if the form field is not displayed but the value that is being stored on the connection.
* @type {boolean}
* @memberof FormField
*/
hidden?: boolean | null;
/**
* When the setting is deprecated, it should be hidden from the user interface. The value will still be stored on the connection for the sake of backwards compatibility.
* @type {boolean}
* @memberof FormField
*/
deprecated?: boolean | null;
/**
* Indicates if the form field contains sensitive data, which will display the value as a masked input.
* @type {boolean}
* @memberof FormField
*/
sensitive?: boolean | null;
/**
* Prefix to display in front of the form field.
* @type {string}
* @memberof FormField
*/
prefix?: string | null;
/**
* Suffix to display next to the form field.
* @type {string}
* @memberof FormField
*/
suffix?: string | null;
/**
*
* @type {Array<FormFieldOption>}
* @memberof FormField
*/
options?: Array<FormFieldOption>;
}
/**
* @export
* @enum {string}
*/
export declare enum FormFieldType {
text = "text",
checkbox = "checkbox",
tel = "tel",
email = "email",
url = "url",
textarea = "textarea",
select = "select",
filtered_select = "filtered-select",
multi_select = "multi-select",
datetime = "datetime",
date = "date",
time = "time",
number = "number"
}
export declare function FormFieldFromJSON(json: any): FormField;
export declare function FormFieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): FormField;
export declare function FormFieldToJSON(value?: FormField | null): any;