Class AnnouncementsService

constructor

• new AnnouncementsService(httpRequest): AnnouncementsService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns AnnouncementsService

Readonly httpRequest

announcementCreate

• announcementCreate(options): CancelablePromise<{
      announcement: AnnouncementPayload;
  }>

• Create an announcement

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        requestBody: {
            content: string | Record<string, any>;
            title: string;
        };
    }

    • channelId: string

    • requestBody: {
          content: string | Record<string, any>;
          title: string;
      }

      • content: string | Record<string, any>

        The content of the announcement

      • title: string

        The title of the announcement

  Returns CancelablePromise<{
      announcement: AnnouncementPayload;
  }>

  any Success

announcementDelete

• announcementDelete(options): CancelablePromise<void>

• Delete an announcement

  Throws

  ApiError

  Parameters

  • options: {
        announcementId: string;
        channelId: string;
    }

    • announcementId: string

    • channelId: string

  Returns CancelablePromise<void>

  void

announcementRead

• announcementRead(options): CancelablePromise<{
      announcement: AnnouncementPayload;
  }>

• Read an announcement

  Throws

  ApiError

  Parameters

  • options: {
        announcementId: string;
        channelId: string;
    }

    • announcementId: string

    • channelId: string

  Returns CancelablePromise<{
      announcement: AnnouncementPayload;
  }>

  any Success

announcementReadMany

• announcementReadMany(options): CancelablePromise<{
      announcements: AnnouncementPayload[];
  }>

• Get announcements Results returned will be ordered ascending by the announcement's createdAt. before will filter based on the announcement's createdAt

  Throws

  ApiError

  Parameters

  • options: {
        before?: string;
        channelId: string;
        limit?: number;
    }

    • Optional before?: string

    • channelId: string

    • Optional limit?: number

  Returns CancelablePromise<{
      announcements: AnnouncementPayload[];
  }>

  any Success

announcementUpdate

• announcementUpdate(options): CancelablePromise<{
      announcement: AnnouncementPayload;
  }>

• Update an announcement

  Throws

  ApiError

  Parameters

  • options: {
        announcementId: string;
        channelId: string;
        requestBody: {
            content?: string | Record<string, any>;
            title?: string;
        };
    }

    • announcementId: string

    • channelId: string

    • requestBody: {
          content?: string | Record<string, any>;
          title?: string;
      }

      • Optional content?: string | Record<string, any>

        The content of the announcement

      • Optional title?: string

        The title of the announcement

  Returns CancelablePromise<{
      announcement: AnnouncementPayload;
  }>

  any Success