rbflagr 0.1.2

data/docs/FlagSnapshot.md

@@ -0,0 +1,11 @@
+# Flagr::FlagSnapshot
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | 
+**updated_by** | **String** |  | [optional] 
+**flag** | [**Flag**](Flag.md) |  | 
+**updated_at** | **String** |  | 
+
+

data/docs/HealthApi.md

@@ -0,0 +1,46 @@
+# Flagr::HealthApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**health_get**](HealthApi.md#health_get) | **GET** /health | 
+
+
+# **health_get**
+> health_get
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::HealthApi.new
+
+begin
+  api_instance.health_get
+rescue Flagr::ApiError => e
+  puts "Exception when calling HealthApi->health_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/PutDistributionsRequest.md

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

data/docs/PutFlagRequest.md

@@ -0,0 +1,9 @@
+# Flagr::PutFlagRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** |  | 
+**data_records_enabled** | **BOOLEAN** | enabled data records will get data logging in the metrics pipeline, for example, kafka. | [optional] 
+
+

data/docs/PutSegmentReorderRequest.md

@@ -0,0 +1,8 @@
+# Flagr::PutSegmentReorderRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**segment_i_ds** | **Array<Integer>** |  | 
+
+

data/docs/PutSegmentRequest.md

@@ -0,0 +1,9 @@
+# Flagr::PutSegmentRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** |  | 
+**rollout_percent** | **Integer** |  | 
+
+

data/docs/PutVariantRequest.md

@@ -0,0 +1,9 @@
+# Flagr::PutVariantRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** |  | 
+**attachment** | **Object** |  | 
+
+

data/docs/Segment.md

@@ -0,0 +1,13 @@
+# Flagr::Segment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**description** | **String** |  | 
+**constraints** | [**Array<Constraint>**](Constraint.md) |  | [optional] 
+**distributions** | [**Array<Distribution>**](Distribution.md) |  | [optional] 
+**rank** | **Integer** |  | 
+**rollout_percent** | **Integer** |  | 
+
+

data/docs/SegmentApi.md

