|
| 1 | +# IO.Swagger - the C# library for the LaunchDarkly REST API |
| 2 | + |
| 3 | +Build custom integrations with the LaunchDarkly REST API |
| 4 | + |
| 5 | +This C# SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: |
| 6 | + |
| 7 | +- API version: 2.0.0 |
| 8 | +- SDK version: 1.0.0 |
| 9 | +- Build date: 2017-09-08T14:59:53.133-07:00 |
| 10 | +- Build package: io.swagger.codegen.languages.CsharpDotNet2ClientCodegen |
| 11 | + For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com) |
| 12 | + |
| 13 | +<a name="frameworks-supported"></a> |
| 14 | +## Frameworks supported |
| 15 | +- .NET 2.0 |
| 16 | + |
| 17 | +<a name="dependencies"></a> |
| 18 | +## Dependencies |
| 19 | +- Mono compiler |
| 20 | +- Newtonsoft.Json.7.0.1 |
| 21 | +- RestSharp.Net2.1.1.11 |
| 22 | + |
| 23 | +Note: NuGet is downloaded by the mono compilation script and packages are installed with it. No dependency DLLs are bundled with this generator |
| 24 | + |
| 25 | +<a name="installation"></a> |
| 26 | +## Installation |
| 27 | +Run the following command to generate the DLL |
| 28 | +- [Mac/Linux] `/bin/sh compile-mono.sh` |
| 29 | +- [Windows] TODO |
| 30 | + |
| 31 | +Then include the DLL (under the `bin` folder) in the C# project, and use the namespaces: |
| 32 | +```csharp |
| 33 | +using IO.Swagger.IO.Swagger.Api; |
| 34 | +using IO.Swagger.Client; |
| 35 | +using IO.Swagger.IO.Swagger.Model; |
| 36 | +``` |
| 37 | +<a name="getting-started"></a> |
| 38 | +## Getting Started |
| 39 | + |
| 40 | +```csharp |
| 41 | +using System; |
| 42 | +using System.Diagnostics; |
| 43 | +using IO.Swagger.Api; |
| 44 | +using IO.Swagger.Client; |
| 45 | +using IO.Swagger.Model; |
| 46 | + |
| 47 | +namespace Example |
| 48 | +{ |
| 49 | + public class Example |
| 50 | + { |
| 51 | + public void main() |
| 52 | + { |
| 53 | + |
| 54 | + // Configure API key authorization: Token |
| 55 | + Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY"); |
| 56 | + // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 57 | + // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer"); |
| 58 | +
|
| 59 | + var apiInstance = new RootApi(); |
| 60 | + |
| 61 | + try |
| 62 | + { |
| 63 | + // Get the root resource |
| 64 | + Links result = apiInstance.GetRoot(); |
| 65 | + Debug.WriteLine(result); |
| 66 | + } |
| 67 | + catch (Exception e) |
| 68 | + { |
| 69 | + Debug.Print("Exception when calling RootApi.GetRoot: " + e.Message ); |
| 70 | + } |
| 71 | + } |
| 72 | + } |
| 73 | +} |
| 74 | +``` |
| 75 | + |
| 76 | +<a name="documentation-for-api-endpoints"></a> |
| 77 | +## Documentation for API Endpoints |
| 78 | + |
| 79 | +All URIs are relative to *https://app.launchdarkly.com/api/v2* |
| 80 | + |
| 81 | +Class | Method | HTTP request | Description |
| 82 | +------------ | ------------- | ------------- | ------------- |
| 83 | +*RootApi* | [**GetRoot**](docs/RootApi.md#getroot) | **GET** / | Get the root resource |
| 84 | +*WebhooksApi* | [**DeleteWebhook**](docs/WebhooksApi.md#deletewebhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook by ID |
| 85 | +*WebhooksApi* | [**GetWebhook**](docs/WebhooksApi.md#getwebhook) | **GET** /webhooks/{webhookId} | Get a webhook by ID |
| 86 | +*WebhooksApi* | [**GetWebhooks**](docs/WebhooksApi.md#getwebhooks) | **GET** /webhooks | Fetch a list of all webhooks |
| 87 | +*WebhooksApi* | [**PatchWebhook**](docs/WebhooksApi.md#patchwebhook) | **PATCH** /webhooks/{webhookId} | Modify a webhook by ID |
| 88 | +*WebhooksApi* | [**PostWebhook**](docs/WebhooksApi.md#postwebhook) | **POST** /webhooks | Create a webhook |
| 89 | + |
| 90 | + |
| 91 | +<a name="documentation-for-models"></a> |
| 92 | +## Documentation for Models |
| 93 | + |
| 94 | + - [IO.Swagger.Model.Link](docs/Link.md) |
| 95 | + - [IO.Swagger.Model.Links](docs/Links.md) |
| 96 | + - [IO.Swagger.Model.PatchDelta](docs/PatchDelta.md) |
| 97 | + - [IO.Swagger.Model.Webhook](docs/Webhook.md) |
| 98 | + - [IO.Swagger.Model.WebhookPost](docs/WebhookPost.md) |
| 99 | + - [IO.Swagger.Model.Webhooks](docs/Webhooks.md) |
| 100 | + |
| 101 | + |
| 102 | +<a name="documentation-for-authorization"></a> |
| 103 | +## Documentation for Authorization |
| 104 | + |
| 105 | +<a name="Token"></a> |
| 106 | +### Token |
| 107 | + |
| 108 | +- **Type**: API key |
| 109 | +- **API key parameter name**: Authorization |
| 110 | +- **Location**: HTTP header |
| 111 | + |
0 commit comments