magicbell/dist/commonjs/project-resources/users/push-subscriptions.d.ts

MagicBell API wrapper

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/users/push-subscriptions.js';
type ListUsersPushSubscriptionsResponse = FromSchema<typeof schemas.ListUsersPushSubscriptionsResponseSchema>;
type ListUsersPushSubscriptionsPayload = FromSchema<typeof schemas.ListUsersPushSubscriptionsPayloadSchema>;
export declare class UsersPushSubscriptions extends Resource {
    path: string;
    entity: string;
    /**
     * Fetch a user's push subscriptions. Returns a paginated list of web and mobile
     * push subscriptions for all platforms.
     *
     * @param userId - The user id is the MagicBell user id. Accepts a UUID
     * @param options - override client request options.
     * @returns
     **/
    list(userId: string, options?: RequestOptions): IterablePromise<ListUsersPushSubscriptionsResponse>;
    /**
     * Fetch a user's push subscriptions. Returns a paginated list of web and mobile
     * push subscriptions for all platforms.
     *
     * @param userId - The user id is the MagicBell user id. Accepts a UUID
     * @param data
     * @param options - override client request options.
     * @returns
     **/
    list(userId: string, data: ListUsersPushSubscriptionsPayload, options?: RequestOptions): IterablePromise<ListUsersPushSubscriptionsResponse>;
}
export {};