@kard-financial/sdk 14.1.0 → 14.2.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": "14.1.0",
-        "User-Agent": "@kard-financial/sdk/14.1.0",
+        "X-Fern-SDK-Version": "14.2.0",
+        "User-Agent": "@kard-financial/sdk/14.2.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/users/resources/rewards/client/Client.d.ts

@@ -35,6 +35,27 @@ export declare class RewardsClient {
      */
     offers(organizationId: KardApi.OrganizationId, userId: KardApi.UserId, request?: KardApi.users.GetOffersByUserRequest, requestOptions?: RewardsClient.RequestOptions): core.HttpResponsePromise<KardApi.users.OffersResponseObject>;
     private __offers;
+    /**
+     * Retrieve offers for a placement slot. Returns offers sorted by highest cash back,
+     * limited by the placement's available slots.<br/>
+     * <b>Required scopes:</b> `rewards:read`
+     *
+     * @param {KardApi.OrganizationId} organizationId
+     * @param {KardApi.UserId} userId
+     * @param {string} placementId
+     * @param {KardApi.users.GetOffersByPlacementRequest} 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.placementOffers("organizationId", "userId", "placementId")
+     */
+    placementOffers(organizationId: KardApi.OrganizationId, userId: KardApi.UserId, placementId: string, request?: KardApi.users.GetOffersByPlacementRequest, requestOptions?: RewardsClient.RequestOptions): core.HttpResponsePromise<KardApi.users.OffersResponseObject>;
+    private __placementOffers;
     /**
      * 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/cjs/api/resources/users/resources/rewards/client/Client.js

@@ -139,6 +139,81 @@ class RewardsClient {
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v2/issuers/{organizationId}/users/{userId}/offers");
         });
     }
+    /**
+     * Retrieve offers for a placement slot. Returns offers sorted by highest cash back,
+     * limited by the placement's available slots.<br/>
+     * <b>Required scopes:</b> `rewards:read`
+     *
+     * @param {KardApi.OrganizationId} organizationId
+     * @param {KardApi.UserId} userId
+     * @param {string} placementId
+     * @param {KardApi.users.GetOffersByPlacementRequest} 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.placementOffers("organizationId", "userId", "placementId")
+     */
+    placementOffers(organizationId, userId, placementId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__placementOffers(organizationId, userId, placementId, request, requestOptions));
+    }
+    __placementOffers(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 { "filter[search]": filterSearch, "filter[purchaseChannel]": filterPurchaseChannel, "filter[category]": filterCategory, "filter[isTargeted]": filterIsTargeted, include, supportedComponents, } = request;
+            const _queryParams = {
+                "filter[search]": filterSearch,
+                "filter[purchaseChannel]": filterPurchaseChannel != null ? (0, json_js_1.toJson)(filterPurchaseChannel) : undefined,
+                "filter[category]": filterCategory != null ? filterCategory : undefined,
+                "filter[isTargeted]": filterIsTargeted,
+                include,
+                supportedComponents: Array.isArray(supportedComponents)
+                    ? supportedComponents.map((item) => item)
+                    : supportedComponents != null
+                        ? supportedComponents
+                        : undefined,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.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)}/offers`),
+                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 (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v2/issuers/{organizationId}/users/{userId}/placements/{placementId}/offers");
+        });
+    }
     /**
      * 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/cjs/api/resources/users/resources/rewards/client/requests/GetOffersByPlacementRequest.d.ts

@@ -0,0 +1,16 @@
+import type * as KardApi from "../../../../../../index.js";
+/**
+ * @example
+ *     {}
+ */
+export interface GetOffersByPlacementRequest {
+    /** Case-insensitive search string to filter offers by merchant name */
+    "filter[search]"?: string;
+    "filter[purchaseChannel]"?: KardApi.PurchaseChannel[];
+    "filter[category]"?: KardApi.CategoryOption;
+    "filter[isTargeted]"?: boolean;
+    /** CSV list of included resources in the response (e.g "categories"). Allowed value is `categories`. */
+    include?: string | string[];
+    /** UI component types to include in the response. */
+    supportedComponents?: KardApi.users.ComponentType | KardApi.users.ComponentType[];
+}

package/dist/cjs/api/resources/users/resources/rewards/client/requests/GetOffersByPlacementRequest.js

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

package/dist/cjs/api/resources/users/resources/rewards/client/requests/index.d.ts

@@ -1,2 +1,3 @@
 export type { GetLocationsByUserRequest } from "./GetLocationsByUserRequest.js";
+export type { GetOffersByPlacementRequest } from "./GetOffersByPlacementRequest.js";
 export type { GetOffersByUserRequest } from "./GetOffersByUserRequest.js";

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "14.1.0";
+export declare const SDK_VERSION = "14.2.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 = "14.1.0";
+exports.SDK_VERSION = "14.2.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": "14.1.0",
-        "User-Agent": "@kard-financial/sdk/14.1.0",
+        "X-Fern-SDK-Version": "14.2.0",
+        "User-Agent": "@kard-financial/sdk/14.2.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/users/resources/rewards/client/Client.d.mts

@@ -35,6 +35,27 @@ export declare class RewardsClient {
      */
     offers(organizationId: KardApi.OrganizationId, userId: KardApi.UserId, request?: KardApi.users.GetOffersByUserRequest, requestOptions?: RewardsClient.RequestOptions): core.HttpResponsePromise<KardApi.users.OffersResponseObject>;
     private __offers;
+    /**
+     * Retrieve offers for a placement slot. Returns offers sorted by highest cash back,
+     * limited by the placement's available slots.<br/>
+     * <b>Required scopes:</b> `rewards:read`
+     *
+     * @param {KardApi.OrganizationId} organizationId
+     * @param {KardApi.UserId} userId
+     * @param {string} placementId
+     * @param {KardApi.users.GetOffersByPlacementRequest} 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.placementOffers("organizationId", "userId", "placementId")
+     */
+    placementOffers(organizationId: KardApi.OrganizationId, userId: KardApi.UserId, placementId: string, request?: KardApi.users.GetOffersByPlacementRequest, requestOptions?: RewardsClient.RequestOptions): core.HttpResponsePromise<KardApi.users.OffersResponseObject>;
+    private __placementOffers;
     /**
      * 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

@@ -103,6 +103,81 @@ export class RewardsClient {
             return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/issuers/{organizationId}/users/{userId}/offers");
         });
     }
+    /**
+     * Retrieve offers for a placement slot. Returns offers sorted by highest cash back,
+     * limited by the placement's available slots.<br/>
+     * <b>Required scopes:</b> `rewards:read`
+     *
+     * @param {KardApi.OrganizationId} organizationId
+     * @param {KardApi.UserId} userId
+     * @param {string} placementId
+     * @param {KardApi.users.GetOffersByPlacementRequest} 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.placementOffers("organizationId", "userId", "placementId")
+     */
+    placementOffers(organizationId, userId, placementId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__placementOffers(organizationId, userId, placementId, request, requestOptions));
+    }
+    __placementOffers(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 { "filter[search]": filterSearch, "filter[purchaseChannel]": filterPurchaseChannel, "filter[category]": filterCategory, "filter[isTargeted]": filterIsTargeted, include, supportedComponents, } = request;
+            const _queryParams = {
+                "filter[search]": filterSearch,
+                "filter[purchaseChannel]": filterPurchaseChannel != null ? toJson(filterPurchaseChannel) : undefined,
+                "filter[category]": filterCategory != null ? filterCategory : undefined,
+                "filter[isTargeted]": filterIsTargeted,
+                include,
+                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)}/offers`),
+                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}/offers");
+        });
+    }
     /**
      * 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/GetOffersByPlacementRequest.d.mts

@@ -0,0 +1,16 @@
+import type * as KardApi from "../../../../../../index.mjs";
+/**
+ * @example
+ *     {}
+ */
+export interface GetOffersByPlacementRequest {
+    /** Case-insensitive search string to filter offers by merchant name */
+    "filter[search]"?: string;
+    "filter[purchaseChannel]"?: KardApi.PurchaseChannel[];
+    "filter[category]"?: KardApi.CategoryOption;
+    "filter[isTargeted]"?: boolean;
+    /** CSV list of included resources in the response (e.g "categories"). Allowed value is `categories`. */
+    include?: string | string[];
+    /** 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/GetOffersByPlacementRequest.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,2 +1,3 @@
 export type { GetLocationsByUserRequest } from "./GetLocationsByUserRequest.mjs";
+export type { GetOffersByPlacementRequest } from "./GetOffersByPlacementRequest.mjs";
 export type { GetOffersByUserRequest } from "./GetOffersByUserRequest.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "14.1.0";
+export declare const SDK_VERSION = "14.2.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "14.1.0";
+export const SDK_VERSION = "14.2.0";

package/package.json

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

package/reference.md

@@ -2491,6 +2491,95 @@ await client.users.rewards.offers("organization-123", "user-123", {
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.users.rewards.<a href="/src/api/resources/users/resources/rewards/client/Client.ts">placementOffers</a>(organizationId, userId, placementId, { ...params }) -> KardApi.OffersResponseObject</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve offers for a placement slot. Returns offers sorted by highest cash back,
+limited by the placement's available slots.<br/>
+<b>Required scopes:</b> `rewards:read`
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.users.rewards.placementOffers("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.GetOffersByPlacementRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `RewardsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>