@kash-88/alerts 1.2.1 → 1.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mikhail
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/src/Function/createCustomAlerts.d.ts

@@ -0,0 +1,16 @@
+import { CustomAlerts } from "../Types/index.js";
+/**
+ * Send a custom alert to the authorized user.
+ *
+ * @param {string} access_token - User access token
+ * @param {string} external_id - Up to 32 characters long unique alert ID
+ * @param {string} header - Up to 255 characters long header text
+ * @param {string} message - Up to 300 characters long message text
+ * @param {number} is_shown - 0 or 1, determines whether the alert should be displayed
+ * @param {string | null} [image_url] - URL to the image file displayed with the alert
+ * @param {string | null} [sound_url] - URL to the sound file played when displaying the alert
+ *
+ * @returns {Promise<CustomAlerts>} Created custom alert data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__custom_alerts__send_custom_alerts}
+ */
+export default function createCustomAlerts(access_token: string, external_id: string, header: string, message: string, is_shown: 0 | 1, image_url?: string | null, sound_url?: string | null): Promise<CustomAlerts>;

package/dist/src/Function/createCustomAlerts.js

@@ -0,0 +1,51 @@
+import axios from "axios";
+import { formatAxiosError } from "../utils.js";
+/**
+ * Send a custom alert to the authorized user.
+ *
+ * @param {string} access_token - User access token
+ * @param {string} external_id - Up to 32 characters long unique alert ID
+ * @param {string} header - Up to 255 characters long header text
+ * @param {string} message - Up to 300 characters long message text
+ * @param {number} is_shown - 0 or 1, determines whether the alert should be displayed
+ * @param {string | null} [image_url] - URL to the image file displayed with the alert
+ * @param {string | null} [sound_url] - URL to the sound file played when displaying the alert
+ *
+ * @returns {Promise<CustomAlerts>} Created custom alert data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__custom_alerts__send_custom_alerts}
+ */
+export default async function createCustomAlerts(access_token, external_id, header, message, is_shown, image_url, sound_url) {
+    if (!access_token || typeof access_token !== "string") {
+        throw new Error("access_token must be a non-empty string");
+    }
+    if (!external_id || typeof external_id !== "string") {
+        throw new Error("external_id must be a non-empty string");
+    }
+    if (typeof header !== "string" || typeof message !== "string") {
+        throw new Error("header and message must be strings");
+    }
+    if (is_shown !== 0 && is_shown !== 1) {
+        throw new Error("is_shown must be 0 or 1");
+    }
+    try {
+        const formData = new URLSearchParams();
+        formData.append("external_id", external_id);
+        formData.append("header", header);
+        formData.append("message", message);
+        formData.append("is_shown", String(is_shown));
+        if (image_url)
+            formData.append("image_url", image_url);
+        if (sound_url)
+            formData.append("sound_url", sound_url);
+        const response = await axios.post("https://www.donationalerts.com/api/v1/custom_alert", formData, {
+            headers: {
+                Authorization: `Bearer ${access_token}`,
+                "Content-Type": "application/x-www-form-urlencoded"
+            }
+        });
+        return response.data.data;
+    }
+    catch (error) {
+        throw new Error(formatAxiosError(error));
+    }
+}

package/dist/src/Function/createMerchandise.d.ts

@@ -0,0 +1,22 @@
+import { Merchandise } from "../Types/index.js";
+/**
+ * Create a new merchandise.
+ *
+ * @param {string} access_token - User access token
+ * @param {string} client_secret - API client secret key for signature
+ * @param {string} merchant_identifier - Merchant's ID on DonationAlerts
+ * @param {string} merchandise_identifier - Up to 16 characters long unique merchandise ID
+ * @param {Record<string, string>} title - Object with merchandise titles in different locales (en_US required)
+ * @param {string} currency - Currency code (EUR, USD, RUB, BRL, TRY)
+ * @param {number} price_user - Revenue added to streamer for each sale
+ * @param {number} price_service - Revenue added to DonationAlerts for each sale
+ * @param {number} [is_active=0] - 0 or 1, whether merchandise is available for purchase
+ * @param {number} [is_percentage=0] - 0 or 1, whether prices are percentages or absolute amounts
+ * @param {string} [url] - URL to merchandise's web page
+ * @param {string} [img_url] - URL to merchandise's image
+ * @param {number} [end_at_ts] - Unix timestamp when merchandise becomes inactive
+ *
+ * @returns {Promise<Merchandise>} Created merchandise data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__merchandises__create_merchandise}
+ */
+export default function createMerchandise(access_token: string, client_secret: string, merchant_identifier: string, merchandise_identifier: string, title: Record<string, string>, currency: string, price_user: number, price_service: number, is_active?: number, is_percentage?: number, url?: string, img_url?: string, end_at_ts?: number): Promise<Merchandise>;

