emnify.modules.api.models¶

Classes¶

`Authentication`
`AuthenticationResponse`
`Auth404Response`
`Field40xResponse`
`ChangeQuota422Response`
`Status`
`Type`
`CreateMFAResponse`
`Status1`
`ActivateMFAKeyRequest`
`Country`
`Error`
`SimpleError`
`APICallback`
`CallbackSecret`
`ApiType`
`DataStreamType`
`DataStream`
`DataStreamType1`
`ApiType1`
`ApiCallback`
`CreateDataStream`
`TrafficType`
`Currency`
`Data`
`TrafficType1`
`Currency1`
`Sms`
`LastMonth`
`SIMStatsResponseObject`
`TrafficType2`
`Currency2`
`Sms1`
`StatsResponseObject`
`TrafficType3`
`Currency3`
`Data1`
`TrafficType4`
`Currency4`
`Sms2`
`SIMStatsDataObject`
`TrafficType5`
`Currency5`
`TrafficStatsObject`
`TrafficTypeObject`
`CurrencyObject`
`TrafficType6`
`Data2`
`TrafficType7`
`Sms3`
`StatsObjectItem`
`StatsObject`
`TrafficType8`
`VolumeObject`
`Country1`
`SmppBind`
`Country2`
`Operator`
`MsisdnPool`
`GtConfig`
`SccpCalledPartyPrefix`
`SmsRoutingData`
`RatType`
`ListofSMSresponse`
`SubmitMTSMSrequest`
`GetdetailsofSMSresponse`
`RetrieveConnectivityInformationresponse`
`OperatorPatchRequest`
`OperatorDataPostRequest`
`RetrieveOperatorBlacklistresponse`
`RetrievePrepaidBalanceresponse`
`UpdatePrepaidBalanceresponse`
`Description`	Create a collection of name/value pairs.
`Id`	Create a collection of name/value pairs.
`Status2`
`Id1`	Create a collection of name/value pairs.
`Description1`	Create a collection of name/value pairs.
`ActionOnExhaustion`
`EndpointQuota`
`ThrottleCutoffVolume`
`Id2`	Create a collection of name/value pairs.
`Description2`	Create a collection of name/value pairs.
`ActionOnExhaustion1`
`Description3`	Create a collection of name/value pairs.
`Id3`	Create a collection of name/value pairs.
`QuotaStatus`
`SMSQuota`
`RetrieveEventsresponse`
`StartingaUSSDDialogrequest`
`StartingaUSSDDialogresponse`
`RetrieveOrganisationListresponse`
`CreateanOrganisationrequest`
`RetrieveaSingleOrganisationresponse`
`UpdateOrganisationrequest`
`RetrieveOrganisationStatusesresponse`
`RetrieveAvailableOrganisationTypesresponse`
`RetrieveAvailableOrganisationRelationTypesresponse`
`RetrieveAvailableOrganisationVerificationTypesresponse`
`RetrieveContactsforanOrganisationresponse`
`CreateaContactforanOrganisationrequest`
`RetrieveaSingleContactresponse`
`UpdateaSingleContactresponse`
`Retrievelistofassignedtariffsforanorganisationresponse`
`RetrieveBillingPeriodsresponse`
`RetrieveBillingDataByPeriodResponse`
`RetrieveSIMlistresponse`
`SIMResource`
`UpdateSIMrequest`
`ListofAllAvailableSIMStatusesresponse`
`ListofIMSIsresponse`
`RetrieveIMSIByIDresponse`
`UpdateIMSIrequest`
`ListofallavailableIMSIstatusesresponse`
`ListofTariffsresponse`
`CreateTariffrequest`
`TariffCategory`
`RetrieveTariffresponse`
`PatchTariffrequest`
`ListofavailableTariffstatusesresponse`
`ListofRatezonesresponse`
`AddRatezonetoTariffrequest`
`PatchRatezonerequest`
`Listofavailableratezonestatusesresponse`
`AddRatetoaRatezonerequest`
`UpdateRateofaRatezonerequest`
`ListofTariffProfilesresponse`
`CreateTariffProfilerequest`
`RetrieveTariffProfileresponse`
`PatchTariffProfilerequest`
`RetrieveCoverageresponse`
`Retrievesingleselectionsresponse`
`RetrieveServiceProfileListresponse`
`CreateaServiceProfilerequest`
`RetrieveaSingleServiceProfileresponse`
`UpdateServiceProfilerequest`
`RetrieveAvailableServicesresponse`
`RetrieveavailableTrafficLimitsresponse`
`CreateTrafficLimitrequest`
`Period`
`ServiceTrafficLimitsResponseItem`
`ServiceTrafficLimitsResponse`
`RetrieveDNSlistresponseItem`
`RetrieveDNSlistresponse`
`CreateaDNSentryrequest`
`Status3`
`Organisation`
`User`
`CreateUserrequest`
`RetrievetheUserresponse`
`UpdateUserrequest`
`RetrieveUserByUsernameresponse`
`RetrieveAvailableUserStatusesresponse`
`EventType`
`EventSource`
`EventSeverity`
`Organisation1`
`User1`
`Event`
`RetrieveEventsresponse4`
`AccountActivationrequest`
`ReSendActivationMailrequest`
`Id4`	Create a collection of name/value pairs.
`Status4`
`CoverageUpdateVPLMNStatusPatch`
`ChangePasswordrequest`
`ChangePassword422response`
`RetrieveownIPAddressSpacesresponse`
`RetrieveAvailableAddressSpacesresponse`
`Field204Response`
`RetrieveEventsresponse5`
`RetrieveEventTypesresponse`
`RetrieveAvailableCountriesresponse`
`RetrieveAvailableCurrenciesresponse`
`RetrieveAvailableDataBlocksizesresponse`
`RetrieveAvailableDataThrottlesresponse`
`RetrieveAvailableOperatorsresponse`
`RetrieveAvailableBreakoutRegionsresponse`
`TariffPlanStatusesGetResponse`
`TariffPlanConfigGetResponse`
`RetrieveAvailableESMEInterfaceTypesresponse`
`PDPContextDefinitionsGetResponse`
`Organisation2`
`PDPContextDefinitionsCreateUpdate`
`PDPContextDefinitionsCreateResponse`
`RatType1`
`QoSDefinitionCreateRequest`
`RatType2`
`QoSDefinitionGetResponse`
`QoSDefinitionPatchRequest`
`NetworkCoverage`
`TrafficType9`
`Currency6`
`IOTCreate`
`HasId`
`LocalDate`
`LocalDateTime`
`Currency7`
`GtConfig1`
`MsisdnPool1`
`Country3`
`Operator1`
`Organisation3`
`PaymentOption`
`Type1`
`OrgPrepaidBalance`
`SmppBind1`
`SmsRoutingListItem`
`SmsRoutingList1`
`SmsRoutingList`
`Organisation4`
`SmsRoutingEntry`
`SccpCalledPartyPrefix1`
`Country4`
`SmppBind2`
`Country5`
`Operator2`
`MsisdnPool2`
`GtConfig2`
`SccpCalledPartyPrefix2`
`SmsRoutingDataCreateUpdateRequest`
`GetEntryPoints`
`OperatorPostRequest`
`CreateMFAKeyresponse`
`ActivateMFAKeyrequest`
`MFAKeyStatusLookupresponse`
`MFAKeyTypeLookupresponse`
`Listoftrusteddevicesresponse`
`ListofApplicationTokensresponse`
`CreateApplicationTokenrequest`
`CreateApplicationTokenresponse`
`ApplicationToken`
`EndpointStatus`
`ServiceProfile`
`TariffProfile`
`Sim`
`IpAddressSpace`
`Status5`
`ServiceProfile1`
`TariffProfile1`
`IpAddressSpace1`
`Sim1`
`Endpoint`
`RetrieveSingleEndpointresponse`
`UpdateEndpointrequest`
`RetrieveEndpointConnectivityStatusresponse`
`GetEndpointLocationByIdResponse`
`RetrieveEndpointStatisticsresponse`
`Status6`
`Type2`
`CloudConnectAttachment`
`Status7`
`Type3`
`GetCloudConnectAttachmentsResponseItem`
`GetCloudConnectAttachmentsResponse`
`CloudConnectBreakoutType`
`GetCloudConnectBreakoutTypesResponseItem`
`GetCloudConnectBreakoutTypesResponse`
`Status8`
`Metrics`
`TunnelInformation`
`GetCloudConnectAttachmentByIdResponseItem`
`GetCloudConnectAttachmentByIdResponse`
`Type4`	Create a collection of name/value pairs.
`CreateCloudConnectTGWRequest`
`Type5`	Create a collection of name/value pairs.
`CreateCloudConnectVPNRequest`
`Currency8`
`CloudConnectCharge`
`Currency9`
`ListCloudConnectPricesResponseItem`
`ListCloudConnectPricesResponse`
`BreakoutTypeId`	Create a collection of name/value pairs.
`Currency10`
`CloudConnectCustomPriceRequest`
`Region`
`GetCloudConnectTransitGatewaysResponseItem`
`GetCloudConnectTransitGatewaysResponse`
`CreateCloudConnectTransitGatewaysRequest`
`UpdateCloudConnectTransitGatewayByIdRequest`
`GetCloudConnectBreakoutTypeWhitelistResponseItem`
`GetCloudConnectBreakoutTypeWhitelistResponse`
`Formfactor`
`SimModel`

Module Contents¶

class emnify.modules.api.models.Authentication¶

Bases: pydantic.BaseModel

application_token: str | None = None¶

username: str | None = None¶

password: pydantic.SecretStr | None = None¶

