CreateLoyaltyPromotion

//native

type Square = {

  token: string;

};

/**

 * CreateLoyaltyPromotion

 * Creates a loyalty promotion for a [loyalty program]($m/LoyaltyProgram). A loyalty promotion

enables buyers to earn points in addition to those earned from the base loyalty program.

This endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the

`available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an

`ACTIVE` or `SCHEDULED` status.

 */

export async function main(

  auth: Square,

  program_id: string,

  body: {

    loyalty_promotion: {

      id?: string;

      name: string;

      incentive: {

        type: "POINTS_MULTIPLIER" | "POINTS_ADDITION";

        points_multiplier_data?: {

          points_multiplier?: number;

          multiplier?: string;

        };

        points_addition_data?: { points_addition: number };

      };

      available_time: {

        start_date?: string;

        end_date?: string;

        time_periods: string[];

      };

      trigger_limit?: { times: number; interval?: "ALL_TIME" | "DAY" };

      status?: "ACTIVE" | "ENDED" | "CANCELED" | "SCHEDULED";

      created_at?: string;

      canceled_at?: string;

      updated_at?: string;

      loyalty_program_id?: string;

      minimum_spend_amount_money?: {

        amount?: number;

        currency?:

          | "UNKNOWN_CURRENCY"

          | "AED"

          | "AFN"

          | "ALL"

          | "AMD"

          | "ANG"

          | "AOA"

          | "ARS"

          | "AUD"

          | "AWG"

          | "AZN"

          | "BAM"

          | "BBD"

          | "BDT"

          | "BGN"

          | "BHD"

          | "BIF"

          | "BMD"

          | "BND"

          | "BOB"

          | "BOV"

          | "BRL"

          | "BSD"

          | "BTN"

          | "BWP"

          | "BYR"

          | "BZD"

          | "CAD"

          | "CDF"

          | "CHE"

          | "CHF"

          | "CHW"

          | "CLF"

          | "CLP"

          | "CNY"

          | "COP"

          | "COU"

          | "CRC"

          | "CUC"

          | "CUP"

          | "CVE"

          | "CZK"

          | "DJF"

          | "DKK"

          | "DOP"

          | "DZD"

          | "EGP"

          | "ERN"

          | "ETB"

          | "EUR"

          | "FJD"

          | "FKP"

          | "GBP"

          | "GEL"

          | "GHS"

          | "GIP"

          | "GMD"

          | "GNF"

          | "GTQ"

          | "GYD"

          | "HKD"

          | "HNL"

          | "HRK"

          | "HTG"

          | "HUF"

          | "IDR"

          | "ILS"

          | "INR"

          | "IQD"

          | "IRR"

          | "ISK"

          | "JMD"

          | "JOD"

          | "JPY"

          | "KES"

          | "KGS"

          | "KHR"

          | "KMF"

          | "KPW"

          | "KRW"

          | "KWD"

          | "KYD"

          | "KZT"

          | "LAK"

          | "LBP"

          | "LKR"

          | "LRD"

          | "LSL"

          | "LTL"

          | "LVL"

          | "LYD"

          | "MAD"

          | "MDL"

          | "MGA"

          | "MKD"

          | "MMK"

          | "MNT"

          | "MOP"

          | "MRO"

          | "MUR"

          | "MVR"

          | "MWK"

          | "MXN"

          | "MXV"

          | "MYR"

          | "MZN"

          | "NAD"

          | "NGN"

          | "NIO"

          | "NOK"

          | "NPR"

          | "NZD"

          | "OMR"

          | "PAB"

          | "PEN"

          | "PGK"

          | "PHP"

          | "PKR"

          | "PLN"

          | "PYG"

          | "QAR"

          | "RON"

          | "RSD"

          | "RUB"

          | "RWF"

          | "SAR"

          | "SBD"

          | "SCR"

          | "SDG"

          | "SEK"

          | "SGD"

          | "SHP"

          | "SLL"

          | "SLE"

          | "SOS"

          | "SRD"

          | "SSP"

          | "STD"

          | "SVC"

          | "SYP"

          | "SZL"

          | "THB"

          | "TJS"

          | "TMT"

          | "TND"

          | "TOP"

          | "TRY"

          | "TTD"

          | "TWD"

          | "TZS"

          | "UAH"

          | "UGX"

          | "USD"

          | "USN"

          | "USS"

          | "UYI"

          | "UYU"

          | "UZS"

          | "VEF"

          | "VND"

          | "VUV"

          | "WST"

          | "XAF"

          | "XAG"

          | "XAU"

          | "XBA"

          | "XBB"

          | "XBC"

          | "XBD"

          | "XCD"

          | "XDR"

          | "XOF"

          | "XPD"

          | "XPF"

          | "XPT"

          | "XTS"

          | "XXX"

          | "YER"

          | "ZAR"

          | "ZMK"

          | "ZMW"

          | "BTC"

          | "XUS";

      };

      qualifying_item_variation_ids?: string[];

      qualifying_category_ids?: string[];

    };

    idempotency_key: string;

  },

) {

  const url = new URL(

    `https://connect.squareup.com/v2/loyalty/programs/${program_id}/promotions`,

  );

  const response = await fetch(url, {

    method: "POST",

    headers: {

      "Content-Type": "application/json",

      Authorization: "Bearer " + auth.token,

    },

    body: JSON.stringify(body),

  });

  if (!response.ok) {

    const text = await response.text();

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

  }

  return await response.json();

}