insights-approval-api-client 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3dbea180a4ad74df8918453b36b2f3fd98d38249d85bb003cbafa1ef87aa79e7
+  data.tar.gz: 1540ce146fab4470de3f8ced5545d2ad61fdfc6999a2606baf9244b0cb2f72db
+SHA512:
+  metadata.gz: c3b0433715fd86775ffc00bca399f23d2f6af4bec7723c10eb45eeb68907963c45e6efff9019458fe0f0e2c8115621c53fbedfcf9d40e394ed163c40a553fa8a
+  data.tar.gz: 070d739ce6595bf34e816ee1bcbc4938b30054f765305ec0db65c471d38e100316429f16046c765fa292cee7ab71ecac635c97a4cb1e14ce633e120bc2be67e6

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,142 @@
+# approval-api-client-ruby
+
+ApprovalApiClient - the Ruby gem for the Insights Service Approval APIs
+
+APIs to query approval service
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build approval-api-client-ruby.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./approval-api-client-ruby-1.0.0.gem
+```
+(for development, run `gem install --dev ./approval-api-client-ruby-1.0.0.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 'approval-api-client-ruby', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'approval-api-client-ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.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 'approval-api-client-ruby'
+
+# Setup authorization
+ApprovalApiClient.configure do |config|
+  # Configure API key authorization: APIKey_auth
+  config.api_key['x-rh-identity'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-rh-identity'] = 'Bearer'
+
+  # Configure HTTP basic authorization: Basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ApprovalApiClient::ActionApi.new
+stage_id = 56 # Integer | Id of stage
+action_in = ApprovalApiClient::ActionIn.new # ActionIn | Action object that will be added
+
+begin
+  #Add an action to a given stage
+  result = api_instance.create_action(stage_id, action_in)
+  p result
+rescue ApprovalApiClient::ApiError => e
+  puts "Exception when calling ActionApi->create_action: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost/api/approval*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ApprovalApiClient::ActionApi* | [**create_action**](docs/ActionApi.md#create_action) | **POST** /stages/{stage_id}/actions | Add an action to a given stage
+*ApprovalApiClient::ActionApi* | [**list_actions_by_stage**](docs/ActionApi.md#list_actions_by_stage) | **GET** /stages/{stage_id}/actions | Return actions in a given stage
+*ApprovalApiClient::ActionApi* | [**show_action**](docs/ActionApi.md#show_action) | **GET** /actions/{id} | Return an user action by id
+*ApprovalApiClient::RequestApi* | [**create_request**](docs/RequestApi.md#create_request) | **POST** /workflows/{workflow_id}/requests | Add an approval request by given parameters
+*ApprovalApiClient::RequestApi* | [**list_requests**](docs/RequestApi.md#list_requests) | **GET** /requests | Return an array of approval requests
+*ApprovalApiClient::RequestApi* | [**list_requests_by_workflow**](docs/RequestApi.md#list_requests_by_workflow) | **GET** /workflows/{workflow_id}/requests | Return approval requests by given workflow id
+*ApprovalApiClient::RequestApi* | [**show_request**](docs/RequestApi.md#show_request) | **GET** /requests/{id} | Return an approval request by given id
+*ApprovalApiClient::StageApi* | [**list_stages_by_request**](docs/StageApi.md#list_stages_by_request) | **GET** /requests/{request_id}/stages | Return an array of stages by given request id
+*ApprovalApiClient::StageApi* | [**show_stage**](docs/StageApi.md#show_stage) | **GET** /stages/{id} | Return an approval stage by given id
+*ApprovalApiClient::TemplateApi* | [**list_templates**](docs/TemplateApi.md#list_templates) | **GET** /templates | Return all templates
+*ApprovalApiClient::TemplateApi* | [**show_template**](docs/TemplateApi.md#show_template) | **GET** /templates/{id} | Return a template by given id
+*ApprovalApiClient::WorkflowApi* | [**add_workflow_to_template**](docs/WorkflowApi.md#add_workflow_to_template) | **POST** /templates/{template_id}/workflows | Add a workflow by given template id
+*ApprovalApiClient::WorkflowApi* | [**destroy_workflow**](docs/WorkflowApi.md#destroy_workflow) | **DELETE** /workflows/{id} | Delete approval workflow by given id
+*ApprovalApiClient::WorkflowApi* | [**list_workflows**](docs/WorkflowApi.md#list_workflows) | **GET** /workflows | Return all approval workflows
+*ApprovalApiClient::WorkflowApi* | [**list_workflows_by_template**](docs/WorkflowApi.md#list_workflows_by_template) | **GET** /templates/{template_id}/workflows | Return an array of workflows by given template id
+*ApprovalApiClient::WorkflowApi* | [**show_workflow**](docs/WorkflowApi.md#show_workflow) | **GET** /workflows/{id} | Return an approval workflow by given id
+*ApprovalApiClient::WorkflowApi* | [**update_workflow**](docs/WorkflowApi.md#update_workflow) | **PATCH** /workflows/{id} | Update an approval workflow by given id
+
+
+## Documentation for Models
+
+ - [ApprovalApiClient::ActionIn](docs/ActionIn.md)
+ - [ApprovalApiClient::ActionOut](docs/ActionOut.md)
+ - [ApprovalApiClient::ActionOutCollection](docs/ActionOutCollection.md)
+ - [ApprovalApiClient::CollectionLinks](docs/CollectionLinks.md)
+ - [ApprovalApiClient::CollectionMetadata](docs/CollectionMetadata.md)
+ - [ApprovalApiClient::RequestIn](docs/RequestIn.md)
+ - [ApprovalApiClient::RequestOut](docs/RequestOut.md)
+ - [ApprovalApiClient::RequestOutCollection](docs/RequestOutCollection.md)
+ - [ApprovalApiClient::StageOut](docs/StageOut.md)
+ - [ApprovalApiClient::StageOutCollection](docs/StageOutCollection.md)
+ - [ApprovalApiClient::TemplateOut](docs/TemplateOut.md)
+ - [ApprovalApiClient::TemplateOutCollection](docs/TemplateOutCollection.md)
+ - [ApprovalApiClient::WorkflowIn](docs/WorkflowIn.md)
+ - [ApprovalApiClient::WorkflowOut](docs/WorkflowOut.md)
+ - [ApprovalApiClient::WorkflowOutCollection](docs/WorkflowOutCollection.md)
+
+
+## Documentation for Authorization
+
+
+### APIKey_auth
+
+- **Type**: API key
+- **API key parameter name**: x-rh-identity
+- **Location**: HTTP header
+
+### Basic_auth
+
+- **Type**: HTTP basic authentication
+
+## License
+
+This project is available as open source under the terms of the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).

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/client-meta.json

@@ -0,0 +1,9 @@
+{
+	"moduleName": "ApprovalApiClient",
+	"gemName": "insights-approval-api-client",
+	"gemHomepage" : "https://github.com/RedHatInsights/approval-api-client-ruby",
+	"gemAuthor" : "Insights Authors",
+	"gemLicense" : "Apache-2.0",
+	"gemVersion" : "1.2.0",
+	"gemDescription" : "Ruby client gem to connect to Insights Approval Service"
+}

data/docs/Action.md

@@ -0,0 +1,27 @@
+# ApprovalApiClient::Action
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] [readonly] 
+**created_at** | **DateTime** | Timestamp of creation | [optional] [readonly] 
+**request_id** | **String** | Associated request id | [optional] [readonly] 
+**processed_by** | **String** | The person who performs the action | [optional] 
+**operation** | **String** | Types of action, may be one of the value (approve, cancel, deny, error, notify, memo, skip, or start). The request state will be updated according to the operation. | [optional] [default to 'memo']
+**comments** | **String** | Comments for action | [optional] 
+
+## Code Sample
+
+```ruby
+require 'ApprovalApiClient'
+
+instance = ApprovalApiClient::Action.new(id: null,
+                                 created_at: null,
+                                 request_id: null,
+                                 processed_by: null,
+                                 operation: null,
+                                 comments: null)
+```
+
+

data/docs/ActionApi.md

@@ -0,0 +1,172 @@
+# ApprovalApiClient::ActionApi
+
+All URIs are relative to *https://cloud.redhat.com//api/approval/v1.2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_action**](ActionApi.md#create_action) | **POST** /requests/{request_id}/actions | Add an action to a given request
+[**list_actions_by_request**](ActionApi.md#list_actions_by_request) | **GET** /requests/{request_id}/actions | List all actions of a request
+[**show_action**](ActionApi.md#show_action) | **GET** /actions/{id} | Return an user action by id
+
+
+
+## create_action
+
+> Action create_action(request_id, action)
+
+Add an action to a given request
+
+Add an action to a given request. Admin can do approve, deny, memo, and cancel operations; approver can do approve, deny and memo operations; while requester can do only cancel operation.
+
+### Example
+
+```ruby
+# load the gem
+require 'insights-approval-api-client'
+# setup authorization
+ApprovalApiClient.configure do |config|
+  # Configure HTTP basic authorization: Basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ApprovalApiClient::ActionApi.new
+request_id = 'request_id_example' # String | Id of request
+action = ApprovalApiClient::Action.new # Action | Action object that will be added
+
+begin
+  #Add an action to a given request
+  result = api_instance.create_action(request_id, action)
+  p result
+rescue ApprovalApiClient::ApiError => e
+  puts "Exception when calling ActionApi->create_action: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_id** | **String**| Id of request | 
+ **action** | [**Action**](Action.md)| Action object that will be added | 
+
+### Return type
+
+[**Action**](Action.md)
+
+### Authorization
+
+[Basic_auth](../README.md#Basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_actions_by_request
+
+> ActionCollection list_actions_by_request(request_id)
+
+List all actions of a request
+
+Return actions in a given request, available for admin/approver
+
+### Example
+
+```ruby
+# load the gem
+require 'insights-approval-api-client'
+# setup authorization
+ApprovalApiClient.configure do |config|
+  # Configure HTTP basic authorization: Basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ApprovalApiClient::ActionApi.new
+request_id = 'request_id_example' # String | Id of request
+
+begin
+  #List all actions of a request
+  result = api_instance.list_actions_by_request(request_id)
+  p result
+rescue ApprovalApiClient::ApiError => e
+  puts "Exception when calling ActionApi->list_actions_by_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_id** | **String**| Id of request | 
+
+### Return type
+
+[**ActionCollection**](ActionCollection.md)
+
+### Authorization
+
+[Basic_auth](../README.md#Basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## show_action
+
+> Action show_action(id)
+
+Return an user action by id
+
+Return an user action by id, available to all
+
+### Example
+
+```ruby
+# load the gem
+require 'insights-approval-api-client'
+# setup authorization
+ApprovalApiClient.configure do |config|
+  # Configure HTTP basic authorization: Basic_auth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ApprovalApiClient::ActionApi.new
+id = 'id_example' # String | Query by id
+
+begin
+  #Return an user action by id
+  result = api_instance.show_action(id)
+  p result
+rescue ApprovalApiClient::ApiError => e
+  puts "Exception when calling ActionApi->show_action: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Query by id | 
+
+### Return type
+
+[**Action**](Action.md)
+
+### Authorization
+
+[Basic_auth](../README.md#Basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+

data/docs/ActionCollection.md

@@ -0,0 +1,21 @@
+# ApprovalApiClient::ActionCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**CollectionMetadata**](CollectionMetadata.md) |  | [optional] 
+**links** | [**CollectionLinks**](CollectionLinks.md) |  | [optional] 
+**data** | [**Array<Action>**](Action.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'ApprovalApiClient'
+
+instance = ApprovalApiClient::ActionCollection.new(meta: null,
+                                 links: null,
+                                 data: null)
+```
+
+

data/docs/CollectionLinks.md

@@ -0,0 +1,23 @@
+# ApprovalApiClient::CollectionLinks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first** | **String** | The link to fetch the first group of items in the result set | [optional] 
+**last** | **String** | The link to fetch the last group of items in the result set | [optional] 
+**prev** | **String** | The link to fetch the previous group of items in the result set | [optional] 
+**_next** | **String** | The link to fetch the next group of items in the result set | [optional] 
+
+## Code Sample
+
+```ruby
+require 'ApprovalApiClient'
+
+instance = ApprovalApiClient::CollectionLinks.new(first: null,
+                                 last: null,
+                                 prev: null,
+                                 _next: null)
+```
+
+

data/docs/CollectionMetadata.md

@@ -0,0 +1,21 @@
+# ApprovalApiClient::CollectionMetadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | This is the total number of items in the result set, of which only a subset is returned defined by the QueryLimit parameter | [optional] 
+**limit** | **Integer** | This is the number of items each page can display | [optional] 
+**offset** | **Integer** | This is the offset from beginning of the result set | [optional] 
+
+## Code Sample
+
+```ruby
+require 'ApprovalApiClient'
+
+instance = ApprovalApiClient::CollectionMetadata.new(count: null,
+                                 limit: null,
+                                 offset: null)
+```
+
+