Class ObjectSchemaEgg

Defines a new object type, its properties, and associations.

Constructors

constructor

Properties

associatedObjects description? labels name primaryDisplayProperty? properties requiredProperties searchableProperties? secondaryDisplayProperties? attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

associatedObjects

associatedObjects: string[]

Associations defined for this object type.

Optionaldescription

description?: string

labels

labels: ObjectTypeDefinitionLabels

name

name: string

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

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.

properties

properties: ObjectTypePropertyCreate[]

Properties defined 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.

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