launchdarkly_api 5.4.0 → 6.0.0

data/docs/MetricPost.md

@@ -0,0 +1,40 @@
+# LaunchDarklyApi::MetricPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  |  |
+| **name** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **kind** | **String** |  |  |
+| **selector** | **String** | Required for click metrics | [optional] |
+| **urls** | [**Array<UrlPost>**](UrlPost.md) | Required for click and pageview metrics | [optional] |
+| **is_active** | **Boolean** |  | [optional] |
+| **is_numeric** | **Boolean** |  | [optional] |
+| **unit** | **String** |  | [optional] |
+| **event_key** | **String** | Required for custom metrics | [optional] |
+| **success_criteria** | **Integer** |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::MetricPost.new(
+  key: null,
+  name: null,
+  description: null,
+  kind: null,
+  selector: null,
+  urls: null,
+  is_active: null,
+  is_numeric: null,
+  unit: null,
+  event_key: null,
+  success_criteria: null,
+  tags: null
+)
+```
+

data/docs/MetricRep.md

@@ -0,0 +1,62 @@
+# LaunchDarklyApi::MetricRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **String** |  |  |
+| **key** | **String** |  |  |
+| **name** | **String** |  |  |
+| **kind** | **String** |  |  |
+| **_attached_flag_count** | **Integer** |  | [optional] |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **_site** | [**Link**](Link.md) |  | [optional] |
+| **_access** | [**AccessRep**](AccessRep.md) |  | [optional] |
+| **tags** | **Array<String>** |  |  |
+| **_creation_date** | **Integer** |  |  |
+| **last_modified** | [**Modification**](Modification.md) |  | [optional] |
+| **maintainer_id** | **String** |  | [optional] |
+| **_maintainer** | [**MemberSummaryRep**](MemberSummaryRep.md) |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **is_numeric** | **Boolean** |  | [optional] |
+| **success_criteria** | **Integer** |  | [optional] |
+| **unit** | **String** |  | [optional] |
+| **event_key** | **String** |  | [optional] |
+| **is_active** | **Boolean** |  | [optional] |
+| **_attached_features** | [**Array<FlagListingRep>**](FlagListingRep.md) |  | [optional] |
+| **_version** | **Integer** |  | [optional] |
+| **selector** | **String** |  | [optional] |
+| **urls** | **Array<Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::MetricRep.new(
+  _id: 5902deadbeef667524a01290,
+  key: my-metric,
+  name: my-metric,
+  kind: null,
+  _attached_flag_count: 0,
+  _links: {"parent":{"href":"/api/v2/metrics/my-project","type":"application/json"},"self":{"href":"/api/v2/metrics/my-project/my-metric","type":"application/json"}},
+  _site: null,
+  _access: null,
+  tags: [],
+  _creation_date: null,
+  last_modified: null,
+  maintainer_id: 569fdeadbeef1644facecafe,
+  _maintainer: null,
+  description: null,
+  is_numeric: null,
+  success_criteria: null,
+  unit: null,
+  event_key: null,
+  is_active: null,
+  _attached_features: null,
+  _version: null,
+  selector: null,
+  urls: null
+)
+```
+

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**: Not defined
+
+
+## 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
+