glitch-javascript-sdk 1.7.6 → 1.7.8

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

@@ -0,0 +1,188 @@
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+declare class Ads {
+    /**
+     * List Ad Campaigns.
+     *
+     * Example usage:
+     *  Ads.listCampaigns({ community: 'uuid-of-community', platform: 'tiktok' })
+     *
+     * @param params Query parameters (e.g. community, platform, advertiser_id, etc.)
+     * @returns A paginated list of AdCampaign resources
+     */
+    static listCampaigns<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Create a new Ad Campaign.
+     *
+     * @param data  The Ad Campaign payload (JSON) to create
+     * @param params Optional query parameters
+     * @returns The newly created AdCampaign resource
+     */
+    static createCampaign<T>(data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve a single Ad Campaign by ID.
+     *
+     * @param campaign_id The UUID of the campaign to fetch
+     * @param params Optional query parameters
+     * @returns The requested AdCampaign resource
+     */
+    static viewCampaign<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Update an existing Ad Campaign by ID.
+     *
+     * @param campaign_id The UUID of the campaign to update
+     * @param data  The partial or full updated AdCampaign payload
+     * @param params Optional query parameters
+     * @returns The updated AdCampaign resource
+     */
+    static updateCampaign<T>(campaign_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Delete an Ad Campaign by ID.
+     *
+     * @param campaign_id The UUID of the campaign to delete
+     * @param params Optional query parameters
+     * @returns A 204 No Content response on success
+     */
+    static deleteCampaign<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * List Ad Groups (ad sets) for a specific campaign.
+     *
+     * Example usage:
+     *  Ads.listGroups('some-campaign-uuid', { promotion_type: 'WEBSITE' })
+     *
+     * @param campaign_id The UUID of the parent Ad Campaign
+     * @param params Optional query parameters (e.g. promotion_type, operation_status, etc.)
+     * @returns A paginated list of AdGroup resources
+     */
+    static listGroups<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Create a new Ad Group (ad set) under a specific campaign.
+     *
+     * @param campaign_id The UUID of the parent Ad Campaign
+     * @param data The AdGroup creation payload
+     * @param params Optional query parameters
+     * @returns The newly created AdGroup resource
+     */
+    static createGroup<T>(campaign_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve a single Ad Group by ID, under a specific campaign.
+     *
+     * @param campaign_id The UUID of the parent Ad Campaign
+     * @param group_id The UUID of the AdGroup to fetch
+     * @param params Optional query parameters
+     * @returns The requested AdGroup resource
+     */
+    static viewGroup<T>(campaign_id: string, group_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Update an Ad Group (ad set) by ID.
+     *
+     * @param campaign_id The UUID of the parent Ad Campaign
+     * @param group_id The UUID of the AdGroup to update
+     * @param data Updated fields for the AdGroup
+     * @param params Optional query parameters
+     * @returns The updated AdGroup resource
+     */
+    static updateGroup<T>(campaign_id: string, group_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Delete an Ad Group (ad set) by ID, under a specific campaign.
+     *
+     * @param campaign_id The UUID of the parent Ad Campaign
+     * @param group_id The UUID of the AdGroup to delete
+     * @param params Optional query parameters
+     * @returns A 204 No Content response on success
+     */
+    static deleteGroup<T>(campaign_id: string, group_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * List Ads (creatives).
+     *
+     * Supports filtering by ad_group_id, social_media_post_id, operation_status, etc.
+     *
+     * @param params Optional query parameters for filtering/sorting
+     * @returns A paginated list of Ad resources
+     */
+    static listAds<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Create a new Ad (creative).
+     *
+     * @param data The Ad creation payload
+     * @param params Optional query parameters
+     * @returns The newly created Ad resource
+     */
+    static createAd<T>(data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve a single Ad by ID.
+     *
+     * @param ad_id The UUID of the Ad to fetch
+     * @param params Optional query parameters
+     * @returns The requested Ad resource
+     */
+    static viewAd<T>(ad_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Update an existing Ad by ID.
+     *
+     * @param ad_id The UUID of the Ad to update
+     * @param data The partial or full Ad payload
+     * @param params Optional query parameters
+     * @returns The updated Ad resource
+     */
+    static updateAd<T>(ad_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Delete an Ad by ID.
+     *
+     * @param ad_id The UUID of the Ad to delete
+     * @param params Optional query parameters
+     * @returns A 204 No Content response on success
+     */
+    static deleteAd<T>(ad_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * List triggers defined for a given Ad Group.
+     *
+     * @param campaign_id The UUID of the parent Ad Campaign
+     * @param group_id The UUID of the Ad Group
+     * @param params Optional query parameters (pagination, etc.)
+     * @returns A paginated list of AdGroupTrigger resources
+     */
+    static listTriggers<T>(campaign_id: string, group_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Create a new Ad Group Trigger.
+     *
+     * @param campaign_id The UUID of the parent Ad Campaign
+     * @param group_id The UUID of the Ad Group
+     * @param data The trigger creation payload
+     * @param params Optional query parameters
+     * @returns The newly created AdGroupTrigger resource
+     */
+    static createTrigger<T>(campaign_id: string, group_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve a single Ad Group Trigger by ID.
+     *
+     * @param campaign_id The UUID of the parent Ad Campaign
+     * @param group_id The UUID of the Ad Group
+     * @param trigger_id The UUID of the trigger
+     * @param params Optional query parameters
+     * @returns The requested AdGroupTrigger resource
+     */
+    static viewTrigger<T>(campaign_id: string, group_id: string, trigger_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Update an existing Ad Group Trigger by ID.
+     *
+     * @param campaign_id The UUID of the parent Ad Campaign
+     * @param group_id The UUID of the Ad Group
+     * @param trigger_id The UUID of the trigger to update
+     * @param data Updated trigger fields
+     * @param params Optional query parameters
+     * @returns The updated AdGroupTrigger resource
+     */
+    static updateTrigger<T>(campaign_id: string, group_id: string, trigger_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Delete an Ad Group Trigger by ID.
+     *
+     * @param campaign_id The UUID of the parent Ad Campaign
+     * @param group_id The UUID of the Ad Group
+     * @param trigger_id The UUID of the trigger
+     * @param params Optional query parameters
+     * @returns A 204 No Content response on success
+     */
+    static deleteTrigger<T>(campaign_id: string, group_id: string, trigger_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+}
+export default Ads;

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

@@ -223,9 +223,9 @@ declare class Titles {
     static retentionAnalysis<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
     static distinctDimensions<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
- * List sessions for a specific title, with optional filters and pagination.
- * Returns a paginated list of sessions with start/end times, session_length, user info, etc.
- */
+     * List sessions for a specific title, with optional filters and pagination.
+     * Returns a paginated list of sessions with start/end times, session_length, user info, etc.
+     */
     static listSessions<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * Get aggregated average session length data (daily/weekly/monthly) for a title.
@@ -233,5 +233,35 @@ declare class Titles {
      */
     static sessionsAverage<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
     static sessionsHistogram<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Upload a CSV/Excel file containing daily UTM analytics for a specific title.
+     *
+     * @param title_id The UUID of the title
+     * @param file The CSV or Excel file
+     * @param data Optional form fields (if needed)
+     * @param params Optional query parameters
+     * @returns AxiosPromise
+     */
+    static importUtmAnalytics<T>(title_id: string, file: File | Blob, data?: Record<string, any>, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve the UTM analytics data for a title (paginated, filterable, sortable).
+     *
+     * GET /titles/{title_id}/utm
+     *
+     * @param title_id The UUID of the title
+     * @param params Optional query params: start_date, end_date, source, device_type, sort_by, etc.
+     * @returns AxiosPromise
+     */
+    static getUtmAnalytics<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Analyze UTM data with optional group_by (source, campaign, medium, device_type, etc.)
+     *
+     * GET /titles/{title_id}/utm/analysis
+     *
+     * @param title_id The UUID of the title
+     * @param params e.g. ?group_by=source&start_date=YYYY-MM-DD
+     * @returns AxiosPromise
+     */
+    static analyzeUtmAnalytics<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 export default Titles;

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

@@ -1,4 +1,5 @@
 import Auth from "./Auth";
+import Ads from "./Ads";
 import Competitions from "./Competitions";
 import Communities from "./Communities";
 import Users from "./Users";
@@ -30,6 +31,7 @@ import Scheduler from "./Scheduler";
 import Funnel from "./Funnel";
 import SocialStats from "./SocialStats";
 import Hashtags from "./Hashtags";
+export { Ads };
 export { Auth };
 export { Competitions };
 export { Communities };

package/dist/esm/index.d.ts

@@ -2,6 +2,7 @@ import { Config } from "./config";
 import Auth from "./api/Auth";
 import Competitions from "./api/Competitions";
 import { Communities, Social } from "./api";
+import { Ads } from "./api";
 import { Users } from "./api";
 import { Events } from "./api";
 import { Teams } from "./api";
@@ -49,6 +50,7 @@ declare class Glitch {
         Config: typeof Config;
     };
     static api: {
+        Ads: typeof Ads;
         Auth: typeof Auth;
         Campaigns: typeof Campaigns;
         Competitions: typeof Competitions;