README.md

# Go API client for client

This API is the main platform API and mainly used by the AdvantEDGE frontend to interact with scenarios <p>**Micro-service**<br>[meep-ctrl-engine](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-ctrl-engine) <p>**Type & Usage**<br>Platform main interface used by controller software that want to interact with the AdvantEDGE platform <p>**Details**<br>API details available at _your-AdvantEDGE-ip-address/api_

## Overview
This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project.  By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.

- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.GoClientCodegen

## Installation
Put the package under your project folder and add the following in import:
```golang
import "./client"
```

## Documentation for API Endpoints

All URIs are relative to *https://localhost/ctrl-engine/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*EventReplayApi* | [**CreateReplayFile**](docs/EventReplayApi.md#createreplayfile) | **Post** /replay/{name} | Add a replay file
*EventReplayApi* | [**CreateReplayFileFromScenarioExec**](docs/EventReplayApi.md#createreplayfilefromscenarioexec) | **Post** /replay/{name}/generate | Generate a replay file from scenario execution events
*EventReplayApi* | [**DeleteReplayFile**](docs/EventReplayApi.md#deletereplayfile) | **Delete** /replay/{name} | Delete a replay file
*EventReplayApi* | [**DeleteReplayFileList**](docs/EventReplayApi.md#deletereplayfilelist) | **Delete** /replay | Delete all replay files
*EventReplayApi* | [**GetReplayFile**](docs/EventReplayApi.md#getreplayfile) | **Get** /replay/{name} | Get a specific replay file
*EventReplayApi* | [**GetReplayFileList**](docs/EventReplayApi.md#getreplayfilelist) | **Get** /replay | Get all replay file names
*EventReplayApi* | [**GetReplayStatus**](docs/EventReplayApi.md#getreplaystatus) | **Get** /replaystatus | Get status of replay manager
*EventReplayApi* | [**LoopReplay**](docs/EventReplayApi.md#loopreplay) | **Post** /replay/{name}/loop | Loop-Execute a replay file present in the platform store
*EventReplayApi* | [**PlayReplayFile**](docs/EventReplayApi.md#playreplayfile) | **Post** /replay/{name}/play | Execute a replay file present in the platform store
*EventReplayApi* | [**StopReplayFile**](docs/EventReplayApi.md#stopreplayfile) | **Post** /replay/{name}/stop | Stop execution of a replay file
*PodStatesApi* | [**GetStates**](docs/PodStatesApi.md#getstates) | **Get** /states | Get pods states
*ScenarioConfigurationApi* | [**CreateScenario**](docs/ScenarioConfigurationApi.md#createscenario) | **Post** /scenarios/{name} | Add a scenario
*ScenarioConfigurationApi* | [**DeleteScenario**](docs/ScenarioConfigurationApi.md#deletescenario) | **Delete** /scenarios/{name} | Delete a scenario
*ScenarioConfigurationApi* | [**DeleteScenarioList**](docs/ScenarioConfigurationApi.md#deletescenariolist) | **Delete** /scenarios | Delete all scenarios
*ScenarioConfigurationApi* | [**GetScenario**](docs/ScenarioConfigurationApi.md#getscenario) | **Get** /scenarios/{name} | Get a specific scenario
*ScenarioConfigurationApi* | [**GetScenarioList**](docs/ScenarioConfigurationApi.md#getscenariolist) | **Get** /scenarios | Get all scenarios
*ScenarioConfigurationApi* | [**SetScenario**](docs/ScenarioConfigurationApi.md#setscenario) | **Put** /scenarios/{name} | Update a scenario
*ScenarioExecutionApi* | [**ActivateScenario**](docs/ScenarioExecutionApi.md#activatescenario) | **Post** /active/{name} | Deploy a scenario
*ScenarioExecutionApi* | [**GetActiveNodeServiceMaps**](docs/ScenarioExecutionApi.md#getactivenodeservicemaps) | **Get** /active/serviceMaps | Get deployed scenario&#39;s port mapping
*ScenarioExecutionApi* | [**GetActiveScenario**](docs/ScenarioExecutionApi.md#getactivescenario) | **Get** /active | Get the deployed scenario
*ScenarioExecutionApi* | [**SendEvent**](docs/ScenarioExecutionApi.md#sendevent) | **Post** /events/{type} | Send events to the deployed scenario
*ScenarioExecutionApi* | [**TerminateScenario**](docs/ScenarioExecutionApi.md#terminatescenario) | **Delete** /active | Terminate the deployed scenario


## Documentation For Models

 - [ActivationInfo](docs/ActivationInfo.md)
 - [CellularDomainConfig](docs/CellularDomainConfig.md)
 - [CellularPoaConfig](docs/CellularPoaConfig.md)
 - [Deployment](docs/Deployment.md)
 - [Domain](docs/Domain.md)
 - [EgressService](docs/EgressService.md)
 - [Event](docs/Event.md)
 - [EventMobility](docs/EventMobility.md)
 - [EventNetworkCharacteristicsUpdate](docs/EventNetworkCharacteristicsUpdate.md)
 - [EventOther](docs/EventOther.md)
 - [EventPoasInRange](docs/EventPoasInRange.md)
 - [ExternalConfig](docs/ExternalConfig.md)
 - [GpuConfig](docs/GpuConfig.md)
 - [IngressService](docs/IngressService.md)
 - [NetworkCharacteristics](docs/NetworkCharacteristics.md)
 - [NetworkLocation](docs/NetworkLocation.md)
 - [NodeServiceMaps](docs/NodeServiceMaps.md)
 - [PhysicalLocation](docs/PhysicalLocation.md)
 - [PodStatus](docs/PodStatus.md)
 - [PodsStatus](docs/PodsStatus.md)
 - [Process](docs/Process.md)
 - [Replay](docs/Replay.md)
 - [ReplayEvent](docs/ReplayEvent.md)
 - [ReplayFileList](docs/ReplayFileList.md)
 - [ReplayInfo](docs/ReplayInfo.md)
 - [ReplayStatus](docs/ReplayStatus.md)
 - [Scenario](docs/Scenario.md)
 - [ScenarioConfig](docs/ScenarioConfig.md)
 - [ScenarioList](docs/ScenarioList.md)
 - [ServiceConfig](docs/ServiceConfig.md)
 - [ServicePort](docs/ServicePort.md)
 - [Zone](docs/Zone.md)


## Documentation For Authorization
 Endpoints do not require authorization.


## Author

AdvantEDGE@InterDigital.com