Skip to content

Commit 55dc101

Browse files
author
LaunchDarklyReleaseBot
committed
Version 12.1.0 automatically generated from ld-openapi.
1 parent a29d6db commit 55dc101

File tree

792 files changed

+2219
-1235
lines changed

Some content is hidden

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

792 files changed

+2219
-1235
lines changed

.openapi-generator/FILES

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ docs/ContextSettingsBetaApi.md
6868
docs/Contexts.md
6969
docs/ContextsBetaApi.md
7070
docs/CopiedFromEnv.md
71+
docs/CreateApprovalRequestRequest.md
7172
docs/CreateCopyFlagConfigApprovalRequestRequest.md
7273
docs/CreateFlagConfigApprovalRequestRequest.md
7374
docs/CreateWorkflowTemplateInput.md
@@ -76,6 +77,7 @@ docs/CustomProperty.md
7677
docs/CustomRole.md
7778
docs/CustomRolePost.md
7879
docs/CustomRolePostData.md
80+
docs/CustomRoleSummary.md
7981
docs/CustomRoles.md
8082
docs/CustomRolesApi.md
8183
docs/CustomWorkflowInput.md
@@ -479,6 +481,7 @@ src/model/ContextRecord.js
479481
src/model/ContextSearch.js
480482
src/model/Contexts.js
481483
src/model/CopiedFromEnv.js
484+
src/model/CreateApprovalRequestRequest.js
482485
src/model/CreateCopyFlagConfigApprovalRequestRequest.js
483486
src/model/CreateFlagConfigApprovalRequestRequest.js
484487
src/model/CreateWorkflowTemplateInput.js
@@ -487,6 +490,7 @@ src/model/CustomProperty.js
487490
src/model/CustomRole.js
488491
src/model/CustomRolePost.js
489492
src/model/CustomRolePostData.js
493+
src/model/CustomRoleSummary.js
490494
src/model/CustomRoles.js
491495
src/model/CustomWorkflowInput.js
492496
src/model/CustomWorkflowMeta.js
@@ -857,6 +861,7 @@ test/model/ContextRecord.spec.js
857861
test/model/ContextSearch.spec.js
858862
test/model/Contexts.spec.js
859863
test/model/CopiedFromEnv.spec.js
864+
test/model/CreateApprovalRequestRequest.spec.js
860865
test/model/CreateCopyFlagConfigApprovalRequestRequest.spec.js
861866
test/model/CreateFlagConfigApprovalRequestRequest.spec.js
862867
test/model/CreateWorkflowTemplateInput.spec.js
@@ -865,6 +870,7 @@ test/model/CustomProperty.spec.js
865870
test/model/CustomRole.spec.js
866871
test/model/CustomRolePost.spec.js
867872
test/model/CustomRolePostData.spec.js
873+
test/model/CustomRoleSummary.spec.js
868874
test/model/CustomRoles.spec.js
869875
test/model/CustomWorkflowInput.spec.js
870876
test/model/CustomWorkflowMeta.spec.js

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ We use several rate limiting strategies to ensure the availability of our APIs.
274274
275275
### Global rate limits
276276

277-
Authenticated requests are subject to a global limit. This is the maximum number of calls that your account can make to the API per ten seconds. All personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits return the headers below:
277+
Authenticated requests are subject to a global limit. This is the maximum number of calls that your account can make to the API per ten seconds. All personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits may return the headers below:
278278

279279
| Header name | Description |
280280
| ------------------------------ | -------------------------------------------------------------------------------- |
@@ -342,6 +342,14 @@ Use this header:
342342
LD-API-Version: beta
343343
```
344344

345+
## Federal environments
346+
347+
The version of LaunchDarkly that is available on domains controlled by the United States government is different from the version of LaunchDarkly available to the general public. If you are an employee or contractor for a United States federal agency and use LaunchDarkly in your work, you likely use the federal instance of LaunchDarkly.
348+
349+
If you are working in the federal instance of LaunchDarkly, the base URI for each request is `https://app.launchdarkly.us`. In the \"Try it\" sandbox for each request, click the request path to view the complete resource path for the federal environment.
350+
351+
To learn more, read [LaunchDarkly in federal environments](https://docs.launchdarkly.com/home/advanced/federal).
352+
345353
## Versioning
346354

347355
We try hard to keep our REST API backwards compatible, but we occasionally have to make backwards-incompatible changes in the process of shipping new features. These breaking changes can cause unexpected behavior if you don't prepare for them accordingly.
@@ -384,7 +392,7 @@ If you would like to upgrade your integration to use a new API version, you can
384392
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
385393

386394
- API version: 2.0
387-
- Package version: 12.0.0
395+
- Package version: 12.1.0
388396
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
389397
For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
390398

@@ -535,8 +543,12 @@ Class | Method | HTTP request | Description
535543
*LaunchDarklyApi.ApprovalsApi* | [**postApprovalRequestForFlag**](docs/ApprovalsApi.md#postApprovalRequestForFlag) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Create approval request for a flag
536544
*LaunchDarklyApi.ApprovalsApi* | [**postApprovalRequestReviewForFlag**](docs/ApprovalsApi.md#postApprovalRequestReviewForFlag) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/reviews | Review approval request for a flag
537545
*LaunchDarklyApi.ApprovalsApi* | [**postFlagCopyConfigApprovalRequest**](docs/ApprovalsApi.md#postFlagCopyConfigApprovalRequest) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests-flag-copy | Create approval request to copy flag configurations across environments
546+
*LaunchDarklyApi.ApprovalsBetaApi* | [**deleteApprovalRequest**](docs/ApprovalsBetaApi.md#deleteApprovalRequest) | **DELETE** /api/v2/approval-requests/{id} | Delete approval request
538547
*LaunchDarklyApi.ApprovalsBetaApi* | [**getApprovalRequest**](docs/ApprovalsBetaApi.md#getApprovalRequest) | **GET** /api/v2/approval-requests/{id} | Get approval request
539548
*LaunchDarklyApi.ApprovalsBetaApi* | [**getApprovalRequests**](docs/ApprovalsBetaApi.md#getApprovalRequests) | **GET** /api/v2/approval-requests | List approval requests
549+
*LaunchDarklyApi.ApprovalsBetaApi* | [**postApprovalRequest**](docs/ApprovalsBetaApi.md#postApprovalRequest) | **POST** /api/v2/approval-requests | Create approval request
550+
*LaunchDarklyApi.ApprovalsBetaApi* | [**postApprovalRequestApply**](docs/ApprovalsBetaApi.md#postApprovalRequestApply) | **POST** /api/v2/approval-requests/{id}/apply | Apply approval request
551+
*LaunchDarklyApi.ApprovalsBetaApi* | [**postApprovalRequestReview**](docs/ApprovalsBetaApi.md#postApprovalRequestReview) | **POST** /api/v2/approval-requests/{id}/reviews | Review approval request
540552
*LaunchDarklyApi.AuditLogApi* | [**getAuditLogEntries**](docs/AuditLogApi.md#getAuditLogEntries) | **GET** /api/v2/auditlog | List audit log entries
541553
*LaunchDarklyApi.AuditLogApi* | [**getAuditLogEntry**](docs/AuditLogApi.md#getAuditLogEntry) | **GET** /api/v2/auditlog/{id} | Get audit log entry
542554
*LaunchDarklyApi.CodeReferencesApi* | [**deleteBranches**](docs/CodeReferencesApi.md#deleteBranches) | **POST** /api/v2/code-refs/repositories/{repo}/branch-delete-tasks | Delete branches
@@ -772,6 +784,7 @@ Class | Method | HTTP request | Description
772784
- [LaunchDarklyApi.ContextSearch](docs/ContextSearch.md)
773785
- [LaunchDarklyApi.Contexts](docs/Contexts.md)
774786
- [LaunchDarklyApi.CopiedFromEnv](docs/CopiedFromEnv.md)
787+
- [LaunchDarklyApi.CreateApprovalRequestRequest](docs/CreateApprovalRequestRequest.md)
775788
- [LaunchDarklyApi.CreateCopyFlagConfigApprovalRequestRequest](docs/CreateCopyFlagConfigApprovalRequestRequest.md)
776789
- [LaunchDarklyApi.CreateFlagConfigApprovalRequestRequest](docs/CreateFlagConfigApprovalRequestRequest.md)
777790
- [LaunchDarklyApi.CreateWorkflowTemplateInput](docs/CreateWorkflowTemplateInput.md)
@@ -780,6 +793,7 @@ Class | Method | HTTP request | Description
780793
- [LaunchDarklyApi.CustomRole](docs/CustomRole.md)
781794
- [LaunchDarklyApi.CustomRolePost](docs/CustomRolePost.md)
782795
- [LaunchDarklyApi.CustomRolePostData](docs/CustomRolePostData.md)
796+
- [LaunchDarklyApi.CustomRoleSummary](docs/CustomRoleSummary.md)
783797
- [LaunchDarklyApi.CustomRoles](docs/CustomRoles.md)
784798
- [LaunchDarklyApi.CustomWorkflowInput](docs/CustomWorkflowInput.md)
785799
- [LaunchDarklyApi.CustomWorkflowMeta](docs/CustomWorkflowMeta.md)

docs/AccountUsageBetaApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Name | Type | Description | Notes
142142
143143
Get experimentation keys usage
144144

145-
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.
145+
Get a time-series array of the number of monthly experimentation keys from your account. The granularity is always daily, with a maximum of 31 days.
146146

147147
### Example
148148

@@ -197,7 +197,7 @@ Name | Type | Description | Notes
197197
198198
Get MAU SDKs by type
199199

200-
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).
200+
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/>LaunchDarkly's billing calculations will change on April 1, 2023. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
201201

202202
### Example
203203

@@ -254,7 +254,7 @@ Name | Type | Description | Notes
254254
255255
Get MAU usage
256256

257-
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).
257+
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/>LaunchDarkly's billing calculations will change on April 1, 2023. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
258258

259259
### Example
260260

@@ -321,7 +321,7 @@ Name | Type | Description | Notes
321321
322322
Get MAU usage by category
323323

324-
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).
324+
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/>LaunchDarkly's billing calculations will change on April 1, 2023. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
325325

326326
### Example
327327

0 commit comments

Comments
 (0)