Recurse Center C# API Library

Note

The Recurse Center C# API Library is currently in beta and we're excited for you to experiment with it!

This library has not yet been exhaustively tested in production environments and may be missing some features you'd expect in a stable release. As we continue development, there may be breaking changes that require updates to your code.

We'd love your feedback! Please share any suggestions, bug reports, feature requests, or general thoughts by filing an issue.

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

It is generated with Stainless.

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

Installation

git clone [email protected]:recursecenter/recurse-sdk-csharp.git
dotnet add reference recurse-sdk-csharp/src/RecurseCenter

Requirements

This library requires .NET 8 or later.

Note

The library is currently in beta. The requirements will be lowered in the future.

Usage

See the examples directory for complete and runnable examples.

using System;
using RecurseCenter;

RecurseCenterClient client = new();

var page = await client.Profiles.List();

Console.WriteLine(page);

Client configuration

Configure the client using environment variables:

using RecurseCenter;

// Configured using the RECURSE_CENTER_API_KEY, RECURSE_CENTER_USERNAME, RECURSE_CENTER_PASSWORD and RECURSE_CENTER_BASE_URL environment variables
RecurseCenterClient client = new();

Or manually:

using RecurseCenter;

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

Or using a combination of the two approaches.

See this table for the available options:

Property	Environment variable	Required	Default value
APIKey	RECURSE_CENTER_API_KEY	false	-
Username	RECURSE_CENTER_USERNAME	false	-
Password	RECURSE_CENTER_PASSWORD	false	-
BaseUrl	RECURSE_CENTER_BASE_URL	true	"https://www.recurse.com/api/v1"

Modifying configuration

To temporarily use a modified client configuration, while reusing the same connection and thread pools, call WithOptions on any client or service:

using System;

var page = await client
    .WithOptions(options =>
        options with
        {
            BaseUrl = new("https://example.com"),
            Timeout = TimeSpan.FromSeconds(42),
        }
    )
    .Profiles.List();

Console.WriteLine(page);

Using a with expression makes it easy to construct the modified options.

The WithOptions method does not affect the original client or service.

Requests and responses

To send a request to the Recurse Center 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.Profiles.List should be called with an instance of ProfileListParams, and it will return an instance of Task<List<Profile>>.

Error handling

The SDK throws custom unchecked exception types:

• RecurseCenterApiException: Base class for API errors. See this table for which exception subclass is thrown for each HTTP status code:

Status	Exception
400	RecurseCenterBadRequestException
401	RecurseCenterUnauthorizedException
403	RecurseCenterForbiddenException
404	RecurseCenterNotFoundException
422	RecurseCenterUnprocessableEntityException
429	RecurseCenterRateLimitException
5xx	RecurseCenter5xxException
others	RecurseCenterUnexpectedStatusCodeException

Additionally, all 4xx errors inherit from RecurseCenter4xxException.

false

• RecurseCenterIOException: I/O networking errors.

• RecurseCenterInvalidDataException: Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.

• RecurseCenterException: Base class for all exceptions.

Network options

Retries

The SDK automatically retries 2 times by default, with a short exponential backoff between requests.

Only the following error types are retried:

• Connection errors (for example, due to a network connectivity problem)
• 408 Request Timeout
• 409 Conflict
• 429 Rate Limit
• 5xx Internal

The API may also explicitly instruct the SDK to retry or not retry a request.

To set a custom number of retries, configure the client using the MaxRetries method:

using RecurseCenter;

RecurseCenterClient client = new() { MaxRetries = 3 };

Or configure a single method call using WithOptions:

using System;

var page = await client
    .WithOptions(options =>
        options with { MaxRetries = 3 }
    )
    .Profiles.List();

Console.WriteLine(page);

Timeouts

Requests time out after 1 minute by default.

To set a custom timeout, configure the client using the Timeout option:

using System;
using RecurseCenter;

RecurseCenterClient client = new() { Timeout = TimeSpan.FromSeconds(42) };

Or configure a single method call using WithOptions:

using System;

var page = await client
    .WithOptions(options =>
        options with { Timeout = TimeSpan.FromSeconds(42) }
    )
    .Profiles.List();

Console.WriteLine(page);

Undocumented API functionality

The SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.

Response validation

In rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a string, but the API could return something else.

By default, the SDK will not throw an exception in this case. It will throw RecurseCenterInvalidDataException only if you directly access the property.

If you would prefer to check that the response is completely well-typed upfront, then either call Validate:

var profile = client.Profiles.Retrieve(parameters);
profile.Validate();

Or configure the client using the ResponseValidation option:

using RecurseCenter;

RecurseCenterClient client = new() { ResponseValidation = true };

Or configure a single method call using WithOptions:

using System;

var profile = await client
    .WithOptions(options =>
        options with { ResponseValidation = true }
    )
    .Profiles.Retrieve(parameters);

Console.WriteLine(profile);

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.