Skip to content

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

Package listing

@kody/calendly

src/list-invitees.ts

76 lines · 2.8 KB · TypeScript
import { calendlyRequest, uuidFromUri } from './client.ts'
import { mapInvitee } from './models.ts'
import type { CalendlyAuthInput, CalendlyInviteeSummary, CalendlyPageInfo } from './types.ts'
import { clampInt, compactRecord, optionalString, requireRecord } from './types.ts'
import { requireAuthMode } from './auth.ts'

export type ListInviteesInput = CalendlyAuthInput & {
	/** Scheduled event uuid or URI. */
	event: string
	status?: 'active' | 'canceled'
	email?: string
	count?: number
	pageToken?: string
	sort?: string
}

export type ListInviteesResult = {
	items: Array<CalendlyInviteeSummary>
	pageInfo: CalendlyPageInfo
}

/**
 * List invitees for a Calendly scheduled event.
 * @example
 * import listInvitees from 'kody:@kody/calendly/list-invitees'
 * const { items } = await listInvitees({ event: 'AAAAAAAAAAAAAAAA', status: 'active' })
 */
export async function listInvitees(input: ListInviteesInput): Promise<ListInviteesResult> {
	const event = optionalString(input.event, 'event')
	if (!event) throw new Error('list-invitees requires event (scheduled event uuid or URI).')
	const status = optionalString(input.status, 'status')
	if (status && status !== 'active' && status !== 'canceled') {
		throw new Error('status must be "active" or "canceled".')
	}
	const result = await calendlyRequest<Array<unknown>>({
		...input,
		operation: 'scheduledEvents.read',
		path: `/scheduled_events/${uuidFromUri(event)}/invitees`,
		query: compactRecord({
			status,
			email: optionalString(input.email, 'email'),
			count: clampInt(input.count, 1, 100, 20),
			page_token: optionalString(input.pageToken, 'pageToken'),
			sort: optionalString(input.sort, 'sort'),
		}),
	})
	return {
		items: (Array.isArray(result.data) ? result.data : []).map(mapInvitee),
		pageInfo: result.pageInfo,
	}
}

/**
 * List invitees for a Calendly scheduled event.
 * @example
 * import listInvitees from 'kody:@kody/calendly/list-invitees'
 * const result = await listInvitees({ event: 'AAAAAAAAAAAAAAAA' })
 */
export default async function listInviteesEntrypoint(
	params: Partial<ListInviteesInput> & Record<string, unknown> = {},
) {
	const input = requireRecord(params, 'list-invitees')
	return listInvitees({
		event: optionalString(input.event, 'event') ?? '',
		status: optionalString(input.status, 'status') as ListInviteesInput['status'],
		email: optionalString(input.email, 'email'),
		count: input.count as number | undefined,
		pageToken: optionalString(input.pageToken, 'pageToken'),
		sort: optionalString(input.sort, 'sort'),
		integrationName: optionalString(input.integrationName, 'integrationName'),
		integration: optionalString(input.integration, 'integration'),
		account: optionalString(input.account, 'account'),
		secretName: optionalString(input.secretName, 'secretName'),
		auth: requireAuthMode(input.auth),
	})
}