@kard-financial/sdk 23.0.0 → 23.1.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": "23.0.0",
-        "User-Agent": "@kard-financial/sdk/23.0.0",
+        "X-Fern-SDK-Version": "23.1.0",
+        "User-Agent": "@kard-financial/sdk/23.1.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/organizations/resources/children/client/Client.d.ts

@@ -28,7 +28,7 @@ export declare class ChildrenClient {
     list(organizationId: string, request?: KardApi.organizations.ListChildrenRequest, requestOptions?: ChildrenClient.RequestOptions): core.HttpResponsePromise<KardApi.organizations.ChildOrganizationListResponse>;
     private __list;
     /**
-     * Create a child organization by cloning the parent and overriding specified fields. An 8-digit numeric ID is generated automatically. The name is required, must be uppercase, and must not contain spaces.
+     * Create a child organization by cloning the parent and overriding specified fields. An 8-digit numeric ID is generated automatically. The name is required, must contain at least one letter, and may contain only letters and spaces.
      *
      * @param {string} organizationId - Unique identifier of the parent organization
      * @param {KardApi.organizations.CreateChildRequestBody} request

package/dist/cjs/api/resources/organizations/resources/children/client/Client.js

@@ -122,7 +122,7 @@ class ChildrenClient {
         });
     }
     /**
-     * Create a child organization by cloning the parent and overriding specified fields. An 8-digit numeric ID is generated automatically. The name is required, must be uppercase, and must not contain spaces.
+     * Create a child organization by cloning the parent and overriding specified fields. An 8-digit numeric ID is generated automatically. The name is required, must contain at least one letter, and may contain only letters and spaces.
      *
      * @param {string} organizationId - Unique identifier of the parent organization
      * @param {KardApi.organizations.CreateChildRequestBody} request

package/dist/cjs/api/resources/organizations/resources/children/types/ChildOrganizationAttributes.d.ts

@@ -2,7 +2,7 @@
  * Limited set of child organization attributes exposed to external consumers
  */
 export interface ChildOrganizationAttributes {
-    /** Name of the child organization (uppercase, no spaces) */
+    /** Name of the child organization (at least one letter; letters and spaces only) */
     name: string;
     /** External identifier for the child organization */
     externalId?: string | undefined;

package/dist/cjs/api/resources/organizations/resources/children/types/CreateChildAttributes.d.ts

@@ -3,13 +3,13 @@
  *
  * @example
  *     {
- *         name: "ACMECHILDBANK",
+ *         name: "Acme Child Bank",
  *         externalId: "ext-123",
  *         bins: ["123456", "789012"]
  *     }
  */
 export interface CreateChildAttributes {
-    /** Name of the child organization (must be uppercase, no spaces) */
+    /** Name of the child organization (at least one letter; letters and spaces only) */
     name: string;
     /** External identifier for the child organization */
     externalId?: string | undefined;

package/dist/cjs/api/resources/organizations/resources/children/types/UpdateChildAttributes.d.ts

@@ -3,7 +3,7 @@
  *
  * @example
  *     {
- *         name: "NEWCHILDNAME"
+ *         name: "New Child Name"
  *     }
  *
  * @example
@@ -12,7 +12,7 @@
  *     }
  */
 export interface UpdateChildAttributes {
-    /** New name for the child organization (must be uppercase, no spaces) */
+    /** New name for the child organization (at least one letter; letters and spaces only) */
     name?: string | undefined;
     /** External identifier for the child organization */
     externalId?: string | undefined;

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

@@ -278,7 +278,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. By default this 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 that have been paid in full to the issuer (`paidToIssuer` is `PAID_IN_FULL`). Pass `filter[includeUnpaid]=true` to also return matched transactions that have not yet been paid in full.
      * <br/>
      * <b>Required scopes:</b> `transaction:read`
      * <br/>

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

@@ -505,7 +505,7 @@ class TransactionsClient {
         });
     }
     /**
-     * Retrieve rewarded transaction history for a specific user. By default this 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 that have been paid in full to the issuer (`paidToIssuer` is `PAID_IN_FULL`). Pass `filter[includeUnpaid]=true` to also return matched transactions that have not yet been paid in full.
      * <br/>
      * <b>Required scopes:</b> `transaction:read`
      * <br/>
@@ -534,12 +534,13 @@ 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, "filter[status]": filterStatus, include, } = request;
+            const { "page[after]": pageAfter, "page[before]": pageBefore, "page[size]": pageSize, "filter[status]": filterStatus, "filter[includeUnpaid]": filterIncludeUnpaid, include, } = request;
             const _queryParams = {
                 "page[after]": pageAfter,
                 "page[before]": pageBefore,
                 "page[size]": pageSize,
                 "filter[status]": filterStatus != null ? filterStatus : undefined,
+                "filter[includeUnpaid]": filterIncludeUnpaid,
                 include,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();

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

@@ -16,6 +16,8 @@ export interface GetEarnedRewardsRequest {
     "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;
+    /** When `true`, return any matched transaction regardless of payment status. By default (`false`), only transactions that have been paid in full to the issuer (`paidToIssuer` is `PAID_IN_FULL`) are returned. This also controls whether unpaid transactions contribute to `lifetimeRewardsInCents`. Has no effect on `APPROVED` transactions, which are always returned when requested. */
+    "filter[includeUnpaid]"?: boolean;
     /** 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

@@ -1,4 +1,4 @@
 export interface GetEarnedRewardsMeta {
-    /** Lifetime rewards earned by the user across all matched transactions in cents. */
+    /** Lifetime rewards earned by the user across matched transactions in cents. By default only transactions paid in full to the issuer (`paidToIssuer` is `PAID_IN_FULL`) are included; pass `filter[includeUnpaid]=true` to include all matched transactions. */
     lifetimeRewardsInCents: number;
 }

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "23.0.0";
+export declare const SDK_VERSION = "23.1.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 = "23.0.0";
+exports.SDK_VERSION = "23.1.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": "23.0.0",
-        "User-Agent": "@kard-financial/sdk/23.0.0",
+        "X-Fern-SDK-Version": "23.1.0",
+        "User-Agent": "@kard-financial/sdk/23.1.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/organizations/resources/children/client/Client.d.mts

