brevo-python 4.0.1__py3-none-any.whl

brevo/types/get_campaign_stats.py

@@ -0,0 +1,130 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class GetCampaignStats(UncheckedBaseModel):
+    apple_mpp_opens: typing_extensions.Annotated[
+        int,
+        FieldMetadata(alias="appleMppOpens"),
+        pydantic.Field(
+            alias="appleMppOpens",
+            description="Numbers of times your email has been opened automatically through Apple MPP.",
+        ),
+    ]
+    clickers: int = pydantic.Field()
+    """
+    Number of total clicks for the campaign
+    """
+
+    complaints: int = pydantic.Field()
+    """
+    Number of complaints (Spam reports) for the campaign
+    """
+
+    deferred: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of deferred emails for the campaign
+    """
+
+    delivered: int = pydantic.Field()
+    """
+    Number of delivered emails for the campaign
+    """
+
+    estimated_views: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="estimatedViews"),
+        pydantic.Field(
+            alias="estimatedViews",
+            description="Rate of recipients without any privacy protection option enabled in their email client_dev, applied to all delivered emails",
+        ),
+    ] = None
+    hard_bounces: typing_extensions.Annotated[
+        int,
+        FieldMetadata(alias="hardBounces"),
+        pydantic.Field(alias="hardBounces", description="Number of harbounce for the campaign"),
+    ]
+    list_id: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="listId"),
+        pydantic.Field(
+            alias="listId",
+            description="List Id of email campaign (only in case of get email campaign(s)(not for global stats))",
+        ),
+    ] = None
+    opens_rate: typing_extensions.Annotated[
+        float,
+        FieldMetadata(alias="opensRate"),
+        pydantic.Field(
+            alias="opensRate",
+            description="Percentage of recipients who open the email out of your total number of recipients. Depending on your Campaign settings, they may include Apple MPP opens.",
+        ),
+    ]
+    return_bounce: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="returnBounce"),
+        pydantic.Field(
+            alias="returnBounce", description="Total number of non-delivered campaigns for a particular campaign id."
+        ),
+    ] = None
+    sent: int = pydantic.Field()
+    """
+    Number of sent emails for the campaign
+    """
+
+    soft_bounces: typing_extensions.Annotated[
+        int,
+        FieldMetadata(alias="softBounces"),
+        pydantic.Field(alias="softBounces", description="Number of softbounce for the campaign"),
+    ]
+    trackable_views: typing_extensions.Annotated[
+        int,
+        FieldMetadata(alias="trackableViews"),
+        pydantic.Field(
+            alias="trackableViews",
+            description="Recipients without any privacy protection option enabled in their email client_dev",
+        ),
+    ]
+    trackable_views_rate: typing_extensions.Annotated[
+        typing.Optional[float],
+        FieldMetadata(alias="trackableViewsRate"),
+        pydantic.Field(
+            alias="trackableViewsRate",
+            description="Rate of recipients without any privacy protection option enabled in their email client_dev",
+        ),
+    ] = None
+    unique_clicks: typing_extensions.Annotated[
+        int,
+        FieldMetadata(alias="uniqueClicks"),
+        pydantic.Field(alias="uniqueClicks", description="Number of unique clicks for the campaign"),
+    ]
+    unique_views: typing_extensions.Annotated[
+        int,
+        FieldMetadata(alias="uniqueViews"),
+        pydantic.Field(alias="uniqueViews", description="Number of unique openings for the campaign"),
+    ]
+    unsubscriptions: int = pydantic.Field()
+    """
+    Number of unsubscription for the campaign
+    """
+
+    viewed: int = pydantic.Field()
+    """
+    Number of openings for the campaign
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/types/get_category_details.py

@@ -0,0 +1,54 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class GetCategoryDetails(UncheckedBaseModel):
+    created_at: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="createdAt"),
+        pydantic.Field(
+            alias="createdAt", description="Creation UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ)"
+        ),
+    ]
+    id: str = pydantic.Field()
+    """
+    Category ID for which you requested the details
+    """
+
+    is_deleted: typing_extensions.Annotated[
+        bool,
+        FieldMetadata(alias="isDeleted"),
+        pydantic.Field(alias="isDeleted", description="category deleted from the shop's database"),
+    ]
+    modified_at: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="modifiedAt"),
+        pydantic.Field(
+            alias="modifiedAt", description="Last modification UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ)"
+        ),
+    ]
+    name: str = pydantic.Field()
+    """
+    Name of the category for which you requested the details
+    """
+
+    url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL to the category
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/types/get_contact_details.py

