Class HubSpotBaseAction`Abstract`

Base class for all HubSpot CRM actions. Handles HubSpot-specific authentication and API interaction patterns.

Hierarchy (View Summary)

BaseCRMAction
- HubSpotBaseAction

Constructors

constructor

new HubSpotBaseAction(): HubSpotBaseAction
Returns HubSpotBaseAction
Inherited from BaseCRMAction.constructor

Properties

`Protected`apiVersion

apiVersion: string = 'v3'

HubSpot API version

`Protected`crmProvider

crmProvider: string = 'HubSpot'

The CRM provider this action is designed for (e.g., 'HubSpot', 'Salesforce', etc.)

`Protected`integrationName

integrationName: string = 'HubSpot'

The integration name to look up in the Integration entity

`Protected`params

params: any

Current action parameters (set by the framework)

Methods

`Protected`associateObjects

associateObjects(
    fromObjectType: string,
    fromObjectId: string,
    toObjectType: string,
    toObjectId: string,
    associationType?: string,
    contextUser?: UserInfo,
): Promise<void>
Associate objects in HubSpot
Parameters
- fromObjectType: string
- fromObjectId: string
- toObjectType: string
- toObjectId: string
- OptionalassociationType: string
- OptionalcontextUser: UserInfo
Returns Promise<void>
- Defined in BizApps/CRM/src/providers/hubspot/hubspot-base.action.ts:239

`Protected`batchCreateHubSpotObjects

batchCreateHubSpotObjects<T = any>(
    objectType: string,
    objects: { properties: Record<string, any> }[],
    contextUser?: UserInfo,
): Promise<T[]>
Batch create objects in HubSpot
Type Parameters
- T = any
Parameters
- objectType: string
- objects: { properties: Record<string, any> }[]
- OptionalcontextUser: UserInfo
Returns Promise<T[]>
- Defined in BizApps/CRM/src/providers/hubspot/hubspot-base.action.ts:201

`Protected`batchUpdateHubSpotObjects

batchUpdateHubSpotObjects<T = any>(
    objectType: string,
    updates: { id: string; properties: Record<string, any> }[],
    contextUser?: UserInfo,
): Promise<T[]>
Batch update objects in HubSpot
Type Parameters
- T = any
Parameters
- objectType: string
- updates: { id: string; properties: Record<string, any> }[]
- OptionalcontextUser: UserInfo
Returns Promise<T[]>
- Defined in BizApps/CRM/src/providers/hubspot/hubspot-base.action.ts:220

`Protected`buildCRMErrorMessage

buildCRMErrorMessage(
    operation: string,
    details: string,
    systemError?: any,
): string
Helper to build consistent error messages for CRM operations
Parameters
- operation: string
- details: string
- OptionalsystemError: any
Returns string
Inherited from BaseCRMAction.buildCRMErrorMessage
- Defined in BizApps/CRM/src/base/base-crm.action.ts:193

`Protected`formatCRMDate

formatCRMDate(date: Date): string
Standard date format for CRM systems (ISO 8601)
Parameters
- date: Date
Returns string
Inherited from BaseCRMAction.formatCRMDate
- Defined in BizApps/CRM/src/base/base-crm.action.ts:148

`Protected`formatHubSpotDate

formatHubSpotDate(date: Date): string
Format date for HubSpot (ISO string or milliseconds)
Parameters
- date: Date
Returns string
- Defined in BizApps/CRM/src/providers/hubspot/hubspot-base.action.ts:271

`Protected`formatPhoneNumber

formatPhoneNumber(phone: string): string
Format phone numbers to E.164 format if possible
Parameters
- phone: string
Returns string
Inherited from BaseCRMAction.formatPhoneNumber
- Defined in BizApps/CRM/src/base/base-crm.action.ts:162

`Protected`getAPIBaseURL

getAPIBaseURL(integration: MJCompanyIntegrationEntity): Promise<string>
Gets the base URL for API calls
Parameters
- integration: MJCompanyIntegrationEntity
Returns Promise<string>
Inherited from BaseCRMAction.getAPIBaseURL
- Defined in BizApps/CRM/src/base/base-crm.action.ts:127

`Protected`getAPICredentials

getAPICredentials(
    integration: MJCompanyIntegrationEntity,
): Promise<
    {
        accessToken?: string;
        apiKey?: string;
        apiSecret?: string;
        clientId?: string;
        clientSecret?: string;
        refreshToken?: string;
    },
>
Gets API credentials - first tries environment variables, then falls back to database
Parameters
- integration: MJCompanyIntegrationEntity
Returns Promise<
    {
        accessToken?: string;
        apiKey?: string;
        apiSecret?: string;
        clientId?: string;
        clientSecret?: string;
        refreshToken?: string;
    },
