@kard-financial/sdk 11.0.1 → 12.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.
Files changed (149) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/commons/types/NotificationType.d.ts +0 -4
  3. package/dist/cjs/api/resources/commons/types/NotificationType.js +0 -4
  4. package/dist/cjs/api/resources/notifications/types/NotificationDataUnion.d.ts +1 -13
  5. package/dist/cjs/api/resources/notifications/types/NotificationPayload.d.ts +0 -201
  6. package/dist/cjs/api/resources/notifications/types/index.d.ts +0 -29
  7. package/dist/cjs/api/resources/notifications/types/index.js +0 -29
  8. package/dist/cjs/api/resources/transactions/types/CreateFileUploadData.d.ts +1 -1
  9. package/dist/cjs/api/resources/transactions/types/CreateFileUploadUrlResponse.d.ts +2 -2
  10. package/dist/cjs/api/resources/transactions/types/FileUploadType.d.ts +6 -0
  11. package/dist/cjs/api/resources/transactions/types/FileUploadType.js +9 -0
  12. package/dist/cjs/api/resources/transactions/types/FileUploadUrlData.d.ts +1 -1
  13. package/dist/cjs/api/resources/transactions/types/index.d.ts +1 -0
  14. package/dist/cjs/api/resources/transactions/types/index.js +1 -0
  15. package/dist/cjs/version.d.ts +1 -1
  16. package/dist/cjs/version.js +1 -1
  17. package/dist/esm/BaseClient.mjs +2 -2
  18. package/dist/esm/api/resources/commons/types/NotificationType.d.mts +0 -4
  19. package/dist/esm/api/resources/commons/types/NotificationType.mjs +0 -4
  20. package/dist/esm/api/resources/notifications/types/NotificationDataUnion.d.mts +1 -13
  21. package/dist/esm/api/resources/notifications/types/NotificationPayload.d.mts +0 -201
  22. package/dist/esm/api/resources/notifications/types/index.d.mts +0 -29
  23. package/dist/esm/api/resources/notifications/types/index.mjs +0 -29
  24. package/dist/esm/api/resources/transactions/types/CreateFileUploadData.d.mts +1 -1
  25. package/dist/esm/api/resources/transactions/types/CreateFileUploadUrlResponse.d.mts +2 -2
  26. package/dist/esm/api/resources/transactions/types/FileUploadType.d.mts +6 -0
  27. package/dist/esm/api/resources/transactions/types/FileUploadType.mjs +6 -0
  28. package/dist/esm/api/resources/transactions/types/FileUploadUrlData.d.mts +1 -1
  29. package/dist/esm/api/resources/transactions/types/index.d.mts +1 -0
  30. package/dist/esm/api/resources/transactions/types/index.mjs +1 -0
  31. package/dist/esm/version.d.mts +1 -1
  32. package/dist/esm/version.mjs +1 -1
  33. package/package.json +1 -1
  34. package/dist/cjs/api/resources/notifications/types/BrokerAmount.d.ts +0 -7
  35. package/dist/cjs/api/resources/notifications/types/BrokerAmount.js +0 -3
  36. package/dist/cjs/api/resources/notifications/types/BrokerAmountType.d.ts +0 -4
  37. package/dist/cjs/api/resources/notifications/types/BrokerAmountType.js +0 -7
  38. package/dist/cjs/api/resources/notifications/types/BrokerAsset.d.ts +0 -9
  39. package/dist/cjs/api/resources/notifications/types/BrokerAsset.js +0 -3
  40. package/dist/cjs/api/resources/notifications/types/BrokerAssetType.d.ts +0 -5
  41. package/dist/cjs/api/resources/notifications/types/BrokerAssetType.js +0 -8
  42. package/dist/cjs/api/resources/notifications/types/BrokerOperationHours.d.ts +0 -7
  43. package/dist/cjs/api/resources/notifications/types/BrokerOperationHours.js +0 -3
  44. package/dist/cjs/api/resources/notifications/types/BrokerOperationPeriod.d.ts +0 -7
  45. package/dist/cjs/api/resources/notifications/types/BrokerOperationPeriod.js +0 -3
  46. package/dist/cjs/api/resources/notifications/types/BrokerPurchaseChannel.d.ts +0 -5
  47. package/dist/cjs/api/resources/notifications/types/BrokerPurchaseChannel.js +0 -8
  48. package/dist/cjs/api/resources/notifications/types/BrokerReward.d.ts +0 -7
  49. package/dist/cjs/api/resources/notifications/types/BrokerReward.js +0 -3
  50. package/dist/cjs/api/resources/notifications/types/BrokerRewardType.d.ts +0 -5
  51. package/dist/cjs/api/resources/notifications/types/BrokerRewardType.js +0 -8
  52. package/dist/cjs/api/resources/notifications/types/LocationAddress.d.ts +0 -10
  53. package/dist/cjs/api/resources/notifications/types/LocationAddress.js +0 -3
  54. package/dist/cjs/api/resources/notifications/types/LocationCoordinates.d.ts +0 -6
  55. package/dist/cjs/api/resources/notifications/types/LocationCoordinates.js +0 -3
  56. package/dist/cjs/api/resources/notifications/types/LocationStatus.d.ts +0 -5
  57. package/dist/cjs/api/resources/notifications/types/LocationStatus.js +0 -8
  58. package/dist/cjs/api/resources/notifications/types/MerchantSource.d.ts +0 -5
  59. package/dist/cjs/api/resources/notifications/types/MerchantSource.js +0 -8
  60. package/dist/cjs/api/resources/notifications/types/OfferStatus.d.ts +0 -5
  61. package/dist/cjs/api/resources/notifications/types/OfferStatus.js +0 -8
  62. package/dist/cjs/api/resources/notifications/types/OfferType.d.ts +0 -4
  63. package/dist/cjs/api/resources/notifications/types/OfferType.js +0 -7
  64. package/dist/cjs/api/resources/notifications/types/TimePeriod.d.ts +0 -6
  65. package/dist/cjs/api/resources/notifications/types/TimePeriod.js +0 -3
  66. package/dist/cjs/api/resources/notifications/types/UserOfferStatus.d.ts +0 -5
  67. package/dist/cjs/api/resources/notifications/types/UserOfferStatus.js +0 -8
  68. package/dist/cjs/api/resources/notifications/types/WebhookLocationsAttributes.d.ts +0 -21
  69. package/dist/cjs/api/resources/notifications/types/WebhookLocationsAttributes.js +0 -3
  70. package/dist/cjs/api/resources/notifications/types/WebhookLocationsData.d.ts +0 -7
  71. package/dist/cjs/api/resources/notifications/types/WebhookLocationsData.js +0 -3
  72. package/dist/cjs/api/resources/notifications/types/WebhookLocationsRelationships.d.ts +0 -4
  73. package/dist/cjs/api/resources/notifications/types/WebhookLocationsRelationships.js +0 -3
  74. package/dist/cjs/api/resources/notifications/types/WebhookMerchantAttributes.d.ts +0 -21
  75. package/dist/cjs/api/resources/notifications/types/WebhookMerchantAttributes.js +0 -3
  76. package/dist/cjs/api/resources/notifications/types/WebhookMerchantData.d.ts +0 -7
  77. package/dist/cjs/api/resources/notifications/types/WebhookMerchantData.js +0 -3
  78. package/dist/cjs/api/resources/notifications/types/WebhookMerchantRelationships.d.ts +0 -4
  79. package/dist/cjs/api/resources/notifications/types/WebhookMerchantRelationships.js +0 -3
  80. package/dist/cjs/api/resources/notifications/types/WebhookOfferAttributes.d.ts +0 -43
  81. package/dist/cjs/api/resources/notifications/types/WebhookOfferAttributes.js +0 -3
  82. package/dist/cjs/api/resources/notifications/types/WebhookOfferData.d.ts +0 -7
  83. package/dist/cjs/api/resources/notifications/types/WebhookOfferData.js +0 -3
  84. package/dist/cjs/api/resources/notifications/types/WebhookOfferRelationships.d.ts +0 -4
  85. package/dist/cjs/api/resources/notifications/types/WebhookOfferRelationships.js +0 -3
  86. package/dist/cjs/api/resources/notifications/types/WebhookUserOfferAttributes.d.ts +0 -11
  87. package/dist/cjs/api/resources/notifications/types/WebhookUserOfferAttributes.js +0 -3
  88. package/dist/cjs/api/resources/notifications/types/WebhookUserOfferData.d.ts +0 -7
  89. package/dist/cjs/api/resources/notifications/types/WebhookUserOfferData.js +0 -3
  90. package/dist/cjs/api/resources/notifications/types/WebhookUserOfferRelationships.d.ts +0 -5
  91. package/dist/cjs/api/resources/notifications/types/WebhookUserOfferRelationships.js +0 -3
  92. package/dist/esm/api/resources/notifications/types/BrokerAmount.d.mts +0 -7
  93. package/dist/esm/api/resources/notifications/types/BrokerAmount.mjs +0 -2
  94. package/dist/esm/api/resources/notifications/types/BrokerAmountType.d.mts +0 -4
  95. package/dist/esm/api/resources/notifications/types/BrokerAmountType.mjs +0 -4
  96. package/dist/esm/api/resources/notifications/types/BrokerAsset.d.mts +0 -9
  97. package/dist/esm/api/resources/notifications/types/BrokerAsset.mjs +0 -2
  98. package/dist/esm/api/resources/notifications/types/BrokerAssetType.d.mts +0 -5
  99. package/dist/esm/api/resources/notifications/types/BrokerAssetType.mjs +0 -5
  100. package/dist/esm/api/resources/notifications/types/BrokerOperationHours.d.mts +0 -7
  101. package/dist/esm/api/resources/notifications/types/BrokerOperationHours.mjs +0 -2
  102. package/dist/esm/api/resources/notifications/types/BrokerOperationPeriod.d.mts +0 -7
  103. package/dist/esm/api/resources/notifications/types/BrokerOperationPeriod.mjs +0 -2
  104. package/dist/esm/api/resources/notifications/types/BrokerPurchaseChannel.d.mts +0 -5
  105. package/dist/esm/api/resources/notifications/types/BrokerPurchaseChannel.mjs +0 -5
  106. package/dist/esm/api/resources/notifications/types/BrokerReward.d.mts +0 -7
  107. package/dist/esm/api/resources/notifications/types/BrokerReward.mjs +0 -2
  108. package/dist/esm/api/resources/notifications/types/BrokerRewardType.d.mts +0 -5
  109. package/dist/esm/api/resources/notifications/types/BrokerRewardType.mjs +0 -5
  110. package/dist/esm/api/resources/notifications/types/LocationAddress.d.mts +0 -10
  111. package/dist/esm/api/resources/notifications/types/LocationAddress.mjs +0 -2
  112. package/dist/esm/api/resources/notifications/types/LocationCoordinates.d.mts +0 -6
  113. package/dist/esm/api/resources/notifications/types/LocationCoordinates.mjs +0 -2
  114. package/dist/esm/api/resources/notifications/types/LocationStatus.d.mts +0 -5
  115. package/dist/esm/api/resources/notifications/types/LocationStatus.mjs +0 -5
  116. package/dist/esm/api/resources/notifications/types/MerchantSource.d.mts +0 -5
  117. package/dist/esm/api/resources/notifications/types/MerchantSource.mjs +0 -5
  118. package/dist/esm/api/resources/notifications/types/OfferStatus.d.mts +0 -5
  119. package/dist/esm/api/resources/notifications/types/OfferStatus.mjs +0 -5
  120. package/dist/esm/api/resources/notifications/types/OfferType.d.mts +0 -4
  121. package/dist/esm/api/resources/notifications/types/OfferType.mjs +0 -4
  122. package/dist/esm/api/resources/notifications/types/TimePeriod.d.mts +0 -6
  123. package/dist/esm/api/resources/notifications/types/TimePeriod.mjs +0 -2
  124. package/dist/esm/api/resources/notifications/types/UserOfferStatus.d.mts +0 -5
  125. package/dist/esm/api/resources/notifications/types/UserOfferStatus.mjs +0 -5
  126. package/dist/esm/api/resources/notifications/types/WebhookLocationsAttributes.d.mts +0 -21
  127. package/dist/esm/api/resources/notifications/types/WebhookLocationsAttributes.mjs +0 -2
  128. package/dist/esm/api/resources/notifications/types/WebhookLocationsData.d.mts +0 -7
  129. package/dist/esm/api/resources/notifications/types/WebhookLocationsData.mjs +0 -2
  130. package/dist/esm/api/resources/notifications/types/WebhookLocationsRelationships.d.mts +0 -4
  131. package/dist/esm/api/resources/notifications/types/WebhookLocationsRelationships.mjs +0 -2
  132. package/dist/esm/api/resources/notifications/types/WebhookMerchantAttributes.d.mts +0 -21
  133. package/dist/esm/api/resources/notifications/types/WebhookMerchantAttributes.mjs +0 -2
  134. package/dist/esm/api/resources/notifications/types/WebhookMerchantData.d.mts +0 -7
  135. package/dist/esm/api/resources/notifications/types/WebhookMerchantData.mjs +0 -2
  136. package/dist/esm/api/resources/notifications/types/WebhookMerchantRelationships.d.mts +0 -4
  137. package/dist/esm/api/resources/notifications/types/WebhookMerchantRelationships.mjs +0 -2
  138. package/dist/esm/api/resources/notifications/types/WebhookOfferAttributes.d.mts +0 -43
  139. package/dist/esm/api/resources/notifications/types/WebhookOfferAttributes.mjs +0 -2
  140. package/dist/esm/api/resources/notifications/types/WebhookOfferData.d.mts +0 -7
  141. package/dist/esm/api/resources/notifications/types/WebhookOfferData.mjs +0 -2
  142. package/dist/esm/api/resources/notifications/types/WebhookOfferRelationships.d.mts +0 -4
  143. package/dist/esm/api/resources/notifications/types/WebhookOfferRelationships.mjs +0 -2
  144. package/dist/esm/api/resources/notifications/types/WebhookUserOfferAttributes.d.mts +0 -11
  145. package/dist/esm/api/resources/notifications/types/WebhookUserOfferAttributes.mjs +0 -2
  146. package/dist/esm/api/resources/notifications/types/WebhookUserOfferData.d.mts +0 -7
  147. package/dist/esm/api/resources/notifications/types/WebhookUserOfferData.mjs +0 -2
  148. package/dist/esm/api/resources/notifications/types/WebhookUserOfferRelationships.d.mts +0 -5
  149. package/dist/esm/api/resources/notifications/types/WebhookUserOfferRelationships.mjs +0 -2
