@kard-financial/sdk 28.2.0 → 29.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.
Files changed (142) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/organizations/resources/placements/client/Client.d.ts +51 -4
  3. package/dist/cjs/api/resources/organizations/resources/placements/client/Client.js +51 -4
  4. package/dist/cjs/api/resources/organizations/resources/placements/client/requests/GetPlacementRequest.d.ts +1 -1
  5. package/dist/cjs/api/resources/organizations/resources/placements/client/requests/ListPlacementsRequest.d.ts +2 -2
  6. package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationPlacementData.d.ts +1 -1
  7. package/dist/cjs/api/resources/organizations/resources/placements/types/Cadence.d.ts +1 -1
  8. package/dist/cjs/api/resources/organizations/resources/placements/types/CadenceFrequency.d.ts +1 -1
  9. package/dist/cjs/api/resources/organizations/resources/placements/types/CadenceFrequency.js +1 -1
  10. package/dist/cjs/api/resources/organizations/resources/placements/types/CreateBatchActivationSlot.d.ts +1 -1
  11. package/dist/cjs/api/resources/organizations/resources/placements/types/CreateEmailAttributes.d.ts +25 -0
  12. package/dist/cjs/api/resources/organizations/resources/placements/types/CreateEmailPlacementData.d.ts +8 -0
  13. package/dist/cjs/api/resources/organizations/resources/placements/types/CreateGroupAttributes.d.ts +20 -0
  14. package/dist/cjs/api/resources/organizations/resources/placements/types/CreateGroupPlacementData.d.ts +8 -0
  15. package/dist/cjs/api/resources/organizations/resources/placements/types/CreatePlacementDataUnion.d.ts +9 -3
  16. package/dist/cjs/api/resources/organizations/resources/placements/types/CreatePlacementRequestBody.d.ts +48 -1
  17. package/dist/{esm/api/resources/organizations/resources/placements/types/CreateMainPageAttributes.d.mts → cjs/api/resources/organizations/resources/placements/types/CreateStandardAttributes.d.ts} +2 -2
  18. package/dist/cjs/api/resources/organizations/resources/placements/types/CreateStandardPlacementData.d.ts +8 -0
  19. package/dist/cjs/api/resources/organizations/resources/placements/types/EmailPlacementAttributes.d.ts +16 -0
  20. package/dist/cjs/api/resources/organizations/resources/placements/types/{MainPagePlacementData.d.ts → EmailPlacementData.d.ts} +3 -3
  21. package/dist/cjs/api/resources/organizations/resources/placements/types/EmailPlacementData.js +3 -0
  22. package/dist/cjs/api/resources/organizations/resources/placements/types/GroupPlacementAttributes.d.ts +9 -0
  23. package/dist/cjs/api/resources/organizations/resources/placements/types/GroupPlacementAttributes.js +3 -0
  24. package/dist/cjs/api/resources/organizations/resources/placements/types/GroupPlacementData.d.ts +11 -0
  25. package/dist/cjs/api/resources/organizations/resources/placements/types/GroupPlacementData.js +3 -0
  26. package/dist/cjs/api/resources/organizations/resources/placements/types/IncludedResource.d.ts +6 -3
  27. package/dist/{esm/api/resources/organizations/resources/placements/types/MainPagePlacementAttributes.d.mts → cjs/api/resources/organizations/resources/placements/types/PlacementAttributes.d.ts} +2 -2
  28. package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementAttributes.js +3 -0
  29. package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementData.d.ts +11 -0
  30. package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementData.js +3 -0
  31. package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementFormatUnion.d.ts +44 -4
  32. package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementListResponse.d.ts +1 -1
  33. package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementResource.d.ts +1 -1
  34. package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementTypeFilter.d.ts +3 -1
  35. package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementTypeFilter.js +3 -1
  36. package/dist/cjs/api/resources/organizations/resources/placements/types/SlottedPlacementRelationships.d.ts +8 -0
  37. package/dist/cjs/api/resources/organizations/resources/placements/types/SlottedPlacementRelationships.js +3 -0
  38. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateBatchActivationSlot.d.ts +1 -1
  39. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateEmailAttributes.d.ts +25 -0
  40. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateEmailAttributes.js +3 -0
  41. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateEmailPlacementData.d.ts +8 -0
  42. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateEmailPlacementData.js +3 -0
  43. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateGroupAttributes.d.ts +21 -0
  44. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateGroupAttributes.js +3 -0
  45. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateGroupPlacementData.d.ts +8 -0
  46. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateGroupPlacementData.js +3 -0
  47. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdatePlacementDataUnion.d.ts +9 -3
  48. package/dist/cjs/api/resources/organizations/resources/placements/types/{UpdateMainPageAttributes.d.ts → UpdateStandardAttributes.d.ts} +2 -2
  49. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateStandardAttributes.js +3 -0
  50. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateStandardPlacementData.d.ts +8 -0
  51. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateStandardPlacementData.js +3 -0
  52. package/dist/cjs/api/resources/organizations/resources/placements/types/index.d.ts +19 -7
  53. package/dist/cjs/api/resources/organizations/resources/placements/types/index.js +19 -7
  54. package/dist/cjs/api/resources/users/resources/rewards/client/Client.d.ts +12 -8
  55. package/dist/cjs/api/resources/users/resources/rewards/client/Client.js +12 -8
  56. package/dist/cjs/api/resources/users/resources/rewards/types/BatchesResponseObject.d.ts +1 -1
  57. package/dist/cjs/api/resources/users/resources/rewards/types/PlacementBatchAttributes.d.ts +2 -2
  58. package/dist/cjs/api/resources/users/resources/rewards/types/PlacementBatchData.d.ts +1 -1
  59. package/dist/cjs/version.d.ts +1 -1
  60. package/dist/cjs/version.js +1 -1
  61. package/dist/esm/BaseClient.mjs +2 -2
  62. package/dist/esm/api/resources/organizations/resources/placements/client/Client.d.mts +51 -4
  63. package/dist/esm/api/resources/organizations/resources/placements/client/Client.mjs +51 -4
  64. package/dist/esm/api/resources/organizations/resources/placements/client/requests/GetPlacementRequest.d.mts +1 -1
  65. package/dist/esm/api/resources/organizations/resources/placements/client/requests/ListPlacementsRequest.d.mts +2 -2
  66. package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationPlacementData.d.mts +1 -1
  67. package/dist/esm/api/resources/organizations/resources/placements/types/Cadence.d.mts +1 -1
  68. package/dist/esm/api/resources/organizations/resources/placements/types/CadenceFrequency.d.mts +1 -1
  69. package/dist/esm/api/resources/organizations/resources/placements/types/CadenceFrequency.mjs +1 -1
  70. package/dist/esm/api/resources/organizations/resources/placements/types/CreateBatchActivationSlot.d.mts +1 -1
  71. package/dist/esm/api/resources/organizations/resources/placements/types/CreateEmailAttributes.d.mts +25 -0
  72. package/dist/esm/api/resources/organizations/resources/placements/types/CreateEmailPlacementData.d.mts +8 -0
  73. package/dist/esm/api/resources/organizations/resources/placements/types/CreateGroupAttributes.d.mts +20 -0
  74. package/dist/esm/api/resources/organizations/resources/placements/types/CreateGroupPlacementData.d.mts +8 -0
  75. package/dist/esm/api/resources/organizations/resources/placements/types/CreatePlacementDataUnion.d.mts +9 -3
  76. package/dist/esm/api/resources/organizations/resources/placements/types/CreatePlacementRequestBody.d.mts +48 -1
  77. package/dist/{cjs/api/resources/organizations/resources/placements/types/CreateMainPageAttributes.d.ts → esm/api/resources/organizations/resources/placements/types/CreateStandardAttributes.d.mts} +2 -2
  78. package/dist/esm/api/resources/organizations/resources/placements/types/CreateStandardPlacementData.d.mts +8 -0
  79. package/dist/esm/api/resources/organizations/resources/placements/types/EmailPlacementAttributes.d.mts +16 -0
  80. package/dist/esm/api/resources/organizations/resources/placements/types/{MainPagePlacementData.d.mts → EmailPlacementData.d.mts} +3 -3
  81. package/dist/esm/api/resources/organizations/resources/placements/types/EmailPlacementData.mjs +2 -0
  82. package/dist/esm/api/resources/organizations/resources/placements/types/GroupPlacementAttributes.d.mts +9 -0
  83. package/dist/esm/api/resources/organizations/resources/placements/types/GroupPlacementAttributes.mjs +2 -0
  84. package/dist/esm/api/resources/organizations/resources/placements/types/GroupPlacementData.d.mts +11 -0
  85. package/dist/esm/api/resources/organizations/resources/placements/types/GroupPlacementData.mjs +2 -0
  86. package/dist/esm/api/resources/organizations/resources/placements/types/IncludedResource.d.mts +6 -3
  87. package/dist/{cjs/api/resources/organizations/resources/placements/types/MainPagePlacementAttributes.d.ts → esm/api/resources/organizations/resources/placements/types/PlacementAttributes.d.mts} +2 -2
  88. package/dist/esm/api/resources/organizations/resources/placements/types/PlacementAttributes.mjs +2 -0
  89. package/dist/esm/api/resources/organizations/resources/placements/types/PlacementData.d.mts +11 -0
  90. package/dist/esm/api/resources/organizations/resources/placements/types/PlacementData.mjs +2 -0
  91. package/dist/esm/api/resources/organizations/resources/placements/types/PlacementFormatUnion.d.mts +44 -4
  92. package/dist/esm/api/resources/organizations/resources/placements/types/PlacementListResponse.d.mts +1 -1
  93. package/dist/esm/api/resources/organizations/resources/placements/types/PlacementResource.d.mts +1 -1
  94. package/dist/esm/api/resources/organizations/resources/placements/types/PlacementTypeFilter.d.mts +3 -1
  95. package/dist/esm/api/resources/organizations/resources/placements/types/PlacementTypeFilter.mjs +3 -1
  96. package/dist/esm/api/resources/organizations/resources/placements/types/SlottedPlacementRelationships.d.mts +8 -0
  97. package/dist/esm/api/resources/organizations/resources/placements/types/SlottedPlacementRelationships.mjs +2 -0
  98. package/dist/esm/api/resources/organizations/resources/placements/types/UpdateBatchActivationSlot.d.mts +1 -1
  99. package/dist/esm/api/resources/organizations/resources/placements/types/UpdateEmailAttributes.d.mts +25 -0
  100. package/dist/esm/api/resources/organizations/resources/placements/types/UpdateEmailAttributes.mjs +2 -0
  101. package/dist/esm/api/resources/organizations/resources/placements/types/UpdateEmailPlacementData.d.mts +8 -0
  102. package/dist/esm/api/resources/organizations/resources/placements/types/UpdateEmailPlacementData.mjs +2 -0
  103. package/dist/esm/api/resources/organizations/resources/placements/types/UpdateGroupAttributes.d.mts +21 -0
  104. package/dist/esm/api/resources/organizations/resources/placements/types/UpdateGroupAttributes.mjs +2 -0
  105. package/dist/esm/api/resources/organizations/resources/placements/types/UpdateGroupPlacementData.d.mts +8 -0
  106. package/dist/esm/api/resources/organizations/resources/placements/types/UpdateGroupPlacementData.mjs +2 -0
  107. package/dist/esm/api/resources/organizations/resources/placements/types/UpdatePlacementDataUnion.d.mts +9 -3
  108. package/dist/esm/api/resources/organizations/resources/placements/types/{UpdateMainPageAttributes.d.mts → UpdateStandardAttributes.d.mts} +2 -2
  109. package/dist/esm/api/resources/organizations/resources/placements/types/UpdateStandardAttributes.mjs +2 -0
  110. package/dist/esm/api/resources/organizations/resources/placements/types/UpdateStandardPlacementData.d.mts +8 -0
  111. package/dist/esm/api/resources/organizations/resources/placements/types/UpdateStandardPlacementData.mjs +2 -0
  112. package/dist/esm/api/resources/organizations/resources/placements/types/index.d.mts +19 -7
  113. package/dist/esm/api/resources/organizations/resources/placements/types/index.mjs +19 -7
  114. package/dist/esm/api/resources/users/resources/rewards/client/Client.d.mts +12 -8
  115. package/dist/esm/api/resources/users/resources/rewards/client/Client.mjs +12 -8
  116. package/dist/esm/api/resources/users/resources/rewards/types/BatchesResponseObject.d.mts +1 -1
  117. package/dist/esm/api/resources/users/resources/rewards/types/PlacementBatchAttributes.d.mts +2 -2
  118. package/dist/esm/api/resources/users/resources/rewards/types/PlacementBatchData.d.mts +1 -1
  119. package/dist/esm/version.d.mts +1 -1
  120. package/dist/esm/version.mjs +1 -1
  121. package/package.json +1 -1
  122. package/reference.md +16 -12
  123. package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationPlacementRelationships.d.ts +0 -8
  124. package/dist/cjs/api/resources/organizations/resources/placements/types/CreateMainPagePlacementData.d.ts +0 -8
  125. package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateMainPagePlacementData.d.ts +0 -8
  126. package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationPlacementRelationships.d.mts +0 -8
  127. package/dist/esm/api/resources/organizations/resources/placements/types/CreateMainPagePlacementData.d.mts +0 -8
  128. package/dist/esm/api/resources/organizations/resources/placements/types/UpdateMainPagePlacementData.d.mts +0 -8
  129. /package/dist/cjs/api/resources/organizations/resources/placements/types/{BatchActivationPlacementRelationships.js → CreateEmailAttributes.js} +0 -0
  130. /package/dist/cjs/api/resources/organizations/resources/placements/types/{CreateMainPageAttributes.js → CreateEmailPlacementData.js} +0 -0
  131. /package/dist/cjs/api/resources/organizations/resources/placements/types/{CreateMainPagePlacementData.js → CreateGroupAttributes.js} +0 -0
  132. /package/dist/cjs/api/resources/organizations/resources/placements/types/{MainPagePlacementAttributes.js → CreateGroupPlacementData.js} +0 -0
  133. /package/dist/cjs/api/resources/organizations/resources/placements/types/{MainPagePlacementData.js → CreateStandardAttributes.js} +0 -0
  134. /package/dist/cjs/api/resources/organizations/resources/placements/types/{UpdateMainPageAttributes.js → CreateStandardPlacementData.js} +0 -0
  135. /package/dist/cjs/api/resources/organizations/resources/placements/types/{UpdateMainPagePlacementData.js → EmailPlacementAttributes.js} +0 -0
  136. /package/dist/esm/api/resources/organizations/resources/placements/types/{BatchActivationPlacementRelationships.mjs → CreateEmailAttributes.mjs} +0 -0
  137. /package/dist/esm/api/resources/organizations/resources/placements/types/{CreateMainPageAttributes.mjs → CreateEmailPlacementData.mjs} +0 -0
  138. /package/dist/esm/api/resources/organizations/resources/placements/types/{CreateMainPagePlacementData.mjs → CreateGroupAttributes.mjs} +0 -0
  139. /package/dist/esm/api/resources/organizations/resources/placements/types/{MainPagePlacementAttributes.mjs → CreateGroupPlacementData.mjs} +0 -0
  140. /package/dist/esm/api/resources/organizations/resources/placements/types/{MainPagePlacementData.mjs → CreateStandardAttributes.mjs} +0 -0
  141. /package/dist/esm/api/resources/organizations/resources/placements/types/{UpdateMainPageAttributes.mjs → CreateStandardPlacementData.mjs} +0 -0
  142. /package/dist/esm/api/resources/organizations/resources/placements/types/{UpdateMainPagePlacementData.mjs → EmailPlacementAttributes.mjs} +0 -0
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,8 @@
1
+ import type * as KardApi from "../../../../../index.mjs";
2
+ /**
3
+ * Data for updating an email placement
4
+ */
5
+ export interface UpdateEmailPlacementData {
6
+ /** Email placement attributes for update */
7
+ attributes: KardApi.organizations.UpdateEmailAttributes;
8
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,21 @@
1
+ import type * as KardApi from "../../../../../index.mjs";
2
+ /**
3
+ * Attributes for updating a group placement. All fields are required.
4
+ *
5
+ * @example
6
+ * {
7
+ * name: "Updated Collection",
8
+ * slots: [{
9
+ * slotId: "01961e5a-b59c-7f77-9d8c-4d0af3ce7b9a",
10
+ * placementId: "01961e5a-f26f-7e44-ce5f-1ad7c9fb4e67",
11
+ * alias: "primary",
12
+ * shortDescription: "Seasonal picks"
13
+ * }]
14
+ * }
15
+ */
16
+ export interface UpdateGroupAttributes {
17
+ /** Name of the placement */
18
+ name: string;
19
+ /** Slots that make up the group. Slots present in the prior state but absent from this list are removed. */
20
+ slots: KardApi.organizations.UpdateBatchActivationSlot[];
21
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,8 @@
1
+ import type * as KardApi from "../../../../../index.mjs";
2
+ /**
3
+ * Data for updating a group placement
4
+ */
5
+ export interface UpdateGroupPlacementData {
6
+ /** Group placement attributes for update */
7
+ attributes: KardApi.organizations.UpdateGroupAttributes;
8
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -2,15 +2,21 @@ import type * as KardApi from "../../../../../index.mjs";
2
2
  /**
3
3
  * Discriminated union for updating a placement
4
4
  */
5
- export type UpdatePlacementDataUnion = KardApi.organizations.UpdatePlacementDataUnion.PlacementMainPage | KardApi.organizations.UpdatePlacementDataUnion.PlacementPushNotification | KardApi.organizations.UpdatePlacementDataUnion.PlacementBatchActivation;
5
+ export type UpdatePlacementDataUnion = KardApi.organizations.UpdatePlacementDataUnion.Placement | KardApi.organizations.UpdatePlacementDataUnion.PlacementPushNotification | KardApi.organizations.UpdatePlacementDataUnion.PlacementEmail | KardApi.organizations.UpdatePlacementDataUnion.PlacementBatchActivation | KardApi.organizations.UpdatePlacementDataUnion.PlacementGroup;
6
6
  export declare namespace UpdatePlacementDataUnion {
7
- interface PlacementMainPage extends KardApi.organizations.UpdateMainPagePlacementData {
8
- type: "placementMainPage";
7
+ interface Placement extends KardApi.organizations.UpdateStandardPlacementData {
8
+ type: "placement";
9
9
  }
10
10
  interface PlacementPushNotification extends KardApi.organizations.UpdatePushNotificationPlacementData {
11
11
  type: "placementPushNotification";
12
12
  }
13
+ interface PlacementEmail extends KardApi.organizations.UpdateEmailPlacementData {
14
+ type: "placementEmail";
15
+ }
13
16
  interface PlacementBatchActivation extends KardApi.organizations.UpdateBatchActivationPlacementData {
14
17
  type: "placementBatchActivation";
15
18
  }
19
+ interface PlacementGroup extends KardApi.organizations.UpdateGroupPlacementData {
20
+ type: "placementGroup";
21
+ }
16
22
  }
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Attributes for updating a main-page placement. All fields are required.
2
+ * Attributes for updating a standard placement. All fields are required.
3
3
  *
4
4
  * @example
5
5
  * {
@@ -7,7 +7,7 @@
7
7
  * availableSlots: 10
8
8
  * }
9
9
  */
10
- export interface UpdateMainPageAttributes {
10
+ export interface UpdateStandardAttributes {
11
11
  /** Name of the placement */
12
12
  name: string;
13
13
  /** Number of available slots (minimum 1) */
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,8 @@
1
+ import type * as KardApi from "../../../../../index.mjs";
2
+ /**
3
+ * Data for updating a standard placement
4
+ */
5
+ export interface UpdateStandardPlacementData {
6
+ /** Standard placement attributes for update */
7
+ attributes: KardApi.organizations.UpdateStandardAttributes;
8
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -1,6 +1,5 @@
1
1
  export * from "./BatchActivationPlacementAttributes.mjs";
2
2
  export * from "./BatchActivationPlacementData.mjs";
3
- export * from "./BatchActivationPlacementRelationships.mjs";
4
3
  export * from "./BatchActivationSlotAttributes.mjs";
5
4
  export * from "./BatchActivationSlotInclusion.mjs";
6
5
  export * from "./BatchActivationSlotRelationships.mjs";
@@ -10,16 +9,24 @@ export * from "./ContentStrategyInclusion.mjs";
10
9
  export * from "./CreateBatchActivationAttributes.mjs";
11
10
  export * from "./CreateBatchActivationPlacementData.mjs";
12
11
  export * from "./CreateBatchActivationSlot.mjs";
13
- export * from "./CreateMainPageAttributes.mjs";
14
- export * from "./CreateMainPagePlacementData.mjs";
12
+ export * from "./CreateEmailAttributes.mjs";
13
+ export * from "./CreateEmailPlacementData.mjs";
14
+ export * from "./CreateGroupAttributes.mjs";
15
+ export * from "./CreateGroupPlacementData.mjs";
15
16
  export * from "./CreatePlacementDataUnion.mjs";
16
17
  export * from "./CreatePlacementRequestBody.mjs";
17
18
  export * from "./CreatePushNotificationAttributes.mjs";
18
19
  export * from "./CreatePushNotificationPlacementData.mjs";
20
+ export * from "./CreateStandardAttributes.mjs";
21
+ export * from "./CreateStandardPlacementData.mjs";
19
22
  export * from "./DayOfWeek.mjs";
23
+ export * from "./EmailPlacementAttributes.mjs";
24
+ export * from "./EmailPlacementData.mjs";
25
+ export * from "./GroupPlacementAttributes.mjs";
26
+ export * from "./GroupPlacementData.mjs";
20
27
  export * from "./IncludedResource.mjs";
21
- export * from "./MainPagePlacementAttributes.mjs";
22
- export * from "./MainPagePlacementData.mjs";
28
+ export * from "./PlacementAttributes.mjs";
29
+ export * from "./PlacementData.mjs";
23
30
  export * from "./PlacementFormatUnion.mjs";
24
31
  export * from "./PlacementListResponse.mjs";
25
32
  export * from "./PlacementRelationships.mjs";
@@ -28,14 +35,19 @@ export * from "./PlacementTypeFilter.mjs";
28
35
  export * from "./PushNotificationPlacementAttributes.mjs";
29
36
  export * from "./PushNotificationPlacementData.mjs";
30
37
  export * from "./ResourceIdentifier.mjs";
38
+ export * from "./SlottedPlacementRelationships.mjs";
31
39
  export * from "./ToManyRelationship.mjs";
32
40
  export * from "./ToOneRelationship.mjs";
33
41
  export * from "./UpdateBatchActivationAttributes.mjs";
34
42
  export * from "./UpdateBatchActivationPlacementData.mjs";
35
43
  export * from "./UpdateBatchActivationSlot.mjs";
36
- export * from "./UpdateMainPageAttributes.mjs";
37
- export * from "./UpdateMainPagePlacementData.mjs";
44
+ export * from "./UpdateEmailAttributes.mjs";
45
+ export * from "./UpdateEmailPlacementData.mjs";
46
+ export * from "./UpdateGroupAttributes.mjs";
47
+ export * from "./UpdateGroupPlacementData.mjs";
38
48
  export * from "./UpdatePlacementDataUnion.mjs";
39
49
  export * from "./UpdatePlacementRequestBody.mjs";
40
50
  export * from "./UpdatePushNotificationAttributes.mjs";
41
51
  export * from "./UpdatePushNotificationPlacementData.mjs";
52
+ export * from "./UpdateStandardAttributes.mjs";
53
+ export * from "./UpdateStandardPlacementData.mjs";
@@ -1,6 +1,5 @@
1
1
  export * from "./BatchActivationPlacementAttributes.mjs";
2
2
  export * from "./BatchActivationPlacementData.mjs";
3
- export * from "./BatchActivationPlacementRelationships.mjs";
4
3
  export * from "./BatchActivationSlotAttributes.mjs";
5
4
  export * from "./BatchActivationSlotInclusion.mjs";
6
5
  export * from "./BatchActivationSlotRelationships.mjs";
@@ -10,16 +9,24 @@ export * from "./ContentStrategyInclusion.mjs";
10
9
  export * from "./CreateBatchActivationAttributes.mjs";
11
10
  export * from "./CreateBatchActivationPlacementData.mjs";
12
11
  export * from "./CreateBatchActivationSlot.mjs";
13
- export * from "./CreateMainPageAttributes.mjs";
14
- export * from "./CreateMainPagePlacementData.mjs";
12
+ export * from "./CreateEmailAttributes.mjs";
13
+ export * from "./CreateEmailPlacementData.mjs";
14
+ export * from "./CreateGroupAttributes.mjs";
15
+ export * from "./CreateGroupPlacementData.mjs";
15
16
  export * from "./CreatePlacementDataUnion.mjs";
16
17
  export * from "./CreatePlacementRequestBody.mjs";
17
18
  export * from "./CreatePushNotificationAttributes.mjs";
18
19
  export * from "./CreatePushNotificationPlacementData.mjs";
20
+ export * from "./CreateStandardAttributes.mjs";
21
+ export * from "./CreateStandardPlacementData.mjs";
19
22
  export * from "./DayOfWeek.mjs";
23
+ export * from "./EmailPlacementAttributes.mjs";
24
+ export * from "./EmailPlacementData.mjs";
25
+ export * from "./GroupPlacementAttributes.mjs";
26
+ export * from "./GroupPlacementData.mjs";
20
27
  export * from "./IncludedResource.mjs";
21
- export * from "./MainPagePlacementAttributes.mjs";
22
- export * from "./MainPagePlacementData.mjs";
28
+ export * from "./PlacementAttributes.mjs";
29
+ export * from "./PlacementData.mjs";
23
30
  export * from "./PlacementFormatUnion.mjs";
24
31
  export * from "./PlacementListResponse.mjs";
25
32
  export * from "./PlacementRelationships.mjs";
@@ -28,14 +35,19 @@ export * from "./PlacementTypeFilter.mjs";
28
35
  export * from "./PushNotificationPlacementAttributes.mjs";
29
36
  export * from "./PushNotificationPlacementData.mjs";
30
37
  export * from "./ResourceIdentifier.mjs";
38
+ export * from "./SlottedPlacementRelationships.mjs";
31
39
  export * from "./ToManyRelationship.mjs";
32
40
  export * from "./ToOneRelationship.mjs";
33
41
  export * from "./UpdateBatchActivationAttributes.mjs";
34
42
  export * from "./UpdateBatchActivationPlacementData.mjs";
35
43
  export * from "./UpdateBatchActivationSlot.mjs";
36
- export * from "./UpdateMainPageAttributes.mjs";
37
- export * from "./UpdateMainPagePlacementData.mjs";
44
+ export * from "./UpdateEmailAttributes.mjs";
45
+ export * from "./UpdateEmailPlacementData.mjs";
46
+ export * from "./UpdateGroupAttributes.mjs";
47
+ export * from "./UpdateGroupPlacementData.mjs";
38
48
  export * from "./UpdatePlacementDataUnion.mjs";
39
49
  export * from "./UpdatePlacementRequestBody.mjs";
40
50
  export * from "./UpdatePushNotificationAttributes.mjs";
41
51
  export * from "./UpdatePushNotificationPlacementData.mjs";
52
+ export * from "./UpdateStandardAttributes.mjs";
53
+ export * from "./UpdateStandardPlacementData.mjs";
@@ -57,14 +57,18 @@ export declare class RewardsClient {
57
57
  placementOffers(organizationId: KardApi.OrganizationId, userId: KardApi.UserId, placementId: string, request?: KardApi.users.GetOffersByPlacementRequest, requestOptions?: RewardsClient.RequestOptions): core.HttpResponsePromise<KardApi.users.OffersResponseObject>;
58
58
  private __placementOffers;
59
59
  /**
60
- * Retrieve batches for a batch-activation placement. Returns each slot in slot
61
- * order with its current offer set, alias, and freshness fields (`isActive`,
62
- * `lastActivatedAt`, `expiresAt`). Applies the same per-user eligibility and
63
- * per-slot content-strategy filter as Get Offers By Placement, independently
64
- * per slot. A slot only flips to `isActive: false` when its refresh interval
65
- * has elapsed AND its post-eligibility `offers[]` is non-empty; otherwise the
66
- * slot is still returned and stays active so the partner UI does not promote
67
- * "refresh" with nothing to show.<br/>
60
+ * Retrieve batches for a batch-activation or group placement. Returns each
61
+ * slot in slot order with its current offer set, alias, and freshness fields
62
+ * (`isActive`, `lastActivatedAt`, `expiresAt`). Applies the same per-user
63
+ * eligibility and per-slot content-strategy filter as Get Offers By
64
+ * Placement, independently per slot. For a batch-activation placement, a
65
+ * slot only flips to `isActive: false` when its refresh interval has elapsed
66
+ * AND its post-eligibility `offers[]` is non-empty; otherwise the slot is
67
+ * still returned and stays active so the partner UI does not promote
68
+ * "refresh" with nothing to show. For a group placement, slots are always
69
+ * active and each slot returns its offers regardless of activation state,
70
+ * hiding only offers that require activation (`requiredInBatch`) and have
71
+ * no activation record.<br/>
68
72
  * <b>Required scopes:</b> `rewards:read`
69
73
  *
70
74
  * @param {KardApi.OrganizationId} organizationId
@@ -179,14 +179,18 @@ export class RewardsClient {
179
179
  });
180
180
  }
181
181
  /**
182
- * Retrieve batches for a batch-activation placement. Returns each slot in slot
183
- * order with its current offer set, alias, and freshness fields (`isActive`,
184
- * `lastActivatedAt`, `expiresAt`). Applies the same per-user eligibility and
185
- * per-slot content-strategy filter as Get Offers By Placement, independently
186
- * per slot. A slot only flips to `isActive: false` when its refresh interval
187
- * has elapsed AND its post-eligibility `offers[]` is non-empty; otherwise the
188
- * slot is still returned and stays active so the partner UI does not promote
189
- * "refresh" with nothing to show.<br/>
182
+ * Retrieve batches for a batch-activation or group placement. Returns each
183
+ * slot in slot order with its current offer set, alias, and freshness fields
184
+ * (`isActive`, `lastActivatedAt`, `expiresAt`). Applies the same per-user
185
+ * eligibility and per-slot content-strategy filter as Get Offers By
186
+ * Placement, independently per slot. For a batch-activation placement, a
187
+ * slot only flips to `isActive: false` when its refresh interval has elapsed
188
+ * AND its post-eligibility `offers[]` is non-empty; otherwise the slot is
189
+ * still returned and stays active so the partner UI does not promote
190
+ * "refresh" with nothing to show. For a group placement, slots are always
191
+ * active and each slot returns its offers regardless of activation state,
192
+ * hiding only offers that require activation (`requiredInBatch`) and have
193
+ * no activation record.<br/>
190
194
  * <b>Required scopes:</b> `rewards:read`
191
195
  *
192
196
  * @param {KardApi.OrganizationId} organizationId
@@ -1,6 +1,6 @@
1
1
  import type * as KardApi from "../../../../../index.mjs";
2
2
  /**
3
- * Ordered list of slots for a batch-activation placement, with freshness fields and per-slot offer sets.
3
+ * Ordered list of slots for a batch-activation or group placement, with freshness fields and per-slot offer sets.
4
4
  */
5
5
  export interface BatchesResponseObject {
6
6
  data: KardApi.users.PlacementBatchData[];
@@ -5,13 +5,13 @@ import type * as KardApi from "../../../../../index.mjs";
5
5
  export interface PlacementBatchAttributes {
6
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
7
  name: string;
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. */
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. Always true for slots of a group placement, which has no activation cycle. */
9
9
  isActive: boolean;
10
10
  /** Timestamp of the most recent placementSlotAttribution ACTIVATE event for this (user, placement, slot). Absent for cold slots that have never been activated. */
11
11
  lastActivatedAt?: string | undefined;
12
12
  /** Computed as `lastActivatedAt + placement.refreshInterval`. Absent for cold slots that have never been activated. */
13
13
  expiresAt?: string | undefined;
14
- /** Slot-level UI components. Carries `shortDescription` and `longDescription` (activation copy derived from the parent placement's `refreshInterval`), plus either a `cta` (POST to the slot's activate endpoint) when the slot has no active (non-expired) activation, or a `logoFlare` decoration when it does — `cta` and `logoFlare` are mutually exclusive on a single slot. */
14
+ /** Slot-level UI components. Carries `shortDescription` and `longDescription` (activation copy derived from the parent placement's `refreshInterval`), plus either a `cta` (POST to the slot's activate endpoint) when the slot has no active (non-expired) activation, or a `logoFlare` decoration when it does — `cta` and `logoFlare` are mutually exclusive on a single slot. Omitted for slots of a group placement, which has no activation cycle. */
15
15
  components?: KardApi.users.OfferComponents | undefined;
16
16
  /** Slot-level visual assets. Currently a single `IMG_VIEW` SVG showing the slot's initials, themed via the `--icon-fill` CSS custom property. */
17
17
  assets?: KardApi.users.Asset[] | undefined;
@@ -1,6 +1,6 @@
1
1
  import type * as KardApi from "../../../../../index.mjs";
2
2
  /**
3
- * One slot in a batch-activation placement, with freshness fields and the offers that resolve under the slot's content strategy.
3
+ * One slot in a batch-activation or group placement, with freshness fields and the offers that resolve under the slot's content strategy.
4
4
  */
5
5
  export interface PlacementBatchData {
6
6
  /** Stable identifier for the slot within the placement */
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "28.2.0";
1
+ export declare const SDK_VERSION = "29.0.0";
@@ -1 +1 @@
1
- export const SDK_VERSION = "28.2.0";
1
+ export const SDK_VERSION = "29.0.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kard-financial/sdk",
3
- "version": "28.2.0",
3
+ "version": "29.0.0",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -1206,7 +1206,7 @@ await client.organizations.contentStrategies.delete("organizationId", "contentSt
1206
1206
  <dl>
1207
1207
  <dd>
1208
1208
 
1209
- Create a placement for the organization. Use type "placementMainPage" for main-page placements (requires name and availableSlots) or "placementPushNotification" for push-notification placements (requires name and cadence; availableSlots is automatically set to 1).
1209
+ Create a placement for the organization. Use type "placement" for standard placements (requires name and availableSlots), "placementPushNotification" for push-notification placements (requires name and cadence; availableSlots is automatically set to 1), "placementEmail" for email placements (requires name, cadence, and availableSlots), "placementBatchActivation" for batch-activation placements (requires name, refreshInterval, and slots), or "placementGroup" for group placements (requires name and slots).
1210
1210
  </dd>
1211
1211
  </dl>
1212
1212
  </dd>
@@ -1223,7 +1223,7 @@ Create a placement for the organization. Use type "placementMainPage" for main-p
1223
1223
  ```typescript
1224
1224
  await client.organizations.placements.create("org-123", {
1225
1225
  data: {
1226
- type: "placementMainPage",
1226
+ type: "placement",
1227
1227
  attributes: {
1228
1228
  name: "Homepage Banner",
1229
1229
  availableSlots: 5
@@ -1435,7 +1435,7 @@ await client.organizations.placements.get("organizationId", "placementId");
1435
1435
  <dl>
1436
1436
  <dd>
1437
1437
 
1438
- 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.
1438
+ Replace a placement. All fields must be provided. Use type "placement", "placementPushNotification", "placementEmail", "placementBatchActivation", or "placementGroup" to set the placement kind. If the type is "placementPushNotification", availableSlots is automatically set to 1.
1439
1439
  </dd>
1440
1440
  </dl>
1441
1441
  </dd>
@@ -1452,7 +1452,7 @@ Replace a placement. All fields must be provided. Use type "placementMainPage" o
1452
1452
  ```typescript
1453
1453
  await client.organizations.placements.update("organizationId", "placementId", {
1454
1454
  data: {
1455
- type: "placementMainPage",
1455
+ type: "placement",
1456
1456
  attributes: {
1457
1457
  name: "name",
1458
1458
  availableSlots: 1
@@ -3075,14 +3075,18 @@ await client.users.rewards.placementOffers("organizationId", "userId", "placemen
3075
3075
  <dl>
3076
3076
  <dd>
3077
3077
 
3078
- Retrieve batches for a batch-activation placement. Returns each slot in slot
3079
- order with its current offer set, alias, and freshness fields (`isActive`,
3080
- `lastActivatedAt`, `expiresAt`). Applies the same per-user eligibility and
3081
- per-slot content-strategy filter as Get Offers By Placement, independently
3082
- per slot. A slot only flips to `isActive: false` when its refresh interval
3083
- has elapsed AND its post-eligibility `offers[]` is non-empty; otherwise the
3084
- slot is still returned and stays active so the partner UI does not promote
3085
- "refresh" with nothing to show.<br/>
3078
+ Retrieve batches for a batch-activation or group placement. Returns each
3079
+ slot in slot order with its current offer set, alias, and freshness fields
3080
+ (`isActive`, `lastActivatedAt`, `expiresAt`). Applies the same per-user
3081
+ eligibility and per-slot content-strategy filter as Get Offers By
3082
+ Placement, independently per slot. For a batch-activation placement, a
3083
+ slot only flips to `isActive: false` when its refresh interval has elapsed
3084
+ AND its post-eligibility `offers[]` is non-empty; otherwise the slot is
3085
+ still returned and stays active so the partner UI does not promote
3086
+ "refresh" with nothing to show. For a group placement, slots are always
3087
+ active and each slot returns its offers regardless of activation state,
3088
+ hiding only offers that require activation (`requiredInBatch`) and have
3089
+ no activation record.<br/>
3086
3090
  <b>Required scopes:</b> `rewards:read`
3087
3091
  </dd>
3088
3092
  </dl>
@@ -1,8 +0,0 @@
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
- }
@@ -1,8 +0,0 @@
1
- import type * as KardApi from "../../../../../index.js";
2
- /**
3
- * Data for creating a main-page placement
4
- */
5
- export interface CreateMainPagePlacementData {
6
- /** Main-page placement attributes for creation */
7
- attributes: KardApi.organizations.CreateMainPageAttributes;
8
- }
@@ -1,8 +0,0 @@
1
- import type * as KardApi from "../../../../../index.js";
2
- /**
3
- * Data for updating a main-page placement
4
- */
5
- export interface UpdateMainPagePlacementData {
6
- /** Main-page placement attributes for update */
7
- attributes: KardApi.organizations.UpdateMainPageAttributes;
8
- }
@@ -1,8 +0,0 @@
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
- }
@@ -1,8 +0,0 @@
1
- import type * as KardApi from "../../../../../index.mjs";
2
- /**
3
- * Data for creating a main-page placement
4
- */
5
- export interface CreateMainPagePlacementData {
6
- /** Main-page placement attributes for creation */
7
- attributes: KardApi.organizations.CreateMainPageAttributes;
8
- }
@@ -1,8 +0,0 @@
1
- import type * as KardApi from "../../../../../index.mjs";
2
- /**
3
- * Data for updating a main-page placement
4
- */
5
- export interface UpdateMainPagePlacementData {
6
- /** Main-page placement attributes for update */
7
- attributes: KardApi.organizations.UpdateMainPageAttributes;
8
- }