Search Articles

//native

/**

 * Search Articles

 * Search Help Center articles by text, category, section and/or labels (at least one is required). Dates are `YYYY-MM-DD`; `locale` takes `*` for all locales. Label filtering needs a Professional or Enterprise plan. Offset-paged (`page`, up to 100 per page).

 */

export async function main(

  auth: RT.Zendesk,

  query: string | undefined,

  locale: string | undefined,

  category_ids: number[] | undefined,

  section_ids: number[] | undefined,

  label_names: string[] | undefined,

  brand_id: number | undefined,

  multibrand: boolean,

  created_after: string | undefined,

  created_before: string | undefined,

  updated_after: string | undefined,

  updated_before: string | undefined,

  sort_by: "created_at" | "updated_at" | undefined,

  sort_order: "asc" | "desc" | undefined,

  page: number | undefined,

  per_page: number | undefined

) {

  const url = new URL(

    `https://${auth.subdomain}.zendesk.com/api/v2/help_center/articles/search`

  )

  const params = {

    query,

    locale,

    category: category_ids?.join(","),

    section: section_ids?.join(","),

    label_names: label_names?.join(","),

    brand_id,

    multibrand: multibrand ? "true" : undefined,

    created_after,

    created_before,

    updated_after,

    updated_before,

    sort_by,

    sort_order,

    page: page || 1,

    per_page: per_page || 25,

  }

  for (const [key, value] of Object.entries(params)) {

    if (value != null && value !== "") {

      url.searchParams.append(key, String(value))

    }

  }

  const response = await fetch(url, {

    headers: {

      Authorization: auth.token

        ? `Bearer ${auth.token}`

        : `Basic ${btoa(`${auth.username}:${auth.password}`)}`,

      Accept: "application/json",

    },

  })

  if (!response.ok) {

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

  }

  return await response.json()

}