@@ -0,0 +1,75 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .get_contact_details_attributes import GetContactDetailsAttributes
+
+
+class GetContactDetails(UncheckedBaseModel):
+    attributes: GetContactDetailsAttributes = pydantic.Field()
+    """
+    Set of attributes of the contact
+    """
+
+    created_at: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="createdAt"),
+        pydantic.Field(
+            alias="createdAt", description="Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)"
+        ),
+    ]
+    email: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Email address of the contact for which you requested the details
+    """
+
+    email_blacklisted: typing_extensions.Annotated[
+        bool,
+        FieldMetadata(alias="emailBlacklisted"),
+        pydantic.Field(
+            alias="emailBlacklisted",
+            description="Blacklist status for email campaigns (true=blacklisted, false=not blacklisted)",
+        ),
+    ]
+    id: int = pydantic.Field()
+    """
+    ID of the contact for which you requested the details
+    """
+
+    list_ids: typing_extensions.Annotated[
+        typing.List[int], FieldMetadata(alias="listIds"), pydantic.Field(alias="listIds")
+    ]
+    list_unsubscribed: typing_extensions.Annotated[
+        typing.Optional[typing.List[int]],
+        FieldMetadata(alias="listUnsubscribed"),
+        pydantic.Field(alias="listUnsubscribed"),
+    ] = None
+    modified_at: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="modifiedAt"),
+        pydantic.Field(
+            alias="modifiedAt", description="Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)"
+        ),
+    ]
+    sms_blacklisted: typing_extensions.Annotated[
+        bool,
+        FieldMetadata(alias="smsBlacklisted"),
+        pydantic.Field(
+            alias="smsBlacklisted",
+            description="Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted)",
+        ),
+    ]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/types/get_contact_details_attributes.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class GetContactDetailsAttributes(UncheckedBaseModel):
+    """
+    Set of attributes of the contact
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/types/get_contacts.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .get_contact_details import GetContactDetails
+
+
+class GetContacts(UncheckedBaseModel):
+    contacts: typing.List[GetContactDetails]
+    count: int = pydantic.Field()
+    """
+    Number of contacts
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/types/get_coupon_collection.py

@@ -0,0 +1,75 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class GetCouponCollection(UncheckedBaseModel):
+    created_at: typing_extensions.Annotated[
+        dt.datetime,
+        FieldMetadata(alias="createdAt"),
+        pydantic.Field(alias="createdAt", description="Datetime on which the collection was created."),
+    ]
+    default_coupon: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="defaultCoupon"),
+        pydantic.Field(alias="defaultCoupon", description="The default coupon of the collection."),
+    ]
+    expiration_date: typing_extensions.Annotated[
+        typing.Optional[dt.datetime],
+        FieldMetadata(alias="expirationDate"),
+        pydantic.Field(
+            alias="expirationDate", description="Expiration date for the coupon collection in RFC3339 format."
+        ),
+    ] = None
+    id: str = pydantic.Field()
+    """
+    The id of the collection.
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name of the collection.
+    """
+
+    remaining_coupons: typing_extensions.Annotated[
+        int,
+        FieldMetadata(alias="remainingCoupons"),
+        pydantic.Field(alias="remainingCoupons", description="Number of coupons that have not been sent yet."),
+    ]
+    remaining_coupons_alert: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="remainingCouponsAlert"),
+        pydantic.Field(
+            alias="remainingCouponsAlert",
+            description="If present, an email notification is going to be sent when the total number of available coupons falls below the defined threshold.",
+        ),
+    ] = None
+    remaining_days_alert: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="remainingDaysAlert"),
+        pydantic.Field(
+            alias="remainingDaysAlert",
+            description="If present, an email notification is going to be sent the defined amount of days before to the expiration date.",
+        ),
+    ] = None
+    total_coupons: typing_extensions.Annotated[
+        int,
+        FieldMetadata(alias="totalCoupons"),
+        pydantic.Field(alias="totalCoupons", description="Total number of coupons in the collection."),
+    ]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/types/get_device_browser_stats.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class GetDeviceBrowserStats(UncheckedBaseModel):
+    clickers: int = pydantic.Field()
+    """
+    Number of total clicks for the campaign using the particular browser
+    """
+
+    unique_clicks: typing_extensions.Annotated[
+        int,
+        FieldMetadata(alias="uniqueClicks"),
+        pydantic.Field(
+            alias="uniqueClicks", description="Number of unique clicks for the campaign using the particular browser"
+        ),
+    ]
+    unique_views: typing_extensions.Annotated[
+        int,
+        FieldMetadata(alias="uniqueViews"),
+        pydantic.Field(
+            alias="uniqueViews", description="Number of unique openings for the campaign using the particular browser"
+        ),
+    ]
+    viewed: int = pydantic.Field()
+    """
+    Number of openings for the campaign using the particular browser
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/types/get_extended_campaign_overview.py

