@kard-financial/sdk 0.0.1

package/dist/cjs/api/resources/transactions/types/States.js

@@ -0,0 +1,67 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.States = void 0;
+exports.States = {
+    Al: "AL",
+    Ak: "AK",
+    As: "AS",
+    Az: "AZ",
+    Ar: "AR",
+    Ca: "CA",
+    Co: "CO",
+    Ct: "CT",
+    De: "DE",
+    Dc: "DC",
+    Fm: "FM",
+    Fl: "FL",
+    Ga: "GA",
+    Gu: "GU",
+    Hi: "HI",
+    Id: "ID",
+    Il: "IL",
+    In: "IN",
+    Ia: "IA",
+    Ks: "KS",
+    Ky: "KY",
+    La: "LA",
+    Me: "ME",
+    Mh: "MH",
+    Md: "MD",
+    Ma: "MA",
+    Mi: "MI",
+    Mn: "MN",
+    Ms: "MS",
+    Mo: "MO",
+    Mt: "MT",
+    Ne: "NE",
+    Nv: "NV",
+    Nh: "NH",
+    Nj: "NJ",
+    Nm: "NM",
+    Ny: "NY",
+    Nc: "NC",
+    Nd: "ND",
+    Mp: "MP",
+    Oh: "OH",
+    Ok: "OK",
+    Or: "OR",
+    Pw: "PW",
+    Pa: "PA",
+    Pr: "PR",
+    Ri: "RI",
+    Sc: "SC",
+    Sd: "SD",
+    Tn: "TN",
+    Tx: "TX",
+    Ut: "UT",
+    Vt: "VT",
+    Vi: "VI",
+    Va: "VA",
+    Wa: "WA",
+    Wv: "WV",
+    Wi: "WI",
+    Wy: "WY",
+};

package/dist/cjs/api/resources/transactions/types/TransactionPaymentType.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type TransactionPaymentType = "CARD";
+export declare const TransactionPaymentType: {
+    readonly Card: "CARD";
+};

package/dist/cjs/api/resources/transactions/types/TransactionPaymentType.js

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

package/dist/cjs/api/resources/transactions/types/TransactionStatus.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type TransactionStatus = "APPROVED" | "SETTLED" | "REVERSED" | "RETURNED" | "DECLINED";
+export declare const TransactionStatus: {
+    readonly Approved: "APPROVED";
+    readonly Settled: "SETTLED";
+    readonly Reversed: "REVERSED";
+    readonly Returned: "RETURNED";
+    readonly Declined: "DECLINED";
+};

package/dist/cjs/api/resources/transactions/types/TransactionStatus.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionStatus = void 0;
+exports.TransactionStatus = {
+    Approved: "APPROVED",
+    Settled: "SETTLED",
+    Reversed: "REVERSED",
+    Returned: "RETURNED",
+    Declined: "DECLINED",
+};

package/dist/cjs/api/resources/transactions/types/Transactions.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as KardApi from "../../../index.js";
+export type Transactions = KardApi.Transactions.Transaction | KardApi.Transactions.MatchedTransaction;
+export declare namespace Transactions {
+    interface Transaction extends KardApi.TransactionsRequest {
+        type: "transaction";
+    }
+    interface MatchedTransaction extends KardApi.MatchedTransactionsRequest {
+        type: "matchedTransaction";
+    }
+}

package/dist/cjs/api/resources/transactions/types/Transactions.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/transactions/types/TransactionsAttributes.d.ts

