docs/AliasesApi.md in vgs_api_client-0.0.21 vs docs/AliasesApi.md in vgs_api_client-0.0.26
- old
+ new
@@ -1,6 +1,6 @@
-# VgsapiClient::AliasesApi
+# VgsApiClient::AliasesApi
All URIs are relative to *https://api.sandbox.verygoodvault.com*
| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
@@ -23,26 +23,26 @@
```ruby
require 'time'
require 'vgs_api_client'
# setup authorization
-VgsapiClient.configure do |config|
+VgsApiClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
-api_instance = VgsapiClient::AliasesApi.new
+api_instance = VgsApiClient::AliasesApi.new
opts = {
- create_aliases_request: VgsapiClient::CreateAliasesRequest.new({data: [TODO]}) # CreateAliasesRequest |
+ create_aliases_request: VgsApiClient::CreateAliasesRequest.new({data: [TODO]}) # CreateAliasesRequest |
}
begin
# Create aliases
result = api_instance.create_aliases(opts)
p result
-rescue VgsapiClient::ApiError => e
+rescue VgsApiClient::ApiError => e
puts "Error when calling AliasesApi->create_aliases: #{e}"
end
```
#### Using the create_aliases_with_http_info variant
@@ -56,11 +56,11 @@
# 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
+rescue VgsApiClient::ApiError => e
puts "Error when calling AliasesApi->create_aliases_with_http_info: #{e}"
end
```
### Parameters
@@ -95,23 +95,23 @@
```ruby
require 'time'
require 'vgs_api_client'
# setup authorization
-VgsapiClient.configure do |config|
+VgsApiClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
-api_instance = VgsapiClient::AliasesApi.new
+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
+rescue VgsApiClient::ApiError => e
puts "Error when calling AliasesApi->delete_alias: #{e}"
end
```
#### Using the delete_alias_with_http_info variant
@@ -125,11 +125,11 @@
# 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
+rescue VgsApiClient::ApiError => e
puts "Error when calling AliasesApi->delete_alias_with_http_info: #{e}"
end
```
### Parameters
@@ -164,24 +164,24 @@
```ruby
require 'time'
require 'vgs_api_client'
# setup authorization
-VgsapiClient.configure do |config|
+VgsApiClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
-api_instance = VgsapiClient::AliasesApi.new
+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
+rescue VgsApiClient::ApiError => e
puts "Error when calling AliasesApi->reveal_alias: #{e}"
end
```
#### Using the reveal_alias_with_http_info variant
@@ -195,11 +195,11 @@
# 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
+rescue VgsApiClient::ApiError => e
puts "Error when calling AliasesApi->reveal_alias_with_http_info: #{e}"
end
```
### Parameters
@@ -234,24 +234,24 @@
```ruby
require 'time'
require 'vgs_api_client'
# setup authorization
-VgsapiClient.configure do |config|
+VgsApiClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
-api_instance = VgsapiClient::AliasesApi.new
+api_instance = VgsApiClient::AliasesApi.new
q = 'tok_sandbox_5UpnbMvaihRuRwz5QXwBFw, tok_sandbox_9ToiJHedw1nE1Jfx1qYYgz' # String | Comma-separated aliases string
begin
# Reveal multiple aliases
result = api_instance.reveal_multiple_aliases(q)
p result
-rescue VgsapiClient::ApiError => e
+rescue VgsApiClient::ApiError => e
puts "Error when calling AliasesApi->reveal_multiple_aliases: #{e}"
end
```
#### Using the reveal_multiple_aliases_with_http_info variant
@@ -265,11 +265,11 @@
# 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
+rescue VgsApiClient::ApiError => e
puts "Error when calling AliasesApi->reveal_multiple_aliases_with_http_info: #{e}"
end
```
### Parameters
@@ -304,26 +304,26 @@
```ruby
require 'time'
require 'vgs_api_client'
# setup authorization
-VgsapiClient.configure do |config|
+VgsApiClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
-api_instance = VgsapiClient::AliasesApi.new
+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 |
+ 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
+rescue VgsApiClient::ApiError => e
puts "Error when calling AliasesApi->update_alias: #{e}"
end
```
#### Using the update_alias_with_http_info variant
@@ -337,10 +337,10 @@
# 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
+rescue VgsApiClient::ApiError => e
puts "Error when calling AliasesApi->update_alias_with_http_info: #{e}"
end
```
### Parameters