@@ -0,0 +1,230 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .get_extended_campaign_overview_sender import GetExtendedCampaignOverviewSender
+from .get_extended_campaign_overview_status import GetExtendedCampaignOverviewStatus
+from .get_extended_campaign_overview_type import GetExtendedCampaignOverviewType
+
+
+class GetExtendedCampaignOverview(UncheckedBaseModel):
+    ab_testing: typing_extensions.Annotated[
+        typing.Optional[bool],
+        FieldMetadata(alias="abTesting"),
+        pydantic.Field(
+            alias="abTesting",
+            description="Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.",
+        ),
+    ] = None
+    id: int = pydantic.Field()
+    """
+    ID of the campaign
+    """
+
+    name: str = pydantic.Field()
+    """
+    Name of the campaign
+    """
+
+    preview_text: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="previewText"),
+        pydantic.Field(alias="previewText", description="Preview text or preheader of the email campaign"),
+    ] = None
+    scheduled_at: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="scheduledAt"),
+        pydantic.Field(
+            alias="scheduledAt", description="UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)"
+        ),
+    ] = None
+    send_at_best_time: typing_extensions.Annotated[
+        typing.Optional[bool],
+        FieldMetadata(alias="sendAtBestTime"),
+        pydantic.Field(
+            alias="sendAtBestTime",
+            description="It is true if you have chosen to send your campaign at best time, otherwise it is false",
+        ),
+    ] = None
+    split_rule: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="splitRule"),
+        pydantic.Field(
+            alias="splitRule",
+            description="The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`",
+        ),
+    ] = None
+    status: GetExtendedCampaignOverviewStatus = pydantic.Field()
+    """
+    Status of the campaign
+    """
+
+    subject: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`
+    """
+
+    subject_a: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="subjectA"),
+        pydantic.Field(
+            alias="subjectA",
+            description="Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`",
+        ),
+    ] = None
+    subject_b: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="subjectB"),
+        pydantic.Field(
+            alias="subjectB",
+            description="Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`",
+        ),
+    ] = None
+    type: GetExtendedCampaignOverviewType = pydantic.Field()
+    """
+    Type of campaign
+    """
+
+    winner_criteria: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="winnerCriteria"),
+        pydantic.Field(
+            alias="winnerCriteria",
+            description="Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true`",
+        ),
+    ] = None
+    winner_delay: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="winnerDelay"),
+        pydantic.Field(
+            alias="winnerDelay",
+            description="The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true`",
+        ),
+    ] = None
+    created_at: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="createdAt"),
+        pydantic.Field(
+            alias="createdAt", description="Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)"
+        ),
+    ]
+    footer: str = pydantic.Field()
+    """
+    Footer of the campaign
+    """
+
+    header: str = pydantic.Field()
+    """
+    Header of the campaign
+    """
+
+    html_content: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="htmlContent"),
+        pydantic.Field(alias="htmlContent", description="HTML content of the campaign"),
+    ]
+    inline_image_activation: typing_extensions.Annotated[
+        typing.Optional[bool],
+        FieldMetadata(alias="inlineImageActivation"),
+        pydantic.Field(
+            alias="inlineImageActivation",
+            description="Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email.",
+        ),
+    ] = None
+    mirror_active: typing_extensions.Annotated[
+        typing.Optional[bool],
+        FieldMetadata(alias="mirrorActive"),
+        pydantic.Field(
+            alias="mirrorActive",
+            description="Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign",
+        ),
+    ] = None
+    modified_at: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="modifiedAt"),
+        pydantic.Field(
+            alias="modifiedAt",
+            description="UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)",
+        ),
+    ]
+    recurring: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
+    """
+
+    reply_to: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="replyTo"),
+        pydantic.Field(alias="replyTo", description='Email defined as the "Reply to" of the campaign'),
+    ]
+    return_bounce: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="returnBounce"),
+        pydantic.Field(
+            alias="returnBounce", description="Total number of non-delivered campaigns for a particular campaign id."
+        ),
+    ] = None
+    sender: GetExtendedCampaignOverviewSender
+    sent_date: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="sentDate"),
+        pydantic.Field(
+            alias="sentDate",
+            description="Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'",
+        ),
+    ] = None
+    share_link: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="shareLink"),
+        pydantic.Field(alias="shareLink", description="Link to share the campaign on social medias"),
+    ] = None
+    tag: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Tag of the campaign
+    """
+
+    test_sent: typing_extensions.Annotated[
+        bool,
+        FieldMetadata(alias="testSent"),
+        pydantic.Field(
+            alias="testSent",
+            description="Retrieved the status of test email sending. (true=Test email has been sent  false=Test email has not been sent)",
+        ),
+    ]
+    to_field: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="toField"),
+        pydantic.Field(alias="toField", description='Customisation of the "to" field of the campaign'),
+    ] = None
+    utm_campaign_value: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="utmCampaignValue"),
+        pydantic.Field(alias="utmCampaignValue", description="utm parameter associated with campaign"),
+    ] = None
+    utm_id_active: typing_extensions.Annotated[
+        typing.Optional[bool],
+        FieldMetadata(alias="utmIDActive"),
+        pydantic.Field(alias="utmIDActive", description="utm id active"),
+    ] = None
+    utm_medium: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="utmMedium"), pydantic.Field(alias="utmMedium")
+    ] = None
+    utm_source: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="utmSource"),
+        pydantic.Field(alias="utmSource", description="source of utm"),
+    ] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/types/get_extended_campaign_overview_sender.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class GetExtendedCampaignOverviewSender(UncheckedBaseModel):
+    email: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sender email of the campaign
+    """
+
+    id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Sender id of the campaign
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sender name of the campaign
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow