import { AbstractEntity } from '../../abstractEntity'; import { AdminSubscriptionsListData, SubscriptionsClient, SubscriptionsListPayload } from '../subscriptionsClient'; import { SubscriptionData } from './subscription'; /** * Subscriptions list result plain data */ export declare type SubscriptionsListResultData = { subscriptions: AsyncGenerator; totalPage: number; nbResults: number; }; export declare class SubscriptionsListResult extends AbstractEntity { #private; /** * FindResult constructor. Uses the client and request data to go through the pages. * @param response - First call response data * @param client - Subscriptions client the call was made with * @param payload - Payload parameter sent to the first call */ constructor(response: AdminSubscriptionsListData, client: SubscriptionsClient, payload?: SubscriptionsListPayload); get subscriptions(): AsyncGenerator; get client(): SubscriptionsClient; get payload(): SubscriptionsListPayload; get currentPage(): number; get totalPage(): number; get nbResults(): number; get nextPageURL(): string; get previousPageURL(): string; /** * Gets all the subscriptions for the current page * @returns Generator|{@link SubscriptionData}[] */ getSubscriptionsForCurrentPage(): Generator; /** * Gets all the subscriptions from the result, page per page. * Follows the asybc interator implementation through the generator pattern. * @returns Generator|{@link SubscriptionData}[] */ getSubscriptions(): AsyncGenerator; /** * Plain JSON object representation of the result entity. * @returns {@link SubscriptionsListResultData} */ toJSON(): SubscriptionsListResultData; }