@@ -28,7 +28,7 @@ export declare class ChildrenClient {
     list(organizationId: string, request?: KardApi.organizations.ListChildrenRequest, requestOptions?: ChildrenClient.RequestOptions): core.HttpResponsePromise<KardApi.organizations.ChildOrganizationListResponse>;
     private __list;
     /**
-     * Create a child organization by cloning the parent and overriding specified fields. An 8-digit numeric ID is generated automatically. The name is required, must be uppercase, and must not contain spaces.
+     * Create a child organization by cloning the parent and overriding specified fields. An 8-digit numeric ID is generated automatically. The name is required, must contain at least one letter, and may contain only letters and spaces.
      *
      * @param {string} organizationId - Unique identifier of the parent organization
      * @param {KardApi.organizations.CreateChildRequestBody} request

package/dist/esm/api/resources/organizations/resources/children/client/Client.mjs

@@ -86,7 +86,7 @@ export class ChildrenClient {
         });
     }
     /**
-     * Create a child organization by cloning the parent and overriding specified fields. An 8-digit numeric ID is generated automatically. The name is required, must be uppercase, and must not contain spaces.
+     * Create a child organization by cloning the parent and overriding specified fields. An 8-digit numeric ID is generated automatically. The name is required, must contain at least one letter, and may contain only letters and spaces.
      *
      * @param {string} organizationId - Unique identifier of the parent organization
      * @param {KardApi.organizations.CreateChildRequestBody} request

package/dist/esm/api/resources/organizations/resources/children/types/ChildOrganizationAttributes.d.mts

@@ -2,7 +2,7 @@
  * Limited set of child organization attributes exposed to external consumers
  */
 export interface ChildOrganizationAttributes {
-    /** Name of the child organization (uppercase, no spaces) */
+    /** Name of the child organization (at least one letter; letters and spaces only) */
     name: string;
     /** External identifier for the child organization */
     externalId?: string | undefined;

package/dist/esm/api/resources/organizations/resources/children/types/CreateChildAttributes.d.mts

@@ -3,13 +3,13 @@
  *
  * @example
  *     {
- *         name: "ACMECHILDBANK",
+ *         name: "Acme Child Bank",
  *         externalId: "ext-123",
  *         bins: ["123456", "789012"]
  *     }
  */
 export interface CreateChildAttributes {
-    /** Name of the child organization (must be uppercase, no spaces) */
+    /** Name of the child organization (at least one letter; letters and spaces only) */
     name: string;
     /** External identifier for the child organization */
     externalId?: string | undefined;

package/dist/esm/api/resources/organizations/resources/children/types/UpdateChildAttributes.d.mts

@@ -3,7 +3,7 @@
  *
  * @example
  *     {
- *         name: "NEWCHILDNAME"
+ *         name: "New Child Name"
  *     }
  *
  * @example
@@ -12,7 +12,7 @@
  *     }
  */
 export interface UpdateChildAttributes {
-    /** New name for the child organization (must be uppercase, no spaces) */
+    /** New name for the child organization (at least one letter; letters and spaces only) */
     name?: string | undefined;
     /** External identifier for the child organization */
     externalId?: string | undefined;

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

@@ -278,7 +278,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. By default this 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 that have been paid in full to the issuer (`paidToIssuer` is `PAID_IN_FULL`). Pass `filter[includeUnpaid]=true` to also return matched transactions that have not yet been paid in full.
      * <br/>
      * <b>Required scopes:</b> `transaction:read`
      * <br/>

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

@@ -469,7 +469,7 @@ export class TransactionsClient {
         });
     }
     /**
-     * Retrieve rewarded transaction history for a specific user. By default this 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 that have been paid in full to the issuer (`paidToIssuer` is `PAID_IN_FULL`). Pass `filter[includeUnpaid]=true` to also return matched transactions that have not yet been paid in full.
      * <br/>
      * <b>Required scopes:</b> `transaction:read`
      * <br/>
@@ -498,12 +498,13 @@ 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, "filter[status]": filterStatus, include, } = request;
+            const { "page[after]": pageAfter, "page[before]": pageBefore, "page[size]": pageSize, "filter[status]": filterStatus, "filter[includeUnpaid]": filterIncludeUnpaid, include, } = request;
             const _queryParams = {
                 "page[after]": pageAfter,
                 "page[before]": pageBefore,
                 "page[size]": pageSize,
                 "filter[status]": filterStatus != null ? filterStatus : undefined,
+                "filter[includeUnpaid]": filterIncludeUnpaid,
                 include,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();

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

@@ -16,6 +16,8 @@ export interface GetEarnedRewardsRequest {
     "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;
+    /** When `true`, return any matched transaction regardless of payment status. By default (`false`), only transactions that have been paid in full to the issuer (`paidToIssuer` is `PAID_IN_FULL`) are returned. This also controls whether unpaid transactions contribute to `lifetimeRewardsInCents`. Has no effect on `APPROVED` transactions, which are always returned when requested. */
+    "filter[includeUnpaid]"?: boolean;
     /** 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

@@ -1,4 +1,4 @@
 export interface GetEarnedRewardsMeta {
-    /** Lifetime rewards earned by the user across all matched transactions in cents. */
+    /** Lifetime rewards earned by the user across matched transactions in cents. By default only transactions paid in full to the issuer (`paidToIssuer` is `PAID_IN_FULL`) are included; pass `filter[includeUnpaid]=true` to include all matched transactions. */
     lifetimeRewardsInCents: number;
 }

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "23.0.0";
+export declare const SDK_VERSION = "23.1.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "23.0.0";
+export const SDK_VERSION = "23.1.0";

package/package.json

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

package/reference.md

@@ -516,7 +516,7 @@ await client.organizations.children.list("organizationId");
 <dl>
 <dd>
 
-Create a child organization by cloning the parent and overriding specified fields. An 8-digit numeric ID is generated automatically. The name is required, must be uppercase, and must not contain spaces.
+Create a child organization by cloning the parent and overriding specified fields. An 8-digit numeric ID is generated automatically. The name is required, must contain at least one letter, and may contain only letters and spaces.
 </dd>
 </dl>
 </dd>
@@ -2033,7 +2033,7 @@ await client.transactions.createBulkTransactionsUploadUrl("organization-123", {
 <dl>
 <dd>
 
-Retrieve rewarded transaction history for a specific user. By default this 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 that have been paid in full to the issuer (`paidToIssuer` is `PAID_IN_FULL`). Pass `filter[includeUnpaid]=true` to also return matched transactions that have not yet been paid in full.
 <br/>
 <b>Required scopes:</b> `transaction:read`
 <br/>