bitapy-sdk 6.2.1

package/dist/Client/InvoiceClient.js

@@ -0,0 +1,222 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvoiceClient = void 0;
+const BitPayResponseParser_1 = require("../util/BitPayResponseParser");
+const BitPayExceptionProvider_1 = require("../Exceptions/BitPayExceptionProvider");
+const Facade_1 = require("../Facade");
+class InvoiceClient {
+    constructor(bitPayClient, tokenContainer, guidGenerator) {
+        this.bitPayClient = bitPayClient;
+        this.tokenContainer = tokenContainer;
+        this.guidGenerator = guidGenerator;
+    }
+    /**
+     * Create a BitPay invoice.
+     *
+     * @param invoice An Invoice object with request parameters defined
+     * @param facade The facade used to create it.
+     * @param signRequest Signed request.
+     * @returns Invoice
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    async create(invoice, facade, signRequest) {
+        invoice.guid = invoice.guid ? invoice.guid : this.guidGenerator.execute();
+        invoice.token = this.tokenContainer.getToken(facade);
+        const result = await this.bitPayClient.post('invoices', invoice, signRequest);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Invoice', e.message);
+            throw new Error();
+        }
+    }
+    /**
+     * Retrieve a BitPay invoice by invoice id using the specified facade. The client must have been previously
+     * authorized for the specified facade (the public facade requires no authorization).
+     *
+     * @param invoiceId The id of the invoice to retrieve.
+     * @param facade The facade used to create it.
+     * @param signRequest Signed request.
+     * @returns Invoice
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    async get(invoiceId, facade, signRequest) {
+        const params = { token: this.tokenContainer.getToken(facade) };
+        const result = await this.bitPayClient.get('invoices/' + invoiceId, params, signRequest);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Invoice', e.message);
+            throw new Error();
+        }
+    }
+    /**
+     * @param guid
+     * @param facade
+     * @param signRequest
+     * @returns Invoice
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    async getByGuid(guid, facade, signRequest) {
+        const params = { token: this.tokenContainer.getToken(facade) };
+        const result = await this.bitPayClient.get('invoices/guid/' + guid, params, signRequest);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Invoice', e.message);
+            throw new Error();
+        }
+    }
+    /**
+     * Retrieve a collection of BitPay invoices.
+     *
+     * @param params
+     * @returns Invoice[]
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    async getInvoices(params) {
+        params['token'] = this.tokenContainer.getToken(Facade_1.Facade.Merchant);
+        const result = await this.bitPayClient.get('invoices', params, true);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Invoice', e.message);
+            throw new Error();
+        }
+    }
+    /**
+     *
+     * @param invoiceId
+     * @returns
+     */
+    async getInvoiceEventToken(invoiceId) {
+        const params = {};
+        params['token'] = this.tokenContainer.getToken(Facade_1.Facade.Merchant);
+        const result = await this.bitPayClient.get('invoices/' + invoiceId + '/events', params, true);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Invoice', e.message);
+            throw new Error();
+        }
+    }
+    /**
+     * Update a BitPay invoice.
+     *
+     * @param invoiceId The id of the invoice to updated.
+     * @param params
+     * @returns Invoice
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    async update(invoiceId, params) {
+        params['token'] = this.tokenContainer.getToken(Facade_1.Facade.Merchant);
+        const result = await this.bitPayClient.put('invoices/' + invoiceId, params);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Invoice', e.message);
+            throw new Error();
+        }
+    }
+    /**
+     * Pay an invoice with a mock transaction
+     *
+     * @param invoiceId The id of the invoice.
+     * @param status  Status the invoice will become. Acceptable values are confirmed (default) and complete.
+     * @returns Invoice Invoice object.
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    async pay(invoiceId, status) {
+        const params = {
+            token: this.tokenContainer.getToken(Facade_1.Facade.Merchant),
+            status: status
+        };
+        const result = await this.bitPayClient.put('invoices/pay/' + invoiceId, params);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Invoice', e.message);
+            throw new Error();
+        }
+    }
+    /**
+     * Cancel a BitPay invoice.
+     *
+     * @param invoiceId The id of the invoice to updated.
+     * @param forceCancel
+     * @returns Invoice  Cancelled invoice object.
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    async cancel(invoiceId, forceCancel) {
+        const params = {
+            token: this.tokenContainer.getToken(Facade_1.Facade.Merchant),
+            forceCancel: forceCancel
+        };
+        const result = await this.bitPayClient.delete('invoices/' + invoiceId, params);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Invoice', e.message);
+            throw new Error();
+        }
+    }
+    /**
+     * Cancel a BitPay invoice.
+     *
+     * @param guid The guid of the invoice to cancel.
+     * @param forceCancel
+     * @returns Invoice Cancelled invoice object.
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    async cancelByGuid(guid, forceCancel) {
+        const params = {
+            token: this.tokenContainer.getToken(Facade_1.Facade.Merchant),
+            forceCancel: forceCancel
+        };
+        const result = await this.bitPayClient.delete('invoices/guid/' + guid, params);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Invoice', e.message);
+            throw new Error();
+        }
+    }
+    /**
+     * Request a BitPay Invoice Webhook.
+     *
+     * @param invoiceId A BitPay invoice ID.
+     * @returns boolean
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    async requestInvoiceWebhookToBeResent(invoiceId) {
+        const params = { token: this.tokenContainer.getToken(Facade_1.Facade.Merchant) };
+        const result = await this.bitPayClient.post('invoices/' + invoiceId + '/notifications', params);
+        try {
+            return BitPayResponseParser_1.BitPayResponseParser.jsonToBoolean(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Invoice', e.message);
+            throw new Error();
+        }
+    }
+}
+exports.InvoiceClient = InvoiceClient;
+//# sourceMappingURL=InvoiceClient.js.map

package/dist/Client/LedgerClient.d.ts

@@ -0,0 +1,26 @@
+import { BitPayClient } from './BitPayClient';
+import { TokenContainer } from '../TokenContainer';
+import { LedgerEntryInterface, LedgerInterface } from '../Model';
+export declare class LedgerClient {
+    private bitPayClient;
+    private tokenContainer;
+    constructor(bitPayClient: BitPayClient, tokenContainer: TokenContainer);
+    /**
+     * Retrieve a list of ledgers using the merchant facade.
+     *
+     * @return A list of Ledger objects populated with the currency and current balance of each one.
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    getLedgers(): Promise<LedgerInterface[]>;
+    /**
+     * Retrieve a list of ledgers by params
+     *
+     * @param currency
+     * @param params
+     * @returns ledgers
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    getEntries(currency: string, params: object): Promise<LedgerEntryInterface[]>;
+}

package/dist/Client/LedgerClient.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LedgerClient = void 0;
+const Facade_1 = require("../Facade");
+const BitPayExceptionProvider_1 = require("../Exceptions/BitPayExceptionProvider");
+class LedgerClient {
+    constructor(bitPayClient, tokenContainer) {
+        this.bitPayClient = bitPayClient;
+        this.tokenContainer = tokenContainer;
+    }
+    /**
+     * Retrieve a list of ledgers using the merchant facade.
+     *
+     * @return A list of Ledger objects populated with the currency and current balance of each one.
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    async getLedgers() {
+        const params = { token: this.tokenContainer.getToken(Facade_1.Facade.Merchant) };
+        const result = await this.bitPayClient.get('ledgers', params, true);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Ledger', e.message);
+            throw new Error();
+        }
+    }
+    /**
+     * Retrieve a list of ledgers by params
+     *
+     * @param currency
+     * @param params
+     * @returns ledgers
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    async getEntries(currency, params) {
+        params['token'] = this.tokenContainer.getToken(Facade_1.Facade.Merchant);
+        const result = await this.bitPayClient.get('ledgers/' + currency, params, true);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Ledger', e.message);
+            throw new Error();
+        }
+    }
+}
+exports.LedgerClient = LedgerClient;
+//# sourceMappingURL=LedgerClient.js.map

package/dist/Client/PayoutClient.d.ts

@@ -0,0 +1,51 @@
+import { BitPayClient } from './BitPayClient';
+import { TokenContainer } from '../TokenContainer';
+import { GuidGenerator } from '../util/GuidGenerator';
+import { PayoutInterface } from '../Model';
+export declare class PayoutClient {
+    private bitPayClient;
+    private tokenContainer;
+    private guidGenerator;
+    constructor(bitPayClient: BitPayClient, tokenContainer: TokenContainer, guidGenerator: GuidGenerator);
+    /**
+     * Submit a BitPay Payout.
+     *
+     * @param payout Payout object with request parameters defined.
+     * @returns Payout
+     * @throws PayoutCreationException
+     */
+    submit(payout: PayoutInterface): Promise<PayoutInterface>;
+    /**
+     * Retrieve a BitPay payout by payout id using. The client must have been previously authorized
+     * for the payout facade.
+     *
+     * @param payoutId The id of the payout to retrieve.
+     * @returns Payout
+     * @throws PayoutQueryException
+     */
+    get(payoutId: string): Promise<PayoutInterface>;
+    /**
+     * Retrieve a collection of BitPay payouts.
+     *
+     * @param params
+     * @returns Payout[]
+     * @throws PayoutQueryException
+     */
+    getPayouts(params: object): Promise<PayoutInterface[]>;
+    /**
+     * Notify BitPay Payout.
+     *
+     * @param payoutId The id of the Payout to notify.
+     * @returns boolean
+     * @throws PayoutNotificationException
+     */
+    requestNotification: (payoutId: string) => Promise<boolean>;
+    /**
+     *  Cancel a BitPay Payout.
+     *
+     * @param payoutId
+     * @returns boolean
+     * @throws PayoutDeleteException
+     */
+    cancel: (payoutId: string) => Promise<boolean>;
+}

