launchdarkly_api 18.0.2 → 18.1.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d219a763fe1d96abf1b11f018db76f3e6a2211baf7ea9234a6a442235122d9da
4
- data.tar.gz: 4880d0dd99c4aba39408958ff5dec4402dec505516918cb49f5e25acb3f6b9d8
3
+ metadata.gz: 00e0607d1279d13394795f83997fb8fe902f8074ef93be287c8d71c26c3193f2
4
+ data.tar.gz: 8b2ccdcd3f7fb2872019fd9278f3e6a8119d1fd7884fc5a16cdbb4112a851ea3
5
5
  SHA512:
6
- metadata.gz: 2210e65dbf06f0ce075a1ec6b10a0536d34c4a89643ef9d9e0398b595c0e837d1f398f0707e547e9f58ea85ef3f66598d2405c52b0101edce023d6c131883495
7
- data.tar.gz: 0eb98124b4513bf497079b63bb87fe819f3a81393f7512155d8de80bf06252c7d8ef5fdd8a4d2ed037b3b542b459a901a5cd950fe83e6b1cef83a669f2a6dd66
6
+ metadata.gz: 4984c7a783aa732d78a7368ed120544e9ba038aa4b7d39beed50d368c206fae77f1a049ecaef92d8536bd15ab14d6a3af4de0c1444cbcf698c33a618f9997493
7
+ data.tar.gz: 7c92fe762bb76ad077b852f40fb4de48df502ac933e6f135bdaa95edbf05d155dceecf604f2cfaae84e5ae49bb3e7709ff1943fcc381ead5e98d207a0e81506a
data/README.md CHANGED
@@ -450,7 +450,7 @@ To learn more about how EOL is determined, read LaunchDarkly's [End of Life (EOL
450
450
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
451
451
 
452
452
  - API version: 2.0
453
- - Package version: 18.0.2
453
+ - Package version: 18.1.0
454
454
  - Generator version: 7.16.0
455
455
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
456
456
  For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
@@ -468,16 +468,16 @@ gem build launchdarkly_api.gemspec
468
468
  Then either install the gem locally:
469
469
 
470
470
  ```shell
471
- gem install ./launchdarkly_api-18.0.2.gem
471
+ gem install ./launchdarkly_api-18.1.0.gem
472
472
  ```
473
473
 
474
- (for development, run `gem install --dev ./launchdarkly_api-18.0.2.gem` to install the development dependencies)
474
+ (for development, run `gem install --dev ./launchdarkly_api-18.1.0.gem` to install the development dependencies)
475
475
 
476
476
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
477
477
 
478
478
  Finally add this to the Gemfile:
479
479
 
480
- gem 'launchdarkly_api', '~> 18.0.2'
480
+ gem 'launchdarkly_api', '~> 18.1.0'
481
481
 
482
482
  ### Install from Git
483
483
 
data/docs/Environment.md CHANGED
@@ -13,6 +13,7 @@
13
13
  | **color** | **String** | The color used to indicate this environment in the UI | |
14
14
  | **default_ttl** | **Integer** | The default time (in minutes) that the PHP SDK can cache feature flag rules locally | |
15
15
  | **secure_mode** | **Boolean** | Ensures that one end user of the client-side SDK cannot inspect the variations for another end user | |
16
+ | **_access** | [**Access**](Access.md) | | [optional] |
16
17
  | **default_track_events** | **Boolean** | Enables tracking detailed information for new flags by default | |
17
18
  | **require_comments** | **Boolean** | Whether members who modify flags and segments through the LaunchDarkly user interface are required to add a comment | |
18
19
  | **confirm_changes** | **Boolean** | Whether members who modify flags and segments through the LaunchDarkly user interface are required to confirm those changes | |
