am-wd/cloudflare-api
1
0
Fork 0
Code Issues Actions Activity

Reorganize, shared entities from TypeScript SDK

Browse Source 
https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts
This commit is contained in:
Andreas Müller
2025-06-24 09:16:43 +02:00
parent d64e445a79
commit 135e1a11f3
49 changed files with 1719 additions and 237 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
Cloudflare/Models/AccountBase.cs
View File

@@ -1,21 +0,0 @@
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// Base implementation of an account.
/// </summary>
public class AccountBase
{
/// <summary>
/// Identifier
/// </summary>
// <= 32 characters
[JsonProperty("id")]
public string? Id { get; set; }
/// <summary>
/// The name of the account.
/// </summary>
[JsonProperty("name")]
public string? Name { get; set; }
}
}

182
Cloudflare/Models/AuditLog.cs Normal file
View File

@@ -0,0 +1,182 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// An audit log entry.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L10">Source</see>
/// </summary>
public class AuditLog
{
/// <summary>
/// A string that uniquely identifies the audit log.
/// </summary>
[JsonProperty("id")]
public string? Id { get; set; }
/// <summary>
/// The action that was performed.
/// </summary>
[JsonProperty("action")]
public AuditLogAction? Action { get; set; }
/// <summary>
/// The actor that performed the action.
/// </summary>
[JsonProperty("actor")]
public AuditLogActor? Actor { get; set; }
/// <summary>
/// The source of the event.
/// </summary>
[JsonProperty("interface")]
public string? Interface { get; set; }
/// <summary>
/// An object which can lend more context to the action being logged.
/// This is a flexible value and varies between different actions.
/// </summary>
[JsonProperty("metadata")]
public object? MetaData { get; set; }
/// <summary>
/// The new value of the resource that was modified.
/// </summary>
[JsonProperty("newValue")]
public string? NewValue { get; set; }
/// <summary>
/// The value of the resource before it was modified.
/// </summary>
[JsonProperty("oldValue")]
public string? OldValue { get; set; }
/// <summary>
/// The owner of the resource that was modified.
/// </summary>
[JsonProperty("owner")]
public AuditLogOwner? Owner { get; set; }
/// <summary>
/// The resource that was modified.
/// </summary>
[JsonProperty("resource")]
public AuditLogResource? Resource { get; set; }
/// <summary>
/// A UTC RFC3339 timestamp that specifies when the action being logged occured.
/// </summary>
[JsonProperty("when")]
public DateTime? When { get; set; }
}
/// <summary>
/// The action that was performed.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L52">Soruce</see>
/// </summary>
public class AuditLogAction
{
/// <summary>
/// A boolean that indicates if the action attempted was successful.
/// </summary>
[JsonProperty("result")]
public bool? Result { get; set; }
/// <summary>
/// A short string that describes the action that was performed.
/// </summary>
[JsonProperty("type")]
public string? Type { get; set; }
}
/// <summary>
/// The actor that performed the action.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L64">Source</see>
/// </summary>
public class AuditLogActor
{
/// <summary>
/// The ID of the actor that performed the action.
/// If a user performed the action, this will be the user's ID.
/// </summary>
[JsonProperty("id")]
public string? Id { get; set; }
/// <summary>
/// The email of the user that performed the action.
/// </summary>
[JsonProperty("email")]
public string? Email { get; set; }
/// <summary>
/// The IP address of the request that performed the action.
/// </summary>
[JsonProperty("ip")]
public string? IpAddress { get; set; }
/// <summary>
/// The type of actor, whether a User, Cloudflare Admin, or an Automated System.
/// </summary>
[JsonProperty("type")]
public AuditLogActorType? Type { get; set; }
}
/// <summary>
/// The type of actor.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L84">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum AuditLogActorType
{
/// <summary>
/// User interaction.
/// </summary>
[EnumMember(Value = "user")]
User = 1,
/// <summary>
/// Cloudflare admin interaction.
/// </summary>
[EnumMember(Value = "admin")]
Admin = 2,
/// <summary>
/// Cloudflare automated system interaction.
/// </summary>
[EnumMember(Value = "Cloudflare")]
Cloudflare = 3
}
/// <summary>
/// The owner of the resource that was modified.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L87">Source</see>
/// </summary>
public class AuditLogOwner
{
/// <summary>
/// Identifier.
/// </summary>
[JsonProperty("id")]
public string? Id { get; set; }
}
/// <summary>
/// The resource that was modified.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L94">Source</see>
/// </summary>
public class AuditLogResource
{
/// <summary>
/// An identifier for the resource that was affected by the action.
/// </summary>
[JsonProperty("id")]
public string? Id { get; set; }
/// <summary>
/// A short string that describes the resource that was affected by the action.
/// </summary>
[JsonProperty("type")]
public string? Type { get; set; }
}
}

44
Cloudflare/Models/CloudflareResponse.cs Normal file
View File

