Class LoadRecordsResponse

Namespace

Vonage.Reports.LoadRecords

Assembly

Vonage.dll

Represents the synchronous records response, containing request metadata, pagination, and an array of product-specific records.

public record LoadRecordsResponse : IEquatable<LoadRecordsResponse>

Inheritance

object

LoadRecordsResponse

Implements

IEquatable<LoadRecordsResponse>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LoadRecordsResponse(Guid, SyncRequestStatus, DateTimeOffset, long, ReportProduct, HalLinks<LoadRecordsHalLink>, Maybe<string>, Maybe<string>, Maybe<string>, JsonElement[])

Represents the synchronous records response, containing request metadata, pagination, and an array of product-specific records.

public LoadRecordsResponse(Guid RequestId, SyncRequestStatus RequestStatus, DateTimeOffset ReceivedAt, long ItemsCount, ReportProduct Product, HalLinks<LoadRecordsHalLink> Links, Maybe<string> Cursor, Maybe<string> Iv, Maybe<string> IdsNotFound, JsonElement[] Records)

Parameters

RequestId Guid

Unique ID associated with this synchronous request.

RequestStatus SyncRequestStatus

The result status of the request.

ReceivedAt DateTimeOffset

Timestamp when the request was processed by the Reports API.

ItemsCount long

The number of records returned in this page.

Product ReportProduct

The product type the records cover.

Links HalLinks<LoadRecordsHalLink>

HAL links for navigation and pagination.

Cursor Maybe<string>

Cursor for paginating results. Present only when pagination is applicable.

Iv Maybe<string>

Initialization vector for cursor processing. Present only when pagination is applicable.

IdsNotFound Maybe<string>

Comma-separated list of IDs not found, when the request was made by ID.

Records JsonElement[]

The product-specific records returned by this request.

Properties

Cursor

Cursor for paginating results. Present only when pagination is applicable.

[JsonPropertyName("cursor")]
[JsonConverter(typeof(MaybeJsonConverter<string>))]
public Maybe<string> Cursor { get; init; }

Property Value

Maybe<string>

IdsNotFound

Comma-separated list of IDs not found, when the request was made by ID.

[JsonPropertyName("ids_not_found")]
[JsonConverter(typeof(MaybeJsonConverter<string>))]
public Maybe<string> IdsNotFound { get; init; }

Property Value

Maybe<string>

ItemsCount

The number of records returned in this page.

[JsonPropertyName("items_count")]
public long ItemsCount { get; init; }

Property Value

long

Iv

Initialization vector for cursor processing. Present only when pagination is applicable.

[JsonPropertyName("iv")]
[JsonConverter(typeof(MaybeJsonConverter<string>))]
public Maybe<string> Iv { get; init; }

Property Value

Maybe<string>

Links

HAL links for navigation and pagination.

[JsonPropertyName("_links")]
public HalLinks<LoadRecordsHalLink> Links { get; init; }

Property Value

HalLinks<LoadRecordsHalLink>

Product

The product type the records cover.

[JsonPropertyName("product")]
[JsonConverter(typeof(EnumDescriptionJsonConverter<ReportProduct>))]
public ReportProduct Product { get; init; }

Property Value

ReportProduct

ReceivedAt

Timestamp when the request was processed by the Reports API.

[JsonPropertyName("received_at")]
public DateTimeOffset ReceivedAt { get; init; }

Property Value

DateTimeOffset

Records

The product-specific records returned by this request.

[JsonPropertyName("records")]
public JsonElement[] Records { get; init; }

Property Value

JsonElement[]

RequestId

Unique ID associated with this synchronous request.

[JsonPropertyName("request_id")]
public Guid RequestId { get; init; }

Property Value

Guid

RequestStatus

The result status of the request.

[JsonPropertyName("request_status")]
[JsonConverter(typeof(EnumDescriptionJsonConverter<SyncRequestStatus>))]
public SyncRequestStatus RequestStatus { get; init; }

Property Value

SyncRequestStatus