@kard-financial/sdk 2.0.0 → 2.1.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/users/resources/rewards/client/Client.js +18 -2
- package/dist/cjs/api/resources/users/resources/rewards/client/requests/GetLocationsByUserRequest.d.ts +2 -0
- package/dist/cjs/api/resources/users/resources/rewards/client/requests/GetOffersByUserRequest.d.ts +2 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/ButtonStyle.d.ts +6 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/ButtonStyle.js +9 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/ComponentType.d.ts +9 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/ComponentType.js +12 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/CtaComponent.d.ts +10 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/CtaComponent.js +3 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/OfferCommonFields.d.ts +2 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/OfferComponents.d.ts +16 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/OfferComponents.js +3 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/index.d.ts +4 -0
- package/dist/cjs/api/resources/users/resources/rewards/types/index.js +4 -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/users/resources/rewards/client/Client.mjs +18 -2
- package/dist/esm/api/resources/users/resources/rewards/client/requests/GetLocationsByUserRequest.d.mts +2 -0
- package/dist/esm/api/resources/users/resources/rewards/client/requests/GetOffersByUserRequest.d.mts +2 -0
- package/dist/esm/api/resources/users/resources/rewards/types/ButtonStyle.d.mts +6 -0
- package/dist/esm/api/resources/users/resources/rewards/types/ButtonStyle.mjs +6 -0
- package/dist/esm/api/resources/users/resources/rewards/types/ComponentType.d.mts +9 -0
- package/dist/esm/api/resources/users/resources/rewards/types/ComponentType.mjs +9 -0
- package/dist/esm/api/resources/users/resources/rewards/types/CtaComponent.d.mts +10 -0
- package/dist/esm/api/resources/users/resources/rewards/types/CtaComponent.mjs +2 -0
- package/dist/esm/api/resources/users/resources/rewards/types/OfferCommonFields.d.mts +2 -0
- package/dist/esm/api/resources/users/resources/rewards/types/OfferComponents.d.mts +16 -0
- package/dist/esm/api/resources/users/resources/rewards/types/OfferComponents.mjs +2 -0
- package/dist/esm/api/resources/users/resources/rewards/types/index.d.mts +4 -0
- package/dist/esm/api/resources/users/resources/rewards/types/index.mjs +4 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
|
|
|
43
43
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
44
44
|
"X-Fern-Language": "JavaScript",
|
|
45
45
|
"X-Fern-SDK-Name": "@kard-financial/sdk",
|
|
46
|
-
"X-Fern-SDK-Version": "2.
|
|
47
|
-
"User-Agent": "@kard-financial/sdk/2.
|
|
46
|
+
"X-Fern-SDK-Version": "2.1.0",
|
|
47
|
+
"User-Agent": "@kard-financial/sdk/2.1.0",
|
|
48
48
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
49
49
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
50
50
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
@@ -85,7 +85,7 @@ class RewardsClient {
|
|
|
85
85
|
__offers(organizationId_1, userId_1) {
|
|
86
86
|
return __awaiter(this, arguments, void 0, function* (organizationId, userId, request = {}, requestOptions) {
|
|
87
87
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
88
|
-
const { "page[size]": pageSize, "page[after]": pageAfter, "page[before]": pageBefore, "filter[purchaseChannel]": filterPurchaseChannel, "filter[category]": filterCategory, "filter[isTargeted]": filterIsTargeted, sort, include, } = request;
|
|
88
|
+
const { "page[size]": pageSize, "page[after]": pageAfter, "page[before]": pageBefore, "filter[purchaseChannel]": filterPurchaseChannel, "filter[category]": filterCategory, "filter[isTargeted]": filterIsTargeted, sort, include, supportedComponents, } = request;
|
|
89
89
|
const _queryParams = {};
|
|
90
90
|
if (pageSize != null) {
|
|
91
91
|
_queryParams["page[size]"] = pageSize.toString();
|
|
@@ -121,6 +121,14 @@ class RewardsClient {
|
|
|
121
121
|
_queryParams.include = include;
|
|
122
122
|
}
|
|
123
123
|
}
|
|
124
|
+
if (supportedComponents != null) {
|
|
125
|
+
if (Array.isArray(supportedComponents)) {
|
|
126
|
+
_queryParams.supportedComponents = supportedComponents.map((item) => item);
|
|
127
|
+
}
|
|
128
|
+
else {
|
|
129
|
+
_queryParams.supportedComponents = supportedComponents;
|
|
130
|
+
}
|
|
131
|
+
}
|
|
124
132
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
125
133
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
126
134
|
const _response = yield core.fetcher({
|
|
@@ -211,7 +219,7 @@ class RewardsClient {
|
|
|
211
219
|
__locations(organizationId_1, userId_1) {
|
|
212
220
|
return __awaiter(this, arguments, void 0, function* (organizationId, userId, request = {}, requestOptions) {
|
|
213
221
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
214
|
-
const { "page[size]": pageSize, "page[after]": pageAfter, "page[before]": pageBefore, "filter[name]": filterName, "filter[city]": filterCity, "filter[zipCode]": filterZipCode, "filter[state]": filterState, "filter[category]": filterCategory, "filter[longitude]": filterLongitude, "filter[latitude]": filterLatitude, "filter[radius]": filterRadius, sort, include, } = request;
|
|
222
|
+
const { "page[size]": pageSize, "page[after]": pageAfter, "page[before]": pageBefore, "filter[name]": filterName, "filter[city]": filterCity, "filter[zipCode]": filterZipCode, "filter[state]": filterState, "filter[category]": filterCategory, "filter[longitude]": filterLongitude, "filter[latitude]": filterLatitude, "filter[radius]": filterRadius, sort, include, supportedComponents, } = request;
|
|
215
223
|
const _queryParams = {};
|
|
216
224
|
if (pageSize != null) {
|
|
217
225
|
_queryParams["page[size]"] = pageSize.toString();
|
|
@@ -262,6 +270,14 @@ class RewardsClient {
|
|
|
262
270
|
_queryParams.include = include;
|
|
263
271
|
}
|
|
264
272
|
}
|
|
273
|
+
if (supportedComponents != null) {
|
|
274
|
+
if (Array.isArray(supportedComponents)) {
|
|
275
|
+
_queryParams.supportedComponents = supportedComponents.map((item) => item);
|
|
276
|
+
}
|
|
277
|
+
else {
|
|
278
|
+
_queryParams.supportedComponents = supportedComponents;
|
|
279
|
+
}
|
|
280
|
+
}
|
|
265
281
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
266
282
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
267
283
|
const _response = yield core.fetcher({
|
|
@@ -25,4 +25,6 @@ export interface GetLocationsByUserRequest {
|
|
|
25
25
|
sort?: KardApi.users.LocationSortOptions | KardApi.users.LocationSortOptions[];
|
|
26
26
|
/** CSV list of included resources in the response (e.g "offers,categories"). Allowed values are `offers` and `categories`. */
|
|
27
27
|
include?: string | string[];
|
|
28
|
+
/** UI component types to include in included offers. Valid values are shortDescription, longDescription, cta, tags, and detailTags. */
|
|
29
|
+
supportedComponents?: KardApi.users.ComponentType | KardApi.users.ComponentType[];
|
|
28
30
|
}
|
package/dist/cjs/api/resources/users/resources/rewards/client/requests/GetOffersByUserRequest.d.ts
CHANGED
|
@@ -18,4 +18,6 @@ export interface GetOffersByUserRequest {
|
|
|
18
18
|
sort?: KardApi.users.OfferSortOptions | KardApi.users.OfferSortOptions[];
|
|
19
19
|
/** CSV list of included resources in the response (e.g "categories"). Allowed value is `categories`. */
|
|
20
20
|
include?: string | string[];
|
|
21
|
+
/** UI component types to include in the response. Valid values are shortDescription, longDescription, cta, tags, and detailTags. */
|
|
22
|
+
supportedComponents?: KardApi.users.ComponentType | KardApi.users.ComponentType[];
|
|
21
23
|
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ButtonStyle = void 0;
|
|
5
|
+
/** Available button styles for CTA components */
|
|
6
|
+
exports.ButtonStyle = {
|
|
7
|
+
Primary: "PRIMARY",
|
|
8
|
+
Disabled: "DISABLED",
|
|
9
|
+
};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/** Available UI component types for offers */
|
|
2
|
+
export declare const ComponentType: {
|
|
3
|
+
readonly ShortDescription: "shortDescription";
|
|
4
|
+
readonly LongDescription: "longDescription";
|
|
5
|
+
readonly Cta: "cta";
|
|
6
|
+
readonly Tags: "tags";
|
|
7
|
+
readonly DetailTags: "detailTags";
|
|
8
|
+
};
|
|
9
|
+
export type ComponentType = (typeof ComponentType)[keyof typeof ComponentType];
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ComponentType = void 0;
|
|
5
|
+
/** Available UI component types for offers */
|
|
6
|
+
exports.ComponentType = {
|
|
7
|
+
ShortDescription: "shortDescription",
|
|
8
|
+
LongDescription: "longDescription",
|
|
9
|
+
Cta: "cta",
|
|
10
|
+
Tags: "tags",
|
|
11
|
+
DetailTags: "detailTags",
|
|
12
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Call-to-action button component for offers
|
|
4
|
+
*/
|
|
5
|
+
export interface CtaComponent {
|
|
6
|
+
/** Text to display on the button */
|
|
7
|
+
buttonText: string;
|
|
8
|
+
/** Style of the button */
|
|
9
|
+
buttonStyle: KardApi.users.ButtonStyle;
|
|
10
|
+
}
|
|
@@ -28,4 +28,6 @@ export interface OfferCommonFields {
|
|
|
28
28
|
websiteUrl?: string;
|
|
29
29
|
/** Description of the offer */
|
|
30
30
|
description?: string;
|
|
31
|
+
/** UI component data for the offer, returned when supportedComponents query parameter is provided */
|
|
32
|
+
components?: KardApi.users.OfferComponents;
|
|
31
33
|
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* UI component data for rendering offer details
|
|
4
|
+
*/
|
|
5
|
+
export interface OfferComponents {
|
|
6
|
+
/** Short description for the offer */
|
|
7
|
+
shortDescription?: string;
|
|
8
|
+
/** Long description for the offer */
|
|
9
|
+
longDescription?: string;
|
|
10
|
+
/** Call-to-action button component */
|
|
11
|
+
cta?: KardApi.users.CtaComponent;
|
|
12
|
+
/** Tags for the offer */
|
|
13
|
+
tags?: string[];
|
|
14
|
+
/** Detail tags for the offer */
|
|
15
|
+
detailTags?: string[];
|
|
16
|
+
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./Amount.js";
|
|
2
2
|
export * from "./AmountType.js";
|
|
3
3
|
export * from "./Asset.js";
|
|
4
|
+
export * from "./ButtonStyle.js";
|
|
4
5
|
export * from "./CategoryData.js";
|
|
5
6
|
export * from "./CategoryFields.js";
|
|
6
7
|
export * from "./CategoryIdentifier.js";
|
|
@@ -8,7 +9,9 @@ export * from "./CategoryIncluded.js";
|
|
|
8
9
|
export * from "./CategoryRelationship.js";
|
|
9
10
|
export * from "./CategoryRelationshipObject.js";
|
|
10
11
|
export * from "./Commission.js";
|
|
12
|
+
export * from "./ComponentType.js";
|
|
11
13
|
export * from "./Coordinates.js";
|
|
14
|
+
export * from "./CtaComponent.js";
|
|
12
15
|
export * from "./EligibilityLocationAddress.js";
|
|
13
16
|
export * from "./EligibilityLocationIncluded.js";
|
|
14
17
|
export * from "./EligibilityOfferIncluded.js";
|
|
@@ -19,6 +22,7 @@ export * from "./LocationRelationships.js";
|
|
|
19
22
|
export * from "./LocationSortOptions.js";
|
|
20
23
|
export * from "./LocationsResponseObject.js";
|
|
21
24
|
export * from "./OfferCommonFields.js";
|
|
25
|
+
export * from "./OfferComponents.js";
|
|
22
26
|
export * from "./OfferDataUnion.js";
|
|
23
27
|
export * from "./OfferRelationship.js";
|
|
24
28
|
export * from "./OfferSortOptions.js";
|
|
@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
17
17
|
__exportStar(require("./Amount.js"), exports);
|
|
18
18
|
__exportStar(require("./AmountType.js"), exports);
|
|
19
19
|
__exportStar(require("./Asset.js"), exports);
|
|
20
|
+
__exportStar(require("./ButtonStyle.js"), exports);
|
|
20
21
|
__exportStar(require("./CategoryData.js"), exports);
|
|
21
22
|
__exportStar(require("./CategoryFields.js"), exports);
|
|
22
23
|
__exportStar(require("./CategoryIdentifier.js"), exports);
|
|
@@ -24,7 +25,9 @@ __exportStar(require("./CategoryIncluded.js"), exports);
|
|
|
24
25
|
__exportStar(require("./CategoryRelationship.js"), exports);
|
|
25
26
|
__exportStar(require("./CategoryRelationshipObject.js"), exports);
|
|
26
27
|
__exportStar(require("./Commission.js"), exports);
|
|
28
|
+
__exportStar(require("./ComponentType.js"), exports);
|
|
27
29
|
__exportStar(require("./Coordinates.js"), exports);
|
|
30
|
+
__exportStar(require("./CtaComponent.js"), exports);
|
|
28
31
|
__exportStar(require("./EligibilityLocationAddress.js"), exports);
|
|
29
32
|
__exportStar(require("./EligibilityLocationIncluded.js"), exports);
|
|
30
33
|
__exportStar(require("./EligibilityOfferIncluded.js"), exports);
|
|
@@ -35,6 +38,7 @@ __exportStar(require("./LocationRelationships.js"), exports);
|
|
|
35
38
|
__exportStar(require("./LocationSortOptions.js"), exports);
|
|
36
39
|
__exportStar(require("./LocationsResponseObject.js"), exports);
|
|
37
40
|
__exportStar(require("./OfferCommonFields.js"), exports);
|
|
41
|
+
__exportStar(require("./OfferComponents.js"), exports);
|
|
38
42
|
__exportStar(require("./OfferDataUnion.js"), exports);
|
|
39
43
|
__exportStar(require("./OfferRelationship.js"), exports);
|
|
40
44
|
__exportStar(require("./OfferSortOptions.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "2.
|
|
1
|
+
export declare const SDK_VERSION = "2.1.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "@kard-financial/sdk",
|
|
9
|
-
"X-Fern-SDK-Version": "2.
|
|
10
|
-
"User-Agent": "@kard-financial/sdk/2.
|
|
9
|
+
"X-Fern-SDK-Version": "2.1.0",
|
|
10
|
+
"User-Agent": "@kard-financial/sdk/2.1.0",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
@@ -49,7 +49,7 @@ export class RewardsClient {
|
|
|
49
49
|
__offers(organizationId_1, userId_1) {
|
|
50
50
|
return __awaiter(this, arguments, void 0, function* (organizationId, userId, request = {}, requestOptions) {
|
|
51
51
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
52
|
-
const { "page[size]": pageSize, "page[after]": pageAfter, "page[before]": pageBefore, "filter[purchaseChannel]": filterPurchaseChannel, "filter[category]": filterCategory, "filter[isTargeted]": filterIsTargeted, sort, include, } = request;
|
|
52
|
+
const { "page[size]": pageSize, "page[after]": pageAfter, "page[before]": pageBefore, "filter[purchaseChannel]": filterPurchaseChannel, "filter[category]": filterCategory, "filter[isTargeted]": filterIsTargeted, sort, include, supportedComponents, } = request;
|
|
53
53
|
const _queryParams = {};
|
|
54
54
|
if (pageSize != null) {
|
|
55
55
|
_queryParams["page[size]"] = pageSize.toString();
|
|
@@ -85,6 +85,14 @@ export class RewardsClient {
|
|
|
85
85
|
_queryParams.include = include;
|
|
86
86
|
}
|
|
87
87
|
}
|
|
88
|
+
if (supportedComponents != null) {
|
|
89
|
+
if (Array.isArray(supportedComponents)) {
|
|
90
|
+
_queryParams.supportedComponents = supportedComponents.map((item) => item);
|
|
91
|
+
}
|
|
92
|
+
else {
|
|
93
|
+
_queryParams.supportedComponents = supportedComponents;
|
|
94
|
+
}
|
|
95
|
+
}
|
|
88
96
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
89
97
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
90
98
|
const _response = yield core.fetcher({
|
|
@@ -175,7 +183,7 @@ export class RewardsClient {
|
|
|
175
183
|
__locations(organizationId_1, userId_1) {
|
|
176
184
|
return __awaiter(this, arguments, void 0, function* (organizationId, userId, request = {}, requestOptions) {
|
|
177
185
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
178
|
-
const { "page[size]": pageSize, "page[after]": pageAfter, "page[before]": pageBefore, "filter[name]": filterName, "filter[city]": filterCity, "filter[zipCode]": filterZipCode, "filter[state]": filterState, "filter[category]": filterCategory, "filter[longitude]": filterLongitude, "filter[latitude]": filterLatitude, "filter[radius]": filterRadius, sort, include, } = request;
|
|
186
|
+
const { "page[size]": pageSize, "page[after]": pageAfter, "page[before]": pageBefore, "filter[name]": filterName, "filter[city]": filterCity, "filter[zipCode]": filterZipCode, "filter[state]": filterState, "filter[category]": filterCategory, "filter[longitude]": filterLongitude, "filter[latitude]": filterLatitude, "filter[radius]": filterRadius, sort, include, supportedComponents, } = request;
|
|
179
187
|
const _queryParams = {};
|
|
180
188
|
if (pageSize != null) {
|
|
181
189
|
_queryParams["page[size]"] = pageSize.toString();
|
|
@@ -226,6 +234,14 @@ export class RewardsClient {
|
|
|
226
234
|
_queryParams.include = include;
|
|
227
235
|
}
|
|
228
236
|
}
|
|
237
|
+
if (supportedComponents != null) {
|
|
238
|
+
if (Array.isArray(supportedComponents)) {
|
|
239
|
+
_queryParams.supportedComponents = supportedComponents.map((item) => item);
|
|
240
|
+
}
|
|
241
|
+
else {
|
|
242
|
+
_queryParams.supportedComponents = supportedComponents;
|
|
243
|
+
}
|
|
244
|
+
}
|
|
229
245
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
230
246
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
231
247
|
const _response = yield core.fetcher({
|
|
@@ -25,4 +25,6 @@ export interface GetLocationsByUserRequest {
|
|
|
25
25
|
sort?: KardApi.users.LocationSortOptions | KardApi.users.LocationSortOptions[];
|
|
26
26
|
/** CSV list of included resources in the response (e.g "offers,categories"). Allowed values are `offers` and `categories`. */
|
|
27
27
|
include?: string | string[];
|
|
28
|
+
/** UI component types to include in included offers. Valid values are shortDescription, longDescription, cta, tags, and detailTags. */
|
|
29
|
+
supportedComponents?: KardApi.users.ComponentType | KardApi.users.ComponentType[];
|
|
28
30
|
}
|
package/dist/esm/api/resources/users/resources/rewards/client/requests/GetOffersByUserRequest.d.mts
CHANGED
|
@@ -18,4 +18,6 @@ export interface GetOffersByUserRequest {
|
|
|
18
18
|
sort?: KardApi.users.OfferSortOptions | KardApi.users.OfferSortOptions[];
|
|
19
19
|
/** CSV list of included resources in the response (e.g "categories"). Allowed value is `categories`. */
|
|
20
20
|
include?: string | string[];
|
|
21
|
+
/** UI component types to include in the response. Valid values are shortDescription, longDescription, cta, tags, and detailTags. */
|
|
22
|
+
supportedComponents?: KardApi.users.ComponentType | KardApi.users.ComponentType[];
|
|
21
23
|
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/** Available UI component types for offers */
|
|
2
|
+
export declare const ComponentType: {
|
|
3
|
+
readonly ShortDescription: "shortDescription";
|
|
4
|
+
readonly LongDescription: "longDescription";
|
|
5
|
+
readonly Cta: "cta";
|
|
6
|
+
readonly Tags: "tags";
|
|
7
|
+
readonly DetailTags: "detailTags";
|
|
8
|
+
};
|
|
9
|
+
export type ComponentType = (typeof ComponentType)[keyof typeof ComponentType];
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
/** Available UI component types for offers */
|
|
3
|
+
export const ComponentType = {
|
|
4
|
+
ShortDescription: "shortDescription",
|
|
5
|
+
LongDescription: "longDescription",
|
|
6
|
+
Cta: "cta",
|
|
7
|
+
Tags: "tags",
|
|
8
|
+
DetailTags: "detailTags",
|
|
9
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Call-to-action button component for offers
|
|
4
|
+
*/
|
|
5
|
+
export interface CtaComponent {
|
|
6
|
+
/** Text to display on the button */
|
|
7
|
+
buttonText: string;
|
|
8
|
+
/** Style of the button */
|
|
9
|
+
buttonStyle: KardApi.users.ButtonStyle;
|
|
10
|
+
}
|
|
@@ -28,4 +28,6 @@ export interface OfferCommonFields {
|
|
|
28
28
|
websiteUrl?: string;
|
|
29
29
|
/** Description of the offer */
|
|
30
30
|
description?: string;
|
|
31
|
+
/** UI component data for the offer, returned when supportedComponents query parameter is provided */
|
|
32
|
+
components?: KardApi.users.OfferComponents;
|
|
31
33
|
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type * as KardApi from "../../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* UI component data for rendering offer details
|
|
4
|
+
*/
|
|
5
|
+
export interface OfferComponents {
|
|
6
|
+
/** Short description for the offer */
|
|
7
|
+
shortDescription?: string;
|
|
8
|
+
/** Long description for the offer */
|
|
9
|
+
longDescription?: string;
|
|
10
|
+
/** Call-to-action button component */
|
|
11
|
+
cta?: KardApi.users.CtaComponent;
|
|
12
|
+
/** Tags for the offer */
|
|
13
|
+
tags?: string[];
|
|
14
|
+
/** Detail tags for the offer */
|
|
15
|
+
detailTags?: string[];
|
|
16
|
+
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./Amount.mjs";
|
|
2
2
|
export * from "./AmountType.mjs";
|
|
3
3
|
export * from "./Asset.mjs";
|
|
4
|
+
export * from "./ButtonStyle.mjs";
|
|
4
5
|
export * from "./CategoryData.mjs";
|
|
5
6
|
export * from "./CategoryFields.mjs";
|
|
6
7
|
export * from "./CategoryIdentifier.mjs";
|
|
@@ -8,7 +9,9 @@ export * from "./CategoryIncluded.mjs";
|
|
|
8
9
|
export * from "./CategoryRelationship.mjs";
|
|
9
10
|
export * from "./CategoryRelationshipObject.mjs";
|
|
10
11
|
export * from "./Commission.mjs";
|
|
12
|
+
export * from "./ComponentType.mjs";
|
|
11
13
|
export * from "./Coordinates.mjs";
|
|
14
|
+
export * from "./CtaComponent.mjs";
|
|
12
15
|
export * from "./EligibilityLocationAddress.mjs";
|
|
13
16
|
export * from "./EligibilityLocationIncluded.mjs";
|
|
14
17
|
export * from "./EligibilityOfferIncluded.mjs";
|
|
@@ -19,6 +22,7 @@ export * from "./LocationRelationships.mjs";
|
|
|
19
22
|
export * from "./LocationSortOptions.mjs";
|
|
20
23
|
export * from "./LocationsResponseObject.mjs";
|
|
21
24
|
export * from "./OfferCommonFields.mjs";
|
|
25
|
+
export * from "./OfferComponents.mjs";
|
|
22
26
|
export * from "./OfferDataUnion.mjs";
|
|
23
27
|
export * from "./OfferRelationship.mjs";
|
|
24
28
|
export * from "./OfferSortOptions.mjs";
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./Amount.mjs";
|
|
2
2
|
export * from "./AmountType.mjs";
|
|
3
3
|
export * from "./Asset.mjs";
|
|
4
|
+
export * from "./ButtonStyle.mjs";
|
|
4
5
|
export * from "./CategoryData.mjs";
|
|
5
6
|
export * from "./CategoryFields.mjs";
|
|
6
7
|
export * from "./CategoryIdentifier.mjs";
|
|
@@ -8,7 +9,9 @@ export * from "./CategoryIncluded.mjs";
|
|
|
8
9
|
export * from "./CategoryRelationship.mjs";
|
|
9
10
|
export * from "./CategoryRelationshipObject.mjs";
|
|
10
11
|
export * from "./Commission.mjs";
|
|
12
|
+
export * from "./ComponentType.mjs";
|
|
11
13
|
export * from "./Coordinates.mjs";
|
|
14
|
+
export * from "./CtaComponent.mjs";
|
|
12
15
|
export * from "./EligibilityLocationAddress.mjs";
|
|
13
16
|
export * from "./EligibilityLocationIncluded.mjs";
|
|
14
17
|
export * from "./EligibilityOfferIncluded.mjs";
|
|
@@ -19,6 +22,7 @@ export * from "./LocationRelationships.mjs";
|
|
|
19
22
|
export * from "./LocationSortOptions.mjs";
|
|
20
23
|
export * from "./LocationsResponseObject.mjs";
|
|
21
24
|
export * from "./OfferCommonFields.mjs";
|
|
25
|
+
export * from "./OfferComponents.mjs";
|
|
22
26
|
export * from "./OfferDataUnion.mjs";
|
|
23
27
|
export * from "./OfferRelationship.mjs";
|
|
24
28
|
export * from "./OfferSortOptions.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "2.
|
|
1
|
+
export declare const SDK_VERSION = "2.1.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "2.
|
|
1
|
+
export const SDK_VERSION = "2.1.0";
|