Class AssociateContactToCompanyAction

ProtectedapiVersion

ProtectedcrmProvider

ProtectedintegrationName

Protectedparams

ProtectedassociateObjects

• 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>

ProtectedbatchCreateHubSpotObjects

• 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[]>

ProtectedbatchUpdateHubSpotObjects

• 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[]>

ProtectedbuildCRMErrorMessage

• 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

ProtectedformatCRMDate

• formatCRMDate(date: Date): string

  Standard date format for CRM systems (ISO 8601)

  Parameters

  • date: Date

  Returns string

ProtectedformatHubSpotDate

• formatHubSpotDate(date: Date): string

  Format date for HubSpot (ISO string or milliseconds)

  Parameters

  • date: Date

  Returns string

ProtectedformatPhoneNumber

• formatPhoneNumber(phone: string): string

  Format phone numbers to E.164 format if possible

  Parameters

  • phone: string

  Returns string

ProtectedgetAPIBaseURL

• getAPIBaseURL(integration: MJCompanyIntegrationEntity): Promise<string>

  Gets the base URL for API calls

  Parameters

  • integration: MJCompanyIntegrationEntity

  Returns Promise<string>

ProtectedgetAPICredentials

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

ProtectedgetAssociationTypeId

• 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

ProtectedgetCommonCRMParams

• getCommonCRMParams(): ActionParam[]

  Common CRM parameters that many actions will need

  Returns ActionParam[]

ProtectedgetCompanyIntegration

• 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>

ProtectedgetCredentialFromEnv

• 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

ProtectedgetParamValue

• getParamValue(params: ActionParam[], paramName: string): any

  Helper to get parameter value with type safety

  Parameters

  • params: ActionParam[]
  • paramName: string

  Returns any

ProtectedisValidEmail

• isValidEmail(email: string): boolean

  Validate email format

  Parameters

  • email: string

  Returns boolean

ProtectedmakeHubSpotPaginatedRequest

• 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[]>

ProtectedmakeHubSpotRequest

• 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>

ProtectedmapActivityType

• mapActivityType(
      type: string,
  ): "call" | "email" | "meeting" | "task" | "note" | "other"

  Common activity types mapping

  Parameters

  • type: string

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

ProtectedmapDealStatus

• mapDealStatus(stage: string): "open" | "won" | "lost" | "unknown"

  Map deal/opportunity stages to common statuses

  Parameters

  • stage: string

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

ProtectedmapHubSpotProperties

• mapHubSpotProperties(hubspotObject: any): any

  Map HubSpot object properties to a standard format

  Parameters

  • hubspotObject: any

  Returns any

ProtectedparseCRMDate

• parseCRMDate(dateString: string): Date

  Parse date from CRM format

  Parameters

  • dateString: string

  Returns Date

ProtectedparseHubSpotDate

• parseHubSpotDate(timestamp: string | number): Date

  Convert HubSpot timestamp to Date

  Parameters

  • timestamp: string | number

  Returns Date

ProtectedsearchHubSpotObjects

• 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[]>