@passband/sdk - v0.0.0
    Preparing search index...

    Class SourcesResource

    Sources resource — GET/POST /sources, PATCH/DELETE /sources/{id}, POST /sources/{id}/test.

    Index

    Constructors

    constructor

    Methods

    add list remove test update

    Constructors

    • Parameters

      • http: HttpClient

      Returns SourcesResource

    Methods

    • Create a source. POST /sources

      Parameters

      • body: {
            config?: Record<string, never>;
            name: string;
            type:
                | "rss"
                | "twitter"
                | "reddit"
                | "hackernews"
                | "google_news"
                | "substack";
            url: string;
        }
        • Optionalconfig?: Record<string, never>
        • name: string
        • type: "rss" | "twitter" | "reddit" | "hackernews" | "google_news" | "substack"
        • url: string

          Format: uri

      Returns Promise<
          {
              config?: Record<string, never>
              | null;
              createdAt?: string;
              enabled?: boolean;
              failCount?: number;
              health?: "error" | "healthy" | "stale" | "degraded" | "unknown";
              id?: string;
              itemCount?: number;
              lastError?: string | null;
              lastFetch?: string | null;
              name?: string;
              type?:
                  | "rss"
                  | "twitter"
                  | "reddit"
                  | "hackernews"
                  | "google_news"
                  | "substack";
              updatedAt?: string;
              url?: string
              | null;
          },
      >

    • List all sources. GET /sources

      Returns Promise<
          {
              config?: Record<string, never>
              | null;
              createdAt?: string;
              enabled?: boolean;
              failCount?: number;
              health?: "error" | "healthy" | "stale" | "degraded" | "unknown";
              id?: string;
              itemCount?: number;
              lastError?: string | null;
              lastFetch?: string | null;
              name?: string;
              type?:
                  | "rss"
                  | "twitter"
                  | "reddit"
                  | "hackernews"
                  | "google_news"
                  | "substack";
              updatedAt?: string;
              url?: string
              | null;
          }[],
      >

    • Delete a source and its items/drafts. DELETE /sources/{id}

      Parameters

      • id: string

      Returns Promise<{ ok: boolean }>

    • Run a test fetch against a source. POST /sources/{id}/test

      Parameters

      • id: string

      Returns Promise<
          {
              error?: string;
              items?: { title?: string; url?: string }[];
              ok?: boolean;
          },
      >

    • Update a source. PATCH /sources/{id}

      Parameters

      • id: string
      • body: {
            config?: Record<string, never>;
            enabled?: boolean;
            name?: string;
            type?:
                | "rss"
                | "twitter"
                | "reddit"
                | "hackernews"
                | "google_news"
                | "substack";
            url?: string;
        }
        • Optionalconfig?: Record<string, never>
        • Optionalenabled?: boolean
        • Optionalname?: string
        • Optionaltype?: "rss" | "twitter" | "reddit" | "hackernews" | "google_news" | "substack"
        • Optionalurl?: string

          Format: uri

      Returns Promise<
          {
              config?: Record<string, never>
              | null;
              createdAt?: string;
              enabled?: boolean;
              failCount?: number;
              health?: "error" | "healthy" | "stale" | "degraded" | "unknown";
              id?: string;
              itemCount?: number;
              lastError?: string | null;
              lastFetch?: string | null;
              name?: string;
              type?:
                  | "rss"
                  | "twitter"
                  | "reddit"
                  | "hackernews"
                  | "google_news"
                  | "substack";
              updatedAt?: string;
              url?: string
              | null;
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods