@junobuild/admin/dist/types/services/satellite.rules.services.d.ts

A library for interfacing with admin features of Juno

import type { Rule, RulesType } from '@junobuild/config';
import type { SatelliteParameters } from '../types/actor.types';
import type { ListRulesMatcher, ListRulesResults } from '../types/list.types';
/**
 * Lists the rules for a satellite.
 * @param {Object} params - The parameters for listing the rules.
 * @param {RulesType} params.type - The type of rules to list.
 * @param {ListRulesMatcher} params.filter - The optional filter for the query.
 * @param {SatelliteParameters} params.satellite - The satellite parameters.
 * @returns {Promise<ListRulesResults>} A promise that resolves to the resolved rules.
 */
export declare const listRules: ({ type, satellite, filter }: {
    type: RulesType;
    filter?: ListRulesMatcher;
    satellite: SatelliteParameters;
}) => Promise<ListRulesResults>;
/**
 * Sets a rule for a satellite.
 * @param {Object} params - The parameters for setting the rule.
 * @param {Rule} params.rule - The rule to set.
 * @param {RulesType} params.type - The type of rule.
 * @param {SatelliteParameters} params.satellite - The satellite parameters.
 * @returns {Promise<void>} A promise that resolves when the rule is set.
 */
export declare const setRule: ({ rule: { collection, ...rest }, type, satellite }: {
    rule: Rule;
    type: RulesType;
    satellite: SatelliteParameters;
}) => Promise<void>;