vgs_api_client 0.0.28 → 0.0.35

data/spec/spec_helper.rb

@@ -1,12 +1,12 @@
 =begin
 #Vault HTTP API
 
-#Storing, retrieving, and managing sensitive data within a VGS organization.  **NOTE:** _The Vault API is intended only for environments that are already PCI-compliant. If you want to use this API, but are not yet PCI-compliant, you can use [VGS Collect](https://www.verygoodsecurity.com/docs/vgs-collect/what-is-it) or VGS Proxy with [Inbound Routes](https://www.verygoodsecurity.com/docs/getting-started/quick-integration#securing-inbound-connection) to quickly and seamlessly achieve compliance._  Looking for the old version of the API? Find it [here](https://www.verygoodsecurity.com/docs/api/1/vault).  # Introduction  Each encrypted value stored in a VGS vault has one or multiple _aliases_ associated with it. These aliases are fully opaque and retain no information about the underlying data. The user may safely store aliases without compromising data security.  **NOTE:** The API works with persistent storage only. Unlike volatile storage, this means that the data is stored permanently, without any implicit TTL.  Aliases are not valuable on their own. However, they can be used to decrypt the associated value and pass it to another service via the [forward proxy](https://www.verygoodsecurity.com/docs/guides/outbound-connection).  ## Alias Formats  Each alias corresponds to a certain format. There are several alias formats suitable for different kinds of sensitive data.  For example, `UUID` produces a random Base58-encoded UUID string with an environment-dependent prefix:  ``` tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e ```  This format is generic and suitable for any kind of data.  The tables below contain descriptions of all alias formats recognized by the API.  ### Generic Formats  | Value                   | Description                                           | |-------------------------|-------------------------------------------------------| | `NUM_LENGTH_PRESERVING` | Length-Preserving, Numeric                            | | `RAW_UUID`              | UUID                                                  | | `UUID`                  | UUID (Prefixed, Base58-Encoded)                       | | `GENERIC_T_FOUR`        | UUID (Prefixed, Base58-Encoded, Last four preserving) |  ### Account Number Formats  | Value                             | Description                          | |-----------------------------------|--------------------------------------| | `FPE_ACC_NUM_T_FOUR`              | Length-Preserving, Numeric (A4)      | | `FPE_ALPHANUMERIC_ACC_NUM_T_FOUR` | Length-Preserving, Alphanumeric (A4) |   ### Payment Card Formats  | Value            | Description                                 | |------------------|---------------------------------------------| | `FPE_SIX_T_FOUR` | Format-Preserving, Luhn Valid (6T4)         | | `FPE_T_FOUR`     | Format-Preserving, Luhn Valid (T4)          | | `PFPT`           | Prefixed, Luhn Valid, 19-Digit Fixed Length |  ### SSN Formats  | Value            | Description            | |------------------|------------------------| | `FPE_SSN_T_FOUR` | Format-Preserving (A4) |  # Authentication  This API uses `Basic` authentication.  Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing.  [Docs » Guides » Access credentials](https://www.verygoodsecurity.com/docs/settings/access-credentials)  # Rate Limiting  The API allows up to 3,000 requests per minute. Requests are associated with the vault, regardless of the access credentials used to authenticate the request.  Your current rate limit is included as HTTP headers in every API response:  | Header Name             | Description                                              | |-------------------------|----------------------------------------------------------| | `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. |  If you exceed the rate limit, the API will reject the request with HTTP [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).  # Errors  The API uses standard HTTP status codes to indicate whether the request succeeded or not.  In case of failure, the response body will be JSON in a predefined format. For example, trying to create too many aliases at once results in the following response:  ```json {     \"errors\": [         {             \"status\": 400,             \"title\": \"Bad request\",             \"detail\": \"Too many values (limit: 20)\",             \"href\": \"https://api.sandbox.verygoodvault.com/aliases\"         }     ] } ``` 
+#The VGS Vault HTTP API is used for storing, retrieving, and managing sensitive data (aka Tokenization) within a VGS Vault.  The VGS API is organized around REST. Our API is built with a predictable resource-oriented structure, uses JSON-encoded requests and responses, follows standard HTTP verbs/responses, and uses industry standard authentication.  ## What is VGS  Storing sensitive data on your company’s infrastructure often comes with a heavy compliance burden. For instance, storing payments data yourself greatly increases the amount of work needed to become PCI compliant. It also increases your security risk in general. To combat this, companies will minimize the amount of sensitive information they have to handle or store.  VGS provides multiple methods for minimizing the sensitive information that needs to be stored which allows customers to secure any type of data for any use-case.  **Tokenization** is a method that focuses on securing the storage of data. This is the quickest way to get started and is free. [Get started with Tokenization](https://www.verygoodsecurity.com/docs/tokenization/getting-started).  **Zero Data** is a unique method invented by VGS in 2016 that securely stores data like Tokenization, however it also removes the customer’s environment from PCI scope completely providing maximum security, and minimum compliance scope. [Get started with Zero Data](https://www.verygoodsecurity.com/docs/getting-started/before-you-start).  Additionally, for scenarios where neither technology is a complete solution, for instance with legacy systems, VGS provides a compliance product which guarantees customers are able to meet their compliance needs no matter what may happen. [Get started with Control](https://www.verygoodsecurity.com/docs/control).  ## Learn about Tokenization  - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)  ### Authentication  This API uses `Basic` authentication.  Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing.  [Docs » Guides » Access credentials](https://www.verygoodsecurity.com/docs/settings/access-credentials)  ## Resource Limits  ### Data Limits  This API allows storing data up to 32MB in size.  ### Rate Limiting  The API allows up to 3,000 requests per minute. Requests are associated with the vault, regardless of the access credentials used to authenticate the request.  Your current rate limit is included as HTTP headers in every API response:  | Header Name             | Description                                              | |-------------------------|----------------------------------------------------------| | `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. |  If you exceed the rate limit, the API will reject the request with HTTP [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).  ### Errors  The API uses standard HTTP status codes to indicate whether the request succeeded or not.  In case of failure, the response body will be JSON in a predefined format. For example, trying to create too many aliases at once results in the following response:  ```json {     \"errors\": [         {             \"status\": 400,             \"title\": \"Bad request\",             \"detail\": \"Too many values (limit: 20)\",             \"href\": \"https://api.sandbox.verygoodvault.com/aliases\"         }     ] } ``` 
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@verygoodsecurity.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0-SNAPSHOT
+OpenAPI Generator version: 5.4.0
 
 =end
 

