@itentialopensource/adapter-godaddy 0.2.0

package/CALLS.md

@@ -0,0 +1,748 @@
+## Using this Adapter
+
+The `adapter.js` file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls.
+
+
+### Generic Adapter Calls
+
+These are adapter methods that IAP or you might use. There are some other methods not shown here that might be used for internal adapter functionality.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">connect()</td>
+    <td style="padding:15px">This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">healthCheck(callback)</td>
+    <td style="padding:15px">This call ensures that the adapter can communicate with Adapter for GoDaddy. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">refreshProperties(properties)</td>
+    <td style="padding:15px">This call provides the adapter the ability to accept property changes without having to restart the adapter.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">encryptProperty(property, technique, callback)</td>
+    <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for GoDaddy.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)</td>
+    <td style="padding:15px">This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
+    <td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapUnsuspendAdapter(callback)</td>
+    <td style="padding:15px">This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapGetAdapterQueue(callback)</td>
+    <td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
+    <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
+    <td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
+    <td style="padding:15px">This call will return the results of a healthcheck.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRunAdapterConnectivity(callback)</td>
+    <td style="padding:15px">This call will return the results of a connectivity check.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRunAdapterBasicGet(callback)</td>
+    <td style="padding:15px">This call will return the results of running basic get API calls.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapMoveAdapterEntitiesToDB(callback)</td>
+    <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapDeactivateTasks(tasks, callback)</td>
+    <td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapActivateTasks(tasks, callback)</td>
+    <td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td>
+    <td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
+    <td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
+    <td style="padding:15px">This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRunAdapterLint(callback)</td>
+    <td style="padding:15px">Runs lint on the addapter and provides the information back.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRunAdapterTests(callback)</td>
+    <td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapGetAdapterInventory(callback)</td>
+    <td style="padding:15px">This call provides some inventory related information about the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+</table>
+<br>
+  
+### Adapter Cache Calls
+
+These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td>
+    <td style="padding:15px">This call populates the adapter cache.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td>
+    <td style="padding:15px">This call retrieves the specific items from the adapter cache.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+</table>
+<br>
+  
+### Adapter Broker Calls
+
+These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">hasEntities(entityType, entityList, callback)</td>
+    <td style="padding:15px">This call is utilized by the IAP Device Broker to determine if the adapter has a specific entity and item of the entity.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDevice(deviceName, callback)</td>
+    <td style="padding:15px">This call returns the details of the requested device.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDevicesFiltered(options, callback)</td>
+    <td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">isAlive(deviceName, callback)</td>
+    <td style="padding:15px">This call returns whether the device status is active</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getConfig(deviceName, format, callback)</td>
+    <td style="padding:15px">This call returns the configuration for the selected device.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapGetDeviceCount(callback)</td>
+    <td style="padding:15px">This call returns the count of devices.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+</table>
+<br>
+
+
+### Specific Adapter Calls
+
+Specific adapter calls are built based on the API of the Godaddy. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteListings(domains, callback)</td>
+    <td style="padding:15px">Remove listings from GoDaddy Auction</td>
+    <td style="padding:15px">{base_path}/{version}/v1/aftermarket/listings?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">addExpiryListings(expiryListings, callback)</td>
+    <td style="padding:15px">Add expiry listings into GoDaddy Auction</td>
+    <td style="padding:15px">{base_path}/{version}/v1/aftermarket/listings/expiry?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getTickets(type = 'A_RECORD', closed, sourceDomainOrIp, target, createdStart, createdEnd, limit, offset, callback)</td>
+    <td style="padding:15px">List all abuse tickets ids that match user provided filters</td>
+    <td style="padding:15px">{base_path}/{version}/v1/abuse/tickets?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createTicket(body, callback)</td>
+    <td style="padding:15px">Create a new abuse ticket</td>
+    <td style="padding:15px">{base_path}/{version}/v1/abuse/tickets?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getTicketInfo(ticketId, callback)</td>
+    <td style="padding:15px">Return the abuse ticket data for a given ticket id</td>
+    <td style="padding:15px">{base_path}/{version}/v1/abuse/tickets/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAgreements(keys, callback)</td>
+    <td style="padding:15px">Retrieve Legal Agreements for provided agreements keys</td>
+    <td style="padding:15px">{base_path}/{version}/v1/agreements?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateCreate(certificateCreate, callback)</td>
+    <td style="padding:15px">Create a pending order for certificate</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateValidate(certificateCreate, callback)</td>
+    <td style="padding:15px">Validate a pending order for certificate</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/validate?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateGet(certificateId, callback)</td>
+    <td style="padding:15px">Retrieve certificate details</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateActionRetrieve(certificateId, callback)</td>
+    <td style="padding:15px">Retrieve all certificate actions</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/actions?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateResendEmail(certificateId, emailId, callback)</td>
+    <td style="padding:15px">Resend an email</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/email/{pathv2}/resend?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateAlternateEmailAddress(certificateId, emailAddress, callback)</td>
+    <td style="padding:15px">Add alternate email address</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/email/resend/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateResendEmailAddress(certificateId, emailId, emailAddress, callback)</td>
+    <td style="padding:15px">Resend email to email address</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/email/{pathv2}/resend/{pathv3}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateEmailHistory(certificateId, callback)</td>
+    <td style="padding:15px">Retrieve email history</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/email/history?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateCallbackDelete(certificateId, callback)</td>
+    <td style="padding:15px">Unregister system callback</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/callback?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateCallbackGet(certificateId, callback)</td>
+    <td style="padding:15px">Retrieve system stateful action callback url</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/callback?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateCallbackReplace(certificateId, callbackUrl, callback)</td>
+    <td style="padding:15px">Register of certificate action callback</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/callback?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateCancel(certificateId, callback)</td>
+    <td style="padding:15px">Cancel a pending certificate</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/cancel?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateDownload(certificateId, callback)</td>
+    <td style="padding:15px">Download certificate</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/download?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateReissue(certificateId, reissueCreate, callback)</td>
+    <td style="padding:15px">Reissue active certificate</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/reissue?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateRenew(certificateId, renewCreate, callback)</td>
+    <td style="padding:15px">Renew active certificate</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/renew?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateRevoke(certificateId, certificateRevoke, callback)</td>
+    <td style="padding:15px">Revoke active certificate</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/revoke?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateSitesealGet(certificateId, theme = 'DARK', locale, callback)</td>
+    <td style="padding:15px">Get Site seal</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/siteSeal?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateVerifydomaincontrol(certificateId, callback)</td>
+    <td style="padding:15px">Check Domain Control</td>
+    <td style="padding:15px">{base_path}/{version}/v1/certificates/{pathv1}/verifyDomainControl?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateGetEntitlement(entitlementId, latest, callback)</td>
+    <td style="padding:15px">Search for certificate details by entitlement</td>
+    <td style="padding:15px">{base_path}/{version}/v2/certificates?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">certificateDownloadEntitlement(entitlementId, callback)</td>
+    <td style="padding:15px">Download certificate by entitlement</td>
+    <td style="padding:15px">{base_path}/{version}/v2/certificates/download?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCustomerCertificatesByCustomerId(customerId, offset, limit, callback)</td>
+    <td style="padding:15px">Retrieve customer's certificates</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/certificates?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCertificateDetailByCertIdentifier(customerId, certificateId, callback)</td>
+    <td style="padding:15px">Retrieve individual certificate details</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/certificates/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDomainInformationByCertificateId(customerId, certificateId, callback)</td>
+    <td style="padding:15px">Retrieve domain verification status</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/certificates/{pathv2}/domainVerifications?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDomainDetailsByDomain(customerId, certificateId, domain, callback)</td>
+    <td style="padding:15px">Retrieve detailed information for supplied domain</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/certificates/{pathv2}/domainVerifications/{pathv3}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAcmeExternalAccountBinding(customerId, callback)</td>
+    <td style="padding:15px">Retrieves the external account binding for the specified customer</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/certificates/acme/externalAccountBinding?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCountries(marketId, regionTypeId, regionName, sort = 'key', order = 'ascending', callback)</td>
+    <td style="padding:15px">Retrieves summary country information for the provided marketId and filters</td>
+    <td style="padding:15px">{base_path}/{version}/v1/countries?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCountry(countryKey, marketId, sort = 'key', order = 'ascending', callback)</td>
+    <td style="padding:15px">Retrieves country and summary state information for provided countryKey</td>
+    <td style="padding:15px">{base_path}/{version}/v1/countries/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">listDomains(statuses, statusGroups, limit, marker, includes, modifiedDate, callback)</td>
+    <td style="padding:15px">Retrieve a list of Domains for the specified Shopper</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAgreement(tlds, privacy, forTransfer, callback)</td>
+    <td style="padding:15px">Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/agreements?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">available(domain, checkType = 'FAST', forTransfer, callback)</td>
+    <td style="padding:15px">Determine whether or not the specified domain is available for purchase</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/available?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">availableBulk(domains, checkType = 'FAST', callback)</td>
+    <td style="padding:15px">Determine whether or not the specified domains are available for purchase</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/available?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">contactsValidate(marketId, body, callback)</td>
+    <td style="padding:15px">Validate the request body using the Domain Contact Validation Schema for specified domains.</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/contacts/validate?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">purchase(body, callback)</td>
+    <td style="padding:15px">Purchase and register the specified Domain</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/purchase?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">schema(tld, callback)</td>
+    <td style="padding:15px">Retrieve the schema to be submitted when registering a Domain for the specified TLD</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/purchase/schema/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">validate(body, callback)</td>
+    <td style="padding:15px">Validate the request body using the Domain Purchase Schema for the specified TLD</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/purchase/validate?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">suggest(query, country = 'AC', city, sources, tlds, lengthMax, lengthMin, limit, waitMs, callback)</td>
+    <td style="padding:15px">Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/suggest?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">tlds(callback)</td>
+    <td style="padding:15px">Retrieves a list of TLDs supported and enabled for sale</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/tlds?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">cancel(domain, callback)</td>
+    <td style="padding:15px">Cancel a purchased domain</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDomain(domain, callback)</td>
+    <td style="padding:15px">Retrieve details for the specified Domain</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">update(domain, body, callback)</td>
+    <td style="padding:15px">Update details for the specified Domain</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateContacts(domain, contacts, callback)</td>
+    <td style="padding:15px">Update domain</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}/contacts?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">cancelPrivacy(domain, callback)</td>
+    <td style="padding:15px">Submit a privacy cancellation request for the given domain</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}/privacy?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">purchasePrivacy(domain, body, callback)</td>
+    <td style="padding:15px">Purchase privacy for a specified domain</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}/privacy/purchase?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">recordAdd(domain, records, callback)</td>
+    <td style="padding:15px">Add the specified DNS Records to the specified Domain</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}/records?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">recordReplace(domain, records, callback)</td>
+    <td style="padding:15px">Replace all DNS Records for the specified Domain</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}/records?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">recordGet(domain, type = 'A', name, offset, limit, callback)</td>
+    <td style="padding:15px">Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}/records/{pathv2}/{pathv3}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">recordReplaceTypeName(domain, type = 'A', name, records, callback)</td>
+    <td style="padding:15px">Replace all DNS Records for the specified Domain with the specified Type and Name</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}/records/{pathv2}/{pathv3}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">recordDeleteTypeName(domain, type = 'A', name, callback)</td>
+    <td style="padding:15px">Delete all DNS Records for the specified Domain with the specified Type and Name</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}/records/{pathv2}/{pathv3}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">recordReplaceType(domain, type = 'A', records, callback)</td>
+    <td style="padding:15px">Replace all DNS Records for the specified Domain with the specified Type</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}/records/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">renew(domain, body, callback)</td>
+    <td style="padding:15px">Renew the specified Domain</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}/renew?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">transferIn(domain, body, callback)</td>
+    <td style="padding:15px">Purchase and start or restart transfer process</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}/transfer?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">verifyEmail(domain, callback)</td>
+    <td style="padding:15px">Re-send Contact E-mail Verification for specified Domain</td>
+    <td style="padding:15px">{base_path}/{version}/v1/domains/{pathv1}/verifyRegistrantEmail?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getV2CustomersCustomerIdDomainsDomain(customerId, domain, includes, callback)</td>
+    <td style="padding:15px">Retrieve details for the specified Domain</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postV2CustomersCustomerIdDomainsDomainRedeem(customerId, domain, body, callback)</td>
+    <td style="padding:15px">Purchase a restore for the given domain to bring it out of redemption</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/{pathv2}/redeem?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postV2CustomersCustomerIdDomainsDomainTransferOut(customerId, domain, registrar, callback)</td>
+    <td style="padding:15px">Initiate transfer out to another registrar for a .uk domain.</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/{pathv2}/transferOut?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">domainsForwardsDelete(customerId, fqdn, callback)</td>
+    <td style="padding:15px">Submit a forwarding cancellation request for the given fqdn</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/forwards/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">domainsForwardsGet(customerId, fqdn, includeSubs, callback)</td>
+    <td style="padding:15px">Retrieve the forwarding information for the given fqdn</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/forwards/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">domainsForwardsPut(customerId, fqdn, body, callback)</td>
+    <td style="padding:15px">Modify the forwarding information for the given fqdn</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/forwards/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">domainsForwardsPost(customerId, fqdn, body, callback)</td>
+    <td style="padding:15px">Create a new forwarding configuration for the given FQDN</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/forwards/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getV2DomainsMaintenances(status = 'ACTIVE', modifiedAtAfter, startsAtAfter, limit, callback)</td>
+    <td style="padding:15px">Retrieve a list of upcoming system Maintenances</td>
+    <td style="padding:15px">{base_path}/{version}/v2/domains/maintenances?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getV2DomainsMaintenancesMaintenanceId(maintenanceId, callback)</td>
+    <td style="padding:15px">Retrieve the details for an upcoming system Maintenances</td>
+    <td style="padding:15px">{base_path}/{version}/v2/domains/maintenances/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getV2CustomersCustomerIdDomainsDomainActions(customerId, domain, callback)</td>
+    <td style="padding:15px">Retrieves a list of the most recent actions for the specified domain</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/{pathv2}/actions?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteV2CustomersCustomerIdDomainsDomainActionsType(customerId, domain, type = 'AUTH_CODE_PURCHASE', callback)</td>
+    <td style="padding:15px">Cancel the most recent user action for the specified domain</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/{pathv2}/actions/{pathv3}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getV2CustomersCustomerIdDomainsDomainActionsType(customerId, domain, type = 'AUTH_CODE_PURCHASE', callback)</td>
+    <td style="padding:15px">Retrieves the most recent action for the specified domain</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/{pathv2}/actions/{pathv3}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getV2CustomersCustomerIdDomainsNotifications(customerId, callback)</td>
+    <td style="padding:15px">Retrieve the next domain notification</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/notifications?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getV2CustomersCustomerIdDomainsNotificationsOptIn(customerId, callback)</td>
+    <td style="padding:15px">Retrieve a list of notification types that are opted in</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/notifications/optIn?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">putV2CustomersCustomerIdDomainsNotificationsOptIn(customerId, types, callback)</td>
+    <td style="padding:15px">Opt in to recieve notifications for the submitted notification types</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/notifications/optIn?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getV2CustomersCustomerIdDomainsNotificationsSchemasType(customerId, type = 'AUTO_RENEWAL', callback)</td>
+    <td style="padding:15px">Retrieve the schema for the notification data for the specified notification type</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/notifications/schemas/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postV2CustomersCustomerIdDomainsNotificationsNotificationIdAcknowledge(customerId, notificationId, callback)</td>
+    <td style="padding:15px">Acknowledge a domain notification</td>
+    <td style="padding:15px">{base_path}/{version}/v2/customers/{pathv1}/domains/notifications/{pathv2}/acknowledge?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">listOrders(periodStart, periodEnd, domain, productGroupId, paymentProfileId, parentOrderId, offset, limit, sort = 'createdAt', callback)</td>
+    <td style="padding:15px">Retrieve a list of orders for the authenticated shopper. Only one filter may be used at a time</td>
+    <td style="padding:15px">{base_path}/{version}/v1/orders?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">get(orderId, callback)</td>
+    <td style="padding:15px">Retrieve details for specified order</td>
+    <td style="padding:15px">{base_path}/{version}/v1/orders/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getMetrics(customerId, periodStartPtz, periodEndPtz, limit, offset, callback)</td>
+    <td style="padding:15px">Returns a list of parking metrics for the specified customer, using specified filters</td>
+    <td style="padding:15px">{base_path}/{version}/v1/customers/{pathv1}/parking/metrics?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getMetricsByDomain(customerId, startDate, endDate, domains, domainLike, portfolioId, limit, offset, callback)</td>
+    <td style="padding:15px">Returns a list of domain metrics for the specified customer and portfolio, using specified filters</td>
+    <td style="padding:15px">{base_path}/{version}/v1/customers/{pathv1}/parking/metricsByDomain?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createSubaccount(subaccount, callback)</td>
+    <td style="padding:15px">Create a Subaccount owned by the authenticated Reseller</td>
+    <td style="padding:15px">{base_path}/{version}/v1/shoppers/subaccount?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getShopper(shopperId, includes, callback)</td>
+    <td style="padding:15px">Get details for the specified Shopper</td>
+    <td style="padding:15px">{base_path}/{version}/v1/shoppers/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateShopper(shopperId, shopper, callback)</td>
+    <td style="padding:15px">Update details for the specified Shopper</td>
+    <td style="padding:15px">{base_path}/{version}/v1/shoppers/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">delete(shopperId, auditClientIp, callback)</td>
+    <td style="padding:15px">Request the deletion of a shopper profile</td>
+    <td style="padding:15px">{base_path}/{version}/v1/shoppers/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getStatus(shopperId, auditClientIp, callback)</td>
+    <td style="padding:15px">Get details for the specified Shopper</td>
+    <td style="padding:15px">{base_path}/{version}/v1/shoppers/{pathv1}/status?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">changePassword(shopperId, secret, callback)</td>
+    <td style="padding:15px">Set subaccount's password</td>
+    <td style="padding:15px">{base_path}/{version}/v1/shoppers/{pathv1}/factors/password?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">list(productGroupKeys, includes = 'addons', offset, limit, sort = 'expiresAt', callback)</td>
+    <td style="padding:15px">Retrieve a list of Subscriptions for the specified Shopper</td>
+    <td style="padding:15px">{base_path}/{version}/v1/subscriptions?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">productGroups(callback)</td>
+    <td style="padding:15px">Retrieve a list of ProductGroups for the specified Shopper</td>
+    <td style="padding:15px">{base_path}/{version}/v1/subscriptions/productGroups?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">cancelSubscription(subscriptionId, callback)</td>
+    <td style="padding:15px">Cancel the specified Subscription</td>
+    <td style="padding:15px">{base_path}/{version}/v1/subscriptions/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSubscription(subscriptionId, callback)</td>
+    <td style="padding:15px">Retrieve details for the specified Subscription</td>
+    <td style="padding:15px">{base_path}/{version}/v1/subscriptions/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateSubscription(subscriptionId, subscription, callback)</td>
+    <td style="padding:15px">Update details for the specified Subscription</td>
+    <td style="padding:15px">{base_path}/{version}/v1/subscriptions/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+</table>
+<br>