icann-rdap-common 0.0.29

//! Things representing registrations from the IANA RDAP registries.

use {
    super::Extension,
    serde::{Deserialize, Serialize},
    strum_macros::{AsRefStr, Display, EnumString},
};

/// Extension Identifiers
///
/// This enum uses [EnumString] and [AsRefStr] to allow serialization
/// and deserialization of the variant to the matching name in the IANA registry.
///
/// To get the variant from a string:
///
/// ```rust
/// use std::str::FromStr;
/// use icann_rdap_common::prelude::*;
///
/// let cidr0 = ExtensionId::from_str("cidr0").unwrap();
/// assert_eq!(cidr0, ExtensionId::Cidr0);
/// println!("{}", cidr0.to_string());
/// ```
///
/// To get the enum variants as a string:
///
/// ```rust
/// use icann_rdap_common::prelude::*;
///
/// let s = ExtensionId::Cidr0.to_string();
/// ```
///
/// To get the enum variants as a &str:
///
/// ```rust
/// use icann_rdap_common::prelude::*;
///
/// let s = ExtensionId::Cidr0.as_ref();
/// ```
#[derive(
    Serialize, Deserialize, EnumString, Display, Debug, PartialEq, Eq, AsRefStr, Hash, Clone,
)]
pub enum ExtensionId {
    #[strum(serialize = "rdap_level_0")]
    RdapLevel0,
    #[strum(serialize = "arin_originas0")]
    ArinOriginAs0,
    #[strum(serialize = "autnums")]
    Autnums,
    #[strum(serialize = "autnumSearchResults")]
    AutnumSearchResults,
    #[strum(serialize = "artRecord")]
    ArtRecord,
    #[strum(serialize = "cidr0")]
    Cidr0,
    #[strum(serialize = "exts")]
    Exts,
    #[strum(serialize = "farv1")]
    Farv1,
    #[strum(serialize = "fred")]
    Fred,
    #[strum(serialize = "icann_rdap_response_profile_0")]
    IcannRdapResponseProfile0,
    #[strum(serialize = "icann_rdap_response_profile_1")]
    IcannRdapResponseProfile1,
    #[strum(serialize = "icann_rdap_technical_implementation_guide_0")]
    IcannRdapTechnicalImplementationGuide0,
    #[strum(serialize = "icann_rdap_technical_implementation_guide_1")]
    IcannRdapTechnicalImplementationGuide1,
    #[strum(serialize = "ips")]
    Ips,
    #[strum(serialize = "ipSearchResults")]
    IpSearchResults,
    #[strum(serialize = "jscontact")]
    JsContact,
    #[strum(serialize = "nro_rdap_profile_0")]
    NroRdapProfile0,
    #[strum(serialize = "nro_rdap_profile_asn_flat_0")]
    NroRdapProfileAsnFlat0,
    #[strum(serialize = "nro_rdap_profile_asn_hierarchical_0")]
    NroRdapProfileAsnHierarchical0,
    #[strum(serialize = "paging")]
    Paging,
    #[strum(serialize = "platformNS")]
    PlatformNs,
    #[strum(serialize = "rdap_objectTag")]
    RdapObjectTag,
    #[strum(serialize = "redacted")]
    Redacted,
    #[strum(serialize = "redirect_with_content")]
    RedirectWithContent,
    #[strum(serialize = "regType")]
    RegType,
    #[strum(serialize = "reverse_search")]
    ReverseSearch,
    #[strum(serialize = "rirSearch1")]
    RirSearch1,
    #[strum(serialize = "simpleRedaction")]
    SimpleRedaction,
    #[strum(serialize = "sorting")]
    Sorting,
    #[strum(serialize = "subsetting")]
    Subsetting,
    #[strum(serialize = "ttl0")]
    Ttl0,
}

impl ExtensionId {
    /// Gets an [Extension] from an Extension ID.
    pub fn to_extension(&self) -> Extension {
        Extension(self.to_string())
    }
}

/// IANA registered roles for entities.
#[derive(PartialEq, Eq, Debug, EnumString, Display)]
#[strum(serialize_all = "lowercase")]
pub enum EntityRole {
    Registrant,
    Technical,
    Administrative,
    Abuse,
    Billing,
    Registrar,
    Reseller,
    Sponsor,
    Proxy,
    Notifications,
    Noc,
}

