@trycourier/courier-js/dist/client/list-client.d.ts

A browser-safe API wrapper

import { Client } from './client';
export declare class ListClient extends Client {
    /**
     * Subscribe a user to a list
     * @param listId - The ID of the list to subscribe to
     * @returns Promise resolving when subscription is complete
     * @see https://www.courier.com/docs/api-reference/lists/subscribe-user-profile-to-list
     */
    putSubscription(props: {
        listId: string;
    }): Promise<void>;
    /**
     * Unsubscribe a user from a list
     * @param listId - The ID of the list to unsubscribe from
     * @returns Promise resolving when unsubscription is complete
     * @see https://www.courier.com/docs/api-reference/lists/unsubscribe-user-profile-from-list
     */
    deleteSubscription(props: {
        listId: string;
    }): Promise<void>;
}