forestvpn_cloud_api 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35f0fffbd578794c13a1fadf27a00b404ba1ec5c5e7396196f24c1eceab9aa99
-  data.tar.gz: 6f480714e01c5ef48fb9a7c86b9cccd19ad2ec00a13a6bdccd80460e401d51c2
+  metadata.gz: 3c3fd8e416c393d61f1b2bde8d0514e7194dfccf6fd0d5284be0928ea5fc08d1
+  data.tar.gz: 9349977890b05499a6f6b2a185987698fe8e878d0b2736ddb2f7b8aa607748a5
 SHA512:
-  metadata.gz: 258c190afd9ad2ab933291f130db6f2a0c21dc9f20cf51f1243071552d5ac6c625fa188c40a992513bf5a9df72ec7f4ce353cad959f82912366270c4e04eaa24
-  data.tar.gz: 8e487c941266c9395ddb0a6998a456b5f9bf67cd3695648f785432ca85711c23c7e5cf4bd4e8e520db42b71fbb8ebd61ff53dee920f4e21e28f68cc14c8170af
+  metadata.gz: 072d39af59d250880d386baf546a170b05a7d2198e4b81f35a9a147396b533c7bdb1c6e8f8c07e055404bbe072e8d6e6815c07d80d12cd274d5e9c57721903b5
+  data.tar.gz: f1b9d57bde25d13a1fa430800a6bab81378e2f3345351cbb1aebbdedcf302512be38b9833f32c00aaebba6108e420cfb5e058da6b985f0683e54794f49dfc2a8

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 ForestVPN
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,18 +1,49 @@
-# ForestVPN Cloud API
+# forestvpn_cloud_api
 
