launchdarkly_api 21.0.0 → 22.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.
- checksums.yaml +4 -4
- data/README.md +15 -6
- data/docs/AIConfig.md +3 -1
- data/docs/AIConfigDependency.md +20 -0
- data/docs/AIConfigPatch.md +2 -2
- data/docs/AIConfigPost.md +2 -2
- data/docs/AITool.md +3 -1
- data/docs/AIToolPatch.md +6 -4
- data/docs/AIToolPost.md +6 -4
- data/docs/AccountUsageBetaApi.md +164 -0
- data/docs/AgentGraph.md +4 -0
- data/docs/AgentGraphMaintainer.md +49 -0
- data/docs/AgentGraphPatch.md +4 -0
- data/docs/AgentGraphPost.md +4 -0
- data/docs/AiConfigsMetricListingRep.md +4 -0
- data/docs/AuditLogApi.md +80 -0
- data/docs/CallerIdentityRep.md +3 -1
- data/docs/CountBucket.md +20 -0
- data/docs/CountBucketsResult.md +22 -0
- data/docs/EventFilter.md +1 -1
- data/docs/ExpandedFlag.md +4 -2
- data/docs/ExpandedFlagMaintainer.md +24 -0
- data/docs/ExpandedLinkedResourcesItems.md +1 -5
- data/docs/ExperimentsApi.md +1 -1
- data/docs/MetricListingRep.md +2 -0
- data/docs/MetricRep.md +2 -0
- data/docs/ResourceSummary.md +0 -4
- data/docs/VariationTool.md +3 -1
- data/docs/ViewLinkRequest.md +3 -1
- data/docs/ViewLinkRequestFilter.md +22 -0
- data/docs/ViewLinkRequestKeys.md +4 -2
- data/docs/ViewLinkRequestSegmentIdentifiers.md +4 -0
- data/docs/ViewLinkedResource.md +1 -1
- data/docs/ViewsBetaApi.md +17 -11
- data/docs/ViewsMemberSummary.md +28 -0
- data/docs/ViewsMemberTeamSummaryRep.md +24 -0
- data/lib/launchdarkly_api/api/account_usage_beta_api.rb +144 -0
- data/lib/launchdarkly_api/api/audit_log_api.rb +81 -0
- data/lib/launchdarkly_api/api/experiments_api.rb +2 -2
- data/lib/launchdarkly_api/api/views_beta_api.rb +31 -18
- data/lib/launchdarkly_api/models/agent_graph.rb +19 -1
- data/lib/launchdarkly_api/models/agent_graph_maintainer.rb +104 -0
- data/lib/launchdarkly_api/models/agent_graph_patch.rb +21 -1
- data/lib/launchdarkly_api/models/agent_graph_post.rb +21 -1
- data/lib/launchdarkly_api/models/ai_config.rb +16 -4
- data/lib/launchdarkly_api/models/ai_config_dependency.rb +217 -0
- data/lib/launchdarkly_api/models/ai_configs_metric_listing_rep.rb +20 -1
- data/lib/launchdarkly_api/models/ai_tool.rb +12 -1
- data/lib/launchdarkly_api/models/ai_tool_patch.rb +15 -4
- data/lib/launchdarkly_api/models/ai_tool_post.rb +15 -4
- data/lib/launchdarkly_api/models/caller_identity_rep.rb +15 -4
- data/lib/launchdarkly_api/models/{expanded_linked_resources_metrics.rb → count_bucket.rb} +34 -36
- data/lib/launchdarkly_api/models/{expanded_linked_resources_ai_configs.rb → count_buckets_result.rb} +49 -23
- data/lib/launchdarkly_api/models/event_filter.rb +1 -1
- data/lib/launchdarkly_api/models/expanded_flag.rb +16 -7
- data/lib/launchdarkly_api/models/expanded_flag_maintainer.rb +234 -0
- data/lib/launchdarkly_api/models/expanded_linked_resources_items.rb +4 -22
- data/lib/launchdarkly_api/models/failed_resource_link.rb +2 -2
- data/lib/launchdarkly_api/models/metric_group_post.rb +2 -2
- data/lib/launchdarkly_api/models/metric_listing_rep.rb +10 -1
- data/lib/launchdarkly_api/models/metric_rep.rb +10 -1
- data/lib/launchdarkly_api/models/resource_summary.rb +1 -19
- data/lib/launchdarkly_api/models/variation_tool.rb +16 -4
- data/lib/launchdarkly_api/models/view_link_request.rb +1 -0
- data/lib/launchdarkly_api/models/view_link_request_filter.rb +187 -0
- data/lib/launchdarkly_api/models/view_link_request_keys.rb +12 -2
- data/lib/launchdarkly_api/models/view_link_request_segment_identifiers.rb +21 -1
- data/lib/launchdarkly_api/models/view_linked_resource.rb +3 -3
- data/lib/launchdarkly_api/models/views_member_summary.rb +268 -0
- data/lib/launchdarkly_api/models/views_member_team_summary_rep.rb +232 -0
- data/lib/launchdarkly_api/version.rb +1 -1
- data/lib/launchdarkly_api.rb +8 -2
- data/spec/api/account_usage_beta_api_spec.rb +32 -0
- data/spec/api/audit_log_api_spec.rb +15 -0
- data/spec/api/experiments_api_spec.rb +1 -1
- data/spec/api/views_beta_api_spec.rb +9 -6
- data/spec/models/agent_graph_maintainer_spec.rb +32 -0
- data/spec/models/agent_graph_patch_spec.rb +12 -0
- data/spec/models/agent_graph_post_spec.rb +12 -0
- data/spec/models/agent_graph_spec.rb +12 -0
- data/spec/models/ai_config_dependency_spec.rb +46 -0
- data/spec/models/ai_config_spec.rb +6 -0
- data/spec/models/ai_configs_metric_listing_rep_spec.rb +12 -0
- data/spec/models/ai_tool_patch_spec.rb +6 -0
- data/spec/models/ai_tool_post_spec.rb +6 -0
- data/spec/models/ai_tool_spec.rb +6 -0
- data/spec/models/caller_identity_rep_spec.rb +6 -0
- data/spec/models/{expanded_linked_resources_metrics_spec.rb → count_bucket_spec.rb} +8 -8
- data/spec/models/{expanded_linked_resources_ai_configs_spec.rb → count_buckets_result_spec.rb} +13 -7
- data/spec/models/expanded_flag_maintainer_spec.rb +58 -0
- data/spec/models/expanded_flag_spec.rb +7 -1
- data/spec/models/expanded_linked_resources_items_spec.rb +0 -12
- data/spec/models/failed_resource_link_spec.rb +1 -1
- data/spec/models/metric_group_post_spec.rb +1 -1
- data/spec/models/metric_listing_rep_spec.rb +6 -0
- data/spec/models/metric_rep_spec.rb +6 -0
- data/spec/models/resource_summary_spec.rb +0 -12
- data/spec/models/variation_tool_spec.rb +6 -0
- data/spec/models/view_link_request_filter_spec.rb +48 -0
- data/spec/models/view_link_request_keys_spec.rb +6 -0
- data/spec/models/view_link_request_segment_identifiers_spec.rb +12 -0
- data/spec/models/view_linked_resource_spec.rb +1 -1
- data/spec/models/views_member_summary_spec.rb +66 -0
- data/spec/models/views_member_team_summary_rep_spec.rb +54 -0
- metadata +626 -602
- data/docs/ExpandedLinkedResourcesAIConfigs.md +0 -20
- data/docs/ExpandedLinkedResourcesMetrics.md +0 -20
data/docs/AuditLogApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://app.launchdarkly.com*
|
|
|
7
7
|
| [**get_audit_log_entries**](AuditLogApi.md#get_audit_log_entries) | **GET** /api/v2/auditlog | List audit log entries |
|
|
8
8
|
| [**get_audit_log_entry**](AuditLogApi.md#get_audit_log_entry) | **GET** /api/v2/auditlog/{id} | Get audit log entry |
|
|
9
9
|
| [**post_audit_log_entries**](AuditLogApi.md#post_audit_log_entries) | **POST** /api/v2/auditlog | Search audit log entries |
|
|
10
|
+
| [**post_audit_log_entry_counts**](AuditLogApi.md#post_audit_log_entry_counts) | **POST** /api/v2/auditlog/counts | Get audit log entry counts |
|
|
10
11
|
|
|
11
12
|
|
|
12
13
|
## get_audit_log_entries
|
|
@@ -241,3 +242,82 @@ end
|
|
|
241
242
|
- **Content-Type**: application/json
|
|
242
243
|
- **Accept**: application/json
|
|
243
244
|
|
|
245
|
+
|
|
246
|
+
## post_audit_log_entry_counts
|
|
247
|
+
|
|
248
|
+
> <CountBucketsResult> post_audit_log_entry_counts(after, statement_post, opts)
|
|
249
|
+
|
|
250
|
+
Get audit log entry counts
|
|
251
|
+
|
|
252
|
+
Returns aggregate counts of audit log entries per time bucket. Used for dashboard overlays that show flag targeting changes.
|
|
253
|
+
|
|
254
|
+
### Examples
|
|
255
|
+
|
|
256
|
+
```ruby
|
|
257
|
+
require 'time'
|
|
258
|
+
require 'launchdarkly_api'
|
|
259
|
+
# setup authorization
|
|
260
|
+
LaunchDarklyApi.configure do |config|
|
|
261
|
+
# Configure API key authorization: ApiKey
|
|
262
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
263
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
264
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
api_instance = LaunchDarklyApi::AuditLogApi.new
|
|
268
|
+
after = 789 # Integer | A timestamp filter, expressed as a Unix epoch time in milliseconds. Required.
|
|
269
|
+
statement_post = [LaunchDarklyApi::StatementPost.new({effect: 'allow'})] # Array<StatementPost> |
|
|
270
|
+
opts = {
|
|
271
|
+
before: 789, # Integer | A timestamp filter, expressed as a Unix epoch time in milliseconds. Defaults to now.
|
|
272
|
+
buckets: 789 # Integer | Number of time buckets to divide the range into. Default 50, max 500.
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
begin
|
|
276
|
+
# Get audit log entry counts
|
|
277
|
+
result = api_instance.post_audit_log_entry_counts(after, statement_post, opts)
|
|
278
|
+
p result
|
|
279
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
280
|
+
puts "Error when calling AuditLogApi->post_audit_log_entry_counts: #{e}"
|
|
281
|
+
end
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
#### Using the post_audit_log_entry_counts_with_http_info variant
|
|
285
|
+
|
|
286
|
+
This returns an Array which contains the response data, status code and headers.
|
|
287
|
+
|
|
288
|
+
> <Array(<CountBucketsResult>, Integer, Hash)> post_audit_log_entry_counts_with_http_info(after, statement_post, opts)
|
|
289
|
+
|
|
290
|
+
```ruby
|
|
291
|
+
begin
|
|
292
|
+
# Get audit log entry counts
|
|
293
|
+
data, status_code, headers = api_instance.post_audit_log_entry_counts_with_http_info(after, statement_post, opts)
|
|
294
|
+
p status_code # => 2xx
|
|
295
|
+
p headers # => { ... }
|
|
296
|
+
p data # => <CountBucketsResult>
|
|
297
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
298
|
+
puts "Error when calling AuditLogApi->post_audit_log_entry_counts_with_http_info: #{e}"
|
|
299
|
+
end
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
### Parameters
|
|
303
|
+
|
|
304
|
+
| Name | Type | Description | Notes |
|
|
305
|
+
| ---- | ---- | ----------- | ----- |
|
|
306
|
+
| **after** | **Integer** | A timestamp filter, expressed as a Unix epoch time in milliseconds. Required. | |
|
|
307
|
+
| **statement_post** | [**Array<StatementPost>**](StatementPost.md) | | |
|
|
308
|
+
| **before** | **Integer** | A timestamp filter, expressed as a Unix epoch time in milliseconds. Defaults to now. | [optional] |
|
|
309
|
+
| **buckets** | **Integer** | Number of time buckets to divide the range into. Default 50, max 500. | [optional] |
|
|
310
|
+
|
|
311
|
+
### Return type
|
|
312
|
+
|
|
313
|
+
[**CountBucketsResult**](CountBucketsResult.md)
|
|
314
|
+
|
|
315
|
+
### Authorization
|
|
316
|
+
|
|
317
|
+
[ApiKey](../README.md#ApiKey)
|
|
318
|
+
|
|
319
|
+
### HTTP request headers
|
|
320
|
+
|
|
321
|
+
- **Content-Type**: application/json
|
|
322
|
+
- **Accept**: application/json
|
|
323
|
+
|
data/docs/CallerIdentityRep.md
CHANGED
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
| **token_id** | **String** | | [optional] |
|
|
17
17
|
| **member_id** | **String** | | [optional] |
|
|
18
18
|
| **service_token** | **Boolean** | | [optional] |
|
|
19
|
+
| **scopes** | **Array<String>** | | [optional] |
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -34,7 +35,8 @@ instance = LaunchDarklyApi::CallerIdentityRep.new(
|
|
|
34
35
|
token_name: null,
|
|
35
36
|
token_id: null,
|
|
36
37
|
member_id: null,
|
|
37
|
-
service_token: null
|
|
38
|
+
service_token: null,
|
|
39
|
+
scopes: null
|
|
38
40
|
)
|
|
39
41
|
```
|
|
40
42
|
|
data/docs/CountBucket.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# LaunchDarklyApi::CountBucket
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **timestamp** | **Integer** | | |
|
|
8
|
+
| **count** | **Integer** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'launchdarkly_api'
|
|
14
|
+
|
|
15
|
+
instance = LaunchDarklyApi::CountBucket.new(
|
|
16
|
+
timestamp: null,
|
|
17
|
+
count: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# LaunchDarklyApi::CountBucketsResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **buckets** | [**Array<CountBucket>**](CountBucket.md) | | |
|
|
8
|
+
| **total_count** | **Integer** | | |
|
|
9
|
+
| **bucket_interval_ms** | **Integer** | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'launchdarkly_api'
|
|
15
|
+
|
|
16
|
+
instance = LaunchDarklyApi::CountBucketsResult.new(
|
|
17
|
+
buckets: null,
|
|
18
|
+
total_count: null,
|
|
19
|
+
bucket_interval_ms: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/EventFilter.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **type** | **String** | Filter type. One of [contextAttribute, eventProperty, group] | |
|
|
8
8
|
| **attribute** | **String** | If not a group node, the context attribute name or event property name to filter on | [optional] |
|
|
9
9
|
| **op** | **String** | | |
|
|
10
|
-
| **values** | **Array<Object>** | The context attribute / event property values or group member nodes | |
|
|
10
|
+
| **values** | **Array<Object>** | The context attribute / event property values or group member nodes. Numeric values must not exceed 14 decimal places. | |
|
|
11
11
|
| **context_kind** | **String** | For context attribute filters, the context kind. | [optional] |
|
|
12
12
|
| **negate** | **Boolean** | If set, then take the inverse of the operator. 'in' becomes 'not in'. | |
|
|
13
13
|
|
data/docs/ExpandedFlag.md
CHANGED
|
@@ -8,11 +8,12 @@
|
|
|
8
8
|
| **name** | **String** | A human-friendly name for the flag | |
|
|
9
9
|
| **description** | **String** | Description of the flag | [optional] |
|
|
10
10
|
| **creation_date** | **Integer** | Creation date in milliseconds | [optional] |
|
|
11
|
-
| **
|
|
11
|
+
| **_version** | **Integer** | Version of the flag | [optional] |
|
|
12
12
|
| **archived** | **Boolean** | Whether the flag is archived | [optional] |
|
|
13
13
|
| **tags** | **Array<String>** | Tags for the flag | [optional] |
|
|
14
14
|
| **temporary** | **Boolean** | Whether the flag is temporary | [optional] |
|
|
15
15
|
| **include_in_snippet** | **Boolean** | Whether to include in snippet | [optional] |
|
|
16
|
+
| **maintainer** | [**ExpandedFlagMaintainer**](ExpandedFlagMaintainer.md) | | [optional] |
|
|
16
17
|
| **_links** | [**ParentAndSelfLinks**](ParentAndSelfLinks.md) | | [optional] |
|
|
17
18
|
|
|
18
19
|
## Example
|
|
@@ -25,11 +26,12 @@ instance = LaunchDarklyApi::ExpandedFlag.new(
|
|
|
25
26
|
name: null,
|
|
26
27
|
description: null,
|
|
27
28
|
creation_date: null,
|
|
28
|
-
|
|
29
|
+
_version: null,
|
|
29
30
|
archived: null,
|
|
30
31
|
tags: null,
|
|
31
32
|
temporary: null,
|
|
32
33
|
include_in_snippet: null,
|
|
34
|
+
maintainer: null,
|
|
33
35
|
_links: null
|
|
34
36
|
)
|
|
35
37
|
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LaunchDarklyApi::ExpandedFlagMaintainer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | The ID of the maintainer member, or the key of the maintainer team | |
|
|
8
|
+
| **kind** | **String** | The type of the maintainer | |
|
|
9
|
+
| **_member** | [**ViewsMemberSummary**](ViewsMemberSummary.md) | | [optional] |
|
|
10
|
+
| **_team** | [**ViewsMemberTeamSummaryRep**](ViewsMemberTeamSummaryRep.md) | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'launchdarkly_api'
|
|
16
|
+
|
|
17
|
+
instance = LaunchDarklyApi::ExpandedFlagMaintainer.new(
|
|
18
|
+
key: null,
|
|
19
|
+
kind: null,
|
|
20
|
+
_member: null,
|
|
21
|
+
_team: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -6,8 +6,6 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **flags** | [**ExpandedLinkedResourcesFlags**](ExpandedLinkedResourcesFlags.md) | | |
|
|
8
8
|
| **segments** | [**ExpandedLinkedResourcesSegments**](ExpandedLinkedResourcesSegments.md) | | [optional] |
|
|
9
|
-
| **ai_configs** | [**ExpandedLinkedResourcesAIConfigs**](ExpandedLinkedResourcesAIConfigs.md) | | [optional] |
|
|
10
|
-
| **metrics** | [**ExpandedLinkedResourcesMetrics**](ExpandedLinkedResourcesMetrics.md) | | [optional] |
|
|
11
9
|
|
|
12
10
|
## Example
|
|
13
11
|
|
|
@@ -16,9 +14,7 @@ require 'launchdarkly_api'
|
|
|
16
14
|
|
|
17
15
|
instance = LaunchDarklyApi::ExpandedLinkedResourcesItems.new(
|
|
18
16
|
flags: null,
|
|
19
|
-
segments: null
|
|
20
|
-
ai_configs: null,
|
|
21
|
-
metrics: null
|
|
17
|
+
segments: null
|
|
22
18
|
)
|
|
23
19
|
```
|
|
24
20
|
|
data/docs/ExperimentsApi.md
CHANGED
|
@@ -94,7 +94,7 @@ end
|
|
|
94
94
|
|
|
95
95
|
Create iteration
|
|
96
96
|
|
|
97
|
-
Create an experiment iteration. Experiment iterations let you record experiments in individual blocks of time. Initially, iterations are created with a status of `not_started` and appear in the `draftIteration` field of an experiment. To start or stop an iteration, [update the experiment](https://launchdarkly.com/docs/api/experiments/patch-experiment) with the `startIteration` or `stopIteration` instruction. To learn more, read [Start experiment iterations](https://launchdarkly.com/docs/home/experimentation/
|
|
97
|
+
Create an experiment iteration. Experiment iterations let you record experiments in individual blocks of time. Initially, iterations are created with a status of `not_started` and appear in the `draftIteration` field of an experiment. To start or stop an iteration, [update the experiment](https://launchdarkly.com/docs/api/experiments/patch-experiment) with the `startIteration` or `stopIteration` instruction. To learn more, read [Start experiment iterations](https://launchdarkly.com/docs/home/experimentation/create#start-an-experiment-iteration).
|
|
98
98
|
|
|
99
99
|
### Examples
|
|
100
100
|
|
data/docs/MetricListingRep.md
CHANGED
|
@@ -36,6 +36,7 @@
|
|
|
36
36
|
| **percentile_value** | **Integer** | The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>. | [optional] |
|
|
37
37
|
| **event_default** | [**MetricEventDefaultRep**](MetricEventDefaultRep.md) | | [optional] |
|
|
38
38
|
| **data_source** | [**MetricDataSourceRefRep**](MetricDataSourceRefRep.md) | | |
|
|
39
|
+
| **last_seen** | **Integer** | | [optional] |
|
|
39
40
|
| **archived** | **Boolean** | Whether the metric version is archived | [optional] |
|
|
40
41
|
| **archived_at** | **Integer** | | [optional] |
|
|
41
42
|
| **selector** | **String** | For click metrics, the CSS selectors | [optional] |
|
|
@@ -79,6 +80,7 @@ instance = LaunchDarklyApi::MetricListingRep.new(
|
|
|
79
80
|
percentile_value: 95,
|
|
80
81
|
event_default: null,
|
|
81
82
|
data_source: null,
|
|
83
|
+
last_seen: null,
|
|
82
84
|
archived: null,
|
|
83
85
|
archived_at: null,
|
|
84
86
|
selector: null,
|
data/docs/MetricRep.md
CHANGED
|
@@ -36,6 +36,7 @@
|
|
|
36
36
|
| **percentile_value** | **Integer** | The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>. | [optional] |
|
|
37
37
|
| **event_default** | [**MetricEventDefaultRep**](MetricEventDefaultRep.md) | | [optional] |
|
|
38
38
|
| **data_source** | [**MetricDataSourceRefRep**](MetricDataSourceRefRep.md) | | |
|
|
39
|
+
| **last_seen** | **Integer** | | [optional] |
|
|
39
40
|
| **archived** | **Boolean** | Whether the metric version is archived | [optional] |
|
|
40
41
|
| **archived_at** | **Integer** | | [optional] |
|
|
41
42
|
| **selector** | **String** | For click metrics, the CSS selectors | [optional] |
|
|
@@ -85,6 +86,7 @@ instance = LaunchDarklyApi::MetricRep.new(
|
|
|
85
86
|
percentile_value: 95,
|
|
86
87
|
event_default: null,
|
|
87
88
|
data_source: null,
|
|
89
|
+
last_seen: null,
|
|
88
90
|
archived: null,
|
|
89
91
|
archived_at: null,
|
|
90
92
|
selector: null,
|
data/docs/ResourceSummary.md
CHANGED
|
@@ -6,8 +6,6 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **flag_count** | **Integer** | | |
|
|
8
8
|
| **segment_count** | **Integer** | | [optional] |
|
|
9
|
-
| **metric_count** | **Integer** | | [optional] |
|
|
10
|
-
| **ai_config_count** | **Integer** | | [optional] |
|
|
11
9
|
| **total_count** | **Integer** | | |
|
|
12
10
|
|
|
13
11
|
## Example
|
|
@@ -18,8 +16,6 @@ require 'launchdarkly_api'
|
|
|
18
16
|
instance = LaunchDarklyApi::ResourceSummary.new(
|
|
19
17
|
flag_count: null,
|
|
20
18
|
segment_count: null,
|
|
21
|
-
metric_count: null,
|
|
22
|
-
ai_config_count: null,
|
|
23
19
|
total_count: null
|
|
24
20
|
)
|
|
25
21
|
```
|
data/docs/VariationTool.md
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **key** | **String** | The key of the tool to use. | |
|
|
8
8
|
| **version** | **Integer** | The version of the tool. | |
|
|
9
|
+
| **custom_parameters** | **Hash<String, Object>** | Custom metadata and configuration for application-level use | [optional] |
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -14,7 +15,8 @@ require 'launchdarkly_api'
|
|
|
14
15
|
|
|
15
16
|
instance = LaunchDarklyApi::VariationTool.new(
|
|
16
17
|
key: null,
|
|
17
|
-
version: null
|
|
18
|
+
version: null,
|
|
19
|
+
custom_parameters: null
|
|
18
20
|
)
|
|
19
21
|
```
|
|
20
22
|
|
data/docs/ViewLinkRequest.md
CHANGED
|
@@ -14,6 +14,7 @@ require 'launchdarkly_api'
|
|
|
14
14
|
LaunchDarklyApi::ViewLinkRequest.openapi_one_of
|
|
15
15
|
# =>
|
|
16
16
|
# [
|
|
17
|
+
# :'ViewLinkRequestFilter',
|
|
17
18
|
# :'ViewLinkRequestKeys',
|
|
18
19
|
# :'ViewLinkRequestSegmentIdentifiers'
|
|
19
20
|
# ]
|
|
@@ -29,7 +30,7 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
|
|
|
29
30
|
require 'launchdarkly_api'
|
|
30
31
|
|
|
31
32
|
LaunchDarklyApi::ViewLinkRequest.build(data)
|
|
32
|
-
# => #<
|
|
33
|
+
# => #<ViewLinkRequestFilter:0x00007fdd4aab02a0>
|
|
33
34
|
|
|
34
35
|
LaunchDarklyApi::ViewLinkRequest.build(data_that_doesnt_match)
|
|
35
36
|
# => nil
|
|
@@ -43,6 +44,7 @@ LaunchDarklyApi::ViewLinkRequest.build(data_that_doesnt_match)
|
|
|
43
44
|
|
|
44
45
|
#### Return type
|
|
45
46
|
|
|
47
|
+
- `ViewLinkRequestFilter`
|
|
46
48
|
- `ViewLinkRequestKeys`
|
|
47
49
|
- `ViewLinkRequestSegmentIdentifiers`
|
|
48
50
|
- `nil` (if no type matches)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# LaunchDarklyApi::ViewLinkRequestFilter
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **filter** | **String** | Filter string to match resources for linking. Uses the same syntax as list endpoints: flags use comma-separated field:value filters, segments use queryfilter syntax. Supported filters by resource type: - flags: query, tags, maintainerId, maintainerTeamKey, type, status, state, staleState, sdkAvailability, targeting, hasExperiment, hasDataExport, evaluated, creationDate, contextKindTargeted, contextKindsEvaluated, filterEnv, segmentTargeted, codeReferences.min, codeReferences.max, excludeSettings, releasePipeline, applicationEvaluated, purpose, guardedRollout, view, key, name, archived, followerId - segments (queryfilter): query, tags, keys, excludedKeys, unbounded, external, view, type Some filters are only available when the corresponding feature is enabled on your account. | |
|
|
8
|
+
| **environment_id** | **String** | Required when using filter for segment resources. Specifies which environment to query for segments matching the filter. Ignored for flag resources (flags are global across environments). | [optional] |
|
|
9
|
+
| **comment** | **String** | Optional comment for the link/unlink operation | [optional][default to ''] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'launchdarkly_api'
|
|
15
|
+
|
|
16
|
+
instance = LaunchDarklyApi::ViewLinkRequestFilter.new(
|
|
17
|
+
filter: maintainerId:507f1f77bcf86cd799439011,tags:backend+beta,
|
|
18
|
+
environment_id: null,
|
|
19
|
+
comment: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/ViewLinkRequestKeys.md
CHANGED
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **keys** | **Array<String>** | Keys of the resources (flags, segments
|
|
7
|
+
| **keys** | **Array<String>** | Keys of the resources (flags, segments) to link/unlink | |
|
|
8
|
+
| **filter** | **String** | Optional filter string to determine which resources should be linked. Resources only need to match either the filter or explicitly-listed keys to be linked (union). Uses the same syntax as list endpoints: flags use comma-separated field:value filters, segments use queryfilter syntax. Supported filters by resource type: - flags: query, tags, maintainerId, maintainerTeamKey, type, status, state, staleState, sdkAvailability, targeting, hasExperiment, hasDataExport, evaluated, creationDate, contextKindTargeted, contextKindsEvaluated, filterEnv, segmentTargeted, codeReferences.min, codeReferences.max, excludeSettings, releasePipeline, applicationEvaluated, purpose, guardedRollout, view, key, name, archived, followerId - segments (queryfilter): query, tags, keys, excludedKeys, unbounded, external, view, type Some filters are only available when the corresponding feature is enabled on your account. | [optional] |
|
|
8
9
|
| **comment** | **String** | Optional comment for the link/unlink operation | [optional][default to ''] |
|
|
9
10
|
|
|
10
11
|
## Example
|
|
@@ -13,7 +14,8 @@
|
|
|
13
14
|
require 'launchdarkly_api'
|
|
14
15
|
|
|
15
16
|
instance = LaunchDarklyApi::ViewLinkRequestKeys.new(
|
|
16
|
-
keys:
|
|
17
|
+
keys: ["flag-1","flag-2"],
|
|
18
|
+
filter: maintainerId:507f1f77bcf86cd799439011,tags:backend+beta,
|
|
17
19
|
comment: null
|
|
18
20
|
)
|
|
19
21
|
```
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **segment_identifiers** | [**Array<ViewLinkRequestSegmentIdentifier>**](ViewLinkRequestSegmentIdentifier.md) | Identifiers of the segments to link/unlink (environmentId and segmentKey) | |
|
|
8
|
+
| **filter** | **String** | Optional filter string to determine which resources should be linked. Resources only need to match either the filter or explicitly-listed keys to be linked (union). Uses the same queryfilter syntax as the segments list endpoint. Supported filters for segments: query, tags, keys, excludedKeys, unbounded, external, view, type | [optional] |
|
|
9
|
+
| **environment_id** | **String** | Required when using filter for segment resources. Specifies which environment to query for segments matching the filter. Ignored when only using explicit segmentIdentifiers (since each identifier contains its own environmentId). | [optional] |
|
|
8
10
|
| **comment** | **String** | Optional comment for the link/unlink operation | [optional][default to ''] |
|
|
9
11
|
|
|
10
12
|
## Example
|
|
@@ -14,6 +16,8 @@ require 'launchdarkly_api'
|
|
|
14
16
|
|
|
15
17
|
instance = LaunchDarklyApi::ViewLinkRequestSegmentIdentifiers.new(
|
|
16
18
|
segment_identifiers: null,
|
|
19
|
+
filter: tags anyOf ["backend"],
|
|
20
|
+
environment_id: null,
|
|
17
21
|
comment: null
|
|
18
22
|
)
|
|
19
23
|
```
|
data/docs/ViewLinkedResource.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **_links** | [**ParentAndSelfLinks**](ParentAndSelfLinks.md) | | |
|
|
8
|
-
| **resource_key** | **String** | Key of the resource (flag
|
|
8
|
+
| **resource_key** | **String** | Key of the resource (flag or segment) | |
|
|
9
9
|
| **environment_id** | **String** | Environment ID of the resource (only present for segments) | [optional] |
|
|
10
10
|
| **environment_key** | **String** | Environment Key of the resource (only present for segments) | [optional] |
|
|
11
11
|
| **resource_type** | **String** | | |
|
data/docs/ViewsBetaApi.md
CHANGED
|
@@ -193,7 +193,10 @@ resource_type = 'flags' # String |
|
|
|
193
193
|
opts = {
|
|
194
194
|
limit: 56, # Integer | The number of views to return.
|
|
195
195
|
offset: 56, # Integer | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
|
|
196
|
-
sort: 'linkedAt' # String | Field to sort by. Default field is `linkedAt`, default order is ascending.
|
|
196
|
+
sort: 'linkedAt', # String | Field to sort by. Default field is `linkedAt`, default order is ascending.
|
|
197
|
+
query: 'query_example', # String | Case-insensitive search query for linked resources. Matches resource key and, when expanded, resource name.
|
|
198
|
+
filter: 'filter_example', # String | Optional resource filter expression for linked resources. - Supported for `flags` and `segments` resource types. - Uses the same syntax as link/unlink and list endpoints. - For `segments`, `environmentId` is required when `filter` is provided.
|
|
199
|
+
expand: ['maintainer'] # Array<String> | A comma-separated list of fields to expand.
|
|
197
200
|
}
|
|
198
201
|
|
|
199
202
|
begin
|
|
@@ -234,6 +237,9 @@ end
|
|
|
234
237
|
| **limit** | **Integer** | The number of views to return. | [optional] |
|
|
235
238
|
| **offset** | **Integer** | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. | [optional] |
|
|
236
239
|
| **sort** | **String** | Field to sort by. Default field is `linkedAt`, default order is ascending. | [optional][default to 'linkedAt'] |
|
|
240
|
+
| **query** | **String** | Case-insensitive search query for linked resources. Matches resource key and, when expanded, resource name. | [optional] |
|
|
241
|
+
| **filter** | **String** | Optional resource filter expression for linked resources. - Supported for `flags` and `segments` resource types. - Uses the same syntax as link/unlink and list endpoints. - For `segments`, `environmentId` is required when `filter` is provided. | [optional] |
|
|
242
|
+
| **expand** | [**Array<String>**](String.md) | A comma-separated list of fields to expand. | [optional] |
|
|
237
243
|
|
|
238
244
|
### Return type
|
|
239
245
|
|
|
@@ -255,7 +261,7 @@ end
|
|
|
255
261
|
|
|
256
262
|
Get linked views for a given resource
|
|
257
263
|
|
|
258
|
-
Get a list of all linked views for a resource. Flags
|
|
264
|
+
Get a list of all linked views for a resource. Flags are identified by key. Segments are identified by segment ID.
|
|
259
265
|
|
|
260
266
|
### Examples
|
|
261
267
|
|
|
@@ -363,7 +369,7 @@ opts = {
|
|
|
363
369
|
sort: 'key', # String | A sort to apply to the list of views.
|
|
364
370
|
limit: 56, # Integer | The number of views to return.
|
|
365
371
|
offset: 56, # Integer | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
|
|
366
|
-
filter: 'filter_example', # String | A filter to apply to the list of views.
|
|
372
|
+
filter: 'filter_example', # String | A filter to apply to the list of views. Supports the following fields and operators: `name` (equals, notEquals, startsWith, contains, anyOf), `key` (equals, notEquals, startsWith, contains, anyOf), `tag` (equals, anyOf), `maintainerId` (equals, anyOf), `isPayloadView` (equals).
|
|
367
373
|
expand: ['allFlags'] # Array<String> | A comma-separated list of fields to expand.
|
|
368
374
|
}
|
|
369
375
|
|
|
@@ -404,7 +410,7 @@ end
|
|
|
404
410
|
| **sort** | **String** | A sort to apply to the list of views. | [optional] |
|
|
405
411
|
| **limit** | **Integer** | The number of views to return. | [optional] |
|
|
406
412
|
| **offset** | **Integer** | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. | [optional] |
|
|
407
|
-
| **filter** | **String** | A filter to apply to the list of views. | [optional] |
|
|
413
|
+
| **filter** | **String** | A filter to apply to the list of views. Supports the following fields and operators: `name` (equals, notEquals, startsWith, contains, anyOf), `key` (equals, notEquals, startsWith, contains, anyOf), `tag` (equals, anyOf), `maintainerId` (equals, anyOf), `isPayloadView` (equals). | [optional] |
|
|
408
414
|
| **expand** | [**Array<String>**](String.md) | A comma-separated list of fields to expand. | [optional] |
|
|
409
415
|
|
|
410
416
|
### Return type
|
|
@@ -449,7 +455,7 @@ opts = {
|
|
|
449
455
|
sort: 'key', # String | A sort to apply to the list of views.
|
|
450
456
|
limit: 56, # Integer | The number of views to return.
|
|
451
457
|
offset: 56, # Integer | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
|
|
452
|
-
filter: 'filter_example', # String | A filter to apply to the list of views.
|
|
458
|
+
filter: 'filter_example', # String | A filter to apply to the list of views. Supports the following fields and operators: `name` (equals, notEquals, startsWith, contains, anyOf), `key` (equals, notEquals, startsWith, contains, anyOf), `tag` (equals, anyOf), `maintainerId` (equals, anyOf), `isPayloadView` (equals).
|
|
453
459
|
expand: ['flagsSummary'] # Array<String> | A comma-separated list of fields to expand.
|
|
454
460
|
}
|
|
455
461
|
|
|
@@ -489,7 +495,7 @@ end
|
|
|
489
495
|
| **sort** | **String** | A sort to apply to the list of views. | [optional] |
|
|
490
496
|
| **limit** | **Integer** | The number of views to return. | [optional] |
|
|
491
497
|
| **offset** | **Integer** | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. | [optional] |
|
|
492
|
-
| **filter** | **String** | A filter to apply to the list of views. | [optional] |
|
|
498
|
+
| **filter** | **String** | A filter to apply to the list of views. Supports the following fields and operators: `name` (equals, notEquals, startsWith, contains, anyOf), `key` (equals, notEquals, startsWith, contains, anyOf), `tag` (equals, anyOf), `maintainerId` (equals, anyOf), `isPayloadView` (equals). | [optional] |
|
|
493
499
|
| **expand** | [**Array<String>**](String.md) | A comma-separated list of fields to expand. | [optional] |
|
|
494
500
|
|
|
495
501
|
### Return type
|
|
@@ -512,7 +518,7 @@ end
|
|
|
512
518
|
|
|
513
519
|
Link resource
|
|
514
520
|
|
|
515
|
-
Link one or multiple resources to a view: - Link flags using flag keys
|
|
521
|
+
Link one or multiple resources to a view by keys, filters, or both: - Link flags using flag keys or filters (maintainerId, maintainerTeamKey, tags, state, query) - Link segments using segment IDs or filters (tags, query, unbounded) When both keys and filters are provided, resources matching either condition are linked (union).
|
|
516
522
|
|
|
517
523
|
### Examples
|
|
518
524
|
|
|
@@ -532,7 +538,7 @@ ld_api_version = 'beta' # String | Version of the endpoint.
|
|
|
532
538
|
project_key = 'default' # String |
|
|
533
539
|
view_key = 'my-view' # String |
|
|
534
540
|
resource_type = 'flags' # String |
|
|
535
|
-
view_link_request = LaunchDarklyApi::
|
|
541
|
+
view_link_request = LaunchDarklyApi::ViewLinkRequestFilter.new({filter: 'maintainerId:507f1f77bcf86cd799439011,tags:backend+beta'}) # ViewLinkRequest | Resources to link to the view. You can provide explicit keys/IDs, filters, or both. - Flags: identified by key or filtered by maintainerId, maintainerTeamKey, tags, state, query - Segments: identified by segment ID or filtered by tags, query, unbounded
|
|
536
542
|
|
|
537
543
|
begin
|
|
538
544
|
# Link resource
|
|
@@ -569,7 +575,7 @@ end
|
|
|
569
575
|
| **project_key** | **String** | | |
|
|
570
576
|
| **view_key** | **String** | | |
|
|
571
577
|
| **resource_type** | **String** | | |
|
|
572
|
-
| **view_link_request** | [**ViewLinkRequest**](ViewLinkRequest.md) |
|
|
578
|
+
| **view_link_request** | [**ViewLinkRequest**](ViewLinkRequest.md) | Resources to link to the view. You can provide explicit keys/IDs, filters, or both. - Flags: identified by key or filtered by maintainerId, maintainerTeamKey, tags, state, query - Segments: identified by segment ID or filtered by tags, query, unbounded | |
|
|
573
579
|
|
|
574
580
|
### Return type
|
|
575
581
|
|
|
@@ -591,7 +597,7 @@ end
|
|
|
591
597
|
|
|
592
598
|
Unlink resource
|
|
593
599
|
|
|
594
|
-
Unlink one or multiple resources from a view: - Unlink flags using flag keys - Unlink segments using segment IDs
|
|
600
|
+
Unlink one or multiple resources from a view: - Unlink flags using flag keys - Unlink segments using segment IDs
|
|
595
601
|
|
|
596
602
|
### Examples
|
|
597
603
|
|
|
@@ -611,7 +617,7 @@ ld_api_version = 'beta' # String | Version of the endpoint.
|
|
|
611
617
|
project_key = 'default' # String |
|
|
612
618
|
view_key = 'my-view' # String |
|
|
613
619
|
resource_type = 'flags' # String |
|
|
614
|
-
view_link_request = LaunchDarklyApi::
|
|
620
|
+
view_link_request = LaunchDarklyApi::ViewLinkRequestFilter.new({filter: 'maintainerId:507f1f77bcf86cd799439011,tags:backend+beta'}) # ViewLinkRequest | The resource to link to the view. Flags are identified by key. Segments are identified by segment ID.
|
|
615
621
|
|
|
616
622
|
begin
|
|
617
623
|
# Unlink resource
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# LaunchDarklyApi::ViewsMemberSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_links** | [**Hash<String, ViewsLink>**](ViewsLink.md) | The location and content type of related resources | |
|
|
8
|
+
| **_id** | **String** | The member's ID | |
|
|
9
|
+
| **first_name** | **String** | The member's first name | [optional] |
|
|
10
|
+
| **last_name** | **String** | The member's last name | [optional] |
|
|
11
|
+
| **role** | **String** | The member's base role. If the member has no additional roles, this role will be in effect. | |
|
|
12
|
+
| **email** | **String** | The member's email address | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'launchdarkly_api'
|
|
18
|
+
|
|
19
|
+
instance = LaunchDarklyApi::ViewsMemberSummary.new(
|
|
20
|
+
_links: {"self":{"href":"/api/v2/members/569f183514f4432160000007","type":"application/json"}},
|
|
21
|
+
_id: 569f183514f4432160000007,
|
|
22
|
+
first_name: Ariel,
|
|
23
|
+
last_name: Flores,
|
|
24
|
+
role: admin,
|
|
25
|
+
email: ariel@acme.com
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LaunchDarklyApi::ViewsMemberTeamSummaryRep
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **custom_role_keys** | **Array<String>** | A list of keys of the custom roles this team has access to | |
|
|
8
|
+
| **key** | **String** | The team key | |
|
|
9
|
+
| **_links** | [**Hash<String, ViewsLink>**](ViewsLink.md) | | [optional] |
|
|
10
|
+
| **name** | **String** | The team name | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'launchdarkly_api'
|
|
16
|
+
|
|
17
|
+
instance = LaunchDarklyApi::ViewsMemberTeamSummaryRep.new(
|
|
18
|
+
custom_role_keys: ["access-to-test-projects"],
|
|
19
|
+
key: team-key-123abc,
|
|
20
|
+
_links: null,
|
|
21
|
+
name: QA Team
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|