API Documentation

API Coaxis.Accounts

Class Diagram

classDiagram
    class Interest {
        UUID id
        CiString name
        String description
        Atom type
        User[] users
        destroy()
        update(UUID id, CiString name, String description, Atom type)
        read()
        create(UUID id, CiString name, String description, Atom type)
        by_id(UUID id)
        by_type(String type)
        by_name(String name)
    }
    class Token {
        Map extra_data
        String purpose
        UtcDatetime expires_at
        String subject
        String jti
        get_token(String token, String jti, String purpose)
        store_token(String token, Map extra_data, String purpose)
        store_confirmation_changes(String token, Map extra_data, String purpose)
        get_confirmation_changes(String jti)
        revoked?(String token, String jti)
        revoke_token(String token, Map extra_data)
        read_expired()
        expunge_expired()
    }
    class User {
        UUID id
        CiString email
        CiString first_name
        CiString last_name
        String hashed_password
        Interest[] interests
        password_reset_with_password(String reset_token, String password, String password_confirmation)
        request_password_reset_with_password(CiString email)
        sign_in_with_token_for_password(String token)
        sign_in_with_password(CiString email, String password)
        register_with_password(String password, String password_confirmation, CiString email)
        get_by_subject()
        destroy()
        update(UUID id, CiString email, CiString first_name, CiString last_name, ...)
        read()
        create(UUID id, CiString email, CiString first_name, CiString last_name, ...)
        by_id(UUID id)
    }
    class UserInterest {
        UUID id
        UUID user_id
        UUID interest_id
        User user
        Interest interest
        destroy()
        update(UUID id, UUID user_id, UUID interest_id)
        read()
        create(UUID id, UUID user_id, UUID interest_id)
        by_id(UUID id)
    }

    Interest -- User
    Interest -- UserInterest
    User -- UserInterest

ER Diagram

erDiagram
    Interest {
        UUID id
        CiString name
        String description
        Atom type
    }
    Token {
        Map extra_data
        String purpose
        UtcDatetime expires_at
        String subject
        String jti
    }
    User {
        UUID id
        CiString email
        CiString first_name
        CiString last_name
        String hashed_password
    }
    UserInterest {
        UUID id
        UUID user_id
        UUID interest_id
    }

    Interest ||--|| User : ""
    Interest ||--|| UserInterest : ""
    User ||--|| UserInterest : ""

Resources

• Interest
• Token
• User
• UserInterest

Interest

Attributes

Actions

Token

Attributes

Actions

User

Attributes

Actions

UserInterest

Attributes

Actions