refresh_token: str | None = None¶

class emnify.modules.api.models.AuthenticationResponse¶

Bases: pydantic.BaseModel

auth_token: str | None = None¶

refresh_token: str | None = None¶

class emnify.modules.api.models.Auth404Response¶

Bases: pydantic.BaseModel

error_code: float | None = None¶

error_token: str | None = None¶

message: str | None = None¶

class emnify.modules.api.models.Field40xResponse¶

Bases: pydantic.BaseModel

error_code: int | None = None¶

error_token: str | None = None¶

message: str | None = None¶

class emnify.modules.api.models.ChangeQuota422Response¶

Bases: pydantic.BaseModel

message: str | None = None¶

class emnify.modules.api.models.Status¶

Bases: pydantic.BaseModel

id: float | None = None¶

description: str | None = None¶

class emnify.modules.api.models.Type¶

Bases: pydantic.BaseModel

id: float | None = None¶

description: str | None = None¶

class emnify.modules.api.models.CreateMFAResponse¶

Bases: pydantic.BaseModel

id: float | None = None¶

status: Status | None = None¶

type: Type | None = None¶

secret_key: str | None = None¶

otpauth: str | None = None¶

creation_date: str | None = None¶

class emnify.modules.api.models.Status1¶

Bases: pydantic.BaseModel

id: float | None = None¶

code: float | None = None¶

class emnify.modules.api.models.ActivateMFAKeyRequest¶

Bases: pydantic.BaseModel

status: Status1 | None = None¶

class emnify.modules.api.models.Country¶

Bases: pydantic.BaseModel

name: str | None = None¶

country_code: int | None = None¶

mcc: str | None = None¶

iso_code: str | None = None¶

latitude: float | None = None¶

longitude: float | None = None¶

id: int | None = None¶

class emnify.modules.api.models.Error¶

Bases: pydantic.BaseModel

code: str¶

message: str¶

class emnify.modules.api.models.SimpleError¶

Bases: pydantic.BaseModel

message: str¶

class emnify.modules.api.models.APICallback¶

Bases: pydantic.BaseModel

organisation_id: str | None = None¶

url: str | None = None¶

created: datetime.datetime | None = None¶

purpose: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.CallbackSecret¶

Bases: pydantic.BaseModel

organisation_id: str | None = None¶

purpose: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.ApiType¶

Bases: pydantic.BaseModel

description: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.DataStreamType¶

Bases: pydantic.BaseModel

description: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.DataStream¶

Bases: pydantic.BaseModel

last_traffic_log_id: int | None = None¶

last_event_id: str | None = None¶

last_dispatched_timestamp: datetime.datetime | None = None¶

last_result_code: str | None = None¶

active: int | None = None¶

running: int | None = None¶

id: int | None = None¶

api_callback: str | None = None¶

api_type: ApiType | None = None¶

data_stream_type: DataStreamType | None = None¶

class emnify.modules.api.models.DataStreamType1¶

Bases: pydantic.BaseModel

description: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.ApiType1¶

Bases: pydantic.BaseModel

description: str | None = None¶

id: int | None = None¶

route: str | None = None¶

reqParams: str | None = None¶

fromServer: bool | None = None¶

parentResource: str | None = None¶

restangularCollection: bool | None = None¶

class emnify.modules.api.models.ApiCallback¶

Bases: pydantic.BaseModel

organisation_id: str | None = None¶

url: str | None = None¶

created: datetime.datetime | None = None¶

purpose: str | None = None¶

id: int | None = None¶

route: str | None = None¶

reqParams: str | None = None¶

fromServer: bool | None = None¶

parentResource: str | None = None¶

restangularCollection: bool | None = None¶

class emnify.modules.api.models.CreateDataStream¶

Bases: pydantic.BaseModel

stream_historic_data: int | None = None¶

data_stream_type: DataStreamType1 | None = None¶

api_type: ApiType1 | None = None¶

api_callback: ApiCallback | None = None¶

event_stream: str | None = None¶

api_username: str | None = None¶

api_password: str | None = None¶

api_parameter: str | None = None¶

class emnify.modules.api.models.TrafficType¶

Bases: pydantic.BaseModel

description: str | None = None¶

unit: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.Currency¶

Bases: pydantic.BaseModel

code: str | None = None¶

symbol: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.Data¶

Bases: pydantic.BaseModel

sim_id: float | None = None¶

month: datetime.date | None = None¶

volume: float | None = None¶

volume_tx: float | None = None¶

volume_rx: float | None = None¶

traffic_type_id: float | None = None¶

last_updated: datetime.datetime | None = None¶

cost: float | None = None¶

currency_id: float | None = None¶

id: float | None = None¶

traffic_type: TrafficType | None = None¶

currency: Currency | None¶

class emnify.modules.api.models.TrafficType1¶

Bases: pydantic.BaseModel

description: str | None = None¶

unit: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.Currency1¶

Bases: pydantic.BaseModel

code: str | None = None¶

symbol: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.Sms¶

Bases: pydantic.BaseModel

sim_id: float | None = None¶

month: datetime.date | None = None¶

volume: float | None = None¶

volume_tx: float | None = None¶

volume_rx: float | None = None¶

traffic_type_id: float | None = None¶

last_updated: datetime.datetime | None = None¶

cost: float | None = None¶

currency_id: float | None = None¶

id: float | None = None¶

traffic_type: TrafficType1 | None = None¶

currency: Currency1 | None¶

class emnify.modules.api.models.LastMonth¶

Bases: pydantic.BaseModel

data: Data | None = None¶

sms: Sms | None = None¶

class emnify.modules.api.models.SIMStatsResponseObject¶

Bases: pydantic.BaseModel

last_month: LastMonth¶

current_month: Dict[str, Any]¶

last_hour: Dict[str, Any]¶

class emnify.modules.api.models.TrafficType2¶

Bases: pydantic.BaseModel

description: str | None = None¶

unit: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.Currency2¶

Bases: pydantic.BaseModel

code: str | None = None¶

symbol: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.Sms1¶

Bases: pydantic.BaseModel

sim_id: float | None = None¶

month: datetime.date | None = None¶

volume: float | None = None¶

volume_tx: float | None = None¶

volume_rx: float | None = None¶

traffic_type_id: float | None = None¶

last_updated: datetime.datetime | None = None¶

cost: float | None = None¶

currency_id: float | None = None¶

id: float | None = None¶

traffic_type: TrafficType2 | None = None¶

currency: Currency2 | None¶

class emnify.modules.api.models.StatsResponseObject¶

Bases: pydantic.BaseModel

date: str | None = None¶

data: Dict[str, Any] | None = None¶

sms: Sms1 | None = None¶

class emnify.modules.api.models.TrafficType3¶

Bases: pydantic.BaseModel

description: str | None = None¶

unit: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.Currency3¶

Bases: pydantic.BaseModel

code: str | None = None¶

symbol: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.Data1¶

Bases: pydantic.BaseModel

sim_id: float | None = None¶

month: datetime.date | None = None¶

volume: float | None = None¶

volume_tx: float | None = None¶

volume_rx: float | None = None¶

traffic_type_id: float | None = None¶

last_updated: datetime.datetime | None = None¶

cost: float | None = None¶

currency_id: float | None = None¶

id: float | None = None¶

traffic_type: TrafficType3 | None = None¶

currency: Currency3 | None¶

class emnify.modules.api.models.TrafficType4¶

Bases: pydantic.BaseModel

description: str | None = None¶

unit: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.Currency4¶

Bases: pydantic.BaseModel

code: str | None = None¶

symbol: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.Sms2¶

Bases: pydantic.BaseModel

sim_id: float | None = None¶

month: datetime.date | None = None¶

volume: float | None = None¶

volume_tx: float | None = None¶

volume_rx: float | None = None¶

traffic_type_id: float | None = None¶

last_updated: datetime.datetime | None = None¶

cost: float | None = None¶

currency_id: float | None = None¶

id: float | None = None¶

traffic_type: TrafficType4 | None = None¶

currency: Currency4 | None¶

class emnify.modules.api.models.SIMStatsDataObject¶

Bases: pydantic.BaseModel

data: Data1 | None = None¶

sms: Sms2 | None = None¶

class emnify.modules.api.models.TrafficType5¶

Bases: pydantic.BaseModel

description: str | None = None¶

unit: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.Currency5¶

Bases: pydantic.BaseModel

code: str | None = None¶

symbol: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.TrafficStatsObject¶

Bases: pydantic.BaseModel

sim_id: float | None = None¶

month: datetime.date | None = None¶

volume: float | None = None¶

volume_tx: float | None = None¶

volume_rx: float | None = None¶

traffic_type_id: float | None = None¶

last_updated: datetime.datetime | None = None¶

cost: float | None = None¶

currency_id: float | None = None¶

id: float | None = None¶

traffic_type: TrafficType5 | None = None¶

currency: Currency5 | None¶

class emnify.modules.api.models.TrafficTypeObject¶

Bases: pydantic.BaseModel

description: str | None = None¶

unit: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.CurrencyObject¶

Bases: pydantic.BaseModel

code: str | None = None¶

symbol: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.TrafficType6¶

Bases: pydantic.BaseModel

description: str | None = None¶

unit: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.Data2¶

Bases: pydantic.BaseModel

volume: float | None = None¶

volume_tx: float | None = None¶

volume_rx: float | None = None¶

cost: float | None = None¶

traffic_type: TrafficType6 | None = None¶

currency: str | None = None¶

class emnify.modules.api.models.TrafficType7¶

Bases: pydantic.BaseModel

description: str | None = None¶

unit: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.Sms3¶

