UNPKG

@itentialopensource/adapter-godaddy

Version:

This adapter integrates with system described as: GoDaddy REST API v1 and v2.

696 lines 18.4 kB
{ "actions": [ { "name": "listDomains", "protocol": "REST", "method": "GET", "entitypath": "{base_path}/{version}/v1/domains?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "sendGetBody": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "mockdatafiles/listDomains-default.json" } ] }, { "name": "getAgreement", "protocol": "REST", "method": "GET", "entitypath": "{base_path}/{version}/v1/domains/agreements?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "sendGetBody": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "mockdatafiles/getAgreement-default.json" } ] }, { "name": "available", "protocol": "REST", "method": "GET", "entitypath": "{base_path}/{version}/v1/domains/available?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "sendGetBody": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "availableBulk", "protocol": "REST", "method": "POST", "entitypath": "{base_path}/{version}/v1/domains/available?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "contactsValidate", "protocol": "REST", "method": "POST", "entitypath": "{base_path}/{version}/v1/domains/contacts/validate?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "purchase", "protocol": "REST", "method": "POST", "entitypath": "{base_path}/{version}/v1/domains/purchase?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "schema", "protocol": "REST", "method": "GET", "entitypath": "{base_path}/{version}/v1/domains/purchase/schema/{pathv1}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "sendGetBody": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "validate", "protocol": "REST", "method": "POST", "entitypath": "{base_path}/{version}/v1/domains/purchase/validate?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "suggest", "protocol": "REST", "method": "GET", "entitypath": "{base_path}/{version}/v1/domains/suggest?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "sendGetBody": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "mockdatafiles/suggest-default.json" } ] }, { "name": "tlds", "protocol": "REST", "method": "GET", "entitypath": "{base_path}/{version}/v1/domains/tlds?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "sendGetBody": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "mockdatafiles/tlds-default.json" } ] }, { "name": "cancel", "protocol": "REST", "method": "DELETE", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "getDomain", "protocol": "REST", "method": "GET", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "sendGetBody": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "update", "protocol": "REST", "method": "PATCH", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "updateContacts", "protocol": "REST", "method": "PATCH", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}/contacts?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "cancelPrivacy", "protocol": "REST", "method": "DELETE", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}/privacy?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "purchasePrivacy", "protocol": "REST", "method": "POST", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}/privacy/purchase?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "recordAdd", "protocol": "REST", "method": "PATCH", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}/records?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "recordReplace", "protocol": "REST", "method": "PUT", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}/records?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "recordGet", "protocol": "REST", "method": "GET", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}/records/{pathv2}/{pathv3}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "sendGetBody": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "mockdatafiles/recordGet-default.json" } ] }, { "name": "recordReplaceTypeName", "protocol": "REST", "method": "PUT", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}/records/{pathv2}/{pathv3}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "recordDeleteTypeName", "protocol": "REST", "method": "DELETE", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}/records/{pathv2}/{pathv3}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "recordReplaceType", "protocol": "REST", "method": "PUT", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}/records/{pathv2}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "renew", "protocol": "REST", "method": "POST", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}/renew?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "transferIn", "protocol": "REST", "method": "POST", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}/transfer?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "verifyEmail", "protocol": "REST", "method": "POST", "entitypath": "{base_path}/{version}/v1/domains/{pathv1}/verifyRegistrantEmail?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "getV2CustomersCustomerIdDomainsDomain", "protocol": "REST", "method": "GET", "entitypath": "{base_path}/{version}/v2/customers/{pathv1}/domains/{pathv2}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "sendGetBody": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "postV2CustomersCustomerIdDomainsDomainRedeem", "protocol": "REST", "method": "POST", "entitypath": "{base_path}/{version}/v2/customers/{pathv1}/domains/{pathv2}/redeem?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "postV2CustomersCustomerIdDomainsDomainTransferOut", "protocol": "REST", "method": "POST", "entitypath": "{base_path}/{version}/v2/customers/{pathv1}/domains/{pathv2}/transferOut?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "domainsForwardsDelete", "protocol": "REST", "method": "DELETE", "entitypath": "{base_path}/{version}/v2/customers/{pathv1}/domains/forwards/{pathv2}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "domainsForwardsGet", "protocol": "REST", "method": "GET", "entitypath": "{base_path}/{version}/v2/customers/{pathv1}/domains/forwards/{pathv2}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "sendGetBody": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "mockdatafiles/domainsForwardsGet-default.json" } ] }, { "name": "domainsForwardsPut", "protocol": "REST", "method": "PUT", "entitypath": "{base_path}/{version}/v2/customers/{pathv1}/domains/forwards/{pathv2}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "domainsForwardsPost", "protocol": "REST", "method": "POST", "entitypath": "{base_path}/{version}/v2/customers/{pathv1}/domains/forwards/{pathv2}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "getV2DomainsMaintenances", "protocol": "REST", "method": "GET", "entitypath": "{base_path}/{version}/v2/domains/maintenances?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "sendGetBody": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] }, { "name": "getV2DomainsMaintenancesMaintenanceId", "protocol": "REST", "method": "GET", "entitypath": "{base_path}/{version}/v2/domains/maintenances/{pathv1}?{query}", "requestSchema": "schema.json", "responseSchema": "schema.json", "timeout": 0, "sendEmpty": false, "sendGetBody": false, "requestDatatype": "JSON", "responseDatatype": "JSON", "headers": {}, "responseObjects": [ { "type": "default", "key": "", "mockFile": "" } ] } ] }