glitch-javascript-sdk 2.4.9 → 2.5.0

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,96 @@ declare class TwitchReporting {
     static getStreamersForGame<T>(game_name: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
+declare class Raffles {
+    /**
+     * List all raffles.
+     * @param params Filter by title_id, community_id, or status.
+     */
+    static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Create a new raffle for a specific title.
+     */
+    static create<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Get full details of a raffle.
+     */
+    static view<T>(raffle_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Update raffle settings (Draft/Active status, dates, etc).
+     */
+    static update<T>(raffle_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Delete a raffle.
+     */
+    static delete<T>(raffle_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Enter the authenticated user into the raffle.
+     * @param data { referral_code?, device_fingerprint? }
+     */
+    static enter<T>(raffle_id: string, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Record a viral action (Steam Wishlist, Social Share) to earn more tickets.
+     * @param data { action_type: 'steam_wishlist'|'social_share', platform?, reference_id? }
+     */
+    static performAction<T>(raffle_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Get the authenticated user's specific entry status for this raffle.
+     */
+    static me<T>(raffle_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Submit shipping address for a winning entry.
+     * @param entry_id The UUID of the RaffleEntry.
+     */
+    static updateAddress<T>(entry_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Invite a friend via email to join the raffle.
+     */
+    static inviteFriend<T>(raffle_id: string, data: {
+        email: string;
+    }): AxiosPromise<Response<T>>;
+    /**
+     * Get the public list of winners (only available if raffle is completed).
+     */
+    static winners<T>(raffle_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Add a prize tier (quantity, value, description) to the raffle.
+     */
+    static addPrize<T>(raffle_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Randomly draw winners for all prize tiers based on ticket weights.
+     */
+    static drawWinners<T>(raffle_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Manually assign a specific user to a specific prize (Live Event Mode).
+     * @param data { entry_id, prize_id }
+     */
+    static pickWinner<T>(raffle_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Provide shipping/tracking info for a prize fulfillment.
+     * @param entry_id The UUID of the RaffleEntry.
+     */
+    static fulfillPrize<T>(entry_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Disqualify an entry for fraud or rule violations.
+     */
+    static disqualify<T>(raffle_id: string, entry_id: string, data: {
+        reason: string;
+    }): AxiosPromise<Response<T>>;
+    /**
+     * List all participants/entries for management.
+     * @param params { opt_in_playtesting?, page?, per_page? }
+     */
+    static listParticipants<T>(raffle_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Check if the raffle is fully funded in the community ledger.
+     */
+    static escrowStatus<T>(raffle_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Get viral loop analytics (K-factor, Cost Per Entry).
+     */
+    static analytics<T>(raffle_id: string): AxiosPromise<Response<T>>;
+}
+
 interface Route {
     url: string;
     method: string;
@@ -7308,6 +7398,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.0",
   "description": "Javascript SDK for Glitch",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/api/Raffles.ts

@@ -0,0 +1,149 @@
+import RafflesRoute from "../routes/RafflesRoute";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class Raffles {
+
+    /**
+     * List all raffles.
+     * @param params Filter by title_id, community_id, or status.
+     */
+    public static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.list, undefined, undefined, params);
+    }
+
+    /**
+     * Create a new raffle for a specific title.
+     */
+    public static create<T>(data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.create, data);
+    }
+
+    /**
+     * Get full details of a raffle.
+     */
+    public static view<T>(raffle_id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.view, {}, { raffle_id });
+    }
+
+    /**
+     * Update raffle settings (Draft/Active status, dates, etc).
+     */
+    public static update<T>(raffle_id: string, data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.update, data, { raffle_id });
+    }
+
+    /**
+     * Delete a raffle.
+     */
+    public static delete<T>(raffle_id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.delete, {}, { raffle_id });
+    }
+
+    /**
+     * Enter the authenticated user into the raffle.
+     * @param data { referral_code?, device_fingerprint? }
+     */
+    public static enter<T>(raffle_id: string, data?: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.enter, data, { raffle_id });
+    }
+
+    /**
+     * Record a viral action (Steam Wishlist, Social Share) to earn more tickets.
+     * @param data { action_type: 'steam_wishlist'|'social_share', platform?, reference_id? }
+     */
+    public static performAction<T>(raffle_id: string, data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.performAction, data, { raffle_id });
+    }
+
+    /**
+     * Get the authenticated user's specific entry status for this raffle.
+     */
+    public static me<T>(raffle_id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.me, {}, { raffle_id });
+    }
+
+    /**
+     * Submit shipping address for a winning entry.
+     * @param entry_id The UUID of the RaffleEntry.
+     */
+    public static updateAddress<T>(entry_id: string, data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.updateAddress, data, { entry_id });
+    }
+
+    /**
+     * Invite a friend via email to join the raffle.
+     */
+    public static inviteFriend<T>(raffle_id: string, data: { email: string }): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.inviteFriend, data, { raffle_id });
+    }
+
+    /**
+     * Get the public list of winners (only available if raffle is completed).
+     */
+    public static winners<T>(raffle_id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.winners, {}, { raffle_id });
+    }
+
+    /**
+     * Add a prize tier (quantity, value, description) to the raffle.
+     */
+    public static addPrize<T>(raffle_id: string, data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.addPrize, data, { raffle_id });
+    }
+
+    /**
+     * Randomly draw winners for all prize tiers based on ticket weights.
+     */
+    public static drawWinners<T>(raffle_id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.drawWinners, {}, { raffle_id });
+    }
+
+    /**
+     * Manually assign a specific user to a specific prize (Live Event Mode).
+     * @param data { entry_id, prize_id }
+     */
+    public static pickWinner<T>(raffle_id: string, data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.pickWinner, data, { raffle_id });
+    }
+
+    /**
+     * Provide shipping/tracking info for a prize fulfillment.
+     * @param entry_id The UUID of the RaffleEntry.
+     */
+    public static fulfillPrize<T>(entry_id: string, data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.fulfillPrize, data, { entry_id });
+    }
+
+    /**
+     * Disqualify an entry for fraud or rule violations.
+     */
+    public static disqualify<T>(raffle_id: string, entry_id: string, data: { reason: string }): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.disqualify, data, { raffle_id, entry_id });
+    }
+
+    /**
+     * List all participants/entries for management.
+     * @param params { opt_in_playtesting?, page?, per_page? }
+     */
+    public static listParticipants<T>(raffle_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.participants, {}, { raffle_id }, params);
+    }
+
+    /**
+     * Check if the raffle is fully funded in the community ledger.
+     */
+    public static escrowStatus<T>(raffle_id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.escrowStatus, {}, { raffle_id });
+    }
+
+    /**
+     * Get viral loop analytics (K-factor, Cost Per Entry).
+     */
+    public static analytics<T>(raffle_id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(RafflesRoute.routes.analytics, {}, { raffle_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 } = {
+    // CRUD
+    list: { url: '/raffles', method: HTTP_METHODS.GET },
+    create: { url: '/raffles', method: HTTP_METHODS.POST },
+    view: { url: '/raffles/{raffle_id}', method: HTTP_METHODS.GET },
+    update: { url: '/raffles/{raffle_id}', method: HTTP_METHODS.PUT },
+    delete: { url: '/raffles/{raffle_id}', method: HTTP_METHODS.DELETE },
+
+    // User/Player Actions
+    enter: { url: '/raffles/{raffle_id}/enter', method: HTTP_METHODS.POST },
+    performAction: { url: '/raffles/{raffle_id}/actions', method: HTTP_METHODS.POST },
+    me: { url: '/raffles/{raffle_id}/me', method: HTTP_METHODS.GET },
+    updateAddress: { url: '/raffles/entries/{entry_id}/address', method: HTTP_METHODS.PUT },
+    inviteFriend: { url: '/raffles/{raffle_id}/invite-friend', method: HTTP_METHODS.POST },
+    winners: { url: '/raffles/{raffle_id}/winners', method: HTTP_METHODS.GET },
+
+    // Admin/Developer Actions
+    addPrize: { url: '/raffles/{raffle_id}/prizes', method: HTTP_METHODS.POST },
+    drawWinners: { url: '/raffles/{raffle_id}/draw', method: HTTP_METHODS.POST },
+    pickWinner: { url: '/raffles/{raffle_id}/pick-winner', method: HTTP_METHODS.POST },
+    fulfillPrize: { url: '/raffles/entries/{entry_id}/fulfill', method: HTTP_METHODS.PUT },
+    disqualify: { url: '/raffles/{raffle_id}/disqualify/{entry_id}', method: HTTP_METHODS.POST },
+    participants: { url: '/raffles/{raffle_id}/participants', method: HTTP_METHODS.GET },
+    escrowStatus: { url: '/raffles/{raffle_id}/escrow', method: HTTP_METHODS.GET },
+    analytics: { url: '/raffles/{raffle_id}/analytics', method: HTTP_METHODS.GET },
+  };
+
+}
+
+export default RafflesRoute;