@@ -36,6 +37,7 @@ instance = LaunchDarklyApi::Environment.new(
36
37
  color: F5A623,
37
38
  default_ttl: 5,
38
39
  secure_mode: true,
40
+ _access: null,
39
41
  default_track_events: false,
40
42
  require_comments: true,
41
43
  confirm_changes: true,
data/docs/Experiment.md CHANGED
@@ -12,6 +12,7 @@
12
12
  | **_creation_date** | **Integer** | | |
13
13
  | **environment_key** | **String** | | |
14
14
  | **archived_date** | **Integer** | | [optional] |
15
+ | **tags** | **Array<String>** | Tags for the experiment | [optional] |
15
16
  | **_links** | [**Hash<String, Link>**](Link.md) | The location and content type of related resources | |
16
17
  | **holdout_id** | **String** | The holdout ID | [optional] |
17
18
  | **current_iteration** | [**IterationRep**](IterationRep.md) | | [optional] |
@@ -32,6 +33,7 @@ instance = LaunchDarklyApi::Experiment.new(
32
33
  _creation_date: null,
33
34
  environment_key: null,
34
35
  archived_date: null,
36
+ tags: ["experiment","feature"],
35
37
  _links: {"parent":{"href":"/api/v2/projects/my-project/environments/my-environment","type":"application/json"},"self":{"href":"/api/v2/projects/my-project/environments/my-environment/experiments/my-experiment","type":"application/json"}},
36
38
  holdout_id: f3b74309-d581-44e1-8a2b-bb2933b4fe40,
37
39
  current_iteration: null,
@@ -10,6 +10,7 @@
10
10
  | **key** | **String** | The experiment key | |
11
11
  | **iteration** | [**IterationInput**](IterationInput.md) | | |
12
12
  | **holdout_id** | **String** | The ID of the holdout | [optional] |
13
+ | **tags** | **Array<String>** | Tags for the experiment | [optional] |
13
14
 
14
15
  ## Example
15
16
 
@@ -22,7 +23,8 @@ instance = LaunchDarklyApi::ExperimentPost.new(
22
23
  maintainer_id: 12ab3c45de678910fgh12345,
23
24
  key: experiment-key-123abc,
24
25
  iteration: null,
25
- holdout_id: f3b74309-d581-44e1-8a2b-bb2933b4fe40
26
+ holdout_id: f3b74309-d581-44e1-8a2b-bb2933b4fe40,
27
+ tags: null
26
28
  )
27
29
  ```
28
30
 
@@ -239,7 +239,7 @@ end
239
239
 
240
240
  List metric groups
241
241
 
242
- Get a list of all metric groups for the specified project. ### Expanding the metric groups response LaunchDarkly supports one field for expanding the \"Get metric groups\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the following field: - `experiments` includes all experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment's status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals 'not_started' and query equals 'metric name'`
242
+ Get a list of all metric groups for the specified project. ### Expanding the metric groups response This endpoint does not support response expansion. Although the API accepts an `expand` query parameter for compatibility reasons, it does not currently modify the response. The parameter is reserved for future use. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment's status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals 'not_started' and query equals 'metric name'`
243
243
 
244
244
  ### Examples
245
245
 
@@ -259,7 +259,7 @@ project_key = 'project_key_example' # String | The project key
259
259
  opts = {
260
260
  filter: 'filter_example', # String | Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`.
261
261
  sort: 'sort_example', # String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields.
262
- expand: 'expand_example', # String | A comma-separated list of properties that can reveal additional information in the response.
262
+ expand: 'expand_example', # String | This parameter is reserved for future use and is not currently supported on this endpoint.
263
263
  limit: 789, # Integer | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.
264
264
  offset: 789 # Integer | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items.
265
265
  }
@@ -298,7 +298,7 @@ end
298
298
  | **project_key** | **String** | The project key | |
299
299
  | **filter** | **String** | Accepts filter by &#x60;experimentStatus&#x60;, &#x60;query&#x60;, &#x60;kind&#x60;, &#x60;hasConnections&#x60;, &#x60;maintainerIds&#x60;, and &#x60;maintainerTeamKey&#x60;. Example: &#x60;filter&#x3D;experimentStatus equals &#39;running&#39; and query equals &#39;test&#39;&#x60;. | [optional] |
300
300
  | **sort** | **String** | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. | [optional] |
301
- | **expand** | **String** | A comma-separated list of properties that can reveal additional information in the response. | [optional] |
301
+ | **expand** | **String** | This parameter is reserved for future use and is not currently supported on this endpoint. | [optional] |
302
302
  | **limit** | **Integer** | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. | [optional] |
303
303
  | **offset** | **Integer** | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next &#x60;limit&#x60; items. | [optional] |
304
304
 
@@ -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: null,
23
+ progressive_release_config: {&quot;rolloutContextKindKey&quot;:&quot;user&quot;},
24
24
  name: Production Release,
25
25
  key: production-release
26
26
  )
@@ -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: null,
22
+ progressive_release_config: {&quot;rolloutContextKindKey&quot;:&quot;user&quot;},
23
23
  name: Production Release
24
24
  )
