@payabli/sdk-node 0.0.116 → 0.0.117
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -7
- package/dist/cjs/BaseClient.d.ts +10 -1
- package/dist/cjs/BaseClient.js +57 -0
- package/dist/cjs/Client.d.ts +87 -86
- package/dist/cjs/Client.js +31 -72
- package/dist/cjs/api/resources/bill/client/Client.d.ts +33 -33
- package/dist/cjs/api/resources/bill/client/Client.js +69 -216
- package/dist/cjs/api/resources/boarding/client/Client.d.ts +27 -27
- package/dist/cjs/api/resources/boarding/client/Client.js +51 -198
- package/dist/cjs/api/resources/chargeBacks/client/Client.d.ts +17 -15
- package/dist/cjs/api/resources/chargeBacks/client/Client.js +38 -79
- package/dist/cjs/api/resources/checkCapture/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/checkCapture/client/Client.js +11 -28
- package/dist/cjs/api/resources/cloud/client/Client.d.ts +17 -17
- package/dist/cjs/api/resources/cloud/client/Client.js +33 -89
- package/dist/cjs/api/resources/customer/client/Client.d.ts +17 -17
- package/dist/cjs/api/resources/customer/client/Client.js +31 -113
- package/dist/cjs/api/resources/export/client/Client.d.ts +93 -89
- package/dist/cjs/api/resources/export/client/Client.js +205 -582
- package/dist/cjs/api/resources/hostedPaymentPages/client/Client.d.ts +11 -11
- package/dist/cjs/api/resources/hostedPaymentPages/client/Client.js +19 -62
- package/dist/cjs/api/resources/import/client/Client.d.ts +11 -11
- package/dist/cjs/api/resources/import/client/Client.js +19 -62
- package/dist/cjs/api/resources/invoice/client/Client.d.ts +31 -31
- package/dist/cjs/api/resources/invoice/client/Client.js +62 -209
- package/dist/cjs/api/resources/lineItem/client/Client.d.ts +15 -15
- package/dist/cjs/api/resources/lineItem/client/Client.js +27 -96
- package/dist/cjs/api/resources/moneyIn/client/Client.d.ts +39 -39
- package/dist/cjs/api/resources/moneyIn/client/Client.js +79 -249
- package/dist/cjs/api/resources/moneyOut/client/Client.d.ts +43 -26
- package/dist/cjs/api/resources/moneyOut/client/Client.js +105 -168
- package/dist/cjs/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.ts +2 -1
- package/dist/cjs/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.ts +3 -1
- package/dist/cjs/api/resources/notification/client/Client.d.ts +16 -16
- package/dist/cjs/api/resources/notification/client/Client.js +32 -101
- package/dist/cjs/api/resources/notificationlogs/client/Client.d.ts +13 -13
- package/dist/cjs/api/resources/notificationlogs/client/Client.js +23 -79
- package/dist/cjs/api/resources/ocr/client/Client.d.ts +13 -9
- package/dist/cjs/api/resources/ocr/client/Client.js +19 -45
- package/dist/cjs/api/resources/organization/client/Client.d.ts +19 -19
- package/dist/cjs/api/resources/organization/client/Client.js +35 -130
- package/dist/cjs/api/resources/paymentLink/client/Client.d.ts +23 -23
- package/dist/cjs/api/resources/paymentLink/client/Client.js +43 -164
- package/dist/cjs/api/resources/paymentMethodDomain/client/Client.d.ts +19 -19
- package/dist/cjs/api/resources/paymentMethodDomain/client/Client.js +35 -130
- package/dist/cjs/api/resources/paypoint/client/Client.d.ts +22 -22
- package/dist/cjs/api/resources/paypoint/client/Client.js +44 -152
- package/dist/cjs/api/resources/query/client/Client.d.ts +71 -71
- package/dist/cjs/api/resources/query/client/Client.js +137 -572
- package/dist/cjs/api/resources/query/client/requests/ListPayoutOrgRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/ListPayoutRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransactionsRequest.d.ts +1 -0
- package/dist/cjs/api/resources/statistic/client/Client.d.ts +50 -50
- package/dist/cjs/api/resources/statistic/client/Client.js +80 -133
- package/dist/cjs/api/resources/statistic/client/requests/BasicStatsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/statistic/types/StatBasicExtendedQueryRecord.d.ts +76 -0
- package/dist/cjs/api/resources/statistic/types/StatBasicExtendedQueryRecord.js +3 -0
- package/dist/cjs/api/resources/statistic/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/statistic/types/index.js +1 -0
- package/dist/cjs/api/resources/subscription/client/Client.d.ts +13 -13
- package/dist/cjs/api/resources/subscription/client/Client.js +23 -79
- package/dist/cjs/api/resources/templates/client/Client.d.ts +15 -15
- package/dist/cjs/api/resources/templates/client/Client.js +28 -84
- package/dist/cjs/api/resources/tokenStorage/client/Client.d.ts +13 -13
- package/dist/cjs/api/resources/tokenStorage/client/Client.js +23 -79
- package/dist/cjs/api/resources/user/client/Client.d.ts +54 -32
- package/dist/cjs/api/resources/user/client/Client.js +84 -222
- package/dist/cjs/api/resources/vendor/client/Client.d.ts +13 -13
- package/dist/cjs/api/resources/vendor/client/Client.js +23 -79
- package/dist/cjs/api/resources/wallet/client/Client.d.ts +13 -13
- package/dist/cjs/api/resources/wallet/client/Client.js +23 -79
- package/dist/cjs/api/types/ApplicationDetailsRecord.d.ts +2 -2
- package/dist/cjs/api/types/NotificationContent.d.ts +1 -0
- package/dist/cjs/api/types/NotificationContent.js +1 -0
- package/dist/cjs/api/types/NotificationStandardRequest.d.ts +1 -0
- package/dist/cjs/api/types/NotificationStandardRequest.js +1 -0
- package/dist/cjs/api/types/QueryResponseSettlements.d.ts +1 -1
- package/dist/cjs/auth/HeaderAuthProvider.d.ts +14 -0
- package/dist/cjs/auth/HeaderAuthProvider.js +71 -0
- package/dist/cjs/auth/index.d.ts +1 -0
- package/dist/cjs/auth/index.js +5 -0
- package/dist/cjs/core/auth/AuthProvider.d.ts +7 -0
- package/dist/cjs/{version.js → core/auth/AuthProvider.js} +0 -2
- package/dist/cjs/core/auth/AuthRequest.d.ts +9 -0
- package/dist/cjs/core/auth/AuthRequest.js +2 -0
- package/dist/cjs/core/auth/BasicAuth.d.ts +8 -0
- package/dist/cjs/core/auth/BasicAuth.js +27 -0
- package/dist/cjs/core/auth/BearerToken.d.ts +7 -0
- package/dist/cjs/core/auth/BearerToken.js +16 -0
- package/dist/cjs/core/auth/NoOpAuthProvider.d.ts +5 -0
- package/dist/cjs/core/auth/NoOpAuthProvider.js +9 -0
- package/dist/cjs/core/auth/index.d.ts +5 -0
- package/dist/cjs/core/auth/index.js +9 -0
- package/dist/cjs/core/base64.d.ts +2 -0
- package/dist/cjs/core/base64.js +26 -0
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +6 -7
- package/dist/cjs/core/fetcher/Fetcher.d.ts +5 -1
- package/dist/cjs/core/fetcher/Fetcher.js +42 -24
- package/dist/cjs/core/fetcher/getResponseBody.js +18 -4
- package/dist/cjs/core/fetcher/makeRequest.d.ts +1 -1
- package/dist/cjs/core/fetcher/makeRequest.js +0 -2
- package/dist/cjs/core/fetcher/requestWithRetries.js +0 -9
- package/dist/cjs/core/fetcher/signals.d.ts +1 -7
- package/dist/cjs/core/fetcher/signals.js +0 -12
- package/dist/cjs/core/index.d.ts +2 -0
- package/dist/cjs/core/index.js +2 -0
- package/dist/cjs/core/logging/logger.js +1 -1
- package/dist/cjs/core/runtime/runtime.js +11 -10
- package/dist/cjs/core/url/join.js +0 -1
- package/dist/cjs/errors/handleNonStatusCodeError.d.ts +2 -0
- package/dist/cjs/errors/handleNonStatusCodeError.js +65 -0
- package/dist/esm/BaseClient.d.mts +10 -1
- package/dist/esm/BaseClient.mjs +22 -1
- package/dist/esm/Client.d.mts +87 -86
- package/dist/esm/Client.mjs +59 -67
- package/dist/esm/api/resources/bill/client/Client.d.mts +33 -33
- package/dist/esm/api/resources/bill/client/Client.mjs +67 -214
- package/dist/esm/api/resources/boarding/client/Client.d.mts +27 -27
- package/dist/esm/api/resources/boarding/client/Client.mjs +50 -197
- package/dist/esm/api/resources/chargeBacks/client/Client.d.mts +17 -15
- package/dist/esm/api/resources/chargeBacks/client/Client.mjs +36 -77
- package/dist/esm/api/resources/checkCapture/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/checkCapture/client/Client.mjs +10 -27
- package/dist/esm/api/resources/cloud/client/Client.d.mts +17 -17
- package/dist/esm/api/resources/cloud/client/Client.mjs +31 -87
- package/dist/esm/api/resources/customer/client/Client.d.mts +17 -17
- package/dist/esm/api/resources/customer/client/Client.mjs +29 -111
- package/dist/esm/api/resources/export/client/Client.d.mts +93 -89
- package/dist/esm/api/resources/export/client/Client.mjs +204 -581
- package/dist/esm/api/resources/hostedPaymentPages/client/Client.d.mts +11 -11
- package/dist/esm/api/resources/hostedPaymentPages/client/Client.mjs +17 -60
- package/dist/esm/api/resources/import/client/Client.d.mts +11 -11
- package/dist/esm/api/resources/import/client/Client.mjs +17 -60
- package/dist/esm/api/resources/invoice/client/Client.d.mts +31 -31
- package/dist/esm/api/resources/invoice/client/Client.mjs +60 -207
- package/dist/esm/api/resources/lineItem/client/Client.d.mts +15 -15
- package/dist/esm/api/resources/lineItem/client/Client.mjs +25 -94
- package/dist/esm/api/resources/moneyIn/client/Client.d.mts +39 -39
- package/dist/esm/api/resources/moneyIn/client/Client.mjs +77 -247
- package/dist/esm/api/resources/moneyOut/client/Client.d.mts +43 -26
- package/dist/esm/api/resources/moneyOut/client/Client.mjs +103 -166
- package/dist/esm/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.mts +2 -1
- package/dist/esm/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.mts +3 -1
- package/dist/esm/api/resources/notification/client/Client.d.mts +16 -16
- package/dist/esm/api/resources/notification/client/Client.mjs +31 -100
- package/dist/esm/api/resources/notificationlogs/client/Client.d.mts +13 -13
- package/dist/esm/api/resources/notificationlogs/client/Client.mjs +22 -78
- package/dist/esm/api/resources/ocr/client/Client.d.mts +13 -9
- package/dist/esm/api/resources/ocr/client/Client.mjs +18 -44
- package/dist/esm/api/resources/organization/client/Client.d.mts +19 -19
- package/dist/esm/api/resources/organization/client/Client.mjs +33 -128
- package/dist/esm/api/resources/paymentLink/client/Client.d.mts +23 -23
- package/dist/esm/api/resources/paymentLink/client/Client.mjs +41 -162
- package/dist/esm/api/resources/paymentMethodDomain/client/Client.d.mts +19 -19
- package/dist/esm/api/resources/paymentMethodDomain/client/Client.mjs +34 -129
- package/dist/esm/api/resources/paypoint/client/Client.d.mts +22 -22
- package/dist/esm/api/resources/paypoint/client/Client.mjs +43 -151
- package/dist/esm/api/resources/query/client/Client.d.mts +71 -71
- package/dist/esm/api/resources/query/client/Client.mjs +136 -571
- package/dist/esm/api/resources/query/client/requests/ListPayoutOrgRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/ListPayoutRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/ListTransactionsRequest.d.mts +1 -0
- package/dist/esm/api/resources/statistic/client/Client.d.mts +50 -50
- package/dist/esm/api/resources/statistic/client/Client.mjs +79 -132
- package/dist/esm/api/resources/statistic/client/requests/BasicStatsRequest.d.mts +2 -2
- package/dist/esm/api/resources/statistic/types/StatBasicExtendedQueryRecord.d.mts +76 -0
- package/dist/esm/api/resources/statistic/types/StatBasicExtendedQueryRecord.mjs +2 -0
- package/dist/esm/api/resources/statistic/types/index.d.mts +1 -0
- package/dist/esm/api/resources/statistic/types/index.mjs +1 -0
- package/dist/esm/api/resources/subscription/client/Client.d.mts +13 -13
- package/dist/esm/api/resources/subscription/client/Client.mjs +21 -77
- package/dist/esm/api/resources/templates/client/Client.d.mts +15 -15
- package/dist/esm/api/resources/templates/client/Client.mjs +27 -83
- package/dist/esm/api/resources/tokenStorage/client/Client.d.mts +13 -13
- package/dist/esm/api/resources/tokenStorage/client/Client.mjs +21 -77
- package/dist/esm/api/resources/user/client/Client.d.mts +54 -32
- package/dist/esm/api/resources/user/client/Client.mjs +83 -221
- package/dist/esm/api/resources/vendor/client/Client.d.mts +13 -13
- package/dist/esm/api/resources/vendor/client/Client.mjs +22 -78
- package/dist/esm/api/resources/wallet/client/Client.d.mts +13 -13
- package/dist/esm/api/resources/wallet/client/Client.mjs +22 -78
- package/dist/esm/api/types/ApplicationDetailsRecord.d.mts +2 -2
- package/dist/esm/api/types/NotificationContent.d.mts +1 -0
- package/dist/esm/api/types/NotificationContent.mjs +1 -0
- package/dist/esm/api/types/NotificationStandardRequest.d.mts +1 -0
- package/dist/esm/api/types/NotificationStandardRequest.mjs +1 -0
- package/dist/esm/api/types/QueryResponseSettlements.d.mts +1 -1
- package/dist/esm/auth/HeaderAuthProvider.d.mts +14 -0
- package/dist/esm/auth/HeaderAuthProvider.mjs +34 -0
- package/dist/esm/auth/index.d.mts +1 -0
- package/dist/esm/auth/index.mjs +1 -0
- package/dist/esm/core/auth/AuthProvider.d.mts +7 -0
- package/dist/esm/core/auth/AuthProvider.mjs +1 -0
- package/dist/esm/core/auth/AuthRequest.d.mts +9 -0
- package/dist/esm/core/auth/AuthRequest.mjs +1 -0
- package/dist/esm/core/auth/BasicAuth.d.mts +8 -0
- package/dist/esm/core/auth/BasicAuth.mjs +24 -0
- package/dist/esm/core/auth/BearerToken.d.mts +7 -0
- package/dist/esm/core/auth/BearerToken.mjs +13 -0
- package/dist/esm/core/auth/NoOpAuthProvider.d.mts +5 -0
- package/dist/esm/core/auth/NoOpAuthProvider.mjs +5 -0
- package/dist/esm/core/auth/index.d.mts +5 -0
- package/dist/esm/core/auth/index.mjs +3 -0
- package/dist/esm/core/base64.d.mts +2 -0
- package/dist/esm/core/base64.mjs +22 -0
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +6 -7
- package/dist/esm/core/fetcher/Fetcher.d.mts +5 -1
- package/dist/esm/core/fetcher/Fetcher.mjs +42 -24
- package/dist/esm/core/fetcher/getResponseBody.mjs +18 -4
- package/dist/esm/core/fetcher/makeRequest.d.mts +1 -1
- package/dist/esm/core/fetcher/makeRequest.mjs +0 -2
- package/dist/esm/core/fetcher/requestWithRetries.mjs +0 -9
- package/dist/esm/core/fetcher/signals.d.mts +1 -7
- package/dist/esm/core/fetcher/signals.mjs +0 -12
- package/dist/esm/core/index.d.mts +2 -0
- package/dist/esm/core/index.mjs +2 -0
- package/dist/esm/core/logging/logger.mjs +1 -1
- package/dist/esm/core/runtime/runtime.mjs +11 -10
- package/dist/esm/core/url/join.mjs +0 -1
- package/dist/esm/errors/handleNonStatusCodeError.d.mts +2 -0
- package/dist/esm/errors/handleNonStatusCodeError.mjs +29 -0
- package/package.json +4 -4
- package/reference.md +761 -473
- package/dist/cjs/core/fetcher/ResponseWithBody.d.ts +0 -4
- package/dist/cjs/core/fetcher/ResponseWithBody.js +0 -6
- package/dist/cjs/version.d.ts +0 -1
- package/dist/esm/core/fetcher/ResponseWithBody.d.mts +0 -4
- package/dist/esm/core/fetcher/ResponseWithBody.mjs +0 -3
- package/dist/esm/version.d.mts +0 -1
- package/dist/esm/version.mjs +0 -1
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
export interface StatBasicExtendedQueryRecord {
|
|
2
|
+
/** The time window based on the mode and frequency used for the query. */
|
|
3
|
+
statX: string;
|
|
4
|
+
/** Number of active vendors. */
|
|
5
|
+
outCustomers: number;
|
|
6
|
+
/** Number of new vendors. */
|
|
7
|
+
outNewCustomers: number;
|
|
8
|
+
/** Outbound (payout) transactions count. */
|
|
9
|
+
outTransactions: number;
|
|
10
|
+
/** Recurring outbound (payout) transactions count. */
|
|
11
|
+
outSubscriptionsPaid: number;
|
|
12
|
+
/** Outbound (payout) pCard transactions count. */
|
|
13
|
+
outCardTransactions: number;
|
|
14
|
+
/** Outbound (payout) vCard transactions count. */
|
|
15
|
+
outVCardTransactions: number;
|
|
16
|
+
/** Outbound (payout) ACH transactions count. */
|
|
17
|
+
outACHTransactions: number;
|
|
18
|
+
/** Outbound (payout) check transactions count. */
|
|
19
|
+
outCheckTransactions: number;
|
|
20
|
+
/** Outbound (payout) Managed Payables transactions count. */
|
|
21
|
+
outPendingMethodTransactions: number;
|
|
22
|
+
/** Outbound (payout) volume. */
|
|
23
|
+
outTransactionsVolume: number;
|
|
24
|
+
/** Recurring outbound (payout) volume. */
|
|
25
|
+
outSubscriptionsPaidVolume: number;
|
|
26
|
+
/** Outbound (payout) pCard transactions volume. */
|
|
27
|
+
outCardVolume: number;
|
|
28
|
+
/** Outbound (payout) vCard transactions volume. */
|
|
29
|
+
outVCardVolume: number;
|
|
30
|
+
/** Outbound (payout) ACH transactions volume. */
|
|
31
|
+
outACHVolume: number;
|
|
32
|
+
/** Outbound (payout) check transactions volume. */
|
|
33
|
+
outCheckVolume: number;
|
|
34
|
+
/** Outbound (payout) Managed Payables volume. */
|
|
35
|
+
outPendingMethodVolume: number;
|
|
36
|
+
/** Inbound transactions count. */
|
|
37
|
+
inTransactions: number;
|
|
38
|
+
/** Inbound recurring transactions count. */
|
|
39
|
+
inSubscriptionsPaid: number;
|
|
40
|
+
/** Number of active customers. */
|
|
41
|
+
inCustomers: number;
|
|
42
|
+
/** Number of new customers. */
|
|
43
|
+
inNewCustomers: number;
|
|
44
|
+
/** Inbound card transactions count. */
|
|
45
|
+
inCardTransactions: number;
|
|
46
|
+
/** Inbound ACH transactions count. */
|
|
47
|
+
inACHTransactions: number;
|
|
48
|
+
/** Inbound check transactions count. */
|
|
49
|
+
inCheckTransactions: number;
|
|
50
|
+
/** Inbound cash transactions count. */
|
|
51
|
+
inCashTransactions: number;
|
|
52
|
+
/** Inbound wallet transactions count. */
|
|
53
|
+
inWalletTransactions: number;
|
|
54
|
+
/** Inbound card chargebacks and returns count. */
|
|
55
|
+
inCardChargeBacks: number;
|
|
56
|
+
/** Inbound ACH returns count. */
|
|
57
|
+
inACHReturns: number;
|
|
58
|
+
/** Inbound volume. */
|
|
59
|
+
inTransactionsVolume: number;
|
|
60
|
+
/** Inbound recurring payments volume. */
|
|
61
|
+
inSubscriptionsPaidVolume: number;
|
|
62
|
+
/** Inbound card volume. */
|
|
63
|
+
inCardVolume: number;
|
|
64
|
+
/** Inbound ACH volume. */
|
|
65
|
+
inACHVolume: number;
|
|
66
|
+
/** Inbound check volume. */
|
|
67
|
+
inCheckVolume: number;
|
|
68
|
+
/** Inbound cash volume recognized. */
|
|
69
|
+
inCashVolume: number;
|
|
70
|
+
/** Inbound wallet transactions. */
|
|
71
|
+
inWalletVolume: number;
|
|
72
|
+
/** Inbound Card chargebacks and returns volume. */
|
|
73
|
+
inCardChargeBackVolume: number;
|
|
74
|
+
/** Inbound ACH returns volume. */
|
|
75
|
+
inACHReturnsVolume: number;
|
|
76
|
+
}
|
|
@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./StatBasicExtendedQueryRecord.js"), exports);
|
|
17
18
|
__exportStar(require("./StatBasicQueryRecord.js"), exports);
|
|
18
19
|
__exportStar(require("./StatisticsVendorQueryRecord.js"), exports);
|
|
19
20
|
__exportStar(require("./SubscriptionStatsQueryRecord.js"), exports);
|
|
@@ -1,20 +1,21 @@
|
|
|
1
1
|
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
|
|
2
3
|
import * as core from "../../../../core/index.js";
|
|
3
4
|
import * as Payabli from "../../../index.js";
|
|
4
|
-
export declare namespace
|
|
5
|
+
export declare namespace SubscriptionClient {
|
|
5
6
|
interface Options extends BaseClientOptions {
|
|
6
7
|
}
|
|
7
8
|
interface RequestOptions extends BaseRequestOptions {
|
|
8
9
|
}
|
|
9
10
|
}
|
|
10
|
-
export declare class
|
|
11
|
-
protected readonly _options:
|
|
12
|
-
constructor(
|
|
11
|
+
export declare class SubscriptionClient {
|
|
12
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<SubscriptionClient.Options>;
|
|
13
|
+
constructor(options?: SubscriptionClient.Options);
|
|
13
14
|
/**
|
|
14
15
|
* Retrieves a single subscription's details.
|
|
15
16
|
*
|
|
16
17
|
* @param {number} subId - The subscription ID.
|
|
17
|
-
* @param {
|
|
18
|
+
* @param {SubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
18
19
|
*
|
|
19
20
|
* @throws {@link Payabli.BadRequestError}
|
|
20
21
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -24,13 +25,13 @@ export declare class Subscription {
|
|
|
24
25
|
* @example
|
|
25
26
|
* await client.subscription.getSubscription(263)
|
|
26
27
|
*/
|
|
27
|
-
getSubscription(subId: number, requestOptions?:
|
|
28
|
+
getSubscription(subId: number, requestOptions?: SubscriptionClient.RequestOptions): core.HttpResponsePromise<Payabli.SubscriptionQueryRecords>;
|
|
28
29
|
private __getSubscription;
|
|
29
30
|
/**
|
|
30
31
|
* Creates a subscription or scheduled payment to run at a specified time and frequency.
|
|
31
32
|
*
|
|
32
33
|
* @param {Payabli.RequestSchedule} request
|
|
33
|
-
* @param {
|
|
34
|
+
* @param {SubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
34
35
|
*
|
|
35
36
|
* @throws {@link Payabli.BadRequestError}
|
|
36
37
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -120,13 +121,13 @@ export declare class Subscription {
|
|
|
120
121
|
* }
|
|
121
122
|
* })
|
|
122
123
|
*/
|
|
123
|
-
newSubscription(request: Payabli.RequestSchedule, requestOptions?:
|
|
124
|
+
newSubscription(request: Payabli.RequestSchedule, requestOptions?: SubscriptionClient.RequestOptions): core.HttpResponsePromise<Payabli.AddSubscriptionResponse>;
|
|
124
125
|
private __newSubscription;
|
|
125
126
|
/**
|
|
126
127
|
* Deletes a subscription, autopay, or recurring payment and prevents future charges.
|
|
127
128
|
*
|
|
128
129
|
* @param {number} subId - The subscription ID.
|
|
129
|
-
* @param {
|
|
130
|
+
* @param {SubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
130
131
|
*
|
|
131
132
|
* @throws {@link Payabli.BadRequestError}
|
|
132
133
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -136,14 +137,14 @@ export declare class Subscription {
|
|
|
136
137
|
* @example
|
|
137
138
|
* await client.subscription.removeSubscription(396)
|
|
138
139
|
*/
|
|
139
|
-
removeSubscription(subId: number, requestOptions?:
|
|
140
|
+
removeSubscription(subId: number, requestOptions?: SubscriptionClient.RequestOptions): core.HttpResponsePromise<Payabli.RemoveSubscriptionResponse>;
|
|
140
141
|
private __removeSubscription;
|
|
141
142
|
/**
|
|
142
143
|
* Updates a subscription's details.
|
|
143
144
|
*
|
|
144
145
|
* @param {number} subId - The subscription ID.
|
|
145
146
|
* @param {Payabli.RequestUpdateSchedule} request
|
|
146
|
-
* @param {
|
|
147
|
+
* @param {SubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
147
148
|
*
|
|
148
149
|
* @throws {@link Payabli.BadRequestError}
|
|
149
150
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -174,7 +175,6 @@ export declare class Subscription {
|
|
|
174
175
|
* }
|
|
175
176
|
* })
|
|
176
177
|
*/
|
|
177
|
-
updateSubscription(subId: number, request?: Payabli.RequestUpdateSchedule, requestOptions?:
|
|
178
|
+
updateSubscription(subId: number, request?: Payabli.RequestUpdateSchedule, requestOptions?: SubscriptionClient.RequestOptions): core.HttpResponsePromise<Payabli.UpdateSubscriptionResponse>;
|
|
178
179
|
private __updateSubscription;
|
|
179
|
-
protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
|
|
180
180
|
}
|
|
@@ -43,21 +43,23 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
43
43
|
});
|
|
44
44
|
};
|
|
45
45
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
46
|
-
exports.
|
|
46
|
+
exports.SubscriptionClient = void 0;
|
|
47
|
+
const BaseClient_js_1 = require("../../../../BaseClient.js");
|
|
47
48
|
const headers_js_1 = require("../../../../core/headers.js");
|
|
48
49
|
const core = __importStar(require("../../../../core/index.js"));
|
|
49
50
|
const environments = __importStar(require("../../../../environments.js"));
|
|
51
|
+
const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
|
|
50
52
|
const errors = __importStar(require("../../../../errors/index.js"));
|
|
51
53
|
const Payabli = __importStar(require("../../../index.js"));
|
|
52
|
-
class
|
|
53
|
-
constructor(
|
|
54
|
-
this._options =
|
|
54
|
+
class SubscriptionClient {
|
|
55
|
+
constructor(options = {}) {
|
|
56
|
+
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
55
57
|
}
|
|
56
58
|
/**
|
|
57
59
|
* Retrieves a single subscription's details.
|
|
58
60
|
*
|
|
59
61
|
* @param {number} subId - The subscription ID.
|
|
60
|
-
* @param {
|
|
62
|
+
* @param {SubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
61
63
|
*
|
|
62
64
|
* @throws {@link Payabli.BadRequestError}
|
|
63
65
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -73,7 +75,8 @@ class Subscription {
|
|
|
73
75
|
__getSubscription(subId, requestOptions) {
|
|
74
76
|
return __awaiter(this, void 0, void 0, function* () {
|
|
75
77
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
76
|
-
const
|
|
78
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
79
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
77
80
|
const _response = yield core.fetcher({
|
|
78
81
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Subscription/${core.url.encodePathParam(subId)}`),
|
|
79
82
|
method: "GET",
|
|
@@ -106,28 +109,14 @@ class Subscription {
|
|
|
106
109
|
});
|
|
107
110
|
}
|
|
108
111
|
}
|
|
109
|
-
|
|
110
|
-
case "non-json":
|
|
111
|
-
throw new errors.PayabliError({
|
|
112
|
-
statusCode: _response.error.statusCode,
|
|
113
|
-
body: _response.error.rawBody,
|
|
114
|
-
rawResponse: _response.rawResponse,
|
|
115
|
-
});
|
|
116
|
-
case "timeout":
|
|
117
|
-
throw new errors.PayabliTimeoutError("Timeout exceeded when calling GET /Subscription/{subId}.");
|
|
118
|
-
case "unknown":
|
|
119
|
-
throw new errors.PayabliError({
|
|
120
|
-
message: _response.error.errorMessage,
|
|
121
|
-
rawResponse: _response.rawResponse,
|
|
122
|
-
});
|
|
123
|
-
}
|
|
112
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Subscription/{subId}");
|
|
124
113
|
});
|
|
125
114
|
}
|
|
126
115
|
/**
|
|
127
116
|
* Creates a subscription or scheduled payment to run at a specified time and frequency.
|
|
128
117
|
*
|
|
129
118
|
* @param {Payabli.RequestSchedule} request
|
|
130
|
-
* @param {
|
|
119
|
+
* @param {SubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
131
120
|
*
|
|
132
121
|
* @throws {@link Payabli.BadRequestError}
|
|
133
122
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -228,7 +217,8 @@ class Subscription {
|
|
|
228
217
|
if (forceCustomerCreation != null) {
|
|
229
218
|
_queryParams.forceCustomerCreation = forceCustomerCreation.toString();
|
|
230
219
|
}
|
|
231
|
-
const
|
|
220
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
221
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ idempotencyKey: idempotencyKey != null ? idempotencyKey : undefined }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
232
222
|
const _response = yield core.fetcher({
|
|
233
223
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, "Subscription/add"),
|
|
234
224
|
method: "POST",
|
|
@@ -264,28 +254,14 @@ class Subscription {
|
|
|
264
254
|
});
|
|
265
255
|
}
|
|
266
256
|
}
|
|
267
|
-
|
|
268
|
-
case "non-json":
|
|
269
|
-
throw new errors.PayabliError({
|
|
270
|
-
statusCode: _response.error.statusCode,
|
|
271
|
-
body: _response.error.rawBody,
|
|
272
|
-
rawResponse: _response.rawResponse,
|
|
273
|
-
});
|
|
274
|
-
case "timeout":
|
|
275
|
-
throw new errors.PayabliTimeoutError("Timeout exceeded when calling POST /Subscription/add.");
|
|
276
|
-
case "unknown":
|
|
277
|
-
throw new errors.PayabliError({
|
|
278
|
-
message: _response.error.errorMessage,
|
|
279
|
-
rawResponse: _response.rawResponse,
|
|
280
|
-
});
|
|
281
|
-
}
|
|
257
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/Subscription/add");
|
|
282
258
|
});
|
|
283
259
|
}
|
|
284
260
|
/**
|
|
285
261
|
* Deletes a subscription, autopay, or recurring payment and prevents future charges.
|
|
286
262
|
*
|
|
287
263
|
* @param {number} subId - The subscription ID.
|
|
288
|
-
* @param {
|
|
264
|
+
* @param {SubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
289
265
|
*
|
|
290
266
|
* @throws {@link Payabli.BadRequestError}
|
|
291
267
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -301,7 +277,8 @@ class Subscription {
|
|
|
301
277
|
__removeSubscription(subId, requestOptions) {
|
|
302
278
|
return __awaiter(this, void 0, void 0, function* () {
|
|
303
279
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
304
|
-
const
|
|
280
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
281
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
305
282
|
const _response = yield core.fetcher({
|
|
306
283
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Subscription/${core.url.encodePathParam(subId)}`),
|
|
307
284
|
method: "DELETE",
|
|
@@ -334,21 +311,7 @@ class Subscription {
|
|
|
334
311
|
});
|
|
335
312
|
}
|
|
336
313
|
}
|
|
337
|
-
|
|
338
|
-
case "non-json":
|
|
339
|
-
throw new errors.PayabliError({
|
|
340
|
-
statusCode: _response.error.statusCode,
|
|
341
|
-
body: _response.error.rawBody,
|
|
342
|
-
rawResponse: _response.rawResponse,
|
|
343
|
-
});
|
|
344
|
-
case "timeout":
|
|
345
|
-
throw new errors.PayabliTimeoutError("Timeout exceeded when calling DELETE /Subscription/{subId}.");
|
|
346
|
-
case "unknown":
|
|
347
|
-
throw new errors.PayabliError({
|
|
348
|
-
message: _response.error.errorMessage,
|
|
349
|
-
rawResponse: _response.rawResponse,
|
|
350
|
-
});
|
|
351
|
-
}
|
|
314
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/Subscription/{subId}");
|
|
352
315
|
});
|
|
353
316
|
}
|
|
354
317
|
/**
|
|
@@ -356,7 +319,7 @@ class Subscription {
|
|
|
356
319
|
*
|
|
357
320
|
* @param {number} subId - The subscription ID.
|
|
358
321
|
* @param {Payabli.RequestUpdateSchedule} request
|
|
359
|
-
* @param {
|
|
322
|
+
* @param {SubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
360
323
|
*
|
|
361
324
|
* @throws {@link Payabli.BadRequestError}
|
|
362
325
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -393,7 +356,8 @@ class Subscription {
|
|
|
393
356
|
__updateSubscription(subId_1) {
|
|
394
357
|
return __awaiter(this, arguments, void 0, function* (subId, request = {}, requestOptions) {
|
|
395
358
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
396
|
-
const
|
|
359
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
360
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
397
361
|
const _response = yield core.fetcher({
|
|
398
362
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Subscription/${core.url.encodePathParam(subId)}`),
|
|
399
363
|
method: "PUT",
|
|
@@ -429,28 +393,8 @@ class Subscription {
|
|
|
429
393
|
});
|
|
430
394
|
}
|
|
431
395
|
}
|
|
432
|
-
|
|
433
|
-
case "non-json":
|
|
434
|
-
throw new errors.PayabliError({
|
|
435
|
-
statusCode: _response.error.statusCode,
|
|
436
|
-
body: _response.error.rawBody,
|
|
437
|
-
rawResponse: _response.rawResponse,
|
|
438
|
-
});
|
|
439
|
-
case "timeout":
|
|
440
|
-
throw new errors.PayabliTimeoutError("Timeout exceeded when calling PUT /Subscription/{subId}.");
|
|
441
|
-
case "unknown":
|
|
442
|
-
throw new errors.PayabliError({
|
|
443
|
-
message: _response.error.errorMessage,
|
|
444
|
-
rawResponse: _response.rawResponse,
|
|
445
|
-
});
|
|
446
|
-
}
|
|
447
|
-
});
|
|
448
|
-
}
|
|
449
|
-
_getCustomAuthorizationHeaders() {
|
|
450
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
451
|
-
const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
|
|
452
|
-
return { requestToken: apiKeyValue };
|
|
396
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PUT", "/Subscription/{subId}");
|
|
453
397
|
});
|
|
454
398
|
}
|
|
455
399
|
}
|
|
456
|
-
exports.
|
|
400
|
+
exports.SubscriptionClient = SubscriptionClient;
|
|
@@ -1,20 +1,21 @@
|
|
|
1
1
|
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
|
|
2
3
|
import * as core from "../../../../core/index.js";
|
|
3
4
|
import * as Payabli from "../../../index.js";
|
|
4
|
-
export declare namespace
|
|
5
|
+
export declare namespace TemplatesClient {
|
|
5
6
|
interface Options extends BaseClientOptions {
|
|
6
7
|
}
|
|
7
8
|
interface RequestOptions extends BaseRequestOptions {
|
|
8
9
|
}
|
|
9
10
|
}
|
|
10
|
-
export declare class
|
|
11
|
-
protected readonly _options:
|
|
12
|
-
constructor(
|
|
11
|
+
export declare class TemplatesClient {
|
|
12
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<TemplatesClient.Options>;
|
|
13
|
+
constructor(options?: TemplatesClient.Options);
|
|
13
14
|
/**
|
|
14
15
|
* Deletes a template by ID.
|
|
15
16
|
*
|
|
16
17
|
* @param {number} templateId - The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
|
|
17
|
-
* @param {
|
|
18
|
+
* @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
18
19
|
*
|
|
19
20
|
* @throws {@link Payabli.BadRequestError}
|
|
20
21
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -24,14 +25,14 @@ export declare class Templates {
|
|
|
24
25
|
* @example
|
|
25
26
|
* await client.templates.deleteTemplate(80)
|
|
26
27
|
*/
|
|
27
|
-
deleteTemplate(templateId: number, requestOptions?:
|
|
28
|
+
deleteTemplate(templateId: number, requestOptions?: TemplatesClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponseTemplateId>;
|
|
28
29
|
private __deleteTemplate;
|
|
29
30
|
/**
|
|
30
31
|
* Generates a boarding link from a boarding template.
|
|
31
32
|
*
|
|
32
|
-
* @param {boolean} ignoreEmpty - Ignore read-only and empty fields Default is `false`. If `ignoreEmpty` = `false` and any field is empty, then the request returns a failure response. If `ignoreEmpty` = `true`, the request returns the boarding link name regardless of whether fields are empty.
|
|
33
33
|
* @param {number} templateId - The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
|
|
34
|
-
* @param {
|
|
34
|
+
* @param {boolean} ignoreEmpty - Ignore read-only and empty fields Default is `false`. If `ignoreEmpty` = `false` and any field is empty, then the request returns a failure response. If `ignoreEmpty` = `true`, the request returns the boarding link name regardless of whether fields are empty.
|
|
35
|
+
* @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
35
36
|
*
|
|
36
37
|
* @throws {@link Payabli.BadRequestError}
|
|
37
38
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -39,15 +40,15 @@ export declare class Templates {
|
|
|
39
40
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
40
41
|
*
|
|
41
42
|
* @example
|
|
42
|
-
* await client.templates.getlinkTemplate(
|
|
43
|
+
* await client.templates.getlinkTemplate(80, true)
|
|
43
44
|
*/
|
|
44
|
-
getlinkTemplate(
|
|
45
|
+
getlinkTemplate(templateId: number, ignoreEmpty: boolean, requestOptions?: TemplatesClient.RequestOptions): core.HttpResponsePromise<Payabli.BoardingLinkApiResponse>;
|
|
45
46
|
private __getlinkTemplate;
|
|
46
47
|
/**
|
|
47
48
|
* Retrieves a boarding template's details by ID.
|
|
48
49
|
*
|
|
49
50
|
* @param {number} templateId - The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
|
|
50
|
-
* @param {
|
|
51
|
+
* @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
51
52
|
*
|
|
52
53
|
* @throws {@link Payabli.BadRequestError}
|
|
53
54
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -57,14 +58,14 @@ export declare class Templates {
|
|
|
57
58
|
* @example
|
|
58
59
|
* await client.templates.getTemplate(80)
|
|
59
60
|
*/
|
|
60
|
-
getTemplate(templateId: number, requestOptions?:
|
|
61
|
+
getTemplate(templateId: number, requestOptions?: TemplatesClient.RequestOptions): core.HttpResponsePromise<Payabli.TemplateQueryRecord>;
|
|
61
62
|
private __getTemplate;
|
|
62
63
|
/**
|
|
63
64
|
* Retrieves a list of boarding templates for an organization. Use filters to limit results. You can't make a request that includes filters from the API console in the documentation. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
|
|
64
65
|
*
|
|
65
66
|
* @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
|
|
66
67
|
* @param {Payabli.ListTemplatesRequest} request
|
|
67
|
-
* @param {
|
|
68
|
+
* @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
68
69
|
*
|
|
69
70
|
* @throws {@link Payabli.BadRequestError}
|
|
70
71
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -78,7 +79,6 @@ export declare class Templates {
|
|
|
78
79
|
* sortBy: "desc(field_name)"
|
|
79
80
|
* })
|
|
80
81
|
*/
|
|
81
|
-
listTemplates(orgId: number, request?: Payabli.ListTemplatesRequest, requestOptions?:
|
|
82
|
+
listTemplates(orgId: number, request?: Payabli.ListTemplatesRequest, requestOptions?: TemplatesClient.RequestOptions): core.HttpResponsePromise<Payabli.TemplateQueryResponse>;
|
|
82
83
|
private __listTemplates;
|
|
83
|
-
protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
|
|
84
84
|
}
|