bysquare 2.12.0 → 2.12.2

package/dist/types.d.ts

@@ -4,52 +4,59 @@
  * It's a bit silly to limit the version number to 4-bit, if they keep
  * increasing the version number, the latest possible mapped value is 16
  */
-export declare enum Version {
+export declare const Version: {
     /**
      * Created this document from original by square specifications.
      *
      * **Released Date:** 2013-02-22
      */
-    "1.0.0" = 0,
+    readonly "1.0.0": 0;
     /**
      * Added fields for beneficiary name and address
      *
      * **Released Date:** 2015-06-24
      */
-    "1.1.0" = 1
-}
+    readonly "1.1.0": 1;
+};
+export type Version = typeof Version[keyof typeof Version];
 /**
  * Kalendárny mesiac.
+ *
+ * @dprint-ignore
  */
-export declare enum Month {
-    January = 1,
-    February = 2,
-    March = 4,
-    April = 8,
-    May = 16,
-    June = 32,
-    July = 64,
-    August = 128,
-    September = 256,
-    October = 512,
-    November = 1024,
-    December = 2048
-}
+export declare const Month: {
+    readonly January: 1;
+    readonly February: 2;
+    readonly March: 4;
+    readonly April: 8;
+    readonly May: 16;
+    readonly June: 32;
+    readonly July: 64;
+    readonly August: 128;
+    readonly September: 256;
+    readonly October: 512;
+    readonly November: 1024;
+    readonly December: 2048;
+};
+export type Month = typeof Month[keyof typeof Month];
 /**
  * Deň platby vyplývajúci z opakovania (Periodicity). Deň v mesiaci je číslo
  * medzi 1 a 31. Deň v týždni je číslo medzi 1 a 7 (1 = pondelok, 2=utorok, …, 7
  * = nedeľa).
+ *
+ * @dprint-ignore
  */
-export declare enum Periodicity {
-    Daily = "d",
-    Weekly = "w",
-    Biweekly = "b",
-    Monthly = "m",
-    Bimonthly = "B",
-    Quarterly = "q",
-    Semiannually = "s",
-    Annually = "a"
-}
+export declare const Periodicity: {
+    readonly Daily: "d";
+    readonly Weekly: "w";
+    readonly Biweekly: "b";
+    readonly Monthly: "m";
+    readonly Bimonthly: "B";
+    readonly Quarterly: "q";
+    readonly Semiannually: "s";
+    readonly Annually: "a";
+};
+export type Periodicity = typeof Periodicity[keyof typeof Periodicity];
 /**
  * This is the payment day. It‘s meaning depends on the periodicity, meaning
  * either day of the month (number between 1 and 31) or day of the week
@@ -66,20 +73,21 @@ export type Day = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 1
  * - `StandingOrder`: trvalý príkaz, údaje sa vyplnia do StandingOrderExt
  * - `DirectDebit`: inkaso, údaje sa vyplnia do DirectDebitExt
  */
-export declare enum PaymentOptions {
+export declare const PaymentOptions: {
     /**
      * Platobný príkaz
      */
-    PaymentOrder = 1,
+    readonly PaymentOrder: 1;
     /**
      * Trvalý príkaz, údaje sa vyplnia do StandingOrderExt
      */
-    StandingOrder = 2,
+    readonly StandingOrder: 2;
     /**
      * Inkaso, údaje sa vyplnia do DirectDebitExt
      */
-    DirectDebit = 4
-}
+    readonly DirectDebit: 4;
+};
+export type PaymentOptions = typeof PaymentOptions[keyof typeof PaymentOptions];
 /**
  * Údaje bankového účtu prijímateľa platby.
  */