@@ -0,0 +1,44 @@
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// The base Cloudflare response.
/// Derived from <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L616">Source: Result</see>
/// </summary>
public class CloudflareResponse
{
/// <summary>
/// Errors returned by the API call.
/// </summary>
[JsonProperty("errors")]
public IReadOnlyList<ResponseInfo> Errors { get; set; } = [];
/// <summary>
/// Messages returned by the API call.
/// </summary>
[JsonProperty("messages")]
public IReadOnlyList<ResponseInfo> Messages { get; set; } = [];
/// <summary>
/// Whether the API call was successful.
/// </summary>
[JsonProperty("success")]
public bool Success { get; set; }
}
/// <inheritdoc/>
/// <typeparam name="T">The result type.</typeparam>
public class CloudflareResponse<T> : CloudflareResponse
{
/// <summary>
/// The result of the API call.
/// </summary>
[JsonProperty("result")]
public T? Result { get; set; }
/// <summary>
/// Information about the result of the request.
/// </summary>
[JsonProperty("result_info")]
public PaginationInfo? ResultInfo { get; set; }
}
}

229
Cloudflare/Models/CloudflareTunnel.cs Normal file
View File

@@ -0,0 +1,229 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L132">Source</see>
/// </summary>
public class CloudflareTunnel
{
/// <summary>
/// UUID of the tunnel.
/// </summary>
[JsonProperty("id")]
public string? Id { get; set; }
/// <summary>
/// Cloudflare account ID.
/// </summary>
[JsonProperty("account_tag")]
public string? AccountTag { get; set; }
/// <summary>
/// Active connections.
/// </summary>
[JsonProperty("connections")]
[Obsolete("This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint '/accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections'.")]
public IReadOnlyCollection<CloudflareTunnelConnection>? Connections { get; set; }
/// <summary>
/// Timestamp of when the tunnel established at least one connection to Cloudflare's edge.
/// If <see langword="null"/>, the tunnel is inactive.
/// </summary>
[JsonProperty("conns_active_at")]
public DateTime? ConnectionsActiveAt { get; set; }
/// <summary>
/// Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge).
/// If <see langword="null"/>, the tunnel is active.
/// </summary>
[JsonProperty("conns_inactive_at")]
public DateTime? ConnectionsInactiveAt { get; set; }
/// <summary>
/// Timestamp of when the resource was created.
/// </summary>
[JsonProperty("created_at")]
public DateTime? CreatedAt { get; set; }
/// <summary>
/// Timestamp of when the resource was deleted.
/// If <see langword="null"/>, the resource has not been deleted.
/// </summary>
[JsonProperty("deleted_at")]
public DateTime? DeletedAt { get; set; }
/// <summary>
/// Metadata associated with the tunnel.
/// </summary>
[JsonProperty("metadata")]
public object? MetaData { get; set; }
/// <summary>
/// A user-friendly name for a tunnel.
/// </summary>
[JsonProperty("name")]
public string? Name { get; set; }
/// <summary>
/// If <see langword="true"/>, the tunnel can be configured remotely from the Zero Trust dashboard.
/// If <see langword="false"/>, the tunnel must be configured locally on the origin machine.
/// </summary>
[JsonProperty("remote_config")]
public bool? RemoteConfiguration { get; set; }
/// <summary>
/// The status of the tunnel.
/// </summary>
[JsonProperty("status")]
public CloudflareTunnelStatus? Status { get; set; }
/// <summary>
/// The type of tunnel.
/// </summary>
[JsonProperty("tun_type")]
public CloudflareTunnelType? TunType { get; set; }
}
/// <summary>
/// A connection to Cloudflare's edge.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L204">Source</see>
/// </summary>
public class CloudflareTunnelConnection
{
/// <summary>
/// UUID of the Cloudflare Tunnel connection.
/// </summary>
[JsonProperty("id")]
public string? Id { get; set; }
/// <summary>
/// UUID of the Cloudflare Tunnel connector.
/// </summary>
[JsonProperty("client_id")]
public string? ClientId { get; set; }
/// <summary>
/// The cloudflared version used to establish this connection.
/// </summary>
[JsonProperty("client_version")]
public string? ClientVersion { get; set; }
/// <summary>
/// The Cloudflare data center used for this connection.
/// </summary>
[JsonProperty("colo_name")]
public string? ColocationName { get; set; }
/// <summary>
/// Cloudflare continues to track connections for several minutes after they disconnect.
/// This is an optimization to improve latency and reliability of reconnecting.
/// <br/>
/// If <see langword="true"/>, the connection has disconnected but is still being tracked.
/// If <see langword="false"/>, the connection is actively serving traffic.
/// </summary>
[JsonProperty("is_pending_reconnect")]
public bool? IsPendingReconnect { get; set; }
/// <summary>
/// Timestamp of when the connection was established.
/// </summary>
[JsonProperty("opened_at")]
public DateTime? OpenedAt { get; set; }
/// <summary>
/// The public IP address of the host running cloudflared.
/// </summary>
[JsonProperty("origin_ip")]
public string? OriginIp { get; set; }
/// <summary>
/// UUID of the Cloudflare Tunnel connection.
/// </summary>
[JsonProperty("uuid")]
public string? UUID { get; set; }
}
/// <summary>
/// The status of the tunnel.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L195">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum CloudflareTunnelStatus
{
/// <summary>
/// The tunnel has never been run.
/// </summary>
[EnumMember(Value = "inactive")]
Inactive = 1,
/// <summary>
/// The tunnel is active and able to serve traffic but in an unhealthy state.
/// </summary>
[EnumMember(Value = "degraded")]
Degraded = 2,
/// <summary>
/// The tunnel is active and able to serve traffic.
/// </summary>
[EnumMember(Value = "healthy")]
Healthy = 3,
/// <summary>
/// The tunnel can not serve traffic as it has no connections to the Cloudflare Edge.
/// </summary>
[EnumMember(Value = "down")]
Down = 4
}
/// <summary>
/// The type of tunnel.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L200">Source</see>
/// </summary>
public enum CloudflareTunnelType
{
/// <summary>
/// Cloudflared.
/// </summary>
[EnumMember(Value = "cfd_tunnel")]
Cloudflared = 1,
/// <summary>
/// WARP Connector.
/// </summary>
[EnumMember(Value = "warp_connector")]
WarpConnector = 2,
/// <summary>
/// WARP.
/// </summary>
[EnumMember(Value = "warp")]
Warp = 3,
/// <summary>
/// Magic WAN.
/// </summary>
[EnumMember(Value = "magic")]
MagicWAN = 4,
/// <summary>
/// IPsec.
/// </summary>
[EnumMember(Value = "ip_sec")]
IpSec = 5,
/// <summary>
/// GRE.
/// </summary>
[EnumMember(Value = "gre")]
Gre = 6,
/// <summary>
/// CNI.
/// </summary>
[EnumMember(Value = "cni")]
Cni = 7
}
}

