Source code for tdw_catalog.organization_utils

from dataclasses import dataclass
from typing import List

import tdw_catalog.organization_member as organization_member


@dataclass
class InviteMembersResponseFailedInvitation:
    """
    :class:`.InviteMembersResponseFailedInvitation` is a container for a single failed invitation,
    providing information about why that invitation failed to send.

    Attributes
    ----------
    email: str
        The email address of the invitee
    error_message : str
        A message indicating why the invitation failed to send.
    """
    email: str
    error_message: str


@dataclass
class InviteMembersResponse:
    """
    :class:`.InviteMembersResponse` contains the successfully invited members
    and summarizes any failed invitations.

    Attributes
    ----------
    failed_invitations: List[InviteMembersResponseFailedInvitee]
        List of email addresses and error message summaries of the failed invitations.
    successful_invitation : List[organization_member.OrganizationMember]
        List of members which were successfully invited to the :class:`.Organization`.
    """
    failed_invitations: List[InviteMembersResponseFailedInvitation]
    successful_invitations: List['organization_member.OrganizationMember']