Registration

import type { Registration } from "https://googleapis.deno.dev/v1/domains:v1.ts";

The Registration resource facilitates managing and configuring domain name registrations. There are several ways to create a new Registration resource: To create a new Registration resource, find a suitable domain name by calling the SearchDomains method with a query to see available domain name options. After choosing a name, call RetrieveRegisterParameters to ensure availability and obtain information like pricing, which is needed to build a call to RegisterDomain. Another way to create a new Registration is to transfer an existing domain from another registrar (Deprecated: For more information, see Cloud Domains feature deprecation). First, go to the current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call RetrieveTransferParameters to confirm that the domain is unlocked and to get values needed to build a call to TransferDomain. Finally, you can create a new Registration by importing an existing domain managed with Google Domains (Deprecated: For more information, see Cloud Domains feature deprecation). First, call RetrieveImportableDomains to list domains to which the calling user has sufficient access. Then call ImportDomain on any domain names you want to use with Cloud Domains.

interface Registration {

contactSettings?: ContactSettings;

readonly createTime?: Date;

dnsSettings?: DnsSettings;

domainName?: string;

readonly expireTime?: Date;

readonly issues?:

| "ISSUE_UNSPECIFIED"

| "CONTACT_SUPPORT"

| "UNVERIFIED_EMAIL"

| "PROBLEM_WITH_BILLING"[];

labels?: {

[key: string]: string;

};

managementSettings?: ManagementSettings;

readonly name?: string;

readonly pendingContactSettings?: ContactSettings;

readonly registerFailureReason?:

| "REGISTER_FAILURE_REASON_UNSPECIFIED"

| "REGISTER_FAILURE_REASON_UNKNOWN"

| "DOMAIN_NOT_AVAILABLE"

| "INVALID_CONTACTS";

readonly state?:

| "STATE_UNSPECIFIED"

| "REGISTRATION_PENDING"

| "REGISTRATION_FAILED"

| "TRANSFER_PENDING"

| "TRANSFER_FAILED"

| "IMPORT_PENDING"

| "ACTIVE"

| "SUSPENDED"

| "EXPORTED"

| "EXPIRED";

readonly supportedPrivacy?:

| "CONTACT_PRIVACY_UNSPECIFIED"

| "PUBLIC_CONTACT_DATA"

| "PRIVATE_CONTACT_DATA"

| "REDACTED_CONTACT_DATA"[];

readonly transferFailureReason?:

| "TRANSFER_FAILURE_REASON_UNSPECIFIED"

| "TRANSFER_FAILURE_REASON_UNKNOWN"

| "EMAIL_CONFIRMATION_FAILURE"

| "DOMAIN_NOT_REGISTERED"

| "DOMAIN_HAS_TRANSFER_LOCK"

| "INVALID_AUTHORIZATION_CODE"

| "TRANSFER_CANCELLED"

| "TRANSFER_REJECTED"

| "INVALID_REGISTRANT_EMAIL_ADDRESS"

| "DOMAIN_NOT_ELIGIBLE_FOR_TRANSFER"

| "TRANSFER_ALREADY_PENDING";

}

§Properties

contactSettings?: ContactSettings

[src]

Required. Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.

readonly createTime?: Date

[src]

Output only. The creation timestamp of the Registration resource.

dnsSettings?: DnsSettings

[src]

Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.

domainName?: string

[src]

Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.

readonly expireTime?: Date

[src]

Output only. The expiration timestamp of the Registration.

readonly issues?: "ISSUE_UNSPECIFIED" | "CONTACT_SUPPORT" | "UNVERIFIED_EMAIL" | "PROBLEM_WITH_BILLING"[]

[src]

Output only. The set of issues with the Registration that require attention.

labels?: {

[key: string]: string;

}

[src]

Set of labels associated with the Registration.

managementSettings?: ManagementSettings

[src]

Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.

readonly name?: string

[src]

Output only. Name of the Registration resource, in the format projects/*\/locations/*\/registrations/.

readonly pendingContactSettings?: ContactSettings

[src]

Output only. Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.

readonly registerFailureReason?: "REGISTER_FAILURE_REASON_UNSPECIFIED" | "REGISTER_FAILURE_REASON_UNKNOWN" | "DOMAIN_NOT_AVAILABLE" | "INVALID_CONTACTS"

[src]

Output only. The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.

[src]

Output only. The state of the Registration

readonly supportedPrivacy?: "CONTACT_PRIVACY_UNSPECIFIED" | "PUBLIC_CONTACT_DATA" | "PRIVATE_CONTACT_DATA" | "REDACTED_CONTACT_DATA"[]

[src]

Output only. Set of options for the contact_settings.privacy field that this Registration supports.

[src]

Output only. Deprecated: For more information, see Cloud Domains feature deprecation. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.