@kard-financial/sdk 0.0.1 → 0.0.2

package/README.md

@@ -3,7 +3,7 @@
 [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FKardFinancial%2Fkard-node-sdk)
 [![npm shield](https://img.shields.io/npm/v/@kard-financial/sdk)](https://www.npmjs.com/package/@kard-financial/sdk)
 
-The Kard TypeScript library provides convenient access to the Kard API from TypeScript.
+The Kard TypeScript library provides convenient access to the Kard APIs from TypeScript.
 
 ## Installation
 
@@ -23,24 +23,14 @@ Instantiate and use the client with the following:
 import { KardApiClient } from "@kard-financial/sdk";
 
 const client = new KardApiClient({ token: "YOUR_TOKEN" });
-await client.attributions.createAttributionEvents("organization-123", "user-123", {
+await client.notifications.subscriptions.create("organization-123", {
     data: [
         {
-            type: "offerAttribution",
+            type: "subscription",
             attributes: {
-                entityId: "60e4ba1da31c5a22a144c075",
-                eventCode: "VIEW",
-                medium: "SEARCH",
-                eventDate: "2025-01-01T00:00:00Z",
-            },
-        },
-        {
-            type: "notificationAttribution",
-            attributes: {
-                entityId: "60e4ba1da31c5a22a144c076",
-                eventCode: "IMPRESSION",
-                medium: "PUSH",
-                eventDate: "2025-01-01T00:00:00Z",
+                eventName: "earnedRewardApproved",
+                webhookUrl: "https://webhookUrl.com/post",
+                enabled: true,
             },
         },
     ],
@@ -69,7 +59,7 @@ will be thrown.
 import { KardApiError } from "@kard-financial/sdk";
 
 try {
-    await client.attributions.createAttributionEvents(...);
+    await client.notifications.subscriptions.create(...);
 } catch (err) {
     if (err instanceof KardApiError) {
         console.log(err.statusCode);
@@ -87,7 +77,7 @@ try {
 If you would like to send additional headers as part of the request, use the `headers` request option.
 
 ```typescript
-const response = await client.attributions.createAttributionEvents(..., {
+const response = await client.notifications.subscriptions.create(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
@@ -109,7 +99,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.attributions.createAttributionEvents(..., {
+const response = await client.notifications.subscriptions.create(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -119,7 +109,7 @@ const response = await client.attributions.createAttributionEvents(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.attributions.createAttributionEvents(..., {
+const response = await client.notifications.subscriptions.create(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -130,7 +120,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.attributions.createAttributionEvents(..., {
+const response = await client.notifications.subscriptions.create(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request
@@ -142,7 +132,7 @@ The SDK provides access to raw response data, including headers, through the `.w
 The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
 
 ```typescript
-const { data, rawResponse } = await client.attributions.createAttributionEvents(...).withRawResponse();
+const { data, rawResponse } = await client.notifications.subscriptions.create(...).withRawResponse();
 
 console.log(data);
 console.log(rawResponse.headers['X-My-Header']);

package/dist/cjs/Client.d.ts

@@ -3,8 +3,6 @@
  */
 import * as environments from "./environments.js";
 import * as core from "./core/index.js";
-import { Attributions } from "./api/resources/attributions/client/Client.js";
-import { Eligibility } from "./api/resources/eligibility/client/Client.js";
 import { Notifications } from "./api/resources/notifications/client/Client.js";
 import { Transactions } from "./api/resources/transactions/client/Client.js";
 import { Users } from "./api/resources/users/client/Client.js";
@@ -28,14 +26,10 @@ export declare namespace KardApiClient {
 }
 export declare class KardApiClient {
     protected readonly _options: KardApiClient.Options;
-    protected _attributions: Attributions | undefined;
-    protected _eligibility: Eligibility | undefined;
     protected _notifications: Notifications | undefined;
     protected _transactions: Transactions | undefined;
     protected _users: Users | undefined;
     constructor(_options: KardApiClient.Options);
-    get attributions(): Attributions;
-    get eligibility(): Eligibility;
     get notifications(): Notifications;
     get transactions(): Transactions;
     get users(): Users;

package/dist/cjs/Client.js

@@ -4,34 +4,24 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KardApiClient = void 0;
-const Client_js_1 = require("./api/resources/attributions/client/Client.js");
-const Client_js_2 = require("./api/resources/eligibility/client/Client.js");
-const Client_js_3 = require("./api/resources/notifications/client/Client.js");
-const Client_js_4 = require("./api/resources/transactions/client/Client.js");
-const Client_js_5 = require("./api/resources/users/client/Client.js");
+const Client_js_1 = require("./api/resources/notifications/client/Client.js");
+const Client_js_2 = require("./api/resources/transactions/client/Client.js");
+const Client_js_3 = require("./api/resources/users/client/Client.js");
 class KardApiClient {
     constructor(_options) {
         this._options = _options;
     }
-    get attributions() {
-        var _a;
-        return ((_a = this._attributions) !== null && _a !== void 0 ? _a : (this._attributions = new Client_js_1.Attributions(this._options)));
-    }
-    get eligibility() {
-        var _a;
-        return ((_a = this._eligibility) !== null && _a !== void 0 ? _a : (this._eligibility = new Client_js_2.Eligibility(this._options)));
-    }
     get notifications() {
         var _a;
-        return ((_a = this._notifications) !== null && _a !== void 0 ? _a : (this._notifications = new Client_js_3.Notifications(this._options)));
+        return ((_a = this._notifications) !== null && _a !== void 0 ? _a : (this._notifications = new Client_js_1.Notifications(this._options)));
     }
     get transactions() {
         var _a;
-        return ((_a = this._transactions) !== null && _a !== void 0 ? _a : (this._transactions = new Client_js_4.Transactions(this._options)));
+        return ((_a = this._transactions) !== null && _a !== void 0 ? _a : (this._transactions = new Client_js_2.Transactions(this._options)));
     }
     get users() {
         var _a;
-        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_js_5.Users(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_js_3.Users(this._options)));
     }
 }
 exports.KardApiClient = KardApiClient;

package/dist/cjs/api/resources/commons/types/CommissionValue.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 CommissionValue {
+    /** The type of commission */
+    type: KardApi.CommissionValueType;
+    /** The commission value. */
+    value: number;
+}

package/dist/cjs/api/resources/commons/types/CommissionValueType.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of commission value
+ */
+export type CommissionValueType = "cents";
+export declare const CommissionValueType: {
+    readonly Cents: "cents";
+};

package/dist/cjs/api/resources/{notifications/types/CommissionEarnedType.js → commons/types/CommissionValueType.js}

@@ -3,7 +3,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommissionEarnedType = void 0;
-exports.CommissionEarnedType = {
+exports.CommissionValueType = void 0;
+exports.CommissionValueType = {
     Cents: "cents",
 };

package/dist/cjs/api/resources/commons/types/index.d.ts

@@ -1,5 +1,8 @@
+export * from "./NotificationType.js";
 export * from "./CategoryOption.js";
 export * from "./CommissionType.js";
+export * from "./CommissionValueType.js";
+export * from "./CommissionValue.js";
 export * from "./State.js";
 export * from "./EnrolledRewardsType.js";
 export * from "./PurchaseChannel.js";

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

@@ -14,8 +14,11 @@ 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("./NotificationType.js"), exports);
 __exportStar(require("./CategoryOption.js"), exports);
 __exportStar(require("./CommissionType.js"), exports);
+__exportStar(require("./CommissionValueType.js"), exports);
+__exportStar(require("./CommissionValue.js"), exports);
 __exportStar(require("./State.js"), exports);
 __exportStar(require("./EnrolledRewardsType.js"), exports);
 __exportStar(require("./PurchaseChannel.js"), exports);

package/dist/cjs/api/resources/index.d.ts

@@ -1,9 +1,5 @@
-export * as attributions from "./attributions/index.js";
-export * from "./attributions/types/index.js";
 export * as commons from "./commons/index.js";
 export * from "./commons/types/index.js";
-export * as eligibility from "./eligibility/index.js";
-export * from "./eligibility/types/index.js";
 export * as notifications from "./notifications/index.js";
 export * from "./notifications/types/index.js";
 export * as transactions from "./transactions/index.js";
@@ -13,4 +9,3 @@ export * from "./users/types/index.js";
 export * from "./commons/errors/index.js";
 export * from "./transactions/errors/index.js";
 export * from "./users/errors/index.js";
-export * from "./eligibility/client/requests/index.js";

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

@@ -36,13 +36,9 @@ 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 });
-exports.users = exports.transactions = exports.notifications = exports.eligibility = exports.commons = exports.attributions = void 0;
-exports.attributions = __importStar(require("./attributions/index.js"));
-__exportStar(require("./attributions/types/index.js"), exports);
+exports.users = exports.transactions = exports.notifications = exports.commons = void 0;
 exports.commons = __importStar(require("./commons/index.js"));
 __exportStar(require("./commons/types/index.js"), exports);
-exports.eligibility = __importStar(require("./eligibility/index.js"));
-__exportStar(require("./eligibility/types/index.js"), exports);
 exports.notifications = __importStar(require("./notifications/index.js"));
 __exportStar(require("./notifications/types/index.js"), exports);
 exports.transactions = __importStar(require("./transactions/index.js"));
@@ -52,4 +48,3 @@ __exportStar(require("./users/types/index.js"), exports);
 __exportStar(require("./commons/errors/index.js"), exports);
 __exportStar(require("./transactions/errors/index.js"), exports);
 __exportStar(require("./users/errors/index.js"), exports);
-__exportStar(require("./eligibility/client/requests/index.js"), exports);

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

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments.js";
 import * as core from "../../../../core/index.js";
-import * as KardApi from "../../../index.js";
+import { Subscriptions } from "../resources/subscriptions/client/Client.js";
 export declare namespace Notifications {
     interface Options {
         environment?: core.Supplier<environments.KardApiEnvironment | string>;
@@ -11,46 +11,10 @@ export declare namespace Notifications {
         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 Notifications {
     protected readonly _options: Notifications.Options;
+    protected _subscriptions: Subscriptions | undefined;
     constructor(_options: Notifications.Options);
-    /**
-     * Call this endpoint to subscribe to notification events.<br/>
-     * <b>Required scopes:</b> `notifications:write`
-     *
-     * @param {KardApi.OrganizationId} organizationId
-     * @param {KardApi.SubscriptionRequestBody} request
-     * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link KardApi.UnauthorizedError}
-     * @throws {@link KardApi.InternalServerError}
-     * @throws {@link KardApi.InvalidRequest}
-     * @throws {@link KardApi.ConflictError}
-     *
-     * @example
-     *     await client.notifications.createSubscriptions("organization-123", {
-     *         data: [{
-     *                 type: "subscription",
-     *                 attributes: {
-     *                     eventName: "earnedRewardApproved",
-     *                     webhookUrl: "https://webhookUrl.com/post",
-     *                     enabled: true
-     *                 }
-     *             }]
-     *     })
-     */
-    createSubscriptions(organizationId: KardApi.OrganizationId, request: KardApi.SubscriptionRequestBody, requestOptions?: Notifications.RequestOptions): core.HttpResponsePromise<KardApi.CreateSubscriptionsResponseObject>;
-    private __createSubscriptions;
-    protected _getAuthorizationHeader(): Promise<string>;
+    get subscriptions(): Subscriptions;
 }

package/dist/cjs/api/resources/notifications/client/Client.js

@@ -2,149 +2,16 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Notifications = void 0;
-const environments = __importStar(require("../../../../environments.js"));
-const core = __importStar(require("../../../../core/index.js"));
-const KardApi = __importStar(require("../../../index.js"));
-const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors/index.js"));
+const Client_js_1 = require("../resources/subscriptions/client/Client.js");
 class Notifications {
     constructor(_options) {
         this._options = _options;
     }
-    /**
-     * Call this endpoint to subscribe to notification events.<br/>
-     * <b>Required scopes:</b> `notifications:write`
-     *
-     * @param {KardApi.OrganizationId} organizationId
-     * @param {KardApi.SubscriptionRequestBody} request
-     * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link KardApi.UnauthorizedError}
-     * @throws {@link KardApi.InternalServerError}
-     * @throws {@link KardApi.InvalidRequest}
-     * @throws {@link KardApi.ConflictError}
-     *
-     * @example
-     *     await client.notifications.createSubscriptions("organization-123", {
-     *         data: [{
-     *                 type: "subscription",
-     *                 attributes: {
-     *                     eventName: "earnedRewardApproved",
-     *                     webhookUrl: "https://webhookUrl.com/post",
-     *                     enabled: true
-     *                 }
-     *             }]
-     *     })
-     */
-    createSubscriptions(organizationId, request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__createSubscriptions(organizationId, request, requestOptions));
-    }
-    __createSubscriptions(organizationId, request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.KardApiEnvironment.Production, `/v2/issuers/${encodeURIComponent(organizationId)}/subscriptions`),
-                method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@kard-financial/sdk", "X-Fern-SDK-Version": "0.0.1", "User-Agent": "@kard-financial/sdk/0.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
-                contentType: "application/json",
-                requestType: "json",
-                body: request,
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return {
-                    data: _response.body,
-                    rawResponse: _response.rawResponse,
-                };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 401:
-                        throw new KardApi.UnauthorizedError(_response.error.body, _response.rawResponse);
-                    case 500:
-                        throw new KardApi.InternalServerError(_response.error.body, _response.rawResponse);
-                    case 400:
-                        throw new KardApi.InvalidRequest(_response.error.body, _response.rawResponse);
-                    case 409:
-                        throw new KardApi.ConflictError(_response.error.body, _response.rawResponse);
-                    default:
-                        throw new errors.KardApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.KardApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.KardApiTimeoutError("Timeout exceeded when calling POST /v2/issuers/{organizationId}/subscriptions.");
-                case "unknown":
-                    throw new errors.KardApiError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
-    _getAuthorizationHeader() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.token)}`;
-        });
+    get subscriptions() {
+        var _a;
+        return ((_a = this._subscriptions) !== null && _a !== void 0 ? _a : (this._subscriptions = new Client_js_1.Subscriptions(this._options)));
     }
 }
 exports.Notifications = Notifications;

package/dist/cjs/api/resources/notifications/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./types/index.js";
+export * from "./resources/index.js";
 export * from "./client/index.js";

package/dist/cjs/api/resources/notifications/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types/index.js"), exports);
+__exportStar(require("./resources/index.js"), exports);
 __exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/notifications/resources/index.d.ts

@@ -0,0 +1,2 @@
+export * as subscriptions from "./subscriptions/index.js";
+export * from "./subscriptions/types/index.js";

package/dist/cjs/api/resources/notifications/resources/index.js

@@ -0,0 +1,41 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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 });
+exports.subscriptions = void 0;
+exports.subscriptions = __importStar(require("./subscriptions/index.js"));
+__exportStar(require("./subscriptions/types/index.js"), exports);

package/dist/cjs/api/resources/notifications/resources/subscriptions/client/Client.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 Subscriptions {
+    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 Subscriptions {
+    protected readonly _options: Subscriptions.Options;
+    constructor(_options: Subscriptions.Options);
+    /**
+     * Call this endpoint to subscribe to notification events.<br/>
+     * <b>Required scopes:</b> `notifications:write`
+     *
+     * @param {KardApi.OrganizationId} organizationId
+     * @param {KardApi.notifications.SubscriptionRequestBody} request
+     * @param {Subscriptions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link KardApi.UnauthorizedError}
+     * @throws {@link KardApi.InternalServerError}
+     * @throws {@link KardApi.InvalidRequest}
+     * @throws {@link KardApi.ConflictError}
+     *
+     * @example
+     *     await client.notifications.subscriptions.create("organization-123", {
+     *         data: [{
+     *                 type: "subscription",
+     *                 attributes: {
+     *                     eventName: "earnedRewardApproved",
+     *                     webhookUrl: "https://webhookUrl.com/post",
+     *                     enabled: true
+     *                 }
+     *             }]
+     *     })
+     */
+    create(organizationId: KardApi.OrganizationId, request: KardApi.notifications.SubscriptionRequestBody, requestOptions?: Subscriptions.RequestOptions): core.HttpResponsePromise<KardApi.notifications.CreateSubscriptionsResponseObject>;
+    private __create;
+    protected _getAuthorizationHeader(): Promise<string>;
+}