Add "ZoneSettings" extensions

This commit is contained in:
2025-07-09 08:21:36 +02:00
parent b5279b60a8
commit a916d49b11
69 changed files with 3004 additions and 0 deletions

View File

@@ -0,0 +1,31 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Value states on/off/custom.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L591">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum OnOffCustomState
{
/// <summary>
/// On state.
/// </summary>
[EnumMember(Value = "on")]
On = 1,
/// <summary>
/// Off state.
/// </summary>
[EnumMember(Value = "off")]
Off = 2,
/// <summary>
/// Custom state.
/// </summary>
[EnumMember(Value = "custom")]
Custom = 3
}
}

View File

@@ -0,0 +1,31 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Value states on/off/open.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L704">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum OnOffOpenState
{
/// <summary>
/// On state.
/// </summary>
[EnumMember(Value = "on")]
On = 1,
/// <summary>
/// Off state.
/// </summary>
[EnumMember(Value = "off")]
Off = 2,
/// <summary>
/// Custom state.
/// </summary>
[EnumMember(Value = "open")]
Open = 4
}
}

View File

@@ -0,0 +1,25 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Value states on/off.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L71">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum OnOffState
{
/// <summary>
/// On state.
/// </summary>
[EnumMember(Value = "on")]
On = 1,
/// <summary>
/// Off state.
/// </summary>
[EnumMember(Value = "off")]
Off = 2
}
}

View File

@@ -0,0 +1,352 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// The zone setting ID.
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum ZoneSettingId
{
/// <summary>
/// Advanced protection from Distributed Denial of Service (DDoS) attacks on your
/// website.
/// </summary>
[EnumMember(Value = "advanced_ddos")]
AdvancedDDoS = 1,
/// <summary>
/// Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your
/// layer 7 WAF and CDN services.
/// </summary>
[EnumMember(Value = "aegis")]
Aegis = 2,
/// <summary>
/// When enabled, Cloudflare serves limited copies of web pages available from the
/// Internet Archive's Wayback Machine if your server is offline.
/// </summary>
[EnumMember(Value = "always_online")]
AlwaysOnline = 3,
/// <summary>
/// If enabled, any <c>http://</c> URL is converted to <c>https://</c> through a 301
/// redirect.
/// </summary>
[EnumMember(Value = "always_use_https")]
AlwaysUseHTTPS = 4,
/// <summary>
/// Turn on or off Automatic HTTPS Rewrites.
/// </summary>
[EnumMember(Value = "automatic_https_rewrites")]
AutomaticHTTPSRewrites = 5,
/// <summary>
/// Brotli Compression.
/// </summary>
[EnumMember(Value = "brotli")]
Brotli = 6,
/// <summary>
/// Control how long resources cached by client browsers remain valid.
/// </summary>
[EnumMember(Value = "browser_cache_ttl")]
BrowserCacheTTL = 7,
/// <summary>
/// Inspect the visitor's browser for headers commonly associated with spammers and
/// certain bots.
/// </summary>
[EnumMember(Value = "browser_check")]
BrowserCheck = 8,
/// <summary>
/// Apply custom caching based on the option selected.
/// </summary>
[EnumMember(Value = "cache_level")]
CacheLevel = 9,
/// <summary>
/// Specify how long a visitor is allowed access to your site after successfully completing a challenge.
/// </summary>
[EnumMember(Value = "challenge_ttl")]
ChallengeTTL = 10,
/// <summary>
/// An allowlist of ciphers for TLS termination.
/// </summary>
[EnumMember(Value = "ciphers")]
Ciphers = 11,
/// <summary>
/// Development Mode temporarily allows you to enter development mode for your
/// websites if you need to make changes to your site.
/// </summary>
[EnumMember(Value = "development_mode")]
DevelopmentMode = 12,
/// <summary>
/// When enabled, Cloudflare will attempt to speed up overall page loads.
/// </summary>
[EnumMember(Value = "early_hints")]
EarlyHints = 13,
/// <summary>
/// Email obfuscation.
/// </summary>
[EnumMember(Value = "email_obfuscation")]
EmailObfuscation = 14,
/// <summary>
/// Enhance your website's font delivery with Cloudflare Fonts.
/// </summary>
[EnumMember(Value = "fonts")]
FontSettings = 15,
/// <summary>
/// HTTP/2 Edge Prioritization optimises the delivery of resources served through
/// HTTP/2 to improve page load performance.
/// </summary>
[EnumMember(Value = "h2_prioritization")]
H2Prioritization = 16,
/// <summary>
/// Hotlink Protection option ensures that other sites cannot suck
/// up your bandwidth by building pages that use images hosted on your site.
/// </summary>
[EnumMember(Value = "hotlink_protection")]
HotlinkProtection = 17,
/// <summary>
/// HTTP/2 option.
/// </summary>
[EnumMember(Value = "http2")]
HTTP2 = 18,
/// <summary>
/// HTTP/3 option.
/// </summary>
[EnumMember(Value = "http3")]
HTTP3 = 19,
/// <summary>
/// Image Transformations provides on-demand resizing, conversion and optimization.
/// </summary>
[EnumMember(Value = "image_resizing")]
ImageResizing = 20,
/// <summary>
/// Cloudflare adds a header with the visitor's country.
/// </summary>
[EnumMember(Value = "ip_geolocation")]
IPGeolocation = 21,
/// <summary>
/// Enable IPv6 on all subdomains that are Cloudflare enabled.
/// </summary>
[EnumMember(Value = "ipv6")]
IPV6 = 22,
/// <summary>
/// Only accepts HTTPS requests that use at least the TLS protocol version specified.
/// </summary>
[EnumMember(Value = "min_tls_version")]
MinTLSVersion = 23,
/// <summary>
/// Cloudflare Mirage reduces bandwidth used by images in mobile browsers.
/// </summary>
[EnumMember(Value = "mirage")]
Mirage = 24,
/// <summary>
/// Network Error Logging.
/// </summary>
[EnumMember(Value = "nel")]
NEL = 25,
/// <summary>
/// Opportunistic Encryption allows browsers to access HTTP URIs over an encrypted TLS channel.
/// </summary>
[EnumMember(Value = "opportunistic_encryption")]
OpportunisticEncryption = 26,
/// <summary>
/// Add an Alt-Svc header to all legitimate requests from Tor.
/// </summary>
[EnumMember(Value = "opportunistic_onion")]
OpportunisticOnion = 27,
/// <summary>
/// Orange to Orange option.
/// </summary>
[EnumMember(Value = "orange_to_orange")]
OrangeToOrange = 28,
/// <summary>
/// Cloudflare error pages generated from issues sent from the origin server.
/// </summary>
[EnumMember(Value = "origin_error_page_pass_thru")]
OriginErrorPagePassThru = 29,
/// <summary>
/// Only accepts HTTP requests that use at least the HTTP protocol version specified.
/// </summary>
[EnumMember(Value = "origin_max_http_version")]
OriginMaxHTTPVersion = 30,
/// <summary>
/// Polish feature of the Cloudflare Speed app.
/// </summary>
[EnumMember(Value = "polish")]
Polish = 31,
/// <summary>
/// Cloudflare will prefetch any URLs that are included in the response headers.
/// </summary>
[EnumMember(Value = "prefetch_preload")]
PrefetchPreload = 32,
/// <summary>
/// Proxy Read Timeout.
/// </summary>
[EnumMember(Value = "proxy_read_timeout")]
ProxyReadTimeout = 33,
/// <summary>
/// Pseudo IPv4.
/// </summary>
[EnumMember(Value = "pseudo_ipv4")]
PseudoIPV4 = 34,
/// <summary>
/// Turn on or off whether Cloudflare should wait for an entire file from the origin.
/// </summary>
[EnumMember(Value = "response_buffering")]
ResponseBuffering = 35,
/// <summary>
/// Rocket Loader in the Cloudflare Speed app.
/// </summary>
[EnumMember(Value = "rocket_loader")]
RocketLoader = 36,
/// <summary>
/// Security Headers.
/// </summary>
[EnumMember(Value = "security_header")]
SecurityHeaders = 37,
/// <summary>
/// Security Level feature from the Security app.
/// </summary>
[EnumMember(Value = "security_level")]
SecurityLevel = 38,
/// <summary>
/// Server-Side Excludes.
/// </summary>
[EnumMember(Value = "server_side_excludes")]
ServerSideExcludes = 39,
/// <summary>
/// Sort Query String for Cache.
/// </summary>
[EnumMember(Value = "sort_query_string_for_cache")]
SortQueryStringForCache = 40,
/// <summary>
/// SSL.
/// </summary>
[EnumMember(Value = "ssl")]
SSL = 41,
/// <summary>
/// Enrollment value for SSL/TLS Recommender.
/// </summary>
[EnumMember(Value = "ssl_recommender")]
SSLRecommender = 42,
/// <summary>
/// TLS 1.3.
/// </summary>
[EnumMember(Value = "tls_1_3")]
TLS1_3 = 43,
/// <summary>
/// TLS Client Authentication.
/// </summary>
[EnumMember(Value = "tls_client_auth")]
TLSClientAuth = 44,
/// <summary>
/// True Client IP Header.
/// </summary>
[EnumMember(Value = "true_client_ip_header")]
TrueClientIPHeader = 45,
/// <summary>
/// Web Application Firewall.
/// </summary>
[EnumMember(Value = "waf")]
WAF = 46,
/// <summary>
/// Cloudflare will serve a WebP version of the original image.
/// </summary>
[EnumMember(Value = "webp")]
WebP = 47,
/// <summary>
/// WebSockets settings.
/// </summary>
[EnumMember(Value = "websockets")]
Websocket = 48,
/// <summary>
/// 0-RTT
/// </summary>
[EnumMember(Value = "0rtt")]
ZeroRTT = 49,
/// <summary>
/// Edge Cache TTL.
/// </summary>
[EnumMember(Value = "edge_cache_ttl")]
SchemasEdgeCacheTTL = 501,
/// <summary>
/// Maximum size of an allowable upload.
/// </summary>
[EnumMember(Value = "max_upload")]
MaxUpload = 502,
/// <summary>
/// Replace insecure JS.
/// </summary>
[EnumMember(Value = "replace_insecure_js")]
ReplaceInsecureJS = 503,
/// <summary>
/// Only allows TLS1.2.
/// </summary>
[EnumMember(Value = "tls_1_2_only")]
TLS1_2Only = 504,
/// <summary>
/// How to flatten the cname destination.
/// </summary>
[Obsolete("Please use the DNS Settings route instead.")]
[EnumMember(Value = "cname_flattening")]
CNAMEFlattening = 901,
/// <summary>
/// Privacy Pass.
/// </summary>
[Obsolete("Privacy Pass v1 was deprecated in 2023.")]
[EnumMember(Value = "privacy_pass")]
PrivacyPass = 902,
}
}

