Skip to content

Built for people who want to own their automations. Join the waitlist for an invite.

Package listing

@kody/hubspot

src/get-object.ts

36 lines · 1.5 KB · TypeScript
import { getObject, type GetObjectInput } from './objects.ts'
import { optionalBoolean, optionalString, optionalStringArray, requireRecord, requireString } from './types.ts'
import { requireAuthMode } from './auth.ts'

/**
 * Get one HubSpot CRM record for any object type, including custom objects.
 * @example
 * import getObject from 'kody:@kody/hubspot/get-object'
 * const record = await getObject({ objectType: 'contacts', id: '123' })
 */
export { getObject }

/**
 * Get one HubSpot CRM record for any object type, including custom objects.
 * @example
 * import getObject from 'kody:@kody/hubspot/get-object'
 * const record = await getObject({ objectType: 'contacts', id: 'pat@example.com', idProperty: 'email' })
 */
export default async function getObjectEntrypoint(
	params: Partial<GetObjectInput> & Record<string, unknown> = {},
) {
	const input = requireRecord(params, 'get-object')
	return getObject({
		objectType: requireString(input.objectType, 'objectType'),
		id: requireString(input.id, 'id'),
		idProperty: optionalString(input.idProperty, 'idProperty'),
		properties: optionalStringArray(input.properties, 'properties'),
		archived: optionalBoolean(input.archived, 'archived'),
		associations: optionalStringArray(input.associations, 'associations'),
		integrationName: optionalString(input.integrationName, 'integrationName'),
		integration: optionalString(input.integration, 'integration'),
		account: optionalString(input.account, 'account'),
		secretName: optionalString(input.secretName, 'secretName'),
		auth: requireAuthMode(input.auth),
	})
}