pnap_tag_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b70aa2b6b69e9fd90165577e7987cc72a8281e681d6c495c4ccbc51f801aee51
+  data.tar.gz: 8b58122c10f768995146c7ffd802b07615b11762d01ab2fb5476d7605cb06481
+SHA512:
+  metadata.gz: c08b3698c95ea78e4c04dd8f8a3dd04f3ce22164364fd2695d32326cd86918bf653378d1e540df5a8ee77457fbcb7fd826e68459a0f54cb801a985a20f43583b
+  data.tar.gz: 51c5dc057fb3633c0aa0c7ae9732818a9527381c27c8d2db4bd9eee5907c282f0337dc8a7fde9dc7a1c531f79da92cedc7355f6e72f03a070c04d79549f2f240

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/README.md

@@ -0,0 +1,155 @@
+# pnap_tag_api
+
+TagApi - the Ruby gem for the Tags API
+
+Tags are case-sensitive key-value pairs that simplify resource management. The Tag Manager API allows you to create
+and manage such tags to later assign them to related resources in your Bare Metal Cloud (through the respective
+resource apis) in order to group and categorize them.<br>
+<br>
+<span class='pnap-api-knowledge-base-link'>
+Knowledge base articles to help you can be found
+<a href='https://phoenixnap.com/kb/bmc-server-management-via-api#server-tag-manager-api' target='_blank'>here</a>
+</span><br>
+<br>
+<b>All URLs are relative to (https://api.phoenixnap.com/tag-manager/v1/)</b>
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+For more information, please visit [https://phoenixnap.com/](https://phoenixnap.com/)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pnap_tag_api.gemspec
+```
+
+Then either install the gem locally, replacing `<VERSION>` with the actual version:
+
+```shell
+gem install ./pnap_tag_api-<VERSION>.gem
+```
+
+(for development, run `gem install --dev ./pnap_tag_api-<VERSION>.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 'pnap_tag_api', '~> <VERSION>'
+
+### Install from Git
+
+To install this Gem from this repository, you'll need to get Bundler by doing `gem install bundler`. Add the following line in your Gemfile:
+
+    gem 'pnap_tag_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'TagApi/*.gemspec'
+
+If you'd like the development version:
+
+    gem 'pnap_tag_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'TagApi/*.gemspec', branch: 'develop'
+
+Then run `bundle install`.
+
+### 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 'pnap_tag_api'
+
+# Setup authorization
+TagApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = TagApi::TagsApi.new
+opts = {
+  name: 'env' # String | Query a tag by its name.
+}
+
+begin
+  #List tags.
+  result = api_instance.tags_get(opts)
+  p result
+rescue TagApi::ApiError => e
+  puts "Exception when calling TagsApi->tags_get: #{e}"
+end
+
+```
+
+Authorization can also be setup by using the [`oauth`](https://github.com/oauth-xx/oauth2) library:
+
+```ruby
+# Load the gem
+require 'pnap_tag_api'
+require 'oauth2'
+
+# Setup variables for getting a token.
+client_id = 'YOUR_CLIENT_ID'
+client_secret = 'YOUR_CLIENT_SECRET'
+auth_url = 'https://auth.phoenixnap.com/auth/realms/BMC/protocol/openid-connect/token'
+
+
+# Setup authorization
+TagApi.configure do |config|
+  # Retrieve the token using OAuth2.
+  client = OAuth2::Client.new(client_id, client_secret, token_url: auth_url)
+  token = client.client_credentials.get_token
+
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = token.token
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.phoenixnap.com/tag-manager/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*TagApi::TagsApi* | [**tags_get**](docs/TagsApi.md#tags_get) | **GET** /tags | List tags.
+*TagApi::TagsApi* | [**tags_post**](docs/TagsApi.md#tags_post) | **POST** /tags | Create a Tag.
+*TagApi::TagsApi* | [**tags_tag_id_delete**](docs/TagsApi.md#tags_tag_id_delete) | **DELETE** /tags/{tagId} | Delete a Tag.
+*TagApi::TagsApi* | [**tags_tag_id_get**](docs/TagsApi.md#tags_tag_id_get) | **GET** /tags/{tagId} | Get a Tag.
+*TagApi::TagsApi* | [**tags_tag_id_patch**](docs/TagsApi.md#tags_tag_id_patch) | **PATCH** /tags/{tagId} | Modify a Tag.
+
+
+## Documentation for Models
+
+ - [TagApi::DeleteResult](docs/DeleteResult.md)
+ - [TagApi::Error](docs/Error.md)
+ - [TagApi::ResourceAssignment](docs/ResourceAssignment.md)
+ - [TagApi::Tag](docs/Tag.md)
+ - [TagApi::TagCreate](docs/TagCreate.md)
+ - [TagApi::TagUpdate](docs/TagUpdate.md)
+
+
+## Documentation for Authorization
+
+
+### OAuth2
+
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+  - tags: Grants full access to tags-api.
+  - tags.read: Grants read only access to tags-api.
+

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/VERSION

@@ -0,0 +1 @@
+1.0.0

data/docs/DeleteResult.md

@@ -0,0 +1,20 @@
+# TagApi::DeleteResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **result** | **String** | Tag deletion result message. |  |
+| **tag_id** | **String** | The unique identifier of the tag. |  |
+
+## Example
+
+```ruby
+require 'pnap_tag_api'
+
+instance = TagApi::DeleteResult.new(
+  result: Tag [tag-name] has been deleted.,
+  tag_id: 60ffafcdffb8b074c7968dad
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,20 @@
+# TagApi::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | The description detailing the cause of the error code. |  |
+| **validation_errors** | **Array<String>** | Validation errors, if any. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_tag_api'
+
+instance = TagApi::Error.new(
+  message: null,
+  validation_errors: null
+)
+```
+

data/docs/ResourceAssignment.md

@@ -0,0 +1,20 @@
+# TagApi::ResourceAssignment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **resource_name** | **String** | The resource name. |  |
+| **value** | **String** | The value of the tag assigned to the resource. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_tag_api'
+
+instance = TagApi::ResourceAssignment.new(
+  resource_name: /bmc/servers/60ffafcdffb8b074c7968dad,
+  value: DEV
+)
+```
+

data/docs/Tag.md

@@ -0,0 +1,30 @@
+# TagApi::Tag
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique id of the tag. |  |
+| **name** | **String** | The name of the tag. |  |
+| **values** | **Array<String>** | The optional values of the tag. | [optional] |
+| **description** | **String** | The description of the tag. | [optional] |
+| **is_billing_tag** | **Boolean** | Whether or not to show the tag as part of billing and invoices. |  |
+| **resource_assignments** | [**Array<ResourceAssignment>**](ResourceAssignment.md) | The tag's assigned resources. | [optional] |
+| **created_by** | **String** | The tag's creator. | [optional][default to 'USER'] |
+
+## Example
+
+```ruby
+require 'pnap_tag_api'
+
+instance = TagApi::Tag.new(
+  id: 60ffafcdffb8b074c7968dad,
+  name: Environment,
+  values: [DEV, PROD],
+  description: This tag is used for all resources that need to be assigned to an environment.,
+  is_billing_tag: true,
+  resource_assignments: null,
+  created_by: null
+)
+```
+

data/docs/TagCreate.md

@@ -0,0 +1,22 @@
+# TagApi::TagCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The unique name of the tag. Tag names are case-sensitive, and should be composed of a maximum of 100 characters including UTF-8 Unicode letters, numbers, and the following symbols: '-', '_'. Regex: [A-zÀ-ú0-9_-]{1,100} |  |
+| **description** | **String** | The description of the tag. | [optional] |
+| **is_billing_tag** | **Boolean** | Whether or not to show the tag as part of billing and invoices. |  |
+
+## Example
+
+```ruby
+require 'pnap_tag_api'
+
+instance = TagApi::TagCreate.new(
+  name: Environment,
+  description: This tag is used for all resources that need to be assigned to an environment.,
+  is_billing_tag: true
+)
+```
+

data/docs/TagUpdate.md

@@ -0,0 +1,22 @@
+# TagApi::TagUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The unique name of the tag. Tag names are case-sensitive, and should be composed of a maximum of 100 characters including UTF-8 Unicode letters, numbers, and the following symbols: '-', '_'. Regex: [A-zÀ-ú0-9_-]{1,100} |  |
+| **description** | **String** | The description of the tag. | [optional] |
+| **is_billing_tag** | **Boolean** | Whether or not to show the tag as part of billing and invoices. |  |
+
+## Example
+
+```ruby
+require 'pnap_tag_api'
+
+instance = TagApi::TagUpdate.new(
+  name: Environment,
+  description: This tag is used for all resources that need to be assigned to an environment.,
+  is_billing_tag: true
+)
+```
+

data/docs/TagsApi.md

@@ -0,0 +1,361 @@
+# TagApi::TagsApi
+
+All URIs are relative to *https://api.phoenixnap.com/tag-manager/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**tags_get**](TagsApi.md#tags_get) | **GET** /tags | List tags. |
+| [**tags_post**](TagsApi.md#tags_post) | **POST** /tags | Create a Tag. |
+| [**tags_tag_id_delete**](TagsApi.md#tags_tag_id_delete) | **DELETE** /tags/{tagId} | Delete a Tag. |
+| [**tags_tag_id_get**](TagsApi.md#tags_tag_id_get) | **GET** /tags/{tagId} | Get a Tag. |
+| [**tags_tag_id_patch**](TagsApi.md#tags_tag_id_patch) | **PATCH** /tags/{tagId} | Modify a Tag. |
+
+
+## tags_get
+
+> <Array<Tag>> tags_get(opts)
+
+List tags.
+
+Retrieve all tags belonging to the BMC Account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_tag_api'
+# setup authorization
+TagApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = TagApi::TagsApi.new
+opts = {
+  name: 'env' # String | Query a tag by its name.
+}
+
+begin
+  # List tags.
+  result = api_instance.tags_get(opts)
+  p result
+rescue TagApi::ApiError => e
+  puts "Error when calling TagsApi->tags_get: #{e}"
+end
+```
+
+#### Using the tags_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Tag>>, Integer, Hash)> tags_get_with_http_info(opts)
+
+```ruby
+begin
+  # List tags.
+  data, status_code, headers = api_instance.tags_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Tag>>
+rescue TagApi::ApiError => e
+  puts "Error when calling TagsApi->tags_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Query a tag by its name. | [optional] |
+
+### Return type
+
+[**Array&lt;Tag&gt;**](Tag.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## tags_post
+
+> <Tag> tags_post(tag_create)
+
+Create a Tag.
+
+Create a tag with the provided information.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_tag_api'
+# setup authorization
+TagApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = TagApi::TagsApi.new
+tag_create = TagApi::TagCreate.new({name: 'Environment', is_billing_tag: true}) # TagCreate | The body containing the tag details.
+
+begin
+  # Create a Tag.
+  result = api_instance.tags_post(tag_create)
+  p result
+rescue TagApi::ApiError => e
+  puts "Error when calling TagsApi->tags_post: #{e}"
+end
+```
+
+#### Using the tags_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Tag>, Integer, Hash)> tags_post_with_http_info(tag_create)
+
+```ruby
+begin
+  # Create a Tag.
+  data, status_code, headers = api_instance.tags_post_with_http_info(tag_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Tag>
+rescue TagApi::ApiError => e
+  puts "Error when calling TagsApi->tags_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tag_create** | [**TagCreate**](TagCreate.md) | The body containing the tag details. |  |
+
+### Return type
+
+[**Tag**](Tag.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## tags_tag_id_delete
+
+> <DeleteResult> tags_tag_id_delete(tag_id)
+
+Delete a Tag.
+
+Delete the tag with the given ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_tag_api'
+# setup authorization
+TagApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = TagApi::TagsApi.new
+tag_id = 'e6afba51-7de8-4080-83ab-0f915570659c' # String | The tag's ID.
+
+begin
+  # Delete a Tag.
+  result = api_instance.tags_tag_id_delete(tag_id)
+  p result
+rescue TagApi::ApiError => e
+  puts "Error when calling TagsApi->tags_tag_id_delete: #{e}"
+end
+```
+
+#### Using the tags_tag_id_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteResult>, Integer, Hash)> tags_tag_id_delete_with_http_info(tag_id)
+
+```ruby
+begin
+  # Delete a Tag.
+  data, status_code, headers = api_instance.tags_tag_id_delete_with_http_info(tag_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteResult>
+rescue TagApi::ApiError => e
+  puts "Error when calling TagsApi->tags_tag_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tag_id** | **String** | The tag&#39;s ID. |  |
+
+### Return type
+
+[**DeleteResult**](DeleteResult.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## tags_tag_id_get
+
+> <Tag> tags_tag_id_get(tag_id)
+
+Get a Tag.
+
+Retrieve the tag with the given ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_tag_api'
+# setup authorization
+TagApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = TagApi::TagsApi.new
+tag_id = 'e6afba51-7de8-4080-83ab-0f915570659c' # String | The tag's ID.
+
+begin
+  # Get a Tag.
+  result = api_instance.tags_tag_id_get(tag_id)
+  p result
+rescue TagApi::ApiError => e
+  puts "Error when calling TagsApi->tags_tag_id_get: #{e}"
+end
+```
+
+#### Using the tags_tag_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Tag>, Integer, Hash)> tags_tag_id_get_with_http_info(tag_id)
+
+```ruby
+begin
+  # Get a Tag.
+  data, status_code, headers = api_instance.tags_tag_id_get_with_http_info(tag_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Tag>
+rescue TagApi::ApiError => e
+  puts "Error when calling TagsApi->tags_tag_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tag_id** | **String** | The tag&#39;s ID. |  |
+
+### Return type
+
+[**Tag**](Tag.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## tags_tag_id_patch
+
+> <Tag> tags_tag_id_patch(tag_id, tag_update)
+
+Modify a Tag.
+
+Updates the tag with the given ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_tag_api'
+# setup authorization
+TagApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = TagApi::TagsApi.new
+tag_id = 'e6afba51-7de8-4080-83ab-0f915570659c' # String | The tag's ID.
+tag_update = TagApi::TagUpdate.new({name: 'Environment', is_billing_tag: true}) # TagUpdate | The body containing the tag changes.
+
+begin
+  # Modify a Tag.
+  result = api_instance.tags_tag_id_patch(tag_id, tag_update)
+  p result
+rescue TagApi::ApiError => e
+  puts "Error when calling TagsApi->tags_tag_id_patch: #{e}"
+end
+```
+
+#### Using the tags_tag_id_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Tag>, Integer, Hash)> tags_tag_id_patch_with_http_info(tag_id, tag_update)
+
+```ruby
+begin
+  # Modify a Tag.
+  data, status_code, headers = api_instance.tags_tag_id_patch_with_http_info(tag_id, tag_update)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Tag>
+rescue TagApi::ApiError => e
+  puts "Error when calling TagsApi->tags_tag_id_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tag_id** | **String** | The tag&#39;s ID. |  |
+| **tag_update** | [**TagUpdate**](TagUpdate.md) | The body containing the tag changes. |  |
+
+### Return type
+
+[**Tag**](Tag.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+