data/spec/test_api_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+require 'securerandom'
+require 'vgs'
+
+describe 'AliasesApiSpec' do
+  before(:all) do
+    config = VGS.config(username = ENV["VAULT_API_USERNAME"], password = ENV["VAULT_API_PASSWORD"])
+    @aliases_api = VGS::Aliases.new(config)
+  end
+
+  describe 'redact' do
+    it 'should redact values' do
+      data = [
+        {
+          :format => 'UUID',
+          :value => '5201784564572092',
+          :classifiers => %w[credit-card number],
+          :storage => 'PERSISTENT',
+        },
+        {
+          :format => 'UUID',
+          :value => 'Joe Doe',
+          :storage => 'VOLATILE',
+        }
+      ]
+      aliases = @aliases_api.redact(data)
+      expect(aliases.length).to eq 2
+      data.each_with_index do |item, index|
+        expect(aliases[index].value).to eq item[:value]
+        expect(aliases[index].storage).to eq item[:storage]
+        expect(aliases[index].aliases[0]._alias).to start_with "tok_"
+      end
+      expect(Set.new(aliases[0].classifiers)).to eq Set.new(%w[credit-card number])
+      expect(Set.new(aliases[1].classifiers)).to eq Set.new
+    end
+  end
+
+  describe 'reveal' do
+    it 'should reveal aliases' do
+      data = [
+        {
+          :format => 'UUID',
+          :value => '5201784564572092',
+          :classifiers => %w[credit-card number],
+          :storage => 'PERSISTENT',
+        },
+        {
+          :format => 'UUID',
+          :value => 'Joe Doe',
+          :storage => 'VOLATILE',
+        }
+      ]
+      aliases = @aliases_api.redact(data).map { |item| item.aliases[0]._alias }
+
+      response = @aliases_api.reveal(aliases)
+
+      expect(response.length).to eq 2
+      original_values = data.map { |i| i[:value] }
+      revealed_values = response.values.map { |i| i.value }
+      expect(Set.new(original_values)).to eq Set.new(revealed_values)
+    end
+  end
+
+  describe 'update' do
+    it 'should update alias' do
+      data = [
+        {
+          :format => 'UUID',
+          :value => SecureRandom.alphanumeric(10),
+        }
+      ]
+      _alias = @aliases_api.redact(data).map { |item| item.aliases[0]._alias }[0]
+
+      @aliases_api.update(_alias = _alias, data = { :classifiers => ["secure"] })
+
+      response = @aliases_api.reveal(_alias)
+      expect(response[_alias].classifiers).to eq %w[secure]
+    end
+  end
+
+  describe 'delete' do
+    it 'should delete alias' do
+      data = [
+        {
+          :format => 'UUID',
+          :value => '5201784564572092',
+        }
+      ]
+      _alias = @aliases_api.redact(data).map { |item| item.aliases[0]._alias }[0]
+
+      @aliases_api.delete(_alias = _alias)
+
+      expect { @aliases_api.reveal(_alias) }.to raise_error(VGS::VgsApiException)
+    end
+  end
+
+end

