//native
export type DynSelect_object_type = string
// Dropdown of the standard CRM object types plus the account's custom objects.
export async function object_type(auth: RT.Hubspot) {
const standard = [
"contacts",
"companies",
"deals",
"tickets",
"line_items",
"products",
"quotes",
"leads",
"notes",
"tasks",
"meetings",
"calls",
"emails",
"communications",
].map((o) => ({ value: o, label: o }))
const response = await fetch("https://api.hubapi.com/crm/v3/schemas", {
headers: {
Authorization: `Bearer ${auth.token}`,
Accept: "application/json",
},
})
// A token without crm.schemas.custom.read still gets the standard objects.
if (!response.ok) return standard
const { results } = (await response.json()) as {
results: { fullyQualifiedName: string; labels: { plural: string } }[]
}
return [
...standard,
...results.map((s) => ({
value: s.fullyQualifiedName,
label: `${s.labels.plural} (custom)`,
})),
]
}
export type DynMultiselect_properties = string[]
// Dependent checklist: the properties of the chosen object type.
export async function properties(
auth: RT.Hubspot,
object_type: DynSelect_object_type
) {
if (!object_type) return []
const response = await fetch(
`https://api.hubapi.com/crm/v3/properties/${object_type}`,
{
headers: {
Authorization: `Bearer ${auth.token}`,
Accept: "application/json",
},
}
)
if (!response.ok) {
throw new Error(`${response.status} ${await response.text()}`)
}
const { results } = (await response.json()) as {
results: { name: string; label: string }[]
}
return results.map((p) => ({
value: p.name,
label: `${p.label} (${p.name})`,
}))
}
/**
* List CRM Objects
* List records of a CRM object type, one page at a time. Paginate by passing `paging.next.after` as `after`. Use Search CRM Objects to filter. Object types other than contacts, companies and deals need their own scope on the connection (e.g. tickets, crm.objects.line_items.read, crm.objects.custom.read).
*/
export async function main(
auth: RT.Hubspot,
object_type: DynSelect_object_type,
properties: DynMultiselect_properties | undefined,
associations: string[] | undefined,
limit: number | undefined,
after: string | undefined,
archived: boolean | undefined
) {
const url = new URL(`https://api.hubapi.com/crm/v3/objects/${object_type}`)
if (properties?.length)
url.searchParams.append("properties", properties.join(","))
if (associations?.length)
url.searchParams.append("associations", associations.join(","))
if (limit != null) url.searchParams.append("limit", String(limit))
if (after != null && after !== "") url.searchParams.append("after", after)
if (archived) url.searchParams.append("archived", String(archived))
const response = await fetch(url, {
headers: {
Authorization: `Bearer ${auth.token}`,
Accept: "application/json",
},
})
if (!response.ok) {
throw new Error(`${response.status} ${await response.text()}`)
}
return await response.json()
}
Submitted by hugo989 5 hours ago