46
Cloudflare/Models/ErrorData.cs Normal file
View File

@@ -0,0 +1,46 @@
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// An error message.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L250">Source</see>
/// </summary>
public class ErrorData
{
/// <summary>
/// The error code.
/// </summary>
[JsonProperty("code")]
public int? Code { get; set; }
/// <summary>
/// A link to documentation about the error.
/// </summary>
[JsonProperty("documentation_url")]
public string? DocumentationUrl { get; set; }
/// <summary>
/// The error message.
/// </summary>
[JsonProperty("message")]
public string? Message { get; set; }
/// <summary>
/// The source of the error.
/// </summary>
[JsonProperty("source")]
public ErrorDataSource? Source { get; set; }
}
/// <summary>
/// The source of the error.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L261">Source</see>
/// </summary>
public class ErrorDataSource
{
/// <summary>
/// The pointer to the source of the error.
/// </summary>
[JsonProperty("pointer")]
public string? Pointer { get; set; }
}
}

15
Cloudflare/Models/Identifier.cs Normal file
View File

@@ -0,0 +1,15 @@
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// A Cloudflare identifier.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L266">Source</see>
/// </summary>
public class Identifier
{
/// <summary>
/// Identifier.
/// </summary>
[JsonProperty("id")]
public string? Id { get; set; }
}
}

21
Cloudflare/Models/LoadBalancerPreview.cs Normal file
View File

@@ -0,0 +1,21 @@
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// A load balancer preview.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L273">Source</see>
/// </summary>
public class LoadBalancerPreview
{
/// <summary>
/// Monitored pool IDs mapped to their respective names.
/// </summary>
[JsonProperty("pools")]
public IDictionary<string, string>? Pools { get; set; }
/// <summary>
/// Preview ID.
/// </summary>
[JsonProperty("preview_id")]
public string? PreviewId { get; set; }
}
}

321
Cloudflare/Models/Member.cs Normal file
View File

