/ 
WWW-LogicBoxes-1.11.0
River stage zero No dependents
/ WWW::LogicBoxes::Domain

NAME

WWW::LogicBoxes::Domain - Representation of Registered LogicBoxes Domain

SYNOPSIS

use WWW::LogicBoxes;

my $logic_boxes = WWW::LogicBoxes->new( ... );

my $domain = $logic_boxes->get_domain_by_name( 'test-domain.com' );

print 'ID For domain test-domain.com is ' . $domain->id . "\n";

DESCRIPTION

Represents LogicBoxes domains, containing all related information. For most operations this will be the base object that is used to represent the data.

ATTRIBUTES

id

The order_id of the domain in LogicBoxes's system.

name

The full domain name ( test-domain.com ).

customer_id

The id of the customer who owns this domain in LogicBoxes.

status

Current status of the domain with LogicBoxes. Will be one of the following values:

InActive
Active
Suspended
Pending Delete Restorable
QueuedForDeletion
Deleted
Archived

verification_status

According to ICANN rules, all new gTLD domains that were registered after January 1st, 2014 must be verified. verification_status describes the current state of this verification and will be one of the following values:

Verified
Pending
Suspended

For details on the ICANN policy please see the riveting ICANN Registrar Agreement https://www.icann.org/resources/pages/approved-with-specs-2013-09-17-en.

is_locked

Boolean indicating if the domain is currently locked, preventing transfer.

is_private

Boolean indicating if this domain uses WHOIS Privacy.

created_date

Date this domain registration was created.

expiration_date

Date this domain registration expires.

ns

ArrayRef of Domain Names that are the authorizative nameservers for this domain.

registrant_contact_id

A Contact id for the Registrant.

admin_contact_id

A Contact id for the Admin.

technical_contact_id

A Contact id for the Technical.

billing_contact_id

A Contact id for the Billing. Offers a predicate of has_billing_contact_id.

Almost all TLDs require a billing contact, however for .ca domains it must not be provided.

epp_key

The secret key needed in order to transfer a domain to another registrar.

private_nameserves

ArrayRef of WWW::LogicBoxes::PrivateNameServer objects that contains any created private name servers. Predicate of has_private_nameservers.

irtp_detail

If an IRTP Verification is in process for this domain, this attribute will contain a fully formed WWW::LogicBoxes::IRTPDetail object. If there is no pending IRTP Verification this attribute will not be set. A predicate of has_irtp_detail is provided.

METHODS

These methods are used internally, it's fairly unlikely that consumers will ever call them directly.

construct_from_response

my $logic_boxes = WWW::LogicBoxes->new( ... );

my $response = $logic_boxes->submit({
    method => 'domains__details_by_name',
    params => {
        'domain-name' => 'test-domain.com',
        'options'     => [qw( All )],
    },
});

my $domain = WWW::LogicBoxes::Domain->construct_from_response( $response );

Constructs an instance of $self from a LogicBoxes response.