@@ -111,16 +119,17 @@ export type BankAccount = {
  * - SEPA - Inkaso zodpovedá schéme
  * - SEPA. other - iné
  */
-export declare enum DirectDebitScheme {
+export declare const DirectDebitScheme: {
     /**
      * other - iné
      */
-    Other = 0,
+    readonly Other: 0;
     /**
      * SEPA - Inkaso zodpovedá schéme
      */
-    Sepa = 1
-}
+    readonly Sepa: 1;
+};
+export type DirectDebitScheme = typeof DirectDebitScheme[keyof typeof DirectDebitScheme];
 /**
  * Typ inkasa. Uvádza ja jedna z možností:
  *
@@ -129,16 +138,17 @@ export declare enum DirectDebitScheme {
  * - one-off - jednorázové inkaso
  * - recurrent - opakované inkaso
  */
-export declare enum DirectDebitType {
+export declare const DirectDebitType: {
     /**
      * Jednorázové inkaso
      */
-    OneOff = 0,
+    readonly OneOff: 0;
     /**
      * Opakované inkaso
      */
-    Recurrent = 1
-}
+    readonly Recurrent: 1;
+};
+export type DirectDebitType = typeof DirectDebitType[keyof typeof DirectDebitType];
 export type Beneficiary = {
     /**
      * Rozšírenie o meno príjemcu
@@ -179,7 +189,7 @@ export type SimplePayment = {
      *
      * @example "EUR"
      */
-    currencyCode: string | CurrencyCode;
+    currencyCode: string | keyof typeof CurrencyCode;
     /**
      * Dátum splatnosti vo formáte [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) `"RRRR-MM-DD"`.
      * Vprípade trvalého príkazu označuje dátum prvej platby.
@@ -228,13 +238,13 @@ export type SimplePayment = {
     beneficiary?: Beneficiary;
 };
 export type PaymentOrder = SimplePayment & {
-    type: PaymentOptions.PaymentOrder;
+    type: typeof PaymentOptions.PaymentOrder;
 };
 /**
  * Rozšírenie platobných údajov o údaje pre nastavenie trvalého príkazu.
  */
 export type StandingOrder = SimplePayment & {
-    type: PaymentOptions.StandingOrder;
+    type: typeof PaymentOptions.StandingOrder;
     /**
      * Deň platby vyplývajúci z opakovania (Periodicity). Deň v mesiaci je číslo
      * medzi 1 a 31. Deň v týždni je číslo medzi 1 a 7 (1 = pondelok, 2 =utorok,
@@ -244,11 +254,11 @@ export type StandingOrder = SimplePayment & {
     /**
      * Medzerou oddelený zoznam mesiacov, v ktoré sa má platba uskutočniť.
      */
-    month?: Month;
+    month?: keyof typeof Month | number;
     /**
      * Opakovanie (periodicita) trvalého príkazu.
      */
-    periodicity: Periodicity;
+    periodicity: keyof typeof Periodicity | string;
     /**
      * Dátum poslednej platby v trvalom príkaze.
      *
@@ -260,9 +270,9 @@ export type StandingOrder = SimplePayment & {
  * Rozšírenie platobných údajov o údaje pre nastavenie a identifikáciu inkasa.
  */
 export type DirectDebit = SimplePayment & {
-    type: PaymentOptions.DirectDebit;
-    directDebitScheme?: DirectDebitScheme;
-    directDebitType?: DirectDebitType;
+    type: typeof PaymentOptions.DirectDebit;
+    directDebitScheme?: keyof typeof DirectDebitScheme | number;
+    directDebitType?: keyof typeof DirectDebitType | number;
     /**
      * Identifikácia mandátu medzi veriteľom a dlžníkom podľa SEPA.
      *
@@ -316,162 +326,163 @@ export type DataModel = {
 /**
  * [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217)
  */
-export declare enum CurrencyCode {
-    AED = "AED",
-    AFN = "AFN",
-    ALL = "ALL",
-    AMD = "AMD",
-    ANG = "ANG",
-    AOA = "AOA",
-    ARS = "ARS",
-    AUD = "AUD",
-    AWG = "AWG",
-    AZN = "AZN",
-    BAM = "BAM",
-    BBD = "BBD",
-    BDT = "BDT",
-    BGN = "BGN",
-    BHD = "BHD",
-    BIF = "BIF",
-    BMD = "BMD",
-    BND = "BND",
-    BOB = "BOB",
-    BRL = "BRL",
-    BSD = "BSD",
-    BTN = "BTN",
-    BWP = "BWP",
-    BYN = "BYN",
-    BZD = "BZD",
-    CAD = "CAD",
-    CDF = "CDF",
-    CHF = "CHF",
-    CLP = "CLP",
-    CNY = "CNY",
-    COP = "COP",
-    CRC = "CRC",
-    CUC = "CUC",
-    CUP = "CUP",
-    CVE = "CVE",
-    CZK = "CZK",
-    DJF = "DJF",
-    DKK = "DKK",
-    DOP = "DOP",
-    DZD = "DZD",
-    EGP = "EGP",
-    ERN = "ERN",
-    ETB = "ETB",
-    EUR = "EUR",
-    FJD = "FJD",
-    FKP = "FKP",
-    GBP = "GBP",
-    GEL = "GEL",
-    GHS = "GHS",
-    GIP = "GIP",
-    GMD = "GMD",
-    GNF = "GNF",
-    GTQ = "GTQ",
-    GYD = "GYD",
-    HKD = "HKD",
-    HNL = "HNL",
-    HRK = "HRK",
-    HTG = "HTG",
-    HUF = "HUF",
-    IDR = "IDR",
-    ILS = "ILS",
-    INR = "INR",
-    IQD = "IQD",
-    IRR = "IRR",
-    ISK = "ISK",
-    JMD = "JMD",
-    JOD = "JOD",
-    JPY = "JPY",
-    KES = "KES",
-    KGS = "KGS",
-    KHR = "KHR",
-    KMF = "KMF",
-    KPW = "KPW",
-    KRW = "KRW",
-    KWD = "KWD",
-    KYD = "KYD",
-    KZT = "KZT",
-    LAK = "LAK",
-    LBP = "LBP",
-    LKR = "LKR",
-    LRD = "LRD",
-    LSL = "LSL",
-    LYD = "LYD",
-    MAD = "MAD",
-    MDL = "MDL",
-    MGA = "MGA",
-    MKD = "MKD",
-    MMK = "MMK",
-    MNT = "MNT",
-    MOP = "MOP",
-    MRU = "MRU",
-    MUR = "MUR",
-    MVR = "MVR",
-    MWK = "MWK",
-    MXN = "MXN",
-    MYR = "MYR",
-    MZN = "MZN",
-    NAD = "NAD",
-    NGN = "NGN",
-    NIO = "NIO",
-    NOK = "NOK",
-    NPR = "NPR",
-    NZD = "NZD",
-    OMR = "OMR",
-    PAB = "PAB",
-    PEN = "PEN",
-    PGK = "PGK",
-    PHP = "PHP",
-    PKR = "PKR",
-    PLN = "PLN",
-    PYG = "PYG",
-    QAR = "QAR",
-    RON = "RON",
-    RSD = "RSD",
-    RUB = "RUB",
-    RWF = "RWF",
-    SAR = "SAR",
-    SBD = "SBD",
-    SCR = "SCR",
-    SDG = "SDG",
-    SEK = "SEK",
-    SGD = "SGD",
-    SHP = "SHP",
-    SLL = "SLL",
-    SOS = "SOS",
-    SRD = "SRD",
-    SSP = "SSP",
-    STN = "STN",
-    SVC = "SVC",
-    SYP = "SYP",
-    SZL = "SZL",
-    THB = "THB",
-    TJS = "TJS",
-    TMT = "TMT",
-    TND = "TND",
-    TOP = "TOP",
-    TRY = "TRY",
-    TTD = "TTD",
-    TWD = "TWD",
-    TZS = "TZS",
-    UAH = "UAH",
-    UGX = "UGX",
-    USD = "USD",
-    UYU = "UYU",
-    UZS = "UZS",
-    VES = "VES",
-    VND = "VND",
-    VUV = "VUV",
-    WST = "WST",
-    XAF = "XAF",
-    XCD = "XCD",
-    XOF = "XOF",
-    XPF = "XPF",
-    YER = "YER",
-    ZAR = "ZAR",
-    ZMW = "ZMW",
-    ZWL = "ZWL"
-}
+export declare const CurrencyCode: {
+    readonly AED: "AED";
+    readonly AFN: "AFN";
+    readonly ALL: "ALL";
+    readonly AMD: "AMD";
+    readonly ANG: "ANG";
+    readonly AOA: "AOA";
+    readonly ARS: "ARS";
+    readonly AUD: "AUD";
+    readonly AWG: "AWG";
+    readonly AZN: "AZN";
+    readonly BAM: "BAM";
+    readonly BBD: "BBD";
+    readonly BDT: "BDT";
+    readonly BGN: "BGN";
+    readonly BHD: "BHD";
+    readonly BIF: "BIF";
+    readonly BMD: "BMD";
+    readonly BND: "BND";
+    readonly BOB: "BOB";
+    readonly BRL: "BRL";
+    readonly BSD: "BSD";
+    readonly BTN: "BTN";
+    readonly BWP: "BWP";
+    readonly BYN: "BYN";
+    readonly BZD: "BZD";
+    readonly CAD: "CAD";
+    readonly CDF: "CDF";
+    readonly CHF: "CHF";
+    readonly CLP: "CLP";
+    readonly CNY: "CNY";
+    readonly COP: "COP";
+    readonly CRC: "CRC";
+    readonly CUC: "CUC";
+    readonly CUP: "CUP";
+    readonly CVE: "CVE";
+    readonly CZK: "CZK";
+    readonly DJF: "DJF";
+    readonly DKK: "DKK";
+    readonly DOP: "DOP";
+    readonly DZD: "DZD";
+    readonly EGP: "EGP";
+    readonly ERN: "ERN";
+    readonly ETB: "ETB";
+    readonly EUR: "EUR";
+    readonly FJD: "FJD";
+    readonly FKP: "FKP";
+    readonly GBP: "GBP";
+    readonly GEL: "GEL";
+    readonly GHS: "GHS";
+    readonly GIP: "GIP";
+    readonly GMD: "GMD";
+    readonly GNF: "GNF";
+    readonly GTQ: "GTQ";
+    readonly GYD: "GYD";
+    readonly HKD: "HKD";
+    readonly HNL: "HNL";
+    readonly HRK: "HRK";
+    readonly HTG: "HTG";
+    readonly HUF: "HUF";
+    readonly IDR: "IDR";
+    readonly ILS: "ILS";
+    readonly INR: "INR";
+    readonly IQD: "IQD";
+    readonly IRR: "IRR";
+    readonly ISK: "ISK";
+    readonly JMD: "JMD";
+    readonly JOD: "JOD";
+    readonly JPY: "JPY";
+    readonly KES: "KES";
+    readonly KGS: "KGS";
+    readonly KHR: "KHR";
+    readonly KMF: "KMF";
+    readonly KPW: "KPW";
+    readonly KRW: "KRW";
+    readonly KWD: "KWD";
+    readonly KYD: "KYD";
+    readonly KZT: "KZT";
+    readonly LAK: "LAK";
+    readonly LBP: "LBP";
+    readonly LKR: "LKR";
+    readonly LRD: "LRD";
+    readonly LSL: "LSL";
+    readonly LYD: "LYD";
+    readonly MAD: "MAD";
+    readonly MDL: "MDL";
+    readonly MGA: "MGA";
+    readonly MKD: "MKD";
+    readonly MMK: "MMK";
+    readonly MNT: "MNT";
+    readonly MOP: "MOP";
+    readonly MRU: "MRU";
+    readonly MUR: "MUR";
+    readonly MVR: "MVR";
+    readonly MWK: "MWK";
+    readonly MXN: "MXN";
+    readonly MYR: "MYR";
+    readonly MZN: "MZN";
+    readonly NAD: "NAD";
+    readonly NGN: "NGN";
+    readonly NIO: "NIO";
+    readonly NOK: "NOK";
+    readonly NPR: "NPR";
+    readonly NZD: "NZD";
+    readonly OMR: "OMR";
+    readonly PAB: "PAB";
+    readonly PEN: "PEN";
+    readonly PGK: "PGK";
+    readonly PHP: "PHP";
+    readonly PKR: "PKR";
+    readonly PLN: "PLN";
+    readonly PYG: "PYG";
+    readonly QAR: "QAR";
+    readonly RON: "RON";
+    readonly RSD: "RSD";
+    readonly RUB: "RUB";
+    readonly RWF: "RWF";
+    readonly SAR: "SAR";
+    readonly SBD: "SBD";
+    readonly SCR: "SCR";
+    readonly SDG: "SDG";
+    readonly SEK: "SEK";
+    readonly SGD: "SGD";
+    readonly SHP: "SHP";
+    readonly SLL: "SLL";
+    readonly SOS: "SOS";
+    readonly SRD: "SRD";
+    readonly SSP: "SSP";
+    readonly STN: "STN";
+    readonly SVC: "SVC";
+    readonly SYP: "SYP";
+    readonly SZL: "SZL";
+    readonly THB: "THB";
+    readonly TJS: "TJS";
+    readonly TMT: "TMT";
+    readonly TND: "TND";
+    readonly TOP: "TOP";
+    readonly TRY: "TRY";
+    readonly TTD: "TTD";
+    readonly TWD: "TWD";
+    readonly TZS: "TZS";
+    readonly UAH: "UAH";
+    readonly UGX: "UGX";
+    readonly USD: "USD";
+    readonly UYU: "UYU";
+    readonly UZS: "UZS";
+    readonly VES: "VES";
+    readonly VND: "VND";
+    readonly VUV: "VUV";
+    readonly WST: "WST";
+    readonly XAF: "XAF";
+    readonly XCD: "XCD";
+    readonly XOF: "XOF";
+    readonly XPF: "XPF";
+    readonly YER: "YER";
+    readonly ZAR: "ZAR";
+    readonly ZMW: "ZMW";
+    readonly ZWL: "ZWL";
+};
+export type CurrencyCode = typeof CurrencyCode[keyof typeof CurrencyCode];