package/dist/src/Function/createMerchandise.js

@@ -0,0 +1,82 @@
+import axios from "axios";
+import generateSignature from "./generateSignature.js";
+import { formatAxiosError } from "../utils.js";
+/**
+ * Create a new merchandise.
+ *
+ * @param {string} access_token - User access token
+ * @param {string} client_secret - API client secret key for signature
+ * @param {string} merchant_identifier - Merchant's ID on DonationAlerts
+ * @param {string} merchandise_identifier - Up to 16 characters long unique merchandise ID
+ * @param {Record<string, string>} title - Object with merchandise titles in different locales (en_US required)
+ * @param {string} currency - Currency code (EUR, USD, RUB, BRL, TRY)
+ * @param {number} price_user - Revenue added to streamer for each sale
+ * @param {number} price_service - Revenue added to DonationAlerts for each sale
+ * @param {number} [is_active=0] - 0 or 1, whether merchandise is available for purchase
+ * @param {number} [is_percentage=0] - 0 or 1, whether prices are percentages or absolute amounts
+ * @param {string} [url] - URL to merchandise's web page
+ * @param {string} [img_url] - URL to merchandise's image
+ * @param {number} [end_at_ts] - Unix timestamp when merchandise becomes inactive
+ *
+ * @returns {Promise<Merchandise>} Created merchandise data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__merchandises__create_merchandise}
+ */
+export default async function createMerchandise(access_token, client_secret, merchant_identifier, merchandise_identifier, title, currency, price_user, price_service, is_active = 0, is_percentage = 0, url, img_url, end_at_ts) {
+    if (!access_token || typeof access_token !== "string") {
+        throw new Error("access_token must be a non-empty string");
+    }
+    if (!client_secret || typeof client_secret !== "string") {
+        throw new Error("client_secret must be a non-empty string");
+    }
+    if (!merchant_identifier || typeof merchant_identifier !== "string") {
+        throw new Error("merchant_identifier must be a non-empty string");
+    }
+    if (!merchandise_identifier || typeof merchandise_identifier !== "string") {
+        throw new Error("merchandise_identifier must be a non-empty string");
+    }
+    if (!title || Object.keys(title).length === 0) {
+        throw new Error("title must be a non-empty object");
+    }
+    if (!currency || typeof currency !== "string") {
+        throw new Error("currency must be a non-empty string");
+    }
+    if (typeof price_user !== "number" || typeof price_service !== "number") {
+        throw new Error("price_user and price_service must be numbers");
+    }
+    try {
+        const params = {
+            merchant_identifier,
+            merchandise_identifier,
+            currency,
+            price_user,
+            price_service,
+            is_active,
+            is_percentage
+        };
+        for (const [locale, value] of Object.entries(title)) {
+            params[`title[${locale}]`] = value;
+        }
+        if (url)
+            params.url = url;
+        if (img_url)
+            params.img_url = img_url;
+        if (end_at_ts !== undefined)
+            params.end_at_ts = end_at_ts;
+        const signature = generateSignature(params, client_secret);
+        params.signature = signature;
+        const formData = new URLSearchParams();
+        for (const [key, value] of Object.entries(params)) {
+            formData.append(key, String(value));
+        }
+        const response = await axios.post("https://www.donationalerts.com/api/v1/merchandise", formData, {
+            headers: {
+                Authorization: `Bearer ${access_token}`,
+                "Content-Type": "application/x-www-form-urlencoded"
+            }
+        });
+        return response.data.data;
+    }
+    catch (error) {
+        throw new Error(formatAxiosError(error));
+    }
+}

