@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
|
@@ -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,19 @@
|
|
|
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 StatisticClient {
|
|
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 StatisticClient {
|
|
12
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<StatisticClient.Options>;
|
|
13
|
+
constructor(options?: StatisticClient.Options);
|
|
13
14
|
/**
|
|
14
15
|
* Retrieves the basic statistics for an organization or a paypoint, for a given time period, grouped by a particular frequency.
|
|
15
16
|
*
|
|
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
17
|
* @param {string} mode - Mode for the request. Allowed values:
|
|
29
18
|
*
|
|
30
19
|
* - `custom` - Allows you to set a custom date range
|
|
@@ -40,8 +29,20 @@ export declare class Statistic {
|
|
|
40
29
|
* - `lastw` - Last Week
|
|
41
30
|
* - `yesterday` - Last Day
|
|
42
31
|
*
|
|
32
|
+
* @param {string} freq - Frequency to group series. Allowed values:
|
|
33
|
+
*
|
|
34
|
+
* - `m` - monthly
|
|
35
|
+
* - `w` - weekly
|
|
36
|
+
* - `d` - daily
|
|
37
|
+
* - `h` - hourly
|
|
38
|
+
*
|
|
39
|
+
* For example, `w` groups the results by week.
|
|
40
|
+
* @param {number} level - The entry level for the request:
|
|
41
|
+
* - 0 for Organization
|
|
42
|
+
* - 2 for Paypoint
|
|
43
|
+
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
43
44
|
* @param {Payabli.BasicStatsRequest} request
|
|
44
|
-
* @param {
|
|
45
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
45
46
|
*
|
|
46
47
|
* @throws {@link Payabli.BadRequestError}
|
|
47
48
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -49,25 +50,16 @@ export declare class Statistic {
|
|
|
49
50
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
50
51
|
*
|
|
51
52
|
* @example
|
|
52
|
-
* await client.statistic.basicStats(
|
|
53
|
-
* endDate: "
|
|
54
|
-
* startDate: "
|
|
53
|
+
* await client.statistic.basicStats("ytd", "m", 1, 1000000, {
|
|
54
|
+
* endDate: "2025-11-01",
|
|
55
|
+
* startDate: "2025-11-30"
|
|
55
56
|
* })
|
|
56
57
|
*/
|
|
57
|
-
basicStats(
|
|
58
|
+
basicStats(mode: string, freq: string, level: number, entryId: number, request?: Payabli.BasicStatsRequest, requestOptions?: StatisticClient.RequestOptions): core.HttpResponsePromise<Payabli.StatBasicExtendedQueryRecord[]>;
|
|
58
59
|
private __basicStats;
|
|
59
60
|
/**
|
|
60
61
|
* Retrieves the basic statistics for a customer for a specific time period, grouped by a selected frequency.
|
|
61
62
|
*
|
|
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
63
|
* @param {string} mode - Mode for request. Allowed values:
|
|
72
64
|
*
|
|
73
65
|
* - `ytd` - Year To Date
|
|
@@ -81,8 +73,17 @@ export declare class Statistic {
|
|
|
81
73
|
* - `lastm` - Last Month
|
|
82
74
|
* - `lastw` - Last Week
|
|
83
75
|
* - `yesterday` - Last Day
|
|
76
|
+
* @param {string} freq - Frequency to group series. Allowed values:
|
|
77
|
+
*
|
|
78
|
+
* - `m` - monthly
|
|
79
|
+
* - `w` - weekly
|
|
80
|
+
* - `d` - daily
|
|
81
|
+
* - `h` - hourly
|
|
82
|
+
*
|
|
83
|
+
* For example, `w` groups the results by week.
|
|
84
|
+
* @param {number} customerId - Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
|
|
84
85
|
* @param {Payabli.CustomerBasicStatsRequest} request
|
|
85
|
-
* @param {
|
|
86
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
86
87
|
*
|
|
87
88
|
* @throws {@link Payabli.BadRequestError}
|
|
88
89
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -90,14 +91,13 @@ export declare class Statistic {
|
|
|
90
91
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
91
92
|
*
|
|
92
93
|
* @example
|
|
93
|
-
* await client.statistic.customerBasicStats(
|
|
94
|
+
* await client.statistic.customerBasicStats("ytd", "m", 998)
|
|
94
95
|
*/
|
|
95
|
-
customerBasicStats(
|
|
96
|
+
customerBasicStats(mode: string, freq: string, customerId: number, request?: Payabli.CustomerBasicStatsRequest, requestOptions?: StatisticClient.RequestOptions): core.HttpResponsePromise<Payabli.SubscriptionStatsQueryRecord[]>;
|
|
96
97
|
private __customerBasicStats;
|
|
97
98
|
/**
|
|
98
99
|
* Retrieves the subscription statistics for a given interval for a paypoint or organization.
|
|
99
100
|
*
|
|
100
|
-
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
101
101
|
* @param {string} interval - Interval to get the data. Allowed values:
|
|
102
102
|
*
|
|
103
103
|
* - `all` - all intervals
|
|
@@ -108,8 +108,9 @@ export declare class Statistic {
|
|
|
108
108
|
* @param {number} level - The entry level for the request:
|
|
109
109
|
* - 0 for Organization
|
|
110
110
|
* - 2 for Paypoint
|
|
111
|
+
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
111
112
|
* @param {Payabli.SubStatsRequest} request
|
|
112
|
-
* @param {
|
|
113
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
113
114
|
*
|
|
114
115
|
* @throws {@link Payabli.BadRequestError}
|
|
115
116
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -117,22 +118,13 @@ export declare class Statistic {
|
|
|
117
118
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
118
119
|
*
|
|
119
120
|
* @example
|
|
120
|
-
* await client.statistic.subStats(
|
|
121
|
+
* await client.statistic.subStats("30", 1, 1000000)
|
|
121
122
|
*/
|
|
122
|
-
subStats(
|
|
123
|
+
subStats(interval: string, level: number, entryId: number, request?: Payabli.SubStatsRequest, requestOptions?: StatisticClient.RequestOptions): core.HttpResponsePromise<Payabli.StatBasicQueryRecord[]>;
|
|
123
124
|
private __subStats;
|
|
124
125
|
/**
|
|
125
126
|
* Retrieve the basic statistics about a vendor for a given time period, grouped by frequency.
|
|
126
127
|
*
|
|
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
128
|
* @param {string} mode - Mode for request. Allowed values:
|
|
137
129
|
*
|
|
138
130
|
* - `ytd` - Year To Date
|
|
@@ -146,8 +138,17 @@ export declare class Statistic {
|
|
|
146
138
|
* - `lastm` - Last Month
|
|
147
139
|
* - `lastw` - Last Week
|
|
148
140
|
* - `yesterday` - Last Day
|
|
141
|
+
* @param {string} freq - Frequency to group series. Allowed values:
|
|
142
|
+
*
|
|
143
|
+
* - `m` - monthly
|
|
144
|
+
* - `w` - weekly
|
|
145
|
+
* - `d` - daily
|
|
146
|
+
* - `h` - hourly
|
|
147
|
+
*
|
|
148
|
+
* For example, `w` groups the results by week.
|
|
149
|
+
* @param {number} idVendor - Vendor ID.
|
|
149
150
|
* @param {Payabli.VendorBasicStatsRequest} request
|
|
150
|
-
* @param {
|
|
151
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
151
152
|
*
|
|
152
153
|
* @throws {@link Payabli.BadRequestError}
|
|
153
154
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -155,9 +156,8 @@ export declare class Statistic {
|
|
|
155
156
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
156
157
|
*
|
|
157
158
|
* @example
|
|
158
|
-
* await client.statistic.vendorBasicStats("m", 1
|
|
159
|
+
* await client.statistic.vendorBasicStats("ytd", "m", 1)
|
|
159
160
|
*/
|
|
160
|
-
vendorBasicStats(
|
|
161
|
+
vendorBasicStats(mode: string, freq: string, idVendor: number, request?: Payabli.VendorBasicStatsRequest, requestOptions?: StatisticClient.RequestOptions): core.HttpResponsePromise<Payabli.StatisticsVendorQueryRecord[]>;
|
|
161
162
|
private __vendorBasicStats;
|
|
162
|
-
protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
|
|
163
163
|
}
|
|
@@ -43,32 +43,22 @@ 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.StatisticClient = 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 json_js_1 = require("../../../../core/json.js");
|
|
50
51
|
const environments = __importStar(require("../../../../environments.js"));
|
|
52
|
+
const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
|
|
51
53
|
const errors = __importStar(require("../../../../errors/index.js"));
|
|
52
54
|
const Payabli = __importStar(require("../../../index.js"));
|
|
53
|
-
class
|
|
54
|
-
constructor(
|
|
55
|
-
this._options =
|
|
55
|
+
class StatisticClient {
|
|
56
|
+
constructor(options = {}) {
|
|
57
|
+
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
56
58
|
}
|
|
57
59
|
/**
|
|
58
60
|
* Retrieves the basic statistics for an organization or a paypoint, for a given time period, grouped by a particular frequency.
|
|
59
61
|
*
|
|
60
|
-
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
61
|
-
* @param {string} freq - Frequency to group series. Allowed values:
|
|
62
|
-
*
|
|
63
|
-
* - `m` - monthly
|
|
64
|
-
* - `w` - weekly
|
|
65
|
-
* - `d` - daily
|
|
66
|
-
* - `h` - hourly
|
|
67
|
-
*
|
|
68
|
-
* For example, `w` groups the results by week.
|
|
69
|
-
* @param {number} level - The entry level for the request:
|
|
70
|
-
* - 0 for Organization
|
|
71
|
-
* - 2 for Paypoint
|
|
72
62
|
* @param {string} mode - Mode for the request. Allowed values:
|
|
73
63
|
*
|
|
74
64
|
* - `custom` - Allows you to set a custom date range
|
|
@@ -84,8 +74,20 @@ class Statistic {
|
|
|
84
74
|
* - `lastw` - Last Week
|
|
85
75
|
* - `yesterday` - Last Day
|
|
86
76
|
*
|
|
77
|
+
* @param {string} freq - Frequency to group series. Allowed values:
|
|
78
|
+
*
|
|
79
|
+
* - `m` - monthly
|
|
80
|
+
* - `w` - weekly
|
|
81
|
+
* - `d` - daily
|
|
82
|
+
* - `h` - hourly
|
|
83
|
+
*
|
|
84
|
+
* For example, `w` groups the results by week.
|
|
85
|
+
* @param {number} level - The entry level for the request:
|
|
86
|
+
* - 0 for Organization
|
|
87
|
+
* - 2 for Paypoint
|
|
88
|
+
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
87
89
|
* @param {Payabli.BasicStatsRequest} request
|
|
88
|
-
* @param {
|
|
90
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
89
91
|
*
|
|
90
92
|
* @throws {@link Payabli.BadRequestError}
|
|
91
93
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -93,16 +95,16 @@ class Statistic {
|
|
|
93
95
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
94
96
|
*
|
|
95
97
|
* @example
|
|
96
|
-
* await client.statistic.basicStats(
|
|
97
|
-
* endDate: "
|
|
98
|
-
* startDate: "
|
|
98
|
+
* await client.statistic.basicStats("ytd", "m", 1, 1000000, {
|
|
99
|
+
* endDate: "2025-11-01",
|
|
100
|
+
* startDate: "2025-11-30"
|
|
99
101
|
* })
|
|
100
102
|
*/
|
|
101
|
-
basicStats(
|
|
102
|
-
return core.HttpResponsePromise.fromPromise(this.__basicStats(
|
|
103
|
+
basicStats(mode, freq, level, entryId, request = {}, requestOptions) {
|
|
104
|
+
return core.HttpResponsePromise.fromPromise(this.__basicStats(mode, freq, level, entryId, request, requestOptions));
|
|
103
105
|
}
|
|
104
|
-
__basicStats(
|
|
105
|
-
return __awaiter(this, arguments, void 0, function* (
|
|
106
|
+
__basicStats(mode_1, freq_1, level_1, entryId_1) {
|
|
107
|
+
return __awaiter(this, arguments, void 0, function* (mode, freq, level, entryId, request = {}, requestOptions) {
|
|
106
108
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
107
109
|
const { endDate, parameters, startDate } = request;
|
|
108
110
|
const _queryParams = {};
|
|
@@ -115,7 +117,8 @@ class Statistic {
|
|
|
115
117
|
if (startDate != null) {
|
|
116
118
|
_queryParams.startDate = startDate;
|
|
117
119
|
}
|
|
118
|
-
const
|
|
120
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
121
|
+
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);
|
|
119
122
|
const _response = yield core.fetcher({
|
|
120
123
|
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)}`),
|
|
121
124
|
method: "GET",
|
|
@@ -128,7 +131,10 @@ class Statistic {
|
|
|
128
131
|
logging: this._options.logging,
|
|
129
132
|
});
|
|
130
133
|
if (_response.ok) {
|
|
131
|
-
return {
|
|
134
|
+
return {
|
|
135
|
+
data: _response.body,
|
|
136
|
+
rawResponse: _response.rawResponse,
|
|
137
|
+
};
|
|
132
138
|
}
|
|
133
139
|
if (_response.error.reason === "status-code") {
|
|
134
140
|
switch (_response.error.statusCode) {
|
|
@@ -148,35 +154,12 @@ class Statistic {
|
|
|
148
154
|
});
|
|
149
155
|
}
|
|
150
156
|
}
|
|
151
|
-
|
|
152
|
-
case "non-json":
|
|
153
|
-
throw new errors.PayabliError({
|
|
154
|
-
statusCode: _response.error.statusCode,
|
|
155
|
-
body: _response.error.rawBody,
|
|
156
|
-
rawResponse: _response.rawResponse,
|
|
157
|
-
});
|
|
158
|
-
case "timeout":
|
|
159
|
-
throw new errors.PayabliTimeoutError("Timeout exceeded when calling GET /Statistic/basic/{mode}/{freq}/{level}/{entryId}.");
|
|
160
|
-
case "unknown":
|
|
161
|
-
throw new errors.PayabliError({
|
|
162
|
-
message: _response.error.errorMessage,
|
|
163
|
-
rawResponse: _response.rawResponse,
|
|
164
|
-
});
|
|
165
|
-
}
|
|
157
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Statistic/basic/{mode}/{freq}/{level}/{entryId}");
|
|
166
158
|
});
|
|
167
159
|
}
|
|
168
160
|
/**
|
|
169
161
|
* Retrieves the basic statistics for a customer for a specific time period, grouped by a selected frequency.
|
|
170
162
|
*
|
|
171
|
-
* @param {number} customerId - Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
|
|
172
|
-
* @param {string} freq - Frequency to group series. Allowed values:
|
|
173
|
-
*
|
|
174
|
-
* - `m` - monthly
|
|
175
|
-
* - `w` - weekly
|
|
176
|
-
* - `d` - daily
|
|
177
|
-
* - `h` - hourly
|
|
178
|
-
*
|
|
179
|
-
* For example, `w` groups the results by week.
|
|
180
163
|
* @param {string} mode - Mode for request. Allowed values:
|
|
181
164
|
*
|
|
182
165
|
* - `ytd` - Year To Date
|
|
@@ -190,8 +173,17 @@ class Statistic {
|
|
|
190
173
|
* - `lastm` - Last Month
|
|
191
174
|
* - `lastw` - Last Week
|
|
192
175
|
* - `yesterday` - Last Day
|
|
176
|
+
* @param {string} freq - Frequency to group series. Allowed values:
|
|
177
|
+
*
|
|
178
|
+
* - `m` - monthly
|
|
179
|
+
* - `w` - weekly
|
|
180
|
+
* - `d` - daily
|
|
181
|
+
* - `h` - hourly
|
|
182
|
+
*
|
|
183
|
+
* For example, `w` groups the results by week.
|
|
184
|
+
* @param {number} customerId - Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
|
|
193
185
|
* @param {Payabli.CustomerBasicStatsRequest} request
|
|
194
|
-
* @param {
|
|
186
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
195
187
|
*
|
|
196
188
|
* @throws {@link Payabli.BadRequestError}
|
|
197
189
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -199,20 +191,21 @@ class Statistic {
|
|
|
199
191
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
200
192
|
*
|
|
201
193
|
* @example
|
|
202
|
-
* await client.statistic.customerBasicStats(
|
|
194
|
+
* await client.statistic.customerBasicStats("ytd", "m", 998)
|
|
203
195
|
*/
|
|
204
|
-
customerBasicStats(
|
|
205
|
-
return core.HttpResponsePromise.fromPromise(this.__customerBasicStats(
|
|
196
|
+
customerBasicStats(mode, freq, customerId, request = {}, requestOptions) {
|
|
197
|
+
return core.HttpResponsePromise.fromPromise(this.__customerBasicStats(mode, freq, customerId, request, requestOptions));
|
|
206
198
|
}
|
|
207
|
-
__customerBasicStats(
|
|
208
|
-
return __awaiter(this, arguments, void 0, function* (
|
|
199
|
+
__customerBasicStats(mode_1, freq_1, customerId_1) {
|
|
200
|
+
return __awaiter(this, arguments, void 0, function* (mode, freq, customerId, request = {}, requestOptions) {
|
|
209
201
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
210
202
|
const { parameters } = request;
|
|
211
203
|
const _queryParams = {};
|
|
212
204
|
if (parameters != null) {
|
|
213
205
|
_queryParams.parameters = (0, json_js_1.toJson)(parameters);
|
|
214
206
|
}
|
|
215
|
-
const
|
|
207
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
208
|
+
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);
|
|
216
209
|
const _response = yield core.fetcher({
|
|
217
210
|
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)}`),
|
|
218
211
|
method: "GET",
|
|
@@ -248,27 +241,12 @@ class Statistic {
|
|
|
248
241
|
});
|
|
249
242
|
}
|
|
250
243
|
}
|
|
251
|
-
|
|
252
|
-
case "non-json":
|
|
253
|
-
throw new errors.PayabliError({
|
|
254
|
-
statusCode: _response.error.statusCode,
|
|
255
|
-
body: _response.error.rawBody,
|
|
256
|
-
rawResponse: _response.rawResponse,
|
|
257
|
-
});
|
|
258
|
-
case "timeout":
|
|
259
|
-
throw new errors.PayabliTimeoutError("Timeout exceeded when calling GET /Statistic/customerbasic/{mode}/{freq}/{customerId}.");
|
|
260
|
-
case "unknown":
|
|
261
|
-
throw new errors.PayabliError({
|
|
262
|
-
message: _response.error.errorMessage,
|
|
263
|
-
rawResponse: _response.rawResponse,
|
|
264
|
-
});
|
|
265
|
-
}
|
|
244
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Statistic/customerbasic/{mode}/{freq}/{customerId}");
|
|
266
245
|
});
|
|
267
246
|
}
|
|
268
247
|
/**
|
|
269
248
|
* Retrieves the subscription statistics for a given interval for a paypoint or organization.
|
|
270
249
|
*
|
|
271
|
-
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
272
250
|
* @param {string} interval - Interval to get the data. Allowed values:
|
|
273
251
|
*
|
|
274
252
|
* - `all` - all intervals
|
|
@@ -279,8 +257,9 @@ class Statistic {
|
|
|
279
257
|
* @param {number} level - The entry level for the request:
|
|
280
258
|
* - 0 for Organization
|
|
281
259
|
* - 2 for Paypoint
|
|
260
|
+
* @param {number} entryId - Identifier in Payabli for the entity.
|
|
282
261
|
* @param {Payabli.SubStatsRequest} request
|
|
283
|
-
* @param {
|
|
262
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
284
263
|
*
|
|
285
264
|
* @throws {@link Payabli.BadRequestError}
|
|
286
265
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -288,20 +267,21 @@ class Statistic {
|
|
|
288
267
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
289
268
|
*
|
|
290
269
|
* @example
|
|
291
|
-
* await client.statistic.subStats(
|
|
270
|
+
* await client.statistic.subStats("30", 1, 1000000)
|
|
292
271
|
*/
|
|
293
|
-
subStats(
|
|
294
|
-
return core.HttpResponsePromise.fromPromise(this.__subStats(
|
|
272
|
+
subStats(interval, level, entryId, request = {}, requestOptions) {
|
|
273
|
+
return core.HttpResponsePromise.fromPromise(this.__subStats(interval, level, entryId, request, requestOptions));
|
|
295
274
|
}
|
|
296
|
-
__subStats(
|
|
297
|
-
return __awaiter(this, arguments, void 0, function* (
|
|
275
|
+
__subStats(interval_1, level_1, entryId_1) {
|
|
276
|
+
return __awaiter(this, arguments, void 0, function* (interval, level, entryId, request = {}, requestOptions) {
|
|
298
277
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
299
278
|
const { parameters } = request;
|
|
300
279
|
const _queryParams = {};
|
|
301
280
|
if (parameters != null) {
|
|
302
281
|
_queryParams.parameters = (0, json_js_1.toJson)(parameters);
|
|
303
282
|
}
|
|
304
|
-
const
|
|
283
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
284
|
+
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
285
|
const _response = yield core.fetcher({
|
|
306
286
|
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)}`),
|
|
307
287
|
method: "GET",
|
|
@@ -334,35 +314,12 @@ class Statistic {
|
|
|
334
314
|
});
|
|
335
315
|
}
|
|
336
316
|
}
|
|
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 GET /Statistic/subscriptions/{interval}/{level}/{entryId}.");
|
|
346
|
-
case "unknown":
|
|
347
|
-
throw new errors.PayabliError({
|
|
348
|
-
message: _response.error.errorMessage,
|
|
349
|
-
rawResponse: _response.rawResponse,
|
|
350
|
-
});
|
|
351
|
-
}
|
|
317
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Statistic/subscriptions/{interval}/{level}/{entryId}");
|
|
352
318
|
});
|
|
353
319
|
}
|
|
354
320
|
/**
|
|
355
321
|
* Retrieve the basic statistics about a vendor for a given time period, grouped by frequency.
|
|
356
322
|
*
|
|
357
|
-
* @param {string} freq - Frequency to group series. Allowed values:
|
|
358
|
-
*
|
|
359
|
-
* - `m` - monthly
|
|
360
|
-
* - `w` - weekly
|
|
361
|
-
* - `d` - daily
|
|
362
|
-
* - `h` - hourly
|
|
363
|
-
*
|
|
364
|
-
* For example, `w` groups the results by week.
|
|
365
|
-
* @param {number} idVendor - Vendor ID.
|
|
366
323
|
* @param {string} mode - Mode for request. Allowed values:
|
|
367
324
|
*
|
|
368
325
|
* - `ytd` - Year To Date
|
|
@@ -376,8 +333,17 @@ class Statistic {
|
|
|
376
333
|
* - `lastm` - Last Month
|
|
377
334
|
* - `lastw` - Last Week
|
|
378
335
|
* - `yesterday` - Last Day
|
|
336
|
+
* @param {string} freq - Frequency to group series. Allowed values:
|
|
337
|
+
*
|
|
338
|
+
* - `m` - monthly
|
|
339
|
+
* - `w` - weekly
|
|
340
|
+
* - `d` - daily
|
|
341
|
+
* - `h` - hourly
|
|
342
|
+
*
|
|
343
|
+
* For example, `w` groups the results by week.
|
|
344
|
+
* @param {number} idVendor - Vendor ID.
|
|
379
345
|
* @param {Payabli.VendorBasicStatsRequest} request
|
|
380
|
-
* @param {
|
|
346
|
+
* @param {StatisticClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
381
347
|
*
|
|
382
348
|
* @throws {@link Payabli.BadRequestError}
|
|
383
349
|
* @throws {@link Payabli.UnauthorizedError}
|
|
@@ -385,20 +351,21 @@ class Statistic {
|
|
|
385
351
|
* @throws {@link Payabli.ServiceUnavailableError}
|
|
386
352
|
*
|
|
387
353
|
* @example
|
|
388
|
-
* await client.statistic.vendorBasicStats("m", 1
|
|
354
|
+
* await client.statistic.vendorBasicStats("ytd", "m", 1)
|
|
389
355
|
*/
|
|
390
|
-
vendorBasicStats(freq, idVendor,
|
|
391
|
-
return core.HttpResponsePromise.fromPromise(this.__vendorBasicStats(freq, idVendor,
|
|
356
|
+
vendorBasicStats(mode, freq, idVendor, request = {}, requestOptions) {
|
|
357
|
+
return core.HttpResponsePromise.fromPromise(this.__vendorBasicStats(mode, freq, idVendor, request, requestOptions));
|
|
392
358
|
}
|
|
393
|
-
__vendorBasicStats(freq_1, idVendor_1
|
|
394
|
-
return __awaiter(this, arguments, void 0, function* (freq, idVendor,
|
|
359
|
+
__vendorBasicStats(mode_1, freq_1, idVendor_1) {
|
|
360
|
+
return __awaiter(this, arguments, void 0, function* (mode, freq, idVendor, request = {}, requestOptions) {
|
|
395
361
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
396
362
|
const { parameters } = request;
|
|
397
363
|
const _queryParams = {};
|
|
398
364
|
if (parameters != null) {
|
|
399
365
|
_queryParams.parameters = (0, json_js_1.toJson)(parameters);
|
|
400
366
|
}
|
|
401
|
-
const
|
|
367
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
368
|
+
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);
|
|
402
369
|
const _response = yield core.fetcher({
|
|
403
370
|
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)}`),
|
|
404
371
|
method: "GET",
|
|
@@ -434,28 +401,8 @@ class Statistic {
|
|
|
434
401
|
});
|
|
435
402
|
}
|
|
436
403
|
}
|
|
437
|
-
|
|
438
|
-
case "non-json":
|
|
439
|
-
throw new errors.PayabliError({
|
|
440
|
-
statusCode: _response.error.statusCode,
|
|
441
|
-
body: _response.error.rawBody,
|
|
442
|
-
rawResponse: _response.rawResponse,
|
|
443
|
-
});
|
|
444
|
-
case "timeout":
|
|
445
|
-
throw new errors.PayabliTimeoutError("Timeout exceeded when calling GET /Statistic/vendorbasic/{mode}/{freq}/{idVendor}.");
|
|
446
|
-
case "unknown":
|
|
447
|
-
throw new errors.PayabliError({
|
|
448
|
-
message: _response.error.errorMessage,
|
|
449
|
-
rawResponse: _response.rawResponse,
|
|
450
|
-
});
|
|
451
|
-
}
|
|
452
|
-
});
|
|
453
|
-
}
|
|
454
|
-
_getCustomAuthorizationHeaders() {
|
|
455
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
456
|
-
const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
|
|
457
|
-
return { requestToken: apiKeyValue };
|
|
404
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Statistic/vendorbasic/{mode}/{freq}/{idVendor}");
|
|
458
405
|
});
|
|
459
406
|
}
|
|
460
407
|
}
|
|
461
|
-
exports.
|
|
408
|
+
exports.StatisticClient = StatisticClient;
|