-The Ruby gem for the ForestVPN Cloud API.
+ForestVPNCloudAPI - 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/)
+For more information, please visit [https://forestvpn.com/](https://forestvpn.com/)
 
 ## Installation
 
-### Install from Gems
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build forestvpn_cloud_api.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./forestvpn_cloud_api-ERSION.gem
+```
+
+(for development, run `gem install --dev ./forestvpn_cloud_api-ERSION.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'forestvpn_cloud_api', '~> ERSION'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the
+Gemfile:
+
+    gem 'forestvpn_cloud_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
 
 ```shell
-gem install forestvpn_cloud_api
+ruby -Ilib script.rb
 ```
 
 ## Getting Started
@@ -133,7 +164,3 @@ PUT** /profiles/{profileId}/limits/data-usages/{limitId}/ | Update profile data
 
 - **Type**: Bearer authentication (JWT)
 
-## Credits
-
-- ForestVPN.com [Free VPN](https://forestvpn.com) for all
-- SpaceV.net [VPN for teams](https://spacev.net)

data/docs/CreateOrUpdateDataUsageLimitRequest.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **duration** | **String** | Duration in ISO 8601 format. Example P7D - per week | [optional] |
-| **value** | **Float** | Limit of bytes | [optional] |
+| **value** | **Integer** | Limit of bytes | [optional] |
 
 ## Example
 

data/docs/DataUsageLimit.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **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) |  |
+| **value** | **Integer** | Value in bytes. For convert to MegaBytes use formula {value} / (1024 * 1024) |  |
 | **scope** | **String** |  |  |
 
 ## Example

data/docs/LimitsApi.md

@@ -7,7 +7,7 @@ All URIs are relative to *https://api.forestvpn.com/cloud/v1*
 | [**create_data_usage_limit**](LimitsApi.md#create_data_usage_limit) | **POST** /limits/data-usage/ | Create data usage limit |
 | [**delete_data_usage_limit**](LimitsApi.md#delete_data_usage_limit) | **DELETE** /limits/data-usage/{limitId}/ | Delete data usage limit |
 | [**get_data_usage_limit**](LimitsApi.md#get_data_usage_limit) | **GET** /limits/data-usage/{limitId}/ | Data usage limit details |
-| [**lis_data_usage_limits**](LimitsApi.md#lis_data_usage_limits) | **GET** /limits/data-usage/ | Data usage limit list |
+| [**list_data_usage_limits**](LimitsApi.md#list_data_usage_limits) | **GET** /limits/data-usage/ | Data usage limit list |
 | [**partial_update_data_usage_limit**](LimitsApi.md#partial_update_data_usage_limit) | **PATCH** /limits/data-usage/{limitId}/ | Partial update profile details |
 | [**update_data_usage_limit**](LimitsApi.md#update_data_usage_limit) | **PUT** /limits/data-usage/{limitId}/ | Update data usage limit |
 
@@ -229,9 +229,9 @@ end
 - **Accept**: application/json
 
 
-## lis_data_usage_limits
+## list_data_usage_limits
 
-> <Array<DataUsageLimit>> lis_data_usage_limits
+> <Array<DataUsageLimit>> list_data_usage_limits
 
 Data usage limit list
 
@@ -255,28 +255,28 @@ api_instance = ForestVPNCloudAPI::LimitsApi.new
 
 begin
   # Data usage limit list
-  result = api_instance.lis_data_usage_limits
+  result = api_instance.list_data_usage_limits
   p result
 rescue ForestVPNCloudAPI::ApiError => e
-  puts "Error when calling LimitsApi->lis_data_usage_limits: #{e}"
+  puts "Error when calling LimitsApi->list_data_usage_limits: #{e}"
 end
 ```
 
-#### Using the lis_data_usage_limits_with_http_info variant
+#### Using the list_data_usage_limits_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<DataUsageLimit>>, Integer, Hash)> lis_data_usage_limits_with_http_info
+> <Array(<Array<DataUsageLimit>>, Integer, Hash)> list_data_usage_limits_with_http_info
 
 ```ruby
 begin
   # Data usage limit list
-  data, status_code, headers = api_instance.lis_data_usage_limits_with_http_info
+  data, status_code, headers = api_instance.list_data_usage_limits_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<DataUsageLimit>>
 rescue ForestVPNCloudAPI::ApiError => e
-  puts "Error when calling LimitsApi->lis_data_usage_limits_with_http_info: #{e}"
+  puts "Error when calling LimitsApi->list_data_usage_limits_with_http_info: #{e}"
 end
 ```
 

data/docs/ProfileStats.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **connections** | **Float** |  |  |
-| **received_bytes** | **Float** |  |  |
-| **transmitted_bytes** | **Float** |  |  |
+| **connections** | **Integer** |  |  |
+| **received_bytes** | **Integer** |  |  |
+| **transmitted_bytes** | **Integer** |  |  |
 | **date** | **Time** |  |  |
 
 ## Example

data/docs/ProfilesApi.md

@@ -561,8 +561,8 @@ opts = {
   aggregate_by: 'hourly', # String | 
   date_after: Date.parse('2013-10-20'), # Date | 
   date_before: Date.parse('2013-10-20'), # Date | 
-  per_page: 8.14, # Float | 
-  page: 8.14 # Float | 
+  per_page: 56, # Integer | 
+  page: 56 # Integer | 
 }
 
 begin
@@ -600,8 +600,8 @@ end
 | **aggregate_by** | **String** |  | [optional] |
 | **date_after** | **Date** |  | [optional] |
 | **date_before** | **Date** |  | [optional] |
-| **per_page** | **Float** |  | [optional] |
-| **page** | **Float** |  | [optional] |
+| **per_page** | **Integer** |  | [optional] |
+| **page** | **Integer** |  | [optional] |
 
 ### Return type
 
@@ -642,8 +642,8 @@ end
 api_instance = ForestVPNCloudAPI::ProfilesApi.new
 opts = {
   external_key: 'external_key_example', # String | 
-  per_page: 8.14, # Float | 
-  page: 8.14 # Float | 
+  per_page: 56, # Integer | 
+  page: 56 # Integer | 
 }
 
 begin
@@ -678,8 +678,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **external_key** | **String** |  | [optional] |
-| **per_page** | **Float** |  | [optional] |
-| **page** | **Float** |  | [optional] |
+| **per_page** | **Integer** |  | [optional] |
+| **page** | **Integer** |  | [optional] |
 
 ### Return type
 

data/lib/forestvpn_cloud_api/api/limits_api.rb

@@ -206,17 +206,17 @@ module ForestVPNCloudAPI
     # Data usage limit list
     # @param [Hash] opts the optional parameters
     # @return [Array<DataUsageLimit>]
-    def lis_data_usage_limits(opts = {})
-      data, _status_code, _headers = lis_data_usage_limits_with_http_info(opts)
+    def list_data_usage_limits(opts = {})
+      data, _status_code, _headers = list_data_usage_limits_with_http_info(opts)
       data
     end
 
     # Data usage limit list
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<DataUsageLimit>, Integer, Hash)>] Array<DataUsageLimit> data, response status code and response headers
-    def lis_data_usage_limits_with_http_info(opts = {})
+    def list_data_usage_limits_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: LimitsApi.lis_data_usage_limits ...'
+        @api_client.config.logger.debug 'Calling API: LimitsApi.list_data_usage_limits ...'
       end
       # resource path
       local_var_path = '/limits/data-usage/'
@@ -242,7 +242,7 @@ module ForestVPNCloudAPI
       auth_names = opts[:debug_auth_names] || ['ApiTokenAuth', 'BearerTokenAuth']
 
       new_options = opts.merge(
-        :operation => :"LimitsApi.lis_data_usage_limits",
+        :operation => :"LimitsApi.list_data_usage_limits",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -253,7 +253,7 @@ module ForestVPNCloudAPI
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: LimitsApi#lis_data_usage_limits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: LimitsApi#list_data_usage_limits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/forestvpn_cloud_api/api/profiles_api.rb

@@ -474,8 +474,8 @@ module ForestVPNCloudAPI
     # @option opts [String] :aggregate_by 
     # @option opts [Date] :date_after 
     # @option opts [Date] :date_before 
-    # @option opts [Float] :per_page 
-    # @option opts [Float] :page 
+    # @option opts [Integer] :per_page 
+    # @option opts [Integer] :page 
     # @return [Array<ProfileStats>]
     def list_profile_stats(profile_id, opts = {})
       data, _status_code, _headers = list_profile_stats_with_http_info(profile_id, opts)
@@ -488,8 +488,8 @@ module ForestVPNCloudAPI
     # @option opts [String] :aggregate_by 
     # @option opts [Date] :date_after 
     # @option opts [Date] :date_before 
-    # @option opts [Float] :per_page 
-    # @option opts [Float] :page 
+    # @option opts [Integer] :per_page 
+    # @option opts [Integer] :page 
     # @return [Array<(Array<ProfileStats>, Integer, Hash)>] Array<ProfileStats> data, response status code and response headers
     def list_profile_stats_with_http_info(profile_id, opts = {})
       if @api_client.config.debugging
@@ -551,8 +551,8 @@ module ForestVPNCloudAPI
     # Profile list
     # @param [Hash] opts the optional parameters
     # @option opts [String] :external_key 
-    # @option opts [Float] :per_page 
-    # @option opts [Float] :page 
+    # @option opts [Integer] :per_page 
+    # @option opts [Integer] :page 
     # @return [Array<Profile>]
     def list_profiles(opts = {})
       data, _status_code, _headers = list_profiles_with_http_info(opts)
@@ -562,8 +562,8 @@ module ForestVPNCloudAPI
     # Profile list
     # @param [Hash] opts the optional parameters
     # @option opts [String] :external_key 
-    # @option opts [Float] :per_page 
-    # @option opts [Float] :page 
+    # @option opts [Integer] :per_page 
+    # @option opts [Integer] :page 
     # @return [Array<(Array<Profile>, Integer, Hash)>] Array<Profile> data, response status code and response headers
     def list_profiles_with_http_info(opts = {})
       if @api_client.config.debugging

data/lib/forestvpn_cloud_api/models/create_or_update_data_usage_limit_request.rb

@@ -38,7 +38,7 @@ module ForestVPNCloudAPI
     def self.openapi_types
       {
         :'duration' => :'String',
-        :'value' => :'Float'
+        :'value' => :'Integer'
       }
     end
 

data/lib/forestvpn_cloud_api/models/data_usage_limit.rb

@@ -67,7 +67,7 @@ module ForestVPNCloudAPI
       {
         :'id' => :'String',
         :'duration' => :'String',
-        :'value' => :'Float',
+        :'value' => :'Integer',
         :'scope' => :'String'
       }
     end

data/lib/forestvpn_cloud_api/models/profile_stats.rb

@@ -45,9 +45,9 @@ module ForestVPNCloudAPI
     def self.openapi_types
       {
         :'id' => :'String',
-        :'connections' => :'Float',
-        :'received_bytes' => :'Float',
-        :'transmitted_bytes' => :'Float',
+        :'connections' => :'Integer',
+        :'received_bytes' => :'Integer',
+        :'transmitted_bytes' => :'Integer',
         :'date' => :'Time'
       }
     end

data/lib/forestvpn_cloud_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.0
 =end
 
 module ForestVPNCloudAPI
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forestvpn_cloud_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Digital Services LLC
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-06 00:00:00.000000000 Z
+date: 2022-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -48,22 +48,22 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 description: '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. '
 email:
@@ -73,6 +73,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - docs/Action.md
@@ -155,7 +156,7 @@ homepage: https://forestvpn.com/
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -170,34 +171,34 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: A package to interact api.forestvpn.com/cloud/ (manage vpn profiles / check
   usage statistics / manage locations / manage servers / etc)
 test_files:
-- spec/api/profiles_api_spec.rb
 - spec/api/geo_api_spec.rb
+- spec/api/profiles_api_spec.rb
 - spec/api/limits_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/models/error_spec.rb
-- spec/models/country_spec.rb
-- spec/models/create_or_update_data_usage_limit_request_spec.rb
-- spec/models/data_usage_limit_spec.rb
 - spec/models/resource_ref_spec.rb
+- spec/models/data_usage_limit_spec.rb
+- spec/models/profile_stats_spec.rb
 - spec/models/project_spec.rb
-- spec/models/activity_spec.rb
+- spec/models/country_spec.rb
+- spec/models/create_billing_request_spec.rb
+- spec/models/create_or_update_data_usage_limit_request_spec.rb
 - spec/models/create_or_update_payment_profile_request_spec.rb
 - spec/models/create_or_update_profile_request_spec.rb
-- spec/models/address_spec.rb
-- spec/models/profile_stats_spec.rb
-- spec/models/profile_spec.rb
 - spec/models/location_spec.rb
-- spec/models/create_billing_request_spec.rb
-- spec/models/billing_spec.rb
 - spec/models/action_spec.rb
-- spec/models/payment_profile_spec.rb
-- spec/models/user_spec.rb
+- spec/models/activity_spec.rb
+- spec/models/profile_spec.rb
 - spec/models/payment_method_spec.rb
+- spec/models/user_spec.rb
+- spec/models/payment_profile_spec.rb
+- spec/models/billing_spec.rb
+- spec/models/address_spec.rb
 - spec/spec_helper.rb