package/dist/src/Function/generateSignature.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generate a SHA256 request signature for Merchandise API.
+ *
+ * The signature is formed from alphabetically sorted parameter values
+ * (interpreted as strings) with the API client secret appended to the end.
+ *
+ * @param {Record<string, string | number>} params - Request parameters
+ * @param {string} client_secret - API client secret key
+ *
+ * @returns {string} SHA256 hex digest signature
+ * @see {@link https://www.donationalerts.com/apidoc#introduction__http_api_requests__request_signatures}
+ */
+export default function generateSignature(params: Record<string, string | number>, client_secret: string): string;

package/dist/src/Function/generateSignature.js

@@ -0,0 +1,18 @@
+import { createHash } from "crypto";
+/**
+ * Generate a SHA256 request signature for Merchandise API.
+ *
+ * The signature is formed from alphabetically sorted parameter values
+ * (interpreted as strings) with the API client secret appended to the end.
+ *
+ * @param {Record<string, string | number>} params - Request parameters
+ * @param {string} client_secret - API client secret key
+ *
+ * @returns {string} SHA256 hex digest signature
+ * @see {@link https://www.donationalerts.com/apidoc#introduction__http_api_requests__request_signatures}
+ */
+export default function generateSignature(params, client_secret) {
+    const sortedValues = Object.values(params).map(String).sort();
+    const valuesString = sortedValues.join("");
+    return createHash("sha256").update(valuesString + client_secret).digest("hex");
+}

package/dist/src/Function/getAuthorizeLink.d.ts

@@ -0,0 +1,13 @@
+import { OAuthScope } from "../Types/index.js";
+/**
+ * Generate OAuth authorization link for DonationAlerts.
+ *
+ * @param {string} client_id - Your client (application) ID
+ * @param {string} redirect_uri - The URL where users will be sent after authorization
+ * @param {OAuthScope[]} scopes - Array of access scopes
+ * @param {'code' | 'token'} type - Type response oauth token
+ *
+ * @returns {string} The authorization URL.
+ * @see {@link https://www.donationalerts.com/apidoc#authorization__authorization_code__authorization_steps}
+ */
+export default function getAuthorizeLink(client_id: string, redirect_uri: string, scopes: OAuthScope[], type: 'code' | 'token'): string;

package/dist/src/Function/getAuthorizeLink.js

@@ -0,0 +1,27 @@
+/**
+ * Generate OAuth authorization link for DonationAlerts.
+ *
+ * @param {string} client_id - Your client (application) ID
+ * @param {string} redirect_uri - The URL where users will be sent after authorization
+ * @param {OAuthScope[]} scopes - Array of access scopes
+ * @param {'code' | 'token'} type - Type response oauth token
+ *
+ * @returns {string} The authorization URL.
+ * @see {@link https://www.donationalerts.com/apidoc#authorization__authorization_code__authorization_steps}
+ */
+export default function getAuthorizeLink(client_id, redirect_uri, scopes, type) {
+    if (!client_id || typeof client_id !== "string") {
+        throw new Error("client_id must be a non-empty string");
+    }
+    if (!redirect_uri || typeof redirect_uri !== "string") {
+        throw new Error("redirect_uri must be a non-empty string");
+    }
+    if (!Array.isArray(scopes) || scopes.length === 0) {
+        throw new Error("scopes must be a non-empty array");
+    }
+    if (type !== "code" && type !== "token") {
+        throw new Error("type must be 'code' or 'token'");
+    }
+    const uniqueScopes = Array.from(new Set(scopes));
+    return `https://www.donationalerts.com/oauth/authorize?client_id=${encodeURIComponent(client_id)}&redirect_uri=${encodeURIComponent(redirect_uri)}&response_type=${type}&scope=${uniqueScopes.join("%20")}`;
+}

package/dist/src/Function/getDonationsAlerts.d.ts

@@ -0,0 +1,11 @@
+import { DonationsAlerts } from "../Types/index.js";
+/**
+ * Fetch user donation alerts list.
+ *
+ * @param {string} access_token - User access token
+ * @param {number | string} [page=1] - Page number for pagination
+ *
+ * @returns {Promise<DonationsAlerts>} Donation alerts data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__donations__donation_alerts_list}
+ */
+export default function getDonationsAlerts(access_token: string, page?: number | string): Promise<DonationsAlerts>;

package/dist/src/Function/getDonationsAlerts.js

@@ -0,0 +1,30 @@
+import axios from "axios";
+import { formatAxiosError } from "../utils.js";
+/**
+ * Fetch user donation alerts list.
+ *
+ * @param {string} access_token - User access token
+ * @param {number | string} [page=1] - Page number for pagination
+ *
+ * @returns {Promise<DonationsAlerts>} Donation alerts data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__donations__donation_alerts_list}
+ */
+export default async function getDonationsAlerts(access_token, page = 1) {
+    if (!access_token || typeof access_token !== "string") {
+        throw new Error("access_token must be a non-empty string");
+    }
+    try {
+        const response = await axios.get("https://www.donationalerts.com/api/v1/alerts/donations", {
+            params: {
+                page
+            },
+            headers: {
+                Authorization: `Bearer ${access_token}`
+            }
+        });
+        return response.data;
+    }
+    catch (error) {
+        throw new Error(formatAxiosError(error));
+    }
+}

package/dist/src/Function/getExternal.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generate a random 32-character external ID.
+ *
+ * @returns {string} 32 random alphanumeric characters
+ */
+export default function getExternal(): string;

package/dist/src/Function/getExternal.js

@@ -0,0 +1,27 @@
+import { randomBytes } from "crypto";
+/**
+ * Generate a random 32-character external ID.
+ *
+ * @returns {string} 32 random alphanumeric characters
+ */
+export default function getExternal() {
+    const charset = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+    const randomValues = randomBytes(32);
+    // Use rejection sampling to avoid bias
+    const charsetLength = charset.length;
+    const maxValidValue = 256 - (256 % charsetLength);
+    let result = "";
+    let index = 0;
+    while (index < 32) {
+        const randomValue = randomValues[index];
+        if (randomValue < maxValidValue) {
+            result += charset[randomValue % charsetLength];
+            index++;
+        }
+        else {
+            // Rejection: generate a new random value for this position
+            randomValues[index] = randomBytes(1)[0];
+        }
+    }
+    return result;
+}

package/dist/src/Function/getOauthToken.d.ts

@@ -0,0 +1,13 @@
+import { OAuthToken } from "../Types/index.js";
+/**
+ * Exchange Authorization code for OAuth token and Refresh token.
+ *
+ * @param {string} client_id - Your client (application) ID
+ * @param {string} client_secret - Your client (application) secret
+ * @param {string} redirect_uri - The URL where users will be sent after authorization
+ * @param {string} code - User authorization code
+ *
+ * @returns {Promise<OAuthToken>} OAuth user token
+ * @see {@link https://github.com/kash-ts/alerts-SDK?tab=readme-ov-file#getOauthToken}
+ */
+export default function getOauthToken(client_id: string, client_secret: string, redirect_uri: string, code: string): Promise<OAuthToken>;

package/dist/src/Function/getOauthToken.js

@@ -0,0 +1,44 @@
+import axios from "axios";
+import { formatAxiosError } from "../utils.js";
+/**
+ * Exchange Authorization code for OAuth token and Refresh token.
+ *
+ * @param {string} client_id - Your client (application) ID
+ * @param {string} client_secret - Your client (application) secret
+ * @param {string} redirect_uri - The URL where users will be sent after authorization
+ * @param {string} code - User authorization code
+ *
+ * @returns {Promise<OAuthToken>} OAuth user token
+ * @see {@link https://github.com/kash-ts/alerts-SDK?tab=readme-ov-file#getOauthToken}
+ */
+export default async function getOauthToken(client_id, client_secret, redirect_uri, code) {
+    if (!client_id || typeof client_id !== "string") {
+        throw new Error("client_id must be a non-empty string");
+    }
+    if (!client_secret || typeof client_secret !== "string") {
+        throw new Error("client_secret must be a non-empty string");
+    }
+    if (!redirect_uri || typeof redirect_uri !== "string") {
+        throw new Error("redirect_uri must be a non-empty string");
+    }
+    if (!code || typeof code !== "string") {
+        throw new Error("code must be a non-empty string");
+    }
+    try {
+        const formData = new URLSearchParams();
+        formData.append("grant_type", "authorization_code");
+        formData.append("client_id", client_id);
+        formData.append("client_secret", client_secret);
+        formData.append("redirect_uri", redirect_uri);
+        formData.append("code", code);
+        const response = await axios.post("https://www.donationalerts.com/oauth/token", formData, {
+            headers: {
+                "Content-Type": "application/x-www-form-urlencoded"
+            }
+        });
+        return response.data;
+    }
+    catch (error) {
+        throw new Error(formatAxiosError(error));
+    }
+}

package/dist/src/Function/getPrivateToken.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Get a Private token for subscribing to a DonationAlerts channel via Centrifuge.
+ *
+ * @param {string} channel - User channel
+ * @param {string} client - Centrifugo UUIDv4 client ID
+ * @param {string} access_token - User OAuth token
+ *
+ * @returns {Promise<string>} - Token for channel subscription.
+ */
+export default function getPrivateToken(channel: string, client: string, access_token: string): Promise<string>;

package/dist/src/Function/getPrivateToken.js

@@ -0,0 +1,40 @@
+import axios from "axios";
+import { formatAxiosError } from "../utils.js";
+/**
+ * Get a Private token for subscribing to a DonationAlerts channel via Centrifuge.
+ *
+ * @param {string} channel - User channel
+ * @param {string} client - Centrifugo UUIDv4 client ID
+ * @param {string} access_token - User OAuth token
+ *
+ * @returns {Promise<string>} - Token for channel subscription.
+ */
+export default async function getPrivateToken(channel, client, access_token) {
+    if (!channel || typeof channel !== "string") {
+        throw new Error("channel must be a non-empty string");
+    }
+    if (!client || typeof client !== "string") {
+        throw new Error("client must be a non-empty string");
+    }
+    if (!access_token || typeof access_token !== "string") {
+        throw new Error("access_token must be a non-empty string");
+    }
+    try {
+        const response = await axios.post("https://www.donationalerts.com/api/v1/centrifuge/subscribe", {
+            channels: [channel],
+            client: client
+        }, {
+            headers: {
+                Authorization: `Bearer ${access_token}`,
+                "Content-Type": "application/json"
+            }
+        });
+        if (!response.data?.channels?.[0]?.token) {
+            throw new Error("Failed to get private token: no channels in response");
+        }
+        return response.data.channels[0].token;
+    }
+    catch (error) {
+        throw new Error(formatAxiosError(error));
+    }
+}

package/dist/src/Function/getUser.d.ts

@@ -0,0 +1,10 @@
+import { User } from "../Types/index.js";
+/**
+ * Fetch user profile information by OAuth token.
+ *
+ * @param {string} access_token - User access token
+ *
+ * @returns {Promise<User>} User data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__users__user_profile_information}
+ */
+export default function getUser(access_token: string): Promise<User>;

package/dist/src/Function/getUser.js

@@ -0,0 +1,26 @@
+import axios from "axios";
+import { formatAxiosError } from "../utils.js";
+/**
+ * Fetch user profile information by OAuth token.
+ *
+ * @param {string} access_token - User access token
+ *
+ * @returns {Promise<User>} User data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__users__user_profile_information}
+ */
+export default async function getUser(access_token) {
+    if (!access_token || typeof access_token !== "string") {
+        throw new Error("access_token must be a non-empty string");
+    }
+    try {
+        const response = await axios.get("https://www.donationalerts.com/api/v1/user/oauth", {
+            headers: {
+                Authorization: `Bearer ${access_token}`
+            }
+        });
+        return response.data.data;
+    }
+    catch (error) {
+        throw new Error(formatAxiosError(error));
+    }
+}

package/dist/src/Function/getUserChannel.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Get user channel by user id for WebSocket.
+ *
+ * @param {string | number} id - User ID
+ *
+ * @returns {string} The donation alert channel identifier in the format "$alerts:donation_{id}".
+ */
+export default function getUserChannel(id: string | number): string;

package/dist/src/Function/getUserChannel.js

@@ -0,0 +1,13 @@
+/**
+ * Get user channel by user id for WebSocket.
+ *
+ * @param {string | number} id - User ID
+ *
+ * @returns {string} The donation alert channel identifier in the format "$alerts:donation_{id}".
+ */
+export default function getUserChannel(id) {
+    if (id === null || id === undefined || id === "") {
+        throw new Error("id must be a non-empty string or number");
+    }
+    return `$alerts:donation_${id}`;
+}

package/dist/src/Function/getUserDataFromPromocode.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Get user ID from an advertising promocode.
+ *
+ * @param {string} access_token - User access token
+ * @param {string} client_secret - API client secret key for signature
+ * @param {string} promocode - User promocode
+ *
+ * @returns {Promise<number>} DonationAlerts user ID
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__merchandises__update_or_create_merchandise__get_user_data_from_promocode}
+ */
+export default function getUserDataFromPromocode(access_token: string, client_secret: string, promocode: string): Promise<number>;

