Added 'Account Custom Nameserver' extensions
This commit is contained in:
61
src/Extensions/Cloudflare.Dns/CustomNameserversExtensions.cs
Normal file
61
src/Extensions/Cloudflare.Dns/CustomNameserversExtensions.cs
Normal file
@@ -0,0 +1,61 @@
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using AMWD.Net.Api.Cloudflare.Dns.Internals;
|
||||
|
||||
namespace AMWD.Net.Api.Cloudflare.Dns
|
||||
{
|
||||
/// <summary>
|
||||
/// Extensions for <see href="https://developers.cloudflare.com/api/resources/custom_nameservers/">Account Custom Nameservers</see>.
|
||||
/// </summary>
|
||||
public static class CustomNameserversExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Add Account Custom Nameserver.
|
||||
/// </summary>
|
||||
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
|
||||
/// <param name="request">The request.</param>
|
||||
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
|
||||
public static Task<CloudflareResponse<CustomNameserver>> AddCustomNameserver(this ICloudflareClient client, AddCustomNameserverRequest request, CancellationToken cancellationToken = default)
|
||||
{
|
||||
request.AccountId.ValidateCloudflareId();
|
||||
|
||||
var req = new InternalAddCustomNameserverRequest
|
||||
{
|
||||
NameserverName = request.NameserverName,
|
||||
NameserverSet = request.NameserverSet
|
||||
};
|
||||
|
||||
return client.PostAsync<CustomNameserver, InternalAddCustomNameserverRequest>($"/accounts/{request.AccountId}/custom_ns", req, null, cancellationToken);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Delete Account Custom Nameserver.
|
||||
/// </summary>
|
||||
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
|
||||
/// <param name="accountId">The account identifier.</param>
|
||||
/// <param name="nameserverId">The nameserver identifier.</param>
|
||||
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
|
||||
public static Task<CloudflareResponse<IReadOnlyCollection<string>>> DeleteCustomNameserver(this ICloudflareClient client, string accountId, string nameserverId, CancellationToken cancellationToken = default)
|
||||
{
|
||||
accountId.ValidateCloudflareId();
|
||||
|
||||
if (string.IsNullOrWhiteSpace(nameserverId))
|
||||
throw new ArgumentNullException(nameof(nameserverId));
|
||||
|
||||
return client.DeleteAsync<IReadOnlyCollection<string>>($"/accounts/{accountId}/custom_ns/{nameserverId}", null, cancellationToken);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// List an account's custom nameservers.
|
||||
/// </summary>
|
||||
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
|
||||
/// <param name="accountId">The account identifier.</param>
|
||||
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
|
||||
public static Task<CloudflareResponse<IReadOnlyCollection<CustomNameserver>>> ListCustomNameserver(this ICloudflareClient client, string accountId, CancellationToken cancellationToken = default)
|
||||
{
|
||||
accountId.ValidateCloudflareId();
|
||||
|
||||
return client.GetAsync<IReadOnlyCollection<CustomNameserver>>($"/accounts/{accountId}/custom_ns", null, cancellationToken);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
namespace AMWD.Net.Api.Cloudflare.Dns.Internals
|
||||
{
|
||||
internal class InternalAddCustomNameserverRequest
|
||||
{
|
||||
[JsonProperty("ns_name")]
|
||||
public string? NameserverName { get; set; }
|
||||
|
||||
[JsonProperty("ns_set")]
|
||||
public int? NameserverSet { get; set; }
|
||||
}
|
||||
}
|
||||
121
src/Extensions/Cloudflare.Dns/Models/CustomNameserver.cs
Normal file
121
src/Extensions/Cloudflare.Dns/Models/CustomNameserver.cs
Normal file
@@ -0,0 +1,121 @@
|
||||
using System.Runtime.Serialization;
|
||||
using Newtonsoft.Json.Converters;
|
||||
|
||||
namespace AMWD.Net.Api.Cloudflare.Dns
|
||||
{
|
||||
/// <summary>
|
||||
/// A Cloudflare custom nameserver.
|
||||
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/custom-nameservers.ts#L88">Source</see>
|
||||
/// </summary>
|
||||
public class CustomNameserver
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="CustomNameserver"/> class.
|
||||
/// </summary>
|
||||
/// <param name="nameserverName">The FQDN of the name server.</param>
|
||||
public CustomNameserver(string nameserverName)
|
||||
{
|
||||
NameserverName = nameserverName;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A and AAAA records associated with the nameserver.
|
||||
/// </summary>
|
||||
[JsonProperty("dns_records")]
|
||||
public IReadOnlyCollection<CustomNameserverDnsRecord>? DnsRecords { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The full qualified domain name (FQDN) of the name server.
|
||||
/// </summary>
|
||||
[JsonProperty("ns_name")]
|
||||
public string NameserverName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Verification status of the nameserver.
|
||||
/// </summary>
|
||||
[Obsolete]
|
||||
[JsonProperty("status")]
|
||||
public CustomNameserverStatus? Status { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Identifier.
|
||||
/// </summary>
|
||||
[JsonProperty("zone_tag")]
|
||||
public string? ZoneTag { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The number of the set that this name server belongs to.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <c>1 <= X <= 5</c>
|
||||
/// <br/>
|
||||
/// Default: 1
|
||||
/// </remarks>
|
||||
[JsonProperty("ns_set")]
|
||||
public int? NameserverSet { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Records associated with the nameserver.
|
||||
/// </summary>
|
||||
public class CustomNameserverDnsRecord
|
||||
{
|
||||
/// <summary>
|
||||
/// DNS record type.
|
||||
/// </summary>
|
||||
[JsonProperty("type")]
|
||||
public CustomNameserverDnsRecordType? Type { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// DNS record contents (an IPv4 or IPv6 address).
|
||||
/// </summary>
|
||||
[JsonProperty("value")]
|
||||
public string? Value { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Record types.
|
||||
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/custom-nameservers.ts#L120">Source</see>
|
||||
/// </summary>
|
||||
[JsonConverter(typeof(StringEnumConverter))]
|
||||
public enum CustomNameserverDnsRecordType
|
||||
{
|
||||
/// <summary>
|
||||
/// IPv4 record.
|
||||
/// </summary>
|
||||
[EnumMember(Value = "A")]
|
||||
A = 1,
|
||||
|
||||
/// <summary>
|
||||
/// IPv6 record.
|
||||
/// </summary>
|
||||
[EnumMember(Value = "AAAA")]
|
||||
AAAA = 2
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Custom nameserver states.
|
||||
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/custom-nameservers.ts#L102">Source</see>
|
||||
/// </summary>
|
||||
[JsonConverter(typeof(StringEnumConverter))]
|
||||
public enum CustomNameserverStatus
|
||||
{
|
||||
/// <summary>
|
||||
/// The nameserver has been moved.
|
||||
/// </summary>
|
||||
[EnumMember(Value = "moved")]
|
||||
Moved = 1,
|
||||
|
||||
/// <summary>
|
||||
/// The nameserver is pending verification.
|
||||
/// </summary>
|
||||
[EnumMember(Value = "pending")]
|
||||
Pending = 2,
|
||||
|
||||
/// <summary>
|
||||
/// The nameserver has been verified.
|
||||
/// </summary>
|
||||
[EnumMember(Value = "verified")]
|
||||
Verified = 3
|
||||
}
|
||||
}
|
||||
@@ -4,6 +4,13 @@ This package contains the feature set of the _DNS_ section of the Cloudflare API
|
||||
|
||||
## Implemented Methods
|
||||
|
||||
### [Account Custom Nameservers]
|
||||
|
||||
- [Add Account Custom Nameserver](https://developers.cloudflare.com/api/resources/custom_nameservers/methods/create/)
|
||||
- [Delete Account Custom Nameserver](https://developers.cloudflare.com/api/resources/custom_nameservers/methods/delete/)
|
||||
- [List Account Custom Nameservers](https://developers.cloudflare.com/api/resources/custom_nameservers/methods/get/)
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
@@ -12,3 +19,5 @@ Published under MIT License (see [choose a license])
|
||||
|
||||
|
||||
[choose a license]: https://choosealicense.com/licenses/mit/
|
||||
|
||||
[Account Custom Nameservers]: https://developers.cloudflare.com/api/resources/custom_nameservers/
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
namespace AMWD.Net.Api.Cloudflare.Dns
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a request to add a custom nameserver.
|
||||
/// </summary>
|
||||
public class AddCustomNameserverRequest
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="AddCustomNameserverRequest"/> class.
|
||||
/// </summary>
|
||||
/// <param name="accountId">The account identifier.</param>
|
||||
/// <param name="nameserverName">The FQDN of the name server.</param>
|
||||
public AddCustomNameserverRequest(string accountId, string nameserverName)
|
||||
{
|
||||
AccountId = accountId;
|
||||
NameserverName = nameserverName;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The account identifier.
|
||||
/// </summary>
|
||||
public string AccountId { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The FQDN of the name server.
|
||||
/// </summary>
|
||||
public string NameserverName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The number of the set that this name server belongs to.
|
||||
/// </summary>
|
||||
public int? NameserverSet { get; set; }
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user