Skip to content

Commit 928b1bc

Browse files
author
LaunchDarklyReleaseBot
committed
Version 19.0.0 automatically generated from ld-openapi.
1 parent d7c21ca commit 928b1bc

21 files changed

+326
-58
lines changed

.openapi-generator/FILES

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,7 @@ docs/FollowFlagsApi.md
301301
docs/FollowersPerFlag.md
302302
docs/ForbiddenErrorRep.md
303303
docs/FormVariable.md
304+
docs/GenerateTrustPolicyPostRep.md
304305
docs/GenerateWarehouseDestinationKeyPairPostRep.md
305306
docs/GetAnnouncementsPublic200Response.md
306307
docs/GuardedReleaseConfig.md
@@ -576,6 +577,8 @@ docs/TreatmentRep.md
576577
docs/TriggerPost.md
577578
docs/TriggerWorkflowCollectionRep.md
578579
docs/TriggerWorkflowRep.md
580+
docs/TrustPolicyDetails.md
581+
docs/TrustPolicyStatement.md
579582
docs/UnauthorizedErrorRep.md
580583
docs/UnlinkResourceSuccessResponse.md
581584
docs/UpdatePhaseStatusInput.md

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This REST API is for custom integrations, data export, or automating your featur
66
This client library is only compatible with the latest version of our REST API. Previous versions of this client library are compatible with earlier versions of our REST API. When you create an access token, you can set the REST API version associated with the token. By default, API requests you send using the token will use the specified API version. To learn more, read [Versioning](https://apidocs.launchdarkly.com/#section/Overview/Versioning).
77
View our [sample code](#sample-code) for example usage.
88

9-
## launchdarkly-api-typescript@18.1.0
9+
## launchdarkly-api-typescript@19.0.0
1010

1111
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
1212

@@ -44,7 +44,7 @@ navigate to the folder of your consuming project and run one of the following co
4444
_published:_
4545

4646
```
47-
npm install launchdarkly-api-typescript@18.1.0 --save
47+
npm install launchdarkly-api-typescript@19.0.0 --save
4848
```
4949

5050
_unPublished (not recommended):_
@@ -181,6 +181,7 @@ Class | Method | HTTP request | Description
181181
*DataExportDestinationsApi* | [**getDestinations**](docs/DataExportDestinationsApi.md#getdestinations) | **GET** /api/v2/destinations | List destinations
182182
*DataExportDestinationsApi* | [**patchDestination**](docs/DataExportDestinationsApi.md#patchdestination) | **PATCH** /api/v2/destinations/{projectKey}/{environmentKey}/{id} | Update Data Export destination
183183
*DataExportDestinationsApi* | [**postDestination**](docs/DataExportDestinationsApi.md#postdestination) | **POST** /api/v2/destinations/{projectKey}/{environmentKey} | Create Data Export destination
184+
*DataExportDestinationsApi* | [**postGenerateTrustPolicy**](docs/DataExportDestinationsApi.md#postgeneratetrustpolicy) | **POST** /api/v2/destinations/projects/{projKey}/environments/{envKey}/generate-trust-policy | Generate trust policy
184185
*DataExportDestinationsApi* | [**postGenerateWarehouseDestinationKeyPair**](docs/DataExportDestinationsApi.md#postgeneratewarehousedestinationkeypair) | **POST** /api/v2/destinations/generate-warehouse-destination-key-pair | Generate Snowflake destination key pair
185186
*EnvironmentsApi* | [**deleteEnvironment**](docs/EnvironmentsApi.md#deleteenvironment) | **DELETE** /api/v2/projects/{projectKey}/environments/{environmentKey} | Delete environment
186187
*EnvironmentsApi* | [**getEnvironment**](docs/EnvironmentsApi.md#getenvironment) | **GET** /api/v2/projects/{projectKey}/environments/{environmentKey} | Get environment
@@ -672,6 +673,7 @@ Class | Method | HTTP request | Description
672673
- [FollowersPerFlag](docs/FollowersPerFlag.md)
673674
- [ForbiddenErrorRep](docs/ForbiddenErrorRep.md)
674675
- [FormVariable](docs/FormVariable.md)
676+
- [GenerateTrustPolicyPostRep](docs/GenerateTrustPolicyPostRep.md)
675677
- [GenerateWarehouseDestinationKeyPairPostRep](docs/GenerateWarehouseDestinationKeyPairPostRep.md)
676678
- [GetAnnouncementsPublic200Response](docs/GetAnnouncementsPublic200Response.md)
677679
- [GuardedReleaseConfig](docs/GuardedReleaseConfig.md)
@@ -922,6 +924,8 @@ Class | Method | HTTP request | Description
922924
- [TriggerPost](docs/TriggerPost.md)
923925
- [TriggerWorkflowCollectionRep](docs/TriggerWorkflowCollectionRep.md)
924926
- [TriggerWorkflowRep](docs/TriggerWorkflowRep.md)
927+
- [TrustPolicyDetails](docs/TrustPolicyDetails.md)
928+
- [TrustPolicyStatement](docs/TrustPolicyStatement.md)
925929
- [UnauthorizedErrorRep](docs/UnauthorizedErrorRep.md)
926930
- [UnlinkResourceSuccessResponse](docs/UnlinkResourceSuccessResponse.md)
927931
- [UpdatePhaseStatusInput](docs/UpdatePhaseStatusInput.md)

api.ts

Lines changed: 167 additions & 38 deletions
Large diffs are not rendered by default.

docs/AIConfig.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
1717
**variations** | [**Array<AIConfigVariation>**](AIConfigVariation.md) | | [default to undefined]
1818
**createdAt** | **number** | | [default to undefined]
1919
**updatedAt** | **number** | | [default to undefined]
20+
**evaluationMetricKeys** | **Array<string>** | List of evaluation metric keys for this AI config | [optional] [default to undefined]
2021

2122
## Example
2223

@@ -36,6 +37,7 @@ const instance: AIConfig = {
3637
variations,
3738
createdAt,
3839
updatedAt,
40+
evaluationMetricKeys,
3941
};
4042
```
4143

docs/AiConfigsMetricDataSourceRefRep.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**key** | **string** | | [optional] [default to undefined]
8+
**key** | **string** | | [default to undefined]
99
**environmentKey** | **string** | | [optional] [default to undefined]
1010
**_name** | **string** | | [optional] [default to undefined]
1111
**_integrationKey** | **string** | | [optional] [default to undefined]

docs/AiConfigsMetricListingRep.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Name | Type | Description | Notes
3737
**analysisType** | **string** | The method for analyzing metric events | [optional] [default to undefined]
3838
**percentileValue** | **number** | The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>. | [optional] [default to undefined]
3939
**eventDefault** | [**AiConfigsMetricEventDefaultRep**](AiConfigsMetricEventDefaultRep.md) | | [optional] [default to undefined]
40-
**dataSource** | [**AiConfigsMetricDataSourceRefRep**](AiConfigsMetricDataSourceRefRep.md) | | [optional] [default to undefined]
40+
**dataSource** | [**AiConfigsMetricDataSourceRefRep**](AiConfigsMetricDataSourceRefRep.md) | | [default to undefined]
4141
**archived** | **boolean** | Whether the metric version is archived | [optional] [default to undefined]
4242
**archivedAt** | **number** | | [optional] [default to undefined]
4343
**selector** | **string** | For click metrics, the CSS selectors | [optional] [default to undefined]

docs/DataExportDestinationsApi.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ All URIs are relative to *https://app.launchdarkly.com*
99
|[**getDestinations**](#getdestinations) | **GET** /api/v2/destinations | List destinations|
1010
|[**patchDestination**](#patchdestination) | **PATCH** /api/v2/destinations/{projectKey}/{environmentKey}/{id} | Update Data Export destination|
1111
|[**postDestination**](#postdestination) | **POST** /api/v2/destinations/{projectKey}/{environmentKey} | Create Data Export destination|
12+
|[**postGenerateTrustPolicy**](#postgeneratetrustpolicy) | **POST** /api/v2/destinations/projects/{projKey}/environments/{envKey}/generate-trust-policy | Generate trust policy|
1213
|[**postGenerateWarehouseDestinationKeyPair**](#postgeneratewarehousedestinationkeypair) | **POST** /api/v2/destinations/generate-warehouse-destination-key-pair | Generate Snowflake destination key pair|
1314

1415
# **deleteDestination**
@@ -309,6 +310,65 @@ const { status, data } = await apiInstance.postDestination(
309310

310311
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
311312

313+
# **postGenerateTrustPolicy**
314+
> GenerateTrustPolicyPostRep postGenerateTrustPolicy()
315+
316+
Trust policy to allow Data Export to assume the role and perform operations on AWS resources
317+
318+
### Example
319+
320+
```typescript
321+
import {
322+
DataExportDestinationsApi,
323+
Configuration
324+
} from 'launchdarkly-api-typescript';
325+
326+
const configuration = new Configuration();
327+
const apiInstance = new DataExportDestinationsApi(configuration);
328+
329+
let projKey: string; //The project key (default to undefined)
330+
let envKey: string; //The environment key (default to undefined)
331+
332+
const { status, data } = await apiInstance.postGenerateTrustPolicy(
333+
projKey,
334+
envKey
335+
);
336+
```
337+
338+
### Parameters
339+
340+
|Name | Type | Description | Notes|
341+
|------------- | ------------- | ------------- | -------------|
342+
| **projKey** | [**string**] | The project key | defaults to undefined|
343+
| **envKey** | [**string**] | The environment key | defaults to undefined|
344+
345+
346+
### Return type
347+
348+
**GenerateTrustPolicyPostRep**
349+
350+
### Authorization
351+
352+
[ApiKey](../README.md#ApiKey)
353+
354+
### HTTP request headers
355+
356+
- **Content-Type**: Not defined
357+
- **Accept**: application/json
358+
359+
360+
### HTTP response details
361+
| Status code | Description | Response headers |
362+
|-------------|-------------|------------------|
363+
|**201** | Generate trust policy response | - |
364+
|**400** | Invalid request | - |
365+
|**401** | Invalid access token | - |
366+
|**403** | Forbidden | - |
367+
|**409** | Status conflict | - |
368+
|**429** | Rate limited | - |
369+
370+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
371+
312372
# **postGenerateWarehouseDestinationKeyPair**
313373
> GenerateWarehouseDestinationKeyPairPostRep postGenerateWarehouseDestinationKeyPair()
314374

docs/FeatureFlagsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,7 @@ let tag: string; //Filter feature flags by tag (optional) (default to undefined)
528528
let limit: number; //The number of feature flags to return. Defaults to 20. (optional) (default to undefined)
529529
let offset: number; //Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional) (default to undefined)
530530
let archived: boolean; //Deprecated, use `filter=archived:true` instead. A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned (optional) (default to undefined)
531-
let summary: boolean; //By default, flags do _not_ include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` to include these fields for each flag returned. (optional) (default to undefined)
531+
let summary: boolean; //By default, flags do _not_ include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` and include the `env` query parameter to include these fields for each flag returned. (optional) (default to undefined)
532532
let filter: string; //A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. (optional) (default to undefined)
533533
let sort: string; //A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. (optional) (default to undefined)
534534
let compare: boolean; //Deprecated, unavailable in API version `20240415`. A boolean to filter results by only flags that have differences between environments. (optional) (default to undefined)
@@ -559,7 +559,7 @@ const { status, data } = await apiInstance.getFeatureFlags(
559559
| **limit** | [**number**] | The number of feature flags to return. Defaults to 20. | (optional) defaults to undefined|
560560
| **offset** | [**number**] | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. | (optional) defaults to undefined|
561561
| **archived** | [**boolean**] | Deprecated, use `filter=archived:true` instead. A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned | (optional) defaults to undefined|
562-
| **summary** | [**boolean**] | By default, flags do _not_ include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` to include these fields for each flag returned. | (optional) defaults to undefined|
562+
| **summary** | [**boolean**] | By default, flags do _not_ include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` and include the `env` query parameter to include these fields for each flag returned. | (optional) defaults to undefined|
563563
| **filter** | [**string**] | A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. | (optional) defaults to undefined|
564564
| **sort** | [**string**] | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. | (optional) defaults to undefined|
565565
| **compare** | [**boolean**] | Deprecated, unavailable in API version `20240415`. A boolean to filter results by only flags that have differences between environments. | (optional) defaults to undefined|

docs/GenerateTrustPolicyPostRep.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# GenerateTrustPolicyPostRep
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**awsTrustPolicy** | [**TrustPolicyDetails**](TrustPolicyDetails.md) | | [optional] [default to undefined]
9+
10+
## Example
11+
12+
```typescript
13+
import { GenerateTrustPolicyPostRep } from 'launchdarkly-api-typescript';
14+
15+
const instance: GenerateTrustPolicyPostRep = {
16+
awsTrustPolicy,
17+
};
18+
```
19+
20+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/MetricDataSourceRefRep.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**key** | **string** | | [optional] [default to undefined]
8+
**key** | **string** | | [default to undefined]
99
**environmentKey** | **string** | | [optional] [default to undefined]
1010
**_name** | **string** | | [optional] [default to undefined]
1111
**_integrationKey** | **string** | | [optional] [default to undefined]

0 commit comments

Comments
 (0)