# Rust API client for tapis-notifications

The Tapis Notifications API provides for management of subscriptions and event publication

For more information, please visit [https://tapis-project.org](https://tapis-project.org)

## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

- API version: 25Q4.0
- Package version: 0.2.0
- Generator version: 7.18.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `tapis-notifications` and add the following to `Cargo.toml` under `[dependencies]`:

```
tapis-notifications = { path = "./tapis-notifications" }
```

## Documentation for API Endpoints

All URIs are relative to *http://localhost:8080*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*EventsApi* | [**end_event_series**](docs/EventsApi.md#end_event_series) | **POST** /v3/notifications/events/endSeries | 
*EventsApi* | [**post_event**](docs/EventsApi.md#post_event) | **POST** /v3/notifications/events | 
*EventsApi* | [**publish_event**](docs/EventsApi.md#publish_event) | **POST** /v3/notifications/events/publish | 
*GeneralApi* | [**health_check**](docs/GeneralApi.md#health_check) | **GET** /v3/notifications/healthcheck | 
*GeneralApi* | [**ready_check**](docs/GeneralApi.md#ready_check) | **GET** /v3/notifications/readycheck | 
*SubscriptionsApi* | [**delete_subscription_by_name**](docs/SubscriptionsApi.md#delete_subscription_by_name) | **DELETE** /v3/notifications/subscriptions/byName/{name} | 
*SubscriptionsApi* | [**delete_subscription_by_uuid**](docs/SubscriptionsApi.md#delete_subscription_by_uuid) | **DELETE** /v3/notifications/subscriptions/byUuid/{uuid} | 
*SubscriptionsApi* | [**delete_subscriptions_by_subject**](docs/SubscriptionsApi.md#delete_subscriptions_by_subject) | **DELETE** /v3/notifications/subscriptions/bySubject/{subject} | 
*SubscriptionsApi* | [**disable_subscription**](docs/SubscriptionsApi.md#disable_subscription) | **POST** /v3/notifications/subscriptions/{name}/disable | 
*SubscriptionsApi* | [**enable_subscription**](docs/SubscriptionsApi.md#enable_subscription) | **POST** /v3/notifications/subscriptions/{name}/enable | 
*SubscriptionsApi* | [**get_subscription_by_name**](docs/SubscriptionsApi.md#get_subscription_by_name) | **GET** /v3/notifications/subscriptions/byName/{name} | 
*SubscriptionsApi* | [**get_subscription_by_uuid**](docs/SubscriptionsApi.md#get_subscription_by_uuid) | **GET** /v3/notifications/subscriptions/byUuid/{uuid} | 
*SubscriptionsApi* | [**get_subscriptions**](docs/SubscriptionsApi.md#get_subscriptions) | **GET** /v3/notifications/subscriptions | 
*SubscriptionsApi* | [**is_enabled**](docs/SubscriptionsApi.md#is_enabled) | **GET** /v3/notifications/subscriptions/{name}/isEnabled | 
*SubscriptionsApi* | [**patch_subscription_by_name**](docs/SubscriptionsApi.md#patch_subscription_by_name) | **PATCH** /v3/notifications/subscriptions/byName/{name} | 
*SubscriptionsApi* | [**post_subscription**](docs/SubscriptionsApi.md#post_subscription) | **POST** /v3/notifications/subscriptions | 
*SubscriptionsApi* | [**search_subscriptions_query_parameters**](docs/SubscriptionsApi.md#search_subscriptions_query_parameters) | **GET** /v3/notifications/subscriptions/search | 
*SubscriptionsApi* | [**search_subscriptions_request_body**](docs/SubscriptionsApi.md#search_subscriptions_request_body) | **POST** /v3/notifications/subscriptions/search | 
*SubscriptionsApi* | [**update_ttl**](docs/SubscriptionsApi.md#update_ttl) | **POST** /v3/notifications/subscriptions/{name}/updateTTL/{ttlMinutes} | 
*TestApi* | [**begin_test_sequence**](docs/TestApi.md#begin_test_sequence) | **POST** /v3/notifications/test/begin | 
*TestApi* | [**delete_test_sequence**](docs/TestApi.md#delete_test_sequence) | **DELETE** /v3/notifications/test/{name} | 
*TestApi* | [**get_test_sequence**](docs/TestApi.md#get_test_sequence) | **GET** /v3/notifications/test/{name} | 
*TestApi* | [**record_test_notification**](docs/TestApi.md#record_test_notification) | **POST** /v3/notifications/test/callback/{name} | 


## Documentation For Models

 - [DeliveryMethod](docs/DeliveryMethod.md)
 - [DeliveryTarget](docs/DeliveryTarget.md)
 - [Event](docs/Event.md)
 - [EventSeries](docs/EventSeries.md)
 - [Notification](docs/Notification.md)
 - [ReqPatchSubscription](docs/ReqPatchSubscription.md)
 - [ReqPostSubscription](docs/ReqPostSubscription.md)
 - [ReqSearchSubscriptions](docs/ReqSearchSubscriptions.md)
 - [RespBasic](docs/RespBasic.md)
 - [RespBoolean](docs/RespBoolean.md)
 - [RespChangeCount](docs/RespChangeCount.md)
 - [RespNameArray](docs/RespNameArray.md)
 - [RespResourceUrl](docs/RespResourceUrl.md)
 - [RespSubscription](docs/RespSubscription.md)
 - [RespSubscriptions](docs/RespSubscriptions.md)
 - [RespSubscriptionsMetadata](docs/RespSubscriptionsMetadata.md)
 - [RespTestSequence](docs/RespTestSequence.md)
 - [ResultBoolean](docs/ResultBoolean.md)
 - [ResultChangeCount](docs/ResultChangeCount.md)
 - [ResultNameArray](docs/ResultNameArray.md)
 - [ResultResourceUrl](docs/ResultResourceUrl.md)
 - [TapisSubscription](docs/TapisSubscription.md)
 - [TestSequence](docs/TestSequence.md)


To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author

cicsupport@tacc.utexas.edu

