glitch-javascript-sdk 2.0.3 → 2.0.5

package/dist/esm/api/AccessKeys.d.ts

@@ -0,0 +1,39 @@
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+declare class AccessKeys {
+    /**
+     * List all access keys for a given title.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Access%20Keys/get_titles__title_id__keys
+     *
+     * @param title_id The UUID of the title.
+     * @param params Optional query parameters for pagination.
+     * @returns promise
+     */
+    static list<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Bulk create access keys from a string of codes.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Access%20Keys/post_titles__title_id__keys
+     *
+     * @param title_id The UUID of the title.
+     * @param data The platform and codes to upload.
+     * @param data.platform The platform for the keys (e.g., 'steam').
+     * @param data.codes A string of codes separated by newlines, commas, or spaces.
+     * @returns Promise
+     */
+    static store<T>(title_id: string, data: {
+        platform: string;
+        codes: string;
+    }, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Deletes an unassigned access key.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Access%20Keys/delete_keys__key_id_
+     *
+     * @param key_id The UUID of the access key to delete.
+     * @returns promise
+     */
+    static delete<T>(key_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+}
+export default AccessKeys;

package/dist/esm/api/Campaigns.d.ts

@@ -595,5 +595,20 @@ declare class Campaigns {
      * @returns promise
      */
     static updateSourcedCreator<T>(campaign_id: string, sourced_creator_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Assigns an available access key to an influencer for a specific campaign.
+     * This will find the next available key for the given platform and assign it.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Campaigns/assignKey
+     *
+     * @param campaign_id The ID of the campaign.
+     * @param user_id The ID of the user (influencer).
+     * @param data The platform for which to assign a key.
+     * @param data.platform The platform of the key to assign (e.g., 'steam').
+     * @returns promise
+     */
+    static assignKeyToInfluencer<T>(campaign_id: string, user_id: string, data: {
+        platform: string;
+    }, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 export default Campaigns;

package/dist/esm/api/ShortLinks.d.ts

@@ -17,5 +17,25 @@ declare class ShortLinks {
      * Update a short link
      */
     static update<T>(id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+    * Get click-summary report
+    *  - Example usage: ShortLinks.clickSummary({ short_link_id: 'uuid-here' })
+    */
+    static clickSummary<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get geo & device breakdown report
+     *  - Example usage: ShortLinks.geoDeviceBreakdown({ short_link_id: 'uuid-here' })
+     */
+    static geoDeviceBreakdown<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get time-series report
+     *  - Example usage: ShortLinks.timeSeries({ short_link_id: 'uuid-here', group_by: 'day' })
+     */
+    static timeSeries<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get referrer & UTM report
+     *  - Example usage: ShortLinks.referrerReport({ short_link_id: 'uuid-here' })
+     */
+    static referrerReport<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 export default ShortLinks;

package/dist/esm/api/Titles.d.ts

@@ -289,5 +289,63 @@ declare class Titles {
      * Update a specific chat message.
      */
     static chatUpdateMessage<T>(title_id: string, message_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+  * List all purchase events for a specific title.
+  * Matches GET /titles/{title_id}/purchases
+  */
+    static listPurchases<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve a single purchase record by ID.
+     * Matches GET /titles/{title_id}/purchases/{purchase_id}
+     */
+    static viewPurchase<T>(title_id: string, purchase_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Create a new purchase record.
+     * Matches POST /titles/{title_id}/purchases
+     */
+    static createPurchase<T>(title_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a summary of total revenue, grouped by day or purchase_type.
+     * Matches GET /titles/{title_id}/purchases/summary
+     */
+    static purchaseSummary<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Revenue by time (daily, weekly, or monthly).
+     * Matches GET /titles/{title_id}/purchases/reports/time
+     */
+    static purchaseRevenueByTime<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 30-day LTV (Lifetime Value) per install.
+     * Matches GET /titles/{title_id}/purchases/reports/ltv30
+     */
+    static purchaseLtv30<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Show breakdown of revenue per currency, with optional USD conversion.
+     * Matches GET /titles/{title_id}/purchases/reports/currency
+     */
+    static purchaseCurrencyBreakdown<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Distribution of installs by total revenue, plus a histogram array.
+     * Matches GET /titles/{title_id}/purchases/reports/install-distribution
+     */
+    static installRevenueDistribution<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Stats by item SKU, purchase type, and repeat purchase analysis.
+     * Matches GET /titles/{title_id}/purchases/reports/item-type-stats
+     */
+    static itemAndPurchaseTypeStats<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+       * Bulk import access keys for a title from a CSV or Excel file.
+       * The file must contain 'platform' and 'code' columns.
+       *
+       * @see https://api.glitch.fun/api/documentation#/Titles/importTitleKeys
+       *
+       * @param title_id The UUID of the title.
+       * @param file The CSV or Excel file to upload.
+       * @param data Optional additional form data.
+       * @param params Optional query parameters.
+       * @returns AxiosPromise
+       */
+    static importKeys<T>(title_id: string, file: File | Blob, data?: Record<string, any>, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 export default Titles;

package/dist/esm/api/index.d.ts

@@ -1,5 +1,6 @@
 import Auth from "./Auth";
 import Ads from "./Ads";
+import AccessKeys from "./AccessKeys";
 import Competitions from "./Competitions";
 import Communities from "./Communities";
 import Users from "./Users";
@@ -37,6 +38,7 @@ import ShortLinks from "./ShortLinks";
 import AIUsage from "./AIUsage";
 import MarketingAgencies from "./MarketingAgencies";
 export { Ads };
+export { AccessKeys };
 export { Auth };
 export { Competitions };
 export { Communities };

package/dist/esm/index.d.ts

@@ -1,5 +1,6 @@
 import { Config } from "./config";
 import Auth from "./api/Auth";
+import AccessKeys from "./api/AccessKeys";
 import Competitions from "./api/Competitions";
 import { Communities, Social } from "./api";
 import { Ads } from "./api";
@@ -56,6 +57,7 @@ declare class Glitch {
     };
     static api: {
         Ads: typeof Ads;
+        AccessKeys: typeof AccessKeys;
         Auth: typeof Auth;
         Campaigns: typeof Campaigns;
         Competitions: typeof Competitions;

package/dist/esm/index.js

@@ -5895,6 +5895,60 @@ var Auth = /** @class */ (function () {
     return Auth;
 }());
 
+var AccessKeysRoute = /** @class */ (function () {
+    function AccessKeysRoute() {
+    }
+    AccessKeysRoute.routes = {
+        list: { url: '/titles/{title_id}/keys', method: HTTP_METHODS.GET },
+        store: { url: '/titles/{title_id}/keys', method: HTTP_METHODS.POST },
+        delete: { url: '/keys/{key_id}', method: HTTP_METHODS.DELETE },
+    };
+    return AccessKeysRoute;
+}());
+
+var AccessKeys = /** @class */ (function () {
+    function AccessKeys() {
+    }
+    /**
+     * List all access keys for a given title.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Access%20Keys/get_titles__title_id__keys
+     *
+     * @param title_id The UUID of the title.
+     * @param params Optional query parameters for pagination.
+     * @returns promise
+     */
+    AccessKeys.list = function (title_id, params) {
+        return Requests.processRoute(AccessKeysRoute.routes.list, undefined, { title_id: title_id }, params);
+    };
+    /**
+     * Bulk create access keys from a string of codes.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Access%20Keys/post_titles__title_id__keys
+     *
+     * @param title_id The UUID of the title.
+     * @param data The platform and codes to upload.
+     * @param data.platform The platform for the keys (e.g., 'steam').
+     * @param data.codes A string of codes separated by newlines, commas, or spaces.
+     * @returns Promise
+     */
+    AccessKeys.store = function (title_id, data, params) {
+        return Requests.processRoute(AccessKeysRoute.routes.store, data, { title_id: title_id }, params);
+    };
+    /**
+     * Deletes an unassigned access key.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Access%20Keys/delete_keys__key_id_
+     *
+     * @param key_id The UUID of the access key to delete.
+     * @returns promise
+     */
+    AccessKeys.delete = function (key_id, params) {
+        return Requests.processRoute(AccessKeysRoute.routes.delete, {}, { key_id: key_id }, params);
+    };
+    return AccessKeys;
+}());
+
 var CompetitionRoutes = /** @class */ (function () {
     function CompetitionRoutes() {
     }
@@ -11091,6 +11145,47 @@ var TitlesRoute = /** @class */ (function () {
             url: '/titles/{title_id}/chat/messages/{message_id}',
             method: HTTP_METHODS.PUT
         },
+        importKeys: { url: '/titles/{title_id}/import-keys', method: HTTP_METHODS.POST },
+        // ─────────────────────────────────────────────────────────────────  
+        // Purchase/Revenue Endpoints  
+        // ─────────────────────────────────────────────────────────────────  
+        purchasesList: {
+            url: "/titles/{title_id}/purchases",
+            method: HTTP_METHODS.GET,
+        },
+        purchasesShow: {
+            url: "/titles/{title_id}/purchases/{purchase_id}",
+            method: HTTP_METHODS.GET,
+        },
+        purchasesCreate: {
+            url: "/titles/{title_id}/purchases",
+            method: HTTP_METHODS.POST,
+        },
+        purchasesSummary: {
+            url: "/titles/{title_id}/purchases/summary",
+            method: HTTP_METHODS.GET,
+        },
+        // Advanced analytics sub-routes  
+        purchasesTimeReport: {
+            url: "/titles/{title_id}/purchases/reports/time",
+            method: HTTP_METHODS.GET,
+        },
+        purchasesLtv30Report: {
+            url: "/titles/{title_id}/purchases/reports/ltv30",
+            method: HTTP_METHODS.GET,
+        },
+        purchasesCurrencyBreakdown: {
+            url: "/titles/{title_id}/purchases/reports/currency",
+            method: HTTP_METHODS.GET,
+        },
+        purchasesInstallDistribution: {
+            url: "/titles/{title_id}/purchases/reports/install-distribution",
+            method: HTTP_METHODS.GET,
+        },
+        purchasesItemTypeStats: {
+            url: "/titles/{title_id}/purchases/reports/item-type-stats",
+            method: HTTP_METHODS.GET,
+        },
     };
     return TitlesRoute;
 }());
@@ -11470,6 +11565,85 @@ var Titles = /** @class */ (function () {
     Titles.chatUpdateMessage = function (title_id, message_id, data) {
         return Requests.processRoute(TitlesRoute.routes.chatUpdateMessage, data, { title_id: title_id, message_id: message_id });
     };
+    /**
+  * List all purchase events for a specific title.
+  * Matches GET /titles/{title_id}/purchases
+  */
+    Titles.listPurchases = function (title_id, params) {
+        return Requests.processRoute(TitlesRoute.routes.purchasesList, {}, { title_id: title_id }, params);
+    };
+    /**
+     * Retrieve a single purchase record by ID.
+     * Matches GET /titles/{title_id}/purchases/{purchase_id}
+     */
+    Titles.viewPurchase = function (title_id, purchase_id, params) {
+        return Requests.processRoute(TitlesRoute.routes.purchasesShow, {}, { title_id: title_id, purchase_id: purchase_id }, params);
+    };
+    /**
+     * Create a new purchase record.
+     * Matches POST /titles/{title_id}/purchases
+     */
+    Titles.createPurchase = function (title_id, data, params) {
+        return Requests.processRoute(TitlesRoute.routes.purchasesCreate, data, { title_id: title_id }, params);
+    };
+    /**
+     * Get a summary of total revenue, grouped by day or purchase_type.
+     * Matches GET /titles/{title_id}/purchases/summary
+     */
+    Titles.purchaseSummary = function (title_id, params) {
+        return Requests.processRoute(TitlesRoute.routes.purchasesSummary, {}, { title_id: title_id }, params);
+    };
+    /**
+     * Revenue by time (daily, weekly, or monthly).
+     * Matches GET /titles/{title_id}/purchases/reports/time
+     */
+    Titles.purchaseRevenueByTime = function (title_id, params) {
+        return Requests.processRoute(TitlesRoute.routes.purchasesTimeReport, {}, { title_id: title_id }, params);
+    };
+    /**
+     * 30-day LTV (Lifetime Value) per install.
+     * Matches GET /titles/{title_id}/purchases/reports/ltv30
+     */
+    Titles.purchaseLtv30 = function (title_id, params) {
+        return Requests.processRoute(TitlesRoute.routes.purchasesLtv30Report, {}, { title_id: title_id }, params);
+    };
+    /**
+     * Show breakdown of revenue per currency, with optional USD conversion.
+     * Matches GET /titles/{title_id}/purchases/reports/currency
+     */
+    Titles.purchaseCurrencyBreakdown = function (title_id, params) {
+        return Requests.processRoute(TitlesRoute.routes.purchasesCurrencyBreakdown, {}, { title_id: title_id }, params);
+    };
+    /**
+     * Distribution of installs by total revenue, plus a histogram array.
+     * Matches GET /titles/{title_id}/purchases/reports/install-distribution
+     */
+    Titles.installRevenueDistribution = function (title_id, params) {
+        return Requests.processRoute(TitlesRoute.routes.purchasesInstallDistribution, {}, { title_id: title_id }, params);
+    };
+    /**
+     * Stats by item SKU, purchase type, and repeat purchase analysis.
+     * Matches GET /titles/{title_id}/purchases/reports/item-type-stats
+     */
+    Titles.itemAndPurchaseTypeStats = function (title_id, params) {
+        return Requests.processRoute(TitlesRoute.routes.purchasesItemTypeStats, {}, { title_id: title_id }, params);
+    };
+    /**
+       * Bulk import access keys for a title from a CSV or Excel file.
+       * The file must contain 'platform' and 'code' columns.
+       *
+       * @see https://api.glitch.fun/api/documentation#/Titles/importTitleKeys
+       *
+       * @param title_id The UUID of the title.
+       * @param file The CSV or Excel file to upload.
+       * @param data Optional additional form data.
+       * @param params Optional query parameters.
+       * @returns AxiosPromise
+       */
+    Titles.importKeys = function (title_id, file, data, params) {
+        var url = TitlesRoute.routes.importKeys.url.replace("{title_id}", title_id);
+        return Requests.uploadFile(url, "file", file, data, params);
+    };
     return Titles;
 }());
 
@@ -11542,6 +11716,7 @@ var CampaignsRoute = /** @class */ (function () {
         getSourcedCreators: { url: '/campaigns/{campaign_id}/sourcing/creators', method: HTTP_METHODS.GET },
         getSourcedCreator: { url: '/campaigns/{campaign_id}/sourcing/creators/{sourced_creator_id}', method: HTTP_METHODS.GET },
         updateSourcedCreator: { url: '/campaigns/{campaign_id}/sourcing/creators/{sourced_creator_id}', method: HTTP_METHODS.PUT },
+        assignKeyToInfluencer: { url: '/campaigns/{campaign_id}/influencers/{user_id}/assign-key', method: HTTP_METHODS.POST },
     };
     return CampaignsRoute;
 }());
@@ -12273,6 +12448,21 @@ var Campaigns = /** @class */ (function () {
     Campaigns.updateSourcedCreator = function (campaign_id, sourced_creator_id, data) {
         return Requests.processRoute(CampaignsRoute.routes.updateSourcedCreator, data, { campaign_id: campaign_id, sourced_creator_id: sourced_creator_id });
     };
+    /**
+     * Assigns an available access key to an influencer for a specific campaign.
+     * This will find the next available key for the given platform and assign it.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Campaigns/assignKey
+     *
+     * @param campaign_id The ID of the campaign.
+     * @param user_id The ID of the user (influencer).
+     * @param data The platform for which to assign a key.
+     * @param data.platform The platform of the key to assign (e.g., 'steam').
+     * @returns promise
+     */
+    Campaigns.assignKeyToInfluencer = function (campaign_id, user_id, data, params) {
+        return Requests.processRoute(CampaignsRoute.routes.assignKeyToInfluencer, data, { campaign_id: campaign_id, user_id: user_id }, params);
+    };
     return Campaigns;
 }());
 
@@ -14462,6 +14652,10 @@ var ShortLinksRoute = /** @class */ (function () {
         updateShortLink: { url: '/shortlinks/{id}', method: HTTP_METHODS.PUT },
         // Delete can be added if supported
         // deleteShortLink:   { url: '/shortlinks/{id}', method: HTTP_METHODS.DELETE }
+        clickSummary: { url: '/shortlinks/reports/click-summary', method: HTTP_METHODS.GET },
+        geoDeviceBreakdown: { url: '/shortlinks/reports/geo-device', method: HTTP_METHODS.GET },
+        timeSeries: { url: '/shortlinks/reports/time-series', method: HTTP_METHODS.GET },
+        referrerReport: { url: '/shortlinks/reports/referrer', method: HTTP_METHODS.GET },
     };
     return ShortLinksRoute;
 }());
@@ -14493,6 +14687,38 @@ var ShortLinks = /** @class */ (function () {
     ShortLinks.update = function (id, data, params) {
         return Requests.processRoute(ShortLinksRoute.routes.updateShortLink, data, { id: id }, params);
     };
+    // Uncomment when delete is supported
+    // public static delete<T>(id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    //   return Requests.processRoute(ShortLinksRoute.routes.deleteShortLink, {}, { id }, params);
+    // }
+    /**
+    * Get click-summary report
+    *  - Example usage: ShortLinks.clickSummary({ short_link_id: 'uuid-here' })
+    */
+    ShortLinks.clickSummary = function (params) {
+        return Requests.processRoute(ShortLinksRoute.routes.clickSummary, undefined, undefined, params);
+    };
+    /**
+     * Get geo & device breakdown report
+     *  - Example usage: ShortLinks.geoDeviceBreakdown({ short_link_id: 'uuid-here' })
+     */
+    ShortLinks.geoDeviceBreakdown = function (params) {
+        return Requests.processRoute(ShortLinksRoute.routes.geoDeviceBreakdown, undefined, undefined, params);
+    };
+    /**
+     * Get time-series report
+     *  - Example usage: ShortLinks.timeSeries({ short_link_id: 'uuid-here', group_by: 'day' })
+     */
+    ShortLinks.timeSeries = function (params) {
+        return Requests.processRoute(ShortLinksRoute.routes.timeSeries, undefined, undefined, params);
+    };
+    /**
+     * Get referrer & UTM report
+     *  - Example usage: ShortLinks.referrerReport({ short_link_id: 'uuid-here' })
+     */
+    ShortLinks.referrerReport = function (params) {
+        return Requests.processRoute(ShortLinksRoute.routes.referrerReport, undefined, undefined, params);
+    };
     return ShortLinks;
 }());
 
@@ -15243,6 +15469,7 @@ var Glitch = /** @class */ (function () {
     };
     Glitch.api = {
         Ads: Ads,
+        AccessKeys: AccessKeys,
         Auth: Auth,
         Campaigns: Campaigns,
         Competitions: Competitions,