Class Option

The options available when a property is an enumeration

Constructors

constructor

Properties

description? displayOrder? hidden label value attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

Optionaldescription

description?: string

A description of the option.

OptionaldisplayOrder

displayOrder?: number

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

hidden

hidden: boolean

Hidden options will not be displayed in HubSpot.

label

label: string

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

value

value: string

The internal value of the option, which must be used when setting the property value through the API.

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