data/vgs_api_client.gemspec

@@ -3,12 +3,12 @@
 =begin
 #Vault HTTP API
 
-#Storing, retrieving, and managing sensitive data within a VGS organization.  **NOTE:** _The Vault API is intended only for environments that are already PCI-compliant. If you want to use this API, but are not yet PCI-compliant, you can use [VGS Collect](https://www.verygoodsecurity.com/docs/vgs-collect/what-is-it) or VGS Proxy with [Inbound Routes](https://www.verygoodsecurity.com/docs/getting-started/quick-integration#securing-inbound-connection) to quickly and seamlessly achieve compliance._  Looking for the old version of the API? Find it [here](https://www.verygoodsecurity.com/docs/api/1/vault).  # Introduction  Each encrypted value stored in a VGS vault has one or multiple _aliases_ associated with it. These aliases are fully opaque and retain no information about the underlying data. The user may safely store aliases without compromising data security.  **NOTE:** The API works with persistent storage only. Unlike volatile storage, this means that the data is stored permanently, without any implicit TTL.  Aliases are not valuable on their own. However, they can be used to decrypt the associated value and pass it to another service via the [forward proxy](https://www.verygoodsecurity.com/docs/guides/outbound-connection).  ## Alias Formats  Each alias corresponds to a certain format. There are several alias formats suitable for different kinds of sensitive data.  For example, `UUID` produces a random Base58-encoded UUID string with an environment-dependent prefix:  ``` tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e ```  This format is generic and suitable for any kind of data.  The tables below contain descriptions of all alias formats recognized by the API.  ### Generic Formats  | Value                   | Description                                           | |-------------------------|-------------------------------------------------------| | `NUM_LENGTH_PRESERVING` | Length-Preserving, Numeric                            | | `RAW_UUID`              | UUID                                                  | | `UUID`                  | UUID (Prefixed, Base58-Encoded)                       | | `GENERIC_T_FOUR`        | UUID (Prefixed, Base58-Encoded, Last four preserving) |  ### Account Number Formats  | Value                             | Description                          | |-----------------------------------|--------------------------------------| | `FPE_ACC_NUM_T_FOUR`              | Length-Preserving, Numeric (A4)      | | `FPE_ALPHANUMERIC_ACC_NUM_T_FOUR` | Length-Preserving, Alphanumeric (A4) |   ### Payment Card Formats  | Value            | Description                                 | |------------------|---------------------------------------------| | `FPE_SIX_T_FOUR` | Format-Preserving, Luhn Valid (6T4)         | | `FPE_T_FOUR`     | Format-Preserving, Luhn Valid (T4)          | | `PFPT`           | Prefixed, Luhn Valid, 19-Digit Fixed Length |  ### SSN Formats  | Value            | Description            | |------------------|------------------------| | `FPE_SSN_T_FOUR` | Format-Preserving (A4) |  # Authentication  This API uses `Basic` authentication.  Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing.  [Docs » Guides » Access credentials](https://www.verygoodsecurity.com/docs/settings/access-credentials)  # Rate Limiting  The API allows up to 3,000 requests per minute. Requests are associated with the vault, regardless of the access credentials used to authenticate the request.  Your current rate limit is included as HTTP headers in every API response:  | Header Name             | Description                                              | |-------------------------|----------------------------------------------------------| | `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. |  If you exceed the rate limit, the API will reject the request with HTTP [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).  # Errors  The API uses standard HTTP status codes to indicate whether the request succeeded or not.  In case of failure, the response body will be JSON in a predefined format. For example, trying to create too many aliases at once results in the following response:  ```json {     \"errors\": [         {             \"status\": 400,             \"title\": \"Bad request\",             \"detail\": \"Too many values (limit: 20)\",             \"href\": \"https://api.sandbox.verygoodvault.com/aliases\"         }     ] } ``` 
+#The VGS Vault HTTP API is used for storing, retrieving, and managing sensitive data (aka Tokenization) within a VGS Vault.  The VGS API is organized around REST. Our API is built with a predictable resource-oriented structure, uses JSON-encoded requests and responses, follows standard HTTP verbs/responses, and uses industry standard authentication.  ## What is VGS  Storing sensitive data on your company’s infrastructure often comes with a heavy compliance burden. For instance, storing payments data yourself greatly increases the amount of work needed to become PCI compliant. It also increases your security risk in general. To combat this, companies will minimize the amount of sensitive information they have to handle or store.  VGS provides multiple methods for minimizing the sensitive information that needs to be stored which allows customers to secure any type of data for any use-case.  **Tokenization** is a method that focuses on securing the storage of data. This is the quickest way to get started and is free. [Get started with Tokenization](https://www.verygoodsecurity.com/docs/tokenization/getting-started).  **Zero Data** is a unique method invented by VGS in 2016 that securely stores data like Tokenization, however it also removes the customer’s environment from PCI scope completely providing maximum security, and minimum compliance scope. [Get started with Zero Data](https://www.verygoodsecurity.com/docs/getting-started/before-you-start).  Additionally, for scenarios where neither technology is a complete solution, for instance with legacy systems, VGS provides a compliance product which guarantees customers are able to meet their compliance needs no matter what may happen. [Get started with Control](https://www.verygoodsecurity.com/docs/control).  ## Learn about Tokenization  - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)  ### Authentication  This API uses `Basic` authentication.  Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing.  [Docs » Guides » Access credentials](https://www.verygoodsecurity.com/docs/settings/access-credentials)  ## Resource Limits  ### Data Limits  This API allows storing data up to 32MB in size.  ### Rate Limiting  The API allows up to 3,000 requests per minute. Requests are associated with the vault, regardless of the access credentials used to authenticate the request.  Your current rate limit is included as HTTP headers in every API response:  | Header Name             | Description                                              | |-------------------------|----------------------------------------------------------| | `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. |  If you exceed the rate limit, the API will reject the request with HTTP [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).  ### Errors  The API uses standard HTTP status codes to indicate whether the request succeeded or not.  In case of failure, the response body will be JSON in a predefined format. For example, trying to create too many aliases at once results in the following response:  ```json {     \"errors\": [         {             \"status\": 400,             \"title\": \"Bad request\",             \"detail\": \"Too many values (limit: 20)\",             \"href\": \"https://api.sandbox.verygoodvault.com/aliases\"         }     ] } ``` 
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@verygoodsecurity.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0-SNAPSHOT
+OpenAPI Generator version: 5.4.0
 
 =end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vgs_api_client
 version: !ruby/object:Gem::Version
