insights-approval-api-client 1.2.0

data/docs/GraphqlApi.md

@@ -0,0 +1,62 @@
+# ApprovalApiClient::GraphqlApi
+
+All URIs are relative to *https://cloud.redhat.com//api/approval/v1.2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**post_graphql**](GraphqlApi.md#post_graphql) | **POST** /graphql | Perform a GraphQL Query
+
+
+
+## post_graphql
+
+> GraphqlOut post_graphql(graphql_in)
+
+Perform a GraphQL Query
+
+Performs a GraphQL Query
+
+### 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::GraphqlApi.new
+graphql_in = ApprovalApiClient::GraphqlIn.new # GraphqlIn | GraphQL Query Request
+
+begin
+  #Perform a GraphQL Query
+  result = api_instance.post_graphql(graphql_in)
+  p result
+rescue ApprovalApiClient::ApiError => e
+  puts "Exception when calling GraphqlApi->post_graphql: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **graphql_in** | [**GraphqlIn**](GraphqlIn.md)| GraphQL Query Request | 
+
+### Return type
+
+[**GraphqlOut**](GraphqlOut.md)
+
+### Authorization
+
+[Basic_auth](../README.md#Basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/GraphqlIn.md

@@ -0,0 +1,21 @@
+# ApprovalApiClient::GraphqlIn
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **String** | The GraphQL query | [default to '{}']
+**operation_name** | **String** | If the Query contains several named operations, the operationName controls which one should be executed | [optional] [default to '']
+**variables** | [**Object**](.md) | Optional Query variables | [optional] 
+
+## Code Sample
+
+```ruby
+require 'ApprovalApiClient'
+
+instance = ApprovalApiClient::GraphqlIn.new(query: null,
+                                 operation_name: null,
+                                 variables: null)
+```
+
+

data/docs/GraphqlOut.md

@@ -0,0 +1,19 @@
+# ApprovalApiClient::GraphqlOut
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Object**](.md) | Results from the GraphQL query | [optional] 
+**errors** | **Array<Object>** | Errors resulting from the GraphQL query | [optional] 
+
+## Code Sample
+
+```ruby
+require 'ApprovalApiClient'
+
+instance = ApprovalApiClient::GraphqlOut.new(data: null,
+                                 errors: null)
+```
+
+

data/docs/GroupRef.md

@@ -0,0 +1,19 @@
+# ApprovalApiClient::GroupRef
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Group name | [optional] 
+**uuid** | **String** | Group UUID | 
+
+## Code Sample
+
+```ruby
+require 'ApprovalApiClient'
+
+instance = ApprovalApiClient::GroupRef.new(name: null,
+                                 uuid: null)
+```
+
+

data/docs/HttpApiError.md

@@ -0,0 +1,19 @@
+# ApprovalApiClient::HttpApiError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | HTTP status code | [optional] 
+**details** | **String** | Error details | [optional] 
+
+## Code Sample
+
+```ruby
+require 'ApprovalApiClient'
+
+instance = ApprovalApiClient::HttpApiError.new(status: 400,
+                                 details: Bad Request)
+```
+
+

data/docs/HttpApiErrorCollection.md

@@ -0,0 +1,17 @@
+# ApprovalApiClient::HttpApiErrorCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<HttpApiError>**](HttpApiError.md) | Error list from the API query | [optional] 
+
+## Code Sample
+
+```ruby
+require 'ApprovalApiClient'
+
+instance = ApprovalApiClient::HttpApiErrorCollection.new(errors: null)
+```
+
+

data/docs/Request.md

