@kard-financial/sdk 12.4.0 → 14.0.0

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@kard-financial/sdk",
-        "X-Fern-SDK-Version": "12.4.0",
-        "User-Agent": "@kard-financial/sdk/12.4.0",
+        "X-Fern-SDK-Version": "14.0.0",
+        "User-Agent": "@kard-financial/sdk/14.0.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/api/resources/transactions/client/Client.d.ts

@@ -268,7 +268,7 @@ export declare class TransactionsClient {
     createBulkTransactionsUploadUrl(organizationId: KardApi.OrganizationId, request: KardApi.CreateFileUploadRequestBody, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<KardApi.CreateFileUploadUrlResponse>;
     private __createBulkTransactionsUploadUrl;
     /**
-     * Retrieve rewarded transaction history for a specific user. Returns only SETTLED transactions within the last 12 months.
+     * Retrieve rewarded transaction history for a specific user. By default this returns only SETTLED transactions within the last 12 months.
      * <br/>
      * <b>Required scopes:</b> `transaction:read`
      * <br/>
@@ -287,6 +287,7 @@ export declare class TransactionsClient {
      * @example
      *     await client.transactions.getEarnedRewards("org-123", "user-456", {
      *         "page[size]": 10,
+     *         "filter[status]": "APPROVED",
      *         include: "merchant,offer"
      *     })
      */

package/dist/cjs/api/resources/transactions/client/Client.js

@@ -495,7 +495,7 @@ class TransactionsClient {
         });
     }
     /**
-     * Retrieve rewarded transaction history for a specific user. Returns only SETTLED transactions within the last 12 months.
+     * Retrieve rewarded transaction history for a specific user. By default this returns only SETTLED transactions within the last 12 months.
      * <br/>
      * <b>Required scopes:</b> `transaction:read`
      * <br/>
@@ -514,6 +514,7 @@ class TransactionsClient {
      * @example
      *     await client.transactions.getEarnedRewards("org-123", "user-456", {
      *         "page[size]": 10,
+     *         "filter[status]": "APPROVED",
      *         include: "merchant,offer"
      *     })
      */