@@ -1,5 +0,0 @@
1
- export declare const UserOfferStatus: {
2
- readonly Active: "ACTIVE";
3
- readonly Inactive: "INACTIVE";
4
- };
5
- export type UserOfferStatus = (typeof UserOfferStatus)[keyof typeof UserOfferStatus];
@@ -1,8 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.UserOfferStatus = void 0;
5
- exports.UserOfferStatus = {
6
- Active: "ACTIVE",
7
- Inactive: "INACTIVE",
8
- };
@@ -1,21 +0,0 @@
1
- import type * as KardApi from "../../../index.js";
2
- export interface WebhookLocationsAttributes {
3
- /** The Kard location ID */
4
- locationId: string;
5
- /** The name of the location */
6
- name: string;
7
- /** The status of the location */
8
- status: KardApi.LocationStatus;
9
- /** The physical address of the location */
10
- address: KardApi.LocationAddress;
11
- /** The geographic coordinates of the location */
12
- coordinates: KardApi.LocationCoordinates;
13
- /** The phone number of the location */
14
- phone: string;
15
- /** The hours of operation for the location */
16
- operationHours: KardApi.BrokerOperationHours;
17
- /** When the location was created */
18
- createdAt: string;
19
- /** When the location was last updated */
20
- updatedAt: string;
21
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,7 +0,0 @@
1
- import type * as KardApi from "../../../index.js";
2
- export interface WebhookLocationsData {
3
- /** The internal ID of the notification */
4
- id: string;
5
- attributes: KardApi.WebhookLocationsAttributes;
6
- relationships: KardApi.WebhookLocationsRelationships;
7
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,4 +0,0 @@
1
- import type * as KardApi from "../../../index.js";
2
- export interface WebhookLocationsRelationships {
3
- merchant: KardApi.RelationshipSingle;
4
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,21 +0,0 @@
1
- import type * as KardApi from "../../../index.js";
2
- export interface WebhookMerchantAttributes {
3
- /** The Kard merchant ID */
4
- merchantId: string;
5
- /** The name of the merchant */
6
- name: string;
7
- /** The description of the merchant */
8
- description: string;
9
- /** The URL of the merchant's website */
10
- websiteUrl: string;
11
- /** Media assets associated with the merchant */
12
- assets: KardApi.BrokerAsset[];
13
- /** The source of the merchant data */
14
- source: KardApi.MerchantSource;
15
- /** The category of the merchant */
16
- category: string;
17
- /** When the merchant was last updated */
18
- updatedAt: string;
19
- /** When the merchant was created */
20
- createdAt: string;
21
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,7 +0,0 @@
1
- import type * as KardApi from "../../../index.js";
2
- export interface WebhookMerchantData {
3
- /** The internal ID of the notification */
4
- id: string;
5
- attributes: KardApi.WebhookMerchantAttributes;
6
- relationships: KardApi.WebhookMerchantRelationships;
7
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,4 +0,0 @@
1
- import type * as KardApi from "../../../index.js";
2
- export interface WebhookMerchantRelationships {
3
- offer?: KardApi.RelationshipMultiple;
4
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,43 +0,0 @@
1
- import type * as KardApi from "../../../index.js";
2
- export interface WebhookOfferAttributes {
3
- /** The Kard offer ID */
4
- offerId: string;
5
- /** The type of kard platform offer (e.g., "standardOffer") */
6
- offerType: KardApi.OfferType;
7
- /** The name of the offer */
8
- name: string;
9
- /** Terms and conditions for the offer */
10
- terms: string;
11
- /** Current status of the offer */
12
- status: KardApi.OfferStatus;
13
- /** Channels where the offer can be redeemed */
14
- purchaseChannel: KardApi.BrokerPurchaseChannel[];
15
- /** Reward details for the user */
16
- userReward: KardApi.BrokerReward;
17
- /** When the offer becomes active */
18
- startDate: string;
19
- /** When the offer expires */
20
- expirationDate: string;
21
- /** Minimum reward amount */
22
- minRewardAmount?: KardApi.BrokerAmount;
23
- /** Maximum reward amount */
24
- maxRewardAmount?: KardApi.BrokerAmount;
25
- /** Minimum user reward amount */
26
- minUserRewardAmount?: KardApi.BrokerAmount;
27
- /** Maximum user reward amount */
28
- maxUserRewardAmount?: KardApi.BrokerAmount;
29
- /** Minimum transaction amount */
30
- minTransactionAmount?: KardApi.BrokerAmount;
31
- /** Maximum transaction amount */
32
- maxTransactionAmount?: KardApi.BrokerAmount;
33
- /** Maximum number of times the offer can be redeemed */
34
- maxRedemptions?: number;
35
- /** Required MCCs to redeem the offer. If this is empty or not present no MCCs are required. */
36
- validMCCs?: string[];
37
- /** Whether the offer is targeted to specific users */
38
- isTargeted: boolean;
39
- /** When the offer was last updated */
40
- updatedAt: string;
41
- /** When the offer was created */
42
- createdAt: string;
43
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,7 +0,0 @@
1
- import type * as KardApi from "../../../index.js";
2
- export interface WebhookOfferData {
3
- /** The internal ID of the notification */
4
- id: string;
5
- attributes: KardApi.WebhookOfferAttributes;
6
- relationships: KardApi.WebhookOfferRelationships;
7
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,4 +0,0 @@
1
- import type * as KardApi from "../../../index.js";
2
- export interface WebhookOfferRelationships {
3
- merchant: KardApi.RelationshipSingle;
4
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,11 +0,0 @@
1
- import type * as KardApi from "../../../index.js";
2
- export interface WebhookUserOfferAttributes {
3
- /** Current status of the user offer */
4
- status: KardApi.UserOfferStatus;
5
- /** When the user offer was last updated */
6
- updatedAt: string;
7
- /** When the user offer was created */
8
- createdAt: string;
9
- /** The priority of the notification event. This will be a number between 1-10 with 1 being the highest priority. */
10
- eventPriority: number;
11
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,7 +0,0 @@
1
- import type * as KardApi from "../../../index.js";
2
- export interface WebhookUserOfferData {
3
- /** The internal ID of the notification */
4
- id: string;
5
- attributes: KardApi.WebhookUserOfferAttributes;
6
- relationships: KardApi.WebhookUserOfferRelationships;
7
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,5 +0,0 @@
1
- import type * as KardApi from "../../../index.js";
2
- export interface WebhookUserOfferRelationships {
3
- offer: KardApi.RelationshipSingle;
4
- user: KardApi.RelationshipSingle;
5
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file was auto-generated by Fern from our API Definition.
3
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,7 +0,0 @@
1
- import type * as KardApi from "../../../index.mjs";
2
- export interface BrokerAmount {
3
- /** Type of amount */
4
- type: KardApi.BrokerAmountType;
5
- /** Amount value */
6
- value: number;
7
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,4 +0,0 @@
1
- export declare const BrokerAmountType: {
2
- readonly Cents: "CENTS";
3
- };
4
- export type BrokerAmountType = (typeof BrokerAmountType)[keyof typeof BrokerAmountType];
@@ -1,4 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export const BrokerAmountType = {
3
- Cents: "CENTS",
4
- };
@@ -1,9 +0,0 @@
1
- import type * as KardApi from "../../../index.mjs";
2
- export interface BrokerAsset {
3
- /** Type of asset */
4
- type: KardApi.BrokerAssetType;
5
- /** URL to the asset */
6
- url: string;
7
- /** Alt text for the asset */
8
- alt?: string;
9
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,5 +0,0 @@
1
- export declare const BrokerAssetType: {
2
- readonly LogoImage: "LOGO_IMAGE";
3
- readonly BannerImage: "BANNER_IMAGE";
4
- };
5
- export type BrokerAssetType = (typeof BrokerAssetType)[keyof typeof BrokerAssetType];
@@ -1,5 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export const BrokerAssetType = {
3
- LogoImage: "LOGO_IMAGE",
4
- BannerImage: "BANNER_IMAGE",
5
- };
@@ -1,7 +0,0 @@
1
- import type * as KardApi from "../../../index.mjs";
2
- export interface BrokerOperationHours {
3
- /** Operating hour periods by day of week */
4
- periods?: KardApi.BrokerOperationPeriod[];
5
- /** Human-readable description of operating hours */
6
- weekdayText: string[];
7
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,7 +0,0 @@
1
- import type * as KardApi from "../../../index.mjs";
2
- export interface BrokerOperationPeriod {
3
- /** When the location opens */
4
- open: KardApi.TimePeriod;
5
- /** When the location closes */
6
- close: KardApi.TimePeriod;
7
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,5 +0,0 @@
1
- export declare const BrokerPurchaseChannel: {
2
- readonly Instore: "INSTORE";
3
- readonly Online: "ONLINE";
4
- };
5
- export type BrokerPurchaseChannel = (typeof BrokerPurchaseChannel)[keyof typeof BrokerPurchaseChannel];
@@ -1,5 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export const BrokerPurchaseChannel = {
3
- Instore: "INSTORE",
4
- Online: "ONLINE",
5
- };
@@ -1,7 +0,0 @@
1
- import type * as KardApi from "../../../index.mjs";
2
- export interface BrokerReward {
3
- /** Type of reward */
4
- type: KardApi.BrokerRewardType;
5
- /** Reward value */
6
- value: number;
7
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,5 +0,0 @@
1
- export declare const BrokerRewardType: {
2
- readonly Percent: "PERCENT";
3
- readonly Flat: "FLAT";
4
- };
5
- export type BrokerRewardType = (typeof BrokerRewardType)[keyof typeof BrokerRewardType];
@@ -1,5 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export const BrokerRewardType = {
3
- Percent: "PERCENT",
4
- Flat: "FLAT",
5
- };
@@ -1,10 +0,0 @@
1
- export interface LocationAddress {
2
- /** The street address */
3
- street: string;
4
- /** The city */
5
- city: string;
6
- /** The state or province */
7
- state: string;
8
- /** The postal or ZIP code */
9
- zipCode: string;
10
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,6 +0,0 @@
1
- export interface LocationCoordinates {
2
- /** The longitude coordinate */
3
- longitude: number;
4
- /** The latitude coordinate */
5
- latitude: number;
6
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,5 +0,0 @@
1
- export declare const LocationStatus: {
2
- readonly Active: "ACTIVE";
3
- readonly Inactive: "INACTIVE";
4
- };
5
- export type LocationStatus = (typeof LocationStatus)[keyof typeof LocationStatus];
@@ -1,5 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export const LocationStatus = {
3
- Active: "ACTIVE",
4
- Inactive: "INACTIVE",
5
- };
@@ -1,5 +0,0 @@
1
- export declare const MerchantSource: {
2
- readonly National: "NATIONAL";
3
- readonly Local: "LOCAL";
4
- };
5
- export type MerchantSource = (typeof MerchantSource)[keyof typeof MerchantSource];
@@ -1,5 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export const MerchantSource = {
3
- National: "NATIONAL",
4
- Local: "LOCAL",
5
- };
@@ -1,5 +0,0 @@
1
- export declare const OfferStatus: {
2
- readonly Inactive: "INACTIVE";
3
- readonly Active: "ACTIVE";
4
- };
5
- export type OfferStatus = (typeof OfferStatus)[keyof typeof OfferStatus];
@@ -1,5 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export const OfferStatus = {
3
- Inactive: "INACTIVE",
4
- Active: "ACTIVE",
5
- };
@@ -1,4 +0,0 @@
1
- export declare const OfferType: {
2
- readonly StandardOffer: "standardOffer";
3
- };
4
- export type OfferType = (typeof OfferType)[keyof typeof OfferType];
@@ -1,4 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export const OfferType = {
3
- StandardOffer: "standardOffer",
4
- };
@@ -1,6 +0,0 @@
1
- export interface TimePeriod {
2
- /** Day of week (0=Sunday, 1=Monday, etc.) */
3
- day: number;
4
- /** Time in 24-hour format (e.g. "0900" for 9:00 AM) */
5
- time: string;
6
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,5 +0,0 @@
1
- export declare const UserOfferStatus: {
2
- readonly Active: "ACTIVE";
3
- readonly Inactive: "INACTIVE";
4
- };
5
- export type UserOfferStatus = (typeof UserOfferStatus)[keyof typeof UserOfferStatus];
@@ -1,5 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export const UserOfferStatus = {
3
- Active: "ACTIVE",
4
- Inactive: "INACTIVE",
5
- };
@@ -1,21 +0,0 @@
1
- import type * as KardApi from "../../../index.mjs";
2
- export interface WebhookLocationsAttributes {
3
- /** The Kard location ID */
4
- locationId: string;
5
- /** The name of the location */
6
- name: string;
7
- /** The status of the location */
8
- status: KardApi.LocationStatus;
9
- /** The physical address of the location */
10
- address: KardApi.LocationAddress;
11
- /** The geographic coordinates of the location */
12
- coordinates: KardApi.LocationCoordinates;
13
- /** The phone number of the location */
14
- phone: string;
15
- /** The hours of operation for the location */
16
- operationHours: KardApi.BrokerOperationHours;
17
- /** When the location was created */
18
- createdAt: string;
19
- /** When the location was last updated */
20
- updatedAt: string;
21
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,7 +0,0 @@
1
- import type * as KardApi from "../../../index.mjs";
2
- export interface WebhookLocationsData {
3
- /** The internal ID of the notification */
4
- id: string;
5
- attributes: KardApi.WebhookLocationsAttributes;
6
- relationships: KardApi.WebhookLocationsRelationships;
7
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,4 +0,0 @@
1
- import type * as KardApi from "../../../index.mjs";
2
- export interface WebhookLocationsRelationships {
3
- merchant: KardApi.RelationshipSingle;
4
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,21 +0,0 @@
1
- import type * as KardApi from "../../../index.mjs";
2
- export interface WebhookMerchantAttributes {
3
- /** The Kard merchant ID */
4
- merchantId: string;
5
- /** The name of the merchant */
6
- name: string;
7
- /** The description of the merchant */
8
- description: string;
9
- /** The URL of the merchant's website */
10
- websiteUrl: string;
11
- /** Media assets associated with the merchant */
12
- assets: KardApi.BrokerAsset[];
13
- /** The source of the merchant data */
14
- source: KardApi.MerchantSource;
15
- /** The category of the merchant */
16
- category: string;
17
- /** When the merchant was last updated */
18
- updatedAt: string;
19
- /** When the merchant was created */
20
- createdAt: string;
21
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,7 +0,0 @@
1
- import type * as KardApi from "../../../index.mjs";
2
- export interface WebhookMerchantData {
3
- /** The internal ID of the notification */
4
- id: string;
5
- attributes: KardApi.WebhookMerchantAttributes;
6
- relationships: KardApi.WebhookMerchantRelationships;
7
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,4 +0,0 @@
1
- import type * as KardApi from "../../../index.mjs";
2
- export interface WebhookMerchantRelationships {
3
- offer?: KardApi.RelationshipMultiple;
4
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};
@@ -1,43 +0,0 @@
1
- import type * as KardApi from "../../../index.mjs";
2
- export interface WebhookOfferAttributes {
3
- /** The Kard offer ID */
4
- offerId: string;
5
- /** The type of kard platform offer (e.g., "standardOffer") */
6
- offerType: KardApi.OfferType;
7
- /** The name of the offer */
8
- name: string;
9
- /** Terms and conditions for the offer */
10
- terms: string;
11
- /** Current status of the offer */
12
- status: KardApi.OfferStatus;
13
- /** Channels where the offer can be redeemed */
14
- purchaseChannel: KardApi.BrokerPurchaseChannel[];
15
- /** Reward details for the user */
16
- userReward: KardApi.BrokerReward;
17
- /** When the offer becomes active */
18
- startDate: string;
19
- /** When the offer expires */
20
- expirationDate: string;
21
- /** Minimum reward amount */
22
- minRewardAmount?: KardApi.BrokerAmount;
23
- /** Maximum reward amount */
24
- maxRewardAmount?: KardApi.BrokerAmount;
25
- /** Minimum user reward amount */
26
- minUserRewardAmount?: KardApi.BrokerAmount;
27
- /** Maximum user reward amount */
28
- maxUserRewardAmount?: KardApi.BrokerAmount;
29
- /** Minimum transaction amount */
30
- minTransactionAmount?: KardApi.BrokerAmount;
31
- /** Maximum transaction amount */
32
- maxTransactionAmount?: KardApi.BrokerAmount;
33
- /** Maximum number of times the offer can be redeemed */
34
- maxRedemptions?: number;
35
- /** Required MCCs to redeem the offer. If this is empty or not present no MCCs are required. */
36
- validMCCs?: string[];
37
- /** Whether the offer is targeted to specific users */
38
- isTargeted: boolean;
39
- /** When the offer was last updated */
40
- updatedAt: string;
41
- /** When the offer was created */
42
- createdAt: string;
43
- }
@@ -1,2 +0,0 @@
1
- // This file was auto-generated by Fern from our API Definition.
2
- export {};