launchdarkly_api 19.0.0 → 20.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +24 -10
  3. data/docs/AIConfigPost.md +3 -1
  4. data/docs/AIConfigsBetaApi.md +387 -0
  5. data/docs/AccountUsageBetaApi.md +182 -0
  6. data/docs/AgentGraph.md +30 -0
  7. data/docs/AgentGraphEdge.md +24 -0
  8. data/docs/AgentGraphEdgePost.md +24 -0
  9. data/docs/AgentGraphPatch.md +24 -0
  10. data/docs/AgentGraphPost.md +26 -0
  11. data/docs/AgentGraphs.md +22 -0
  12. data/docs/FeatureFlagsApi.md +3 -1
  13. data/docs/GuardedReleaseConfig.md +10 -2
  14. data/docs/IterationInput.md +0 -2
  15. data/docs/IterationRep.md +1 -3
  16. data/docs/PostReleasePolicyRequest.md +2 -2
  17. data/docs/ProgressiveReleaseConfig.md +20 -0
  18. data/docs/PutReleasePolicyRequest.md +2 -2
  19. data/docs/ReleasePolicy.md +2 -2
  20. data/docs/ReleasePolicyScope.md +3 -1
  21. data/docs/ReleasePolicyStage.md +20 -0
  22. data/docs/Rule.md +2 -0
  23. data/docs/SegmentsApi.md +8 -4
  24. data/docs/TagsApi.md +2 -2
  25. data/lib/launchdarkly_api/api/account_usage_beta_api.rb +171 -0
  26. data/lib/launchdarkly_api/api/ai_configs_beta_api.rb +417 -0
  27. data/lib/launchdarkly_api/api/feature_flags_api.rb +3 -0
  28. data/lib/launchdarkly_api/api/segments_api.rb +3 -0
  29. data/lib/launchdarkly_api/api/tags_api.rb +2 -2
  30. data/lib/launchdarkly_api/models/agent_graph.rb +350 -0
  31. data/lib/launchdarkly_api/models/agent_graph_edge.rb +303 -0
  32. data/lib/launchdarkly_api/models/agent_graph_edge_post.rb +303 -0
  33. data/lib/launchdarkly_api/models/agent_graph_patch.rb +254 -0
  34. data/lib/launchdarkly_api/models/agent_graph_post.rb +298 -0
  35. data/lib/launchdarkly_api/models/{covariance_info_rep.rb → agent_graphs.rb} +43 -59
  36. data/lib/launchdarkly_api/models/ai_config_post.rb +13 -4
  37. data/lib/launchdarkly_api/models/guarded_release_config.rb +50 -21
  38. data/lib/launchdarkly_api/models/iteration_input.rb +1 -11
  39. data/lib/launchdarkly_api/models/iteration_rep.rb +4 -13
  40. data/lib/launchdarkly_api/models/post_release_policy_request.rb +1 -2
  41. data/lib/launchdarkly_api/models/progressive_release_config.rb +234 -0
  42. data/lib/launchdarkly_api/models/put_release_policy_request.rb +1 -2
  43. data/lib/launchdarkly_api/models/release_policy.rb +1 -2
  44. data/lib/launchdarkly_api/models/release_policy_scope.rb +16 -4
  45. data/lib/launchdarkly_api/models/release_policy_stage.rb +263 -0
  46. data/lib/launchdarkly_api/models/rule.rb +11 -1
  47. data/lib/launchdarkly_api/version.rb +1 -1
  48. data/lib/launchdarkly_api.rb +8 -1
  49. data/spec/api/account_usage_beta_api_spec.rb +41 -0
  50. data/spec/api/ai_configs_beta_api_spec.rb +72 -0
  51. data/spec/api/feature_flags_api_spec.rb +1 -0
  52. data/spec/api/segments_api_spec.rb +1 -0
  53. data/spec/api/tags_api_spec.rb +1 -1
  54. data/spec/models/agent_graph_edge_post_spec.rb +54 -0
  55. data/spec/models/agent_graph_edge_spec.rb +54 -0
  56. data/spec/models/agent_graph_patch_spec.rb +54 -0
  57. data/spec/models/agent_graph_post_spec.rb +60 -0
  58. data/spec/models/agent_graph_spec.rb +72 -0
  59. data/spec/models/{covariance_info_rep_spec.rb → agent_graphs_spec.rb} +9 -9
  60. data/spec/models/ai_config_post_spec.rb +6 -0
  61. data/spec/models/guarded_release_config_spec.rb +24 -0
  62. data/spec/models/iteration_input_spec.rb +0 -6
  63. data/spec/models/iteration_rep_spec.rb +0 -6
  64. data/spec/models/progressive_release_config_spec.rb +42 -0
  65. data/spec/models/release_policy_scope_spec.rb +6 -0
  66. data/spec/models/release_policy_stage_spec.rb +42 -0
  67. data/spec/models/rule_spec.rb +6 -0
  68. metadata +34 -6
  69. data/docs/CovarianceInfoRep.md +0 -22
