vpn_api (EXPERIMENTAL)

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

• Dart 2.15.0+ or Flutter 2.8.0+
• Dio 5.0.0+ (https://pub.dev/packages/dio)
• JSON Serializable 6.1.5+ (https://pub.dev/packages/json_serializable)

Installation & Usage

pub.dev

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

dependencies:
  vpn_api: 1.0.0

Github

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

dependencies:
  vpn_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:
  vpn_api:
    path: /path/to/vpn_api

Getting Started

Please follow the installation procedure and then run the following:

import 'package:vpn_api/vpn_api.dart';


final api = VpnApi().getAuthentication();

try {
    final response = await api.authConfig();
    print(response);
} catch on DioException (e) {
    print("Exception when calling Authentication->authConfig: $e\n");
}

Documentation for API Endpoints

All URIs are relative to http://localhost:3030/api/v1

Class	Method	HTTP request	Description
Authentication	authConfig	GET /auth/config	Get authentication configuration
Authentication	checkAuth	GET /auth/check	Get authentication status
Authentication	getActivationStatus	GET /auth/activation/{id}	Get activation request status
Authentication	introspectToken	POST /oauth/introspect	OAuth Token introspection endpoint [RFC 7662]
Authentication	logout	POST /auth/logout	Deletes authentication cookie (effective on web only)
Authentication	redirectMagicLink	GET /magic-link/redirect	Redirect from magic link click
Authentication	requestActivation	POST /auth/activation	Create session activation request
Authentication	requestMagicLink	POST /magic-link	Request magic link
Authentication	token	POST /oauth/token	OAuth Token endpoint [RFC 6749]. Requires Proof Key for Code Exchange (PKCE) [RFC 7636].
Connection	connect	POST /connection/connect	Get Wireguard configuration template given connect options
Connection	connectOpenvpn	POST /connection/connect-openvpn	Get OpenVPN configuration
Connection	connectProxy	POST /connection/connect-proxy	Get proxy configuration given connect options
Connection	connectionConfig	GET /connection/config	Get connection options
Connection	connectionConfigRegions	GET /connection/config/regions	Get connection region options
Connection	connectionLocations	GET /connection/config/locations	Get connection locations
Connection	disconnect	GET /connection/disconnect	Disconnect from the current Wireguard connection
Connection	disconnectAll	GET /connection/disconnect-all	Disconnect all Wireguard connections
Connection	rateConnection	POST /connection/rate-connection	Rate connection
Connection	userIntents	GET /connection/user-intents	List supported user intents
EmailMarketing	contactStatusRequest	GET /email-marketing/contact-status	Get marketing contact status
EmailMarketing	createContactRequest	POST /email-marketing/create-contact	Create marketing contact
EmailMarketing	setMarketingConsent	POST /email-marketing/marketing-consent	Set marketing consent
EmailMarketing	updateContactRequest	POST /email-marketing/update-contact	Update marketing contact
Infrastructure	healthcheck	GET /healthcheck	Check whether the API is up
Location	location	GET /subscription/location	Get location
Subscription	invoices	POST /subscription/invoices	Get invoices list with pagination
Subscription	orderSummary	POST /subscription/order-summary	Preview order summary breakdown
Subscription	subscribe	POST /subscription	Create subscription
Subscription	subscriptionConfig	GET /subscription/config	Get subscription options
Subscription	subscriptionStatus	GET /subscription	Get subscription status
Subscription	subscriptionUserCallback	POST /subscription/user-callback	Post user callback of payment

Documentation For Models

• ActivationAuthorizationRequest
• AuthCheckResponse
• AuthConfigResponse
• AuthorizationDevice
• CheckAuth401Response
• CheckAuth401ResponseError
• CheckAuth401ResponseErrorFieldsValue
• CodeAuthorizationRequest
• ConnectionConfigRegionsQuery
• ConnectionConfigRegionsResponse
• ConnectionConfigRequestQuery
• ConnectionConfigResponse
• ConnectionKilledMessage
• ConnectionLocation
• ConnectionLocationCity
• ConnectionLocationsRequestQuery
• ConnectionMessage
• ConnectionMessageLocation
• ConnectionRegion
• ContactStatusResponse
• Country
• CreateAdyenSubscriptionRequest
• CreateAdyenSubscriptionResponse
• CreateAppleSubscriptionRequest
• CreateAppleSubscriptionResponse
• CreateContactRequest
• CreateGenericSubscriptionRequest
• CreateGenericSubscriptionResponse
• CreateGoogleSubscriptionRequest
• CreateGoogleSubscriptionResponse
• DisconnectQuery
• GetLocationResponse
• GetSubscriptionResponse
• Healthcheck200Response
• HealthcheckMessage
• HealthcheckResponse
• HttpsConnectRequest
• Invoice
• InvoicesRequest
• InvoicesResponse
• InvoicesResponsePaging
• LocationRate
• MagicLinkRedirectRequestQuery
• MagicLinkRequest
• MagicLinkResponse
• MarketingPermissionsRequest
• OAuth2AuthorizationRequest
• OAuth2AuthorizationResponse
• OAuth2TokenIntrospectionRequest
• OAuth2TokenIntrospectionResponse
• OAuth2TokenRequest
• OAuth2TokenRequestOneOf
• OAuth2TokenRequestOneOf1
• OAuth2TokenRequestOneOf2
• OAuth2TokenRequestOneOf3
• OAuth2TokenRequestOneOf3Authorization
• OAuth2TokenResponse
• OpenVpnConnectRequest
• OpenVpnConnectResponse
• OrderSummaryRequest
• OrderSummaryResponse
• ProxyConnectResponse
• ProxyConnectResponseProxyConfig
• RateConnectionRequest
• RequestActivation200Response
• RequestActivationRequest
• Subscribe200Response
• SubscribeRequest
• SubscriptionConfigResponse
• SubscriptionConfigResponseGatewaysInner
• SubscriptionConfigResponsePlansInner
• SubscriptionConfigResponsePlansInnerInterval
• SubscriptionConfigResponsePlansInnerPrice
• SubscriptionConfigResponsePlansInnerPricesInner
• UpdateContactRequest
• UserCallbackRequest
• WireguardConnectRequest
• WireguardConnectResponse

Documentation For Authorization

Endpoints do not require authorization.

Author