Search Custom Object Records

type Zendesk = {

  username: string;

  password: string;

  subdomain: string;

};

/**

 * Search Custom Object Records

 * Returns an array of custom object records that meet the search criteria

#### Pagination

* Cursor pagination only.

* Returns the records sorted by relevancy with page limits. Without a `sort` parameter, only the first 10,000 records are returned. With a `sort` parameter, all records are returned.

#### Allowed For

* Agents

 */

export async function main(

  auth: Zendesk,

  custom_object_key: string,

  query: string | undefined,

  sort: string | undefined,

  page_before_: string | undefined,

  page_after_: string | undefined,

  page_size_: string | undefined

) {

  const url = new URL(

    `https://${auth.subdomain}.zendesk.com/api/v2/custom_objects/${custom_object_key}/records/search`

  );

  for (const [k, v] of [

    ["query", query],

    ["sort", sort],

    ["page[before]", page_before_],

    ["page[after]", page_after_],

    ["page[size]", page_size_],

  ]) {

    if (v !== undefined && v !== "") {

      url.searchParams.append(k, v);

    }

  }

  const response = await fetch(url, {

    method: "GET",

    headers: {

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

    },

    body: undefined,

  });

  if (!response.ok) {

    const text = await response.text();

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

  }

  return await response.json();

}