package/dist/Client/PayoutClient.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayoutClient = void 0;
+const Facade_1 = require("../Facade");
+const BitPayResponseParser_1 = require("../util/BitPayResponseParser");
+const BitPayExceptionProvider_1 = require("../Exceptions/BitPayExceptionProvider");
+class PayoutClient {
+    constructor(bitPayClient, tokenContainer, guidGenerator) {
+        /**
+         * Notify BitPay Payout.
+         *
+         * @param payoutId The id of the Payout to notify.
+         * @returns boolean
+         * @throws PayoutNotificationException
+         */
+        this.requestNotification = async (payoutId) => {
+            const params = { token: this.tokenContainer.getToken(Facade_1.Facade.Payout) };
+            const result = await this.bitPayClient.post('payouts/' + payoutId + '/notifications', params, true);
+            try {
+                return BitPayResponseParser_1.BitPayResponseParser.jsonToBoolean(result);
+            }
+            catch (e) {
+                BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Payout', e.message);
+                throw new Error();
+            }
+        };
+        /**
+         *  Cancel a BitPay Payout.
+         *
+         * @param payoutId
+         * @returns boolean
+         * @throws PayoutDeleteException
+         */
+        this.cancel = async (payoutId) => {
+            const params = { token: this.tokenContainer.getToken(Facade_1.Facade.Payout) };
+            const result = await this.bitPayClient.delete('payouts/' + payoutId, params, true);
+            try {
+                return BitPayResponseParser_1.BitPayResponseParser.jsonToBoolean(result);
+            }
+            catch (e) {
+                BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Payout', e.message);
+                throw new Error();
+            }
+        };
+        this.bitPayClient = bitPayClient;
+        this.tokenContainer = tokenContainer;
+        this.guidGenerator = guidGenerator;
+    }
+    /**
+     * Submit a BitPay Payout.
+     *
+     * @param payout Payout object with request parameters defined.
+     * @returns Payout
+     * @throws PayoutCreationException
+     */
+    async submit(payout) {
+        payout.token = this.tokenContainer.getToken(Facade_1.Facade.Payout);
+        const result = await this.bitPayClient.post('payouts', payout, true);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Payout', e.message);
+            throw new Error();
+        }
+    }
+    /**
+     * Retrieve a BitPay payout by payout id using. The client must have been previously authorized
+     * for the payout facade.
+     *
+     * @param payoutId The id of the payout to retrieve.
+     * @returns Payout
+     * @throws PayoutQueryException
+     */
+    async get(payoutId) {
+        const params = { token: this.tokenContainer.getToken(Facade_1.Facade.Payout) };
+        const result = await this.bitPayClient.get('payouts/' + payoutId, params, true);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Payout', e.message);
+            throw new Error();
+        }
+    }
+    /**
+     * Retrieve a collection of BitPay payouts.
+     *
+     * @param params
+     * @returns Payout[]
+     * @throws PayoutQueryException
+     */
+    async getPayouts(params) {
+        params['token'] = this.tokenContainer.getToken(Facade_1.Facade.Payout);
+        const result = await this.bitPayClient.get('payouts', params, true);
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Payout', e.message);
+            throw new Error();
+        }
+    }
+}
+exports.PayoutClient = PayoutClient;
+//# sourceMappingURL=PayoutClient.js.map

