pl-api
    Preparing search index...

    Function scheduledStatusesCategory

    • Parameters

      Returns {
          cancelScheduledStatus: (
              scheduledStatusId: string,
          ) => Promise<EmptyObject>;
          getScheduledStatus: (
              scheduledStatusId: string,
          ) => Promise<
              {
                  id: string;
                  media_attachments: (
                      | {
                          blurhash: string
                          | null;
                          description: string;
                          id: string;
                          meta: {
                              focus?: { x: number; y: number };
                              original?: {
                                  aspect: (...) | (...);
                                  height: number;
                                  size: (...) | (...);
                                  width: number;
                              };
                              small?: {
                                  aspect: (...)
                                  | (...);
                                  height: number;
                                  size: (...) | (...);
                                  width: number;
                              };
                          };
                          mime_type: string
                          | null;
                          preview_url: string;
                          remote_url: string | null;
                          type: "image";
                          url: string;
                      }
                      | {
                          blurhash: string
                          | null;
                          description: string;
                          id: string;
                          meta: {
                              duration?: number;
                              original?: {
                                  aspect: (...) | (...);
                                  duration: (...) | (...);
                                  frame_rate: (...) | (...);
                                  height: number;
                                  size: (...) | (...);
                                  width: number;
                              };
                              small?: {
                                  aspect: (...)
                                  | (...);
                                  height: number;
                                  size: (...) | (...);
                                  width: number;
                              };
                          };
                          mime_type: string
                          | null;
                          preview_url: string;
                          remote_url: string | null;
                          type: "video";
                          url: string;
                      }
                      | {
                          blurhash: string
                          | null;
                          description: string;
                          id: string;
                          meta: {
                              duration?: number;
                              focus?: { x: number; y: number };
                              original?: {
                                  aspect: (...) | (...);
                                  height: number;
                                  size: (...) | (...);
                                  width: number;
                              };
                          };
                          mime_type: string
                          | null;
                          preview_url: string;
                          remote_url: string | null;
                          type: "gifv";
                          url: string;
                      }
                      | {
                          blurhash: string
                          | null;
                          description: string;
                          id: string;
                          meta: {
                              colors?: {
                                  accent?: (...) | (...);
                                  background?: (...) | (...);
                                  duration?: (...) | (...);
                                  foreground?: (...) | (...);
                              };
                              duration?: number;
                              original?: { bitrate?: (...)
                              | (...); duration?: (...) | (...) };
                          };
                          mime_type: string
                          | null;
                          preview_url: string;
                          remote_url: string | null;
                          type: "audio";
                          url: string;
                      }
                      | {
                          blurhash: string
                          | null;
                          description: string;
                          id: string;
                          mime_type: string | null;
                          preview_url: string;
                          remote_url: string | null;
                          type: "unknown";
                          url: string;
                      }
                  )[];
                  params: {
                      application_id: number
                      | null;
                      expires_in: number | null;
                      idempotency: string | null;
                      in_reply_to_id: string | null;
                      language: string | null;
                      media_ids: string | null;
                      poll:
                          | {
                              expires_in: string;
                              hide_totals?: boolean;
                              multiple?: boolean;
                              options: string[];
                          }
                          | null;
                      scheduled_at: string
                      | null;
                      sensitive: boolean | null;
                      spoiler_text: string | null;
                      text: string | null;
                      visibility: string;
                      with_rate_limit: boolean;
                  };
                  scheduled_at: string;
              },
          >;
          getScheduledStatuses: (
              params?: PaginationParams,
          ) => Promise<
              PaginatedResponse<
                  {
                      id: string;
                      media_attachments: (
                          | {
                              blurhash: string
                              | null;
                              description: string;
                              id: string;
                              meta: {
                                  focus?: { x: ...; y: ... };
                                  original?: { aspect: ...; height: ...; size: ...; width: ... };
                                  small?: { aspect: ...; height: ...; size: ...; width: ... };
                              };
                              mime_type: string
                              | null;
                              preview_url: string;
                              remote_url: string | null;
                              type: "image";
                              url: string;
                          }
                          | {
                              blurhash: string
                              | null;
                              description: string;
                              id: string;
                              meta: {
                                  duration?: number;
                                  original?: {
                                      aspect: ...;
                                      duration: ...;
                                      frame_rate: ...;
                                      height: ...;
                                      size: ...;
                                      width: ...;
                                  };
                                  small?: { aspect: ...; height: ...; size: ...; width: ... };
                              };
                              mime_type: string
                              | null;
                              preview_url: string;
                              remote_url: string | null;
                              type: "video";
                              url: string;
                          }
                          | {
                              blurhash: string
                              | null;
                              description: string;
                              id: string;
                              meta: {
                                  duration?: number;
                                  focus?: { x: ...; y: ... };
                                  original?: { aspect: ...; height: ...; size: ...; width: ... };
                              };
                              mime_type: string
                              | null;
                              preview_url: string;
                              remote_url: string | null;
                              type: "gifv";
                              url: string;
                          }
                          | {
                              blurhash: string
                              | null;
                              description: string;
                              id: string;
                              meta: {
                                  colors?: {
                                      accent?: ...;
                                      background?: ...;
                                      duration?: ...;
                                      foreground?: ...;
                                  };
                                  duration?: number;
                                  original?: { bitrate?: ...; duration?: ... };
                              };
                              mime_type: string
                              | null;
                              preview_url: string;
                              remote_url: string | null;
                              type: "audio";
                              url: string;
                          }
                          | {
                              blurhash: string
                              | null;
                              description: string;
                              id: string;
                              mime_type: string | null;
                              preview_url: string;
                              remote_url: string | null;
                              type: "unknown";
                              url: string;
                          }
                      )[];
                      params: {
                          application_id: number
                          | null;
                          expires_in: number | null;
                          idempotency: string | null;
                          in_reply_to_id: string | null;
                          language: string | null;
                          media_ids: string | null;
                          poll:
                              | {
                                  expires_in: string;
                                  hide_totals?: boolean;
                                  multiple?: boolean;
                                  options: string[];
                              }
                              | null;
                          scheduled_at: string
                          | null;
                          sensitive: boolean | null;
                          spoiler_text: string | null;
                          text: string | null;
                          visibility: string;
                          with_rate_limit: boolean;
                      };
                      scheduled_at: string;
                  },
                  true,
              >,
          >;
          updateScheduledStatus: (
              scheduledStatusId: string,
              scheduled_at: string,
          ) => Promise<
              {
                  id: string;
                  media_attachments: (
                      | {
                          blurhash: string
                          | null;
                          description: string;
                          id: string;
                          meta: {
                              focus?: { x: number; y: number };
                              original?: {
                                  aspect: (...) | (...);
                                  height: number;
                                  size: (...) | (...);
                                  width: number;
                              };
                              small?: {
                                  aspect: (...)
                                  | (...);
                                  height: number;
                                  size: (...) | (...);
                                  width: number;
                              };
                          };
                          mime_type: string
                          | null;
                          preview_url: string;
                          remote_url: string | null;
                          type: "image";
                          url: string;
                      }
                      | {
                          blurhash: string
                          | null;
                          description: string;
                          id: string;
                          meta: {
                              duration?: number;
                              original?: {
                                  aspect: (...) | (...);
                                  duration: (...) | (...);
                                  frame_rate: (...) | (...);
                                  height: number;
                                  size: (...) | (...);
                                  width: number;
                              };
                              small?: {
                                  aspect: (...)
                                  | (...);
                                  height: number;
                                  size: (...) | (...);
                                  width: number;
                              };
                          };
                          mime_type: string
                          | null;
                          preview_url: string;
                          remote_url: string | null;
                          type: "video";
                          url: string;
                      }
                      | {
                          blurhash: string
                          | null;
                          description: string;
                          id: string;
                          meta: {
                              duration?: number;
                              focus?: { x: number; y: number };
                              original?: {
                                  aspect: (...) | (...);
                                  height: number;
                                  size: (...) | (...);
                                  width: number;
                              };
                          };
                          mime_type: string
                          | null;
                          preview_url: string;
                          remote_url: string | null;
                          type: "gifv";
                          url: string;
                      }
                      | {
                          blurhash: string
                          | null;
                          description: string;
                          id: string;
                          meta: {
                              colors?: {
                                  accent?: (...) | (...);
                                  background?: (...) | (...);
                                  duration?: (...) | (...);
                                  foreground?: (...) | (...);
                              };
                              duration?: number;
                              original?: { bitrate?: (...)
                              | (...); duration?: (...) | (...) };
                          };
                          mime_type: string
                          | null;
                          preview_url: string;
                          remote_url: string | null;
                          type: "audio";
                          url: string;
                      }
                      | {
                          blurhash: string
                          | null;
                          description: string;
                          id: string;
                          mime_type: string | null;
                          preview_url: string;
                          remote_url: string | null;
                          type: "unknown";
                          url: string;
                      }
                  )[];
                  params: {
                      application_id: number
                      | null;
                      expires_in: number | null;
                      idempotency: string | null;
                      in_reply_to_id: string | null;
                      language: string | null;
                      media_ids: string | null;
                      poll:
                          | {
                              expires_in: string;
                              hide_totals?: boolean;
                              multiple?: boolean;
                              options: string[];
                          }
                          | null;
                      scheduled_at: string
                      | null;
                      sensitive: boolean | null;
                      spoiler_text: string | null;
                      text: string | null;
                      visibility: string;
                      with_rate_limit: boolean;
                  };
                  scheduled_at: string;
              },
          >;
      }

      • cancelScheduledStatus: (scheduledStatusId: string) => Promise<EmptyObject>

        Cancel a scheduled status

      • getScheduledStatus: (
            scheduledStatusId: string,
        ) => Promise<
            {
                id: string;
                media_attachments: (
                    | {
                        blurhash: string
                        | null;
                        description: string;
                        id: string;
                        meta: {
                            focus?: { x: number; y: number };
                            original?: {
                                aspect: (...) | (...);
                                height: number;
                                size: (...) | (...);
                                width: number;
                            };
                            small?: {
                                aspect: (...)
                                | (...);
                                height: number;
                                size: (...) | (...);
                                width: number;
                            };
                        };
                        mime_type: string
                        | null;
                        preview_url: string;
                        remote_url: string | null;
                        type: "image";
                        url: string;
                    }
                    | {
                        blurhash: string
                        | null;
                        description: string;
                        id: string;
                        meta: {
                            duration?: number;
                            original?: {
                                aspect: (...) | (...);
                                duration: (...) | (...);
                                frame_rate: (...) | (...);
                                height: number;
                                size: (...) | (...);
                                width: number;
                            };
                            small?: {
                                aspect: (...)
                                | (...);
                                height: number;
                                size: (...) | (...);
                                width: number;
                            };
                        };
                        mime_type: string
                        | null;
                        preview_url: string;
                        remote_url: string | null;
                        type: "video";
                        url: string;
                    }
                    | {
                        blurhash: string
                        | null;
                        description: string;
                        id: string;
                        meta: {
                            duration?: number;
                            focus?: { x: number; y: number };
                            original?: {
                                aspect: (...) | (...);
                                height: number;
                                size: (...) | (...);
                                width: number;
                            };
                        };
                        mime_type: string
                        | null;
                        preview_url: string;
                        remote_url: string | null;
                        type: "gifv";
                        url: string;
                    }
                    | {
                        blurhash: string
                        | null;
                        description: string;
                        id: string;
                        meta: {
                            colors?: {
                                accent?: (...) | (...);
                                background?: (...) | (...);
                                duration?: (...) | (...);
                                foreground?: (...) | (...);
                            };
                            duration?: number;
                            original?: { bitrate?: (...)
                            | (...); duration?: (...) | (...) };
                        };
                        mime_type: string
                        | null;
                        preview_url: string;
                        remote_url: string | null;
                        type: "audio";
                        url: string;
                    }
                    | {
                        blurhash: string
                        | null;
                        description: string;
                        id: string;
                        mime_type: string | null;
                        preview_url: string;
                        remote_url: string | null;
                        type: "unknown";
                        url: string;
                    }
                )[];
                params: {
                    application_id: number
                    | null;
                    expires_in: number | null;
                    idempotency: string | null;
                    in_reply_to_id: string | null;
                    language: string | null;
                    media_ids: string | null;
                    poll:
                        | {
                            expires_in: string;
                            hide_totals?: boolean;
                            multiple?: boolean;
                            options: string[];
                        }
                        | null;
                    scheduled_at: string
                    | null;
                    sensitive: boolean | null;
                    spoiler_text: string | null;
                    text: string | null;
                    visibility: string;
                    with_rate_limit: boolean;
                };
                scheduled_at: string;
            },
        >

        View a single scheduled status

      • getScheduledStatuses: (
            params?: PaginationParams,
        ) => Promise<
            PaginatedResponse<
                {
                    id: string;
                    media_attachments: (
                        | {
                            blurhash: string
                            | null;
                            description: string;
                            id: string;
                            meta: {
                                focus?: { x: ...; y: ... };
                                original?: { aspect: ...; height: ...; size: ...; width: ... };
                                small?: { aspect: ...; height: ...; size: ...; width: ... };
                            };
                            mime_type: string
                            | null;
                            preview_url: string;
                            remote_url: string | null;
                            type: "image";
                            url: string;
                        }
                        | {
                            blurhash: string
                            | null;
                            description: string;
                            id: string;
                            meta: {
                                duration?: number;
                                original?: {
                                    aspect: ...;
                                    duration: ...;
                                    frame_rate: ...;
                                    height: ...;
                                    size: ...;
                                    width: ...;
                                };
                                small?: { aspect: ...; height: ...; size: ...; width: ... };
                            };
                            mime_type: string
                            | null;
                            preview_url: string;
                            remote_url: string | null;
                            type: "video";
                            url: string;
                        }
                        | {
                            blurhash: string
                            | null;
                            description: string;
                            id: string;
                            meta: {
                                duration?: number;
                                focus?: { x: ...; y: ... };
                                original?: { aspect: ...; height: ...; size: ...; width: ... };
                            };
                            mime_type: string
                            | null;
                            preview_url: string;
                            remote_url: string | null;
                            type: "gifv";
                            url: string;
                        }
                        | {
                            blurhash: string
                            | null;
                            description: string;
                            id: string;
                            meta: {
                                colors?: {
                                    accent?: ...;
                                    background?: ...;
                                    duration?: ...;
                                    foreground?: ...;
                                };
                                duration?: number;
                                original?: { bitrate?: ...; duration?: ... };
                            };
                            mime_type: string
                            | null;
                            preview_url: string;
                            remote_url: string | null;
                            type: "audio";
                            url: string;
                        }
                        | {
                            blurhash: string
                            | null;
                            description: string;
                            id: string;
                            mime_type: string | null;
                            preview_url: string;
                            remote_url: string | null;
                            type: "unknown";
                            url: string;
                        }
                    )[];
                    params: {
                        application_id: number
                        | null;
                        expires_in: number | null;
                        idempotency: string | null;
                        in_reply_to_id: string | null;
                        language: string | null;
                        media_ids: string | null;
                        poll:
                            | {
                                expires_in: string;
                                hide_totals?: boolean;
                                multiple?: boolean;
                                options: string[];
                            }
                            | null;
                        scheduled_at: string
                        | null;
                        sensitive: boolean | null;
                        spoiler_text: string | null;
                        text: string | null;
                        visibility: string;
                        with_rate_limit: boolean;
                    };
                    scheduled_at: string;
                },
                true,
            >,
        >

        View scheduled statuses

      • updateScheduledStatus: (
            scheduledStatusId: string,
            scheduled_at: string,
        ) => Promise<
            {
                id: string;
                media_attachments: (
                    | {
                        blurhash: string
                        | null;
                        description: string;
                        id: string;
                        meta: {
                            focus?: { x: number; y: number };
                            original?: {
                                aspect: (...) | (...);
                                height: number;
                                size: (...) | (...);
                                width: number;
                            };
                            small?: {
                                aspect: (...)
                                | (...);
                                height: number;
                                size: (...) | (...);
                                width: number;
                            };
                        };
                        mime_type: string
                        | null;
                        preview_url: string;
                        remote_url: string | null;
                        type: "image";
                        url: string;
                    }
                    | {
                        blurhash: string
                        | null;
                        description: string;
                        id: string;
                        meta: {
                            duration?: number;
                            original?: {
                                aspect: (...) | (...);
                                duration: (...) | (...);
                                frame_rate: (...) | (...);
                                height: number;
                                size: (...) | (...);
                                width: number;
                            };
                            small?: {
                                aspect: (...)
                                | (...);
                                height: number;
                                size: (...) | (...);
                                width: number;
                            };
                        };
                        mime_type: string
                        | null;
                        preview_url: string;
                        remote_url: string | null;
                        type: "video";
                        url: string;
                    }
                    | {
                        blurhash: string
                        | null;
                        description: string;
                        id: string;
                        meta: {
                            duration?: number;
                            focus?: { x: number; y: number };
                            original?: {
                                aspect: (...) | (...);
                                height: number;
                                size: (...) | (...);
                                width: number;
                            };
                        };
                        mime_type: string
                        | null;
                        preview_url: string;
                        remote_url: string | null;
                        type: "gifv";
                        url: string;
                    }
                    | {
                        blurhash: string
                        | null;
                        description: string;
                        id: string;
                        meta: {
                            colors?: {
                                accent?: (...) | (...);
                                background?: (...) | (...);
                                duration?: (...) | (...);
                                foreground?: (...) | (...);
                            };
                            duration?: number;
                            original?: { bitrate?: (...)
                            | (...); duration?: (...) | (...) };
                        };
                        mime_type: string
                        | null;
                        preview_url: string;
                        remote_url: string | null;
                        type: "audio";
                        url: string;
                    }
                    | {
                        blurhash: string
                        | null;
                        description: string;
                        id: string;
                        mime_type: string | null;
                        preview_url: string;
                        remote_url: string | null;
                        type: "unknown";
                        url: string;
                    }
                )[];
                params: {
                    application_id: number
                    | null;
                    expires_in: number | null;
                    idempotency: string | null;
                    in_reply_to_id: string | null;
                    language: string | null;
                    media_ids: string | null;
                    poll:
                        | {
                            expires_in: string;
                            hide_totals?: boolean;
                            multiple?: boolean;
                            options: string[];
                        }
                        | null;
                    scheduled_at: string
                    | null;
                    sensitive: boolean | null;
                    spoiler_text: string | null;
                    text: string | null;
                    visibility: string;
                    with_rate_limit: boolean;
                };
                scheduled_at: string;
            },
        >

        Update a scheduled status’s publishing date