BroadcastMessages.ts

import { BaseResource } from '@gitbeaker/requester-utils';
import { RequestHelper } from '../infrastructure';
import type {
  GitlabAPIResponse,
  PaginationRequestOptions,
  PaginationTypes,
  ShowExpanded,
  Sudo,
} from '../infrastructure';
import { AccessLevel } from '../constants';

export interface BroadcastMessageSchema extends Record<string, unknown> {
  message: string;
  starts_at: string;
  ends_at: string;
  color: string;
  font: string;
  id: number;
  active: boolean;
  target_path: string;
  target_access_levels: Exclude<
    AccessLevel,
    AccessLevel.MINIMAL_ACCESS | AccessLevel.NO_ACCESS | AccessLevel.ADMIN
  >[];
  broadcast_type: string;
  dismissable: boolean;
}

export interface BroadcastMessageOptions extends Record<string, unknown> {
  message?: string;
  startsAt?: string;
  endsAt?: string;
  color?: string;
  font?: string;
  active?: boolean;
  targetPath?: string;
  targetAccessLevels?: Exclude<
    AccessLevel,
    AccessLevel.MINIMAL_ACCESS | AccessLevel.NO_ACCESS | AccessLevel.ADMIN
  >[];
  broadcastType?: string;
  dismissable?: boolean;
}

export class BroadcastMessages<C extends boolean = false> extends BaseResource<C> {
  all<E extends boolean = false, P extends PaginationTypes = 'offset'>(
    options?: PaginationRequestOptions<P> & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<BroadcastMessageSchema[], C, E, P>> {
    return RequestHelper.get<BroadcastMessageSchema[]>()(this, 'broadcast_messages', options);
  }

  create<E extends boolean = false>(
    options?: BroadcastMessageOptions & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<BroadcastMessageSchema, C, E, void>> {
    return RequestHelper.post<BroadcastMessageSchema>()(this, 'broadcast_messages', options);
  }

  edit<E extends boolean = false>(
    broadcastMessageId: number,
    options?: BroadcastMessageOptions & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<BroadcastMessageSchema, C, E, void>> {
    return RequestHelper.put<BroadcastMessageSchema>()(
      this,
      `broadcast_messages/${broadcastMessageId}`,
      options,
    );
  }

  remove<E extends boolean = false>(
    broadcastMessageId: number,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<void, C, E, void>> {
    return RequestHelper.del()(this, `broadcast_messages/${broadcastMessageId}`, options);
  }

  show<E extends boolean = false>(
    broadcastMessageId: number,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<BroadcastMessageSchema, C, E, void>> {
    return RequestHelper.get<BroadcastMessageSchema>()(
      this,
      `broadcast_messages/${broadcastMessageId}`,
      options,
    );
  }
}