External API clients

Description of external API clients used by Aura

Introduction

External API clients are associated with services external to Aura.

They are located inside the Github repository @telefonica/aura-clients, which is a Github private repository shared with Telefonica’s LCDO.

Kernel API clients

Aura contains different Kernel API clients for interacting with Telefónica Kernel products, which are described in the following sections.

You can access to the corresponding swaggers, per environment and country, here.

Find more information in the Github repository for the kernel-directsql-api-client: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-clients/src/kernel-directsql-api-client/

Access Sessions client

Implementation of the Kernel Access Sessions API.

It provides a SingleAccessSessionApi class with all the models and methods implemented to handle Access Sessions API.

Find more information in the Github repository: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-clients/src/aura-bot-access-sessions-client/

Aura Bot Events client

Implementation of the Kernel Aura Bot Events API.

It provides an API class to handle AuraBotEvent, with all the models and methods implemented to be able to handle this API.

Find more information in the Github repository: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-clients/src/aura-bot-events-client/

Invoicing client

Implementation of the Kernel Invoicing API v2.

It provides a central class called InvoicingClient that makes it the very simple to interact with Telefónica Kernel Invoicing Service, passing the base path where the service is hosted and the user OAuth access token to use when interacting with the remote service.

Find more information in the Github repository: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-clients/src/invoicing-client/

Mobile Balance client

Implementation of Kernel Mobile Balance API

It provides a couple of classes called BalanceClient and TopUpClient that makes it very simple to interact with Telefónica Kernel Mobile Balance Service, passing the base path where the service is hosted and the user OAuth access token to use when interacting with the remote service.

Find more information in the Github repository: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-clients/src/mobile-balance-client

Mobile Quota client

Implementation of Kernel Mobile Quota API

It provides a central class called MobileQuotaClient that makes it the very simple to interact with Telefónica Kernel Mobile Quota Service, passing the base path where the service is hosted and the user OAuth access token to use when interacting with the remote service.

Find more information in the Github repository: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-clients/src/mobile-quota-client

Smart Wifi client

Implementation of Kernel Smart Wifi API

It provides a central class called SmartWifiClient which makes it very simple to interact with Telefónica Kernel Smart Wifi Service passing the base path where the service is hosted and the user OAuth access token to use when interacting with the remote service.

Find more information in the Github repository: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-clients/src/smart-wifi-client/

Subscribed Products client

Implementation of Kernel Subscribed Products API

It provides a central class called SubscribedProductsClient which makes it very simple to interact with Telefónica Kernel Subscribed Products Service passing the base path where the service is hosted and the user OAuth access token to use when interacting with the remote service.

Find more information in the Github repository: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-clients/src/subscribed-products-client/

User Profile client

Implementation of the Kernel User Profile API

It provides a UserApi class with all models and methods needed to handle user profile requests.

Find more information in the Github repository: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-clients/src/user-profile-client/

WhatsApp API client

Implementation of the Kernel WhatsApp API

It provides a WhatsApp API class with all models and methods needed to handle WhatsApp requests.

Find more information in the Github repository: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-clients/src/whatsapp-api-client/

Genesys API client

The common call center solution in Telefonica OBs is a platform called Genesys.

The current client is an implementation of the Genesys API version 8.5.2, that is compatible with the call center platform of all the OBs. It is required in order to provide the internal handover to agent solution in Aura.

As Genesys API is not defined with OpenAPI, we have gathered all the methods and objects needed to handle Genesys requests and provide the API definition by our own.

Find more information in the Github repository: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-clients/src/genesys-api-client/

Aura AI Service API client

Implementation of the aura-ai-services

It provides FeedbackApi, GenerativeApi, NlpaasApi classes with all the models and methods implemented to handle requests to aura-ai-services.

Find more information in the Github repository: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-clients/src/aura-aiservices/

Agents API client

Implementation of the agents-api

It provides DefaultApi class with all the models and methods implemented to handle requests to agents-api.