>
Inherited from BaseCRMAction.getAPICredentials
- Defined in BizApps/CRM/src/base/base-crm.action.ts:83

`Protected`getAssociationTypeId

getAssociationTypeId(fromType: string, toType: string): number
Get HubSpot association type IDs Based on HubSpot's default association type IDs
Parameters
- fromType: string
- toType: string
Returns number
- Defined in BizApps/CRM/src/providers/hubspot/hubspot-base.action.ts:292

`Protected`getCommonCRMParams

getCommonCRMParams(): ActionParam[]
Common CRM parameters that many actions will need

Returns ActionParam[]
Inherited from BaseCRMAction.getCommonCRMParams
- Defined in BizApps/CRM/src/base/base-crm.action.ts:32

`Protected`getCompanyIntegration

getCompanyIntegration(
companyId: string,
contextUser: UserInfo,
): Promise<MJCompanyIntegrationEntity>
Gets the company integration record for the specified company and CRM
Parameters
- companyId: string
- contextUser: UserInfo
Returns Promise<MJCompanyIntegrationEntity>
Inherited from BaseCRMAction.getCompanyIntegration
- Defined in BizApps/CRM/src/base/base-crm.action.ts:45

`Protected`getCredentialFromEnv

getCredentialFromEnv(companyId: string, credentialType: string): string
Gets credentials from environment variables Format: BIZAPPS_{PROVIDER}{COMPANY_ID}{CREDENTIAL_TYPE} Example: BIZAPPS_HUBSPOT_12345_API_KEY
Parameters
- companyId: string
- credentialType: string
Returns string
Inherited from BaseCRMAction.getCredentialFromEnv
- Defined in BizApps/CRM/src/base/base-crm.action.ts:75

`Protected`getParamValue

getParamValue(params: ActionParam[], paramName: string): any
Helper to get parameter value with type safety
Parameters
- params: ActionParam[]
- paramName: string
Returns any
Inherited from BaseCRMAction.getParamValue
- Defined in BizApps/CRM/src/base/base-crm.action.ts:140

`Protected` `Abstract`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Internal method that must be implemented by derived action classes. This is where the actual action logic should be implemented.
Parameters
- params: RunActionParams
  The action execution parameters including typed context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseCRMAction.InternalRunAction
- Defined in Engine/dist/generic/BaseAction.d.ts:45

`Protected`isValidEmail

isValidEmail(email: string): boolean
Validate email format
Parameters
- email: string
Returns boolean
Inherited from BaseCRMAction.isValidEmail
- Defined in BizApps/CRM/src/base/base-crm.action.ts:185

`Protected`makeHubSpotPaginatedRequest

makeHubSpotPaginatedRequest<T = any>(
    endpoint: string,
    params?: Record<string, any>,
    contextUser?: UserInfo,
): Promise<T[]>
Makes a paginated request to HubSpot API using cursor-based pagination
Type Parameters
- T = any
Parameters
- endpoint: string
- params: Record<string, any> = {}
- OptionalcontextUser: UserInfo
Returns Promise<T[]>
- Defined in BizApps/CRM/src/providers/hubspot/hubspot-base.action.ts:117

`Protected`makeHubSpotRequest

makeHubSpotRequest<T = any>(
    endpoint: string,
    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE",
    body?: any,
    contextUser?: UserInfo,
): Promise<T>
Makes an authenticated request to HubSpot API
Type Parameters
- T = any
Parameters
- endpoint: string
- method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" = 'GET'
- Optionalbody: any
- OptionalcontextUser: UserInfo
Returns Promise<T>
- Defined in BizApps/CRM/src/providers/hubspot/hubspot-base.action.ts:29

`Protected`mapActivityType

mapActivityType(
type: string,
): "call" | "email" | "meeting" | "task" | "note" | "other"
Common activity types mapping
Parameters
- type: string
Returns "call" | "email" | "meeting" | "task" | "note" | "other"
Inherited from BaseCRMAction.mapActivityType
- Defined in BizApps/CRM/src/base/base-crm.action.ts:225

`Protected`mapDealStatus

mapDealStatus(stage: string): "open" | "won" | "lost" | "unknown"
Map deal/opportunity stages to common statuses
Parameters
- stage: string
Returns "open" | "won" | "lost" | "unknown"
Inherited from BaseCRMAction.mapDealStatus
- Defined in BizApps/CRM/src/base/base-crm.action.ts:204

`Protected`mapHubSpotProperties

