tebex_headless/dist/index.d.ts

Tebex Headless API

import { Method } from 'axios';

/**
 * @type {Data}
 * @description The data returned from the Tebex Headless API
 *
 * @type {T} The type of data to be returned
 */
type Data<T> = {
    data: T;
};
/**
 * @type {Message}
 * @description The message returned from the Tebex Headless API
 *
 * @param {boolean} success Whether the request was successful
 * @param {string} message The message returned from the Tebex Headless API
 */
type Message = {
    success: boolean;
    message: string;
};
/**
 * @type {GenericObject}
 * @description A generic object
 */
type GenericObject = string | number | boolean | null | undefined;
/**
 * @type {Route}
 * @description The route of the Tebex Headless API
 *
 * @param {string} accounts The accounts route
 * @param {string} baskets The baskets route
 */
type Route = "accounts" | "baskets";
/**
 * @type {ApplyType}
 * @description The type of the apply request
 *
 * @param {string} coupons The coupons type
 * @param {string} giftcards The giftcards type
 * @param {string} creator-codes The creator codes type
 */
type ApplyType = "coupons" | "giftcards" | "creator-codes";
/**
 * @type {BaseItem}
 * @description The base item object for the package and category objects
 *
 * @param {number} id The ID of the base item
 * @param {string} name The name of the base item
 */
type BaseItem = {
    id: number;
    name: string;
};
/**
 * @type {CouponCodeBody}
 * @description The coupon code object for the body of the request
 *
 * @param {string} coupon_code The coupon code to apply or remove
 */
type CouponCode = {
    coupon_code: string;
};
/**
 * @type {GiftCardCodeBody}
 * @description The gift card code object for the body of the request
 *
 * @param {string} card_number The gift card code to apply or remove
 */
type GiftCardCode = {
    card_number: string;
};
/**
 * @type {CreatorCodeBody}
 * @description The creator code object for the body of the request
 *
 * @param {string} creator_code The creator code to apply or remove
 */
type CreatorCode = {
    creator_code: string;
};
/**
 * @function Request
 * @description A function to make a request to the Tebex Headless API
 *
 * @param {Method | string} method The method of the request
 * @param {Route} route The route of the request
 * @param {string} path The path of the request
 * @param {Record<string, GenericObject>} params The parameters of the request
 *
 * @returns {Promise<T>}
 */
declare function Request<T, Body>(webstoreIdentifier: string, privateKey: string | undefined, method: Method, identifier: string | null, route: Route, path?: string, params?: Record<string, GenericObject>, body?: Body): Promise<T>;
/**
 * @type {Category}
 * @description The category object returned from the Tebex Headless API
 *
 * @param {number} id The ID of the category
 * @param {string} name The name of the category
 * @param {string} description The description of the category
 * @param {Category | null} parent The parent category of the category
 * @param {number} order The order of the category
 * @param {Package[]} packages The packages in the category
 * @param {"grid" | "list" | string} display_type The display type of the category
 * @param {string | null} slug The slug of the category
 */
type Category = BaseItem & {
    description: string;
    parent: Category | null;
    order: number;
    packages: Package[];
    display_type: "grid" | "list";
    slug: string | null;
};
/**
 * @type {ApplyTypeToInterface}
 * @description The type of the apply request
 *
 * @param {string} coupons The coupons type
 * @param {string} giftcards The giftcards type
 * @param {string} creator-codes The creator codes type
 *
 * @returns {CouponCode | GiftCardCode | CreatorCode}
 */
type ApplyTypeToInterface<T extends ApplyType> = T extends "coupons" ? CouponCode : T extends "giftcards" ? GiftCardCode : T extends "creator-codes" ? CreatorCode : never;
/**
 * @type {PackageType}
 * @description The type of the package
 *
 * @param {string} subscription The subscription type
 * @param {string} single The single type
 */
type PackageType = "subscription" | "single" | "both";
/**
 * @type {Package}
 * @description The package object returned from the Tebex Headless API
 *
 * @param {number} id The ID of the package
 * @param {string} name The name of the package
 * @param {string} description The description of the package
 * @param {PackageType} type The type of the package
 * @param {boolean} disable_gifting Whether gifting is disabled for the package
 * @param {boolean} disable_quantity Whether quantity is disabled for the package
 * @param {string | null} expiration_date The expiration date of the package
 * @param {ShortCategory} category The category of the package
 * @param {number} base_price The base price of the package
 * @param {number} sales_tax The sales tax of the package
 * @param {number} total_price The total price of the package
 * @param {number} discount The discount of the package
 * @param {string | null} image The image of the package
 * @param {string} created_at The date the package was created
 * @param {string} updated_at The date the package was updated
 * @param {Array<string>} variables The variables referred to in this package
 * @param {number} order The order this package should be sorted in
 */
