glitch-javascript-sdk 2.4.9 → 2.5.1

package/dist/esm/routes/RafflesRoute.d.ts

@@ -0,0 +1,7 @@
+import Route from "./interface";
+declare class RafflesRoute {
+    static routes: {
+        [key: string]: Route;
+    };
+}
+export default RafflesRoute;

package/dist/index.d.ts

@@ -6961,6 +6961,102 @@ declare class TwitchReporting {
     static getStreamersForGame<T>(game_name: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
+declare class Raffles {
+    /**
+     * List all raffles with optional filters.
+     */
+    static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Create a new raffle (Game Owner).
+     */
+    static create<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve details for a specific raffle.
+     */
+    static view<T>(id: string): AxiosPromise<Response<T>>;
+    /**
+     * Enter a raffle (User/Player). Requires Steam ID.
+     */
+    static enter<T>(id: string, data: {
+        referral_code?: string;
+        device_fingerprint?: string;
+        opt_in_playtesting?: boolean;
+    }): AxiosPromise<Response<T>>;
+    /**
+     * Get the authenticated user's entry status for a specific raffle.
+     */
+    static me<T>(id: string): AxiosPromise<Response<T>>;
+    /**
+     * Record a viral action (e.g., Steam Wishlist, Social Share).
+     */
+    static performAction<T>(id: string, data: {
+        action_type: string;
+        platform?: string;
+        reference_id?: string;
+    }): AxiosPromise<Response<T>>;
+    /**
+     * Post raffle content to social media via Glitch API.
+     */
+    static shareSocially<T>(id: string, data: {
+        platform: string;
+        content: string;
+    }): AxiosPromise<Response<T>>;
+    /**
+     * Send an invitation email to a friend.
+     */
+    static inviteFriend<T>(id: string, data: {
+        email: string;
+    }): AxiosPromise<Response<T>>;
+    /**
+     * Add a prize tier to a raffle (Game Owner).
+     */
+    static addPrize<T>(id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Trigger the automated drawing process (Game Owner).
+     */
+    static drawWinners<T>(id: string): AxiosPromise<Response<T>>;
+    /**
+     * Manually select a winner for a specific prize (Live Event Mode).
+     */
+    static pickWinner<T>(id: string, data: {
+        entry_id: string;
+        prize_id: string;
+    }): AxiosPromise<Response<T>>;
+    /**
+     * Get the public list of winners for a completed raffle.
+     */
+    static winners<T>(id: string): AxiosPromise<Response<T>>;
+    /**
+     * List all participants/entries for a raffle (Game Owner).
+     */
+    static participants<T>(id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Update shipping/tracking info for a prize (Game Owner).
+     */
+    static fulfillPrize<T>(entry_id: string, data: {
+        tracking_number: string;
+        shipping_carrier: string;
+    }): AxiosPromise<Response<T>>;
+    /**
+     * Submit shipping address for a won prize (User/Winner).
+     */
+    static updateAddress<T>(entry_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Disqualify a specific entry (Game Owner).
+     */
+    static disqualify<T>(id: string, entry_id: string, data: {
+        reason: string;
+    }): AxiosPromise<Response<T>>;
+    /**
+     * Check if the raffle is fully funded in the community ledger.
+     */
+    static escrowStatus<T>(id: string): AxiosPromise<Response<T>>;
+    /**
+     * Get viral loop analytics (K-Factor, Cost Per Entry).
+     */
+    static analytics<T>(id: string): AxiosPromise<Response<T>>;
+}
+
 interface Route {
     url: string;
     method: string;
@@ -7308,6 +7404,7 @@ declare class Glitch {
         AIUsage: typeof AIUsage;
         MarketingAgencies: typeof MarketingAgencies;
         TwitchReporting: typeof TwitchReporting;
+        Raffles: typeof Raffles;
     };
     static util: {
         Requests: typeof Requests;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "2.4.9",
+  "version": "2.5.1",
   "description": "Javascript SDK for Glitch",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/api/Raffles.ts

@@ -0,0 +1,134 @@
+import RafflesRoute from "../routes/RafflesRoute";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class Raffles {
+    /**
+     * List all raffles with optional filters.
+     */
+    public static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.list, undefined, undefined, params);
+    }
+
+    /**
+     * Create a new raffle (Game Owner).
+     */
+    public static create<T>(data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.create, data);
+    }
+
+    /**
+     * Retrieve details for a specific raffle.
+     */
+    public static view<T>(id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.view, {}, { id });
+    }
+
+    /**
+     * Enter a raffle (User/Player). Requires Steam ID.
+     */
+    public static enter<T>(id: string, data: { referral_code?: string, device_fingerprint?: string, opt_in_playtesting?: boolean }): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.enter, data, { id });
+    }
+
+    /**
+     * Get the authenticated user's entry status for a specific raffle.
+     */
+    public static me<T>(id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.me, {}, { id });
+    }
+
+    /**
+     * Record a viral action (e.g., Steam Wishlist, Social Share).
+     */
+    public static performAction<T>(id: string, data: { action_type: string, platform?: string, reference_id?: string }): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.performAction, data, { id });
+    }
+
+    /**
+     * Post raffle content to social media via Glitch API.
+     */
+    public static shareSocially<T>(id: string, data: { platform: string, content: string }): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.shareSocially, data, { id });
+    }
+
+    /**
+     * Send an invitation email to a friend.
+     */
+    public static inviteFriend<T>(id: string, data: { email: string }): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.inviteFriend, data, { id });
+    }
+
+    /**
+     * Add a prize tier to a raffle (Game Owner).
+     */
+    public static addPrize<T>(id: string, data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.addPrize, data, { id });
+    }
+
+    /**
+     * Trigger the automated drawing process (Game Owner).
+     */
+    public static drawWinners<T>(id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.drawWinners, {}, { id });
+    }
+
+    /**
+     * Manually select a winner for a specific prize (Live Event Mode).
+     */
+    public static pickWinner<T>(id: string, data: { entry_id: string, prize_id: string }): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.pickWinner, data, { id });
+    }
+
+    /**
+     * Get the public list of winners for a completed raffle.
+     */
+    public static winners<T>(id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.winners, {}, { id });
+    }
+
+    /**
+     * List all participants/entries for a raffle (Game Owner).
+     */
+    public static participants<T>(id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.participants, {}, { id }, params);
+    }
+
+    /**
+     * Update shipping/tracking info for a prize (Game Owner).
+     */
+    public static fulfillPrize<T>(entry_id: string, data: { tracking_number: string, shipping_carrier: string }): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.fulfillPrize, data, { entry_id });
+    }
+
+    /**
+     * Submit shipping address for a won prize (User/Winner).
+     */
+    public static updateAddress<T>(entry_id: string, data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.updateAddress, data, { entry_id });
+    }
+
+    /**
+     * Disqualify a specific entry (Game Owner).
+     */
+    public static disqualify<T>(id: string, entry_id: string, data: { reason: string }): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.disqualify, data, { id, entry_id });
+    }
+
+    /**
+     * Check if the raffle is fully funded in the community ledger.
+     */
+    public static escrowStatus<T>(id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.escrowStatus, {}, { id });
+    }
+
+    /**
+     * Get viral loop analytics (K-Factor, Cost Per Entry).
+     */
+    public static analytics<T>(id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.analytics, {}, { id });
+    }
+}
+
+export default Raffles;

