Skip to content

Commit 1e73a6a

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

File tree

840 files changed

+2680
-937
lines changed

Some content is hidden

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

840 files changed

+2680
-937
lines changed

.openapi-generator/FILES

+6
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ docs/ContextSettingsBetaApi.md
7070
docs/Contexts.md
7171
docs/ContextsBetaApi.md
7272
docs/CopiedFromEnv.md
73+
docs/CreateApprovalRequestRequest.md
7374
docs/CreateCopyFlagConfigApprovalRequestRequest.md
7475
docs/CreateFlagConfigApprovalRequestRequest.md
7576
docs/CreateWorkflowTemplateInput.md
@@ -79,6 +80,7 @@ docs/CustomProperty.md
7980
docs/CustomRole.md
8081
docs/CustomRolePost.md
8182
docs/CustomRolePostData.md
83+
docs/CustomRoleSummary.md
8284
docs/CustomRoles.md
8385
docs/CustomRolesApi.md
8486
docs/CustomWorkflowInput.md
@@ -504,6 +506,7 @@ launchdarkly_api/model/context_record.py
504506
launchdarkly_api/model/context_search.py
505507
launchdarkly_api/model/contexts.py
506508
launchdarkly_api/model/copied_from_env.py
509+
launchdarkly_api/model/create_approval_request_request.py
507510
launchdarkly_api/model/create_copy_flag_config_approval_request_request.py
508511
launchdarkly_api/model/create_flag_config_approval_request_request.py
509512
launchdarkly_api/model/create_workflow_template_input.py
@@ -513,6 +516,7 @@ launchdarkly_api/model/custom_property.py
513516
launchdarkly_api/model/custom_role.py
514517
launchdarkly_api/model/custom_role_post.py
515518
launchdarkly_api/model/custom_role_post_data.py
519+
launchdarkly_api/model/custom_role_summary.py
516520
launchdarkly_api/model/custom_roles.py
517521
launchdarkly_api/model/custom_workflow_input.py
518522
launchdarkly_api/model/custom_workflow_meta.py
@@ -882,6 +886,7 @@ test/test_context_settings_beta_api.py
882886
test/test_contexts.py
883887
test/test_contexts_beta_api.py
884888
test/test_copied_from_env.py
889+
test/test_create_approval_request_request.py
885890
test/test_create_copy_flag_config_approval_request_request.py
886891
test/test_create_flag_config_approval_request_request.py
887892
test/test_create_workflow_template_input.py
@@ -891,6 +896,7 @@ test/test_custom_property.py
891896
test/test_custom_role.py
892897
test/test_custom_role_post.py
893898
test/test_custom_role_post_data.py
899+
test/test_custom_role_summary.py
894900
test/test_custom_roles.py
895901
test/test_custom_roles_api.py
896902
test/test_custom_workflow_input.py

README.md

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

275-
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:
275+
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:
276276

