celitech-sdk 1.3.63__tar.gz → 2.0.0__tar.gz

{celitech_sdk-1.3.63/src/celitech_sdk.egg-info → celitech_sdk-2.0.0}/PKG-INFO

@@ -1,24 +1,24 @@
 Metadata-Version: 2.4
 Name: celitech-sdk
-Version: 1.3.63
+Version: 2.0.0
 Summary: Welcome to the CELITECH API documentation!
 License: MIT
+Project-URL: Repository, https://github.com/Celitech/CelitechSDKPython
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests>=2.31.0
+Requires-Dist: pydantic<3.0.0,>=2.0.0
 Dynamic: license-file
 
-# Celitech Python SDK 1.3.63<a id="celitech-python-sdk-1363"></a>
+# Celitech Python SDK 2.0.0<a id="celitech-python-sdk-200"></a>
 
 Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
 
-[![This SDK was generated by liblab](https://raw.githubusercontent.com/liblaber/liblab-assets/main/assets/built-by-liblab-icon.svg)](https://liblab.com/?utm_source=readme)
-
 ## Versions<a id="versions"></a>
 
-- API version: `1.3.63`
-- SDK version: `1.3.63`
+- API version: `2.0.0`
+- SDK version: `2.0.0`
 
 ## About the API<a id="about-the-api"></a>
 
@@ -64,9 +64,9 @@ pip3 install celitech-sdk
 
 ### OAuth Authentication<a id="oauth-authentication"></a>
 
-The Celitech API uses OAuth for authentication.
+The Celitech API uses OAuth 2.0 for authentication.
 
-You need to provide the OAuth parameters when initializing the SDK.
+You need to provide your OAuth credentials when initializing the SDK. Tokens are automatically fetched, cached, and refreshed — you do not need to manage them yourself.
 
 ```py
 sdk = Celitech(
@@ -75,7 +75,7 @@ sdk = Celitech(
 )
 ```
 
-If you need to set or update the OAuth parameters after the SDK initialization, you can use:
+If you need to set or update the OAuth credentials after the SDK initialization, you can use:
 
 ```py
 sdk.set_client_id("CLIENT_ID")
@@ -186,6 +186,7 @@ The SDK includes several models that represent the data structures used in API r
 | GetEsimDeviceOkResponse          |             |
 | GetEsimHistoryOkResponse         |             |
 | TokenOkResponse                  |             |
+| GrantType                        |             |
 | BadRequest                       |             |
 | Unauthorized                     |             |
 

{celitech_sdk-1.3.63 → celitech_sdk-2.0.0}/PyPI_README.md

@@ -1,13 +1,11 @@
-# Celitech Python SDK 1.3.63<a id="celitech-python-sdk-1363"></a>
+# Celitech Python SDK 2.0.0<a id="celitech-python-sdk-200"></a>
 
 Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
 
-[![This SDK was generated by liblab](https://raw.githubusercontent.com/liblaber/liblab-assets/main/assets/built-by-liblab-icon.svg)](https://liblab.com/?utm_source=readme)
-
 ## Versions<a id="versions"></a>
 
-- API version: `1.3.63`
-- SDK version: `1.3.63`
+- API version: `2.0.0`
+- SDK version: `2.0.0`
 
 ## About the API<a id="about-the-api"></a>
 
@@ -53,9 +51,9 @@ pip3 install celitech-sdk
 
 ### OAuth Authentication<a id="oauth-authentication"></a>
 
-The Celitech API uses OAuth for authentication.
+The Celitech API uses OAuth 2.0 for authentication.
 
-You need to provide the OAuth parameters when initializing the SDK.
+You need to provide your OAuth credentials when initializing the SDK. Tokens are automatically fetched, cached, and refreshed — you do not need to manage them yourself.
 
 ```py
 sdk = Celitech(
@@ -64,7 +62,7 @@ sdk = Celitech(
 )
 ```
 
-If you need to set or update the OAuth parameters after the SDK initialization, you can use:
+If you need to set or update the OAuth credentials after the SDK initialization, you can use:
 
 ```py
 sdk.set_client_id("CLIENT_ID")
@@ -175,6 +173,7 @@ The SDK includes several models that represent the data structures used in API r
 | GetEsimDeviceOkResponse          |             |
 | GetEsimHistoryOkResponse         |             |
 | TokenOkResponse                  |             |
+| GrantType                        |             |
 | BadRequest                       |             |
 | Unauthorized                     |             |
 

{celitech_sdk-1.3.63 → celitech_sdk-2.0.0}/README.md

@@ -1,13 +1,11 @@
-# Celitech Python SDK 1.3.63
+# Celitech Python SDK 2.0.0
 
 Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
 
-[![This SDK was generated by liblab](https://raw.githubusercontent.com/liblaber/liblab-assets/main/assets/built-by-liblab-icon.svg)](https://liblab.com/?utm_source=readme)
-
 ## Versions
 
-- API version: `1.3.63`
-- SDK version: `1.3.63`
+- API version: `2.0.0`
+- SDK version: `2.0.0`
 
 ## About the API
 
@@ -54,9 +52,9 @@ pip3 install celitech-sdk
 
 ### OAuth Authentication
 
-The Celitech API uses OAuth for authentication.
+The Celitech API uses OAuth 2.0 for authentication.
 
-You need to provide the OAuth parameters when initializing the SDK.
+You need to provide your OAuth credentials when initializing the SDK. Tokens are automatically fetched, cached, and refreshed — you do not need to manage them yourself.
 
 ```py
 sdk = Celitech(
@@ -65,7 +63,7 @@ sdk = Celitech(
 )
 ```
 
-If you need to set or update the OAuth parameters after the SDK initialization, you can use:
+If you need to set or update the OAuth credentials after the SDK initialization, you can use:
 
 ```py
 sdk.set_client_id("CLIENT_ID")
@@ -176,6 +174,7 @@ The SDK includes several models that represent the data structures used in API r
 | [GetEsimDeviceOkResponse](documentation/models/GetEsimDeviceOkResponse.md)                   |             |
 | [GetEsimHistoryOkResponse](documentation/models/GetEsimHistoryOkResponse.md)                 |             |
 | [TokenOkResponse](documentation/models/TokenOkResponse.md)                                   |             |
+| [GrantType](documentation/models/GrantType.md)                                               |             |
 | [BadRequest](documentation/models/BadRequest.md)                                             |             |
 | [Unauthorized](documentation/models/Unauthorized.md)                                         |             |
 

{celitech_sdk-1.3.63 → celitech_sdk-2.0.0}/pyproject.toml

@@ -4,11 +4,15 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "celitech-sdk"
-version = "1.3.63"
+version = "2.0.0"
 license = { text = "MIT" }
 description = """Welcome to the CELITECH API documentation!\n\nUseful links: [Homepage](https://www.celitech.com) | [Support email](mailto:support@celitech.com) | [Blog](https://www.celitech.com/blog/)\n"""
 readme = "PyPI_README.md"
 requires-python = ">=3.9"
 dependencies = [
-    "requests>=2.31.0"
+    "requests>=2.31.0",
+    "pydantic>=2.0.0,<3.0.0"
 ]
+
+[project.urls]
+Repository = "https://github.com/Celitech/CelitechSDKPython"

celitech_sdk-2.0.0/src/celitech/models/__init__.py

@@ -0,0 +1,75 @@
+from .list_destinations_ok_response import ListDestinationsOkResponse, Destinations
+from .list_packages_ok_response import ListPackagesOkResponse, Packages
+from .create_purchase_v2_request import (
+    CreatePurchaseV2Request,
+    CreatePurchaseV2RequestLanguage,
+)
+from .create_purchase_v2_ok_response import (
+    CreatePurchaseV2OkResponse,
+    CreatePurchaseV2OkResponsePurchase,
+    CreatePurchaseV2OkResponseProfile,
+)
+from .list_purchases_ok_response import ListPurchasesOkResponse, Purchases
+from .create_purchase_request import (
+    CreatePurchaseRequest,
+    CreatePurchaseRequestLanguage,
+)
+from .create_purchase_ok_response import (
+    CreatePurchaseOkResponse,
+    CreatePurchaseOkResponsePurchase,
+    CreatePurchaseOkResponseProfile,
+)
+from .top_up_esim_request import TopUpEsimRequest
+from .top_up_esim_ok_response import (
+    TopUpEsimOkResponse,
+    TopUpEsimOkResponsePurchase,
+    TopUpEsimOkResponseProfile,
+)
+from .edit_purchase_request import EditPurchaseRequest
+from .edit_purchase_ok_response import EditPurchaseOkResponse
+from .get_purchase_consumption_ok_response import GetPurchaseConsumptionOkResponse
+from .get_esim_ok_response import GetEsimOkResponse, GetEsimOkResponseEsim
+from .get_esim_device_ok_response import GetEsimDeviceOkResponse, Device
+from .get_esim_history_ok_response import (
+    GetEsimHistoryOkResponse,
+    GetEsimHistoryOkResponseEsim,
+)
+from .token_ok_response import TokenOkResponse
+from .o_auth_token_request import OAuthTokenRequest
+from .o_auth_token_response import OAuthTokenResponse
+from .grant_type import GrantType
+from .bad_request import BadRequest
+from .unauthorized import Unauthorized
+
+# Rebuild models to resolve circular forward references
+# This ensures Pydantic can properly validate models that reference each other
+ListDestinationsOkResponse.model_rebuild()
+Destinations.model_rebuild()
+ListPackagesOkResponse.model_rebuild()
+Packages.model_rebuild()
+CreatePurchaseV2Request.model_rebuild()
+CreatePurchaseV2OkResponse.model_rebuild()
+CreatePurchaseV2OkResponsePurchase.model_rebuild()
+CreatePurchaseV2OkResponseProfile.model_rebuild()
+ListPurchasesOkResponse.model_rebuild()
+Purchases.model_rebuild()
+CreatePurchaseRequest.model_rebuild()
+CreatePurchaseOkResponse.model_rebuild()
+CreatePurchaseOkResponsePurchase.model_rebuild()
+CreatePurchaseOkResponseProfile.model_rebuild()
+TopUpEsimRequest.model_rebuild()
+TopUpEsimOkResponse.model_rebuild()
+TopUpEsimOkResponsePurchase.model_rebuild()
+TopUpEsimOkResponseProfile.model_rebuild()
+EditPurchaseRequest.model_rebuild()
+EditPurchaseOkResponse.model_rebuild()
+GetPurchaseConsumptionOkResponse.model_rebuild()
+GetEsimOkResponse.model_rebuild()
+GetEsimOkResponseEsim.model_rebuild()
+GetEsimDeviceOkResponse.model_rebuild()
+Device.model_rebuild()
+GetEsimHistoryOkResponse.model_rebuild()
+GetEsimHistoryOkResponseEsim.model_rebuild()
+TokenOkResponse.model_rebuild()
+OAuthTokenRequest.model_rebuild()
+OAuthTokenResponse.model_rebuild()

celitech_sdk-2.0.0/src/celitech/models/bad_request.py

@@ -0,0 +1,26 @@
+from pydantic import Field
+from typing import Optional
+from .utils.base_error import BaseError
+from .utils.base_model import BaseModel
+
+
+# Pydantic validation model for BadRequest
+class BadRequestData(BaseModel):
+    """BadRequest
+
+    :param message: Message of the error, defaults to None
+    :type message: str, optional
+    """
+
+    message: Optional[str] = Field(default=None, description="Message of the error")
+
+
+# Error exception class
+class BadRequest(BaseError):
+    """BadRequest
+
+    :param message: Message of the error, defaults to None
+    :type message: str, optional
+    """
+
+    _model_class = BadRequestData

celitech_sdk-2.0.0/src/celitech/models/create_purchase_ok_response.py

@@ -0,0 +1,99 @@
+from pydantic import Field
+from typing import Optional
+from typing import Union
+from .utils.base_model import BaseModel
+
+
+class CreatePurchaseOkResponsePurchase(BaseModel):
+    """CreatePurchaseOkResponsePurchase
+
+    :param id_: ID of the purchase
+    :type id_: str
+    :param package_id: ID of the package
+    :type package_id: str
+    :param start_date: Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
+    :type start_date: str
+    :param end_date: End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
+    :type end_date: str
+    :param created_date: Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
+    :type created_date: str
+    :param start_time: Epoch value representing the start time of the package's validity, defaults to None
+    :type start_time: float, optional
+    :param end_time: Epoch value representing the end time of the package's validity, defaults to None
+    :type end_time: float, optional
+    """
+
+    id_: str = Field(
+        alias="id", serialization_alias="id", description="ID of the purchase"
+    )
+    package_id: str = Field(
+        alias="packageId",
+        serialization_alias="packageId",
+        description="ID of the package",
+    )
+    start_date: Optional[str] = Field(
+        alias="startDate",
+        serialization_alias="startDate",
+        description="Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'",
+    )
+    end_date: Optional[str] = Field(
+        alias="endDate",
+        serialization_alias="endDate",
+        description="End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'",
+    )
+    created_date: str = Field(
+        alias="createdDate",
+        serialization_alias="createdDate",
+        description="Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'",
+    )
+    start_time: Optional[float] = Field(
+        alias="startTime",
+        serialization_alias="startTime",
+        default=None,
+        description="Epoch value representing the start time of the package's validity",
+    )
+    end_time: Optional[float] = Field(
+        alias="endTime",
+        serialization_alias="endTime",
+        default=None,
+        description="Epoch value representing the end time of the package's validity",
+    )
+
+
+class CreatePurchaseOkResponseProfile(BaseModel):
+    """CreatePurchaseOkResponseProfile
+
+    :param iccid: ID of the eSIM
+    :type iccid: str
+    :param activation_code: QR Code of the eSIM as base64
+    :type activation_code: str
+    :param manual_activation_code: Manual Activation Code of the eSIM
+    :type manual_activation_code: str
+    """
+
+    iccid: str = Field(description="ID of the eSIM", min_length=18, max_length=22)
+    activation_code: str = Field(
+        alias="activationCode",
+        serialization_alias="activationCode",
+        description="QR Code of the eSIM as base64",
+        min_length=1000,
+        max_length=8000,
+    )
+    manual_activation_code: str = Field(
+        alias="manualActivationCode",
+        serialization_alias="manualActivationCode",
+        description="Manual Activation Code of the eSIM",
+    )
+
+
+class CreatePurchaseOkResponse(BaseModel):
+    """CreatePurchaseOkResponse
+
+    :param purchase: purchase
+    :type purchase: CreatePurchaseOkResponsePurchase
+    :param profile: profile
+    :type profile: CreatePurchaseOkResponseProfile
+    """
+
+    purchase: CreatePurchaseOkResponsePurchase
+    profile: CreatePurchaseOkResponseProfile

celitech_sdk-2.0.0/src/celitech/models/create_purchase_request.py

@@ -0,0 +1,122 @@
+from enum import Enum
+from pydantic import Field
+from typing import Optional
+from .utils.base_model import BaseModel
+
+
+class CreatePurchaseRequestLanguage(str, Enum):
+    """An enumeration representing different categories.
+
+    :cvar EN: "en"
+    :vartype EN: str
+    :cvar ES: "es"
+    :vartype ES: str
+    :cvar FR: "fr"
+    :vartype FR: str
+    :cvar DE: "de"
+    :vartype DE: str
+    :cvar PTBR: "pt-br"
+    :vartype PTBR: str
+    """
+
+    EN = "en"
+    ES = "es"
+    FR = "fr"
+    DE = "de"
+    PTBR = "pt-br"
+
+    @staticmethod
+    def list():
+        """Lists all enum values.
+
+        :return: A list of all enum values.
+        :rtype: list
+        """
+        return list(
+            map(lambda x: x.value, CreatePurchaseRequestLanguage._member_map_.values())
+        )
+
+
+class CreatePurchaseRequest(BaseModel):
+    """CreatePurchaseRequest
+
+    :param destination: ISO representation of the package's destination. Supports both ISO2 (e.g., 'FR') and ISO3 (e.g., 'FRA') country codes.
+    :type destination: str
+    :param data_limit_in_gb: Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20, 50GB
+    :type data_limit_in_gb: float
+    :param start_date: Start date of the package's validity in the format 'yyyy-MM-dd'. This date can be set to the current day or any day within the next 12 months.
+    :type start_date: str
+    :param end_date: End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 90 days after Start date.
+    :type end_date: str
+    :param email: Email address where the purchase confirmation email will be sent (including QR Code & activation steps), defaults to None
+    :type email: str, optional
+    :param reference_id: An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes., defaults to None
+    :type reference_id: str, optional
+    :param network_brand: Customize the network brand of the issued eSIM. The `networkBrand` parameter cannot exceed 15 characters in length and must contain only letters, numbers, dots (.), ampersands (&), and spaces. This feature is available to platforms with Diamond tier only., defaults to None
+    :type network_brand: str, optional
+    :param email_brand: Customize the email subject brand. The `emailBrand` parameter cannot exceed 25 characters in length and must contain only letters, numbers, and spaces. This feature is available to platforms with Diamond tier only., defaults to None
+    :type email_brand: str, optional
+    :param language: Language of the confirmation email sent to the customer., defaults to None
+    :type language: CreatePurchaseRequestLanguage, optional
+    :param start_time: Epoch value representing the start time of the package's validity. This timestamp can be set to the current time or any time within the next 12 months., defaults to None
+    :type start_time: float, optional
+    :param end_time: Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time., defaults to None
+    :type end_time: float, optional
+    """
+
+    destination: str = Field(
+        description="ISO representation of the package's destination. Supports both ISO2 (e.g., 'FR') and ISO3 (e.g., 'FRA') country codes."
+    )
+    data_limit_in_gb: float = Field(
+        alias="dataLimitInGB",
+        serialization_alias="dataLimitInGB",
+        description="Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20, 50GB",
+    )
+    start_date: str = Field(
+        alias="startDate",
+        serialization_alias="startDate",
+        description="Start date of the package's validity in the format 'yyyy-MM-dd'. This date can be set to the current day or any day within the next 12 months.",
+    )
+    end_date: str = Field(
+        alias="endDate",
+        serialization_alias="endDate",
+        description="End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 90 days after Start date.",
+    )
+    email: Optional[str] = Field(
+        default=None,
+        description="Email address where the purchase confirmation email will be sent (including QR Code & activation steps)",
+    )
+    reference_id: Optional[str] = Field(
+        alias="referenceId",
+        serialization_alias="referenceId",
+        default=None,
+        description="An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.",
+    )
+    network_brand: Optional[str] = Field(
+        alias="networkBrand",
+        serialization_alias="networkBrand",
+        default=None,
+        description="Customize the network brand of the issued eSIM. The `networkBrand` parameter cannot exceed 15 characters in length and must contain only letters, numbers, dots (.), ampersands (&), and spaces. This feature is available to platforms with Diamond tier only.",
+    )
+    email_brand: Optional[str] = Field(
+        alias="emailBrand",
+        serialization_alias="emailBrand",
+        default=None,
+        description="Customize the email subject brand. The `emailBrand` parameter cannot exceed 25 characters in length and must contain only letters, numbers, and spaces. This feature is available to platforms with Diamond tier only.",
+    )
+    language: Optional[CreatePurchaseRequestLanguage] = Field(
+        default=None,
+        description="Language of the confirmation email sent to the customer.",
+    )
+    start_time: Optional[float] = Field(
+        alias="startTime",
+        serialization_alias="startTime",
+        default=None,
+        description="Epoch value representing the start time of the package's validity. This timestamp can be set to the current time or any time within the next 12 months.",
+    )
+    end_time: Optional[float] = Field(
+        alias="endTime",
+        serialization_alias="endTime",
+        default=None,
+        description="Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time.",
+    )

celitech_sdk-2.0.0/src/celitech/models/create_purchase_v2_ok_response.py

@@ -0,0 +1,82 @@
+from pydantic import Field
+from typing import Optional
+from .utils.base_model import BaseModel
+
+
+class CreatePurchaseV2OkResponsePurchase(BaseModel):
+    """CreatePurchaseV2OkResponsePurchase
+
+    :param id_: ID of the purchase
+    :type id_: str
+    :param package_id: ID of the package
+    :type package_id: str
+    :param created_date: Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
+    :type created_date: str
+    """
+
+    id_: str = Field(
+        alias="id", serialization_alias="id", description="ID of the purchase"
+    )
+    package_id: str = Field(
+        alias="packageId",
+        serialization_alias="packageId",
+        description="ID of the package",
+    )
+    created_date: str = Field(
+        alias="createdDate",
+        serialization_alias="createdDate",
+        description="Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'",
+    )
+
+
+class CreatePurchaseV2OkResponseProfile(BaseModel):
+    """CreatePurchaseV2OkResponseProfile
+
+    :param iccid: ID of the eSIM
+    :type iccid: str
+    :param activation_code: QR Code of the eSIM as base64
+    :type activation_code: str
+    :param manual_activation_code: Manual Activation Code of the eSIM
+    :type manual_activation_code: str
+    :param ios_activation_link: iOS Activation Link of the eSIM
+    :type ios_activation_link: str
+    :param android_activation_link: Android Activation Link of the eSIM
+    :type android_activation_link: str
+    """
+
+    iccid: str = Field(description="ID of the eSIM", min_length=18, max_length=22)
+    activation_code: str = Field(
+        alias="activationCode",
+        serialization_alias="activationCode",
+        description="QR Code of the eSIM as base64",
+        min_length=1000,
+        max_length=8000,
+    )
+    manual_activation_code: str = Field(
+        alias="manualActivationCode",
+        serialization_alias="manualActivationCode",
+        description="Manual Activation Code of the eSIM",
+    )
+    ios_activation_link: str = Field(
+        alias="iosActivationLink",
+        serialization_alias="iosActivationLink",
+        description="iOS Activation Link of the eSIM",
+    )
+    android_activation_link: str = Field(
+        alias="androidActivationLink",
+        serialization_alias="androidActivationLink",
+        description="Android Activation Link of the eSIM",
+    )
+
+
+class CreatePurchaseV2OkResponse(BaseModel):
+    """CreatePurchaseV2OkResponse
+
+    :param purchase: purchase
+    :type purchase: CreatePurchaseV2OkResponsePurchase
+    :param profile: profile
+    :type profile: CreatePurchaseV2OkResponseProfile
+    """
+
+    purchase: CreatePurchaseV2OkResponsePurchase
+    profile: CreatePurchaseV2OkResponseProfile