@tax1driver/ts-przelewy24 2.1.0

package/dist/p24/BaseParameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseParameters.js","sourceRoot":"","sources":["../../src/p24/BaseParameters.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG"}

package/dist/p24/P24.d.ts

@@ -0,0 +1,241 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2019 Kasun Vithanage
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+import { P24Options } from './P24Options';
+import { Order, Transaction } from '../orders';
+import { Verification, NotificationRequest } from '../verify';
+import { RefundRequest, RefundResult } from '../refund';
+import { TransactionDetails } from '../orders/TransactionDetails';
+import { Currency } from '../enums';
+import { PaymentMethod } from '../payment/PaymentMethod';
+import { OfflineTransaction } from '../orders/OfflineTransaction';
+import { SplitPaymentOrder } from '../orders/SplitPayment';
+import { TransactionWithRefunds } from '../refund/TransactionWithRefunds';
+import { ChargeCard3DSParams, ChargeCardParams, ChargeCardDirectParams } from '../cards/ChargeCard';
+import { CardPaymentNotification } from '../cards/CardNotification';
+import { BlikAlias } from '../blik/Alias';
+import { ChargeBlikByAliasParams, ChargeBlikByCodeParams, ChargeBlikData } from '../blik/ChargeBlik';
+/**
+ * Represents a P24 payment system
+ *
+ * @export
+ * @class P24
+ */
+export declare class P24 {
+    private merchantId;
+    private posId;
+    private crcKey;
+    private apiKey;
+    private client;
+    private baseUrl;
+    private options;
+    private baseParameters;
+    /**
+    * Creates an instance of Przelewy24.
+    * @param {number} merchantId Merchant ID given by Przelewy24
+    * @param {number} posId Shop ID (defaults to merchantId)
+    * @param {string} apiKey API Key from P24 panel(Klucz do raportów)
+    * @param {string} crcKey CRC key from P24 panel
+    * @param {P24Options} [options={ sandbox: false }] - additional options
+    * @memberof P24
+    */
+    constructor(merchantId: number, posId: number, apiKey: string, crcKey: string, options?: P24Options);
+    /**
+     * Centralized error handler for API calls
+     * @private
+     * @param {any} error - The caught error
+     * @param {string} defaultMessage - Default error message
+     * @throws {P24Error}
+     */
+    private handleApiError;
+    /**
+     * Test access to the service
+     *
+     * @returns {Promise<boolean>}
+     * @throws {P24Error}
+     * @memberof P24
+     */
+    testAccess(): Promise<boolean>;
+    /**
+     * Creates a transaction
+     *
+     * @param {Order} order - order to be created
+     * @returns {Promise<Transaction>}
+     * @throws {P24Error}
+     * @memberof P24
+     */
+    createTransaction(order: Order): Promise<Transaction>;
+    /**
+     * Verify transaction
+     *
+     * @param {Verification} verification - verification request
+     * @returns {Promise<boolean>}
+     * @throws {P24Error}
+     * @memberof P24
+     */
+    verifyTransaction(verification: Verification): Promise<boolean>;
+    /**
+     * Verify notification transaction with our CRC Key
+     *
+     * @param {NotificationRequest} notificationRequest
+     * @returns {boolean}
+     * @memberof P24
+     */
+    verifyNotification(notificationRequest: NotificationRequest): boolean;
+    /**
+     * Handle refund
+     *
+     * @param {RefundRequest} refundRequest
+     * @returns {Promise<RefundResult[]>}
+     * @memberof P24
+     */
+    refund(refundRequest: RefundRequest): Promise<RefundResult[]>;
+    /**
+     * Get transaction details
+     *
+     * @param {string} sessionId
+     * @returns {Promise<TransactionDetails>}
+     * @memberof P24
+     */
+    getTransactionDetails(sessionId: string): Promise<TransactionDetails>;
+    /**
+     * List payment methods
+     *
+     * @param {string} lang - Language code ('en' or 'pl')
+     * @returns {PaymentMethod[]} - List of payment methods
+     * @memberof P24
+     */
+    listPaymentMethods(lang: string, options?: {
+        amount?: number;
+        currency?: Currency;
+    }): Promise<PaymentMethod[]>;
+    /**
+     * Register offline transaction
+     *
+     * @param {string} token - Transaction token obtained with createTransaction
+     * @returns {Promise<OfflineTransaction>} - Offline transaction details
+     * @throws {P24Error}
+     * @memberof P24
+     */
+    registerOfflineTransaction(token: string): Promise<OfflineTransaction>;
+    /**
+     * Split payment
+     *
+     * @param {SplitPaymentOrder} order - order with split payment details
+     * @returns {Promise<Transaction>}
+     * @throws {P24Error}
+     * @memberof P24
+     */
+    splitPayment(order: SplitPaymentOrder): Promise<Transaction>;
+    /**
+     * Get refund by orderID
+     *
+     * @param {string} orderId - Order ID
+     * @returns {Promise<TransactionWithRefunds>} - List of refunds
+     * @throws {P24Error}
+     * @memberof P24
+     */
+    getRefundsByOrderId(orderId: string): Promise<TransactionWithRefunds>;
+    /**
+     * Charge card with 3DS
+     *
+     * @param {string} token - Card token
+     * @returns {Promise<ChargeCard3DSParams>} - 3DS Data
+     * @throws {P24Error}
+     * @memberof P24
+     */
+    chargeCard3DS(token: string): Promise<ChargeCard3DSParams>;
+    /**
+     * Charge card without 3DS
+     *
+     * @param {string} token - Card token
+     * @returns {Promise<ChargeCardParams>} - Charge card data
+     * @throws {P24Error}
+     * @memberof P24
+     */
+    chargeCard(token: string): Promise<ChargeCardParams>;
+    /**
+     * Charge card directly
+     *
+     * @param {ChargeCardDirectParams} params - Direct charge parameters
+     * @returns {Promise<ChargeCardParams>} - Charge card data
+     * @throws {P24Error}
+     * @memberof P24
+     */
+    chargeCardDirect(params: ChargeCardDirectParams): Promise<ChargeCardParams | ChargeCard3DSParams>;
+    /**
+     * Verifies card payment notification
+     *
+     * @param {CardNotificationRequest} cardNotificationRequest - Card notification request
+     * @returns {boolean} - true on valid notification
+     * @memberof P24
+     */
+    verifyCardNotification(cardNotificationRequest: CardPaymentNotification): boolean;
+    /**
+     * Charge BLIK account by code
+     *
+     * @param {ChargeBlikByCodeParams} params - BLIK charge parameters
+     * @returns {Promise<ChargeBlikData>} - BLIK charge data
+     * @throws {P24Error}
+     * @memberof P24
+     */
+    chargeBlikByCode(params: ChargeBlikByCodeParams): Promise<ChargeBlikData>;
+    /**
+     * Charge BLIK account by alias
+     *
+     * @param {ChargeBlikByAliasParams} params - BLIK charge parameters
+     * @returns {Promise<ChargeBlikData>} - BLIK charge data
+     * @throws {P24Error}
+     * @memberof P24
+     */
+    chargeBlikByAlias(params: ChargeBlikByAliasParams): Promise<ChargeBlikData>;
+    /**
+     * Get BLIK aliases by email
+     *
+     * @param {string} email - Customer email
+     * @returns {Promise<BlikAlias[]>} - List of BLIK aliases
+     * @throws {P24Error}
+     * @memberof P24
+     */
+    getBlikAliasesByEmail(email: string): Promise<BlikAlias[]>;
+    /**
+     * Get BLIK aliases by email (for aliases registered with aliasValue and aliasLabel fields)
+     *
+     * @param {string} email - Customer email
+     * @returns {Promise<BlikAlias[]>} - List of BLIK aliases
+     * @throws {P24Error}
+     * @memberof P24
+     */
+    getBlikAliasesByEmailCustom(email: string): Promise<BlikAlias[]>;
+    /**
+     * Validates IP with P24 backends
+     *
+     * @static
+     * @param {string} ip - IP Address
+     * @returns {boolean} - true on validated ip
+     * @memberof Przelewy24
+     */
+    static isIpValid(ip: string): boolean;
+}
+//# sourceMappingURL=P24.d.ts.map