package/dist/Client/PayoutGroupClient.d.ts

@@ -0,0 +1,25 @@
+import { BitPayClient } from './BitPayClient';
+import { TokenContainer } from '../TokenContainer';
+import { GuidGenerator } from '../util/GuidGenerator';
+import { PayoutGroupInterface, PayoutInterface } from '../Model';
+export declare class PayoutGroupClient {
+    private bitPayClient;
+    private tokenContainer;
+    private guidGenerator;
+    constructor(bitPayClient: BitPayClient, tokenContainer: TokenContainer, guidGenerator: GuidGenerator);
+    /**
+     *
+     * @param payouts
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    submitPayouts: (payouts: PayoutInterface[]) => Promise<PayoutGroupInterface>;
+    /**
+     *
+     * @param payoutGroupId
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    cancelPayouts: (payoutGroupId: string) => Promise<PayoutGroupInterface>;
+    private static getPayoutGroupResponse;
+}

package/dist/Client/PayoutGroupClient.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayoutGroupClient = void 0;
+const Facade_1 = require("../Facade");
+const BitPayExceptionProvider_1 = require("../Exceptions/BitPayExceptionProvider");
+const PayoutGroup_1 = require("../Model/Payout/PayoutGroup");
+class PayoutGroupClient {
+    constructor(bitPayClient, tokenContainer, guidGenerator) {
+        /**
+         *
+         * @param payouts
+         * @throws BitPayApiException BitPayApiException class
+         * @throws BitPayGenericException BitPayGenericException class
+         */
+        this.submitPayouts = async (payouts) => {
+            const params = { token: this.tokenContainer.getToken(Facade_1.Facade.Payout), instructions: payouts };
+            const result = await this.bitPayClient.post('payouts/group', params, true);
+            return PayoutGroupClient.getPayoutGroupResponse(result, 'created');
+        };
+        /**
+         *
+         * @param payoutGroupId
+         * @throws BitPayApiException BitPayApiException class
+         * @throws BitPayGenericException BitPayGenericException class
+         */
+        this.cancelPayouts = async (payoutGroupId) => {
+            const params = { token: this.tokenContainer.getToken(Facade_1.Facade.Payout) };
+            const result = await this.bitPayClient.delete('payouts/group/' + payoutGroupId, params, true);
+            return PayoutGroupClient.getPayoutGroupResponse(result, 'cancelled');
+        };
+        this.bitPayClient = bitPayClient;
+        this.tokenContainer = tokenContainer;
+        this.guidGenerator = guidGenerator;
+    }
+    static getPayoutGroupResponse(json, responseType) {
+        const response = JSON.parse(json);
+        if (!(responseType in response)) {
+            BitPayExceptionProvider_1.BitPayExceptionProvider.throwDeserializeResourceException('Payout Group', response);
+        }
+        return new PayoutGroup_1.PayoutGroup(response[responseType], response['failed']);
+    }
+}
+exports.PayoutGroupClient = PayoutGroupClient;
+//# sourceMappingURL=PayoutGroupClient.js.map