@@ -0,0 +1,321 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// A Cloudflare member.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L282">Source</see>
/// </summary>
public class Member
{
/// <summary>
/// Membership identifier tag.
/// </summary>
[JsonProperty("id")]
public string? Id { get; set; }
/// <summary>
/// Access policy for the membership.
/// </summary>
[JsonProperty("policies")]
public IReadOnlyCollection<MemberPolicy>? Policies { get; set; }
/// <summary>
/// Roles assigned to this Member.
/// </summary>
[JsonProperty("roles")]
public IReadOnlyCollection<Role>? Roles { get; set; }
/// <summary>
/// A member's status in the account.
/// </summary>
[JsonProperty("status")]
public MemberStatus? Status { get; set; }
/// <summary>
/// Details of the user associated to the membership.
/// </summary>
[JsonProperty("user")]
public MemberUser? User { get; set; }
}
/// <summary>
/// A member's access policy.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L310">Source</see>
/// </summary>
public class MemberPolicy
{
/// <summary>
/// Policy identifier.
/// </summary>
[JsonProperty("id")]
public string? Id { get; set; }
/// <summary>
/// Allow or deny operations against the resources.
/// </summary>
[JsonProperty("access")]
public MemberPolicyAccess? Access { get; set; }
/// <summary>
/// A set of permission groups that are specified to the policy.
/// </summary>
[JsonProperty("permission_groups")]
public IReadOnlyCollection<MemberPolicyPermissionGroup>? PermissionGroups { get; set; }
/// <summary>
/// A list of resource groups that the policy applies to.
/// </summary>
[JsonProperty("resource_groups")]
public IReadOnlyCollection<MemberPolicyResourceGroup>? ResourceGroups { get; set; }
}
/// <summary>
/// A member's status.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L301">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum MemberStatus
{
/// <summary>
/// The member has accepted the invitation.
/// </summary>
[EnumMember(Value = "accepted")]
Accepted = 1,
/// <summary>
/// The member has not yet accepted the invitation.
/// </summary>
[EnumMember(Value = "pending")]
Pending = 2
}
/// <summary>
/// A member's policy access.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L319">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum MemberPolicyAccess
{
/// <summary>
/// Allow operations against the resource.
/// </summary>
[EnumMember(Value = "allow")]
Allow = 1,
/// <summary>
/// Deny operations against the resource.
/// </summary>
[EnumMember(Value = "deny")]
Deny = 2
}
/// <summary>
/// A member's permission group.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L337">Source</see>
/// </summary>
public class MemberPolicyPermissionGroup
{
/// <summary>
/// Initializes a new instance of the <see cref="MemberPolicyPermissionGroup"/> class.
/// </summary>
/// <param name="id">Identifier of the permission group.</param>
public MemberPolicyPermissionGroup(string id)
{
Id = id;
}
/// <summary>
/// Identifier of the permission group.
/// </summary>
[JsonProperty("id")]
public string Id { get; set; }
/// <summary>
/// Attributes associated to the permission group.
/// </summary>
[JsonProperty("meta")]
public MemberPolicyPermissionGroupMeta? Meta { get; set; }
/// <summary>
/// Name of the permission group.
/// </summary>
[JsonProperty("name")]
public string? Name { get; set; }
}
/// <summary>
/// Attributes associated to the permission group.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L358">Source</see>
/// </summary>
public class MemberPolicyPermissionGroupMeta
{
/// <summary>
/// The key of the attribute.
/// </summary>
[JsonProperty("key")]
public string? Key { get; set; }
/// <summary>
/// The value of the attribute.
/// </summary>
[JsonProperty("value")]
public string? Value { get; set; }
}
/// <summary>
/// A group of scoped resources.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L368">Source</see>
/// </summary>
public class MemberPolicyResourceGroup
{
/// <summary>
/// Initializes a new instance of the <see cref="MemberPolicyResourceGroup"/> class.
/// </summary>
/// <param name="id">Identifier of the resource group.</param>
public MemberPolicyResourceGroup(string id)
{
Id = id;
}
/// <summary>
/// Identifier of the resource group.
/// </summary>
[JsonProperty("id")]
public string Id { get; set; }
/// <summary>
/// The scope associated to the resource group.
/// </summary>
[JsonProperty("scope")]
public IReadOnlyCollection<MemberPolicyResourceGroupScope> Scope { get; set; } = [];
/// <summary>
/// Attributes associated to the resource group.
/// </summary>
[JsonProperty("meta")]
public MemberPolicyResourceGroupMeta? Meta { get; set; }
/// <summary>
/// Name of the resource group.
/// </summary>
[JsonProperty("name")]
public string? Name { get; set; }
}
/// <summary>
/// Attributes associated to the resource group.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L394">Source</see>
/// </summary>
public class MemberPolicyResourceGroupScope
{
/// <summary>
/// Initializes a new instance of the <see cref="MemberPolicyResourceGroupScope"/> class.
/// </summary>
/// <param name="key">Combination of pre-defined resource name and identifier.</param>
public MemberPolicyResourceGroupScope(string key)
{
Key = key;
}
/// <summary>
/// This is a combination of pre-defined resource name and identifier (like Account ID etc.)
/// </summary>
[JsonProperty("key")]
public string Key { get; set; }
/// <summary>
/// A list of scope objects for additional context.
/// </summary>
[JsonProperty("objects")]
public IReadOnlyCollection<MemberPolicyResourceGroupScopeObject> Objects { get; set; } = [];
}
/// <summary>
/// A scope object for additional context.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L412">Source</see>
/// </summary>
public class MemberPolicyResourceGroupScopeObject
{
/// <summary>
/// Initializes a new instance of the <see cref="MemberPolicyResourceGroupScopeObject"/> class.
/// </summary>
/// <param name="key">Combination of pre-defined resource name and identifier.</param>
public MemberPolicyResourceGroupScopeObject(string key)
{
Key = key;
}
/// <summary>
/// This is a combination of pre-defined resource name and identifier (like Zone ID etc.)
/// </summary>
[JsonProperty("key")]
public string Key { get; set; }
}
/// <summary>
/// Attributes associated to the resource group.
/// </summary>
public class MemberPolicyResourceGroupMeta
{
/// <summary>
/// The key of the attribute.
/// </summary>
[JsonProperty("key")]
public string? Key { get; set; }
/// <summary>
/// The value of the attribute.
/// </summary>
[JsonProperty("value")]
public string? Value { get; set; }
}
/// <summary>
/// Details of the user associated to the membership.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L435">Source</see>
/// </summary>
public class MemberUser
{
/// <summary>
/// Initializes a new instance of the <see cref="MemberUser"/> class.
/// </summary>
/// <param name="email">The contact email address of the user.</param>
public MemberUser(string email)
{
Email = email;
}
/// <summary>
/// The contact email address of the user.
/// </summary>
[JsonProperty("email")]
public string Email { get; set; }
/// <summary>
/// Identifier.
/// </summary>
[JsonProperty("id")]
public string? Id { get; set; }
/// <summary>
/// User's first name.
/// </summary>
[JsonProperty("first_name")]
public string? FirstName { get; set; }
/// <summary>
/// User's last name.
/// </summary>
[JsonProperty("last_name")]
public string? LastName { get; set; }
/// <summary>
/// Indicates whether two-factor authentication is enabled for the user account.
/// Does not apply to API authentication.
/// </summary>
[JsonProperty("two_factor_authentication_enabled")]
public bool? TwoFactorAuthEnabled { get; set; }
}
}

