Skip to content

Commit d876572

Browse files
author
LaunchDarklyCI
committed
Version 5.0.0 automatically generated from ld-openapi@eae1d69.
1 parent 15a2ed4 commit d876572

File tree

312 files changed

+4820
-914
lines changed

Some content is hidden

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

312 files changed

+4820
-914
lines changed

README.md

Lines changed: 26 additions & 16 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: 4.0.0
12-
- Package version: 4.0.0
11+
- API version: 5.0.0
12+
- Package version: 5.0.0
1313
- Build package: io.swagger.codegen.languages.PythonClientCodegen
1414
For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
1515

@@ -116,22 +116,28 @@ Class | Method | HTTP request | Description
116116
*EnvironmentsApi* | [**reset_environment_mobile_key**](docs/EnvironmentsApi.md#reset_environment_mobile_key) | **POST** /projects/{projectKey}/environments/{environmentKey}/mobileKey | Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.
117117
*EnvironmentsApi* | [**reset_environment_sdk_key**](docs/EnvironmentsApi.md#reset_environment_sdk_key) | **POST** /projects/{projectKey}/environments/{environmentKey}/apiKey | Reset an environment's SDK key with an optional expiry time for the old key.
118118
*FeatureFlagsApi* | [**copy_feature_flag**](docs/FeatureFlagsApi.md#copy_feature_flag) | **POST** /flags/{projectKey}/{featureFlagKey}/copy | Copies the feature flag configuration from one environment to the same feature flag in another environment.
119+
*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
119120
*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.
120-
*FeatureFlagsApi* | [**delete_feature_flag_approval_request**](docs/FeatureFlagsApi.md#delete_feature_flag_approval_request) | **DELETE** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagApprovalRequestId} | Delete an approval request for a feature flag
121+
*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* | [**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
123+
*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
121124
*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
122125
*FeatureFlagsApi* | [**get_feature_flag**](docs/FeatureFlagsApi.md#get_feature_flag) | **GET** /flags/{projectKey}/{featureFlagKey} | Get a single feature flag by key.
123-
*FeatureFlagsApi* | [**get_feature_flag_approval_request**](docs/FeatureFlagsApi.md#get_feature_flag_approval_request) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagApprovalRequestId} | Get a single approval request for a feature flag
124-
*FeatureFlagsApi* | [**get_feature_flag_approval_requests**](docs/FeatureFlagsApi.md#get_feature_flag_approval_requests) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Get all approval requests for a feature flag
125126
*FeatureFlagsApi* | [**get_feature_flag_status**](docs/FeatureFlagsApi.md#get_feature_flag_status) | **GET** /flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey} | Get the status for a particular feature flag.
126127
*FeatureFlagsApi* | [**get_feature_flag_status_across_environments**](docs/FeatureFlagsApi.md#get_feature_flag_status_across_environments) | **GET** /flag-status/{projectKey}/{featureFlagKey} | Get the status for a particular feature flag across environments
127128
*FeatureFlagsApi* | [**get_feature_flag_statuses**](docs/FeatureFlagsApi.md#get_feature_flag_statuses) | **GET** /flag-statuses/{projectKey}/{environmentKey} | Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as the state of the flag.
128129
*FeatureFlagsApi* | [**get_feature_flags**](docs/FeatureFlagsApi.md#get_feature_flags) | **GET** /flags/{projectKey} | Get a list of all features in the given project.
130+
*FeatureFlagsApi* | [**get_flag_config_scheduled_change**](docs/FeatureFlagsApi.md#get_flag_config_scheduled_change) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Get a scheduled change on a feature flag by id.
131+
*FeatureFlagsApi* | [**get_flag_config_scheduled_changes**](docs/FeatureFlagsApi.md#get_flag_config_scheduled_changes) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes | Get all scheduled workflows for a feature flag by key.
132+
*FeatureFlagsApi* | [**get_flag_config_scheduled_changes_conflicts**](docs/FeatureFlagsApi.md#get_flag_config_scheduled_changes_conflicts) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes-conflicts | Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
129133
*FeatureFlagsApi* | [**patch_expiring_user_targets**](docs/FeatureFlagsApi.md#patch_expiring_user_targets) | **PATCH** /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Update, add, or delete expiring user targets on feature flag
130134
*FeatureFlagsApi* | [**patch_feature_flag**](docs/FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /flags/{projectKey}/{featureFlagKey} | Perform a partial update to a feature.
131-
*FeatureFlagsApi* | [**post_apply_feature_flag_approval_request**](docs/FeatureFlagsApi.md#post_apply_feature_flag_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagApprovalRequestId}/apply | Apply approval request for a feature flag
135+
*FeatureFlagsApi* | [**patch_flag_config_scheduled_change**](docs/FeatureFlagsApi.md#patch_flag_config_scheduled_change) | **PATCH** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Updates an existing scheduled-change on a feature flag in an environment.
136+
*FeatureFlagsApi* | [**post_apply_approval_request**](docs/FeatureFlagsApi.md#post_apply_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/apply | Apply approval request for a feature flag config
137+
*FeatureFlagsApi* | [**post_approval_request**](docs/FeatureFlagsApi.md#post_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Create an approval request for a feature flag config
132138
*FeatureFlagsApi* | [**post_feature_flag**](docs/FeatureFlagsApi.md#post_feature_flag) | **POST** /flags/{projectKey} | Creates a new feature flag.
133-
*FeatureFlagsApi* | [**post_feature_flag_approval_request**](docs/FeatureFlagsApi.md#post_feature_flag_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagApprovalRequestId} | Create an approval request for a feature flag
134-
*FeatureFlagsApi* | [**post_review_feature_flag_approval_request**](docs/FeatureFlagsApi.md#post_review_feature_flag_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagApprovalRequestId}/review | Review approval request for a feature flag
139+
*FeatureFlagsApi* | [**post_flag_config_scheduled_changes**](docs/FeatureFlagsApi.md#post_flag_config_scheduled_changes) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes | Creates a new scheduled change for a feature flag.
140+
*FeatureFlagsApi* | [**post_review_approval_request**](docs/FeatureFlagsApi.md#post_review_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/review | Review approval request for a feature flag config
135141
*IntegrationsApi* | [**delete_integration_subscription**](docs/IntegrationsApi.md#delete_integration_subscription) | **DELETE** /integrations/{integrationKey}/{integrationId} | Delete an integration subscription by ID.
136142
*IntegrationsApi* | [**get_integration_subscription**](docs/IntegrationsApi.md#get_integration_subscription) | **GET** /integrations/{integrationKey}/{integrationId} | Get a single integration subscription by ID.
137143
*IntegrationsApi* | [**get_integration_subscriptions**](docs/IntegrationsApi.md#get_integration_subscriptions) | **GET** /integrations/{integrationKey} | Get a list of all configured integrations of a given kind.
@@ -156,6 +162,7 @@ Class | Method | HTTP request | Description
156162
*TeamMembersApi* | [**get_members**](docs/TeamMembersApi.md#get_members) | **GET** /members | Returns a list of all members in the account.
157163
*TeamMembersApi* | [**patch_member**](docs/TeamMembersApi.md#patch_member) | **PATCH** /members/{memberId} | Modify a team member by ID.
158164
*TeamMembersApi* | [**post_members**](docs/TeamMembersApi.md#post_members) | **POST** /members | Invite new members.
165+
*UserRecordApi* | [**get_user**](docs/UserRecordApi.md#get_user) | **GET** /users/{projectKey}/{environmentKey}/{userKey} | Get a user by key.
159166
*UserSegmentsApi* | [**delete_user_segment**](docs/UserSegmentsApi.md#delete_user_segment) | **DELETE** /segments/{projectKey}/{environmentKey}/{userSegmentKey} | Delete a user segment.
160167
*UserSegmentsApi* | [**get_expiring_user_targets_on_segment**](docs/UserSegmentsApi.md#get_expiring_user_targets_on_segment) | **GET** /segments/{projectKey}/{userSegmentKey}/expiring-user-targets/{environmentKey} | Get expiring user targets for user segment
161168
*UserSegmentsApi* | [**get_user_segment**](docs/UserSegmentsApi.md#get_user_segment) | **GET** /segments/{projectKey}/{environmentKey}/{userSegmentKey} | Get a single user segment by key.
@@ -171,7 +178,6 @@ Class | Method | HTTP request | Description
171178
*UserSettingsApi* | [**put_flag_setting**](docs/UserSettingsApi.md#put_flag_setting) | **PUT** /users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} | Specifically enable or disable a feature flag for a user based on their key.
172179
*UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /users/{projectKey}/{environmentKey}/{userKey} | Delete a user by ID.
173180
*UsersApi* | [**get_search_users**](docs/UsersApi.md#get_search_users) | **GET** /user-search/{projectKey}/{environmentKey} | Search users in LaunchDarkly based on their last active date, or a search query. It should not be used to enumerate all users in LaunchDarkly-- use the List users API resource.
174-
*UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /users/{projectKey}/{environmentKey}/{userKey} | Get a user by key.
175181
*UsersApi* | [**get_users**](docs/UsersApi.md#get_users) | **GET** /users/{projectKey}/{environmentKey} | List all users in the environment. Includes the total count of users. In each page, there will be up to 'limit' users returned (default 20). This is useful for exporting all users in the system for further analysis. Paginated collections will include a next link containing a URL with the next set of elements in the collection.
176182
*WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{resourceId} | Delete a webhook by ID.
177183
*WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /webhooks/{resourceId} | Get a webhook by ID.
@@ -182,6 +188,13 @@ Class | Method | HTTP request | Description
182188

183189
## Documentation For Models
184190

191+
- [ApprovalRequest](docs/ApprovalRequest.md)
192+
- [ApprovalRequestApplyConfigBody](docs/ApprovalRequestApplyConfigBody.md)
193+
- [ApprovalRequestConfigBody](docs/ApprovalRequestConfigBody.md)
194+
- [ApprovalRequestReview](docs/ApprovalRequestReview.md)
195+
- [ApprovalRequestReviewConfigBody](docs/ApprovalRequestReviewConfigBody.md)
196+
- [ApprovalRequestReviewStatus](docs/ApprovalRequestReviewStatus.md)
197+
- [ApprovalRequests](docs/ApprovalRequests.md)
185198
- [AuditLogEntries](docs/AuditLogEntries.md)
186199
- [AuditLogEntry](docs/AuditLogEntry.md)
187200
- [AuditLogEntryTarget](docs/AuditLogEntryTarget.md)
@@ -208,13 +221,6 @@ Class | Method | HTTP request | Description
208221
- [Events](docs/Events.md)
209222
- [Fallthrough](docs/Fallthrough.md)
210223
- [FeatureFlag](docs/FeatureFlag.md)
211-
- [FeatureFlagApprovalRequest](docs/FeatureFlagApprovalRequest.md)
212-
- [FeatureFlagApprovalRequestApplyConfigBody](docs/FeatureFlagApprovalRequestApplyConfigBody.md)
213-
- [FeatureFlagApprovalRequestConfigBody](docs/FeatureFlagApprovalRequestConfigBody.md)
214-
- [FeatureFlagApprovalRequestReview](docs/FeatureFlagApprovalRequestReview.md)
215-
- [FeatureFlagApprovalRequestReviewConfigBody](docs/FeatureFlagApprovalRequestReviewConfigBody.md)
216-
- [FeatureFlagApprovalRequestReviewStatus](docs/FeatureFlagApprovalRequestReviewStatus.md)
217-
- [FeatureFlagApprovalRequests](docs/FeatureFlagApprovalRequests.md)
218224
- [FeatureFlagBody](docs/FeatureFlagBody.md)
219225
- [FeatureFlagConfig](docs/FeatureFlagConfig.md)
220226
- [FeatureFlagCopyBody](docs/FeatureFlagCopyBody.md)
@@ -228,6 +234,9 @@ Class | Method | HTTP request | Description
228234
- [FeatureFlagStatusForQueriedEnvironment](docs/FeatureFlagStatusForQueriedEnvironment.md)
229235
- [FeatureFlagStatuses](docs/FeatureFlagStatuses.md)
230236
- [FeatureFlags](docs/FeatureFlags.md)
237+
- [FlagConfigScheduledChangesConflictsBody](docs/FlagConfigScheduledChangesConflictsBody.md)
238+
- [FlagConfigScheduledChangesPatchBody](docs/FlagConfigScheduledChangesPatchBody.md)
239+
- [FlagConfigScheduledChangesPostBody](docs/FlagConfigScheduledChangesPostBody.md)
231240
- [FlagListItem](docs/FlagListItem.md)
232241
- [HierarchicalLinks](docs/HierarchicalLinks.md)
233242
- [Id](docs/Id.md)
@@ -242,6 +251,7 @@ Class | Method | HTTP request | Description
242251
- [MAUMetadata](docs/MAUMetadata.md)
243252
- [MAUbyCategory](docs/MAUbyCategory.md)
244253
- [Member](docs/Member.md)
254+
- [MemberLastSeenMetadata](docs/MemberLastSeenMetadata.md)
245255
- [Members](docs/Members.md)
246256
- [MembersBody](docs/MembersBody.md)
247257
- [PatchComment](docs/PatchComment.md)

docs/ApprovalRequest.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# ApprovalRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | [**Id**](Id.md) | | [optional]
7+
**version** | **int** | | [optional]
8+
**creation_date** | **int** | A unix epoch time in milliseconds specifying the date the approval request was requested | [optional]
9+
**requestor_id** | **str** | The id of the member that requested the change | [optional]
10+
**review_status** | [**ApprovalRequestReviewStatus**](ApprovalRequestReviewStatus.md) | | [optional]
11+
**status** | **str** | | Name | Description | | --------:| ----------- | | pending | the approval request has not been applied yet | | completed| the approval request has been applied successfully | | failed | the approval request has been applied but the changes were not applied successfully | | [optional]
12+
**applied_by_member_id** | **str** | The id of the member that applied the approval request | [optional]
13+
**applied_date** | **int** | A unix epoch time in milliseconds specifying the date the approval request was applied | [optional]
14+
**all_reviews** | [**list[ApprovalRequestReview]**](ApprovalRequestReview.md) | | [optional]
15+
**notify_member_ids** | **list[str]** | | [optional]
16+
**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) | | [optional]
17+
18+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
19+
20+
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ApprovalRequestApplyConfigBody
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**comment** | **str** | comment will be included in audit log item for change. | [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/ApprovalRequestConfigBody.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ApprovalRequestConfigBody
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**description** | **str** | A name that describes the changes you would like to apply to a feature flag configuration |
7+
**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) | |
8+
**notify_member_ids** | **list[str]** | |
9+
**comment** | **str** | comment will be included in audit log item for change. | [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/ApprovalRequestReview.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ApprovalRequestReview
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**creation_date** | **int** | A unix epoch time in milliseconds specifying the date the approval request was reviewed | [optional]
7+
**kind** | [**ApprovalRequestReviewStatus**](ApprovalRequestReviewStatus.md) | | [optional]
8+
**member_id** | [**Id**](Id.md) | | [optional]
9+
**id** | [**Id**](Id.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+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ApprovalRequestReviewConfigBody
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**kind** | **str** | One of approve, decline, or comment. |
7+
**comment** | **str** | comment will be included in audit log item for change. | [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/ApprovalRequestReviewStatus.md

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

docs/ApprovalRequests.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ApprovalRequests
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**links** | [**Links**](Links.md) | | [optional]
7+
**items** | [**list[ApprovalRequest]**](ApprovalRequest.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+

0 commit comments

Comments
 (0)