@kard-financial/sdk 18.0.0 → 18.2.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/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/organizations/client/Client.js +7 -2
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/client/Client.d.ts +127 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/client/Client.js +414 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/client/index.js +17 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/client/requests/ListContentStrategiesRequest.d.ts +12 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/client/requests/ListContentStrategiesRequest.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/exports.d.ts +2 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/exports.js +21 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/index.d.ts +2 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/index.js +18 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/ContentStrategyAttributes.d.ts +22 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/ContentStrategyAttributes.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/ContentStrategyFilter.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/ContentStrategyFilter.js +11 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/ContentStrategyListResponse.d.ts +11 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/ContentStrategyListResponse.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/ContentStrategyResponse.d.ts +26 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/ContentStrategyResponse.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/CreateContentStrategyAttributes.d.ts +25 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/CreateContentStrategyAttributes.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/CreateContentStrategyRequestBody.d.ts +22 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/CreateContentStrategyRequestBody.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/CreateContentStrategyRequestData.d.ts +10 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/CreateContentStrategyRequestData.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/UpdateContentStrategyAttributes.d.ts +25 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/UpdateContentStrategyAttributes.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/UpdateContentStrategyRequestBody.d.ts +8 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/UpdateContentStrategyRequestBody.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/UpdateContentStrategyRequestData.d.ts +10 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/UpdateContentStrategyRequestData.js +3 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/index.d.ts +10 -0
- package/dist/cjs/api/resources/organizations/resources/contentStrategies/types/index.js +26 -0
- package/dist/cjs/api/resources/organizations/resources/index.d.ts +3 -0
- package/dist/cjs/api/resources/organizations/resources/index.js +4 -1
- package/dist/cjs/api/resources/organizations/resources/placements/client/Client.js +2 -1
- package/dist/cjs/api/resources/organizations/resources/placements/client/requests/ListPlacementsRequest.d.ts +2 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreateMainPageAttributes.d.ts +2 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/CreatePushNotificationAttributes.d.ts +2 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/MainPagePlacementAttributes.d.ts +2 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/PushNotificationPlacementAttributes.d.ts +2 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdateMainPageAttributes.d.ts +2 -0
- package/dist/cjs/api/resources/organizations/resources/placements/types/UpdatePushNotificationAttributes.d.ts +2 -0
- 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/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/organizations/client/Client.mjs +5 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/client/Client.d.mts +127 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/client/Client.mjs +377 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/client/index.d.mts +1 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/client/index.mjs +1 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/client/requests/ListContentStrategiesRequest.d.mts +12 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/client/requests/ListContentStrategiesRequest.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/exports.d.mts +2 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/exports.mjs +3 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/index.d.mts +2 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/index.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/ContentStrategyAttributes.d.mts +22 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/ContentStrategyAttributes.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/ContentStrategyFilter.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/ContentStrategyFilter.mjs +8 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/ContentStrategyListResponse.d.mts +11 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/ContentStrategyListResponse.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/ContentStrategyResponse.d.mts +26 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/ContentStrategyResponse.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/CreateContentStrategyAttributes.d.mts +25 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/CreateContentStrategyAttributes.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/CreateContentStrategyRequestBody.d.mts +22 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/CreateContentStrategyRequestBody.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/CreateContentStrategyRequestData.d.mts +10 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/CreateContentStrategyRequestData.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/UpdateContentStrategyAttributes.d.mts +25 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/UpdateContentStrategyAttributes.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/UpdateContentStrategyRequestBody.d.mts +8 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/UpdateContentStrategyRequestBody.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/UpdateContentStrategyRequestData.d.mts +10 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/UpdateContentStrategyRequestData.mjs +2 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/index.d.mts +10 -0
- package/dist/esm/api/resources/organizations/resources/contentStrategies/types/index.mjs +10 -0
- package/dist/esm/api/resources/organizations/resources/index.d.mts +3 -0
- package/dist/esm/api/resources/organizations/resources/index.mjs +3 -0
- package/dist/esm/api/resources/organizations/resources/placements/client/Client.mjs +2 -1
- package/dist/esm/api/resources/organizations/resources/placements/client/requests/ListPlacementsRequest.d.mts +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/CreateMainPageAttributes.d.mts +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/CreatePushNotificationAttributes.d.mts +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/MainPagePlacementAttributes.d.mts +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/PushNotificationPlacementAttributes.d.mts +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdateMainPageAttributes.d.mts +2 -0
- package/dist/esm/api/resources/organizations/resources/placements/types/UpdatePushNotificationAttributes.d.mts +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +12 -1
- package/reference.md +386 -0
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Content strategy data structure for update
|
|
4
|
+
*/
|
|
5
|
+
export interface UpdateContentStrategyRequestData {
|
|
6
|
+
/** Resource type identifier */
|
|
7
|
+
type: "contentStrategy";
|
|
8
|
+
/** Content strategy attributes for update */
|
|
9
|
+
attributes: KardApi.organizations.UpdateContentStrategyAttributes;
|
|
10
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export * from "./ContentStrategyAttributes.mjs";
|
|
2
|
+
export * from "./ContentStrategyFilter.mjs";
|
|
3
|
+
export * from "./ContentStrategyListResponse.mjs";
|
|
4
|
+
export * from "./ContentStrategyResponse.mjs";
|
|
5
|
+
export * from "./CreateContentStrategyAttributes.mjs";
|
|
6
|
+
export * from "./CreateContentStrategyRequestBody.mjs";
|
|
7
|
+
export * from "./CreateContentStrategyRequestData.mjs";
|
|
8
|
+
export * from "./UpdateContentStrategyAttributes.mjs";
|
|
9
|
+
export * from "./UpdateContentStrategyRequestBody.mjs";
|
|
10
|
+
export * from "./UpdateContentStrategyRequestData.mjs";
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export * from "./ContentStrategyAttributes.mjs";
|
|
2
|
+
export * from "./ContentStrategyFilter.mjs";
|
|
3
|
+
export * from "./ContentStrategyListResponse.mjs";
|
|
4
|
+
export * from "./ContentStrategyResponse.mjs";
|
|
5
|
+
export * from "./CreateContentStrategyAttributes.mjs";
|
|
6
|
+
export * from "./CreateContentStrategyRequestBody.mjs";
|
|
7
|
+
export * from "./CreateContentStrategyRequestData.mjs";
|
|
8
|
+
export * from "./UpdateContentStrategyAttributes.mjs";
|
|
9
|
+
export * from "./UpdateContentStrategyRequestBody.mjs";
|
|
10
|
+
export * from "./UpdateContentStrategyRequestData.mjs";
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
export * from "./children/client/requests/index.mjs";
|
|
2
2
|
export * as children from "./children/index.mjs";
|
|
3
3
|
export * from "./children/types/index.mjs";
|
|
4
|
+
export * from "./contentStrategies/client/requests/index.mjs";
|
|
5
|
+
export * as contentStrategies from "./contentStrategies/index.mjs";
|
|
6
|
+
export * from "./contentStrategies/types/index.mjs";
|
|
4
7
|
export * from "./placements/client/requests/index.mjs";
|
|
5
8
|
export * as placements from "./placements/index.mjs";
|
|
6
9
|
export * from "./placements/types/index.mjs";
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
export * from "./children/client/requests/index.mjs";
|
|
2
2
|
export * as children from "./children/index.mjs";
|
|
3
3
|
export * from "./children/types/index.mjs";
|
|
4
|
+
export * from "./contentStrategies/client/requests/index.mjs";
|
|
5
|
+
export * as contentStrategies from "./contentStrategies/index.mjs";
|
|
6
|
+
export * from "./contentStrategies/types/index.mjs";
|
|
4
7
|
export * from "./placements/client/requests/index.mjs";
|
|
5
8
|
export * as placements from "./placements/index.mjs";
|
|
6
9
|
export * from "./placements/types/index.mjs";
|
|
@@ -130,10 +130,11 @@ export class PlacementsClient {
|
|
|
130
130
|
__list(organizationId_1) {
|
|
131
131
|
return __awaiter(this, arguments, void 0, function* (organizationId, request = {}, requestOptions) {
|
|
132
132
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
133
|
-
const { "filter[type]": filterType, "filter[name]": filterName, "page[after]": pageAfter, "page[size]": pageSize, } = request;
|
|
133
|
+
const { "filter[type]": filterType, "filter[name]": filterName, "filter[contentStrategyId]": filterContentStrategyId, "page[after]": pageAfter, "page[size]": pageSize, } = request;
|
|
134
134
|
const _queryParams = {
|
|
135
135
|
"filter[type]": filterType != null ? filterType : undefined,
|
|
136
136
|
"filter[name]": filterName,
|
|
137
|
+
"filter[contentStrategyId]": filterContentStrategyId,
|
|
137
138
|
"page[after]": pageAfter,
|
|
138
139
|
"page[size]": pageSize,
|
|
139
140
|
};
|
|
@@ -8,6 +8,8 @@ export interface ListPlacementsRequest {
|
|
|
8
8
|
"filter[type]"?: KardApi.organizations.PlacementTypeFilter;
|
|
9
9
|
/** Filter by exact placement name (unique within an organization per type) */
|
|
10
10
|
"filter[name]"?: string;
|
|
11
|
+
/** Filter by the ID of the content strategy linked to the placement */
|
|
12
|
+
"filter[contentStrategyId]"?: string;
|
|
11
13
|
/** Cursor value for the next page of results */
|
|
12
14
|
"page[after]"?: string;
|
|
13
15
|
/** Maximum number of records to return [1 - 200] (default = 200) */
|
|
@@ -16,4 +16,6 @@ export interface CreatePushNotificationAttributes {
|
|
|
16
16
|
name: string;
|
|
17
17
|
/** Delivery cadence for the notification */
|
|
18
18
|
cadence: KardApi.organizations.Cadence;
|
|
19
|
+
/** ID of the content strategy to link this placement to */
|
|
20
|
+
contentStrategyId?: string | undefined;
|
|
19
21
|
}
|
|
@@ -8,6 +8,8 @@ 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 */
|
|
12
|
+
contentStrategyId?: string | undefined;
|
|
11
13
|
/** When the placement was created (ISO 8601 UTC) */
|
|
12
14
|
createdAt: string;
|
|
13
15
|
/** When the placement was last modified (ISO 8601 UTC) */
|
|
@@ -9,6 +9,8 @@ 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 */
|
|
13
|
+
contentStrategyId?: string | undefined;
|
|
12
14
|
/** When the placement was created (ISO 8601 UTC) */
|
|
13
15
|
createdAt: string;
|
|
14
16
|
/** When the placement was last modified (ISO 8601 UTC) */
|
|
@@ -12,4 +12,6 @@ export interface UpdateMainPageAttributes {
|
|
|
12
12
|
name: string;
|
|
13
13
|
/** Number of available slots (minimum 1) */
|
|
14
14
|
availableSlots: number;
|
|
15
|
+
/** 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). */
|
|
16
|
+
contentStrategyId?: string | undefined;
|
|
15
17
|
}
|
|
@@ -17,4 +17,6 @@ export interface UpdatePushNotificationAttributes {
|
|
|
17
17
|
name: string;
|
|
18
18
|
/** Delivery cadence for the notification */
|
|
19
19
|
cadence: KardApi.organizations.Cadence;
|
|
20
|
+
/** 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). */
|
|
21
|
+
contentStrategyId?: string | undefined;
|
|
20
22
|
}
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "18.
|
|
1
|
+
export declare const SDK_VERSION = "18.2.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "18.
|
|
1
|
+
export const SDK_VERSION = "18.2.0";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kard-financial/sdk",
|
|
3
|
-
"version": "18.
|
|
3
|
+
"version": "18.2.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -88,6 +88,17 @@
|
|
|
88
88
|
},
|
|
89
89
|
"default": "./dist/cjs/api/resources/organizations/resources/children/exports.js"
|
|
90
90
|
},
|
|
91
|
+
"./organizations/contentStrategies": {
|
|
92
|
+
"import": {
|
|
93
|
+
"types": "./dist/esm/api/resources/organizations/resources/contentStrategies/exports.d.mts",
|
|
94
|
+
"default": "./dist/esm/api/resources/organizations/resources/contentStrategies/exports.mjs"
|
|
95
|
+
},
|
|
96
|
+
"require": {
|
|
97
|
+
"types": "./dist/cjs/api/resources/organizations/resources/contentStrategies/exports.d.ts",
|
|
98
|
+
"default": "./dist/cjs/api/resources/organizations/resources/contentStrategies/exports.js"
|
|
99
|
+
},
|
|
100
|
+
"default": "./dist/cjs/api/resources/organizations/resources/contentStrategies/exports.js"
|
|
101
|
+
},
|
|
91
102
|
"./organizations/placements": {
|
|
92
103
|
"import": {
|
|
93
104
|
"types": "./dist/esm/api/resources/organizations/resources/placements/exports.d.mts",
|
package/reference.md
CHANGED
|
@@ -804,6 +804,392 @@ await client.organizations.children.delete("organizationId", "childId");
|
|
|
804
804
|
</dl>
|
|
805
805
|
|
|
806
806
|
|
|
807
|
+
</dd>
|
|
808
|
+
</dl>
|
|
809
|
+
</details>
|
|
810
|
+
|
|
811
|
+
## ContentStrategies
|
|
812
|
+
<details><summary><code>client.organizations.contentStrategies.<a href="/src/api/resources/organizations/resources/contentStrategies/client/Client.ts">create</a>(organizationId, { ...params }) -> KardApi.ContentStrategyResponse</code></summary>
|
|
813
|
+
<dl>
|
|
814
|
+
<dd>
|
|
815
|
+
|
|
816
|
+
#### 📝 Description
|
|
817
|
+
|
|
818
|
+
<dl>
|
|
819
|
+
<dd>
|
|
820
|
+
|
|
821
|
+
<dl>
|
|
822
|
+
<dd>
|
|
823
|
+
|
|
824
|
+
Create a content strategy for the organization. The strategy name must be unique within the organization.
|
|
825
|
+
</dd>
|
|
826
|
+
</dl>
|
|
827
|
+
</dd>
|
|
828
|
+
</dl>
|
|
829
|
+
|
|
830
|
+
#### 🔌 Usage
|
|
831
|
+
|
|
832
|
+
<dl>
|
|
833
|
+
<dd>
|
|
834
|
+
|
|
835
|
+
<dl>
|
|
836
|
+
<dd>
|
|
837
|
+
|
|
838
|
+
```typescript
|
|
839
|
+
await client.organizations.contentStrategies.create("org-123", {
|
|
840
|
+
data: {
|
|
841
|
+
type: "contentStrategy",
|
|
842
|
+
attributes: {
|
|
843
|
+
name: "Featured Travel",
|
|
844
|
+
filters: ["HIGHEST_CASHBACK", "NEWLY_LIVE"],
|
|
845
|
+
categories: ["Travel"],
|
|
846
|
+
categoryExclusions: ["Gas"],
|
|
847
|
+
merchantExclusions: ["merchant-abc"]
|
|
848
|
+
}
|
|
849
|
+
}
|
|
850
|
+
});
|
|
851
|
+
|
|
852
|
+
```
|
|
853
|
+
</dd>
|
|
854
|
+
</dl>
|
|
855
|
+
</dd>
|
|
856
|
+
</dl>
|
|
857
|
+
|
|
858
|
+
#### ⚙️ Parameters
|
|
859
|
+
|
|
860
|
+
<dl>
|
|
861
|
+
<dd>
|
|
862
|
+
|
|
863
|
+
<dl>
|
|
864
|
+
<dd>
|
|
865
|
+
|
|
866
|
+
**organizationId:** `string` — Unique identifier of the organization
|
|
867
|
+
|
|
868
|
+
</dd>
|
|
869
|
+
</dl>
|
|
870
|
+
|
|
871
|
+
<dl>
|
|
872
|
+
<dd>
|
|
873
|
+
|
|
874
|
+
**request:** `KardApi.CreateContentStrategyRequestBody`
|
|
875
|
+
|
|
876
|
+
</dd>
|
|
877
|
+
</dl>
|
|
878
|
+
|
|
879
|
+
<dl>
|
|
880
|
+
<dd>
|
|
881
|
+
|
|
882
|
+
**requestOptions:** `ContentStrategiesClient.RequestOptions`
|
|
883
|
+
|
|
884
|
+
</dd>
|
|
885
|
+
</dl>
|
|
886
|
+
</dd>
|
|
887
|
+
</dl>
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
</dd>
|
|
891
|
+
</dl>
|
|
892
|
+
</details>
|
|
893
|
+
|
|
894
|
+
<details><summary><code>client.organizations.contentStrategies.<a href="/src/api/resources/organizations/resources/contentStrategies/client/Client.ts">list</a>(organizationId, { ...params }) -> KardApi.ContentStrategyListResponse</code></summary>
|
|
895
|
+
<dl>
|
|
896
|
+
<dd>
|
|
897
|
+
|
|
898
|
+
#### 📝 Description
|
|
899
|
+
|
|
900
|
+
<dl>
|
|
901
|
+
<dd>
|
|
902
|
+
|
|
903
|
+
<dl>
|
|
904
|
+
<dd>
|
|
905
|
+
|
|
906
|
+
List content strategies belonging to the authenticated organization
|
|
907
|
+
</dd>
|
|
908
|
+
</dl>
|
|
909
|
+
</dd>
|
|
910
|
+
</dl>
|
|
911
|
+
|
|
912
|
+
#### 🔌 Usage
|
|
913
|
+
|
|
914
|
+
<dl>
|
|
915
|
+
<dd>
|
|
916
|
+
|
|
917
|
+
<dl>
|
|
918
|
+
<dd>
|
|
919
|
+
|
|
920
|
+
```typescript
|
|
921
|
+
await client.organizations.contentStrategies.list("organizationId");
|
|
922
|
+
|
|
923
|
+
```
|
|
924
|
+
</dd>
|
|
925
|
+
</dl>
|
|
926
|
+
</dd>
|
|
927
|
+
</dl>
|
|
928
|
+
|
|
929
|
+
#### ⚙️ Parameters
|
|
930
|
+
|
|
931
|
+
<dl>
|
|
932
|
+
<dd>
|
|
933
|
+
|
|
934
|
+
<dl>
|
|
935
|
+
<dd>
|
|
936
|
+
|
|
937
|
+
**organizationId:** `string` — Unique identifier of the organization
|
|
938
|
+
|
|
939
|
+
</dd>
|
|
940
|
+
</dl>
|
|
941
|
+
|
|
942
|
+
<dl>
|
|
943
|
+
<dd>
|
|
944
|
+
|
|
945
|
+
**request:** `KardApi.organizations.ListContentStrategiesRequest`
|
|
946
|
+
|
|
947
|
+
</dd>
|
|
948
|
+
</dl>
|
|
949
|
+
|
|
950
|
+
<dl>
|
|
951
|
+
<dd>
|
|
952
|
+
|
|
953
|
+
**requestOptions:** `ContentStrategiesClient.RequestOptions`
|
|
954
|
+
|
|
955
|
+
</dd>
|
|
956
|
+
</dl>
|
|
957
|
+
</dd>
|
|
958
|
+
</dl>
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
</dd>
|
|
962
|
+
</dl>
|
|
963
|
+
</details>
|
|
964
|
+
|
|
965
|
+
<details><summary><code>client.organizations.contentStrategies.<a href="/src/api/resources/organizations/resources/contentStrategies/client/Client.ts">get</a>(organizationId, contentStrategyId) -> KardApi.ContentStrategyResponse</code></summary>
|
|
966
|
+
<dl>
|
|
967
|
+
<dd>
|
|
968
|
+
|
|
969
|
+
#### 📝 Description
|
|
970
|
+
|
|
971
|
+
<dl>
|
|
972
|
+
<dd>
|
|
973
|
+
|
|
974
|
+
<dl>
|
|
975
|
+
<dd>
|
|
976
|
+
|
|
977
|
+
Retrieve a specific content strategy
|
|
978
|
+
</dd>
|
|
979
|
+
</dl>
|
|
980
|
+
</dd>
|
|
981
|
+
</dl>
|
|
982
|
+
|
|
983
|
+
#### 🔌 Usage
|
|
984
|
+
|
|
985
|
+
<dl>
|
|
986
|
+
<dd>
|
|
987
|
+
|
|
988
|
+
<dl>
|
|
989
|
+
<dd>
|
|
990
|
+
|
|
991
|
+
```typescript
|
|
992
|
+
await client.organizations.contentStrategies.get("organizationId", "contentStrategyId");
|
|
993
|
+
|
|
994
|
+
```
|
|
995
|
+
</dd>
|
|
996
|
+
</dl>
|
|
997
|
+
</dd>
|
|
998
|
+
</dl>
|
|
999
|
+
|
|
1000
|
+
#### ⚙️ Parameters
|
|
1001
|
+
|
|
1002
|
+
<dl>
|
|
1003
|
+
<dd>
|
|
1004
|
+
|
|
1005
|
+
<dl>
|
|
1006
|
+
<dd>
|
|
1007
|
+
|
|
1008
|
+
**organizationId:** `string` — Unique identifier of the organization
|
|
1009
|
+
|
|
1010
|
+
</dd>
|
|
1011
|
+
</dl>
|
|
1012
|
+
|
|
1013
|
+
<dl>
|
|
1014
|
+
<dd>
|
|
1015
|
+
|
|
1016
|
+
**contentStrategyId:** `string` — Unique identifier of the content strategy (UUID v7)
|
|
1017
|
+
|
|
1018
|
+
</dd>
|
|
1019
|
+
</dl>
|
|
1020
|
+
|
|
1021
|
+
<dl>
|
|
1022
|
+
<dd>
|
|
1023
|
+
|
|
1024
|
+
**requestOptions:** `ContentStrategiesClient.RequestOptions`
|
|
1025
|
+
|
|
1026
|
+
</dd>
|
|
1027
|
+
</dl>
|
|
1028
|
+
</dd>
|
|
1029
|
+
</dl>
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
</dd>
|
|
1033
|
+
</dl>
|
|
1034
|
+
</details>
|
|
1035
|
+
|
|
1036
|
+
<details><summary><code>client.organizations.contentStrategies.<a href="/src/api/resources/organizations/resources/contentStrategies/client/Client.ts">update</a>(organizationId, contentStrategyId, { ...params }) -> KardApi.ContentStrategyResponse</code></summary>
|
|
1037
|
+
<dl>
|
|
1038
|
+
<dd>
|
|
1039
|
+
|
|
1040
|
+
#### 📝 Description
|
|
1041
|
+
|
|
1042
|
+
<dl>
|
|
1043
|
+
<dd>
|
|
1044
|
+
|
|
1045
|
+
<dl>
|
|
1046
|
+
<dd>
|
|
1047
|
+
|
|
1048
|
+
Replace a content strategy. All fields must be provided; any omitted attribute is treated as cleared.
|
|
1049
|
+
</dd>
|
|
1050
|
+
</dl>
|
|
1051
|
+
</dd>
|
|
1052
|
+
</dl>
|
|
1053
|
+
|
|
1054
|
+
#### 🔌 Usage
|
|
1055
|
+
|
|
1056
|
+
<dl>
|
|
1057
|
+
<dd>
|
|
1058
|
+
|
|
1059
|
+
<dl>
|
|
1060
|
+
<dd>
|
|
1061
|
+
|
|
1062
|
+
```typescript
|
|
1063
|
+
await client.organizations.contentStrategies.update("organizationId", "contentStrategyId", {
|
|
1064
|
+
data: {
|
|
1065
|
+
type: "contentStrategy",
|
|
1066
|
+
attributes: {
|
|
1067
|
+
name: "name",
|
|
1068
|
+
filters: ["NEWLY_LIVE", "NEWLY_LIVE"],
|
|
1069
|
+
categories: ["Arts & Entertainment", "Arts & Entertainment"],
|
|
1070
|
+
categoryExclusions: ["Arts & Entertainment", "Arts & Entertainment"],
|
|
1071
|
+
merchantExclusions: ["merchantExclusions", "merchantExclusions"]
|
|
1072
|
+
}
|
|
1073
|
+
}
|
|
1074
|
+
});
|
|
1075
|
+
|
|
1076
|
+
```
|
|
1077
|
+
</dd>
|
|
1078
|
+
</dl>
|
|
1079
|
+
</dd>
|
|
1080
|
+
</dl>
|
|
1081
|
+
|
|
1082
|
+
#### ⚙️ Parameters
|
|
1083
|
+
|
|
1084
|
+
<dl>
|
|
1085
|
+
<dd>
|
|
1086
|
+
|
|
1087
|
+
<dl>
|
|
1088
|
+
<dd>
|
|
1089
|
+
|
|
1090
|
+
**organizationId:** `string` — Unique identifier of the organization
|
|
1091
|
+
|
|
1092
|
+
</dd>
|
|
1093
|
+
</dl>
|
|
1094
|
+
|
|
1095
|
+
<dl>
|
|
1096
|
+
<dd>
|
|
1097
|
+
|
|
1098
|
+
**contentStrategyId:** `string` — Unique identifier of the content strategy (UUID v7)
|
|
1099
|
+
|
|
1100
|
+
</dd>
|
|
1101
|
+
</dl>
|
|
1102
|
+
|
|
1103
|
+
<dl>
|
|
1104
|
+
<dd>
|
|
1105
|
+
|
|
1106
|
+
**request:** `KardApi.UpdateContentStrategyRequestBody`
|
|
1107
|
+
|
|
1108
|
+
</dd>
|
|
1109
|
+
</dl>
|
|
1110
|
+
|
|
1111
|
+
<dl>
|
|
1112
|
+
<dd>
|
|
1113
|
+
|
|
1114
|
+
**requestOptions:** `ContentStrategiesClient.RequestOptions`
|
|
1115
|
+
|
|
1116
|
+
</dd>
|
|
1117
|
+
</dl>
|
|
1118
|
+
</dd>
|
|
1119
|
+
</dl>
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
</dd>
|
|
1123
|
+
</dl>
|
|
1124
|
+
</details>
|
|
1125
|
+
|
|
1126
|
+
<details><summary><code>client.organizations.contentStrategies.<a href="/src/api/resources/organizations/resources/contentStrategies/client/Client.ts">delete</a>(organizationId, contentStrategyId) -> KardApi.DeleteResourceResponse</code></summary>
|
|
1127
|
+
<dl>
|
|
1128
|
+
<dd>
|
|
1129
|
+
|
|
1130
|
+
#### 📝 Description
|
|
1131
|
+
|
|
1132
|
+
<dl>
|
|
1133
|
+
<dd>
|
|
1134
|
+
|
|
1135
|
+
<dl>
|
|
1136
|
+
<dd>
|
|
1137
|
+
|
|
1138
|
+
Delete a content strategy. Returns 409 if the strategy is still referenced by another resource.
|
|
1139
|
+
</dd>
|
|
1140
|
+
</dl>
|
|
1141
|
+
</dd>
|
|
1142
|
+
</dl>
|
|
1143
|
+
|
|
1144
|
+
#### 🔌 Usage
|
|
1145
|
+
|
|
1146
|
+
<dl>
|
|
1147
|
+
<dd>
|
|
1148
|
+
|
|
1149
|
+
<dl>
|
|
1150
|
+
<dd>
|
|
1151
|
+
|
|
1152
|
+
```typescript
|
|
1153
|
+
await client.organizations.contentStrategies.delete("organizationId", "contentStrategyId");
|
|
1154
|
+
|
|
1155
|
+
```
|
|
1156
|
+
</dd>
|
|
1157
|
+
</dl>
|
|
1158
|
+
</dd>
|
|
1159
|
+
</dl>
|
|
1160
|
+
|
|
1161
|
+
#### ⚙️ Parameters
|
|
1162
|
+
|
|
1163
|
+
<dl>
|
|
1164
|
+
<dd>
|
|
1165
|
+
|
|
1166
|
+
<dl>
|
|
1167
|
+
<dd>
|
|
1168
|
+
|
|
1169
|
+
**organizationId:** `string` — Unique identifier of the organization
|
|
1170
|
+
|
|
1171
|
+
</dd>
|
|
1172
|
+
</dl>
|
|
1173
|
+
|
|
1174
|
+
<dl>
|
|
1175
|
+
<dd>
|
|
1176
|
+
|
|
1177
|
+
**contentStrategyId:** `string` — Unique identifier of the content strategy (UUID v7)
|
|
1178
|
+
|
|
1179
|
+
</dd>
|
|
1180
|
+
</dl>
|
|
1181
|
+
|
|
1182
|
+
<dl>
|
|
1183
|
+
<dd>
|
|
1184
|
+
|
|
1185
|
+
**requestOptions:** `ContentStrategiesClient.RequestOptions`
|
|
1186
|
+
|
|
1187
|
+
</dd>
|
|
1188
|
+
</dl>
|
|
1189
|
+
</dd>
|
|
1190
|
+
</dl>
|
|
1191
|
+
|
|
1192
|
+
|
|
807
1193
|
</dd>
|
|
808
1194
|
</dl>
|
|
809
1195
|
</details>
|