forestvpn_api (EXPERIMENTAL)

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.DartDioNextClientCodegen For more information, please visit https://www.forestvpn.com/

Requirements

  • Dart 2.12.0 or later OR Flutter 1.26.0 or later
  • Dio 4.0.0+

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  forestvpn_api: 2.11.10

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  forestvpn_api:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  forestvpn_api:
    path: /path/to/forestvpn_api

Getting Started

Please follow the installation procedure and then run the following:

import 'package:forestvpn_api/forestvpn_api.dart';


final api = ForestvpnApi().getAdsApi();
final CreateAdUnitRequestLogRequest createAdUnitRequestLogRequest = ; // CreateAdUnitRequestLogRequest | 

try {
    final response = await api.createAdUnitRequestLog(createAdUnitRequestLogRequest);
    print(response);
} catch on DioError (e) {
    print("Exception when calling AdsApi->createAdUnitRequestLog: $e\n");
}

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
AdsApicreateAdUnitRequestLogPOST /ads/request-logs/Create ad unit request log
AdsApilistAdPlacementsGET /ads/placements/Get ad placement list
AppleApiverifyAppStoreReceiptPOST /purchase/apple/verify/App store receipt verification
AuthApiloginTokenPOST /auth/token/login/Login with JWT token
AuthApimigrateLegacyAuthGET /legacy/auth/Legacy auth migration
AuthApiobtainTokenGET /auth/token/obtain/Obtain JWT token
AuthApiupdateUserProfilePATCH /auth/profile/Update profile
AuthApiuserProfileGET /auth/profile/Profile
AuthApiwhoAmIGET /auth/whoami/Who am I
BillingApigetBillingBundleGET /billing/bundles/{bundleID}/Bundle info
BillingApigetBillingPaymentMethodGET /billing/payment-methods/{paymentMethodID}/Payment method info
BillingApigetBillingProductGET /billing/products/{productID}/Product info
BillingApilistBillingBundlesGET /billing/bundles/Billing bundles list
BillingApilistBillingFeaturesGET /billing/features/Billing feature list
BillingApilistBillingPaymentMethodsGET /billing/payment-methods/Billing payment methods list
BillingApilistBillingProductsGET /billing/products/Billing products list
CheckoutApiapplyCouponCheckoutSessionPOST /checkout/sessions/{sessionID}/apply_coupon/Apply coupon to session
CheckoutApicreateCheckoutSessionPOST /checkout/sessions/Create checkout session
CheckoutApiexpireCheckoutSessionPOST /checkout/sessions/{sessionID}/expire/Expire checkout session
CheckoutApigetCheckoutSessionGET /checkout/sessions/{sessionID}/Checkout session details
CheckoutApigetStripeCheckoutSessionGET /checkout/sessions/{sessionID}/stripe/checkout/session/Stripe checkout session details
CheckoutApiprocessCloudPaymentsAuthPOST /checkout/sessions/{sessionID}/cloud-payments/auth/Cloud payments auth
CheckoutApiprocessCloudPaymentsPost3dsPOST /checkout/sessions/{sessionID}/cloud-payments/post3ds/Cloud payments post3ds
DeviceApicreateDevicePOST /devices/Create new device
DeviceApicreateDevicePortForwardingPOST /devices/{deviceID}/port-forwarding/Create new device port forwarding
DeviceApideleteDeviceDELETE /devices/{deviceID}/Delete Device
DeviceApideleteDevicePortForwardingDELETE /devices/{deviceID}/port-forwarding/{portForwardingID}/Delete Device's Port Forwarding
DeviceApigetDeviceGET /devices/{deviceID}/Device Info
DeviceApigetDeviceStatsGET /devices/{deviceID}/stats/{statsID}/Device's stats detail
DeviceApigetDeviceWireGuardGET /devices/{deviceID}/wireguards/{wireGuardID}/Device's wireguard profile detail
DeviceApilistDeviceBindingsGET /devices/{deviceID}/bindings/Device bindings
DeviceApilistDeviceConnectionModesGET /devices/{deviceID}/connection-modes/Device connection modes
DeviceApilistDeviceDetailStatsGET /devices/{deviceID}/detail-stats/Device's detail stats list
DeviceApilistDevicePortForwardingsGET /devices/{deviceID}/port-forwarding/Device Port Forwarding List
DeviceApilistDeviceStatsGET /devices/{deviceID}/stats/Device's stats list
DeviceApilistDeviceWireGuardPeersGET /devices/{deviceID}/wireguards/{wireGuardID}/peers/Device's wireguard peers
DeviceApilistDeviceWireGuardsGET /devices/{deviceID}/wireguards/Device's wireguard profiles list
DeviceApilistDevicesGET /devices/Device List
DeviceApiupdateDevicePATCH /devices/{deviceID}/Update device properties
DeviceApiupdateDevicePortForwardingPATCH /devices/{deviceID}/port-forwarding/{portForwardingID}/Update device's port forwarding
FcmApicreateFCMDevicePOST /notification/fcm/Device registration for push notification through out Firebase Cloud Messaging
FcmApideleteFCMDeviceDELETE /notification/fcm/{registrationID}/Delete fcm device
FcmApigetFCMDeviceGET /notification/fcm/{registrationID}/Device info
FcmApiupdateFCMDevicePATCH /notification/fcm/{registrationID}/Update device fcm properties
FriendshipApiacceptFriendshipInvitationPATCH /friendship/invitations/{code}/Accept friendship invitation
FriendshipApicreateFriendshipInvitationPOST /friendship/invitations/Create friendship invitation
FriendshipApideleteFriendDELETE /friendship/friends/{id}/Delete friend
FriendshipApigetFriendGET /friendship/friends/{id}/Friend details
FriendshipApigetFriendshipInvitationGET /friendship/invitations/{code}/Friendship invitation details
FriendshipApilistFriendsGET /friendship/friends/Get friends list
FriendshipApirejectFriendshipInvitationDELETE /friendship/invitations/{code}/Reject friendship invitation
GeoApilistCountriesGET /geo/countries/Countries list
GeoApilistCurrenciesGET /geo/currencies/Correncies list
GeoApilistLocationsGET /locations/Location list
GoogleApiverifyPlayStorePurchasePOST /purchase/google/verify/Play store purchase verification
WireguardApigetWireGuardPeerInfoGET /wireguard/peers/{pubKey}/Wireguard peer info
WireguardApilistWireGuardPeersGET /wireguard/peers/Wireguard peers list

Documentation For Models

Documentation For Authorization

bearerAuth

  • Type: HTTP basic authentication

wireguardAuth

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

Author

support@forestvpn.com

Libraries

forestvpn_api