@kard-financial/sdk 0.0.1

package/dist/cjs/api/resources/notifications/types/NotificationPayload.d.ts

@@ -0,0 +1,445 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as KardApi from "../../../index.js";
+/**
+ * @example
+ *     {
+ *         data: {
+ *             type: "earnedRewardSettled",
+ *             id: "d80a6f28-1b24-4d65-9e42-e1cf3379bc98",
+ *             attributes: {
+ *                 message: "You have earned a 72 cent reward on your transaction at McDonald's",
+ *                 name: "McDonald's",
+ *                 commissionEarned: {
+ *                     type: KardApi.CommissionEarnedType.Cents,
+ *                     value: 72
+ *                 },
+ *                 attributionUrl: "www.attribution.com/token",
+ *                 surveyUrl: "www.survey.com",
+ *                 cardProductId: "card_product_123"
+ *             },
+ *             relationships: {
+ *                 user: {
+ *                     data: {
+ *                         type: "user",
+ *                         id: "1234567890"
+ *                     }
+ *                 },
+ *                 transaction: {
+ *                     data: {
+ *                         type: "transaction",
+ *                         id: "0987654321"
+ *                     }
+ *                 }
+ *             }
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         data: {
+ *             type: "earnedRewardApproved",
+ *             id: "d80a6f28-1b24-4d65-9e42-e1cf3379bc98",
+ *             attributes: {
+ *                 message: "You have earned a 72 cent reward on your transaction at McDonald's",
+ *                 name: "McDonald's",
+ *                 attributionUrl: "www.attribution.com/token",
+ *                 surveyUrl: "www.survey.com",
+ *                 cardProductId: "card_product_123"
+ *             },
+ *             relationships: {
+ *                 user: {
+ *                     data: {
+ *                         type: "user",
+ *                         id: "1234567890"
+ *                     }
+ *                 },
+ *                 transaction: {
+ *                     data: {
+ *                         type: "transaction",
+ *                         id: "0987654321"
+ *                     }
+ *                 }
+ *             }
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         data: {
+ *             type: "validTransaction",
+ *             id: "a12b34c56d78e90f1234",
+ *             attributes: {
+ *                 message: "Your transaction at Amazon has been validated successfully.",
+ *                 name: "Amazon",
+ *                 commissionEarned: {
+ *                     type: KardApi.CommissionEarnedType.Cents,
+ *                     value: 100
+ *                 },
+ *                 attributionUrl: "www.attribution.com/token",
+ *                 surveyUrl: "www.survey.com",
+ *                 cardProductId: "card_product_123"
+ *             },
+ *             relationships: {
+ *                 user: {
+ *                     data: {
+ *                         type: "user",
+ *                         id: "9876543210"
+ *                     }
+ *                 },
+ *                 offer: {
+ *                     data: {
+ *                         type: "offer",
+ *                         id: "1234567890"
+ *                     }
+ *                 },
+ *                 transaction: {
+ *                     data: {
+ *                         type: "transaction",
+ *                         id: "0987654321"
+ *                     }
+ *                 }
+ *             }
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         data: {
+ *             type: "failedTransaction",
+ *             id: "a12b34c56d78e90f1234",
+ *             attributes: {
+ *                 message: "Transaction validation failed",
+ *                 reason: "User is not part of the targeted audience eligible to redeem this offer",
+ *                 name: "Walmart",
+ *                 cardProductId: "card_product_123"
+ *             },
+ *             relationships: {
+ *                 user: {
+ *                     data: {
+ *                         type: "user",
+ *                         id: "9876543210"
+ *                     }
+ *                 },
+ *                 offer: {
+ *                     data: {
+ *                         type: "offer",
+ *                         id: "1234567890"
+ *                     }
+ *                 },
+ *                 transaction: {
+ *                     data: {
+ *                         type: "transaction",
+ *                         id: "0987654321"
+ *                     }
+ *                 }
+ *             }
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         data: {
+ *             type: "clawback",
+ *             id: "a12b34c56d78e90f1234",
+ *             attributes: {
+ *                 message: "Transaction has been marked for clawback",
+ *                 reason: "This transaction was previously rewarded in another system",
+ *                 name: "Starbucks",
+ *                 cardProductId: "card_product_123"
+ *             },
+ *             relationships: {
+ *                 user: {
+ *                     data: {
+ *                         type: "user",
+ *                         id: "9876543210"
+ *                     }
+ *                 },
+ *                 offer: {
+ *                     data: {
+ *                         type: "offer",
+ *                         id: "1234567890"
+ *                     }
+ *                 },
+ *                 transaction: {
+ *                     data: {
+ *                         type: "transaction",
+ *                         id: "0987654321"
+ *                     }
+ *                 }
+ *             }
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         data: {
+ *             type: "userOffer",
+ *             id: "d80a6f28-1b24-4d65-9e42-e1cf3379bc98",
+ *             attributes: {
+ *                 status: KardApi.UserOfferStatus.Active,
+ *                 updatedAt: "2024-12-13T00:00:00.000Z",
+ *                 createdAt: "2024-12-13T00:00:00.000Z"
+ *             },
+ *             relationships: {
+ *                 user: {
+ *                     data: {
+ *                         type: "user",
+ *                         id: "d80a6f28-1b24-4d65-9e42-e1cf3379bc98"
+ *                     }
+ *                 },
+ *                 offer: {
+ *                     data: {
+ *                         type: "offer",
+ *                         id: "5e27318c9b346f00087fbb5c"
+ *                     }
+ *                 }
+ *             }
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         data: {
+ *             type: "location",
+ *             id: "d80a6f28-1b24-4d65-9e42-e1cf3379bc98",
+ *             attributes: {
+ *                 name: "Worlds Greatest Chicken",
+ *                 address: {
+ *                     street: "120 Main St",
+ *                     city: "Philadelphia",
+ *                     state: "PA",
+ *                     zipCode: "19147"
+ *                 },
+ *                 coordinates: {
+ *                     longitude: -75.1446869,
+ *                     latitude: 39.9419429
+ *                 },
+ *                 phone: "+1 (123) 555-8880",
+ *                 operationHours: {
+ *                     periods: [{
+ *                             close: {
+ *                                 day: 1,
+ *                                 time: "1700"
+ *                             },
+ *                             open: {
+ *                                 day: 1,
+ *                                 time: "0900"
+ *                             }
+ *                         }, {
+ *                             close: {
+ *                                 day: 2,
+ *                                 time: "1700"
+ *                             },
+ *                             open: {
+ *                                 day: 2,
+ *                                 time: "0900"
+ *                             }
+ *                         }, {
+ *                             close: {
+ *                                 day: 3,
+ *                                 time: "1700"
+ *                             },
+ *                             open: {
+ *                                 day: 3,
+ *                                 time: "0900"
+ *                             }
+ *                         }, {
+ *                             close: {
+ *                                 day: 4,
+ *                                 time: "1700"
+ *                             },
+ *                             open: {
+ *                                 day: 4,
+ *                                 time: "0900"
+ *                             }
+ *                         }, {
+ *                             close: {
+ *                                 day: 5,
+ *                                 time: "1700"
+ *                             },
+ *                             open: {
+ *                                 day: 5,
+ *                                 time: "0900"
+ *                             }
+ *                         }],
+ *                     weekdayText: ["Monday: 9:00 AM \u2013 5:00 PM", "Tuesday: 9:00 AM \u2013 5:00 PM", "Wednesday: 9:00 AM \u2013 5:00 PM", "Thursday: 9:00 AM \u2013 5:00 PM", "Friday: 9:00 AM \u2013 5:00 PM", "Saturday: Closed", "Sunday: Closed"]
+ *                 }
+ *             },
+ *             relationships: {
+ *                 merchant: {
+ *                     data: {
+ *                         type: "merchant",
+ *                         id: "5e27318c9b346f00087fbb5c"
+ *                     }
+ *                 },
+ *                 location: {
+ *                     data: {
+ *                         type: "location",
+ *                         id: "5e27318c9b346f00087fba8l"
+ *                     }
+ *                 }
+ *             }
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         data: {
+ *             type: "offer",
+ *             id: "d80a6f28-1b24-4d65-9e42-e1cf3379bc98",
+ *             attributes: {
+ *                 name: "some offer",
+ *                 terms: "some terms",
+ *                 status: KardApi.OfferStatus.Active,
+ *                 purchaseChannel: [KardApi.BrokerPurchaseChannel.Instore, KardApi.BrokerPurchaseChannel.Online],
+ *                 userReward: {
+ *                     type: KardApi.BrokerRewardType.Percent,
+ *                     value: 5.7
+ *                 },
+ *                 startDate: "2022-01-01T05:00:00Z",
+ *                 expirationDate: "2022-01-01T05:00:00Z",
+ *                 minRewardAmount: {
+ *                     type: KardApi.BrokerAmountType.Cents,
+ *                     value: 500
+ *                 },
+ *                 maxRewardAmount: {
+ *                     type: KardApi.BrokerAmountType.Cents,
+ *                     value: 2000
+ *                 },
+ *                 minTransactionAmount: {
+ *                     type: KardApi.BrokerAmountType.Cents,
+ *                     value: 500
+ *                 },
+ *                 maxTransactionAmount: {
+ *                     type: KardApi.BrokerAmountType.Cents,
+ *                     value: 2000
+ *                 },
+ *                 maxRedemptions: 1,
+ *                 isTargeted: true,
+ *                 assets: [{
+ *                         type: KardApi.BrokerAssetType.LogoImage,
+ *                         url: "http://somelogoimageurl.com",
+ *                         alt: "Logo Image URL"
+ *                     }, {
+ *                         type: KardApi.BrokerAssetType.BannerImage,
+ *                         url: "http://somebannerimageurl.com",
+ *                         alt: "Banner Image URL"
+ *                     }],
+ *                 websiteUrl: "http://someofferprovider.com",
+ *                 description: "some description",
+ *                 updatedAt: "2024-12-13T00:00:00.000Z",
+ *                 createdAt: "2024-12-13T00:00:00.000Z"
+ *             },
+ *             relationships: {
+ *                 offer: {
+ *                     data: {
+ *                         type: "offer",
+ *                         id: "5e27318c9b346f00087fbb5c"
+ *                     }
+ *                 },
+ *                 merchant: {
+ *                     data: {
+ *                         type: "merchant",
+ *                         id: "5e27318c9b346f00087fbb5c"
+ *                     }
+ *                 }
+ *             }
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         data: {
+ *             type: "merchant",
+ *             id: "d80a6f28-1b24-4d65-9e42-e1cf3379bc98",
+ *             attributes: {
+ *                 name: "some merchant",
+ *                 source: "NATIONAL",
+ *                 description: "some description",
+ *                 websiteURL: "https://test.com",
+ *                 updatedAt: "2024-12-13T00:00:00.000Z",
+ *                 createdAt: "2024-12-13T00:00:00.000Z"
+ *             },
+ *             relationships: {
+ *                 merchant: {
+ *                     data: {
+ *                         type: "merchant",
+ *                         id: "5e27318c9b346f00087fbb5c"
+ *                     }
+ *                 },
+ *                 locations: {
+ *                     data: [{
+ *                             type: "location",
+ *                             id: "5e27318c9b346f00087fbb5c"
+ *                         }]
+ *                 }
+ *             }
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         data: {
+ *             type: "auditUpdate",
+ *             id: "a12b34c56d78e90f1234",
+ *             attributes: {
+ *                 status: KardApi.AuditStatus.InProgress,
+ *                 auditCode: 8001,
+ *                 merchantName: "Caribbean Goodness",
+ *                 auditDescription: "duplicate",
+ *                 transactionId: "txn-123"
+ *             },
+ *             relationships: {
+ *                 user: {
+ *                     data: {
+ *                         type: "user",
+ *                         id: "9876543210"
+ *                     }
+ *                 },
+ *                 audit: {
+ *                     data: {
+ *                         type: "audit",
+ *                         id: "5eb2d4a39ce24e00081488c4"
+ *                     }
+ *                 }
+ *             }
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         data: {
+ *             type: "auditUpdate",
+ *             id: "a12b34c56d78e90f1234",
+ *             attributes: {
+ *                 status: KardApi.AuditStatus.Closed,
+ *                 auditCode: 3006,
+ *                 merchantName: "Caribbean Goodness",
+ *                 auditDescription: "reward was not given for offer",
+ *                 transactionId: "txn-123",
+ *                 resolutionDescription: "offer had expired",
+ *                 resolutionTimeStamp: "2022-09-15T19:03:26.236Z",
+ *                 resolutionCode: 9003
+ *             },
+ *             relationships: {
+ *                 user: {
+ *                     data: {
+ *                         type: "user",
+ *                         id: "9876543210"
+ *                     }
+ *                 },
+ *                 audit: {
+ *                     data: {
+ *                         type: "audit",
+ *                         id: "5eb2d4a39ce24e00081488c4"
+ *                     }
+ *                 }
+ *             }
+ *         }
+ *     }
+ */
+export interface NotificationPayload {
+    data: KardApi.NotificationDataUnion;
+}

