@vibrantnet/ryp-subscription-api
v0.0.1
Published
OpenAPI client for the RYP subscription core service
Downloads
12
Readme
Reach Your People - Subscription API Client
This is a client library for the Reach Your People Subscription API. It is a wrapper around the API that provides a more convenient interface for interacting with the API.
Installation
Simply include the library in your project via npm install @vibrantnet/ryp-subscription-api --save
and then import it into your project.
Usage
After installing, you can create an instance of the DefaultApi
class and use it to interact with the API.
import { Configuration, DefaultApi } from '@vibrantnet/ryp-subscription-api'
const RYP_SUBSCRIPTION_API_URL = 'http://localhost:8071';
const coreSubscriptionApi = new DefaultApi(new Configuration({
basePath: RYP_SUBSCRIPTION_API_URL
}));
Contributing
The API client is currently autogenerated via the OpenAPI generator. If you would like to contribute to the client, please contribute your changes to the OpenAPI specification over in the RYP main repository at https://gitlab.com/vibrantnet/ryp.