View File

@@ -0,0 +1,24 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Advanced protection from Distributed Denial of Service (DDoS) attacks on your
/// website. This is an uneditable value that is <see cref="OnOffState.On"/> in the
/// case of Business and Enterprise zones.
/// </summary>
public class AdvancedDDoS : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="AdvancedDDoS"/> class.
/// </summary>
public AdvancedDDoS()
{
Id = ZoneSettingId.AdvancedDDoS;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,44 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your
/// layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your
/// account so that you can increase your origin security by only allowing traffic
/// from a small list of IP addresses.
/// </summary>
public class Aegis : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="Aegis"/> class.
/// </summary>
public Aegis()
{
Id = ZoneSettingId.Aegis;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public AegisValue? Value { get; set; }
}
/// <summary>
/// Value of the zone setting.
/// </summary>
public class AegisValue
{
/// <summary>
/// Whether the feature is enabled or not.
/// </summary>
[JsonProperty("enabled")]
public bool? Enabled { get; set; }
/// <summary>
/// Egress pool id which refers to a grouping of dedicated egress IPs through which
/// Cloudflare will connect to origin.
/// </summary>
[JsonProperty("pool_id")]
public string? PoolId { get; set; }
}
}

View File

@@ -0,0 +1,26 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// When enabled, Cloudflare serves limited copies of web pages available from the
/// <see href="https://archive.org/web/">Internet Archive's Wayback Machine</see>
/// if your server is offline.
/// Refer to <see href="https://developers.cloudflare.com/cache/about/always-online">Always Online</see>
/// for more information.
/// </summary>
public class AlwaysOnline : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="AlwaysOnline"/> class.
/// </summary>
public AlwaysOnline()
{
Id = ZoneSettingId.AlwaysOnline;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// If enabled, any <c>http://</c> URL is converted to <c>https://</c> through a 301
/// redirect.
/// </summary>
public class AlwaysUseHTTPS : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="AlwaysUseHTTPS"/> class.
/// </summary>
public AlwaysUseHTTPS()
{
Id = ZoneSettingId.AlwaysUseHTTPS;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,22 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Turn on or off Automatic HTTPS Rewrites.
/// </summary>
public class AutomaticHTTPSRewrites : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="AutomaticHTTPSRewrites"/> class.
/// </summary>
public AutomaticHTTPSRewrites()
{
Id = ZoneSettingId.AutomaticHTTPSRewrites;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,48 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Apply custom caching based on the option selected.
/// </summary>
public class AutomaticPlatformOptimization
{
/// <summary>
/// Indicates whether or not
/// <see href="https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/">cache by device type</see>
/// is enabled.
/// </summary>
[JsonProperty("cache_by_device_type")]
public bool? CacheByDeviceType { get; set; }
/// <summary>
/// Indicates whether or not Cloudflare proxy is enabled.
/// </summary>
[JsonProperty("cf")]
public bool? CloudflareProxyEnabled { get; set; }
/// <summary>
/// Indicates whether or not Automatic Platform Optimization is enabled.
/// </summary>
[JsonProperty("enabled")]
public bool? Enabled { get; set; }
/// <summary>
/// An array of hostnames where Automatic Platform Optimization for WordPress is activated.
/// </summary>
[JsonProperty("hostnames")]
public IReadOnlyCollection<string>? Hostnames { get; set; }
/// <summary>
/// Indicates whether or not site is powered by WordPress.
/// </summary>
[JsonProperty("wordpress")]
public bool? WordPress { get; set; }
/// <summary>
/// Indicates whether or not
/// <see href="https://wordpress.org/plugins/cloudflare/">Cloudflare for WordPress plugin</see>
/// is installed.
/// </summary>
[JsonProperty("wp_plugin")]
public bool? WpPlugin { get; set; }
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// When the client requesting an asset supports the Brotli compression algorithm,
/// Cloudflare will serve a Brotli compressed version of the asset.
/// </summary>
public class Brotli : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="Brotli"/> class.
/// </summary>
public Brotli()
{
Id = ZoneSettingId.Brotli;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Control how long resources cached by client browsers remain valid.
/// </summary>
public class BrowserCacheTTL : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="BrowserCacheTTL"/> class.
/// </summary>
public BrowserCacheTTL()
{
Id = ZoneSettingId.BrowserCacheTTL;
}
/// <summary>
/// The number of seconds to cache resources for.
/// The API prohibits setting this to 0 for non-Enterprise domains.
/// </summary>
[JsonProperty("value")]
public int? Value { get; set; }
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Inspect the visitor's browser for headers commonly associated with spammers and
/// certain bots.
/// </summary>
public class BrowserCheck : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="BrowserCheck"/> class.
/// </summary>
public BrowserCheck()
{
Id = ZoneSettingId.BrowserCheck;
}
/// <summary>
/// The status of Browser Integrity Check.
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,24 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// How to flatten the cname destination.
/// </summary>
[Obsolete("Please use the DNS Settings route instead.")]
public class CNAMEFlattening : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="CNAMEFlattening"/> class.
/// </summary>
public CNAMEFlattening()
{
Id = ZoneSettingId.CNAMEFlattening;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[Obsolete("Please use the DNS Settings route instead.")]
[JsonProperty("value")]
public string? Value { get; set; }
}
}

View File

@@ -0,0 +1,64 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Apply custom caching based on the option selected.
/// </summary>
public class CacheLevel : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="CacheLevel"/> class.
/// </summary>
public CacheLevel()
{
Id = ZoneSettingId.CacheLevel;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public CacheLevelOption? Value { get; set; }
}
/// <summary>
/// Apply custom caching based on the option selected.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L365">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum CacheLevelOption
{
/// <summary>
/// Cloudflare does not cache.
/// </summary>
[EnumMember(Value = "bypass")]
Bypass = 1,
/// <summary>
/// Delivers resources from cache when there is no query string.
/// </summary>
[EnumMember(Value = "basic")]
Basic = 2,
/// <summary>
/// Delivers the same resource to everyone independent of the query string.
/// </summary>
[EnumMember(Value = "simplified")]
Simplified = 3,
/// <summary>
/// Caches all static content that has a query string.
/// </summary>
[EnumMember(Value = "aggressive")]
Aggressive = 4,
/// <summary>
/// Treats all content as static and caches all file types beyond the
/// <see href="https://developers.cloudflare.com/cache/concepts/default-cache-behavior/#default-cached-file-extensions">Cloudflare default cached content</see>
/// </summary>
[EnumMember(Value = "cache_everything")]
CacheEverything = 5
}
}

View File

@@ -0,0 +1,103 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Specify how long a visitor is allowed access to your site after successfully
/// completing a challenge (such as a CAPTCHA). After the TTL has expired the
/// visitor will have to complete a new challenge. We recommend a 15 - 45 minute
/// setting and will attempt to honor any setting above 45 minutes.
/// (<see href="https://support.cloudflare.com/hc/en-us/articles/200170136"/>).
/// </summary>
public class ChallengeTTL : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="ChallengeTTL"/> class.
/// </summary>
public ChallengeTTL()
{
Id = ZoneSettingId.ChallengeTTL;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public ChallengeTTLValue Value { get; set; }
}
/// <summary>
/// The time-to-live (TTL) of the challenge.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L403">Soruce</see>
/// </summary>
public enum ChallengeTTLValue : int
{
/// <summary>
/// 5 minutes.
/// </summary>
FiveMinutes = 300,
/// <summary>
/// 15 minutes.
/// </summary>
FifteenMinutes = 900,
/// <summary>
/// 30 minutes.
/// </summary>
HalfHour = 1800,
/// <summary>
/// 45 minutes.
/// </summary>
ThreeQuartersHour = 2700,
/// <summary>
/// 1 hour.
/// </summary>
Hour = 3600,
/// <summary>
/// 2 hours.
/// </summary>
TwoHours = 7200,
/// <summary>
/// 3 hours.
/// </summary>
ThreeHours = 10800,
/// <summary>
/// 4 hours.
/// </summary>
FourHours = 14400,
/// <summary>
/// 8 hours.
/// </summary>
EightHours = 28800,
/// <summary>
/// 16 hours.
/// </summary>
SixteenHours = 57600,
/// <summary>
/// 1 day.
/// </summary>
Day = 86400,
/// <summary>
/// 1 week.
/// </summary>
Week = 604800,
/// <summary>
/// 30 days.
/// </summary>
Month = 2592000,
/// <summary>
/// 365 days.
/// </summary>
Year = 31536000
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// An allowlist of ciphers for TLS termination. These ciphers must be in the
/// BoringSSL format.
/// </summary>
public class Ciphers : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="Ciphers"/> class.
/// </summary>
public Ciphers()
{
Id = ZoneSettingId.Ciphers;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public IReadOnlyCollection<string> Value { get; set; } = [];
}
}

View File

@@ -0,0 +1,35 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Development Mode temporarily allows you to enter development mode for your
/// websites if you need to make changes to your site.This will bypass Cloudflare's
/// accelerated cache and slow down your site, but is useful if you are making
/// changes to cacheable content (like images, css, or JavaScript) and would like to
/// see those changes right away. Once entered, development mode will last for 3
/// hours and then automatically toggle off.
/// </summary>
public class DevelopmentMode : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="DevelopmentMode"/> class.
/// </summary>
public DevelopmentMode()
{
Id = ZoneSettingId.DevelopmentMode;
}
/// <summary>
/// Current state of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
/// <summary>
/// The interval (in seconds) from when development mode expires (positive integer)
/// or last expired (negative integer) for the domain.
/// If development mode has never been enabled, this value is zero.
/// </summary>
[JsonProperty("time_remaining")]
public int? TimeRemaining { get; set; }
}
}

View File

@@ -0,0 +1,25 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// When enabled, Cloudflare will attempt to speed up overall page loads by serving
/// <c>103</c> responses with <c>Link</c> headers from the final response. Refer to
/// <see href="https://developers.cloudflare.com/cache/about/early-hints">Early Hints</see>
/// for more information.
/// </summary>
public class EarlyHints : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="EarlyHints"/> class.
/// </summary>
public EarlyHints()
{
Id = ZoneSettingId.EarlyHints;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,22 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Turn on or off <strong>Email Obfuscation</strong>.
/// </summary>
public class EmailObfuscation : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="EmailObfuscation"/> class.
/// </summary>
public EmailObfuscation()
{
Id = ZoneSettingId.EmailObfuscation;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,24 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Enhance your website's font delivery with Cloudflare Fonts. Deliver Google
/// Hosted fonts from your own domain, boost performance, and enhance user privacy.
/// Refer to the Cloudflare Fonts documentation for more information.
/// </summary>
public class FontSettings : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="FontSettings"/> class.
/// </summary>
public FontSettings()
{
Id = ZoneSettingId.FontSettings;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,24 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// HTTP/2 Edge Prioritization optimises the delivery of resources served through
/// HTTP/2 to improve page load performance.It also supports fine control of
/// content delivery when used in conjunction with Workers.
/// </summary>
public class H2Prioritization : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="H2Prioritization"/> class.
/// </summary>
public H2Prioritization()
{
Id = ZoneSettingId.H2Prioritization;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffCustomState Value { get; set; }
}
}

View File

@@ -0,0 +1,22 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// HTTP/2 enabled for this zone.
/// </summary>
public class HTTP2 : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="HTTP2"/> class.
/// </summary>
public HTTP2()
{
Id = ZoneSettingId.HTTP2;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,22 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// HTTP/3 enabled for this zone.
/// </summary>
public class HTTP3 : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="HTTP3"/> class.
/// </summary>
public HTTP3()
{
Id = ZoneSettingId.HTTP3;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,28 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// When enabled, the Hotlink Protection option ensures that other sites cannot suck
/// up your bandwidth by building pages that use images hosted on your site.Anytime
/// a request for an image on your site hits Cloudflare, we check to ensure that
/// it's not another site requesting them. People will still be able to download and
/// view images from your page, but other sites won't be able to steal them for use
/// on their own pages.
/// (<see href="https://support.cloudflare.com/hc/en-us/articles/200170026"/>).
/// </summary>
public class HotlinkProtection : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="HotlinkProtection"/> class.
/// </summary>
public HotlinkProtection()
{
Id = ZoneSettingId.HotlinkProtection;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Cloudflare adds a CF-IPCountry HTTP header containing the country code that
/// corresponds to the visitor.
/// </summary>
public class IPGeolocation : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="IPGeolocation"/> class.
/// </summary>
public IPGeolocation()
{
Id = ZoneSettingId.IPGeolocation;
}
/// <summary>
/// The status of adding the IP Geolocation Header.
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Enable IPv6 on all subdomains that are Cloudflare enabled.
/// (<see href="https://support.cloudflare.com/hc/en-us/articles/200168586"/>).
/// </summary>
public class IPV6 : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="IPV6"/> class.
/// </summary>
public IPV6()
{
Id = ZoneSettingId.IPV6;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,25 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Image Transformations provides on-demand resizing, conversion and optimization
/// for images served through Cloudflare's network. Refer to the
/// <see href="https://developers.cloudflare.com/images/">Image Transformations documentation</see>
/// for more information.
/// </summary>
public class ImageResizing : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="ImageResizing"/> class.
/// </summary>
public ImageResizing()
{
Id = ZoneSettingId.ImageResizing;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffOpenState Value { get; set; }
}
}

View File

@@ -0,0 +1,119 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Maximum size of an allowable upload.
/// </summary>
public class MaxUpload : ZoneSettingBase
{
/// <summary>
/// Initialize a new instance of the <see cref="MaxUpload"/> class.
/// </summary>
public MaxUpload()
{
Id = ZoneSettingId.MaxUpload;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public MaxUploadSize Value { get; set; }
}
/// <summary>
/// Maximum size of an allowable upload.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L1980">Soruce</see>
/// </summary>
public enum MaxUploadSize : int
{
/// <summary>
/// 100 MB.
/// </summary>
M100 = 100,
/// <summary>
/// 125 MB.
/// </summary>
M125 = 125,
/// <summary>
/// 150 MB.
/// </summary>
M150 = 150,
/// <summary>
/// 175 MB.
/// </summary>
M175 = 175,
/// <summary>
/// 200 MB.
/// </summary>
M200 = 200,
/// <summary>
/// 225 MB.
/// </summary>
M225 = 225,
/// <summary>
/// 250 MB.
/// </summary>
M250 = 250,
/// <summary>
/// 275 MB.
/// </summary>
M275 = 275,
/// <summary>
/// 300 MB.
/// </summary>
M300 = 300,
/// <summary>
/// 325 MB.
/// </summary>
M325 = 325,
/// <summary>
/// 350 MB.
/// </summary>
M350 = 350,
/// <summary>
/// 375 MB.
/// </summary>
M375 = 375,
/// <summary>
/// 400 MB.
/// </summary>
M400 = 400,
/// <summary>
/// 425 MB.
/// </summary>
M425 = 425,
/// <summary>
/// 450 MB.
/// </summary>
M450 = 450,
/// <summary>
/// 475 MB.
/// </summary>
M475 = 475,
/// <summary>
/// 500 MB.
/// </summary>
M500 = 500,
/// <summary>
/// 1000 MB (1 GB).
/// </summary>
G1 = 1000
}
}

View File

@@ -0,0 +1,58 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Only accepts HTTPS requests that use at least the TLS protocol version
/// specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be
/// rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted.
/// </summary>
public class MinTLSVersion : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="MinTLSVersion"/> class.
/// </summary>
public MinTLSVersion()
{
Id = ZoneSettingId.MinTLSVersion;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
public TlsVersion? Value { get; set; }
}
/// <summary>
/// Available TLS versions.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L785">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum TlsVersion
{
/// <summary>
/// TLS 1.0
/// </summary>
[EnumMember(Value = "1.0")]
Tls10 = 1,
/// <summary>
/// TLS 1.1
/// </summary>
[EnumMember(Value = "1.1")]
Tls11 = 2,
/// <summary>
/// TLS 1.2
/// </summary>
[EnumMember(Value = "1.2")]
Tls12 = 3,
/// <summary>
/// TLS 1.3
/// </summary>
[EnumMember(Value = "1.3")]
Tls13 = 4
}
}

View File

@@ -0,0 +1,24 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Cloudflare Mirage reduces bandwidth used by images in mobile browsers. It can
/// accelerate loading of image-heavy websites on very slow mobile connections and
/// HTTP/1.
/// </summary>
public class Mirage : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="Mirage"/> class.
/// </summary>
public Mirage()
{
Id = ZoneSettingId.Mirage;
}
/// <summary>
/// The status of Mirage.
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,34 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Enable Network Error Logging reporting on your zone. (Beta)
/// </summary>
public class NEL : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="NEL"/> class.
/// </summary>
public NEL()
{
Id = ZoneSettingId.NEL;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public NELValue? Value { get; set; }
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
public class NELValue
{
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("enabled")]
public bool? Enabled { get; set; }
}
}

View File

@@ -0,0 +1,24 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Opportunistic Encryption allows browsers to access HTTP URIs over an encrypted
/// TLS channel. It's not a substitute for HTTPS, but provides additional security
/// for otherwise vulnerable requests.
/// </summary>
public class OpportunisticEncryption : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="OpportunisticEncryption"/> class.
/// </summary>
public OpportunisticEncryption()
{
Id = ZoneSettingId.OpportunisticEncryption;
}
/// <summary>
/// The status of Opportunistic Encryption.
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Add an Alt-Svc header to all legitimate requests from Tor, allowing the
/// connection to use our onion services instead of exit nodes.
/// </summary>
public class OpportunisticOnion : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="OpportunisticOnion"/> class.
/// </summary>
public OpportunisticOnion()
{
Id = ZoneSettingId.OpportunisticOnion;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also
/// on Cloudflare.
/// </summary>
public class OrangeToOrange : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="OrangeToOrange"/> class.
/// </summary>
public OrangeToOrange()
{
Id = ZoneSettingId.OrangeToOrange;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Turn on or off Cloudflare error pages generated from issues sent from the origin
/// server. If enabled, this setting triggers error pages issued by the origin.
/// </summary>
public class OriginErrorPagePassThru : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="OriginErrorPagePassThru"/> class.
/// </summary>
public OriginErrorPagePassThru()
{
Id = ZoneSettingId.OriginErrorPagePassThru;
}
/// <summary>
/// The status of Origin Error Page Passthru.
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,45 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// The maximum HTTP version supported by the origin server.
/// </summary>
public class OriginMaxHTTPVersion : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="OriginMaxHTTPVersion"/> class.
/// </summary>
public OriginMaxHTTPVersion()
{
Id = ZoneSettingId.OriginMaxHTTPVersion;
}
/// <summary>
/// The value of the feature.
/// </summary>
[JsonProperty("value")]
public HttpVersion Value { get; set; }
}
/// <summary>
/// HTTP versions.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L984">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum HttpVersion
{
/// <summary>
/// HTTP/1
/// </summary>
[EnumMember(Value = "1")]
HTTP1 = 1,
/// <summary>
/// HTTP/2
/// </summary>
[EnumMember(Value = "2")]
HTTP2 = 2
}
}

View File

@@ -0,0 +1,51 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Apply options from the Polish feature of the Cloudflare Speed app.
/// </summary>
public class Polish : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="Polish"/> class.
/// </summary>
public Polish()
{
Id = ZoneSettingId.Polish;
}
/// <summary>
/// The level of Polish you want applied to your origin.
/// </summary>
[JsonProperty("value")]
public PolishLevel? Value { get; set; }
}
/// <summary>
/// The level of Polish.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L1001">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum PolishLevel
{
/// <summary>
/// No Polish.
/// </summary>
[EnumMember(Value = "off")]
Off = 1,
/// <summary>
/// Basic Polish.
/// </summary>
[EnumMember(Value = "lossless")]
LossLess = 2,
/// <summary>
/// Full Polish.
/// </summary>
[EnumMember(Value = "lossy")]
Lossy = 3
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Cloudflare will prefetch any URLs that are included in the response headers.
/// This is limited to Enterprise Zones.
/// </summary>
public class PrefetchPreload : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="PrefetchPreload"/> class.
/// </summary>
public PrefetchPreload()
{
Id = ZoneSettingId.PrefetchPreload;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Privacy Pass.
/// </summary>
[Obsolete("Privacy Pass v1 was deprecated in 2023.")]
public class PrivacyPass : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="PrivacyPass"/> class.
/// </summary>
public PrivacyPass()
{
Id = ZoneSettingId.PrivacyPass;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,22 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Maximum time between two read operations from origin.
/// </summary>
public class ProxyReadTimeout : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="ProxyReadTimeout"/> class.
/// </summary>
public ProxyReadTimeout()
{
Id = ZoneSettingId.ProxyReadTimeout;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public int Value { get; set; }
}
}

View File

@@ -0,0 +1,51 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// The value set for the Pseudo IPv4 setting.
/// </summary>
public class PseudoIPV4 : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="PseudoIPV4"/> class.
/// </summary>
public PseudoIPV4()
{
Id = ZoneSettingId.PseudoIPV4;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public PseudoIPV4Value Value { get; set; }
}
/// <summary>
/// Pseudo IPv4 values.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L1081">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum PseudoIPV4Value
{
/// <summary>
/// Off.
/// </summary>
[EnumMember(Value = "off")]
Off = 1,
/// <summary>
/// Add a header.
/// </summary>
[EnumMember(Value = "add_header")]
AddHeader = 2,
/// <summary>
/// Add header or overwrite if exists.
/// </summary>
[EnumMember(Value = "overwrite_header")]
OverwriteHeader = 3
}
}

View File

@@ -0,0 +1,24 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Automatically replace insecure JavaScript libraries with safer and faster
/// alternatives provided under cdnjs and powered by Cloudflare. Currently supports
/// the following libraries: Polyfill under polyfill.io.
/// </summary>
public class ReplaceInsecureJS : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="ReplaceInsecureJS"/> class.
/// </summary>
public ReplaceInsecureJS()
{
Id = ZoneSettingId.ReplaceInsecureJS;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,24 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Turn on or off whether Cloudflare should wait for an entire file from the origin
/// server before forwarding it to the site visitor. By default, Cloudflare sends
/// packets to the client as they arrive from the origin server.
/// </summary>
public class ResponseBuffering : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="ResponseBuffering"/> class.
/// </summary>
public ResponseBuffering()
{
Id = ZoneSettingId.ResponseBuffering;
}
/// <summary>
/// The status of Response Buffering.
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,22 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Turn on or off Rocket Loader in the Cloudflare Speed app.
/// </summary>
public class RocketLoader : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="RocketLoader"/> class.
/// </summary>
public RocketLoader()
{
Id = ZoneSettingId.RocketLoader;
}
/// <summary>
/// The status of Rocket Loader.
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,69 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Control options for the SSL feature of the Edge Certificates tab in the
/// Cloudflare SSL/TLS app.
/// </summary>
public class SSL : ZoneSettingBase
{
/// <summary>
/// Initialize a new instance of the <see cref="SSL"/> class.
/// </summary>
public SSL()
{
Id = ZoneSettingId.SSL;
}
/// <summary>
/// The encryption mode that Cloudflare uses to connect to your origin server.
/// </summary>
[JsonProperty("value")]
public SslMode? Value { get; set; }
}
/// <summary>
/// SSL encryption modes.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L1307">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum SslMode
{
/// <summary>
/// No encryption applied.
/// Turning off SSL disables HTTPS and causes browsers to show a warning that your website is not secure.
/// </summary>
[EnumMember(Value = "off")]
Off = 1,
/// <summary>
/// Enable encryption only between your visitors and Cloudflare.
/// This will avoid browser security warnings, but all connections between Cloudflare and your origin are made through HTTP.
/// </summary>
[EnumMember(Value = "flexible")]
Flexible = 2,
/// <summary>
/// Enable encryption end-to-end.
/// Use this mode when your origin server supports SSL certification but does not use a valid, publicly trusted certificate.
/// </summary>
[EnumMember(Value = "full")]
Full = 3,
/// <summary>
/// Enable encryption end-to-end and enforce validation on origin certificates.
/// Use Cloudflares Origin CA to generate certificates for your origin.
/// </summary>
[EnumMember(Value = "strict")]
Strict = 4,
/// <summary>
/// Enforce encryption between Cloudflare and your origin.
/// Use this mode to guarantee connections to your origin will always be encrypted, regardless of your visitors request.
/// </summary>
[EnumMember(Value = "origin_pull")]
OriginPull = 5
}
}

View File

@@ -0,0 +1,25 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Enrollment in the SSL/TLS Recommender service which tries to detect and
/// recommend (by sending periodic emails) the most secure SSL/TLS setting your
/// origin servers support.
/// </summary>
[Obsolete("SSL/TLS Recommender has been decommissioned in favor of Automatic SSL/TLS: ssl_automatic_mode")]
public class SSLRecommender : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="SSLRecommender"/> class.
/// </summary>
public SSLRecommender()
{
Id = ZoneSettingId.SSLRecommender;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public string? Value { get; set; }
}
}

View File

@@ -0,0 +1,135 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Time (in seconds) that a resource will be ensured to remain on Cloudflare's
/// cache servers.
/// </summary>
public class SchemasEdgeCacheTTL : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="SchemasEdgeCacheTTL"/> class.
/// </summary>
public SchemasEdgeCacheTTL()
{
Id = ZoneSettingId.SchemasEdgeCacheTTL;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public EdgeCacheTTLValue Value { get; set; }
}
/// <summary>
/// The time-to-live (TTL) of the challenge.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L1873">Soruce</see>
/// </summary>
public enum EdgeCacheTTLValue : int
{
/// <summary>
/// 30 seconds.
/// </summary>
HalfMinute = 30,
/// <summary>
/// 1 minute.
/// </summary>
Minute = 60,
/// <summary>
/// 5 minutes.
/// </summary>
FiveMinutes = 300,
/// <summary>
/// 20 minutes.
/// </summary>
TwentyMinutes = 1200,
/// <summary>
/// 30 minutes.
/// </summary>
HalfHour = 1800,
/// <summary>
/// 1 hour.
/// </summary>
Hour = 3600,
/// <summary>
/// 2 hours.
/// </summary>
TwoHours = 7200,
/// <summary>
/// 3 hours.
/// </summary>
ThreeHours = 10800,
/// <summary>
/// 4 hours.
/// </summary>
FourHours = 14400,
/// <summary>
/// 5 hours.
/// </summary>
FiveHours = 18000,
/// <summary>
/// 8 hours.
/// </summary>
EightHours = 28800,
/// <summary>
/// 12 hours.
/// </summary>
HalfDay = 43200,
/// <summary>
/// 16 hours.
/// </summary>
SixteenHours = 57600,
/// <summary>
/// 20 hours.
/// </summary>
TwentyHours = 72000,
/// <summary>
/// 1 day.
/// </summary>
Day = 86400,
/// <summary>
/// 2 days.
/// </summary>
TwoDays = 172800,
/// <summary>
/// 3 days.
/// </summary>
ThreeDays = 259200,
/// <summary>
/// 4 days.
/// </summary>
FourDays = 345600,
/// <summary>
/// 5 days.
/// </summary>
FiveDays = 432000,
/// <summary>
/// 6 days.
/// </summary>
SixDays = 518400,
/// <summary>
/// 1 week.
/// </summary>
Week = 604800,
}
}

View File

@@ -0,0 +1,70 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Cloudflare security header for a zone.
/// </summary>
public class SecurityHeaders : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="SecurityHeaders"/> class.
/// </summary>
public SecurityHeaders()
{
Id = ZoneSettingId.SecurityHeaders;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public SecurityHeaderValue? Value { get; set; }
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
public class SecurityHeaderValue
{
/// <summary>
/// Strict Transport Security.
/// </summary>
[JsonProperty("strict_transport_security")]
public SecurityHeaderStrictTransportSecurity? StrictTransportSecurity { get; set; }
}
/// <summary>
/// Strict Transport Security.
/// </summary>
public class SecurityHeaderStrictTransportSecurity
{
/// <summary>
/// Whether or not strict transport security is enabled.
/// </summary>
[JsonProperty("enabled")]
public bool? Enabled { get; set; }
/// <summary>
/// Include all subdomains for strict transport security.
/// </summary>
[JsonProperty("include_subdomains")]
public bool? IncludeSubdomains { get; set; }
/// <summary>
/// Max age in seconds of the strict transport security.
/// </summary>
[JsonProperty("max_age")]
public int? MaxAge { get; set; }
/// <summary>
/// Whether or not to include <c>X-Content-Type-Options: nosniff</c> header.
/// </summary>
[JsonProperty("nosniff")]
public bool? NoSniff { get; set; }
/// <summary>
/// Enable automatic preload of the HSTS configuration.
/// </summary>
[JsonProperty("preload")]
public bool? Preload { get; set; }
}
}

View File

@@ -0,0 +1,69 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Control options for the <strong>Security Level</strong> feature from the <strong>Security</strong> app.
/// </summary>
public class SecurityLevel : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="SecurityLevel"/> class.
/// </summary>
public SecurityLevel()
{
Id = ZoneSettingId.SecurityLevel;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public SecurityLevelValue? Value { get; set; }
}
/// <summary>
/// Security levels.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L1223">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum SecurityLevelValue
{
/// <summary>
/// Off.
/// </summary>
[EnumMember(Value = "off")]
Off = 1,
/// <summary>
/// Essentially off.
/// </summary>
[EnumMember(Value = "essentially_off")]
EssentiallyOff = 2,
/// <summary>
/// Low.
/// </summary>
[EnumMember(Value = "low")]
Low = 3,
/// <summary>
/// Medium.
/// </summary>
[EnumMember(Value = "medium")]
Medium = 4,
/// <summary>
/// High.
/// </summary>
[EnumMember(Value = "high")]
High = 5,
/// <summary>
/// Under Attack.
/// </summary>
[EnumMember(Value = "under_attack")]
UnderAttack = 6
}
}

View File

@@ -0,0 +1,34 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// If there is sensitive content on your website that you want visible to real
/// visitors, but that you want to hide from suspicious visitors, all you have to do
/// is wrap the content with Cloudflare SSE tags. Wrap any content that you want to
/// be excluded from suspicious visitors in the following SSE tags: <c>&lt;!--sse--&gt;&lt;/!--sse--&gt;</c>.
/// </summary>
/// <remarks>
/// For example: <c>&lt;!--sse--&gt;Bad visitors won't see my phone number, 555-555-5555&lt;/!--sse--&gt;</c>
/// <br/>
/// Note: SSE only will work with HTML. If you have HTML minification enabled,
/// you won't see the SSE tags in your HTML source when it's served through Cloudflare.
/// SSE will still function in this case, as Cloudflare's HTML minification and SSE
/// functionality occur on-the-fly as the resource moves through our network to the visitor's computer.
/// (<see href="https://support.cloudflare.com/hc/en-us/articles/200170036"/>).
/// </remarks>
public class ServerSideExcludes : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="ServerSideExcludes"/> class.
/// </summary>
public ServerSideExcludes()
{
Id = ZoneSettingId.ServerSideExcludes;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Turn on or off the reordering of query strings. When query strings have the same
/// structure, caching improves.
/// </summary>
public class SortQueryStringForCache : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="SortQueryStringForCache"/> class.
/// </summary>
public SortQueryStringForCache()
{
Id = ZoneSettingId.SortQueryStringForCache;
}
/// <summary>
/// The status of Query String Sort.
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,22 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Only allows TLS1.2.
/// </summary>
public class TLS1_2Only : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="TLS1_2Only"/> class.
/// </summary>
public TLS1_2Only()
{
Id = ZoneSettingId.TLS1_2Only;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,51 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Enables Crypto TLS 1.3 feature for a zone.
/// </summary>
public class TLS1_3 : ZoneSettingBase
{
/// <summary>
/// Enables Crypto TLS 1.3 feature for a zone.
/// </summary>
public TLS1_3()
{
Id = ZoneSettingId.TLS1_3;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public TlsOption Value { get; set; }
}
/// <summary>
/// Available TLS options.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/settings.ts#L1352">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum TlsOption
{
/// <summary>
/// Off.
/// </summary>
[EnumMember(Value = "off")]
Off = 1,
/// <summary>
/// On.
/// </summary>
[EnumMember(Value = "on")]
On = 2,
/// <summary>
/// ZRT refers to <see href="https://blog.cloudflare.com/introducing-0-rtt/">Zero Round Trip Time Resumption (0-RTT)</see>.
/// </summary>
[EnumMember(Value = "zrt")]
ZeroRoundTrip = 3
}
}

View File

@@ -0,0 +1,23 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// TLS Client Auth requires Cloudflare to connect to your origin server using a
/// client certificate (Enterprise Only).
/// </summary>
public class TLSClientAuth : ZoneSettingBase
{
/// <summary>
/// Initialize a new instance of the <see cref="TLSClientAuth"/> class.
/// </summary>
public TLSClientAuth()
{
Id = ZoneSettingId.TLSClientAuth;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,22 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Turn on or off the True-Client-IP Header feature of the Cloudflare Network app.
/// </summary>
public class TrueClientIPHeader : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="TrueClientIPHeader"/> class.
/// </summary>
public TrueClientIPHeader()
{
Id = ZoneSettingId.TrueClientIPHeader;
}
/// <summary>
/// The status of True Client IP Header.
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,24 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Turn on or off
/// <see href="https://developers.cloudflare.com/waf/reference/legacy/old-waf-managed-rules/">WAF managed rules (previous version, deprecated)</see>.
/// You cannot enable or disable individual WAF managed rules via Page Rules.
/// </summary>
public class WAF : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="WAF"/> class.
/// </summary>
public WAF()
{
Id = ZoneSettingId.WAF;
}
/// <summary>
/// The status of WAF managed rules (previous version).
/// </summary>
[JsonProperty("value")]
public OnOffState? Value { get; set; }
}
}

View File

@@ -0,0 +1,24 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// When the client requesting the image supports the WebP image codec, and WebP
/// offers a performance advantage over the original image format, Cloudflare will
/// serve a WebP version of the original image.
/// </summary>
public class WebP : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="WebP"/> class.
/// </summary>
public WebP()
{
Id = ZoneSettingId.WebP;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,27 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// WebSockets are open connections sustained between the client and the origin
/// server. Inside a WebSockets connection, the client and the origin can pass data
/// back and forth without having to reestablish sessions. This makes exchanging
/// data within a WebSockets connection fast. WebSockets are often used for real-time
/// applications such as live chat and gaming. For more information refer to
/// <see href="https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-">Can I use Cloudflare with Websockets</see>.
/// </summary>
public class Websocket : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="Websocket"/> class.
/// </summary>
public Websocket()
{
Id = ZoneSettingId.Websocket;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,22 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// 0-RTT session resumption enabled for this zone.
/// </summary>
public class ZeroRTT : ZoneSettingBase
{
/// <summary>
/// Initializes a new instance of the <see cref="ZeroRTT"/> class.
/// </summary>
public ZeroRTT()
{
Id = ZoneSettingId.ZeroRTT;
}
/// <summary>
/// Current value of the zone setting.
/// </summary>
[JsonProperty("value")]
public OnOffState Value { get; set; }
}
}

View File

@@ -0,0 +1,26 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// A Cloudflare zone setting.
/// </summary>
public abstract class ZoneSettingBase
{
/// <summary>
/// The ID of the zone setting.
/// </summary>
[JsonProperty("id")]
public ZoneSettingId? Id { get; protected set; }
/// <summary>
/// Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).
/// </summary>
[JsonProperty("editable")]
public bool? Editable { get; set; }
/// <summary>
/// The last time this setting was modified.
/// </summary>
[JsonProperty("modified_on")]
public DateTime? ModifiedOn { get; set; }
}
}

View File

@@ -44,6 +44,12 @@ This package contains the feature set of the _Domain/Zone Management_ section of
- [List Available Rate Plans](https://developers.cloudflare.com/api/resources/zones/subresources/rate_plans/methods/get/) - [List Available Rate Plans](https://developers.cloudflare.com/api/resources/zones/subresources/rate_plans/methods/get/)
##### [Settings]
- **DEPRECATED** [Edit Multiple Zone Settings](https://developers.cloudflare.com/api/resources/zones/subresources/settings/methods/bulk_edit/)
- [Edit Zone Setting](https://developers.cloudflare.com/api/resources/zones/subresources/settings/methods/edit/)
- [Get Zone Setting](https://developers.cloudflare.com/api/resources/zones/subresources/settings/methods/get/)
- **DEPRECATED** [Get All Zone Settings](https://developers.cloudflare.com/api/resources/zones/subresources/settings/methods/list/)
@@ -61,3 +67,4 @@ Published under MIT License (see [choose a license])
[Holds]: https://developers.cloudflare.com/api/resources/zones/subresources/holds/ [Holds]: https://developers.cloudflare.com/api/resources/zones/subresources/holds/
[Plans]: https://developers.cloudflare.com/api/resources/zones/subresources/plans/ [Plans]: https://developers.cloudflare.com/api/resources/zones/subresources/plans/
[Rate Plans]: https://developers.cloudflare.com/api/resources/zones/subresources/rate_plans/ [Rate Plans]: https://developers.cloudflare.com/api/resources/zones/subresources/rate_plans/
[Settings]: https://developers.cloudflare.com/api/resources/zones/subresources/settings/

View File

@@ -0,0 +1,27 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Represents a request to edit multiple zone settings.
/// </summary>
public class EditMultipleZoneSettingsRequest
{
/// <summary>
/// Initializes a new instance of the <see cref="EditMultipleZoneSettingsRequest"/> class.
/// </summary>
/// <param name="zoneId">The zone identifier.</param>
public EditMultipleZoneSettingsRequest(string zoneId)
{
ZoneId = zoneId;
}
/// <summary>
/// The zone identifier.
/// </summary>
public string ZoneId { get; set; }
/// <summary>
/// The zone settings.
/// </summary>
public IReadOnlyCollection<ZoneSettingBase>? Settings { get; set; }
}
}

View File

@@ -0,0 +1,39 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Represents a request to edit a zone setting.
/// </summary>
/// <typeparam name="T"></typeparam>
public class EditZoneSettingRequest<T>
{
/// <summary>
/// Initializes a new instance of the <see cref="EditZoneSettingRequest{T}"/> class.
/// </summary>
/// <param name="zoneId">The zone identifier.</param>
/// <param name="setting">The zone setting.</param>
public EditZoneSettingRequest(string zoneId, T setting)
{
ZoneId = zoneId;
Setting = setting;
}
/// <summary>
/// The zone identifier.
/// </summary>
public string ZoneId { get; set; }
/// <summary>
/// The zone setting.
/// </summary>
public T Setting { get; set; }
/// <summary>
/// Indicates whether the setting should be enabled or disabled.
/// </summary>
/// <remarks>
/// If this property is not <see langword="null"/>,
/// the value of the <see cref="Setting"/> will not be modified.
/// </remarks>
public bool? Enabled { get; set; }
}
}

View File

@@ -0,0 +1,82 @@
using System.Threading;
using System.Threading.Tasks;
using Newtonsoft.Json.Linq;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Extensions for <see href="https://developers.cloudflare.com/api/resources/zones/subresources/settings/">Zone Settings</see>.
/// </summary>
public static class ZoneSettingsExtensions
{
/// <summary>
/// Edit settings for a zone.
/// </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>
[Obsolete("This endpoint is deprecated. Zone settings should instead be managed individually.")]
public static Task<CloudflareResponse<IReadOnlyCollection<ZoneSettingBase>>> EditMultipleZoneSettings(this ICloudflareClient client, EditMultipleZoneSettingsRequest request, CancellationToken cancellationToken = default)
{
request.ZoneId.ValidateCloudflareId();
return client.PatchAsync<IReadOnlyCollection<ZoneSettingBase>, IReadOnlyCollection<ZoneSettingBase>>($"/zones/{request.ZoneId}/settings", request.Settings, cancellationToken);
}
/// <summary>
/// Updates a single zone setting by the identifier.
/// </summary>
/// <typeparam name="T">The type of the zone setting.</typeparam>
/// <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<T>> EditZoneSetting<T>(this ICloudflareClient client, EditZoneSettingRequest<T> request, CancellationToken cancellationToken = default)
where T : ZoneSettingBase
{
request.ZoneId.ValidateCloudflareId();
string settingId = request.Setting.Id?.GetEnumMemberValue()
?? throw new ArgumentException("The zone setting type is not known.");
var req = new JObject();
if (request.Enabled.HasValue)
req.Add("enabled", request.Enabled.Value);
else
req.Add("value", JObject.FromObject(request.Setting)["value"]);
return client.PatchAsync<T, JObject>($"/zones/{request.ZoneId}/settings/{settingId}", req, cancellationToken);
}
/// <summary>
/// Fetch a single zone setting.
/// </summary>
/// <typeparam name="T">The type of the zone setting.</typeparam>
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
/// <param name="zoneId">The zone identifier.</param>
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
public static Task<CloudflareResponse<T>> GetZoneSetting<T>(this ICloudflareClient client, string zoneId, CancellationToken cancellationToken = default)
where T : ZoneSettingBase
{
zoneId.ValidateCloudflareId();
string settingId = ((ZoneSettingBase)Activator.CreateInstance(typeof(T))).Id?.GetEnumMemberValue()
?? throw new ArgumentException("The zone setting type is not known.");
return client.GetAsync<T>($"/zones/{zoneId}/settings/{settingId}", null, cancellationToken);
}
/// <summary>
/// Available settings for your user in relation to a zone.
/// </summary>
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
/// <param name="zoneId">The zone identifier.</param>
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
[Obsolete("This endpoint is deprecated. Zone settings should instead be managed individually.")]
public static Task<CloudflareResponse<IReadOnlyCollection<ZoneSettingBase>>> GetAllZoneSettings(this ICloudflareClient client, string zoneId, CancellationToken cancellationToken = default)
{
zoneId.ValidateCloudflareId();
return client.GetAsync<IReadOnlyCollection<ZoneSettingBase>>($"/zones/{zoneId}/settings", null, cancellationToken);
}
}
}

View File

@@ -0,0 +1,91 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare;
using AMWD.Net.Api.Cloudflare.Zones;
using Moq;
namespace Cloudflare.Zones.Tests.ZoneSettingsExtensions
{
[TestClass]
public class EditMultipleZoneSettingsTest
{
private const string ZoneId = "023e105f4ecef8ad9ca31a8372d0c353";
private Mock<ICloudflareClient> _clientMock;
private CloudflareResponse<IReadOnlyCollection<ZoneSettingBase>> _response;
private List<(string RequestPath, IReadOnlyCollection<ZoneSettingBase> Request)> _callbacks;
private EditMultipleZoneSettingsRequest _request;
[TestInitialize]
public void Initialize()
{
_callbacks = [];
_response = new CloudflareResponse<IReadOnlyCollection<ZoneSettingBase>>
{
Success = true,
Messages = [
new ResponseInfo(1000, "Message 1")
],
Errors = [
new ResponseInfo(1000, "Error 1")
],
Result = [
new SSL { Value = SslMode.Flexible },
new WebP { Value = OnOffState.Off }
]
};
_request = new EditMultipleZoneSettingsRequest(ZoneId)
{
Settings = [
new SSL { Value = SslMode.Strict },
new WebP { Value = OnOffState.On }
]
};
}
[TestMethod]
public async Task ShouldEditMultipleZoneSettings()
{
// Arrange
var client = GetClient();
// Act
#pragma warning disable CS0618
var response = await client.EditMultipleZoneSettings(_request);
#pragma warning restore CS0618
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/settings", callback.RequestPath);
Assert.IsNotNull(callback.Request);
Assert.AreEqual(2, callback.Request.Count);
Assert.IsInstanceOfType<SSL>(callback.Request.First());
Assert.IsInstanceOfType<WebP>(callback.Request.Last());
}
private ICloudflareClient GetClient()
{
_clientMock = new Mock<ICloudflareClient>();
_clientMock
.Setup(m => m.PatchAsync<IReadOnlyCollection<ZoneSettingBase>, IReadOnlyCollection<ZoneSettingBase>>(It.IsAny<string>(), It.IsAny<IReadOnlyCollection<ZoneSettingBase>>(), It.IsAny<CancellationToken>()))
.Callback<string, IReadOnlyCollection<ZoneSettingBase>, CancellationToken>((requestPath, request, _) => _callbacks.Add((requestPath, request)))
.ReturnsAsync(() => _response);
return _clientMock.Object;
}
}
}

View File

@@ -0,0 +1,127 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare;
using AMWD.Net.Api.Cloudflare.Zones;
using Moq;
using Newtonsoft.Json.Linq;
namespace Cloudflare.Zones.Tests.ZoneSettingsExtensions
{
[TestClass]
public class EditZoneSettingTest
{
private const string ZoneId = "023e105f4ecef8ad9ca31a8372d0c353";
private Mock<ICloudflareClient> _clientMock;
private CloudflareResponse<SSL> _response;
private List<(string RequestPath, JObject Request)> _callbacks;
private EditZoneSettingRequest<SSL> _request;
[TestInitialize]
public void Initialize()
{
_callbacks = [];
_response = new CloudflareResponse<SSL>
{
Success = true,
Messages = [
new ResponseInfo(1000, "Message 1")
],
Errors = [
new ResponseInfo(1000, "Error 1")
],
Result = new SSL { Value = SslMode.Flexible }
};
_request = new EditZoneSettingRequest<SSL>(ZoneId, null)
{
Setting = new SSL { Value = SslMode.OriginPull }
};
}
[TestMethod]
public async Task ShouldEditZoneSetting()
{
// Arrange
var client = GetClient();
// Act
var response = await client.EditZoneSetting(_request);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/settings/ssl", callback.RequestPath);
Assert.IsNotNull(callback.Request);
Assert.AreEqual("origin_pull", callback.Request["value"]);
Assert.IsFalse(callback.Request.ContainsKey("enabled"));
}
[DataTestMethod]
[DataRow(true)]
[DataRow(false)]
public async Task ShouldEditEnabledState(bool enabled)
{
// Arrange
_request.Enabled = enabled;
var client = GetClient();
// Act
var response = await client.EditZoneSetting(_request);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/settings/ssl", callback.RequestPath);
Assert.IsNotNull(callback.Request);
Assert.AreEqual(enabled, callback.Request["enabled"]);
Assert.IsFalse(callback.Request.ContainsKey("value"));
}
[TestMethod]
[ExpectedException(typeof(ArgumentException))]
public async Task ShouldThrowArgumentException()
{
// Arrange
var request = new EditZoneSettingRequest<TestSetting>(ZoneId, new TestSetting());
var client = GetClient();
// Act
var response = await client.EditZoneSetting(request);
// Assert - ArgumentException
}
private ICloudflareClient GetClient()
{
_clientMock = new Mock<ICloudflareClient>();
_clientMock
.Setup(m => m.PatchAsync<SSL, JObject>(It.IsAny<string>(), It.IsAny<JObject>(), It.IsAny<CancellationToken>()))
.Callback<string, JObject, CancellationToken>((requestPath, request, _) => _callbacks.Add((requestPath, request)))
.ReturnsAsync(() => _response);
return _clientMock.Object;
}
public class TestSetting : ZoneSettingBase
{
}
}
}

View File

@@ -0,0 +1,79 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare;
using AMWD.Net.Api.Cloudflare.Zones;
using Moq;
namespace Cloudflare.Zones.Tests.ZoneSettingsExtensions
{
[TestClass]
public class GetAllZoneSettingsTest
{
private const string ZoneId = "023e105f4ecef8ad9ca31a8372d0c353";
private Mock<ICloudflareClient> _clientMock;
private CloudflareResponse<IReadOnlyCollection<ZoneSettingBase>> _response;
private List<(string RequestPath, IQueryParameterFilter QueryFilter)> _callbacks;
[TestInitialize]
public void Initialize()
{
_callbacks = [];
_response = new CloudflareResponse<IReadOnlyCollection<ZoneSettingBase>>
{
Success = true,
Messages = [
new ResponseInfo(1000, "Message 1")
],
Errors = [
new ResponseInfo(1000, "Error 1")
],
Result = [
new SSL { Value = SslMode.Flexible },
new WebP { Value = OnOffState.Off }
]
};
}
[TestMethod]
public async Task ShouldReturnZoneSetting()
{
// Arrange
var client = GetClient();
// Act
#pragma warning disable CS0618
var response = await client.GetAllZoneSettings(ZoneId);
#pragma warning restore CS0618
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/settings", callback.RequestPath);
Assert.IsNull(callback.QueryFilter);
_clientMock.Verify(m => m.GetAsync<IReadOnlyCollection<ZoneSettingBase>>($"/zones/{ZoneId}/settings", null, It.IsAny<CancellationToken>()), Times.Once);
_clientMock.VerifyNoOtherCalls();
}
private ICloudflareClient GetClient()
{
_clientMock = new Mock<ICloudflareClient>();
_clientMock
.Setup(m => m.GetAsync<IReadOnlyCollection<ZoneSettingBase>>(It.IsAny<string>(), It.IsAny<IQueryParameterFilter>(), It.IsAny<CancellationToken>()))
.Callback<string, IQueryParameterFilter, CancellationToken>((requestPath, queryFilter, _) => _callbacks.Add((requestPath, queryFilter)))
.ReturnsAsync(() => _response);
return _clientMock.Object;
}
}
}

View File

@@ -0,0 +1,91 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare;
using AMWD.Net.Api.Cloudflare.Zones;
using Moq;
namespace Cloudflare.Zones.Tests.ZoneSettingsExtensions
{
[TestClass]
public class GetZoneSettingTest
{
private const string ZoneId = "023e105f4ecef8ad9ca31a8372d0c353";
private Mock<ICloudflareClient> _clientMock;
private CloudflareResponse<SSL> _response;
private List<(string RequestPath, IQueryParameterFilter QueryFilter)> _callbacks;
[TestInitialize]
public void Initialize()
{
_callbacks = [];
_response = new CloudflareResponse<SSL>
{
Success = true,
Messages = [
new ResponseInfo(1000, "Message 1")
],
Errors = [
new ResponseInfo(1000, "Error 1")
],
Result = new SSL { Value = SslMode.Flexible }
};
}
[TestMethod]
public async Task ShouldReturnZoneSetting()
{
// Arrange
var client = GetClient();
// Act
var response = await client.GetZoneSetting<SSL>(ZoneId);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/settings/ssl", callback.RequestPath);
Assert.IsNull(callback.QueryFilter);
_clientMock.Verify(m => m.GetAsync<SSL>($"/zones/{ZoneId}/settings/ssl", null, It.IsAny<CancellationToken>()), Times.Once);
_clientMock.VerifyNoOtherCalls();
}
[TestMethod]
[ExpectedException(typeof(ArgumentException))]
public async Task ShouldThrowArgumentException()
{
// Arrange
var client = GetClient();
// Act
var response = await client.GetZoneSetting<TestSetting>(ZoneId);
// Assert - ArgumentException
}
private ICloudflareClient GetClient()
{
_clientMock = new Mock<ICloudflareClient>();
_clientMock
.Setup(m => m.GetAsync<SSL>(It.IsAny<string>(), It.IsAny<IQueryParameterFilter>(), It.IsAny<CancellationToken>()))
.Callback<string, IQueryParameterFilter, CancellationToken>((requestPath, queryFilter, _) => _callbacks.Add((requestPath, queryFilter)))
.ReturnsAsync(() => _response);
return _clientMock.Object;
}
public class TestSetting : ZoneSettingBase
{
}
}
}