Added 'DNS Account Settings' implementation - part one
This commit is contained in:
@@ -0,0 +1,90 @@
|
||||
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/dns/subresources/settings/subresources/account/">DNS Account Settings</see>.
|
||||
/// </summary>
|
||||
public static class DnsAccountSettingsExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Update DNS settings for a zone default of an account.
|
||||
/// </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<DnsAccountSettings>> UpdateDnsAccountSettings(this ICloudflareClient client, UpdateDnsAccountSettingsRequest request, CancellationToken cancellationToken = default)
|
||||
{
|
||||
request.AccountId.ValidateCloudflareId();
|
||||
|
||||
var req = new InternalUpdateDnsAccountSettingsRequest();
|
||||
|
||||
if (request.ZoneDefaults != null)
|
||||
{
|
||||
req.ZoneDefaults = new InternalDnsAccountZoneDefaults();
|
||||
|
||||
if (request.ZoneDefaults.ZoneMode.HasValue && !Enum.IsDefined(typeof(DnsZoneMode), request.ZoneDefaults.ZoneMode))
|
||||
throw new ArgumentOutOfRangeException($"{nameof(request.ZoneDefaults)}.{nameof(request.ZoneDefaults.ZoneMode)}", request.ZoneDefaults.ZoneMode, "Value must be one of the ZoneMode enum values.");
|
||||
|
||||
if (request.ZoneDefaults.Nameservers != null && !Enum.IsDefined(typeof(DnsAccountNameserversType), request.ZoneDefaults.Nameservers.Type))
|
||||
throw new ArgumentOutOfRangeException($"{nameof(request.ZoneDefaults)}.{nameof(request.ZoneDefaults.Nameservers)}.{nameof(request.ZoneDefaults.Nameservers.Type)}", request.ZoneDefaults.Nameservers.Type, "Value must be one of the NameserverType enum values.");
|
||||
|
||||
if (request.ZoneDefaults.NameserverTtl.HasValue && (request.ZoneDefaults.NameserverTtl < 30 || 86400 < request.ZoneDefaults.NameserverTtl))
|
||||
throw new ArgumentOutOfRangeException($"{nameof(request.ZoneDefaults)}.{nameof(request.ZoneDefaults.NameserverTtl)}", request.ZoneDefaults.NameserverTtl, "Value must be between 30 and 86400.");
|
||||
|
||||
if (request.ZoneDefaults.SOA != null)
|
||||
{
|
||||
string paramNameBase = $"{nameof(request.ZoneDefaults)}.{nameof(request.ZoneDefaults.SOA)}";
|
||||
|
||||
if (request.ZoneDefaults.SOA.Expire < 86400 || 2419200 < request.ZoneDefaults.SOA.Expire)
|
||||
throw new ArgumentOutOfRangeException($"{paramNameBase}.{nameof(request.ZoneDefaults.SOA.Expire)}", request.ZoneDefaults.SOA.Expire, "Value must be between 86400 and 2419200.");
|
||||
|
||||
if (request.ZoneDefaults.SOA.MinimumTtl < 60 || 86400 < request.ZoneDefaults.SOA.MinimumTtl)
|
||||
throw new ArgumentOutOfRangeException($"{paramNameBase}.{nameof(request.ZoneDefaults.SOA.MinimumTtl)}", request.ZoneDefaults.SOA.MinimumTtl, "Value must be between 60 and 86400.");
|
||||
|
||||
if (string.IsNullOrWhiteSpace(request.ZoneDefaults.SOA.PrimaryNameserver))
|
||||
throw new ArgumentNullException($"{paramNameBase}.{nameof(request.ZoneDefaults.SOA.PrimaryNameserver)}");
|
||||
|
||||
if (request.ZoneDefaults.SOA.Refresh < 600 || 86400 < request.ZoneDefaults.SOA.Refresh)
|
||||
throw new ArgumentOutOfRangeException($"{paramNameBase}.{nameof(request.ZoneDefaults.SOA.Refresh)}", request.ZoneDefaults.SOA.Refresh, "Value must be between 600 and 86400.");
|
||||
|
||||
if (request.ZoneDefaults.SOA.Retry < 600 || 86400 < request.ZoneDefaults.SOA.Retry)
|
||||
throw new ArgumentOutOfRangeException($"{paramNameBase}.{nameof(request.ZoneDefaults.SOA.Retry)}", request.ZoneDefaults.SOA.Retry, "Value must be between 600 and 86400.");
|
||||
|
||||
if (request.ZoneDefaults.SOA.TimeToLive < 300 || 86400 < request.ZoneDefaults.SOA.TimeToLive)
|
||||
throw new ArgumentOutOfRangeException($"{paramNameBase}.{nameof(request.ZoneDefaults.SOA.TimeToLive)}", request.ZoneDefaults.SOA.TimeToLive, "Value must be between 300 and 86400.");
|
||||
|
||||
if (string.IsNullOrWhiteSpace(request.ZoneDefaults.SOA.ZoneAdministrator))
|
||||
throw new ArgumentNullException($"{paramNameBase}.{nameof(request.ZoneDefaults.SOA.ZoneAdministrator)}");
|
||||
}
|
||||
|
||||
req.ZoneDefaults.FlattenAllCnames = request.ZoneDefaults.FlattenAllCnames;
|
||||
req.ZoneDefaults.FoundationDns = request.ZoneDefaults.FoundationDns;
|
||||
req.ZoneDefaults.InternalDns = request.ZoneDefaults.InternalDns;
|
||||
req.ZoneDefaults.MultiProvider = request.ZoneDefaults.MultiProvider;
|
||||
req.ZoneDefaults.Nameservers = request.ZoneDefaults.Nameservers;
|
||||
req.ZoneDefaults.NameserverTtl = request.ZoneDefaults.NameserverTtl;
|
||||
req.ZoneDefaults.SecondaryOverrides = request.ZoneDefaults.SecondaryOverrides;
|
||||
req.ZoneDefaults.SOA = request.ZoneDefaults.SOA;
|
||||
req.ZoneDefaults.ZoneMode = request.ZoneDefaults.ZoneMode;
|
||||
}
|
||||
|
||||
return client.PatchAsync<DnsAccountSettings, InternalUpdateDnsAccountSettingsRequest>($"/accounts/{request.AccountId}/dns_settings", req, cancellationToken);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Show DNS settings for a zone default of an account.
|
||||
/// </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<DnsAccountSettings>> ShowDnsAccountSettings(this ICloudflareClient client, string accountId, CancellationToken cancellationToken = default)
|
||||
{
|
||||
accountId.ValidateCloudflareId();
|
||||
|
||||
return client.GetAsync<DnsAccountSettings>($"/accounts/{accountId}/dns_settings", null, cancellationToken);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
namespace AMWD.Net.Api.Cloudflare.Dns.Internals
|
||||
{
|
||||
internal class InternalDnsAccountZoneDefaults
|
||||
{
|
||||
[JsonProperty("flatten_all_cnames")]
|
||||
public bool? FlattenAllCnames { get; set; }
|
||||
|
||||
[JsonProperty("foundation_dns")]
|
||||
public bool? FoundationDns { get; set; }
|
||||
|
||||
[JsonProperty("internal_dns")]
|
||||
public DnsAccountInternalDns? InternalDns { get; set; }
|
||||
|
||||
[JsonProperty("multi_provider")]
|
||||
public bool? MultiProvider { get; set; }
|
||||
|
||||
[JsonProperty("nameservers")]
|
||||
public DnsAccountNameservers? Nameservers { get; set; }
|
||||
|
||||
[JsonProperty("ns_ttl")]
|
||||
public int? NameserverTtl { get; set; }
|
||||
|
||||
[JsonProperty("secondary_overrides")]
|
||||
public bool? SecondaryOverrides { get; set; }
|
||||
|
||||
[JsonProperty("soa")]
|
||||
public DnsZoneSoa? SOA { get; set; }
|
||||
|
||||
[JsonProperty("zone_mode")]
|
||||
public DnsZoneMode? ZoneMode { get; set; }
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
namespace AMWD.Net.Api.Cloudflare.Dns.Internals
|
||||
{
|
||||
internal class InternalUpdateDnsAccountSettingsRequest
|
||||
{
|
||||
[JsonProperty("zone_defaults")]
|
||||
public InternalDnsAccountZoneDefaults? ZoneDefaults { get; set; }
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
namespace AMWD.Net.Api.Cloudflare.Dns
|
||||
{
|
||||
/// <summary>
|
||||
/// Settings for this internal zone.
|
||||
/// </summary>
|
||||
public class DnsAccountInternalDns
|
||||
{
|
||||
/// <summary>
|
||||
/// The ID of the zone to fallback to.
|
||||
/// </summary>
|
||||
[JsonProperty("reference_zone_id")]
|
||||
public string? ReferenceZoneId { get; set; }
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
using System.Runtime.Serialization;
|
||||
using Newtonsoft.Json.Converters;
|
||||
|
||||
namespace AMWD.Net.Api.Cloudflare.Dns
|
||||
{
|
||||
/// <summary>
|
||||
/// Settings determining the nameservers through which the zone should be available.
|
||||
/// </summary>
|
||||
public class DnsAccountNameservers
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="DnsAccountNameservers"/> class.
|
||||
/// </summary>
|
||||
/// <param name="type">Nameserver type.</param>
|
||||
public DnsAccountNameservers(DnsAccountNameserversType type)
|
||||
{
|
||||
Type = type;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Nameserver type.
|
||||
/// </summary>
|
||||
[JsonProperty("type")]
|
||||
public DnsAccountNameserversType Type { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The type of a DNS zone nameserver.
|
||||
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/dns/settings/account/account.ts#L137">Source</see>
|
||||
/// </summary>
|
||||
[JsonConverter(typeof(StringEnumConverter))]
|
||||
public enum DnsAccountNameserversType
|
||||
{
|
||||
/// <summary>
|
||||
/// The Cloudflare standard nameservers.
|
||||
/// </summary>
|
||||
[EnumMember(Value = "cloudflare.standard")]
|
||||
Standard = 1,
|
||||
|
||||
/// <summary>
|
||||
/// The zone specific nameservers.
|
||||
/// </summary>
|
||||
[EnumMember(Value = "cloudflare.standard.random")]
|
||||
Random = 2,
|
||||
|
||||
/// <summary>
|
||||
/// The account specific nameservers.
|
||||
/// </summary>
|
||||
[EnumMember(Value = "custom.account")]
|
||||
Account = 3,
|
||||
|
||||
/// <summary>
|
||||
/// The tenant specific nameservers.
|
||||
/// </summary>
|
||||
[EnumMember(Value = "custom.tenant")]
|
||||
Tenant = 4,
|
||||
}
|
||||
}
|
||||
14
src/Extensions/Cloudflare.Dns/Models/DnsAccountSettings.cs
Normal file
14
src/Extensions/Cloudflare.Dns/Models/DnsAccountSettings.cs
Normal file
@@ -0,0 +1,14 @@
|
||||
namespace AMWD.Net.Api.Cloudflare.Dns
|
||||
{
|
||||
/// <summary>
|
||||
/// Settings for a Cloudflare DNS zone on account level.
|
||||
/// </summary>
|
||||
public class DnsAccountSettings
|
||||
{
|
||||
/// <summary>
|
||||
/// Settings zone defaults.
|
||||
/// </summary>
|
||||
[JsonProperty("zone_defaults")]
|
||||
public DnsAccountZoneDefaults? ZoneDefaults { get; set; }
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,66 @@
|
||||
namespace AMWD.Net.Api.Cloudflare.Dns
|
||||
{
|
||||
/// <summary>
|
||||
/// Settings zone defaults.
|
||||
/// </summary>
|
||||
public class DnsAccountZoneDefaults
|
||||
{
|
||||
/// <summary>
|
||||
/// Whether to flatten all CNAME records in the zone. Note that, due to DNS
|
||||
/// limitations, a CNAME record at the zone apex will always be flattened.
|
||||
/// </summary>
|
||||
[JsonProperty("flatten_all_cnames")]
|
||||
public bool? FlattenAllCnames { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Whether to enable Foundation DNS Advanced Nameservers on the zone.
|
||||
/// </summary>
|
||||
[JsonProperty("foundation_dns")]
|
||||
public bool? FoundationDns { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Settings for this internal zone.
|
||||
/// </summary>
|
||||
[JsonProperty("internal_dns")]
|
||||
public DnsAccountInternalDns? InternalDns { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Whether to enable multi-provider DNS, which causes Cloudflare to activate the
|
||||
/// zone even when non-Cloudflare NS records exist, and to respect NS records at the
|
||||
/// zone apex during outbound zone transfers.
|
||||
/// </summary>
|
||||
[JsonProperty("multi_provider")]
|
||||
public bool? MultiProvider { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Settings determining the nameservers through which the zone should be available.
|
||||
/// </summary>
|
||||
[JsonProperty("nameservers")]
|
||||
public DnsAccountNameservers? Nameservers { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The time to live (TTL) of the zone's nameserver (NS) records.
|
||||
/// </summary>
|
||||
[JsonProperty("ns_ttl")]
|
||||
public int? NameserverTtl { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Allows a Secondary DNS zone to use (proxied) override records and CNAME
|
||||
/// flattening at the zone apex.
|
||||
/// </summary>
|
||||
[JsonProperty("secondary_overrides")]
|
||||
public bool? SecondaryOverrides { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Components of the zone's SOA record.
|
||||
/// </summary>
|
||||
[JsonProperty("soa")]
|
||||
public DnsZoneSoa? SOA { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Whether the zone mode is a regular or CDN/DNS only zone.
|
||||
/// </summary>
|
||||
[JsonProperty("zone_mode")]
|
||||
public DnsZoneMode? ZoneMode { get; set; }
|
||||
}
|
||||
}
|
||||
@@ -29,6 +29,12 @@ This package contains the feature set of the _DNS_ section of the Cloudflare API
|
||||
|
||||
#### [Settings]
|
||||
|
||||
##### [Account]
|
||||
|
||||
- [Update DNS Settings](https://developers.cloudflare.com/api/resources/dns/subresources/settings/subresources/account/methods/edit/)
|
||||
- [Show DNS Settings](https://developers.cloudflare.com/api/resources/dns/subresources/settings/subresources/account/methods/get/)
|
||||
|
||||
|
||||
##### [Zone]
|
||||
|
||||
- [Update DNS Settings](https://developers.cloudflare.com/api/resources/dns/subresources/settings/subresources/zone/methods/edit/)
|
||||
@@ -49,4 +55,5 @@ Published under MIT License (see [choose a license])
|
||||
[Records]: https://developers.cloudflare.com/api/resources/dns/subresources/records/
|
||||
|
||||
[Settings]: https://developers.cloudflare.com/api/resources/dns/subresources/settings/
|
||||
[Account]: https://developers.cloudflare.com/api/resources/dns/subresources/settings/subresources/account/
|
||||
[Zone]: https://developers.cloudflare.com/api/resources/dns/subresources/settings/subresources/zone/
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
namespace AMWD.Net.Api.Cloudflare.Dns
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a request to update DNS zone defaults on account level.
|
||||
/// </summary>
|
||||
public class UpdateDnsAccountSettingsRequest
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="UpdateDnsAccountSettingsRequest"/> class.
|
||||
/// </summary>
|
||||
/// <param name="accountId">The account identifier.</param>
|
||||
public UpdateDnsAccountSettingsRequest(string accountId)
|
||||
{
|
||||
AccountId = accountId;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The zone identifier.
|
||||
/// </summary>
|
||||
public string AccountId { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The DNS zone defaults.
|
||||
/// </summary>
|
||||
public DnsAccountZoneDefaults? ZoneDefaults { get; set; }
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user