@payabli/sdk-node 0.0.116 → 0.0.123
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 +31 -2
- package/dist/cjs/BaseClient.d.ts +13 -4
- package/dist/cjs/BaseClient.js +59 -0
- package/dist/cjs/Client.d.ts +88 -88
- package/dist/cjs/Client.js +31 -72
- package/dist/cjs/api/errors/BadRequestError.js +5 -1
- package/dist/cjs/api/errors/ConflictError.js +5 -1
- package/dist/cjs/api/errors/ForbiddenError.js +5 -1
- package/dist/cjs/api/errors/InternalServerError.js +5 -1
- package/dist/cjs/api/errors/ServiceUnavailableError.js +5 -1
- package/dist/cjs/api/errors/UnauthorizedError.js +5 -1
- package/dist/cjs/api/resources/bill/client/Client.d.ts +34 -35
- package/dist/cjs/api/resources/bill/client/Client.js +69 -216
- package/dist/cjs/api/resources/boarding/client/Client.d.ts +28 -29
- package/dist/cjs/api/resources/boarding/client/Client.js +51 -198
- package/dist/cjs/api/resources/chargeBacks/client/Client.d.ts +18 -17
- package/dist/cjs/api/resources/chargeBacks/client/Client.js +38 -79
- package/dist/cjs/api/resources/checkCapture/client/Client.d.ts +8 -9
- package/dist/cjs/api/resources/checkCapture/client/Client.js +11 -28
- package/dist/cjs/api/resources/cloud/client/Client.d.ts +18 -19
- package/dist/cjs/api/resources/cloud/client/Client.js +33 -89
- package/dist/cjs/api/resources/customer/client/Client.d.ts +18 -19
- package/dist/cjs/api/resources/customer/client/Client.js +31 -113
- package/dist/cjs/api/resources/export/client/Client.d.ts +94 -91
- package/dist/cjs/api/resources/export/client/Client.js +205 -582
- package/dist/cjs/api/resources/hostedPaymentPages/client/Client.d.ts +12 -13
- package/dist/cjs/api/resources/hostedPaymentPages/client/Client.js +19 -62
- package/dist/cjs/api/resources/import/client/Client.d.ts +12 -13
- package/dist/cjs/api/resources/import/client/Client.js +19 -62
- package/dist/cjs/api/resources/invoice/client/Client.d.ts +37 -36
- package/dist/cjs/api/resources/invoice/client/Client.js +67 -212
- package/dist/cjs/api/resources/invoice/client/requests/AddInvoiceRequest.d.ts +5 -3
- package/dist/cjs/api/resources/lineItem/client/Client.d.ts +16 -17
- package/dist/cjs/api/resources/lineItem/client/Client.js +27 -96
- package/dist/cjs/api/resources/moneyIn/client/Client.d.ts +40 -41
- package/dist/cjs/api/resources/moneyIn/client/Client.js +79 -249
- package/dist/cjs/api/resources/moneyIn/errors/CaptureError.js +5 -1
- package/dist/cjs/api/resources/moneyIn/errors/InvalidTransStatusError.js +5 -1
- package/dist/cjs/api/resources/moneyOut/client/Client.d.ts +44 -28
- 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 +30 -18
- package/dist/cjs/api/resources/notification/client/Client.js +45 -101
- package/dist/cjs/api/resources/notificationlogs/client/Client.d.ts +14 -15
- package/dist/cjs/api/resources/notificationlogs/client/Client.js +23 -79
- package/dist/cjs/api/resources/ocr/client/Client.d.ts +14 -11
- package/dist/cjs/api/resources/ocr/client/Client.js +19 -45
- package/dist/cjs/api/resources/organization/client/Client.d.ts +20 -21
- package/dist/cjs/api/resources/organization/client/Client.js +35 -130
- package/dist/cjs/api/resources/paymentLink/client/Client.d.ts +27 -28
- package/dist/cjs/api/resources/paymentLink/client/Client.js +46 -167
- package/dist/cjs/api/resources/paymentLink/client/requests/PayLinkDataBill.d.ts +1 -1
- package/dist/cjs/api/resources/paymentLink/client/requests/PayLinkDataInvoice.d.ts +1 -1
- package/dist/cjs/api/resources/paymentLink/client/requests/PayLinkDataOut.d.ts +1 -1
- package/dist/cjs/api/resources/paymentLink/types/PaymentPageRequestBody.d.ts +2 -2
- package/dist/cjs/api/resources/paymentMethodDomain/client/Client.d.ts +20 -21
- package/dist/cjs/api/resources/paymentMethodDomain/client/Client.js +35 -130
- package/dist/cjs/api/resources/paypoint/client/Client.d.ts +23 -24
- package/dist/cjs/api/resources/paypoint/client/Client.js +44 -152
- package/dist/cjs/api/resources/query/client/Client.d.ts +72 -73
- 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 +51 -52
- 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 +14 -15
- package/dist/cjs/api/resources/subscription/client/Client.js +23 -79
- package/dist/cjs/api/resources/templates/client/Client.d.ts +16 -17
- package/dist/cjs/api/resources/templates/client/Client.js +28 -84
- package/dist/cjs/api/resources/tokenStorage/client/Client.d.ts +14 -15
- package/dist/cjs/api/resources/tokenStorage/client/Client.js +23 -79
- package/dist/cjs/api/resources/tokenStorage/types/GetMethodResponse.d.ts +1 -1
- package/dist/cjs/api/resources/user/client/Client.d.ts +55 -34
- package/dist/cjs/api/resources/user/client/Client.js +84 -222
- package/dist/cjs/api/resources/vendor/client/Client.d.ts +14 -15
- package/dist/cjs/api/resources/vendor/client/Client.js +23 -79
- package/dist/cjs/api/resources/wallet/client/Client.d.ts +14 -15
- 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/Frequency.d.ts +1 -1
- package/dist/cjs/api/types/Frequency.js +1 -1
- package/dist/cjs/api/types/FrequencyList.d.ts +1 -1
- 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/PayorDataResponse.d.ts +1 -1
- package/dist/cjs/api/types/QueryResponseSettlements.d.ts +1 -1
- package/dist/cjs/auth/HeaderAuthProvider.d.ts +16 -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/core/auth/AuthProvider.js +2 -0
- 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/PayabliError.js +5 -1
- package/dist/cjs/errors/PayabliTimeoutError.js +5 -1
- package/dist/cjs/errors/handleNonStatusCodeError.d.ts +2 -0
- package/dist/cjs/errors/handleNonStatusCodeError.js +65 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +13 -4
- package/dist/esm/BaseClient.mjs +24 -1
- package/dist/esm/Client.d.mts +88 -88
- package/dist/esm/Client.mjs +59 -67
- package/dist/esm/api/errors/BadRequestError.mjs +5 -1
- package/dist/esm/api/errors/ConflictError.mjs +5 -1
- package/dist/esm/api/errors/ForbiddenError.mjs +5 -1
- package/dist/esm/api/errors/InternalServerError.mjs +5 -1
- package/dist/esm/api/errors/ServiceUnavailableError.mjs +5 -1
- package/dist/esm/api/errors/UnauthorizedError.mjs +5 -1
- package/dist/esm/api/resources/bill/client/Client.d.mts +34 -35
- package/dist/esm/api/resources/bill/client/Client.mjs +67 -214
- package/dist/esm/api/resources/boarding/client/Client.d.mts +28 -29
- package/dist/esm/api/resources/boarding/client/Client.mjs +50 -197
- package/dist/esm/api/resources/chargeBacks/client/Client.d.mts +18 -17
- package/dist/esm/api/resources/chargeBacks/client/Client.mjs +36 -77
- package/dist/esm/api/resources/checkCapture/client/Client.d.mts +8 -9
- package/dist/esm/api/resources/checkCapture/client/Client.mjs +10 -27
- package/dist/esm/api/resources/cloud/client/Client.d.mts +18 -19
- package/dist/esm/api/resources/cloud/client/Client.mjs +31 -87
- package/dist/esm/api/resources/customer/client/Client.d.mts +18 -19
- package/dist/esm/api/resources/customer/client/Client.mjs +29 -111
- package/dist/esm/api/resources/export/client/Client.d.mts +94 -91
- package/dist/esm/api/resources/export/client/Client.mjs +204 -581
- package/dist/esm/api/resources/hostedPaymentPages/client/Client.d.mts +12 -13
- package/dist/esm/api/resources/hostedPaymentPages/client/Client.mjs +17 -60
- package/dist/esm/api/resources/import/client/Client.d.mts +12 -13
- package/dist/esm/api/resources/import/client/Client.mjs +17 -60
- package/dist/esm/api/resources/invoice/client/Client.d.mts +37 -36
- package/dist/esm/api/resources/invoice/client/Client.mjs +65 -210
- package/dist/esm/api/resources/invoice/client/requests/AddInvoiceRequest.d.mts +5 -3
- package/dist/esm/api/resources/lineItem/client/Client.d.mts +16 -17
- package/dist/esm/api/resources/lineItem/client/Client.mjs +25 -94
- package/dist/esm/api/resources/moneyIn/client/Client.d.mts +40 -41
- package/dist/esm/api/resources/moneyIn/client/Client.mjs +77 -247
- package/dist/esm/api/resources/moneyIn/errors/CaptureError.mjs +5 -1
- package/dist/esm/api/resources/moneyIn/errors/InvalidTransStatusError.mjs +5 -1
- package/dist/esm/api/resources/moneyOut/client/Client.d.mts +44 -28
- 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 +30 -18
- package/dist/esm/api/resources/notification/client/Client.mjs +44 -100
- package/dist/esm/api/resources/notificationlogs/client/Client.d.mts +14 -15
- package/dist/esm/api/resources/notificationlogs/client/Client.mjs +22 -78
- package/dist/esm/api/resources/ocr/client/Client.d.mts +14 -11
- package/dist/esm/api/resources/ocr/client/Client.mjs +18 -44
- package/dist/esm/api/resources/organization/client/Client.d.mts +20 -21
- package/dist/esm/api/resources/organization/client/Client.mjs +33 -128
- package/dist/esm/api/resources/paymentLink/client/Client.d.mts +27 -28
- package/dist/esm/api/resources/paymentLink/client/Client.mjs +44 -165
- package/dist/esm/api/resources/paymentLink/client/requests/PayLinkDataBill.d.mts +1 -1
- package/dist/esm/api/resources/paymentLink/client/requests/PayLinkDataInvoice.d.mts +1 -1
- package/dist/esm/api/resources/paymentLink/client/requests/PayLinkDataOut.d.mts +1 -1
- package/dist/esm/api/resources/paymentLink/types/PaymentPageRequestBody.d.mts +2 -2
- package/dist/esm/api/resources/paymentMethodDomain/client/Client.d.mts +20 -21
- package/dist/esm/api/resources/paymentMethodDomain/client/Client.mjs +34 -129
- package/dist/esm/api/resources/paypoint/client/Client.d.mts +23 -24
- package/dist/esm/api/resources/paypoint/client/Client.mjs +43 -151
- package/dist/esm/api/resources/query/client/Client.d.mts +72 -73
- 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 +51 -52
- 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 +14 -15
- package/dist/esm/api/resources/subscription/client/Client.mjs +21 -77
- package/dist/esm/api/resources/templates/client/Client.d.mts +16 -17
- package/dist/esm/api/resources/templates/client/Client.mjs +27 -83
- package/dist/esm/api/resources/tokenStorage/client/Client.d.mts +14 -15
- package/dist/esm/api/resources/tokenStorage/client/Client.mjs +21 -77
- package/dist/esm/api/resources/tokenStorage/types/GetMethodResponse.d.mts +1 -1
- package/dist/esm/api/resources/user/client/Client.d.mts +55 -34
- package/dist/esm/api/resources/user/client/Client.mjs +83 -221
- package/dist/esm/api/resources/vendor/client/Client.d.mts +14 -15
- package/dist/esm/api/resources/vendor/client/Client.mjs +22 -78
- package/dist/esm/api/resources/wallet/client/Client.d.mts +14 -15
- 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/Frequency.d.mts +1 -1
- package/dist/esm/api/types/Frequency.mjs +1 -1
- package/dist/esm/api/types/FrequencyList.d.mts +1 -1
- 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/PayorDataResponse.d.mts +1 -1
- package/dist/esm/api/types/QueryResponseSettlements.d.mts +1 -1
- package/dist/esm/auth/HeaderAuthProvider.d.mts +16 -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/PayabliError.mjs +5 -1
- package/dist/esm/errors/PayabliTimeoutError.mjs +5 -1
- package/dist/esm/errors/handleNonStatusCodeError.d.mts +2 -0
- package/dist/esm/errors/handleNonStatusCodeError.mjs +29 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +5 -2
- package/reference.md +768 -478
- package/dist/cjs/core/fetcher/ResponseWithBody.d.ts +0 -4
- package/dist/cjs/core/fetcher/ResponseWithBody.js +0 -6
- package/dist/esm/core/fetcher/ResponseWithBody.d.mts +0 -4
- package/dist/esm/core/fetcher/ResponseWithBody.mjs +0 -3
|
@@ -68,6 +68,7 @@ export interface ListPayoutOrgRequest {
|
|
|
68
68
|
* - `lotNumber` (ct, nct)
|
|
69
69
|
* - `customerVendorAccount` (ct, nct, eq, ne)
|
|
70
70
|
* - `batchId` (eq, ne)
|
|
71
|
+
* - `AchTraceNumber` (eq, ne)
|
|
71
72
|
* - `payoutProgram`(eq, ne) the options are `managed` or `odp`. For example, `payoutProgram(eq)=managed` returns all records with a `payoutProgram` equal to `managed`.
|
|
72
73
|
*
|
|
73
74
|
* List of comparison accepted - enclosed between parentheses:
|
|
@@ -69,6 +69,7 @@ export interface ListPayoutRequest {
|
|
|
69
69
|
* - `lotNumber` (ct, nct)
|
|
70
70
|
* - `customerVendorAccount` (ct, nct, eq, ne)
|
|
71
71
|
* - `batchId` (eq, ne)
|
|
72
|
+
* - `AchTraceNumber` (eq, ne)
|
|
72
73
|
* - `payoutProgram`(eq, ne) the options are `managed` or `odp`. For example, `payoutProgram(eq)=managed` returns all records with a `payoutProgram` equal to `managed`.
|
|
73
74
|
*
|
|
74
75
|
* List of comparison accepted - enclosed between parentheses:
|
|
@@ -56,6 +56,7 @@ export interface ListTransactionsRequest {
|
|
|
56
56
|
* - `settlementStatus` (in, nin, eq, ne)
|
|
57
57
|
* - `batchNumber` (nct, ct)
|
|
58
58
|
* - `invoiceNumber` (ct, nct)
|
|
59
|
+
* - `ipAddress` (eq, ne)
|
|
59
60
|
* - `authCode` (ct, nct)
|
|
60
61
|
* - `orderDescription` (ct, nct)
|
|
61
62
|
* - `payaccountLastfour` (nct, ct)
|
|
@@ -1,30 +1,18 @@
|
|
|
1
1
|
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
|
|
2
3
|
import * as core from "../../../../core/index.mjs";
|
|
3
4
|
import * as Payabli from "../../../index.mjs";
|
|
4
|
-
export declare namespace
|
|
5
|
-
|
|
6
|
-
}
|
|
5
|
+
export declare namespace StatisticClient {
|
|
6
|
+
type Options = BaseClientOptions;
|
|
7
7
|
interface RequestOptions extends BaseRequestOptions {
|
|
8
8
|
}
|
|
9
9
|
}
|
|
10
|
-
export declare class
|
|
11
|
-
protected readonly _options:
|
|
12
|
-
constructor(
|
|
10
|
+
export declare class StatisticClient {
|
|
11
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<StatisticClient.Options>;
|
|
12
|
+
constructor(options?: StatisticClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* Retrieves the basic statistics for an organization or a paypoint, for a given time period, grouped by a particular frequency.
|
|
15
15
|
*
|
|
16
|
-
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
17
|
-
* @param {string} freq - Frequency to group series. Allowed values:
|
|
18
|
-
*
|
|
19
|
-
* - `m` - monthly
|
|
20
|
-
* - `w` - weekly
|
|
21
|
-
* - `d` - daily
|
|
22
|
-
* - `h` - hourly
|
|
23
|
-
*
|
|
24
|
-
* For example, `w` groups the results by week.
|
|
25
|
-
* @param {number} level - The entry level for the request:
|
|
26
|
-
* - 0 for Organization
|
|
27
|
-
* - 2 for Paypoint
|
|
28
16
|
* @param {string} mode - Mode for the request. Allowed values:
|
|
29
17
|
*
|
|
30
18
|
* - `custom` - Allows you to set a custom date range
|
|
@@ -40,8 +28,20 @@ export declare class Statistic {
|
|
|
40
28
|
* - `lastw` - Last Week
|
|
41
29
|
* - `yesterday` - Last Day
|
|
42
30
|
*
|
|
31
|
+
* @param {string} freq - Frequency to group series. Allowed values:
|
|
32
|
+
*
|
|
33
|
+
* - `m` - monthly
|
|
34
|
+
* - `w` - weekly
|
|
35
|
+
* - `d` - daily
|
|
36
|
+
* - `h` - hourly
|
|
37
|
+
*
|
|
38
|
+
* For example, `w` groups the results by week.
|
|
39
|
+
* @param {number} level - The entry level for the request:
|
|
40
|
+
* - 0 for Organization
|
|
41
|
+
* - 2 for Paypoint
|
|
42
|
+
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
43
43
|
* @param {Payabli.BasicStatsRequest} request
|
|
44
|
-
* @param {
|
|
44
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
45
45
|
*
|
|
46
46
|
* @throws {@link Payabli.BadRequestError}
|
|
47
47
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -49,25 +49,16 @@ export declare class Statistic {
|
|
|
49
49
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
50
50
|
*
|
|
51
51
|
* @example
|
|
52
|
-
* await client.statistic.basicStats(
|
|
53
|
-
* endDate: "
|
|
54
|
-
* startDate: "
|
|
52
|
+
* await client.statistic.basicStats("ytd", "m", 1, 1000000, {
|
|
53
|
+
* endDate: "2025-11-01",
|
|
54
|
+
* startDate: "2025-11-30"
|
|
55
55
|
* })
|
|
56
56
|
*/
|
|
57
|
-
basicStats(
|
|
57
|
+
basicStats(mode: string, freq: string, level: number, entryId: number, request?: Payabli.BasicStatsRequest, requestOptions?: StatisticClient.RequestOptions): core.HttpResponsePromise<Payabli.StatBasicExtendedQueryRecord[]>;
|
|
58
58
|
private __basicStats;
|
|
59
59
|
/**
|
|
60
60
|
* Retrieves the basic statistics for a customer for a specific time period, grouped by a selected frequency.
|
|
61
61
|
*
|
|
62
|
-
* @param {number} customerId - Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
|
|
63
|
-
* @param {string} freq - Frequency to group series. Allowed values:
|
|
64
|
-
*
|
|
65
|
-
* - `m` - monthly
|
|
66
|
-
* - `w` - weekly
|
|
67
|
-
* - `d` - daily
|
|
68
|
-
* - `h` - hourly
|
|
69
|
-
*
|
|
70
|
-
* For example, `w` groups the results by week.
|
|
71
62
|
* @param {string} mode - Mode for request. Allowed values:
|
|
72
63
|
*
|
|
73
64
|
* - `ytd` - Year To Date
|
|
@@ -81,8 +72,17 @@ export declare class Statistic {
|
|
|
81
72
|
* - `lastm` - Last Month
|
|
82
73
|
* - `lastw` - Last Week
|
|
83
74
|
* - `yesterday` - Last Day
|
|
75
|
+
* @param {string} freq - Frequency to group series. Allowed values:
|
|
76
|
+
*
|
|
77
|
+
* - `m` - monthly
|
|
78
|
+
* - `w` - weekly
|
|
79
|
+
* - `d` - daily
|
|
80
|
+
* - `h` - hourly
|
|
81
|
+
*
|
|
82
|
+
* For example, `w` groups the results by week.
|
|
83
|
+
* @param {number} customerId - Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
|
|
84
84
|
* @param {Payabli.CustomerBasicStatsRequest} request
|
|
85
|
-
* @param {
|
|
85
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
86
86
|
*
|
|
87
87
|
* @throws {@link Payabli.BadRequestError}
|
|
88
88
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -90,14 +90,13 @@ export declare class Statistic {
|
|
|
90
90
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
91
91
|
*
|
|
92
92
|
* @example
|
|
93
|
-
* await client.statistic.customerBasicStats(
|
|
93
|
+
* await client.statistic.customerBasicStats("ytd", "m", 998)
|
|
94
94
|
*/
|
|
95
|
-
customerBasicStats(
|
|
95
|
+
customerBasicStats(mode: string, freq: string, customerId: number, request?: Payabli.CustomerBasicStatsRequest, requestOptions?: StatisticClient.RequestOptions): core.HttpResponsePromise<Payabli.SubscriptionStatsQueryRecord[]>;
|
|
96
96
|
private __customerBasicStats;
|
|
97
97
|
/**
|
|
98
98
|
* Retrieves the subscription statistics for a given interval for a paypoint or organization.
|
|
99
99
|
*
|
|
100
|
-
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
101
100
|
* @param {string} interval - Interval to get the data. Allowed values:
|
|
102
101
|
*
|
|
103
102
|
* - `all` - all intervals
|
|
@@ -108,8 +107,9 @@ export declare class Statistic {
|
|
|
108
107
|
* @param {number} level - The entry level for the request:
|
|
109
108
|
* - 0 for Organization
|
|
110
109
|
* - 2 for Paypoint
|
|
110
|
+
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
111
111
|
* @param {Payabli.SubStatsRequest} request
|
|
112
|
-
* @param {
|
|
112
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
113
113
|
*
|
|
114
114
|
* @throws {@link Payabli.BadRequestError}
|
|
115
115
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -117,22 +117,13 @@ export declare class Statistic {
|
|
|
117
117
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
118
118
|
*
|
|
119
119
|
* @example
|
|
120
|
-
* await client.statistic.subStats(
|
|
120
|
+
* await client.statistic.subStats("30", 1, 1000000)
|
|
121
121
|
*/
|
|
122
|
-
subStats(
|
|
122
|
+
subStats(interval: string, level: number, entryId: number, request?: Payabli.SubStatsRequest, requestOptions?: StatisticClient.RequestOptions): core.HttpResponsePromise<Payabli.StatBasicQueryRecord[]>;
|
|
123
123
|
private __subStats;
|
|
124
124
|
/**
|
|
125
125
|
* Retrieve the basic statistics about a vendor for a given time period, grouped by frequency.
|
|
126
126
|
*
|
|
127
|
-
* @param {string} freq - Frequency to group series. Allowed values:
|
|
128
|
-
*
|
|
129
|
-
* - `m` - monthly
|
|
130
|
-
* - `w` - weekly
|
|
131
|
-
* - `d` - daily
|
|
132
|
-
* - `h` - hourly
|
|
133
|
-
*
|
|
134
|
-
* For example, `w` groups the results by week.
|
|
135
|
-
* @param {number} idVendor - Vendor ID.
|
|
136
127
|
* @param {string} mode - Mode for request. Allowed values:
|
|
137
128
|
*
|
|
138
129
|
* - `ytd` - Year To Date
|
|
@@ -146,8 +137,17 @@ export declare class Statistic {
|
|
|
146
137
|
* - `lastm` - Last Month
|
|
147
138
|
* - `lastw` - Last Week
|
|
148
139
|
* - `yesterday` - Last Day
|
|
140
|
+
* @param {string} freq - Frequency to group series. Allowed values:
|
|
141
|
+
*
|
|
142
|
+
* - `m` - monthly
|
|
143
|
+
* - `w` - weekly
|
|
144
|
+
* - `d` - daily
|
|
145
|
+
* - `h` - hourly
|
|
146
|
+
*
|
|
147
|
+
* For example, `w` groups the results by week.
|
|
148
|
+
* @param {number} idVendor - Vendor ID.
|
|
149
149
|
* @param {Payabli.VendorBasicStatsRequest} request
|
|
150
|
-
* @param {
|
|
150
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
151
151
|
*
|
|
152
152
|
* @throws {@link Payabli.BadRequestError}
|
|
153
153
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -155,9 +155,8 @@ export declare class Statistic {
|
|
|
155
155
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
156
156
|
*
|
|
157
157
|
* @example
|
|
158
|
-
* await client.statistic.vendorBasicStats("m", 1
|
|
158
|
+
* await client.statistic.vendorBasicStats("ytd", "m", 1)
|
|
159
159
|
*/
|
|
160
|
-
vendorBasicStats(
|
|
160
|
+
vendorBasicStats(mode: string, freq: string, idVendor: number, request?: Payabli.VendorBasicStatsRequest, requestOptions?: StatisticClient.RequestOptions): core.HttpResponsePromise<Payabli.StatisticsVendorQueryRecord[]>;
|
|
161
161
|
private __vendorBasicStats;
|
|
162
|
-
protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
|
|
163
162
|
}
|
|
@@ -8,31 +8,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
8
8
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
9
|
});
|
|
10
10
|
};
|
|
11
|
-
import {
|
|
11
|
+
import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
|
|
12
|
+
import { mergeHeaders } from "../../../../core/headers.mjs";
|
|
12
13
|
import * as core from "../../../../core/index.mjs";
|
|
13
14
|
import { toJson } from "../../../../core/json.mjs";
|
|
14
15
|
import * as environments from "../../../../environments.mjs";
|
|
16
|
+
import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
|
|
15
17
|
import * as errors from "../../../../errors/index.mjs";
|
|
16
18
|
import * as Payabli from "../../../index.mjs";
|
|
17
|
-
export class
|
|
18
|
-
constructor(
|
|
19
|
-
this._options =
|
|
19
|
+
export class StatisticClient {
|
|
20
|
+
constructor(options = {}) {
|
|
21
|
+
this._options = normalizeClientOptionsWithAuth(options);
|
|
20
22
|
}
|
|
21
23
|
/**
|
|
22
24
|
* Retrieves the basic statistics for an organization or a paypoint, for a given time period, grouped by a particular frequency.
|
|
23
25
|
*
|
|
24
|
-
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
25
|
-
* @param {string} freq - Frequency to group series. Allowed values:
|
|
26
|
-
*
|
|
27
|
-
* - `m` - monthly
|
|
28
|
-
* - `w` - weekly
|
|
29
|
-
* - `d` - daily
|
|
30
|
-
* - `h` - hourly
|
|
31
|
-
*
|
|
32
|
-
* For example, `w` groups the results by week.
|
|
33
|
-
* @param {number} level - The entry level for the request:
|
|
34
|
-
* - 0 for Organization
|
|
35
|
-
* - 2 for Paypoint
|
|
36
26
|
* @param {string} mode - Mode for the request. Allowed values:
|
|
37
27
|
*
|
|
38
28
|
* - `custom` - Allows you to set a custom date range
|
|
@@ -48,8 +38,20 @@ export class Statistic {
|
|
|
48
38
|
* - `lastw` - Last Week
|
|
49
39
|
* - `yesterday` - Last Day
|
|
50
40
|
*
|
|
41
|
+
* @param {string} freq - Frequency to group series. Allowed values:
|
|
42
|
+
*
|
|
43
|
+
* - `m` - monthly
|
|
44
|
+
* - `w` - weekly
|
|
45
|
+
* - `d` - daily
|
|
46
|
+
* - `h` - hourly
|
|
47
|
+
*
|
|
48
|
+
* For example, `w` groups the results by week.
|
|
49
|
+
* @param {number} level - The entry level for the request:
|
|
50
|
+
* - 0 for Organization
|
|
51
|
+
* - 2 for Paypoint
|
|
52
|
+
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
51
53
|
* @param {Payabli.BasicStatsRequest} request
|
|
52
|
-
* @param {
|
|
54
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
53
55
|
*
|
|
54
56
|
* @throws {@link Payabli.BadRequestError}
|
|
55
57
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -57,16 +59,16 @@ export class Statistic {
|
|
|
57
59
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
58
60
|
*
|
|
59
61
|
* @example
|
|
60
|
-
* await client.statistic.basicStats(
|
|
61
|
-
* endDate: "
|
|
62
|
-
* startDate: "
|
|
62
|
+
* await client.statistic.basicStats("ytd", "m", 1, 1000000, {
|
|
63
|
+
* endDate: "2025-11-01",
|
|
64
|
+
* startDate: "2025-11-30"
|
|
63
65
|
* })
|
|
64
66
|
*/
|
|
65
|
-
basicStats(
|
|
66
|
-
return core.HttpResponsePromise.fromPromise(this.__basicStats(
|
|
67
|
+
basicStats(mode, freq, level, entryId, request = {}, requestOptions) {
|
|
68
|
+
return core.HttpResponsePromise.fromPromise(this.__basicStats(mode, freq, level, entryId, request, requestOptions));
|
|
67
69
|
}
|
|
68
|
-
__basicStats(
|
|
69
|
-
return __awaiter(this, arguments, void 0, function* (
|
|
70
|
+
__basicStats(mode_1, freq_1, level_1, entryId_1) {
|
|
71
|
+
return __awaiter(this, arguments, void 0, function* (mode, freq, level, entryId, request = {}, requestOptions) {
|
|
70
72
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
71
73
|
const { endDate, parameters, startDate } = request;
|
|
72
74
|
const _queryParams = {};
|
|
@@ -79,7 +81,8 @@ export class Statistic {
|
|
|
79
81
|
if (startDate != null) {
|
|
80
82
|
_queryParams.startDate = startDate;
|
|
81
83
|
}
|
|
82
|
-
const
|
|
84
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
85
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
83
86
|
const _response = yield core.fetcher({
|
|
84
87
|
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, `Statistic/basic/${core.url.encodePathParam(mode)}/${core.url.encodePathParam(freq)}/${core.url.encodePathParam(level)}/${core.url.encodePathParam(entryId)}`),
|
|
85
88
|
method: "GET",
|
|
@@ -92,7 +95,10 @@ export class Statistic {
|
|
|
92
95
|
logging: this._options.logging,
|
|
93
96
|
});
|
|
94
97
|
if (_response.ok) {
|
|
95
|
-
return {
|
|
98
|
+
return {
|
|
99
|
+
data: _response.body,
|
|
100
|
+
rawResponse: _response.rawResponse,
|
|
101
|
+
};
|
|
96
102
|
}
|
|
97
103
|
if (_response.error.reason === "status-code") {
|
|
98
104
|
switch (_response.error.statusCode) {
|
|
@@ -112,35 +118,12 @@ export class Statistic {
|
|
|
112
118
|
});
|
|
113
119
|
}
|
|
114
120
|
}
|
|
115
|
-
|
|
116
|
-
case "non-json":
|
|
117
|
-
throw new errors.PayabliError({
|
|
118
|
-
statusCode: _response.error.statusCode,
|
|
119
|
-
body: _response.error.rawBody,
|
|
120
|
-
rawResponse: _response.rawResponse,
|
|
121
|
-
});
|
|
122
|
-
case "timeout":
|
|
123
|
-
throw new errors.PayabliTimeoutError("Timeout exceeded when calling GET /Statistic/basic/{mode}/{freq}/{level}/{entryId}.");
|
|
124
|
-
case "unknown":
|
|
125
|
-
throw new errors.PayabliError({
|
|
126
|
-
message: _response.error.errorMessage,
|
|
127
|
-
rawResponse: _response.rawResponse,
|
|
128
|
-
});
|
|
129
|
-
}
|
|
121
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Statistic/basic/{mode}/{freq}/{level}/{entryId}");
|
|
130
122
|
});
|
|
131
123
|
}
|
|
132
124
|
/**
|
|
133
125
|
* Retrieves the basic statistics for a customer for a specific time period, grouped by a selected frequency.
|
|
134
126
|
*
|
|
135
|
-
* @param {number} customerId - Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
|
|
136
|
-
* @param {string} freq - Frequency to group series. Allowed values:
|
|
137
|
-
*
|
|
138
|
-
* - `m` - monthly
|
|
139
|
-
* - `w` - weekly
|
|
140
|
-
* - `d` - daily
|
|
141
|
-
* - `h` - hourly
|
|
142
|
-
*
|
|
143
|
-
* For example, `w` groups the results by week.
|
|
144
127
|
* @param {string} mode - Mode for request. Allowed values:
|
|
145
128
|
*
|
|
146
129
|
* - `ytd` - Year To Date
|
|
@@ -154,8 +137,17 @@ export class Statistic {
|
|
|
154
137
|
* - `lastm` - Last Month
|
|
155
138
|
* - `lastw` - Last Week
|
|
156
139
|
* - `yesterday` - Last Day
|
|
140
|
+
* @param {string} freq - Frequency to group series. Allowed values:
|
|
141
|
+
*
|
|
142
|
+
* - `m` - monthly
|
|
143
|
+
* - `w` - weekly
|
|
144
|
+
* - `d` - daily
|
|
145
|
+
* - `h` - hourly
|
|
146
|
+
*
|
|
147
|
+
* For example, `w` groups the results by week.
|
|
148
|
+
* @param {number} customerId - Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
|
|
157
149
|
* @param {Payabli.CustomerBasicStatsRequest} request
|
|
158
|
-
* @param {
|
|
150
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
159
151
|
*
|
|
160
152
|
* @throws {@link Payabli.BadRequestError}
|
|
161
153
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -163,20 +155,21 @@ export class Statistic {
|
|
|
163
155
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
164
156
|
*
|
|
165
157
|
* @example
|
|
166
|
-
* await client.statistic.customerBasicStats(
|
|
158
|
+
* await client.statistic.customerBasicStats("ytd", "m", 998)
|
|
167
159
|
*/
|
|
168
|
-
customerBasicStats(
|
|
169
|
-
return core.HttpResponsePromise.fromPromise(this.__customerBasicStats(
|
|
160
|
+
customerBasicStats(mode, freq, customerId, request = {}, requestOptions) {
|
|
161
|
+
return core.HttpResponsePromise.fromPromise(this.__customerBasicStats(mode, freq, customerId, request, requestOptions));
|
|
170
162
|
}
|
|
171
|
-
__customerBasicStats(
|
|
172
|
-
return __awaiter(this, arguments, void 0, function* (
|
|
163
|
+
__customerBasicStats(mode_1, freq_1, customerId_1) {
|
|
164
|
+
return __awaiter(this, arguments, void 0, function* (mode, freq, customerId, request = {}, requestOptions) {
|
|
173
165
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
174
166
|
const { parameters } = request;
|
|
175
167
|
const _queryParams = {};
|
|
176
168
|
if (parameters != null) {
|
|
177
169
|
_queryParams.parameters = toJson(parameters);
|
|
178
170
|
}
|
|
179
|
-
const
|
|
171
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
172
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
180
173
|
const _response = yield core.fetcher({
|
|
181
174
|
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, `Statistic/customerbasic/${core.url.encodePathParam(mode)}/${core.url.encodePathParam(freq)}/${core.url.encodePathParam(customerId)}`),
|
|
182
175
|
method: "GET",
|
|
@@ -212,27 +205,12 @@ export class Statistic {
|
|
|
212
205
|
});
|
|
213
206
|
}
|
|
214
207
|
}
|
|
215
|
-
|
|
216
|
-
case "non-json":
|
|
217
|
-
throw new errors.PayabliError({
|
|
218
|
-
statusCode: _response.error.statusCode,
|
|
219
|
-
body: _response.error.rawBody,
|
|
220
|
-
rawResponse: _response.rawResponse,
|
|
221
|
-
});
|
|
222
|
-
case "timeout":
|
|
223
|
-
throw new errors.PayabliTimeoutError("Timeout exceeded when calling GET /Statistic/customerbasic/{mode}/{freq}/{customerId}.");
|
|
224
|
-
case "unknown":
|
|
225
|
-
throw new errors.PayabliError({
|
|
226
|
-
message: _response.error.errorMessage,
|
|
227
|
-
rawResponse: _response.rawResponse,
|
|
228
|
-
});
|
|
229
|
-
}
|
|
208
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Statistic/customerbasic/{mode}/{freq}/{customerId}");
|
|
230
209
|
});
|
|
231
210
|
}
|
|
232
211
|
/**
|
|
233
212
|
* Retrieves the subscription statistics for a given interval for a paypoint or organization.
|
|
234
213
|
*
|
|
235
|
-
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
236
214
|
* @param {string} interval - Interval to get the data. Allowed values:
|
|
237
215
|
*
|
|
238
216
|
* - `all` - all intervals
|
|
@@ -243,8 +221,9 @@ export class Statistic {
|
|
|
243
221
|
* @param {number} level - The entry level for the request:
|
|
244
222
|
* - 0 for Organization
|
|
245
223
|
* - 2 for Paypoint
|
|
224
|
+
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
246
225
|
* @param {Payabli.SubStatsRequest} request
|
|
247
|
-
* @param {
|
|
226
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
248
227
|
*
|
|
249
228
|
* @throws {@link Payabli.BadRequestError}
|
|
250
229
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -252,20 +231,21 @@ export class Statistic {
|
|
|
252
231
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
253
232
|
*
|
|
254
233
|
* @example
|
|
255
|
-
* await client.statistic.subStats(
|
|
234
|
+
* await client.statistic.subStats("30", 1, 1000000)
|
|
256
235
|
*/
|
|
257
|
-
subStats(
|
|
258
|
-
return core.HttpResponsePromise.fromPromise(this.__subStats(
|
|
236
|
+
subStats(interval, level, entryId, request = {}, requestOptions) {
|
|
237
|
+
return core.HttpResponsePromise.fromPromise(this.__subStats(interval, level, entryId, request, requestOptions));
|
|
259
238
|
}
|
|
260
|
-
__subStats(
|
|
261
|
-
return __awaiter(this, arguments, void 0, function* (
|
|
239
|
+
__subStats(interval_1, level_1, entryId_1) {
|
|
240
|
+
return __awaiter(this, arguments, void 0, function* (interval, level, entryId, request = {}, requestOptions) {
|
|
262
241
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
263
242
|
const { parameters } = request;
|
|
264
243
|
const _queryParams = {};
|
|
265
244
|
if (parameters != null) {
|
|
266
245
|
_queryParams.parameters = toJson(parameters);
|
|
267
246
|
}
|
|
268
|
-
const
|
|
247
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
248
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
269
249
|
const _response = yield core.fetcher({
|
|
270
250
|
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, `Statistic/subscriptions/${core.url.encodePathParam(interval)}/${core.url.encodePathParam(level)}/${core.url.encodePathParam(entryId)}`),
|
|
271
251
|
method: "GET",
|
|
@@ -298,35 +278,12 @@ export class Statistic {
|
|
|
298
278
|
});
|
|
299
279
|
}
|
|
300
280
|
}
|
|
301
|
-
|
|
302
|
-
case "non-json":
|
|
303
|
-
throw new errors.PayabliError({
|
|
304
|
-
statusCode: _response.error.statusCode,
|
|
305
|
-
body: _response.error.rawBody,
|
|
306
|
-
rawResponse: _response.rawResponse,
|
|
307
|
-
});
|
|
308
|
-
case "timeout":
|
|
309
|
-
throw new errors.PayabliTimeoutError("Timeout exceeded when calling GET /Statistic/subscriptions/{interval}/{level}/{entryId}.");
|
|
310
|
-
case "unknown":
|
|
311
|
-
throw new errors.PayabliError({
|
|
312
|
-
message: _response.error.errorMessage,
|
|
313
|
-
rawResponse: _response.rawResponse,
|
|
314
|
-
});
|
|
315
|
-
}
|
|
281
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Statistic/subscriptions/{interval}/{level}/{entryId}");
|
|
316
282
|
});
|
|
317
283
|
}
|
|
318
284
|
/**
|
|
319
285
|
* Retrieve the basic statistics about a vendor for a given time period, grouped by frequency.
|
|
320
286
|
*
|
|
321
|
-
* @param {string} freq - Frequency to group series. Allowed values:
|
|
322
|
-
*
|
|
323
|
-
* - `m` - monthly
|
|
324
|
-
* - `w` - weekly
|
|
325
|
-
* - `d` - daily
|
|
326
|
-
* - `h` - hourly
|
|
327
|
-
*
|
|
328
|
-
* For example, `w` groups the results by week.
|
|
329
|
-
* @param {number} idVendor - Vendor ID.
|
|
330
287
|
* @param {string} mode - Mode for request. Allowed values:
|
|
331
288
|
*
|
|
332
289
|
* - `ytd` - Year To Date
|
|
@@ -340,8 +297,17 @@ export class Statistic {
|
|
|
340
297
|
* - `lastm` - Last Month
|
|
341
298
|
* - `lastw` - Last Week
|
|
342
299
|
* - `yesterday` - Last Day
|
|
300
|
+
* @param {string} freq - Frequency to group series. Allowed values:
|
|
301
|
+
*
|
|
302
|
+
* - `m` - monthly
|
|
303
|
+
* - `w` - weekly
|
|
304
|
+
* - `d` - daily
|
|
305
|
+
* - `h` - hourly
|
|
306
|
+
*
|
|
307
|
+
* For example, `w` groups the results by week.
|
|
308
|
+
* @param {number} idVendor - Vendor ID.
|
|
343
309
|
* @param {Payabli.VendorBasicStatsRequest} request
|
|
344
|
-
* @param {
|
|
310
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
345
311
|
*
|
|
346
312
|
* @throws {@link Payabli.BadRequestError}
|
|
347
313
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -349,20 +315,21 @@ export class Statistic {
|
|
|
349
315
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
350
316
|
*
|
|
351
317
|
* @example
|
|
352
|
-
* await client.statistic.vendorBasicStats("m", 1
|
|
318
|
+
* await client.statistic.vendorBasicStats("ytd", "m", 1)
|
|
353
319
|
*/
|
|
354
|
-
vendorBasicStats(freq, idVendor,
|
|
355
|
-
return core.HttpResponsePromise.fromPromise(this.__vendorBasicStats(freq, idVendor,
|
|
320
|
+
vendorBasicStats(mode, freq, idVendor, request = {}, requestOptions) {
|
|
321
|
+
return core.HttpResponsePromise.fromPromise(this.__vendorBasicStats(mode, freq, idVendor, request, requestOptions));
|
|
356
322
|
}
|
|
357
|
-
__vendorBasicStats(freq_1, idVendor_1
|
|
358
|
-
return __awaiter(this, arguments, void 0, function* (freq, idVendor,
|
|
323
|
+
__vendorBasicStats(mode_1, freq_1, idVendor_1) {
|
|
324
|
+
return __awaiter(this, arguments, void 0, function* (mode, freq, idVendor, request = {}, requestOptions) {
|
|
359
325
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
360
326
|
const { parameters } = request;
|
|
361
327
|
const _queryParams = {};
|
|
362
328
|
if (parameters != null) {
|
|
363
329
|
_queryParams.parameters = toJson(parameters);
|
|
364
330
|
}
|
|
365
|
-
const
|
|
331
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
332
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
366
333
|
const _response = yield core.fetcher({
|
|
367
334
|
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, `Statistic/vendorbasic/${core.url.encodePathParam(mode)}/${core.url.encodePathParam(freq)}/${core.url.encodePathParam(idVendor)}`),
|
|
368
335
|
method: "GET",
|
|
@@ -398,27 +365,7 @@ export class Statistic {
|
|
|
398
365
|
});
|
|
399
366
|
}
|
|
400
367
|
}
|
|
401
|
-
|
|
402
|
-
case "non-json":
|
|
403
|
-
throw new errors.PayabliError({
|
|
404
|
-
statusCode: _response.error.statusCode,
|
|
405
|
-
body: _response.error.rawBody,
|
|
406
|
-
rawResponse: _response.rawResponse,
|
|
407
|
-
});
|
|
408
|
-
case "timeout":
|
|
409
|
-
throw new errors.PayabliTimeoutError("Timeout exceeded when calling GET /Statistic/vendorbasic/{mode}/{freq}/{idVendor}.");
|
|
410
|
-
case "unknown":
|
|
411
|
-
throw new errors.PayabliError({
|
|
412
|
-
message: _response.error.errorMessage,
|
|
413
|
-
rawResponse: _response.rawResponse,
|
|
414
|
-
});
|
|
415
|
-
}
|
|
416
|
-
});
|
|
417
|
-
}
|
|
418
|
-
_getCustomAuthorizationHeaders() {
|
|
419
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
420
|
-
const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
|
|
421
|
-
return { requestToken: apiKeyValue };
|
|
368
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Statistic/vendorbasic/{mode}/{freq}/{idVendor}");
|
|
422
369
|
});
|
|
423
370
|
}
|
|
424
371
|
}
|