-  version: 0.0.28
+  version: 0.0.35
 platform: ruby
 authors:
 - Very Good Security
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -57,25 +57,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- DEVELOPMENT.md
 - Gemfile
-- README.md
+- LICENSE
+- RELEASE.md
 - Rakefile
 - docker-compose.yaml
-- docs/AliasFormat.md
-- docs/AliasesApi.md
-- docs/ApiError.md
-- docs/CreateAliasesRequest.md
-- docs/CreateAliasesRequestExisting.md
-- docs/CreateAliasesRequestNew.md
-- docs/InlineResponse200.md
-- docs/InlineResponse2001.md
-- docs/InlineResponse201.md
-- docs/InlineResponseDefault.md
-- docs/ModelAlias.md
-- docs/RevealedData.md
-- docs/UpdateAliasRequest.md
-- docs/UpdateAliasRequestData.md
-- git_push.sh
+- lib/vgs.rb
 - lib/vgs_api_client.rb
 - lib/vgs_api_client/api/aliases_api.rb
 - lib/vgs_api_client/api_client.rb
@@ -84,8 +72,8 @@ files:
 - lib/vgs_api_client/models/alias_format.rb
 - lib/vgs_api_client/models/api_error.rb
 - lib/vgs_api_client/models/create_aliases_request.rb