@@ -0,0 +1,58 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as KardApi from "../../../index.js";
+export interface TransactionsAttributes {
+    /** The ID of the user as defined on the issuers system */
+    userId: string;
+    /** Transaction amount in cents */
+    amount: number;
+    /** The base amount in cents excluding additional charges (such as tips, taxes, and other fees). */
+    subtotal?: number;
+    /** Transaction status */
+    status: KardApi.TransactionStatus;
+    /** Currency of transaction */
+    currency: string;
+    /** Description of transaction - usually includes merchant and other key details on transaction */
+    description: string;
+    /** Description2 of transaction — usually includes other merchant identifying information */
+    description2?: string;
+    /** Merchant Category Code (usually a 4-digit numerical number). <b>Note, this field is REQUIRED for SOME national offers. We HIGHLY RECOMMEND sending this field as it will be required in the near future.</b> */
+    mcc?: string;
+    /** Name of processor associated with transaction */
+    coreProviderId?: string;
+    /** Timestamp for <b>REVERSED, RETURNED, DECLINED</b> transaction events; <b>REQUIRED</b> for transactions with <b>REVERSED, RETURNED, DECLINED</b> status. Date string should be in ISO format i.e.`'YYYY-MM-DDThh:mm:ss.sTZD'` where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. `1994-11-05T08:15:30-05:00` OR `1994-11-05T08:15:30Z` */
+    transactionDate?: string;
+    /** Timestamp for <b>APPROVED</b> transaction event; <b>REQUIRED</b> for transactions with <b>APPROVED</b> status, and <b>HIGHLY RECOMMENDED</b> to include for transactions with a <b>SETTLED</b> status. Date string should be in ISO format i.e.`'YYYY-MM-DDThh:mm:ss.sTZD'` where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. `1994-11-05T08:15:30-05:00 OR 1994-11-05T08:15:30Z` */
+    authorizationDate?: string;
+    /** Timestamp for <b>SETTLED</b> transaction event, <b>REQUIRED</b> for transactions with <b>SETTLED</b> status. Date string should be in ISO format i.e.`'YYYY-MM-DDThh:mm:ss.sTZD'` where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. `1994-11-05T08:15:30-05:00` OR `1994-11-05T08:15:30Z` */
+    settledDate?: string;
+    /** Merchant details */
+    merchant?: KardApi.Merchant;
+    /** Whether card was present at time of transaction */
+    cardPresence?: string;
+    /** PAN entry mode */
+    panEntryMode?: string;
+    /** Bank identification number (BIN). Must be a valid BIN of 6 digits. If over 6 digits, please send first 6. */
+    cardBIN: string;
+    /** Card last four digits. */
+    cardLastFour: string;
+    /** Transaction approval code */
+    authorizationCode?: string;
+    /** Retrieval Reference Number */
+    retrievalReferenceNumber?: string;
+    /** System Trace Audit Number */
+    systemTraceAuditNumber?: string;
+    /** Acquirer Reference Number */
+    acquirerReferenceNumber?: string;
+    /** The direction in which the funds flow - DEBIT or CREDIT */
+    direction: KardApi.DirectionType;
+    /** The type of payment involved in the transaction. */
+    paymentType: KardApi.TransactionPaymentType;
+    /** The card network associated with the transaction */
+    cardNetwork?: KardApi.CardNetwork;
+    /** The transaction ID */
+    transactionId: string;
+    /** The card product ID associated with the transaction */
+    cardProductId?: string;
+}

package/dist/cjs/api/resources/transactions/types/TransactionsAttributes.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/transactions/types/TransactionsMultiResponse.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 TransactionsMultiResponse extends KardApi.ErrorResponse {
+    data: KardApi.TransactionsResponseData;
+}

package/dist/cjs/api/resources/transactions/types/TransactionsMultiResponse.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/transactions/types/TransactionsRequest.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 TransactionsRequest {
+    /** Unique identifier for the transaction event. This <b>must</b> be unique for each distinct event sent to the API. */
+    id: string;
+    attributes: KardApi.TransactionsAttributes;
+}

package/dist/cjs/api/resources/transactions/types/TransactionsRequest.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/transactions/types/TransactionsRequestBody.d.ts