33
Cloudflare/Models/PaginationInfo.cs Normal file
View File

@@ -0,0 +1,33 @@
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// Information about pagination.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L464">Source</see>
/// </summary>
public class PaginationInfo
{
/// <summary>
/// Total number of results for the requested service.
/// </summary>
[JsonProperty("count")]
public int? Count { get; set; }
/// <summary>
/// Current page within paginated list of results.
/// </summary>
[JsonProperty("page")]
public int? Page { get; set; }
/// <summary>
/// Number of results per page of results.
/// </summary>
[JsonProperty("per_page")]
public int? PerPage { get; set; }
/// <summary>
/// Total results available without any search parameters.
/// </summary>
[JsonProperty("total_count")]
public int? TotalCount { get; set; }
}
}

21
Cloudflare/Models/PermissionGrant.cs Normal file
View File

@@ -0,0 +1,21 @@
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// A permission grant.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L488">Source</see>
/// </summary>
public class PermissionGrant
{
/// <summary>
/// Whether the member can read the resource.
/// </summary>
[JsonProperty("read")]
public bool? CanRead { get; set; }
/// <summary>
/// Whether the member can write to the resource.
/// </summary>
[JsonProperty("write")]
public bool? CanWrite { get; set; }
}
}

122
Cloudflare/Models/RatePlan.cs Normal file
View File

@@ -0,0 +1,122 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// The rate plan applied to the subscription.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L503">Source</see>
/// </summary>
public class RatePlan
{
/// <summary>
/// The ID of the rate plan.
/// </summary>
[JsonProperty("id")]
public RatePlanId? Id { get; set; }
/// <summary>
/// The currency applied to the rate plan subscription.
/// </summary>
[JsonProperty("currency")]
public string? Currency { get; set; }
/// <summary>
/// Whether this rate plan is managed externally from Cloudflare.
/// </summary>
[JsonProperty("externally_managed")]
public bool? ExternallyManaged { get; set; }
/// <summary>
/// Whether a rate plan is enterprise-based (or newly adopted term contract).
/// </summary>
[JsonProperty("is_contract")]
public bool? IsContract { get; set; }
/// <summary>
/// The full name of the rate plan.
/// </summary>
[JsonProperty("public_name")]
public string? PublicName { get; set; }
/// <summary>
/// The scope that this rate plan applies to.
/// </summary>
[JsonProperty("scope")]
public string? Scope { get; set; }
/// <summary>
/// The list of sets this rate plan applies to.
/// </summary>
[JsonProperty("sets")]
public IReadOnlyCollection<string>? Sets { get; set; }
}
/// <summary>
/// Available rate plan ids.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L507">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum RatePlanId
{
/// <summary>
/// The free rate plan.
/// </summary>
[EnumMember(Value = "free")]
Free = 1,
/// <summary>
/// The lite rate plan.
/// </summary>
[EnumMember(Value = "lite")]
Lite = 2,
/// <summary>
/// The pro rate plan.
/// </summary>
[EnumMember(Value = "pro")]
Pro = 3,
/// <summary>
/// The pro+ rate plan.
/// </summary>
[EnumMember(Value = "pro_plus")]
ProPlus = 4,
/// <summary>
/// The business rate plan.
/// </summary>
[EnumMember(Value = "business")]
Business = 5,
/// <summary>
/// The enterprise rate plan.
/// </summary>
[EnumMember(Value = "enterprise")]
Enterprise = 6,
/// <summary>
/// The partners free rate plan.
/// </summary>
[EnumMember(Value = "partners_free")]
PartnersFree = 7,
/// <summary>
/// The partners pro rate plan.
/// </summary>
[EnumMember(Value = "partners_pro")]
PartnersPro = 8,
/// <summary>
/// The partners business rate plan.
/// </summary>
[EnumMember(Value = "partners_business")]
PartnersBusiness = 9,
/// <summary>
/// The partners enterprise rate plan.
/// </summary>
[EnumMember(Value = "partners_enterprise")]
PartnersEnterprise = 10
}
}