277277
| Header name | Description |
278278
| ------------------------------ | -------------------------------------------------------------------------------- |
@@ -340,6 +340,14 @@ Use this header:
340340
LD-API-Version: beta
341341
```
342342

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

345353
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.
@@ -383,7 +391,7 @@ If you would like to upgrade your integration to use a new API version, you can
383391
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
384392

385393
- API version: 2.0
386-
- Package version: 12.0.0
394+
- Package version: 12.1.0
387395
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
388396
For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
389397

@@ -507,8 +515,12 @@ Class | Method | HTTP request | Description
507515
*ApprovalsApi* | [**post_approval_request_for_flag**](docs/ApprovalsApi.md#post_approval_request_for_flag) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Create approval request for a flag
508516
*ApprovalsApi* | [**post_approval_request_review_for_flag**](docs/ApprovalsApi.md#post_approval_request_review_for_flag) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/reviews | Review approval request for a flag
509517
*ApprovalsApi* | [**post_flag_copy_config_approval_request**](docs/ApprovalsApi.md#post_flag_copy_config_approval_request) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests-flag-copy | Create approval request to copy flag configurations across environments
518+
*ApprovalsBetaApi* | [**delete_approval_request**](docs/ApprovalsBetaApi.md#delete_approval_request) | **DELETE** /api/v2/approval-requests/{id} | Delete approval request
510519
*ApprovalsBetaApi* | [**get_approval_request**](docs/ApprovalsBetaApi.md#get_approval_request) | **GET** /api/v2/approval-requests/{id} | Get approval request
511520
*ApprovalsBetaApi* | [**get_approval_requests**](docs/ApprovalsBetaApi.md#get_approval_requests) | **GET** /api/v2/approval-requests | List approval requests
521+
*ApprovalsBetaApi* | [**post_approval_request**](docs/ApprovalsBetaApi.md#post_approval_request) | **POST** /api/v2/approval-requests | Create approval request
522+
*ApprovalsBetaApi* | [**post_approval_request_apply**](docs/ApprovalsBetaApi.md#post_approval_request_apply) | **POST** /api/v2/approval-requests/{id}/apply | Apply approval request
523+
*ApprovalsBetaApi* | [**post_approval_request_review**](docs/ApprovalsBetaApi.md#post_approval_request_review) | **POST** /api/v2/approval-requests/{id}/reviews | Review approval request
512524
*AuditLogApi* | [**get_audit_log_entries**](docs/AuditLogApi.md#get_audit_log_entries) | **GET** /api/v2/auditlog | List audit log entries
513525
*AuditLogApi* | [**get_audit_log_entry**](docs/AuditLogApi.md#get_audit_log_entry) | **GET** /api/v2/auditlog/{id} | Get audit log entry
514526
*CodeReferencesApi* | [**delete_branches**](docs/CodeReferencesApi.md#delete_branches) | **POST** /api/v2/code-refs/repositories/{repo}/branch-delete-tasks | Delete branches
@@ -746,6 +758,7 @@ Class | Method | HTTP request | Description
746758
- [ContextSearch](docs/ContextSearch.md)
747759
- [Contexts](docs/Contexts.md)
748760
- [CopiedFromEnv](docs/CopiedFromEnv.md)
761+
- [CreateApprovalRequestRequest](docs/CreateApprovalRequestRequest.md)
749762
- [CreateCopyFlagConfigApprovalRequestRequest](docs/CreateCopyFlagConfigApprovalRequestRequest.md)
750763
- [CreateFlagConfigApprovalRequestRequest](docs/CreateFlagConfigApprovalRequestRequest.md)
751764
- [CreateWorkflowTemplateInput](docs/CreateWorkflowTemplateInput.md)
@@ -755,6 +768,7 @@ Class | Method | HTTP request | Description
755768
- [CustomRole](docs/CustomRole.md)
756769
- [CustomRolePost](docs/CustomRolePost.md)
757770
- [CustomRolePostData](docs/CustomRolePostData.md)
771+
- [CustomRoleSummary](docs/CustomRoleSummary.md)
758772
- [CustomRoles](docs/CustomRoles.md)
759773
- [CustomWorkflowInput](docs/CustomWorkflowInput.md)
760774
- [CustomWorkflowMeta](docs/CustomWorkflowMeta.md)

docs/AccountMembersApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -517,8 +517,8 @@ with launchdarkly_api.ApiClient(configuration) as api_client:
517517
NewMemberForm(
518518
519519
password="***",
520-
first_name="Sandy",
521-
last_name="Smith",
520+
first_name="Ariel",
521+
last_name="Flores",
522522
role="reader",
523523
custom_roles=["customRole1","customRole2"],
524524
team_keys=["team-1","team-2"],

docs/AccountUsageBetaApi.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ Name | Type | Description | Notes
228228
229229
Get experimentation keys usage
230230

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.
231+
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.
232232

233233
### Example
234234

@@ -319,7 +319,7 @@ Name | Type | Description | Notes
319319
320320
Get MAU SDKs by type
321321

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).
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/>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).
323323

324324
### Example
325325

@@ -410,7 +410,7 @@ Name | Type | Description | Notes
410410
411411
Get MAU usage
412412

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).
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/>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).
414414

415415
### Example
416416

@@ -511,7 +511,7 @@ Name | Type | Description | Notes
511511
512512
Get MAU usage by category
513513

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).
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/>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).
515515

516516
### Example
517517

docs/ApprovalsApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -645,7 +645,7 @@ with launchdarkly_api.ApiClient(configuration) as api_client:
645645
notify_member_ids=["1234a56b7c89d012345e678f"],
646646
notify_team_keys=["example-reviewer-team"],
647647
source=SourceFlag(
648-
key="example-environment-key",
648+
key="environment-key-123abc",
649649
version=1,
650650
),
651651
included_actions=["updateOn"],

0 commit comments

Comments
 (0)