forestvpn_cloud_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35f0fffbd578794c13a1fadf27a00b404ba1ec5c5e7396196f24c1eceab9aa99
+  data.tar.gz: 6f480714e01c5ef48fb9a7c86b9cccd19ad2ec00a13a6bdccd80460e401d51c2
+SHA512:
+  metadata.gz: 258c190afd9ad2ab933291f130db6f2a0c21dc9f20cf51f1243071552d5ac6c625fa188c40a992513bf5a9df72ec7f4ce353cad959f82912366270c4e04eaa24
+  data.tar.gz: 8e487c941266c9395ddb0a6998a456b5f9bf67cd3695648f785432ca85711c23c7e5cf4bd4e8e520db42b71fbb8ebd61ff53dee920f4e21e28f68cc14c8170af

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,139 @@
+# ForestVPN Cloud API
+
+The Ruby gem for the ForestVPN Cloud API.
+
+ForestVPN Cloud - it's a Google Cloud but for VPN apps. Ready to use VPN Cloud Platform minimizes efforts to build fast,
+secure, and modern VPN apps.
+
+For more information, please visit [ForestVPN](https://forestvpn.com/)
+
+## Installation
+
+### Install from Gems
+
+```shell
+gem install forestvpn_cloud_api
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'forestvpn_cloud_api'
+
+# Setup authorization
+ForestVPNCloudAPI.configure do |config|
+  # Configure API key authorization: ApiTokenAuth
+  config.api_key['ApiTokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiTokenAuth'] = 'Bearer'
+
+  # Configure Bearer authorization (JWT): BearerTokenAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ForestVPNCloudAPI::GeoApi.new
+
+begin
+  #Location list
+  result = api_instance.list_locations
+  p result
+rescue ForestVPNCloudAPI::ApiError => e
+  puts "Exception when calling GeoApi->list_locations: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.forestvpn.com/cloud/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ForestVPNCloudAPI::GeoApi* | [**list_locations**](docs/GeoApi.md#list_locations) | **GET** /locations/ | Location list
+*ForestVPNCloudAPI::LimitsApi* | [**create_data_usage_limit**](docs/LimitsApi.md#create_data_usage_limit) | **
+POST** /limits/data-usage/ | Create data usage limit
+*ForestVPNCloudAPI::LimitsApi* | [**delete_data_usage_limit**](docs/LimitsApi.md#delete_data_usage_limit) | **
+DELETE** /limits/data-usage/{limitId}/ | Delete data usage limit
+*ForestVPNCloudAPI::LimitsApi* | [**get_data_usage_limit**](docs/LimitsApi.md#get_data_usage_limit) | **
+GET** /limits/data-usage/{limitId}/ | Data usage limit details
+*ForestVPNCloudAPI::LimitsApi* | [**lis_data_usage_limits**](docs/LimitsApi.md#lis_data_usage_limits) | **
+GET** /limits/data-usage/ | Data usage limit list
+*ForestVPNCloudAPI::LimitsApi* | [**
+partial_update_data_usage_limit**](docs/LimitsApi.md#partial_update_data_usage_limit) | **
+PATCH** /limits/data-usage/{limitId}/ | Partial update profile details
+*ForestVPNCloudAPI::LimitsApi* | [**update_data_usage_limit**](docs/LimitsApi.md#update_data_usage_limit) | **
+PUT** /limits/data-usage/{limitId}/ | Update data usage limit
+*ForestVPNCloudAPI::ProfilesApi* | [**create_profile**](docs/ProfilesApi.md#create_profile) | **
+POST** /profiles/ | Create profile
+*ForestVPNCloudAPI::ProfilesApi* | [**
+create_profile_data_usage_limit**](docs/ProfilesApi.md#create_profile_data_usage_limit) | **
+POST** /profiles/{profileId}/limits/data-usages/ | Create profile data usage limit
+*ForestVPNCloudAPI::ProfilesApi* | [**delete_profile**](docs/ProfilesApi.md#delete_profile) | **
+DELETE** /profiles/{profileId}/ | Delete profile
+*ForestVPNCloudAPI::ProfilesApi* | [**
+delete_profile_data_usage_limit**](docs/ProfilesApi.md#delete_profile_data_usage_limit) | **
+DELETE** /profiles/{profileId}/limits/data-usages/{limitId}/ | Delete profile data usage limit
+*ForestVPNCloudAPI::ProfilesApi* | [**get_profile**](docs/ProfilesApi.md#get_profile) | **
+GET** /profiles/{profileId}/ | Profile details
+*ForestVPNCloudAPI::ProfilesApi* | [**
+get_profile_data_usage_limit**](docs/ProfilesApi.md#get_profile_data_usage_limit) | **
+GET** /profiles/{profileId}/limits/data-usages/{limitId}/ | Profile data usage limit details
+*ForestVPNCloudAPI::ProfilesApi* | [**
+list_profile_data_usage_limits**](docs/ProfilesApi.md#list_profile_data_usage_limits) | **
+GET** /profiles/{profileId}/limits/data-usages/ | Profile data usage limits list
+*ForestVPNCloudAPI::ProfilesApi* | [**list_profile_stats**](docs/ProfilesApi.md#list_profile_stats) | **
+GET** /profiles/{profileId}/stats/ | Profile stats list
+*ForestVPNCloudAPI::ProfilesApi* | [**list_profiles**](docs/ProfilesApi.md#list_profiles) | **
+GET** /profiles/ | Profile list
+*ForestVPNCloudAPI::ProfilesApi* | [**partial_update_profile**](docs/ProfilesApi.md#partial_update_profile) | **
+PATCH** /profiles/{profileId}/ | Partial update profile details
+*ForestVPNCloudAPI::ProfilesApi* | [**
+partial_update_profile_data_usage_limit**](docs/ProfilesApi.md#partial_update_profile_data_usage_limit) | **
+PATCH** /profiles/{profileId}/limits/data-usages/{limitId}/ | Partial update profile data usage limit
+*ForestVPNCloudAPI::ProfilesApi* | [**update_profile**](docs/ProfilesApi.md#update_profile) | **
+PUT** /profiles/{profileId}/ | Update profile details
+*ForestVPNCloudAPI::ProfilesApi* | [**
+update_profile_data_usage_limit**](docs/ProfilesApi.md#update_profile_data_usage_limit) | **
+PUT** /profiles/{profileId}/limits/data-usages/{limitId}/ | Update profile data usage limit
+
+## Documentation for Models
+
+- [ForestVPNCloudAPI::Action](docs/Action.md)
+- [ForestVPNCloudAPI::Activity](docs/Activity.md)
+- [ForestVPNCloudAPI::Address](docs/Address.md)
+- [ForestVPNCloudAPI::Billing](docs/Billing.md)
+- [ForestVPNCloudAPI::Country](docs/Country.md)
+- [ForestVPNCloudAPI::CreateBillingRequest](docs/CreateBillingRequest.md)
+- [ForestVPNCloudAPI::CreateOrUpdateDataUsageLimitRequest](docs/CreateOrUpdateDataUsageLimitRequest.md)
+- [ForestVPNCloudAPI::CreateOrUpdatePaymentProfileRequest](docs/CreateOrUpdatePaymentProfileRequest.md)
+- [ForestVPNCloudAPI::CreateOrUpdateProfileRequest](docs/CreateOrUpdateProfileRequest.md)
+- [ForestVPNCloudAPI::DataUsageLimit](docs/DataUsageLimit.md)
+- [ForestVPNCloudAPI::Error](docs/Error.md)
+- [ForestVPNCloudAPI::Location](docs/Location.md)
+- [ForestVPNCloudAPI::PaymentMethod](docs/PaymentMethod.md)
+- [ForestVPNCloudAPI::PaymentProfile](docs/PaymentProfile.md)
+- [ForestVPNCloudAPI::Profile](docs/Profile.md)
+- [ForestVPNCloudAPI::ProfileStats](docs/ProfileStats.md)
+- [ForestVPNCloudAPI::Project](docs/Project.md)
+- [ForestVPNCloudAPI::ResourceRef](docs/ResourceRef.md)
+- [ForestVPNCloudAPI::User](docs/User.md)
+
+## Documentation for Authorization
+
+### ApiTokenAuth
+
+- **Type**: API key
+- **API key parameter name**: X-API-TOKEN
+- **Location**: HTTP header
+
+### BearerTokenAuth
+
+- **Type**: Bearer authentication (JWT)
+
+## Credits
+
+- ForestVPN.com [Free VPN](https://forestvpn.com) for all
+- SpaceV.net [VPN for teams](https://spacev.net)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Action.md

@@ -0,0 +1,32 @@
+# ForestVPNCloudAPI::Action
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **command** | **String** |  |  |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **status** | **String** |  |  |
+| **progress** | **Float** |  |  |
+| **resources** | [**Array<ResourceRef>**](ResourceRef.md) |  |  |
+| **created_at** | **Time** |  |  |
+| **finished_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'forestvpn_cloud_api'
+
+instance = ForestVPNCloudAPI::Action.new(
+  id: null,
+  command: null,
+  error: null,
+  status: null,
+  progress: null,
+  resources: null,
+  created_at: null,
+  finished_at: null
+)
+```
+

data/docs/Activity.md

@@ -0,0 +1,36 @@
+# ForestVPNCloudAPI::Activity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **action_type** | **String** |  | [optional] |
+| **resource_type** | **String** |  |  |
+| **user** | [**User**](User.md) |  | [optional] |
+| **api_token** | **String** |  | [optional] |
+| **project** | [**Project**](Project.md) |  | [optional] |
+| **source_ip** | **String** | Source IP Address. Last 3 digits is hidden by security reason. |  |
+| **status** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **finished_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'forestvpn_cloud_api'
+
+instance = ForestVPNCloudAPI::Activity.new(
+  id: null,
+  action_type: null,
+  resource_type: null,
+  user: null,
+  api_token: null,
+  project: null,
+  source_ip: null,
+  status: null,
+  created_at: null,
+  finished_at: null
+)
+```
+

data/docs/Address.md

@@ -0,0 +1,28 @@
+# ForestVPNCloudAPI::Address
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **city** | **String** | City, district, suburb, town, or village. | [optional] |
+| **country** | [**Country**](Country.md) |  | [optional] |
+| **line1** | **String** | Address line 1 (e.g., street, PO Box, or company name). | [optional] |
+| **line2** | **String** | Address line 2 (e.g., apartment, suite, unit, or building). | [optional] |
+| **postal_code** | **String** | ZIP or postal code. | [optional] |
+| **state** | **String** | State, county, province, or region. | [optional] |
+
+## Example
+
+```ruby
+require 'forestvpn_cloud_api'
+
+instance = ForestVPNCloudAPI::Address.new(
+  city: null,
+  country: null,
+  line1: null,
+  line2: null,
+  postal_code: null,
+  state: null
+)
+```
+

data/docs/Billing.md

@@ -0,0 +1,24 @@
+# ForestVPNCloudAPI::Billing
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **country** | [**Country**](Country.md) |  |  |
+| **payment_profile** | [**PaymentProfile**](PaymentProfile.md) |  |  |
+
+## Example
+
+```ruby
+require 'forestvpn_cloud_api'
+
+instance = ForestVPNCloudAPI::Billing.new(
+  id: null,
+  name: null,
+  country: null,
+  payment_profile: null
+)
+```
+

data/docs/Country.md

@@ -0,0 +1,26 @@
+# ForestVPNCloudAPI::Country
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **emoji** | **String** |  |  |
+| **currency** | **String** |  |  |
+| **alternative_names** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'forestvpn_cloud_api'
+
+instance = ForestVPNCloudAPI::Country.new(
+  id: null,
+  name: null,
+  emoji: null,
+  currency: null,
+  alternative_names: null
+)
+```
+

data/docs/CreateBillingRequest.md

@@ -0,0 +1,22 @@
+# ForestVPNCloudAPI::CreateBillingRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **country** | **String** |  |  |
+| **payment_profile** | [**CreateOrUpdatePaymentProfileRequest**](CreateOrUpdatePaymentProfileRequest.md) |  |  |
+
+## Example
+
+```ruby
+require 'forestvpn_cloud_api'
+
+instance = ForestVPNCloudAPI::CreateBillingRequest.new(
+  name: null,
+  country: null,
+  payment_profile: null
+)
+```
+

data/docs/CreateOrUpdateDataUsageLimitRequest.md

@@ -0,0 +1,20 @@
+# ForestVPNCloudAPI::CreateOrUpdateDataUsageLimitRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **duration** | **String** | Duration in ISO 8601 format. Example P7D - per week | [optional] |
+| **value** | **Float** | Limit of bytes | [optional] |
+
+## Example
+
+```ruby
+require 'forestvpn_cloud_api'
+
+instance = ForestVPNCloudAPI::CreateOrUpdateDataUsageLimitRequest.new(
+  duration: P7D,
+  value: null
+)
+```
+

data/docs/CreateOrUpdatePaymentProfileRequest.md

@@ -0,0 +1,34 @@
+# ForestVPNCloudAPI::CreateOrUpdatePaymentProfileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tax_number** | **String** | In some situations, your tax status will determine your tax treatment. | [optional] |
+| **business_name** | **String** |  |  |
+| **name** | **String** |  |  |
+| **address_line1** | **String** |  |  |
+| **address_line2** | **String** |  | [optional] |
+| **address_line3** | **String** | Administrative area. Usually it is city or region. |  |
+| **primary_contact_name** | **String** |  |  |
+| **primary_contact_phone** | **String** |  |  |
+| **primary_contact_email** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'forestvpn_cloud_api'
+
+instance = ForestVPNCloudAPI::CreateOrUpdatePaymentProfileRequest.new(
+  tax_number: null,
+  business_name: null,
+  name: null,
+  address_line1: null,
+  address_line2: null,
+  address_line3: null,
+  primary_contact_name: null,
+  primary_contact_phone: null,
+  primary_contact_email: null
+)
+```
+

data/docs/CreateOrUpdateProfileRequest.md

@@ -0,0 +1,22 @@
+# ForestVPNCloudAPI::CreateOrUpdateProfileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_key** | **String** |  | [optional] |
+| **metadata** | **Hash<String, String>** |  | [optional] |
+| **status** | **String** |  | [optional][default to 'suspended'] |
+
+## Example
+
+```ruby
+require 'forestvpn_cloud_api'
+
+instance = ForestVPNCloudAPI::CreateOrUpdateProfileRequest.new(
+  external_key: null,
+  metadata: null,
+  status: null
+)
+```
+

data/docs/DataUsageLimit.md

@@ -0,0 +1,24 @@
+# ForestVPNCloudAPI::DataUsageLimit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **duration** | **String** | Duration in ISO 8601 format. Example P7D - per week |  |
+| **value** | **Float** | Value in bytes. For convert to MegaBytes use formula {value} / (1024 * 1024) |  |
+| **scope** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'forestvpn_cloud_api'
+
+instance = ForestVPNCloudAPI::DataUsageLimit.new(
+  id: null,
+  duration: P7D,
+  value: null,
+  scope: null
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,20 @@
+# ForestVPNCloudAPI::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **message** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'forestvpn_cloud_api'
+
+instance = ForestVPNCloudAPI::Error.new(
+  code: null,
+  message: null
+)
+```
+

data/docs/GeoApi.md

@@ -0,0 +1,77 @@
+# ForestVPNCloudAPI::GeoApi
+
+All URIs are relative to *https://api.forestvpn.com/cloud/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_locations**](GeoApi.md#list_locations) | **GET** /locations/ | Location list |
+
+
+## list_locations
+
+> <Array<Location>> list_locations
+
+Location list
+
+### Examples
+
+```ruby
+require 'time'
+require 'forestvpn_cloud_api'
+# setup authorization
+ForestVPNCloudAPI.configure do |config|
+  # Configure API key authorization: ApiTokenAuth
+  config.api_key['ApiTokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiTokenAuth'] = 'Bearer'
+
+  # Configure Bearer authorization (JWT): BearerTokenAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ForestVPNCloudAPI::GeoApi.new
+
+begin
+  # Location list
+  result = api_instance.list_locations
+  p result
+rescue ForestVPNCloudAPI::ApiError => e
+  puts "Error when calling GeoApi->list_locations: #{e}"
+end
+```
+
+#### Using the list_locations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Location>>, Integer, Hash)> list_locations_with_http_info
+
+```ruby
+begin
+  # Location list
+  data, status_code, headers = api_instance.list_locations_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Location>>
+rescue ForestVPNCloudAPI::ApiError => e
+  puts "Error when calling GeoApi->list_locations_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;Location&gt;**](Location.md)
+
+### Authorization
+
+[ApiTokenAuth](../README.md#ApiTokenAuth), [BearerTokenAuth](../README.md#BearerTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+