Skip to content

Commit 540569d

Browse files
author
LaunchDarklyCI
committed
Version 3.8.0 automatically generated from ld-openapi@ed00931.
1 parent 89b6ea3 commit 540569d

File tree

275 files changed

+3041
-571
lines changed

Some content is hidden

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

275 files changed

+3041
-571
lines changed

‎README.md

Lines changed: 208 additions & 195 deletions
Large diffs are not rendered by default.

‎docs/HierarchicalLinks.md

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

‎docs/Integration.md

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

‎docs/IntegrationLinks.md

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

‎docs/IntegrationSubscription.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# LaunchDarklyApi.IntegrationSubscription
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**links** | [**HierarchicalLinks**](HierarchicalLinks.md) | | [optional]
7+
**id** | [**Id**](Id.md) | | [optional]
8+
**kind** | **String** | The type of integration associated with this configuration. | [optional]
9+
**name** | **String** | The user-defined name associated with this configuration. | [optional]
10+
**config** | **Object** | A key-value mapping of configuration fields. | [optional]
11+
**statements** | [**[Statement]**](Statement.md) | | [optional]
12+
**on** | **Boolean** | Whether or not the integration is currently active. | [optional]
13+
**tags** | **[String]** | An array of tags for this integration configuration. | [optional]
14+
**status** | [**IntegrationSubscriptionStatus**](IntegrationSubscriptionStatus.md) | | [optional]
15+
16+

‎docs/IntegrationSubscriptionStatus.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# LaunchDarklyApi.IntegrationSubscriptionStatus
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**successCount** | **Number** | | [optional]
7+
**lastSuccess** | **Number** | A unix epoch time in milliseconds specifying the last time this integration was successfully used. | [optional]
8+
**errorCount** | **Number** | | [optional]
9+
10+

‎docs/Integrations.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# LaunchDarklyApi.Integrations
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**links** | **Object** | A mapping of integration types to their respective API endpoints. | [optional]
7+
**items** | [**[IntegrationSubscription]**](IntegrationSubscription.md) | | [optional]
8+
9+

‎docs/IntegrationsApi.md