Bases: pydantic.BaseModel

volume: float | None = None¶

volume_tx: float | None = None¶

volume_rx: float | None = None¶

cost: float | None = None¶

traffic_type: TrafficType7 | None = None¶

currency: str | None = None¶

class emnify.modules.api.models.StatsObjectItem¶

Bases: pydantic.BaseModel

date: StatsObjectItem.date | None = None¶

data: Data2 | None = None¶

sms: Sms3 | None = None¶

class emnify.modules.api.models.StatsObject¶

Bases: pydantic.BaseModel

__root__: List[StatsObjectItem]¶

class emnify.modules.api.models.TrafficType8¶

Bases: pydantic.BaseModel

description: str | None = None¶

unit: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.VolumeObject¶

Bases: pydantic.BaseModel

volume: float | None = None¶

volume_tx: float | None = None¶

volume_rx: float | None = None¶

cost: float | None = None¶

traffic_type: TrafficType8 | None = None¶

currency: str | None = None¶

class emnify.modules.api.models.Country1¶

Bases: pydantic.BaseModel

name: str | None = None¶

country_code: int | None = None¶

mcc: float | None = None¶

iso_code: str | None = None¶

latitude: float | None = None¶

longitude: float | None = None¶

id: int | None = None¶

class emnify.modules.api.models.SmppBind¶

Bases: pydantic.BaseModel

system_id: str | None = None¶

smpp_bind_status_id: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.Country2¶

Bases: pydantic.BaseModel

name: str | None = None¶

country_code: int | None = None¶

mcc: float | None = None¶

iso_code: str | None = None¶

latitude: float | None = None¶

longitude: float | None = None¶

id: int | None = None¶

class emnify.modules.api.models.Operator¶

Bases: pydantic.BaseModel

country_id: str | None = None¶

name: str | None = None¶

country_name: str | None = None¶

id: int | None = None¶

country: Country2 | None = None¶

tapcodes: str | None = None¶

mncs: str | None = None¶

class emnify.modules.api.models.MsisdnPool¶

Bases: pydantic.BaseModel

resource_provider_id: str | None = None¶

description: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.GtConfig¶

Bases: pydantic.BaseModel

imsi_prefix: str | None = None¶

calling_party: str | None = None¶

called_party_tt: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.SccpCalledPartyPrefix¶

Bases: pydantic.BaseModel

prefix: str | None = None¶

tt: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.SmsRoutingData¶

Bases: pydantic.BaseModel

id: float | None = None¶

sms_routing_id: str | None = None¶

country: Country1 | None = None¶

smpp_bind: SmppBind | None = None¶

operator: Operator | None = None¶

msisdn_pool: MsisdnPool | None = None¶

gt_config: GtConfig | None = None¶

sccp_called_party_prefix: SccpCalledPartyPrefix | None = None¶

class emnify.modules.api.models.RatType¶

Bases: pydantic.BaseModel

id: float | None = None¶

description: str | None = None¶

class emnify.modules.api.models.ListofSMSresponse¶

Bases: pydantic.BaseModel

submit_date: str | None¶

delivery_date: str | None¶

expiry_date: str | None¶

final_date: str | None¶

retry_date: str | None = None¶

last_delivery_attempt: str | None¶

retry_count: str | None¶

gsm_map_error: str | None = None¶

dcs: int | None¶

pid: int | None¶

source_address: str | None¶

endpoint: Dict[str, Any] | None¶

sim_id: str | None¶

iccid: str | None¶

msisdn: str | None¶

imsi: str | None¶

msc: str | None¶

udh: str | None = None¶

payload: str | None¶

id: int | None¶

status: Dict[str, Any] | None¶

sms_type: Dict[str, Any] | None¶

source_address_type: Dict[str, Any] | None¶

class emnify.modules.api.models.SubmitMTSMSrequest¶

Bases: pydantic.BaseModel

source_address: str¶

payload: str¶

class emnify.modules.api.models.GetdetailsofSMSresponse¶

Bases: pydantic.BaseModel

submit_date: str | None = None¶

delivery_date: str | None = None¶

expiry_date: str | None = None¶

final_date: str | None = None¶

retry_date: str | None = None¶

last_delivery_attempt: str | None = None¶

retry_count: str | None = None¶

gsm_map_error: str | None = None¶

dcs: int | None = None¶

pid: int | None = None¶

source_address: str | None = None¶

endpoint: Dict[str, Any] | None = None¶

sim_id: str | None = None¶

iccid: str | None = None¶

msisdn: str | None = None¶

imsi: str | None = None¶

msc: str | None = None¶

udh: str | None = None¶

payload: str | None = None¶

id: int | None = None¶

status: Dict[str, Any] | None = None¶

sms_type: Dict[str, Any] | None = None¶

source_address_type: Dict[str, Any] | None = None¶

class emnify.modules.api.models.RetrieveConnectivityInformationresponse¶

Bases: pydantic.BaseModel

ussd_info: Dict[str, Any] | None = None¶

subscriber_info: Dict[str, Any] | None = None¶

request_timestamp: str | None = None¶

reply_timestamp: str | None = None¶

class emnify.modules.api.models.OperatorPatchRequest¶

Bases: pydantic.BaseModel

__root__: Any¶

class emnify.modules.api.models.OperatorDataPostRequest¶

Bases: pydantic.BaseModel

__root__: Any¶

class emnify.modules.api.models.RetrieveOperatorBlacklistresponse¶

Bases: pydantic.BaseModel

id: int | None¶

name: str | None¶

country: Dict[str, Any] | None¶

tapcode: List[Dict[str, Any]] | None¶

mnc: List[Dict[str, Any]] | None¶

class emnify.modules.api.models.RetrievePrepaidBalanceresponse¶

Bases: pydantic.BaseModel

amount: float | None = None¶

currency: Dict[str, Any] | None = None¶

last_updated: str | None = None¶

expiry_date: str | None = None¶

class emnify.modules.api.models.UpdatePrepaidBalanceresponse¶

Bases: pydantic.BaseModel

amount: int | None = None¶

currency: Dict[str, Any] | None = None¶

expiry_date: str | None = None¶

class emnify.modules.api.models.Description(*args, **kwds)¶

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

EXHAUSTED = 'EXHAUSTED'¶

ACTIVE = 'ACTIVE'¶

EXPIRED = 'EXPIRED'¶

class emnify.modules.api.models.Id(*args, **kwds)¶

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

integer_1 = 1¶

integer_2 = 2¶

integer_3 = 3¶

class emnify.modules.api.models.Status2¶

Bases: pydantic.BaseModel

description: Description | None = None¶

id: Id¶

class emnify.modules.api.models.Id1(*args, **kwds)¶

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

integer_1 = 1¶

integer_2 = 2¶

class emnify.modules.api.models.Description1(*args, **kwds)¶

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

Throttle = 'Throttle'¶

Block = 'Block'¶

class emnify.modules.api.models.ActionOnExhaustion¶

Bases: pydantic.BaseModel

id: Id1¶

description: Description1 | None = None¶

peak_throughput: int | None = None¶

class emnify.modules.api.models.EndpointQuota¶

Bases: pydantic.BaseModel

last_volume_added: float | None = None¶

last_status_change_date: constr(regex='^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$') | None = None¶

auto_refill: int | None = None¶

threshold_volume: float | None = None¶

threshold_percentage: float | None = None¶

status: Status2¶

volume: float¶

expiry_date: constr(regex='^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$')¶

action_on_exhaustion: ActionOnExhaustion¶

peak_throughput: int | None = None¶

class emnify.modules.api.models.ThrottleCutoffVolume¶

Bases: pydantic.BaseModel

id: float¶

volume: float | None = None¶

class emnify.modules.api.models.Id2(*args, **kwds)¶

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

integer_1 = 1¶

integer_2 = 2¶

class emnify.modules.api.models.Description2(*args, **kwds)¶

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

Throttle = 'Throttle'¶

Block = 'Block'¶

class emnify.modules.api.models.ActionOnExhaustion1¶

Bases: pydantic.BaseModel

id: Id2¶

description: Description2 | None = None¶

peak_throughput: int | None = None¶

class emnify.modules.api.models.Description3(*args, **kwds)¶

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

EXHAUSTED = 'EXHAUSTED'¶

ACTIVE = 'ACTIVE'¶

EXPIRED = 'EXPIRED'¶

class emnify.modules.api.models.Id3(*args, **kwds)¶

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

integer_1 = 1¶

integer_2 = 2¶

integer_3 = 3¶

class emnify.modules.api.models.QuotaStatus¶

Bases: pydantic.BaseModel

description: Description3 | None = None¶

id: Id3¶

class emnify.modules.api.models.SMSQuota¶

Bases: pydantic.BaseModel

volume: float¶

expiry_date: datetime.datetime¶

last_volume_added: float | None = None¶

last_status_change_date: datetime.datetime | None = None¶

auto_refill: bool | None = None¶

threshold_percentage: float¶

threshold_volume: float | None = None¶

status: QuotaStatus¶

action_on_exhaustion: ActionOnExhaustion1 | None = None¶

class emnify.modules.api.models.RetrieveEventsresponse¶

Bases: pydantic.BaseModel

timestamp: str | None¶

alert: bool | None¶

description: str | None¶

id: int | None¶

event_type: Dict[str, Any] | None¶

event_source: Dict[str, Any] | None¶

event_severity: Dict[str, Any] | None¶

organisation: Dict[str, Any] | None¶

endpoint: Dict[str, Any] | None¶

sim: Dict[str, Any] | None¶

imsi: Dict[str, Any] | None¶

