TimeWizard.Sdk 0.1.116

Time Wizard .NET SDK

Official .NET client for the Time Wizard public REST API. Generated from the live OpenAPI spec on every push, so the SDK never lags behind the API.

Install

dotnet add package TimeWizard.Sdk

Targets netstandard2.1.

Quick start

using TimeWizard.Sdk;

var client = new TimeWizardClient("acme", "tw_...");

var workers = await client.Workers.ListWorkersAsync();
foreach (var worker in workers)
{
    Console.WriteLine($"{worker.FirstName} {worker.LastName}");
}

The constructor takes:

• slug — your workspace slug, i.e. the subdomain on timewizard.io.
• apiKey — a tenant-scoped API key minted from the admin "API keys" screen. Keys are prefixed tw_.

The client targets https://{slug}.timewizard.io/api/v1 and sends the key as Authorization: Bearer <apiKey> on every request.

Identifying your application

Pass an optional userAgent to identify your integration in our server logs — useful when you contact support or want to correlate spikes back to a specific deployment:

var client = new TimeWizardClient("acme", "tw_...", userAgent: "AcmePayroll/2.3");

Your token is prefixed to the SDK identifier rather than replacing it, so requests go out with:

User-Agent: AcmePayroll/2.3 TimeWizard.Sdk/1.2.3

The SDK portion always reflects the installed package version, so we can tell at a glance whether a customer is on a recent release.

What's exposed

One property per resource group, returning a typed API class:

Upsert semantics

Mutations on most resources are upserts keyed by atsReference — your system-of-record's identifier for the entity. A single POST /{resource} either inserts a new row or full-replaces the existing one matched by atsReference. The response carries an Operation discriminator (Created / Updated) so you can branch on it without a separate "does it exist?" round-trip.

Errors

Non-2xx responses throw ApiException. The body is the shared ApiError envelope ({ "error": { "code", "message", "details?" } }) — call .AsApiError() to get a typed view:

try
{
    await client.Workers.UpsertWorkerAsync(input);
}
catch (ApiException ex)
{
    var error = ex.AsApiError();
    if (error?.Error.Code == "ats_reference_in_use")
    {
        // handle the conflict
    }
}

Common status / code combinations:

• 422 validation_failed — request didn't match the schema; details is a flatten of which fields failed.
• 409 ats_reference_in_use (and other resource-specific codes) — business-rule conflict.
• 401 not_authenticated — missing or invalid API key.
• 403 missing_permission — your key lacks the required scope.

API reference

The full OpenAPI document and an interactive playground live at https://{slug}.timewizard.io/api/v1/docs.