package/dist/src/Function/getUserDataFromPromocode.js

@@ -0,0 +1,39 @@
+import axios from "axios";
+import generateSignature from "./generateSignature.js";
+import { formatAxiosError } from "../utils.js";
+/**
+ * Get user ID from an advertising promocode.
+ *
+ * @param {string} access_token - User access token
+ * @param {string} client_secret - API client secret key for signature
+ * @param {string} promocode - User promocode
+ *
+ * @returns {Promise<number>} DonationAlerts user ID
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__merchandises__update_or_create_merchandise__get_user_data_from_promocode}
+ */
+export default async function getUserDataFromPromocode(access_token, client_secret, promocode) {
+    if (!access_token || typeof access_token !== "string") {
+        throw new Error("access_token must be a non-empty string");
+    }
+    if (!client_secret || typeof client_secret !== "string") {
+        throw new Error("client_secret must be a non-empty string");
+    }
+    if (!promocode || typeof promocode !== "string") {
+        throw new Error("promocode must be a non-empty string");
+    }
+    try {
+        const params = { promocode };
+        const signature = generateSignature(params, client_secret);
+        params.signature = signature;
+        const response = await axios.get("https://www.donationalerts.com/api/v1/merchandise/user", {
+            params,
+            headers: {
+                Authorization: `Bearer ${access_token}`
+            }
+        });
+        return response.data.data.user_id;
+    }
+    catch (error) {
+        throw new Error(formatAxiosError(error));
+    }
+}

