@kard-financial/sdk 19.0.0 → 20.0.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": "19.0.0",
-        "User-Agent": "@kard-financial/sdk/19.0.0",
+        "X-Fern-SDK-Version": "20.0.0",
+        "User-Agent": "@kard-financial/sdk/20.0.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/api/resources/organizations/resources/placements/client/Client.d.ts

@@ -73,6 +73,7 @@ export declare class PlacementsClient {
      *
      * @param {string} organizationId - Unique identifier of the organization
      * @param {string} placementId - Unique identifier of the placement (UUID v7)
+     * @param {KardApi.organizations.GetPlacementRequest} request
      * @param {PlacementsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link KardApi.UnauthorizedError}
@@ -83,7 +84,7 @@ export declare class PlacementsClient {
      * @example
      *     await client.organizations.placements.get("organizationId", "placementId")
      */
-    get(organizationId: string, placementId: string, requestOptions?: PlacementsClient.RequestOptions): core.HttpResponsePromise<KardApi.organizations.PlacementFormatUnion>;
+    get(organizationId: string, placementId: string, request?: KardApi.organizations.GetPlacementRequest, requestOptions?: PlacementsClient.RequestOptions): core.HttpResponsePromise<KardApi.organizations.PlacementResource>;
     private __get;
     /**
      * Replace a placement. All fields must be provided. Use type "placementMainPage" or "placementPushNotification" to set the placement kind. If the type is "placementPushNotification", availableSlots is automatically set to 1.

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

@@ -166,11 +166,12 @@ class PlacementsClient {
     __list(organizationId_1) {
         return __awaiter(this, arguments, void 0, function* (organizationId, request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { "filter[type]": filterType, "filter[name]": filterName, "filter[contentStrategyId]": filterContentStrategyId, "page[after]": pageAfter, "page[size]": pageSize, } = request;
+            const { "filter[type]": filterType, "filter[name]": filterName, "filter[contentStrategyId]": filterContentStrategyId, include, "page[after]": pageAfter, "page[size]": pageSize, } = request;
             const _queryParams = {
                 "filter[type]": filterType != null ? filterType : undefined,
                 "filter[name]": filterName,
                 "filter[contentStrategyId]": filterContentStrategyId,
+                include,
                 "page[after]": pageAfter,
                 "page[size]": pageSize,
             };
@@ -221,6 +222,7 @@ class PlacementsClient {
      *
      * @param {string} organizationId - Unique identifier of the organization
      * @param {string} placementId - Unique identifier of the placement (UUID v7)
+     * @param {KardApi.organizations.GetPlacementRequest} request
      * @param {PlacementsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link KardApi.UnauthorizedError}
@@ -231,19 +233,23 @@ class PlacementsClient {
      * @example
      *     await client.organizations.placements.get("organizationId", "placementId")
      */
-    get(organizationId, placementId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__get(organizationId, placementId, requestOptions));
+    get(organizationId, placementId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__get(organizationId, placementId, request, requestOptions));
     }
-    __get(organizationId, placementId, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
+    __get(organizationId_1, placementId_1) {
+        return __awaiter(this, arguments, void 0, function* (organizationId, placementId, request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { include } = request;
+            const _queryParams = {
+                include,
+            };
             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)}/placements/${core.url.encodePathParam(placementId)}`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                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,

package/dist/cjs/api/resources/organizations/resources/placements/client/requests/GetPlacementRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @example
+ *     {}
+ */
+export interface GetPlacementRequest {
+    /** CSV list of related resources to embed in the `included` array (allowed value is `contentStrategy`). */
+    include?: string;
+}

package/dist/cjs/api/resources/organizations/resources/placements/client/requests/GetPlacementRequest.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/organizations/resources/placements/client/requests/ListPlacementsRequest.d.ts

@@ -10,6 +10,8 @@ export interface ListPlacementsRequest {
     "filter[name]"?: string;
     /** Filter by the ID of the content strategy linked to the placement */
     "filter[contentStrategyId]"?: string;
+    /** CSV list of related resources to embed in the `included` array (allowed value is `contentStrategy`). */
+    include?: string;
     /** Cursor value for the next page of results */
     "page[after]"?: string;
     /** Maximum number of records to return [1 - 200] (default = 200) */

package/dist/cjs/api/resources/organizations/resources/placements/client/requests/index.d.ts

@@ -1 +1,2 @@
+export type { GetPlacementRequest } from "./GetPlacementRequest.js";
 export type { ListPlacementsRequest } from "./ListPlacementsRequest.js";

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

@@ -5,6 +5,8 @@ import type * as KardApi from "../../../../../index.js";
 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;
     links?: KardApi.Links | undefined;
     /** Pagination metadata */
     meta?: KardApi.OrganizationPaginationMetadata | undefined;

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

@@ -0,0 +1,10 @@
+import type * as KardApi from "../../../../../index.js";
+/**
+ * Single placement document, optionally with embedded related resources
+ */
+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;
+}

package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementResource.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/organizations/resources/placements/types/index.d.ts

@@ -11,6 +11,7 @@ export * from "./MainPagePlacementAttributes.js";
 export * from "./MainPagePlacementData.js";
 export * from "./PlacementFormatUnion.js";
 export * from "./PlacementListResponse.js";
+export * from "./PlacementResource.js";
 export * from "./PlacementTypeFilter.js";
 export * from "./PushNotificationPlacementAttributes.js";
 export * from "./PushNotificationPlacementData.js";

package/dist/cjs/api/resources/organizations/resources/placements/types/index.js

@@ -27,6 +27,7 @@ __exportStar(require("./MainPagePlacementAttributes.js"), exports);
 __exportStar(require("./MainPagePlacementData.js"), exports);
 __exportStar(require("./PlacementFormatUnion.js"), exports);
 __exportStar(require("./PlacementListResponse.js"), exports);
+__exportStar(require("./PlacementResource.js"), exports);
 __exportStar(require("./PlacementTypeFilter.js"), exports);
 __exportStar(require("./PushNotificationPlacementAttributes.js"), exports);
 __exportStar(require("./PushNotificationPlacementData.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "19.0.0";
+export declare const SDK_VERSION = "20.0.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 = "19.0.0";
+exports.SDK_VERSION = "20.0.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": "19.0.0",
-        "User-Agent": "@kard-financial/sdk/19.0.0",
+        "X-Fern-SDK-Version": "20.0.0",
+        "User-Agent": "@kard-financial/sdk/20.0.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/esm/api/resources/organizations/resources/placements/client/Client.d.mts

@@ -73,6 +73,7 @@ export declare class PlacementsClient {
      *
      * @param {string} organizationId - Unique identifier of the organization
      * @param {string} placementId - Unique identifier of the placement (UUID v7)
+     * @param {KardApi.organizations.GetPlacementRequest} request
      * @param {PlacementsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link KardApi.UnauthorizedError}
@@ -83,7 +84,7 @@ export declare class PlacementsClient {
      * @example
      *     await client.organizations.placements.get("organizationId", "placementId")
      */
-    get(organizationId: string, placementId: string, requestOptions?: PlacementsClient.RequestOptions): core.HttpResponsePromise<KardApi.organizations.PlacementFormatUnion>;
+    get(organizationId: string, placementId: string, request?: KardApi.organizations.GetPlacementRequest, requestOptions?: PlacementsClient.RequestOptions): core.HttpResponsePromise<KardApi.organizations.PlacementResource>;
     private __get;
     /**
      * Replace a placement. All fields must be provided. Use type "placementMainPage" or "placementPushNotification" to set the placement kind. If the type is "placementPushNotification", availableSlots is automatically set to 1.

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

@@ -130,11 +130,12 @@ export class PlacementsClient {
     __list(organizationId_1) {
         return __awaiter(this, arguments, void 0, function* (organizationId, request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { "filter[type]": filterType, "filter[name]": filterName, "filter[contentStrategyId]": filterContentStrategyId, "page[after]": pageAfter, "page[size]": pageSize, } = request;
+            const { "filter[type]": filterType, "filter[name]": filterName, "filter[contentStrategyId]": filterContentStrategyId, include, "page[after]": pageAfter, "page[size]": pageSize, } = request;
             const _queryParams = {
                 "filter[type]": filterType != null ? filterType : undefined,
                 "filter[name]": filterName,
                 "filter[contentStrategyId]": filterContentStrategyId,
+                include,
                 "page[after]": pageAfter,
                 "page[size]": pageSize,
             };
@@ -185,6 +186,7 @@ export class PlacementsClient {
      *
      * @param {string} organizationId - Unique identifier of the organization
      * @param {string} placementId - Unique identifier of the placement (UUID v7)
+     * @param {KardApi.organizations.GetPlacementRequest} request
      * @param {PlacementsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link KardApi.UnauthorizedError}
@@ -195,19 +197,23 @@ export class PlacementsClient {
      * @example
      *     await client.organizations.placements.get("organizationId", "placementId")
      */
-    get(organizationId, placementId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__get(organizationId, placementId, requestOptions));
+    get(organizationId, placementId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__get(organizationId, placementId, request, requestOptions));
     }
-    __get(organizationId, placementId, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
+    __get(organizationId_1, placementId_1) {
+        return __awaiter(this, arguments, void 0, function* (organizationId, placementId, request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { include } = request;
+            const _queryParams = {
+                include,
+            };
             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)}/placements/${core.url.encodePathParam(placementId)}`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                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,

package/dist/esm/api/resources/organizations/resources/placements/client/requests/GetPlacementRequest.d.mts

@@ -0,0 +1,8 @@
+/**
+ * @example
+ *     {}
+ */
+export interface GetPlacementRequest {
+    /** CSV list of related resources to embed in the `included` array (allowed value is `contentStrategy`). */
+    include?: string;
+}

package/dist/esm/api/resources/organizations/resources/placements/client/requests/GetPlacementRequest.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/client/requests/ListPlacementsRequest.d.mts

@@ -10,6 +10,8 @@ export interface ListPlacementsRequest {
     "filter[name]"?: string;
     /** Filter by the ID of the content strategy linked to the placement */
     "filter[contentStrategyId]"?: string;
+    /** CSV list of related resources to embed in the `included` array (allowed value is `contentStrategy`). */
+    include?: string;
     /** Cursor value for the next page of results */
     "page[after]"?: string;
     /** Maximum number of records to return [1 - 200] (default = 200) */

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

@@ -1 +1,2 @@
+export type { GetPlacementRequest } from "./GetPlacementRequest.mjs";
 export type { ListPlacementsRequest } from "./ListPlacementsRequest.mjs";

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

@@ -5,6 +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;
     links?: KardApi.Links | undefined;
     /** Pagination metadata */
     meta?: KardApi.OrganizationPaginationMetadata | undefined;

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

@@ -0,0 +1,10 @@
+import type * as KardApi from "../../../../../index.mjs";
+/**
+ * Single placement document, optionally with embedded related resources
+ */
+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;
+}

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

@@ -11,6 +11,7 @@ export * from "./MainPagePlacementAttributes.mjs";
 export * from "./MainPagePlacementData.mjs";
 export * from "./PlacementFormatUnion.mjs";
 export * from "./PlacementListResponse.mjs";
+export * from "./PlacementResource.mjs";
 export * from "./PlacementTypeFilter.mjs";
 export * from "./PushNotificationPlacementAttributes.mjs";
 export * from "./PushNotificationPlacementData.mjs";

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

@@ -11,6 +11,7 @@ export * from "./MainPagePlacementAttributes.mjs";
 export * from "./MainPagePlacementData.mjs";
 export * from "./PlacementFormatUnion.mjs";
 export * from "./PlacementListResponse.mjs";
+export * from "./PlacementResource.mjs";
 export * from "./PlacementTypeFilter.mjs";
 export * from "./PushNotificationPlacementAttributes.mjs";
 export * from "./PushNotificationPlacementData.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "19.0.0";
+export declare const SDK_VERSION = "20.0.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "19.0.0";
+export const SDK_VERSION = "20.0.0";

package/package.json

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

package/reference.md

@@ -1344,7 +1344,7 @@ await client.organizations.placements.list("organizationId");
 </dl>
 </details>
 
-<details><summary><code>client.organizations.placements.<a href="/src/api/resources/organizations/resources/placements/client/Client.ts">get</a>(organizationId, placementId) -> KardApi.PlacementFormatUnion</code></summary>
+<details><summary><code>client.organizations.placements.<a href="/src/api/resources/organizations/resources/placements/client/Client.ts">get</a>(organizationId, placementId, { ...params }) -> KardApi.PlacementResource</code></summary>
 <dl>
 <dd>
 
@@ -1403,6 +1403,14 @@ await client.organizations.placements.get("organizationId", "placementId");
 <dl>
 <dd>
 
+**request:** `KardApi.organizations.GetPlacementRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `PlacementsClient.RequestOptions` 
     
 </dd>