vgs_api_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa58a9dafab3d45d960f49d470d79509bba961f316afbc3781db258fed4210d8
+  data.tar.gz: ca3de31ef5e4aa3c54c1f1affb04eafac0f27e522610a43f3b2fdf84729a3df4
+SHA512:
+  metadata.gz: 7b607efeb9383e71d6cd91c77f33516af8e15de6e8fffb7afe6bf48da2c2f78d04f3c1cf73fe3344d723f6074bab6f92ffbae51be9e389c4b077e4cc70672752
+  data.tar.gz: 844366566921e3055a23339c3869edd7ed88ed5e11c10793fbb75bb50a01ae29205e7c4f67317b14403a7d0b7a01a135b865d5937f8e9449deb3e5dcfb579199

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/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    vgs_api_client (0.0.1)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.5)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (4.0.3)
+      stringio
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.11.0)
+    stringio (3.0.1)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+  vgs_api_client!
+
+BUNDLED WITH
+   2.2.22

data/README.md

@@ -0,0 +1,237 @@
+# 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.1
+- 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.1.gem
+```
+
+(for development, run `gem install --dev ./vgs_api_client-0.0.1.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.1'
+
+### 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/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/AliasFormat.md

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