Filter Definitions

type Zendesk = {

  username: string;

  password: string;

  subdomain: string;

};

/**

 * Filter Definitions

 * Returns filter definitions based on the given target type.  Target types

include users (zen:user), tickets (zen:ticket), organizations (zen:organization), or custom objects (zen:custom_object:CUSTOM_OBJECT_KEY).

The returned filter definitions are the options that you can use to build a custom field or ticket field's

`relationship_filter`.

 */

export async function main(auth: Zendesk, target_type: string) {

  const url = new URL(

    `https://${auth.subdomain}.zendesk.com/api/v2/relationships/definitions/${target_type}`

  );

  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();

}