d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
118 lines
3.5 KiB
TypeScript
118 lines
3.5 KiB
TypeScript
import { createLogger } from '@sim/logger'
|
|
import type { HubSpotListEmailsParams, HubSpotListEmailsResponse } from '@/tools/hubspot/types'
|
|
import { EMAILS_ARRAY_OUTPUT, METADATA_OUTPUT, PAGING_OUTPUT } from '@/tools/hubspot/types'
|
|
import type { ToolConfig } from '@/tools/types'
|
|
|
|
const logger = createLogger('HubSpotListEmails')
|
|
|
|
export const hubspotListEmailsTool: ToolConfig<HubSpotListEmailsParams, HubSpotListEmailsResponse> =
|
|
{
|
|
id: 'hubspot_list_emails',
|
|
name: 'List Emails from HubSpot',
|
|
description: 'Retrieve all email engagements from HubSpot account with pagination support',
|
|
version: '1.0.0',
|
|
|
|
oauth: {
|
|
required: true,
|
|
provider: 'hubspot',
|
|
},
|
|
|
|
params: {
|
|
accessToken: {
|
|
type: 'string',
|
|
required: true,
|
|
visibility: 'hidden',
|
|
description: 'The access token for the HubSpot API',
|
|
},
|
|
limit: {
|
|
type: 'string',
|
|
required: false,
|
|
visibility: 'user-or-llm',
|
|
description: 'Maximum number of results per page (max 100, default 10)',
|
|
},
|
|
after: {
|
|
type: 'string',
|
|
required: false,
|
|
visibility: 'user-or-llm',
|
|
description: 'Pagination cursor for next page of results (from previous response)',
|
|
},
|
|
properties: {
|
|
type: 'string',
|
|
required: false,
|
|
visibility: 'user-or-llm',
|
|
description:
|
|
'Comma-separated list of HubSpot property names to return (e.g., "hs_email_subject,hs_email_text,hs_timestamp")',
|
|
},
|
|
associations: {
|
|
type: 'string',
|
|
required: false,
|
|
visibility: 'user-or-llm',
|
|
description:
|
|
'Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals")',
|
|
},
|
|
},
|
|
|
|
request: {
|
|
url: (params) => {
|
|
const baseUrl = 'https://api.hubapi.com/crm/v3/objects/emails'
|
|
const queryParams = new URLSearchParams()
|
|
|
|
if (params.limit) {
|
|
queryParams.append('limit', params.limit)
|
|
}
|
|
if (params.after) {
|
|
queryParams.append('after', params.after)
|
|
}
|
|
if (params.properties) {
|
|
queryParams.append('properties', params.properties)
|
|
}
|
|
if (params.associations) {
|
|
queryParams.append('associations', params.associations)
|
|
}
|
|
|
|
const queryString = queryParams.toString()
|
|
return queryString ? `${baseUrl}?${queryString}` : baseUrl
|
|
},
|
|
method: 'GET',
|
|
headers: (params) => {
|
|
if (!params.accessToken) {
|
|
throw new Error('Access token is required')
|
|
}
|
|
|
|
return {
|
|
Authorization: `Bearer ${params.accessToken}`,
|
|
'Content-Type': 'application/json',
|
|
}
|
|
},
|
|
},
|
|
|
|
transformResponse: async (response: Response) => {
|
|
const data = await response.json()
|
|
|
|
if (!response.ok) {
|
|
logger.error('HubSpot API request failed', { data, status: response.status })
|
|
throw new Error(data.message || 'Failed to list emails from HubSpot')
|
|
}
|
|
|
|
return {
|
|
success: true,
|
|
output: {
|
|
emails: data.results || [],
|
|
paging: data.paging ?? null,
|
|
metadata: {
|
|
totalReturned: data.results?.length || 0,
|
|
hasMore: !!data.paging?.next,
|
|
},
|
|
success: true,
|
|
},
|
|
}
|
|
},
|
|
|
|
outputs: {
|
|
emails: EMAILS_ARRAY_OUTPUT,
|
|
paging: PAGING_OUTPUT,
|
|
metadata: METADATA_OUTPUT,
|
|
success: { type: 'boolean', description: 'Operation success status' },
|
|
},
|
|
}
|