commonMain.sh.christian.ozone.unspecced.UnspeccedBlueskyApi.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bluesky Show documentation

Bluesky Social API bindings for Kotlin.

The newest version!

package sh.christian.ozone.unspecced

import app.bsky.unspecced.GetConfigResponse
import app.bsky.unspecced.GetPopularFeedGeneratorsQueryParams
import app.bsky.unspecced.GetPopularFeedGeneratorsResponse
import app.bsky.unspecced.GetSuggestionsSkeletonQueryParams
import app.bsky.unspecced.GetSuggestionsSkeletonResponse
import app.bsky.unspecced.GetTaggedSuggestionsResponse
import app.bsky.unspecced.SearchActorsSkeletonQueryParams
import app.bsky.unspecced.SearchActorsSkeletonResponse
import app.bsky.unspecced.SearchPostsSkeletonQueryParams
import app.bsky.unspecced.SearchPostsSkeletonResponse
import app.bsky.unspecced.SearchStarterPacksSkeletonQueryParams
import app.bsky.unspecced.SearchStarterPacksSkeletonResponse
import sh.christian.ozone.api.response.AtpResponse

public interface UnspeccedBlueskyApi {
  /**
   * Get miscellaneous runtime configuration.
   */
  public suspend fun getConfig(): AtpResponse

  /**
   * An unspecced view of globally popular feed generators.
   */
  public suspend fun getPopularFeedGenerators(params: GetPopularFeedGeneratorsQueryParams): AtpResponse

  /**
   * Get a skeleton of suggested actors. Intended to be called and then hydrated through
   * app.bsky.actor.getSuggestions
   */
  public suspend fun getSuggestionsSkeleton(params: GetSuggestionsSkeletonQueryParams): AtpResponse

  /**
   * Get a list of suggestions (feeds and users) tagged with categories
   */
  public suspend fun getTaggedSuggestions(): AtpResponse

  /**
   * Backend Actors (profile) search, returns only skeleton.
   */
  public suspend fun searchActorsSkeleton(params: SearchActorsSkeletonQueryParams): AtpResponse

  /**
   * Backend Posts search, returns only skeleton
   */
  public suspend fun searchPostsSkeleton(params: SearchPostsSkeletonQueryParams): AtpResponse

  /**
   * Backend Starter Pack search, returns only skeleton.
   */
  public suspend fun searchStarterPacksSkeleton(params: SearchStarterPacksSkeletonQueryParams): AtpResponse
}