@kard-financial/sdk 22.2.0 → 22.4.0

package/dist/esm/api/resources/users/resources/attributions/types/ActivatePlacementSlotResponse.d.mts

@@ -0,0 +1,23 @@
+import type * as KardApi from "../../../../../index.mjs";
+/**
+ * Ack payload for a slot activation request.
+ *
+ * @example
+ *     {
+ *         data: {
+ *             type: "placementSlotAttribution",
+ *             id: "c94a93a7-beb9-4e58-960c-2c812f849398",
+ *             attributes: {
+ *                 placementId: "018f8d6b-1abc-7def-9012-345678901234",
+ *                 slotId: "slot-a",
+ *                 eventCode: "ACTIVATE",
+ *                 medium: "CTA",
+ *                 eventDate: "2025-01-01T00:00:00Z",
+ *                 offerIds: ["offer-1", "offer-2", "offer-3"]
+ *             }
+ *         }
+ *     }
+ */
+export interface ActivatePlacementSlotResponse {
+    data: KardApi.users.ActivatePlacementSlotResponseData;
+}

package/dist/esm/api/resources/users/resources/attributions/types/ActivatePlacementSlotResponse.mjs

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

package/dist/esm/api/resources/users/resources/attributions/types/ActivatePlacementSlotResponseAttributes.d.mts

@@ -0,0 +1,15 @@
+export interface ActivatePlacementSlotResponseAttributes {
+    /** Unique identifier of the placement */
+    placementId: string;
+    /** Stable identifier for the slot within the placement */
+    slotId: string;
+    eventCode: string;
+    medium: string;
+    eventDate: string;
+    /**
+     * All offer IDs that resolved under the slot's content strategy and had
+     * per-offer `offerAttribution` ACTIVATE events written. The partner can use
+     * this to render the batch immediately without an extra round-trip.
+     */
+    offerIds: string[];
+}

package/dist/esm/api/resources/users/resources/attributions/types/ActivatePlacementSlotResponseAttributes.mjs

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

package/dist/esm/api/resources/users/resources/attributions/types/ActivatePlacementSlotResponseData.d.mts

@@ -0,0 +1,7 @@
+import type * as KardApi from "../../../../../index.mjs";
+export interface ActivatePlacementSlotResponseData {
+    type: string;
+    /** The slot-level attribution event id */
+    id: string;
+    attributes: KardApi.users.ActivatePlacementSlotResponseAttributes;
+}

package/dist/esm/api/resources/users/resources/attributions/types/ActivatePlacementSlotResponseData.mjs

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

package/dist/esm/api/resources/users/resources/attributions/types/AttributionState.d.mts

@@ -4,4 +4,8 @@ export interface AttributionState {
     rank?: number | undefined;
     /** The active filters when the user saw the offer */
     filters?: KardApi.users.AttributionFilter[] | undefined;
+    /** Unique identifier of the placement the attribution event originated from */
+    placementId?: string | undefined;
+    /** Stable identifier for the slot within the placement */
+    slotId?: string | undefined;
 }

package/dist/esm/api/resources/users/resources/attributions/types/CreateAttributionRequestUnion.d.mts

@@ -1,5 +1,5 @@
 import type * as KardApi from "../../../../../index.mjs";