class emnify.modules.api.models.StartingaUSSDDialogrequest¶

Bases: pydantic.BaseModel

ussd_begin: Dict[str, Any]¶

class emnify.modules.api.models.StartingaUSSDDialogresponse¶

Bases: pydantic.BaseModel

session_id: str | None¶

class emnify.modules.api.models.RetrieveOrganisationListresponse¶

Bases: pydantic.BaseModel

id: int¶

name: str¶

class_: Dict[str, Any]¶

type: Dict[str, Any]¶

country: Dict[str, Any]¶

status: Dict[str, Any]¶

relation: Dict[str, Any]¶

monthly_cost_limit: int¶

currency: Dict[str, Any]¶

created: str¶

verification_type: Dict[str, Any]¶

verification: str¶

class emnify.modules.api.models.CreateanOrganisationrequest¶

Bases: pydantic.BaseModel

name: str¶

class_: Dict[str, Any]¶

type: Dict[str, Any]¶

country: Dict[str, Any]¶

status: Dict[str, Any]¶

relation: Dict[str, Any]¶

currency: Dict[str, Any]¶

verification_type: Dict[str, Any]¶

verification: str¶

ext_reference: str¶

monthly_cost_limit: int¶

class emnify.modules.api.models.RetrieveaSingleOrganisationresponse¶

Bases: pydantic.BaseModel

id: int | None = None¶

name: str | None = None¶

class_: Dict[str, Any] | None¶

type: Dict[str, Any] | None = None¶

country: Dict[str, Any] | None = None¶

status: Dict[str, Any] | None = None¶

relation: Dict[str, Any] | None = None¶

monthly_cost_limit: int | None = None¶

currency: Dict[str, Any] | None = None¶

created: str | None = None¶

verification_type: Dict[str, Any] | None = None¶

verification: str | None = None¶

class emnify.modules.api.models.UpdateOrganisationrequest¶

Bases: pydantic.BaseModel

name: str¶

class_: Dict[str, Any]¶

type: Dict[str, Any]¶

country: Dict[str, Any]¶

status: Dict[str, Any]¶

ext_reference: str¶

monthly_cost_limit: int¶

currency: Dict[str, Any]¶

verification_type: Dict[str, Any]¶

verification: str¶

class emnify.modules.api.models.RetrieveOrganisationStatusesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

class emnify.modules.api.models.RetrieveAvailableOrganisationTypesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

class emnify.modules.api.models.RetrieveAvailableOrganisationRelationTypesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

class emnify.modules.api.models.RetrieveAvailableOrganisationVerificationTypesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

class emnify.modules.api.models.RetrieveContactsforanOrganisationresponse¶

Bases: pydantic.BaseModel

id: int | None¶

organisation: Dict[str, Any] | None¶

type: Dict[str, Any] | None¶

name: str | None¶

title: str | None¶

department: str | None¶

street: str | None¶

zipcode: str | None¶

city: str | None¶

country: Dict[str, Any] | None¶

email: str | None¶

phone: str | None¶

mobile: str | None¶

state: str | None = None¶

secondary_address: str | None = None¶

class emnify.modules.api.models.CreateaContactforanOrganisationrequest¶

Bases: pydantic.BaseModel

type: Dict[str, Any]¶

name: str¶

title: str¶

department: str¶

street: str¶

zipcode: str¶

city: str¶

country: Dict[str, Any]¶

email: str¶

phone: str¶

mobile: str¶

state: str | None = None¶

secondary_address: str | None = None¶

class emnify.modules.api.models.RetrieveaSingleContactresponse¶

Bases: pydantic.BaseModel

id: int | None = None¶

organisation: Dict[str, Any] | None = None¶

type: Dict[str, Any] | None = None¶

name: str | None = None¶

title: str | None = None¶

department: str | None = None¶

street: str | None = None¶

zipcode: str | None = None¶

city: str | None = None¶

country: Dict[str, Any] | None = None¶

email: str | None = None¶

phone: str | None = None¶

mobile: str | None = None¶

state: str | None = None¶

secondary_address: str | None = None¶

class emnify.modules.api.models.UpdateaSingleContactresponse¶

Bases: pydantic.BaseModel

type: Dict[str, Any] | None = None¶

name: str | None = None¶

title: str | None = None¶

department: str | None = None¶

street: str | None = None¶

zipcode: str | None = None¶

city: str | None = None¶

country: Dict[str, Any] | None = None¶

email: str | None = None¶

phone: str | None = None¶

mobile: str | None = None¶

class emnify.modules.api.models.Retrievelistofassignedtariffsforanorganisationresponse¶

Bases: pydantic.BaseModel

id: int | None¶

name: str | None¶

description: str | None¶

created: str | None¶

default_sms_mt_rate: float | None¶

default_sms_mo_rate: float | None¶

sim_issued_rate: float | None¶

sim_activated_rate: float | None¶

sim_suspended_rate: float | None¶

sim_activation_rate: float | None¶

sim_reactivation_rate: float | None¶

sim_suspension_rate: float | None¶

sim_termination_rate: float | None¶

status: Dict[str, Any] | None¶

currency: Dict[str, Any] | None¶

data_blocksize: Dict[str, Any] | None¶

data_throttle: Dict[str, Any] | None¶

pdp_context_definition: List[Dict[str, Any]] | None¶

class emnify.modules.api.models.RetrieveBillingPeriodsresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

class emnify.modules.api.models.RetrieveBillingDataByPeriodResponse¶

Bases: pydantic.BaseModel

__root__: Any¶

class emnify.modules.api.models.RetrieveSIMlistresponse¶

Bases: pydantic.BaseModel

id: int | None¶

iccid: str | None¶

production_date: str | None¶

activation_date: str | None¶

status: Dict[str, Any] | None¶

customer_org: Dict[str, Any] | None¶

issuer_org: Dict[str, Any] | None¶

endpoint: Dict[str, Any] | None¶

imsi: str | None¶

msisdn: str | None¶

model: Dict[str, Any] | None¶

reseller_org: Dict[str, Any] | None¶

class emnify.modules.api.models.SIMResource¶

Bases: pydantic.BaseModel

id: int | None¶

iccid: str | None¶

production_date: str | None¶

activation_date: str | None¶

status: Dict[str, Any] | None¶

customer_org: Dict[str, Any] | None¶

issuer_org: Dict[str, Any] | None¶

endpoint: Dict[str, Any] | None = None¶

imsi: str | None¶

msisdn: str | None¶

model: Dict[str, Any] | None = None¶

reseller_org: Dict[str, Any] | None = None¶

class emnify.modules.api.models.UpdateSIMrequest¶

Bases: pydantic.BaseModel

issuer_org: Dict[str, Any]¶

reseller_org: Dict[str, Any]¶

customer_org: Dict[str, Any]¶

status: Dict[str, Any]¶

class emnify.modules.api.models.ListofAllAvailableSIMStatusesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

class emnify.modules.api.models.ListofIMSIsresponse¶

Bases: pydantic.BaseModel

id: int | None¶

imsi: str | None¶

import_date: str | None¶

status: Dict[str, Any] | None¶

imsi_pool: Dict[str, Any] | None¶

type: Dict[str, Any] | None¶

sim: Dict[str, Any] | None¶

class emnify.modules.api.models.RetrieveIMSIByIDresponse¶

Bases: pydantic.BaseModel

id: int | None = None¶

imsi: str | None = None¶

import_date: str | None = None¶

status: Dict[str, Any] | None = None¶

imsi_pool: Dict[str, Any] | None = None¶

type: Dict[str, Any] | None = None¶

sim: Dict[str, Any] | None = None¶

class emnify.modules.api.models.UpdateIMSIrequest¶

Bases: pydantic.BaseModel

status: Dict[str, Any]¶

class emnify.modules.api.models.ListofallavailableIMSIstatusesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

class emnify.modules.api.models.ListofTariffsresponse¶

Bases: pydantic.BaseModel

id: int | None¶

name: str | None¶

description: str | None¶

created: str | None¶

default_sms_mt_rate: float | None¶

default_sms_mo_rate: float | None¶

sim_issued_rate: float | None¶

sim_activated_rate: float | None¶

sim_suspended_rate: float | None¶

sim_activation_rate: float | None¶

sim_reactivation_rate: float | None¶

sim_suspension_rate: float | None¶

sim_termination_rate: float | None¶

used_count: int | None¶

assigned_count: int | None¶

status: Dict[str, Any] | None¶

currency: Dict[str, Any] | None¶

data_blocksize: Dict[str, Any] | None¶

data_throttle: Dict[str, Any] | None¶

pdp_context_definition: List[Dict[str, Any]] | None¶

class emnify.modules.api.models.CreateTariffrequest¶

Bases: pydantic.BaseModel

name: str¶

description: str | None = None¶

default_sms_mt_rate: float | None = None¶

default_sms_mo_rate: float | None = None¶

sim_issued_rate: float | None = None¶

sim_activated_rate: float | None = None¶

sim_suspended_rate: float | None = None¶

sim_activation_rate: float | None = None¶

sim_reactivation_rate: float | None = None¶

sim_suspension_rate: float | None = None¶

sim_termination_rate: float | None = None¶

currency: Dict[str, Any] | None = None¶

data_blocksize: Dict[str, Any] | None = None¶

data_throttle: Dict[str, Any] | None = None¶

class emnify.modules.api.models.TariffCategory¶

Bases: pydantic.BaseModel

id: int | None = None¶

name: str¶

used_by: int | None = None¶

class emnify.modules.api.models.RetrieveTariffresponse¶

Bases: pydantic.BaseModel

id: int | None = None¶

