rbflagr 0.1.2

data/docs/Distribution.md

@@ -0,0 +1,12 @@
+# Flagr::Distribution
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**percent** | **Integer** |  | 
+**bitmap** | **String** |  | [optional] 
+**variant_key** | **String** |  | 
+**variant_id** | **Integer** |  | 
+
+

data/docs/DistributionApi.md

@@ -0,0 +1,109 @@
+# Flagr::DistributionApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**find_distributions**](DistributionApi.md#find_distributions) | **GET** /flags/{flagID}/segments/{segmentID}/distributions | 
+[**put_distributions**](DistributionApi.md#put_distributions) | **PUT** /flags/{flagID}/segments/{segmentID}/distributions | 
+
+
+# **find_distributions**
+> Array<Distribution> find_distributions(flag_id, segment_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::DistributionApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag
+
+segment_id = 789 # Integer | numeric ID of the segment
+
+
+begin
+  result = api_instance.find_distributions(flag_id, segment_id)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling DistributionApi->find_distributions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag | 
+ **segment_id** | **Integer**| numeric ID of the segment | 
+
+### Return type
+
+[**Array<Distribution>**](Distribution.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_distributions**
+> Array<Distribution> put_distributions(flag_id, segment_id, body)
+
+
+
+replace the distribution with the new setting
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::DistributionApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag
+
+segment_id = 789 # Integer | numeric ID of the segment
+
+body = Flagr::PutDistributionsRequest.new # PutDistributionsRequest | array of distributions
+
+
+begin
+  result = api_instance.put_distributions(flag_id, segment_id, body)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling DistributionApi->put_distributions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag | 
+ **segment_id** | **Integer**| numeric ID of the segment | 
+ **body** | [**PutDistributionsRequest**](PutDistributionsRequest.md)| array of distributions | 
+
+### Return type
+
+[**Array<Distribution>**](Distribution.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Error.md

@@ -0,0 +1,8 @@
+# Flagr::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | 
+
+

data/docs/EvalContext.md

@@ -0,0 +1,12 @@
+# Flagr::EvalContext
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_id** | **String** | entityID is used to deterministically at random to evaluate the flag result. If it's empty, flagr will randomly generate one. | [optional] 
+**entity_type** | **String** |  | 
+**entity_context** | **Object** |  | [optional] 
+**enable_debug** | **BOOLEAN** |  | [optional] 
+**flag_id** | **Integer** |  | 
+
+

data/docs/EvalDebugLog.md

@@ -0,0 +1,9 @@
+# Flagr::EvalDebugLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**segment_debug_logs** | [**Array<SegmentDebugLog>**](SegmentDebugLog.md) |  | [optional] 
+**msg** | **String** |  | [optional] 
+
+

data/docs/EvalResult.md

@@ -0,0 +1,16 @@
+# Flagr::EvalResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**flag_id** | **Integer** |  | 
+**flag_snapshot_id** | **Integer** |  | [optional] 
+**segment_id** | **Integer** |  | 
+**variant_id** | **Integer** |  | 
+**variant_key** | **String** |  | 
+**variant_attachment** | **Object** |  | 
+**eval_context** | [**EvalContext**](EvalContext.md) |  | 
+**timestamp** | **String** |  | 
+**eval_debug_log** | [**EvalDebugLog**](EvalDebugLog.md) |  | [optional] 
+
+

data/docs/EvaluationApi.md

@@ -0,0 +1,98 @@
+# Flagr::EvaluationApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**post_evaluation**](EvaluationApi.md#post_evaluation) | **POST** /evaluation | 
+[**post_evaluation_batch**](EvaluationApi.md#post_evaluation_batch) | **POST** /evaluation/batch | 
+
+
+# **post_evaluation**
+> EvalResult post_evaluation(body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::EvaluationApi.new
+
+body = Flagr::EvalContext.new # EvalContext | evalution context
+
+
+begin
+  result = api_instance.post_evaluation(body)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling EvaluationApi->post_evaluation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**EvalContext**](EvalContext.md)| evalution context | 
+
+### Return type
+
+[**EvalResult**](EvalResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_evaluation_batch**
+> EvaluationBatchResponse post_evaluation_batch(body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::EvaluationApi.new
+
+body = Flagr::EvaluationBatchRequest.new # EvaluationBatchRequest | evalution batch request
+
+
+begin
+  result = api_instance.post_evaluation_batch(body)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling EvaluationApi->post_evaluation_batch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**EvaluationBatchRequest**](EvaluationBatchRequest.md)| evalution batch request | 
+
+### Return type
+
+[**EvaluationBatchResponse**](EvaluationBatchResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/EvaluationBatchRequest.md

@@ -0,0 +1,10 @@
+# Flagr::EvaluationBatchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entities** | [**Array<EvaluationEntity>**](EvaluationEntity.md) |  | 
+**enable_debug** | **BOOLEAN** |  | [optional] 
+**flag_i_ds** | **Array<Integer>** |  | 
+
+

data/docs/EvaluationBatchResponse.md

@@ -0,0 +1,8 @@
+# Flagr::EvaluationBatchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**evaluation_results** | [**Array<EvalResult>**](EvalResult.md) |  | 
+
+

data/docs/EvaluationEntity.md

@@ -0,0 +1,10 @@
+# Flagr::EvaluationEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_id** | **String** |  | [optional] 
+**entity_type** | **String** |  | 
+**entity_context** | **Object** |  | [optional] 
+
+

data/docs/Flag.md

@@ -0,0 +1,13 @@
+# Flagr::Flag
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**description** | **String** |  | 
+**enabled** | **BOOLEAN** |  | 
+**segments** | [**Array<Segment>**](Segment.md) |  | [optional] 
+**variants** | [**Array<Variant>**](Variant.md) |  | [optional] 
+**data_records_enabled** | **BOOLEAN** | enabled data records will get data logging in the metrics pipeline, for example, kafka. | 
+
+

data/docs/FlagApi.md

@@ -0,0 +1,337 @@
+# Flagr::FlagApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_flag**](FlagApi.md#create_flag) | **POST** /flags | 
+[**delete_flag**](FlagApi.md#delete_flag) | **DELETE** /flags/{flagID} | 
+[**find_flags**](FlagApi.md#find_flags) | **GET** /flags | 
+[**get_flag**](FlagApi.md#get_flag) | **GET** /flags/{flagID} | 
+[**get_flag_snapshots**](FlagApi.md#get_flag_snapshots) | **GET** /flags/{flagID}/snapshots | 
+[**put_flag**](FlagApi.md#put_flag) | **PUT** /flags/{flagID} | 
+[**set_flag_enabled**](FlagApi.md#set_flag_enabled) | **PUT** /flags/{flagID}/enabled | 
+
+
+# **create_flag**
+> Flag create_flag(body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::FlagApi.new
+
+body = Flagr::CreateFlagRequest.new # CreateFlagRequest | create a flag
+
+
+begin
+  result = api_instance.create_flag(body)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling FlagApi->create_flag: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CreateFlagRequest**](CreateFlagRequest.md)| create a flag | 
+
+### Return type
+
+[**Flag**](Flag.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_flag**
+> delete_flag(flag_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::FlagApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag
+
+
+begin
+  api_instance.delete_flag(flag_id)
+rescue Flagr::ApiError => e
+  puts "Exception when calling FlagApi->delete_flag: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_flags**
+> Array<Flag> find_flags(opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::FlagApi.new
+
+opts = { 
+  limit: 789, # Integer | the numbers of flags to return
+  enabled: true, # BOOLEAN | return flags having given enabled status
+  description: 'description_example', # String | return flags exactly matching given description
+  description_like: 'description_like_example', # String | return flags partially matching given description
+  offset: 789 # Integer | return flags given the offset, it should usually set together with limit
+}
+
+begin
+  result = api_instance.find_flags(opts)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling FlagApi->find_flags: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| the numbers of flags to return | [optional] 
+ **enabled** | **BOOLEAN**| return flags having given enabled status | [optional] 
+ **description** | **String**| return flags exactly matching given description | [optional] 
+ **description_like** | **String**| return flags partially matching given description | [optional] 
+ **offset** | **Integer**| return flags given the offset, it should usually set together with limit | [optional] 
+
+### Return type
+
+[**Array<Flag>**](Flag.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_flag**
+> Flag get_flag(flag_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::FlagApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag to get
+
+
+begin
+  result = api_instance.get_flag(flag_id)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling FlagApi->get_flag: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag to get | 
+
+### Return type
+
+[**Flag**](Flag.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_flag_snapshots**
+> Array<FlagSnapshot> get_flag_snapshots(flag_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::FlagApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag to get
+
+
+begin
+  result = api_instance.get_flag_snapshots(flag_id)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling FlagApi->get_flag_snapshots: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag to get | 
+
+### Return type
+
+[**Array<FlagSnapshot>**](FlagSnapshot.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_flag**
+> Flag put_flag(flag_id, body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::FlagApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag to get
+
+body = Flagr::PutFlagRequest.new # PutFlagRequest | update a flag
+
+
+begin
+  result = api_instance.put_flag(flag_id, body)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling FlagApi->put_flag: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag to get | 
+ **body** | [**PutFlagRequest**](PutFlagRequest.md)| update a flag | 
+
+### Return type
+
+[**Flag**](Flag.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **set_flag_enabled**
+> Flag set_flag_enabled(flag_id, body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::FlagApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag to get
+
+body = Flagr::SetFlagEnabledRequest.new # SetFlagEnabledRequest | set flag enabled state
+
+
+begin
+  result = api_instance.set_flag_enabled(flag_id, body)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling FlagApi->set_flag_enabled: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag to get | 
+ **body** | [**SetFlagEnabledRequest**](SetFlagEnabledRequest.md)| set flag enabled state | 
+
+### Return type
+
+[**Flag**](Flag.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+