esimsCreateOrder method

Future<EsimOrder?> esimsCreateOrder(
  1. String idempotencyKey, {
  2. EsimOrderRequest? esimOrderRequest,
  3. Future<void>? abortTrigger,
})

Order eSIMs

Places an order for new eSIMs or a top-up and returns the accepted order. Takes the same body as quote and needs the manage order permission (403 / 10003 without it). An Idempotency-Key header with a new UUID is required for every purchase: a retry with the same key and body returns the order already accepted, 202 / 12002 with Retry-After while it is still being accepted, and a changed body gives 409 / 12001. A top-up is an offer from search?iccid= ordered with inputs.iccid and quantity 1; without inputs.iccid the same offer is bought as a new eSIM. A new eSIM is instant unless inputs.isInstant is false, which delivers an entitlement to provision later. Every price is recalculated: a current price above inputs.maxPrice gives 409 / 11002 before anything is charged.

Parameters:

  • String idempotencyKey (required): UUID idempotency key for safe retries of this operation.

  • EsimOrderRequest esimOrderRequest:

Implementation

Future<EsimOrder?> esimsCreateOrder(String idempotencyKey, { EsimOrderRequest? esimOrderRequest, Future<void>? abortTrigger, }) async {
  final response = await esimsCreateOrderWithHttpInfo(idempotencyKey, esimOrderRequest: esimOrderRequest, abortTrigger: abortTrigger,);
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'EsimOrder',) as EsimOrder;

  }
  return null;
}