57
Cloudflare/Models/ResponseInfo.cs Normal file
View File

@@ -0,0 +1,57 @@
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// A response info.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L600">Source</see>
/// </summary>
public class ResponseInfo
{
/// <summary>
/// Initializes a new instance of the <see cref="ResponseInfo"/> class.
/// </summary>
/// <param name="code">The response code.</param>
/// <param name="message">The response message.</param>
public ResponseInfo(int code, string message)
{
Code = code;
Message = message;
}
/// <summary>
/// The response code.
/// </summary>
[JsonProperty("code")]
public int Code { get; set; }
/// <summary>
/// The response message.
/// </summary>
[JsonProperty("message")]
public string Message { get; set; }
/// <summary>
/// The documentation URL.
/// </summary>
[JsonProperty("documentation_url")]
public string? DocumentationUrl { get; set; }
/// <summary>
/// The response source.
/// </summary>
[JsonProperty("source")]
public ResponseInfoSource? Source { get; set; }
}
/// <summary>
/// A response info source.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L611">Source</see>
/// </summary>
public class ResponseInfoSource
{
/// <summary>
/// The pointer.
/// </summary>
[JsonProperty("pointer")]
public string? Pointer { get; set; }
}
}

127
Cloudflare/Models/Role.cs Normal file
View File

@@ -0,0 +1,127 @@
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// A Cloudflare role.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L641">Source</see>
/// </summary>
public class Role
{
/// <summary>
/// Initializes a new instance of the <see cref="Role"/> class.
/// </summary>
/// <param name="id">Role identifier tag.</param>
/// <param name="name">Role name.</param>
/// <param name="description">Description of role's permissions.</param>
/// <param name="permissions">Permissions.</param>
public Role(string id, string name, string description, RolePermissions permissions)
{
Id = id;
Name = name;
Description = description;
Permissions = permissions;
}
/// <summary>
/// Role identifier tag.
/// </summary>
[JsonProperty("id")]
public string Id { get; set; }
/// <summary>
/// Description of role's permissions.
/// </summary>
[JsonProperty("description")]
public string Description { get; set; }
/// <summary>
/// Role name.
/// </summary>
[JsonProperty("name")]
public string Name { get; set; }
/// <summary>
/// Role permissions.
/// </summary>
[JsonProperty("permissions")]
public RolePermissions Permissions { get; set; }
}
/// <summary>
/// Role permissions.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L661">Source</see>
/// </summary>
public class RolePermissions
{
/// <summary>
/// Analytics permissions.
/// </summary>
[JsonProperty("analytics")]
public PermissionGrant? Analytics { get; set; }
/// <summary>
/// Billing permissions.
/// </summary>
[JsonProperty("billing")]
public PermissionGrant? Billing { get; set; }
/// <summary>
/// Cache Purge permissions.
/// </summary>
[JsonProperty("cache_purge")]
public PermissionGrant? CachePurge { get; set; }
/// <summary>
/// DNS permissions.
/// </summary>
[JsonProperty("dns")]
public PermissionGrant? Dns { get; set; }
/// <summary>
/// DNS Records permissions.
/// </summary>
[JsonProperty("dns_records")]
public PermissionGrant? DnsRecords { get; set; }
/// <summary>
/// Load Balancer permissions.
/// </summary>
[JsonProperty("lb")]
public PermissionGrant? LoadBalancer { get; set; }
/// <summary>
/// Logs permissions.
/// </summary>
[JsonProperty("logs")]
public PermissionGrant? Logs { get; set; }
/// <summary>
/// Organization permissions.
/// </summary>
[JsonProperty("organization")]
public PermissionGrant? Organization { get; set; }
/// <summary>
/// SSL permissions.
/// </summary>
[JsonProperty("ssl")]
public PermissionGrant? Ssl { get; set; }
/// <summary>
/// WAF permissions.
/// </summary>
[JsonProperty("waf")]
public PermissionGrant? WebApplicationFirewall { get; set; }
/// <summary>
/// Zone Settings permissions.
/// </summary>
[JsonProperty("zone_settings")]
public PermissionGrant? ZoneSettings { get; set; }
/// <summary>
/// Zones permissions.
/// </summary>
[JsonProperty("zones")]
public PermissionGrant? Zones { get; set; }
}
}