25
25
  ```
@@ -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: null,
29
+ progressive_release_config: {&quot;rolloutContextKindKey&quot;:&quot;user&quot;},
30
30
  name: Production Release,
31
31
  key: production-release
32
32
  )
@@ -235,12 +235,12 @@ module LaunchDarklyApi
235
235
  end
236
236
 
237
237
  # List metric groups
238
- # Get a list of all metric groups for the specified project. ### Expanding the metric groups response LaunchDarkly supports one field for expanding the \"Get metric groups\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the following field: - `experiments` includes all experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment's status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals 'not_started' and query equals 'metric name'`
238
+ # Get a list of all metric groups for the specified project. ### Expanding the metric groups response This endpoint does not support response expansion. Although the API accepts an `expand` query parameter for compatibility reasons, it does not currently modify the response. The parameter is reserved for future use. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment's status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals 'not_started' and query equals 'metric name'`
239
239
  # @param project_key [String] The project key
240
240
  # @param [Hash] opts the optional parameters
241
241
  # @option opts [String] :filter Accepts filter by &#x60;experimentStatus&#x60;, &#x60;query&#x60;, &#x60;kind&#x60;, &#x60;hasConnections&#x60;, &#x60;maintainerIds&#x60;, and &#x60;maintainerTeamKey&#x60;. Example: &#x60;filter&#x3D;experimentStatus equals &#39;running&#39; and query equals &#39;test&#39;&#x60;.
242
242
  # @option opts [String] :sort A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields.
243
- # @option opts [String] :expand A comma-separated list of properties that can reveal additional information in the response.
243
+ # @option opts [String] :expand This parameter is reserved for future use and is not currently supported on this endpoint.
244
244
  # @option opts [Integer] :limit The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.
245
245
  # @option opts [Integer] :offset Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next &#x60;limit&#x60; items.
246
246
  # @return [MetricGroupCollectionRep]
@@ -250,12 +250,12 @@ module LaunchDarklyApi
250
250
  end
251
251
 
252
252
  # List metric groups