-- lib/vgs_api_client/models/create_aliases_request_existing.rb
 - lib/vgs_api_client/models/create_aliases_request_new.rb
+- lib/vgs_api_client/models/create_aliases_request_reference.rb
 - lib/vgs_api_client/models/inline_response200.rb
 - lib/vgs_api_client/models/inline_response2001.rb
 - lib/vgs_api_client/models/inline_response201.rb
@@ -95,27 +83,19 @@ files:
 - lib/vgs_api_client/models/update_alias_request.rb
 - lib/vgs_api_client/models/update_alias_request_data.rb
 - lib/vgs_api_client/version.rb
-- publish/Dockerfile
-- publish/build_and_publish.sh
-- spec/api/aliases_api_spec.rb
-- spec/api/test_api_spec.rb
+- scripts/assemble/Dockerfile
+- scripts/assemble/run.sh
+- scripts/publish.sh
+- scripts/publish/Dockerfile
+- scripts/publish/run.sh
+- scripts/run-tests-e2e.sh
+- scripts/run-tests.sh
+- scripts/test/Dockerfile
+- scripts/test/run.sh
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
-- spec/models/alias_format_spec.rb
-- spec/models/api_error_spec.rb
-- spec/models/create_aliases_request_existing_spec.rb
-- spec/models/create_aliases_request_new_spec.rb
-- spec/models/create_aliases_request_spec.rb
-- spec/models/inline_response2001_spec.rb
-- spec/models/inline_response200_spec.rb
-- spec/models/inline_response201_spec.rb
-- spec/models/inline_response_default_spec.rb
-- spec/models/model_alias_spec.rb
-- spec/models/revealed_data_spec.rb
-- spec/models/update_alias_request_data_spec.rb
-- spec/models/update_alias_request_spec.rb
 - spec/spec_helper.rb
-- test/Dockerfile
+- spec/test_api_spec.rb
 - vgs_api_client.gemspec
 homepage: https://openapi-generator.tech
 licenses:
@@ -141,21 +121,7 @@ signing_key:
 specification_version: 4
 summary: A ruby wrapper for the VGS Vault API
 test_files:
-- spec/api/test_api_spec.rb
-- spec/api/aliases_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
-- spec/models/create_aliases_request_new_spec.rb
-- spec/models/revealed_data_spec.rb
-- spec/models/create_aliases_request_spec.rb
-- spec/models/inline_response2001_spec.rb
-- spec/models/update_alias_request_data_spec.rb
-- spec/models/inline_response_default_spec.rb
-- spec/models/model_alias_spec.rb
-- spec/models/inline_response201_spec.rb
-- spec/models/inline_response200_spec.rb
-- spec/models/create_aliases_request_existing_spec.rb
-- spec/models/api_error_spec.rb
-- spec/models/update_alias_request_spec.rb
-- spec/models/alias_format_spec.rb
 - spec/spec_helper.rb
+- spec/test_api_spec.rb

data/README.md

