launchdarkly_api 5.4.0 → 7.1.0

data/docs/ExpandedTeamRep.md

@@ -0,0 +1,44 @@
+# LaunchDarklyApi::ExpandedTeamRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_roles** | [**Array<CustomRolesRep>**](CustomRolesRep.md) |  | [optional] |
+| **team_maintainers** | [**Array<MemberSummaryRep>**](MemberSummaryRep.md) |  | [optional] |
+| **custom_role_keys** | **Array<String>** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **key** | **String** |  | [optional] |
+| **member_ids** | **Array<String>** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **permission_grants** | [**Array<PermissionGrantRep>**](PermissionGrantRep.md) |  | [optional] |
+| **project_keys** | **Array<String>** |  | [optional] |
+| **_access** | [**AccessRep**](AccessRep.md) |  | [optional] |
+| **_created_at** | **Integer** |  | [optional] |
+| **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
+| **_updated_at** | **Integer** |  | [optional] |
+| **_version** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExpandedTeamRep.new(
+  custom_roles: null,
+  team_maintainers: null,
+  custom_role_keys: null,
+  description: null,
+  key: null,
+  member_ids: null,
+  name: null,
+  permission_grants: null,
+  project_keys: null,
+  _access: null,
+  _created_at: null,
+  _links: null,
+  _updated_at: null,
+  _version: null
+)
+```
+

data/docs/ExperimentAllocationRep.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::ExperimentAllocationRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **default_variation** | **Integer** |  |  |
+| **can_reshuffle** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExperimentAllocationRep.new(
+  default_variation: null,
+  can_reshuffle: null
+)
+```
+

data/docs/ExperimentEnabledPeriodRep.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::ExperimentEnabledPeriodRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **Integer** |  | [optional] |
+| **stop_date** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExperimentEnabledPeriodRep.new(
+  start_date: null,
+  stop_date: null
+)
+```
+

data/docs/ExperimentEnvironmentSettingRep.md

@@ -0,0 +1,22 @@
+# LaunchDarklyApi::ExperimentEnvironmentSettingRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **Integer** |  | [optional] |
+| **stop_date** | **Integer** |  | [optional] |
+| **enabled_periods** | [**Array<ExperimentEnabledPeriodRep>**](ExperimentEnabledPeriodRep.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExperimentEnvironmentSettingRep.new(
+  start_date: null,
+  stop_date: null,
+  enabled_periods: null
+)
+```
+

data/docs/ExperimentInfoRep.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::ExperimentInfoRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **baseline_idx** | **Integer** |  |  |
+| **items** | [**Array<ExperimentRep>**](ExperimentRep.md) |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExperimentInfoRep.new(
+  baseline_idx: null,
+  items: null
+)
+```
+

data/docs/ExperimentMetadataRep.md

@@ -0,0 +1,18 @@
+# LaunchDarklyApi::ExperimentMetadataRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExperimentMetadataRep.new(
+  key: null
+)
+```
+

data/docs/ExperimentRep.md

