Skip to content

MathiasKoch/emnify-rs

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
docs
docs
 
 
patches
patches
 
 
src
src
 
 
.gitignore
.gitignore
 
 
Cargo.toml
Cargo.toml
 
 
README.md
README.md
 
 
generate.sh
generate.sh
 
 

Repository files navigation

Rust API client for EMnify

UNOFFICIAL Rest API resources of the EMnify System.

This repository is in no way affiliated with, or maintained by EMnify.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 1.3
  • Package version: 2.0.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named emnify and add the following to Cargo.toml under [dependencies]:

emnify = { path = "./emnify-rs" }

Documentation for API Endpoints

All URIs are relative to https://cdn.emnify.net

Class Method HTTP request Description
ApplicationTokensApi application_token_by_id_patch PATCH /api/v1/application_token/{app_token_id} Update Application Token
ApplicationTokensApi application_token_get GET /api/v1/application_token List Application Tokens
ApplicationTokensApi application_token_post POST /api/v1/application_token Create Application Token
AuthenticationApi authenticate POST /api/v1/authenticate Retrieve Authentication Token
AuthenticationApi post_mfa POST /api/v1/user/mfa Create an MFA key
AuthenticationApi user_mfa_by_id_patch PATCH /api/v1/user/mfa/{key_id} Activate MFA key
AuthenticationApi user_mfa_by_user_id_and_key_id_delete DELETE /api/v1/user/{user_id}/mfa/{key_id} Delete an MFA key
AuthenticationApi user_mfa_status_get GET /api/v1/user/mfa/status List MFA key Statuses
AuthenticationApi user_mfa_trusted_device_by_user_id_and_device_id_delete DELETE /api/v1/user/{user_id}/mfa/trusted_device/{device_id} Delete a Trusted Device
AuthenticationApi user_mfa_trusted_device_by_user_id_get GET /api/v1/user/{user_id}/mfa/trusted_device List Trusted Devices
AuthenticationApi user_mfa_type_get GET /api/v1/user/mfa/type List MFA key types
CloudConnectApi create_cloud_connect_attachment_tgw POST /api/v1/cnc/breakout/tgw Create a CloudConnect attachment via Transit Gateway
CloudConnectApi create_cloud_connect_attachment_vpn POST /api/v1/cnc/breakout/vpn Create a CloudConnect attachment via IPSec VPN
CloudConnectApi delete_cloud_connect_attachment DELETE /api/v1/cnc/breakout/{cloudconnect_attachment_id} Delete a specific CloudConnect attachment
CloudConnectApi get_cloud_connect_attachment_by_id GET /api/v1/cnc/breakout/{cloudconnect_attachment_id} View details of a CloudConnect attachment
CloudConnectApi get_cloud_connect_attachments GET /api/v1/cnc/breakout List all CloudConnect attachments of an organisation
CloudConnectApi get_cloud_connect_available_regions_by_breakout_type GET /api/v1/cnc/breakout_type/{breakout_type_id}/available_region Get list of available CloudConnect regions by breakout type
CloudConnectApi get_cloud_connect_breakout_types GET /api/v1/cnc/breakout_type List CloudConnect breakout types
CloudConnectApi get_cloud_connect_regions GET /api/v1/cnc/region Get list of available CloudConnect regions
CloudConnectApi list_cloud_connect_custom_prices GET /api/v1/cnc/pricing List CloudConnect prices
CloudConnectApi retry_cloud_connect_attachment PATCH /api/v1/cnc/breakout/{cloudconnect_attachment_id} Retry creation of an expired TGW breakout
EndpointApi create_endpoint POST /api/v1/endpoint Create Endpoint
EndpointApi delete_endpoint_data_quota_by_id DELETE /api/v1/endpoint/{endpoint_id}/quota/data Remove Data Quota
EndpointApi delete_endpoint_sms_quota_by_id DELETE /api/v1/endpoint/{endpoint_id}/quota/sms Remove SMS Quota
EndpointApi endpoint_balance_by_endpoint_id_delete DELETE /api/v1/endpoint/{endpoint_id}/balance Reset Prepaid Balance
EndpointApi endpoint_balance_by_endpoint_id_get GET /api/v1/endpoint/{endpoint_id}/balance Endpoint Prepaid Balance
EndpointApi endpoint_balance_by_endpoint_id_post POST /api/v1/endpoint/{endpoint_id}/balance Update Prepaid Balance
EndpointApi endpoint_by_id_delete DELETE /api/v1/endpoint/{endpoint_id} Delete Endpoint
EndpointApi endpoint_by_id_get GET /api/v1/endpoint/{endpoint_id} Get Endpoint
EndpointApi endpoint_by_id_patch PATCH /api/v1/endpoint/{endpoint_id} Update Endpoint
EndpointApi endpoint_connectivity_by_id_get GET /api/v1/endpoint/{endpoint_id}/connectivity Endpoint Connectivity Status
EndpointApi endpoint_events_by_id GET /api/v1/endpoint/{endpoint_id}/event List Endpoint events
EndpointApi endpoint_operator_blacklist_by_endpoint_id_get GET /api/v1/endpoint/{endpoint_id}/operator_blacklist List Operator Blacklist for Endpoint
EndpointApi endpoint_operator_blacklist_by_ep_id_and_operator_id_delete DELETE /api/v1/endpoint/{endpoint_id}/operator_blacklist/{operator_id} Remove an Operator from the Blacklist
EndpointApi endpoint_operator_blacklist_by_ep_id_and_operator_id_put PUT /api/v1/endpoint/{endpoint_id}/operator_blacklist/{operator_id} Add an Operator to the Blacklist
EndpointApi endpoint_quota_data_by_endpoint_id_get GET /api/v1/endpoint/{endpoint_id}/quota/data Retrieve Data Quota details
EndpointApi endpoint_quota_data_by_endpoint_id_post POST /api/v1/endpoint/{endpoint_id}/quota/data Set Data Quota
EndpointApi endpoint_quota_sms_by_endpoint_id_get GET /api/v1/endpoint/{endpoint_id}/quota/sms Show SMS Quota details
EndpointApi endpoint_quota_sms_by_endpoint_id_post POST /api/v1/endpoint/{endpoint_id}/quota/sms Set SMS Quota
EndpointApi endpoint_sms_by_endpoint_id_and_sms_id_delete DELETE /api/v1/endpoint/{endpoint_id}/sms/{sms_id} Cancel SMS
EndpointApi endpoint_sms_by_endpoint_id_and_sms_id_get GET /api/v1/endpoint/{endpoint_id}/sms/{sms_id} SMS details
EndpointApi endpoint_sms_by_id_get GET /api/v1/endpoint/{endpoint_id}/sms List sent and received SMS
EndpointApi endpoint_sms_by_id_post POST /api/v1/endpoint/{endpoint_id}/sms Send SMS to an Endpoint
EndpointApi endpoint_stats_by_id_get GET /api/v1/endpoint/{endpoint_id}/stats Endpoint Usage and Costs Statistics
EndpointApi endpoint_stats_daily_by_id_get GET /api/v1/endpoint/{endpoint_id}/stats/daily Endpoint Usage and Costs Statistics per day
EndpointApi endpoint_status_get GET /api/v1/endpoint/status List Endpoint Statuses
EndpointApi get_connectivity_info_by_endpoint_id GET /api/v1/endpoint/{endpoint_id}/connectivity_info Connectivity Info of an Endpoint
EndpointApi get_endpoints GET /api/v1/endpoint List Endpoints
EndpointApi update_endpoint_connectivity_by_id PATCH /api/v1/endpoint/{endpoint_id}/connectivity Reset Endpoint Connectivity
EventsApi event_type_get GET /api/v1/event/type List Event Types
EventsApi get_events GET /api/v1/event List Events
IpAddressSpacesApi ip_address_space_available_by_ip_address_version_get GET /api/v1/ip_address_space/available Get Random Address Spaces
IpAddressSpacesApi ip_address_space_by_id_delete DELETE /api/v1/ip_address_space/{address_space_id} Release an IP Address Space from an Organisation
IpAddressSpacesApi ip_address_space_by_id_put PUT /api/v1/ip_address_space/{address_space_id} Assign an IP Address Space to an Organisation
IpAddressSpacesApi ip_address_space_get GET /api/v1/ip_address_space List IP Address Spaces
IntegrationsApi create_callback_secret POST /api/v1/api_secret Create a Callback Secret
IntegrationsApi create_callback_url POST /api/v1/api_callback Create a Callback URL
IntegrationsApi create_data_streamer POST /api/v2/data_stream Create Data Stream
IntegrationsApi data_streamer_v2_by_id_restart POST /api/v2/data_stream/{data_stream_id}/restart Restart Existing Data Stream
IntegrationsApi delete_callback_secret DELETE /api/v1/api_secret/{api_secret_id} Delete a Callback Secret
IntegrationsApi delete_callback_url DELETE /api/v1/api_callback/{api_callback_id} Delete a Callback URL
IntegrationsApi delete_data_streamer_v2 DELETE /api/v2/data_stream/{data_stream_id} Delete Existing Data Stream
IntegrationsApi get_api_callback_secret GET /api/v1/api_secret List API Callback Secrets
IntegrationsApi get_api_callback_urls GET /api/v1/api_callback Retrieve list of API Callback URLs
IntegrationsApi get_callback_secretby_id GET /api/v1/api_secret/{api_secret_id} Get a Callback Secret by ID
IntegrationsApi get_callback_ur_lby_id GET /api/v1/api_callback/{api_callback_id} Get a Callback URL by ID
IntegrationsApi get_data_streamer_by_id_v2 GET /api/v2/data_stream/{data_stream_id} Get Details on Existing Data Stream
IntegrationsApi get_data_streamer_data_stream_type GET /api/v2/data_stream/type Get Data Stream Types
IntegrationsApi get_data_streamer_enum_filter_field_type GET /api/v2/data_stream/filter_field_type Get Possible Data Stream Filter Fields
IntegrationsApi get_data_streamer_statuses GET /api/v2/data_stream/status Get Possible Data Stream Statuses
IntegrationsApi list_data_streamer_v2s GET /api/v2/data_stream List Data Stream configurations of your organization
IntegrationsApi patch_v2_data_stream PATCH /api/v2/data_stream/{data_stream_id} Modify Existing Data Stream
LookupsApi breakout_region_get GET /api/v1/breakout_region List Breakout Regions
LookupsApi country_get GET /api/v1/country List Country Codes
LookupsApi currency_get GET /api/v1/currency List Currencies
LookupsApi data_blocksize_get GET /api/v1/data_blocksize List Data blocksizes
LookupsApi data_throttle_get GET /api/v1/data_throttle List Data Throttles
LookupsApi esme_interface_type_get GET /api/v1/esme_interface_type List ESME Interface Types
LookupsApi list_service_levels GET /api/v1/service_level Get list of service levels
LookupsApi rat_type GET /api/v1/rat_type List RAT types
OperatorApi operator_get GET /api/v1/operator List Operators
OrganisationApi assign_ratezone_inclusive_volume PUT /api/v1/organisation/{org_id_or_my}/inclusive_volume/{inclusive_volume_id} Assign a ratezone inclusive volume to an organisation
OrganisationApi get_active_organisation_inclusive_volume GET /api/v1/organisation/{org_id_or_my}/inclusive_volume/active Get list of active organisation inclusive volumes
OrganisationApi get_organisation_daily_stats GET /api/v1/organisation/{org_id_or_my}/stats/daily Daily organisation traffic and cost statistics
OrganisationApi get_organisation_hourly_stats GET /api/v1/organisation/{org_id_or_my}/stats/hourly Hourly organisation traffic statistics
OrganisationApi get_organisation_monthly_stats GET /api/v1/organisation/{org_id_or_my}/stats Monthly organisation traffic and cost statistics
OrganisationApi my_organisation_get GET /api/v1/organisation/my My Organisation Details
OrganisationApi organisation_status_get GET /api/v1/organisation/status List Organisation Status
OrganisationApi statistics_daily_by_id_get GET /api/v1/stats/daily Organisation Usage and Costs Statistics per day for the current month
OrganisationApi update_organisation_tariff PATCH /api/v1/organisation/{org_id}/tariff Update assigned tariff
PasswordManagementAndActivationApi user_activation_post POST /api/v1/user/activation Activate User
PasswordManagementAndActivationApi user_activation_resend_post POST /api/v1/user/activation_resend Resend User Activation E-mail
PasswordManagementAndActivationApi user_password_patch PATCH /api/v1/user/password Change Password
SimApi register_sim_batch_by_bic PATCH /api/v1/sim_batch/bic/{bic} Register a given batch by BIC
SimApi s_im_statistics_daily_by_id_get GET /api/v1/sim/{sim_id}/stats/daily SIM Usage and Costs Statistics per day
SimApi sim_by_id_delete DELETE /api/v1/sim/{sim_id} Delete a SIM
SimApi sim_by_id_get GET /api/v1/sim/{sim_id} SIM Details
SimApi sim_by_id_patch PATCH /api/v1/sim/{sim_id} Update a SIM
SimApi sim_event_page_per_page_sort_by_sim_id_and_q_get GET /api/v1/sim/{sim_id}/event List SIM Events
SimApi sim_per_page_sort_by_q_and_page_get GET /api/v1/sim List SIMs
SimApi sim_stats_by_id_get GET /api/v1/sim/{sim_id}/stats SIM Usage and Costs Statistics
SimApi sim_status_get GET /api/v1/sim/status List SIM Statuses
SimApi validate_sim_batch_by_bic GET /api/v1/sim_batch/bic/{bic} Validate if a given batch can be registered by BIC
ServiceLookupsAndConfigurationApi dns_by_id_delete DELETE /api/v1/dns/{dns_id} Delete DNS config
ServiceLookupsAndConfigurationApi dns_get GET /api/v1/dns List DNS Configs
ServiceLookupsAndConfigurationApi dns_post POST /api/v1/dns Create DNS config
ServiceLookupsAndConfigurationApi service_get GET /api/v1/service List Services
ServiceLookupsAndConfigurationApi service_traffic_limit_by_id_get GET /api/v1/service/{service_id}/traffic_limit Get Service Traffic Limit
ServiceLookupsAndConfigurationApi traffic_limit_get GET /api/v1/traffic_limit List Traffic Limits
ServiceProfilesApi add_traffic_limit PUT /api/v1/service_profile/{profile_id}/service/{service_id}/traffic_limit/{limit_id} Add Traffic Limit to Service Profile
ServiceProfilesApi delete_quota_by_service_profile_id DELETE /api/v1/service_profile/{profile_id}/quota/{quota_type} Remove all quotas of assigned endpoints
ServiceProfilesApi remove_traffic_limit DELETE /api/v1/service_profile/{profile_id}/service/{service_id}/traffic_limit/{limit_id} Remove Traffic Limit from a Service Profile
ServiceProfilesApi service_profile_by_profile_id_delete DELETE /api/v1/service_profile/{profile_id} Delete a Service Profile
ServiceProfilesApi service_profile_by_profile_id_get GET /api/v1/service_profile/{profile_id} Retrieve a Service Profile
ServiceProfilesApi service_profile_by_profile_id_patch PATCH /api/v1/service_profile/{profile_id} Update Service Profile
ServiceProfilesApi service_profile_get GET /api/v1/service_profile List Service Profiles
ServiceProfilesApi service_profile_post POST /api/v1/service_profile Create Service Profile
ServiceProfilesApi service_profile_service_by_profile_and_service_delete DELETE /api/v1/service_profile/{profile_id}/service/{service_id} Remove a Service from a Service Profile
ServiceProfilesApi service_profile_service_by_profile_and_service_put PUT /api/v1/service_profile/{profile_id}/service/{service_id} Add a Service to a Service Profile
TariffPlansApi get_organisation_active_tariff_plan GET /api/v1/organisation/{org_id_or_my}/tariff_plan/active Get the active tariff plan for the given organisation
TariffPlansApi organisation_tariff_plan_by_org_id_get GET /api/v1/organisation/{org_id}/tariff_plan List Organisation Tariff Plans
TariffProfilesApi tariff_profile_by_id_delete DELETE /api/v1/tariff_profile/{tariff_profile_id} Delete Tariff Profile
TariffProfilesApi tariff_profile_by_id_get GET /api/v1/tariff_profile/{tariff_profile_id} Tariff Profile Details
TariffProfilesApi tariff_profile_by_id_patch PATCH /api/v1/tariff_profile/{tariff_profile_id} Update Tariff Profile
TariffProfilesApi tariff_profile_coverage_by_tp_id_get GET /api/v1/tariff_profile/{tariff_profile_id}/coverage List Tariff Profile Coverage
TariffProfilesApi tariff_profile_get GET /api/v1/tariff_profile List Tariff Profiles
TariffProfilesApi tariff_profile_inclusive_volume_assignment PUT /api/v1/tariff_profile/{tariff_profile_id}/inclusive_volume/{inclusive_volume_id} Assign Inclusive Volume to Tarriff Profile
TariffProfilesApi tariff_profile_inclusive_volume_remove_assignment DELETE /api/v1/tariff_profile/{tariff_profile_id}/inclusive_volume/{inclusive_volume_id} Unassign Inclusive Volume from Tariff Profile
TariffProfilesApi tariff_profile_post POST /api/v1/tariff_profile Create Tariff Profile
TariffProfilesApi tariff_profile_ratezone_selection_by_tp_id_and_rz_id_delete DELETE /api/v1/tariff_profile/{tariff_profile_id}/ratezone_selection/{ratezone_id} Delete Ratezone from Tariff Profile
TariffProfilesApi tariff_profile_ratezone_selection_by_tp_id_and_rz_id_put PUT /api/v1/tariff_profile/{tariff_profile_id}/ratezone_selection/{ratezone_id} Assign Ratezone to Tarriff Profile
UssdApi endpoint_ussd_by_id_post POST /api/v1/endpoint/{endpoint_id}/ussd Create USSD dialog
UserManagementApi user_by_id_delete DELETE /api/v1/user/{user_id} Delete User by ID
UserManagementApi user_by_id_delete_v2 DELETE /api/v2/user/{user_id} Delete User by ID
UserManagementApi user_by_id_get GET /api/v1/user/{user_id} Get User by ID or Username
UserManagementApi user_by_id_patch PATCH /api/v1/user/{user_id} Update User by ID
UserManagementApi user_by_id_v2_create_support_token POST /api/v2/user/{user_id}/support_token Create support access token for given user
UserManagementApi user_event_page_per_page_sort_by_user_id_and_q_get GET /api/v1/user/{user_id}/event List User Events
UserManagementApi user_per_page_sort_by_q_and_page_get GET /api/v1/user List User Accounts
UserManagementApi user_per_page_sort_by_q_and_page_post POST /api/v1/user Create User
UserManagementApi user_role_by_id_and_role_id_delete DELETE /api/v1/user/{user_id}/role/{role_id} Delete User Role
UserManagementApi user_role_by_id_and_role_id_put PUT /api/v1/user/{user_id}/role/{role_id} Assign Role to User
UserManagementApi user_role_get GET /api/v1/user/role List User Roles
UserManagementApi user_role_permission_by_id_get GET /api/v1/user/{user_id}/role/permission List User Role Permissions
UserManagementApi user_status_get GET /api/v1/user/status List User Statuses

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

About

Rest API resources of the EMnify System

Resources

Readme
Activity

Stars

0 stars

Watchers

2 watching

Forks

1 fork
Report repository

Releases

No releases published

Contributors 2

  •  
  •  

Languages