Skip to content

Commit a1776fb

Browse files
author
LaunchDarklyReleaseBot
committed
Version 12.1.0 automatically generated from ld-openapi.
1 parent d8bb8e8 commit a1776fb

File tree

795 files changed

+4102
-908
lines changed

Some content is hidden

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

795 files changed

+4102
-908
lines changed

.openapi-generator/FILES

+6
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ docs/Model/ContextRecord.md
9797
docs/Model/ContextSearch.md
9898
docs/Model/Contexts.md
9999
docs/Model/CopiedFromEnv.md
100+
docs/Model/CreateApprovalRequestRequest.md
100101
docs/Model/CreateCopyFlagConfigApprovalRequestRequest.md
101102
docs/Model/CreateFlagConfigApprovalRequestRequest.md
102103
docs/Model/CreateWorkflowTemplateInput.md
@@ -105,6 +106,7 @@ docs/Model/CustomProperty.md
105106
docs/Model/CustomRole.md
106107
docs/Model/CustomRolePost.md
107108
docs/Model/CustomRolePostData.md
109+
docs/Model/CustomRoleSummary.md
108110
docs/Model/CustomRoles.md
109111
docs/Model/CustomWorkflowInput.md
110112
docs/Model/CustomWorkflowMeta.md
@@ -479,6 +481,7 @@ lib/Model/ContextRecord.php
479481
lib/Model/ContextSearch.php
480482
lib/Model/Contexts.php
481483
lib/Model/CopiedFromEnv.php
484+
lib/Model/CreateApprovalRequestRequest.php
482485
lib/Model/CreateCopyFlagConfigApprovalRequestRequest.php
483486
lib/Model/CreateFlagConfigApprovalRequestRequest.php
484487
lib/Model/CreateWorkflowTemplateInput.php
@@ -487,6 +490,7 @@ lib/Model/CustomProperty.php
487490
lib/Model/CustomRole.php
488491
lib/Model/CustomRolePost.php
489492
lib/Model/CustomRolePostData.php
493+
lib/Model/CustomRoleSummary.php
490494
lib/Model/CustomRoles.php
491495
lib/Model/CustomWorkflowInput.php
492496
lib/Model/CustomWorkflowMeta.php
@@ -860,13 +864,15 @@ test/Model/ContextRecordTest.php
860864
test/Model/ContextSearchTest.php
861865
test/Model/ContextsTest.php
862866
test/Model/CopiedFromEnvTest.php
867+
test/Model/CreateApprovalRequestRequestTest.php
863868
test/Model/CreateCopyFlagConfigApprovalRequestRequestTest.php
864869
test/Model/CreateFlagConfigApprovalRequestRequestTest.php
865870
test/Model/CreateWorkflowTemplateInputTest.php
866871
test/Model/CredibleIntervalRepTest.php
867872
test/Model/CustomPropertyTest.php
868873
test/Model/CustomRolePostDataTest.php
869874
test/Model/CustomRolePostTest.php
875+
test/Model/CustomRoleSummaryTest.php
870876
test/Model/CustomRoleTest.php
871877
test/Model/CustomRolesTest.php
872878
test/Model/CustomWorkflowInputTest.php

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ We use several rate limiting strategies to ensure the availability of our APIs.
273273
274274
### Global rate limits
275275

276-
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:
276+
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:
277277

