Skip to content

Commit 4d80f8b

Browse files
author
LaunchDarklyCI
committed
Version 5.1.0 automatically generated from ld-openapi@c4d960a.
1 parent 6255639 commit 4d80f8b

File tree

321 files changed

+2562
-326
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

321 files changed

+2562
-326
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Build custom integrations with the LaunchDarkly REST API
88

99
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
1010

11-
- API version: 5.0.3
12-
- Package version: 5.0.3
11+
- API version: 5.1.0
12+
- Package version: 5.1.0
1313
- Build package: io.swagger.codegen.languages.PythonClientCodegen
1414
For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
1515

@@ -119,6 +119,8 @@ Class | Method | HTTP request | Description
119119
*FeatureFlagsApi* | [**delete_approval_request**](docs/FeatureFlagsApi.md#delete_approval_request) | **DELETE** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Delete an approval request for a feature flag config
120120
*FeatureFlagsApi* | [**delete_feature_flag**](docs/FeatureFlagsApi.md#delete_feature_flag) | **DELETE** /flags/{projectKey}/{featureFlagKey} | Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
121121
*FeatureFlagsApi* | [**delete_flag_config_scheduled_changes**](docs/FeatureFlagsApi.md#delete_flag_config_scheduled_changes) | **DELETE** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Delete a scheduled change on a feature flag in an environment.
122+
*FeatureFlagsApi* | [**flags_project_key_environment_key_feature_flag_key_dependent_flags_get**](docs/FeatureFlagsApi.md#flags_project_key_environment_key_feature_flag_key_dependent_flags_get) | **GET** /flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags | Get dependent flags for the flag in the environment specified in path parameters
123+
*FeatureFlagsApi* | [**flags_project_key_feature_flag_key_dependent_flags_get**](docs/FeatureFlagsApi.md#flags_project_key_feature_flag_key_dependent_flags_get) | **GET** /flags/{projectKey}/{featureFlagKey}/dependent-flags | Get dependent flags across all environments for the flag specified in the path parameters
122124
*FeatureFlagsApi* | [**get_approval_request**](docs/FeatureFlagsApi.md#get_approval_request) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Get a single approval request for a feature flag config
123125
*FeatureFlagsApi* | [**get_approval_requests**](docs/FeatureFlagsApi.md#get_approval_requests) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Get all approval requests for a feature flag config
124126
*FeatureFlagsApi* | [**get_expiring_user_targets**](docs/FeatureFlagsApi.md#get_expiring_user_targets) | **GET** /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Get expiring user targets for feature flag
@@ -169,7 +171,7 @@ Class | Method | HTTP request | Description
169171
*UserSegmentsApi* | [**patch_expiring_user_targets_on_segment**](docs/UserSegmentsApi.md#patch_expiring_user_targets_on_segment) | **PATCH** /segments/{projectKey}/{userSegmentKey}/expiring-user-targets/{environmentKey} | Update, add, or delete expiring user targets on user segment
170172
*UserSegmentsApi* | [**patch_user_segment**](docs/UserSegmentsApi.md#patch_user_segment) | **PATCH** /segments/{projectKey}/{environmentKey}/{userSegmentKey} | Perform a partial update to a user segment.
171173
*UserSegmentsApi* | [**post_user_segment**](docs/UserSegmentsApi.md#post_user_segment) | **POST** /segments/{projectKey}/{environmentKey} | Creates a new user segment.
172-
*UserSegmentsApi* | [**updated_big_segment_targets**](docs/UserSegmentsApi.md#updated_big_segment_targets) | **POST** /segments/{projectKey}/{environmentKey}/{userSegmentKey}/users | Update targets included or excluded in a big segment
174+
*UserSegmentsApi* | [**update_big_segment_targets**](docs/UserSegmentsApi.md#update_big_segment_targets) | **POST** /segments/{projectKey}/{environmentKey}/{userSegmentKey}/users | Update targets included or excluded in a big segment
173175
*UserSettingsApi* | [**get_expiring_user_targets_for_user**](docs/UserSettingsApi.md#get_expiring_user_targets_for_user) | **GET** /users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey} | Get expiring dates on flags for user
174176
*UserSettingsApi* | [**get_user_flag_setting**](docs/UserSettingsApi.md#get_user_flag_setting) | **GET** /users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} | Fetch a single flag setting for a user by key.
175177
*UserSettingsApi* | [**get_user_flag_settings**](docs/UserSettingsApi.md#get_user_flag_settings) | **GET** /users/{projectKey}/{environmentKey}/{userKey}/flags | Fetch a single flag setting for a user by key.
@@ -209,6 +211,12 @@ Class | Method | HTTP request | Description
209211
- [CustomRoleBody](docs/CustomRoleBody.md)
210212
- [CustomRoles](docs/CustomRoles.md)
211213
- [Defaults](docs/Defaults.md)
214+
- [DependentFlag](docs/DependentFlag.md)
215+
- [DependentFlagEnvironment](docs/DependentFlagEnvironment.md)
216+
- [DependentFlagEnvironmentLinks](docs/DependentFlagEnvironmentLinks.md)
217+
- [DependentFlagLinks](docs/DependentFlagLinks.md)
218+
- [DependentFlagsByEnvironment](docs/DependentFlagsByEnvironment.md)
219+
- [DependentFlagsLinks](docs/DependentFlagsLinks.md)
212220
- [Destination](docs/Destination.md)
213221
- [DestinationAmazonKinesis](docs/DestinationAmazonKinesis.md)
214222
- [DestinationBody](docs/DestinationBody.md)
@@ -244,7 +252,6 @@ Class | Method | HTTP request | Description
244252
- [HierarchicalLinks](docs/HierarchicalLinks.md)
245253
- [Id](docs/Id.md)
246254
- [Integration](docs/Integration.md)
247-
- [IntegrationLinks](docs/IntegrationLinks.md)
248255
- [IntegrationSubscription](docs/IntegrationSubscription.md)
249256
- [IntegrationSubscriptionStatus](docs/IntegrationSubscriptionStatus.md)
250257
- [Integrations](docs/Integrations.md)
@@ -257,6 +264,8 @@ Class | Method | HTTP request | Description
257264
- [MemberLastSeenMetadata](docs/MemberLastSeenMetadata.md)
258265
- [Members](docs/Members.md)
259266
- [MembersBody](docs/MembersBody.md)
267+
- [MultiEnvironmentDependentFlag](docs/MultiEnvironmentDependentFlag.md)
268+
- [MultiEnvironmentDependentFlags](docs/MultiEnvironmentDependentFlags.md)
260269
- [PatchComment](docs/PatchComment.md)
261270
- [PatchOperation](docs/PatchOperation.md)
262271
- [Policy](docs/Policy.md)

docs/DependentFlag.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# DependentFlag
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **str** | | [optional]
7+
**key** | **str** | | [optional]
8+
**links** | [**DependentFlagLinks**](DependentFlagLinks.md) | | [optional]
9+
**site** | [**Site**](Site.md) | | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

docs/DependentFlagEnvironment.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# DependentFlagEnvironment
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **str** | | [optional]
7+
**key** | **str** | | [optional]
8+
**links** | [**DependentFlagEnvironmentLinks**](DependentFlagEnvironmentLinks.md) | | [optional]
9+
**site** | [**Site**](Site.md) | | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

docs/DependentFlagEnvironmentLinks.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# DependentFlagEnvironmentLinks
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**_self** | [**Link**](Link.md) | | [optional]
7+
**flag_link** | [**Link**](Link.md) | | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

docs/DependentFlagLinks.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# DependentFlagLinks
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**_self** | [**Link**](Link.md) | | [optional]
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

docs/DependentFlagsByEnvironment.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# DependentFlagsByEnvironment
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**items** | [**list[DependentFlag]**](DependentFlag.md) | | [optional]
7+
**links** | [**DependentFlagsLinks**](DependentFlagsLinks.md) | | [optional]
8+
**site** | [**Site**](Site.md) | | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

docs/DependentFlagsLinks.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# DependentFlagsLinks
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**parent** | [**Link**](Link.md) | | [optional]
7+
**_self** | [**Link**](Link.md) | | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

docs/FeatureFlagsApi.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Method | HTTP request | Description
88
[**delete_approval_request**](FeatureFlagsApi.md#delete_approval_request) | **DELETE** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Delete an approval request for a feature flag config
99
[**delete_feature_flag**](FeatureFlagsApi.md#delete_feature_flag) | **DELETE** /flags/{projectKey}/{featureFlagKey} | Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
1010
[**delete_flag_config_scheduled_changes**](FeatureFlagsApi.md#delete_flag_config_scheduled_changes) | **DELETE** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Delete a scheduled change on a feature flag in an environment.
11+
[**flags_project_key_environment_key_feature_flag_key_dependent_flags_get**](FeatureFlagsApi.md#flags_project_key_environment_key_feature_flag_key_dependent_flags_get) | **GET** /flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags | Get dependent flags for the flag in the environment specified in path parameters
12+
[**flags_project_key_feature_flag_key_dependent_flags_get**](FeatureFlagsApi.md#flags_project_key_feature_flag_key_dependent_flags_get) | **GET** /flags/{projectKey}/{featureFlagKey}/dependent-flags | Get dependent flags across all environments for the flag specified in the path parameters
1113
[**get_approval_request**](FeatureFlagsApi.md#get_approval_request) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Get a single approval request for a feature flag config
1214
[**get_approval_requests**](FeatureFlagsApi.md#get_approval_requests) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Get all approval requests for a feature flag config
1315
[**get_expiring_user_targets**](FeatureFlagsApi.md#get_expiring_user_targets) | **GET** /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Get expiring user targets for feature flag
@@ -254,6 +256,116 @@ void (empty response body)
254256

255257
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
256258

259+
# **flags_project_key_environment_key_feature_flag_key_dependent_flags_get**
260+
> DependentFlagsByEnvironment flags_project_key_environment_key_feature_flag_key_dependent_flags_get(project_key, environment_key, feature_flag_key)
261+
262+
Get dependent flags for the flag in the environment specified in path parameters
263+
264+
### Example
265+
```python
266+
from __future__ import print_function
267+
import time
268+
import launchdarkly_api
269+
from launchdarkly_api.rest import ApiException
270+
from pprint import pprint
271+
272+
# Configure API key authorization: Token
273+
configuration = launchdarkly_api.Configuration()
274+
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
275+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
276+
# configuration.api_key_prefix['Authorization'] = 'Bearer'
277+
278+
# create an instance of the API class
279+
api_instance = launchdarkly_api.FeatureFlagsApi(launchdarkly_api.ApiClient(configuration))
280+
project_key = 'project_key_example' # str | The project key, used to tie the flags together under one project so they can be managed together.
281+
environment_key = 'environment_key_example' # str | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
282+
feature_flag_key = 'feature_flag_key_example' # str | The feature flag's key. The key identifies the flag in your code.
283+
284+
try:
285+
# Get dependent flags for the flag in the environment specified in path parameters
286+
api_response = api_instance.flags_project_key_environment_key_feature_flag_key_dependent_flags_get(project_key, environment_key, feature_flag_key)
287+
pprint(api_response)
288+
except ApiException as e:
289+
print("Exception when calling FeatureFlagsApi->flags_project_key_environment_key_feature_flag_key_dependent_flags_get: %s\n" % e)
290+
```
291+
292+
### Parameters
293+
294+
Name | Type | Description | Notes
295+
------------- | ------------- | ------------- | -------------
296+
**project_key** | **str**| The project key, used to tie the flags together under one project so they can be managed together. |
297+
**environment_key** | **str**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
298+
**feature_flag_key** | **str**| The feature flag's key. The key identifies the flag in your code. |
299+
300+
### Return type
301+
302+
[**DependentFlagsByEnvironment**](DependentFlagsByEnvironment.md)
303+
304+
### Authorization
305+
306+
[Token](../README.md#Token)
307+
308+
### HTTP request headers
309+
310+
- **Content-Type**: application/json
311+
- **Accept**: application/json
312+
313+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
314+
315+
# **flags_project_key_feature_flag_key_dependent_flags_get**
316+
> MultiEnvironmentDependentFlags flags_project_key_feature_flag_key_dependent_flags_get(project_key, feature_flag_key)
317+
318+
Get dependent flags across all environments for the flag specified in the path parameters
319+
320+
### Example
321+
```python
322+
from __future__ import print_function
323+
import time
324+
import launchdarkly_api
325+
from launchdarkly_api.rest import ApiException
326+
from pprint import pprint
327+
328+
# Configure API key authorization: Token
329+
configuration = launchdarkly_api.Configuration()
330+
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
331+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
332+
# configuration.api_key_prefix['Authorization'] = 'Bearer'
333+
334+
# create an instance of the API class
335+
api_instance = launchdarkly_api.FeatureFlagsApi(launchdarkly_api.ApiClient(configuration))
336+
project_key = 'project_key_example' # str | The project key, used to tie the flags together under one project so they can be managed together.
337+
feature_flag_key = 'feature_flag_key_example' # str | The feature flag's key. The key identifies the flag in your code.
338+
339+
try:
340+
# Get dependent flags across all environments for the flag specified in the path parameters
341+
api_response = api_instance.flags_project_key_feature_flag_key_dependent_flags_get(project_key, feature_flag_key)
342+
pprint(api_response)
343+
except ApiException as e:
344+
print("Exception when calling FeatureFlagsApi->flags_project_key_feature_flag_key_dependent_flags_get: %s\n" % e)
345+
```
346+
347+
### Parameters
348+
349+
Name | Type | Description | Notes
350+
------------- | ------------- | ------------- | -------------
351+
**project_key** | **str**| The project key, used to tie the flags together under one project so they can be managed together. |
352+
**feature_flag_key** | **str**| The feature flag's key. The key identifies the flag in your code. |
353+
354+
### Return type
355+
356+
[**MultiEnvironmentDependentFlags**](MultiEnvironmentDependentFlags.md)
357+
358+
### Authorization
359+
360+
[Token](../README.md#Token)
361+
362+
### HTTP request headers
363+
364+
- **Content-Type**: application/json
365+
- **Accept**: application/json
366+
367+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
368+
257369
# **get_approval_request**
258370
> ApprovalRequests get_approval_request(project_key, feature_flag_key, environment_key, approval_request_id)
259371

docs/Integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**links** | [**IntegrationLinks**](IntegrationLinks.md) | | [optional]
6+
**links** | [**DependentFlagLinks**](DependentFlagLinks.md) | | [optional]
77
**items** | [**list[IntegrationSubscription]**](IntegrationSubscription.md) | | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/MultiEnvironmentDependentFlag.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# MultiEnvironmentDependentFlag
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **str** | | [optional]
7+
**key** | **str** | | [optional]
8+
**environments** | [**list[DependentFlagEnvironment]**](DependentFlagEnvironment.md) | | [optional]
9+
**links** | [**DependentFlagsLinks**](DependentFlagsLinks.md) | | [optional]
10+
**site** | [**Site**](Site.md) | | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

0 commit comments

Comments
 (0)