forked from alpacahq/alpaca-trade-api-csharp
/
HistoricalAuctionsRequest.cs
153 lines (141 loc) · 5.99 KB
/
HistoricalAuctionsRequest.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
namespace Alpaca.Markets;
/// <summary>
/// Encapsulates request parameters for
/// <see cref="IHistoricalQuotesClient{TRequest}.ListHistoricalQuotesAsync(TRequest,CancellationToken)"/> and
/// <see cref="IHistoricalQuotesClient{TRequest}.GetHistoricalQuotesAsync(TRequest,CancellationToken)"/> calls.
/// </summary>
[UsedImplicitly]
public sealed class HistoricalAuctionsRequest : HistoricalRequestBase, IHistoricalRequest<HistoricalAuctionsRequest, IAuction>
{
/// <summary>
/// Creates new instance of <see cref="HistoricalAuctionsRequest"/> object.
/// </summary>
/// <param name="symbol">Asset symbol for data retrieval.</param>
/// <param name="from">Filter data equal to or after this time.</param>
/// <param name="into">Filter data equal to or before this time.</param>
/// <exception cref="ArgumentNullException">
/// The <paramref name="symbol"/> argument is <c>null</c>.
/// </exception>
public HistoricalAuctionsRequest(
String symbol,
DateTime from,
DateTime into)
: this(new[] { symbol.EnsureNotNull() }, from, into)
{
}
/// <summary>
/// Creates new instance of <see cref="HistoricalAuctionsRequest"/> object.
/// </summary>
/// <param name="symbol">Asset symbol for data retrieval.</param>
/// <param name="timeInterval">Inclusive time interval for filtering items in response.</param>
/// <exception cref="ArgumentNullException">
/// The <paramref name="symbol"/> argument is <c>null</c>.
/// </exception>
public HistoricalAuctionsRequest(
String symbol,
Interval<DateTime> timeInterval)
: this(new[] { symbol.EnsureNotNull() }, timeInterval)
{
}
/// <summary>
/// Creates new instance of <see cref="HistoricalAuctionsRequest"/> object.
/// </summary>
/// <param name="symbol">Asset symbol for data retrieval.</param>
/// <exception cref="ArgumentNullException">
/// The <paramref name="symbol"/> argument is <c>null</c>.
/// </exception>
public HistoricalAuctionsRequest(
String symbol)
: this(new[] { symbol.EnsureNotNull() })
{
}
/// <summary>
/// Creates new instance of <see cref="HistoricalAuctionsRequest"/> object.
/// </summary>
/// <param name="symbols">Asset symbols for data retrieval.</param>
/// <param name="from">Filter data equal to or after this time.</param>
/// <param name="into">Filter data equal to or before this time.</param>
/// <exception cref="ArgumentNullException">
/// The <paramref name="symbols"/> argument is <c>null</c>.
/// </exception>
public HistoricalAuctionsRequest(
IEnumerable<String> symbols,
DateTime from,
DateTime into)
: base(symbols.EnsureNotNull(), from, into)
{
}
/// <summary>
/// Creates new instance of <see cref="HistoricalAuctionsRequest"/> object.
/// </summary>
/// <param name="symbols">Asset symbols for data retrieval.</param>
/// <param name="timeInterval">Inclusive time interval for filtering items in response.</param>
/// <exception cref="ArgumentNullException">
/// The <paramref name="symbols"/> argument is <c>null</c>.
/// </exception>
public HistoricalAuctionsRequest(
IEnumerable<String> symbols,
Interval<DateTime> timeInterval)
: base(symbols.EnsureNotNull(), timeInterval)
{
}
/// <summary>
/// Creates new instance of <see cref="HistoricalAuctionsRequest"/> object.
/// </summary>
/// <param name="symbols">Asset symbols for data retrieval.</param>
/// <exception cref="ArgumentNullException">
/// The <paramref name="symbols"/> argument is <c>null</c>.
/// </exception>
public HistoricalAuctionsRequest(
IEnumerable<String> symbols)
: base(symbols.EnsureNotNull(), new Interval<DateTime>())
{
}
/// <summary>
/// Creates new instance of <see cref="HistoricalAuctionsRequest"/> object.
/// </summary>
/// <param name="symbol">Asset symbol for data retrieval.</param>
/// <param name="timeInterval">Inclusive time interval for filtering items in response.</param>
/// <exception cref="ArgumentNullException">
/// The <paramref name="symbol"/> argument is <c>null</c>.
/// </exception>
[ExcludeFromCodeCoverage]
[Obsolete("Use constructor with Interval<DateTime> argument instead of this one.", true)]
public HistoricalAuctionsRequest(
String symbol,
IInclusiveTimeInterval timeInterval)
: this(new[] { symbol.EnsureNotNull() }, timeInterval)
{
}
/// <summary>
/// Creates new instance of <see cref="HistoricalAuctionsRequest"/> object.
/// </summary>
/// <param name="symbols">Asset symbols for data retrieval.</param>
/// <param name="timeInterval">Inclusive time interval for filtering items in response.</param>
/// <exception cref="ArgumentNullException">
/// The <paramref name="symbols"/> argument is <c>null</c>.
/// </exception>
[ExcludeFromCodeCoverage]
[Obsolete("Use constructor with Interval<DateTime> argument instead of this one.", true)]
public HistoricalAuctionsRequest(
IEnumerable<String> symbols,
IInclusiveTimeInterval timeInterval)
: base(symbols.EnsureNotNull(), timeInterval)
{
}
/// <summary>
/// Gets or sets the optional parameter for mapping symbol to contract by a specific date.
/// </summary>
[UsedImplicitly]
public DateOnly? UseSymbolAsOfTheDate { get; set; }
/// <inheritdoc />
protected override String LastPathSegment => "auctions";
internal override QueryBuilder AddParameters(
QueryBuilder queryBuilder) =>
queryBuilder
.AddParameter("asof", UseSymbolAsOfTheDate);
HistoricalAuctionsRequest IHistoricalRequest<HistoricalAuctionsRequest, IAuction>.GetValidatedRequestWithoutPageToken() =>
new HistoricalAuctionsRequest(Symbols, TimeInterval)
{ UseSymbolAsOfTheDate = UseSymbolAsOfTheDate }
.WithPageSize(this.GetPageSize());
}