Edits history of script submission #23408 for ' Batch Read CRM Objects (hubspot)'

  • bunnative
    One script reply has been approved by the moderators
    Ap­pro­ved
    //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})`,
      }))
    }
    
    /**
     * Batch Read CRM Objects
     * Retrieve up to 100 CRM records of one object type by ID, or by a unique property via `id_property`. 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,
      ids: string[],
      properties: DynMultiselect_properties | undefined,
      id_property: string | undefined
    ) {
      const body: { [key: string]: any } = { inputs: ids.map((id) => ({ id })) }
      if (properties?.length) body.properties = properties
      if (id_property != null && id_property !== "") body.idProperty = id_property
    
      const response = await fetch(
        `https://api.hubapi.com/crm/v3/objects/${object_type}/batch/read`,
        {
          method: "POST",
          headers: {
            Authorization: `Bearer ${auth.token}`,
            "Content-Type": "application/json",
            Accept: "application/json",
          },
          body: JSON.stringify(body),
        }
      )
    
      if (!response.ok) {
        throw new Error(`${response.status} ${await response.text()}`)
      }
    
      return await response.json()
    }
    

    Submitted by hugo989 4 hours ago