RulesAPI¶

class minim.api.tidal.RulesAPI(client: APIClient, /)[source]¶

Bases: TIDALResourceAPI

Usage Rules API endpoints for the TIDAL API.

Important

This class is managed by TIDALAPIClient and should not be instantiated directly.

Parameters:

clientminim.api._shared.APIClient: API client instance used to make HTTP requests.

Methods

Usage Rules > Get Single Usage Rule: Get TIDAL catalog information for a usage rule․ Usage Rules > Get Multiple Usage Rules: Get TIDAL catalog information for multiple usage rules.

get_usage_rules(rule_ids: str | Collection[str], /) → dict[str, Any][source]¶

Usage Rules > Get Single Usage Rule: Get TIDAL catalog information for a usage rule․ Usage Rules > Get Multiple Usage Rules: Get TIDAL catalog information for multiple usage rules.

Parameters:

rule_idsstr or Collection[str]; positional-only

TIDAL IDs of the usage rules.

Examples: "hkgYE3k5zqU2lmFo8CZbHKdf", ["hkgYE3k5zqU2lmFo8CZbHKdf", "VFJBQ0tTOjEyMzpOTw"].

Returns:

usage_rulesdict[str, Any]

TIDAL metadata for the usage rules.

Sample responses

Single usage rule

...

Multiple usage rules

...