@@ -1,237 +0,0 @@
-# vgs_api_client
-
-VgsApiClient - the Ruby gem for the Vault HTTP API
-
-Storing, retrieving, and managing sensitive data within a VGS organization.
-
-**NOTE:** _The Vault API is intended only for environments that are already PCI-compliant.
-If you want to use this API, but are not yet PCI-compliant, you can
-use [VGS Collect](https://www.verygoodsecurity.com/docs/vgs-collect/what-is-it) or
-VGS Proxy with [Inbound Routes](https://www.verygoodsecurity.com/docs/getting-started/quick-integration#securing-inbound-connection)
-to quickly and seamlessly achieve compliance._
-
-Looking for the old version of the API? Find it
-[here](https://www.verygoodsecurity.com/docs/api/1/vault).
-
-# Introduction
-
-Each encrypted value stored in a VGS vault has one or multiple _aliases_
-associated with it. These aliases are fully opaque and retain no information
-about the underlying data. The user may safely store aliases without
-compromising data security.
-
-**NOTE:** The API works with persistent storage only. Unlike volatile
-storage, this means that the data is stored permanently, without any
-implicit TTL.
-
-Aliases are not valuable on their own. However, they can be used to decrypt
-the associated value and pass it to another service via the
-[forward proxy](https://www.verygoodsecurity.com/docs/guides/outbound-connection).
-
-## Alias Formats
-
-Each alias corresponds to a certain format. There are several alias formats
-suitable for different kinds of sensitive data.
-
-For example, `UUID` produces a random Base58-encoded UUID string with an
-environment-dependent prefix:
-
-```
-tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e
-```
-
-This format is generic and suitable for any kind of data.
-
-The tables below contain descriptions of all alias formats recognized by the
-API.
-
-### Generic Formats
-
-| Value                   | Description                                           |
-|-------------------------|-------------------------------------------------------|
-| `NUM_LENGTH_PRESERVING` | Length-Preserving, Numeric                            |
-| `RAW_UUID`              | UUID                                                  |
-| `UUID`                  | UUID (Prefixed, Base58-Encoded)                       |
-| `GENERIC_T_FOUR`        | UUID (Prefixed, Base58-Encoded, Last four preserving) |
-
-### Account Number Formats
-
-| Value                             | Description                          |
-|-----------------------------------|--------------------------------------|
-| `FPE_ACC_NUM_T_FOUR`              | Length-Preserving, Numeric (A4)      |
-| `FPE_ALPHANUMERIC_ACC_NUM_T_FOUR` | Length-Preserving, Alphanumeric (A4) |
-
-
-### Payment Card Formats
-
-| Value            | Description                                 |
-|------------------|---------------------------------------------|
-| `FPE_SIX_T_FOUR` | Format-Preserving, Luhn Valid (6T4)         |
-| `FPE_T_FOUR`     | Format-Preserving, Luhn Valid (T4)          |
-| `PFPT`           | Prefixed, Luhn Valid, 19-Digit Fixed Length |
-
-### SSN Formats
-
-| Value            | Description            |
-|------------------|------------------------|
-| `FPE_SSN_T_FOUR` | Format-Preserving (A4) |
-
-# Authentication
-
-This API uses `Basic` authentication.
-
-Credentials to access the API can be generated on the
-[dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings
-section of the vault of your choosing.
-
-[Docs » Guides » Access credentials](https://www.verygoodsecurity.com/docs/settings/access-credentials)
-
-# Rate Limiting
-
-The API allows up to 3,000 requests per minute. Requests are associated with
-the vault, regardless of the access credentials used to authenticate the
-request.
-
-Your current rate limit is included as HTTP headers in every API response:
-
-| Header Name             | Description                                              |
-|-------------------------|----------------------------------------------------------|
-| `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. |
-
-If you exceed the rate limit, the API will reject the request with HTTP
-[429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).
-
-# Errors
-
-The API uses standard HTTP status codes to indicate whether the request
-succeeded or not.
-
-In case of failure, the response body will be JSON in a predefined format.
-For example, trying to create too many aliases at once results in the
-following response:
-
-```json
-{
-    \"errors\": [
-        {
-            \"status\": 400,
-            \"title\": \"Bad request\",
-            \"detail\": \"Too many values (limit: 20)\",
-            \"href\": \"https://api.sandbox.verygoodvault.com/aliases\"
-        }
-    ]
-}
-```
-
-
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
-
-- API version: 1.0.0
-- Package version: 0.0.28
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
-
-## Installation
-
-### Build a gem
-
-To build the Ruby code into a gem:
-
-```shell
-gem build vgs_api_client.gemspec
-```
-
-Then either install the gem locally:
-
-```shell
-gem install ./vgs_api_client-0.0.28.gem
-```
-
-(for development, run `gem install --dev ./vgs_api_client-0.0.28.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 'vgs_api_client', '~> 0.0.28'
-
-### Install from Git
-
-If the Ruby gem is hosted at a git repository: https://github.com/verygoodsecurity/vgs-api-client-ruby, then add the following in the Gemfile:
-
-    gem 'vgs_api_client', :git => 'https://github.com/verygoodsecurity/vgs-api-client-ruby.git'
-
-### Include the Ruby code directly
-
-Include the Ruby code directly using `-I` as follows:
-
-```shell
-ruby -Ilib script.rb
-```
-
-## Getting Started
-
-Please follow the [installation](#installation) procedure and then run the following code:
-
-```ruby
-# Load the gem
-require 'vgs_api_client'
-
-# Setup authorization
-VgsApiClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR_USERNAME'
-  config.password = 'YOUR_PASSWORD'
-end
-
-api_instance = VgsApiClient::AliasesApi.new
-opts = {
-  create_aliases_request: VgsApiClient::CreateAliasesRequest.new({data: [TODO]}) # CreateAliasesRequest | 
-}
-
-begin
-  #Create aliases
-  result = api_instance.create_aliases(opts)
-  p result
-rescue VgsApiClient::ApiError => e
-  puts "Exception when calling AliasesApi->create_aliases: #{e}"
-end
-
-```
-
-## Documentation for API Endpoints
-
-All URIs are relative to *https://api.sandbox.verygoodvault.com*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*VgsApiClient::AliasesApi* | [**create_aliases**](docs/AliasesApi.md#create_aliases) | **POST** /aliases | Create aliases
-*VgsApiClient::AliasesApi* | [**delete_alias**](docs/AliasesApi.md#delete_alias) | **DELETE** /aliases/{alias} | Delete alias
-*VgsApiClient::AliasesApi* | [**reveal_alias**](docs/AliasesApi.md#reveal_alias) | **GET** /aliases/{alias} | Reveal single alias
-*VgsApiClient::AliasesApi* | [**reveal_multiple_aliases**](docs/AliasesApi.md#reveal_multiple_aliases) | **GET** /aliases | Reveal multiple aliases
-*VgsApiClient::AliasesApi* | [**update_alias**](docs/AliasesApi.md#update_alias) | **PUT** /aliases/{alias} | Update data classifiers
-
-
-## Documentation for Models
-
- - [VgsApiClient::AliasFormat](docs/AliasFormat.md)
- - [VgsApiClient::ApiError](docs/ApiError.md)
- - [VgsApiClient::CreateAliasesRequest](docs/CreateAliasesRequest.md)
- - [VgsApiClient::CreateAliasesRequestExisting](docs/CreateAliasesRequestExisting.md)
- - [VgsApiClient::CreateAliasesRequestNew](docs/CreateAliasesRequestNew.md)
- - [VgsApiClient::InlineResponse200](docs/InlineResponse200.md)
- - [VgsApiClient::InlineResponse2001](docs/InlineResponse2001.md)
- - [VgsApiClient::InlineResponse201](docs/InlineResponse201.md)
- - [VgsApiClient::InlineResponseDefault](docs/InlineResponseDefault.md)
- - [VgsApiClient::ModelAlias](docs/ModelAlias.md)
- - [VgsApiClient::RevealedData](docs/RevealedData.md)
- - [VgsApiClient::UpdateAliasRequest](docs/UpdateAliasRequest.md)
- - [VgsApiClient::UpdateAliasRequestData](docs/UpdateAliasRequestData.md)
-
-
-## Documentation for Authorization
-
-
-### basicAuth
-
-- **Type**: HTTP basic authentication
-

data/docs/AliasFormat.md

@@ -1,15 +0,0 @@
-# VgsApiClient::AliasFormat
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'vgs_api_client'
-
-instance = VgsApiClient::AliasFormat.new()
-```
-