Skip to content

Commit 210030b

Browse files
author
LaunchDarklyReleaseBot
committed
Version 12.0.0 automatically generated from ld-openapi.
1 parent 1c44735 commit 210030b

File tree

917 files changed

+23558
-1563
lines changed

Some content is hidden

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

917 files changed

+23558
-1563
lines changed

.openapi-generator/FILES

+141-3
Large diffs are not rendered by default.

README.md

+78-12
Large diffs are not rendered by default.

docs/AccountUsageBetaApi.md

+95-3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**get_evaluations_usage**](AccountUsageBetaApi.md#get_evaluations_usage) | **GET** /api/v2/usage/evaluations/{projectKey}/{environmentKey}/{featureFlagKey} | Get evaluations usage
88
[**get_events_usage**](AccountUsageBetaApi.md#get_events_usage) | **GET** /api/v2/usage/events/{type} | Get events usage
9+
[**get_experimentation_keys_usage**](AccountUsageBetaApi.md#get_experimentation_keys_usage) | **GET** /api/v2/usage/experimentation-keys | Get experimentation keys usage
910
[**get_mau_sdks_by_type**](AccountUsageBetaApi.md#get_mau_sdks_by_type) | **GET** /api/v2/usage/mau/sdks | Get MAU SDKs by type
1011
[**get_mau_usage**](AccountUsageBetaApi.md#get_mau_usage) | **GET** /api/v2/usage/mau | Get MAU usage
1112
[**get_mau_usage_by_category**](AccountUsageBetaApi.md#get_mau_usage_by_category) | **GET** /api/v2/usage/mau/bycategory | Get MAU usage by category
@@ -222,12 +223,103 @@ Name | Type | Description | Notes
222223

223224
[[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)
224225

226+
# **get_experimentation_keys_usage**
227+
> SeriesIntervalsRep get_experimentation_keys_usage()
228+
229+
Get experimentation keys usage
230+
231+
Get a time-series array of the number of monthly experimentation keys from your account. The granularity is always daily, with a max of 31 days.
232+
233+
### Example
234+
235+
* Api Key Authentication (ApiKey):
236+
237+
```python
238+
import time
239+
import launchdarkly_api
240+
from launchdarkly_api.api import account_usage_beta_api
241+
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
242+
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
243+
from launchdarkly_api.model.status_service_unavailable import StatusServiceUnavailable
244+
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
245+
from launchdarkly_api.model.series_intervals_rep import SeriesIntervalsRep
246+
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
247+
from pprint import pprint
248+
# Defining the host is optional and defaults to https://app.launchdarkly.com
249+
# See configuration.py for a list of all supported configuration parameters.
250+
configuration = launchdarkly_api.Configuration(
251+
host = "https://app.launchdarkly.com"
252+
)
253+
254+
# The client must configure the authentication and authorization parameters
255+
# in accordance with the API server security policy.
256+
# Examples for each auth method are provided below, use the example that
257+
# satisfies your auth use case.
258+
259+
# Configure API key authorization: ApiKey
260+
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
261+
262+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
263+
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
264+
265+
# Enter a context with an instance of the API client
266+
with launchdarkly_api.ApiClient(configuration) as api_client:
267+
# Create an instance of the API class
268+
api_instance = account_usage_beta_api.AccountUsageBetaApi(api_client)
269+
_from = "from_example" # str | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. (optional)
270+
to = "to_example" # str | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. (optional)
271+
272+
# example passing only required values which don't have defaults set
273+
# and optional values
274+
try:
275+
# Get experimentation keys usage
276+
api_response = api_instance.get_experimentation_keys_usage(_from=_from, to=to)
277+
pprint(api_response)
278+
except launchdarkly_api.ApiException as e:
279+
print("Exception when calling AccountUsageBetaApi->get_experimentation_keys_usage: %s\n" % e)
280+
```
281+
282+
283+
### Parameters
284+
285+
Name | Type | Description | Notes
286+
------------- | ------------- | ------------- | -------------
287+
**_from** | **str**| The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | [optional]
288+
**to** | **str**| The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | [optional]
289+
290+
### Return type
291+
292+
[**SeriesIntervalsRep**](SeriesIntervalsRep.md)
293+
294+
### Authorization
295+
296+
[ApiKey](../README.md#ApiKey)
297+
298+
### HTTP request headers
299+
300+
- **Content-Type**: Not defined
301+
- **Accept**: application/json
302+
303+
304+
### HTTP response details
305+
306+
| Status code | Description | Response headers |
307+
|-------------|-------------|------------------|
308+
**200** | Usage response | - |
309+
**400** | Invalid request | - |
310+
**401** | Invalid access token | - |
311+
**403** | Forbidden | - |
312+
**429** | Rate limited | - |
313+
**503** | Service unavailable | - |
314+
315+
[[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)
316+
225317
# **get_mau_sdks_by_type**
226318
> SdkListRep get_mau_sdks_by_type()
227319
228320
Get MAU SDKs by type
229321

230-
Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period.
322+
Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period.<br/><br/>Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. Use [Get client-side monthly context instances uage](/tag/Account-usage-(beta)#operation/getCMCIUsage) instead. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
231323

232324
### Example
233325

@@ -318,7 +410,7 @@ Name | Type | Description | Notes
318410
319411
Get MAU usage
320412

321-
Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.
413+
Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.<br/><br/>Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. Use [Get client-side monthly context instances uage](/tag/Account-usage-(beta)#operation/getCMCIUsage) instead. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
322414

323415
### Example
324416

@@ -419,7 +511,7 @@ Name | Type | Description | Notes
419511
420512
Get MAU usage by category
421513

422-
Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either `browser`, `mobile`, or `backend`.
514+
Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either `browser`, `mobile`, or `backend`.<br/><br/>Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. Use [Get client-side monthly context instances uage](/tag/Account-usage-(beta)#operation/getCMCIUsage) instead. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
423515

424516
### Example
425517

docs/ApprovalConditionInput.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**description** | **str** | | [optional]
8-
**notify_member_ids** | **[str]** | | [optional]
9-
**notify_team_keys** | **[str]** | | [optional]
7+
**description** | **str** | A description of the approval required for this stage | [optional]
8+
**notify_member_ids** | **[str]** | A list of member IDs for the members to request approval from for this stage | [optional]
9+
**notify_team_keys** | **[str]** | A list of team keys for the teams to request approval from for this stage | [optional]
1010
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
1111

1212
[[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/ApprovalRequestResponse.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# ApprovalRequestResponse
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **str** | The ID of this approval request |
8+
**version** | **int** | Version of the approval request |
9+
**creation_date** | **int** | |
10+
**service_kind** | **str** | |
11+
**review_status** | **str** | Current status of the review of this approval request |
12+
**all_reviews** | [**[ReviewResponse]**](ReviewResponse.md) | An array of individual reviews of this approval request |
13+
**notify_member_ids** | **[str]** | An array of member IDs. These members are notified to review the approval request. |
14+
**status** | **str** | Current status of the approval request |
15+
**instructions** | [**Instructions**](Instructions.md) | |
16+
**conflicts** | [**[Conflict]**](Conflict.md) | Details on any conflicting approval requests |
17+
**links** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | The location and content type of related resources |
18+
**requestor_id** | **str** | The ID of the member who requested the approval | [optional]
19+
**description** | **str** | A human-friendly name for the approval request | [optional]
20+
**applied_date** | **int** | | [optional]
21+
**applied_by_member_id** | **str** | The member ID of the member who applied the approval request | [optional]
22+
**execution_date** | **int** | | [optional]
23+
**operating_on_id** | **str** | ID of scheduled change to edit or delete | [optional]
24+
**integration_metadata** | [**IntegrationMetadata**](IntegrationMetadata.md) | | [optional]
25+
**source** | [**CopiedFromEnv**](CopiedFromEnv.md) | | [optional]
26+
**custom_workflow_metadata** | [**CustomWorkflowMeta**](CustomWorkflowMeta.md) | | [optional]
27+
**resource_id** | **str** | String representation of a resource | [optional]
28+
**approval_settings** | [**ApprovalSettings**](ApprovalSettings.md) | | [optional]
29+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
30+
31+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
32+
33+

0 commit comments

Comments
 (0)