253
- # Get a list of all metric groups for the specified project. ### Expanding the metric groups response LaunchDarkly supports one field for expanding the \&quot;Get metric groups\&quot; response. By default, these fields are **not** included in the response. To expand the response, append the &#x60;expand&#x60; query parameter and add a comma-separated list with the following field: - &#x60;experiments&#x60; includes all experiments from the specific project that use the metric group For example, &#x60;expand&#x3D;experiments&#x60; includes the &#x60;experiments&#x60; field in the response. ### Filtering metric groups The &#x60;filter&#x60; parameter supports the following operators: &#x60;contains&#x60;, &#x60;equals&#x60;, &#x60;anyOf&#x60;. #### Supported fields and operators You can only filter certain fields in metrics when using the &#x60;filter&#x60; parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the &#x60;filter&#x60; parameter supports the following fields and operators: |&lt;div style&#x3D;\&quot;width:120px\&quot;&gt;Field&lt;/div&gt; |Description |Supported operators | |---|---|---| | &#x60;experimentStatus&#x60; | The experiment&#39;s status. One of &#x60;not_started&#x60;, &#x60;running&#x60;, &#x60;stopped&#x60;, &#x60;started&#x60;. | &#x60;equals&#x60; | | &#x60;hasConnections&#x60; | Whether the metric group has connections to experiments or guarded rollouts. One of &#x60;true&#x60;, &#x60;false&#x60;. | &#x60;equals&#x60; | | &#x60;kind&#x60; | The metric group kind. One of &#x60;funnel&#x60;, &#x60;standard&#x60;. | &#x60;equals&#x60; | | &#x60;maintainerIds&#x60; | The metric maintainer IDs. | &#x60;anyOf&#x60; | | &#x60;maintainerTeamKey&#x60; | The metric maintainer team key. | &#x60;equals&#x60; | | &#x60;query&#x60; | A \&quot;fuzzy\&quot; search across metric group key and name. Supply a string or list of strings to the operator. | &#x60;equals&#x60; | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - &#x60;name&#x60; sorts by metric group name. - &#x60;createdAt&#x60; sorts by the creation date of the metric group. - &#x60;connectionCount&#x60; sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use &#x60;-&#x60; to sort in descending order. For example, &#x60;?sort&#x3D;name&#x60; sorts the response by metric group name in ascending order, and &#x60;?sort&#x3D;-name&#x60; sorts in descending order. #### Sample query &#x60;filter&#x3D;experimentStatus equals &#39;not_started&#39; and query equals &#39;metric name&#39;&#x60;
253
+ # Get a list of all metric groups for the specified project. ### Expanding the metric groups response This endpoint does not support response expansion. Although the API accepts an &#x60;expand&#x60; query parameter for compatibility reasons, it does not currently modify the response. The parameter is reserved for future use. ### Filtering metric groups The &#x60;filter&#x60; parameter supports the following operators: &#x60;contains&#x60;, &#x60;equals&#x60;, &#x60;anyOf&#x60;. #### Supported fields and operators You can only filter certain fields in metrics when using the &#x60;filter&#x60; parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the &#x60;filter&#x60; parameter supports the following fields and operators: |&lt;div style&#x3D;\&quot;width:120px\&quot;&gt;Field&lt;/div&gt; |Description |Supported operators | |---|---|---| | &#x60;experimentStatus&#x60; | The experiment&#39;s status. One of &#x60;not_started&#x60;, &#x60;running&#x60;, &#x60;stopped&#x60;, &#x60;started&#x60;. | &#x60;equals&#x60; | | &#x60;hasConnections&#x60; | Whether the metric group has connections to experiments or guarded rollouts. One of &#x60;true&#x60;, &#x60;false&#x60;. | &#x60;equals&#x60; | | &#x60;kind&#x60; | The metric group kind. One of &#x60;funnel&#x60;, &#x60;standard&#x60;. | &#x60;equals&#x60; | | &#x60;maintainerIds&#x60; | The metric maintainer IDs. | &#x60;anyOf&#x60; | | &#x60;maintainerTeamKey&#x60; | The metric maintainer team key. | &#x60;equals&#x60; | | &#x60;query&#x60; | A \&quot;fuzzy\&quot; search across metric group key and name. Supply a string or list of strings to the operator. | &#x60;equals&#x60; | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - &#x60;name&#x60; sorts by metric group name. - &#x60;createdAt&#x60; sorts by the creation date of the metric group. - &#x60;connectionCount&#x60; sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use &#x60;-&#x60; to sort in descending order. For example, &#x60;?sort&#x3D;name&#x60; sorts the response by metric group name in ascending order, and &#x60;?sort&#x3D;-name&#x60; sorts in descending order. #### Sample query &#x60;filter&#x3D;experimentStatus equals &#39;not_started&#39; and query equals &#39;metric name&#39;&#x60;
254
254
  # @param project_key [String] The project key
255
255
  # @param [Hash] opts the optional parameters