110
Cloudflare/Models/Subscription.cs Normal file
View File

@@ -0,0 +1,110 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// A Cloudflare subscription.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L705">Source</see>
/// </summary>
public class Subscription
{
/// <summary>
/// Subscription identifier tag.
/// </summary>
[JsonProperty("id")]
public string? Id { get; set; }
/// <summary>
/// The monetary unit in which pricing information is displayed.
/// </summary>
[JsonProperty("currency")]
public string? Currency { get; set; }
/// <summary>
/// The end of the current period and also when the next billing is due.
/// </summary>
[JsonProperty("current_period_end")]
public DateTime? CurrentPeriodEnd { get; set; }
/// <summary>
/// When the current billing period started.
/// </summary>
[JsonProperty("current_period_start")]
public DateTime? CurrentPeriodStart { get; set; }
/// <summary>
/// How often the subscription is renewed automatically.
/// </summary>
[JsonProperty("frequency")]
public RenewFrequency? Frequency { get; set; }
/// <summary>
/// The price of the subscription that will be billed, in US dollars.
/// </summary>
[JsonProperty("price")]
public decimal? Price { get; set; }
/// <summary>
/// The rate plan applied to the subscription.
/// </summary>
[JsonProperty("rate_plan")]
public RatePlan? RatePlan { get; set; }
/// <summary>
/// The state that the subscription is in.
/// </summary>
[JsonProperty("state")]
public SubscriptionState? State { get; set; }
}
/// <summary>
/// The state that the subscription is in.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L745">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum SubscriptionState
{
/// <summary>
/// The subscription is in the trial period.
/// </summary>
[EnumMember(Value = "Trial")]
Trial = 1,
/// <summary>
/// The subscription is provisioned.
/// </summary>
[EnumMember(Value = "Provisioned")]
Provisioned = 2,
/// <summary>
/// The subscription is paid.
/// </summary>
[EnumMember(Value = "Paid")]
Paid = 3,
/// <summary>
/// The subscription is awaiting payment.
/// </summary>
[EnumMember(Value = "AwaitingPayment")]
AwaitingPayment = 4,
/// <summary>
/// The subscription is cancelled.
/// </summary>
[EnumMember(Value = "Cancelled")]
Cancelled = 5,
/// <summary>
/// The subscription has failed.
/// </summary>
[EnumMember(Value = "Failed")]
Failed = 6,
/// <summary>
/// The subscription has expired.
/// </summary>
[EnumMember(Value = "Expired")]
Expired = 7
}
}

33
Cloudflare/Models/SubscriptionComponent.cs Normal file
View File

@@ -0,0 +1,33 @@
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// A component value for a subscription.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L751">Source</see>
/// </summary>
public class SubscriptionComponent
{
/// <summary>
/// The default amount assigned.
/// </summary>
[JsonProperty("default")]
public int? Default { get; set; }
/// <summary>
/// The name of the component value.
/// </summary>
[JsonProperty("name")]
public string? Name { get; set; }
/// <summary>
/// The unit price for the component value.
/// </summary>
[JsonProperty("price")]
public decimal? Price { get; set; }
/// <summary>
/// The amount of the component value assigned.
/// </summary>
[JsonProperty("value")]
public int? Value { get; set; }
}
}

14
Cloudflare/Models/OwnerBase.cs → Cloudflare/Models/SubscriptionZone.cs
View File

@@ -1,27 +1,21 @@
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// Base implementation of an owner.
/// A simple zone object. May have null properties if not a zone subscription.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L776">Source</see>
/// </summary>
public class OwnerBase
public class SubscriptionZone
{
/// <summary>
/// Identifier.
/// </summary>
// <= 32 characters
[JsonProperty("id")]
public string? Id { get; set; }
/// <summary>
/// Name of the owner.
/// The domain name.
/// </summary>
[JsonProperty("name")]
public string? Name { get; set; }
/// <summary>
/// The type of owner.
/// </summary>
[JsonProperty("type")]
public string? Type { get; set; }
}
}

123
Cloudflare/Models/Token.cs Normal file
View File

