Constructors

Methods

  • Clear Bluesky OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear Discord OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear Facebook OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear Instagram OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear Kick OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear Patreon OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear Pinterest OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear Reddit Ads OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear Reddit OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear Snapchat OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear Steam OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear TikTok OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear Twitch OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear Twitter OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Clear YouTube OAuth credentials from a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Find potential cross-promote partners for a scheduler (with optional filters). GET /schedulers/{scheduler_id}/crosspromote/find

    Type Parameters

    • T

    Parameters

    • scheduler_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Accept an invite to cross-promote. POST /schedulers/{scheduler_id}/crosspromote/invites/{invite_id}/accept

    Type Parameters

    • T

    Parameters

    • scheduler_id: string
    • invite_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Reject an invite to cross-promote. POST /schedulers/{scheduler_id}/crosspromote/invites/{invite_id}/reject

    Type Parameters

    • T

    Parameters

    • scheduler_id: string
    • invite_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Send an invite to cross-promote (from scheduler_id to partner_scheduler_id). POST /schedulers/{scheduler_id}/crosspromote/invites

    Type Parameters

    • T

    Parameters

    • scheduler_id: string
    • data: object

      { partner_scheduler_id, optional_message }

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List cross-promote invites for a scheduler (incoming + outgoing). GET /schedulers/{scheduler_id}/crosspromote/invites

    Type Parameters

    • T

    Parameters

    • scheduler_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List cross-promote relationships for a scheduler (with optional pagination). GET /schedulers/{scheduler_id}/crosspromote/relationships

    Type Parameters

    • T

    Parameters

    • scheduler_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • End a cross-promote relationship (delete). DELETE /schedulers/{scheduler_id}/crosspromote/relationships/{relationship_id}

    Type Parameters

    • T

    Parameters

    • scheduler_id: string
    • relationship_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Get which platforms are cross-promoted in an existing relationship. GET /schedulers/{scheduler_id}/crosspromote/relationships/{relationship_id}/platforms

    Type Parameters

    • T

    Parameters

    • scheduler_id: string
    • relationship_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Get recently cross-promoted logs under a relationship. GET /schedulers/{scheduler_id}/crosspromote/relationships/{relationship_id}/posts

    Type Parameters

    • T

    Parameters

    • scheduler_id: string
    • relationship_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Set which platforms are cross-promoted in an existing relationship. PUT /schedulers/{scheduler_id}/crosspromote/relationships/{relationship_id}/platforms data = { platforms: ['twitter','facebook',...]}

    Type Parameters

    • T

    Parameters

    • scheduler_id: string
    • relationship_id: string
    • data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Get Discord channels associated with the scheduler's Discord account.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Get Facebook groups associated with the scheduler's Facebook account.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Get Instagram accounts associated with the scheduler's Instagram account.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Get flairs for a specific Reddit subreddit.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • subreddit: string

      The name of the subreddit.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Get Reddit subreddits associated with the scheduler's Reddit account.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    promise

  • Get progression data for social media posts over time.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

      Query parameters (e.g., social_platform, start_date, end_date)

    Returns AxiosPromise<default<T>>

    promise

  • Get aggregated reports for a promotion schedule.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The ID of the promotion schedule.

    • Optional params: Record<string, any>

      Query parameters (e.g., social_platform, start_date, end_date)

    Returns AxiosPromise<default<T>>

    promise

  • List Ad Accounts for the given campaign ID, as defined by /schedulers/{scheduler_id}/ad_accounts on the backend.

    E.g. for Reddit, you can pass ?business_id= to get business-level ad accounts, or for Twitter, it might just return a user’s ad accounts, etc.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The UUID of the Ad Campaign

    • Optional params: Record<string, any>

      Optional query parameters, e.g. business_id, page.size, etc.

    Returns AxiosPromise<default<T>>

    A response object with data (ad account list)

  • List platform-level businesses for the given campaign ID, as defined by /schedulers/{scheduler_id}/businesses on the backend.

    Typically relevant for Reddit (list businesses), or might return a "not supported" message for Meta/TikTok.

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The UUID of the Ad Campaign

    • Optional params: Record<string, any>

      Optional query parameters, e.g. page.size, etc.

    Returns AxiosPromise<default<T>>

    A response object with data (business list or messages)

  • List funding instruments for the given campaign ID, as defined by /schedulers/{scheduler_id}/funding_instruments on the backend.

    For Twitter, pass ?account_id=... For Reddit, pass ?ad_account_id=... or ?business_id=...

    Type Parameters

    • T

    Parameters

    • scheduler_id: string

      The UUID of the Ad Campaign

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    A response object with data (funding instruments)

Generated using TypeDoc