togglr-sdk 1.0.0

data/generated/docs/DefaultApi.md

@@ -0,0 +1,282 @@
+# TogglrClient::DefaultApi
+
+All URIs are relative to *http://localhost:8090*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_feature_health**](DefaultApi.md#get_feature_health) | **GET** /sdk/v1/features/{feature_key}/health | Get health status of feature (including auto-disable state) |
+| [**report_feature_error**](DefaultApi.md#report_feature_error) | **POST** /sdk/v1/features/{feature_key}/report-error | Report feature execution error (for auto-disable) |
+| [**sdk_v1_features_feature_key_evaluate_post**](DefaultApi.md#sdk_v1_features_feature_key_evaluate_post) | **POST** /sdk/v1/features/{feature_key}/evaluate | Evaluate feature for given context |
+| [**sdk_v1_health_get**](DefaultApi.md#sdk_v1_health_get) | **GET** /sdk/v1/health | Health check for SDK server |
+
+
+## get_feature_health
+
+> <FeatureHealth> get_feature_health(feature_key)
+
+Get health status of feature (including auto-disable state)
+
+### Examples
+
+```ruby
+require 'time'
+require 'togglr-client'
+# setup authorization
+TogglrClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = TogglrClient::DefaultApi.new
+feature_key = 'feature_key_example' # String | 
+
+begin
+  # Get health status of feature (including auto-disable state)
+  result = api_instance.get_feature_health(feature_key)
+  p result
+rescue TogglrClient::ApiError => e
+  puts "Error when calling DefaultApi->get_feature_health: #{e}"
+end
+```
+
+#### Using the get_feature_health_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FeatureHealth>, Integer, Hash)> get_feature_health_with_http_info(feature_key)
+
+```ruby
+begin
+  # Get health status of feature (including auto-disable state)
+  data, status_code, headers = api_instance.get_feature_health_with_http_info(feature_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FeatureHealth>
+rescue TogglrClient::ApiError => e
+  puts "Error when calling DefaultApi->get_feature_health_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **feature_key** | **String** |  |  |
+
+### Return type
+
+[**FeatureHealth**](FeatureHealth.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## report_feature_error
+
+> report_feature_error(feature_key, feature_error_report)
+
+Report feature execution error (for auto-disable)
+
+### Examples
+
+```ruby
+require 'time'
+require 'togglr-client'
+# setup authorization
+TogglrClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = TogglrClient::DefaultApi.new
+feature_key = 'feature_key_example' # String | 
+feature_error_report = TogglrClient::FeatureErrorReport.new({error_type: 'timeout', error_message: 'Service X did not respond in 5s'}) # FeatureErrorReport | 
+
+begin
+  # Report feature execution error (for auto-disable)
+  api_instance.report_feature_error(feature_key, feature_error_report)
+rescue TogglrClient::ApiError => e
+  puts "Error when calling DefaultApi->report_feature_error: #{e}"
+end
+```
+
+#### Using the report_feature_error_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)> report_feature_error_with_http_info(feature_key, feature_error_report)
+
+```ruby
+begin
+  # Report feature execution error (for auto-disable)
+  data, status_code, headers = api_instance.report_feature_error_with_http_info(feature_key, feature_error_report)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TogglrClient::ApiError => e
+  puts "Error when calling DefaultApi->report_feature_error_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **feature_key** | **String** |  |  |
+| **feature_error_report** | [**FeatureErrorReport**](FeatureErrorReport.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## sdk_v1_features_feature_key_evaluate_post
+
+> <EvaluateResponse> sdk_v1_features_feature_key_evaluate_post(feature_key, request_body)
+
+Evaluate feature for given context
+
+Returns feature evaluation result for given project and context. The project is derived from the API key. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'togglr-client'
+# setup authorization
+TogglrClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = TogglrClient::DefaultApi.new
+feature_key = 'feature_key_example' # String | 
+request_body = { key: 3.56} # Hash<String, Object> | 
+
+begin
+  # Evaluate feature for given context
+  result = api_instance.sdk_v1_features_feature_key_evaluate_post(feature_key, request_body)
+  p result
+rescue TogglrClient::ApiError => e
+  puts "Error when calling DefaultApi->sdk_v1_features_feature_key_evaluate_post: #{e}"
+end
+```
+
+#### Using the sdk_v1_features_feature_key_evaluate_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EvaluateResponse>, Integer, Hash)> sdk_v1_features_feature_key_evaluate_post_with_http_info(feature_key, request_body)
+
+```ruby
+begin
+  # Evaluate feature for given context
+  data, status_code, headers = api_instance.sdk_v1_features_feature_key_evaluate_post_with_http_info(feature_key, request_body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EvaluateResponse>
+rescue TogglrClient::ApiError => e
+  puts "Error when calling DefaultApi->sdk_v1_features_feature_key_evaluate_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **feature_key** | **String** |  |  |
+| **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) |  |  |
+
+### Return type
+
+[**EvaluateResponse**](EvaluateResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## sdk_v1_health_get
+
+> <HealthResponse> sdk_v1_health_get
+
+Health check for SDK server
+
+### Examples
+
+```ruby
+require 'time'
+require 'togglr-client'
+
+api_instance = TogglrClient::DefaultApi.new
+
+begin
+  # Health check for SDK server
+  result = api_instance.sdk_v1_health_get
+  p result
+rescue TogglrClient::ApiError => e
+  puts "Error when calling DefaultApi->sdk_v1_health_get: #{e}"
+end
+```
+
+#### Using the sdk_v1_health_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<HealthResponse>, Integer, Hash)> sdk_v1_health_get_with_http_info
+
+```ruby
+begin
+  # Health check for SDK server
+  data, status_code, headers = api_instance.sdk_v1_health_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <HealthResponse>
+rescue TogglrClient::ApiError => e
+  puts "Error when calling DefaultApi->sdk_v1_health_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**HealthResponse**](HealthResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/generated/docs/Error.md

@@ -0,0 +1,18 @@
+# TogglrClient::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ErrorError**](ErrorError.md) |  |  |
+
+## Example
+
+```ruby
+require 'togglr-client'
+
+instance = TogglrClient::Error.new(
+  error: null
+)
+```
+

data/generated/docs/ErrorBadRequest.md

@@ -0,0 +1,18 @@
+# TogglrClient::ErrorBadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ErrorError**](ErrorError.md) |  |  |
+
+## Example
+
+```ruby
+require 'togglr-client'
+
+instance = TogglrClient::ErrorBadRequest.new(
+  error: null
+)
+```
+

data/generated/docs/ErrorError.md

@@ -0,0 +1,18 @@
+# TogglrClient::ErrorError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togglr-client'
+
+instance = TogglrClient::ErrorError.new(
+  message: null
+)
+```
+

data/generated/docs/ErrorInternalServerError.md

@@ -0,0 +1,18 @@
+# TogglrClient::ErrorInternalServerError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ErrorError**](ErrorError.md) |  |  |
+
+## Example
+
+```ruby
+require 'togglr-client'
+
+instance = TogglrClient::ErrorInternalServerError.new(
+  error: null
+)
+```
+

data/generated/docs/ErrorNotFound.md

@@ -0,0 +1,18 @@
+# TogglrClient::ErrorNotFound
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ErrorError**](ErrorError.md) |  |  |
+
+## Example
+
+```ruby
+require 'togglr-client'
+
+instance = TogglrClient::ErrorNotFound.new(
+  error: null
+)
+```
+

data/generated/docs/ErrorPermissionDenied.md

@@ -0,0 +1,18 @@
+# TogglrClient::ErrorPermissionDenied
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ErrorError**](ErrorError.md) |  |  |
+
+## Example
+
+```ruby
+require 'togglr-client'
+
+instance = TogglrClient::ErrorPermissionDenied.new(
+  error: null
+)
+```
+

data/generated/docs/ErrorTooManyRequests.md

@@ -0,0 +1,18 @@
+# TogglrClient::ErrorTooManyRequests
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ErrorError**](ErrorError.md) |  |  |
+
+## Example
+
+```ruby
+require 'togglr-client'
+
+instance = TogglrClient::ErrorTooManyRequests.new(
+  error: null
+)
+```
+

data/generated/docs/ErrorUnauthorized.md

@@ -0,0 +1,18 @@
+# TogglrClient::ErrorUnauthorized
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ErrorError**](ErrorError.md) |  |  |
+
+## Example
+
+```ruby
+require 'togglr-client'
+
+instance = TogglrClient::ErrorUnauthorized.new(
+  error: null
+)
+```
+

data/generated/docs/EvaluateResponse.md

@@ -0,0 +1,22 @@
+# TogglrClient::EvaluateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **feature_key** | **String** |  |  |
+| **enabled** | **Boolean** |  |  |
+| **value** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'togglr-client'
+
+instance = TogglrClient::EvaluateResponse.new(
+  feature_key: null,
+  enabled: null,
+  value: null
+)
+```
+

data/generated/docs/FeatureErrorReport.md

@@ -0,0 +1,22 @@
+# TogglrClient::FeatureErrorReport
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_type** | **String** |  |  |
+| **error_message** | **String** |  |  |
+| **context** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togglr-client'
+
+instance = TogglrClient::FeatureErrorReport.new(
+  error_type: timeout,
+  error_message: Service X did not respond in 5s,
+  context: null
+)
+```
+

data/generated/docs/FeatureHealth.md

@@ -0,0 +1,30 @@
+# TogglrClient::FeatureHealth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **feature_key** | **String** |  |  |
+| **environment_key** | **String** |  |  |
+| **enabled** | **Boolean** |  |  |
+| **auto_disabled** | **Boolean** |  |  |
+| **error_rate** | **Float** |  | [optional] |
+| **threshold** | **Float** |  | [optional] |
+| **last_error_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togglr-client'
+
+instance = TogglrClient::FeatureHealth.new(
+  feature_key: null,
+  environment_key: null,
+  enabled: null,
+  auto_disabled: null,
+  error_rate: 0.15,
+  threshold: 0.2,
+  last_error_at: null
+)
+```
+

data/generated/docs/HealthResponse.md

@@ -0,0 +1,20 @@
+# TogglrClient::HealthResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  |  |
+| **server_time** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'togglr-client'
+
+instance = TogglrClient::HealthResponse.new(
+  status: null,
+  server_time: null
+)
+```
+

data/generated/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="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    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'