glitch-javascript-sdk 1.7.6 → 1.7.8

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

@@ -0,0 +1,14 @@
+import Route from "./interface";
+/**
+ * AdsRoute holds all the endpoint definitions for:
+ * - Ad Campaigns
+ * - Ad Groups (Ad Sets)
+ * - Ads (Creatives)
+ * - Ad Group Triggers
+ */
+declare class AdsRoute {
+    static routes: {
+        [key: string]: Route;
+    };
+}
+export default AdsRoute;

package/dist/index.d.ts

@@ -642,6 +642,192 @@ declare class Competitions {
     static me<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
+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>>;
+}
+
 declare class Communities {
     /**
      * List all the communities.
@@ -3010,9 +3196,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.
@@ -3020,6 +3206,36 @@ 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>>;
 }
 
 declare class Campaigns {
@@ -4937,6 +5153,7 @@ declare class Glitch {
         Config: typeof Config;
     };
     static api: {
+        Ads: typeof Ads;
         Auth: typeof Auth;
         Campaigns: typeof Campaigns;
         Competitions: typeof Competitions;

package/package.json

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

package/src/api/Ads.ts

@@ -0,0 +1,409 @@
+import AdsRoute from "../routes/AdsRoute";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class Ads {
+  // ----------------------------------------------------------------------
+  // AD CAMPAIGNS
+  // ----------------------------------------------------------------------
+
+  /**
+   * 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
+   */
+  public static listCampaigns<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(AdsRoute.routes.getCampaigns, undefined, undefined, params);
+  }
+
+  /**
+   * 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
+   */
+  public static createCampaign<T>(data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(AdsRoute.routes.createCampaign, data, {}, params);
+  }
+
+  /**
+   * 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
+   */
+  public static viewCampaign<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.retrieveCampaign,
+      {},
+      { campaign_id: campaign_id },
+      params
+    );
+  }
+
+  /**
+   * 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
+   */
+  public static updateCampaign<T>(
+    campaign_id: string,
+    data?: object,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.updateCampaign,
+      data,
+      { campaign_id: campaign_id },
+      params
+    );
+  }
+
+  /**
+   * 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
+   */
+  public static deleteCampaign<T>(
+    campaign_id: string,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.deleteCampaign,
+      {},
+      { campaign_id: campaign_id },
+      params
+    );
+  }
+
+  // ----------------------------------------------------------------------
+  // AD GROUPS (AD SETS)
+  // ----------------------------------------------------------------------
+
+  /**
+   * 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
+   */
+  public static listGroups<T>(
+    campaign_id: string,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.getGroups,
+      {},
+      { campaign_id },
+      params
+    );
+  }
+
+  /**
+   * 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
+   */
+  public static createGroup<T>(
+    campaign_id: string,
+    data?: object,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.createGroup,
+      data,
+      { campaign_id },
+      params
+    );
+  }
+
+  /**
+   * 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
+   */
+  public static viewGroup<T>(
+    campaign_id: string,
+    group_id: string,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.retrieveGroup,
+      {},
+      { campaign_id, group_id },
+      params
+    );
+  }
+
+  /**
+   * 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
+   */
+  public static updateGroup<T>(
+    campaign_id: string,
+    group_id: string,
+    data?: object,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.updateGroup,
+      data,
+      { campaign_id, group_id },
+      params
+    );
+  }
+
+  /**
+   * 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
+   */
+  public static deleteGroup<T>(
+    campaign_id: string,
+    group_id: string,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.deleteGroup,
+      {},
+      { campaign_id, group_id },
+      params
+    );
+  }
+
+  // ----------------------------------------------------------------------
+  // ADS (CREATIVES)
+  // ----------------------------------------------------------------------
+
+  /**
+   * 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
+   */
+  public static listAds<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(AdsRoute.routes.getAds, undefined, undefined, params);
+  }
+
+  /**
+   * Create a new Ad (creative).
+   *
+   * @param data The Ad creation payload
+   * @param params Optional query parameters
+   * @returns The newly created Ad resource
+   */
+  public static createAd<T>(data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(AdsRoute.routes.createAd, data, {}, params);
+  }
+
+  /**
+   * 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
+   */
+  public static viewAd<T>(
+    ad_id: string,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.retrieveAd,
+      {},
+      { ad_id },
+      params
+    );
+  }
+
+  /**
+   * 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
+   */
+  public static updateAd<T>(
+    ad_id: string,
+    data?: object,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.updateAd,
+      data,
+      { ad_id },
+      params
+    );
+  }
+
+  /**
+   * 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
+   */
+  public static deleteAd<T>(
+    ad_id: string,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.deleteAd,
+      {},
+      { ad_id },
+      params
+    );
+  }
+
+  // ----------------------------------------------------------------------
+  // AD GROUP TRIGGERS
+  // ----------------------------------------------------------------------
+
+  /**
+   * 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
+   */
+  public static listTriggers<T>(
+    campaign_id: string,
+    group_id: string,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.getTriggers,
+      {},
+      { campaign_id, group_id },
+      params
+    );
+  }
+
+  /**
+   * 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
+   */
+  public static createTrigger<T>(
+    campaign_id: string,
+    group_id: string,
+    data?: object,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.createTrigger,
+      data,
+      { campaign_id, group_id },
+      params
+    );
+  }
+
+  /**
+   * 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
+   */
+  public static viewTrigger<T>(
+    campaign_id: string,
+    group_id: string,
+    trigger_id: string,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.retrieveTrigger,
+      {},
+      { campaign_id, group_id, trigger_id },
+      params
+    );
+  }
+
+  /**
+   * 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
+   */
+  public static updateTrigger<T>(
+    campaign_id: string,
+    group_id: string,
+    trigger_id: string,
+    data?: object,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.updateTrigger,
+      data,
+      { campaign_id, group_id, trigger_id },
+      params
+    );
+  }
+
+  /**
+   * 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
+   */
+  public static deleteTrigger<T>(
+    campaign_id: string,
+    group_id: string,
+    trigger_id: string,
+    params?: Record<string, any>
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.deleteTrigger,
+      {},
+      { campaign_id, group_id, trigger_id },
+      params
+    );
+  }
+}
+
+export default Ads;