forestvpn_api 1.0.4

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 OpenAPI Generator project:

• API version: 1.0
• Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://www.forestvpn.com/

Requirements

Dart 2.0 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  forestvpn_api:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your 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';

// TODO Configure API key authorization: Bearer
//defaultApiClient.getAuthentication<ApiKeyAuth>('Bearer').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Bearer').apiKeyPrefix = 'Bearer';

var api_instance = AppleApi();
var notification = 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/profiles/{profileId}/	Retrieve WireGuarg profile
WireguardApi	getProfiles	GET /wg/profiles/	Retrieve list of WireGuard profiles

Documentation For Models

• AndroidDeviceInfo
• AndroidDeviceInfoVersion
• AppleStoreLatestReceiptInfo
• AppleStorePendingRenewalInfo
• AppleStoreServerNotification
• AppleStoreUnifiedReceipt
• AppleVerifyReceiptRequest
• Country
• Error
• Feature
• GeoPoint
• IOSDeviceInfo
• IOSDeviceInfoUtsname
• Location
• Lookup
• LookupRequest
• Preference
• PreferenceUpdateRequest
• Premium
• UsageTraffic
• UsageTrafficUpdateRequest
• WireGuardProfileCreateRequest
• WireguardInterface
• WireguardPeer
• WireguardProfile

Documentation For Authorization

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author

[e-mail]