package/dist/cjs/api/resources/notifications/types/NotificationPayload.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/notifications/types/NotificationType.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type NotificationType = "earnedRewardApproved" | "earnedRewardSettled" | "validTransaction" | "failedTransaction" | "clawback" | "offer" | "merchant" | "location" | "userOffer" | "auditUpdate";
+export declare const NotificationType: {
+    readonly EarnedRewardApproved: "earnedRewardApproved";
+    readonly EarnedRewardSettled: "earnedRewardSettled";
+    readonly ValidTransaction: "validTransaction";
+    readonly FailedTransaction: "failedTransaction";
+    readonly Clawback: "clawback";
+    readonly Offer: "offer";
+    readonly Merchant: "merchant";
+    readonly Location: "location";
+    readonly UserOffer: "userOffer";
+    readonly AuditUpdate: "auditUpdate";
+};

package/dist/cjs/api/resources/notifications/types/NotificationType.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationType = void 0;
+exports.NotificationType = {
+    EarnedRewardApproved: "earnedRewardApproved",
+    EarnedRewardSettled: "earnedRewardSettled",
+    ValidTransaction: "validTransaction",
+    FailedTransaction: "failedTransaction",
+    Clawback: "clawback",
+    Offer: "offer",
+    Merchant: "merchant",
+    Location: "location",
+    UserOffer: "userOffer",
+    AuditUpdate: "auditUpdate",
+};

