Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/testcompany-sample-sdk
A java SDK for accessing the Event-Notification API.
https://github.com/speakeasy-sdks/testcompany-sample-sdk
Last synced: 2 days ago
JSON representation
A java SDK for accessing the Event-Notification API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/testcompany-sample-sdk
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-11-06T07:54:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:51:32.000Z (7 months ago)
- Last Synced: 2024-04-28T05:14:54.099Z (6 months ago)
- Language: Java
- Size: 195 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Event-Notification
## 🏗 **Welcome to your new SDK!** 🏗
It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)
- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)
- [ ] ✨ When ready to productionize, delete this section from the README
## SDK Installation
### Gradle
```groovy
implementation 'de.testcompany.Event_Notification:Event-Notification:0.6.0'
```
## SDK Example Usage
### Example
```java
package hello.world;
import de.testcompany.Event_Notification.EventNotification;
import de.testcompany.Event_Notification.models.operations.GetCategoriesRequest;
import de.testcompany.Event_Notification.models.operations.GetCategoriesResponse;
import de.testcompany.Event_Notification.models.shared.Security;
public class Application {
public static void main(String[] args) {
try {
EventNotification sdk = EventNotification.builder()
.setSecurity(new Security(
""){{
bearerAuth = "";
}})
.build();
de.testcompany.Event_Notification.models.operations.GetCategoriesResponse res = sdk.eventTypes.getCategories("");
if (res.eventCategoryDescriptions != null) {
// handle response
}
} catch (Exception e) {
// handle exception
}
}
}
```
## Available Resources and Operations
### [eventTypes](docs/sdks/eventtypes/README.md)
* [getCategories](docs/sdks/eventtypes/README.md#getcategories) - Get Event Categories.
* [getCategory](docs/sdks/eventtypes/README.md#getcategory) - Get an Event Category.
* [getName](docs/sdks/eventtypes/README.md#getname) - Get an Event Type Name.
* [getNames](docs/sdks/eventtypes/README.md#getnames) - Get Event Names.
### [info](docs/sdks/info/README.md)
* [getServiceInfo](docs/sdks/info/README.md#getserviceinfo) - Get API service status and info
### [events](docs/sdks/events/README.md)
* [getEvents](docs/sdks/events/README.md#getevents) - Get Event Notifications.
* [postPing](docs/sdks/events/README.md#postping) - Ping endpoint
* [updateEvents](docs/sdks/events/README.md#updateevents) - Update Event Notifications.
### [internal](docs/sdks/internal/README.md)
* [postPing](docs/sdks/internal/README.md#postping) - Ping endpoint
### [subscriptions](docs/sdks/subscriptions/README.md)
* [deleteSubscription](docs/sdks/subscriptions/README.md#deletesubscription) - Delete a Subscription.
* [getSubscription](docs/sdks/subscriptions/README.md#getsubscription) - Get a Subscription.
* [getSubscriptions](docs/sdks/subscriptions/README.md#getsubscriptions) - Get Subscriptions.
* [postSubscription](docs/sdks/subscriptions/README.md#postsubscription) - Create a Subscription.
* [updateSubscription](docs/sdks/subscriptions/README.md#updatesubscription) - Update a Subscription.
## Server Selection
## Server Selection
### Select Server by Index
You can override the default server globally using the `setServerIndex` option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://event-notification-service.ehyp.prod.interhyp-cloud.de` | None |
| 1 | `https://event-notification-service.ehyp.dev.interhyp-cloud.de` | None |
### Override Server URL Per-Client
The default server can also be overridden globally using the `setServerURL` option when initializing the SDK client instance. For example:
# Development
## Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
## Contributions
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)