update meep-vis-client and docs of VIS

5.0.0-beta2

 No newline at end of file

3.0.29

 No newline at end of file

# UnsupportedApi

# {{classname}}

All URIs are relative to *https://localhost/sandboxname/vis/v2*

Method | HTTP request | Description

------------- | ------------- | -------------

[**individualSubscriptionDELETE**](UnsupportedApi.md#individualSubscriptionDELETE) | **DELETE** /subscriptions/{subscriptionId} | Used to cancel the existing subscription.

[**individualSubscriptionGET**](UnsupportedApi.md#individualSubscriptionGET) | **GET** /subscriptions/{subscriptionId} | Retrieve information about this subscription.

[**individualSubscriptionPUT**](UnsupportedApi.md#individualSubscriptionPUT) | **PUT** /subscriptions/{subscriptionId} | Used to update the existing subscription.

[**provInfoGET**](UnsupportedApi.md#provInfoGET) | **GET** /queries/pc5_provisioning_info | Query provisioning information for V2X communication over PC5.

[**provInfoUuMbmsGET**](UnsupportedApi.md#provInfoUuMbmsGET) | **GET** /queries/uu_mbms_provisioning_info | retrieve information required for V2X communication over Uu MBMS.

[**provInfoUuUnicastGET**](UnsupportedApi.md#provInfoUuUnicastGET) | **GET** /queries/uu_unicast_provisioning_info | Used to query provisioning information for V2X communication over Uu unicast.

[**subGET**](UnsupportedApi.md#subGET) | **GET** /subscriptions | Request information about the subscriptions for this requestor.

[**subPOST**](UnsupportedApi.md#subPOST) | **POST** /subscriptions |  create a new subscription to VIS notifications.

[**v2xMessagePOST**](UnsupportedApi.md#v2xMessagePOST) | **POST** /publish_v2x_message | Used to publish a V2X message.

<a name="individualSubscriptionDELETE"></a>

# **individualSubscriptionDELETE**

> individualSubscriptionDELETE(subscriptionId)

Used to cancel the existing subscription.

    Used to cancel the existing subscription.

### Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **subscriptionId** | **String**| Refers to created subscription, where the VIS API allocates a unique resource name for this subscription | [default to null]

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined

- **Accept**: application/json

<a name="individualSubscriptionGET"></a>

# **individualSubscriptionGET**

> oneOf<ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription> individualSubscriptionGET(subscriptionId)

Retrieve information about this subscription.

    Retrieve information about this subscription.

### Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **subscriptionId** | **String**| Refers to created subscription, where the VIS API allocates a unique resource name for this subscription | [default to null]

### Return type

[**oneOf<ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription>**](../Models/oneOf<ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription>.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined

- **Accept**: application/json

<a name="individualSubscriptionPUT"></a>

# **individualSubscriptionPUT**

> oneOf<ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription> individualSubscriptionPUT(subscriptionId, UNKNOWN\_BASE\_TYPE)

Used to update the existing subscription.

    Used to update the existing subscription.

### Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **subscriptionId** | **String**| Refers to created subscription, where the VIS API allocates a unique resource name for this subscription | [default to null]

 **UNKNOWN\_BASE\_TYPE** | [**UNKNOWN_BASE_TYPE**](../Models/UNKNOWN_BASE_TYPE.md)|  |

### Return type

[**oneOf<ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription>**](../Models/oneOf<ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription>.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json

- **Accept**: application/json

<a name="provInfoGET"></a>

# **provInfoGET**

> Pc5ProvisioningInfo provInfoGET(location\_info)

[**ProvInfoGET**](UnsupportedApi.md#ProvInfoGET) | **Get** /queries/pc5_provisioning_info | Query provisioning information for V2X communication over PC5.

[**ProvInfoUuMbmsGET**](UnsupportedApi.md#ProvInfoUuMbmsGET) | **Get** /queries/uu_mbms_provisioning_info | retrieve information required for V2X communication over Uu MBMS.

# **ProvInfoGET**

> Pc5ProvisioningInfo ProvInfoGET(ctx, locationInfo)

Query provisioning information for V2X communication over PC5.

Query provisioning information for V2X communication over PC5.

### Parameters

### Required Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **location\_info** | **String**| Comma separated list of locations to identify a cell of a base station or a particular geographical area | [default to null]

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **locationInfo** | **string**| Comma separated list of locations to identify a cell of a base station or a particular geographical area | 

### Return type

[**Pc5ProvisioningInfo**](../Models/Pc5ProvisioningInfo.md)

[**Pc5ProvisioningInfo**](Pc5ProvisioningInfo.md)

### Authorization

 - **Content-Type**: Not defined

 - **Accept**: application/json

<a name="provInfoUuMbmsGET"></a>

# **provInfoUuMbmsGET**

> UuMbmsProvisioningInfo provInfoUuMbmsGET(location\_info)

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **ProvInfoUuMbmsGET**

> UuMbmsProvisioningInfo ProvInfoUuMbmsGET(ctx, locationInfo)

retrieve information required for V2X communication over Uu MBMS.

retrieve information required for V2X communication over Uu MBMS.

### Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **location\_info** | **String**| omma separated list of locations to identify a cell of a base station or a particular geographical area | [default to null]

### Return type

[**UuMbmsProvisioningInfo**](../Models/UuMbmsProvisioningInfo.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined

- **Accept**: application/json

<a name="provInfoUuUnicastGET"></a>

# **provInfoUuUnicastGET**

> UuUnicastProvisioningInfo provInfoUuUnicastGET(location\_info)

Used to query provisioning information for V2X communication over Uu unicast.

    Used to query provisioning information for V2X communication over Uu unicast.

### Parameters

### Required Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **location\_info** | **String**| Comma separated list of locations to identify a cell of a base station or a particular geographical area | [default to null]

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **locationInfo** | **string**| omma separated list of locations to identify a cell of a base station or a particular geographical area | 

### Return type

[**UuUnicastProvisioningInfo**](../Models/UuUnicastProvisioningInfo.md)

[**UuMbmsProvisioningInfo**](UuMbmsProvisioningInfo.md)

### Authorization

 - **Content-Type**: Not defined

 - **Accept**: application/json

<a name="subGET"></a>

# **subGET**

> SubscriptionLinkList subGET(subscription\_type)

Request information about the subscriptions for this requestor.

    Request information about the subscriptions for this requestor.

### Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **subscription\_type** | **String**| Query parameter to filter on a specific subscription type. Permitted values:  prov_chg_uu_uni: provisioning information change for V2X communication over Uuunicast prov_chg_uu_mbms: provisioning information change for V2X communication over Uu MBMS prov_chg_uu_pc5: provisioning information change for V2X communication over PC5. v2x_msg: V2X interoperability message | [optional] [default to null]

### Return type

[**SubscriptionLinkList**](../Models/SubscriptionLinkList.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined

- **Accept**: application/json

<a name="subPOST"></a>

# **subPOST**

> oneOf<ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription> subPOST(UNKNOWN\_BASE\_TYPE)

 create a new subscription to VIS notifications.

     create a new subscription to VIS notifications.

### Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **UNKNOWN\_BASE\_TYPE** | [**UNKNOWN_BASE_TYPE**](../Models/UNKNOWN_BASE_TYPE.md)|  |

### Return type

[**oneOf<ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription>**](../Models/oneOf<ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription>.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json

- **Accept**: application/json

<a name="v2xMessagePOST"></a>

# **v2xMessagePOST**

> v2xMessagePOST(V2xMsgPublication)

Used to publish a V2X message.

    Used to publish a V2X message.

### Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **V2xMsgPublication** | [**V2xMsgPublication**](../Models/V2xMsgPublication.md)|  |

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json

- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# V2xiApi

# {{classname}}

All URIs are relative to *https://localhost/sandboxname/vis/v2*

Method | HTTP request | Description

------------- | ------------- | -------------

[**mec011AppTerminationPOST**](V2xiApi.md#mec011AppTerminationPOST) | **POST** /notifications/mec011/appTermination | MEC011 Application Termination notification for self termination

[**predictedQosPOST**](V2xiApi.md#predictedQosPOST) | **POST** /provide_predicted_qos | Request the predicted QoS correspondent to potential routes of a vehicular UE.

[**IndividualSubscriptionDELETE**](V2xiApi.md#IndividualSubscriptionDELETE) | **Delete** /subscriptions/{subscriptionId} | Used to cancel the existing subscription.

[**IndividualSubscriptionGET**](V2xiApi.md#IndividualSubscriptionGET) | **Get** /subscriptions/{subscriptionId} | Retrieve information about this subscription.

[**IndividualSubscriptionPUT**](V2xiApi.md#IndividualSubscriptionPUT) | **Put** /subscriptions/{subscriptionId} | Used to update the existing subscription.

[**Mec011AppTerminationPOST**](V2xiApi.md#Mec011AppTerminationPOST) | **Post** /notifications/mec011/appTermination | MEC011 Application Termination notification for self termination

[**PredictedQosPOST**](V2xiApi.md#PredictedQosPOST) | **Post** /provide_predicted_qos | Request the predicted QoS correspondent to potential routes of a vehicular UE.

[**ProvInfoUuUnicastGET**](V2xiApi.md#ProvInfoUuUnicastGET) | **Get** /queries/uu_unicast_provisioning_info | Used to query provisioning information for V2X communication over Uu unicast.

[**SubGET**](V2xiApi.md#SubGET) | **Get** /subscriptions | Request information about the subscriptions for this requestor.

[**SubPOST**](V2xiApi.md#SubPOST) | **Post** /subscriptions |  create a new subscription to VIS notifications.

[**V2xMessagePOST**](V2xiApi.md#V2xMessagePOST) | **Post** /publish_v2x_message | Used to publish a V2X message.

# **IndividualSubscriptionDELETE**

> IndividualSubscriptionDELETE(ctx, subscriptionId)

Used to cancel the existing subscription.

<a name="mec011AppTerminationPOST"></a>

# **mec011AppTerminationPOST**

> mec011AppTerminationPOST(AppTerminationNotification)

Used to cancel the existing subscription.

### Required Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **subscriptionId** | **string**| Refers to created subscription, where the VIS API allocates a unique resource name for this subscription | 

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined

 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **IndividualSubscriptionGET**

> SubscriptionsBody IndividualSubscriptionGET(ctx, subscriptionId)

Retrieve information about this subscription.

Retrieve information about this subscription.

### Required Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **subscriptionId** | **string**| Refers to created subscription, where the VIS API allocates a unique resource name for this subscription | 

### Return type

[**SubscriptionsBody**](subscriptions_body.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined

 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **IndividualSubscriptionPUT**

> SubscriptionsSubscriptionIdBody IndividualSubscriptionPUT(ctx, body, subscriptionId)

Used to update the existing subscription.

Used to update the existing subscription.

### Required Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **body** | [**SubscriptionsSubscriptionIdBody**](SubscriptionsSubscriptionIdBody.md)|  | 

  **subscriptionId** | **string**| Refers to created subscription, where the VIS API allocates a unique resource name for this subscription | 

### Return type

[**SubscriptionsSubscriptionIdBody**](subscriptions_subscriptionId_body.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json

 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **Mec011AppTerminationPOST**

> Mec011AppTerminationPOST(ctx, body)

MEC011 Application Termination notification for self termination

Terminates itself.

### Parameters

### Required Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **AppTerminationNotification** | [**AppTerminationNotification**](../Models/AppTerminationNotification.md)| Termination notification details |

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **body** | [**AppTerminationNotification**](AppTerminationNotification.md)| Termination notification details | 

### Return type

null (empty response body)

 (empty response body)

### Authorization

 - **Content-Type**: application/json

 - **Accept**: Not defined

<a name="predictedQosPOST"></a>

# **predictedQosPOST**

> PredictedQos predictedQosPOST(PredictedQos)

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **PredictedQosPOST**

> PredictedQos PredictedQosPOST(ctx, body)

Request the predicted QoS correspondent to potential routes of a vehicular UE.

Request the predicted QoS correspondent to potential routes of a vehicular UE.

### Parameters

### Required Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **PredictedQos** | [**PredictedQos**](../Models/PredictedQos.md)|  |

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **body** | [**PredictedQos**](PredictedQos.md)|  | 

### Return type

[**PredictedQos**](../Models/PredictedQos.md)

[**PredictedQos**](PredictedQos.md)

### Authorization

 - **Content-Type**: application/json

 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **ProvInfoUuUnicastGET**

> UuUnicastProvisioningInfo ProvInfoUuUnicastGET(ctx, locationInfo)

Used to query provisioning information for V2X communication over Uu unicast.

Used to query provisioning information for V2X communication over Uu unicast.

### Required Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **locationInfo** | **string**| Comma separated list of locations to identify a cell of a base station or a particular geographical area | 

### Return type

[**UuUnicastProvisioningInfo**](UuUnicastProvisioningInfo.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined

 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **SubGET**

> SubscriptionLinkList SubGET(ctx, optional)

Request information about the subscriptions for this requestor.

Request information about the subscriptions for this requestor.

### Required Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

 **optional** | ***V2xiApiSubGETOpts** | optional parameters | nil if no parameters

### Optional Parameters

Optional parameters are passed through a pointer to a V2xiApiSubGETOpts struct

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **subscriptionType** | **optional.String**| Query parameter to filter on a specific subscription type. Permitted values:  prov_chg_uu_uni: provisioning information change for V2X communication over Uuunicast prov_chg_uu_mbms: provisioning information change for V2X communication over Uu MBMS prov_chg_uu_pc5: provisioning information change for V2X communication over PC5. v2x_msg: V2X interoperability message | 

### Return type

[**SubscriptionLinkList**](SubscriptionLinkList.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined

 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **SubPOST**

> SubscriptionsBody SubPOST(ctx, body)

 create a new subscription to VIS notifications.

 create a new subscription to VIS notifications.

### Required Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **body** | [**SubscriptionsBody**](SubscriptionsBody.md)|  | 

### Return type

[**SubscriptionsBody**](subscriptions_body.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json

 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **V2xMessagePOST**

> V2xMessagePOST(ctx, body)

Used to publish a V2X message.

Used to publish a V2X message.

### Required Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **body** | [**V2xMsgPublication**](V2xMsgPublication.md)|  | 

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json

 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# AppTerminationNotification

## Properties

## Properties

Name | Type | Description | Notes

------------ | ------------- | ------------- | -------------

**notificationType** | [**String**](string.md) | Shall be set to AppTerminationNotification. | [default to null]

**operationAction** | [**OperationActionType**](OperationActionType.md) |  | [default to null]

**maxGracefulTimeout** | [**Integer**](integer.md) | Maximum timeout value in seconds for graceful termination or graceful stop of an application instance. | [default to null]

**\_links** | [**AppTerminationNotification__links**](AppTerminationNotification__links.md) |  | [default to null]

**NotificationType** | **string** | Shall be set to AppTerminationNotification. | [default to null]

**OperationAction** | [***OperationActionType**](OperationActionType.md) |  | [default to null]

**MaxGracefulTimeout** | **int32** | Maximum timeout value in seconds for graceful termination or graceful stop of an application instance. | [default to null]

**Links** | [***AppTerminationNotificationLinks**](AppTerminationNotification__links.md) |  | [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

# AppTerminationNotificationLinks

## Properties

## Properties

Name | Type | Description | Notes

------------ | ------------- | ------------- | -------------

**subscription** | [**LinkType**](LinkType.md) |  | [default to null]

**confirmTermination** | [**LinkType**](LinkType.md) |  | [optional] [default to null]

**Subscription** | [***LinkType**](LinkType.md) |  | [default to null]

**ConfirmTermination** | [***LinkType**](LinkType.md) |  | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)