StudyfetchSDK 0.0.2

Studyfetch SDK C# API Library

The Studyfetch SDK C# SDK provides convenient access to the Studyfetch SDK REST API from applications written in C#.

It is generated with Stainless.

The REST API documentation can be found on studyfetch.com.

Installation

dotnet add package StudyfetchSDK

Requirements

This library requires .NET 8 or later.

Usage

See the examples directory for complete and runnable examples.

using ContentProperties = StudyfetchSDK.Models.V1.Materials.MaterialCreateParamsProperties.ContentProperties;
using StudyfetchSDK;
using StudyfetchSDK.Models.V1.Materials;
using System;

// Configured using the STUDYFETCH_SDK_API_KEY and STUDYFETCH_SDK_BASE_URL environment variables
StudyfetchSDKClient client = new();

MaterialCreateParams parameters = new()
{
    Content = new(ContentProperties::Type.Text),
    Name = "Chapter 1 - Introduction",
};

var material = await client.V1.Materials.Create(parameters);

Console.WriteLine(material);

Client Configuration

Configure the client using environment variables:

using StudyfetchSDK;

// Configured using the STUDYFETCH_SDK_API_KEY and STUDYFETCH_SDK_BASE_URL environment variables
StudyfetchSDKClient client = new();

Or manually:

using StudyfetchSDK;

StudyfetchSDKClient client = new() { APIKey = "My API Key" };

Or using a combination of the two approaches.

See this table for the available options:

Requests and responses

To send a request to the Studyfetch SDK API, build an instance of some Params class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a C# class.

For example, client.V1.Materials.Create should be called with an instance of MaterialCreateParams, and it will return an instance of Task<MaterialCreateResponse>.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.