Class Pipeline

A pipeline definition.

Constructors

constructor

Properties

archived archivedAt? createdAt displayOrder id label stages updatedAt attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

archived

archived: boolean

Whether the pipeline is archived.

OptionalarchivedAt

archivedAt?: Date

The date the pipeline was archived. archivedAt will only be present if the pipeline is archived.

createdAt

createdAt: Date

The date the pipeline was created. The default pipelines will have createdAt = 0.

displayOrder

displayOrder: number

The order for displaying this pipeline. If two pipelines have a matching displayOrder, they will be sorted alphabetically by label.

id

id: string

A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline.

label

label: string

A unique label used to organize pipelines in HubSpot's UI

stages

stages: PipelineStage[]

The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints.

updatedAt

updatedAt: Date

The date the pipeline was last updated.

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