@@ -523,11 +524,12 @@ class TransactionsClient {
     __getEarnedRewards(organizationId_1, userId_1) {
         return __awaiter(this, arguments, void 0, function* (organizationId, userId, request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { "page[after]": pageAfter, "page[before]": pageBefore, "page[size]": pageSize, include } = request;
+            const { "page[after]": pageAfter, "page[before]": pageBefore, "page[size]": pageSize, "filter[status]": filterStatus, include, } = request;
             const _queryParams = {
                 "page[after]": pageAfter,
                 "page[before]": pageBefore,
                 "page[size]": pageSize,
+                "filter[status]": filterStatus != null ? filterStatus : undefined,
                 include,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();

package/dist/cjs/api/resources/transactions/client/requests/GetEarnedRewardsRequest.d.ts

@@ -1,7 +1,9 @@
+import type * as KardApi from "../../../../index.js";
 /**
  * @example
  *     {
  *         "page[size]": 10,
+ *         "filter[status]": "APPROVED",
  *         include: "merchant,offer"
  *     }
  */
@@ -12,6 +14,8 @@ export interface GetEarnedRewardsRequest {
     "page[before]"?: string;
     /** Number of results per page */
     "page[size]"?: number;
+    /** Filter by transaction status. Supported values are `APPROVED` and `SETTLED`. Defaults to `SETTLED` when omitted. When `APPROVED` is specified, only approved transactions that do not yet have a corresponding settled transaction are returned. */
+    "filter[status]"?: KardApi.RewardedTransactionStatus;
     /** Comma-separated list of related resources to include in the response. Supported values are `merchant` and `offer`. */
     include?: string;
 }

package/dist/cjs/api/resources/transactions/types/GetEarnedRewardsMeta.d.ts

@@ -0,0 +1,4 @@
+export interface GetEarnedRewardsMeta {
+    /** Lifetime rewards earned by the user across all matched transactions in cents. */
+    lifetimeRewardsInCents: number;
+}

package/dist/cjs/api/resources/transactions/types/GetEarnedRewardsMeta.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/transactions/types/GetEarnedRewardsResponse.d.ts

@@ -6,7 +6,7 @@ import type * as KardApi from "../../../index.js";
  *                 type: "rewardedTransaction",
  *                 id: "fcabf024-3870-41f3-9fbd-b43ea85a3d19",
  *                 attributes: {
- *                     status: KardApi.RewardedTransactionStatus.Settled,
+ *                     status: KardApi.RewardedTransactionStatus.Approved,
  *                     transactionId: "TXN-20241001-F21-127964",
  *                     transactionAmountInCents: 12796,
  *                     transactionTimestamp: "2024-10-01T01:36:57Z",
@@ -45,11 +45,57 @@ import type * as KardApi from "../../../index.js";
  *                         }
  *                     }
  *                 }
+ *             }, {
+ *                 type: "rewardedTransaction",
+ *                 id: "7bcbdb95-f3a5-4f56-a9be-4c25f313eb0a",
+ *                 attributes: {
+ *                     status: KardApi.RewardedTransactionStatus.Settled,
+ *                     transactionId: "TXN-20240928-TGT-778813",
+ *                     transactionAmountInCents: 8800,
+ *                     transactionTimestamp: "2024-09-28T14:11:22Z",
+ *                     paidToIssuer: KardApi.PaymentStatus.PaidInFull,
+ *                     payoutTimestamp: "2024-09-29T10:15:00Z",
+ *                     cardBIN: "123456",
+ *                     cardLastFour: "4321",
+ *                     commissionEarned: {
+ *                         issuer: {
+ *                             type: KardApi.CommissionValueType.Cents,
+ *                             value: 70
+ *                         },
+ *                         user: {
+ *                             type: KardApi.CommissionValueType.Cents,
+ *                             value: 220
+ *                         }
+ *                     }
+ *                 },
+ *                 relationships: {
+ *                     user: {
+ *                         data: {
+ *                             type: "user",
+ *                             id: "8c52423a-c319-44ee-8fc7-508e97b43892"
+ *                         }
+ *                     },
+ *                     merchant: {
+ *                         data: {
+ *                             type: "merchant",
+ *                             id: "5f3e2d1c40abc50008cc4821"
+ *                         }
+ *                     },
+ *                     offer: {
+ *                         data: {
+ *                             type: "offer",
+ *                             id: "OFF-TGT-ONLINE-2024Q4-002"
+ *                         }
+ *                     }
+ *                 }
  *             }],
  *         links: {
  *             self: "/v2/issuers/org-123/users/user-456/earned-rewards?page[size]=10",
  *             next: "/v2/issuers/org-123/users/user-456/earned-rewards?page[size]=10&page[after]=eyJpZCI6ImZjYWJmMDI0LTM4NzAtNDFmMy05ZmJkLWI0M2VhODVhM2QxOSIsInRzIjoiMjAyNC0xMC0wMVQwMTozNjo1N1oifQ=="
  *         },
+ *         meta: {
+ *             lifetimeRewardsInCents: 540
+ *         },
  *         included: [{
  *                 type: "merchant",
  *                 id: "633ed2ab30dcb60009dd5699",
@@ -80,6 +126,8 @@ import type * as KardApi from "../../../index.js";
 export interface GetEarnedRewardsResponse {
     data: KardApi.RewardedTransactionUnion[];
     links: KardApi.Links;
+    /** Additional metadata for the earned rewards response. */
+    meta: KardApi.GetEarnedRewardsMeta;
     /** Additional resources referenced in the response */
     included?: KardApi.TransactionIncludedResource[] | undefined;
 }

package/dist/cjs/api/resources/transactions/types/RewardedTransactionStatus.d.ts

@@ -1,4 +1,5 @@
 export declare const RewardedTransactionStatus: {
+    readonly Approved: "APPROVED";
     readonly Settled: "SETTLED";
 };
 export type RewardedTransactionStatus = (typeof RewardedTransactionStatus)[keyof typeof RewardedTransactionStatus];

package/dist/cjs/api/resources/transactions/types/RewardedTransactionStatus.js

@@ -3,5 +3,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RewardedTransactionStatus = void 0;
 exports.RewardedTransactionStatus = {
+    Approved: "APPROVED",
     Settled: "SETTLED",
 };

package/dist/cjs/api/resources/transactions/types/index.d.ts

@@ -24,6 +24,7 @@ export * from "./FraudulentTransactionData.js";
 export * from "./FraudulentTransactionObject.js";
 export * from "./FraudulentTransactionRequestBody.js";
 export * from "./FraudulentTransactionResponse.js";
+export * from "./GetEarnedRewardsMeta.js";
 export * from "./GetEarnedRewardsResponse.js";
 export * from "./MatchedTransactionsAttributes.js";
 export * from "./MatchedTransactionsRequest.js";

package/dist/cjs/api/resources/transactions/types/index.js

@@ -40,6 +40,7 @@ __exportStar(require("./FraudulentTransactionData.js"), exports);
 __exportStar(require("./FraudulentTransactionObject.js"), exports);
 __exportStar(require("./FraudulentTransactionRequestBody.js"), exports);
 __exportStar(require("./FraudulentTransactionResponse.js"), exports);
+__exportStar(require("./GetEarnedRewardsMeta.js"), exports);
 __exportStar(require("./GetEarnedRewardsResponse.js"), exports);
 __exportStar(require("./MatchedTransactionsAttributes.js"), exports);
 __exportStar(require("./MatchedTransactionsRequest.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "12.4.0";
+export declare const SDK_VERSION = "14.0.0";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "12.4.0";
+exports.SDK_VERSION = "14.0.0";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@kard-financial/sdk",
-        "X-Fern-SDK-Version": "12.4.0",
-        "User-Agent": "@kard-financial/sdk/12.4.0",
+        "X-Fern-SDK-Version": "14.0.0",
+        "User-Agent": "@kard-financial/sdk/14.0.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/esm/api/resources/transactions/client/Client.d.mts

@@ -268,7 +268,7 @@ export declare class TransactionsClient {
     createBulkTransactionsUploadUrl(organizationId: KardApi.OrganizationId, request: KardApi.CreateFileUploadRequestBody, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<KardApi.CreateFileUploadUrlResponse>;
     private __createBulkTransactionsUploadUrl;
     /**
-     * Retrieve rewarded transaction history for a specific user. Returns only SETTLED transactions within the last 12 months.
+     * Retrieve rewarded transaction history for a specific user. By default this returns only SETTLED transactions within the last 12 months.
      * <br/>
      * <b>Required scopes:</b> `transaction:read`
      * <br/>
@@ -287,6 +287,7 @@ export declare class TransactionsClient {
      * @example
      *     await client.transactions.getEarnedRewards("org-123", "user-456", {
      *         "page[size]": 10,
+     *         "filter[status]": "APPROVED",
      *         include: "merchant,offer"
      *     })
      */

package/dist/esm/api/resources/transactions/client/Client.mjs

@@ -459,7 +459,7 @@ export class TransactionsClient {
         });
     }
     /**
-     * Retrieve rewarded transaction history for a specific user. Returns only SETTLED transactions within the last 12 months.
+     * Retrieve rewarded transaction history for a specific user. By default this returns only SETTLED transactions within the last 12 months.
      * <br/>
      * <b>Required scopes:</b> `transaction:read`
      * <br/>
@@ -478,6 +478,7 @@ export class TransactionsClient {
      * @example
      *     await client.transactions.getEarnedRewards("org-123", "user-456", {
      *         "page[size]": 10,
+     *         "filter[status]": "APPROVED",
      *         include: "merchant,offer"
      *     })
      */
@@ -487,11 +488,12 @@ export class TransactionsClient {
     __getEarnedRewards(organizationId_1, userId_1) {
         return __awaiter(this, arguments, void 0, function* (organizationId, userId, request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { "page[after]": pageAfter, "page[before]": pageBefore, "page[size]": pageSize, include } = request;
+            const { "page[after]": pageAfter, "page[before]": pageBefore, "page[size]": pageSize, "filter[status]": filterStatus, include, } = request;
             const _queryParams = {
                 "page[after]": pageAfter,
                 "page[before]": pageBefore,
                 "page[size]": pageSize,
+                "filter[status]": filterStatus != null ? filterStatus : undefined,
                 include,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();

package/dist/esm/api/resources/transactions/client/requests/GetEarnedRewardsRequest.d.mts

@@ -1,7 +1,9 @@
+import type * as KardApi from "../../../../index.mjs";
 /**
  * @example
  *     {
  *         "page[size]": 10,
+ *         "filter[status]": "APPROVED",
  *         include: "merchant,offer"
  *     }
  */
@@ -12,6 +14,8 @@ export interface GetEarnedRewardsRequest {
     "page[before]"?: string;
     /** Number of results per page */
     "page[size]"?: number;
+    /** Filter by transaction status. Supported values are `APPROVED` and `SETTLED`. Defaults to `SETTLED` when omitted. When `APPROVED` is specified, only approved transactions that do not yet have a corresponding settled transaction are returned. */
+    "filter[status]"?: KardApi.RewardedTransactionStatus;
     /** Comma-separated list of related resources to include in the response. Supported values are `merchant` and `offer`. */
     include?: string;
 }

package/dist/esm/api/resources/transactions/types/GetEarnedRewardsMeta.d.mts

@@ -0,0 +1,4 @@
+export interface GetEarnedRewardsMeta {
+    /** Lifetime rewards earned by the user across all matched transactions in cents. */
+    lifetimeRewardsInCents: number;
+}

package/dist/esm/api/resources/transactions/types/GetEarnedRewardsMeta.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/transactions/types/GetEarnedRewardsResponse.d.mts

@@ -6,7 +6,7 @@ import type * as KardApi from "../../../index.mjs";
  *                 type: "rewardedTransaction",
  *                 id: "fcabf024-3870-41f3-9fbd-b43ea85a3d19",
  *                 attributes: {
- *                     status: KardApi.RewardedTransactionStatus.Settled,
+ *                     status: KardApi.RewardedTransactionStatus.Approved,
  *                     transactionId: "TXN-20241001-F21-127964",
  *                     transactionAmountInCents: 12796,
  *                     transactionTimestamp: "2024-10-01T01:36:57Z",
@@ -45,11 +45,57 @@ import type * as KardApi from "../../../index.mjs";
  *                         }
  *                     }
  *                 }
+ *             }, {
+ *                 type: "rewardedTransaction",
+ *                 id: "7bcbdb95-f3a5-4f56-a9be-4c25f313eb0a",
+ *                 attributes: {
+ *                     status: KardApi.RewardedTransactionStatus.Settled,
+ *                     transactionId: "TXN-20240928-TGT-778813",
+ *                     transactionAmountInCents: 8800,
+ *                     transactionTimestamp: "2024-09-28T14:11:22Z",
+ *                     paidToIssuer: KardApi.PaymentStatus.PaidInFull,
+ *                     payoutTimestamp: "2024-09-29T10:15:00Z",
+ *                     cardBIN: "123456",
+ *                     cardLastFour: "4321",
+ *                     commissionEarned: {
+ *                         issuer: {
+ *                             type: KardApi.CommissionValueType.Cents,
+ *                             value: 70
+ *                         },
+ *                         user: {
+ *                             type: KardApi.CommissionValueType.Cents,
+ *                             value: 220
+ *                         }
+ *                     }
+ *                 },
+ *                 relationships: {
+ *                     user: {
+ *                         data: {
+ *                             type: "user",
+ *                             id: "8c52423a-c319-44ee-8fc7-508e97b43892"
+ *                         }
+ *                     },
+ *                     merchant: {
+ *                         data: {
+ *                             type: "merchant",
+ *                             id: "5f3e2d1c40abc50008cc4821"
+ *                         }
+ *                     },
+ *                     offer: {
+ *                         data: {
+ *                             type: "offer",
+ *                             id: "OFF-TGT-ONLINE-2024Q4-002"
+ *                         }
+ *                     }
+ *                 }
  *             }],
  *         links: {
  *             self: "/v2/issuers/org-123/users/user-456/earned-rewards?page[size]=10",
  *             next: "/v2/issuers/org-123/users/user-456/earned-rewards?page[size]=10&page[after]=eyJpZCI6ImZjYWJmMDI0LTM4NzAtNDFmMy05ZmJkLWI0M2VhODVhM2QxOSIsInRzIjoiMjAyNC0xMC0wMVQwMTozNjo1N1oifQ=="
  *         },
+ *         meta: {
+ *             lifetimeRewardsInCents: 540
+ *         },
  *         included: [{
  *                 type: "merchant",
  *                 id: "633ed2ab30dcb60009dd5699",
@@ -80,6 +126,8 @@ import type * as KardApi from "../../../index.mjs";
 export interface GetEarnedRewardsResponse {
     data: KardApi.RewardedTransactionUnion[];
     links: KardApi.Links;
+    /** Additional metadata for the earned rewards response. */
+    meta: KardApi.GetEarnedRewardsMeta;
     /** Additional resources referenced in the response */
     included?: KardApi.TransactionIncludedResource[] | undefined;
 }

package/dist/esm/api/resources/transactions/types/RewardedTransactionStatus.d.mts

@@ -1,4 +1,5 @@
 export declare const RewardedTransactionStatus: {
+    readonly Approved: "APPROVED";
     readonly Settled: "SETTLED";
 };
 export type RewardedTransactionStatus = (typeof RewardedTransactionStatus)[keyof typeof RewardedTransactionStatus];

package/dist/esm/api/resources/transactions/types/RewardedTransactionStatus.mjs

@@ -1,4 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
 export const RewardedTransactionStatus = {
+    Approved: "APPROVED",
     Settled: "SETTLED",
 };

package/dist/esm/api/resources/transactions/types/index.d.mts

@@ -24,6 +24,7 @@ export * from "./FraudulentTransactionData.mjs";
 export * from "./FraudulentTransactionObject.mjs";
 export * from "./FraudulentTransactionRequestBody.mjs";
 export * from "./FraudulentTransactionResponse.mjs";
+export * from "./GetEarnedRewardsMeta.mjs";
 export * from "./GetEarnedRewardsResponse.mjs";
 export * from "./MatchedTransactionsAttributes.mjs";
 export * from "./MatchedTransactionsRequest.mjs";

package/dist/esm/api/resources/transactions/types/index.mjs

@@ -24,6 +24,7 @@ export * from "./FraudulentTransactionData.mjs";
 export * from "./FraudulentTransactionObject.mjs";
 export * from "./FraudulentTransactionRequestBody.mjs";
 export * from "./FraudulentTransactionResponse.mjs";
+export * from "./GetEarnedRewardsMeta.mjs";
 export * from "./GetEarnedRewardsResponse.mjs";
 export * from "./MatchedTransactionsAttributes.mjs";
 export * from "./MatchedTransactionsRequest.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "12.4.0";
+export declare const SDK_VERSION = "14.0.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "12.4.0";
+export const SDK_VERSION = "14.0.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kard-financial/sdk",
-    "version": "12.4.0",
+    "version": "14.0.0",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -828,7 +828,7 @@ await client.transactions.createBulkTransactionsUploadUrl("organization-123", {
 <dl>
 <dd>
 
-Retrieve rewarded transaction history for a specific user. Returns only SETTLED transactions within the last 12 months.
+Retrieve rewarded transaction history for a specific user. By default this returns only SETTLED transactions within the last 12 months.
 <br/>
 <b>Required scopes:</b> `transaction:read`
 <br/>
@@ -849,6 +849,7 @@ Retrieve rewarded transaction history for a specific user. Returns only SETTLED
 ```typescript
 await client.transactions.getEarnedRewards("org-123", "user-456", {
     "page[size]": 10,
+    "filter[status]": "APPROVED",
     include: "merchant,offer"
 });