@kard-financial/sdk 22.1.0 → 22.3.0

package/dist/esm/api/resources/organizations/resources/placements/types/CreateBatchActivationAttributes.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/CreateBatchActivationPlacementData.d.mts

@@ -0,0 +1,8 @@
+import type * as KardApi from "../../../../../index.mjs";
+/**
+ * Data for creating a batch-activation placement
+ */
+export interface CreateBatchActivationPlacementData {
+    /** Batch-activation placement attributes for creation */
+    attributes: KardApi.organizations.CreateBatchActivationAttributes;
+}

package/dist/esm/api/resources/organizations/resources/placements/types/CreateBatchActivationPlacementData.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/CreateBatchActivationSlot.d.mts

@@ -0,0 +1,9 @@
+/**
+ * A slot in a batch-activation placement at creation time
+ */
+export interface CreateBatchActivationSlot {
+    /** ID of the content strategy that fills 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/CreateBatchActivationSlot.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/CreatePlacementDataUnion.d.mts

@@ -2,7 +2,7 @@ import type * as KardApi from "../../../../../index.mjs";
 /**
  * Discriminated union for creating a placement
  */
-export type CreatePlacementDataUnion = KardApi.organizations.CreatePlacementDataUnion.PlacementMainPage | KardApi.organizations.CreatePlacementDataUnion.PlacementPushNotification;
+export type CreatePlacementDataUnion = KardApi.organizations.CreatePlacementDataUnion.PlacementMainPage | KardApi.organizations.CreatePlacementDataUnion.PlacementPushNotification | KardApi.organizations.CreatePlacementDataUnion.PlacementBatchActivation;
 export declare namespace CreatePlacementDataUnion {
     interface PlacementMainPage extends KardApi.organizations.CreateMainPagePlacementData {
         type: "placementMainPage";
@@ -10,4 +10,7 @@ export declare namespace CreatePlacementDataUnion {
     interface PlacementPushNotification extends KardApi.organizations.CreatePushNotificationPlacementData {
         type: "placementPushNotification";
     }
+    interface PlacementBatchActivation extends KardApi.organizations.CreateBatchActivationPlacementData {
+        type: "placementBatchActivation";
+    }
 }

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

@@ -26,8 +26,24 @@ import type * as KardApi from "../../../../../index.mjs";
  *             }
  *         }
  *     }
+ *
+ * @example
+ *     {
+ *         type: "placementBatchActivation",
+ *         id: "01961e5a-d94e-7c22-ac3f-f8b5a7e92c45",
+ *         attributes: {
+ *             name: "Weekly Cohort",
+ *             organizationId: "org-123",
+ *             refreshInterval: "P7D",
+ *             slots: [{
+ *                     slotId: "01961e5a-e15f-7d33-bd4f-09c6b8fa3d56",
+ *                     contentStrategyId: "01961e5a-f26f-7e44-ce5f-1ad7c9fb4e67",
+ *                     alias: "primary"
+ *                 }]
+ *         }
+ *     }
  */