256
256
  # @option opts [String] :filter Accepts filter by &#x60;experimentStatus&#x60;, &#x60;query&#x60;, &#x60;kind&#x60;, &#x60;hasConnections&#x60;, &#x60;maintainerIds&#x60;, and &#x60;maintainerTeamKey&#x60;. Example: &#x60;filter&#x3D;experimentStatus equals &#39;running&#39; and query equals &#39;test&#39;&#x60;.
257
257
  # @option opts [String] :sort A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields.
258
- # @option opts [String] :expand A comma-separated list of properties that can reveal additional information in the response.
258
+ # @option opts [String] :expand This parameter is reserved for future use and is not currently supported on this endpoint.
259
259
  # @option opts [Integer] :limit The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.
260
260
  # @option opts [Integer] :offset Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next &#x60;limit&#x60; items.
261
261
  # @return [Array<(MetricGroupCollectionRep, Integer, Hash)>] MetricGroupCollectionRep data, response status code and response headers
@@ -42,6 +42,8 @@ module LaunchDarklyApi
42
42
  # Ensures that one end user of the client-side SDK cannot inspect the variations for another end user
43
43
  attr_accessor :secure_mode
44
44
 
45
+ attr_accessor :_access
46
+
45
47
  # Enables tracking detailed information for new flags by default
46
48
  attr_accessor :default_track_events
47
49
 
@@ -74,6 +76,7 @@ module LaunchDarklyApi
74
76
  :'color' => :'color',
75
77
  :'default_ttl' => :'defaultTtl',
76
78
  :'secure_mode' => :'secureMode',
79
+ :'_access' => :'_access',
77
80
  :'default_track_events' => :'defaultTrackEvents',
78
81
  :'require_comments' => :'requireComments',
79
82
  :'confirm_changes' => :'confirmChanges',
@@ -106,6 +109,7 @@ module LaunchDarklyApi
106
109
  :'color' => :'String',
107
110
  :'default_ttl' => :'Integer',
108
111
  :'secure_mode' => :'Boolean',
112
+ :'_access' => :'Access',
109
113
  :'default_track_events' => :'Boolean',
110
114
  :'require_comments' => :'Boolean',
111
115
  :'confirm_changes' => :'Boolean',
@@ -194,6 +198,10 @@ module LaunchDarklyApi
194
198
  self.secure_mode = nil
195
199
  end
196
200
 
201
+ if attributes.key?(:'_access')
202
+ self._access = attributes[:'_access']
203
+ end
204
+
197
205
  if attributes.key?(:'default_track_events')
198
206
  self.default_track_events = attributes[:'default_track_events']
199
207
  else
@@ -476,6 +484,7 @@ module LaunchDarklyApi
476
484
  color == o.color &&
477
485
  default_ttl == o.default_ttl &&
478
486
  secure_mode == o.secure_mode &&
487
+ _access == o._access &&
479
488
  default_track_events == o.default_track_events &&
480
489
  require_comments == o.require_comments &&
481
490
  confirm_changes == o.confirm_changes &&
@@ -494,7 +503,7 @@ module LaunchDarklyApi
494
503
  # Calculates hash code according to all attributes.
495
504
  # @return [Integer] Hash code
496
505
  def hash
497
- [_links, _id, key, name, api_key, mobile_key, color, default_ttl, secure_mode, default_track_events, require_comments, confirm_changes, tags, approval_settings, resource_approval_settings, critical].hash
506
+ [_links, _id, key, name, api_key, mobile_key, color, default_ttl, secure_mode, _access, default_track_events, require_comments, confirm_changes, tags, approval_settings, resource_approval_settings, critical].hash
498
507
  end
499
508
 
500
509
  # Builds the object from hash
@@ -36,6 +36,9 @@ module LaunchDarklyApi
36
36
 
37
37
  attr_accessor :archived_date
38
38
 
39
+ # Tags for the experiment
40
+ attr_accessor :tags
41
+
39
42
  # The location and content type of related resources
40
43
  attr_accessor :_links
41
44
 
@@ -60,6 +63,7 @@ module LaunchDarklyApi
60
63
  :'_creation_date' => :'_creationDate',
61
64
  :'environment_key' => :'environmentKey',
