API Reference Zoonk v#0.1.0-dev

Zoonk keeps the contexts that define your domain and business logic.

Send requests to AI services.

Public client for generating AI content across various services.

Base client functionality for AI service implementations.

Configuration module for AI clients.

Gemini service implementation for generating AI responses.

OpenAI service implementation for generating AI responses.

OpenRouter service implementation for generating AI responses.

TogetherAI service implementation for generating AI responses.

Create AI payloads for external APIs/services.

Defines schema specifications for structured AI outputs.

Schema for storing learning recommendations.

Local evaluation system for AI prompts.

Behaviour for AI evaluation cases.

Utility functions to store and retrieve evaluation results for AI models and prompts.

Evaluation models for AI tasks.

A module for running evaluations on AI models.

Implements tasks for evaluating AI-generated content.

Behaviour for AI tasks.

Manages user accounts.

Manages reserved subdomains for the application.

Defines the User schema.

Handles email notifications for user authentication events.

Defines the UserProfile schema and related changesets.

Defines the UserProvider schema.

Represents authentication and verification tokens for users.

Handles billing operations for the application.

Defines the BillingAccount schema.

Represents a pricing option for a subscription plan.

Stripe API client for Zoonk.

Provides data for tax ID types and their associated countries.

Defines the UserSubscription schema.

The Catalog context.

Manages course category configurations for the application.

Defines the Chapter schema.

Defines the ChapterTranslation schema.

Defines the Course schema.

Defines the CourseChapter schema.

Defines the CourseTranslation schema.

Defines the CourseUser schema.

Provides fuzzy search functionality using Jaro distance algorithm.

A module providing Internationalization with a gettext-based API.

Provides helper functions for the Zoonk application.

Manages supported language configurations for the application.

Handles geographic and regional data.

Represents a country's data.

Represents currency information.

Provides email sending functionality.

The Orgs context.

Defines the Org schema.

Defines the OrgMember schema.

Defines the OrgSettings schema.

Defines the scope of the caller to be used throughout the app.

Signing and verifying Stripe webhook signatures.

The Support context for handling user feedback and support requests.

Handles email notifications for user feedback.

Manages social media link configurations for the application.

Handles email notifications for user support requests.

The entrypoint for defining your web interface, such as controllers, components, channels, and so on.

Content Security Policy (CSP) plugs.

Configuration for command palette navigation items.

Command palette LiveComponent for quick navigation and search functionality.

Accordion components using native HTML details/summary elements.

Provides the UI for rendering anchors.

Wrapper for async_result.

UI component for rendering avatars.

Provides the UI for rendering buttons.

Card components.

Components for rendering command dialogs.

Dialog components.

Provides the UI for rendering dividers with optional labels.

Dropdown components.

FAQ components for displaying frequently asked questions.

Provides the UI for rendering flash messages.

Provides the UI for rendering a simple form.

Provides the UI for rendering icons.

Provides the UI for rendering input fields.

Loader components.

Navbar component for the main application navigation.

Provides the UI for rendering text.

Provides the UI for rendering toggle components.

Utility functions for components.

This module is invoked by your endpoint in case of errors on HTML requests.

This module is invoked by your endpoint in case of errors on JSON requests.

Plugs and LiveView hooks for setting the application language.

Renders legal documents such as terms of use and privacy policy.

Handles OAuth authentication.

Reusable module for LiveView pagination.

A Plug that keeps the raw body of incoming requests.

Raises a permission error with a 403 status code.

Settings layout component providing a two-column layout for settings pages.

Session management for user authentication.

Authorization plugs for web routes.

Handles user sessions.

Controller for managing user subscription actions.