launchdarkly_api 5.3.0 → 7.0.0

data/docs/MetricsApi.md

@@ -0,0 +1,376 @@
+# LaunchDarklyApi::MetricsApi
+
+All URIs are relative to *https://app.launchdarkly.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_metric**](MetricsApi.md#delete_metric) | **DELETE** /api/v2/metrics/{projectKey}/{key} | Delete metric |
+| [**get_metric**](MetricsApi.md#get_metric) | **GET** /api/v2/metrics/{projectKey}/{key} | Get metric |
+| [**get_metrics**](MetricsApi.md#get_metrics) | **GET** /api/v2/metrics/{projectKey} | List metrics |
+| [**patch_metric**](MetricsApi.md#patch_metric) | **PATCH** /api/v2/metrics/{projectKey}/{key} | Update metric |
+| [**post_metric**](MetricsApi.md#post_metric) | **POST** /api/v2/metrics/{projectKey} | Create metric |
+
+
+## delete_metric
+
+> delete_metric(project_key, key)
+
+Delete metric
+
+Delete a metric by key.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::MetricsApi.new
+project_key = 'project_key_example' # String | The project key
+key = 'key_example' # String | The metric key
+
+begin
+  # Delete metric
+  api_instance.delete_metric(project_key, key)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling MetricsApi->delete_metric: #{e}"
+end
+```
+
+#### Using the delete_metric_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)> delete_metric_with_http_info(project_key, key)
+
+```ruby
+begin
+  # Delete metric
+  data, status_code, headers = api_instance.delete_metric_with_http_info(project_key, key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling MetricsApi->delete_metric_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **key** | **String** | The metric key |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_metric
+
+> <MetricRep> get_metric(project_key, key)
+
+Get metric
+
+Get information for a single metric from the specific project.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::MetricsApi.new
+project_key = 'project_key_example' # String | The project key
+key = 'key_example' # String | The metric key
+
+begin
+  # Get metric
+  result = api_instance.get_metric(project_key, key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling MetricsApi->get_metric: #{e}"
+end
+```
+
+#### Using the get_metric_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MetricRep>, Integer, Hash)> get_metric_with_http_info(project_key, key)
+
+```ruby
+begin
+  # Get metric
+  data, status_code, headers = api_instance.get_metric_with_http_info(project_key, key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MetricRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling MetricsApi->get_metric_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **key** | **String** | The metric key |  |
+
+### Return type
+
+[**MetricRep**](MetricRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_metrics
+
+> <MetricCollectionRep> get_metrics(project_key)
+
+List metrics
+
+Get a list of all metrics for the specified project.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::MetricsApi.new
+project_key = 'project_key_example' # String | The project key
+
+begin
+  # List metrics
+  result = api_instance.get_metrics(project_key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling MetricsApi->get_metrics: #{e}"
+end
+```
+
+#### Using the get_metrics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MetricCollectionRep>, Integer, Hash)> get_metrics_with_http_info(project_key)
+
+```ruby
+begin
+  # List metrics
+  data, status_code, headers = api_instance.get_metrics_with_http_info(project_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MetricCollectionRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling MetricsApi->get_metrics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+
+### Return type
+
+[**MetricCollectionRep**](MetricCollectionRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## patch_metric
+
+> <MetricRep> patch_metric(project_key, key, patch_operation)
+
+Update metric
+
+Patch a environment by key.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::MetricsApi.new
+project_key = 'project_key_example' # String | The project key
+key = 'key_example' # String | The metric key
+patch_operation = [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/biscuits', value: Chocolate Digestive})] # Array<PatchOperation> | 
+
+begin
+  # Update metric
+  result = api_instance.patch_metric(project_key, key, patch_operation)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling MetricsApi->patch_metric: #{e}"
+end
+```
+
+#### Using the patch_metric_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MetricRep>, Integer, Hash)> patch_metric_with_http_info(project_key, key, patch_operation)
+
+```ruby
+begin
+  # Update metric
+  data, status_code, headers = api_instance.patch_metric_with_http_info(project_key, key, patch_operation)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MetricRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling MetricsApi->patch_metric_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **key** | **String** | The metric key |  |
+| **patch_operation** | [**Array&lt;PatchOperation&gt;**](PatchOperation.md) |  |  |
+
+### Return type
+
+[**MetricRep**](MetricRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_metric
+
+> <MetricRep> post_metric(project_key, metric_post)
+
+Create metric
+
+Create a new metric in the specified project. Note that the expected POST body differs depending on the specified kind property.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::MetricsApi.new
+project_key = 'project_key_example' # String | The project key
+metric_post = LaunchDarklyApi::MetricPost.new({key: 'key_example', kind: 'pageview'}) # MetricPost | 
+
+begin
+  # Create metric
+  result = api_instance.post_metric(project_key, metric_post)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling MetricsApi->post_metric: #{e}"
+end
+```
+
+#### Using the post_metric_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MetricRep>, Integer, Hash)> post_metric_with_http_info(project_key, metric_post)
+
+```ruby
+begin
+  # Create metric
+  data, status_code, headers = api_instance.post_metric_with_http_info(project_key, metric_post)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MetricRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling MetricsApi->post_metric_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **metric_post** | [**MetricPost**](MetricPost.md) |  |  |
+
+### Return type
+
+[**MetricRep**](MetricRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Modification.md

@@ -0,0 +1,18 @@
+# LaunchDarklyApi::Modification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::Modification.new(
+  date: 2021-08-05T19:46:31.148082Z
+)
+```
+

data/docs/MultiEnvironmentDependentFlag.md

@@ -1,12 +1,22 @@
 # LaunchDarklyApi::MultiEnvironmentDependentFlag
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** |  | [optional] 
-**key** | **String** |  | [optional] 
-**environments** | [**Array<DependentFlagEnvironment>**](DependentFlagEnvironment.md) |  | [optional] 
-**_links** | [**DependentFlagsLinks**](DependentFlagsLinks.md) |  | [optional] 
-**_site** | [**Site**](Site.md) |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **key** | **String** |  |  |
+| **environments** | [**Array<DependentFlagEnvironment>**](DependentFlagEnvironment.md) |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::MultiEnvironmentDependentFlag.new(
+  name: null,
+  key: null,
+  environments: null
+)
+```
 

data/docs/MultiEnvironmentDependentFlags.md

@@ -1,10 +1,22 @@
 # LaunchDarklyApi::MultiEnvironmentDependentFlags
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**items** | [**Array<MultiEnvironmentDependentFlag>**](MultiEnvironmentDependentFlag.md) |  | [optional] 
-**_links** | [**DependentFlagsLinks**](DependentFlagsLinks.md) |  | [optional] 
-**_site** | [**Site**](Site.md) |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<MultiEnvironmentDependentFlag>**](MultiEnvironmentDependentFlag.md) |  |  |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **_site** | [**Link**](Link.md) |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::MultiEnvironmentDependentFlags.new(
+  items: null,
+  _links: null,
+  _site: null
+)
+```
 

data/docs/NewMemberForm.md

@@ -0,0 +1,28 @@
+# LaunchDarklyApi::NewMemberForm
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | The member's email |  |
+| **password** | **String** | The member's password | [optional] |
+| **first_name** | **String** | The member's first name | [optional] |
+| **last_name** | **String** | The member's last name | [optional] |
+| **role** | **String** | The member's built-in role | [optional] |
+| **custom_roles** | **Array<String>** | The member's custom role | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::NewMemberForm.new(
+  email: null,
+  password: null,
+  first_name: null,
+  last_name: null,
+  role: null,
+  custom_roles: null
+)
+```
+

data/docs/NotFoundErrorRep.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::NotFoundErrorRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::NotFoundErrorRep.new(
+  code: not_found,
+  message: resource not found
+)
+```
+