@kard-financial/sdk 12.2.1 → 12.4.0
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 +106 -15
- package/dist/cjs/BaseClient.d.ts +7 -8
- package/dist/cjs/BaseClient.js +3 -3
- package/dist/cjs/Client.d.ts +13 -2
- package/dist/cjs/Client.js +67 -0
- package/dist/cjs/api/resources/auth/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/auth/client/Client.js +3 -23
- package/dist/cjs/api/resources/auth/exports.d.ts +2 -0
- package/dist/cjs/api/resources/auth/exports.js +21 -0
- package/dist/cjs/api/resources/commons/errors/ConflictError.js +5 -1
- package/dist/cjs/api/resources/commons/errors/DoesNotExistError.js +5 -1
- package/dist/cjs/api/resources/commons/errors/ForbiddenError.js +5 -1
- package/dist/cjs/api/resources/commons/errors/InternalServerError.js +5 -1
- package/dist/cjs/api/resources/commons/errors/InvalidRequest.js +5 -1
- package/dist/cjs/api/resources/commons/errors/UnauthorizedError.js +5 -1
- package/dist/cjs/api/resources/commons/exports.d.ts +1 -0
- package/dist/cjs/api/resources/commons/exports.js +18 -0
- package/dist/cjs/api/resources/commons/types/ErrorObject.d.ts +2 -2
- package/dist/cjs/api/resources/commons/types/ErrorSource.d.ts +3 -3
- package/dist/cjs/api/resources/commons/types/Links.d.ts +2 -2
- package/dist/cjs/api/resources/files/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/files/client/Client.js +11 -47
- package/dist/cjs/api/resources/files/exports.d.ts +2 -0
- package/dist/cjs/api/resources/files/exports.js +21 -0
- package/dist/cjs/api/resources/notifications/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/notifications/exports.d.ts +3 -0
- package/dist/cjs/api/resources/notifications/exports.js +22 -0
- package/dist/cjs/api/resources/notifications/resources/subscriptions/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/notifications/resources/subscriptions/client/Client.js +7 -64
- package/dist/cjs/api/resources/notifications/resources/subscriptions/exports.d.ts +2 -0
- package/dist/cjs/api/resources/notifications/resources/subscriptions/exports.js +21 -0
- package/dist/cjs/api/resources/notifications/resources/subscriptions/types/UpdateSubscriptionRequestAttributes.d.ts +3 -3
- package/dist/cjs/api/resources/notifications/types/AuditUpdateAttributes.d.ts +3 -3
- package/dist/cjs/api/resources/notifications/types/FailedTransactionAttributes.d.ts +1 -1
- package/dist/cjs/api/resources/notifications/types/NotificationPayload.d.ts +2 -2
- package/dist/cjs/api/resources/notifications/types/RewardNotificationAttributes.d.ts +2 -2
- package/dist/cjs/api/resources/ping/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/ping/client/Client.js +2 -20
- package/dist/cjs/api/resources/ping/errors/NetworkBlockedError.js +5 -1
- package/dist/cjs/api/resources/ping/exports.d.ts +2 -0
- package/dist/cjs/api/resources/ping/exports.js +21 -0
- package/dist/cjs/api/resources/transactions/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/transactions/client/Client.js +15 -112
- package/dist/cjs/api/resources/transactions/client/requests/GetEarnedRewardsRequest.d.ts +4 -1
- package/dist/cjs/api/resources/transactions/errors/CreateAuditMultiStatus.js +5 -1
- package/dist/cjs/api/resources/transactions/errors/CreateIncomingTransactionsMultiStatus.js +5 -1
- package/dist/cjs/api/resources/transactions/errors/FraudMultiStatus.js +5 -1
- package/dist/cjs/api/resources/transactions/exports.d.ts +2 -0
- package/dist/cjs/api/resources/transactions/exports.js +21 -0
- package/dist/cjs/api/resources/transactions/types/CoreTransactionAttributes.d.ts +3 -3
- package/dist/cjs/api/resources/transactions/types/CreateAuditMultiStatusResponse.d.ts +1 -1
- package/dist/cjs/api/resources/transactions/types/GetEarnedRewardsResponse.d.ts +1 -1
- package/dist/cjs/api/resources/transactions/types/MatchedTransactionsAttributes.d.ts +14 -14
- package/dist/cjs/api/resources/transactions/types/Merchant.d.ts +9 -9
- package/dist/cjs/api/resources/transactions/types/RewardedTransactionAttributes.d.ts +3 -3
- package/dist/cjs/api/resources/transactions/types/TransactionsAttributes.d.ts +18 -18
- package/dist/cjs/api/resources/users/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/users/client/Client.js +5 -80
- package/dist/cjs/api/resources/users/errors/MultiStatus.js +5 -1
- package/dist/cjs/api/resources/users/exports.d.ts +3 -0
- package/dist/cjs/api/resources/users/exports.js +22 -0
- package/dist/cjs/api/resources/users/resources/attributions/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/users/resources/attributions/client/Client.js +20 -94
- package/dist/cjs/api/resources/users/resources/attributions/exports.d.ts +2 -0
- package/dist/cjs/api/resources/users/resources/attributions/exports.js +21 -0
- package/dist/cjs/api/resources/users/resources/attributions/types/ActivateOfferResponse.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/attributions/types/AttributionState.d.ts +2 -2
- package/dist/cjs/api/resources/users/resources/attributions/types/BoostOfferResponse.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/attributions/types/NotificationAttributionAttributes.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/attributions/types/OfferAttributionAttributes.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/auth/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/users/resources/auth/client/Client.js +2 -20
- package/dist/cjs/api/resources/users/resources/auth/exports.d.ts +2 -0
- package/dist/cjs/api/resources/users/resources/auth/exports.js +21 -0
- package/dist/cjs/api/resources/users/resources/rewards/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/users/resources/rewards/client/Client.js +39 -144
- package/dist/cjs/api/resources/users/resources/rewards/exports.d.ts +2 -0
- package/dist/cjs/api/resources/users/resources/rewards/exports.js +21 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/CtaComponent.d.ts +2 -2
- package/dist/cjs/api/resources/users/resources/rewards/types/LocationData.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/rewards/types/LocationsResponseObject.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/rewards/types/LogoFlare.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/rewards/types/OfferCommonFields.d.ts +8 -8
- package/dist/cjs/api/resources/users/resources/rewards/types/OfferComponents.d.ts +9 -9
- package/dist/cjs/api/resources/users/resources/rewards/types/OffersMeta.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/rewards/types/OffersResponseObject.d.ts +2 -2
- package/dist/cjs/api/resources/users/resources/rewards/types/ProgressBar.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/rewards/types/ProgressBarLabelPair.d.ts +2 -2
- package/dist/cjs/api/resources/users/resources/rewards/types/ProgressBarLabels.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/rewards/types/ProgressBarSegment.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/rewards/types/ProgressBarSegments.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/rewards/types/StandardOffer.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/uploads/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/users/resources/uploads/client/Client.js +4 -60
- package/dist/cjs/api/resources/users/resources/uploads/errors/UploadPartMultiStatus.js +5 -1
- package/dist/cjs/api/resources/users/resources/uploads/exports.d.ts +2 -0
- package/dist/cjs/api/resources/users/resources/uploads/exports.js +21 -0
- package/dist/cjs/api/resources/users/resources/uploads/types/CreateUploadPartMultiStatusResponse.d.ts +1 -1
- package/dist/cjs/api/resources/users/types/CreateUsersMultiStatusResponse.d.ts +1 -1
- package/dist/cjs/api/resources/users/types/UpdateUserRequestAttributes.d.ts +5 -5
- package/dist/cjs/api/resources/users/types/UserRequestAttributes.d.ts +6 -6
- package/dist/cjs/auth/OAuthAuthProvider.d.ts +36 -14
- package/dist/cjs/auth/OAuthAuthProvider.js +108 -40
- package/dist/cjs/core/auth/BasicAuth.d.ts +2 -2
- package/dist/cjs/core/auth/BasicAuth.js +7 -1
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +1 -1
- package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +2 -2
- package/dist/cjs/core/fetcher/Fetcher.d.ts +3 -2
- package/dist/cjs/core/fetcher/Fetcher.js +12 -2
- package/dist/cjs/core/fetcher/index.d.ts +2 -0
- package/dist/cjs/core/fetcher/index.js +3 -1
- package/dist/cjs/core/fetcher/makePassthroughRequest.d.ts +49 -0
- package/dist/cjs/core/fetcher/makePassthroughRequest.js +135 -0
- package/dist/cjs/core/fetcher/makeRequest.d.ts +6 -1
- package/dist/cjs/core/fetcher/makeRequest.js +30 -9
- package/dist/cjs/core/headers.d.ts +2 -2
- package/dist/cjs/core/runtime/runtime.js +8 -7
- package/dist/cjs/errors/KardApiError.d.ts +3 -1
- package/dist/cjs/errors/KardApiError.js +9 -2
- package/dist/cjs/errors/KardApiTimeoutError.d.ts +4 -1
- package/dist/cjs/errors/KardApiTimeoutError.js +9 -2
- package/dist/cjs/errors/handleNonStatusCodeError.d.ts +2 -0
- package/dist/cjs/errors/handleNonStatusCodeError.js +68 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +7 -8
- package/dist/esm/BaseClient.mjs +3 -3
- package/dist/esm/Client.d.mts +13 -2
- package/dist/esm/Client.mjs +34 -0
- package/dist/esm/api/resources/auth/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/auth/client/Client.mjs +3 -23
- package/dist/esm/api/resources/auth/exports.d.mts +2 -0
- package/dist/esm/api/resources/auth/exports.mjs +3 -0
- package/dist/esm/api/resources/commons/errors/ConflictError.mjs +5 -1
- package/dist/esm/api/resources/commons/errors/DoesNotExistError.mjs +5 -1
- package/dist/esm/api/resources/commons/errors/ForbiddenError.mjs +5 -1
- package/dist/esm/api/resources/commons/errors/InternalServerError.mjs +5 -1
- package/dist/esm/api/resources/commons/errors/InvalidRequest.mjs +5 -1
- package/dist/esm/api/resources/commons/errors/UnauthorizedError.mjs +5 -1
- package/dist/esm/api/resources/commons/exports.d.mts +1 -0
- package/dist/esm/api/resources/commons/exports.mjs +2 -0
- package/dist/esm/api/resources/commons/types/ErrorObject.d.mts +2 -2
- package/dist/esm/api/resources/commons/types/ErrorSource.d.mts +3 -3
- package/dist/esm/api/resources/commons/types/Links.d.mts +2 -2
- package/dist/esm/api/resources/files/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/files/client/Client.mjs +11 -47
- package/dist/esm/api/resources/files/exports.d.mts +2 -0
- package/dist/esm/api/resources/files/exports.mjs +3 -0
- package/dist/esm/api/resources/notifications/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/notifications/exports.d.mts +3 -0
- package/dist/esm/api/resources/notifications/exports.mjs +4 -0
- package/dist/esm/api/resources/notifications/resources/subscriptions/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/notifications/resources/subscriptions/client/Client.mjs +7 -64
- package/dist/esm/api/resources/notifications/resources/subscriptions/exports.d.mts +2 -0
- package/dist/esm/api/resources/notifications/resources/subscriptions/exports.mjs +3 -0
- package/dist/esm/api/resources/notifications/resources/subscriptions/types/UpdateSubscriptionRequestAttributes.d.mts +3 -3
- package/dist/esm/api/resources/notifications/types/AuditUpdateAttributes.d.mts +3 -3
- package/dist/esm/api/resources/notifications/types/FailedTransactionAttributes.d.mts +1 -1
- package/dist/esm/api/resources/notifications/types/NotificationPayload.d.mts +2 -2
- package/dist/esm/api/resources/notifications/types/RewardNotificationAttributes.d.mts +2 -2
- package/dist/esm/api/resources/ping/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/ping/client/Client.mjs +2 -20
- package/dist/esm/api/resources/ping/errors/NetworkBlockedError.mjs +5 -1
- package/dist/esm/api/resources/ping/exports.d.mts +2 -0
- package/dist/esm/api/resources/ping/exports.mjs +3 -0
- package/dist/esm/api/resources/transactions/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/transactions/client/Client.mjs +15 -112
- package/dist/esm/api/resources/transactions/client/requests/GetEarnedRewardsRequest.d.mts +4 -1
- package/dist/esm/api/resources/transactions/errors/CreateAuditMultiStatus.mjs +5 -1
- package/dist/esm/api/resources/transactions/errors/CreateIncomingTransactionsMultiStatus.mjs +5 -1
- package/dist/esm/api/resources/transactions/errors/FraudMultiStatus.mjs +5 -1
- package/dist/esm/api/resources/transactions/exports.d.mts +2 -0
- package/dist/esm/api/resources/transactions/exports.mjs +3 -0
- package/dist/esm/api/resources/transactions/types/CoreTransactionAttributes.d.mts +3 -3
- package/dist/esm/api/resources/transactions/types/CreateAuditMultiStatusResponse.d.mts +1 -1
- package/dist/esm/api/resources/transactions/types/GetEarnedRewardsResponse.d.mts +1 -1
- package/dist/esm/api/resources/transactions/types/MatchedTransactionsAttributes.d.mts +14 -14
- package/dist/esm/api/resources/transactions/types/Merchant.d.mts +9 -9
- package/dist/esm/api/resources/transactions/types/RewardedTransactionAttributes.d.mts +3 -3
- package/dist/esm/api/resources/transactions/types/TransactionsAttributes.d.mts +18 -18
- package/dist/esm/api/resources/users/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/users/client/Client.mjs +5 -80
- package/dist/esm/api/resources/users/errors/MultiStatus.mjs +5 -1
- package/dist/esm/api/resources/users/exports.d.mts +3 -0
- package/dist/esm/api/resources/users/exports.mjs +4 -0
- package/dist/esm/api/resources/users/resources/attributions/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/users/resources/attributions/client/Client.mjs +20 -94
- package/dist/esm/api/resources/users/resources/attributions/exports.d.mts +2 -0
- package/dist/esm/api/resources/users/resources/attributions/exports.mjs +3 -0
- package/dist/esm/api/resources/users/resources/attributions/types/ActivateOfferResponse.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/attributions/types/AttributionState.d.mts +2 -2
- package/dist/esm/api/resources/users/resources/attributions/types/BoostOfferResponse.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/attributions/types/NotificationAttributionAttributes.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/attributions/types/OfferAttributionAttributes.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/auth/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/users/resources/auth/client/Client.mjs +2 -20
- package/dist/esm/api/resources/users/resources/auth/exports.d.mts +2 -0
- package/dist/esm/api/resources/users/resources/auth/exports.mjs +3 -0
- package/dist/esm/api/resources/users/resources/rewards/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/users/resources/rewards/client/Client.mjs +39 -144
- package/dist/esm/api/resources/users/resources/rewards/exports.d.mts +2 -0
- package/dist/esm/api/resources/users/resources/rewards/exports.mjs +3 -0
- package/dist/esm/api/resources/users/resources/rewards/types/CtaComponent.d.mts +2 -2
- package/dist/esm/api/resources/users/resources/rewards/types/LocationData.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/rewards/types/LocationsResponseObject.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/rewards/types/LogoFlare.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/rewards/types/OfferCommonFields.d.mts +8 -8
- package/dist/esm/api/resources/users/resources/rewards/types/OfferComponents.d.mts +9 -9
- package/dist/esm/api/resources/users/resources/rewards/types/OffersMeta.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/rewards/types/OffersResponseObject.d.mts +2 -2
- package/dist/esm/api/resources/users/resources/rewards/types/ProgressBar.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/rewards/types/ProgressBarLabelPair.d.mts +2 -2
- package/dist/esm/api/resources/users/resources/rewards/types/ProgressBarLabels.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/rewards/types/ProgressBarSegment.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/rewards/types/ProgressBarSegments.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/rewards/types/StandardOffer.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/uploads/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/users/resources/uploads/client/Client.mjs +4 -60
- package/dist/esm/api/resources/users/resources/uploads/errors/UploadPartMultiStatus.mjs +5 -1
- package/dist/esm/api/resources/users/resources/uploads/exports.d.mts +2 -0
- package/dist/esm/api/resources/users/resources/uploads/exports.mjs +3 -0
- package/dist/esm/api/resources/users/resources/uploads/types/CreateUploadPartMultiStatusResponse.d.mts +1 -1
- package/dist/esm/api/resources/users/types/CreateUsersMultiStatusResponse.d.mts +1 -1
- package/dist/esm/api/resources/users/types/UpdateUserRequestAttributes.d.mts +5 -5
- package/dist/esm/api/resources/users/types/UserRequestAttributes.d.mts +6 -6
- package/dist/esm/auth/OAuthAuthProvider.d.mts +36 -14
- package/dist/esm/auth/OAuthAuthProvider.mjs +106 -39
- package/dist/esm/core/auth/BasicAuth.d.mts +2 -2
- package/dist/esm/core/auth/BasicAuth.mjs +7 -1
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +1 -1
- package/dist/esm/core/fetcher/EndpointSupplier.d.mts +2 -2
- package/dist/esm/core/fetcher/Fetcher.d.mts +3 -2
- package/dist/esm/core/fetcher/Fetcher.mjs +12 -2
- package/dist/esm/core/fetcher/index.d.mts +2 -0
- package/dist/esm/core/fetcher/index.mjs +1 -0
- package/dist/esm/core/fetcher/makePassthroughRequest.d.mts +49 -0
- package/dist/esm/core/fetcher/makePassthroughRequest.mjs +132 -0
- package/dist/esm/core/fetcher/makeRequest.d.mts +6 -1
- package/dist/esm/core/fetcher/makeRequest.mjs +28 -9
- package/dist/esm/core/headers.d.mts +2 -2
- package/dist/esm/core/runtime/runtime.mjs +8 -7
- package/dist/esm/errors/KardApiError.d.mts +3 -1
- package/dist/esm/errors/KardApiError.mjs +9 -2
- package/dist/esm/errors/KardApiTimeoutError.d.mts +4 -1
- package/dist/esm/errors/KardApiTimeoutError.mjs +9 -2
- package/dist/esm/errors/handleNonStatusCodeError.d.mts +2 -0
- package/dist/esm/errors/handleNonStatusCodeError.mjs +32 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +134 -10
- package/reference.md +3 -1
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
15
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16
|
+
};
|
|
17
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
+
exports.UploadsClient = void 0;
|
|
19
|
+
var Client_js_1 = require("./client/Client.js");
|
|
20
|
+
Object.defineProperty(exports, "UploadsClient", { enumerable: true, get: function () { return Client_js_1.UploadsClient; } });
|
|
21
|
+
__exportStar(require("./client/index.js"), exports);
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import type * as KardApi from "../../../../../index.js";
|
|
2
2
|
export interface CreateUploadPartMultiStatusResponse extends KardApi.ErrorResponse {
|
|
3
|
-
data?: KardApi.users.CreateUploadPartResponseDataUnion[];
|
|
3
|
+
data?: KardApi.users.CreateUploadPartResponseDataUnion[] | undefined;
|
|
4
4
|
}
|
|
@@ -3,13 +3,13 @@ export interface UpdateUserRequestAttributes {
|
|
|
3
3
|
/** Rewards programs to enroll the user in. If an empty array is supplied, the user will not be enrolled in any programs. */
|
|
4
4
|
enrolledRewards: KardApi.EnrolledRewardsType[];
|
|
5
5
|
/** Zipcode of user */
|
|
6
|
-
zipCode?: string;
|
|
6
|
+
zipCode?: string | undefined;
|
|
7
7
|
/** Email address of user */
|
|
8
|
-
email?: string;
|
|
8
|
+
email?: string | undefined;
|
|
9
9
|
/** Hashed email address of user (using SHA-256) */
|
|
10
|
-
hashedEmail?: string;
|
|
10
|
+
hashedEmail?: string | undefined;
|
|
11
11
|
/** Phone number of user in E.164 format */
|
|
12
|
-
phoneNumber?: string;
|
|
12
|
+
phoneNumber?: string | undefined;
|
|
13
13
|
/** Birth year of user */
|
|
14
|
-
birthYear?: string;
|
|
14
|
+
birthYear?: string | undefined;
|
|
15
15
|
}
|
|
@@ -3,15 +3,15 @@ export interface UserRequestAttributes {
|
|
|
3
3
|
/** Rewards programs to enroll the user in. If an empty array is supplied, the user will not be enrolled in any programs. */
|
|
4
4
|
enrolledRewards: KardApi.EnrolledRewardsType[];
|
|
5
5
|
/** Zipcode of user */
|
|
6
|
-
zipCode?: string;
|
|
6
|
+
zipCode?: string | undefined;
|
|
7
7
|
/** Email address of user */
|
|
8
|
-
email?: string;
|
|
8
|
+
email?: string | undefined;
|
|
9
9
|
/** Hashed email address of user (using SHA-256) */
|
|
10
|
-
hashedEmail?: string;
|
|
10
|
+
hashedEmail?: string | undefined;
|
|
11
11
|
/** Phone number of user in E.164 format */
|
|
12
|
-
phoneNumber?: string;
|
|
12
|
+
phoneNumber?: string | undefined;
|
|
13
13
|
/** Birth year of user */
|
|
14
|
-
birthYear?: string;
|
|
14
|
+
birthYear?: string | undefined;
|
|
15
15
|
/** Indicates whether historical transactions have been sent for this user */
|
|
16
|
-
historicalTransactionsSent?: boolean;
|
|
16
|
+
historicalTransactionsSent?: boolean | undefined;
|
|
17
17
|
}
|
|
@@ -1,23 +1,45 @@
|
|
|
1
1
|
import type { BaseClientOptions } from "../BaseClient.js";
|
|
2
2
|
import * as core from "../core/index.js";
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
}
|
|
3
|
+
declare const CLIENT_ID_PARAM: "clientId";
|
|
4
|
+
declare const CLIENT_SECRET_PARAM: "clientSecret";
|
|
5
|
+
declare const TOKEN_PARAM: "token";
|
|
7
6
|
export declare class OAuthAuthProvider implements core.AuthProvider {
|
|
8
|
-
private readonly
|
|
9
|
-
private readonly
|
|
10
|
-
private
|
|
11
|
-
private
|
|
12
|
-
private
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
getAuthRequest(
|
|
7
|
+
private readonly options;
|
|
8
|
+
private readonly authClient;
|
|
9
|
+
private accessToken;
|
|
10
|
+
private expiresAt;
|
|
11
|
+
private refreshPromise;
|
|
12
|
+
constructor(options: OAuthAuthProvider.Options & OAuthAuthProvider.ClientCredentials);
|
|
13
|
+
static canCreate(options?: Partial<OAuthAuthProvider.ClientCredentials & BaseClientOptions>): boolean;
|
|
14
|
+
private clientIdSupplier;
|
|
15
|
+
private clientSecretSupplier;
|
|
16
|
+
getAuthRequest({ endpointMetadata, }?: {
|
|
18
17
|
endpointMetadata?: core.EndpointMetadata;
|
|
19
18
|
}): Promise<core.AuthRequest>;
|
|
20
19
|
private getToken;
|
|
21
20
|
private refresh;
|
|
22
21
|
private getExpiresAt;
|
|
23
22
|
}
|
|
23
|
+
export declare class OAuthTokenOverrideAuthProvider implements core.AuthProvider {
|
|
24
|
+
private readonly options;
|
|
25
|
+
constructor(options: OAuthAuthProvider.TokenOverride);
|
|
26
|
+
static canCreate(options?: Partial<OAuthAuthProvider.TokenOverride & BaseClientOptions>): options is OAuthAuthProvider.TokenOverride;
|
|
27
|
+
getAuthRequest({ endpointMetadata, }?: {
|
|
28
|
+
endpointMetadata?: core.EndpointMetadata;
|
|
29
|
+
}): Promise<core.AuthRequest>;
|
|
30
|
+
}
|
|
31
|
+
export declare namespace OAuthAuthProvider {
|
|
32
|
+
const AUTH_SCHEME: "OAuthScheme";
|
|
33
|
+
const AUTH_CONFIG_ERROR_MESSAGE: string;
|
|
34
|
+
type ClientCredentials = {
|
|
35
|
+
[CLIENT_ID_PARAM]?: core.Supplier<string> | undefined;
|
|
36
|
+
[CLIENT_SECRET_PARAM]?: core.Supplier<string> | undefined;
|
|
37
|
+
};
|
|
38
|
+
type TokenOverride = {
|
|
39
|
+
[TOKEN_PARAM]: core.Supplier<string>;
|
|
40
|
+
};
|
|
41
|
+
type AuthOptions = ClientCredentials | TokenOverride;
|
|
42
|
+
type Options = BaseClientOptions & AuthOptions;
|
|
43
|
+
function createInstance(options: Options): core.AuthProvider;
|
|
44
|
+
}
|
|
45
|
+
export {};
|
|
@@ -43,26 +43,65 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
43
43
|
});
|
|
44
44
|
};
|
|
45
45
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
46
|
-
exports.OAuthAuthProvider = void 0;
|
|
46
|
+
exports.OAuthTokenOverrideAuthProvider = exports.OAuthAuthProvider = void 0;
|
|
47
47
|
const Client_js_1 = require("../api/resources/auth/client/Client.js");
|
|
48
48
|
const core = __importStar(require("../core/index.js"));
|
|
49
49
|
const errors = __importStar(require("../errors/index.js"));
|
|
50
|
+
const CLIENT_ID_PARAM = "clientId";
|
|
51
|
+
const CLIENT_SECRET_PARAM = "clientSecret";
|
|
52
|
+
const TOKEN_PARAM = "token";
|
|
53
|
+
const ENV_CLIENT_ID = "KARD_CLIENT_ID";
|
|
54
|
+
const ENV_CLIENT_SECRET = "KARD_CLIENT_SECRET";
|
|
55
|
+
const CLIENT_ID_REQUIRED_ERROR_MESSAGE = `${CLIENT_ID_PARAM} is required; either pass it as an argument or set the ${ENV_CLIENT_ID} environment variable`;
|
|
56
|
+
const CLIENT_SECRET_REQUIRED_ERROR_MESSAGE = `${CLIENT_SECRET_PARAM} is required; either pass it as an argument or set the ${ENV_CLIENT_SECRET} environment variable`;
|
|
57
|
+
const TOKEN_PARAM_REQUIRED_ERROR_MESSAGE = `${TOKEN_PARAM} is required. Please provide it in options.`;
|
|
58
|
+
const BUFFER_IN_MINUTES = 2;
|
|
50
59
|
class OAuthAuthProvider {
|
|
51
60
|
constructor(options) {
|
|
52
|
-
this.
|
|
53
|
-
this.
|
|
54
|
-
this.
|
|
55
|
-
this._authClient = new Client_js_1.AuthClient(options);
|
|
56
|
-
this._expiresAt = new Date();
|
|
61
|
+
this.options = options;
|
|
62
|
+
this.authClient = new Client_js_1.AuthClient(options);
|
|
63
|
+
this.expiresAt = new Date();
|
|
57
64
|
}
|
|
58
65
|
static canCreate(options) {
|
|
59
66
|
var _a, _b;
|
|
60
|
-
return ((options
|
|
61
|
-
(options
|
|
67
|
+
return (((options === null || options === void 0 ? void 0 : options[CLIENT_ID_PARAM]) != null || ((_a = process.env) === null || _a === void 0 ? void 0 : _a[ENV_CLIENT_ID]) != null) &&
|
|
68
|
+
((options === null || options === void 0 ? void 0 : options[CLIENT_SECRET_PARAM]) != null || ((_b = process.env) === null || _b === void 0 ? void 0 : _b[ENV_CLIENT_SECRET]) != null));
|
|
62
69
|
}
|
|
63
|
-
|
|
64
|
-
return __awaiter(this,
|
|
65
|
-
|
|
70
|
+
clientIdSupplier() {
|
|
71
|
+
return __awaiter(this, arguments, void 0, function* ({ endpointMetadata, } = {}) {
|
|
72
|
+
var _a;
|
|
73
|
+
const supplier = this.options[CLIENT_ID_PARAM];
|
|
74
|
+
if (supplier != null) {
|
|
75
|
+
return core.EndpointSupplier.get(supplier, { endpointMetadata });
|
|
76
|
+
}
|
|
77
|
+
const envClientId = (_a = process.env) === null || _a === void 0 ? void 0 : _a[ENV_CLIENT_ID];
|
|
78
|
+
if (envClientId != null) {
|
|
79
|
+
return envClientId;
|
|
80
|
+
}
|
|
81
|
+
throw new errors.KardApiError({
|
|
82
|
+
message: CLIENT_ID_REQUIRED_ERROR_MESSAGE,
|
|
83
|
+
});
|
|
84
|
+
});
|
|
85
|
+
}
|
|
86
|
+
clientSecretSupplier() {
|
|
87
|
+
return __awaiter(this, arguments, void 0, function* ({ endpointMetadata, } = {}) {
|
|
88
|
+
var _a;
|
|
89
|
+
const supplier = this.options[CLIENT_SECRET_PARAM];
|
|
90
|
+
if (supplier != null) {
|
|
91
|
+
return core.EndpointSupplier.get(supplier, { endpointMetadata });
|
|
92
|
+
}
|
|
93
|
+
const envClientSecret = (_a = process.env) === null || _a === void 0 ? void 0 : _a[ENV_CLIENT_SECRET];
|
|
94
|
+
if (envClientSecret != null) {
|
|
95
|
+
return envClientSecret;
|
|
96
|
+
}
|
|
97
|
+
throw new errors.KardApiError({
|
|
98
|
+
message: CLIENT_SECRET_REQUIRED_ERROR_MESSAGE,
|
|
99
|
+
});
|
|
100
|
+
});
|
|
101
|
+
}
|
|
102
|
+
getAuthRequest() {
|
|
103
|
+
return __awaiter(this, arguments, void 0, function* ({ endpointMetadata, } = {}) {
|
|
104
|
+
const token = yield this.getToken({ endpointMetadata });
|
|
66
105
|
return {
|
|
67
106
|
headers: {
|
|
68
107
|
Authorization: `Bearer ${token}`,
|
|
@@ -70,48 +109,37 @@ class OAuthAuthProvider {
|
|
|
70
109
|
};
|
|
71
110
|
});
|
|
72
111
|
}
|
|
73
|
-
getToken(
|
|
74
|
-
return __awaiter(this,
|
|
75
|
-
if (this.
|
|
76
|
-
return this.
|
|
112
|
+
getToken() {
|
|
113
|
+
return __awaiter(this, arguments, void 0, function* ({ endpointMetadata } = {}) {
|
|
114
|
+
if (this.accessToken && this.expiresAt > new Date()) {
|
|
115
|
+
return this.accessToken;
|
|
77
116
|
}
|
|
78
117
|
// If a refresh is already in progress, return the existing promise
|
|
79
|
-
if (this.
|
|
80
|
-
return this.
|
|
118
|
+
if (this.refreshPromise != null) {
|
|
119
|
+
return this.refreshPromise;
|
|
81
120
|
}
|
|
82
|
-
return this.refresh(
|
|
121
|
+
return this.refresh({ endpointMetadata });
|
|
83
122
|
});
|
|
84
123
|
}
|
|
85
|
-
refresh(
|
|
86
|
-
return __awaiter(this,
|
|
87
|
-
this.
|
|
88
|
-
var _a, _b, _c, _d;
|
|
124
|
+
refresh() {
|
|
125
|
+
return __awaiter(this, arguments, void 0, function* ({ endpointMetadata } = {}) {
|
|
126
|
+
this.refreshPromise = (() => __awaiter(this, void 0, void 0, function* () {
|
|
89
127
|
try {
|
|
90
|
-
const clientId =
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
message: "clientId is required; either pass it as an argument or set the KARD_CLIENT_ID environment variable",
|
|
94
|
-
});
|
|
95
|
-
}
|
|
96
|
-
const clientSecret = (_c = (yield core.Supplier.get(this._clientSecret))) !== null && _c !== void 0 ? _c : (_d = process.env) === null || _d === void 0 ? void 0 : _d.KARD_CLIENT_SECRET;
|
|
97
|
-
if (clientSecret == null) {
|
|
98
|
-
throw new errors.KardApiError({
|
|
99
|
-
message: "clientSecret is required; either pass it as an argument or set the KARD_CLIENT_SECRET environment variable",
|
|
100
|
-
});
|
|
101
|
-
}
|
|
102
|
-
const tokenResponse = yield this._authClient.getToken({
|
|
128
|
+
const clientId = yield this.clientIdSupplier({ endpointMetadata });
|
|
129
|
+
const clientSecret = yield this.clientSecretSupplier({ endpointMetadata });
|
|
130
|
+
const tokenResponse = yield this.authClient.getToken({
|
|
103
131
|
client_id: clientId,
|
|
104
132
|
client_secret: clientSecret,
|
|
105
133
|
});
|
|
106
|
-
this.
|
|
107
|
-
this.
|
|
108
|
-
return this.
|
|
134
|
+
this.accessToken = tokenResponse.access_token;
|
|
135
|
+
this.expiresAt = this.getExpiresAt(tokenResponse.expires_in, BUFFER_IN_MINUTES);
|
|
136
|
+
return this.accessToken;
|
|
109
137
|
}
|
|
110
138
|
finally {
|
|
111
|
-
this.
|
|
139
|
+
this.refreshPromise = undefined;
|
|
112
140
|
}
|
|
113
141
|
}))();
|
|
114
|
-
return this.
|
|
142
|
+
return this.refreshPromise;
|
|
115
143
|
});
|
|
116
144
|
}
|
|
117
145
|
getExpiresAt(expiresInSeconds, bufferInMinutes) {
|
|
@@ -120,3 +148,43 @@ class OAuthAuthProvider {
|
|
|
120
148
|
}
|
|
121
149
|
}
|
|
122
150
|
exports.OAuthAuthProvider = OAuthAuthProvider;
|
|
151
|
+
class OAuthTokenOverrideAuthProvider {
|
|
152
|
+
constructor(options) {
|
|
153
|
+
this.options = options;
|
|
154
|
+
}
|
|
155
|
+
static canCreate(options) {
|
|
156
|
+
return (options === null || options === void 0 ? void 0 : options[TOKEN_PARAM]) != null;
|
|
157
|
+
}
|
|
158
|
+
getAuthRequest() {
|
|
159
|
+
return __awaiter(this, arguments, void 0, function* ({ endpointMetadata, } = {}) {
|
|
160
|
+
const token = this.options[TOKEN_PARAM];
|
|
161
|
+
if (token == null) {
|
|
162
|
+
throw new errors.KardApiError({
|
|
163
|
+
message: TOKEN_PARAM_REQUIRED_ERROR_MESSAGE,
|
|
164
|
+
});
|
|
165
|
+
}
|
|
166
|
+
return {
|
|
167
|
+
headers: {
|
|
168
|
+
Authorization: `Bearer ${yield core.EndpointSupplier.get(token, { endpointMetadata })}`,
|
|
169
|
+
},
|
|
170
|
+
};
|
|
171
|
+
});
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
exports.OAuthTokenOverrideAuthProvider = OAuthTokenOverrideAuthProvider;
|
|
175
|
+
(function (OAuthAuthProvider) {
|
|
176
|
+
OAuthAuthProvider.AUTH_SCHEME = "OAuthScheme";
|
|
177
|
+
OAuthAuthProvider.AUTH_CONFIG_ERROR_MESSAGE = `Insufficient options to create OAuthAuthProvider. Please provide either '${CLIENT_ID_PARAM}' or '${ENV_CLIENT_ID}' env var and '${CLIENT_SECRET_PARAM}' or '${ENV_CLIENT_SECRET}' env var, or ${TOKEN_PARAM}.`;
|
|
178
|
+
function createInstance(options) {
|
|
179
|
+
if (OAuthTokenOverrideAuthProvider.canCreate(options)) {
|
|
180
|
+
return new OAuthTokenOverrideAuthProvider(options);
|
|
181
|
+
}
|
|
182
|
+
else if (OAuthAuthProvider.canCreate(options)) {
|
|
183
|
+
return new OAuthAuthProvider(options);
|
|
184
|
+
}
|
|
185
|
+
throw new errors.KardApiError({
|
|
186
|
+
message: OAuthAuthProvider.AUTH_CONFIG_ERROR_MESSAGE,
|
|
187
|
+
});
|
|
188
|
+
}
|
|
189
|
+
OAuthAuthProvider.createInstance = createInstance;
|
|
190
|
+
})(OAuthAuthProvider || (exports.OAuthAuthProvider = OAuthAuthProvider = {}));
|
|
@@ -5,10 +5,16 @@ const base64_js_1 = require("../base64.js");
|
|
|
5
5
|
const BASIC_AUTH_HEADER_PREFIX = /^Basic /i;
|
|
6
6
|
exports.BasicAuth = {
|
|
7
7
|
toAuthorizationHeader: (basicAuth) => {
|
|
8
|
+
var _a, _b;
|
|
8
9
|
if (basicAuth == null) {
|
|
9
10
|
return undefined;
|
|
10
11
|
}
|
|
11
|
-
const
|
|
12
|
+
const username = (_a = basicAuth.username) !== null && _a !== void 0 ? _a : "";
|
|
13
|
+
const password = (_b = basicAuth.password) !== null && _b !== void 0 ? _b : "";
|
|
14
|
+
if (username === "" && password === "") {
|
|
15
|
+
return undefined;
|
|
16
|
+
}
|
|
17
|
+
const token = (0, base64_js_1.base64Encode)(`${username}:${password}`);
|
|
12
18
|
return `Basic ${token}`;
|
|
13
19
|
},
|
|
14
20
|
fromAuthorizationHeader: (header) => {
|
|
@@ -14,6 +14,6 @@ export type BinaryResponse = {
|
|
|
14
14
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
|
|
15
15
|
* Some versions of the Fetch API may not support this method.
|
|
16
16
|
*/
|
|
17
|
-
bytes?():
|
|
17
|
+
bytes?(): Promise<Uint8Array>;
|
|
18
18
|
};
|
|
19
19
|
export declare function getBinaryResponse(response: Response): BinaryResponse;
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { EndpointMetadata } from "./EndpointMetadata.js";
|
|
2
2
|
import type { Supplier } from "./Supplier.js";
|
|
3
3
|
type EndpointSupplierFn<T> = (arg: {
|
|
4
|
-
endpointMetadata
|
|
4
|
+
endpointMetadata?: EndpointMetadata;
|
|
5
5
|
}) => T | Promise<T>;
|
|
6
6
|
export type EndpointSupplier<T> = Supplier<T> | EndpointSupplierFn<T>;
|
|
7
7
|
export declare const EndpointSupplier: {
|
|
8
8
|
get: <T>(supplier: EndpointSupplier<T>, arg: {
|
|
9
|
-
endpointMetadata
|
|
9
|
+
endpointMetadata?: EndpointMetadata;
|
|
10
10
|
}) => Promise<T>;
|
|
11
11
|
};
|
|
12
12
|
export {};
|
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
import { type LogConfig, type Logger } from "../logging/logger.js";
|
|
2
2
|
import type { APIResponse } from "./APIResponse.js";
|
|
3
3
|
import type { EndpointMetadata } from "./EndpointMetadata.js";
|
|
4
|
-
import { EndpointSupplier } from "./EndpointSupplier.js";
|
|
5
4
|
export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
|
|
6
5
|
export declare namespace Fetcher {
|
|
7
6
|
interface Args {
|
|
8
7
|
url: string;
|
|
9
8
|
method: string;
|
|
10
9
|
contentType?: string;
|
|
11
|
-
headers?: Record<string,
|
|
10
|
+
headers?: Record<string, unknown>;
|
|
12
11
|
queryParameters?: Record<string, unknown>;
|
|
13
12
|
body?: unknown;
|
|
14
13
|
timeoutMs?: number;
|
|
@@ -39,10 +38,12 @@ export declare namespace Fetcher {
|
|
|
39
38
|
}
|
|
40
39
|
interface TimeoutError {
|
|
41
40
|
reason: "timeout";
|
|
41
|
+
cause?: unknown;
|
|
42
42
|
}
|
|
43
43
|
interface UnknownError {
|
|
44
44
|
reason: "unknown";
|
|
45
45
|
errorMessage: string;
|
|
46
|
+
cause?: unknown;
|
|
46
47
|
}
|
|
47
48
|
}
|
|
48
49
|
export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;
|
|
@@ -156,7 +156,13 @@ function getHeaders(args) {
|
|
|
156
156
|
return __awaiter(this, void 0, void 0, function* () {
|
|
157
157
|
var _a;
|
|
158
158
|
const newHeaders = new Headers_js_1.Headers();
|
|
159
|
-
newHeaders.set("Accept", args.responseType === "json"
|
|
159
|
+
newHeaders.set("Accept", args.responseType === "json"
|
|
160
|
+
? "application/json"
|
|
161
|
+
: args.responseType === "text"
|
|
162
|
+
? "text/plain"
|
|
163
|
+
: args.responseType === "sse"
|
|
164
|
+
? "text/event-stream"
|
|
165
|
+
: "*/*");
|
|
160
166
|
if (args.body !== undefined && args.contentType != null) {
|
|
161
167
|
newHeaders.set("Content-Type", args.contentType);
|
|
162
168
|
}
|
|
@@ -200,7 +206,7 @@ function fetcherImpl(args) {
|
|
|
200
206
|
}
|
|
201
207
|
try {
|
|
202
208
|
const response = yield (0, requestWithRetries_js_1.requestWithRetries)(() => __awaiter(this, void 0, void 0, function* () {
|
|
203
|
-
return (0, makeRequest_js_1.makeRequest)(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex);
|
|
209
|
+
return (0, makeRequest_js_1.makeRequest)(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex, args.responseType === "streaming" || args.responseType === "sse");
|
|
204
210
|
}), args.maxRetries);
|
|
205
211
|
if (response.status >= 200 && response.status < 400) {
|
|
206
212
|
if (logger.isDebug()) {
|
|
@@ -255,6 +261,7 @@ function fetcherImpl(args) {
|
|
|
255
261
|
error: {
|
|
256
262
|
reason: "unknown",
|
|
257
263
|
errorMessage: "The user aborted a request",
|
|
264
|
+
cause: error,
|
|
258
265
|
},
|
|
259
266
|
rawResponse: RawResponse_js_1.abortRawResponse,
|
|
260
267
|
};
|
|
@@ -272,6 +279,7 @@ function fetcherImpl(args) {
|
|
|
272
279
|
ok: false,
|
|
273
280
|
error: {
|
|
274
281
|
reason: "timeout",
|
|
282
|
+
cause: error,
|
|
275
283
|
},
|
|
276
284
|
rawResponse: RawResponse_js_1.abortRawResponse,
|
|
277
285
|
};
|
|
@@ -290,6 +298,7 @@ function fetcherImpl(args) {
|
|
|
290
298
|
error: {
|
|
291
299
|
reason: "unknown",
|
|
292
300
|
errorMessage: error.message,
|
|
301
|
+
cause: error,
|
|
293
302
|
},
|
|
294
303
|
rawResponse: RawResponse_js_1.unknownRawResponse,
|
|
295
304
|
};
|
|
@@ -307,6 +316,7 @@ function fetcherImpl(args) {
|
|
|
307
316
|
error: {
|
|
308
317
|
reason: "unknown",
|
|
309
318
|
errorMessage: (0, json_js_1.toJson)(error),
|
|
319
|
+
cause: error,
|
|
310
320
|
},
|
|
311
321
|
rawResponse: RawResponse_js_1.unknownRawResponse,
|
|
312
322
|
};
|
|
@@ -6,6 +6,8 @@ export type { Fetcher, FetchFunction } from "./Fetcher.js";
|
|
|
6
6
|
export { fetcher } from "./Fetcher.js";
|
|
7
7
|
export { getHeader } from "./getHeader.js";
|
|
8
8
|
export { HttpResponsePromise } from "./HttpResponsePromise.js";
|
|
9
|
+
export type { PassthroughRequest } from "./makePassthroughRequest.js";
|
|
10
|
+
export { makePassthroughRequest } from "./makePassthroughRequest.js";
|
|
9
11
|
export type { RawResponse, WithRawResponse } from "./RawResponse.js";
|
|
10
12
|
export { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.js";
|
|
11
13
|
export { Supplier } from "./Supplier.js";
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.Supplier = exports.unknownRawResponse = exports.toRawResponse = exports.abortRawResponse = exports.HttpResponsePromise = exports.getHeader = exports.fetcher = exports.EndpointSupplier = void 0;
|
|
3
|
+
exports.Supplier = exports.unknownRawResponse = exports.toRawResponse = exports.abortRawResponse = exports.makePassthroughRequest = exports.HttpResponsePromise = exports.getHeader = exports.fetcher = exports.EndpointSupplier = void 0;
|
|
4
4
|
var EndpointSupplier_js_1 = require("./EndpointSupplier.js");
|
|
5
5
|
Object.defineProperty(exports, "EndpointSupplier", { enumerable: true, get: function () { return EndpointSupplier_js_1.EndpointSupplier; } });
|
|
6
6
|
var Fetcher_js_1 = require("./Fetcher.js");
|
|
@@ -9,6 +9,8 @@ var getHeader_js_1 = require("./getHeader.js");
|
|
|
9
9
|
Object.defineProperty(exports, "getHeader", { enumerable: true, get: function () { return getHeader_js_1.getHeader; } });
|
|
10
10
|
var HttpResponsePromise_js_1 = require("./HttpResponsePromise.js");
|
|
11
11
|
Object.defineProperty(exports, "HttpResponsePromise", { enumerable: true, get: function () { return HttpResponsePromise_js_1.HttpResponsePromise; } });
|
|
12
|
+
var makePassthroughRequest_js_1 = require("./makePassthroughRequest.js");
|
|
13
|
+
Object.defineProperty(exports, "makePassthroughRequest", { enumerable: true, get: function () { return makePassthroughRequest_js_1.makePassthroughRequest; } });
|
|
12
14
|
var RawResponse_js_1 = require("./RawResponse.js");
|
|
13
15
|
Object.defineProperty(exports, "abortRawResponse", { enumerable: true, get: function () { return RawResponse_js_1.abortRawResponse; } });
|
|
14
16
|
Object.defineProperty(exports, "toRawResponse", { enumerable: true, get: function () { return RawResponse_js_1.toRawResponse; } });
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { type LogConfig, type Logger } from "../logging/logger.js";
|
|
2
|
+
import { Supplier } from "./Supplier.js";
|
|
3
|
+
export declare namespace PassthroughRequest {
|
|
4
|
+
/**
|
|
5
|
+
* Per-request options that can override the SDK client defaults.
|
|
6
|
+
*/
|
|
7
|
+
interface RequestOptions {
|
|
8
|
+
/** Override the default timeout for this request (in seconds). */
|
|
9
|
+
timeoutInSeconds?: number;
|
|
10
|
+
/** Override the default number of retries for this request. */
|
|
11
|
+
maxRetries?: number;
|
|
12
|
+
/** Additional headers to include in this request. */
|
|
13
|
+
headers?: Record<string, string>;
|
|
14
|
+
/** Abort signal for this request. */
|
|
15
|
+
abortSignal?: AbortSignal;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* SDK client configuration used by the passthrough fetch method.
|
|
19
|
+
*/
|
|
20
|
+
interface ClientOptions {
|
|
21
|
+
/** The base URL or environment for the client. */
|
|
22
|
+
environment?: Supplier<string>;
|
|
23
|
+
/** Override the base URL. */
|
|
24
|
+
baseUrl?: Supplier<string>;
|
|
25
|
+
/** Default headers to include in requests. */
|
|
26
|
+
headers?: Record<string, unknown>;
|
|
27
|
+
/** Default maximum time to wait for a response in seconds. */
|
|
28
|
+
timeoutInSeconds?: number;
|
|
29
|
+
/** Default number of times to retry the request. Defaults to 2. */
|
|
30
|
+
maxRetries?: number;
|
|
31
|
+
/** A custom fetch function. */
|
|
32
|
+
fetch?: typeof fetch;
|
|
33
|
+
/** Logging configuration. */
|
|
34
|
+
logging?: LogConfig | Logger;
|
|
35
|
+
/** A function that returns auth headers. */
|
|
36
|
+
getAuthHeaders?: () => Promise<Record<string, string>>;
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Makes a passthrough HTTP request using the SDK's configuration (auth, retry, logging, etc.)
|
|
41
|
+
* while mimicking the standard `fetch` API.
|
|
42
|
+
*
|
|
43
|
+
* @param input - The URL, path, or Request object. If a relative path, it will be resolved against the configured base URL.
|
|
44
|
+
* @param init - Standard RequestInit options (method, headers, body, signal, etc.)
|
|
45
|
+
* @param clientOptions - SDK client options (auth, default headers, logging, etc.)
|
|
46
|
+
* @param requestOptions - Per-request overrides (timeout, retries, extra headers, abort signal).
|
|
47
|
+
* @returns A standard Response object.
|
|
48
|
+
*/
|
|
49
|
+
export declare function makePassthroughRequest(input: Request | string | URL, init: RequestInit | undefined, clientOptions: PassthroughRequest.ClientOptions, requestOptions?: PassthroughRequest.RequestOptions): Promise<Response>;
|