package/dist/cjs/api/resources/notifications/types/OfferStatus.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type OfferStatus = "INACTIVE" | "ACTIVE" | "CLOSED" | "UPCOMING";
+export declare const OfferStatus: {
+    readonly Inactive: "INACTIVE";
+    readonly Active: "ACTIVE";
+    readonly Closed: "CLOSED";
+    readonly Upcoming: "UPCOMING";
+};

package/dist/cjs/api/resources/notifications/types/OfferStatus.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OfferStatus = void 0;
+exports.OfferStatus = {
+    Inactive: "INACTIVE",
+    Active: "ACTIVE",
+    Closed: "CLOSED",
+    Upcoming: "UPCOMING",
+};

package/dist/cjs/api/resources/notifications/types/RewardNotificationAttributes.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RewardNotificationAttributes {
+    /** The display message associated to the notification */
+    message: string;
+    /** The name of the merchant */
+    name: string;
+    /** The attribution URL to track user's interactions with the notification */
+    attributionUrl: string;
+    /** Post experience survey URL, if available. This will be present for rewards associated with local offers. */
+    surveyUrl?: string;
+    /** The ID of the card product */
+    cardProductId?: string;
+}

package/dist/cjs/api/resources/notifications/types/RewardNotificationAttributes.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/notifications/types/SubscriptionRequest.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as KardApi from "../../../index.js";
+export interface SubscriptionRequest {
+    attributes: KardApi.SubscriptionRequestAttributes;
+}