package/dist/src/Function/sendSaleAlert.d.ts

@@ -0,0 +1,20 @@
+import { MerchandiseSale } from "../Types/index.js";
+/**
+ * Send a merchandise sale alert.
+ *
+ * @param {string} access_token - User access token
+ * @param {string} client_secret - API client secret key for signature
+ * @param {number} user_id - DonationAlerts user ID to which the sale is referenced
+ * @param {string} external_id - Up to 32 characters long unique sale ID
+ * @param {string} merchant_identifier - Merchant's ID on DonationAlerts
+ * @param {string} merchandise_identifier - Merchant's merchandise ID that was bought
+ * @param {number} amount - Grand total of the sale
+ * @param {string} currency - Currency code (EUR, USD, RUB, BRL, TRY)
+ * @param {number} [bought_amount=1] - Total number of bought items
+ * @param {string} [username] - Name of the customer
+ * @param {string} [message] - Message sent by the customer
+ *
+ * @returns {Promise<MerchandiseSale>} Created merchandise sale alert data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__merchandise_sale_notifications__send_sale_alerts}
+ */
+export default function sendSaleAlert(access_token: string, client_secret: string, user_id: number, external_id: string, merchant_identifier: string, merchandise_identifier: string, amount: number, currency: string, bought_amount?: number, username?: string, message?: string): Promise<MerchandiseSale>;