launchdarkly_api 25.1.0 → 25.2.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 +18 -4
- data/docs/AIConfigTargetingEnvironmentRule.md +2 -0
- data/docs/AgentControlApi.md +3 -1
- data/docs/AssignmentDataSourceInput.md +24 -0
- data/docs/AuditLogApi.md +2 -0
- data/docs/Experiment.md +2 -0
- data/docs/ExperimentsApi.md +1 -1
- data/docs/IntegrationDeliveryConfiguration.md +3 -1
- data/docs/IntegrationDeliveryConfigurationStatus.md +26 -0
- data/docs/IntegrationsBetaApi.md +4 -4
- data/docs/IterationAssignmentDataSourceRep.md +26 -0
- data/docs/IterationInput.md +3 -1
- data/docs/IterationRep.md +4 -2
- data/docs/PatchSegmentScheduledChangeInput.md +20 -0
- data/docs/PostSegmentScheduledChangeInput.md +22 -0
- data/docs/SegmentScheduledChange.md +34 -0
- data/docs/SegmentScheduledChangeStatus.md +15 -0
- data/docs/SegmentScheduledChanges.md +20 -0
- data/docs/SegmentScheduledChangesLink.md +20 -0
- data/docs/SegmentsApi.md +389 -0
- data/docs/TreatmentInput.md +3 -1
- data/docs/TreatmentRep.md +3 -1
- data/docs/Webhook.md +2 -0
- data/docs/WebhookPost.md +2 -0
- data/lib/launchdarkly_api/api/agent_control_api.rb +3 -0
- data/lib/launchdarkly_api/api/audit_log_api.rb +3 -0
- data/lib/launchdarkly_api/api/experiments_api.rb +2 -2
- data/lib/launchdarkly_api/api/integrations_beta_api.rb +8 -8
- data/lib/launchdarkly_api/api/segments_api.rb +415 -0
- data/lib/launchdarkly_api/models/ai_config_targeting_environment_rule.rb +28 -1
- data/lib/launchdarkly_api/models/assignment_data_source_input.rb +193 -0
- data/lib/launchdarkly_api/models/experiment.rb +23 -1
- data/lib/launchdarkly_api/models/integration_delivery_configuration.rb +13 -4
- data/lib/launchdarkly_api/models/integration_delivery_configuration_status.rb +222 -0
- data/lib/launchdarkly_api/models/iteration_assignment_data_source_rep.rb +237 -0
- data/lib/launchdarkly_api/models/iteration_input.rb +11 -2
- data/lib/launchdarkly_api/models/iteration_rep.rb +14 -5
- data/lib/launchdarkly_api/models/patch_segment_scheduled_change_input.rb +157 -0
- data/lib/launchdarkly_api/models/post_segment_scheduled_change_input.rb +203 -0
- data/lib/launchdarkly_api/models/segment_scheduled_change.rb +353 -0
- data/lib/launchdarkly_api/models/segment_scheduled_change_status.rb +41 -0
- data/lib/launchdarkly_api/models/segment_scheduled_changes.rb +196 -0
- data/lib/launchdarkly_api/models/segment_scheduled_changes_link.rb +156 -0
- data/lib/launchdarkly_api/models/treatment_input.rb +14 -4
- data/lib/launchdarkly_api/models/treatment_rep.rb +14 -4
- data/lib/launchdarkly_api/models/webhook.rb +11 -1
- data/lib/launchdarkly_api/models/webhook_post.rb +11 -1
- data/lib/launchdarkly_api/version.rb +1 -1
- data/lib/launchdarkly_api.rb +9 -0
- data/spec/api/agent_control_api_spec.rb +1 -0
- data/spec/api/audit_log_api_spec.rb +1 -0
- data/spec/api/experiments_api_spec.rb +1 -1
- data/spec/api/integrations_beta_api_spec.rb +4 -4
- data/spec/api/segments_api_spec.rb +75 -0
- data/spec/models/ai_config_targeting_environment_rule_spec.rb +6 -0
- data/spec/models/assignment_data_source_input_spec.rb +54 -0
- data/spec/models/experiment_spec.rb +10 -0
- data/spec/models/integration_delivery_configuration_spec.rb +6 -0
- data/spec/models/integration_delivery_configuration_status_spec.rb +60 -0
- data/spec/models/iteration_assignment_data_source_rep_spec.rb +60 -0
- data/spec/models/iteration_input_spec.rb +6 -0
- data/spec/models/iteration_rep_spec.rb +6 -0
- data/spec/models/patch_segment_scheduled_change_input_spec.rb +42 -0
- data/spec/models/post_segment_scheduled_change_input_spec.rb +48 -0
- data/spec/models/segment_scheduled_change_spec.rb +84 -0
- data/spec/models/segment_scheduled_change_status_spec.rb +30 -0
- data/spec/models/segment_scheduled_changes_link_spec.rb +42 -0
- data/spec/models/segment_scheduled_changes_spec.rb +42 -0
- data/spec/models/treatment_input_spec.rb +6 -0
- data/spec/models/treatment_rep_spec.rb +6 -0
- data/spec/models/webhook_post_spec.rb +6 -0
- data/spec/models/webhook_spec.rb +6 -0
- metadata +757 -724
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f2e66aa402f0cf2baab78dab72a3af51925f7226269c8cdf78c32e8195482f13
|
|
4
|
+
data.tar.gz: e333aefd53f5fc87a723fde421ca9e2625d1517ce3cfb28f1612557197fe6328
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 645628e479e4d9566b170a490a7d045d62d9e7dd7cc070f7c76d4fcad1dd54da3ad04c009d6f90fedb3f642d37380a5abe8f4da42ce623401e4fb56eb9dd60b7
|
|
7
|
+
data.tar.gz: e8c498c1d6a2985c9b0e76773e6703fab5539468eb1236f8eae741b562d5fb2f7db5d9cf432abfaba09aac27bddea5dcfe14c719739aba97c6beeba3f9fef00a
|
data/README.md
CHANGED
|
@@ -466,7 +466,7 @@ To learn more about how EOL is determined, read LaunchDarkly's [End of Life (EOL
|
|
|
466
466
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
467
467
|
|
|
468
468
|
- API version: 2.0
|
|
469
|
-
- Package version: 25.
|
|
469
|
+
- Package version: 25.2.0
|
|
470
470
|
- Generator version: 7.18.0
|
|
471
471
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
472
472
|
For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
|
|
@@ -484,16 +484,16 @@ gem build launchdarkly_api.gemspec
|
|
|
484
484
|
Then either install the gem locally:
|
|
485
485
|
|
|
486
486
|
```shell
|
|
487
|
-
gem install ./launchdarkly_api-25.
|
|
487
|
+
gem install ./launchdarkly_api-25.2.0.gem
|
|
488
488
|
```
|
|
489
489
|
|
|
490
|
-
(for development, run `gem install --dev ./launchdarkly_api-25.
|
|
490
|
+
(for development, run `gem install --dev ./launchdarkly_api-25.2.0.gem` to install the development dependencies)
|
|
491
491
|
|
|
492
492
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
493
493
|
|
|
494
494
|
Finally add this to the Gemfile:
|
|
495
495
|
|
|
496
|
-
gem 'launchdarkly_api', '~> 25.
|
|
496
|
+
gem 'launchdarkly_api', '~> 25.2.0'
|
|
497
497
|
|
|
498
498
|
### Install from Git
|
|
499
499
|
|
|
@@ -894,6 +894,7 @@ Class | Method | HTTP request | Description
|
|
|
894
894
|
*LaunchDarklyApi::SegmentsApi* | [**create_big_segment_export**](docs/SegmentsApi.md#create_big_segment_export) | **POST** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports | Create big segment export
|
|
895
895
|
*LaunchDarklyApi::SegmentsApi* | [**create_big_segment_import**](docs/SegmentsApi.md#create_big_segment_import) | **POST** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports | Create big segment import
|
|
896
896
|
*LaunchDarklyApi::SegmentsApi* | [**delete_segment**](docs/SegmentsApi.md#delete_segment) | **DELETE** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey} | Delete segment
|
|
897
|
+
*LaunchDarklyApi::SegmentsApi* | [**delete_segment_scheduled_change**](docs/SegmentsApi.md#delete_segment_scheduled_change) | **DELETE** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/scheduled-changes/{id} | Delete a scheduled change for a segment
|
|
897
898
|
*LaunchDarklyApi::SegmentsApi* | [**get_big_segment_export**](docs/SegmentsApi.md#get_big_segment_export) | **GET** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports/{exportID} | Get big segment export
|
|
898
899
|
*LaunchDarklyApi::SegmentsApi* | [**get_big_segment_import**](docs/SegmentsApi.md#get_big_segment_import) | **GET** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID} | Get big segment import
|
|
899
900
|
*LaunchDarklyApi::SegmentsApi* | [**get_context_instance_segments_membership_by_env**](docs/SegmentsApi.md#get_context_instance_segments_membership_by_env) | **POST** /api/v2/projects/{projectKey}/environments/{environmentKey}/segments/evaluate | List segment memberships for context instance
|
|
@@ -902,11 +903,15 @@ Class | Method | HTTP request | Description
|
|
|
902
903
|
*LaunchDarklyApi::SegmentsApi* | [**get_segment**](docs/SegmentsApi.md#get_segment) | **GET** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey} | Get segment
|
|
903
904
|
*LaunchDarklyApi::SegmentsApi* | [**get_segment_membership_for_context**](docs/SegmentsApi.md#get_segment_membership_for_context) | **GET** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/contexts/{contextKey} | Get big segment membership for context
|
|
904
905
|
*LaunchDarklyApi::SegmentsApi* | [**get_segment_membership_for_user**](docs/SegmentsApi.md#get_segment_membership_for_user) | **GET** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/users/{userKey} | Get big segment membership for user
|
|
906
|
+
*LaunchDarklyApi::SegmentsApi* | [**get_segment_scheduled_change**](docs/SegmentsApi.md#get_segment_scheduled_change) | **GET** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/scheduled-changes/{id} | Get a scheduled change for a segment
|
|
907
|
+
*LaunchDarklyApi::SegmentsApi* | [**get_segment_scheduled_changes**](docs/SegmentsApi.md#get_segment_scheduled_changes) | **GET** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/scheduled-changes | List scheduled changes for a segment
|
|
905
908
|
*LaunchDarklyApi::SegmentsApi* | [**get_segments**](docs/SegmentsApi.md#get_segments) | **GET** /api/v2/segments/{projectKey}/{environmentKey} | List segments
|
|
906
909
|
*LaunchDarklyApi::SegmentsApi* | [**patch_expiring_targets_for_segment**](docs/SegmentsApi.md#patch_expiring_targets_for_segment) | **PATCH** /api/v2/segments/{projectKey}/{segmentKey}/expiring-targets/{environmentKey} | Update expiring targets for segment
|
|
907
910
|
*LaunchDarklyApi::SegmentsApi* | [**patch_expiring_user_targets_for_segment**](docs/SegmentsApi.md#patch_expiring_user_targets_for_segment) | **PATCH** /api/v2/segments/{projectKey}/{segmentKey}/expiring-user-targets/{environmentKey} | Update expiring user targets for segment
|
|
908
911
|
*LaunchDarklyApi::SegmentsApi* | [**patch_segment**](docs/SegmentsApi.md#patch_segment) | **PATCH** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey} | Patch segment
|
|
912
|
+
*LaunchDarklyApi::SegmentsApi* | [**patch_segment_scheduled_change**](docs/SegmentsApi.md#patch_segment_scheduled_change) | **PATCH** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/scheduled-changes/{id} | Update a scheduled change for a segment
|
|
909
913
|
*LaunchDarklyApi::SegmentsApi* | [**post_segment**](docs/SegmentsApi.md#post_segment) | **POST** /api/v2/segments/{projectKey}/{environmentKey} | Create segment
|
|
914
|
+
*LaunchDarklyApi::SegmentsApi* | [**post_segment_scheduled_change**](docs/SegmentsApi.md#post_segment_scheduled_change) | **POST** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/scheduled-changes | Create a scheduled change for a segment
|
|
910
915
|
*LaunchDarklyApi::SegmentsApi* | [**update_big_segment_context_targets**](docs/SegmentsApi.md#update_big_segment_context_targets) | **POST** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/contexts | Update context targets on a big segment
|
|
911
916
|
*LaunchDarklyApi::SegmentsApi* | [**update_big_segment_targets**](docs/SegmentsApi.md#update_big_segment_targets) | **POST** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/users | Update user context targets on a big segment
|
|
912
917
|
*LaunchDarklyApi::TagsApi* | [**get_tags**](docs/TagsApi.md#get_tags) | **GET** /api/v2/tags | List tags
|
|
@@ -1067,6 +1072,7 @@ Class | Method | HTTP request | Description
|
|
|
1067
1072
|
- [LaunchDarklyApi::ApprovalSettings](docs/ApprovalSettings.md)
|
|
1068
1073
|
- [LaunchDarklyApi::ApprovalsCapabilityConfig](docs/ApprovalsCapabilityConfig.md)
|
|
1069
1074
|
- [LaunchDarklyApi::AssignedToRep](docs/AssignedToRep.md)
|
|
1075
|
+
- [LaunchDarklyApi::AssignmentDataSourceInput](docs/AssignmentDataSourceInput.md)
|
|
1070
1076
|
- [LaunchDarklyApi::Audience](docs/Audience.md)
|
|
1071
1077
|
- [LaunchDarklyApi::AudienceConfiguration](docs/AudienceConfiguration.md)
|
|
1072
1078
|
- [LaunchDarklyApi::AudiencePost](docs/AudiencePost.md)
|
|
@@ -1351,6 +1357,7 @@ Class | Method | HTTP request | Description
|
|
|
1351
1357
|
- [LaunchDarklyApi::IntegrationDeliveryConfigurationLinks](docs/IntegrationDeliveryConfigurationLinks.md)
|
|
1352
1358
|
- [LaunchDarklyApi::IntegrationDeliveryConfigurationPost](docs/IntegrationDeliveryConfigurationPost.md)
|
|
1353
1359
|
- [LaunchDarklyApi::IntegrationDeliveryConfigurationResponse](docs/IntegrationDeliveryConfigurationResponse.md)
|
|
1360
|
+
- [LaunchDarklyApi::IntegrationDeliveryConfigurationStatus](docs/IntegrationDeliveryConfigurationStatus.md)
|
|
1354
1361
|
- [LaunchDarklyApi::IntegrationMetadata](docs/IntegrationMetadata.md)
|
|
1355
1362
|
- [LaunchDarklyApi::IntegrationStatus](docs/IntegrationStatus.md)
|
|
1356
1363
|
- [LaunchDarklyApi::IntegrationStatusRep](docs/IntegrationStatusRep.md)
|
|
@@ -1360,6 +1367,7 @@ Class | Method | HTTP request | Description
|
|
|
1360
1367
|
- [LaunchDarklyApi::IpAllowlistEntryResponse](docs/IpAllowlistEntryResponse.md)
|
|
1361
1368
|
- [LaunchDarklyApi::IpAllowlistResponse](docs/IpAllowlistResponse.md)
|
|
1362
1369
|
- [LaunchDarklyApi::IpList](docs/IpList.md)
|
|
1370
|
+
- [LaunchDarklyApi::IterationAssignmentDataSourceRep](docs/IterationAssignmentDataSourceRep.md)
|
|
1363
1371
|
- [LaunchDarklyApi::IterationInput](docs/IterationInput.md)
|
|
1364
1372
|
- [LaunchDarklyApi::IterationRep](docs/IterationRep.md)
|
|
1365
1373
|
- [LaunchDarklyApi::JudgeAttachment](docs/JudgeAttachment.md)
|
|
@@ -1440,6 +1448,7 @@ Class | Method | HTTP request | Description
|
|
|
1440
1448
|
- [LaunchDarklyApi::PatchSegmentExpiringTargetInstruction](docs/PatchSegmentExpiringTargetInstruction.md)
|
|
1441
1449
|
- [LaunchDarklyApi::PatchSegmentInstruction](docs/PatchSegmentInstruction.md)
|
|
1442
1450
|
- [LaunchDarklyApi::PatchSegmentRequest](docs/PatchSegmentRequest.md)
|
|
1451
|
+
- [LaunchDarklyApi::PatchSegmentScheduledChangeInput](docs/PatchSegmentScheduledChangeInput.md)
|
|
1443
1452
|
- [LaunchDarklyApi::PatchUsersRequest](docs/PatchUsersRequest.md)
|
|
1444
1453
|
- [LaunchDarklyApi::PatchWithComment](docs/PatchWithComment.md)
|
|
1445
1454
|
- [LaunchDarklyApi::PermissionGrantInput](docs/PermissionGrantInput.md)
|
|
@@ -1459,6 +1468,7 @@ Class | Method | HTTP request | Description
|
|
|
1459
1468
|
- [LaunchDarklyApi::PostFlagScheduledChangesInput](docs/PostFlagScheduledChangesInput.md)
|
|
1460
1469
|
- [LaunchDarklyApi::PostInsightGroupParams](docs/PostInsightGroupParams.md)
|
|
1461
1470
|
- [LaunchDarklyApi::PostReleasePolicyRequest](docs/PostReleasePolicyRequest.md)
|
|
1471
|
+
- [LaunchDarklyApi::PostSegmentScheduledChangeInput](docs/PostSegmentScheduledChangeInput.md)
|
|
1462
1472
|
- [LaunchDarklyApi::Prerequisite](docs/Prerequisite.md)
|
|
1463
1473
|
- [LaunchDarklyApi::ProgressiveReleaseConfig](docs/ProgressiveReleaseConfig.md)
|
|
1464
1474
|
- [LaunchDarklyApi::Project](docs/Project.md)
|
|
@@ -1546,6 +1556,10 @@ Class | Method | HTTP request | Description
|
|
|
1546
1556
|
- [LaunchDarklyApi::SdkVersionRep](docs/SdkVersionRep.md)
|
|
1547
1557
|
- [LaunchDarklyApi::SegmentBody](docs/SegmentBody.md)
|
|
1548
1558
|
- [LaunchDarklyApi::SegmentMetadata](docs/SegmentMetadata.md)
|
|
1559
|
+
- [LaunchDarklyApi::SegmentScheduledChange](docs/SegmentScheduledChange.md)
|
|
1560
|
+
- [LaunchDarklyApi::SegmentScheduledChangeStatus](docs/SegmentScheduledChangeStatus.md)
|
|
1561
|
+
- [LaunchDarklyApi::SegmentScheduledChanges](docs/SegmentScheduledChanges.md)
|
|
1562
|
+
- [LaunchDarklyApi::SegmentScheduledChangesLink](docs/SegmentScheduledChangesLink.md)
|
|
1549
1563
|
- [LaunchDarklyApi::SegmentTarget](docs/SegmentTarget.md)
|
|
1550
1564
|
- [LaunchDarklyApi::SegmentUserList](docs/SegmentUserList.md)
|
|
1551
1565
|
- [LaunchDarklyApi::SegmentUserState](docs/SegmentUserState.md)
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_id** | **String** | The rule ID. Pass it as ruleId in targeting instructions that change this rule. | |
|
|
7
8
|
| **clauses** | [**Array<AIConfigTargetingEnvironmentRuleClause>**](AIConfigTargetingEnvironmentRuleClause.md) | The clauses a context must match | |
|
|
8
9
|
| **track_events** | **Boolean** | Whether to send detailed events for evaluations that match this rule | |
|
|
9
10
|
|
|
@@ -13,6 +14,7 @@
|
|
|
13
14
|
require 'launchdarkly_api'
|
|
14
15
|
|
|
15
16
|
instance = LaunchDarklyApi::AIConfigTargetingEnvironmentRule.new(
|
|
17
|
+
_id: null,
|
|
16
18
|
clauses: null,
|
|
17
19
|
track_events: null
|
|
18
20
|
)
|
data/docs/AgentControlApi.md
CHANGED
|
@@ -2360,7 +2360,8 @@ project_key = 'project_key_example' # String | The project key
|
|
|
2360
2360
|
opts = {
|
|
2361
2361
|
limit: 56, # Integer | The number of resources to return.
|
|
2362
2362
|
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`.
|
|
2363
|
-
filter: 'filter_example' # String | A filter to apply to the list.
|
|
2363
|
+
filter: 'filter_example', # String | A filter to apply to the list.
|
|
2364
|
+
sort: 'sort_example' # String | A sort to apply to the list of agent skills. Use `usedIn` to sort by the number of AgentControl configs that use each skill, fewest first, or `-usedIn` for most first. Without a sort, skills are ordered by creation date, newest first.
|
|
2364
2365
|
}
|
|
2365
2366
|
|
|
2366
2367
|
begin
|
|
@@ -2398,6 +2399,7 @@ end
|
|
|
2398
2399
|
| **limit** | **Integer** | The number of resources to return. | [optional] |
|
|
2399
2400
|
| **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] |
|
|
2400
2401
|
| **filter** | **String** | A filter to apply to the list. | [optional] |
|
|
2402
|
+
| **sort** | **String** | A sort to apply to the list of agent skills. Use `usedIn` to sort by the number of AgentControl configs that use each skill, fewest first, or `-usedIn` for most first. Without a sort, skills are ordered by creation date, newest first. | [optional] |
|
|
2401
2403
|
|
|
2402
2404
|
### Return type
|
|
2403
2405
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LaunchDarklyApi::AssignmentDataSourceInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | The key of the assignment data source to use for this iteration | |
|
|
8
|
+
| **experiment_id** | **String** | The experiment identifier in the assignment data source. You can omit this while the experiment is a draft, but it must be set before you start the experiment. | [optional] |
|
|
9
|
+
| **start_time** | **Integer** | | [optional] |
|
|
10
|
+
| **end_time** | **Integer** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'launchdarkly_api'
|
|
16
|
+
|
|
17
|
+
instance = LaunchDarklyApi::AssignmentDataSourceInput.new(
|
|
18
|
+
key: my-assignment-data-source,
|
|
19
|
+
experiment_id: experiment-123,
|
|
20
|
+
start_time: null,
|
|
21
|
+
end_time: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/docs/AuditLogApi.md
CHANGED
|
@@ -195,6 +195,7 @@ opts = {
|
|
|
195
195
|
limit: 789, # Integer | A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10.
|
|
196
196
|
member: 'member_example', # String | A member ID that lets you filter audit log listings by the member who made the change. Repeat the parameter to filter by multiple members.
|
|
197
197
|
token: 'token_example', # String | An access token ID that lets you filter audit log listings by the token that made the change. Repeat the parameter to filter by multiple tokens.
|
|
198
|
+
rollup: 789, # Integer | Set to 1 to return rolled-up audit log entries, which group related changes into one entry. By default, entries aren't rolled up.
|
|
198
199
|
statement_post: [LaunchDarklyApi::StatementPost.new({effect: 'allow'})] # Array<StatementPost> |
|
|
199
200
|
}
|
|
200
201
|
|
|
@@ -235,6 +236,7 @@ end
|
|
|
235
236
|
| **limit** | **Integer** | A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10. | [optional] |
|
|
236
237
|
| **member** | **String** | A member ID that lets you filter audit log listings by the member who made the change. Repeat the parameter to filter by multiple members. | [optional] |
|
|
237
238
|
| **token** | **String** | An access token ID that lets you filter audit log listings by the token that made the change. Repeat the parameter to filter by multiple tokens. | [optional] |
|
|
239
|
+
| **rollup** | **Integer** | Set to 1 to return rolled-up audit log entries, which group related changes into one entry. By default, entries aren't rolled up. | [optional] |
|
|
238
240
|
| **statement_post** | [**Array<StatementPost>**](StatementPost.md) | | [optional] |
|
|
239
241
|
|
|
240
242
|
### Return type
|
data/docs/Experiment.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **environment_key** | **String** | | |
|
|
14
14
|
| **methodology** | **String** | The results analysis approach. | [optional] |
|
|
15
15
|
| **data_source** | **String** | The source of metric data in order to analyze results. Defaults to \"launchdarkly\" when not provided. | [optional] |
|
|
16
|
+
| **assignment_source_type** | **String** | The source of assignment data for this experiment. Defaults to \"launchdarkly\" when not provided. | [optional] |
|
|
16
17
|
| **archived_date** | **Integer** | | [optional] |
|
|
17
18
|
| **tags** | **Array<String>** | Tags for the experiment | [optional] |
|
|
18
19
|
| **_links** | [**Hash<String, Link>**](Link.md) | The location and content type of related resources | |
|
|
@@ -40,6 +41,7 @@ instance = LaunchDarklyApi::Experiment.new(
|
|
|
40
41
|
environment_key: null,
|
|
41
42
|
methodology: bayesian,
|
|
42
43
|
data_source: snowflake,
|
|
44
|
+
assignment_source_type: snowflake,
|
|
43
45
|
archived_date: null,
|
|
44
46
|
tags: ["experiment","feature"],
|
|
45
47
|
_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"}},
|
data/docs/ExperimentsApi.md
CHANGED
|
@@ -490,7 +490,7 @@ end
|
|
|
490
490
|
|
|
491
491
|
Patch experiment
|
|
492
492
|
|
|
493
|
-
Update an experiment. Updating an experiment uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating experiments. #### updateName > **Deprecated**: `updateName` will be removed in a future version. Use `updateExperimentFields` instead. Updates the experiment name. ##### Parameters - `value`: The new name. Here's an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Example updated experiment name\" }] } ``` #### updateDescription > **Deprecated**: `updateDescription` will be removed in a future version. Use `updateExperimentFields` instead. Updates the experiment description. ##### Parameters - `value`: The new description. Here's an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Example updated description\" }] } ``` #### updateExperimentFields Updates one or more fields on an experiment or its current iteration. Each field update specifies an operation (`add`, `update`, or `remove`) and an optional value. Which fields are mutable depends on the current iteration status. To discover which fields and operations are allowed, expand `mutableFieldsByStatus` on the [Get experiment](https://launchdarkly.com/docs/api/experiments/get-experiment) response. ##### Parameters - `value`: An object mapping field names to field updates. Each field update has the following properties: - `operation`: The operation to perform. One of `add`, `update`, or `remove`. - `value`: The new value for the field. Required for `add` and `update` operations. To find which fields are supported and which operations are allowed for each iteration status, expand `mutableFieldsByStatus` on the [Get experiment](https://launchdarkly.com/docs/api/experiments/get-experiment) response. Here's an example: ```json { \"instructions\": [{ \"kind\": \"updateExperimentFields\", \"value\": { \"name\": { \"operation\": \"update\", \"value\": \"Updated experiment name\" }, \"tags\": { \"operation\": \"add\", \"value\": [\"tag1\", \"tag2\"] } } }] } ``` #### saveAndStartNewIteration Stops the current running iteration, creates a new iteration from it, optionally applies field updates, and starts the new iteration. This is a convenience instruction that combines stopping, updating, and starting in a single operation. ##### Parameters - `changeJustification`: (Optional) The reason for stopping and starting a new iteration. - `value`: (Optional) An object mapping field names to field updates, using the same format as `updateExperimentFields`. These updates are applied to the new iteration before it is started. Here's an example: ```json { \"instructions\": [{ \"kind\": \"saveAndStartNewIteration\", \"changeJustification\": \"Adjusting hypothesis based on early results\", \"value\": { \"hypothesis\": { \"operation\": \"update\", \"value\": \"Updated hypothesis text\" } } }] } ``` #### startIteration Starts a new iteration for this experiment. You must [create a new iteration](https://launchdarkly.com/docs/api/experiments/create-iteration) before calling this instruction. An iteration may not be started until it meets the following criteria: * Its associated flag is toggled on and is not archived * Its `randomizationUnit` is set * At least one of its `treatments` has a non-zero `allocationPercent` ##### Parameters - `changeJustification`: The reason for starting a new iteration. Required when you call `startIteration` on an already running experiment, otherwise optional. Here's an example: ```json { \"instructions\": [{ \"kind\": \"startIteration\", \"changeJustification\": \"It's time to start a new iteration\" }] } ``` #### stopIteration Stops the current iteration for this experiment. ##### Parameters - `winningTreatmentId`: The ID of the winning treatment. Treatment IDs are returned as part of the [Get experiment](https://launchdarkly.com/docs/api/experiments/get-experiment) response. They are the `_id` of each element in the `treatments` array. - `winningReason`: The reason for the winner Here's an example: ```json { \"instructions\": [{ \"kind\": \"stopIteration\", \"winningTreatmentId\": \"3a548ec2-72ac-4e59-8518-5c24f5609ccf\", \"winningReason\": \"Example reason to stop the iteration\" }] } ``` #### archiveExperiment Archives this experiment. Archived experiments are hidden by default in the LaunchDarkly user interface. You cannot start new iterations for archived experiments. Here's an example: ```json { \"instructions\": [{ \"kind\": \"archiveExperiment\" }] } ``` #### restoreExperiment Restores an archived experiment. After restoring an experiment, you can start new iterations for it again. Here's an example: ```json { \"instructions\": [{ \"kind\": \"restoreExperiment\" }] } ```
|
|
493
|
+
Update an experiment. Updating an experiment uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating experiments. #### updateName > **Deprecated**: `updateName` will be removed in a future version. Use `updateExperimentFields` instead. Updates the experiment name. ##### Parameters - `value`: The new name. Here's an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Example updated experiment name\" }] } ``` #### updateDescription > **Deprecated**: `updateDescription` will be removed in a future version. Use `updateExperimentFields` instead. Updates the experiment description. ##### Parameters - `value`: The new description. Here's an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Example updated description\" }] } ``` #### updateExperimentFields Updates one or more fields on an experiment or its current iteration. Each field update specifies an operation (`add`, `update`, or `remove`) and an optional value. Which fields are mutable depends on the current iteration status. To discover which fields and operations are allowed, expand `mutableFieldsByStatus` on the [Get experiment](https://launchdarkly.com/docs/api/experiments/get-experiment) response. ##### Parameters - `value`: An object mapping field names to field updates. Each field update has the following properties: - `operation`: The operation to perform. One of `add`, `update`, or `remove`. - `value`: The new value for the field. Required for `add` and `update` operations. To find which fields are supported and which operations are allowed for each iteration status, expand `mutableFieldsByStatus` on the [Get experiment](https://launchdarkly.com/docs/api/experiments/get-experiment) response. Here's an example: ```json { \"instructions\": [{ \"kind\": \"updateExperimentFields\", \"value\": { \"name\": { \"operation\": \"update\", \"value\": \"Updated experiment name\" }, \"tags\": { \"operation\": \"add\", \"value\": [\"tag1\", \"tag2\"] } } }] } ``` ##### Custom assignment source fields If your experiment reads its assignment data from your data warehouse, two additional fields control the assignment source it uses. Use `assignmentDataSource` to attach an assignment source to an iteration, change which source it points at, or detach it. Its value is an object with the following properties: - `key`: (Required) The key of the assignment data source. - `experimentId`: The experiment identifier in the assignment data source. You can omit this while the experiment is a draft, but you must set it before you start the experiment. - `startTime`: (Optional) The start of the assignment data window, in Unix milliseconds. - `endTime`: (Optional) The end of the assignment data window, in Unix milliseconds. This must be later than `startTime`. To detach the assignment source, send `null` as the value. You can only change this field while the iteration is still a draft. Use `assignmentDataSourceWindow` to change only the dates on an assignment source that is already attached. Its value is an object with the same `startTime` and `endTime` properties. The iteration must already have an assignment source. This is how you adjust the dates after an iteration has run, because the source itself is fixed at that point. Multi-armed bandits use flags for assignment, so they support neither field. Here's an example: ```json { \"instructions\": [{ \"kind\": \"updateExperimentFields\", \"value\": { \"assignmentDataSource\": { \"operation\": \"update\", \"value\": { \"key\": \"my-assignment-data-source\", \"experimentId\": \"experiment-123\", \"startTime\": 1690000000000, \"endTime\": 1690600000000 } } } }] } ``` #### saveAndStartNewIteration Stops the current running iteration, creates a new iteration from it, optionally applies field updates, and starts the new iteration. This is a convenience instruction that combines stopping, updating, and starting in a single operation. ##### Parameters - `changeJustification`: (Optional) The reason for stopping and starting a new iteration. - `value`: (Optional) An object mapping field names to field updates, using the same format as `updateExperimentFields`. These updates are applied to the new iteration before it is started. Here's an example: ```json { \"instructions\": [{ \"kind\": \"saveAndStartNewIteration\", \"changeJustification\": \"Adjusting hypothesis based on early results\", \"value\": { \"hypothesis\": { \"operation\": \"update\", \"value\": \"Updated hypothesis text\" } } }] } ``` #### startIteration Starts a new iteration for this experiment. You must [create a new iteration](https://launchdarkly.com/docs/api/experiments/create-iteration) before calling this instruction. An iteration may not be started until it meets the following criteria: * Its associated flag is toggled on and is not archived * Its `randomizationUnit` is set * At least one of its `treatments` has a non-zero `allocationPercent` ##### Parameters - `changeJustification`: The reason for starting a new iteration. Required when you call `startIteration` on an already running experiment, otherwise optional. Here's an example: ```json { \"instructions\": [{ \"kind\": \"startIteration\", \"changeJustification\": \"It's time to start a new iteration\" }] } ``` #### stopIteration Stops the current iteration for this experiment. ##### Parameters - `winningTreatmentId`: The ID of the winning treatment. Treatment IDs are returned as part of the [Get experiment](https://launchdarkly.com/docs/api/experiments/get-experiment) response. They are the `_id` of each element in the `treatments` array. - `winningReason`: The reason for the winner Here's an example: ```json { \"instructions\": [{ \"kind\": \"stopIteration\", \"winningTreatmentId\": \"3a548ec2-72ac-4e59-8518-5c24f5609ccf\", \"winningReason\": \"Example reason to stop the iteration\" }] } ``` #### archiveExperiment Archives this experiment. Archived experiments are hidden by default in the LaunchDarkly user interface. You cannot start new iterations for archived experiments. Here's an example: ```json { \"instructions\": [{ \"kind\": \"archiveExperiment\" }] } ``` #### restoreExperiment Restores an archived experiment. After restoring an experiment, you can start new iterations for it again. Here's an example: ```json { \"instructions\": [{ \"kind\": \"restoreExperiment\" }] } ```
|
|
494
494
|
|
|
495
495
|
### Examples
|
|
496
496
|
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
| **name** | **String** | Name of the configuration | |
|
|
16
16
|
| **version** | **Integer** | Version of the current configuration | |
|
|
17
17
|
| **_access** | [**Access**](Access.md) | | [optional] |
|
|
18
|
+
| **_status** | [**IntegrationDeliveryConfigurationStatus**](IntegrationDeliveryConfigurationStatus.md) | | [optional] |
|
|
18
19
|
|
|
19
20
|
## Example
|
|
20
21
|
|
|
@@ -32,7 +33,8 @@ instance = LaunchDarklyApi::IntegrationDeliveryConfiguration.new(
|
|
|
32
33
|
tags: [],
|
|
33
34
|
name: Development environment configuration,
|
|
34
35
|
version: 1,
|
|
35
|
-
_access: null
|
|
36
|
+
_access: null,
|
|
37
|
+
_status: null
|
|
36
38
|
)
|
|
37
39
|
```
|
|
38
40
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# LaunchDarklyApi::IntegrationDeliveryConfigurationStatus
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **available** | **Boolean** | Whether the latest sync succeeded | |
|
|
8
|
+
| **potentially_stale** | **Boolean** | Whether the feature store may be missing flag data from a failed or in-progress sync | |
|
|
9
|
+
| **last_sync** | **Integer** | | [optional] |
|
|
10
|
+
| **last_error** | **Integer** | | [optional] |
|
|
11
|
+
| **errors** | [**Array<StoreIntegrationError>**](StoreIntegrationError.md) | Recent failed sync responses. Successful (200) and in-progress (202) responses are omitted. Included only when fetching a single configuration by ID. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'launchdarkly_api'
|
|
17
|
+
|
|
18
|
+
instance = LaunchDarklyApi::IntegrationDeliveryConfigurationStatus.new(
|
|
19
|
+
available: false,
|
|
20
|
+
potentially_stale: true,
|
|
21
|
+
last_sync: null,
|
|
22
|
+
last_error: null,
|
|
23
|
+
errors: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/IntegrationsBetaApi.md
CHANGED
|
@@ -17,7 +17,7 @@ All URIs are relative to *https://app.launchdarkly.com*
|
|
|
17
17
|
|
|
18
18
|
Create integration configuration
|
|
19
19
|
|
|
20
|
-
Create a new integration configuration.
|
|
20
|
+
Create a new integration configuration. This endpoint does not include persistent store integrations or flag import configurations. To manage those, use the [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configuration](https://launchdarkly.com/docs/api/flag-import-configurations-beta) endpoints.
|
|
21
21
|
|
|
22
22
|
### Examples
|
|
23
23
|
|
|
@@ -90,7 +90,7 @@ end
|
|
|
90
90
|
|
|
91
91
|
Delete integration configuration
|
|
92
92
|
|
|
93
|
-
Delete an integration configuration by ID.
|
|
93
|
+
Delete an integration configuration by ID. This endpoint does not include persistent store integrations or flag import configurations. To manage those, use the [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configuration](https://launchdarkly.com/docs/api/flag-import-configurations-beta) endpoints.
|
|
94
94
|
|
|
95
95
|
### Examples
|
|
96
96
|
|
|
@@ -160,7 +160,7 @@ nil (empty response body)
|
|
|
160
160
|
|
|
161
161
|
Get all configurations for the integration
|
|
162
162
|
|
|
163
|
-
Get all integration configurations with the specified integration key.
|
|
163
|
+
Get all integration configurations with the specified integration key. This endpoint does not include persistent store integrations or flag import configurations. To manage those, use the [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configuration](https://launchdarkly.com/docs/api/flag-import-configurations-beta) endpoints.
|
|
164
164
|
|
|
165
165
|
### Examples
|
|
166
166
|
|
|
@@ -235,7 +235,7 @@ end
|
|
|
235
235
|
|
|
236
236
|
Get an integration configuration
|
|
237
237
|
|
|
238
|
-
Get integration configuration with the specified ID.
|
|
238
|
+
Get integration configuration with the specified ID. This endpoint does not include persistent store integrations or flag import configurations. To manage those, use the [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configuration](https://launchdarkly.com/docs/api/flag-import-configurations-beta) endpoints.
|
|
239
239
|
|
|
240
240
|
### Examples
|
|
241
241
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# LaunchDarklyApi::IterationAssignmentDataSourceRep
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | The key of the assignment data source used for this iteration | |
|
|
8
|
+
| **name** | **String** | The display name of the assignment data source | |
|
|
9
|
+
| **experiment_id** | **String** | The experiment identifier in the assignment data source | |
|
|
10
|
+
| **start_time** | **Integer** | | [optional] |
|
|
11
|
+
| **end_time** | **Integer** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'launchdarkly_api'
|
|
17
|
+
|
|
18
|
+
instance = LaunchDarklyApi::IterationAssignmentDataSourceRep.new(
|
|
19
|
+
key: my-assignment-data-source,
|
|
20
|
+
name: Snowflake production assignments,
|
|
21
|
+
experiment_id: experiment-123,
|
|
22
|
+
start_time: null,
|
|
23
|
+
end_time: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/IterationInput.md
CHANGED
|
@@ -11,10 +11,11 @@
|
|
|
11
11
|
| **primary_funnel_key** | **String** | The key of the primary funnel group for this experiment. Either <code>primarySingleMetricKey</code> or <code>primaryFunnelKey</code> must be present. | [optional] |
|
|
12
12
|
| **treatments** | [**Array<TreatmentInput>**](TreatmentInput.md) | | |
|
|
13
13
|
| **flags** | [**Hash<String, FlagInput>**](FlagInput.md) | | |
|
|
14
|
+
| **assignment_data_source** | [**AssignmentDataSourceInput**](AssignmentDataSourceInput.md) | | [optional] |
|
|
14
15
|
| **randomization_unit** | **String** | The unit of randomization for this iteration. Defaults to user. | [optional] |
|
|
15
16
|
| **reallocation_frequency_millis** | **Integer** | The cadence (in milliseconds) to update the allocation. | [optional] |
|
|
16
17
|
| **covariate_id** | **String** | The ID of the covariate CSV | [optional] |
|
|
17
|
-
| **attributes** | **Array<String>** | The attributes that this iteration's results can be sliced by | [optional] |
|
|
18
|
+
| **attributes** | **Array<String>** | The attributes that this iteration's results can be sliced by, whose values come from flag evaluation events | [optional] |
|
|
18
19
|
|
|
19
20
|
## Example
|
|
20
21
|
|
|
@@ -29,6 +30,7 @@ instance = LaunchDarklyApi::IterationInput.new(
|
|
|
29
30
|
primary_funnel_key: metric-group-key-123abc,
|
|
30
31
|
treatments: null,
|
|
31
32
|
flags: null,
|
|
33
|
+
assignment_data_source: null,
|
|
32
34
|
randomization_unit: user,
|
|
33
35
|
reallocation_frequency_millis: 3600000,
|
|
34
36
|
covariate_id: null,
|
data/docs/IterationRep.md
CHANGED
|
@@ -20,12 +20,13 @@
|
|
|
20
20
|
| **primary_single_metric** | [**MetricV2Rep**](MetricV2Rep.md) | | [optional] |
|
|
21
21
|
| **primary_funnel** | [**DependentMetricGroupRepWithMetrics**](DependentMetricGroupRepWithMetrics.md) | | [optional] |
|
|
22
22
|
| **randomization_unit** | **String** | The unit of randomization for this iteration | [optional] |
|
|
23
|
-
| **attributes** | **Array<String>** | The
|
|
23
|
+
| **attributes** | **Array<String>** | The attributes this iteration slices results by, whose values come from flag evaluation events. | [optional] |
|
|
24
24
|
| **treatments** | [**Array<TreatmentRep>**](TreatmentRep.md) | Details on the variations you are testing in the experiment | [optional] |
|
|
25
25
|
| **secondary_metrics** | [**Array<MetricV2Rep>**](MetricV2Rep.md) | Deprecated, use <code>metrics</code> instead. Details on the secondary metrics for this experiment. | [optional] |
|
|
26
26
|
| **metrics** | [**Array<DependentMetricOrMetricGroupRep>**](DependentMetricOrMetricGroupRep.md) | Details on the metrics for this experiment | [optional] |
|
|
27
27
|
| **layer_snapshot** | [**LayerSnapshotRep**](LayerSnapshotRep.md) | | [optional] |
|
|
28
28
|
| **covariate_info** | [**CovariateInfoRep**](CovariateInfoRep.md) | | [optional] |
|
|
29
|
+
| **assignment_data_source** | [**IterationAssignmentDataSourceRep**](IterationAssignmentDataSourceRep.md) | | [optional] |
|
|
29
30
|
|
|
30
31
|
## Example
|
|
31
32
|
|
|
@@ -54,7 +55,8 @@ instance = LaunchDarklyApi::IterationRep.new(
|
|
|
54
55
|
secondary_metrics: null,
|
|
55
56
|
metrics: null,
|
|
56
57
|
layer_snapshot: null,
|
|
57
|
-
covariate_info: null
|
|
58
|
+
covariate_info: null,
|
|
59
|
+
assignment_data_source: null
|
|
58
60
|
)
|
|
59
61
|
```
|
|
60
62
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# LaunchDarklyApi::PatchSegmentScheduledChangeInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **execution_date** | **Integer** | | [optional] |
|
|
8
|
+
| **comment** | **String** | The new comment describing the scheduled change. Leave out to keep the current comment, or send an empty string to clear it. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'launchdarkly_api'
|
|
14
|
+
|
|
15
|
+
instance = LaunchDarklyApi::PatchSegmentScheduledChangeInput.new(
|
|
16
|
+
execution_date: null,
|
|
17
|
+
comment: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# LaunchDarklyApi::PostSegmentScheduledChangeInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **execution_date** | **Integer** | | |
|
|
8
|
+
| **comment** | **String** | Optional comment describing the scheduled change | [optional] |
|
|
9
|
+
| **instructions** | **Array<Hash>** | The segment semantic patch instructions to apply on the execution date | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'launchdarkly_api'
|
|
15
|
+
|
|
16
|
+
instance = LaunchDarklyApi::PostSegmentScheduledChangeInput.new(
|
|
17
|
+
execution_date: null,
|
|
18
|
+
comment: null,
|
|
19
|
+
instructions: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# LaunchDarklyApi::SegmentScheduledChange
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_links** | [**Hash<String, SegmentScheduledChangesLink>**](SegmentScheduledChangesLink.md) | The location and content type of related resources | |
|
|
8
|
+
| **status** | [**SegmentScheduledChangeStatus**](SegmentScheduledChangeStatus.md) | | |
|
|
9
|
+
| **_id** | **String** | The ID of this scheduled change | |
|
|
10
|
+
| **_creation_date** | **Integer** | | |
|
|
11
|
+
| **_maintainer_id** | **String** | The ID of the member who scheduled the change | [optional] |
|
|
12
|
+
| **_maintainer_service_token_id** | **String** | The ID of the service token that scheduled the change | [optional] |
|
|
13
|
+
| **execution_date** | **Integer** | | |
|
|
14
|
+
| **comment** | **String** | The comment describing the scheduled change | [optional] |
|
|
15
|
+
| **instructions** | **Array<Hash>** | The segment semantic patch instructions to apply on the execution date | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'launchdarkly_api'
|
|
21
|
+
|
|
22
|
+
instance = LaunchDarklyApi::SegmentScheduledChange.new(
|
|
23
|
+
_links: null,
|
|
24
|
+
status: null,
|
|
25
|
+
_id: null,
|
|
26
|
+
_creation_date: null,
|
|
27
|
+
_maintainer_id: null,
|
|
28
|
+
_maintainer_service_token_id: null,
|
|
29
|
+
execution_date: null,
|
|
30
|
+
comment: null,
|
|
31
|
+
instructions: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# LaunchDarklyApi::SegmentScheduledChangeStatus
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'launchdarkly_api'
|
|
12
|
+
|
|
13
|
+
instance = LaunchDarklyApi::SegmentScheduledChangeStatus.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# LaunchDarklyApi::SegmentScheduledChanges
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_links** | [**Hash<String, SegmentScheduledChangesLink>**](SegmentScheduledChangesLink.md) | The location and content type of related resources | |
|
|
8
|
+
| **items** | [**Array<SegmentScheduledChange>**](SegmentScheduledChange.md) | The segment's scheduled changes that have not been applied yet, plus any that failed to apply, soonest first | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'launchdarkly_api'
|
|
14
|
+
|
|
15
|
+
instance = LaunchDarklyApi::SegmentScheduledChanges.new(
|
|
16
|
+
_links: null,
|
|
17
|
+
items: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# LaunchDarklyApi::SegmentScheduledChangesLink
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **href** | **String** | | [optional] |
|
|
8
|
+
| **type** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'launchdarkly_api'
|
|
14
|
+
|
|
15
|
+
instance = LaunchDarklyApi::SegmentScheduledChangesLink.new(
|
|
16
|
+
href: null,
|
|
17
|
+
type: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|