forestvpn_api 1.0.1 forestvpn_api: ^1.0.1 copied to clipboard
A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)
forestvpn_api #
ForestVPN defeats content restrictions and censorship to deliver unlimited access to video, music, social media, and more, from anywhere in the world.
This Dart package is automatically generated by the Swagger Codegen project:
- API version: 1.0
- Build package: io.swagger.codegen.languages.DartClientCodegen For more information, please visit https://www.forestvpn.com/
Requirements #
Dart 1.20.0 or later OR Flutter 0.0.20 or later
Installation & Usage #
Github #
If this Dart package is published to Github, please include the following in pubspec.yaml
name: forestvpn_api
version: 1.0.0
description: A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)
dependencies:
forestvpn_api:
git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
version: 'any'
Local #
To use the package in your local drive, please include the following in pubspec.yaml
dependencies:
forestvpn_api:
path: /path/to/forestvpn_api
Tests #
TODO
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:forestvpn_api/api.dart';
var api_instance = new AppleApi();
var notification = new AppleStoreServerNotification(); // AppleStoreServerNotification |
try {
api_instance.appleStoreServerNotification(notification);
} catch (e) {
print("Exception when calling AppleApi->appleStoreServerNotification: $e\n");
}
Documentation for API Endpoints #
All URIs are relative to https://api.forestvpn.com/v1
Class | Method | HTTP request | Description |
---|---|---|---|
AppleApi | appleStoreServerNotification | POST /apple/ssn/ | Apple Store Server to Server Notifications |
AppleApi | verifyReceipt | POST /apple/verify-receipt/ | Verify receipt |
DnsApi | lookup | POST /dns/lookup | DNS Lookup |
GeoApi | getCountries | GET /countries/ | List of available countries |
GeoApi | getLocations | GET /locations/ | List of available locations |
UsageApi | getTraffic | GET /usage/traffic/ | Get traffic usage for current month |
UsageApi | trafficUpdate | POST /usage/traffic/ | Usage traffic update |
UserApi | getFeatures | GET /user/features/ | Get active user features |
UserApi | getPreference | GET /user/preference/ | Get user preference |
UserApi | getPremium | GET /user/premium/ | Get premium status details |
UserApi | updatePreference | PATCH /user/preference/ | Update user preference |
WireguardApi | createProfile | POST /wg/profiles/ | Create new WireGuard profile |
WireguardApi | deleteProfile | DELETE /wg/profiles/{profileId}/ | Delete WireGuarg profile |
WireguardApi | getPeers | GET /wg/peers/ | Retrieve Wireguard peers |
WireguardApi | getProfile | GET /wg/profile/ | Retrieve VPN profile |
WireguardApi | getProfileByID | GET /wg/profiles/{profileId}/ | Retrieve WireGuarg profile |
WireguardApi | getProfiles | GET /wg/profiles/ | Retrieve list of WireGuard profiles |
Documentation For Models #
- AppleStoreLatestReceiptInfo
- AppleStorePendingRenewalInfo
- AppleStoreServerNotification
- AppleStoreUnifiedReceipt
- AppleVerifyReceiptRequest
- Country
- Error
- Feature
- GeoPoint
- Location
- Lookup
- LookupRequest
- Preference
- PreferenceUpdateRequest
- Premium
- UsageTraffic
- UsageTrafficUpdateRequest
- User
- WireGuardProfileCreateRequest
- WireguardInterface
- WireguardPeer
- WireguardProfile
Documentation For Authorization #
Bearer #
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header