Ddx.InteractionsApi
0.2.0
dotnet add package Ddx.InteractionsApi --version 0.2.0
NuGet\Install-Package Ddx.InteractionsApi -Version 0.2.0
<PackageReference Include="Ddx.InteractionsApi" Version="0.2.0" />
<PackageVersion Include="Ddx.InteractionsApi" Version="0.2.0" />
<PackageReference Include="Ddx.InteractionsApi" />
paket add Ddx.InteractionsApi --version 0.2.0
#r "nuget: Ddx.InteractionsApi, 0.2.0"
#:package Ddx.InteractionsApi@0.2.0
#addin nuget:?package=Ddx.InteractionsApi&version=0.2.0
#tool nuget:?package=Ddx.InteractionsApi&version=0.2.0
Ddx.InteractionsApi
Interactions API documentation
C# client for the DDx Interactions API, generated from its OpenAPI specification.
- API version: v1
- Package version: 0.2.0
- Generator version: 7.10.0
For more information, please visit https://demexchange.com/.
Requirements
net8.0
Installation
dotnet add package Ddx.InteractionsApi
Then import the namespaces:
using Ddx.InteractionsApi.Api;
using Ddx.InteractionsApi.Client;
using Ddx.InteractionsApi.Model;
Changelog
API changes are recorded in the changelog, regenerated from a diff of the OpenAPI specification on each sync. Entries marked breaking require a change on the consumer side.
Reporting issues
This package is generated. Edits to it are overwritten on the next spec sync. Report problems against the API specification rather than the generated code.
Getting Started
using System;
using Ddx.InteractionsApi.Api;
using Ddx.InteractionsApi.Client;
// HTTP basic auth, API key in the password field, empty username.
// Configuration.BasePath already defaults to the production API.
var config = new Configuration
{
Username = "",
Password = Environment.GetEnvironmentVariable("DDX_API_KEY"),
};
var api = new AuthenticationDetailsApi(config);
try
{
var me = api.VversionAuthMeGet("1");
Console.WriteLine(me.ToJson());
}
catch (ApiException e)
{
// The exception message is only the status line; ErrorContent says why.
Console.Error.WriteLine($"Interactions API returned {e.ErrorCode}: {e.ErrorContent}");
}
<a id="documentation-for-api-endpoints"></a>
Documentation for API Endpoints
All URIs are relative to https://api.movementinfrastructure.org
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AuthenticationDetailsApi | VversionAuthMeGet | GET /v{version}/auth/me | Get authentication context |
| InteractionsApi | VversionInteractionsExchangeStatusGet | GET /v{version}/interactions/exchange-status | Get Exchange pipeline statuses by correlation or interaction ID |
| InteractionsApi | VversionInteractionsExchangeStatusRangeGet | GET /v{version}/interactions/exchange-status/range | Get Exchange pipeline statuses by date range |
| InteractionsApi | VversionInteractionsInteractionIdTransactionsGet | GET /v{version}/interactions/{interactionId}/transactions | Get external API transactions by interactionId |
| InteractionsApi | VversionInteractionsPost | POST /v{version}/interactions | Post interactions data |
| InteractionsApi | VversionInteractionsTransactionsGet | GET /v{version}/interactions/transactions | Get external API transaction logs by date range |
<a id="documentation-for-models"></a>
Documentation for Models
- Model.AcceptedInteractionDto
- Model.AcceptedInteractionsDto
- Model.ActivistCode
- Model.ActivistCodeOutcomeDetails
- Model.Address
- Model.AddressChannelDetails
- Model.CanvasserDetails
- Model.CommitteeDetails
- Model.CommunicationConsent
- Model.CommunicationConsentOutcomeDetails
- Model.CommunicationConsentStatus
- Model.ContactInfo
- Model.ContactMethod
- Model.DynamicChannelDetails
- Model.DynamicOutcomeDetails
- Model.EventDetails
- Model.EventRole
- Model.EventSignup
- Model.EventSignupOutcomeDetails
- Model.EventSignupStatus
- Model.EventSignupStatusValue
- Model.ExchangeInteractionStatus
- Model.ExchangeInteractionStatusDto
- Model.ExchangeInteractionStatusDtoCursorPaginatedResponseDto
- Model.ExternalApiKeyStatus
- Model.ExternalApiKeyType
- Model.ExternalTransactionStatus
- Model.InitiativeDto
- Model.InteractionDto
- Model.InteractionDtoChannel
- Model.InteractionDtoOutcomesDetailedInner
- Model.InteractionErrorDto
- Model.InteractionVanFieldsDto
- Model.InteractionsBatchResultDto
- Model.InteractionsDto
- Model.InteractionsExternalApiTransactionDto
- Model.InteractionsExternalApiTransactionDtoGetResponseDto
- Model.InteractionsExternalApiTransactionLogDto
- Model.MercuryDestinationVanApiKeyDto
- Model.MinervaMetadataDto
- Model.Outcome
- Model.OutcomeDetailOperation
- Model.PersonIdentifier
- Model.ProblemDetails
- Model.RejectedInteractionDto
- Model.RejectedInteractionsDto
- Model.SimpleDestinationDto
- Model.SimpleMovementAppDto
- Model.SimpleWorkspaceDto
- Model.SurveyResponse
- Model.SurveyResponseOutcomeDetails
- Model.VanApiKeyDto
- Model.VanDatabaseMode
- Model.WhoAmIApiKeyDto
- Model.WorkspaceTypeDto
<a id="documentation-for-authorization"></a>
Documentation for Authorization
Authentication schemes defined for the API: <a id="Basic"></a>
Basic
- Type: HTTP basic authentication
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net8.0
- JsonSubTypes (>= 2.0.1)
- Newtonsoft.Json (>= 13.0.3)
- Polly (>= 8.1.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Minor update