Soenneker.Close.OpenApiClientUtil 4.0.85

Soenneker.Close.OpenApiClientUtil

Provides an authenticated, cached instance of the Kiota-generated Close CRM API client.

Installation

dotnet add package Soenneker.Close.OpenApiClientUtil

API-key configuration

{
  "Close": {
    "ApiKey": "<Close API key>",
    "ClientBaseUrl": "https://api.close.com/api/v1"
  }
}

Close:ApiKey is required. The utility uses Close's HTTP Basic API-key scheme by default: the key is the username and the password is empty. See Close's authentication documentation.

For OAuth, place the access token in Close:ApiKey and set Close:AuthHeaderValueTemplate to Bearer {token}. Close:AuthHeaderName can override the default Authorization header name.

Keep API keys and OAuth tokens in a secret provider rather than source control.

Registration

using Microsoft.Extensions.DependencyInjection;
using Soenneker.Close.OpenApiClientUtil.Registrars;

services.AddCloseOpenApiClientUtilAsSingleton();

Use AddCloseOpenApiClientUtilAsScoped() when each dependency-injection scope should own its generated client and request adapter while sharing the singleton HTTP provider.

Usage

using Soenneker.Close.OpenApiClient.Me;
using Soenneker.Close.OpenApiClientUtil.Abstract;

public sealed class CloseProfileService
{
    private readonly ICloseOpenApiClientUtil _closeClients;

    public CloseProfileService(ICloseOpenApiClientUtil closeClients)
    {
        _closeClients = closeClients;
    }

    public async ValueTask<MeGetResponse?> GetCurrentUser(
        CancellationToken cancellationToken)
    {
        var close = await _closeClients.Get(cancellationToken);

        return await close.Me.GetAsync(
            request =>
            {
                request.QueryParameters.Fields = "id,name,organization_id";
            },
            cancellationToken);
    }
}

Other root request builders include Lead, Contact, Opportunity, Activity, Task, Sequence, and Webhook. Names follow the generated OpenAPI surface.

Lifecycle and behavior

• The first Get creates the HTTP client, Kiota request adapter, and generated client. Later calls on the same utility return that client.
• Configuration and credentials are captured during first initialization. Recreate the owning scope or application instance after rotating them.
• The token passed to Get cancels initialization only. Pass a cancellation token to each generated endpoint call.
• Let dependency injection dispose ICloseOpenApiClientUtil. Disposal releases its request adapter; the singleton HTTP provider and cached HttpClient remain available until application shutdown.
• Generated endpoint methods may return null when the schema permits an empty response.
• Service failures are surfaced through generated error models or Kiota exceptions according to each endpoint's schema mapping.
• Request builders and models can change when the generated-client package is refreshed from Close's OpenAPI description.