package/dist/p24/P24.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"P24.d.ts","sourceRoot":"","sources":["../../src/p24/P24.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAIH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAQ1C,OAAO,EACH,KAAK,EAEL,WAAW,EACd,MAAM,WAAW,CAAC;AAenB,OAAO,EACH,YAAY,EACZ,mBAAmB,EAEtB,MAAM,WAAW,CAAC;AACnB,OAAO,EACH,aAAa,EACb,YAAY,EACf,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AACpG,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAIrG;;;;;GAKG;AACH,qBAAa,GAAG;IACZ,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,CAAC,cAAc,CAAiB;IAEvC;;;;;;;;MAQE;gBAEE,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,UAA+B;IA0B5C;;;;;;OAMG;IACH,OAAO,CAAC,cAAc;IAQtB;;;;;;OAMG;IACU,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IAU3C;;;;;;;OAOG;IACU,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC;IAgClE;;;;;;;OAOG;IACU,iBAAiB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IA0B5E;;;;;;OAMG;IACI,kBAAkB,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,OAAO;IAU5E;;;;;;OAMG;IACU,MAAM,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAU1E;;;;;;OAMG;IACU,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAYlF;;;;;;OAMG;IACU,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;KAAE,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAgB3H;;;;;;;OAOG;IACU,0BAA0B,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAanF;;;;;;;OAOG;IACU,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;IAazE;;;;;;;OAOG;IACU,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAWlF;;;;;;;OAOG;IACU,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAavE;;;;;;;OAOG;IACU,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAajE;;;;;;;OAOG;IACU,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,GAAG,mBAAmB,CAAC;IAa9G;;;;;;OAMG;IACI,sBAAsB,CAAC,uBAAuB,EAAE,uBAAuB,GAAG,OAAO;IAWxF;;;;;;;OAOG;IACU,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,cAAc,CAAC;IAWtF;;;;;;;OAOG;IACU,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,cAAc,CAAC;IAUxF;;;;;;;OAOG;IACU,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAUvE;;;;;;;OAOG;IACU,2BAA2B,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAU7E;;;;;;;OAOG;WACW,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;CAI/C"}