@kard-financial/sdk 24.1.0 → 26.0.0

package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationSlotInclusion.mjs

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

package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationSlotRelationships.d.mts

@@ -0,0 +1,8 @@
+import type * as KardApi from "../../../../../index.mjs";
+/**
+ * Relationship block for a `batchActivationSlot` resource.
+ */
+export interface BatchActivationSlotRelationships {
+    /** Reference to the placement that fills this slot. The referenced placement provides the slot's content strategy and offer-count cap; request `?include=slots.placement` to embed it in `included`. */
+    placement: KardApi.organizations.ToOneRelationship;
+}

package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationSlotRelationships.mjs

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

package/dist/esm/api/resources/organizations/resources/placements/types/ContentStrategyInclusion.d.mts

@@ -0,0 +1,8 @@
+import type * as KardApi from "../../../../../index.mjs";
+/**
+ * Content strategy as it appears in the `included` array.
+ */
+export interface ContentStrategyInclusion {
+    id: string;
+    attributes: KardApi.organizations.ContentStrategyAttributes;
+}

package/dist/esm/api/resources/organizations/resources/placements/types/ContentStrategyInclusion.mjs

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

package/dist/esm/api/resources/organizations/resources/placements/types/CreateBatchActivationAttributes.d.mts

@@ -7,8 +7,9 @@ import type * as KardApi from "../../../../../index.mjs";
  *         name: "Weekly Cohort",
  *         refreshInterval: "P7D",
  *         slots: [{
- *                 contentStrategyId: "01961e5a-f26f-7e44-ce5f-1ad7c9fb4e67",
- *                 alias: "primary"
+ *                 placementId: "01961e5a-f26f-7e44-ce5f-1ad7c9fb4e67",
+ *                 alias: "primary",
+ *                 shortDescription: "Featured deals refreshed each week"
  *             }]
  *     }
  */

package/dist/esm/api/resources/organizations/resources/placements/types/CreateBatchActivationSlot.d.mts

@@ -2,8 +2,10 @@
  * A slot in a batch-activation placement at creation time
  */
 export interface CreateBatchActivationSlot {
-    /** ID of the content strategy that fills this slot */
-    contentStrategyId: string;
+    /** ID of another placement that fills this slot. The referenced placement provides both the content strategy and the limit on the number of offers available to the slot. */
+    placementId: string;
     /** Customer-defined alias for the slot, unique within the placement */
     alias: string;
+    /** Optional short description of the slot, limited to 50 characters */
+    shortDescription?: string | undefined;
 }

package/dist/esm/api/resources/organizations/resources/placements/types/IncludedResource.d.mts

@@ -0,0 +1,19 @@
+import type * as KardApi from "../../../../../index.mjs";
+/**
+ * Discriminated union of every resource type that can appear in the `included` array. The shape of each branch matches the corresponding primary-data resource (same attributes and relationships), keyed on the JSON:API `type` discriminant.
+ */
+export type IncludedResource = KardApi.organizations.IncludedResource.ContentStrategy | KardApi.organizations.IncludedResource.BatchActivationSlot | KardApi.organizations.IncludedResource.PlacementMainPage | KardApi.organizations.IncludedResource.PlacementPushNotification;
+export declare namespace IncludedResource {
+    interface ContentStrategy extends KardApi.organizations.ContentStrategyInclusion {
+        type: "contentStrategy";
+    }
+    interface BatchActivationSlot extends KardApi.organizations.BatchActivationSlotInclusion {
+        type: "batchActivationSlot";
+    }
+    interface PlacementMainPage extends KardApi.organizations.MainPagePlacementData {
+        type: "placementMainPage";
+    }
+    interface PlacementPushNotification extends KardApi.organizations.PushNotificationPlacementData {
+        type: "placementPushNotification";
+    }
+}

package/dist/esm/api/resources/organizations/resources/placements/types/IncludedResource.mjs

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

package/dist/esm/api/resources/organizations/resources/placements/types/MainPagePlacementAttributes.d.mts

@@ -8,6 +8,6 @@ export interface MainPagePlacementAttributes {
     organizationId: string;
     /** Number of available slots */
     availableSlots: number;
-    /** ID of the content strategy linked to this placement, if any */
+    /** ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility. */
     contentStrategyId?: string | undefined;
 }

package/dist/esm/api/resources/organizations/resources/placements/types/MainPagePlacementData.d.mts