type Package = BaseItem & {
    description: string;
    type: PackageType;
    disable_gifting: boolean;
    disable_quantity: boolean;
    expiration_date: string | null;
    currency: string;
    category: BaseItem;
    base_price: number;
    sales_tax: number;
    total_price: number;
    discount: number;
    image: string | null;
    created_at: string;
    updated_at: string;
    variables?: Array<string>;
    order: number;
};
/**
 * @type {InBasket}
 * @description The in_basket object inside a basket package object
 *
 * @param {number} quantity The quantity of the package in the basket
 * @param {number} price The price of the package in the basket
 * @param {string | null} gift_username_id The ID of the user the package is gifted to
 * @param {string | null} gift_username The username of the user the package is gifted to
 */
type InBasket = {
    quantity: number;
    price: number;
    gift_username_id: string | null;
    gift_username: string | null;
};
/**
 * @type {BasketPackage}
 * @description The basket package object returned from the Tebex Headless API
 *
 * @param {number} id The ID of the package
 * @param {string} name The name of the package
 * @param {string} description The description of the package
 * @param {InBasket} in_basket The in_basket object inside the basket package object
 * @param {string | null} image The image of the package
 */
type BasketPackage = BaseItem & {
    description: string;
    in_basket: InBasket;
    image: string | null;
};
/**
 * @type {Code}
 * @description The code object inside the basket coupons object
 *
 * @param {string} code The code of the object
 */
type Code = {
    code: string;
};
/**
 * @type {Links}
 * @description The links object inside the basket object
 *
 * @param {string} checkout The checkout link of the basket
 */
type Links = {
    checkout: string;
    [key: string]: string;
};
/**
 * @type {Basket}
 * @description The basket object returned from the Tebex Headless API
 *
 * @param {string} ident The identifier of the basket
 * @param {boolean} complete Whether the basket is complete
 * @param {number} id The ID of the basket
 * @param {string} country The country of the basket
 * @param {string} ip The IP address of the user
 * @param {string | null} username_id The ID of the user
 * @param {string | null} username The username of the user
 * @param {string} cancel_url The cancel url of the basket
 * @param {string} complete_url The complete url of the basket
 * @param {boolean} complete_auto_redirect Whether the basket should automatically redirect to the complete url
 * @param {number} base_price The base price of the basket
 * @param {number} sales_tax The sales tax of the basket
 * @param {number} total_price The total price of the basket
 * @param {string} email The email of the basket
 * @param {string} currency The currency of the basket
 * @param {BasketPackage[]} packages The packages in the basket
 * @param {Code[]} coupons The coupons in the basket
 * @param {GiftCardCode[]} giftcards The giftcards in the basket
 * @param {string} creator_code The creator code of the basket
 * @param {Links} links The links of the basket
 * @param {Record<string, any>} custom The custom object of the basket
 */
type Basket = {
    ident: string;
    complete: boolean;
    id: number;
    country: string;
    ip: string;
    username_id: string | null;
    username: string | null;
    cancel_url: string;
    complete_url: string;
    complete_auto_redirect: boolean;
    base_price: number;
    sales_tax: number;
    total_price: number;
    email: string;
    currency: string;
    packages: BasketPackage[];
    coupons: Code[];
    giftcards: GiftCardCode[];
    creator_code: string;
    links: Links;
    custom: Record<string, any>;
};
/**
 * @type {Urls}
 * @description The url object for the complete and cancel urls
 *
 * @param {string} complete_url The complete url
 * @param {string} cancel_url The cancel url
 */
type Urls = {
    complete_url: string;
    cancel_url: string;
    custom?: Record<string, any>;
    complete_auto_redirect?: boolean;
};
/**
 * @type {AuthUrl}
 * @description The auth url object returned from the Tebex Headless API
 *
 * @param {string} name The name of the auth url
 * @param {string} url The url of the auth url
 */
type AuthUrl = {
    name: string;
    url: string;
};
/**
 * @type {PackageBody}
 * @description The package object for the body of the request
 *
 * @param {number} package_id The ID of the package
 * @param {number} quantity The quantity of the package
 * @param {PackageType} type The type of the package
 */
type PackageBody = {
    package_id: number;
    quantity: number;
    type: PackageType;
};
/**
 * @type {Webstore}
 * @description The webstore object returned from the Tebex Headless API
 *
 * @param {number} id The ID of the webstore
 * @param {string} description The description of the webstore
 * @param {string} name The name of the webstore
 * @param {string} webstore_url The webstore url of the webstore
 * @param {string} currency The currency of the webstore
 * @param {string} lang The language of the webstore
 * @param {string} logo The logo of the webstore
 * @param {string} platform_type The platform type of the webstore
 * @param {number} platform_type_id The platform type ID of the webstore
 * @param {string} created_at The date the webstore was created
 */
