"""Bulk ingest success schema."""

from marshmallow import Schema, fields


class BulkIngestBegin(Schema):
    """Schema for bulk ingest started notification.

    Properties:
        - bulk_session_id (str): the ID of the bulk session
        - execution_arn (str): the execution ARN of the bulk session ingestion
        - vendor_id (int): the ID of the vendor associated with the bulk session
        - 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
        - service_tier (str, optional): the service tier of the vendor
    """

    bulk_session_id = fields.String(required=True)
    execution_arn = fields.String(required=True)
    vendor_id = fields.Int(required=True)
    vendor_name = fields.Str(required=True)
    total_products = fields.Int(required=True)
    service_tier = fields.Str(required=False, allow_none=True)