@@ -0,0 +1,91 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as KardApi from "../../../index.js";
+/**
+ * @example
+ *     {
+ *         data: [{
+ *                 type: "transaction",
+ *                 id: "309rjfoincor3icno3rind093cdow3jciwjdwcm",
+ *                 attributes: {
+ *                     userId: "6FHt5b6Fnp0qdomMEy5AN6PXcSJIeX69",
+ *                     status: KardApi.TransactionStatus.Approved,
+ *                     amount: 1000,
+ *                     subtotal: 800,
+ *                     currency: "USD",
+ *                     direction: KardApi.DirectionType.Debit,
+ *                     paymentType: KardApi.TransactionPaymentType.Card,
+ *                     description: "ADVANCEAUTO",
+ *                     description2: "ADVANCEAUTO",
+ *                     mcc: "1234",
+ *                     cardBIN: "123456",
+ *                     cardLastFour: "4321",
+ *                     authorizationDate: "2021-07-02T17:47:06Z",
+ *                     merchant: {
+ *                         id: "12345678901234567",
+ *                         name: "ADVANCEAUTO",
+ *                         addrStreet: "125 Main St",
+ *                         addrCity: "Philadelphia",
+ *                         addrState: KardApi.States.Pa,
+ *                         addrZipcode: "19147",
+ *                         addrCountry: "United States",
+ *                         latitude: "37.9419429",
+ *                         longitude: "-73.1446869",
+ *                         storeId: "12345"
+ *                     },
+ *                     authorizationCode: "123456",
+ *                     retrievalReferenceNumber: "100804333919",
+ *                     acquirerReferenceNumber: "1234567890123456789012345678",
+ *                     systemTraceAuditNumber: "333828",
+ *                     transactionId: "2467de37-cbdc-416d-a359-75de87bfffb0",
+ *                     cardProductId: "1234567890123456789012345678"
+ *                 }
+ *             }]
+ *     }
+ *
+ * @example
+ *     {
+ *         data: [{
+ *                 type: "matchedTransaction",
+ *                 id: "soduinfwoer82498h248h298heo2eic",
+ *                 attributes: {
+ *                     userId: "6FHt5b6Fnp0qdomMEy5AN6PXcSJIeX69",
+ *                     amount: 1000,
+ *                     subtotal: 800,
+ *                     description: "ADVANCEAUTO",
+ *                     authorizationDate: "2021-07-02T17:47:06Z",
+ *                     paymentType: KardApi.PaymentType.Card,
+ *                     matchedOfferId: "5eb2d4a39ce24e00081488c4",
+ *                     matchedLocationId: "5eb2d4a39ce24e00081488d5",
+ *                     cardBIN: "12345",
+ *                     direction: KardApi.DirectionType.Debit,
+ *                     merchant: {
+ *                         id: "12345678901234567",
+ *                         name: "ADVANCEAUTO",
+ *                         addrStreet: "125 Main St",
+ *                         addrCity: "Philadephia",
+ *                         addrState: KardApi.States.Pa,
+ *                         addrZipcode: "19147",
+ *                         addrCountry: "United States"
+ *                     },
+ *                     cardLastFour: "4321",
+ *                     authorizationCode: "1234",
+ *                     retrievalReferenceNumber: "100804333919",
+ *                     systemTraceAuditNumber: "333828",
+ *                     acquirerReferenceNumber: "1234567890123456789012345678",
+ *                     transactionId: "2467de37-cbdc-416d-a359-75de87bfffb0",
+ *                     cardProductId: "1234567890123456789012345678"
+ *                 }
+ *             }]
+ *     }
+ */
+export interface TransactionsRequestBody {
+    /**
+     * Discriminated union representing the request body for submitting a transaction.
+     * Use `type` to distinguish between the two:
+     * - `transaction`: For transactions requiring processing and matching by the Kard system.
+     * - `matchedTransaction`: For pre-matched transactions that need validation on match by the Kard system.
+     */
+    data: KardApi.Transactions[];
+}

package/dist/cjs/api/resources/transactions/types/TransactionsRequestBody.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/transactions/types/TransactionsResponse.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: "job",
+ *             id: "c94a93a7-beb9-4e58-960c-2c812f849398",
+ *             attributes: {
+ *                 status: KardApi.JobStatus.Queued,
+ *                 message: "Incoming Transactions event successfully queued for processing"
+ *             }
+ *         }
+ *     }
+ */
+export interface TransactionsResponse {
+    data: KardApi.TransactionsResponseData;
+}

package/dist/cjs/api/resources/transactions/types/TransactionsResponse.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/transactions/types/TransactionsResponseData.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as KardApi from "../../../index.js";
+export interface TransactionsResponseData {
+    type: KardApi.ResourceType;
+    /** The request id of the pending job */
+    id: string;
+    attributes: KardApi.Job;
+}

package/dist/cjs/api/resources/transactions/types/TransactionsResponseData.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/transactions/types/index.d.ts

@@ -0,0 +1,17 @@
+export * from "./TransactionsResponseData.js";
+export * from "./TransactionsRequestBody.js";
+export * from "./Transactions.js";
+export * from "./TransactionsRequest.js";
+export * from "./TransactionsAttributes.js";
+export * from "./MatchedTransactionsRequest.js";
+export * from "./MatchedTransactionsAttributes.js";
+export * from "./TransactionsResponse.js";
+export * from "./TransactionsMultiResponse.js";
+export * from "./Merchant.js";
+export * from "./AuditStatus.js";
+export * from "./TransactionStatus.js";
+export * from "./PaymentType.js";
+export * from "./TransactionPaymentType.js";
+export * from "./DirectionType.js";
+export * from "./States.js";
+export * from "./CardNetwork.js";

package/dist/cjs/api/resources/transactions/types/index.js

@@ -0,0 +1,33 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./TransactionsResponseData.js"), exports);
+__exportStar(require("./TransactionsRequestBody.js"), exports);
+__exportStar(require("./Transactions.js"), exports);
+__exportStar(require("./TransactionsRequest.js"), exports);
+__exportStar(require("./TransactionsAttributes.js"), exports);
+__exportStar(require("./MatchedTransactionsRequest.js"), exports);
+__exportStar(require("./MatchedTransactionsAttributes.js"), exports);
+__exportStar(require("./TransactionsResponse.js"), exports);
+__exportStar(require("./TransactionsMultiResponse.js"), exports);
+__exportStar(require("./Merchant.js"), exports);
+__exportStar(require("./AuditStatus.js"), exports);
+__exportStar(require("./TransactionStatus.js"), exports);
+__exportStar(require("./PaymentType.js"), exports);
+__exportStar(require("./TransactionPaymentType.js"), exports);
+__exportStar(require("./DirectionType.js"), exports);
+__exportStar(require("./States.js"), exports);
+__exportStar(require("./CardNetwork.js"), exports);

