import { type FromSchema } from 'json-schema-to-ts'; import { type IterablePromise } from '../client/method.js'; import { Resource } from '../client/resource.js'; import { type RequestOptions } from '../client/types.js'; import * as schemas from '../schemas/broadcasts.js'; import { BroadcastsNotifications } from './broadcasts/notifications.js'; type CreateBroadcastsResponse = FromSchema; type CreateBroadcastsPayload = FromSchema; type ListBroadcastsResponse = FromSchema; type ListBroadcastsPayload = FromSchema; type GetBroadcastsResponse = FromSchema; export declare class Broadcasts extends Resource { path: string; entity: string; notifications: BroadcastsNotifications; /** * Create a broadcast to send notifications to upto a 1,000 recipients - users or * topic subscribers. You can identify users by their email address or by an * external_id. * * You don't have to import your users into MagicBell. If a user does not exist * we'll create it automatically. * * You can send user attributes like first_name, custom_attributes, and more when * creating a broadcast. * * A new notification will be shown in the inbox of each recipient in real-time. It * will also be delivered to each recipient through all channels you have enabled * for your project. * * @param data * @param options - override client request options. * @returns A broadcast is a precursor to a notification. When you specify multiple * recipients, MagicBell creates a notification for each recipient and delivers it * to them based on their preferences. **/ create(data: CreateBroadcastsPayload, options?: RequestOptions): Promise; /** * List all broadcasts. Broadcasts are sorted in descending order by the sent_at * timestamp. * * @param options - override client request options. * @returns **/ list(options?: RequestOptions): IterablePromise; /** * List all broadcasts. Broadcasts are sorted in descending order by the sent_at * timestamp. * * @param data * @param options - override client request options. * @returns **/ list(data: ListBroadcastsPayload, options?: RequestOptions): IterablePromise; /** * Fetch a broadcast by its ID. * * @param broadcastId - ID of the broadcast. * @param options - override client request options. * @returns A broadcast is a precursor to a notification. When you specify multiple * recipients, MagicBell creates a notification for each recipient and delivers it * to them based on their preferences. **/ get(broadcastId: string, options?: RequestOptions): Promise; } export {};