vgs_api_client 0.0.1

data/docs/AliasesApi.md

@@ -0,0 +1,366 @@
+# VgsapiClient::AliasesApi
+
+All URIs are relative to *https://api.sandbox.verygoodvault.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_aliases**](AliasesApi.md#create_aliases) | **POST** /aliases | Create aliases |
+| [**delete_alias**](AliasesApi.md#delete_alias) | **DELETE** /aliases/{alias} | Delete alias |
+| [**reveal_alias**](AliasesApi.md#reveal_alias) | **GET** /aliases/{alias} | Reveal single alias |
+| [**reveal_multiple_aliases**](AliasesApi.md#reveal_multiple_aliases) | **GET** /aliases | Reveal multiple aliases |
+| [**update_alias**](AliasesApi.md#update_alias) | **PUT** /aliases/{alias} | Update data classifiers |
+
+
+## create_aliases
+
+> <InlineResponse201> create_aliases(opts)
+
+Create aliases
+
+Stores multiple values at once & returns their aliases.  Alternatively, this endpoint may be used to associate additional (i.e. secondary) aliases with the same underlying data as the reference alias specified in the request body.  **NOTE:** You cannot reference the same alias more than once in a single request. 
+
+### Examples
+
+```ruby
+require 'time'
+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 "Error when calling AliasesApi->create_aliases: #{e}"
+end
+```
+
+#### Using the create_aliases_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineResponse201>, Integer, Hash)> create_aliases_with_http_info(opts)
+
+```ruby
+begin
+  # Create aliases
+  data, status_code, headers = api_instance.create_aliases_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineResponse201>
+rescue VgsapiClient::ApiError => e
+  puts "Error when calling AliasesApi->create_aliases_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_aliases_request** | [**CreateAliasesRequest**](CreateAliasesRequest.md) |  | [optional] |
+
+### Return type
+
+[**InlineResponse201**](InlineResponse201.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_alias
+
+> delete_alias(_alias)
+
+Delete alias
+
+Removes a single alias. 
+
+### Examples
+
+```ruby
+require 'time'
+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
+_alias = 'tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e' # String | Alias to operate on.
+
+begin
+  # Delete alias
+  api_instance.delete_alias(_alias)
+rescue VgsapiClient::ApiError => e
+  puts "Error when calling AliasesApi->delete_alias: #{e}"
+end
+```
+
+#### Using the delete_alias_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_alias_with_http_info(_alias)
+
+```ruby
+begin
+  # Delete alias
+  data, status_code, headers = api_instance.delete_alias_with_http_info(_alias)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue VgsapiClient::ApiError => e
+  puts "Error when calling AliasesApi->delete_alias_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_alias** | **String** | Alias to operate on. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## reveal_alias
+
+> <InlineResponse2001> reveal_alias(_alias)
+
+Reveal single alias
+
+Retrieves a stored value along with its aliases.  **NOTE:** This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [support@verygoodsecurity.com](mailto:support@verygoodsecurity.com). 
+
+### Examples
+
+```ruby
+require 'time'
+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
+_alias = 'tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e' # String | Alias to operate on.
+
+begin
+  # Reveal single alias
+  result = api_instance.reveal_alias(_alias)
+  p result
+rescue VgsapiClient::ApiError => e
+  puts "Error when calling AliasesApi->reveal_alias: #{e}"
+end
+```
+
+#### Using the reveal_alias_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineResponse2001>, Integer, Hash)> reveal_alias_with_http_info(_alias)
+
+```ruby
+begin
+  # Reveal single alias
+  data, status_code, headers = api_instance.reveal_alias_with_http_info(_alias)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineResponse2001>
+rescue VgsapiClient::ApiError => e
+  puts "Error when calling AliasesApi->reveal_alias_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_alias** | **String** | Alias to operate on. |  |
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## reveal_multiple_aliases
+
+> <InlineResponse200> reveal_multiple_aliases(q)
+
+Reveal multiple aliases
+
+Given a list of aliases, retrieves all associated values stored in the vault.  **NOTE:** This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [support@verygoodsecurity.com](mailto:support@verygoodsecurity.com). 
+
+### Examples
+
+```ruby
+require 'time'
+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
+q = ['inner_example'] # Array<String> | Comma-separated list of aliases to reveal.
+
+begin
+  # Reveal multiple aliases
+  result = api_instance.reveal_multiple_aliases(q)
+  p result
+rescue VgsapiClient::ApiError => e
+  puts "Error when calling AliasesApi->reveal_multiple_aliases: #{e}"
+end
+```
+
+#### Using the reveal_multiple_aliases_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineResponse200>, Integer, Hash)> reveal_multiple_aliases_with_http_info(q)
+
+```ruby
+begin
+  # Reveal multiple aliases
+  data, status_code, headers = api_instance.reveal_multiple_aliases_with_http_info(q)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineResponse200>
+rescue VgsapiClient::ApiError => e
+  puts "Error when calling AliasesApi->reveal_multiple_aliases_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **q** | [**Array&lt;String&gt;**](String.md) | Comma-separated list of aliases to reveal. |  |
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_alias
+
+> update_alias(_alias, opts)
+
+Update data classifiers
+
+Apply new classifiers to the value that the specified alias is associated with. 
+
+### Examples
+
+```ruby
+require 'time'
+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
+_alias = 'tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e' # String | Alias to operate on.
+opts = {
+  update_alias_request: VgsapiClient::UpdateAliasRequest.new({data: VgsapiClient::UpdateAliasRequestData.new({classifiers: ['bank-account']})}) # UpdateAliasRequest | 
+}
+
+begin
+  # Update data classifiers
+  api_instance.update_alias(_alias, opts)
+rescue VgsapiClient::ApiError => e
+  puts "Error when calling AliasesApi->update_alias: #{e}"
+end
+```
+
+#### Using the update_alias_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> update_alias_with_http_info(_alias, opts)
+
+```ruby
+begin
+  # Update data classifiers
+  data, status_code, headers = api_instance.update_alias_with_http_info(_alias, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue VgsapiClient::ApiError => e
+  puts "Error when calling AliasesApi->update_alias_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_alias** | **String** | Alias to operate on. |  |
+| **update_alias_request** | [**UpdateAliasRequest**](UpdateAliasRequest.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ApiError.md

@@ -0,0 +1,24 @@
+# VgsapiClient::ApiError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **detail** | **String** | Explanation of what exactly went wrong. | [optional] |
+| **href** | **String** | Request URL. | [optional] |
+| **status** | **Integer** | HTTP status code. | [optional] |
+| **title** | **String** | High-level reason of why the request failed. | [optional] |
+
+## Example
+
+```ruby
+require 'vgs_api_client'
+
+instance = VgsapiClient::ApiError.new(
+  detail: null,
+  href: null,
+  status: null,
+  title: null
+)
+```
+

data/docs/CreateAliasesRequest.md

@@ -0,0 +1,18 @@
+# VgsapiClient::CreateAliasesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<OneOfCreateAliasesRequestNewCreateAliasesRequestExisting>**](OneOfCreateAliasesRequestNewCreateAliasesRequestExisting.md) |  |  |
+
+## Example
+
+```ruby
+require 'vgs_api_client'
+
+instance = VgsapiClient::CreateAliasesRequest.new(
+  data: null
+)
+```
+

data/docs/CreateAliasesRequestExisting.md

@@ -0,0 +1,20 @@
+# VgsapiClient::CreateAliasesRequestExisting
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_alias** | **String** | Existing alias to use as a reference. |  |
+| **format** | [**AliasFormat**](AliasFormat.md) |  |  |
+
+## Example
+
+```ruby
+require 'vgs_api_client'
+
+instance = VgsapiClient::CreateAliasesRequestExisting.new(
+  _alias: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e,
+  format: null
+)
+```
+

data/docs/CreateAliasesRequestNew.md

@@ -0,0 +1,22 @@
+# VgsapiClient::CreateAliasesRequestNew
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **classifiers** | **Array<String>** | List of tags to classify the value with. | [optional] |
+| **format** | [**AliasFormat**](AliasFormat.md) |  |  |
+| **value** | **String** | Raw value to encrypt & store in the vault. |  |
+
+## Example
+
+```ruby
+require 'vgs_api_client'
+
+instance = VgsapiClient::CreateAliasesRequestNew.new(
+  classifiers: null,
+  format: null,
+  value: 122105155
+)
+```
+

data/docs/InlineResponse200.md

@@ -0,0 +1,18 @@
+# VgsapiClient::InlineResponse200
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Hash<String, RevealedData>**](RevealedData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'vgs_api_client'
+
+instance = VgsapiClient::InlineResponse200.new(
+  data: {"tok_sandbox_5UpnbMvaihRuRwz5QXwBFw":{"aliases":[{"format":"UUID","value":"tok_sandbox_5UpnbMvaihRuRwz5QXwBFw"}],"classifiers":["bank-account"],"created_at":"2019-08-10T11:45:30Z","value":"476673481"},"tok_sandbox_9ToiJHedw1nE1Jfx1qYYgz":{"aliases":[{"format":"UUID","value":"tok_sandbox_9ToiJHedw1nE1Jfx1qYYgz"}],"classifiers":["bank-account"],"created_at":"2019-08-10T11:45:30Z","value":"750360025"}}
+)
+```
+

data/docs/InlineResponse2001.md

@@ -0,0 +1,18 @@
+# VgsapiClient::InlineResponse2001
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<RevealedData>**](RevealedData.md) | The retrieved value. | [optional] |
+
+## Example
+
+```ruby
+require 'vgs_api_client'
+
+instance = VgsapiClient::InlineResponse2001.new(
+  data: null
+)
+```
+

data/docs/InlineResponse201.md

@@ -0,0 +1,18 @@
+# VgsapiClient::InlineResponse201
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<RevealedData>**](RevealedData.md) | List of stored values along with their aliases. | [optional] |
+
+## Example
+
+```ruby
+require 'vgs_api_client'
+
+instance = VgsapiClient::InlineResponse201.new(
+  data: null
+)
+```
+

data/docs/InlineResponseDefault.md

@@ -0,0 +1,18 @@
+# VgsapiClient::InlineResponseDefault
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array<ApiError>**](ApiError.md) | List of errors that occurred while processing the request. | [optional] |
+
+## Example
+
+```ruby
+require 'vgs_api_client'
+
+instance = VgsapiClient::InlineResponseDefault.new(
+  errors: null
+)
+```
+

data/docs/ModelAlias.md

@@ -0,0 +1,20 @@
+# VgsapiClient::ModelAlias
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_alias** | **String** | Opaque string used to substitute the raw value. | [optional] |
+| **format** | [**AliasFormat**](AliasFormat.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'vgs_api_client'
+
+instance = VgsapiClient::ModelAlias.new(
+  _alias: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e,
+  format: null
+)
+```
+

data/docs/RevealedData.md

@@ -0,0 +1,24 @@
+# VgsapiClient::RevealedData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **aliases** | [**Array<ModelAlias>**](ModelAlias.md) | List of aliases associated with the value. | [optional] |
+| **classifiers** | **Array<String>** | List of tags the value is classified with. | [optional] |
+| **created_at** | **Time** | Creation time, in UTC. | [optional] |
+| **value** | **String** | Decrypted value stored in the vault. | [optional] |
+
+## Example
+
+```ruby
+require 'vgs_api_client'
+
+instance = VgsapiClient::RevealedData.new(
+  aliases: null,
+  classifiers: null,
+  created_at: 2019-05-15T12:30:45Z,
+  value: 122105155
+)
+```
+

data/docs/UpdateAliasRequest.md

@@ -0,0 +1,18 @@
+# VgsapiClient::UpdateAliasRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**UpdateAliasRequestData**](UpdateAliasRequestData.md) |  |  |
+
+## Example
+
+```ruby
+require 'vgs_api_client'
+
+instance = VgsapiClient::UpdateAliasRequest.new(
+  data: null
+)
+```
+

data/docs/UpdateAliasRequestData.md

@@ -0,0 +1,18 @@
+# VgsapiClient::UpdateAliasRequestData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **classifiers** | **Array<String>** | List of tags to classify the value with. |  |
+
+## Example
+
+```ruby
+require 'vgs_api_client'
+
+instance = VgsapiClient::UpdateAliasRequestData.new(
+  classifiers: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="verygoodsecurity"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="vgs-api-client-ruby"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'