@@ -12,7 +12,9 @@ All URIs are relative to *https://app.launchdarkly.com*
12
12
  | [**get_events_usage**](AccountUsageBetaApi.md#get_events_usage) | **GET** /api/v2/usage/events/{type} | Get events usage |
13
13
  | [**get_experimentation_events_usage**](AccountUsageBetaApi.md#get_experimentation_events_usage) | **GET** /api/v2/usage/experimentation-events | Get experimentation events usage |
14
14
  | [**get_experimentation_keys_usage**](AccountUsageBetaApi.md#get_experimentation_keys_usage) | **GET** /api/v2/usage/experimentation-keys | Get experimentation keys usage |
15
+ | [**get_mau_clientside_usage**](AccountUsageBetaApi.md#get_mau_clientside_usage) | **GET** /api/v2/usage/clientside-mau | Get MAU clientside usage |
15
16
  | [**get_mau_sdks_by_type**](AccountUsageBetaApi.md#get_mau_sdks_by_type) | **GET** /api/v2/usage/mau/sdks | Get MAU SDKs by type |
17
+ | [**get_mau_total_usage**](AccountUsageBetaApi.md#get_mau_total_usage) | **GET** /api/v2/usage/total-mau | Get MAU total usage |
16
18
  | [**get_mau_usage**](AccountUsageBetaApi.md#get_mau_usage) | **GET** /api/v2/usage/mau | Get MAU usage |
17
19
  | [**get_mau_usage_by_category**](AccountUsageBetaApi.md#get_mau_usage_by_category) | **GET** /api/v2/usage/mau/bycategory | Get MAU usage by category |
18
20
  | [**get_observability_errors_usage**](AccountUsageBetaApi.md#get_observability_errors_usage) | **GET** /api/v2/usage/observability/errors | Get observability errors usage |
@@ -723,6 +725,95 @@ end
723
725
  - **Accept**: application/json
724
726
 
725
727
 
728
+ ## get_mau_clientside_usage
729
+
730
+ > <SeriesListRep> get_mau_clientside_usage(opts)
731
+
732
+ Get MAU clientside usage
733
+
734
+ Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only. The counts reflect data reported from client-side SDKs.<br/><br/>For past months, the primary context kind is fixed and reflects the last known primary kind for that month. For the current month, it may vary as new primary context kinds are observed.<br/><br/>The supported granularity varies by aggregation type. The maximum time range is 365 days.
735
+
736
+ ### Examples
737
+
738
+ ```ruby
739
+ require 'time'
740
+ require 'launchdarkly_api'
741
+ # setup authorization
742
+ LaunchDarklyApi.configure do |config|
743
+ # Configure API key authorization: ApiKey
744
+ config.api_key['Authorization'] = 'YOUR API KEY'
745
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
746
+ # config.api_key_prefix['Authorization'] = 'Bearer'
747
+ end
748
+
749
+ api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
750
+ opts = {
751
+ from: 'from_example', # String | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
752
+ to: 'to_example', # String | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
753
+ project_key: 'project_key_example', # String | A project key to filter results by. Can be specified multiple times, one query parameter per project key.
754
+ environment_key: 'environment_key_example', # String | An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
755
+ sdk_name: 'sdk_name_example', # String | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
756
+ anonymous: 'anonymous_example', # String | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`.
757
+ group_by: 'group_by_example', # String | If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension.<br/>Valid values: `projectId`, `environmentId`, `sdkName`, `sdkAppId`, `anonymousV2`.
758
+ aggregation_type: 'aggregation_type_example', # String | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`.
759
+ granularity: 'granularity_example' # String | Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: **month_to_date** supports `daily` and `monthly`; **incremental** and **rolling_30d** support `daily` only.
760
+ }
761
+
762
+ begin
763
+ # Get MAU clientside usage
764
+ result = api_instance.get_mau_clientside_usage(opts)
765
+ p result
766
+ rescue LaunchDarklyApi::ApiError => e
767
+ puts "Error when calling AccountUsageBetaApi->get_mau_clientside_usage: #{e}"
768
+ end
769
+ ```
770
+
771
+ #### Using the get_mau_clientside_usage_with_http_info variant
772
+
773
+ This returns an Array which contains the response data, status code and headers.
774
+
775
+ > <Array(<SeriesListRep>, Integer, Hash)> get_mau_clientside_usage_with_http_info(opts)
776
+
777
+ ```ruby
778
+ begin
779
+ # Get MAU clientside usage
780
+ data, status_code, headers = api_instance.get_mau_clientside_usage_with_http_info(opts)
781
+ p status_code # => 2xx
782
+ p headers # => { ... }
783
+ p data # => <SeriesListRep>
784
+ rescue LaunchDarklyApi::ApiError => e
785
+ puts "Error when calling AccountUsageBetaApi->get_mau_clientside_usage_with_http_info: #{e}"
786
+ end
787
+ ```
788
+
789
+ ### Parameters
790
+
791
+ | Name | Type | Description | Notes |
792
+ | ---- | ---- | ----------- | ----- |
793
+ | **from** | **String** | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. | [optional] |
794
+ | **to** | **String** | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. | [optional] |
795
+ | **project_key** | **String** | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | [optional] |
796
+ | **environment_key** | **String** | An environment key to filter results by. If specified, exactly one &#x60;projectKey&#x60; must be provided. Can be specified multiple times, one query parameter per environment key. | [optional] |
797
+ | **sdk_name** | **String** | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. | [optional] |
798
+ | **anonymous** | **String** | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.&lt;br/&gt;Valid values: &#x60;true&#x60;, &#x60;false&#x60;. | [optional] |
799
+ | **group_by** | **String** | If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension.&lt;br/&gt;Valid values: &#x60;projectId&#x60;, &#x60;environmentId&#x60;, &#x60;sdkName&#x60;, &#x60;sdkAppId&#x60;, &#x60;anonymousV2&#x60;. | [optional] |
800
+ | **aggregation_type** | **String** | Specifies the aggregation method. Defaults to &#x60;month_to_date&#x60;.&lt;br/&gt;Valid values: &#x60;month_to_date&#x60;, &#x60;incremental&#x60;, &#x60;rolling_30d&#x60;. | [optional] |
801
+ | **granularity** | **String** | Specifies the data granularity. Defaults to &#x60;daily&#x60;. Valid values depend on &#x60;aggregationType&#x60;: **month_to_date** supports &#x60;daily&#x60; and &#x60;monthly&#x60;; **incremental** and **rolling_30d** support &#x60;daily&#x60; only. | [optional] |
802
+
803
+ ### Return type
804
+
805
+ [**SeriesListRep**](SeriesListRep.md)
806
+
807
+ ### Authorization
808
+
809
+ [ApiKey](../README.md#ApiKey)
810
+
811
+ ### HTTP request headers
812
+
813
+ - **Content-Type**: Not defined
814
+ - **Accept**: application/json
815
+
816
+
726
817
  ## get_mau_sdks_by_type
727
818
 
728
819
  > <SdkListRep> get_mau_sdks_by_type(opts)
@@ -800,6 +891,97 @@ end
800
891
  - **Accept**: application/json
801
892
 
802
893
 
894
+ ## get_mau_total_usage
895
+
896
+ > <SeriesListRep> get_mau_total_usage(opts)
897
+
898
+ Get MAU total usage
899
+
900
+ Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only.<br/><br/>For past months, this reflects the context kind that was most recently marked as primary for that month. For the current month, the context kind may vary as new primary kinds are observed.<br/><br/>The supported granularity varies by aggregation type. The maximum time range is 365 days.
901
+
902
+ ### Examples
903
+
904
+ ```ruby
905
+ require 'time'
906
+ require 'launchdarkly_api'
907
+ # setup authorization
908
+ LaunchDarklyApi.configure do |config|
909
+ # Configure API key authorization: ApiKey
910
+ config.api_key['Authorization'] = 'YOUR API KEY'
911
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
912
+ # config.api_key_prefix['Authorization'] = 'Bearer'
913
+ end
914
+
915
+ api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
916
+ opts = {
917
+ from: 'from_example', # String | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
918
+ to: 'to_example', # String | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
919
+ project_key: 'project_key_example', # String | A project key to filter results by. Can be specified multiple times, one query parameter per project key.
920
+ environment_key: 'environment_key_example', # String | An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
921
+ sdk_name: 'sdk_name_example', # String | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
922
+ sdk_type: 'sdk_type_example', # String | An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type.
923
+ anonymous: 'anonymous_example', # String | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`.
924
+ group_by: 'group_by_example', # String | If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension.<br/>Valid values: `projectId`, `environmentId`, `sdkName`, `sdkType`, `sdkAppId`, `anonymousV2`.
925
+ aggregation_type: 'aggregation_type_example', # String | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`.
926
+ granularity: 'granularity_example' # String | Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: **month_to_date** supports `daily` and `monthly`; **incremental** and **rolling_30d** support `daily` only.
927
+ }
928
+
929
+ begin
930
+ # Get MAU total usage
931
+ result = api_instance.get_mau_total_usage(opts)
932
+ p result
933
+ rescue LaunchDarklyApi::ApiError => e
934
+ puts "Error when calling AccountUsageBetaApi->get_mau_total_usage: #{e}"
935
+ end
936
+ ```
937
+
938
+ #### Using the get_mau_total_usage_with_http_info variant
939
+
940
+ This returns an Array which contains the response data, status code and headers.
941
+
942
+ > <Array(<SeriesListRep>, Integer, Hash)> get_mau_total_usage_with_http_info(opts)
943
+
944
+ ```ruby
945
+ begin
946
+ # Get MAU total usage
947
+ data, status_code, headers = api_instance.get_mau_total_usage_with_http_info(opts)
948
+ p status_code # => 2xx
949
+ p headers # => { ... }
950
+ p data # => <SeriesListRep>
951
+ rescue LaunchDarklyApi::ApiError => e
952
+ puts "Error when calling AccountUsageBetaApi->get_mau_total_usage_with_http_info: #{e}"
953
+ end
954
+ ```
955
+
956
+ ### Parameters
957
+
958
+ | Name | Type | Description | Notes |
959
+ | ---- | ---- | ----------- | ----- |
960
+ | **from** | **String** | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. | [optional] |
961
+ | **to** | **String** | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. | [optional] |
962
+ | **project_key** | **String** | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | [optional] |
963
+ | **environment_key** | **String** | An environment key to filter results by. If specified, exactly one &#x60;projectKey&#x60; must be provided. Can be specified multiple times, one query parameter per environment key. | [optional] |
964
+ | **sdk_name** | **String** | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. | [optional] |
965
+ | **sdk_type** | **String** | An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type. | [optional] |
966
+ | **anonymous** | **String** | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.&lt;br/&gt;Valid values: &#x60;true&#x60;, &#x60;false&#x60;. | [optional] |
967
+ | **group_by** | **String** | If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension.&lt;br/&gt;Valid values: &#x60;projectId&#x60;, &#x60;environmentId&#x60;, &#x60;sdkName&#x60;, &#x60;sdkType&#x60;, &#x60;sdkAppId&#x60;, &#x60;anonymousV2&#x60;. | [optional] |
968
+ | **aggregation_type** | **String** | Specifies the aggregation method. Defaults to &#x60;month_to_date&#x60;.&lt;br/&gt;Valid values: &#x60;month_to_date&#x60;, &#x60;incremental&#x60;, &#x60;rolling_30d&#x60;. | [optional] |
969
+ | **granularity** | **String** | Specifies the data granularity. Defaults to &#x60;daily&#x60;. Valid values depend on &#x60;aggregationType&#x60;: **month_to_date** supports &#x60;daily&#x60; and &#x60;monthly&#x60;; **incremental** and **rolling_30d** support &#x60;daily&#x60; only. | [optional] |
970
+
971
+ ### Return type
972
+
973
+ [**SeriesListRep**](SeriesListRep.md)
974
+
975
+ ### Authorization
976
+
977
+ [ApiKey](../README.md#ApiKey)
978
+
979
+ ### HTTP request headers
980
+
981
+ - **Content-Type**: Not defined
982
+ - **Accept**: application/json
983
+
984
+
803
985
  ## get_mau_usage
804
986
 
805
987
  > <SeriesListRep> get_mau_usage(opts)
@@ -0,0 +1,30 @@
1
+ # LaunchDarklyApi::AgentGraph
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **key** | **String** | A unique key for the agent graph | |
8
+ | **name** | **String** | A human-readable name for the agent graph | |
9
+ | **description** | **String** | A description of the agent graph | [optional] |
10
+ | **root_config_key** | **String** | The AI Config key of the root node | [optional] |
11
+ | **edges** | [**Array&lt;AgentGraphEdge&gt;**](AgentGraphEdge.md) | The edges in the graph | [optional] |
12
+ | **created_at** | **Integer** | | |
13
+ | **updated_at** | **Integer** | | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'launchdarkly_api'
19
+
20
+ instance = LaunchDarklyApi::AgentGraph.new(
21
+ key: null,
22
+ name: null,
23
+ description: null,
24
+ root_config_key: null,
25
+ edges: null,
26
+ created_at: null,
27
+ updated_at: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,24 @@
1
+ # LaunchDarklyApi::AgentGraphEdge
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **key** | **String** | A unique key for this edge within the graph | |
8
+ | **source_config** | **String** | The AI Config key that is the source of this edge | |
9
+ | **target_config** | **String** | The AI Config key that is the target of this edge | |
10
+ | **handoff** | **Object** | The handoff options from the source AI Config to the target AI Config | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'launchdarkly_api'
16
+
17
+ instance = LaunchDarklyApi::AgentGraphEdge.new(
18
+ key: null,
19
+ source_config: null,
20
+ target_config: null,
21
+ handoff: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,24 @@
1
+ # LaunchDarklyApi::AgentGraphEdgePost
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **key** | **String** | A unique key for this edge within the graph | |
8
+ | **source_config** | **String** | The AI Config key that is the source of this edge | |
9
+ | **target_config** | **String** | The AI Config key that is the target of this edge | |
10
+ | **handoff** | **Object** | The handoff options from the source AI Config to the target AI Config | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'launchdarkly_api'
16
+
17
+ instance = LaunchDarklyApi::AgentGraphEdgePost.new(
18
+ key: null,
19
+ source_config: null,
20
+ target_config: null,
21
+ handoff: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,24 @@
1
+ # LaunchDarklyApi::AgentGraphPatch
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | A human-readable name for the agent graph | [optional] |
8
+ | **description** | **String** | A description of the agent graph | [optional] |
9
+ | **root_config_key** | **String** | The AI Config key of the root node. If present, edges must also be present. | [optional] |
10
+ | **edges** | [**Array&lt;AgentGraphEdge&gt;**](AgentGraphEdge.md) | The edges in the graph. If present, rootConfigKey must also be present. Replaces all existing edges. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'launchdarkly_api'
16
+
17
+ instance = LaunchDarklyApi::AgentGraphPatch.new(
18
+ name: null,
19
+ description: null,
20
+ root_config_key: null,
21
+ edges: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,26 @@
1
+ # LaunchDarklyApi::AgentGraphPost
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **key** | **String** | A unique key for the agent graph | |
8
+ | **name** | **String** | A human-readable name for the agent graph | |
9
+ | **description** | **String** | A description of the agent graph | [optional] |
10
+ | **root_config_key** | **String** | The AI Config key of the root node. A missing root implies a newly created graph with metadata only. | [optional] |
11
+ | **edges** | [**Array&lt;AgentGraphEdgePost&gt;**](AgentGraphEdgePost.md) | The edges in the graph. If edges or rootConfigKey is present, both must be present. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'launchdarkly_api'
17
+
18
+ instance = LaunchDarklyApi::AgentGraphPost.new(
19
+ key: null,
20
+ name: null,
21
+ description: null,
22
+ root_config_key: null,
23
+ edges: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # LaunchDarklyApi::AgentGraphs
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_links** | [**PaginatedLinks**](PaginatedLinks.md) | | [optional] |
8
+ | **items** | [**Array&lt;AgentGraph&gt;**](AgentGraph.md) | | |
9
+ | **total_count** | **Integer** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'launchdarkly_api'
15
+
16
+ instance = LaunchDarklyApi::AgentGraphs.new(
17
+ _links: null,
18
+ items: null,
19
+ total_count: null
20
+ )
21
+ ```
22
+
@@ -894,7 +894,8 @@ project_key = 'project_key_example' # String | The project key
894
894
  feature_flag_key = 'feature_flag_key_example' # String | The feature flag key. The key identifies the flag in your code.
895
895
  patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/exampleField'})]}) # PatchWithComment |
896
896
  opts = {
897
- ignore_conflicts: true # Boolean | If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail.
897
+ ignore_conflicts: true, # Boolean | If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail.
898
+ dry_run: true # Boolean | If true, the patch will be validated but not persisted. Returns a preview of the flag after the patch is applied.
898
899
  }
899
900
 
900
901
  begin
@@ -932,6 +933,7 @@ end
932
933
  | **feature_flag_key** | **String** | The feature flag key. The key identifies the flag in your code. | |
933
934
  | **patch_with_comment** | [**PatchWithComment**](PatchWithComment.md) | | |
934
935
  | **ignore_conflicts** | **Boolean** | If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail. | [optional] |
936
+ | **dry_run** | **Boolean** | If true, the patch will be validated but not persisted. Returns a preview of the flag after the patch is applied. | [optional] |
935
937
 
936
938
  ### Return type
937
939
 
@@ -4,8 +4,12 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **rollout_context_kind_key** | **String** | Context kind key to use as the randomization unit for the rollout | [optional] |
7
8
  | **min_sample_size** | **Integer** | The minimum number of samples required to make a decision | [optional] |
8
- | **rollback_on_regression** | **Boolean** | Whether to roll back on regression | |
9
+ | **rollback_on_regression** | **Boolean** | Whether to roll back on regression | [optional] |
10
+ | **metric_keys** | **Array&lt;String&gt;** | List of metric keys | [optional] |
11
+ | **metric_group_keys** | **Array&lt;String&gt;** | List of metric group keys | [optional] |
12
+ | **stages** | [**Array&lt;ReleasePolicyStage&gt;**](ReleasePolicyStage.md) | List of stages | [optional] |
9
13
 
10
14
  ## Example
11
15
 
@@ -13,8 +17,12 @@
13
17
  require 'launchdarkly_api'
14
18
 
15
19
  instance = LaunchDarklyApi::GuardedReleaseConfig.new(
20
+ rollout_context_kind_key: user,
16
21
  min_sample_size: 100,
17
- rollback_on_regression: true
22
+ rollback_on_regression: true,
23
+ metric_keys: [&quot;http-errors&quot;,&quot;latency&quot;],
24
+ metric_group_keys: [&quot;frontend-metrics&quot;,&quot;backend-metrics&quot;],
25
+ stages: null
18
26
  )
19
27
  ```
20
28
 
@@ -12,7 +12,6 @@
12
12
  | **treatments** | [**Array&lt;TreatmentInput&gt;**](TreatmentInput.md) | | |
13
13
  | **flags** | [**Hash&lt;String, FlagInput&gt;**](FlagInput.md) | | |
14
14
  | **randomization_unit** | **String** | The unit of randomization for this iteration. Defaults to user. | [optional] |
15
- | **covariance_id** | **String** | The ID of the covariance CSV | [optional] |
16
15
  | **attributes** | **Array&lt;String&gt;** | The attributes that this iteration&#39;s results can be sliced by | [optional] |
17
16
 
18
17
  ## Example
@@ -29,7 +28,6 @@ instance = LaunchDarklyApi::IterationInput.new(
29
28
  treatments: null,
30
29
  flags: null,
31
30
  randomization_unit: user,
32
- covariance_id: null,
33
31
  attributes: [&quot;country&quot;,&quot;device&quot;,&quot;os&quot;]
34
32
  )
35
33
  ```
data/docs/IterationRep.md CHANGED
@@ -25,7 +25,6 @@
25
25
  | **secondary_metrics** | [**Array&lt;MetricV2Rep&gt;**](MetricV2Rep.md) | Deprecated, use &lt;code&gt;metrics&lt;/code&gt; instead. Details on the secondary metrics for this experiment. | [optional] |
26
26
  | **metrics** | [**Array&lt;DependentMetricOrMetricGroupRep&gt;**](DependentMetricOrMetricGroupRep.md) | Details on the metrics for this experiment | [optional] |
27
27
  | **layer_snapshot** | [**LayerSnapshotRep**](LayerSnapshotRep.md) | | [optional] |
28
- | **covariance_info** | [**CovarianceInfoRep**](CovarianceInfoRep.md) | | [optional] |
29
28
 
30
29
  ## Example
31
30
 
@@ -53,8 +52,7 @@ instance = LaunchDarklyApi::IterationRep.new(
53
52
  treatments: null,
54
53
  secondary_metrics: null,
55
54
  metrics: null,
56
- layer_snapshot: null,
57
- covariance_info: null
55
+ layer_snapshot: null
58
56
  )
59
57
  ```
60
58
 
@@ -7,7 +7,7 @@
7
7
  | **scope** | [**ReleasePolicyScope**](ReleasePolicyScope.md) | | [optional] |
8
8
  | **release_method** | [**ReleaseMethod**](ReleaseMethod.md) | | |
9
9
  | **guarded_release_config** | [**GuardedReleaseConfig**](GuardedReleaseConfig.md) | | [optional] |
10
- | **progressive_release_config** | **Object** | Configuration for progressive releases | [optional] |
10
+ | **progressive_release_config** | [**ProgressiveReleaseConfig**](ProgressiveReleaseConfig.md) | | [optional] |
11
11
  | **name** | **String** | The name of the release policy | |
12
12
  | **key** | **String** | The human-readable key of the release policy | |
13
13
 
@@ -20,7 +20,7 @@ instance = LaunchDarklyApi::PostReleasePolicyRequest.new(
20
20
  scope: null,
21
21
  release_method: null,
22
22
  guarded_release_config: null,
23
- progressive_release_config: {&quot;rolloutContextKindKey&quot;:&quot;user&quot;,&quot;stages&quot;:[{&quot;allocation&quot;:25000,&quot;durationMillis&quot;:60000},{&quot;allocation&quot;:25000,&quot;durationMillis&quot;:60000}]},
23
+ progressive_release_config: null,
24
24
  name: Production Release,
25
25
  key: production-release
26
26
  )
@@ -0,0 +1,20 @@
1
+ # LaunchDarklyApi::ProgressiveReleaseConfig
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **rollout_context_kind_key** | **String** | Context kind key to use as the randomization unit for the rollout | [optional] |
8
+ | **stages** | [**Array&lt;ReleasePolicyStage&gt;**](ReleasePolicyStage.md) | List of stages | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'launchdarkly_api'
14
+
15
+ instance = LaunchDarklyApi::ProgressiveReleaseConfig.new(
16
+ rollout_context_kind_key: user,
17
+ stages: null
18
+ )
19
+ ```
20
+
@@ -7,7 +7,7 @@
7
7
  | **scope** | [**ReleasePolicyScope**](ReleasePolicyScope.md) | | [optional] |
8
8
  | **release_method** | [**ReleaseMethod**](ReleaseMethod.md) | | |
9
9
  | **guarded_release_config** | [**GuardedReleaseConfig**](GuardedReleaseConfig.md) | | [optional] |
10
- | **progressive_release_config** | **Object** | Configuration for progressive releases | [optional] |
10
+ | **progressive_release_config** | [**ProgressiveReleaseConfig**](ProgressiveReleaseConfig.md) | | [optional] |
11
11
  | **name** | **String** | The name of the release policy | |
12
12
 
13
13
  ## Example
@@ -19,7 +19,7 @@ instance = LaunchDarklyApi::PutReleasePolicyRequest.new(
19
19
  scope: null,
20
20
  release_method: null,
21
21
  guarded_release_config: null,
22
- progressive_release_config: {&quot;rolloutContextKindKey&quot;:&quot;user&quot;,&quot;stages&quot;:[{&quot;allocation&quot;:25000,&quot;durationMillis&quot;:60000},{&quot;allocation&quot;:25000,&quot;durationMillis&quot;:60000}]},
22
+ progressive_release_config: null,
23
23
  name: Production Release
24
24
  )
25
25
  ```
@@ -10,7 +10,7 @@
10
10
  | **rank** | **Integer** | The rank/priority of the release policy | |
11
11
  | **release_method** | [**ReleaseMethod**](ReleaseMethod.md) | | |
12
12
  | **guarded_release_config** | [**GuardedReleaseConfig**](GuardedReleaseConfig.md) | | [optional] |
13
- | **progressive_release_config** | **Object** | Configuration for progressive releases | [optional] |
13
+ | **progressive_release_config** | [**ProgressiveReleaseConfig**](ProgressiveReleaseConfig.md) | | [optional] |
14
14
  | **name** | **String** | The name of the release policy | |
15
15
  | **key** | **String** | The human-readable key of the release policy | |
16
16
 
@@ -26,7 +26,7 @@ instance = LaunchDarklyApi::ReleasePolicy.new(
26
26
  rank: 1,
27
27
  release_method: null,
28
28
  guarded_release_config: null,
29
- progressive_release_config: {&quot;rolloutContextKindKey&quot;:&quot;user&quot;,&quot;stages&quot;:[{&quot;allocation&quot;:25000,&quot;durationMillis&quot;:60000},{&quot;allocation&quot;:25000,&quot;durationMillis&quot;:60000}]},
29
+ progressive_release_config: null,
30
30
  name: Production Release,
31
31
  key: production-release
32
32
  )
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **environment_keys** | **Array&lt;String&gt;** | List of environment keys this policy applies to | [optional] |
8
+ | **flag_tag_keys** | **Array&lt;String&gt;** | List of flag tag keys this policy applies to | [optional] |
8
9
 
9
10
  ## Example
10
11
 
@@ -12,7 +13,8 @@
12
13
  require 'launchdarkly_api'
13
14
 
14
15
  instance = LaunchDarklyApi::ReleasePolicyScope.new(
15
- environment_keys: [&quot;production&quot;,&quot;staging&quot;]
16
+ environment_keys: [&quot;production&quot;,&quot;staging&quot;],
17
+ flag_tag_keys: [&quot;frontend&quot;,&quot;backend&quot;]
16
18
  )
17
19
  ```
18
20
 
@@ -0,0 +1,20 @@
1
+ # LaunchDarklyApi::ReleasePolicyStage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **allocation** | **Integer** | | |
8
+ | **duration_millis** | **Integer** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'launchdarkly_api'
14
+
15
+ instance = LaunchDarklyApi::ReleasePolicyStage.new(
16
+ allocation: 25000,
17
+ duration_millis: 60000
18
+ )
19
+ ```
20
+
data/docs/Rule.md CHANGED
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **_id** | **String** | The flag rule ID | [optional] |
8
+ | **disabled** | **Boolean** | Whether the rule is disabled | [optional] |
8
9
  | **variation** | **Integer** | The index of the variation, from the array of variations for this flag | [optional] |
9
10
  | **rollout** | [**Rollout**](Rollout.md) | | [optional] |
10
11
  | **clauses** | [**Array&lt;Clause&gt;**](Clause.md) | An array of clauses used for individual targeting based on attributes | |
@@ -19,6 +20,7 @@ require 'launchdarkly_api'
19
20
 
20
21
  instance = LaunchDarklyApi::Rule.new(
21
22
  _id: null,
23
+ disabled: null,
22
24
  variation: null,
23
25
  rollout: null,
24
26
  clauses: null,
data/docs/SegmentsApi.md CHANGED
@@ -1101,7 +1101,7 @@ end
1101
1101
 
1102
1102
  ## patch_segment
1103
1103
 
1104
- > <UserSegment> patch_segment(project_key, environment_key, segment_key, patch_with_comment)
1104
+ > <UserSegment> patch_segment(project_key, environment_key, segment_key, patch_with_comment, opts)
1105
1105
 
1106
1106
  Patch segment
1107
1107
 
@@ -1125,10 +1125,13 @@ project_key = 'project_key_example' # String | The project key
1125
1125
  environment_key = 'environment_key_example' # String | The environment key
1126
1126
  segment_key = 'segment_key_example' # String | The segment key
1127
1127
  patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/exampleField'})]}) # PatchWithComment |
1128
+ opts = {
1129
+ dry_run: true # Boolean | If true, the patch will be validated but not persisted. Returns a preview of the segment after the patch is applied.
1130
+ }
1128
1131
 
1129
1132
  begin
1130
1133
  # Patch segment
1131
- result = api_instance.patch_segment(project_key, environment_key, segment_key, patch_with_comment)
1134
+ result = api_instance.patch_segment(project_key, environment_key, segment_key, patch_with_comment, opts)
1132
1135
  p result
1133
1136
  rescue LaunchDarklyApi::ApiError => e
1134
1137
  puts "Error when calling SegmentsApi->patch_segment: #{e}"
@@ -1139,12 +1142,12 @@ end
1139
1142
 
1140
1143
  This returns an Array which contains the response data, status code and headers.
1141
1144
 
1142
- > <Array(<UserSegment>, Integer, Hash)> patch_segment_with_http_info(project_key, environment_key, segment_key, patch_with_comment)
1145
+ > <Array(<UserSegment>, Integer, Hash)> patch_segment_with_http_info(project_key, environment_key, segment_key, patch_with_comment, opts)
1143
1146
 
1144
1147
  ```ruby
1145
1148
  begin
1146
1149
  # Patch segment
1147
- data, status_code, headers = api_instance.patch_segment_with_http_info(project_key, environment_key, segment_key, patch_with_comment)
1150
+ data, status_code, headers = api_instance.patch_segment_with_http_info(project_key, environment_key, segment_key, patch_with_comment, opts)
1148
1151
  p status_code # => 2xx
1149
1152
  p headers # => { ... }
1150
1153
  p data # => <UserSegment>
@@ -1161,6 +1164,7 @@ end
1161
1164
  | **environment_key** | **String** | The environment key | |
1162
1165
  | **segment_key** | **String** | The segment key | |
1163
1166
  | **patch_with_comment** | [**PatchWithComment**](PatchWithComment.md) | | |
1167
+ | **dry_run** | **Boolean** | If true, the patch will be validated but not persisted. Returns a preview of the segment after the patch is applied. | [optional] |
1164
1168
 
1165
1169
  ### Return type
1166
1170
 
data/docs/TagsApi.md CHANGED
@@ -30,7 +30,7 @@ end
30
30
 
31
31
  api_instance = LaunchDarklyApi::TagsApi.new
32
32
  opts = {
33
- kind: ['inner_example'], # Array<String> | Fetch tags associated with the specified resource type. Options are `flag`, `project`, `environment`, `segment`, `metric`, `aiconfig`, and `view`. Returns all types by default.
33
+ kind: ['inner_example'], # Array<String> | Fetch tags associated with the specified resource type. Options are `flag`, `project`, `environment`, `segment`, `metric`, `metric-data-source`, `aiconfig`, and `view`. Returns all types by default.
34
34
  pre: 'pre_example', # String | Return tags with the specified prefix
35
35
  archived: true, # Boolean | Whether or not to return archived flags
36
36
  limit: 56, # Integer | The number of tags to return. Maximum is 1000.
@@ -69,7 +69,7 @@ end
69
69
 
70
70
  | Name | Type | Description | Notes |
71
71
  | ---- | ---- | ----------- | ----- |
72
- | **kind** | [**Array&lt;String&gt;**](String.md) | Fetch tags associated with the specified resource type. Options are &#x60;flag&#x60;, &#x60;project&#x60;, &#x60;environment&#x60;, &#x60;segment&#x60;, &#x60;metric&#x60;, &#x60;aiconfig&#x60;, and &#x60;view&#x60;. Returns all types by default. | [optional] |
72
+ | **kind** | [**Array&lt;String&gt;**](String.md) | Fetch tags associated with the specified resource type. Options are &#x60;flag&#x60;, &#x60;project&#x60;, &#x60;environment&#x60;, &#x60;segment&#x60;, &#x60;metric&#x60;, &#x60;metric-data-source&#x60;, &#x60;aiconfig&#x60;, and &#x60;view&#x60;. Returns all types by default. | [optional] |
73
73
  | **pre** | **String** | Return tags with the specified prefix | [optional] |
74
74
  | **archived** | **Boolean** | Whether or not to return archived flags | [optional] |
75
75
  | **limit** | **Integer** | The number of tags to return. Maximum is 1000. | [optional] |