@@ -6,4 +6,6 @@ export interface MainPagePlacementData {
     /** Unique identifier of the placement (UUID v7) */
     id: string;
     attributes: KardApi.organizations.MainPagePlacementAttributes;
+    /** JSON:API relationships for the placement. Omitted entirely when the placement has no linked resources. */
+    relationships?: KardApi.organizations.PlacementRelationships | undefined;
 }

package/dist/esm/api/resources/organizations/resources/placements/types/PlacementFormatUnion.d.mts

@@ -34,12 +34,15 @@ import type * as KardApi from "../../../../../index.mjs";
  *         attributes: {
  *             name: "Weekly Cohort",
  *             organizationId: "org-123",
- *             refreshInterval: "P7D",
- *             slots: [{
- *                     slotId: "01961e5a-e15f-7d33-bd4f-09c6b8fa3d56",
- *                     contentStrategyId: "01961e5a-f26f-7e44-ce5f-1ad7c9fb4e67",
- *                     alias: "primary"
- *                 }]
+ *             refreshInterval: "P7D"
+ *         },
+ *         relationships: {
+ *             slots: {
+ *                 data: [{
+ *                         type: "batchActivationSlot",
+ *                         id: "01961e5a-e15f-7d33-bd4f-09c6b8fa3d56"
+ *                     }]
+ *             }
  *         }
  *     }
  */

package/dist/esm/api/resources/organizations/resources/placements/types/PlacementListResponse.d.mts

@@ -5,8 +5,8 @@ import type * as KardApi from "../../../../../index.mjs";
 export interface PlacementListResponse {
     /** Array of placement resources */
     data: KardApi.organizations.PlacementFormatUnion[];
-    /** Related resources requested via the `include` query parameter. Only populated when `include=contentStrategy` is supplied and at least one placement in `data` is linked to a content strategy. */
-    included?: KardApi.organizations.ContentStrategyResponse[] | undefined;
+    /** Related resources requested via the `include` query parameter. Each entry is keyed by its `type` discriminant (`contentStrategy`, `batchActivationSlot`, `placementMainPage`, `placementPushNotification`). */
+    included?: KardApi.organizations.IncludedResource[] | undefined;
     links?: KardApi.Links | undefined;
     /** Pagination metadata */
     meta?: KardApi.OrganizationPaginationMetadata | undefined;

package/dist/esm/api/resources/organizations/resources/placements/types/PlacementRelationships.d.mts

@@ -0,0 +1,8 @@
+import type * as KardApi from "../../../../../index.mjs";
+/**
+ * Relationship block for non-batch placements. Mirrors the `contentStrategyId` attribute so JSON:API clients can walk the graph.
+ */
+export interface PlacementRelationships {
+    /** Relationship to the content strategy that powers this placement. Present whenever the placement has been linked to a content strategy (`data.id` will be set). Omitted entirely when no content strategy is linked. */
+    contentStrategy?: KardApi.organizations.ToOneRelationship | undefined;
+}

package/dist/esm/api/resources/organizations/resources/placements/types/PlacementRelationships.mjs

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

package/dist/esm/api/resources/organizations/resources/placements/types/PlacementResource.d.mts

@@ -5,6 +5,6 @@ import type * as KardApi from "../../../../../index.mjs";
 export interface PlacementResource {
     /** Placement resource */
     data: KardApi.organizations.PlacementFormatUnion;
-    /** Related resources requested via the `include` query parameter. Only populated when `include=contentStrategy` is supplied and the placement is linked to a content strategy. */
-    included?: KardApi.organizations.ContentStrategyResponse[] | undefined;
+    /** Related resources requested via the `include` query parameter. Each entry is keyed by its `type` discriminant (`contentStrategy`, `batchActivationSlot`, `placementMainPage`, `placementPushNotification`). */
+    included?: KardApi.organizations.IncludedResource[] | undefined;
 }

package/dist/esm/api/resources/organizations/resources/placements/types/PushNotificationPlacementAttributes.d.mts

@@ -9,6 +9,6 @@ export interface PushNotificationPlacementAttributes {
     organizationId: string;
     /** Delivery cadence for the notification */
     cadence: KardApi.organizations.Cadence;
-    /** ID of the content strategy linked to this placement, if any */
+    /** ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility. */
     contentStrategyId?: string | undefined;
 }

package/dist/esm/api/resources/organizations/resources/placements/types/PushNotificationPlacementData.d.mts

@@ -6,4 +6,6 @@ export interface PushNotificationPlacementData {
     /** Unique identifier of the placement (UUID v7) */
     id: string;
     attributes: KardApi.organizations.PushNotificationPlacementAttributes;
+    /** JSON:API relationships for the placement. Omitted entirely when the placement has no linked resources. */
+    relationships?: KardApi.organizations.PlacementRelationships | undefined;
 }

package/dist/esm/api/resources/organizations/resources/placements/types/ResourceIdentifier.d.mts

@@ -0,0 +1,9 @@
+/**
+ * A reference to another resource by type and id.
+ */
+export interface ResourceIdentifier {
+    /** Discriminant of the referenced resource (e.g. `contentStrategy`). */
+    type: string;
+    /** Identifier of the referenced resource. */
+    id: string;
+}

package/dist/esm/api/resources/organizations/resources/placements/types/ResourceIdentifier.mjs

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

package/dist/esm/api/resources/organizations/resources/placements/types/ToManyRelationship.d.mts

@@ -0,0 +1,8 @@
+import type * as KardApi from "../../../../../index.mjs";
+/**
+ * A JSON:API to-many relationship payload.
+ */
+export interface ToManyRelationship {
+    /** The linked resource identifiers. */
+    data: KardApi.organizations.ResourceIdentifier[];
+}

package/dist/esm/api/resources/organizations/resources/placements/types/ToManyRelationship.mjs

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

package/dist/esm/api/resources/organizations/resources/placements/types/ToOneRelationship.d.mts

@@ -0,0 +1,8 @@
+import type * as KardApi from "../../../../../index.mjs";
+/**
+ * A JSON:API to-one relationship payload.
+ */
+export interface ToOneRelationship {
+    /** The linked resource identifier, or null when the relationship is present but unlinked. */
+    data?: KardApi.organizations.ResourceIdentifier | undefined;
+}

package/dist/esm/api/resources/organizations/resources/placements/types/ToOneRelationship.mjs

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

package/dist/esm/api/resources/organizations/resources/placements/types/UpdateBatchActivationAttributes.d.mts

@@ -8,8 +8,9 @@ import type * as KardApi from "../../../../../index.mjs";
  *         refreshInterval: "P14D",
  *         slots: [{
  *                 slotId: "01961e5a-e15f-7d33-bd4f-09c6b8fa3d56",
- *                 contentStrategyId: "01961e5a-f26f-7e44-ce5f-1ad7c9fb4e67",
- *                 alias: "primary"
+ *                 placementId: "01961e5a-f26f-7e44-ce5f-1ad7c9fb4e67",
+ *                 alias: "primary",
+ *                 shortDescription: "Featured deals refreshed each week"
  *             }]
  *     }
  */