/// Notice/Remark Values.
#[derive(PartialEq, Eq, Debug, EnumString, Display)]
pub enum NrType {
    #[strum(serialize = "result set truncated due to authorization")]
    ResultSetTruncatedDueToAuthorization,
    #[strum(serialize = "result set truncated due to excessive load")]
    ResultSetTruncatedDueToExcessiveLoad,
    #[strum(serialize = "result set truncated due to unexplainable reasons")]
    ResultSetTruncatedDueToUnexplainableReasons,
    #[strum(serialize = "object truncated due to authorization")]
    ObjectTruncatedDueToAuthorization,
    #[strum(serialize = "object truncated due to excessive load")]
    ObjectTruncatedDueToExcessiveLoad,
    #[strum(serialize = "object truncated due to unexplainable reasons")]
    ObjectTruncatedDueToUnexplainableReasons,
    #[strum(serialize = "object redacted due to authorization")]
    ObjectRedactedDueToAuthorization,
}

/// Status Values
#[derive(PartialEq, Eq, Debug, EnumString, Display)]
pub enum StatusValue {
    #[strum(serialize = "validated")]
    Validated,
    #[strum(serialize = "renew prohibited")]
    RenewProhibited,
    #[strum(serialize = "update prohibited")]
    UpdatedProhibited,
    #[strum(serialize = "transfer prohibited")]
    TransferProhibited,
    #[strum(serialize = "delete prohibited")]
    DeleteProhibited,
    #[strum(serialize = "proxy")]
    Proxy,
    #[strum(serialize = "private")]
    Private,
    #[strum(serialize = "removed")]
    Removed,
    #[strum(serialize = "obscured")]
    Obscured,
    #[strum(serialize = "associated")]
    Associated,
    #[strum(serialize = "active")]
    Active,
    #[strum(serialize = "inactive")]
    Inactive,
    #[strum(serialize = "locked")]
    Locked,
    #[strum(serialize = "pending create")]
    PendingCreate,
    #[strum(serialize = "pending renew")]
    PendingRenew,
    #[strum(serialize = "pending transfer")]
    PendingTransfer,
    #[strum(serialize = "pending update")]
    PendingUpdate,
    #[strum(serialize = "pending delete")]
    PendingDelete,
    #[strum(serialize = "add period")]
    AddPeriod,
    #[strum(serialize = "auto renew period")]
    AutoRenewPeriod,
    #[strum(serialize = "client delete prohibited")]
    ClientDeleteProhibited,
    #[strum(serialize = "client hold")]
    ClientHold,
    #[strum(serialize = "client renew prohibited")]
    ClientRenewProhibited,
    #[strum(serialize = "client transfer prohibited")]
    ClientTransferProhibited,
    #[strum(serialize = "client update prohibited")]
    ClientUpdateProhibited,
    #[strum(serialize = "pending restore")]
    PendingRestore,
    #[strum(serialize = "redemption period")]
    RedemptionPeriod,
    #[strum(serialize = "renew period")]
    RenewPeriod,
    #[strum(serialize = "server delete prohibited")]
    ServerDeleteProhibited,
    #[strum(serialize = "server renew prohibited")]
    ServerRenewProhibited,
    #[strum(serialize = "server transfer prohibited")]
    ServerTransferProhibited,
    #[strum(serialize = "server update prohibited")]
    ServerUpdateProhibited,
    #[strum(serialize = "server hold")]
    ServerHold,
    #[strum(serialize = "transfer hold")]
    TransferPeriod,
    #[strum(serialize = "administrative")]
    Administrative,
    #[strum(serialize = "reserved")]
    Reserved,
}

/// Event Actions
#[derive(PartialEq, Eq, Debug, EnumString, Display)]
pub enum EventActionValue {
    #[strum(serialize = "registration")]
    Registration,
    #[strum(serialize = "reregistration")]
    Reregistration,
    #[strum(serialize = "last changed")]
    LastChanged,
    #[strum(serialize = "expiration")]
    Expiration,
    #[strum(serialize = "deletion")]
    Deletion,
    #[strum(serialize = "reinstantiation")]
    Reinstantiation,
    #[strum(serialize = "transfer")]
    Transfer,
    #[strum(serialize = "locked")]
    Locked,
    #[strum(serialize = "unlocked")]
    Unlocked,
    #[strum(serialize = "last update of RDAP database")]
    LastUpdateOfRDAPDatabase,
    #[strum(serialize = "registrar expiration")]
    RegistrarExpiration,
    #[strum(serialize = "enum validation expiration")]
    EnumValidationExpiration,
}