@@ -0,0 +1,246 @@
+# Flagr::SegmentApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_segment**](SegmentApi.md#create_segment) | **POST** /flags/{flagID}/segments | 
+[**delete_segment**](SegmentApi.md#delete_segment) | **DELETE** /flags/{flagID}/segments/{segmentID} | 
+[**find_segments**](SegmentApi.md#find_segments) | **GET** /flags/{flagID}/segments | 
+[**put_segment**](SegmentApi.md#put_segment) | **PUT** /flags/{flagID}/segments/{segmentID} | 
+[**put_segments_reorder**](SegmentApi.md#put_segments_reorder) | **PUT** /flags/{flagID}/segments/reorder | 
+
+
+# **create_segment**
+> Segment create_segment(flag_id, body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::SegmentApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag to get
+
+body = Flagr::CreateSegmentRequest.new # CreateSegmentRequest | create a segment under a flag
+
+
+begin
+  result = api_instance.create_segment(flag_id, body)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling SegmentApi->create_segment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag to get | 
+ **body** | [**CreateSegmentRequest**](CreateSegmentRequest.md)| create a segment under a flag | 
+
+### Return type
+
+[**Segment**](Segment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_segment**
+> delete_segment(flag_id, segment_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::SegmentApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag
+
+segment_id = 789 # Integer | numeric ID of the segment
+
+
+begin
+  api_instance.delete_segment(flag_id, segment_id)
+rescue Flagr::ApiError => e
+  puts "Exception when calling SegmentApi->delete_segment: #{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
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_segments**
+> Array<Segment> find_segments(flag_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::SegmentApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag to get
+
+
+begin
+  result = api_instance.find_segments(flag_id)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling SegmentApi->find_segments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag to get | 
+
+### Return type
+
+[**Array<Segment>**](Segment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_segment**
+> Segment put_segment(flag_id, segment_id, body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::SegmentApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag
+
+segment_id = 789 # Integer | numeric ID of the segment
+
+body = Flagr::PutSegmentRequest.new # PutSegmentRequest | update a segment
+
+
+begin
+  result = api_instance.put_segment(flag_id, segment_id, body)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling SegmentApi->put_segment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag | 
+ **segment_id** | **Integer**| numeric ID of the segment | 
+ **body** | [**PutSegmentRequest**](PutSegmentRequest.md)| update a segment | 
+
+### Return type
+
+[**Segment**](Segment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_segments_reorder**
+> put_segments_reorder(flag_id, body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::SegmentApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag
+
+body = Flagr::PutSegmentReorderRequest.new # PutSegmentReorderRequest | reorder segments
+
+
+begin
+  api_instance.put_segments_reorder(flag_id, body)
+rescue Flagr::ApiError => e
+  puts "Exception when calling SegmentApi->put_segments_reorder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag | 
+ **body** | [**PutSegmentReorderRequest**](PutSegmentReorderRequest.md)| reorder segments | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/SegmentDebugLog.md

@@ -0,0 +1,9 @@
+# Flagr::SegmentDebugLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**segment_id** | **Integer** |  | [optional] 
+**msg** | **String** |  | [optional] 
+
+

data/docs/SetFlagEnabledRequest.md

@@ -0,0 +1,8 @@
+# Flagr::SetFlagEnabledRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **BOOLEAN** |  | 
+
+

data/docs/Variant.md

@@ -0,0 +1,10 @@
+# Flagr::Variant
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**key** | **String** |  | 
+**attachment** | **Object** |  | [optional] 
+
+

data/docs/VariantApi.md

@@ -0,0 +1,199 @@
+# Flagr::VariantApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_variant**](VariantApi.md#create_variant) | **POST** /flags/{flagID}/variants | 
+[**delete_variant**](VariantApi.md#delete_variant) | **DELETE** /flags/{flagID}/variants/{variantID} | 
+[**find_variants**](VariantApi.md#find_variants) | **GET** /flags/{flagID}/variants | 
+[**put_variant**](VariantApi.md#put_variant) | **PUT** /flags/{flagID}/variants/{variantID} | 
+
+
+# **create_variant**
+> Variant create_variant(flag_id, body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::VariantApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag
+
+body = Flagr::CreateVariantRequest.new # CreateVariantRequest | create a variant
+
+
+begin
+  result = api_instance.create_variant(flag_id, body)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling VariantApi->create_variant: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag | 
+ **body** | [**CreateVariantRequest**](CreateVariantRequest.md)| create a variant | 
+
+### Return type
+
+[**Variant**](Variant.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_variant**
+> delete_variant(flag_id, variant_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::VariantApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag
+
+variant_id = 789 # Integer | numeric ID of the variant
+
+
+begin
+  api_instance.delete_variant(flag_id, variant_id)
+rescue Flagr::ApiError => e
+  puts "Exception when calling VariantApi->delete_variant: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag | 
+ **variant_id** | **Integer**| numeric ID of the variant | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_variants**
+> Array<Variant> find_variants(flag_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::VariantApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag
+
+
+begin
+  result = api_instance.find_variants(flag_id)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling VariantApi->find_variants: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag | 
+
+### Return type
+
+[**Array<Variant>**](Variant.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_variant**
+> Variant put_variant(flag_id, variant_id, body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::VariantApi.new
+
+flag_id = 789 # Integer | numeric ID of the flag
+
+variant_id = 789 # Integer | numeric ID of the variant
+
+body = Flagr::PutVariantRequest.new # PutVariantRequest | update a variant
+
+
+begin
+  result = api_instance.put_variant(flag_id, variant_id, body)
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling VariantApi->put_variant: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **flag_id** | **Integer**| numeric ID of the flag | 
+ **variant_id** | **Integer**| numeric ID of the variant | 
+ **body** | [**PutVariantRequest**](PutVariantRequest.md)| update a variant | 
+
+### Return type
+
+[**Variant**](Variant.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+