mapHubSpotProperties(hubspotObject: any): any
Map HubSpot object properties to a standard format
Parameters
- hubspotObject: any
Returns any
- Defined in BizApps/CRM/src/providers/hubspot/hubspot-base.action.ts:278

`Protected`parseCRMDate

parseCRMDate(dateString: string): Date
Parse date from CRM format
Parameters
- dateString: string
Returns Date
Inherited from BaseCRMAction.parseCRMDate
- Defined in BizApps/CRM/src/base/base-crm.action.ts:155

`Protected`parseHubSpotDate

parseHubSpotDate(timestamp: string | number): Date
Convert HubSpot timestamp to Date
Parameters
- timestamp: string | number
Returns Date
- Defined in BizApps/CRM/src/providers/hubspot/hubspot-base.action.ts:260

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseCRMAction.Run
- Defined in Engine/dist/generic/BaseAction.d.ts:37

`Protected`searchHubSpotObjects

searchHubSpotObjects<T = any>(
    objectType: string,
    filters: { operator: string; propertyName: string; value: string }[],
    properties?: string[],
    contextUser?: UserInfo,
): Promise<T[]>
Search HubSpot objects using the search API
Type Parameters
- T = any
Parameters
- objectType: string
- filters: { operator: string; propertyName: string; value: string }[]
- Optionalproperties: string[]
- OptionalcontextUser: UserInfo
Returns Promise<T[]>
- Defined in BizApps/CRM/src/providers/hubspot/hubspot-base.action.ts:172

Class HubSpotBaseActionAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns HubSpotBaseAction

Properties

ProtectedapiVersion

ProtectedcrmProvider

ProtectedintegrationName

Protectedparams

Methods

ProtectedassociateObjects

Parameters

Returns Promise<void>

ProtectedbatchCreateHubSpotObjects

Type Parameters

Parameters

Returns Promise<T[]>

ProtectedbatchUpdateHubSpotObjects

Type Parameters

Parameters

Returns Promise<T[]>

ProtectedbuildCRMErrorMessage

Parameters

Returns string

ProtectedformatCRMDate

Parameters

Returns string

ProtectedformatHubSpotDate

Parameters

Returns string

ProtectedformatPhoneNumber

Parameters

Returns string

ProtectedgetAPIBaseURL

Parameters

Returns Promise<string>

ProtectedgetAPICredentials

Parameters

Returns Promise< { accessToken?: string; apiKey?: string; apiSecret?: string; clientId?: string; clientSecret?: string; refreshToken?: string; },>

ProtectedgetAssociationTypeId

Parameters

Returns number

ProtectedgetCommonCRMParams

Returns ActionParam[]

ProtectedgetCompanyIntegration

Parameters

Returns Promise<MJCompanyIntegrationEntity>

ProtectedgetCredentialFromEnv

Parameters

Returns string

ProtectedgetParamValue

Parameters

Returns any

Protected AbstractInternalRunAction

Parameters

Returns Promise<ActionResultSimple>

ProtectedisValidEmail

Parameters

Returns boolean

ProtectedmakeHubSpotPaginatedRequest

Type Parameters

Parameters

Returns Promise<T[]>

ProtectedmakeHubSpotRequest

Type Parameters

Parameters

Returns Promise<T>

ProtectedmapActivityType

Parameters

Returns "call" | "email" | "meeting" | "task" | "note" | "other"

ProtectedmapDealStatus

Parameters

Returns "open" | "won" | "lost" | "unknown"

ProtectedmapHubSpotProperties

Parameters

Class HubSpotBaseAction`Abstract`

`Protected`apiVersion

`Protected`crmProvider

`Protected`integrationName

`Protected`params

`Protected`associateObjects

`Protected`batchCreateHubSpotObjects

`Protected`batchUpdateHubSpotObjects

`Protected`buildCRMErrorMessage

`Protected`formatCRMDate

`Protected`formatHubSpotDate

`Protected`formatPhoneNumber

`Protected`getAPIBaseURL

`Protected`getAPICredentials

Returns Promise<
{
accessToken?: string;
apiKey?: string;
apiSecret?: string;
clientId?: string;
clientSecret?: string;
refreshToken?: string;
},
>

`Protected`getAssociationTypeId

`Protected`getCommonCRMParams

`Protected`getCompanyIntegration

`Protected`getCredentialFromEnv

`Protected`getParamValue

`Protected` `Abstract`InternalRunAction

`Protected`isValidEmail

`Protected`makeHubSpotPaginatedRequest

`Protected`makeHubSpotRequest

`Protected`mapActivityType

`Protected`mapDealStatus

`Protected`mapHubSpotProperties

`Protected`parseCRMDate

`Protected`parseHubSpotDate

`Protected`searchHubSpotObjects