@@ -0,0 +1,123 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// A token.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L788">Source</see>
/// </summary>
public class Token
{
/// <summary>
/// Token identifier tag.
/// </summary>
[JsonProperty("id")]
public string? Id { get; set; }
/// <summary>
/// Token condition.
/// </summary>
[JsonProperty("condition")]
public TokenCondition? Condition { get; set; }
/// <summary>
/// The expiration time on or after which the JWT MUST NOT be accepted for processing.
/// </summary>
[JsonProperty("created_on")]
public DateTime? ExpiresOn { get; set; }
/// <summary>
/// The time on which the token was created.
/// </summary>
public DateTime? IssuedOn { get; set; }
/// <summary>
/// Last time the token was used.
/// </summary>
public DateTime? LastUsedOn { get; set; }
/// <summary>
/// Last time the token was modified.
/// </summary>
public DateTime? ModifiedOn { get; set; }
/// <summary>
/// Token name.
/// </summary>
public string? Name { get; set; }
/// <summary>
/// The time before which the token MUST NOT be accepted for processing.
/// </summary>
public DateTime? NotBefore { get; set; }
/// <summary>
/// List of access policies assigned to the token.
/// </summary>
public IReadOnlyCollection<TokenPolicy>? Policies { get; set; }
/// <summary>
/// Status of the token.
/// </summary>
public TokenStatus? Status { get; set; }
}
/// <summary>
/// Token condition.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L839">Source</see>
/// </summary>
public class TokenCondition
{
/// <summary>
/// Client IP restrictions.
/// </summary>
[JsonProperty("request_ip")]
public TokenConditionRequestIP? RequestIp { get; set; }
}
/// <summary>
/// Client IP restrictions.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L850">Source</see>
/// </summary>
public class TokenConditionRequestIP
{
/// <summary>
/// List of IPv4/IPv6 CIDR addresses.
/// </summary>
[JsonProperty("in")]
public IReadOnlyCollection<string>? Allowed { get; set; }
/// <summary>
/// List of IPv4/IPv6 CIDR addresses.
/// </summary>
[JsonProperty("not_in")]
public IReadOnlyCollection<string>? Denied { get; set; }
}
/// <summary>
/// Status of the token.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L835">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum TokenStatus
{
/// <summary>
/// The token is active.
/// </summary>
[EnumMember(Value = "active")]
Active = 1,
/// <summary>
/// The token is disabled.
/// </summary>
[EnumMember(Value = "disabled")]
Disabled = 2,
/// <summary>
/// The token is expired.
/// </summary>
[EnumMember(Value = "expired")]
Expired = 3
}
}

120
Cloudflare/Models/TokenPolicy.cs Normal file
View File

@@ -0,0 +1,120 @@
using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
namespace AMWD.Net.Api.Cloudflare
{
/// <summary>
/// A token policy.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L874">Source</see>
/// </summary>
public class TokenPolicy
{
/// <summary>
/// Initializes a new instance of the <see cref="TokenPolicy"/> class.
/// </summary>
/// <param name="id">Policy identifier.</param>
/// <param name="effect">Allow or deny operations against the resources.</param>
public TokenPolicy(string id, TokenPolicyEffect effect)
{
Id = id;
Effect = effect;
}
/// <summary>
/// Policy identifier.
/// </summary>
[JsonProperty("id")]
public string Id { get; set; }
/// <summary>
/// Allow or deny operations against the resources.
/// </summary>
[JsonProperty("effect")]
public TokenPolicyEffect Effect { get; set; }
/// <summary>
/// A set of permission groups that are specified to the policy.
/// </summary>
[JsonProperty("permission_groups")]
public IReadOnlyCollection<TokenPolicyPermissionGroup> PermissionGroups { get; set; } = [];
/// <summary>
/// A list of resource names that the policy applies to.
/// </summary>
[JsonProperty("resources")]
public IDictionary<string, string> Resources { get; set; } = new Dictionary<string, string>();
}
/// <summary>
/// Allow or deny operations against the resources.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L883">Source</see>
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
public enum TokenPolicyEffect
{
/// <summary>
/// Allow operations against the resources.
/// </summary>
[EnumMember(Value = "allow")]
Allow = 1,
/// <summary>
/// Deny operations against the resources.
/// </summary>
[EnumMember(Value = "deny")]
Deny = 2
}
/// <summary>
/// A named group of permissions that map to a group of operations against resources.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L901">Source</see>
/// </summary>
public class TokenPolicyPermissionGroup
{
/// <summary>
/// Initializes a new instance of the <see cref="TokenPolicyPermissionGroup"/> class.
/// </summary>
/// <param name="id">Identifier of the permission group.</param>
public TokenPolicyPermissionGroup(string id)
{
Id = id;
}
/// <summary>
/// Identifier of the permission group.
/// </summary>
[JsonProperty("id")]
public string Id { get; set; }
/// <summary>
/// Attributes associated to the permission group.
/// </summary>
[JsonProperty("meta")]
public TokenPolicyPermissionGroupMeta? Meta { get; set; }
/// <summary>
/// Name of the permission group.
/// </summary>
[JsonProperty("name")]
public string? Name { get; set; }
}
/// <summary>
/// Attributes associated to the permission group.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/shared.ts#L922">Source</see>
/// </summary>
public class TokenPolicyPermissionGroupMeta
{
/// <summary>
/// Key.
/// </summary>
[JsonProperty("key")]
public string? Key { get; set; }
/// <summary>
/// Value.
/// </summary>
[JsonProperty("value")]
public string? Value { get; set; }
}
}