Archive CRM Object

//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)`,

    })),

  ]

}

/**

 * Archive CRM Object

 * Move a CRM record to the recycling bin. It can be restored from HubSpot for 90 days. 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,

  object_id: string

) {

  const url = new URL(

    `https://api.hubapi.com/crm/v3/objects/${object_type}/${object_id}`

  )

  const response = await fetch(url, {

    method: "DELETE",

    headers: {

      Authorization: `Bearer ${auth.token}`,

      Accept: "application/json",

    },

  })

  if (!response.ok) {

    throw new Error(`${response.status} ${await response.text()}`)

  }

  if (response.status === 204) return { success: true }

  return await response.json()

}