Somum.Broadcast.Requests 10.1.6

Somum.Broadcast.Requests

Somum.Broadcast.Requests is a .NET Standard 2.0 class library that defines the request and response contracts for the Somum broadcast domain.

It contains command and query models used to launch broadcasts, manage broadcast jobs, and retrieve broadcast jobs, broadcast wizards, and supporting broadcast configuration data. The project is transport-oriented: it describes API/mediator inputs, route metadata, and response shapes without implementing business logic.

Target Framework and Dependencies

• Target framework: .NET Standard 2.0
• Project dependencies:
  • Somum.Dtos for broadcast, recipient, and job data contracts
  • Somum.Entities.Enums for shared domain values
  • Somum.Requests for base command, query, pagination, and endpoint abstractions

Contract Organization

Commands

Commands under Commands/ change broadcast state or start broadcasts.

Both launch commands return CreateBroadcastJobCommandResponse, which describes the resolved recipients and the created broadcast job.

Broadcast launch payloads

Launch payloads are split into partial classes so that reusable campaign, delivery, email-option, recipient, template, selected-message, audience, and message-variable contracts remain organized by concern.

• CreateBroadcastJobCommandBasePayload contains options shared by launch modes.
• RunBroadcastTemplateCommandPayload preserves wizard defaults and permits supported overrides.
• CreateBroadcastJobCommandPayload supplies explicit values when the caller must replace wizard configuration.

Use the default command when the broadcast wizard configuration should be the source of truth. Use the override command only when the caller must intentionally provide replacement campaign, audience, recipient, or message configuration.

Broadcast-job lifecycle

PatchBroadcastJobCommand targets a job by route-bound Id and accepts UpdateBroadcastJobStateCommandPayload.

Supported values of PatchBroadcastJobCommandState are:

• Cancel — stop the job; it cannot be resumed.
• Pause — temporarily halt processing.
• Resume — continue a paused job.
• Complete — mark the job as finished.

The command handler determines whether a requested transition is valid for the job's current state.

Queries

Queries under Queries/ retrieve broadcast resources and related configuration:

Collection queries inherit filtering, sorting, and pagination behavior from NavigatingQuery<TResponse>.

Expanding Query Results

Broadcast queries support optional response shaping through BroadcastExpand and BroadcastInclude values:

• Expand requests related resources to be expanded in the returned object graph.
• Include requests additional related resources to be included in the response.

Only request fields needed by the caller to keep response payloads and query costs small.

using Somum.Broadcast.Requests;

var query = new GetBroadcastJobsQuery
{
    Expand = new List<BroadcastExpand>(),
    Include = new List<BroadcastInclude>()
};

Usage

Reference the project from another project in the solution:

<ItemGroup>
  <ProjectReference Include="..\Somum.Broadcast.Requests\Somum.Broadcast.Requests.csproj" />
</ItemGroup>

Create and dispatch a command through the application's mediator abstraction:

using Somum.Broadcast.Requests;

var command = new PatchBroadcastJobCommand
{
    Id = jobId,
    Payloads = new UpdateBroadcastJobStateCommandPayload
    {
        State = PatchBroadcastJobCommandState.Pause
    }
};

Contract Evolution

These request models are shared API and mediator contracts. When changing them:

• Preserve existing route constants, JSON property names, and enum values.
• Prefer additive, nullable properties over removals or renames.
• Keep command payload validation in the corresponding sanitizer/handler project rather than embedding business logic in this project.
• Update handlers, API endpoint documentation, mappings, and tests whenever a request or response shape changes.
• Introduce versioned contracts when a breaking API change is unavoidable.