@@ -0,0 +1,24 @@
+# LaunchDarklyApi::ExperimentRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metric_key** | **String** |  | [optional] |
+| **_metric** | [**MetricListingRep**](MetricListingRep.md) |  | [optional] |
+| **environments** | **Array<String>** |  | [optional] |
+| **_environment_settings** | [**Hash<String, ExperimentEnvironmentSettingRep>**](ExperimentEnvironmentSettingRep.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExperimentRep.new(
+  metric_key: my-metric,
+  _metric: null,
+  environments: ["production","test","my-environment"],
+  _environment_settings: null
+)
+```
+

data/docs/ExperimentResultsRep.md

@@ -0,0 +1,30 @@
+# LaunchDarklyApi::ExperimentResultsRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
+| **metadata** | [**Array<ExperimentMetadataRep>**](ExperimentMetadataRep.md) |  | [optional] |
+| **totals** | [**Array<ExperimentTotalsRep>**](ExperimentTotalsRep.md) |  | [optional] |
+| **series** | [**Array<ExperimentTimeSeriesSlice>**](ExperimentTimeSeriesSlice.md) |  | [optional] |
+| **stats** | [**ExperimentStatsRep**](ExperimentStatsRep.md) |  | [optional] |
+| **granularity** | **String** |  | [optional] |
+| **metric_seen** | [**MetricSeen**](MetricSeen.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExperimentResultsRep.new(
+  _links: null,
+  metadata: null,
+  totals: null,
+  series: null,
+  stats: null,
+  granularity: null,
+  metric_seen: null
+)
+```
+

data/docs/ExperimentStatsRep.md

@@ -0,0 +1,24 @@
+# LaunchDarklyApi::ExperimentStatsRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **p_value** | **Float** |  | [optional] |
+| **chi2** | **Float** |  | [optional] |
+| **winning_variation_idx** | **Integer** |  | [optional] |
+| **min_sample_size_met** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExperimentStatsRep.new(
+  p_value: null,
+  chi2: null,
+  winning_variation_idx: null,
+  min_sample_size_met: null
+)
+```
+

data/docs/ExperimentTimeSeriesSlice.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::ExperimentTimeSeriesSlice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **time** | **Integer** |  | [optional] |
+| **variation_data** | [**Array<ExperimentTimeSeriesVariationSlice>**](ExperimentTimeSeriesVariationSlice.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExperimentTimeSeriesSlice.new(
+  time: null,
+  variation_data: null
+)
+```
+

data/docs/ExperimentTimeSeriesVariationSlice.md

@@ -0,0 +1,32 @@
+# LaunchDarklyApi::ExperimentTimeSeriesVariationSlice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **Float** |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **cumulative_value** | **Float** |  | [optional] |
+| **cumulative_count** | **Integer** |  | [optional] |
+| **conversion_rate** | **Float** |  | [optional] |
+| **cumulative_conversion_rate** | **Float** |  | [optional] |
+| **confidence_interval** | [**ConfidenceIntervalRep**](ConfidenceIntervalRep.md) |  | [optional] |
+| **cumulative_confidence_interval** | [**ConfidenceIntervalRep**](ConfidenceIntervalRep.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExperimentTimeSeriesVariationSlice.new(
+  value: null,
+  count: null,
+  cumulative_value: null,
+  cumulative_count: null,
+  conversion_rate: null,
+  cumulative_conversion_rate: null,
+  confidence_interval: null,
+  cumulative_confidence_interval: null
+)
+```
+

data/docs/ExperimentTotalsRep.md

@@ -0,0 +1,32 @@
+# LaunchDarklyApi::ExperimentTotalsRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cumulative_value** | **Float** |  | [optional] |
+| **cumulative_count** | **Integer** |  | [optional] |
+| **cumulative_impression_count** | **Integer** |  | [optional] |
+| **cumulative_conversion_rate** | **Float** |  | [optional] |
+| **cumulative_confidence_interval** | [**ConfidenceIntervalRep**](ConfidenceIntervalRep.md) |  | [optional] |
+| **p_value** | **Float** |  | [optional] |
+| **improvement** | **Float** |  | [optional] |
+| **min_sample_size** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExperimentTotalsRep.new(
+  cumulative_value: null,
+  cumulative_count: null,
+  cumulative_impression_count: null,
+  cumulative_conversion_rate: null,
+  cumulative_confidence_interval: null,
+  p_value: null,
+  improvement: null,
+  min_sample_size: null
+)
+```
+

data/docs/ExperimentsBetaApi.md

@@ -0,0 +1,168 @@
+# LaunchDarklyApi::ExperimentsBetaApi
+
+All URIs are relative to *https://app.launchdarkly.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_experiment**](ExperimentsBetaApi.md#get_experiment) | **GET** /api/v2/flags/{projKey}/{flagKey}/experiments/{envKey}/{metricKey} | Get experiment results |
+| [**reset_experiment**](ExperimentsBetaApi.md#reset_experiment) | **DELETE** /api/v2/flags/{projKey}/{flagKey}/experiments/{envKey}/{metricKey}/results | Reset experiment results |
+
+
+## get_experiment
+
+> <ExperimentResultsRep> get_experiment(proj_key, flag_key, env_key, metric_key, opts)
+
+Get experiment results
+
+Get detailed experiment result data
+
+### 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::ExperimentsBetaApi.new
+proj_key = 'proj_key_example' # String | The project key
+flag_key = 'flag_key_example' # String | The flag key
+env_key = 'env_key_example' # String | The environment key
+metric_key = 'metric_key_example' # String | The metric key
+opts = {
+  from: 789, # Integer | A timestamp denoting the start of the data collection period, expressed as a Unix epoch time in milliseconds.
+  to: 789 # Integer | A timestamp denoting the end of the data collection period, expressed as a Unix epoch time in milliseconds.
+}
+
+begin
+  # Get experiment results
+  result = api_instance.get_experiment(proj_key, flag_key, env_key, metric_key, opts)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->get_experiment: #{e}"
+end
+```
+
+#### Using the get_experiment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExperimentResultsRep>, Integer, Hash)> get_experiment_with_http_info(proj_key, flag_key, env_key, metric_key, opts)
+
+```ruby
+begin
+  # Get experiment results
+  data, status_code, headers = api_instance.get_experiment_with_http_info(proj_key, flag_key, env_key, metric_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExperimentResultsRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->get_experiment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **proj_key** | **String** | The project key |  |
+| **flag_key** | **String** | The flag key |  |
+| **env_key** | **String** | The environment key |  |
+| **metric_key** | **String** | The metric key |  |
+| **from** | **Integer** | A timestamp denoting the start of the data collection period, expressed as a Unix epoch time in milliseconds. | [optional] |
+| **to** | **Integer** | A timestamp denoting the end of the data collection period, expressed as a Unix epoch time in milliseconds. | [optional] |
+
+### Return type
+
+[**ExperimentResultsRep**](ExperimentResultsRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## reset_experiment
+
+> reset_experiment(proj_key, flag_key, env_key, metric_key)
+
+Reset experiment results
+
+Reset all experiment results by deleting all existing data for an experiment
+
+### 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::ExperimentsBetaApi.new
+proj_key = 'proj_key_example' # String | The project key
+flag_key = 'flag_key_example' # String | The feature flag's key
+env_key = 'env_key_example' # String | The environment key
+metric_key = 'metric_key_example' # String | The metric's key
+
+begin
+  # Reset experiment results
+  api_instance.reset_experiment(proj_key, flag_key, env_key, metric_key)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->reset_experiment: #{e}"
+end
+```
+
+#### Using the reset_experiment_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)> reset_experiment_with_http_info(proj_key, flag_key, env_key, metric_key)
+
+```ruby
+begin
+  # Reset experiment results
+  data, status_code, headers = api_instance.reset_experiment_with_http_info(proj_key, flag_key, env_key, metric_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->reset_experiment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **proj_key** | **String** | The project key |  |
+| **flag_key** | **String** | The feature flag&#39;s key |  |
+| **env_key** | **String** | The environment key |  |
+| **metric_key** | **String** | The metric&#39;s key |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ExpiringUserTargetError.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::ExpiringUserTargetError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **instruction_index** | **Integer** |  |  |
+| **message** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExpiringUserTargetError.new(
+  instruction_index: null,
+  message: null
+)
+```
+

data/docs/ExpiringUserTargetGetResponse.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::ExpiringUserTargetGetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<ExpiringUserTargetItem>**](ExpiringUserTargetItem.md) |  |  |
+| **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExpiringUserTargetGetResponse.new(
+  items: null,
+  _links: null
+)
+```
+

data/docs/ExpiringUserTargetItem.md

@@ -0,0 +1,30 @@
+# LaunchDarklyApi::ExpiringUserTargetItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **String** |  |  |
+| **_version** | **Integer** |  |  |
+| **expiration_date** | **Integer** |  |  |
+| **user_key** | **String** | A unique key used to represent the user |  |
+| **target_type** | **String** | A segment's target type. Included when expiring user targets are updated on a user segment. | [optional] |
+| **variation_id** | **String** | A unique key used to represent the flag variation. Included when expiring user targets are updated on a feature flag. | [optional] |
+| **_resource_id** | [**ResourceIDResponse**](ResourceIDResponse.md) |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExpiringUserTargetItem.new(
+  _id: null,
+  _version: null,
+  expiration_date: null,
+  user_key: null,
+  target_type: null,
+  variation_id: null,
+  _resource_id: null
+)
+```
+

data/docs/ExpiringUserTargetPatchResponse.md

@@ -0,0 +1,28 @@
+# LaunchDarklyApi::ExpiringUserTargetPatchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<ExpiringUserTargetItem>**](ExpiringUserTargetItem.md) |  |  |
+| **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
+| **total_instructions** | **Integer** |  | [optional] |
+| **successful_instructions** | **Integer** |  | [optional] |
+| **failed_instructions** | **Integer** |  | [optional] |
+| **errors** | [**Array<ExpiringUserTargetError>**](ExpiringUserTargetError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExpiringUserTargetPatchResponse.new(
+  items: null,
+  _links: null,
+  total_instructions: null,
+  successful_instructions: null,
+  failed_instructions: null,
+  errors: null
+)
+```
+

data/docs/Extinction.md

@@ -0,0 +1,26 @@
+# LaunchDarklyApi::Extinction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **revision** | **String** | The identifier for the revision where flag became extinct. For example, a commit SHA. |  |
+| **message** | **String** | Description of the extinction. For example, the commit message for the revision. |  |
+| **time** | **Integer** |  |  |
+| **flag_key** | **String** | The feature flag key |  |
+| **proj_key** | **String** | The project key |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::Extinction.new(
+  revision: a94a8fe5ccb19ba61c4c0873d391e987982fbbd3,
+  message: Remove flag for launched feature,
+  time: null,
+  flag_key: enable-feature,
+  proj_key: default
+)
+```
+

data/docs/ExtinctionCollectionRep.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::ExtinctionCollectionRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **items** | **Hash<String, Array<Extinction>>** | An array of extinction events |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExtinctionCollectionRep.new(
+  _links: null,
+  items: null
+)
+```
+