com.forestvpn.cloud.sdk.client - Kotlin client library for ForestVPN Cloud SDK API

Requires

• Kotlin 1.4.30
• Gradle 6.8.3

Build

First, create the gradle wrapper script:

gradle wrapper

Then, run:

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

• Supports JSON inputs/outputs, File inputs, and Form inputs.
• Supports collection formats for query parameters: csv, tsv, ssv, pipes.
• Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.
• Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets.

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AuthForestVPNCloudSDKAPI	getAccessToken	POST /auth/token/	Get an access token
ProfilesForestVPNCloudSDKAPI	getProfile	GET /profiles/{profileId}/	Profile details
ProfilesForestVPNCloudSDKAPI	getProfileProtocolConfig	GET /profiles/{profileId}/protocols/{protocolId}.conf	Profile protocol config
ProfilesForestVPNCloudSDKAPI	getProfileProtocols	GET /profiles/{profileId}/protocols/	Profile supported protocols

Documentation for Models

• com.forestvpn.cloud.sdk.client.models.AccessToken
• com.forestvpn.cloud.sdk.client.models.AccessTokenRequest
• com.forestvpn.cloud.sdk.client.models.Error
• com.forestvpn.cloud.sdk.client.models.Profile
• com.forestvpn.cloud.sdk.client.models.Protocol

Documentation for Authorization

BearerTokenAuth

• Type: HTTP basic authentication

Credits

• ForestVPN.com Free VPN for all
• SpaceV.net VPN for teams