package/dist/cjs/api/resources/users/client/Client.d.ts

@@ -0,0 +1,125 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.js";
+import * as core from "../../../../core/index.js";
+import * as KardApi from "../../../index.js";
+export declare namespace Users {
+    interface Options {
+        environment?: core.Supplier<environments.KardApiEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token: core.Supplier<core.BearerToken>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Users {
+    protected readonly _options: Users.Options;
+    constructor(_options: Users.Options);
+    /**
+     * Call this endpoint to enroll a specified user into your rewards program.<br/>
+     *
+     * <b>Required scopes:</b>&nbsp;&nbsp;`user:write`<br/>
+     * <b>Note:</b> `Maximum of 100 users can be created per request`.
+     *
+     * @param {KardApi.OrganizationId} organizationId
+     * @param {KardApi.CreateUsersObject} request
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link KardApi.MultiStatus}
+     * @throws {@link KardApi.UnauthorizedError}
+     * @throws {@link KardApi.InvalidRequest}
+     * @throws {@link KardApi.InternalServerError}
+     * @throws {@link KardApi.ConflictError}
+     *
+     * @example
+     *     await client.users.createUsers("organization-123", {
+     *         data: [{
+     *                 type: "user",
+     *                 id: "1234567890",
+     *                 attributes: {
+     *                     zipCode: "11238",
+     *                     enrolledRewards: ["CARDLINKED"]
+     *                 }
+     *             }]
+     *     })
+     */
+    createUsers(organizationId: KardApi.OrganizationId, request: KardApi.CreateUsersObject, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<KardApi.CreateUsersObject>;
+    private __createUsers;
+    /**
+     * Call this endpoint to update the details on a specified user.<br/>
+     *
+     * <b>Required scopes:</b> `user:update`
+     *
+     * @param {KardApi.OrganizationId} organizationId
+     * @param {KardApi.UserId} userId
+     * @param {KardApi.UpdateUserObject} request
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link KardApi.UnauthorizedError}
+     * @throws {@link KardApi.InvalidRequest}
+     * @throws {@link KardApi.InternalServerError}
+     * @throws {@link KardApi.DoesNotExistError}
+     *
+     * @example
+     *     await client.users.updateUser("organization-123", "user-123", {
+     *         data: {
+     *             type: "user",
+     *             id: "1234567890",
+     *             attributes: {
+     *                 zipCode: "11238",
+     *                 enrolledRewards: ["CARDLINKED"]
+     *             }
+     *         }
+     *     })
+     */
+    updateUser(organizationId: KardApi.OrganizationId, userId: KardApi.UserId, request: KardApi.UpdateUserObject, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<KardApi.UpdateUserObject>;
+    private __updateUser;
+    /**
+     * Call this endpoint to delete a specified enrolled user from the rewards program and Kard's system. Users can be re-enrolled into rewards by calling the [Create User](/2024-10-01/api/users/create-users) endpoint using the same `id` from before.<br/>
+     *
+     * <b>Required scopes:</b> `user:delete`
+     *
+     * @param {KardApi.OrganizationId} organizationId
+     * @param {KardApi.UserId} userId
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link KardApi.UnauthorizedError}
+     * @throws {@link KardApi.InvalidRequest}
+     * @throws {@link KardApi.InternalServerError}
+     * @throws {@link KardApi.DoesNotExistError}
+     *
+     * @example
+     *     await client.users.deleteUser("organization-123", "user-123")
+     */
+    deleteUser(organizationId: KardApi.OrganizationId, userId: KardApi.UserId, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<KardApi.DeleteUserResponseObject>;
+    private __deleteUser;
+    /**
+     * Call this endpoint to fetch the details on a specified user.<br/>
+     * <br/>
+     * <b>Required scopes:</b>&nbsp;&nbsp;`user:read`
+     *
+     * @param {KardApi.OrganizationId} organizationId
+     * @param {KardApi.UserId} userId
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link KardApi.UnauthorizedError}
+     * @throws {@link KardApi.InternalServerError}
+     * @throws {@link KardApi.DoesNotExistError}
+     *
+     * @example
+     *     await client.users.getUserById("organization-123", "user-123")
+     */
+    getUserById(organizationId: KardApi.OrganizationId, userId: KardApi.UserId, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<KardApi.UpdateUserObject>;
+    private __getUserById;
+    protected _getAuthorizationHeader(): Promise<string>;
+}