feat!: change language type to be more strict in magic link options (#137)

Author: ctran88

passageidentity/__init__.py

@@ -12,6 +12,7 @@
     CreateUserArgs,
     MagicLink,
     MagicLinkChannel,
+    MagicLinkLanguage,
     MagicLinkType,
     PassageUser,
     UpdateUserArgs,
@@ -26,6 +27,7 @@
     "MagicLink",
     "MagicLinkArgs",
     "MagicLinkChannel",
+    "MagicLinkLanguage",
     "MagicLinkOptions",
     "MagicLinkType",
     "MagicLinkWithEmailArgs",

passageidentity/models/magic_link_options.py

@@ -2,19 +2,24 @@
 
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from passageidentity.openapi_client.models.magic_link_language import MagicLinkLanguage
+
 
 class MagicLinkOptions:
     """Options for creating a Magic Link."""
 
-    language: str | None
+    language: MagicLinkLanguage | None
     magic_link_path: str | None
     redirect_url: str | None
     ttl: int | None
 
     def __init__(
         self,
         *,
-        language: str | None = None,
+        language: MagicLinkLanguage | None = None,
         magic_link_path: str | None = None,
         redirect_url: str | None = None,
         ttl: int | None = None,

passageidentity/openapi_client/__init__.py

@@ -46,6 +46,7 @@
 from passageidentity.openapi_client.models.list_paginated_users_response import ListPaginatedUsersResponse
 from passageidentity.openapi_client.models.magic_link import MagicLink
 from passageidentity.openapi_client.models.magic_link_channel import MagicLinkChannel
+from passageidentity.openapi_client.models.magic_link_language import MagicLinkLanguage
 from passageidentity.openapi_client.models.magic_link_response import MagicLinkResponse
 from passageidentity.openapi_client.models.magic_link_type import MagicLinkType
 from passageidentity.openapi_client.models.model400_error import Model400Error

passageidentity/openapi_client/models/__init__.py

@@ -26,6 +26,7 @@
 from passageidentity.openapi_client.models.list_paginated_users_response import ListPaginatedUsersResponse
 from passageidentity.openapi_client.models.magic_link import MagicLink
 from passageidentity.openapi_client.models.magic_link_channel import MagicLinkChannel
+from passageidentity.openapi_client.models.magic_link_language import MagicLinkLanguage
 from passageidentity.openapi_client.models.magic_link_response import MagicLinkResponse
 from passageidentity.openapi_client.models.magic_link_type import MagicLinkType
 from passageidentity.openapi_client.models.model400_error import Model400Error

passageidentity/openapi_client/models/create_magic_link_request.py

@@ -18,9 +18,11 @@
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
 from passageidentity.openapi_client.models.magic_link_channel import MagicLinkChannel
+from passageidentity.openapi_client.models.magic_link_language import MagicLinkLanguage
 from passageidentity.openapi_client.models.magic_link_type import MagicLinkType
 from typing import Optional, Set
 from typing_extensions import Self
@@ -31,12 +33,12 @@ class CreateMagicLinkRequest(BaseModel):
     """ # noqa: E501
     channel: Optional[MagicLinkChannel] = None
     email: Optional[StrictStr] = None
-    language: Optional[StrictStr] = Field(default=None, description="language of the email to send (optional)")
+    language: Optional[MagicLinkLanguage] = None
     magic_link_path: Optional[StrictStr] = Field(default=None, description="must be a relative url")
     phone: Optional[StrictStr] = None
     redirect_url: Optional[StrictStr] = None
     send: Optional[StrictBool] = None
-    ttl: Optional[StrictInt] = None
+    ttl: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="time to live in minutes")
     type: Optional[MagicLinkType] = None
     user_id: Optional[StrictStr] = None
     __properties: ClassVar[List[str]] = ["channel", "email", "language", "magic_link_path", "phone", "redirect_url", "send", "ttl", "type", "user_id"]

passageidentity/openapi_client/models/magic_link.py

@@ -18,7 +18,7 @@
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List
 from passageidentity.openapi_client.models.magic_link_type import MagicLinkType
 from typing import Optional, Set
@@ -34,7 +34,7 @@ class MagicLink(BaseModel):
     identifier: StrictStr
     redirect_url: StrictStr
     secret: StrictStr
-    ttl: StrictInt
+    ttl: StrictInt = Field(description="time to live in minutes")
     type: MagicLinkType
     url: StrictStr
     user_id: StrictStr

passageidentity/openapi_client/models/magic_link_channel.py

@@ -21,7 +21,7 @@
 
 class MagicLinkChannel(str, Enum):
     """
-    MagicLinkChannel
+    The channel for magic link delivery: \"email\" or \"phone\". Required if \"send\" is true.
     """
 
     """

passageidentity/openapi_client/models/magic_link_language.py

@@ -0,0 +1,43 @@
+# coding: utf-8
+
+"""
+    Passage Management API
+
+    Passage's management API to manage your Passage apps and users.
+
+    The version of the OpenAPI document: 1
+    Contact: [email protected]
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class MagicLinkLanguage(str, Enum):
+    """
+    language of the email or sms to send
+    """
+
+    """
+    allowed enum values
+    """
+    DE = 'de'
+    EN = 'en'
+    ES = 'es'
+    IT = 'it'
+    PL = 'pl'
+    PT = 'pt'
+    ZH = 'zh'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MagicLinkLanguage from a JSON string"""
+        return cls(json.loads(json_str))
+
+

passageidentity/openapi_client/models/magic_link_type.py

@@ -21,7 +21,7 @@
 
 class MagicLinkType(str, Enum):
     """
-    MagicLinkType
+    The type of magic link to create: \"login\" or \"verify_identifier\". Defaults to \"login\".
     """
 
     """