package/dist/esm/api/resources/organizations/resources/placements/types/UpdateBatchActivationSlot.d.mts

@@ -2,10 +2,12 @@
  * A slot in a batch-activation placement at update time
  */
 export interface UpdateBatchActivationSlot {
-    /** Existing slot identifier. Echo the value from a prior GET to keep the slot stable; omit to mint a fresh slot. If the contentStrategyId changes, the slotId is regenerated regardless of what was echoed. */
+    /** Existing slot identifier. Echo the value from a prior GET to keep the slot stable; omit to mint a fresh slot. If the placementId changes, the slotId is regenerated regardless of what was echoed. */
     slotId?: string | undefined;
-    /** ID of the content strategy that fills this slot */
-    contentStrategyId: string;
+    /** ID of another placement that fills this slot. The referenced placement provides both the content strategy and the limit on the number of offers available to the slot. */
+    placementId: string;
     /** Customer-defined alias for the slot, unique within the placement */
     alias: string;
+    /** Optional short description of the slot, limited to 50 characters */
+    shortDescription?: string | undefined;
 }

package/dist/esm/api/resources/organizations/resources/placements/types/index.d.mts

@@ -1,8 +1,12 @@
 export * from "./BatchActivationPlacementAttributes.mjs";
 export * from "./BatchActivationPlacementData.mjs";
-export * from "./BatchActivationSlot.mjs";
+export * from "./BatchActivationPlacementRelationships.mjs";
+export * from "./BatchActivationSlotAttributes.mjs";
+export * from "./BatchActivationSlotInclusion.mjs";
+export * from "./BatchActivationSlotRelationships.mjs";
 export * from "./Cadence.mjs";
 export * from "./CadenceFrequency.mjs";
+export * from "./ContentStrategyInclusion.mjs";
 export * from "./CreateBatchActivationAttributes.mjs";
 export * from "./CreateBatchActivationPlacementData.mjs";
 export * from "./CreateBatchActivationSlot.mjs";
@@ -13,14 +17,19 @@ export * from "./CreatePlacementRequestBody.mjs";
 export * from "./CreatePushNotificationAttributes.mjs";
 export * from "./CreatePushNotificationPlacementData.mjs";
 export * from "./DayOfWeek.mjs";
+export * from "./IncludedResource.mjs";
 export * from "./MainPagePlacementAttributes.mjs";
 export * from "./MainPagePlacementData.mjs";
 export * from "./PlacementFormatUnion.mjs";
 export * from "./PlacementListResponse.mjs";
+export * from "./PlacementRelationships.mjs";
 export * from "./PlacementResource.mjs";
 export * from "./PlacementTypeFilter.mjs";
 export * from "./PushNotificationPlacementAttributes.mjs";
 export * from "./PushNotificationPlacementData.mjs";
+export * from "./ResourceIdentifier.mjs";
+export * from "./ToManyRelationship.mjs";
+export * from "./ToOneRelationship.mjs";
 export * from "./UpdateBatchActivationAttributes.mjs";
 export * from "./UpdateBatchActivationPlacementData.mjs";
 export * from "./UpdateBatchActivationSlot.mjs";

package/dist/esm/api/resources/organizations/resources/placements/types/index.mjs

@@ -1,8 +1,12 @@
 export * from "./BatchActivationPlacementAttributes.mjs";
 export * from "./BatchActivationPlacementData.mjs";
-export * from "./BatchActivationSlot.mjs";
+export * from "./BatchActivationPlacementRelationships.mjs";
+export * from "./BatchActivationSlotAttributes.mjs";
+export * from "./BatchActivationSlotInclusion.mjs";
+export * from "./BatchActivationSlotRelationships.mjs";
 export * from "./Cadence.mjs";
 export * from "./CadenceFrequency.mjs";
+export * from "./ContentStrategyInclusion.mjs";
 export * from "./CreateBatchActivationAttributes.mjs";
 export * from "./CreateBatchActivationPlacementData.mjs";
 export * from "./CreateBatchActivationSlot.mjs";
@@ -13,14 +17,19 @@ export * from "./CreatePlacementRequestBody.mjs";
 export * from "./CreatePushNotificationAttributes.mjs";
 export * from "./CreatePushNotificationPlacementData.mjs";
 export * from "./DayOfWeek.mjs";
+export * from "./IncludedResource.mjs";
 export * from "./MainPagePlacementAttributes.mjs";
 export * from "./MainPagePlacementData.mjs";
 export * from "./PlacementFormatUnion.mjs";
 export * from "./PlacementListResponse.mjs";
+export * from "./PlacementRelationships.mjs";
 export * from "./PlacementResource.mjs";
 export * from "./PlacementTypeFilter.mjs";
 export * from "./PushNotificationPlacementAttributes.mjs";
 export * from "./PushNotificationPlacementData.mjs";
+export * from "./ResourceIdentifier.mjs";
+export * from "./ToManyRelationship.mjs";
+export * from "./ToOneRelationship.mjs";
 export * from "./UpdateBatchActivationAttributes.mjs";
 export * from "./UpdateBatchActivationPlacementData.mjs";
 export * from "./UpdateBatchActivationSlot.mjs";

package/dist/esm/api/resources/users/resources/rewards/types/BatchesResponseObject.d.mts

@@ -3,5 +3,5 @@ import type * as KardApi from "../../../../../index.mjs";
  * Ordered list of slots for a batch-activation placement, with freshness fields and per-slot offer sets.
  */
 export interface BatchesResponseObject {
-    data: KardApi.users.BatchSlotData[];
+    data: KardApi.users.PlacementBatchData[];
 }

package/dist/esm/api/resources/users/resources/rewards/types/{BatchSlotData.d.mts → PlacementBatchAttributes.d.mts}

@@ -1,12 +1,10 @@
 import type * as KardApi from "../../../../../index.mjs";
 /**
- * One slot in a batch-activation placement, with freshness fields and the offers that resolve under the slot's content strategy.
+ * Attributes of a placement batch slot.
  */
-export interface BatchSlotData {
-    /** Stable identifier for the slot within the placement */
-    slotId: string;
-    /** Customer-defined alias for the slot, unique within the placement */
-    alias: string;
+export interface PlacementBatchAttributes {
+    /** Display name for the slot. Falls back to the slot's customer-defined alias, or — when the alias is absent — the name of the placement referenced by the slot. */
+    name: string;
     /** Whether the slot is still considered "fresh" for the user. Set to false only when the slot's `expiresAt` is in the past AND the slot resolves to a non-empty offer set; an empty offer set keeps the slot active so partner UIs do not promote "tap to refresh" with nothing to show. */
     isActive: boolean;
     /** Timestamp of the most recent placementSlotAttribution ACTIVATE event for this (user, placement, slot). Absent for cold slots that have never been activated. */

package/dist/esm/api/resources/users/resources/rewards/types/PlacementBatchAttributes.mjs

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

package/dist/esm/api/resources/users/resources/rewards/types/PlacementBatchData.d.mts

@@ -0,0 +1,10 @@
+import type * as KardApi from "../../../../../index.mjs";
+/**
+ * One slot in a batch-activation placement, with freshness fields and the offers that resolve under the slot's content strategy.
+ */
+export interface PlacementBatchData {
+    /** Stable identifier for the slot within the placement */
+    id: string;
+    type: "placementBatch";
+    attributes: KardApi.users.PlacementBatchAttributes;
+}

package/dist/esm/api/resources/users/resources/rewards/types/PlacementBatchData.mjs

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

package/dist/esm/api/resources/users/resources/rewards/types/index.d.mts

@@ -2,7 +2,6 @@ export * from "./Amount.mjs";
 export * from "./AmountType.mjs";
 export * from "./Asset.mjs";
 export * from "./BatchesResponseObject.mjs";
-export * from "./BatchSlotData.mjs";
 export * from "./ButtonStyle.mjs";
 export * from "./CategoryData.mjs";
 export * from "./CategoryFields.mjs";
@@ -40,6 +39,8 @@ export * from "./OffersResponseObject.mjs";
 export * from "./OperationHours.mjs";
 export * from "./OperationPeriod.mjs";
 export * from "./OperationTime.mjs";
+export * from "./PlacementBatchAttributes.mjs";
+export * from "./PlacementBatchData.mjs";
 export * from "./ProgressBar.mjs";
 export * from "./ProgressBarLabelPair.mjs";
 export * from "./ProgressBarLabels.mjs";

package/dist/esm/api/resources/users/resources/rewards/types/index.mjs

@@ -2,7 +2,6 @@ export * from "./Amount.mjs";
 export * from "./AmountType.mjs";
 export * from "./Asset.mjs";
 export * from "./BatchesResponseObject.mjs";
-export * from "./BatchSlotData.mjs";
 export * from "./ButtonStyle.mjs";
 export * from "./CategoryData.mjs";
 export * from "./CategoryFields.mjs";
@@ -40,6 +39,8 @@ export * from "./OffersResponseObject.mjs";
 export * from "./OperationHours.mjs";
 export * from "./OperationPeriod.mjs";
 export * from "./OperationTime.mjs";
+export * from "./PlacementBatchAttributes.mjs";
+export * from "./PlacementBatchData.mjs";
 export * from "./ProgressBar.mjs";
 export * from "./ProgressBarLabelPair.mjs";
 export * from "./ProgressBarLabels.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "24.1.0";
+export declare const SDK_VERSION = "26.0.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "24.1.0";
+export const SDK_VERSION = "26.0.0";

package/package.json

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

package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationSlot.d.ts

@@ -1,11 +0,0 @@
-/**
- * A slot within a batch-activation placement
- */
-export interface BatchActivationSlot {
-    /** Stable identifier for the slot within the placement */
-    slotId: string;
-    /** ID of the content strategy linked to this slot */
-    contentStrategyId: string;
-    /** Customer-defined alias for the slot, unique within the placement */
-    alias: string;
-}

package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationSlot.d.mts

@@ -1,11 +0,0 @@
-/**
- * A slot within a batch-activation placement
- */
-export interface BatchActivationSlot {
-    /** Stable identifier for the slot within the placement */
-    slotId: string;
-    /** ID of the content strategy linked to this slot */
-    contentStrategyId: string;
-    /** Customer-defined alias for the slot, unique within the placement */
-    alias: string;
-}