package/dist/Client/PayoutRecipientClient.d.ts

@@ -0,0 +1,65 @@
+import { BitPayClient } from './BitPayClient';
+import { TokenContainer } from '../TokenContainer';
+import { GuidGenerator } from '../util/GuidGenerator';
+import { PayoutRecipientInterface, PayoutRecipients } from '../Model';
+export declare class PayoutRecipientClient {
+    private bitPayClient;
+    private tokenContainer;
+    private guidGenerator;
+    constructor(bitPayClient: BitPayClient, tokenContainer: TokenContainer, guidGenerator: GuidGenerator);
+    /**
+     * Submit BitPay Payout Recipients.
+     *
+     * @param recipients A PayoutRecipients object with request parameters defined.
+     * @returns PayoutRecipients[]  A list of BitPay PayoutRecipients objects.
+     * @throws BitPayApiException  BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    submit(recipients: PayoutRecipients): Promise<PayoutRecipientInterface[]>;
+    /**
+     * Update a Payout Recipient.
+     *
+     * @param recipientId The recipient id for the recipient to be updated.
+     * @param recipient A PayoutRecipient object with updated parameters defined.
+     * @returns PayoutRecipient
+     * @throws BitPayApiException  BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    update(recipientId: string, recipient: PayoutRecipientInterface): Promise<PayoutRecipientInterface>;
+    /**
+     * Retrieve a BitPay payout recipient by batch id using.  The client must have been previously authorized for the payout facade.
+     *
+     * @param recipientId The id of the recipient to retrieve.
+     * @returns PayoutRecipient
+     * @throws BitPayApiException  BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    get(recipientId: string): Promise<PayoutRecipientInterface>;
+    /**
+     * Retrieve a collection of BitPay Payout Recipients.
+     *
+     * @param params
+     * @returns PayoutRecipient[]
+     * @throws BitPayApiException  BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    getByFilters(params: object): Promise<PayoutRecipientInterface[]>;
+    /**
+     * Delete a Payout Recipient.
+     *
+     * @param recipientId The recipient id for the recipient to be deleted.
+     * @returns boolean True if the recipient was successfully deleted, false otherwise.
+     * @throws BitPayApiException  BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    delete(recipientId: string): Promise<boolean>;
+    /**
+     * Notify BitPay Payout Recipient.
+     *
+     * @param recipientId The id of the recipient to notify.
+     * @returns boolean  True if the notification was successfully sent, false otherwise.
+     * @throws BitPayApiException  BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
+     */
+    requestNotification(recipientId: string): Promise<boolean>;
+}