Skip to content

Commit

Permalink
Version 12.1.0 automatically generated from ld-openapi.
Browse files Browse the repository at this point in the history
  • Loading branch information
LaunchDarklyReleaseBot committed Apr 13, 2023
1 parent 210030b commit 1e73a6a
Show file tree
Hide file tree
Showing 840 changed files with 2,680 additions and 937 deletions.
6 changes: 6 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ docs/ContextSettingsBetaApi.md
docs/Contexts.md
docs/ContextsBetaApi.md
docs/CopiedFromEnv.md
docs/CreateApprovalRequestRequest.md
docs/CreateCopyFlagConfigApprovalRequestRequest.md
docs/CreateFlagConfigApprovalRequestRequest.md
docs/CreateWorkflowTemplateInput.md
Expand All @@ -79,6 +80,7 @@ docs/CustomProperty.md
docs/CustomRole.md
docs/CustomRolePost.md
docs/CustomRolePostData.md
docs/CustomRoleSummary.md
docs/CustomRoles.md
docs/CustomRolesApi.md
docs/CustomWorkflowInput.md
Expand Down Expand Up @@ -504,6 +506,7 @@ launchdarkly_api/model/context_record.py
launchdarkly_api/model/context_search.py
launchdarkly_api/model/contexts.py
launchdarkly_api/model/copied_from_env.py
launchdarkly_api/model/create_approval_request_request.py
launchdarkly_api/model/create_copy_flag_config_approval_request_request.py
launchdarkly_api/model/create_flag_config_approval_request_request.py
launchdarkly_api/model/create_workflow_template_input.py
Expand All @@ -513,6 +516,7 @@ launchdarkly_api/model/custom_property.py
launchdarkly_api/model/custom_role.py
launchdarkly_api/model/custom_role_post.py
launchdarkly_api/model/custom_role_post_data.py
launchdarkly_api/model/custom_role_summary.py
launchdarkly_api/model/custom_roles.py
launchdarkly_api/model/custom_workflow_input.py
launchdarkly_api/model/custom_workflow_meta.py
Expand Down Expand Up @@ -882,6 +886,7 @@ test/test_context_settings_beta_api.py
test/test_contexts.py
test/test_contexts_beta_api.py
test/test_copied_from_env.py
test/test_create_approval_request_request.py
test/test_create_copy_flag_config_approval_request_request.py
test/test_create_flag_config_approval_request_request.py
test/test_create_workflow_template_input.py
Expand All @@ -891,6 +896,7 @@ test/test_custom_property.py
test/test_custom_role.py
test/test_custom_role_post.py
test/test_custom_role_post_data.py
test/test_custom_role_summary.py
test/test_custom_roles.py
test/test_custom_roles_api.py
test/test_custom_workflow_input.py
Expand Down
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ We use several rate limiting strategies to ensure the availability of our APIs.
### Global rate limits

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:
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:

