File size: 6,009 Bytes
6993919 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 | # rugmunch.AlertsApi
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**cancel_api_v1_alerts_alert_id_delete**](AlertsApi.md#cancel_api_v1_alerts_alert_id_delete) | **DELETE** /api/v1/alerts/{alert_id} | Cancel
[**list_alerts_api_v1_alerts_get**](AlertsApi.md#list_alerts_api_v1_alerts_get) | **GET** /api/v1/alerts | List Alerts
[**subscribe_api_v1_alerts_subscribe_post**](AlertsApi.md#subscribe_api_v1_alerts_subscribe_post) | **POST** /api/v1/alerts/subscribe | Subscribe
# **cancel_api_v1_alerts_alert_id_delete**
> cancel_api_v1_alerts_alert_id_delete(alert_id)
Cancel
Cancel (delete) a subscription. Owner only.
### Example
```python
import rugmunch
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.AlertsApi(api_client)
alert_id = 'alert_id_example' # str |
try:
# Cancel
api_instance.cancel_api_v1_alerts_alert_id_delete(alert_id)
except Exception as e:
print("Exception when calling AlertsApi->cancel_api_v1_alerts_alert_id_delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**alert_id** | **str**| |
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Successful Response | - |
**422** | Validation Error | - |
[[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)
# **list_alerts_api_v1_alerts_get**
> PaginatedResponse list_alerts_api_v1_alerts_get()
List Alerts
List alert subscriptions. Authenticated users see their own; anonymous sees all (legacy behavior).
### Example
```python
import rugmunch
from rugmunch.models.paginated_response import PaginatedResponse
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.AlertsApi(api_client)
try:
# List Alerts
api_response = api_instance.list_alerts_api_v1_alerts_get()
print("The response of AlertsApi->list_alerts_api_v1_alerts_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AlertsApi->list_alerts_api_v1_alerts_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**PaginatedResponse**](PaginatedResponse.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
[[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)
# **subscribe_api_v1_alerts_subscribe_post**
> AlertSubscription subscribe_api_v1_alerts_subscribe_post(create_alert_request)
Subscribe
Create a new alert subscription for a token.
### Example
```python
import rugmunch
from rugmunch.models.alert_subscription import AlertSubscription
from rugmunch.models.create_alert_request import CreateAlertRequest
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.AlertsApi(api_client)
create_alert_request = rugmunch.CreateAlertRequest() # CreateAlertRequest |
try:
# Subscribe
api_response = api_instance.subscribe_api_v1_alerts_subscribe_post(create_alert_request)
print("The response of AlertsApi->subscribe_api_v1_alerts_subscribe_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AlertsApi->subscribe_api_v1_alerts_subscribe_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**create_alert_request** | [**CreateAlertRequest**](CreateAlertRequest.md)| |
### Return type
[**AlertSubscription**](AlertSubscription.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Successful Response | - |
**422** | Validation Error | - |
[[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)
|