62
65
  :'archived_date' => :'archivedDate',
66
+ :'tags' => :'tags',
63
67
  :'_links' => :'_links',
64
68
  :'holdout_id' => :'holdoutId',
65
69
  :'current_iteration' => :'currentIteration',
@@ -89,6 +93,7 @@ module LaunchDarklyApi
89
93
  :'_creation_date' => :'Integer',
90
94
  :'environment_key' => :'String',
91
95
  :'archived_date' => :'Integer',
96
+ :'tags' => :'Array<String>',
92
97
  :'_links' => :'Hash<String, Link>',
93
98
  :'holdout_id' => :'String',
94
99
  :'current_iteration' => :'IterationRep',
@@ -161,6 +166,12 @@ module LaunchDarklyApi
161
166
  self.archived_date = attributes[:'archived_date']
162
167
  end
163
168
 
169
+ if attributes.key?(:'tags')
170
+ if (value = attributes[:'tags']).is_a?(Array)
171
+ self.tags = value
172
+ end
173
+ end
174
+
164
175
  if attributes.key?(:'_links')
165
176
  if (value = attributes[:'_links']).is_a?(Hash)
166
177
  self._links = value
@@ -306,6 +317,7 @@ module LaunchDarklyApi
306
317
  _creation_date == o._creation_date &&
307
318
  environment_key == o.environment_key &&
308
319
  archived_date == o.archived_date &&
320
+ tags == o.tags &&
309
321
  _links == o._links &&
310
322
  holdout_id == o.holdout_id &&
311
323
  current_iteration == o.current_iteration &&
@@ -322,7 +334,7 @@ module LaunchDarklyApi
322
334
  # Calculates hash code according to all attributes.
323
335
  # @return [Integer] Hash code
324
336
  def hash
325
- [_id, key, name, description, _maintainer_id, _creation_date, environment_key, archived_date, _links, holdout_id, current_iteration, draft_iteration, previous_iterations].hash
337
+ [_id, key, name, description, _maintainer_id, _creation_date, environment_key, archived_date, tags, _links, holdout_id, current_iteration, draft_iteration, previous_iterations].hash
326
338
  end
327
339
 
328
340
  # Builds the object from hash
@@ -32,6 +32,9 @@ module LaunchDarklyApi
32
32
  # The ID of the holdout
33
33
  attr_accessor :holdout_id
34
34
 
35
+ # Tags for the experiment
36
+ attr_accessor :tags
37
+
35
38
  # Attribute mapping from ruby-style variable name to JSON key.
36
39
  def self.attribute_map
37
40
  {
@@ -40,7 +43,8 @@ module LaunchDarklyApi
40
43
  :'maintainer_id' => :'maintainerId',
41
44
  :'key' => :'key',
42
45
  :'iteration' => :'iteration',
43
- :'holdout_id' => :'holdoutId'
46
+ :'holdout_id' => :'holdoutId',
47
+ :'tags' => :'tags'
44
48
  }
45
49
  end
46
50
 
@@ -62,7 +66,8 @@ module LaunchDarklyApi
62
66
  :'maintainer_id' => :'String',
63
67
  :'key' => :'String',
64
68
  :'iteration' => :'IterationInput',
65
- :'holdout_id' => :'String'
69
+ :'holdout_id' => :'String',
70
+ :'tags' => :'Array<String>'
66
71
  }
67
72
  end
68
73
 
@@ -117,6 +122,12 @@ module LaunchDarklyApi
117
122
  if attributes.key?(:'holdout_id')
118
123
  self.holdout_id = attributes[:'holdout_id']
119
124
  end
125
+
126
+ if attributes.key?(:'tags')
127
+ if (value = attributes[:'tags']).is_a?(Array)
128
+ self.tags = value
129
+ end
130
+ end
120
131
  end
121
132
 
122
133
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -189,7 +200,8 @@ module LaunchDarklyApi
189
200
  maintainer_id == o.maintainer_id &&
190
201
  key == o.key &&
191
202
  iteration == o.iteration &&
