pl-api
    Preparing search index...

    Function circlesCategory

    • Parameters

      Returns {
          addCircleAccounts: (
              circleId: string,
              accountIds: string[],
          ) => Promise<EmptyObject>;
          createCircle: (title: string) => Promise<{ id: string; title: string }>;
          deleteCircle: (circleId: string) => Promise<EmptyObject>;
          deleteCircleAccounts: (
              circleId: string,
              accountIds: string[],
          ) => Promise<EmptyObject>;
          fetchCircles: () => Promise<{ id: string; title: string }[]>;
          getCircle: (circleId: string) => Promise<{ id: string; title: string }>;
          getCircleAccounts: (
              circleId: string,
              params?: PaginationParams,
          ) => Promise<PaginatedResponse<Account, true>>;
          getCircleStatuses: (
              circleId: string,
              params: PaginationParams,
          ) => Promise<PaginatedResponse<Status, true>>;
          updateCircle: (
              circleId: string,
              title: string,
          ) => Promise<{ id: string; title: string }>;
      }

      • addCircleAccounts: (circleId: string, accountIds: string[]) => Promise<EmptyObject>

        Add accounts to a circle Add accounts to the given circle. Note that the user must be following these accounts. Requires featuresFeatures.circles.

      • createCircle: (title: string) => Promise<{ id: string; title: string }>

        Requires featuresFeatures.circles.

      • deleteCircle: (circleId: string) => Promise<EmptyObject>

        Requires featuresFeatures.circles.

      • deleteCircleAccounts: (circleId: string, accountIds: string[]) => Promise<EmptyObject>

        Remove accounts from circle Remove accounts from the given circle. Requires featuresFeatures.circles.

      • fetchCircles: () => Promise<{ id: string; title: string }[]>

        Requires featuresFeatures.circles.

      • getCircle: (circleId: string) => Promise<{ id: string; title: string }>

        Requires featuresFeatures.circles.

      • getCircleAccounts: (
            circleId: string,
            params?: PaginationParams,
        ) => Promise<PaginatedResponse<Account, true>>

        View accounts in a circle Requires featuresFeatures.circles.

      • getCircleStatuses: (
            circleId: string,
            params: PaginationParams,
        ) => Promise<PaginatedResponse<Status, true>>
      • updateCircle: (circleId: string, title: string) => Promise<{ id: string; title: string }>

        Requires featuresFeatures.circles.