bysquare 1.3.3 → 2.0.0

package/lib/types.d.ts

@@ -1,15 +1,8 @@
 /**
- * The bit sequence is split into 5 bit chunks which are mapped onto the
- * characters
- *
- * @see 3.13. Table 9 – Encoding table
+ * Selection of one or more months on which payment occurs. This is enabled
+ * only if periodicity is set to one of the following value: “Weekly,
+ * Biweekly, Monthly, Bimonthly”. Otherwise it must not be specified.
  */
-export declare const SUBST = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
-export declare enum PaymentOptions {
-    PaymentOrder = 1,
-    StandingOrder = 2,
-    DirectDebit = 4
-}
 export declare enum MonthClassifier {
     January = 1,
     February = 2,
@@ -24,7 +17,13 @@ export declare enum MonthClassifier {
     November = 1024,
     December = 2048
 }
-export declare enum PeriodicityClassifier {
+/**
+ * Periodicity of the payment. All valid options are „Daily“, „Weekly“,
+ * „Biweekly“, „Monthly“, „Bimonthly“, „Quarterly“, „Annually“,
+ * „Semiannually“. To find out which periodicity types are supported by the
+ * banks see the following web site: http://www.sbaonline.sk/sk/
+ */
+export declare enum Periodicity {
     Daily = "d",
     Weekly = "w",
     Biweekly = "b",
@@ -34,294 +33,187 @@ export declare enum PeriodicityClassifier {
     Semiannually = "s",
     Annually = "a"
 }
-export declare enum DirectDebitType {
-    OneOff = 0,
-    Recurrent = 1
+/**
+ * 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
+ * (1=Monday,2=Tuesday, …, 7=Sunday).
+ *
+ * Max length 2
+ */
+export type Day = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31;
+export declare enum PaymentOptions {
+    PaymentOrder = 1,
+    StandingOrder = 2,
+    DirectDebit = 4
 }
+/**
+ * In section „encoding BankAccounts“ we provide further recommendations for
+ * encoding bank account
+ */
+export type BankAccount = {
+    /**
+     * Max length 34
+     */
+    iban: string;
+    /**
+     * Format ISO 9362 (swift)
+     * 8 or 11 characters long
+     */
+    bic?: string;
+};
+/**
+ * If DirectDebitScheme value is 1, which is „SEPA“ than encoded direct
+ * debit follows SEPA direct debit scheme which means that fields MandateID,
+ * CreditorID and optional ContractID are used. If direct debit scheme is 0,
+ * which is „OTHER“ this means no specific direct debit scheme and following
+ * rules do apply:
+ *
+ * a. Creditor is identified via bank accounts
+ *
+ * b. Contract between debtor and creditor is identified using one of the
+ *    following two ways: 1. by two optional fields SpecificSymbol and
+ *    VariableSymbol. 2. by one optional field OriginatorsReferenceInformation.
+ *    If SpecificSymbol and VariableSymbol fields or
+ *    OriginatorsReferenceInformation field is filled in DirectDebitExt then
+ *    these fields do apply for the direct debit.
+ */
 export declare enum DirectDebitScheme {
     Other = 0,
     Sepa = 1
 }
 /**
- * Table 15. PAY by square sequence data model (page 30.)
+ * Can be „one­off“ for one time debit or „recurrent“ for repeated debit
+ * until cancelled.
+ *
+ * Max length 1
  */
-export interface Model {
+export declare enum DirectDebitType {
+    OneOff = 0,
+    Recurrent = 1
+}
+export type Beneficiary = {
     /**
-     * Max length 10
+     * Belongs to the N-th payment
+     *
+     * Max length 70
      */
-    InvoiceID?: string;
+    name?: string;
     /**
-     * Appendix E extended beneficiary fields
-     * Table 16 PAY by square extended fields for bulk payment order
+     * Belongs to the N-th payment
+     * Commonly used street and street number
      *
-     * Number of payments
+     * Max length 70
      */
-    Payments: number;
+    street?: string;
     /**
-     * Max length 1
+     * Belongs to the N-th payment
+     * Commonly used for City
+     *
+     * Max length 70
      */
-    PaymentOptions: PaymentOptions;
+    city?: string;
+};
+export type SimplePayment = {
     /**
      * Encoded with amount payable. This field is not required and can be left
      * blank in cases payment amount is not known ­such as donations.
      *
      * Decimal, max length 15
      */
-    Amount?: number;
+    amount?: number;
     /**
-     * 3 letter, payment currency code according to ISO 4217
+     * 3 letter, payment currency code according to ISO-4217
      */
-    CurrencyCode: keyof typeof CurrencyCode;
+    currencyCode: keyof typeof CurrencyCodeEnum;
     /**
      * Format YYYYMMDD
      */
-    PaymentDueDate?: string;
+    paymentDueDate?: string;
     /**
      * Max length 10
      */
-    VariableSymbol?: string;
+    variableSymbol?: string;
     /**
      * Max length 4
      */
-    ConstantSymbol?: string;
+    constantSymbol?: string;
     /**
      * Max length 10
      */
-    SpecificSymbol?: string;
+    specificSymbol?: string;
     /**
      * Max length 35
      */
-    OriginatorsReferenceInformation?: string;
+    originatorRefInfo?: string;
     /**
      * Optional field. In previous section we provide further recommendations
      * for encoding payment note.
      *
      * Max length 140
      */
-    PaymentNote?: string;
-    /**
-     * In section „encoding BankAccounts“ we provide further recommendations for
-     * encoding bank account
-     */
-    BankAccounts: number;
-    /**
-     * Max length 34
-     */
-    IBAN: string;
-    /**
-     * Format ISO 9362, 8 or 11 characters long
-     *
-     * Max length 11
-     */
-    BIC?: string;
-    /**
-     * Max length 1
-     */
-    StandingOrderExt?: 0 | 1;
-    /**
-     * 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
-     * (1=Monday,2=Tuesday, …, 7=Sunday).
-     *
-     * Max length 2
-     * */
-    Day?: number;
-    /**
-     * Selection of one or more months on which payment occurs. This is enabled
-     * only if periodicity is set to one of the following value: “Weekly,
-     * Biweekly, Monthly, Bimonthly”. Otherwise it must not be specified.
-     *
-     * Max length 4
-     */
-    Month?: MonthClassifier;
-    /**
-     * Periodicity of the payment. All valid options are „Daily“, „Weekly“,
-     * „Biweekly“, „Monthly“, „Bimonthly“, „Quarterly“, „Annually“,
-     * „Semiannually“. To find out which periodicity types are supported by the
-     * banks see the following web site: http://www.sbaonline.sk/sk/
-     *
-     * Max length 1
-     */
-    Periodicity?: PeriodicityClassifier;
+    paymentNote?: string;
+    bankAccounts: BankAccount[];
+    beneficiary?: Beneficiary;
+};
+export type PaymentOrder = SimplePayment & {
+    type: PaymentOptions.PaymentOrder;
+};
+export type StandingOrder = SimplePayment & {
+    type: PaymentOptions.StandingOrder;
+    day?: Day;
+    month?: MonthClassifier;
+    periodicity?: Periodicity;
     /**
      * Defines the day of the last payment of the standing order. After this
      * date, standing order is cancelled.
      *
      * Format YYYYMMDD
      */
-    LastDate?: string;
-    /**
-     * Max length 1
-     */
-    DirectDebitExt?: 0 | 1;
-    /**
-     * If DirectDebitScheme value is 1, which is „SEPA“ than encoded direct
-     * debit follows SEPA direct debit scheme which means that fields MandateID,
-     * CreditorID and optional ContractID are used. If direct debit scheme is 0,
-     * which is „OTHER“ this means no specific direct debit scheme and following
-     * rules do apply:
-     *
-     * a. Creditor is identified via bank accounts
-     *
-     * b. Contract between debtor and creditor is identified using one of the
-     * following two ways: 1. by two optional fields SpecificSymbol and
-     * VariableSymbol. 2. by one optional field OriginatorsReferenceInformation.
-     * If SpecificSymbol and VariableSymbol fields or
-     * OriginatorsReferenceInformation field is filled in DirectDebitExt then
-     * these fields do apply for the direct debit.
-     *
-     * Max length 1
-     */
-    DirectDebitScheme?: DirectDebitScheme;
-    /**
-     * Can be „one­off“ for one time debit or „recurrent“ for repeated debit
-     * until cancelled.
-     *
-     * Max length 1
-     */
-    DirectDebitType?: DirectDebitType;
-    /**
-     * Max length 10
-     */
-    VariableSymbol_?: string;
-    /**
-     * Max length 10
-     */
-    SpecificSymbol_?: string;
-    /**
-     * Max length 35
-     */
-    OriginatorsReferenceInformation_?: string;
+    lastDate?: string;
+};
+export type DirectDebit = SimplePayment & {
+    type: PaymentOptions.DirectDebit;
+    directDebitScheme?: DirectDebitScheme;
+    directDebitType?: DirectDebitType;
     /**
      * Max length 35
      */
-    MandateID?: string;
+    mandateId?: string;
     /**
      * Max length 35
      */
-    CreditorID?: string;
+    creditorId?: string;
     /**
      * Max length 35
      */
-    ContractID?: string;
+    contractId?: string;
     /**
      * Optional field. As most users prefer to set up some maximum amount for
      * the direct debit, this can be pre­-filled for them.
      *
      * Decimal, max length 15
      */
-    MaxAmount?: number;
+    maxAmount?: number;
     /**
      * Defines the day after which direct debit is cancelled.
      *
      * Max length 8
      * Format YYYYMMDD
      */
-    ValidTillDate?: string;
+    validTillDate?: string;
+};
+export type Payment = PaymentOrder | StandingOrder | DirectDebit;
+export type DataModel = {
     /**
-     * Belongs to the first payment
-     *
-     * Max length 70
-     */
-    BeneficiaryName?: string;
-    /**
-     * Belongs to the first payment
-     *
-     * Max length 70
-     */
-    BeneficiaryAddressLine1?: string;
-    /**
-     * Belongs to the first payment
-     *
-     * Max length 70
+     * Max length 10
      */
-    BeneficiaryAddressLine2?: string;
-}
-export interface ParsedModel {
-    invoiceId: Model["InvoiceID"];
-    payments: Array<{
-        amount: Model["Amount"];
-        currencyCode: Model["CurrencyCode"];
-        paymentDueDate?: Model["PaymentDueDate"];
-        variableSymbol?: Model["VariableSymbol"];
-        constantSymbol?: Model["ConstantSymbol"];
-        specificSymbol?: Model["SpecificSymbol"];
-        originatorsReferenceInformation?: Model["OriginatorsReferenceInformation"];
-        paymentNote?: Model["PaymentNote"];
-        bankAccounts: Array<{
-            iban: Model["IBAN"];
-            bic?: Model["BIC"];
-        }>;
-        standingOrder?: {
-            day?: Model["Day"];
-            month?: Model["Month"];
-            periodicity?: Model["Periodicity"];
-            lastDate?: Model["LastDate"];
-        };
-        directDebit?: {
-            directDebitScheme?: Model["DirectDebitScheme"];
-            directDebitType?: Model["DirectDebitType"];
-            variableSymbol?: Model["VariableSymbol"];
-            specificSymbol?: Model["SpecificSymbol"];
-            originatorsReferenceInformation?: Model["OriginatorsReferenceInformation_"];
-            mandateId?: Model["MandateID"];
-            creditorId?: Model["CreditorID"];
-            contractId?: Model["ContractID"];
-            maxAmount?: Model["MaxAmount"];
-            validTillDate?: Model["ValidTillDate"];
-        };
-        beneficiary?: {
-            name?: Model["BeneficiaryName"];
-            addressLine1?: Model["BeneficiaryAddressLine1"];
-            addressLine2?: Model["BeneficiaryAddressLine2"];
-        };
-    }>;
-}
-/**
- * Atributes must follow specific order
- * Based on Table 15. PAY by square sequence data model (page 30.)
- *
- * @see{./docs/specification_v1.1.0.pdf}
- */
-export declare enum SequenceOrder {
-    InvoiceID = 0,
-    Payments = 1,
-    PaymentOptions = 2,
-    Amount = 3,
-    CurrencyCode = 4,
-    PaymentDueDate = 5,
-    VariableSymbol = 6,
-    ConstantSymbol = 7,
-    SpecificSymbol = 8,
-    OriginatorsReferenceInformation = 9,
-    PaymentNote = 10,
-    BankAccounts = 11,
-    IBAN = 12,
-    BIC = 13,
-    StandingOrderExt = 14,
-    Day = 15,
-    Month = 16,
-    Periodicity = 17,
-    LastDate = 18,
-    DirectDebitExt = 19,
-    DirectDebitScheme = 20,
-    DirectDebitType = 21,
-    VariableSymbol_ = 22,
-    SpecificSymbol_ = 23,
-    OriginatorsReferenceInformation_ = 24,
-    MandateID = 25,
-    CreditorID = 26,
-    ContractID = 27,
-    MaxAmount = 28,
-    ValidTillDate = 29,
-    BeneficiaryName = 30,
-    BeneficiaryAddressLine1 = 31,
-    BeneficiaryAddressLine2 = 32
-}
+    invoiceId?: string;
+    payments: Payment[];
+};
 /**
- * Currency codes based on ISO 4217
+ * Currency codes based on ISO-4217
  */
-export declare enum CurrencyCode {
+export declare enum CurrencyCodeEnum {
     AED = "United Arab Emirates Dirham",
     AFN = "Afghanistan Afghani",
     ALL = "Albania Lek",