name: str | None = None¶

description: str | None = None¶

created: str | None = None¶

default_sms_mt_rate: float | None = None¶

default_sms_mo_rate: float | None = None¶

sim_issued_rate: float | None = None¶

sim_activated_rate: float | None = None¶

sim_suspended_rate: float | None = None¶

sim_activation_rate: float | None = None¶

sim_reactivation_rate: float | None = None¶

sim_suspension_rate: float | None = None¶

sim_termination_rate: float | None = None¶

used_count: int | None = None¶

assigned_count: int | None = None¶

status: Dict[str, Any] | None = None¶

currency: Dict[str, Any] | None = None¶

data_blocksize: Dict[str, Any] | None = None¶

data_throttle: Dict[str, Any] | None = None¶

pdp_context_definition: List[Dict[str, Any]] | None¶

public: bool | None = None¶

tariff_category: TariffCategory | None¶

class emnify.modules.api.models.PatchTariffrequest¶

Bases: pydantic.BaseModel

name: str | None = None¶

description: str | None = None¶

default_sms_mt_rate: float | None = None¶

default_sms_mo_rate: float | None = None¶

sim_issued_rate: float | None = None¶

sim_activated_rate: float | None = None¶

sim_suspended_rate: float | None = None¶

sim_activation_rate: float | None = None¶

sim_reactivation_rate: float | None = None¶

sim_suspension_rate: float | None = None¶

sim_termination_rate: float | None = None¶

status: Dict[str, Any] | None = None¶

currency: Dict[str, Any] | None = None¶

data_blocksize: Dict[str, Any] | None = None¶

data_throttle: Dict[str, Any] | None = None¶

class emnify.modules.api.models.ListofavailableTariffstatusesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

class emnify.modules.api.models.ListofRatezonesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

name: str | None¶

status: Dict[str, Any] | None¶

valid_from: str | None¶

valid_until: str | None = None¶

coverage: List[Dict[str, Any]] | None¶

rate: List[Dict[str, Any]] | None¶

class emnify.modules.api.models.AddRatezonetoTariffrequest¶

Bases: pydantic.BaseModel

name: str¶

valid_from: str¶

valid_until: str¶

class emnify.modules.api.models.PatchRatezonerequest¶

Bases: pydantic.BaseModel

name: str¶

status: Dict[str, Any]¶

valid_from: str¶

valid_until: str¶

class emnify.modules.api.models.Listofavailableratezonestatusesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

class emnify.modules.api.models.AddRatetoaRatezonerequest¶

Bases: pydantic.BaseModel

rate: float¶

volume: int¶

currency: Dict[str, Any]¶

service: Dict[str, Any]¶

valid_from: str¶

valid_until: str¶

class emnify.modules.api.models.UpdateRateofaRatezonerequest¶

Bases: pydantic.BaseModel

valid_from: str¶

valid_until: str¶

class emnify.modules.api.models.ListofTariffProfilesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

name: str | None¶

description: str | None¶

used_count: int | None¶

tariff: Dict[str, Any] | None¶

class emnify.modules.api.models.CreateTariffProfilerequest¶

Bases: pydantic.BaseModel

name: str¶

description: str¶

tariff: Dict[str, Any]¶

class emnify.modules.api.models.RetrieveTariffProfileresponse¶

Bases: pydantic.BaseModel

id: int | None = None¶

name: str | None = None¶

description: str | None = None¶

used_count: int | None = None¶

tariff: Dict[str, Any] | None = None¶

ratezone: List[Dict[str, Any]] | None¶

class emnify.modules.api.models.PatchTariffProfilerequest¶

Bases: pydantic.BaseModel

name: str¶

description: str¶

tariff: Dict[str, Any]¶

class emnify.modules.api.models.RetrieveCoverageresponse¶

Bases: pydantic.BaseModel

country: Dict[str, Any] | None¶

redundancy_count: int | None¶

class emnify.modules.api.models.Retrievesingleselectionsresponse¶

Bases: pydantic.BaseModel

id: int | None = None¶

tariff_plan: Dict[str, Any] | None = None¶

status: Dict[str, Any] | None = None¶

start_date: str | None = None¶

expiry_date: str | None = None¶

selection_date: str | None = None¶

payment: List[Dict[str, Any]] | None¶

class emnify.modules.api.models.RetrieveServiceProfileListresponse¶

Bases: pydantic.BaseModel

id: int | None¶

name: str | None¶

description: str | None¶

used_count: str | None¶

allowed_3g: bool | None¶

allowed_4g: bool | None¶

allowed_nb_iot: bool | None¶

apply_sms_quota: bool | None¶

apply_data_quota: bool | None¶

class emnify.modules.api.models.CreateaServiceProfilerequest¶

Bases: pydantic.BaseModel

name: str | None = None¶

description: str | None = None¶

allowed_3g: bool | None = None¶

allowed_4g: bool | None = None¶

allowed_nb_iot: bool | None = None¶

apply_sms_quota: bool | None = None¶

apply_data_quota: bool | None = None¶

retail: bool | None = None¶

sms_p2p_int: bool | None = None¶

sms_p2p_ext: bool | None = None¶

prepaid: bool | None = None¶

nipdp: bool | None = None¶

api_callback: Dict[str, Any] | None = None¶

api_secret: Dict[str, Any] | None = None¶

moc_callback: Dict[str, Any] | None = None¶

esme_interface_type: Dict[str, Any] | None = None¶

breakout_region: Dict[str, Any] | None = None¶

dns: Dict[str, Any] | None = None¶

class emnify.modules.api.models.RetrieveaSingleServiceProfileresponse¶

Bases: pydantic.BaseModel

id: int | None = None¶

name: str | None = None¶

description: str | None = None¶

allowed_3g: bool | None = None¶

allowed_4g: bool | None = None¶

allowed_nb_iot: bool | None = None¶

apply_sms_quota: bool | None = None¶

apply_data_quota: bool | None = None¶

retail: bool | None = None¶

sms_p2p_int: bool | None = None¶

sms_p2p_ext: bool | None = None¶

prepaid: bool | None = None¶

nipdp: bool | None = None¶

used_count: int | None = None¶

api_callback: Dict[str, Any] | None = None¶

api_secret: Dict[str, Any] | None = None¶

moc_callback: Dict[str, Any] | None = None¶

esme_interface_type: Dict[str, Any] | None = None¶

breakout_region: Dict[str, Any] | None = None¶

service: List[Dict[str, Any]] | None¶

class emnify.modules.api.models.UpdateServiceProfilerequest¶

Bases: pydantic.BaseModel

name: str | None = None¶

description: str | None = None¶

allowed_3g: bool | None = None¶

allowed_4g: bool | None = None¶

allowed_nb_iot: bool | None = None¶

apply_sms_quota: bool | None = None¶

apply_data_quota: bool | None = None¶

retail: bool | None = None¶

sms_p2p_int: bool | None = None¶

sms_p2p_ext: bool | None = None¶

prepaid: bool | None = None¶

nipdp: bool | None = None¶

api_callback: Dict[str, Any] | None = None¶

api_secret: Dict[str, Any] | None = None¶

moc_callback: Dict[str, Any] | None = None¶

esme_interface_type: Dict[str, Any] | None = None¶

breakout_region: Dict[str, Any] | None = None¶

dns: Dict[str, Any] | None = None¶

class emnify.modules.api.models.RetrieveAvailableServicesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

teleservice_code: int | None¶

used_with_vlr: bool | None¶

used_with_sgsn: bool | None¶

traffic_type: Dict[str, Any] | None¶

class emnify.modules.api.models.RetrieveavailableTrafficLimitsresponse¶

Bases: pydantic.BaseModel

id: int | None¶

service: Dict[str, Any] | None¶

volume: int | None¶

period: Dict[str, Any] | None¶

class emnify.modules.api.models.CreateTrafficLimitrequest¶

Bases: pydantic.BaseModel

service: List[Dict[str, Any]]¶

volume: int¶

period: Dict[str, Any]¶

class emnify.modules.api.models.Period¶

Bases: pydantic.BaseModel

id: int | None = None¶

time_units: int | None = None¶

unit: str | None¶

class emnify.modules.api.models.ServiceTrafficLimitsResponseItem¶

Bases: pydantic.BaseModel

id: int | None = None¶

volume: int | None = None¶

period: Period | None = None¶

class emnify.modules.api.models.ServiceTrafficLimitsResponse¶

Bases: pydantic.BaseModel

__root__: List[ServiceTrafficLimitsResponseItem]¶

class emnify.modules.api.models.RetrieveDNSlistresponseItem¶

Bases: pydantic.BaseModel

id: int | None = None¶

primary: str | None = None¶

secondary: str | None = None¶

ip_address_version: int | None = None¶

class emnify.modules.api.models.RetrieveDNSlistresponse¶

Bases: pydantic.BaseModel

__root__: List[RetrieveDNSlistresponseItem]¶

class emnify.modules.api.models.CreateaDNSentryrequest¶

Bases: pydantic.BaseModel

primary: str¶

secondary: str¶

ip_address_version: int¶

class emnify.modules.api.models.Status3¶

Bases: pydantic.BaseModel

id: float | None¶

description: str | None¶

class emnify.modules.api.models.Organisation¶

Bases: pydantic.BaseModel

id: float | None¶

name: str | None¶

class emnify.modules.api.models.User¶

Bases: pydantic.BaseModel

id: int | None¶

username: str | None¶

name: str | None¶

created: str | None¶

status: Status3 | None = None¶

organisation: Organisation | None = None¶

class emnify.modules.api.models.CreateUserrequest¶

Bases: pydantic.BaseModel

