Table of Contents

Class OpenBiApiClientInquiryExtensions

Namespace
BiExcellence.OpenBi.Api.Inquiries
Assembly
BiExcellence.OpenBi.Api.Client.dll

Extension methods for the /inquiries and /inquirers REST API.

public static class OpenBiApiClientInquiryExtensions
Inheritance
object
OpenBiApiClientInquiryExtensions

Methods

DeleteInquirerAsync(IOpenBiApiClient, string, CancellationToken)

Deletes an inquirer together with all of their inquiries and those inquiries' fields - the call for a deletion request.

public static Task DeleteInquirerAsync(this IOpenBiApiClient client, string id, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient
id string
cancellationToken CancellationToken

Returns

Task

DeleteInquiryAsync(IOpenBiApiClient, string, CancellationToken)

Deletes an inquiry and its fields. The inquirer is kept - delete that separately with DeleteInquirerAsync(IOpenBiApiClient, string, CancellationToken) if the person asked to be removed entirely.

public static Task DeleteInquiryAsync(this IOpenBiApiClient client, string id, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient
id string
cancellationToken CancellationToken

Returns

Task

GetInquirerAsync(IOpenBiApiClient, string, CancellationToken)

Reads one inquirer by id. Throws OpenBiApiException with status 404 when there is no inquirer with this id.

public static Task<Inquirer> GetInquirerAsync(this IOpenBiApiClient client, string id, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient
id string
cancellationToken CancellationToken

Returns

Task<Inquirer>

GetInquirersAsync(IOpenBiApiClient, OpenBiListRequest?, CancellationToken)

Lists inquirers (GET inquirers), with the shared list options of request: the people behind the inquiries. One inquirer can have many inquiries.

public static Task<OpenBiListResult<Inquirer>> GetInquirersAsync(this IOpenBiApiClient client, OpenBiListRequest? request = null, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient
request OpenBiListRequest
cancellationToken CancellationToken

Returns

Task<OpenBiListResult<Inquirer>>

GetInquiriesAsync(IOpenBiApiClient, OpenBiListRequest?, CancellationToken)

Lists inquiries (GET inquiries), with the shared list options of request. An inquiry is a form submission captured by the CMS; its sender is read with GetInquirerAsync(IOpenBiApiClient, string, CancellationToken) and its answers with GetInquiryFieldsAsync(IOpenBiApiClient, string, OpenBiListRequest?, CancellationToken).

public static Task<OpenBiListResult<Inquiry>> GetInquiriesAsync(this IOpenBiApiClient client, OpenBiListRequest? request = null, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient
request OpenBiListRequest
cancellationToken CancellationToken

Returns

Task<OpenBiListResult<Inquiry>>

GetInquiryAsync(IOpenBiApiClient, string, CancellationToken)

Reads one inquiry by id. Throws OpenBiApiException with status 404 when there is no inquiry with this id.

public static Task<Inquiry> GetInquiryAsync(this IOpenBiApiClient client, string id, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient
id string
cancellationToken CancellationToken

Returns

Task<Inquiry>

GetInquiryFieldsAsync(IOpenBiApiClient, string, OpenBiListRequest?, CancellationToken)

Reads the submitted fields of one inquiry as name and value. An unknown inquiry id yields an empty list, not a 404.

public static Task<OpenBiListResult<InquiryField>> GetInquiryFieldsAsync(this IOpenBiApiClient client, string id, OpenBiListRequest? request = null, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient
id string
request OpenBiListRequest
cancellationToken CancellationToken

Returns

Task<OpenBiListResult<InquiryField>>

RedistributeInquiryAsync(IOpenBiApiClient, string, CancellationToken)

Re-runs lead distribution for an inquiry against every registered lead-distributor plugin, as the CMS contact form does on submit - for an inquiry that was captured but whose distribution failed. The inquiry itself is not changed, and with no plugin registered nothing happens. Every plugin is tried; their failures are reported together. A 404 means there is no inquiry with this id.

public static Task RedistributeInquiryAsync(this IOpenBiApiClient client, string id, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient
id string
cancellationToken CancellationToken

Returns

Task