"""Bulk ingest success schema."""

from marshmallow import Schema, fields


class BulkIngestSuccess(Schema):
    """Schema for bulk ingest success notification.

    Properties:
        - bulk_session_id (str): the ID of the bulk session
        - execution_arn (str | None): the execution ARN of the bulk session ingestion
        - identity_id (str): the identity ID of the user to notify of success
        - identity_name (str): the name of the user to notify of success
        - vendor_name (str): the name of the vendor associated with the bulk session
        - total_products (int): the total number of products in the bulk session
        - submitted_products_count (int): the number of products submitted from the bulk session
        - completed_on (datetime): the timestamp when the bulk ingest process completed
        - service_tier (str, optional): the service tier of the vendor
    """

    bulk_session_id = fields.String(required=True)
    execution_arn = fields.String(required=False)
    identity_id = fields.String(required=True)
    identity_name = fields.Str(required=True)
    vendor_id = fields.Int(required=False)
    vendor_name = fields.Str(required=True)
    total_products = fields.Int(required=True)
    submitted_products_count = fields.Int(required=True)
    completed_on = fields.DateTime(required=True)
    metadata_file_link = fields.Str(required=True)
    assets_required = fields.Boolean(required=True)
    submit_products = fields.Boolean(required=True)
    service_tier = fields.Str(required=False, allow_none=True)