package/src/api/index.ts

@@ -38,6 +38,7 @@ import ShortLinks from "./ShortLinks";
 import AIUsage from "./AIUsage";
 import MarketingAgencies from "./MarketingAgencies";
 import TwitchReporting from "./TwitchReporting";
+import Raffles from "./Raffles";
 
 export {Ads};
 export {AccessKeys};
@@ -78,4 +79,5 @@ export {Fingerprinting};
 export {ShortLinks};
 export {AIUsage};
 export {MarketingAgencies};
-export {TwitchReporting};
+export {TwitchReporting};
+export {Raffles};

package/src/index.ts

@@ -42,6 +42,7 @@ import {ShortLinks} from "./api";
 import {AIUsage} from "./api";
 import {MarketingAgencies} from "./api"
 import {TwitchReporting} from './api'
+import {Raffles} from './api'
 
 import Requests from "./util/Requests";
 import Parser from "./util/Parser";
@@ -113,6 +114,7 @@ class Glitch {
         AIUsage : AIUsage,
         MarketingAgencies : MarketingAgencies,
         TwitchReporting: TwitchReporting,
+        Raffles : Raffles,
     }
 
     public static util = {

package/src/routes/RafflesRoute.ts

@@ -0,0 +1,35 @@
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class RafflesRoute {
+    public static routes: { [key: string]: Route } = {
+        list: { url: '/raffles', method: HTTP_METHODS.GET },
+        create: { url: '/raffles', method: HTTP_METHODS.POST },
+        view: { url: '/raffles/{id}', method: HTTP_METHODS.GET },
+        enter: { url: '/raffles/{id}/enter', method: HTTP_METHODS.POST },
+        me: { url: '/raffles/{id}/me', method: HTTP_METHODS.GET },
+        performAction: { url: '/raffles/{id}/actions', method: HTTP_METHODS.POST },
+        shareSocially: { url: '/raffles/{id}/share', method: HTTP_METHODS.POST },
+        inviteFriend: { url: '/raffles/{id}/invite-friend', method: HTTP_METHODS.POST },
+        
+        // Prize Management
+        addPrize: { url: '/raffles/{id}/prizes', method: HTTP_METHODS.POST },
+        
+        // Drawing & Winners
+        drawWinners: { url: '/raffles/{id}/draw', method: HTTP_METHODS.POST },
+        pickWinner: { url: '/raffles/{id}/pick-winner', method: HTTP_METHODS.POST },
+        winners: { url: '/raffles/{id}/winners', method: HTTP_METHODS.GET },
+        
+        // Participant & Fulfillment Management
+        participants: { url: '/raffles/{id}/participants', method: HTTP_METHODS.GET },
+        fulfillPrize: { url: '/raffles/entries/{entry_id}/fulfill', method: HTTP_METHODS.PUT },
+        updateAddress: { url: '/raffles/entries/{entry_id}/address', method: HTTP_METHODS.PUT },
+        disqualify: { url: '/raffles/{id}/disqualify/{entry_id}', method: HTTP_METHODS.POST },
+        
+        // Analytics & Finance
+        escrowStatus: { url: '/raffles/{id}/escrow', method: HTTP_METHODS.GET },
+        analytics: { url: '/raffles/{id}/analytics', method: HTTP_METHODS.GET },
+    };
+}
+
+export default RafflesRoute;