-export type CreateAttributionRequestUnion = KardApi.users.CreateAttributionRequestUnion.OfferAttribution | KardApi.users.CreateAttributionRequestUnion.NotificationAttribution;
+export type CreateAttributionRequestUnion = KardApi.users.CreateAttributionRequestUnion.OfferAttribution | KardApi.users.CreateAttributionRequestUnion.NotificationAttribution | KardApi.users.CreateAttributionRequestUnion.PlacementSlotAttribution;
 export declare namespace CreateAttributionRequestUnion {
     interface OfferAttribution extends KardApi.users.OfferAttributionRequest {
         type: "offerAttribution";
@@ -7,4 +7,7 @@ export declare namespace CreateAttributionRequestUnion {
     interface NotificationAttribution extends KardApi.users.NotificationAttributionRequest {
         type: "notificationAttribution";
     }
+    interface PlacementSlotAttribution extends KardApi.users.PlacementSlotAttributionRequest {
+        type: "placementSlotAttribution";
+    }
 }

package/dist/esm/api/resources/users/resources/attributions/types/PlacementSlotAttributionAttributes.d.mts

@@ -0,0 +1,19 @@
+import type * as KardApi from "../../../../../index.mjs";
+/**
+ * Attributes for a slot-level activation event on a batch-activation placement.
+ * A slot activation also writes per-offer `offerAttribution` ACTIVATE events for
+ * every offer resolved by the slot's content strategy (see `ActivatePlacementSlot`).
+ */
+export interface PlacementSlotAttributionAttributes {
+    /** The slot ID (matches `state.slotId`) */
+    entityId: string;
+    eventCode: KardApi.users.EventCode;
+    medium: KardApi.users.PlacementSlotMedium;
+    /**
+     * The timestamp of the attribution event.
+     * Must be in ISO 8601 format (e.g., "2025-01-01T00:00:00Z").
+     */
+    eventDate: string;
+    /** Placement context for the attribution event */
+    state?: KardApi.users.AttributionState | undefined;
+}

package/dist/esm/api/resources/users/resources/attributions/types/PlacementSlotAttributionAttributes.mjs

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

package/dist/esm/api/resources/users/resources/attributions/types/PlacementSlotAttributionRequest.d.mts

@@ -0,0 +1,4 @@
+import type * as KardApi from "../../../../../index.mjs";
+export interface PlacementSlotAttributionRequest {
+    attributes: KardApi.users.PlacementSlotAttributionAttributes;
+}

package/dist/esm/api/resources/users/resources/attributions/types/PlacementSlotAttributionRequest.mjs

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

package/dist/esm/api/resources/users/resources/attributions/types/PlacementSlotMedium.d.mts

@@ -0,0 +1,5 @@
+/** Where the placement-slot attribution event is taking place in your rewards experience. */
+export declare const PlacementSlotMedium: {
+    readonly Cta: "CTA";
+};
+export type PlacementSlotMedium = (typeof PlacementSlotMedium)[keyof typeof PlacementSlotMedium];

package/dist/esm/api/resources/users/resources/attributions/types/PlacementSlotMedium.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Where the placement-slot attribution event is taking place in your rewards experience. */
+export const PlacementSlotMedium = {
+    Cta: "CTA",
+};

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

@@ -3,6 +3,9 @@ export * from "./ActivateOfferIncludeOption.mjs";
 export * from "./ActivateOfferResponse.mjs";
 export * from "./ActivateOfferResponseAttributes.mjs";
 export * from "./ActivateOfferResponseData.mjs";
+export * from "./ActivatePlacementSlotResponse.mjs";
+export * from "./ActivatePlacementSlotResponseAttributes.mjs";
+export * from "./ActivatePlacementSlotResponseData.mjs";
 export * from "./AttributionFilter.mjs";
 export * from "./AttributionState.mjs";
 export * from "./BoostOfferIncluded.mjs";
@@ -20,3 +23,6 @@ export * from "./NotificationMedium.mjs";
 export * from "./OfferAttributionAttributes.mjs";
 export * from "./OfferAttributionRequest.mjs";
 export * from "./OfferMedium.mjs";
+export * from "./PlacementSlotAttributionAttributes.mjs";
+export * from "./PlacementSlotAttributionRequest.mjs";
+export * from "./PlacementSlotMedium.mjs";

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

@@ -3,6 +3,9 @@ export * from "./ActivateOfferIncludeOption.mjs";
 export * from "./ActivateOfferResponse.mjs";
 export * from "./ActivateOfferResponseAttributes.mjs";
 export * from "./ActivateOfferResponseData.mjs";
+export * from "./ActivatePlacementSlotResponse.mjs";
+export * from "./ActivatePlacementSlotResponseAttributes.mjs";
+export * from "./ActivatePlacementSlotResponseData.mjs";
 export * from "./AttributionFilter.mjs";
 export * from "./AttributionState.mjs";
 export * from "./BoostOfferIncluded.mjs";
@@ -20,3 +23,6 @@ export * from "./NotificationMedium.mjs";
 export * from "./OfferAttributionAttributes.mjs";
 export * from "./OfferAttributionRequest.mjs";
 export * from "./OfferMedium.mjs";
+export * from "./PlacementSlotAttributionAttributes.mjs";
+export * from "./PlacementSlotAttributionRequest.mjs";
+export * from "./PlacementSlotMedium.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.2.0";
+export declare const SDK_VERSION = "22.4.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "22.2.0";
+export const SDK_VERSION = "22.4.0";

package/package.json

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

package/reference.md

@@ -2717,6 +2717,100 @@ await client.users.attributions.boost("organization-123", "user-123", "offer-456
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.users.attributions.<a href="/src/api/resources/users/resources/attributions/client/Client.ts">activatePlacementSlot</a>(organizationId, userId, placementId, slotId) -> KardApi.ActivatePlacementSlotResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Record when a user activates a batch-activation placement slot. Writes a slot-level
+`placementSlotAttribution` ACTIVATE event and fans out a per-offer
+`offerAttribution` ACTIVATE event for every offer resolved by the slot's content
+strategy. The slot-level event id and the resolved `offerIds` are returned so the
+partner can render the batch immediately without an extra `getBatchesByPlacement`
+round-trip.
+
+<b>Required scopes:</b> `attributions:write`
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.users.attributions.activatePlacementSlot("organization-123", "user-123", "018f8d6b-1abc-7def-9012-345678901234", "slot-a");
+
+```
+</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` — Unique identifier of the placement (UUID v7)
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**slotId:** `string` — Stable identifier for the slot within the placement
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AttributionsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2965,6 +3059,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>