Lines changed: 329 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,329 @@
1+
# LaunchDarklyApi.IntegrationsApi
2+
3+
All URIs are relative to *https://app.launchdarkly.com/api/v2*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**deleteIntegrationSubscription**](IntegrationsApi.md#deleteIntegrationSubscription) | **DELETE** /integrations/{integrationKey}/{integrationId} | Delete an integration subscription by ID.
8+
[**getIntegrationSubscription**](IntegrationsApi.md#getIntegrationSubscription) | **GET** /integrations/{integrationKey}/{integrationId} | Get a single integration subscription by ID.
9+
[**getIntegrationSubscriptions**](IntegrationsApi.md#getIntegrationSubscriptions) | **GET** /integrations/{integrationKey} | Get a list of all configured integrations of a given kind.
10+
[**getIntegrations**](IntegrationsApi.md#getIntegrations) | **GET** /integrations | Get a list of all configured audit log event integrations associated with this account.
11+
[**patchIntegrationSubscription**](IntegrationsApi.md#patchIntegrationSubscription) | **PATCH** /integrations/{integrationKey}/{integrationId} | Modify an integration subscription by ID.
12+
[**postIntegrationSubscription**](IntegrationsApi.md#postIntegrationSubscription) | **POST** /integrations/{integrationKey} | Create a new integration subscription of a given kind.
13+
14+
15+
<a name="deleteIntegrationSubscription"></a>
16+
# **deleteIntegrationSubscription**
17+
> deleteIntegrationSubscription(integrationKey, integrationId, )
18+
19+
Delete an integration subscription 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.IntegrationsApi();
33+
34+
var integrationKey = "integrationKey_example"; // String | The key used to specify the integration kind.
35+
36+
var integrationId = "integrationId_example"; // String | The integration ID.
37+
38+
39+
var callback = function(error, data, response) {
40+
if (error) {
41+
console.error(error);
42+
} else {
43+
console.log('API called successfully.');
44+
}
45+
};
46+
apiInstance.deleteIntegrationSubscription(integrationKey, integrationId, , callback);
47+
```
48+
49+
### Parameters
50+
51+
Name | Type | Description | Notes
52+
------------- | ------------- | ------------- | -------------
53+
**integrationKey** | **String**| The key used to specify the integration kind. |
54+
**integrationId** | **String**| The integration ID. |
55+
56+
### Return type
57+
58+
null (empty response body)
59+
60+
### Authorization
61+
62+
[Token](../README.md#Token)
63+
64+
### HTTP request headers
65+
66+
- **Content-Type**: application/json
67+
- **Accept**: application/json
68+
69+
<a name="getIntegrationSubscription"></a>
70+
# **getIntegrationSubscription**
71+
> IntegrationSubscription getIntegrationSubscription(integrationKey, integrationId, )
72+
73+
Get a single integration subscription by ID.
74+
75+
### Example
76+
```javascript
77+
var LaunchDarklyApi = require('launchdarkly-api');
78+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
79+
80+
// Configure API key authorization: Token
81+
var Token = defaultClient.authentications['Token'];
82+
Token.apiKey = 'YOUR API KEY';
83+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
84+
//Token.apiKeyPrefix = 'Token';
85+
86+
var apiInstance = new LaunchDarklyApi.IntegrationsApi();
87+
88+
var integrationKey = "integrationKey_example"; // String | The key used to specify the integration kind.
89+
90+
var integrationId = "integrationId_example"; // String | The integration ID.
91+
92+
93+
var callback = function(error, data, response) {
94+
if (error) {
95+
console.error(error);
96+
} else {
97+
console.log('API called successfully. Returned data: ' + data);
98+
}
99+
};
100+
apiInstance.getIntegrationSubscription(integrationKey, integrationId, , callback);
101+
```
102+
103+
### Parameters
104+
105+
Name | Type | Description | Notes
106+
------------- | ------------- | ------------- | -------------
107+
**integrationKey** | **String**| The key used to specify the integration kind. |
108+
**integrationId** | **String**| The integration ID. |
109+
110+
### Return type
111+
112+
[**IntegrationSubscription**](IntegrationSubscription.md)
113+
114+
### Authorization
115+
116+
[Token](../README.md#Token)
117+
118+
### HTTP request headers
119+
120+
- **Content-Type**: application/json
121+
- **Accept**: application/json
122+
123+
<a name="getIntegrationSubscriptions"></a>
124+
# **getIntegrationSubscriptions**
125+
> Integration getIntegrationSubscriptions(integrationKey, )
126+
127+
Get a list of all configured integrations of a given kind.
128+
129+
### Example
130+
```javascript
131+
var LaunchDarklyApi = require('launchdarkly-api');
132+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
133+
134+
// Configure API key authorization: Token
135+
var Token = defaultClient.authentications['Token'];
136+
Token.apiKey = 'YOUR API KEY';
137+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
138+
//Token.apiKeyPrefix = 'Token';
139+
140+
var apiInstance = new LaunchDarklyApi.IntegrationsApi();
141+
142+
var integrationKey = "integrationKey_example"; // String | The key used to specify the integration kind.
143+
144+
145+
var callback = function(error, data, response) {
146+
if (error) {
147+
console.error(error);
148+
} else {
149+
console.log('API called successfully. Returned data: ' + data);
150+
}
151+
};
152+
apiInstance.getIntegrationSubscriptions(integrationKey, , callback);
153+
```
154+
155+
### Parameters
156+
157+
Name | Type | Description | Notes
158+
------------- | ------------- | ------------- | -------------
159+
**integrationKey** | **String**| The key used to specify the integration kind. |
160+
161+
### Return type
162+
163+
[**Integration**](Integration.md)
164+
165+
### Authorization
166+
167+
[Token](../README.md#Token)
168+
169+
### HTTP request headers
170+
171+
- **Content-Type**: application/json
172+
- **Accept**: application/json
173+
174+
<a name="getIntegrations"></a>
175+
# **getIntegrations**
176+
> Integrations getIntegrations()
177+
178+
Get a list of all configured audit log event integrations associated with this account.
179+
180+
### Example
181+
```javascript
182+
var LaunchDarklyApi = require('launchdarkly-api');
183+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
184+
185+
// Configure API key authorization: Token
186+
var Token = defaultClient.authentications['Token'];
187+
Token.apiKey = 'YOUR API KEY';
188+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
189+
//Token.apiKeyPrefix = 'Token';
190+
191+
var apiInstance = new LaunchDarklyApi.IntegrationsApi();
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.getIntegrations(callback);
201+
```
202+
203+
### Parameters
204+
This endpoint does not need any parameter.
205+
206+
### Return type
207+
208+
[**Integrations**](Integrations.md)
209+
210+
### Authorization
211+
212+
[Token](../README.md#Token)
213+
214+
### HTTP request headers
215+
216+
- **Content-Type**: application/json
217+
- **Accept**: application/json
218+
219+
<a name="patchIntegrationSubscription"></a>
220+
# **patchIntegrationSubscription**
221+
> IntegrationSubscription patchIntegrationSubscription(integrationKey, integrationId, patchDelta)
222+
223+
Modify an integration subscription by ID.
224+
225+
### Example
226+
```javascript
227+
var LaunchDarklyApi = require('launchdarkly-api');
228+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
229+
230+
// Configure API key authorization: Token
231+
var Token = defaultClient.authentications['Token'];
232+
Token.apiKey = 'YOUR API KEY';
233+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
234+
//Token.apiKeyPrefix = 'Token';
235+
236+
var apiInstance = new LaunchDarklyApi.IntegrationsApi();
237+
238+
var integrationKey = "integrationKey_example"; // String | The key used to specify the integration kind.
239+
240+
var integrationId = "integrationId_example"; // String | The integration ID.
241+
242+
var patchDelta = [new LaunchDarklyApi.PatchOperation()]; // [PatchOperation] | Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
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.patchIntegrationSubscription(integrationKey, integrationId, patchDelta, callback);
253+
```
254+
255+
### Parameters
256+
257+
Name | Type | Description | Notes
258+
------------- | ------------- | ------------- | -------------
259+
**integrationKey** | **String**| The key used to specify the integration kind. |
260+
**integrationId** | **String**| The integration ID. |
261+
**patchDelta** | [**[PatchOperation]**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39; |
262+
263+
### Return type
264+
265+
[**IntegrationSubscription**](IntegrationSubscription.md)
266+
267+
### Authorization
268+
269+
[Token](../README.md#Token)
270+
271+
### HTTP request headers
272+
273+
- **Content-Type**: application/json
274+
- **Accept**: application/json
275+
276+
<a name="postIntegrationSubscription"></a>
277+
# **postIntegrationSubscription**
278+
> IntegrationSubscription postIntegrationSubscription(integrationKey, subscriptionBody)
279+
280+
Create a new integration subscription of a given kind.
281+
282+
### Example
283+
```javascript
284+
var LaunchDarklyApi = require('launchdarkly-api');
285+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
286+
287+
// Configure API key authorization: Token
288+
var Token = defaultClient.authentications['Token'];
289+
Token.apiKey = 'YOUR API KEY';
290+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
291+
//Token.apiKeyPrefix = 'Token';
292+
293+
var apiInstance = new LaunchDarklyApi.IntegrationsApi();
294+
295+
var integrationKey = "integrationKey_example"; // String | The key used to specify the integration kind.
296+
297+
var subscriptionBody = new LaunchDarklyApi.SubscriptionBody(); // SubscriptionBody | Create a new integration subscription.
298+
299+
300+
var callback = function(error, data, response) {
301+
if (error) {
302+
console.error(error);
303+
} else {
304+
console.log('API called successfully. Returned data: ' + data);
305+
}
306+
};
307+
apiInstance.postIntegrationSubscription(integrationKey, subscriptionBody, callback);
308+
```
309+
310+
### Parameters
311+
312+
Name | Type | Description | Notes
313+
------------- | ------------- | ------------- | -------------
314+
**integrationKey** | **String**| The key used to specify the integration kind. |
315+
**subscriptionBody** | [**SubscriptionBody**](SubscriptionBody.md)| Create a new integration subscription. |
316+
317+
### Return type
318+
319+
[**IntegrationSubscription**](IntegrationSubscription.md)
320+
321+
### Authorization
322+
323+
[Token](../README.md#Token)
324+
325+
### HTTP request headers
326+
327+
- **Content-Type**: application/json
328+
- **Accept**: application/json
329+

0 commit comments

Comments
 (0)