Skip to content

Commit

Permalink
Merge pull request #2 from sendinblue/update_README_File
Browse files Browse the repository at this point in the history
Update readme file
  • Loading branch information
amitsendinblue authored Apr 1, 2019
2 parents bd80fbd + 7d0a286 commit 4e0a4d6
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,10 @@ This C# SDK is automatically generated by the [Swagger Codegen](https://github.c
- Build package: io.swagger.codegen.languages.CSharpClientCodegen
For more information, please visit [https://account.sendinblue.com/support](https://account.sendinblue.com/support)

<a name="frameworks-supported"></a>
## Frameworks supported
- .NET 4.0 or later
- Windows Phone 7.1 (Mango)

<a name="dependencies"></a>
## Dependencies
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 105.1.0 or later
- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 7.0.0 or later
Expand All @@ -33,16 +31,20 @@ Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See [RestSharp#742](https://github.com/restsharp/RestSharp/issues/742)

<a name="installation"></a>
## Installation
Include the Dependencies (RestSharp, Json.NET and JsonSubTypes as mentioned in Dependencies section) in the C# project, and use the namespaces:
- Include the Dependencies (RestSharp, Json.NET and JsonSubTypes as mentioned in Dependencies section) in the C# project.

**OR**

Install the latest version of our sib_api_v3_sdk from [nuget](https://www.nuget.org/packages/sib_api_v3_sdk/).

- Use the namespaces:
```csharp
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;
```

<a name="getting-started"></a>
## Getting Started

```csharp
Expand Down Expand Up @@ -86,7 +88,6 @@ namespace Example
}
```

<a name="documentation-for-api-endpoints"></a>
## Documentation for API Endpoints

All URIs are relative to *https://api.sendinblue.com/v3*
Expand Down Expand Up @@ -199,7 +200,6 @@ Class | Method | HTTP request | Description
*WebhooksApi* | [**UpdateWebhook**](docs/WebhooksApi.md#updatewebhook) | **PUT** /webhooks/{webhookId} | Update a webhook


<a name="documentation-for-models"></a>
## Documentation for Models

- [Model.AddContactToList](docs/AddContactToList.md)
Expand Down Expand Up @@ -353,17 +353,14 @@ Class | Method | HTTP request | Description
- [Model.GetEmailCampaign](docs/GetEmailCampaign.md)


<a name="documentation-for-authorization"></a>
## Documentation for Authorization

<a name="api-key"></a>
### api-key

- **Type**: API key
- **API key parameter name**: api-key
- **Location**: HTTP header

<a name="partner-key"></a>
### partner-key

The partner key should be passed in the request headers as `partner-key` along with `api-key` pair for successful authentication of partner (Optional).
Expand Down

0 comments on commit 4e0a4d6

Please sign in to comment.