forestvpn_api 2.6.3 copy "forestvpn_api: ^2.6.3" to clipboard
forestvpn_api: ^2.6.3 copied to clipboard

outdated

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: 2.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 HTTP Bearer authorization: bearerAuth
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AppleApi();
final appStoreReceiptVerificationRequest = AppStoreReceiptVerificationRequest(); // AppStoreReceiptVerificationRequest | 

try {
    api_instance.verifyAppStoreReceipt(appStoreReceiptVerificationRequest);
} catch (e) {
    print('Exception when calling AppleApi->verifyAppStoreReceipt: $e\n');
}

Documentation for API Endpoints #

All URIs are relative to https://api.forestvpn.com/v2

Class Method HTTP request Description
AppleApi verifyAppStoreReceipt POST /purchase/apple/verify/ App store receipt verification
AuthApi migrateLegacyAuth GET /legacy/auth/ Legacy auth migration
AuthApi whoAmI GET /auth/whoami/ Who am I
BillingApi listBillingFeatures GET /billing/features/ Billing feature list
DeviceApi createDevice POST /devices/ Create new device
DeviceApi createDevicePortForwarding POST /devices/{deviceID}/port-forwarding/ Create new device port forwarding
DeviceApi deleteDevice DELETE /devices/{deviceID}/ Delete Device
DeviceApi deleteDevicePortForwarding DELETE /devices/{deviceID}/port-forwarding/{portForwardingID}/ Delete Device's Port Forwarding
DeviceApi getDevice GET /devices/{deviceID}/ Device Info
DeviceApi getDeviceStats GET /devices/{deviceID}/stats/{statsID}/ Device's stats detail
DeviceApi getDeviceWireGuard GET /devices/{deviceID}/wireguards/{wireGuardID}/ Device's wireguard profile detail
DeviceApi listDeviceBindings GET /devices/{deviceID}/bindings/ Device bindings
DeviceApi listDeviceConnectionModes GET /devices/{deviceID}/connection-modes/ Device connection modes
DeviceApi listDeviceDetailStats GET /devices/{deviceID}/detail-stats/ Device's detail stats list
DeviceApi listDevicePortForwardings GET /devices/{deviceID}/port-forwarding/ Device Port Forwarding List
DeviceApi listDeviceStats GET /devices/{deviceID}/stats/ Device's stats list
DeviceApi listDeviceWireGuards GET /devices/{deviceID}/wireguards/ Device's wireguard profiles list
DeviceApi listDevices GET /devices/ Device List
DeviceApi updateDevice PATCH /devices/{deviceID}/ Update device properties
DeviceApi updateDevicePortForwarding PATCH /devices/{deviceID}/port-forwarding/{portForwardingID}/ Update device's port forwarding
FcmApi createFCMDevice POST /notification/fcm/ Device registration for push notification through out Firebase Cloud Messaging
FcmApi deleteFCMDevice DELETE /notification/fcm/{registrationID}/ Delete fcm device
FcmApi getFCMDevice GET /notification/fcm/{registrationID}/ Device info
FcmApi updateFCMDevice PATCH /notification/fcm/{registrationID}/ Update device fcm properties
FriendshipApi acceptFriendshipInvitation PATCH /friendship/invitations/{code}/ Accept friendship invitation
FriendshipApi createFriendshipInvitation POST /friendship/invitations/ Create friendship invitation
FriendshipApi deleteFriend DELETE /friendship/friends/{id}/ Delete friend
FriendshipApi getFriend GET /friendship/friends/{id}/ Friend details
FriendshipApi getFriendshipInvitation GET /friendship/invitations/{code}/ Friendship invitation details
FriendshipApi listFriends GET /friendship/friends/ Get friends list
FriendshipApi rejectFriendshipInvitation DELETE /friendship/invitations/{code}/ Reject friendship invitation
GeoApi listLocations GET /locations/ Location list
GoogleApi verifyPlayStorePurchase POST /purchase/google/verify/ Play store purchase verification
WireguardApi getWireGuardPeerInfo GET /wireguard/peers/{pubKey}/ Wireguard peer info

Documentation For Models #

Documentation For Authorization #

bearerAuth #

  • Type: HTTP Bearer authentication

Author #

support@forestvpn.com

8
likes
0
points
257
downloads

Publisher

verified publisherforestvpn.com

Weekly Downloads

A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)

Homepage

License

unknown (license)

Dependencies

http, intl, meta

More

Packages that depend on forestvpn_api