type Webstore = {
    id: number;
    description: string;
    name: string;
    webstore_url: string;
    currency: string;
    lang: string;
    logo: string;
    platform_type: string;
    platform_type_id: number;
    created_at: string;
};
/**
 * @type {Page}
 * @description The page object returned from the Tebex Headless API
 *
 * @param {number} id The ID of the page
 * @param {string} created_at The date the page was created
 * @param {string} updated_at The date the page was updated
 * @param {number} account_id The ID of the account
 * @param {string} title The title of the page
 * @param {string} slug The slug of the page
 * @param {boolean} private Whether the page is private
 * @param {boolean} hidden Whether the page is hidden
 * @param {boolean} disabled Whether the page is disabled
 * @param {boolean} sequence Whether the page is in a sequence
 * @param {string} content The content of the page
*/
type Page = {
    id: number;
    created_at: string;
    updated_at: string;
    account_id: number;
    title: string;
    slug: string;
    private: boolean;
    hidden: boolean;
    disabled: boolean;
    sequence: boolean;
    content: string;
};
declare class TebexHeadless {
    /**
     * @constant webstoreIdentifier
     * @description A function to set the webstore identifier
     *
     * @param {string} identifier The identifier of the webstore
     *
     * @returns {void}
     */
    readonly webstoreIdentifier: string;
    /**
     * @private {privateKey}
     * @description A function to set the private key
     *
     * @param {string} key The private key of the webstore
     *
     * @returns {void}
     */
    private privateKey?;
    constructor(
    /**
     * @constant webstoreIdentifier
     * @description A function to set the webstore identifier
     *
     * @param {string} identifier The identifier of the webstore
     *
     * @returns {void}
     */
    webstoreIdentifier: string, 
    /**
     * @private {privateKey}
     * @description A function to set the private key
     *
     * @param {string} key The private key of the webstore
     *
     * @returns {void}
     */
    privateKey?: string | undefined);
    /**
     * @function getCategories
     * @description A function to get the categories from the Tebex Headless API
     *
     * @param {boolean} includePackages Whether to include the packages in the categories
     * @param {string} basketIdent The identifier of the basket
     * @param {string} ipAddress The IP address of the user
     *
     * @returns {Promise<Category[]>}
     */
    getCategories(includePackages?: boolean, basketIdent?: string, ipAddress?: string): Promise<Category[]>;
    /**
     * @function getCategory
     * @description A function to get a category from the Tebex Headless API
     *
     * @param {number} id The ID of the category
     * @param {boolean} includePackages Whether to include the packages in the category
     * @param {string} basketIdent The identifier of the basket
     * @param {string} ipAddress The IP address of the user
     *
     * @returns {Promise<Category>}
     */
    getCategory(id: number, includePackages?: boolean, basketIdent?: string, ipAddress?: string): Promise<Category>;
    /**
     * @function apply
     * @description A function to apply a coupon, giftcard or creator code to a basket
     *
     * @param {A} body The body of the request
     * @param {string} basketIdent The identifier of the basket
     * @param {ApplyType} type The type of the apply request
     *
     * @returns {Promise<Message>}
     */
    apply<T extends ApplyType, A extends ApplyTypeToInterface<T>>(basketIdent: string, type: T, body: A): Promise<Message>;
    /**
     * @function remove
     * @description A function to remove a coupon, giftcard or creator code from a basket
     *
     * @param {A} body The body of the request
     * @param {string} basketIdent The identifier of the basket
     * @param {ApplyType} type The type of the apply request
     *
     * @returns {Promise<Message>}
     */
    remove<T extends ApplyType, A extends ApplyTypeToInterface<T>>(basketIdent: string, type: T, body: A): Promise<Message>;
    /**
     * @function getPackage
     * @description A function to get a package from the Tebex Headless API
     *
     * @param {number} id The ID of the package
     * @param {string} basketIdent The identifier of the basket
     * @param {string} ipAddress The IP address of the user
     *
     * @returns {Promise<Package>}
     */
    getPackage(id: number, basketIdent?: string, ipAddress?: string): Promise<Package>;
    /**
     * @function getPackages
     * @description A function to get all packages from the Tebex Headless API
     *
     * @param {string} basketIdent The identifier of the basket
     * @param {string} ipAddress The IP address of the user
     *
     * @returns {Promise<Package[]>}
     */
    getPackages(basketIdent?: string, ipAddress?: string): Promise<Package[]>;
    /**
     * @function getBasket
     * @description A function to get a basket from the Tebex Headless API
     *
     * @param {string} basketIdent The identifier of the basket
     *
     * @returns {Promise<Package[]>}
     */
    getBasket(basketIdent: string): Promise<Basket>;
    /**
     * @function createBasket
     * @description A function to create a basket from the Tebex Headless API
     *
     * @param {string} complete_url The complete url
     * @param {string} cancel_url The cancel url
     * @param {Record<string, any>} custom The custom object of the basket
     * @param {boolean} complete_auto_redirect Whether the basket should automatically redirect to the complete url
     * @param {string} ip_address The IP address of the user
     *
     * @returns {Promise<Basket>}
     */
    createBasket(complete_url: string, cancel_url: string, custom?: Record<string, any>, complete_auto_redirect?: boolean, ip_address?: string): Promise<Basket>;
    /**
     * @function createMinecraftBasket
     * @description A function to create a minecraft basket from the Tebex Headless API
     *
     * @param {string} username The username of the user
     * @param {string} complete_url The complete url
     * @param {string} cancel_url The cancel url
     * @param {Record<string, any>} custom The custom object of the basket
     * @param {boolean} complete_auto_redirect Whether the basket should automatically redirect to the complete url
     * @param {string} ip_address The IP address of the user
     *
     * @returns {Promise<Basket>}
     */
    createMinecraftBasket(username: string, complete_url: string, cancel_url: string, custom?: Record<string, any>, complete_auto_redirect?: boolean, ip_address?: string): Promise<Basket>;
    /**
     * @function getBasketAuthUrl
     * @description A function to get the auth url of a basket from the Tebex Headless API
     *
     * @param {string} basketIdent The identifier of the basket
     * @param {string} returnUrl The return url of the basket
     *
     * @returns {Promise<AuthUrl[]>} The data returned or an axios error
     */
    getBasketAuthUrl(basketIdent: string, returnUrl: string): Promise<AuthUrl[]>;
    /**
     * @function addPackageToBasket
     * @description A function to add a package to a basket from the Tebex Headless API
     *
     * @param {string} basketIdent The identifier of the basket
     * @param {number} package_id The ID of the package
     * @param {number} quantity The quantity of the package
     * @param {PackageType} type The type of the package
     * @param {Record<string, any>} variable_data The variable data of the package
     *
     * @returns {Promise<Basket>}
     */
    addPackageToBasket(basketIdent: string, package_id: number, quantity: number, type?: PackageType, variable_data?: Record<string, any>): Promise<Basket>;
    /**
     * @function giftPackage
     * @description A function to gift a package to a user from the Tebex Headless API
     *
     * @param {string} basketIdent The identifier of the basket
     * @param {number} package_id The ID of the package
     * @param {string} target_username_id The ID of the user to gift the package to
     *
     * @returns {Promise<Basket>}
     */
    giftPackage(basketIdent: string, package_id: number, target_username_id: string): Promise<Basket>;
    /**
     * @function removePackage
     * @description A function to remove a package from a basket from the Tebex Headless API
     *
     * @param {string} basketIdent The identifier of the basket
     * @param {number} package_id The ID of the package
     *
     * @returns {Promise<Basket>}
     */
    removePackage(basketIdent: string, package_id: number): Promise<Basket>;
    /**
     * @function updateQuantity
     * @description A function to update the quantity of a package in a basket from the Tebex Headless API
     *
     * @param {string} basketIdent The identifier of the basket
     * @param {number} package_id The ID of the package
     * @param {number} quantity The quantity of the package
     *
     * @returns {Promise<Basket>}
     */
    updateQuantity(basketIdent: string, package_id: number, quantity: number): Promise<Basket>;
    /**
     * @function getWebstore
     * @description A function to get the webstore from the Tebex Headless API
     *
     * @returns {Promise<Webstore>}
     */
    getWebstore(): Promise<Webstore>;
    /**
     * @function getPages
     * @description A function to get the pages from the Tebex Headless API
     *
     * @returns {Promise<Page>}
    */
    getPages(): Promise<Array<Page>>;
    /**
     * @function updateTier
     * @description Update an tier of an package
     *
     * @param {unknown} tierId The ID of the tier
     * @param {number} package_id The ID of the package
     *
     * @returns {Promise<Message>}
     */
    updateTier(tierId: unknown, package_id: number): Promise<Message>;
}

export { type ApplyType, type ApplyTypeToInterface, type AuthUrl, type BaseItem, type Basket, type BasketPackage, type Category, type Code, type CouponCode, type CreatorCode, type Data, type GenericObject, type GiftCardCode, type InBasket, type Links, type Message, type Package, type PackageBody, type PackageType, type Page, Request, type Route, TebexHeadless, type Urls, type Webstore };