package/dist/cjs/api/resources/notifications/types/SubscriptionRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/notifications/types/SubscriptionRequestAttributes.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as KardApi from "../../../index.js";
+export interface SubscriptionRequestAttributes {
+    /** The name of the event for the subscription */
+    eventName: KardApi.NotificationType;
+    /** The URL where notifications will be delivered */
+    webhookUrl: string;
+    /** Indicates whether the subscription is active */
+    enabled: boolean;
+}

package/dist/cjs/api/resources/notifications/types/SubscriptionRequestAttributes.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/notifications/types/SubscriptionRequestBody.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as KardApi from "../../../index.js";
+/**
+ * @example
+ *     {
+ *         data: [{
+ *                 type: "subscription",
+ *                 attributes: {
+ *                     eventName: KardApi.NotificationType.EarnedRewardApproved,
+ *                     webhookUrl: "https://webhookUrl.com/post",
+ *                     enabled: true
+ *                 }
+ *             }]
+ *     }
+ */
+export interface SubscriptionRequestBody {
+    data: KardApi.SubscriptionRequestUnion[];
+}

package/dist/cjs/api/resources/notifications/types/SubscriptionRequestBody.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/notifications/types/SubscriptionRequestUnion.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as KardApi from "../../../index.js";
+export type SubscriptionRequestUnion = KardApi.SubscriptionRequestUnion.Subscription;
+export declare namespace SubscriptionRequestUnion {
+    interface Subscription extends KardApi.SubscriptionRequest {
+        type: "subscription";
+    }
+}

package/dist/cjs/api/resources/notifications/types/SubscriptionRequestUnion.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/notifications/types/TimePeriod.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TimePeriod {
+    /** Day of week (0=Sunday, 1=Monday, etc.) */
+    day: number;
+    /** Time in 24-hour format (e.g. "0900" for 9:00 AM) */
+    time: string;
+}

package/dist/cjs/api/resources/notifications/types/TimePeriod.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/notifications/types/TransactionRelationships.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as KardApi from "../../../index.js";
+export interface TransactionRelationships {
+    user: KardApi.RelationshipSingle;
+    offer: KardApi.RelationshipSingle;
+    transaction: KardApi.RelationshipSingle;
+}

package/dist/cjs/api/resources/notifications/types/TransactionRelationships.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/notifications/types/UserOfferStatus.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type UserOfferStatus = "ACTIVE" | "INACTIVE";
+export declare const UserOfferStatus: {
+    readonly Active: "ACTIVE";
+    readonly Inactive: "INACTIVE";
+};

package/dist/cjs/api/resources/notifications/types/UserOfferStatus.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserOfferStatus = void 0;
+exports.UserOfferStatus = {
+    Active: "ACTIVE",
+    Inactive: "INACTIVE",
+};