Class FilingFile
- Namespace
- MassiveDotNet.Rest.Models
- Assembly
- MassiveDotNet.Rest.dll
One file within an SEC filing: its identifier, name, sequence, size, type, and source.
public sealed record FilingFile : IEquatable<FilingFile>
- Inheritance
-
FilingFile
- Implements
- Inherited Members
Remarks
Reference data, so a class (decision D4). Also the declared payload of GetFilingFileAsync(string, string, CancellationToken), where decision D16 verifies the shape; that route
serves the file itself rather than this object, so DownloadFilingFileAsync(string, string, Stream, CancellationToken) is the method that retrieves one (decision D25).
The item schema's own required list names a file property the schema never
declares, and omits filename, which it does; the generator follows the declared property
over the required list, so Filename binds optional rather than required.
Properties
Description
A description for the contents of the file.
[JsonPropertyName("description")]
public required string Description { get; init; }
Property Value
Filename
The name for the file.
[JsonPropertyName("filename")]
public string? Filename { get; init; }
Property Value
Id
An identifier unique to the filing for this data entry.
[JsonPropertyName("id")]
public required string Id { get; init; }
Property Value
Sequence
File Sequence Number
[JsonPropertyName("sequence")]
public long Sequence { get; init; }
Property Value
SizeBytes
The size of the file in bytes.
[JsonPropertyName("size_bytes")]
public long SizeBytes { get; init; }
Property Value
SourceUrl
The source URL is a link back to the upstream source for this file.
[JsonPropertyName("source_url")]
public required string SourceUrl { get; init; }
Property Value
Type
The type of document contained in the file.
[JsonPropertyName("type")]
public required string Type { get; init; }