emnify.modules.sim.manager
==========================

.. py:module:: emnify.modules.sim.manager


Classes
-------

.. autoapisummary::

   emnify.modules.sim.manager.SimManager


Module Contents
---------------

.. py:class:: SimManager(client)

   Provides methods for interacting with SIM cards using the EMnify API.

   Args:
       client: An instance of the EMnify class used for making API requests.


   .. py:attribute:: client


   .. py:property:: get_sim_list_model


   .. py:property:: get_sim_update_model


   .. py:property:: get_sim_filter_model


   .. py:property:: get_sim_sort_enum


   .. py:method:: get_sim_list(without_device: bool = None, filter_model: emnify.modules.sim.models.SimFilter = None, sort_enum: emnify.constants.SimSort = None) -> Generator[emnify.modules.sim.models.SimList, None, None]

      Retrieves an iterable list of SIM`s.

      :param without_device: Allows to add a filter for request to find all SIM`s without device
      :param filter_model: Model for request`s filtering
      :param sort_enum: Model for request`s sorting



   .. py:method:: retrieve_sim(sim_id: int)

      Retrieves details of single SIM by ID.

      :param sim_id: id of sim to retrieve



   .. py:method:: register_sim(bic: str) -> Union[List[emnify.modules.sim.models.SimList], emnify.modules.sim.models.SimList]

      Registers SIM/batch SIMs.

      :param bic: BIC number of SIM/batch SIMs for registration.



   .. py:method:: update_sim(sim_id: int, sim: emnify.modules.sim.models.SimUpdate) -> bool

      Updates SIM.

      :param sim_id: int of sim to update
      :param sim: filled sim update model



   .. py:method:: activate_sim(sim_id: int)

      Activates `suspended` or `issued` SIM.
      If you want to control both the device and SIM as a whole, it's recommended to use the :class:`DeviceManager.change_status` method if the SIM is assigned to a device.
      Learn more about SIM Lifecycle: https://docs.emnify.com/services/sim-lifecycle-management

      :param sim_id: int of sim to update



   .. py:method:: suspend_sim(sim_id: int)

      Puts the `active` SIM to `suspended` state.
      If you want to control both the device and SIM as a whole, it's recommended to use the :class:`DeviceManager.change_status` method if the SIM is assigned to a device.
      Learn more about SIM Lifecycle: https://docs.emnify.com/services/sim-lifecycle-management

      :param sim_id: id of sim to update



   .. py:method:: __transform_sim_filter_params(filter_model: emnify.modules.sim.models.SimFilter = None, sort_enum: emnify.constants.SimSort = None, without_device: bool = None) -> dict
      :staticmethod: