Class BaseCRMAction`Abstract`

Base class for all CRM-related actions. Provides common functionality and patterns for interacting with Customer Relationship Management systems.

Hierarchy (View Summary)

BaseAction
- BaseCRMAction
  - HubSpotBaseAction

Index

Constructors

constructor

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

Properties

`Protected` `Abstract`crmProvider

crmProvider: string

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

`Protected` `Abstract`integrationName

integrationName: string

The integration name to look up in the Integration entity

`Static` `Readonly`AuthorizesCaller

AuthorizesCaller: boolean

True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

Methods

`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
- 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
- Defined in BizApps/CRM/src/base/base-crm.action.ts:148

`Protected`formatPhoneNumber

formatPhoneNumber(phone: string): string
Format phone numbers to E.164 format if possible
Parameters
- phone: string
Returns string
- 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>
- 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;
    },
>
- Defined in BizApps/CRM/src/base/base-crm.action.ts:83

`Protected`getCommonCRMParams

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

Returns ActionParam[]
- 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>
- 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
- 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
- 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 BaseAction.InternalRunAction
- Defined in Engine/dist/generic/BaseAction.d.ts:57

`Protected`isValidEmail

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

`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"
- 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"
- Defined in BizApps/CRM/src/base/base-crm.action.ts:204

`Protected`parseCRMDate

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

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 BaseAction.Run
- Defined in Engine/dist/generic/BaseAction.d.ts:49

Class BaseCRMActionAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BaseCRMAction

Properties

Protected AbstractcrmProvider

Protected AbstractintegrationName

Static ReadonlyAuthorizesCaller

Methods

ProtectedbuildCRMErrorMessage

Parameters

Returns string

ProtectedformatCRMDate

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; },>

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

ProtectedmapActivityType

Parameters

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

ProtectedmapDealStatus

Parameters

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

ProtectedparseCRMDate

Parameters

Returns Date

Run

Parameters

Returns Promise<ActionResultSimple>

Settings

On This Page

Class BaseCRMAction`Abstract`

`Protected` `Abstract`crmProvider

`Protected` `Abstract`integrationName

`Static` `Readonly`AuthorizesCaller

`Protected`buildCRMErrorMessage

`Protected`formatCRMDate

`Protected`formatPhoneNumber

`Protected`getAPIBaseURL

`Protected`getAPICredentials

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

`Protected`getCommonCRMParams

`Protected`getCompanyIntegration

`Protected`getCredentialFromEnv

`Protected`getParamValue

`Protected` `Abstract`InternalRunAction

`Protected`isValidEmail

`Protected`mapActivityType

`Protected`mapDealStatus

`Protected`parseCRMDate