192
- holdout_id == o.holdout_id
203
+ holdout_id == o.holdout_id &&
204
+ tags == o.tags
193
205
  end
194
206
 
195
207
  # @see the `==` method
@@ -201,7 +213,7 @@ module LaunchDarklyApi
201
213
  # Calculates hash code according to all attributes.
202
214
  # @return [Integer] Hash code
203
215
  def hash
204
- [name, description, maintainer_id, key, iteration, holdout_id].hash
216
+ [name, description, maintainer_id, key, iteration, holdout_id, tags].hash
205
217
  end
206
218
 
207
219
  # Builds the object from hash
@@ -11,5 +11,5 @@ Generator version: 7.16.0
11
11
  =end
12
12
 
13
13
  module LaunchDarklyApi
14
- VERSION = '18.0.2'
14
+ VERSION = '18.1.0'
15
15
  end
@@ -74,12 +74,12 @@ describe 'MetricsBetaApi' do
74
74
 
75
75
  # unit tests for get_metric_groups
76
76
  # List metric groups
77
- # Get a list of all metric groups for the specified project. ### Expanding the metric groups response LaunchDarkly supports one field for expanding the \&quot;Get metric groups\&quot; response. By default, these fields are **not** included in the response. To expand the response, append the &#x60;expand&#x60; query parameter and add a comma-separated list with the following field: - &#x60;experiments&#x60; includes all experiments from the specific project that use the metric group For example, &#x60;expand&#x3D;experiments&#x60; includes the &#x60;experiments&#x60; field in the response. ### Filtering metric groups The &#x60;filter&#x60; parameter supports the following operators: &#x60;contains&#x60;, &#x60;equals&#x60;, &#x60;anyOf&#x60;. #### Supported fields and operators You can only filter certain fields in metrics when using the &#x60;filter&#x60; parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the &#x60;filter&#x60; parameter supports the following fields and operators: |&lt;div style&#x3D;\&quot;width:120px\&quot;&gt;Field&lt;/div&gt; |Description |Supported operators | |---|---|---| | &#x60;experimentStatus&#x60; | The experiment&#39;s status. One of &#x60;not_started&#x60;, &#x60;running&#x60;, &#x60;stopped&#x60;, &#x60;started&#x60;. | &#x60;equals&#x60; | | &#x60;hasConnections&#x60; | Whether the metric group has connections to experiments or guarded rollouts. One of &#x60;true&#x60;, &#x60;false&#x60;. | &#x60;equals&#x60; | | &#x60;kind&#x60; | The metric group kind. One of &#x60;funnel&#x60;, &#x60;standard&#x60;. | &#x60;equals&#x60; | | &#x60;maintainerIds&#x60; | The metric maintainer IDs. | &#x60;anyOf&#x60; | | &#x60;maintainerTeamKey&#x60; | The metric maintainer team key. | &#x60;equals&#x60; | | &#x60;query&#x60; | A \&quot;fuzzy\&quot; search across metric group key and name. Supply a string or list of strings to the operator. | &#x60;equals&#x60; | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - &#x60;name&#x60; sorts by metric group name. - &#x60;createdAt&#x60; sorts by the creation date of the metric group. - &#x60;connectionCount&#x60; sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use &#x60;-&#x60; to sort in descending order. For example, &#x60;?sort&#x3D;name&#x60; sorts the response by metric group name in ascending order, and &#x60;?sort&#x3D;-name&#x60; sorts in descending order. #### Sample query &#x60;filter&#x3D;experimentStatus equals &#39;not_started&#39; and query equals &#39;metric name&#39;&#x60;
77
+ # Get a list of all metric groups for the specified project. ### Expanding the metric groups response This endpoint does not support response expansion. Although the API accepts an &#x60;expand&#x60; query parameter for compatibility reasons, it does not currently modify the response. The parameter is reserved for future use. ### Filtering metric groups The &#x60;filter&#x60; parameter supports the following operators: &#x60;contains&#x60;, &#x60;equals&#x60;, &#x60;anyOf&#x60;. #### Supported fields and operators You can only filter certain fields in metrics when using the &#x60;filter&#x60; parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the &#x60;filter&#x60; parameter supports the following fields and operators: |&lt;div style&#x3D;\&quot;width:120px\&quot;&gt;Field&lt;/div&gt; |Description |Supported operators | |---|---|---| | &#x60;experimentStatus&#x60; | The experiment&#39;s status. One of &#x60;not_started&#x60;, &#x60;running&#x60;, &#x60;stopped&#x60;, &#x60;started&#x60;. | &#x60;equals&#x60; | | &#x60;hasConnections&#x60; | Whether the metric group has connections to experiments or guarded rollouts. One of &#x60;true&#x60;, &#x60;false&#x60;. | &#x60;equals&#x60; | | &#x60;kind&#x60; | The metric group kind. One of &#x60;funnel&#x60;, &#x60;standard&#x60;. | &#x60;equals&#x60; | | &#x60;maintainerIds&#x60; | The metric maintainer IDs. | &#x60;anyOf&#x60; | | &#x60;maintainerTeamKey&#x60; | The metric maintainer team key. | &#x60;equals&#x60; | | &#x60;query&#x60; | A \&quot;fuzzy\&quot; search across metric group key and name. Supply a string or list of strings to the operator. | &#x60;equals&#x60; | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - &#x60;name&#x60; sorts by metric group name. - &#x60;createdAt&#x60; sorts by the creation date of the metric group. - &#x60;connectionCount&#x60; sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use &#x60;-&#x60; to sort in descending order. For example, &#x60;?sort&#x3D;name&#x60; sorts the response by metric group name in ascending order, and &#x60;?sort&#x3D;-name&#x60; sorts in descending order. #### Sample query &#x60;filter&#x3D;experimentStatus equals &#39;not_started&#39; and query equals &#39;metric name&#39;&#x60;
78
78
  # @param project_key The project key
