Class ObjectSchema

Defines an object schema, including its properties and associations.

Constructors

constructor

Properties

archived? associations createdAt? createdByUserId? description? fullyQualifiedName? id labels name objectTypeId? primaryDisplayProperty? properties requiredProperties searchableProperties? secondaryDisplayProperties? updatedAt? updatedByUserId? attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

Optionalarchived

archived?: boolean

associations

associations: AssociationDefinition[]

Associations defined for a given object type.

OptionalcreatedAt

createdAt?: Date

When the object schema was created.

OptionalcreatedByUserId

createdByUserId?: number

Optionaldescription

description?: string

OptionalfullyQualifiedName

fullyQualifiedName?: string

An assigned unique ID for the object, including portal ID and object name.

id

id: string

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

labels

labels: ObjectTypeDefinitionLabels

name

name: string

A unique name for the schema's object type.

OptionalobjectTypeId

objectTypeId?: string

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: Property[]

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.

OptionalupdatedAt

updatedAt?: Date

When the object schema was last updated.

OptionalupdatedByUserId

updatedByUserId?: number

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