username: str¶

name: str¶

organisation: Dict[str, Any]¶

roles: List[Dict[str, Any]]¶

class emnify.modules.api.models.RetrievetheUserresponse¶

Bases: pydantic.BaseModel

id: int | None = None¶

username: str | None = None¶

name: str | None = None¶

created: str | None = None¶

status: Dict[str, Any] | None = None¶

organisation: Dict[str, Any] | None = None¶

roles: List[Dict[str, Any]] | None¶

mfa: List[Dict[str, Any]] | None¶

class emnify.modules.api.models.UpdateUserrequest¶

Bases: pydantic.BaseModel

username: str¶

name: str¶

status: Dict[str, Any]¶

class emnify.modules.api.models.RetrieveUserByUsernameresponse¶

Bases: pydantic.BaseModel

id: int | None = None¶

username: str | None = None¶

name: str | None = None¶

created: str | None = None¶

status: Dict[str, Any] | None = None¶

organisation: Dict[str, Any] | None = None¶

class emnify.modules.api.models.RetrieveAvailableUserStatusesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

class emnify.modules.api.models.EventType¶

Bases: pydantic.BaseModel

id: float | None¶

description: str | None¶

class emnify.modules.api.models.EventSource¶

Bases: pydantic.BaseModel

id: float | None¶

description: str | None¶

class emnify.modules.api.models.EventSeverity¶

Bases: pydantic.BaseModel

id: float | None¶

description: str | None¶

class emnify.modules.api.models.Organisation1¶

Bases: pydantic.BaseModel

id: float | None¶

name: str | None¶

class emnify.modules.api.models.User1¶

Bases: pydantic.BaseModel

id: float | None¶

username: str | None¶

name: str | None¶

class emnify.modules.api.models.Event¶

Bases: pydantic.BaseModel

id: int | None¶

alert: bool | None = None¶

description: str | None¶

timestamp: str | None¶

event_type: EventType | None = None¶

event_source: EventSource | None = None¶

event_severity: EventSeverity | None = None¶

organisation: Organisation1 | None = None¶

user: User1 | None = None¶

class emnify.modules.api.models.RetrieveEventsresponse4¶

Bases: pydantic.BaseModel

id: int¶

alert: bool¶

description: str¶

timestamp: str¶

event_type: Dict[str, Any]¶

event_source: Dict[str, Any]¶

event_severity: Dict[str, Any]¶

organisation: Dict[str, Any]¶

user: Dict[str, Any]¶

class emnify.modules.api.models.AccountActivationrequest¶

Bases: pydantic.BaseModel

activationKey: str¶

password: str¶

class emnify.modules.api.models.ReSendActivationMailrequest¶

Bases: pydantic.BaseModel

username: str¶

g_recaptcha_response: str¶

class emnify.modules.api.models.Id4(*args, **kwds)¶

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

number_0 = 0¶

number_1 = 1¶

class emnify.modules.api.models.Status4¶

Bases: pydantic.BaseModel

id: Id4 | None¶

class emnify.modules.api.models.CoverageUpdateVPLMNStatusPatch¶

Bases: pydantic.BaseModel

status: Status4 | None = None¶

class emnify.modules.api.models.ChangePasswordrequest¶

Bases: pydantic.BaseModel

old_password: str¶

new_password: str¶

class emnify.modules.api.models.ChangePassword422response¶

Bases: pydantic.BaseModel

error_code: int | None = None¶

error_token: str | None = None¶

message: str | None = None¶

errors: List[Dict[str, Any]] | None¶

class emnify.modules.api.models.RetrieveownIPAddressSpacesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

ip_address_space: str | None¶

ip_address_version: int | None¶

used_count: int | None¶

available_count: int | None¶

class emnify.modules.api.models.RetrieveAvailableAddressSpacesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

ip_address_space: str | None¶

ip_address_version: int | None¶

class emnify.modules.api.models.Field204Response¶

Bases: pydantic.BaseModel

__root__: Any¶

class emnify.modules.api.models.RetrieveEventsresponse5¶

Bases: pydantic.BaseModel

id: int¶

alert: bool¶

description: str¶

timestamp: str¶

event_type: Dict[str, Any]¶

event_source: Dict[str, Any]¶

event_severity: Dict[str, Any]¶

organisation: Dict[str, Any]¶

user: Dict[str, Any] | None¶

endpoint: Dict[str, Any] | None¶

sim: Dict[str, Any] | None¶

imsi: Dict[str, Any] | None¶

detail: Dict[str, Any] | None¶

class emnify.modules.api.models.RetrieveEventTypesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

class emnify.modules.api.models.RetrieveAvailableCountriesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

name: str | None¶

country_code: str | None¶

mcc: str | None¶

iso_code: str | None¶

class emnify.modules.api.models.RetrieveAvailableCurrenciesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

code: str | None¶

symbol: str | None¶

class emnify.modules.api.models.RetrieveAvailableDataBlocksizesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

octets: str | None¶

description: str | None¶

class emnify.modules.api.models.RetrieveAvailableDataThrottlesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

octets: str | None¶

description: str | None¶

class emnify.modules.api.models.RetrieveAvailableOperatorsresponse¶

Bases: pydantic.BaseModel

id: int | None¶

name: str | None¶

country: Dict[str, Any] | None¶

tapcode: List[Dict[str, Any]] | None¶

mnc: List[Dict[str, Any]] | None¶

class emnify.modules.api.models.RetrieveAvailableBreakoutRegionsresponse¶

Bases: pydantic.BaseModel

id: int | None¶

name: str | None¶

ip_address: str | None¶

class emnify.modules.api.models.TariffPlanStatusesGetResponse¶

Bases: pydantic.BaseModel

__root__: Any¶

class emnify.modules.api.models.TariffPlanConfigGetResponse¶

Bases: pydantic.BaseModel

__root__: Any¶

class emnify.modules.api.models.RetrieveAvailableESMEInterfaceTypesresponse¶

Bases: pydantic.BaseModel

id: int¶

description: str¶

class emnify.modules.api.models.PDPContextDefinitionsGetResponse¶: Bases: pydantic.BaseModel

class emnify.modules.api.models.Organisation2¶

Bases: pydantic.BaseModel

name: str | None = None¶

organisation_type_id: str | None = None¶

country_id: str | None = None¶

organisation_status_id: str | None = None¶

ext_reference: str | None = None¶

monthly_cost_limit: str | None = None¶

currency_id: int | None = None¶

organisation_class_id: int | None = None¶

created: datetime.datetime | None = None¶

verification_type_id: str | None = None¶

verification: str | None = None¶

brand_id: str | None = None¶

default_sms_routing_id: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.PDPContextDefinitionsCreateUpdate¶

Bases: pydantic.BaseModel

apn: str | None = None¶

organisation: Organisation2 | None = None¶

auto_assign: float | None = None¶

qos_subscribed: str | None = None¶

ext_qos_subscribed: str | None = None¶

ext2_qos_subscribed: str | None = None¶

ext3_qos_subscribed: str | None = None¶

ext4_qos_subscribed: str | None = None¶

class emnify.modules.api.models.PDPContextDefinitionsCreateResponse¶

Bases: pydantic.BaseModel

id: float | None = None¶

class emnify.modules.api.models.RatType1¶

Bases: pydantic.BaseModel

id: int | None = None¶

class emnify.modules.api.models.QoSDefinitionCreateRequest¶

Bases: pydantic.BaseModel

rat_type: RatType1 | None¶

max_bandwidth_dl: conint(ge=0, le=4294967295) | None = None¶

max_bandwidth_ul: conint(ge=0, le=4294967295) | None = None¶

class emnify.modules.api.models.RatType2¶

Bases: pydantic.BaseModel

id: float | None = None¶

description: str | None = None¶

class emnify.modules.api.models.QoSDefinitionGetResponse¶

Bases: pydantic.BaseModel

rat_type: RatType2 | None¶

max_bandwidth_dl: int | None = None¶

max_bandwidth_ul: int | None = None¶

class emnify.modules.api.models.QoSDefinitionPatchRequest¶

Bases: pydantic.BaseModel

max_bandwidth_dl: conint(ge=0, le=4294967295) | None = None¶

max_bandwidth_ul: conint(ge=0, le=4294967295) | None = None¶

class emnify.modules.api.models.NetworkCoverage¶

Bases: pydantic.BaseModel

id: int | None = None¶

class emnify.modules.api.models.TrafficType9¶

Bases: pydantic.BaseModel

id: int | None = None¶

class emnify.modules.api.models.Currency6¶

Bases: pydantic.BaseModel

id: int | None = None¶

class emnify.modules.api.models.IOTCreate¶

Bases: pydantic.BaseModel

mnc: int | None = None¶

mcc: int | None = None¶

network_coverage: NetworkCoverage | None¶

traffic_type: TrafficType9 | None¶

currency: Currency6 | None¶

rate: float | None = None¶

volume: int | None = None¶

blocksize: int | None = None¶

valid_from: datetime.datetime | None = None¶

class emnify.modules.api.models.HasId¶

Bases: pydantic.BaseModel

id: int | None = None¶

class emnify.modules.api.models.LocalDate¶

Bases: pydantic.BaseModel

__root__: constr(regex='^\\d{4}-\\d{2}-\\d{2}$')¶

class emnify.modules.api.models.LocalDateTime¶

Bases: pydantic.BaseModel

__root__: constr(regex='^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\{2}$')¶

class emnify.modules.api.models.Currency7¶

Bases: pydantic.BaseModel

code: str | None = None¶

symbol: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.GtConfig1¶

Bases: pydantic.BaseModel