278278
| Header name | Description |
279279
| ------------------------------ | -------------------------------------------------------------------------------- |
@@ -341,6 +341,14 @@ Use this header:
341341
LD-API-Version: beta
342342
```
343343

344+
## Federal environments
345+
346+
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.
347+
348+
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.
349+
350+
To learn more, read [LaunchDarkly in federal environments](https://docs.launchdarkly.com/home/advanced/federal).
351+
344352
## Versioning
345353

346354
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.
@@ -486,8 +494,12 @@ Class | Method | HTTP request | Description
486494
*ApprovalsApi* | [**postApprovalRequestForFlag**](docs/Api/ApprovalsApi.md#postapprovalrequestforflag) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Create approval request for a flag
487495
*ApprovalsApi* | [**postApprovalRequestReviewForFlag**](docs/Api/ApprovalsApi.md#postapprovalrequestreviewforflag) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/reviews | Review approval request for a flag
488496
*ApprovalsApi* | [**postFlagCopyConfigApprovalRequest**](docs/Api/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
497+
*ApprovalsBetaApi* | [**deleteApprovalRequest**](docs/Api/ApprovalsBetaApi.md#deleteapprovalrequest) | **DELETE** /api/v2/approval-requests/{id} | Delete approval request
489498
*ApprovalsBetaApi* | [**getApprovalRequest**](docs/Api/ApprovalsBetaApi.md#getapprovalrequest) | **GET** /api/v2/approval-requests/{id} | Get approval request
490499
*ApprovalsBetaApi* | [**getApprovalRequests**](docs/Api/ApprovalsBetaApi.md#getapprovalrequests) | **GET** /api/v2/approval-requests | List approval requests
500+
*ApprovalsBetaApi* | [**postApprovalRequest**](docs/Api/ApprovalsBetaApi.md#postapprovalrequest) | **POST** /api/v2/approval-requests | Create approval request
501+
*ApprovalsBetaApi* | [**postApprovalRequestApply**](docs/Api/ApprovalsBetaApi.md#postapprovalrequestapply) | **POST** /api/v2/approval-requests/{id}/apply | Apply approval request
502+
*ApprovalsBetaApi* | [**postApprovalRequestReview**](docs/Api/ApprovalsBetaApi.md#postapprovalrequestreview) | **POST** /api/v2/approval-requests/{id}/reviews | Review approval request
491503
*AuditLogApi* | [**getAuditLogEntries**](docs/Api/AuditLogApi.md#getauditlogentries) | **GET** /api/v2/auditlog | List audit log entries
492504
*AuditLogApi* | [**getAuditLogEntry**](docs/Api/AuditLogApi.md#getauditlogentry) | **GET** /api/v2/auditlog/{id} | Get audit log entry
493505
*CodeReferencesApi* | [**deleteBranches**](docs/Api/CodeReferencesApi.md#deletebranches) | **POST** /api/v2/code-refs/repositories/{repo}/branch-delete-tasks | Delete branches
@@ -722,6 +734,7 @@ Class | Method | HTTP request | Description
722734
- [ContextSearch](docs/Model/ContextSearch.md)
723735
- [Contexts](docs/Model/Contexts.md)
724736
- [CopiedFromEnv](docs/Model/CopiedFromEnv.md)
737+
- [CreateApprovalRequestRequest](docs/Model/CreateApprovalRequestRequest.md)
725738
- [CreateCopyFlagConfigApprovalRequestRequest](docs/Model/CreateCopyFlagConfigApprovalRequestRequest.md)
726739
- [CreateFlagConfigApprovalRequestRequest](docs/Model/CreateFlagConfigApprovalRequestRequest.md)
727740
- [CreateWorkflowTemplateInput](docs/Model/CreateWorkflowTemplateInput.md)
@@ -730,6 +743,7 @@ Class | Method | HTTP request | Description
730743
- [CustomRole](docs/Model/CustomRole.md)
731744
- [CustomRolePost](docs/Model/CustomRolePost.md)
732745
- [CustomRolePostData](docs/Model/CustomRolePostData.md)
746+
- [CustomRoleSummary](docs/Model/CustomRoleSummary.md)
733747
- [CustomRoles](docs/Model/CustomRoles.md)
734748
- [CustomWorkflowInput](docs/Model/CustomWorkflowInput.md)
735749
- [CustomWorkflowMeta](docs/Model/CustomWorkflowMeta.md)
@@ -1035,5 +1049,5 @@ [email protected]
10351049
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
10361050

10371051
- API version: `2.0`
1038-
- Package version: `12.0.0`
1052+
- Package version: `12.1.0`
10391053
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`

composer.json

+2-2
Large diffs are not rendered by default.

docs/Api/AccountUsageBetaApi.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ getExperimentationKeysUsage($from, $to): \LaunchDarklyApi\Model\SeriesIntervalsR
161161

162162
Get experimentation keys usage
163163

164-
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.
164+
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.
165165

166166
### Example
167167

@@ -225,7 +225,7 @@ getMauSdksByType($from, $to, $sdktype): \LaunchDarklyApi\Model\SdkListRep
225225

226226
Get MAU SDKs by type
227227

228-
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).
228+
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).
229229

230230
### Example
231231

@@ -291,7 +291,7 @@ getMauUsage($from, $to, $project, $environment, $sdktype, $sdk, $anonymous, $gro
291291

292292
Get MAU usage
293293

294-
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).
294+
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).
295295

296296
### Example
297297

@@ -367,7 +367,7 @@ getMauUsageByCategory($from, $to): \LaunchDarklyApi\Model\SeriesListRep
367367

368368
Get MAU usage by category
369369

370-
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).
370+
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).
371371

372372
### Example
373373

0 commit comments

Comments
 (0)