Interface ICellularGatewayEsims

Namespace

Meraki.Api.Interfaces.Products.CellularGateway

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface ICellularGatewayEsims

Methods

CreateOrganizationCellularGatewayEsimsServiceProvidersAccountAsync(string, NetworkCellularGatewayEsimsServiceProviderAccountCreateRequest, CancellationToken)

Add a service provider account.

[Post("/organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts")]
Task<NetworkCellularGatewayEsimsServiceProviderAccount> CreateOrganizationCellularGatewayEsimsServiceProvidersAccountAsync(string organizationId, NetworkCellularGatewayEsimsServiceProviderAccountCreateRequest networkCellularGatewayEsimCreateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

networkCellularGatewayEsimCreateRequest NetworkCellularGatewayEsimsServiceProviderAccountCreateRequest

The creation request

cancellationToken CancellationToken

Returns

Task<NetworkCellularGatewayEsimsServiceProviderAccount>

Exceptions

ApiException

Thrown when fails to make API call

CreateOrganizationCellularGatewayEsimsSwapAsync(string, OrganizationCellularGatewayEsimSwapCreateRequest, CancellationToken)

Swap which profile an eSIM uses.

[Post("/organizations/{organizationId}/cellularGateway/esims/swap")]
Task<OrganizationCellularGatewayEsimSwapStatus> CreateOrganizationCellularGatewayEsimsSwapAsync(string organizationId, OrganizationCellularGatewayEsimSwapCreateRequest organizationCellularGatewayEsimSwapCreateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

organizationCellularGatewayEsimSwapCreateRequest OrganizationCellularGatewayEsimSwapCreateRequest

The creation request

cancellationToken CancellationToken

Returns

Task<OrganizationCellularGatewayEsimSwapStatus>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationCellularGatewayEsimsServiceProvidersAccountAsync(string, string, CancellationToken)

Remove a service provider account's integration with the Dashboard.

[Delete("/organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts/{accountId}")]
Task DeleteOrganizationCellularGatewayEsimsServiceProvidersAccountAsync(string organizationId, string accountId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

accountId string

Account ID

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationCellularGatewayEsimsInventoryAsync(string, CancellationToken)

The eSIM inventory of a given organization.

[Get("/organizations/{organizationId}/cellularGateway/esims/inventory")]
Task<NetworkCellularGatewayEsimsInventory> GetOrganizationCellularGatewayEsimsInventoryAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<NetworkCellularGatewayEsimsInventory>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationCellularGatewayEsimsServiceProvidersAccountsAsync(string, List<int>, CancellationToken)

Inventory of service provider accounts tied to the organization.

[Get("/organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts")]
Task<EsimsServiceProvidersAccounts> GetOrganizationCellularGatewayEsimsServiceProvidersAccountsAsync(string organizationId, List<int> accountIds, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

accountIds List<int>

Optional parameter to filter the results by service provider account IDs.

cancellationToken CancellationToken

Returns

Task<EsimsServiceProvidersAccounts>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationCellularGatewayEsimsServiceProvidersAccountsCommunicationPlansAsync(string, List<int>, CancellationToken)

The communication plans available for a given provider.

[Get("/organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts/communicationPlans")]
Task<EsimsServiceProvidersAccountsCommunicationPlans> GetOrganizationCellularGatewayEsimsServiceProvidersAccountsCommunicationPlansAsync(string organizationId, List<int> accountIds, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

accountIds List<int>

Account IDs that communication plans will be fetched for

cancellationToken CancellationToken

Returns

Task<EsimsServiceProvidersAccountsCommunicationPlans>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationCellularGatewayEsimsServiceProvidersAccountsRatePlansAsync(string, List<int>, CancellationToken)

The rate plans available for a given provider.

[Get("/organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts/ratePlans")]
Task<EsimsServiceProvidersAccountsRatePlans> GetOrganizationCellularGatewayEsimsServiceProvidersAccountsRatePlansAsync(string organizationId, List<int> accountIds, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

accountIds List<int>

Account IDs that communication plans will be fetched for

cancellationToken CancellationToken

Returns

Task<EsimsServiceProvidersAccountsRatePlans>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationCellularGatewayEsimsServiceProvidersAsync(string, CancellationToken)

Service providers customers can add accounts for.

[Get("/organizations/{organizationId}/cellularGateway/esims/serviceProviders")]
Task<EsimsServiceProviders> GetOrganizationCellularGatewayEsimsServiceProvidersAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<EsimsServiceProviders>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationCellularGatewayEsimsInventoryAsync(string, string, NetworkCellularGatewayEsimUpdate, CancellationToken)

The eSIM inventory of a given organization.

[Put("/organizations/{organizationId}/cellularGateway/esims/inventory/{id}")]
Task<NetworkCellularGatewayEsimsInventoryItem> UpdateOrganizationCellularGatewayEsimsInventoryAsync(string organizationId, string id, NetworkCellularGatewayEsimUpdate networkCellularGatewayEsimUpdate, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

id string

The eSim Id

networkCellularGatewayEsimUpdate NetworkCellularGatewayEsimUpdate

The eSim update body

cancellationToken CancellationToken

Returns

Task<NetworkCellularGatewayEsimsInventoryItem>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationCellularGatewayEsimsServiceProvidersAccountAsync(string, string, NetworkCellularGatewayEsimsServiceProviderAccountUpdateRequest, CancellationToken)

Edit service provider account info stored in Meraki's database.

[Put("/organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts/{accountId}")]
Task<NetworkCellularGatewayEsimsServiceProviderAccount> UpdateOrganizationCellularGatewayEsimsServiceProvidersAccountAsync(string organizationId, string accountId, NetworkCellularGatewayEsimsServiceProviderAccountUpdateRequest networkCellularGatewayEsimUpdateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

accountId string

Account ID

networkCellularGatewayEsimUpdateRequest NetworkCellularGatewayEsimsServiceProviderAccountUpdateRequest

The update request

cancellationToken CancellationToken

Returns

Task<NetworkCellularGatewayEsimsServiceProviderAccount>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationCellularGatewayEsimsSwapAsync(string, string, CancellationToken)

Get the status of a profile swap.

[Put("/organizations/{organizationId}/cellularGateway/esims/swap/{id}")]
Task<OrganizationCellularGatewayEsimSwapStatus> UpdateOrganizationCellularGatewayEsimsSwapAsync(string organizationId, string id, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

id string

eSIM EID

cancellationToken CancellationToken

Returns

Task<OrganizationCellularGatewayEsimSwapStatus>

Exceptions

ApiException

Thrown when fails to make API call