-export type PlacementFormatUnion = KardApi.organizations.PlacementFormatUnion.PlacementMainPage | KardApi.organizations.PlacementFormatUnion.PlacementPushNotification;
+export type PlacementFormatUnion = KardApi.organizations.PlacementFormatUnion.PlacementMainPage | KardApi.organizations.PlacementFormatUnion.PlacementPushNotification | KardApi.organizations.PlacementFormatUnion.PlacementBatchActivation;
 export declare namespace PlacementFormatUnion {
     interface PlacementMainPage extends KardApi.organizations.MainPagePlacementData {
         type: "placementMainPage";
@@ -35,4 +51,7 @@ export declare namespace PlacementFormatUnion {
     interface PlacementPushNotification extends KardApi.organizations.PushNotificationPlacementData {
         type: "placementPushNotification";
     }
+    interface PlacementBatchActivation extends KardApi.organizations.BatchActivationPlacementData {
+        type: "placementBatchActivation";
+    }
 }

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

@@ -2,5 +2,6 @@
 export declare const PlacementTypeFilter: {
     readonly PlacementMainPage: "placementMainPage";
     readonly PlacementPushNotification: "placementPushNotification";
+    readonly PlacementBatchActivation: "placementBatchActivation";
 };
 export type PlacementTypeFilter = (typeof PlacementTypeFilter)[keyof typeof PlacementTypeFilter];

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

@@ -3,4 +3,5 @@
 export const PlacementTypeFilter = {
     PlacementMainPage: "placementMainPage",
     PlacementPushNotification: "placementPushNotification",
+    PlacementBatchActivation: "placementBatchActivation",
 };

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

@@ -0,0 +1,23 @@
+import type * as KardApi from "../../../../../index.mjs";
+/**
+ * Attributes for updating a batch-activation placement. All fields are required.
+ *
+ * @example
+ *     {
+ *         name: "Updated Cohort",
+ *         refreshInterval: "P14D",
+ *         slots: [{
+ *                 slotId: "01961e5a-e15f-7d33-bd4f-09c6b8fa3d56",
+ *                 contentStrategyId: "01961e5a-f26f-7e44-ce5f-1ad7c9fb4e67",
+ *                 alias: "primary"
+ *             }]
+ *     }
+ */
+export interface UpdateBatchActivationAttributes {
+    /** Name of the placement */
+    name: string;
+    /** ISO-8601 duration controlling how often the activation cohort refreshes */
+    refreshInterval: string;
+    /** Slots that make up the activation cohort. Slots present in the prior state but absent from this list are removed. */
+    slots: KardApi.organizations.UpdateBatchActivationSlot[];
+}

package/dist/esm/api/resources/organizations/resources/placements/types/UpdateBatchActivationAttributes.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/UpdateBatchActivationPlacementData.d.mts

@@ -0,0 +1,8 @@
+import type * as KardApi from "../../../../../index.mjs";
+/**
+ * Data for updating a batch-activation placement
+ */
+export interface UpdateBatchActivationPlacementData {
+    /** Batch-activation placement attributes for update */
+    attributes: KardApi.organizations.UpdateBatchActivationAttributes;
+}

package/dist/esm/api/resources/organizations/resources/placements/types/UpdateBatchActivationPlacementData.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/UpdateBatchActivationSlot.d.mts

@@ -0,0 +1,11 @@
+/**
+ * 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. */
+    slotId?: string | undefined;
+    /** ID of the content strategy that fills 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/UpdateBatchActivationSlot.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/UpdatePlacementDataUnion.d.mts

@@ -2,7 +2,7 @@ import type * as KardApi from "../../../../../index.mjs";
 /**
  * Discriminated union for updating a placement
  */
-export type UpdatePlacementDataUnion = KardApi.organizations.UpdatePlacementDataUnion.PlacementMainPage | KardApi.organizations.UpdatePlacementDataUnion.PlacementPushNotification;
+export type UpdatePlacementDataUnion = KardApi.organizations.UpdatePlacementDataUnion.PlacementMainPage | KardApi.organizations.UpdatePlacementDataUnion.PlacementPushNotification | KardApi.organizations.UpdatePlacementDataUnion.PlacementBatchActivation;
 export declare namespace UpdatePlacementDataUnion {
     interface PlacementMainPage extends KardApi.organizations.UpdateMainPagePlacementData {
         type: "placementMainPage";
@@ -10,4 +10,7 @@ export declare namespace UpdatePlacementDataUnion {
     interface PlacementPushNotification extends KardApi.organizations.UpdatePushNotificationPlacementData {
         type: "placementPushNotification";
     }
+    interface PlacementBatchActivation extends KardApi.organizations.UpdateBatchActivationPlacementData {
+        type: "placementBatchActivation";
+    }
 }

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

@@ -1,5 +1,11 @@
+export * from "./BatchActivationPlacementAttributes.mjs";
+export * from "./BatchActivationPlacementData.mjs";
+export * from "./BatchActivationSlot.mjs";
 export * from "./Cadence.mjs";
 export * from "./CadenceFrequency.mjs";
+export * from "./CreateBatchActivationAttributes.mjs";
+export * from "./CreateBatchActivationPlacementData.mjs";
+export * from "./CreateBatchActivationSlot.mjs";
 export * from "./CreateMainPageAttributes.mjs";
 export * from "./CreateMainPagePlacementData.mjs";
 export * from "./CreatePlacementDataUnion.mjs";
@@ -15,6 +21,9 @@ export * from "./PlacementResource.mjs";
 export * from "./PlacementTypeFilter.mjs";
 export * from "./PushNotificationPlacementAttributes.mjs";
 export * from "./PushNotificationPlacementData.mjs";
+export * from "./UpdateBatchActivationAttributes.mjs";
+export * from "./UpdateBatchActivationPlacementData.mjs";
+export * from "./UpdateBatchActivationSlot.mjs";
 export * from "./UpdateMainPageAttributes.mjs";
 export * from "./UpdateMainPagePlacementData.mjs";
 export * from "./UpdatePlacementDataUnion.mjs";

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

@@ -1,5 +1,11 @@
+export * from "./BatchActivationPlacementAttributes.mjs";
+export * from "./BatchActivationPlacementData.mjs";
+export * from "./BatchActivationSlot.mjs";
 export * from "./Cadence.mjs";
 export * from "./CadenceFrequency.mjs";
+export * from "./CreateBatchActivationAttributes.mjs";
+export * from "./CreateBatchActivationPlacementData.mjs";
+export * from "./CreateBatchActivationSlot.mjs";
 export * from "./CreateMainPageAttributes.mjs";
 export * from "./CreateMainPagePlacementData.mjs";
 export * from "./CreatePlacementDataUnion.mjs";
@@ -15,6 +21,9 @@ export * from "./PlacementResource.mjs";
 export * from "./PlacementTypeFilter.mjs";
 export * from "./PushNotificationPlacementAttributes.mjs";
 export * from "./PushNotificationPlacementData.mjs";
+export * from "./UpdateBatchActivationAttributes.mjs";
+export * from "./UpdateBatchActivationPlacementData.mjs";
+export * from "./UpdateBatchActivationSlot.mjs";
 export * from "./UpdateMainPageAttributes.mjs";
 export * from "./UpdateMainPagePlacementData.mjs";
 export * from "./UpdatePlacementDataUnion.mjs";

package/dist/esm/api/resources/users/resources/rewards/client/Client.d.mts

@@ -56,6 +56,33 @@ export declare class RewardsClient {
      */
     placementOffers(organizationId: KardApi.OrganizationId, userId: KardApi.UserId, placementId: string, request?: KardApi.users.GetOffersByPlacementRequest, requestOptions?: RewardsClient.RequestOptions): core.HttpResponsePromise<KardApi.users.OffersResponseObject>;
     private __placementOffers;
+    /**
+     * Retrieve batches for a batch-activation placement. Returns each slot in slot
+     * order with its current offer set, alias, and freshness fields (`isActive`,
+     * `lastActivatedAt`, `expiresAt`). Applies the same per-user eligibility and
+     * per-slot content-strategy filter as Get Offers By Placement, independently
+     * per slot. A slot only flips to `isActive: false` when its refresh interval
+     * has elapsed AND its post-eligibility `offers[]` is non-empty; otherwise the
+     * slot is still returned and stays active so the partner UI does not promote
+     * "refresh" with nothing to show.<br/>
+     * <b>Required scopes:</b> `rewards:read`
+     *
+     * @param {KardApi.OrganizationId} organizationId
+     * @param {KardApi.UserId} userId
+     * @param {string} placementId
+     * @param {KardApi.users.GetBatchesByPlacementRequest} request
+     * @param {RewardsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link KardApi.InternalServerError}
+     * @throws {@link KardApi.InvalidRequest}
+     * @throws {@link KardApi.DoesNotExistError}
+     * @throws {@link KardApi.UnauthorizedError}
+     *
+     * @example
+     *     await client.users.rewards.placementBatches("organizationId", "userId", "placementId")
+     */
+    placementBatches(organizationId: KardApi.OrganizationId, userId: KardApi.UserId, placementId: string, request?: KardApi.users.GetBatchesByPlacementRequest, requestOptions?: RewardsClient.RequestOptions): core.HttpResponsePromise<KardApi.users.BatchesResponseObject>;
+    private __placementBatches;
     /**
      * Retrieve national and local geographic locations that a specified user has eligible in-store offers at. Use this endpoint to build
      * out your [map-specific UX experiences](/2024-10-01/api/getting-started#c-discover-clos-near-you-map-view). Please note

package/dist/esm/api/resources/users/resources/rewards/client/Client.mjs

@@ -178,6 +178,82 @@ export class RewardsClient {
             return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/issuers/{organizationId}/users/{userId}/placements/{placementId}/offers");
         });
     }
+    /**
+     * Retrieve batches for a batch-activation placement. Returns each slot in slot
+     * order with its current offer set, alias, and freshness fields (`isActive`,
+     * `lastActivatedAt`, `expiresAt`). Applies the same per-user eligibility and
+     * per-slot content-strategy filter as Get Offers By Placement, independently
+     * per slot. A slot only flips to `isActive: false` when its refresh interval
+     * has elapsed AND its post-eligibility `offers[]` is non-empty; otherwise the
+     * slot is still returned and stays active so the partner UI does not promote
+     * "refresh" with nothing to show.<br/>
+     * <b>Required scopes:</b> `rewards:read`
+     *
+     * @param {KardApi.OrganizationId} organizationId
+     * @param {KardApi.UserId} userId
+     * @param {string} placementId
+     * @param {KardApi.users.GetBatchesByPlacementRequest} request
+     * @param {RewardsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link KardApi.InternalServerError}
+     * @throws {@link KardApi.InvalidRequest}
+     * @throws {@link KardApi.DoesNotExistError}
+     * @throws {@link KardApi.UnauthorizedError}
+     *
+     * @example
+     *     await client.users.rewards.placementBatches("organizationId", "userId", "placementId")
+     */
+    placementBatches(organizationId, userId, placementId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__placementBatches(organizationId, userId, placementId, request, requestOptions));
+    }
+    __placementBatches(organizationId_1, userId_1, placementId_1) {
+        return __awaiter(this, arguments, void 0, function* (organizationId, userId, placementId, request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { supportedComponents } = request;
+            const _queryParams = {
+                supportedComponents: Array.isArray(supportedComponents)
+                    ? supportedComponents.map((item) => item)
+                    : supportedComponents != null
+                        ? supportedComponents
+                        : undefined,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.KardApiEnvironment.Production, `/v2/issuers/${core.url.encodePathParam(organizationId)}/users/${core.url.encodePathParam(userId)}/placements/${core.url.encodePathParam(placementId)}/batches`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 500:
+                        throw new KardApi.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 400:
+                        throw new KardApi.InvalidRequest(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new KardApi.DoesNotExistError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new KardApi.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.KardApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/issuers/{organizationId}/users/{userId}/placements/{placementId}/batches");
+        });
+    }
     /**
      * Retrieve national and local geographic locations that a specified user has eligible in-store offers at. Use this endpoint to build
      * out your [map-specific UX experiences](/2024-10-01/api/getting-started#c-discover-clos-near-you-map-view). Please note

package/dist/esm/api/resources/users/resources/rewards/client/requests/GetBatchesByPlacementRequest.d.mts

@@ -0,0 +1,9 @@
+import type * as KardApi from "../../../../../../index.mjs";
+/**
+ * @example
+ *     {}
+ */
+export interface GetBatchesByPlacementRequest {
+    /** UI component types to include in the response. */
+    supportedComponents?: KardApi.users.ComponentType | KardApi.users.ComponentType[];
+}

package/dist/esm/api/resources/users/resources/rewards/client/requests/GetBatchesByPlacementRequest.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/client/requests/index.d.mts

@@ -1,3 +1,4 @@
+export type { GetBatchesByPlacementRequest } from "./GetBatchesByPlacementRequest.mjs";
 export type { GetLocationsByUserRequest } from "./GetLocationsByUserRequest.mjs";
 export type { GetOffersByPlacementRequest } from "./GetOffersByPlacementRequest.mjs";
 export type { GetOffersByUserRequest } from "./GetOffersByUserRequest.mjs";

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

@@ -0,0 +1,18 @@
+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 BatchSlotData {
+    /** Stable identifier for the slot within the placement */
+    slotId: string;
+    /** Customer-defined alias for the slot, unique within the placement */
+    alias: 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. */
+    lastActivatedAt?: string | undefined;
+    /** Computed as `lastActivatedAt + placement.refreshInterval`. Absent for cold slots that have never been activated. */
+    expiresAt?: string | undefined;
+    /** The set of offers eligible for the user under this slot's content strategy. */
+    offers: KardApi.users.OfferDataUnion[];
+}

package/dist/esm/api/resources/users/resources/rewards/types/BatchSlotData.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/BatchesResponseObject.d.mts

@@ -0,0 +1,7 @@
+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[];
+}

package/dist/esm/api/resources/users/resources/rewards/types/BatchesResponseObject.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

@@ -1,6 +1,8 @@
 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";

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

@@ -1,6 +1,8 @@
 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";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "22.1.0";
+export declare const SDK_VERSION = "22.3.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "22.1.0";
+export const SDK_VERSION = "22.3.0";

package/package.json

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

package/reference.md

@@ -2965,6 +2965,101 @@ await client.users.rewards.placementOffers("organizationId", "userId", "placemen
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.users.rewards.<a href="/src/api/resources/users/resources/rewards/client/Client.ts">placementBatches</a>(organizationId, userId, placementId, { ...params }) -> KardApi.BatchesResponseObject</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve batches for a batch-activation placement. Returns each slot in slot
+order with its current offer set, alias, and freshness fields (`isActive`,
+`lastActivatedAt`, `expiresAt`). Applies the same per-user eligibility and
+per-slot content-strategy filter as Get Offers By Placement, independently
+per slot. A slot only flips to `isActive: false` when its refresh interval
+has elapsed AND its post-eligibility `offers[]` is non-empty; otherwise the
+slot is still returned and stays active so the partner UI does not promote
+"refresh" with nothing to show.<br/>
+<b>Required scopes:</b> `rewards:read`
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.users.rewards.placementBatches("organizationId", "userId", "placementId");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**organizationId:** `KardApi.OrganizationId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**userId:** `KardApi.UserId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**placementId:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `KardApi.users.GetBatchesByPlacementRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `RewardsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>