@@ -0,0 +1,49 @@
+# ApprovalApiClient::Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] [readonly] 
+**state** | **String** | The state of the request. Possible value: canceled, completed, failed, notified, skipped, or started | [optional] [readonly] 
+**decision** | **String** | Approval decision. Possible value: undecided, approved, canceled, denied, or error | [optional] [readonly] 
+**reason** | **String** | Reason for the decision. Optional. Present normally when the decision is denied | [optional] [readonly] 
+**workflow_id** | **String** | Associate workflow id. Available only if the request is a leaf node | [optional] [readonly] 
+**created_at** | **DateTime** | Timestamp of creation | [optional] [readonly] 
+**notified_at** | **DateTime** | Timestamp of notification sent to approvers | [optional] [readonly] 
+**finished_at** | **DateTime** | Timestamp of finishing (skipped, canceled, or completed) | [optional] [readonly] 
+**number_of_children** | **Integer** | Number of child requests | [optional] [readonly] 
+**number_of_finished_children** | **Integer** | Number of finished child requests | [optional] [readonly] 
+**owner** | **String** | Requester's id | [optional] [readonly] 
+**requester_name** | **String** | Requester's full name | [optional] [readonly] 
+**name** | **String** | Request name | [optional] [readonly] 
+**description** | **String** | Request description | [optional] [readonly] 
+**group_name** | **String** | Name of approver group(s) assigned to approve this request | [optional] [readonly] 
+**parent_id** | **String** | Parent request id | [optional] [readonly] 
+**metadata** | [**Object**](.md) | JSON Metadata about the request | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'ApprovalApiClient'
+
+instance = ApprovalApiClient::Request.new(id: null,
+                                 state: null,
+                                 decision: null,
+                                 reason: null,
+                                 workflow_id: null,
+                                 created_at: null,
+                                 notified_at: null,
+                                 finished_at: null,
+                                 number_of_children: null,
+                                 number_of_finished_children: null,
+                                 owner: null,
+                                 requester_name: null,
+                                 name: null,
+                                 description: null,
+                                 group_name: null,
+                                 parent_id: null,
+                                 metadata: null)
+```
+
+

data/docs/RequestApi.md

@@ -0,0 +1,292 @@
+# ApprovalApiClient::RequestApi
+
+All URIs are relative to *https://cloud.redhat.com//api/approval/v1.2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_request**](RequestApi.md#create_request) | **POST** /requests | Add an approval request by given parameters
+[**list_requests**](RequestApi.md#list_requests) | **GET** /requests | Return an array of requester made approval requests, available to anyone
+[**list_requests_by_request**](RequestApi.md#list_requests_by_request) | **GET** /requests/{request_id}/requests | Return an array of child requests of a given request id
+[**show_request**](RequestApi.md#show_request) | **GET** /requests/{id} | Return an approval request by given id
+[**show_request_content**](RequestApi.md#show_request_content) | **GET** /requests/{request_id}/content | Return request content of a given request id
+
+
+
+## create_request
+
+> Request create_request(request_in)
+
+Add an approval request by given parameters
+
+Add an approval request by given parameters, available to anyone
+
+### 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::RequestApi.new
+request_in = ApprovalApiClient::RequestIn.new # RequestIn | Parameters need to create a request
+
+begin
+  #Add an approval request by given parameters
+  result = api_instance.create_request(request_in)
+  p result
+rescue ApprovalApiClient::ApiError => e
+  puts "Exception when calling RequestApi->create_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_in** | [**RequestIn**](RequestIn.md)| Parameters need to create a request | 
+
+### Return type
+
+[**Request**](Request.md)
+
+### Authorization
+
+[Basic_auth](../README.md#Basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_requests
+
+> RequestCollection list_requests(opts)
+
+Return an array of requester made approval requests, available to anyone
+
+The result depends on the x-rh-persona header (approval/admin, approval/requseter, or approval/approver). Program generated child requests are not included.
+
+### 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::RequestApi.new
+opts = {
+  x_rh_persona: 'x_rh_persona_example', # String | Current login user's persona
+  limit: 100, # Integer | How many items to return at one time (max 1000)
+  offset: 0, # Integer | Starting Offset
+  filter: nil, # Object | Filter for querying collections.
+  sort_by: 'sort_by_example' # String | Parameter to sort collection
+}
+
+begin
+  #Return an array of requester made approval requests, available to anyone
+  result = api_instance.list_requests(opts)
+  p result
+rescue ApprovalApiClient::ApiError => e
+  puts "Exception when calling RequestApi->list_requests: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_rh_persona** | **String**| Current login user's persona | [optional] 
+ **limit** | **Integer**| How many items to return at one time (max 1000) | [optional] [default to 100]
+ **offset** | **Integer**| Starting Offset | [optional] [default to 0]
+ **filter** | [**Object**](.md)| Filter for querying collections. | [optional] 
+ **sort_by** | **String**| Parameter to sort collection | [optional] 
+
+### Return type
+
+[**RequestCollection**](RequestCollection.md)
+
+### Authorization
+
+[Basic_auth](../README.md#Basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_requests_by_request
+
+> RequestCollection list_requests_by_request(request_id, opts)
+
+Return an array of child requests of a given request id
+
+Return an array of child requests of a given request id. The result depends on the x-rh-persona header (approval/admin, approval/requseter, or approval/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::RequestApi.new
+request_id = 'request_id_example' # String | Id of request
+opts = {
+  x_rh_persona: 'x_rh_persona_example' # String | Current login user's persona
+}
+
+begin
+  #Return an array of child requests of a given request id
+  result = api_instance.list_requests_by_request(request_id, opts)
+  p result
+rescue ApprovalApiClient::ApiError => e
+  puts "Exception when calling RequestApi->list_requests_by_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_id** | **String**| Id of request | 
+ **x_rh_persona** | **String**| Current login user's persona | [optional] 
+
+### Return type
+
+[**RequestCollection**](RequestCollection.md)
+
+### Authorization
+
+[Basic_auth](../README.md#Basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## show_request
+
+> Request show_request(id)
+
+Return an approval request by given id
+
+Return an approval request by given id, available to anyone who can access the request
+
+### 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::RequestApi.new
+id = 'id_example' # String | Query by id
+
+begin
+  #Return an approval request by given id
+  result = api_instance.show_request(id)
+  p result
+rescue ApprovalApiClient::ApiError => e
+  puts "Exception when calling RequestApi->show_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Query by id | 
+
+### Return type
+
+[**Request**](Request.md)
+
+### Authorization
+
+[Basic_auth](../README.md#Basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## show_request_content
+
+> Object show_request_content(request_id)
+
+Return request content of a given request id
+
+Return request content of a given request 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::RequestApi.new
+request_id = 'request_id_example' # String | Id of request
+
+begin
+  #Return request content of a given request id
+  result = api_instance.show_request_content(request_id)
+  p result
+rescue ApprovalApiClient::ApiError => e
+  puts "Exception when calling RequestApi->show_request_content: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_id** | **String**| Id of request | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Basic_auth](../README.md#Basic_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+