ListOrderCustomAttributes

//native

type Square = {

  token: string;

};

/**

 * ListOrderCustomAttributes

 * Lists the [custom attributes]($m/CustomAttribute) associated with an order.

You can use the `with_definitions` query parameter to also retrieve custom attribute definitions

in the same call.

When all response pages are retrieved, the results include all custom attributes that are

visible to the requesting application, including those that are owned by other applications

and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.

 */

export async function main(

  auth: Square,

  order_id: string,

  visibility_filter: "ALL" | "READ" | "READ_WRITE" | undefined,

  cursor: string | undefined,

  limit: string | undefined,

  with_definitions: string | undefined,

) {

  const url = new URL(

    `https://connect.squareup.com/v2/orders/${order_id}/custom-attributes`,

  );

  for (const [k, v] of [

    ["visibility_filter", visibility_filter],

    ["cursor", cursor],

    ["limit", limit],

    ["with_definitions", with_definitions],

  ]) {

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

      url.searchParams.append(k, v);

    }

  }

  const response = await fetch(url, {

    method: "GET",

    headers: {

      Authorization: "Bearer " + auth.token,

    },

    body: undefined,

  });

  if (!response.ok) {

    const text = await response.text();

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

  }

  return await response.json();

}