@foxy.io/sdk/dist/types/customer/getAllowedFrequencies.d.ts

Universal SDK for a full server-side and a limited in-browser access to Foxy hAPI.

import type { CustomerPortalSettings } from './Graph/customer_portal_settings';
import type { Resource } from '../core/Resource/Resource';
import type { Subscription } from './Graph/subscription';
declare type Rules = CustomerPortalSettings['props']['subscriptions']['allow_frequency_modification'];
declare type Options = {
    settings: {
        subscriptions: {
            allow_frequency_modification: Rules;
        };
    };
    subscription: Omit<Resource<Subscription>, '_links' | '_embedded'>;
};
/**
 * Returns allowed frequencies for given subscription and customer portal settings.
 *
 * @param opts Subscription and settings.
 * @returns Array of allowed frequencies.
 */
export declare function getAllowedFrequencies(opts: Options): Generator<string, void, void>;
export {};