imsi_prefix: str | None = None¶

calling_party: str | None = None¶

called_party_tt: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.MsisdnPool1¶

Bases: pydantic.BaseModel

resource_provider_id: str | None = None¶

description: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.Country3¶

Bases: pydantic.BaseModel

name: str | None = None¶

country_code: int | None = None¶

mcc: float | None = None¶

iso_code: str | None = None¶

latitude: float | None = None¶

longitude: float | None = None¶

id: int | None = None¶

class emnify.modules.api.models.Operator1¶

Bases: pydantic.BaseModel

country_id: str | None = None¶

name: str | None = None¶

country_name: str | None = None¶

id: int | None = None¶

country: Country3 | None = None¶

tapcodes: str | None = None¶

mncs: str | None = None¶

class emnify.modules.api.models.Organisation3¶

Bases: pydantic.BaseModel

name: str | None = None¶

organisation_type_id: str | None = None¶

country_id: str | None = None¶

organisation_status_id: str | None = None¶

ext_reference: str | None = None¶

monthly_cost_limit: str | None = None¶

currency_id: int | None = None¶

organisation_class_id: int | None = None¶

created: datetime.datetime | None = None¶

verification_type_id: str | None = None¶

verification: str | None = None¶

brand_id: str | None = None¶

default_sms_routing_id: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.PaymentOption¶

Bases: pydantic.BaseModel

id: float | None = None¶

class emnify.modules.api.models.Type1¶

Bases: pydantic.BaseModel

id: float | None = None¶

class emnify.modules.api.models.OrgPrepaidBalance¶

Bases: pydantic.BaseModel

amount: float | None = None¶

external_payment_identifier: str | None = None¶

payment_option: PaymentOption | None = None¶

type: Type1 | None = None¶

class emnify.modules.api.models.SmppBind1¶

Bases: pydantic.BaseModel

system_id: str | None = None¶

smpp_bind_status_id: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.SmsRoutingListItem¶

Bases: pydantic.BaseModel

id: float | None = None¶

description: str | None = None¶

organisation: Dict[str, Any] | None = None¶

class emnify.modules.api.models.SmsRoutingList1¶

Bases: pydantic.BaseModel

name: str | None = None¶

organisation_type_id: str | None = None¶

country_id: str | None = None¶

organisation_status_id: str | None = None¶

ext_reference: str | None = None¶

monthly_cost_limit: str | None = None¶

currency_id: int | None = None¶

organisation_class_id: int | None = None¶

created: datetime.datetime | None = None¶

verification_type_id: str | None = None¶

verification: str | None = None¶

brand_id: str | None = None¶

default_sms_routing_id: str | None = None¶

id: int | None¶

class emnify.modules.api.models.SmsRoutingList¶

Bases: pydantic.BaseModel

__root__: List[SmsRoutingListItem] | SmsRoutingList1¶

class emnify.modules.api.models.Organisation4¶

Bases: pydantic.BaseModel

name: str | None = None¶

organisation_type_id: str | None = None¶

country_id: str | None = None¶

organisation_status_id: str | None = None¶

ext_reference: str | None = None¶

monthly_cost_limit: str | None = None¶

currency_id: int | None = None¶

organisation_class_id: int | None = None¶

created: datetime.datetime | None = None¶

verification_type_id: str | None = None¶

verification: str | None = None¶

brand_id: str | None = None¶

default_sms_routing_id: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.SmsRoutingEntry¶

Bases: pydantic.BaseModel

id: float | None = None¶

description: str | None = None¶

organisation: Organisation4 | None = None¶

class emnify.modules.api.models.SccpCalledPartyPrefix1¶

Bases: pydantic.BaseModel

prefix: str | None = None¶

tt: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.Country4¶

Bases: pydantic.BaseModel

name: str | None = None¶

country_code: int | None = None¶

mcc: float | None = None¶

iso_code: str | None = None¶

latitude: float | None = None¶

longitude: float | None = None¶

id: int | None = None¶

class emnify.modules.api.models.SmppBind2¶

Bases: pydantic.BaseModel

system_id: str | None = None¶

smpp_bind_status_id: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.Country5¶

Bases: pydantic.BaseModel

name: str | None = None¶

country_code: int | None = None¶

mcc: float | None = None¶

iso_code: str | None = None¶

latitude: float | None = None¶

longitude: float | None = None¶

id: int | None = None¶

class emnify.modules.api.models.Operator2¶

Bases: pydantic.BaseModel

country_id: str | None = None¶

name: str | None = None¶

country_name: str | None = None¶

id: int | None = None¶

country: Country5 | None = None¶

tapcodes: str | None = None¶

mncs: str | None = None¶

class emnify.modules.api.models.MsisdnPool2¶

Bases: pydantic.BaseModel

resource_provider_id: str | None = None¶

description: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.GtConfig2¶

Bases: pydantic.BaseModel

imsi_prefix: str | None = None¶

calling_party: str | None = None¶

called_party_tt: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.SccpCalledPartyPrefix2¶

Bases: pydantic.BaseModel

prefix: str | None = None¶

tt: str | None = None¶

id: int | None = None¶

class emnify.modules.api.models.SmsRoutingDataCreateUpdateRequest¶

Bases: pydantic.BaseModel

id: float | None = None¶

sms_routing_id: str | None = None¶

country: Country4 | None = None¶

smpp_bind: SmppBind2 | None = None¶

operator: Operator2 | None = None¶

msisdn_pool: MsisdnPool2 | None = None¶

gt_config: GtConfig2 | None = None¶

sccp_called_party_prefix: SccpCalledPartyPrefix2 | None = None¶

class emnify.modules.api.models.GetEntryPoints¶

Bases: pydantic.BaseModel

method: str¶

uri: str¶

description: str¶

class emnify.modules.api.models.OperatorPostRequest¶

Bases: pydantic.BaseModel

name: str¶

country: Dict[str, Any] | None = None¶

id: float | None = None¶

class emnify.modules.api.models.CreateMFAKeyresponse¶

Bases: pydantic.BaseModel

id: int | None = None¶

status: Dict[str, Any] | None = None¶

type: Dict[str, Any] | None = None¶

secret_key: str | None = None¶

otpauth: str | None = None¶

creation_date: str | None = None¶

class emnify.modules.api.models.ActivateMFAKeyrequest¶

Bases: pydantic.BaseModel

status: Dict[str, Any]¶

code: str¶

class emnify.modules.api.models.MFAKeyStatusLookupresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

class emnify.modules.api.models.MFAKeyTypeLookupresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

class emnify.modules.api.models.Listoftrusteddevicesresponse¶

Bases: pydantic.BaseModel

id: int | None¶

operating_system: str | None¶

browser: str | None¶

activation_date: str | None¶

class emnify.modules.api.models.ListofApplicationTokensresponse¶

Bases: pydantic.BaseModel

id: int | None¶

description: str | None¶

created: str | None¶

status: Dict[str, Any] | None¶

expiry_date: str | None¶

ip: str | None¶

creator: Dict[str, Any] | None¶

class emnify.modules.api.models.CreateApplicationTokenrequest¶

Bases: pydantic.BaseModel

description: str | None = None¶

expiry_date: str | None = None¶

ip: str | None = None¶

class emnify.modules.api.models.CreateApplicationTokenresponse¶

Bases: pydantic.BaseModel

application_token: str | None = None¶

class emnify.modules.api.models.ApplicationToken¶

Bases: pydantic.BaseModel

description: str | None = None¶

status: Dict[str, Any] | None = None¶

class emnify.modules.api.models.EndpointStatus¶

Bases: pydantic.BaseModel

id: int¶

description: str | None = None¶

class emnify.modules.api.models.ServiceProfile¶

Bases: pydantic.BaseModel

id: int¶

name: str | None = None¶

class emnify.modules.api.models.TariffProfile¶

Bases: pydantic.BaseModel

id: int¶

name: str | None = None¶

class emnify.modules.api.models.Sim¶

Bases: pydantic.BaseModel

id: int¶

iccid: str | None = None¶

msisdn: str | None = None¶

imsi: str | None = None¶

class emnify.modules.api.models.IpAddressSpace¶

Bases: pydantic.BaseModel

id: int¶

class emnify.modules.api.models.Status5¶

Bases: pydantic.BaseModel

id: int¶

description: str | None = None¶

class emnify.modules.api.models.ServiceProfile1¶

Bases: pydantic.BaseModel

id: int¶

name: str | None = None¶

class emnify.modules.api.models.TariffProfile1¶

Bases: pydantic.BaseModel

id: int¶

name: str | None = None¶

class emnify.modules.api.models.IpAddressSpace1¶

Bases: pydantic.BaseModel

id: int¶

class emnify.modules.api.models.Sim1¶

Bases: pydantic.BaseModel

id: int¶

iccid: str | None = None¶

msisdn: str | None = None¶

imsi: str | None = None¶

class emnify.modules.api.models.Endpoint¶

Bases: pydantic.BaseModel

id: int | None = None¶

name: str¶

tags: str | None = None¶

service_profile: ServiceProfile1¶

tariff_profile: TariffProfile1¶

ip_address: str | None = None¶

ip_address_space: IpAddressSpace1 | None¶

sim: Sim1 | None¶

imei: str | None = None¶

imei_lock: bool | None = None¶

created: datetime.datetime | None = None¶

last_updated: datetime.datetime | None = None¶

status: Status5¶

class emnify.modules.api.models.RetrieveSingleEndpointresponse¶

Bases: pydantic.BaseModel

id: int | None = None¶

name: str | None = None¶

tags: str | None = None¶

created: str | None = None¶

