@kard-financial/sdk 24.1.0 → 26.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/organizations/resources/placements/client/requests/GetPlacementRequest.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/resources/placements/client/requests/ListPlacementsRequest.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationPlacementAttributes.d.ts +1 -4
- package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationPlacementData.d.ts +2 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationPlacementRelationships.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationSlotAttributes.d.ts +9 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationSlotInclusion.d.ts +9 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationSlotInclusion.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationSlotRelationships.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationSlotRelationships.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/ContentStrategyInclusion.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/ContentStrategyInclusion.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateBatchActivationAttributes.d.ts +3 -2
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateBatchActivationSlot.d.ts +4 -2
- package/dist/cjs/api/resources/organizations/resources/placements/types/IncludedResource.d.ts +19 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/IncludedResource.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/MainPagePlacementAttributes.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/MainPagePlacementData.d.ts +2 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementFormatUnion.d.ts +9 -6
- package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementListResponse.d.ts +2 -2
- package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementRelationships.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementRelationships.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementResource.d.ts +2 -2
- package/dist/cjs/api/resources/organizations/resources/placements/types/PushNotificationPlacementAttributes.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/PushNotificationPlacementData.d.ts +2 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/ResourceIdentifier.d.ts +9 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/ResourceIdentifier.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/ToManyRelationship.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/ToManyRelationship.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/ToOneRelationship.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/ToOneRelationship.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateBatchActivationAttributes.d.ts +3 -2
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateBatchActivationSlot.d.ts +5 -3
- package/dist/cjs/api/resources/organizations/resources/placements/types/index.d.ts +10 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/index.js +10 -1
- package/dist/cjs/api/resources/users/resources/rewards/types/BatchesResponseObject.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/rewards/types/{BatchSlotData.d.ts → PlacementBatchAttributes.d.ts} +4 -6
- package/dist/cjs/api/resources/users/resources/rewards/types/PlacementBatchAttributes.js +3 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/PlacementBatchData.d.ts +10 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/PlacementBatchData.js +3 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/index.d.ts +2 -1
- package/dist/cjs/api/resources/users/resources/rewards/types/index.js +2 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/organizations/resources/placements/client/requests/GetPlacementRequest.d.mts +1 -1
- package/dist/esm/api/resources/organizations/resources/placements/client/requests/ListPlacementsRequest.d.mts +1 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationPlacementAttributes.d.mts +1 -4
- package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationPlacementData.d.mts +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationPlacementRelationships.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationSlotAttributes.d.mts +9 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationSlotInclusion.d.mts +9 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationSlotInclusion.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationSlotRelationships.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationSlotRelationships.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/ContentStrategyInclusion.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/ContentStrategyInclusion.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateBatchActivationAttributes.d.mts +3 -2
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateBatchActivationSlot.d.mts +4 -2
- package/dist/esm/api/resources/organizations/resources/placements/types/IncludedResource.d.mts +19 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/IncludedResource.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/MainPagePlacementAttributes.d.mts +1 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/MainPagePlacementData.d.mts +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/PlacementFormatUnion.d.mts +9 -6
- package/dist/esm/api/resources/organizations/resources/placements/types/PlacementListResponse.d.mts +2 -2
- package/dist/esm/api/resources/organizations/resources/placements/types/PlacementRelationships.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/PlacementRelationships.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/PlacementResource.d.mts +2 -2
- package/dist/esm/api/resources/organizations/resources/placements/types/PushNotificationPlacementAttributes.d.mts +1 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/PushNotificationPlacementData.d.mts +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/ResourceIdentifier.d.mts +9 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/ResourceIdentifier.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/ToManyRelationship.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/ToManyRelationship.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/ToOneRelationship.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/ToOneRelationship.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateBatchActivationAttributes.d.mts +3 -2
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateBatchActivationSlot.d.mts +5 -3
- package/dist/esm/api/resources/organizations/resources/placements/types/index.d.mts +10 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/index.mjs +10 -1
- package/dist/esm/api/resources/users/resources/rewards/types/BatchesResponseObject.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/rewards/types/{BatchSlotData.d.mts → PlacementBatchAttributes.d.mts} +4 -6
- package/dist/esm/api/resources/users/resources/rewards/types/PlacementBatchAttributes.mjs +2 -0
- package/dist/esm/api/resources/users/resources/rewards/types/PlacementBatchData.d.mts +10 -0
- package/dist/esm/api/resources/users/resources/rewards/types/PlacementBatchData.mjs +2 -0
- package/dist/esm/api/resources/users/resources/rewards/types/index.d.mts +2 -1
- package/dist/esm/api/resources/users/resources/rewards/types/index.mjs +2 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationSlot.d.ts +0 -11
- package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationSlot.d.mts +0 -11
- /package/dist/cjs/api/resources/organizations/resources/placements/types/{BatchActivationSlot.js → BatchActivationPlacementRelationships.js} +0 -0
- /package/dist/cjs/api/resources/{users/resources/rewards/types/BatchSlotData.js → organizations/resources/placements/types/BatchActivationSlotAttributes.js} +0 -0
- /package/dist/esm/api/resources/organizations/resources/placements/types/{BatchActivationSlot.mjs → BatchActivationPlacementRelationships.mjs} +0 -0
- /package/dist/esm/api/resources/{users/resources/rewards/types/BatchSlotData.mjs → organizations/resources/placements/types/BatchActivationSlotAttributes.mjs} +0 -0
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
|
|
|
43
43
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
44
44
|
"X-Fern-Language": "JavaScript",
|
|
45
45
|
"X-Fern-SDK-Name": "@kard-financial/sdk",
|
|
46
|
-
"X-Fern-SDK-Version": "
|
|
47
|
-
"User-Agent": "@kard-financial/sdk/
|
|
46
|
+
"X-Fern-SDK-Version": "26.0.0",
|
|
47
|
+
"User-Agent": "@kard-financial/sdk/26.0.0",
|
|
48
48
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
49
49
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
50
50
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface GetPlacementRequest {
|
|
6
|
-
/** CSV list of related resources to embed in the `included` array (
|
|
6
|
+
/** CSV list of related resources to embed in the `included` array. Supported paths: `contentStrategy` (the direct content strategy of a non-batch placement), `slots` (the slot resources of a batch-activation placement), `slots.placement` (and the placement each slot references), and `slots.placement.contentStrategy` (and the content strategy of each referenced placement). Dotted paths implicitly include all intermediate resources. */
|
|
7
7
|
include?: string;
|
|
8
8
|
}
|
|
@@ -10,7 +10,7 @@ export interface ListPlacementsRequest {
|
|
|
10
10
|
"filter[name]"?: string;
|
|
11
11
|
/** Filter by the ID of the content strategy linked to the placement */
|
|
12
12
|
"filter[contentStrategyId]"?: string;
|
|
13
|
-
/** CSV list of related resources to embed in the `included` array (
|
|
13
|
+
/** CSV list of related resources to embed in the `included` array. Supported paths: `contentStrategy` (the direct content strategy of a non-batch placement), `slots` (the slot resources of a batch-activation placement), `slots.placement` (and the placement each slot references), and `slots.placement.contentStrategy` (and the content strategy of each referenced placement). Dotted paths implicitly include all intermediate resources. */
|
|
14
14
|
include?: string;
|
|
15
15
|
/** Cursor value for the next page of results */
|
|
16
16
|
"page[after]"?: string;
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import type * as KardApi from "../../../../../index.js";
|
|
2
1
|
/**
|
|
3
|
-
* Attributes for a batch-activation placement
|
|
2
|
+
* Attributes for a batch-activation placement. Slot detail is exposed via `relationships.slots` (resource identifiers) and the `batchActivationSlot` entries in `included`; request `?include=slots` (or a deeper path) to get the slot details.
|
|
4
3
|
*/
|
|
5
4
|
export interface BatchActivationPlacementAttributes {
|
|
6
5
|
/** Name of the placement */
|
|
@@ -9,6 +8,4 @@ export interface BatchActivationPlacementAttributes {
|
|
|
9
8
|
organizationId: string;
|
|
10
9
|
/** ISO-8601 duration that controls how often the activation cohort refreshes (e.g. "P7D" for weekly). */
|
|
11
10
|
refreshInterval: string;
|
|
12
|
-
/** Slots that make up the activation cohort */
|
|
13
|
-
slots: KardApi.organizations.BatchActivationSlot[];
|
|
14
11
|
}
|
|
@@ -6,4 +6,6 @@ export interface BatchActivationPlacementData {
|
|
|
6
6
|
/** Unique identifier of the placement (UUID v7) */
|
|
7
7
|
id: string;
|
|
8
8
|
attributes: KardApi.organizations.BatchActivationPlacementAttributes;
|
|
9
|
+
/** JSON:API relationships for the placement. Always present on a batch-activation placement; the `slots` to-many relationship lists the slot resource identifiers. */
|
|
10
|
+
relationships: KardApi.organizations.BatchActivationPlacementRelationships;
|
|
9
11
|
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Relationship block for a batch-activation placement.
|
|
4
|
+
*/
|
|
5
|
+
export interface BatchActivationPlacementRelationships {
|
|
6
|
+
/** Resource identifiers for the slots that make up the activation cohort. Each entry corresponds to a `batchActivationSlot` resource that appears in `included` when the request asks for `slots` (or any deeper path that implies it). */
|
|
7
|
+
slots: KardApi.organizations.ToManyRelationship;
|
|
8
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Attributes block for a `batchActivationSlot` resource.
|
|
3
|
+
*/
|
|
4
|
+
export interface BatchActivationSlotAttributes {
|
|
5
|
+
/** Customer-defined alias for the slot, unique within the placement. */
|
|
6
|
+
alias: string;
|
|
7
|
+
/** Optional short description of the slot, limited to 50 characters. */
|
|
8
|
+
shortDescription?: string | undefined;
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Slot resource as it appears in the `included` array.
|
|
4
|
+
*/
|
|
5
|
+
export interface BatchActivationSlotInclusion {
|
|
6
|
+
id: string;
|
|
7
|
+
attributes: KardApi.organizations.BatchActivationSlotAttributes;
|
|
8
|
+
relationships: KardApi.organizations.BatchActivationSlotRelationships;
|
|
9
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Relationship block for a `batchActivationSlot` resource.
|
|
4
|
+
*/
|
|
5
|
+
export interface BatchActivationSlotRelationships {
|
|
6
|
+
/** Reference to the placement that fills this slot. The referenced placement provides the slot's content strategy and offer-count cap; request `?include=slots.placement` to embed it in `included`. */
|
|
7
|
+
placement: KardApi.organizations.ToOneRelationship;
|
|
8
|
+
}
|
|
@@ -7,8 +7,9 @@ import type * as KardApi from "../../../../../index.js";
|
|
|
7
7
|
* name: "Weekly Cohort",
|
|
8
8
|
* refreshInterval: "P7D",
|
|
9
9
|
* slots: [{
|
|
10
|
-
*
|
|
11
|
-
* alias: "primary"
|
|
10
|
+
* placementId: "01961e5a-f26f-7e44-ce5f-1ad7c9fb4e67",
|
|
11
|
+
* alias: "primary",
|
|
12
|
+
* shortDescription: "Featured deals refreshed each week"
|
|
12
13
|
* }]
|
|
13
14
|
* }
|
|
14
15
|
*/
|
|
@@ -2,8 +2,10 @@
|
|
|
2
2
|
* A slot in a batch-activation placement at creation time
|
|
3
3
|
*/
|
|
4
4
|
export interface CreateBatchActivationSlot {
|
|
5
|
-
/** ID of the content strategy
|
|
6
|
-
|
|
5
|
+
/** ID of another placement that fills this slot. The referenced placement provides both the content strategy and the limit on the number of offers available to the slot. */
|
|
6
|
+
placementId: string;
|
|
7
7
|
/** Customer-defined alias for the slot, unique within the placement */
|
|
8
8
|
alias: string;
|
|
9
|
+
/** Optional short description of the slot, limited to 50 characters */
|
|
10
|
+
shortDescription?: string | undefined;
|
|
9
11
|
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Discriminated union of every resource type that can appear in the `included` array. The shape of each branch matches the corresponding primary-data resource (same attributes and relationships), keyed on the JSON:API `type` discriminant.
|
|
4
|
+
*/
|
|
5
|
+
export type IncludedResource = KardApi.organizations.IncludedResource.ContentStrategy | KardApi.organizations.IncludedResource.BatchActivationSlot | KardApi.organizations.IncludedResource.PlacementMainPage | KardApi.organizations.IncludedResource.PlacementPushNotification;
|
|
6
|
+
export declare namespace IncludedResource {
|
|
7
|
+
interface ContentStrategy extends KardApi.organizations.ContentStrategyInclusion {
|
|
8
|
+
type: "contentStrategy";
|
|
9
|
+
}
|
|
10
|
+
interface BatchActivationSlot extends KardApi.organizations.BatchActivationSlotInclusion {
|
|
11
|
+
type: "batchActivationSlot";
|
|
12
|
+
}
|
|
13
|
+
interface PlacementMainPage extends KardApi.organizations.MainPagePlacementData {
|
|
14
|
+
type: "placementMainPage";
|
|
15
|
+
}
|
|
16
|
+
interface PlacementPushNotification extends KardApi.organizations.PushNotificationPlacementData {
|
|
17
|
+
type: "placementPushNotification";
|
|
18
|
+
}
|
|
19
|
+
}
|
|
@@ -8,6 +8,6 @@ export interface MainPagePlacementAttributes {
|
|
|
8
8
|
organizationId: string;
|
|
9
9
|
/** Number of available slots */
|
|
10
10
|
availableSlots: number;
|
|
11
|
-
/** ID of the content strategy linked to this placement, if any */
|
|
11
|
+
/** ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility. */
|
|
12
12
|
contentStrategyId?: string | undefined;
|
|
13
13
|
}
|
package/dist/cjs/api/resources/organizations/resources/placements/types/MainPagePlacementData.d.ts
CHANGED
|
@@ -6,4 +6,6 @@ export interface MainPagePlacementData {
|
|
|
6
6
|
/** Unique identifier of the placement (UUID v7) */
|
|
7
7
|
id: string;
|
|
8
8
|
attributes: KardApi.organizations.MainPagePlacementAttributes;
|
|
9
|
+
/** JSON:API relationships for the placement. Omitted entirely when the placement has no linked resources. */
|
|
10
|
+
relationships?: KardApi.organizations.PlacementRelationships | undefined;
|
|
9
11
|
}
|
package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementFormatUnion.d.ts
CHANGED
|
@@ -34,12 +34,15 @@ import type * as KardApi from "../../../../../index.js";
|
|
|
34
34
|
* attributes: {
|
|
35
35
|
* name: "Weekly Cohort",
|
|
36
36
|
* organizationId: "org-123",
|
|
37
|
-
* refreshInterval: "P7D"
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
37
|
+
* refreshInterval: "P7D"
|
|
38
|
+
* },
|
|
39
|
+
* relationships: {
|
|
40
|
+
* slots: {
|
|
41
|
+
* data: [{
|
|
42
|
+
* type: "batchActivationSlot",
|
|
43
|
+
* id: "01961e5a-e15f-7d33-bd4f-09c6b8fa3d56"
|
|
44
|
+
* }]
|
|
45
|
+
* }
|
|
43
46
|
* }
|
|
44
47
|
* }
|
|
45
48
|
*/
|
package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementListResponse.d.ts
CHANGED
|
@@ -5,8 +5,8 @@ import type * as KardApi from "../../../../../index.js";
|
|
|
5
5
|
export interface PlacementListResponse {
|
|
6
6
|
/** Array of placement resources */
|
|
7
7
|
data: KardApi.organizations.PlacementFormatUnion[];
|
|
8
|
-
/** Related resources requested via the `include` query parameter.
|
|
9
|
-
included?: KardApi.organizations.
|
|
8
|
+
/** Related resources requested via the `include` query parameter. Each entry is keyed by its `type` discriminant (`contentStrategy`, `batchActivationSlot`, `placementMainPage`, `placementPushNotification`). */
|
|
9
|
+
included?: KardApi.organizations.IncludedResource[] | undefined;
|
|
10
10
|
links?: KardApi.Links | undefined;
|
|
11
11
|
/** Pagination metadata */
|
|
12
12
|
meta?: KardApi.OrganizationPaginationMetadata | undefined;
|
package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementRelationships.d.ts
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Relationship block for non-batch placements. Mirrors the `contentStrategyId` attribute so JSON:API clients can walk the graph.
|
|
4
|
+
*/
|
|
5
|
+
export interface PlacementRelationships {
|
|
6
|
+
/** Relationship to the content strategy that powers this placement. Present whenever the placement has been linked to a content strategy (`data.id` will be set). Omitted entirely when no content strategy is linked. */
|
|
7
|
+
contentStrategy?: KardApi.organizations.ToOneRelationship | undefined;
|
|
8
|
+
}
|
package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementResource.d.ts
CHANGED
|
@@ -5,6 +5,6 @@ import type * as KardApi from "../../../../../index.js";
|
|
|
5
5
|
export interface PlacementResource {
|
|
6
6
|
/** Placement resource */
|
|
7
7
|
data: KardApi.organizations.PlacementFormatUnion;
|
|
8
|
-
/** Related resources requested via the `include` query parameter.
|
|
9
|
-
included?: KardApi.organizations.
|
|
8
|
+
/** Related resources requested via the `include` query parameter. Each entry is keyed by its `type` discriminant (`contentStrategy`, `batchActivationSlot`, `placementMainPage`, `placementPushNotification`). */
|
|
9
|
+
included?: KardApi.organizations.IncludedResource[] | undefined;
|
|
10
10
|
}
|
|
@@ -9,6 +9,6 @@ export interface PushNotificationPlacementAttributes {
|
|
|
9
9
|
organizationId: string;
|
|
10
10
|
/** Delivery cadence for the notification */
|
|
11
11
|
cadence: KardApi.organizations.Cadence;
|
|
12
|
-
/** ID of the content strategy linked to this placement, if any */
|
|
12
|
+
/** ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility. */
|
|
13
13
|
contentStrategyId?: string | undefined;
|
|
14
14
|
}
|
|
@@ -6,4 +6,6 @@ export interface PushNotificationPlacementData {
|
|
|
6
6
|
/** Unique identifier of the placement (UUID v7) */
|
|
7
7
|
id: string;
|
|
8
8
|
attributes: KardApi.organizations.PushNotificationPlacementAttributes;
|
|
9
|
+
/** JSON:API relationships for the placement. Omitted entirely when the placement has no linked resources. */
|
|
10
|
+
relationships?: KardApi.organizations.PlacementRelationships | undefined;
|
|
9
11
|
}
|
package/dist/cjs/api/resources/organizations/resources/placements/types/ToOneRelationship.d.ts
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* A JSON:API to-one relationship payload.
|
|
4
|
+
*/
|
|
5
|
+
export interface ToOneRelationship {
|
|
6
|
+
/** The linked resource identifier, or null when the relationship is present but unlinked. */
|
|
7
|
+
data?: KardApi.organizations.ResourceIdentifier | undefined;
|
|
8
|
+
}
|
|
@@ -8,8 +8,9 @@ import type * as KardApi from "../../../../../index.js";
|
|
|
8
8
|
* refreshInterval: "P14D",
|
|
9
9
|
* slots: [{
|
|
10
10
|
* slotId: "01961e5a-e15f-7d33-bd4f-09c6b8fa3d56",
|
|
11
|
-
*
|
|
12
|
-
* alias: "primary"
|
|
11
|
+
* placementId: "01961e5a-f26f-7e44-ce5f-1ad7c9fb4e67",
|
|
12
|
+
* alias: "primary",
|
|
13
|
+
* shortDescription: "Featured deals refreshed each week"
|
|
13
14
|
* }]
|
|
14
15
|
* }
|
|
15
16
|
*/
|
|
@@ -2,10 +2,12 @@
|
|
|
2
2
|
* A slot in a batch-activation placement at update time
|
|
3
3
|
*/
|
|
4
4
|
export interface UpdateBatchActivationSlot {
|
|
5
|
-
/** Existing slot identifier. Echo the value from a prior GET to keep the slot stable; omit to mint a fresh slot. If the
|
|
5
|
+
/** Existing slot identifier. Echo the value from a prior GET to keep the slot stable; omit to mint a fresh slot. If the placementId changes, the slotId is regenerated regardless of what was echoed. */
|
|
6
6
|
slotId?: string | undefined;
|
|
7
|
-
/** ID of the content strategy
|
|
8
|
-
|
|
7
|
+
/** ID of another placement that fills this slot. The referenced placement provides both the content strategy and the limit on the number of offers available to the slot. */
|
|
8
|
+
placementId: string;
|
|
9
9
|
/** Customer-defined alias for the slot, unique within the placement */
|
|
10
10
|
alias: string;
|
|
11
|
+
/** Optional short description of the slot, limited to 50 characters */
|
|
12
|
+
shortDescription?: string | undefined;
|
|
11
13
|
}
|
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
export * from "./BatchActivationPlacementAttributes.js";
|
|
2
2
|
export * from "./BatchActivationPlacementData.js";
|
|
3
|
-
export * from "./
|
|
3
|
+
export * from "./BatchActivationPlacementRelationships.js";
|
|
4
|
+
export * from "./BatchActivationSlotAttributes.js";
|
|
5
|
+
export * from "./BatchActivationSlotInclusion.js";
|
|
6
|
+
export * from "./BatchActivationSlotRelationships.js";
|
|
4
7
|
export * from "./Cadence.js";
|
|
5
8
|
export * from "./CadenceFrequency.js";
|
|
9
|
+
export * from "./ContentStrategyInclusion.js";
|
|
6
10
|
export * from "./CreateBatchActivationAttributes.js";
|
|
7
11
|
export * from "./CreateBatchActivationPlacementData.js";
|
|
8
12
|
export * from "./CreateBatchActivationSlot.js";
|
|
@@ -13,14 +17,19 @@ export * from "./CreatePlacementRequestBody.js";
|
|
|
13
17
|
export * from "./CreatePushNotificationAttributes.js";
|
|
14
18
|
export * from "./CreatePushNotificationPlacementData.js";
|
|
15
19
|
export * from "./DayOfWeek.js";
|
|
20
|
+
export * from "./IncludedResource.js";
|
|
16
21
|
export * from "./MainPagePlacementAttributes.js";
|
|
17
22
|
export * from "./MainPagePlacementData.js";
|
|
18
23
|
export * from "./PlacementFormatUnion.js";
|
|
19
24
|
export * from "./PlacementListResponse.js";
|
|
25
|
+
export * from "./PlacementRelationships.js";
|
|
20
26
|
export * from "./PlacementResource.js";
|
|
21
27
|
export * from "./PlacementTypeFilter.js";
|
|
22
28
|
export * from "./PushNotificationPlacementAttributes.js";
|
|
23
29
|
export * from "./PushNotificationPlacementData.js";
|
|
30
|
+
export * from "./ResourceIdentifier.js";
|
|
31
|
+
export * from "./ToManyRelationship.js";
|
|
32
|
+
export * from "./ToOneRelationship.js";
|
|
24
33
|
export * from "./UpdateBatchActivationAttributes.js";
|
|
25
34
|
export * from "./UpdateBatchActivationPlacementData.js";
|
|
26
35
|
export * from "./UpdateBatchActivationSlot.js";
|
|
@@ -16,9 +16,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./BatchActivationPlacementAttributes.js"), exports);
|
|
18
18
|
__exportStar(require("./BatchActivationPlacementData.js"), exports);
|
|
19
|
-
__exportStar(require("./
|
|
19
|
+
__exportStar(require("./BatchActivationPlacementRelationships.js"), exports);
|
|
20
|
+
__exportStar(require("./BatchActivationSlotAttributes.js"), exports);
|
|
21
|
+
__exportStar(require("./BatchActivationSlotInclusion.js"), exports);
|
|
22
|
+
__exportStar(require("./BatchActivationSlotRelationships.js"), exports);
|
|
20
23
|
__exportStar(require("./Cadence.js"), exports);
|
|
21
24
|
__exportStar(require("./CadenceFrequency.js"), exports);
|
|
25
|
+
__exportStar(require("./ContentStrategyInclusion.js"), exports);
|
|
22
26
|
__exportStar(require("./CreateBatchActivationAttributes.js"), exports);
|
|
23
27
|
__exportStar(require("./CreateBatchActivationPlacementData.js"), exports);
|
|
24
28
|
__exportStar(require("./CreateBatchActivationSlot.js"), exports);
|
|
@@ -29,14 +33,19 @@ __exportStar(require("./CreatePlacementRequestBody.js"), exports);
|
|
|
29
33
|
__exportStar(require("./CreatePushNotificationAttributes.js"), exports);
|
|
30
34
|
__exportStar(require("./CreatePushNotificationPlacementData.js"), exports);
|
|
31
35
|
__exportStar(require("./DayOfWeek.js"), exports);
|
|
36
|
+
__exportStar(require("./IncludedResource.js"), exports);
|
|
32
37
|
__exportStar(require("./MainPagePlacementAttributes.js"), exports);
|
|
33
38
|
__exportStar(require("./MainPagePlacementData.js"), exports);
|
|
34
39
|
__exportStar(require("./PlacementFormatUnion.js"), exports);
|
|
35
40
|
__exportStar(require("./PlacementListResponse.js"), exports);
|
|
41
|
+
__exportStar(require("./PlacementRelationships.js"), exports);
|
|
36
42
|
__exportStar(require("./PlacementResource.js"), exports);
|
|
37
43
|
__exportStar(require("./PlacementTypeFilter.js"), exports);
|
|
38
44
|
__exportStar(require("./PushNotificationPlacementAttributes.js"), exports);
|
|
39
45
|
__exportStar(require("./PushNotificationPlacementData.js"), exports);
|
|
46
|
+
__exportStar(require("./ResourceIdentifier.js"), exports);
|
|
47
|
+
__exportStar(require("./ToManyRelationship.js"), exports);
|
|
48
|
+
__exportStar(require("./ToOneRelationship.js"), exports);
|
|
40
49
|
__exportStar(require("./UpdateBatchActivationAttributes.js"), exports);
|
|
41
50
|
__exportStar(require("./UpdateBatchActivationPlacementData.js"), exports);
|
|
42
51
|
__exportStar(require("./UpdateBatchActivationSlot.js"), exports);
|
|
@@ -3,5 +3,5 @@ import type * as KardApi from "../../../../../index.js";
|
|
|
3
3
|
* Ordered list of slots for a batch-activation placement, with freshness fields and per-slot offer sets.
|
|
4
4
|
*/
|
|
5
5
|
export interface BatchesResponseObject {
|
|
6
|
-
data: KardApi.users.
|
|
6
|
+
data: KardApi.users.PlacementBatchData[];
|
|
7
7
|
}
|
|
@@ -1,12 +1,10 @@
|
|
|
1
1
|
import type * as KardApi from "../../../../../index.js";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Attributes of a placement batch slot.
|
|
4
4
|
*/
|
|
5
|
-
export interface
|
|
6
|
-
/**
|
|
7
|
-
|
|
8
|
-
/** Customer-defined alias for the slot, unique within the placement */
|
|
9
|
-
alias: string;
|
|
5
|
+
export interface PlacementBatchAttributes {
|
|
6
|
+
/** Display name for the slot. Falls back to the slot's customer-defined alias, or — when the alias is absent — the name of the placement referenced by the slot. */
|
|
7
|
+
name: string;
|
|
10
8
|
/** 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. */
|
|
11
9
|
isActive: boolean;
|
|
12
10
|
/** Timestamp of the most recent placementSlotAttribution ACTIVATE event for this (user, placement, slot). Absent for cold slots that have never been activated. */
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* One slot in a batch-activation placement, with freshness fields and the offers that resolve under the slot's content strategy.
|
|
4
|
+
*/
|
|
5
|
+
export interface PlacementBatchData {
|
|
6
|
+
/** Stable identifier for the slot within the placement */
|
|
7
|
+
id: string;
|
|
8
|
+
type: "placementBatch";
|
|
9
|
+
attributes: KardApi.users.PlacementBatchAttributes;
|
|
10
|
+
}
|
|
@@ -2,7 +2,6 @@ export * from "./Amount.js";
|
|
|
2
2
|
export * from "./AmountType.js";
|
|
3
3
|
export * from "./Asset.js";
|
|
4
4
|
export * from "./BatchesResponseObject.js";
|
|
5
|
-
export * from "./BatchSlotData.js";
|
|
6
5
|
export * from "./ButtonStyle.js";
|
|
7
6
|
export * from "./CategoryData.js";
|
|
8
7
|
export * from "./CategoryFields.js";
|
|
@@ -40,6 +39,8 @@ export * from "./OffersResponseObject.js";
|
|
|
40
39
|
export * from "./OperationHours.js";
|
|
41
40
|
export * from "./OperationPeriod.js";
|
|
42
41
|
export * from "./OperationTime.js";
|
|
42
|
+
export * from "./PlacementBatchAttributes.js";
|
|
43
|
+
export * from "./PlacementBatchData.js";
|
|
43
44
|
export * from "./ProgressBar.js";
|
|
44
45
|
export * from "./ProgressBarLabelPair.js";
|
|
45
46
|
export * from "./ProgressBarLabels.js";
|
|
@@ -18,7 +18,6 @@ __exportStar(require("./Amount.js"), exports);
|
|
|
18
18
|
__exportStar(require("./AmountType.js"), exports);
|
|
19
19
|
__exportStar(require("./Asset.js"), exports);
|
|
20
20
|
__exportStar(require("./BatchesResponseObject.js"), exports);
|
|
21
|
-
__exportStar(require("./BatchSlotData.js"), exports);
|
|
22
21
|
__exportStar(require("./ButtonStyle.js"), exports);
|
|
23
22
|
__exportStar(require("./CategoryData.js"), exports);
|
|
24
23
|
__exportStar(require("./CategoryFields.js"), exports);
|
|
@@ -56,6 +55,8 @@ __exportStar(require("./OffersResponseObject.js"), exports);
|
|
|
56
55
|
__exportStar(require("./OperationHours.js"), exports);
|
|
57
56
|
__exportStar(require("./OperationPeriod.js"), exports);
|
|
58
57
|
__exportStar(require("./OperationTime.js"), exports);
|
|
58
|
+
__exportStar(require("./PlacementBatchAttributes.js"), exports);
|
|
59
|
+
__exportStar(require("./PlacementBatchData.js"), exports);
|
|
59
60
|
__exportStar(require("./ProgressBar.js"), exports);
|
|
60
61
|
__exportStar(require("./ProgressBarLabelPair.js"), exports);
|
|
61
62
|
__exportStar(require("./ProgressBarLabels.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "
|
|
1
|
+
export declare const SDK_VERSION = "26.0.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "@kard-financial/sdk",
|
|
9
|
-
"X-Fern-SDK-Version": "
|
|
10
|
-
"User-Agent": "@kard-financial/sdk/
|
|
9
|
+
"X-Fern-SDK-Version": "26.0.0",
|
|
10
|
+
"User-Agent": "@kard-financial/sdk/26.0.0",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface GetPlacementRequest {
|
|
6
|
-
/** CSV list of related resources to embed in the `included` array (
|
|
6
|
+
/** CSV list of related resources to embed in the `included` array. Supported paths: `contentStrategy` (the direct content strategy of a non-batch placement), `slots` (the slot resources of a batch-activation placement), `slots.placement` (and the placement each slot references), and `slots.placement.contentStrategy` (and the content strategy of each referenced placement). Dotted paths implicitly include all intermediate resources. */
|
|
7
7
|
include?: string;
|
|
8
8
|
}
|
|
@@ -10,7 +10,7 @@ export interface ListPlacementsRequest {
|
|
|
10
10
|
"filter[name]"?: string;
|
|
11
11
|
/** Filter by the ID of the content strategy linked to the placement */
|
|
12
12
|
"filter[contentStrategyId]"?: string;
|
|
13
|
-
/** CSV list of related resources to embed in the `included` array (
|
|
13
|
+
/** CSV list of related resources to embed in the `included` array. Supported paths: `contentStrategy` (the direct content strategy of a non-batch placement), `slots` (the slot resources of a batch-activation placement), `slots.placement` (and the placement each slot references), and `slots.placement.contentStrategy` (and the content strategy of each referenced placement). Dotted paths implicitly include all intermediate resources. */
|
|
14
14
|
include?: string;
|
|
15
15
|
/** Cursor value for the next page of results */
|
|
16
16
|
"page[after]"?: string;
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import type * as KardApi from "../../../../../index.mjs";
|
|
2
1
|
/**
|
|
3
|
-
* Attributes for a batch-activation placement
|
|
2
|
+
* Attributes for a batch-activation placement. Slot detail is exposed via `relationships.slots` (resource identifiers) and the `batchActivationSlot` entries in `included`; request `?include=slots` (or a deeper path) to get the slot details.
|
|
4
3
|
*/
|
|
5
4
|
export interface BatchActivationPlacementAttributes {
|
|
6
5
|
/** Name of the placement */
|
|
@@ -9,6 +8,4 @@ export interface BatchActivationPlacementAttributes {
|
|
|
9
8
|
organizationId: string;
|
|
10
9
|
/** ISO-8601 duration that controls how often the activation cohort refreshes (e.g. "P7D" for weekly). */
|
|
11
10
|
refreshInterval: string;
|
|
12
|
-
/** Slots that make up the activation cohort */
|
|
13
|
-
slots: KardApi.organizations.BatchActivationSlot[];
|
|
14
11
|
}
|
|
@@ -6,4 +6,6 @@ export interface BatchActivationPlacementData {
|
|
|
6
6
|
/** Unique identifier of the placement (UUID v7) */
|
|
7
7
|
id: string;
|
|
8
8
|
attributes: KardApi.organizations.BatchActivationPlacementAttributes;
|
|
9
|
+
/** JSON:API relationships for the placement. Always present on a batch-activation placement; the `slots` to-many relationship lists the slot resource identifiers. */
|
|
10
|
+
relationships: KardApi.organizations.BatchActivationPlacementRelationships;
|
|
9
11
|
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Relationship block for a batch-activation placement.
|
|
4
|
+
*/
|
|
5
|
+
export interface BatchActivationPlacementRelationships {
|
|
6
|
+
/** Resource identifiers for the slots that make up the activation cohort. Each entry corresponds to a `batchActivationSlot` resource that appears in `included` when the request asks for `slots` (or any deeper path that implies it). */
|
|
7
|
+
slots: KardApi.organizations.ToManyRelationship;
|
|
8
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Attributes block for a `batchActivationSlot` resource.
|
|
3
|
+
*/
|
|
4
|
+
export interface BatchActivationSlotAttributes {
|
|
5
|
+
/** Customer-defined alias for the slot, unique within the placement. */
|
|
6
|
+
alias: string;
|
|
7
|
+
/** Optional short description of the slot, limited to 50 characters. */
|
|
8
|
+
shortDescription?: string | undefined;
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Slot resource as it appears in the `included` array.
|
|
4
|
+
*/
|
|
5
|
+
export interface BatchActivationSlotInclusion {
|
|
6
|
+
id: string;
|
|
7
|
+
attributes: KardApi.organizations.BatchActivationSlotAttributes;
|
|
8
|
+
relationships: KardApi.organizations.BatchActivationSlotRelationships;
|
|
9
|
+
}
|