79
79
  # @param [Hash] opts the optional parameters
80
80
  # @option opts [String] :filter Accepts filter by &#x60;experimentStatus&#x60;, &#x60;query&#x60;, &#x60;kind&#x60;, &#x60;hasConnections&#x60;, &#x60;maintainerIds&#x60;, and &#x60;maintainerTeamKey&#x60;. Example: &#x60;filter&#x3D;experimentStatus equals &#39;running&#39; and query equals &#39;test&#39;&#x60;.
81
81
  # @option opts [String] :sort A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields.
82
- # @option opts [String] :expand A comma-separated list of properties that can reveal additional information in the response.
82
+ # @option opts [String] :expand This parameter is reserved for future use and is not currently supported on this endpoint.
83
83
  # @option opts [Integer] :limit The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.
84
84
  # @option opts [Integer] :offset Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next &#x60;limit&#x60; items.
85
85
  # @return [MetricGroupCollectionRep]
@@ -81,6 +81,12 @@ describe LaunchDarklyApi::Environment do
81
81
  end
82
82
  end
83
83
 
84
+ describe 'test attribute "_access"' do
85
+ it 'should work' do
86
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
87
+ end
88
+ end
89
+
84
90
  describe 'test attribute "default_track_events"' do
85
91
  it 'should work' do
86
92
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -63,4 +63,10 @@ describe LaunchDarklyApi::ExperimentPost do
63
63
  end
64
64
  end
65
65
 
66
+ describe 'test attribute "tags"' do
67
+ it 'should work' do
68
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
69
+ end
70
+ end
71
+
66
72
  end
@@ -75,6 +75,12 @@ describe LaunchDarklyApi::Experiment do
75
75
  end
76
76
  end
77
77
 
78
+ describe 'test attribute "tags"' do
79
+ it 'should work' do
80
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
81
+ end
82
+ end
83
+
78
84
  describe 'test attribute "_links"' do
79
85
  it 'should work' do
80
86
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: launchdarkly_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 18.0.2
4
+ version: 18.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenAPI-Generator
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-10-24 00:00:00.000000000 Z
11
+ date: 2025-10-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus