Skip to content

Commit fd57d0f

Browse files
author
LaunchDarklyCI
committed
Version 5.0.1 automatically generated from ld-openapi@b34b97c.
1 parent d876572 commit fd57d0f

File tree

296 files changed

+479
-304
lines changed

Some content is hidden

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

296 files changed

+479
-304
lines changed

README.md

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

@@ -162,7 +162,6 @@ Class | Method | HTTP request | Description
162162
*TeamMembersApi* | [**get_members**](docs/TeamMembersApi.md#get_members) | **GET** /members | Returns a list of all members in the account.
163163
*TeamMembersApi* | [**patch_member**](docs/TeamMembersApi.md#patch_member) | **PATCH** /members/{memberId} | Modify a team member by ID.
164164
*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.
166165
*UserSegmentsApi* | [**delete_user_segment**](docs/UserSegmentsApi.md#delete_user_segment) | **DELETE** /segments/{projectKey}/{environmentKey}/{userSegmentKey} | Delete a user segment.
167166
*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
168167
*UserSegmentsApi* | [**get_user_segment**](docs/UserSegmentsApi.md#get_user_segment) | **GET** /segments/{projectKey}/{environmentKey}/{userSegmentKey} | Get a single user segment by key.
@@ -178,6 +177,7 @@ Class | Method | HTTP request | Description
178177
*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.
179178
*UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /users/{projectKey}/{environmentKey}/{userKey} | Delete a user by ID.
180179
*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.
180+
*UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /users/{projectKey}/{environmentKey}/{userKey} | Get a user by key.
181181
*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.
182182
*WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{resourceId} | Delete a webhook by ID.
183183
*WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /webhooks/{resourceId} | Get a webhook by ID.

docs/UsersApi.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**delete_user**](UsersApi.md#delete_user) | **DELETE** /users/{projectKey}/{environmentKey}/{userKey} | Delete a user by ID.
88
[**get_search_users**](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.
9+
[**get_user**](UsersApi.md#get_user) | **GET** /users/{projectKey}/{environmentKey}/{userKey} | Get a user by key.
910
[**get_users**](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.
1011

1112

@@ -126,6 +127,62 @@ Name | Type | Description | Notes
126127

127128
[[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)
128129

130+
# **get_user**
131+
> UserRecord get_user(project_key, environment_key, user_key)
132+
133+
Get a user by key.
134+
135+
### Example
136+
```python
137+
from __future__ import print_function
138+
import time
139+
import launchdarkly_api
140+
from launchdarkly_api.rest import ApiException
141+
from pprint import pprint
142+
143+
# Configure API key authorization: Token
144+
configuration = launchdarkly_api.Configuration()
145+
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
146+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
147+
# configuration.api_key_prefix['Authorization'] = 'Bearer'
148+
149+
# create an instance of the API class
150+
api_instance = launchdarkly_api.UsersApi(launchdarkly_api.ApiClient(configuration))
151+
project_key = 'project_key_example' # str | The project key, used to tie the flags together under one project so they can be managed together.
152+
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.
153+
user_key = 'user_key_example' # str | The user's key.
154+
155+
try:
156+
# Get a user by key.
157+
api_response = api_instance.get_user(project_key, environment_key, user_key)
158+
pprint(api_response)
159+
except ApiException as e:
160+
print("Exception when calling UsersApi->get_user: %s\n" % e)
161+
```
162+
163+
### Parameters
164+
165+
Name | Type | Description | Notes
166+
------------- | ------------- | ------------- | -------------
167+
**project_key** | **str**| The project key, used to tie the flags together under one project so they can be managed together. |
168+
**environment_key** | **str**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
169+
**user_key** | **str**| The user's key. |
170+
171+
### Return type
172+
173+
[**UserRecord**](UserRecord.md)
174+
175+
### Authorization
176+
177+
[Token](../README.md#Token)
178+
179+
### HTTP request headers
180+
181+
- **Content-Type**: application/json
182+
- **Accept**: application/json
183+
184+
[[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)
185+
129186
# **get_users**
130187
> Users get_users(project_key, environment_key, limit=limit, h=h, scroll_id=scroll_id)
131188

launchdarkly_api/__init__.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
88
Build custom integrations with the LaunchDarkly REST API # noqa: E501
99
10-
OpenAPI spec version: 5.0.0
10+
OpenAPI spec version: 5.0.1
1111
1212
Generated by: https://github.com/swagger-api/swagger-codegen.git
1313
"""
@@ -28,7 +28,6 @@
2828
from launchdarkly_api.api.relay_proxy_configurations_api import RelayProxyConfigurationsApi
2929
from launchdarkly_api.api.root_api import RootApi
3030
from launchdarkly_api.api.team_members_api import TeamMembersApi
31-
from launchdarkly_api.api.user_record_api import UserRecordApi
3231
from launchdarkly_api.api.user_segments_api import UserSegmentsApi
3332
from launchdarkly_api.api.user_settings_api import UserSettingsApi
3433
from launchdarkly_api.api.users_api import UsersApi

launchdarkly_api/api/__init__.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
from launchdarkly_api.api.relay_proxy_configurations_api import RelayProxyConfigurationsApi
1616
from launchdarkly_api.api.root_api import RootApi
1717
from launchdarkly_api.api.team_members_api import TeamMembersApi
18-
from launchdarkly_api.api.user_record_api import UserRecordApi
1918
from launchdarkly_api.api.user_segments_api import UserSegmentsApi
2019
from launchdarkly_api.api.user_settings_api import UserSettingsApi
2120
from launchdarkly_api.api.users_api import UsersApi

launchdarkly_api/api/access_tokens_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Build custom integrations with the LaunchDarkly REST API # noqa: E501
77
8-
OpenAPI spec version: 5.0.0
8+
OpenAPI spec version: 5.0.1
99
1010
Generated by: https://github.com/swagger-api/swagger-codegen.git
1111
"""

launchdarkly_api/api/audit_log_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Build custom integrations with the LaunchDarkly REST API # noqa: E501
77
8-
OpenAPI spec version: 5.0.0
8+
OpenAPI spec version: 5.0.1
99
1010
Generated by: https://github.com/swagger-api/swagger-codegen.git
1111
"""

launchdarkly_api/api/custom_roles_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Build custom integrations with the LaunchDarkly REST API # noqa: E501
77
8-
OpenAPI spec version: 5.0.0
8+
OpenAPI spec version: 5.0.1
99
1010
Generated by: https://github.com/swagger-api/swagger-codegen.git
1111
"""

launchdarkly_api/api/customer_metrics_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Build custom integrations with the LaunchDarkly REST API # noqa: E501
77
8-
OpenAPI spec version: 5.0.0
8+
OpenAPI spec version: 5.0.1
99
1010
Generated by: https://github.com/swagger-api/swagger-codegen.git
1111
"""

launchdarkly_api/api/data_export_destinations_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Build custom integrations with the LaunchDarkly REST API # noqa: E501
77
8-
OpenAPI spec version: 5.0.0
8+
OpenAPI spec version: 5.0.1
99
1010
Generated by: https://github.com/swagger-api/swagger-codegen.git
1111
"""

launchdarkly_api/api/environments_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Build custom integrations with the LaunchDarkly REST API # noqa: E501
77
8-
OpenAPI spec version: 5.0.0
8+
OpenAPI spec version: 5.0.1
99
1010
Generated by: https://github.com/swagger-api/swagger-codegen.git
1111
"""

0 commit comments

Comments
 (0)