Constructors

Methods

  • Remove an item from the user's library (Soft Delete).

    Type Parameters

    • T

    Parameters

    • id: string

    Returns AxiosPromise<default<T>>

  • Get all achievements for a user.

    Type Parameters

    • T

    Parameters

    • user_id: string
    • Optional params: {
          status?: string;
          title_id?: string;
      }
      • Optional status?: string
      • Optional title_id?: string

    Returns AxiosPromise<default<T>>

  • Get the raw gameplay history (Run Records) for a user.

    Type Parameters

    • T

    Parameters

    • user_id: string
    • Optional params: {
          page?: number;
          title_id?: string;
      }
      • Optional page?: number
      • Optional title_id?: string

    Returns AxiosPromise<default<T>>

  • Get all stats for a user, optionally filtered by title_id.

    Type Parameters

    • T

    Parameters

    • user_id: string
    • Optional params: {
          title_id?: string;
      }
      • Optional title_id?: string

    Returns AxiosPromise<default<T>>

  • List the authenticated user's media library (clips, screenshots, AI generated).

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

      Optional filters: { type: 'clip'|'screenshot'|'ai_generated', title_id: string }

    Returns AxiosPromise<default<T>>

  • Apply AI transformations (Style Transfer/Upscale) to a library item.

    Type Parameters

    • T

    Parameters

    • id: string

      The UUID of the UserMedia record.

    • data: {
          prompt: string;
          tool: string;
      }

      { prompt: string, tool: 'style_transfer'|'upscale' }

      • prompt: string
      • tool: string

    Returns AxiosPromise<default<T>>

  • Get a list of games the current user has played. Includes playtime and last played timestamps.

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Share a library item to social media as User Generated Content (UGC). This uses the player media share route, not the developer/scheduler post route.

    Type Parameters

    • T

    Parameters

    • id: string

      The UUID of the UserMedia record.

    • data: {
          content: string;
          main_channel_id?: string;
          media_type?: string;
          platform: string;
          scheduled_at?: string;
          social_platform?: string;
          status?: string;
          sub_channel_id?: string;
          title?: string;
          token?: string;
          track_links?: boolean;
          [key: string]: any;
      }

      Player post payload, including platform/channel/schedule options.

      • [key: string]: any
      • content: string
      • Optional main_channel_id?: string
      • Optional media_type?: string
      • platform: string
      • Optional scheduled_at?: string
      • Optional social_platform?: string
      • Optional status?: string
      • Optional sub_channel_id?: string
      • Optional title?: string
      • Optional token?: string
      • Optional track_links?: boolean

    Returns AxiosPromise<default<T>>

  • Add a Media record to the user's personal library.

    Type Parameters

    • T

    Parameters

    • data: object

      { media_id: string, type: string, title_id?: string, label?: string, studio_metadata?: object }

    Returns AxiosPromise<default<T>>

  • Get AI-generated suggestions for the best 15-second window to trim a video.

    Type Parameters

    • T

    Parameters

    • id: string

    Returns AxiosPromise<default<T>>

  • Update a library item's label or metadata.

    Type Parameters

    • T

    Parameters

    • id: string
    • data: object

    Returns AxiosPromise<default<T>>

  • Retrieve details for a specific library item.

    Type Parameters

    • T

    Parameters

    • id: string

    Returns AxiosPromise<default<T>>

Generated using TypeDoc