Class ObjectTypeDefinitionPatch

Defines attributes to update on an object type.

Constructors

constructor

Properties

clearDescription? description? labels? primaryDisplayProperty? requiredProperties? restorable? searchableProperties? secondaryDisplayProperties? attributeTypeMap discriminator

Methods

getAttributeTypeMap

Constructors

constructor

Properties

OptionalclearDescription

clearDescription?: boolean

Optionaldescription

description?: string

Optionallabels

labels?: ObjectTypeDefinitionLabels

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.

OptionalrequiredProperties

requiredProperties?: string[]

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

Optionalrestorable

restorable?: boolean

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.

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