last_updated: str | None = None¶

status: Dict[str, Any] | None = None¶

service_profile: Dict[str, Any] | None = None¶

tariff_profile: Dict[str, Any] | None = None¶

sim: Dict[str, Any] | None = None¶

imei: str | None = None¶

imei_lock: bool | None = None¶

ip_address: str | None = None¶

ip_address_space: Dict[str, Any] | None = None¶

runtime_data: Dict[str, Any] | None = None¶

class emnify.modules.api.models.UpdateEndpointrequest¶

Bases: pydantic.BaseModel

tags: str¶

status: Dict[str, Any]¶

service_profile: Dict[str, Any]¶

tariff_profile: Dict[str, Any]¶

ip_address: str¶

ip_address_space: Dict[str, Any]¶

sim: Dict[str, Any]¶

imei: str¶

imei_lock: bool¶

class emnify.modules.api.models.RetrieveEndpointConnectivityStatusresponse¶

Bases: pydantic.BaseModel

status: Dict[str, Any] | None = None¶

location: Dict[str, Any] | None = None¶

pdp_context: Dict[str, Any] | None = None¶

services: List[str] | None¶

class emnify.modules.api.models.GetEndpointLocationByIdResponse¶

Bases: pydantic.BaseModel

gcid_cache_id: str | None = None¶

gcid: str | None = None¶

create_date: str | None = None¶

lat: str | None = None¶

lng: str | None = None¶

accuracy: str | None = None¶

class emnify.modules.api.models.RetrieveEndpointStatisticsresponse¶

Bases: pydantic.BaseModel

last_month: Dict[str, Any] | None = None¶

current_month: Dict[str, Any] | None = None¶

last_hour: Dict[str, Any] | None = None¶

class emnify.modules.api.models.Status6¶

Bases: pydantic.BaseModel

id: float | None = None¶

description: str | None = None¶

class emnify.modules.api.models.Type2¶

Bases: pydantic.BaseModel

id: float | None = None¶

description: str | None = None¶

class emnify.modules.api.models.CloudConnectAttachment¶

Bases: pydantic.BaseModel

id: int | None = None¶

name: str | None = None¶

description: str | None = None¶

user_id: int | None = None¶

creation_date: str | None¶

accept_attachment_expiry_date: str | None¶

termination_date: str | None = None¶

aws_transit_gateway_attachment_id: str | None = None¶

aws_vpn_connection_id: str | None¶

status: Status6 | None = None¶

type: Type2 | None = None¶

region: str | None¶

class emnify.modules.api.models.Status7¶

Bases: pydantic.BaseModel

id: float | None = None¶

description: str | None = None¶

class emnify.modules.api.models.Type3¶

Bases: pydantic.BaseModel

id: float | None = None¶

description: str | None = None¶

class emnify.modules.api.models.GetCloudConnectAttachmentsResponseItem¶

Bases: pydantic.BaseModel

id: int | None = None¶

name: str | None = None¶

description: str | None = None¶

user_id: int | None = None¶

creation_date: str | None¶

accept_attachment_expiry_date: str | None¶

termination_date: str | None = None¶

aws_transit_gateway_attachment_id: str | None = None¶

aws_vpn_connection_id: str | None¶

status: Status7 | None = None¶

type: Type3 | None = None¶

region: str | None¶

class emnify.modules.api.models.GetCloudConnectAttachmentsResponse¶

Bases: pydantic.BaseModel

__root__: List[GetCloudConnectAttachmentsResponseItem]¶

class emnify.modules.api.models.CloudConnectBreakoutType¶

Bases: pydantic.BaseModel

id: float | None = None¶

description: str | None = None¶

class emnify.modules.api.models.GetCloudConnectBreakoutTypesResponseItem¶

Bases: pydantic.BaseModel

id: float | None = None¶

description: str | None = None¶

class emnify.modules.api.models.GetCloudConnectBreakoutTypesResponse¶

Bases: pydantic.BaseModel

__root__: List[GetCloudConnectBreakoutTypesResponseItem]¶

class emnify.modules.api.models.Status8¶

Bases: pydantic.BaseModel

id: float | None = None¶

description: str | None = None¶

class emnify.modules.api.models.Metrics¶

Bases: pydantic.BaseModel

tunnel_state: str | None = None¶

bytes_in: Dict[str, float] | None = None¶

bytes_out: Dict[str, float] | None = None¶

class emnify.modules.api.models.TunnelInformation¶

Bases: pydantic.BaseModel

outside_address: str | None = None¶

inside_cidr: str | None = None¶

metrics: Metrics | None = None¶

asn: float | None = None¶

public_ip: str | None = None¶

class emnify.modules.api.models.GetCloudConnectAttachmentByIdResponseItem¶

Bases: pydantic.BaseModel

id: int | None = None¶

name: str | None = None¶

description: str | None = None¶

user_id: int | None = None¶

creation_date: str | None¶

accept_attachment_expiry_date: str | None¶

termination_date: str | None = None¶

aws_transit_gateway_attachment_id: str | None = None¶

aws_vpn_connection_id: str | None¶

status: Status8 | None = None¶

tunnel_information: TunnelInformation | None = None¶

class emnify.modules.api.models.GetCloudConnectAttachmentByIdResponse¶

Bases: pydantic.BaseModel

__root__: List[GetCloudConnectAttachmentByIdResponseItem]¶

class emnify.modules.api.models.Type4(*args, **kwds)¶

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

integer_1 = 1¶

class emnify.modules.api.models.CreateCloudConnectTGWRequest¶

Bases: pydantic.BaseModel

type: Type4¶

name: str¶

description: str | None = None¶

vpc_cidr: List[str]¶

region: str¶

aws_account_id: constr(regex='^\\d{12}$')¶

class emnify.modules.api.models.Type5(*args, **kwds)¶

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

integer_2 = 2¶

integer_3 = 3¶

class emnify.modules.api.models.CreateCloudConnectVPNRequest¶

Bases: pydantic.BaseModel

type: Type5¶

name: str¶

description: str | None = None¶

region: str | None = None¶

public_ip: str¶

psk: str | None¶

asn: int | None¶

premise_cidr: List[str]¶

inside_cidr: List[str] | None¶

class emnify.modules.api.models.Currency8¶

Bases: pydantic.BaseModel

id: int | None = None¶

class emnify.modules.api.models.CloudConnectCharge¶

Bases: pydantic.BaseModel

id: int | None = None¶

breakout_type_id: int | None = None¶

amount: float | None = None¶

currency: Currency8 | None = None¶

class emnify.modules.api.models.Currency9¶

Bases: pydantic.BaseModel

id: int | None = None¶

class emnify.modules.api.models.ListCloudConnectPricesResponseItem¶

Bases: pydantic.BaseModel

id: int | None = None¶

breakout_type_id: int | None = None¶

amount: float | None = None¶

currency: Currency9 | None = None¶

class emnify.modules.api.models.ListCloudConnectPricesResponse¶

Bases: pydantic.BaseModel

__root__: List[ListCloudConnectPricesResponseItem]¶

class emnify.modules.api.models.BreakoutTypeId(*args, **kwds)¶

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

integer_1 = 1¶

integer_2 = 2¶

integer_3 = 3¶

integer_4 = 4¶

integer_5 = 5¶

integer_6 = 6¶

class emnify.modules.api.models.Currency10¶

Bases: pydantic.BaseModel

id: int | None = None¶

class emnify.modules.api.models.CloudConnectCustomPriceRequest¶

Bases: pydantic.BaseModel

breakout_type_id: BreakoutTypeId¶

amount: float¶

currency: Currency10 | None = None¶

class emnify.modules.api.models.Region¶

Bases: pydantic.BaseModel

Id: float | None = None¶

Name: str | None = None¶

Description: str | None = None¶

class emnify.modules.api.models.GetCloudConnectTransitGatewaysResponseItem¶

Bases: pydantic.BaseModel

id: float | None = None¶

name: str | None = None¶

aws_transit_gateway_id: str | None = None¶

active: bool | None = None¶

organisation_id: float | None = None¶

region: Region | None = None¶

class emnify.modules.api.models.GetCloudConnectTransitGatewaysResponse¶

Bases: pydantic.BaseModel

__root__: List[GetCloudConnectTransitGatewaysResponseItem]¶

class emnify.modules.api.models.CreateCloudConnectTransitGatewaysRequest¶

Bases: pydantic.BaseModel

name: str | None = None¶

region: str | None = None¶

aws_transit_gateway_id: str | None = None¶

active: bool | None = None¶

organisation_id: float | None = None¶

class emnify.modules.api.models.UpdateCloudConnectTransitGatewayByIdRequest¶

Bases: pydantic.BaseModel

active: bool | None = None¶

class emnify.modules.api.models.GetCloudConnectBreakoutTypeWhitelistResponseItem¶

Bases: pydantic.BaseModel

organisation_id: float | None = None¶

breakout_type_id: float | None = None¶

organisation_name: str | None = None¶

class emnify.modules.api.models.GetCloudConnectBreakoutTypeWhitelistResponse¶

Bases: pydantic.BaseModel

__root__: List[GetCloudConnectBreakoutTypeWhitelistResponseItem]¶

class emnify.modules.api.models.Formfactor¶

Bases: pydantic.BaseModel

name: str | None = None¶

id: float | None = None¶

class emnify.modules.api.models.SimModel¶

Bases: pydantic.BaseModel

sim_type_id: str | None = None¶

description: str | None = None¶

sim_manufacturer_id: str | None = None¶

sim_formfactor_id: str | None = None¶

memory_size: str | None = None¶

formfactor: Formfactor | None = None¶