Skip to content

Commit 975b80a

Browse files
author
LaunchDarklyCI
committed
Version 3.4.0 automatically generated from ld-openapi@003892e.
1 parent 262055a commit 975b80a

File tree

230 files changed

+2333
-495
lines changed

Some content is hidden

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

230 files changed

+2333
-495
lines changed

‎README.md

Lines changed: 174 additions & 165 deletions
Large diffs are not rendered by default.

‎docs/AccessTokensApi.md

Lines changed: 328 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,328 @@
1+
# LaunchDarklyApi.AccessTokensApi
2+
3+
All URIs are relative to *https://app.launchdarkly.com/api/v2*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**deleteToken**](AccessTokensApi.md#deleteToken) | **DELETE** /tokens/{tokenId} | Delete an access token by ID.
8+
[**getToken**](AccessTokensApi.md#getToken) | **GET** /tokens/{tokenId} | Get a single access token by ID.
9+
[**getTokens**](AccessTokensApi.md#getTokens) | **GET** /tokens | Returns a list of tokens in the account.
10+
[**patchToken**](AccessTokensApi.md#patchToken) | **PATCH** /tokens/{tokenId} | Modify an access tokenby ID.
11+
[**postToken**](AccessTokensApi.md#postToken) | **POST** /tokens | Create a new token.
12+
[**resetToken**](AccessTokensApi.md#resetToken) | **POST** /tokens/{tokenId}/reset | Reset an access token's secret key with an optional expiry time for the old key.
13+
14+
15+
<a name="deleteToken"></a>
16+
# **deleteToken**
17+
> deleteToken(tokenId)
18+
19+
Delete an access token by ID.
20+
21+
### Example
22+
```javascript
23+
var LaunchDarklyApi = require('launchdarkly-api');
24+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
25+
26+
// Configure API key authorization: Token
27+
var Token = defaultClient.authentications['Token'];
28+
Token.apiKey = 'YOUR API KEY';
29+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
30+
//Token.apiKeyPrefix = 'Token';
31+
32+
var apiInstance = new LaunchDarklyApi.AccessTokensApi();
33+
34+
var tokenId = "tokenId_example"; // String | The access token ID.
35+
36+
37+
var callback = function(error, data, response) {
38+
if (error) {
39+
console.error(error);
40+
} else {
41+
console.log('API called successfully.');
42+
}
43+
};
44+
apiInstance.deleteToken(tokenId, callback);
45+
```
46+
47+
### Parameters
48+
49+
Name | Type | Description | Notes
50+
------------- | ------------- | ------------- | -------------
51+
**tokenId** | **String**| The access token ID. |
52+
53+
### Return type
54+
55+
null (empty response body)
56+
57+
### Authorization
58+
59+
[Token](../README.md#Token)
60+
61+
### HTTP request headers
62+
63+
- **Content-Type**: application/json
64+
- **Accept**: application/json
65+
66+
<a name="getToken"></a>
67+
# **getToken**
68+
> Token getToken(tokenId)
69+
70+
Get a single access token by ID.
71+
72+
### Example
73+
```javascript
74+
var LaunchDarklyApi = require('launchdarkly-api');
75+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
76+
77+
// Configure API key authorization: Token
78+
var Token = defaultClient.authentications['Token'];
79+
Token.apiKey = 'YOUR API KEY';
80+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
81+
//Token.apiKeyPrefix = 'Token';
82+
83+
var apiInstance = new LaunchDarklyApi.AccessTokensApi();
84+
85+
var tokenId = "tokenId_example"; // String | The access token ID.
86+
87+
88+
var callback = function(error, data, response) {
89+
if (error) {
90+
console.error(error);
91+
} else {
92+
console.log('API called successfully. Returned data: ' + data);
93+
}
94+
};
95+
apiInstance.getToken(tokenId, callback);
96+
```
97+
98+
### Parameters
99+
100+
Name | Type | Description | Notes
101+
------------- | ------------- | ------------- | -------------
102+
**tokenId** | **String**| The access token ID. |
103+
104+
### Return type
105+
106+
[**Token**](Token.md)
107+
108+
### Authorization
109+
110+
[Token](../README.md#Token)
111+
112+
### HTTP request headers
113+
114+
- **Content-Type**: application/json
115+
- **Accept**: application/json
116+
117+
<a name="getTokens"></a>
118+
# **getTokens**
119+
> Tokens getTokens(opts)
120+
121+
Returns a list of tokens in the account.
122+
123+
### Example
124+
```javascript
125+
var LaunchDarklyApi = require('launchdarkly-api');
126+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
127+
128+
// Configure API key authorization: Token
129+
var Token = defaultClient.authentications['Token'];
130+
Token.apiKey = 'YOUR API KEY';
131+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
132+
//Token.apiKeyPrefix = 'Token';
133+
134+
var apiInstance = new LaunchDarklyApi.AccessTokensApi();
135+
136+
var opts = {
137+
'showAll': true // Boolean | If set to true, and the authentication access token has the \"Admin\" role, personal access tokens for all members will be retrieved.
138+
};
139+
140+
var callback = function(error, data, response) {
141+
if (error) {
142+
console.error(error);
143+
} else {
144+
console.log('API called successfully. Returned data: ' + data);
145+
}
146+
};
147+
apiInstance.getTokens(opts, callback);
148+
```
149+
150+
### Parameters
151+
152+
Name | Type | Description | Notes
153+
------------- | ------------- | ------------- | -------------
154+
**showAll** | **Boolean**| If set to true, and the authentication access token has the \&quot;Admin\&quot; role, personal access tokens for all members will be retrieved. | [optional]
155+
156+
### Return type
157+
158+
[**Tokens**](Tokens.md)
159+
160+
### Authorization
161+
162+
[Token](../README.md#Token)
163+
164+
### HTTP request headers
165+
166+
- **Content-Type**: application/json
167+
- **Accept**: application/json
168+
169+
<a name="patchToken"></a>
170+
# **patchToken**
171+
> Token patchToken(tokenIdpatchDelta)
172+
173+
Modify an access tokenby ID.
174+
175+
### Example
176+
```javascript
177+
var LaunchDarklyApi = require('launchdarkly-api');
178+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
179+
180+
// Configure API key authorization: Token
181+
var Token = defaultClient.authentications['Token'];
182+
Token.apiKey = 'YOUR API KEY';
183+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
184+
//Token.apiKeyPrefix = 'Token';
185+
186+
var apiInstance = new LaunchDarklyApi.AccessTokensApi();
187+
188+
var tokenId = "tokenId_example"; // String | The access token ID.
189+
190+
var patchDelta = [new LaunchDarklyApi.PatchOperation()]; // [PatchOperation] | Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
191+
192+
193+
var callback = function(error, data, response) {
194+
if (error) {
195+
console.error(error);
196+
} else {
197+
console.log('API called successfully. Returned data: ' + data);
198+
}
199+
};
200+
apiInstance.patchToken(tokenIdpatchDelta, callback);
201+
```
202+
203+
### Parameters
204+
205+
Name | Type | Description | Notes
206+
------------- | ------------- | ------------- | -------------
207+
**tokenId** | **String**| The access token ID. |
208+
**patchDelta** | [**[PatchOperation]**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39; |
209+
210+
### Return type
211+
212+
[**Token**](Token.md)
213+
214+
### Authorization
215+
216+
[Token](../README.md#Token)
217+
218+
### HTTP request headers
219+
220+
- **Content-Type**: application/json
221+
- **Accept**: application/json
222+
223+
<a name="postToken"></a>
224+
# **postToken**
225+
> Token postToken(tokenBody)
226+
227+
Create a new token.
228+
229+
### Example
230+
```javascript
231+
var LaunchDarklyApi = require('launchdarkly-api');
232+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
233+
234+
// Configure API key authorization: Token
235+
var Token = defaultClient.authentications['Token'];
236+
Token.apiKey = 'YOUR API KEY';
237+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
238+
//Token.apiKeyPrefix = 'Token';
239+
240+
var apiInstance = new LaunchDarklyApi.AccessTokensApi();
241+
242+
var tokenBody = new LaunchDarklyApi.TokenBody(); // TokenBody | Create a new access token.
243+
244+
245+
var callback = function(error, data, response) {
246+
if (error) {
247+
console.error(error);
248+
} else {
249+
console.log('API called successfully. Returned data: ' + data);
250+
}
251+
};
252+
apiInstance.postToken(tokenBody, callback);
253+
```
254+
255+
### Parameters
256+
257+
Name | Type | Description | Notes
258+
------------- | ------------- | ------------- | -------------
259+
**tokenBody** | [**TokenBody**](TokenBody.md)| Create a new access token. |
260+
261+
### Return type
262+
263+
[**Token**](Token.md)
264+
265+
### Authorization
266+
267+
[Token](../README.md#Token)
268+
269+
### HTTP request headers
270+
271+
- **Content-Type**: application/json
272+
- **Accept**: application/json
273+
274+
<a name="resetToken"></a>
275+
# **resetToken**
276+
> Token resetToken(tokenId, opts)
277+
278+
Reset an access token&#39;s secret key with an optional expiry time for the old key.
279+
280+
### Example
281+
```javascript
282+
var LaunchDarklyApi = require('launchdarkly-api');
283+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
284+
285+
// Configure API key authorization: Token
286+
var Token = defaultClient.authentications['Token'];
287+
Token.apiKey = 'YOUR API KEY';
288+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
289+
//Token.apiKeyPrefix = 'Token';
290+
291+
var apiInstance = new LaunchDarklyApi.AccessTokensApi();
292+
293+
var tokenId = "tokenId_example"; // String | The access token ID.
294+
295+
var opts = {
296+
'expiry': 789 // Number | An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.
297+
};
298+
299+
var callback = function(error, data, response) {
300+
if (error) {
301+
console.error(error);
302+
} else {
303+
console.log('API called successfully. Returned data: ' + data);
304+
}
305+
};
306+
apiInstance.resetToken(tokenId, opts, callback);
307+
```
308+
309+
### Parameters
310+
311+
Name | Type | Description | Notes
312+
------------- | ------------- | ------------- | -------------
313+
**tokenId** | **String**| The access token ID. |
314+
**expiry** | **Number**| An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately. | [optional]
315+
316+
### Return type
317+
318+
[**Token**](Token.md)
319+
320+
### Authorization
321+
322+
[Token](../README.md#Token)
323+
324+
### HTTP request headers
325+
326+
- **Content-Type**: application/json
327+
- **Accept**: application/json
328+

‎docs/FeatureFlagsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,7 @@ var projectKey = "projectKey_example"; // String | The project key, used to tie
432432
var opts = {
433433
'env': ["env_example"] // [String] | By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env=[\"production\"] will restrict the returned configurations to just your production environment.
434434
'summary': true, // Boolean | By default in api version >= 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary=0 to include these fields for each flag returned.
435-
'archived': true, // Boolean | When set to 1, archived flags will be included in the list of flags returned. By default, archived flags are not included in the list of flags.
435+
'archived': true, // Boolean | When set to 1, only archived flags will be included in the list of flags returned. By default, archived flags are not included in the list of flags.
436436
'limit': 8.14, // Number | The number of objects to return. Defaults to -1, which returns everything.
437437
'offset': 8.14, // Number | Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items.
438438
'filter': "filter_example", // String | A comma-separated list of filters. Each filter is of the form field:value.
@@ -457,7 +457,7 @@ Name | Type | Description | Notes
457457
**projectKey** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
458458
**env** | [**[String]**](String.md)| By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env&#x3D;[\&quot;production\&quot;] will restrict the returned configurations to just your production environment. | [optional]
459459
**summary** | **Boolean**| By default in api version &gt;&#x3D; 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary&#x3D;0 to include these fields for each flag returned. | [optional]
460-
**archived** | **Boolean**| When set to 1, archived flags will be included in the list of flags returned. By default, archived flags are not included in the list of flags. | [optional]
460+
**archived** | **Boolean**| When set to 1, only archived flags will be included in the list of flags returned. By default, archived flags are not included in the list of flags. | [optional]
461461
**limit** | **Number**| The number of objects to return. Defaults to -1, which returns everything. | [optional]
462462
**offset** | **Number**| Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items. | [optional]
463463
**filter** | **String**| A comma-separated list of filters. Each filter is of the form field:value. | [optional]

‎docs/Token.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# LaunchDarklyApi.Token
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**links** | [**Links**](Links.md) | | [optional]
7+
**id** | [**Id**](Id.md) | | [optional]
8+
**ownerId** | [**Id**](Id.md) | | [optional]
9+
**memberId** | [**Id**](Id.md) | | [optional]
10+
**member** | [**Member**](Member.md) | | [optional]
11+
**creationDate** | **Number** | A unix epoch time in milliseconds specifying the creation time of this access token. | [optional]
12+
**lastModified** | **Number** | A unix epoch time in milliseconds specifying the last time this access token was modified. | [optional]
13+
**lastUsed** | **Number** | A unix epoch time in milliseconds specifying the last time this access token was used to authorize access to the LaunchDarkly REST API. | [optional]
14+
**token** | **String** | The last 4 digits of the unique secret key for this access token. If creating or resetting the token, this will be the full token secret. | [optional]
15+
**name** | **String** | A human-friendly name for the access token | [optional]
16+
**role** | **String** | The name of a built-in role for the token | [optional]
17+
**customRoleIds** | **[String]** | A list of custom role IDs to use as access limits for the access token | [optional]
18+
**inlineRole** | [**[Statement]**](Statement.md) | | [optional]
19+
**serviceToken** | **Boolean** | Whether the token will be a service token https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens | [optional]
20+
**defaultApiVersion** | **Number** | The default API version for this token | [optional]
21+
22+

‎docs/TokenBody.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# LaunchDarklyApi.TokenBody
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **String** | A human-friendly name for the access token | [optional]
7+
**role** | **String** | The name of a built-in role for the token | [optional]
8+
**customRoleIds** | **[String]** | A list of custom role IDs to use as access limits for the access token | [optional]
9+
**inlineRole** | [**[Statement]**](Statement.md) | | [optional]
10+
**serviceToken** | **Boolean** | Whether the token will be a service token https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens | [optional]
11+
**defaultApiVersion** | **Number** | The default API version for this token | [optional]
12+
13+

‎docs/Tokens.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# LaunchDarklyApi.Tokens
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**links** | [**Links**](Links.md) | | [optional]
7+
**items** | [**[Token]**](Token.md) | | [optional]
8+
9+

0 commit comments

Comments
 (0)