Result Model Reference¶
Result models represent the response of api calls. RequestResult
is the base model
for result models, it provides some common fields shared by all result models.
-
class
namecom.result_models.
RequestResult
(resp)¶ Base class for Response class.
-
resp
¶ http response from requests.Response
-
status_code
¶ http status code
Type: int
-
headers
¶ http response headers from requests.Response
Type: MutableMapping)
-
-
class
namecom.result_models.
ListRecordsResult
(resp)¶ Response class for ListRecords method.
-
nextPage
¶ NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
Type: int
-
lastPage
¶ LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
Type: int
-
-
class
namecom.result_models.
GetRecordResult
(resp)¶ Response class for GetRecord method.
-
class
namecom.result_models.
CreateRecordResult
(resp)¶ Response class for CreateRecord method.
-
class
namecom.result_models.
UpdateRecordResult
(resp)¶ Response class for UpdateRecord method.
-
class
namecom.result_models.
DeleteRecordResult
(resp)¶ Response class for DeleteRecord method.
-
class
namecom.result_models.
ListDnssecsResult
(resp)¶ Response class for ListDnssecs method.
-
nextPage
¶ NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
Type: int
-
lastPage
¶ LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
Type: int
-
-
class
namecom.result_models.
GetDnssecResult
(resp)¶ Response class for GetDnssec method.
-
class
namecom.result_models.
CreateDnssecResult
(resp)¶ Response class for CreateDnssec method.
-
class
namecom.result_models.
DeleteDnssecResult
(resp)¶ Response class for DeleteDnssec method.
-
class
namecom.result_models.
ListDomainsResult
(resp)¶ Response class for ListDomains method.
-
nextPage
¶ NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
Type: int
-
lastPage
¶ LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
Type: int
-
-
class
namecom.result_models.
GetDomainResult
(resp)¶ Response class for GetDomain method.
-
class
namecom.result_models.
SearchResult
(resp)¶ Response class for Search method.
-
results
¶ instance of DomainSearchResult
Type: [] DomainSearchResult
-
-
class
namecom.result_models.
CreateDomainResult
(resp)¶ Response class for CreateDomain method.
-
order
¶ Order is an identifier for this purchase.
Type: int
-
totalPaid
¶ TotalPaid is the total amount paid
Type: float
-
-
class
namecom.result_models.
EnableAutorenewResult
(resp)¶ Response class for EnableAutorenew method.
-
class
namecom.result_models.
DisableAutorenewResult
(resp)¶ Response class for DisableAutorenew method.
-
class
namecom.result_models.
SetNameserversResult
(resp)¶ Response class for SetNameservers method.
-
class
namecom.result_models.
SetContactsResult
(resp)¶ Response class for SetContacts method.
-
class
namecom.result_models.
RenewDomainResult
(resp)¶ Response class for RenewDomain method.
-
order
¶ Order is an identifier for this purchase.
Type: int
-
totalPaid
¶ TotalPaid is the total amount paid
Type: float
-
-
class
namecom.result_models.
PurchasePrivacyResult
(resp)¶ Response class for PurchasePrivacy method.
-
order
¶ Order is an identifier for this purchase.
Type: int
-
totalPaid
¶ TotalPaid is the total amount paid
Type: float
-
-
class
namecom.result_models.
GetAuthCodeForDomainResult
(resp)¶ Response class for GetAuthCodeForDomain method.
-
authCode
¶ AuthCode is the authorization code needed to transfer a domain to another registrar
Type: str
-
-
class
namecom.result_models.
LockDomainResult
(resp)¶ Response class for LockDomain method.
-
class
namecom.result_models.
UnlockDomainResult
(resp)¶ Response class for UnlockDomain method.
-
class
namecom.result_models.
CheckAvailabilityResult
(resp)¶ Response class for CheckAvailability method.
-
results
¶ instance of DomainSearchResult
Type: [] DomainSearchResult
-
-
class
namecom.result_models.
SearchStreamResult
(resp)¶ Response class for SearchStream method.
-
results
¶ a generator yielding of DomainSearchResult
Type: [] DomainSearchResult
-
-
class
namecom.result_models.
ListEmailForwardingsResult
(resp)¶ Response class for ListEmailForwardings method.
-
email_forwardings
¶ list of EmailForwarding
Type: [] EmailForwarding
-
nextPage
¶ NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
Type: int
-
lastPage
¶ LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
Type: int
-
-
class
namecom.result_models.
GetEmailForwardingResult
(resp)¶ Response class for GetEmailForwarding method.
-
email_forwarding
¶ instance of EmailForwarding
Type: EmailForwarding
-
-
class
namecom.result_models.
CreateEmailForwardingResult
(resp)¶ Response class for CreateEmailForwarding method.
-
email_forwarding
¶ instance of EmailForwarding
Type: EmailForwarding
-
-
class
namecom.result_models.
UpdateEmailForwardingResult
(resp)¶ Response class for UpdateEmailForwarding method.
-
email_forwarding
¶ instance of EmailForwarding
Type: EmailForwarding
-
-
class
namecom.result_models.
DeleteEmailForwardingResult
(resp)¶ Response class for DeleteEmailForwarding method.
-
class
namecom.result_models.
ListTransfersResult
(resp)¶ Response class for ListTransfers method.
-
nextPage
¶ NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
Type: int
-
lastPage
¶ LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
Type: int
-
-
class
namecom.result_models.
GetTransferResult
(resp)¶ Response class for GetTransfer method.
-
class
namecom.result_models.
CreateTransferResult
(resp)¶ Response class for CreateTransfer method.
-
order
¶ Order is an identifier for this purchase.
Type: int
-
totalPaid
¶ TotalPaid is the total amount paid
Type: float
-
-
class
namecom.result_models.
CancelTransferResult
(resp)¶ Response class for CancelTransfer method.
-
class
namecom.result_models.
ListURLForwardingsResult
(resp)¶ Response class for ListURLForwardins method.
-
url_forwardings
¶ list of URLForwarding
Type: [] URLForwarding
-
nextPage
¶ NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
Type: int
-
lastPage
¶ LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
Type: int
-
-
class
namecom.result_models.
GetURLForwardingResult
(resp)¶ Response class for GetURLForwarding method.
-
url_forwarding
¶ instance of URLForwarding
Type: URLForwarding
-
-
class
namecom.result_models.
CreateURLForwardingResult
(resp)¶ Response class for CreateURLForwarding method.
-
url_forwarding
¶ instance of URLForwarding
Type: URLForwarding
-
-
class
namecom.result_models.
UpdateURLForwardingResult
(resp)¶ Response class for UpdateURLForwarding method.
-
url_forwarding
¶ instance of URLForwarding
Type: URLForwarding
-
-
class
namecom.result_models.
DeleteURLForwardingResult
(resp)¶ Response class for DeleteURLForwarding method.
-
class
namecom.result_models.
ListVanityNameserversResult
(resp)¶ Response class for ListVanityNameservers method.
-
vanityNameservers
¶ list of VanityNameserver
Type: [] VanityNameserver
-
nextPage
¶ NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
Type: int
-
lastPage
¶ LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
Type: int
-
-
class
namecom.result_models.
GetVanityNameserverResult
(resp)¶ Response class for GetVanityNameserver method.
-
vanityNameserver
¶ instance of VanityNameserver
Type: VanityNameserver
-
-
class
namecom.result_models.
CreateVanityNameserverResult
(resp)¶ Response class for CreateVanityNameserver method.
-
vanityNameserver
¶ instance of VanityNameserver
Type: VanityNameserver
-
-
class
namecom.result_models.
UpdateVanityNameserverResult
(resp)¶ Response class for UpdateVanityNameserver method.
-
vanityNameserver
¶ instance of VanityNameserver
Type: VanityNameserver
-
-
class
namecom.result_models.
DeleteVanityNameserverResult
(resp)¶ Response class for DeleteVanityNameserver method.