NovaLab.ApiClient - the C# library for the NovaLab API

An ASP.NET Core Web API for managing your streams

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

• API version: v1
• SDK version: 1.0.0
• Generator version: 7.6.0
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen

Frameworks supported

Dependencies

• RestSharp - 106.13.0 or later
• Json.NET - 13.0.2 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

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 NovaLab.ApiClient.Api;
using NovaLab.ApiClient.Client;
using NovaLab.ApiClient.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 NovaLab.ApiClient.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 NovaLab.ApiClient.Api;
using NovaLab.ApiClient.Client;
using NovaLab.ApiClient.Model;

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

            Configuration config = new Configuration();
            config.BasePath = "http://localhost";
            var apiInstance = new TrackedStreamSubjectApi(config);
            var subjectId = "subjectId_example";  // Guid? |  (optional) 

            try
            {
                BooleanIApiResult result = apiInstance.DeleteTrackedStreamSubject(subjectId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling TrackedStreamSubjectApi.DeleteTrackedStreamSubject: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
TrackedStreamSubjectApi	DeleteTrackedStreamSubject	DELETE /api/twitch/tracked-stream-subject
TrackedStreamSubjectApi	GetTrackedStreamSubject	GET /api/twitch/tracked-stream-subject
TrackedStreamSubjectApi	GetTrackedStreamSubjects	GET /api/twitch/tracked-stream-subject/all
TrackedStreamSubjectApi	SelectTrackedStreamSubject	POST /api/twitch/tracked-stream-subject/select
TrackedStreamSubjectApi	UpsertTrackedStreamSubject	POST /api/twitch/tracked-stream-subject

Documentation for Models

• Model.ApiResult
• Model.BooleanIApiResult
• Model.HttpStatusCode
• Model.IApiResult
• Model.TrackedStreamSubjectDto
• Model.TrackedStreamSubjectDtoIApiResult
• Model.TrackedStreamSubjectDtoPost

Documentation for Authorization

Endpoints do not require authorization.