| Header name | Description |
| ------------------------------ | -------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -340,6 +340,14 @@ Use this header:
LD-API-Version: beta
```

## Federal environments

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.

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.

To learn more, read [LaunchDarkly in federal environments](https://docs.launchdarkly.com/home/advanced/federal).

## Versioning

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

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

Expand Down Expand Up @@ -507,8 +515,12 @@ Class | Method | HTTP request | Description
*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
*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
*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
*ApprovalsBetaApi* | [**delete_approval_request**](docs/ApprovalsBetaApi.md#delete_approval_request) | **DELETE** /api/v2/approval-requests/{id} | Delete approval request
*ApprovalsBetaApi* | [**get_approval_request**](docs/ApprovalsBetaApi.md#get_approval_request) | **GET** /api/v2/approval-requests/{id} | Get approval request
*ApprovalsBetaApi* | [**get_approval_requests**](docs/ApprovalsBetaApi.md#get_approval_requests) | **GET** /api/v2/approval-requests | List approval requests
*ApprovalsBetaApi* | [**post_approval_request**](docs/ApprovalsBetaApi.md#post_approval_request) | **POST** /api/v2/approval-requests | Create approval request
*ApprovalsBetaApi* | [**post_approval_request_apply**](docs/ApprovalsBetaApi.md#post_approval_request_apply) | **POST** /api/v2/approval-requests/{id}/apply | Apply approval request
*ApprovalsBetaApi* | [**post_approval_request_review**](docs/ApprovalsBetaApi.md#post_approval_request_review) | **POST** /api/v2/approval-requests/{id}/reviews | Review approval request
*AuditLogApi* | [**get_audit_log_entries**](docs/AuditLogApi.md#get_audit_log_entries) | **GET** /api/v2/auditlog | List audit log entries
*AuditLogApi* | [**get_audit_log_entry**](docs/AuditLogApi.md#get_audit_log_entry) | **GET** /api/v2/auditlog/{id} | Get audit log entry
*CodeReferencesApi* | [**delete_branches**](docs/CodeReferencesApi.md#delete_branches) | **POST** /api/v2/code-refs/repositories/{repo}/branch-delete-tasks | Delete branches
Expand Down Expand Up @@ -746,6 +758,7 @@ Class | Method | HTTP request | Description
- [ContextSearch](docs/ContextSearch.md)
- [Contexts](docs/Contexts.md)
- [CopiedFromEnv](docs/CopiedFromEnv.md)
- [CreateApprovalRequestRequest](docs/CreateApprovalRequestRequest.md)
- [CreateCopyFlagConfigApprovalRequestRequest](docs/CreateCopyFlagConfigApprovalRequestRequest.md)
- [CreateFlagConfigApprovalRequestRequest](docs/CreateFlagConfigApprovalRequestRequest.md)
- [CreateWorkflowTemplateInput](docs/CreateWorkflowTemplateInput.md)
Expand All @@ -755,6 +768,7 @@ Class | Method | HTTP request | Description
- [CustomRole](docs/CustomRole.md)
- [CustomRolePost](docs/CustomRolePost.md)
- [CustomRolePostData](docs/CustomRolePostData.md)
- [CustomRoleSummary](docs/CustomRoleSummary.md)
- [CustomRoles](docs/CustomRoles.md)
- [CustomWorkflowInput](docs/CustomWorkflowInput.md)
- [CustomWorkflowMeta](docs/CustomWorkflowMeta.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/AccountMembersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -517,8 +517,8 @@ with launchdarkly_api.ApiClient(configuration) as api_client:
NewMemberForm(
email="[email protected]",
password="***",
first_name="Sandy",
last_name="Smith",
first_name="Ariel",
last_name="Flores",
role="reader",
custom_roles=["customRole1","customRole2"],
team_keys=["team-1","team-2"],
Expand Down
8 changes: 4 additions & 4 deletions docs/AccountUsageBetaApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ Name | Type | Description | Notes
Get experimentation keys usage

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.
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.

### Example

Expand Down Expand Up @@ -319,7 +319,7 @@ Name | Type | Description | Notes
Get MAU SDKs by type

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

### Example

Expand Down Expand Up @@ -410,7 +410,7 @@ Name | Type | Description | Notes
Get MAU usage

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

### Example

Expand Down Expand Up @@ -511,7 +511,7 @@ Name | Type | Description | Notes
Get MAU usage by category

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

### Example

Expand Down
2 changes: 1 addition & 1 deletion docs/ApprovalsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -645,7 +645,7 @@ with launchdarkly_api.ApiClient(configuration) as api_client:
notify_member_ids=["1234a56b7c89d012345e678f"],
notify_team_keys=["example-reviewer-team"],
source=SourceFlag(
key="example-environment-key",
key="environment-key-123abc",
version=1,
),
included_actions=["updateOn"],
Expand Down
Loading

0 comments on commit 1e73a6a

Please sign in to comment.