Skip to content

Commit 847ceb3

Browse files
author
LaunchDarklyReleaseBot
committed
Version 12.0.0 automatically generated from ld-openapi.
1 parent b5039f8 commit 847ceb3

File tree

878 files changed

+21596
-1454
lines changed

Some content is hidden

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

878 files changed

+21596
-1454
lines changed

.openapi-generator/FILES

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

.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ script:
1111
- bundle install --path vendor/bundle
1212
- bundle exec rspec
1313
- gem build launchdarkly_api.gemspec
14-
- gem install ./launchdarkly_api-11.0.0.gem
14+
- gem install ./launchdarkly_api-12.0.0.gem

README.md

+80-15
Large diffs are not rendered by default.

docs/AccountUsageBetaApi.md

+79-3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ All URIs are relative to *https://app.launchdarkly.com*
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 |
@@ -174,13 +175,88 @@ end
174175
- **Accept**: application/json
175176

176177

178+
## get_experimentation_keys_usage
179+
180+
> <SeriesIntervalsRep> get_experimentation_keys_usage(opts)
181+
182+
Get experimentation keys usage
183+
184+
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.
185+
186+
### Examples
187+
188+
```ruby
189+
require 'time'
190+
require 'launchdarkly_api'
191+
# setup authorization
192+
LaunchDarklyApi.configure do |config|
193+
# Configure API key authorization: ApiKey
194+
config.api_key['ApiKey'] = 'YOUR API KEY'
195+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
196+
# config.api_key_prefix['ApiKey'] = 'Bearer'
197+
end
198+
199+
api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
200+
opts = {
201+
from: 'from_example', # String | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
202+
to: 'to_example' # String | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
203+
}
204+
205+
begin
206+
# Get experimentation keys usage
207+
result = api_instance.get_experimentation_keys_usage(opts)
208+
p result
209+
rescue LaunchDarklyApi::ApiError => e
210+
puts "Error when calling AccountUsageBetaApi->get_experimentation_keys_usage: #{e}"
211+
end
212+
```
213+
214+
#### Using the get_experimentation_keys_usage_with_http_info variant
215+
216+
This returns an Array which contains the response data, status code and headers.
217+
218+
> <Array(<SeriesIntervalsRep>, Integer, Hash)> get_experimentation_keys_usage_with_http_info(opts)
219+
220+
```ruby
221+
begin
222+
# Get experimentation keys usage
223+
data, status_code, headers = api_instance.get_experimentation_keys_usage_with_http_info(opts)
224+
p status_code # => 2xx
225+
p headers # => { ... }
226+
p data # => <SeriesIntervalsRep>
227+
rescue LaunchDarklyApi::ApiError => e
228+
puts "Error when calling AccountUsageBetaApi->get_experimentation_keys_usage_with_http_info: #{e}"
229+
end
230+
```
231+
232+
### Parameters
233+
234+
| Name | Type | Description | Notes |
235+
| ---- | ---- | ----------- | ----- |
236+
| **from** | **String** | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | [optional] |
237+
| **to** | **String** | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | [optional] |
238+
239+
### Return type
240+
241+
[**SeriesIntervalsRep**](SeriesIntervalsRep.md)
242+
243+
### Authorization
244+
245+
[ApiKey](../README.md#ApiKey)
246+
247+
### HTTP request headers
248+
249+
- **Content-Type**: Not defined
250+
- **Accept**: application/json
251+
252+
177253
## get_mau_sdks_by_type
178254

179255
> <SdkListRep> get_mau_sdks_by_type(opts)
180256
181257
Get MAU SDKs by type
182258

183-
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.
259+
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).
184260

185261
### Examples
186262

@@ -257,7 +333,7 @@ end
257333
258334
Get MAU usage
259335

260-
Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.
336+
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).
261337

262338
### Examples
263339

@@ -344,7 +420,7 @@ end
344420
345421
Get MAU usage by category
346422

347-
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`.
423+
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).
348424

349425
### Examples
350426

docs/ApprovalConditionInput.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@
44

55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
7-
| **description** | **String** | | [optional] |
8-
| **notify_member_ids** | **Array&lt;String&gt;** | | [optional] |
9-
| **notify_team_keys** | **Array&lt;String&gt;** | | [optional] |
7+
| **description** | **String** | A description of the approval required for this stage | [optional] |
8+
| **notify_member_ids** | **Array&lt;String&gt;** | A list of member IDs for the members to request approval from for this stage | [optional] |
9+
| **notify_team_keys** | **Array&lt;String&gt;** | A list of team keys for the teams to request approval from for this stage | [optional] |
1010

1111
## Example
1212

1313
```ruby
1414
require 'launchdarkly_api'
1515

1616
instance = LaunchDarklyApi::ApprovalConditionInput.new(
17-
description: null,
18-
notify_member_ids: null,
19-
notify_team_keys: null
17+
description: Require example-team approval for final stage,
18+
notify_member_ids: [&quot;507f1f77bcf86cd799439011&quot;],
19+
notify_team_keys: [&quot;example-team&quot;]
2020
)
2121
```
2222

docs/ApprovalRequestResponse.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# LaunchDarklyApi::ApprovalRequestResponse
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **_id** | **String** | The ID of this approval request | |
8+
| **_version** | **Integer** | Version of the approval request | |
9+
| **creation_date** | **Integer** | | |
10+
| **service_kind** | **String** | | |
11+
| **requestor_id** | **String** | The ID of the member who requested the approval | [optional] |
12+
| **description** | **String** | A human-friendly name for the approval request | [optional] |
13+
| **review_status** | **String** | Current status of the review of this approval request | |
14+
| **all_reviews** | [**Array&lt;ReviewResponse&gt;**](ReviewResponse.md) | An array of individual reviews of this approval request | |
15+
| **notify_member_ids** | **Array&lt;String&gt;** | An array of member IDs. These members are notified to review the approval request. | |
16+
| **applied_date** | **Integer** | | [optional] |
17+
| **applied_by_member_id** | **String** | The member ID of the member who applied the approval request | [optional] |
18+
| **status** | **String** | Current status of the approval request | |
19+
| **instructions** | **Array&lt;Hash&gt;** | | |
20+
| **conflicts** | [**Array&lt;Conflict&gt;**](Conflict.md) | Details on any conflicting approval requests | |
21+
| **_links** | **Hash&lt;String, Object&gt;** | The location and content type of related resources | |
22+
| **execution_date** | **Integer** | | [optional] |
23+
| **operating_on_id** | **String** | 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** | **String** | String representation of a resource | [optional] |
28+
| **approval_settings** | [**ApprovalSettings**](ApprovalSettings.md) | | [optional] |
29+
30+
## Example
31+
32+
```ruby
33+
require 'launchdarkly_api'
34+
35+
instance = LaunchDarklyApi::ApprovalRequestResponse.new(
36+
_id: 12ab3c45de678910abc12345,
37+
_version: 1,
38+
creation_date: null,
39+
service_kind: null,
40+
requestor_id: 12ab3c45de678910abc12345,
41+
description: example: request approval from someone,
42+
review_status: pending,
43+
all_reviews: null,
44+
notify_member_ids: [&quot;1234a56b7c89d012345e678f&quot;],
45+
applied_date: null,
46+
applied_by_member_id: 1234a56b7c89d012345e678f,
47+
status: pending,
48+
instructions: null,
49+
conflicts: null,
50+
_links: null,
51+
execution_date: null,
52+
operating_on_id: 12ab3c45de678910abc12345,
53+
integration_metadata: null,
54+
source: null,
55+
custom_workflow_metadata: null,
56+
resource_id: null,
57+
approval_settings: null
58+
)
59+
```
60+

0 commit comments

Comments
 (0)