/** * Pipedrive API v1 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface Field */ export interface Field { /** * The ID of the field. Value is `null` in case of subfields. * @type {number} */ 'id'?: number | null; /** * The key of the field. For custom fields this is generated upon creation. * @type {string} */ 'key'?: string; /** * The name of the field * @type {string} */ 'name'?: string; /** * The order number of the field * @type {number} */ 'order_nr'?: number; /** * The type of the field
ValueDescription
`address`Address field
`date`Date (format YYYY-MM-DD)
`daterange`Date-range field (has a start date and end date value, both YYYY-MM-DD)
`double`Numeric value
`enum`Options field with a single possible chosen option
`monetary`Monetary field (has a numeric value and a currency value)
`org`Organization field (contains an organization ID which is stored on the same account)
`people`Person field (contains a person ID which is stored on the same account)
`phone`Phone field (up to 255 numbers and/or characters)
`set`Options field with a possibility of having multiple chosen options
`text`Long text (up to 65k characters)
`time`Time field (format HH:MM:SS)
`timerange`Time-range field (has a start time and end time value, both HH:MM:SS)
`user`User field (contains a user ID of another Pipedrive user)
`varchar`Text (up to 255 characters)
`varchar_auto`Autocomplete text (up to 255 characters)
`visible_to`System field that keeps item\'s visibility setting
* @type {string} */ 'field_type'?: FieldFieldTypeConst; /** * The creation time of the field * @type {string} */ 'add_time'?: string; /** * The update time of the field * @type {string} */ 'update_time'?: string | null; /** * The ID of the user who created or most recently updated the field, only applicable for custom fields * @type {number} */ 'last_updated_by_user_id'?: number | null; /** * The ID of the user who created the field * @type {number} */ 'created_by_user_id'?: number | null; /** * The active flag of the field * @type {boolean} */ 'active_flag'?: boolean; /** * The edit flag of the field * @type {boolean} */ 'edit_flag'?: boolean; /** * Not used * @type {boolean} */ 'index_visible_flag'?: boolean; /** * Not used * @type {boolean} */ 'details_visible_flag'?: boolean; /** * Not used * @type {boolean} */ 'add_visible_flag'?: boolean; /** * Not used * @type {boolean} */ 'important_flag'?: boolean; /** * Whether or not the field of an item can be edited in bulk * @type {boolean} */ 'bulk_edit_allowed'?: boolean; /** * Whether or not items can be searched by this field * @type {boolean} */ 'searchable_flag'?: boolean; /** * Whether or not items can be filtered by this field * @type {boolean} */ 'filtering_allowed'?: boolean; /** * Whether or not items can be sorted by this field * @type {boolean} */ 'sortable_flag'?: boolean; /** * Whether or not the field is mandatory * @type {boolean} */ 'mandatory_flag'?: boolean; /** * The options of the field. When there are no options, `null` is returned. * @type {Array} */ 'options'?: Array | null; /** * The deleted options of the field. Only present when there is at least 1 deleted option. * @type {Array} */ 'options_deleted'?: Array; /** * Whether or not the field is a subfield of another field. Only present if field is subfield. * @type {boolean} */ 'is_subfield'?: boolean; /** * The subfields of the field. Only present when the field has subfields. * @type {Array} */ 'subfields'?: Array; } export declare const FieldFieldTypeConst: { readonly address: "address"; readonly date: "date"; readonly daterange: "daterange"; readonly double: "double"; readonly enum: "enum"; readonly monetary: "monetary"; readonly org: "org"; readonly people: "people"; readonly phone: "phone"; readonly set: "set"; readonly text: "text"; readonly time: "time"; readonly timerange: "timerange"; readonly user: "user"; readonly varchar: "varchar"; readonly varchar_auto: "varchar_auto"; readonly visible_to: "visible_to"; }; export type FieldFieldTypeConst = typeof FieldFieldTypeConst[keyof typeof FieldFieldTypeConst];