Class PropertyUpdate

Constructors

constructor

Properties

calculationFormula? description? displayOrder? fieldType? formField? groupName? hidden? label? options? type? attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

OptionalcalculationFormula

calculationFormula?: string

Represents a formula that is used to compute a calculated property.

Optionaldescription

description?: string

A description of the property that will be shown as help text in HubSpot.

OptionaldisplayOrder

displayOrder?: number

Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the Property to be displayed after any positive values.

OptionalfieldType

fieldType?: PropertyUpdateFieldTypeEnum

Controls how the property appears in HubSpot.

OptionalformField

formField?: boolean

Whether or not the property can be used in a HubSpot form.

OptionalgroupName

groupName?: string

The name of the property group the property belongs to.

Optionalhidden

hidden?: boolean

If true, the property won't be visible and can't be used in HubSpot.

Optionallabel

label?: string

A human-readable property label that will be shown in HubSpot.

Optionaloptions

options?: OptionInput[]

A list of valid options for the property.

Optionaltype

type?: PropertyUpdateTypeEnum

The data type of the property.

Static ReadonlyattributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Static Readonlydiscriminator

discriminator: undefined | string = undefined

Static Readonlymapping

mapping: undefined | {
    [index: string]: string;
} = undefined

Methods

StaticgetAttributeTypeMap

  • getAttributeTypeMap(): {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods