Class ObjectTypeDefinition

Defines an object type.

Constructors

constructor

Properties

archived? createdAt? description? fullyQualifiedName? id labels name objectTypeId? portalId? primaryDisplayProperty? requiredProperties searchableProperties? secondaryDisplayProperties? updatedAt? attributeTypeMap discriminator

Methods

getAttributeTypeMap

Constructors

constructor

Properties

Optionalarchived

archived?: boolean

OptionalcreatedAt

createdAt?: Date

When the object type was created.

Optionaldescription

description?: string

OptionalfullyQualifiedName

fullyQualifiedName?: string

id

id: string

A unique ID for this object type. Will be defined as {meta-type}-{unique ID}.

labels

labels: ObjectTypeDefinitionLabels

name

name: string

A unique name for this object. For internal use only.

OptionalobjectTypeId

objectTypeId?: string

OptionalportalId

portalId?: number

The ID of the account that this object type is specific to.

OptionalprimaryDisplayProperty

primaryDisplayProperty?: string

The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.

requiredProperties

requiredProperties: string[]

The names of properties that should be required when creating an object of this type.

OptionalsearchableProperties

searchableProperties?: string[]

Names of properties that will be indexed for this object type in by HubSpot's product search.

OptionalsecondaryDisplayProperties

secondaryDisplayProperties?: string[]

The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.

OptionalupdatedAt

updatedAt?: Date

When the object type was last updated.

Static ReadonlyattributeTypeMap

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

Static Readonlydiscriminator

discriminator: undefined | 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