@betatelltd/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @betatelltd/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://esim.betatel.com/api/v1/esim

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CoreApi | getCountries | GET /countries | Get list of countries ESIMRSPApi | getEUICCProfile | GET /euicc-profiles/{iccid} | Get eUICC profile for eSIM ESIMRSPApi | getQRCode | GET /euicc-profiles/{iccid}/qrcode | Generate QR code for eSIM InventoryApi | getESIM | GET /sim-registries/{iccid} | Get eSIM by ICCID InventoryApi | getESIMs | GET /sim-registries | Get list of eSIMs InventoryApi | getInventories | GET /inventories | Get list of inventories PCRApi | createPackageTemplate | POST /package-templates | Create a new package template PCRApi | getPackageTemplate | GET /package-templates/{id} | Get package template by ID PCRApi | getPackageTemplates | GET /package-templates | Get list of package templates PCRProfileApi | getPCRProfile | GET /sim-pcr-profiles/{iccid} | Get PCR profile for a SIM card PCRProfileApi | modifyPCRProfile | PUT /sim-pcr-profiles/{iccid} | Modify PCR profile for a SIM card PackagesApi | activatePackage | POST /packages/{id}/activate | Activate a package PackagesApi | createPackage | POST /packages | Create a new package PackagesApi | getPackage | GET /packages/{id} | Get package by ID PackagesApi | getPackages | GET /packages | Get list of packages PackagesApi | terminatePackage | POST /packages/{id}/terminate | Terminate a package SystemApi | getStatus | GET /api/v1/status | Check API status

Documentation For Models

• Country
• CreatePackageRequest
• CreatePackageResponse
• CreatePackageResponsePackageTemplate
• CreatePackageTemplateRequest
• CreatePackageTemplateResponse
• DataProfile
• ESIM
• ESIMCompany
• ESIMGroup
• ESIMInventory
• GetCountriesResponse
• GetESIMsResponse
• GetEUICCProfileResponse
• GetInventoriesResponse
• GetPCRProfileResponse
• GetPackageTemplatesResponse
• GetPackagesResponse
• IMSI
• Inventory
• ModelError
• ModifyPCRProfileRequest
• ModifyPCRProfileRequestData
• ModifyPCRProfileRequestSms
• ModifyPCRProfileRequestVoice
• Package
• PackageTemplate
• PaginationParams
• ProfileReusePolicy
• ServiceProfile
• StatusResponse
• TimeAllowance

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

ApiUserId

• Type: API key
• API key parameter name: x-user-id
• Location: HTTP header