@kard-financial/sdk 28.1.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.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/commons/types/NotificationType.d.ts +2 -0
- package/dist/cjs/api/resources/commons/types/NotificationType.js +2 -0
- package/dist/cjs/api/resources/notifications/types/EmailNotificationPlacementFileAttributes.d.ts +12 -0
- package/dist/cjs/api/resources/notifications/types/EmailNotificationPlacementFileData.d.ts +7 -0
- package/dist/cjs/api/resources/notifications/types/EmailNotificationPlacementFileRelationships.d.ts +5 -0
- package/dist/cjs/api/resources/notifications/types/NotificationDataUnion.d.ts +7 -1
- package/dist/cjs/api/resources/notifications/types/NotificationPayload.d.ts +57 -0
- package/dist/cjs/api/resources/notifications/types/PushNotificationPlacementFileAttributes.d.ts +10 -0
- package/dist/cjs/api/resources/notifications/types/PushNotificationPlacementFileData.d.ts +7 -0
- package/dist/cjs/api/resources/notifications/types/PushNotificationPlacementFileRelationships.d.ts +5 -0
- package/dist/cjs/api/resources/notifications/types/index.d.ts +6 -0
- package/dist/cjs/api/resources/notifications/types/index.js +6 -0
- package/dist/cjs/api/resources/organizations/resources/placements/client/Client.d.ts +51 -4
- package/dist/cjs/api/resources/organizations/resources/placements/client/Client.js +51 -4
- 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 +2 -2
- package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationPlacementData.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/Cadence.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/CadenceFrequency.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/CadenceFrequency.js +1 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateBatchActivationSlot.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateEmailAttributes.d.ts +25 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateEmailPlacementData.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateEmailPlacementData.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateGroupAttributes.d.ts +20 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateGroupAttributes.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateGroupPlacementData.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateGroupPlacementData.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreatePlacementDataUnion.d.ts +9 -3
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreatePlacementRequestBody.d.ts +48 -1
- package/dist/{esm/api/resources/organizations/resources/placements/types/CreateMainPageAttributes.d.mts → cjs/api/resources/organizations/resources/placements/types/CreateStandardAttributes.d.ts} +2 -2
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateStandardAttributes.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateStandardPlacementData.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateStandardPlacementData.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/EmailPlacementAttributes.d.ts +16 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/EmailPlacementAttributes.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/{MainPagePlacementData.d.ts → EmailPlacementData.d.ts} +3 -3
- package/dist/cjs/api/resources/organizations/resources/placements/types/EmailPlacementData.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/GroupPlacementAttributes.d.ts +9 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/GroupPlacementAttributes.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/GroupPlacementData.d.ts +11 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/GroupPlacementData.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/IncludedResource.d.ts +6 -3
- package/dist/{esm/api/resources/organizations/resources/placements/types/MainPagePlacementAttributes.d.mts → cjs/api/resources/organizations/resources/placements/types/PlacementAttributes.d.ts} +2 -2
- package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementAttributes.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementData.d.ts +11 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementData.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementFormatUnion.d.ts +44 -4
- package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementListResponse.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementResource.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementTypeFilter.d.ts +3 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementTypeFilter.js +3 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/SlottedPlacementRelationships.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/SlottedPlacementRelationships.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateBatchActivationSlot.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateEmailAttributes.d.ts +25 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateEmailAttributes.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateEmailPlacementData.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateEmailPlacementData.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateGroupAttributes.d.ts +21 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateGroupAttributes.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateGroupPlacementData.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateGroupPlacementData.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdatePlacementDataUnion.d.ts +9 -3
- package/dist/cjs/api/resources/organizations/resources/placements/types/{UpdateMainPageAttributes.d.ts → UpdateStandardAttributes.d.ts} +2 -2
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateStandardAttributes.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateStandardPlacementData.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateStandardPlacementData.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/index.d.ts +19 -7
- package/dist/cjs/api/resources/organizations/resources/placements/types/index.js +19 -7
- package/dist/cjs/api/resources/users/resources/rewards/client/Client.d.ts +12 -8
- package/dist/cjs/api/resources/users/resources/rewards/client/Client.js +12 -8
- package/dist/cjs/api/resources/users/resources/rewards/types/BatchesResponseObject.d.ts +1 -1
- package/dist/cjs/api/resources/users/resources/rewards/types/PlacementBatchAttributes.d.ts +2 -2
- package/dist/cjs/api/resources/users/resources/rewards/types/PlacementBatchData.d.ts +1 -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/commons/types/NotificationType.d.mts +2 -0
- package/dist/esm/api/resources/commons/types/NotificationType.mjs +2 -0
- package/dist/esm/api/resources/notifications/types/EmailNotificationPlacementFileAttributes.d.mts +12 -0
- package/dist/esm/api/resources/notifications/types/EmailNotificationPlacementFileData.d.mts +7 -0
- package/dist/esm/api/resources/notifications/types/EmailNotificationPlacementFileRelationships.d.mts +5 -0
- package/dist/esm/api/resources/notifications/types/NotificationDataUnion.d.mts +7 -1
- package/dist/esm/api/resources/notifications/types/NotificationPayload.d.mts +57 -0
- package/dist/esm/api/resources/notifications/types/PushNotificationPlacementFileAttributes.d.mts +10 -0
- package/dist/esm/api/resources/notifications/types/PushNotificationPlacementFileData.d.mts +7 -0
- package/dist/esm/api/resources/notifications/types/PushNotificationPlacementFileRelationships.d.mts +5 -0
- package/dist/esm/api/resources/notifications/types/index.d.mts +6 -0
- package/dist/esm/api/resources/notifications/types/index.mjs +6 -0
- package/dist/esm/api/resources/organizations/resources/placements/client/Client.d.mts +51 -4
- package/dist/esm/api/resources/organizations/resources/placements/client/Client.mjs +51 -4
- 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 +2 -2
- package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationPlacementData.d.mts +1 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/Cadence.d.mts +1 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/CadenceFrequency.d.mts +1 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/CadenceFrequency.mjs +1 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateBatchActivationSlot.d.mts +1 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateEmailAttributes.d.mts +25 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateEmailPlacementData.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateEmailPlacementData.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateGroupAttributes.d.mts +20 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateGroupAttributes.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateGroupPlacementData.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateGroupPlacementData.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/CreatePlacementDataUnion.d.mts +9 -3
- package/dist/esm/api/resources/organizations/resources/placements/types/CreatePlacementRequestBody.d.mts +48 -1
- package/dist/{cjs/api/resources/organizations/resources/placements/types/CreateMainPageAttributes.d.ts → esm/api/resources/organizations/resources/placements/types/CreateStandardAttributes.d.mts} +2 -2
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateStandardAttributes.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateStandardPlacementData.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateStandardPlacementData.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/EmailPlacementAttributes.d.mts +16 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/EmailPlacementAttributes.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/{MainPagePlacementData.d.mts → EmailPlacementData.d.mts} +3 -3
- package/dist/esm/api/resources/organizations/resources/placements/types/EmailPlacementData.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/GroupPlacementAttributes.d.mts +9 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/GroupPlacementAttributes.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/GroupPlacementData.d.mts +11 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/GroupPlacementData.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/IncludedResource.d.mts +6 -3
- package/dist/{cjs/api/resources/organizations/resources/placements/types/MainPagePlacementAttributes.d.ts → esm/api/resources/organizations/resources/placements/types/PlacementAttributes.d.mts} +2 -2
- package/dist/esm/api/resources/organizations/resources/placements/types/PlacementAttributes.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/PlacementData.d.mts +11 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/PlacementData.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/PlacementFormatUnion.d.mts +44 -4
- package/dist/esm/api/resources/organizations/resources/placements/types/PlacementListResponse.d.mts +1 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/PlacementResource.d.mts +1 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/PlacementTypeFilter.d.mts +3 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/PlacementTypeFilter.mjs +3 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/SlottedPlacementRelationships.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/SlottedPlacementRelationships.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateBatchActivationSlot.d.mts +1 -1
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateEmailAttributes.d.mts +25 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateEmailAttributes.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateEmailPlacementData.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateEmailPlacementData.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateGroupAttributes.d.mts +21 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateGroupAttributes.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateGroupPlacementData.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateGroupPlacementData.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdatePlacementDataUnion.d.mts +9 -3
- package/dist/esm/api/resources/organizations/resources/placements/types/{UpdateMainPageAttributes.d.mts → UpdateStandardAttributes.d.mts} +2 -2
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateStandardAttributes.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateStandardPlacementData.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateStandardPlacementData.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/index.d.mts +19 -7
- package/dist/esm/api/resources/organizations/resources/placements/types/index.mjs +19 -7
- package/dist/esm/api/resources/users/resources/rewards/client/Client.d.mts +12 -8
- package/dist/esm/api/resources/users/resources/rewards/client/Client.mjs +12 -8
- package/dist/esm/api/resources/users/resources/rewards/types/BatchesResponseObject.d.mts +1 -1
- package/dist/esm/api/resources/users/resources/rewards/types/PlacementBatchAttributes.d.mts +2 -2
- package/dist/esm/api/resources/users/resources/rewards/types/PlacementBatchData.d.mts +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +16 -12
- package/dist/cjs/api/resources/organizations/resources/placements/types/BatchActivationPlacementRelationships.d.ts +0 -8
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateMainPagePlacementData.d.ts +0 -8
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateMainPagePlacementData.d.ts +0 -8
- package/dist/esm/api/resources/organizations/resources/placements/types/BatchActivationPlacementRelationships.d.mts +0 -8
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateMainPagePlacementData.d.mts +0 -8
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateMainPagePlacementData.d.mts +0 -8
- /package/dist/cjs/api/resources/{organizations/resources/placements/types/BatchActivationPlacementRelationships.js → notifications/types/EmailNotificationPlacementFileAttributes.js} +0 -0
- /package/dist/cjs/api/resources/{organizations/resources/placements/types/CreateMainPageAttributes.js → notifications/types/EmailNotificationPlacementFileData.js} +0 -0
- /package/dist/cjs/api/resources/{organizations/resources/placements/types/CreateMainPagePlacementData.js → notifications/types/EmailNotificationPlacementFileRelationships.js} +0 -0
- /package/dist/cjs/api/resources/{organizations/resources/placements/types/MainPagePlacementAttributes.js → notifications/types/PushNotificationPlacementFileAttributes.js} +0 -0
- /package/dist/cjs/api/resources/{organizations/resources/placements/types/MainPagePlacementData.js → notifications/types/PushNotificationPlacementFileData.js} +0 -0
- /package/dist/cjs/api/resources/{organizations/resources/placements/types/UpdateMainPageAttributes.js → notifications/types/PushNotificationPlacementFileRelationships.js} +0 -0
- /package/dist/cjs/api/resources/organizations/resources/placements/types/{UpdateMainPagePlacementData.js → CreateEmailAttributes.js} +0 -0
- /package/dist/esm/api/resources/{organizations/resources/placements/types/BatchActivationPlacementRelationships.mjs → notifications/types/EmailNotificationPlacementFileAttributes.mjs} +0 -0
- /package/dist/esm/api/resources/{organizations/resources/placements/types/CreateMainPageAttributes.mjs → notifications/types/EmailNotificationPlacementFileData.mjs} +0 -0
- /package/dist/esm/api/resources/{organizations/resources/placements/types/CreateMainPagePlacementData.mjs → notifications/types/EmailNotificationPlacementFileRelationships.mjs} +0 -0
- /package/dist/esm/api/resources/{organizations/resources/placements/types/MainPagePlacementAttributes.mjs → notifications/types/PushNotificationPlacementFileAttributes.mjs} +0 -0
- /package/dist/esm/api/resources/{organizations/resources/placements/types/MainPagePlacementData.mjs → notifications/types/PushNotificationPlacementFileData.mjs} +0 -0
- /package/dist/esm/api/resources/{organizations/resources/placements/types/UpdateMainPageAttributes.mjs → notifications/types/PushNotificationPlacementFileRelationships.mjs} +0 -0
- /package/dist/esm/api/resources/organizations/resources/placements/types/{UpdateMainPagePlacementData.mjs → CreateEmailAttributes.mjs} +0 -0
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Attributes for creating a
|
|
2
|
+
* Attributes for creating a standard placement
|
|
3
3
|
*
|
|
4
4
|
* @example
|
|
5
5
|
* {
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* availableSlots: 5
|
|
8
8
|
* }
|
|
9
9
|
*/
|
|
10
|
-
export interface
|
|
10
|
+
export interface CreateStandardAttributes {
|
|
11
11
|
/** Name of the placement */
|
|
12
12
|
name: string;
|
|
13
13
|
/** Number of available slots (minimum 1) */
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Data for creating a standard placement
|
|
4
|
+
*/
|
|
5
|
+
export interface CreateStandardPlacementData {
|
|
6
|
+
/** Standard placement attributes for creation */
|
|
7
|
+
attributes: KardApi.organizations.CreateStandardAttributes;
|
|
8
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Attributes for an email placement
|
|
4
|
+
*/
|
|
5
|
+
export interface EmailPlacementAttributes {
|
|
6
|
+
/** Name of the placement */
|
|
7
|
+
name: string;
|
|
8
|
+
/** ID of the organization this placement belongs to */
|
|
9
|
+
organizationId: string;
|
|
10
|
+
/** Number of available slots */
|
|
11
|
+
availableSlots: number;
|
|
12
|
+
/** Delivery cadence for the email */
|
|
13
|
+
cadence: KardApi.organizations.Cadence;
|
|
14
|
+
/** ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility. */
|
|
15
|
+
contentStrategyId?: string | undefined;
|
|
16
|
+
}
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import type * as KardApi from "../../../../../index.js";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Email placement resource data
|
|
4
4
|
*/
|
|
5
|
-
export interface
|
|
5
|
+
export interface EmailPlacementData {
|
|
6
6
|
/** Unique identifier of the placement (UUID v7) */
|
|
7
7
|
id: string;
|
|
8
|
-
attributes: KardApi.organizations.
|
|
8
|
+
attributes: KardApi.organizations.EmailPlacementAttributes;
|
|
9
9
|
/** JSON:API relationships for the placement. Omitted entirely when the placement has no linked resources. */
|
|
10
10
|
relationships?: KardApi.organizations.PlacementRelationships | undefined;
|
|
11
11
|
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Attributes for a group placement. A group is configured like a batch-activation placement but has no refreshInterval. 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.
|
|
3
|
+
*/
|
|
4
|
+
export interface GroupPlacementAttributes {
|
|
5
|
+
/** Name of the placement */
|
|
6
|
+
name: string;
|
|
7
|
+
/** ID of the organization this placement belongs to */
|
|
8
|
+
organizationId: string;
|
|
9
|
+
}
|
package/dist/cjs/api/resources/organizations/resources/placements/types/GroupPlacementData.d.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Group placement resource data
|
|
4
|
+
*/
|
|
5
|
+
export interface GroupPlacementData {
|
|
6
|
+
/** Unique identifier of the placement (UUID v7) */
|
|
7
|
+
id: string;
|
|
8
|
+
attributes: KardApi.organizations.GroupPlacementAttributes;
|
|
9
|
+
/** JSON:API relationships for the placement. Always present on a group placement; the `slots` to-many relationship lists the slot resource identifiers. */
|
|
10
|
+
relationships: KardApi.organizations.SlottedPlacementRelationships;
|
|
11
|
+
}
|
package/dist/cjs/api/resources/organizations/resources/placements/types/IncludedResource.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import type * as KardApi from "../../../../../index.js";
|
|
|
2
2
|
/**
|
|
3
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
4
|
*/
|
|
5
|
-
export type IncludedResource = KardApi.organizations.IncludedResource.ContentStrategy | KardApi.organizations.IncludedResource.BatchActivationSlot | KardApi.organizations.IncludedResource.
|
|
5
|
+
export type IncludedResource = KardApi.organizations.IncludedResource.ContentStrategy | KardApi.organizations.IncludedResource.BatchActivationSlot | KardApi.organizations.IncludedResource.Placement | KardApi.organizations.IncludedResource.PlacementPushNotification | KardApi.organizations.IncludedResource.PlacementEmail;
|
|
6
6
|
export declare namespace IncludedResource {
|
|
7
7
|
interface ContentStrategy extends KardApi.organizations.ContentStrategyInclusion {
|
|
8
8
|
type: "contentStrategy";
|
|
@@ -10,10 +10,13 @@ export declare namespace IncludedResource {
|
|
|
10
10
|
interface BatchActivationSlot extends KardApi.organizations.BatchActivationSlotInclusion {
|
|
11
11
|
type: "batchActivationSlot";
|
|
12
12
|
}
|
|
13
|
-
interface
|
|
14
|
-
type: "
|
|
13
|
+
interface Placement extends KardApi.organizations.PlacementData {
|
|
14
|
+
type: "placement";
|
|
15
15
|
}
|
|
16
16
|
interface PlacementPushNotification extends KardApi.organizations.PushNotificationPlacementData {
|
|
17
17
|
type: "placementPushNotification";
|
|
18
18
|
}
|
|
19
|
+
interface PlacementEmail extends KardApi.organizations.EmailPlacementData {
|
|
20
|
+
type: "placementEmail";
|
|
21
|
+
}
|
|
19
22
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Attributes for a
|
|
2
|
+
* Attributes for a standard placement
|
|
3
3
|
*/
|
|
4
|
-
export interface
|
|
4
|
+
export interface PlacementAttributes {
|
|
5
5
|
/** Name of the placement */
|
|
6
6
|
name: string;
|
|
7
7
|
/** ID of the organization this placement belongs to */
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Standard placement resource data
|
|
4
|
+
*/
|
|
5
|
+
export interface PlacementData {
|
|
6
|
+
/** Unique identifier of the placement (UUID v7) */
|
|
7
|
+
id: string;
|
|
8
|
+
attributes: KardApi.organizations.PlacementAttributes;
|
|
9
|
+
/** JSON:API relationships for the placement. Omitted entirely when the placement has no linked resources. */
|
|
10
|
+
relationships?: KardApi.organizations.PlacementRelationships | undefined;
|
|
11
|
+
}
|
package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementFormatUnion.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ import type * as KardApi from "../../../../../index.js";
|
|
|
4
4
|
*
|
|
5
5
|
* @example
|
|
6
6
|
* {
|
|
7
|
-
* type: "
|
|
7
|
+
* type: "placement",
|
|
8
8
|
* id: "01961e5a-b74c-7d42-8456-d3a1f2c90e71",
|
|
9
9
|
* attributes: {
|
|
10
10
|
* name: "Homepage Banner",
|
|
@@ -29,6 +29,22 @@ import type * as KardApi from "../../../../../index.js";
|
|
|
29
29
|
*
|
|
30
30
|
* @example
|
|
31
31
|
* {
|
|
32
|
+
* type: "placementEmail",
|
|
33
|
+
* id: "01961e5a-f37a-7b55-9d6a-2be8d1ac5f78",
|
|
34
|
+
* attributes: {
|
|
35
|
+
* name: "Weekly Deals Email",
|
|
36
|
+
* organizationId: "org-123",
|
|
37
|
+
* availableSlots: 10,
|
|
38
|
+
* cadence: {
|
|
39
|
+
* frequency: KardApi.organizations.CadenceFrequency.Weekly,
|
|
40
|
+
* timeOfDay: "10:00",
|
|
41
|
+
* dayOfWeek: KardApi.organizations.DayOfWeek.Mon
|
|
42
|
+
* }
|
|
43
|
+
* }
|
|
44
|
+
* }
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* {
|
|
32
48
|
* type: "placementBatchActivation",
|
|
33
49
|
* id: "01961e5a-d94e-7c22-ac3f-f8b5a7e92c45",
|
|
34
50
|
* attributes: {
|
|
@@ -45,16 +61,40 @@ import type * as KardApi from "../../../../../index.js";
|
|
|
45
61
|
* }
|
|
46
62
|
* }
|
|
47
63
|
* }
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
* {
|
|
67
|
+
* type: "placementGroup",
|
|
68
|
+
* id: "01961e5a-a48b-7e66-8c7b-3cf9e2bd6a89",
|
|
69
|
+
* attributes: {
|
|
70
|
+
* name: "Seasonal Collection",
|
|
71
|
+
* organizationId: "org-123"
|
|
72
|
+
* },
|
|
73
|
+
* relationships: {
|
|
74
|
+
* slots: {
|
|
75
|
+
* data: [{
|
|
76
|
+
* type: "batchActivationSlot",
|
|
77
|
+
* id: "01961e5a-b59c-7f77-9d8c-4d0af3ce7b9a"
|
|
78
|
+
* }]
|
|
79
|
+
* }
|
|
80
|
+
* }
|
|
81
|
+
* }
|
|
48
82
|
*/
|
|
49
|
-
export type PlacementFormatUnion = KardApi.organizations.PlacementFormatUnion.
|
|
83
|
+
export type PlacementFormatUnion = KardApi.organizations.PlacementFormatUnion.Placement | KardApi.organizations.PlacementFormatUnion.PlacementPushNotification | KardApi.organizations.PlacementFormatUnion.PlacementEmail | KardApi.organizations.PlacementFormatUnion.PlacementBatchActivation | KardApi.organizations.PlacementFormatUnion.PlacementGroup;
|
|
50
84
|
export declare namespace PlacementFormatUnion {
|
|
51
|
-
interface
|
|
52
|
-
type: "
|
|
85
|
+
interface Placement extends KardApi.organizations.PlacementData {
|
|
86
|
+
type: "placement";
|
|
53
87
|
}
|
|
54
88
|
interface PlacementPushNotification extends KardApi.organizations.PushNotificationPlacementData {
|
|
55
89
|
type: "placementPushNotification";
|
|
56
90
|
}
|
|
91
|
+
interface PlacementEmail extends KardApi.organizations.EmailPlacementData {
|
|
92
|
+
type: "placementEmail";
|
|
93
|
+
}
|
|
57
94
|
interface PlacementBatchActivation extends KardApi.organizations.BatchActivationPlacementData {
|
|
58
95
|
type: "placementBatchActivation";
|
|
59
96
|
}
|
|
97
|
+
interface PlacementGroup extends KardApi.organizations.GroupPlacementData {
|
|
98
|
+
type: "placementGroup";
|
|
99
|
+
}
|
|
60
100
|
}
|
package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementListResponse.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ 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. Each entry is keyed by its `type` discriminant (`contentStrategy`, `batchActivationSlot`, `
|
|
8
|
+
/** Related resources requested via the `include` query parameter. Each entry is keyed by its `type` discriminant (`contentStrategy`, `batchActivationSlot`, `placement`, `placementPushNotification`, `placementEmail`). */
|
|
9
9
|
included?: KardApi.organizations.IncludedResource[] | undefined;
|
|
10
10
|
links?: KardApi.Links | undefined;
|
|
11
11
|
/** Pagination metadata */
|
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. Each entry is keyed by its `type` discriminant (`contentStrategy`, `batchActivationSlot`, `
|
|
8
|
+
/** Related resources requested via the `include` query parameter. Each entry is keyed by its `type` discriminant (`contentStrategy`, `batchActivationSlot`, `placement`, `placementPushNotification`, `placementEmail`). */
|
|
9
9
|
included?: KardApi.organizations.IncludedResource[] | undefined;
|
|
10
10
|
}
|
package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementTypeFilter.d.ts
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
/** Placement type discriminator used as a list filter */
|
|
2
2
|
export declare const PlacementTypeFilter: {
|
|
3
|
-
readonly
|
|
3
|
+
readonly Placement: "placement";
|
|
4
4
|
readonly PlacementPushNotification: "placementPushNotification";
|
|
5
|
+
readonly PlacementEmail: "placementEmail";
|
|
5
6
|
readonly PlacementBatchActivation: "placementBatchActivation";
|
|
7
|
+
readonly PlacementGroup: "placementGroup";
|
|
6
8
|
};
|
|
7
9
|
export type PlacementTypeFilter = (typeof PlacementTypeFilter)[keyof typeof PlacementTypeFilter];
|
package/dist/cjs/api/resources/organizations/resources/placements/types/PlacementTypeFilter.js
CHANGED
|
@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.PlacementTypeFilter = void 0;
|
|
5
5
|
/** Placement type discriminator used as a list filter */
|
|
6
6
|
exports.PlacementTypeFilter = {
|
|
7
|
-
|
|
7
|
+
Placement: "placement",
|
|
8
8
|
PlacementPushNotification: "placementPushNotification",
|
|
9
|
+
PlacementEmail: "placementEmail",
|
|
9
10
|
PlacementBatchActivation: "placementBatchActivation",
|
|
11
|
+
PlacementGroup: "placementGroup",
|
|
10
12
|
};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Relationship block for a batch-activation or group placement.
|
|
4
|
+
*/
|
|
5
|
+
export interface SlottedPlacementRelationships {
|
|
6
|
+
/** Resource identifiers for the slots that make up the placement. 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,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* A slot in a batch-activation placement at update time
|
|
2
|
+
* A slot in a batch-activation or group placement at update time
|
|
3
3
|
*/
|
|
4
4
|
export interface UpdateBatchActivationSlot {
|
|
5
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. */
|
package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateEmailAttributes.d.ts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Attributes for updating an email placement. All fields are required.
|
|
4
|
+
*
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* name: "Updated Email",
|
|
8
|
+
* availableSlots: 8,
|
|
9
|
+
* cadence: {
|
|
10
|
+
* frequency: KardApi.organizations.CadenceFrequency.Monthly,
|
|
11
|
+
* timeOfDay: "08:00",
|
|
12
|
+
* dayOfMonth: 1
|
|
13
|
+
* }
|
|
14
|
+
* }
|
|
15
|
+
*/
|
|
16
|
+
export interface UpdateEmailAttributes {
|
|
17
|
+
/** Name of the placement */
|
|
18
|
+
name: string;
|
|
19
|
+
/** Number of available slots (minimum 1) */
|
|
20
|
+
availableSlots: number;
|
|
21
|
+
/** Delivery cadence for the email */
|
|
22
|
+
cadence: KardApi.organizations.Cadence;
|
|
23
|
+
/** ID of the content strategy to link this placement to. Omit to clear any existing link (PUT requires the full attribute set, so a missing value unlinks the placement). */
|
|
24
|
+
contentStrategyId?: string | undefined;
|
|
25
|
+
}
|
package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateGroupAttributes.d.ts
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
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
|
+
}
|
|
@@ -2,15 +2,21 @@ import type * as KardApi from "../../../../../index.js";
|
|
|
2
2
|
/**
|
|
3
3
|
* Discriminated union for updating a placement
|
|
4
4
|
*/
|
|
5
|
-
export type UpdatePlacementDataUnion = KardApi.organizations.UpdatePlacementDataUnion.
|
|
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
|
|
8
|
-
type: "
|
|
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
|
|
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
|
|
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,8 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
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
|
+
}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
export * from "./BatchActivationPlacementAttributes.js";
|
|
2
2
|
export * from "./BatchActivationPlacementData.js";
|
|
3
|
-
export * from "./BatchActivationPlacementRelationships.js";
|
|
4
3
|
export * from "./BatchActivationSlotAttributes.js";
|
|
5
4
|
export * from "./BatchActivationSlotInclusion.js";
|
|
6
5
|
export * from "./BatchActivationSlotRelationships.js";
|
|
@@ -10,16 +9,24 @@ export * from "./ContentStrategyInclusion.js";
|
|
|
10
9
|
export * from "./CreateBatchActivationAttributes.js";
|
|
11
10
|
export * from "./CreateBatchActivationPlacementData.js";
|
|
12
11
|
export * from "./CreateBatchActivationSlot.js";
|
|
13
|
-
export * from "./
|
|
14
|
-
export * from "./
|
|
12
|
+
export * from "./CreateEmailAttributes.js";
|
|
13
|
+
export * from "./CreateEmailPlacementData.js";
|
|
14
|
+
export * from "./CreateGroupAttributes.js";
|
|
15
|
+
export * from "./CreateGroupPlacementData.js";
|
|
15
16
|
export * from "./CreatePlacementDataUnion.js";
|
|
16
17
|
export * from "./CreatePlacementRequestBody.js";
|
|
17
18
|
export * from "./CreatePushNotificationAttributes.js";
|
|
18
19
|
export * from "./CreatePushNotificationPlacementData.js";
|
|
20
|
+
export * from "./CreateStandardAttributes.js";
|
|
21
|
+
export * from "./CreateStandardPlacementData.js";
|
|
19
22
|
export * from "./DayOfWeek.js";
|
|
23
|
+
export * from "./EmailPlacementAttributes.js";
|
|
24
|
+
export * from "./EmailPlacementData.js";
|
|
25
|
+
export * from "./GroupPlacementAttributes.js";
|
|
26
|
+
export * from "./GroupPlacementData.js";
|
|
20
27
|
export * from "./IncludedResource.js";
|
|
21
|
-
export * from "./
|
|
22
|
-
export * from "./
|
|
28
|
+
export * from "./PlacementAttributes.js";
|
|
29
|
+
export * from "./PlacementData.js";
|
|
23
30
|
export * from "./PlacementFormatUnion.js";
|
|
24
31
|
export * from "./PlacementListResponse.js";
|
|
25
32
|
export * from "./PlacementRelationships.js";
|
|
@@ -28,14 +35,19 @@ export * from "./PlacementTypeFilter.js";
|
|
|
28
35
|
export * from "./PushNotificationPlacementAttributes.js";
|
|
29
36
|
export * from "./PushNotificationPlacementData.js";
|
|
30
37
|
export * from "./ResourceIdentifier.js";
|
|
38
|
+
export * from "./SlottedPlacementRelationships.js";
|
|
31
39
|
export * from "./ToManyRelationship.js";
|
|
32
40
|
export * from "./ToOneRelationship.js";
|
|
33
41
|
export * from "./UpdateBatchActivationAttributes.js";
|
|
34
42
|
export * from "./UpdateBatchActivationPlacementData.js";
|
|
35
43
|
export * from "./UpdateBatchActivationSlot.js";
|
|
36
|
-
export * from "./
|
|
37
|
-
export * from "./
|
|
44
|
+
export * from "./UpdateEmailAttributes.js";
|
|
45
|
+
export * from "./UpdateEmailPlacementData.js";
|
|
46
|
+
export * from "./UpdateGroupAttributes.js";
|
|
47
|
+
export * from "./UpdateGroupPlacementData.js";
|
|
38
48
|
export * from "./UpdatePlacementDataUnion.js";
|
|
39
49
|
export * from "./UpdatePlacementRequestBody.js";
|
|
40
50
|
export * from "./UpdatePushNotificationAttributes.js";
|
|
41
51
|
export * from "./UpdatePushNotificationPlacementData.js";
|
|
52
|
+
export * from "./UpdateStandardAttributes.js";
|
|
53
|
+
export * from "./UpdateStandardPlacementData.js";
|
|
@@ -16,7 +16,6 @@ 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("./BatchActivationPlacementRelationships.js"), exports);
|
|
20
19
|
__exportStar(require("./BatchActivationSlotAttributes.js"), exports);
|
|
21
20
|
__exportStar(require("./BatchActivationSlotInclusion.js"), exports);
|
|
22
21
|
__exportStar(require("./BatchActivationSlotRelationships.js"), exports);
|
|
@@ -26,16 +25,24 @@ __exportStar(require("./ContentStrategyInclusion.js"), exports);
|
|
|
26
25
|
__exportStar(require("./CreateBatchActivationAttributes.js"), exports);
|
|
27
26
|
__exportStar(require("./CreateBatchActivationPlacementData.js"), exports);
|
|
28
27
|
__exportStar(require("./CreateBatchActivationSlot.js"), exports);
|
|
29
|
-
__exportStar(require("./
|
|
30
|
-
__exportStar(require("./
|
|
28
|
+
__exportStar(require("./CreateEmailAttributes.js"), exports);
|
|
29
|
+
__exportStar(require("./CreateEmailPlacementData.js"), exports);
|
|
30
|
+
__exportStar(require("./CreateGroupAttributes.js"), exports);
|
|
31
|
+
__exportStar(require("./CreateGroupPlacementData.js"), exports);
|
|
31
32
|
__exportStar(require("./CreatePlacementDataUnion.js"), exports);
|
|
32
33
|
__exportStar(require("./CreatePlacementRequestBody.js"), exports);
|
|
33
34
|
__exportStar(require("./CreatePushNotificationAttributes.js"), exports);
|
|
34
35
|
__exportStar(require("./CreatePushNotificationPlacementData.js"), exports);
|
|
36
|
+
__exportStar(require("./CreateStandardAttributes.js"), exports);
|
|
37
|
+
__exportStar(require("./CreateStandardPlacementData.js"), exports);
|
|
35
38
|
__exportStar(require("./DayOfWeek.js"), exports);
|
|
39
|
+
__exportStar(require("./EmailPlacementAttributes.js"), exports);
|
|
40
|
+
__exportStar(require("./EmailPlacementData.js"), exports);
|
|
41
|
+
__exportStar(require("./GroupPlacementAttributes.js"), exports);
|
|
42
|
+
__exportStar(require("./GroupPlacementData.js"), exports);
|
|
36
43
|
__exportStar(require("./IncludedResource.js"), exports);
|
|
37
|
-
__exportStar(require("./
|
|
38
|
-
__exportStar(require("./
|
|
44
|
+
__exportStar(require("./PlacementAttributes.js"), exports);
|
|
45
|
+
__exportStar(require("./PlacementData.js"), exports);
|
|
39
46
|
__exportStar(require("./PlacementFormatUnion.js"), exports);
|
|
40
47
|
__exportStar(require("./PlacementListResponse.js"), exports);
|
|
41
48
|
__exportStar(require("./PlacementRelationships.js"), exports);
|
|
@@ -44,14 +51,19 @@ __exportStar(require("./PlacementTypeFilter.js"), exports);
|
|
|
44
51
|
__exportStar(require("./PushNotificationPlacementAttributes.js"), exports);
|
|
45
52
|
__exportStar(require("./PushNotificationPlacementData.js"), exports);
|
|
46
53
|
__exportStar(require("./ResourceIdentifier.js"), exports);
|
|
54
|
+
__exportStar(require("./SlottedPlacementRelationships.js"), exports);
|
|
47
55
|
__exportStar(require("./ToManyRelationship.js"), exports);
|
|
48
56
|
__exportStar(require("./ToOneRelationship.js"), exports);
|
|
49
57
|
__exportStar(require("./UpdateBatchActivationAttributes.js"), exports);
|
|
50
58
|
__exportStar(require("./UpdateBatchActivationPlacementData.js"), exports);
|
|
51
59
|
__exportStar(require("./UpdateBatchActivationSlot.js"), exports);
|
|
52
|
-
__exportStar(require("./
|
|
53
|
-
__exportStar(require("./
|
|
60
|
+
__exportStar(require("./UpdateEmailAttributes.js"), exports);
|
|
61
|
+
__exportStar(require("./UpdateEmailPlacementData.js"), exports);
|
|
62
|
+
__exportStar(require("./UpdateGroupAttributes.js"), exports);
|
|
63
|
+
__exportStar(require("./UpdateGroupPlacementData.js"), exports);
|
|
54
64
|
__exportStar(require("./UpdatePlacementDataUnion.js"), exports);
|
|
55
65
|
__exportStar(require("./UpdatePlacementRequestBody.js"), exports);
|
|
56
66
|
__exportStar(require("./UpdatePushNotificationAttributes.js"), exports);
|
|
57
67
|
__exportStar(require("./UpdatePushNotificationPlacementData.js"), exports);
|
|
68
|
+
__exportStar(require("./UpdateStandardAttributes.js"), exports);
|
|
69
|
+
__exportStar(require("./UpdateStandardPlacementData.js"), exports);
|
|
@@ -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
|
|
61
|
-
* order with its current offer set, alias, and freshness fields
|
|
62
|
-
* `lastActivatedAt`, `expiresAt`). Applies the same per-user
|
|
63
|
-
* per-slot content-strategy filter as Get Offers By
|
|
64
|
-
* per slot.
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
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
|