The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

WWW::eNom::DomainRequest::Transfer - Domain Transfer Request

SYNOPSIS

use WWW::eNom;
use WWW::eNom::Contact;
use WWW::eNom::DomainRequest::Transfer;

my $api     = WWW::eNom->new( ... );
my $contact = WWW::eNom::Contact->new( ... );

# Transfer a Domain to eNom
my $transfer_request = WWW::eNom::DomainRequest::Transfer->new(
    name                  => 'drzigman.com',
    verification_method   => 'Autoverification', # Optional, defaults to Autoverification
    is_private            => 0,                  # Optional, defaults to false
    is_locked             => 1,                  # Optional, defaults to true
    is_auto_renew         => 0,                  # Optional, defaults to false
    epp_key               => '12345',
    use_existing_contacts => 0,                  # Optional, defaults to false (which requires that contacts be specified)
    registrant_contact    => $contact,           # See attribute definition for details about when required
    admin_contact         => $contact,           # See attribute definition for details about when required
    technical_contact     => $contact,           # See attribute definition for details about when required
    billing_contact       => $contact,           # See attribute definition for details about when required
);

# Example showing construct_request, contrived!  Use transfer_domain in real life!
my $response = $api->submit({
    method => 'TP_CreateOrder',
    params => $transfer_request->construct_request
});

WITH

WWW::eNom::Role::ParseDomain

DESCRIPTION

WWW::eNom::DomainRequest::Transfer is a representation of all the data needed in order to complete a domain transfer. It is used when requesting a domain transfer to eNom.

ATTRIBUTES

name

The FQDN to transfer

verification_method

The method of verification to use for approval of the domain transfer. The valid options are:

Autoverification

This is the default, it uses an email sent to the registrant to request transfer approval.

Fax

A manual process that involves sending a fax to the registrant for transfer approval.

NOTE If you use this verification_method you must provide at least a registrant_contact.

is_locked

Boolean that defaults to true. Indicates if the domain should be locked, preventing transfers.

is_private

Boolean that defaults to false. If true, the WPPS Service (what eNom calls Privacy Protection) will automatically be purchased and enabled.

is_auto_renew

Boolean that defaults to false. If true, this domain will be automatically renewed by eNom before it expires.

epp_key

The EPP Key (sometimes called Auth Code or another registrar specific name) that allows this domain to be transferred. This must be provided.

NOTE If the epp_key provided is incorrect, eNom will cancel the transfer order and you'll have to submit a new one.

use_existing_contacts

Boolean indicating if you wish to specify a new set of contacts or have eNom attempt to import the existing contacts as part of the transfer process. Defaults to false.

NOTE A false value means you must also provide all of the contacts ( registrant, admin, technical, and billing ).

registrant_contact

A WWW::eNom::Contact for the Registrant Contact.

This is required if the verification_method is Fax, or if use_existing_contacts is false.

admin_contact

A WWW::eNom::Contact for the Admin Contact.

This is required if use_existing_contacts is false.

technical_contact

A WWW::eNom::Contact for the Technical Contact.

This is required if use_existing_contacts is false.

billing_contact

A WWW::eNom::Contact for the Billing Contact.

This is required if use_existing_contacts is false.

NOTE> eNom actually calls this the AuxBilling> contact since the primary billing contact is the reseller's information.

METHODS

construct_request

my $transfer_request = WWW::eNom::DomainRequest::Transfer->new( ... );

my $response = $api->submit({
    method => 'TP_CreateOrder',
    params => $transfer_request->construct_request
});

Converts $self into a HashRef suitable for the TP_CreateOrder (transfer) of a Domain.