Welcome to the CELITECH API documentation! Useful links: [Homepage](https://www.celitech.com) | [Support email](mailto:support@celitech.com) | [Blog](https://www.celitech.com/blog/)
Readme
A Python SDK for Celitech.
Welcome to the CELITECH API documentation! Useful links: Homepage | Support email | Blog
pip install celitech-sdk
You will need the following environment variables in order to access all the features of this SDK:
| Name | Description |
|---|---|
| CLIENT_ID | Client ID parameter |
| CLIENT_SECRET | Client Secret parameter |
You can set these environment variables on the command line or you can use whatever tooling your project has in place to manage environment variables. If you are using a .env file, we have provided a template with the variable names in the .env.example file in the same directory as this readme.
A list of all SDK services. Click on the service name to access its corresponding service methods.
| Service |
|---|
| DestinationsService |
| PackagesService |
| PurchasesService |
| ESimService |
A list of all methods in the DestinationsService service. Click on the method name to view detailed information about that method.
| Methods | Description |
|---|---|
| list_destinations | Name of the destinations |
Name of the destinations
GET/destinationsParameters
| Name | Type | Required | Description |
|---|
Return Type
ListDestinationsOkResponse
Example Usage Code Snippet
from celitech import Celitech, Environment
sdk = Celitech(
base_url=Environment.DEFAULT.value
)
result = sdk.destinations.list_destinations()
print(result)
A list of all methods in the PackagesService service. Click on the method name to view detailed information about that method.
| Methods | Description |
|---|---|
| list_packages | List of available packages |
List of available packages
GET/packagesParameters
| Name | Type | Required | Description |
|---|---|---|---|
| destination | str | ❌ | List of available packages |
| start_date | str | ❌ | List of available packages |
| end_date | str | ❌ | List of available packages |
| after_cursor | str | ❌ | List of available packages |
| limit | float | ❌ | List of available packages |
| start_time | int | ❌ | List of available packages |
| end_time | int | ❌ | List of available packages |
| duration | float | ❌ | List of available packages |
Return Type
ListPackagesOkResponse
Example Usage Code Snippet
from celitech import Celitech, Environment
sdk = Celitech(
base_url=Environment.DEFAULT.value
)
result = sdk.packages.list_packages(
destination="FRA",
start_date="2023-11-01",
end_date="2023-11-20",
after_cursor="Y3JlYXRlZEF0OjE1OTk0OTMwOTgsZGVzdGluYXRpb246QVVTLG1pbkRheXM6MCxkYXRhTGltaXRJbkJ5dGVzOjUzNjg3MDkxMjA",
limit=20
)
print(result)
A list of all methods in the PurchasesService service. Click on the method name to view detailed information about that method.
| Methods | Description |
|---|---|
| list_purchases | This endpoint can be used to list all the successful purchases made between a given interval. |
| create_purchase | This endpoint is used to purchase a new eSIM by providing the package details. |
| top_up_esim | This endpoint is used to top-up an eSIM with the previously associated destination by providing an existing ICCID and the package details. The top-up is not feasible for eSIMs in "DELETED" or "ERROR" state. |
| edit_purchase | This endpoint allows you to modify the dates of an existing package with a future activation start time. Editing can only be performed for packages that have not been activated, and it cannot change the package size. The modification must not change the package duration category to ensure pricing consistency. |
| get_purchase_consumption | This endpoint can be called for consumption notifications (e.g. every 1 hour or when the user clicks a button). It returns the data balance (consumption) of purchased packages. |
This endpoint can be used to list all the successful purchases made between a given interval.
GET/purchasesParameters
| Name | Type | Required | Description |
|---|---|---|---|
| iccid | str | ❌ | This endpoint can be used to list all the successful purchases made between a given interval. |
| after_date | str | ❌ | This endpoint can be used to list all the successful purchases made between a given interval. |
| before_date | str | ❌ | This endpoint can be used to list all the successful purchases made between a given interval. |
| after_cursor | str | ❌ | This endpoint can be used to list all the successful purchases made between a given interval. |
| limit | float | ❌ | This endpoint can be used to list all the successful purchases made between a given interval. |
| after | float | ❌ | This endpoint can be used to list all the successful purchases made between a given interval. |
| before | float | ❌ | This endpoint can be used to list all the successful purchases made between a given interval. |
Return Type
ListPurchasesOkResponse
Example Usage Code Snippet
from celitech import Celitech, Environment
sdk = Celitech(
base_url=Environment.DEFAULT.value
)
result = sdk.purchases.list_purchases(
iccid="1111222233334444555",
after_date="2023-11-01",
before_date="2023-11-20",
after_cursor="Y3JlYXRlZEF0OjE1OTk0OTMwOTgsZGVzdGluYXRpb246QVVTLG1pbkRheXM6MCxkYXRhTGltaXRJbkJ5dGVzOjUzNjg3MDkxMjA",
limit=20
)
print(result)
This endpoint is used to purchase a new eSIM by providing the package details.
POST/purchasesParameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_body | CreatePurchaseRequest | ❌ | The request body. |
Return Type
CreatePurchaseOkResponse
Example Usage Code Snippet
from celitech import Celitech, Environment
from celitech.models import CreatePurchaseRequest
sdk = Celitech(
base_url=Environment.DEFAULT.value
)
request_body = CreatePurchaseRequest(
destination="FRA",
data_limit_in_gb=1,
start_date="2023-11-01",
end_date="2023-11-20",
email="example@domain.com",
network_brand="CELITECH",
start_time=0.16,
end_time=0.96
)
result = sdk.purchases.create_purchase(request_body=request_body)
print(result)
This endpoint is used to top-up an eSIM with the previously associated destination by providing an existing ICCID and the package details. The top-up is not feasible for eSIMs in "DELETED" or "ERROR" state.
POST/purchases/topupParameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_body | TopUpEsimRequest | ❌ | The request body. |
Return Type
TopUpEsimOkResponse
Example Usage Code Snippet
from celitech import Celitech, Environment
from celitech.models import TopUpEsimRequest
sdk = Celitech(
base_url=Environment.DEFAULT.value
)
request_body = TopUpEsimRequest(
iccid="1111222233334444555",
data_limit_in_gb=1,
start_date="2023-11-01",
end_date="2023-11-20",
email="example@domain.com",
start_time=2.14,
end_time=9.34
)
result = sdk.purchases.top_up_esim(request_body=request_body)
print(result)
This endpoint allows you to modify the dates of an existing package with a future activation start time. Editing can only be performed for packages that have not been activated, and it cannot change the package size. The modification must not change the package duration category to ensure pricing consistency.
POST/purchases/editParameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_body | EditPurchaseRequest | ❌ | The request body. |
Return Type
EditPurchaseOkResponse
Example Usage Code Snippet
from celitech import Celitech, Environment
from celitech.models import EditPurchaseRequest
sdk = Celitech(
base_url=Environment.DEFAULT.value
)
request_body = EditPurchaseRequest(
purchase_id="ae471106-c8b4-42cf-b83a-b061291f2922",
start_date="2023-11-01",
end_date="2023-11-20",
start_time=8.29,
end_time=0.24
)
result = sdk.purchases.edit_purchase(request_body=request_body)
print(result)
This endpoint can be called for consumption notifications (e.g. every 1 hour or when the user clicks a button). It returns the data balance (consumption) of purchased packages.
GET/purchases/{purchaseId}/consumptionParameters
| Name | Type | Required | Description |
|---|---|---|---|
| purchase_id | str | ✅ | This endpoint can be called for consumption notifications (e.g. every 1 hour or when the user clicks a button). It returns the data balance (consumption) of purchased packages. |
Return Type
GetPurchaseConsumptionOkResponse
Example Usage Code Snippet
from celitech import Celitech, Environment
sdk = Celitech(
base_url=Environment.DEFAULT.value
)
result = sdk.purchases.get_purchase_consumption(purchase_id="4973fa15-6979-4daa-9cf3-672620df819c")
print(result)
A list of all methods in the ESimService service. Click on the method name to view detailed information about that method.
| Methods | Description |
|---|---|
| get_esim | Get status from eSIM |
| get_esim_device | Get device info from an installed eSIM |
| get_esim_history | Get history from an eSIM |
| get_esim_mac | Get MAC from eSIM |
Get status from eSIM
GET/esimParameters
| Name | Type | Required | Description |
|---|---|---|---|
| iccid | str | ✅ | Get status from eSIM |
Return Type
GetEsimOkResponse
Example Usage Code Snippet
from celitech import Celitech, Environment
sdk = Celitech(
base_url=Environment.DEFAULT.value
)
result = sdk.e_sim.get_esim(iccid="1111222233334444555")
print(result)
Get device info from an installed eSIM
GET/esim/{iccid}/deviceParameters
| Name | Type | Required | Description |
|---|---|---|---|
| iccid | str | ✅ | Get device info from an installed eSIM |
Return Type
GetEsimDeviceOkResponse
Example Usage Code Snippet
from celitech import Celitech, Environment
sdk = Celitech(
base_url=Environment.DEFAULT.value
)
result = sdk.e_sim.get_esim_device(iccid="1111222233334444555")
print(result)
Get history from an eSIM
GET/esim/{iccid}/historyParameters
| Name | Type | Required | Description |
|---|---|---|---|
| iccid | str | ✅ | Get history from an eSIM |
Return Type
GetEsimHistoryOkResponse
Example Usage Code Snippet
from celitech import Celitech, Environment
sdk = Celitech(
base_url=Environment.DEFAULT.value
)
result = sdk.e_sim.get_esim_history(iccid="1111222233334444555")
print(result)
Get MAC from eSIM
GET/esim/{iccid}/macParameters
| Name | Type | Required | Description |
|---|---|---|---|
| iccid | str | ✅ | Get MAC from eSIM |
Return Type
GetEsimMacOkResponse
Example Usage Code Snippet
from celitech import Celitech, Environment
sdk = Celitech(
base_url=Environment.DEFAULT.value
)
result = sdk.e_sim.get_esim_mac(iccid="1111222233334444555")
print(result)
FAQs
Welcome to the CELITECH API documentation! Useful links: [Homepage](https://www.celitech.com) | [Support email](mailto:support@celitech.com) | [Blog](https://www.celitech.com/blog/)
We found that celitech-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.