/netcoreapp-test

Primary LanguageC#

Au.Com.Dingomail.Api.Dingomailau - the C# library for the Dingo Mail AU API

API for api.dingomail.com.au

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 0.2.4
  • SDK version: 1.0.0
  • Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen

Frameworks supported

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Au.Com.Dingomail.Api.Dingomailau.Api;
using Au.Com.Dingomail.Api.Dingomailau.Client;
using Au.Com.Dingomail.Api.Dingomailau.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out Au.Com.Dingomail.Api.Dingomailau.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Au.Com.Dingomail.Api.Dingomailau.Api;
using Au.Com.Dingomail.Api.Dingomailau.Client;
using Au.Com.Dingomail.Api.Dingomailau.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.dingomail.com.au";
            // Configure API key authorization: Key Secret
            config.ApiKey.Add("keysecret", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("keysecret", "Bearer");

            var apiInstance = new EmailApi(config);
            var id = 61ad5fae747be1587d421562;  // string | ID of the Email
            var keyid = ;  // string | The ID of the API Key being used

            try
            {
                CheckStatus result = apiInstance.CheckStatus(id, keyid);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling EmailApi.CheckStatus: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.dingomail.com.au

Class Method HTTP request Description
EmailApi CheckStatus GET /email/{id}
EmailApi Create POST /email
OptoutsApi GetUnsubscribes GET /optouts

Documentation for Models

Documentation for Authorization

Key ID

  • Type: API key
  • API key parameter name: keyid
  • Location: HTTP header

Key Secret

  • Type: API key
  • API key parameter name: keysecret
  • Location: HTTP header