dnsimple 11.1.0 → 12.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +10 -5
- data/.github/workflows/release.yml +44 -13
- data/.github/workflows/sync-test-fixtures.yml +1 -1
- data/.rubocop.yml +4 -1
- data/.rubocop_dnsimple.yml +13 -41
- data/.rubocop_todo.yml +4 -9
- data/CHANGELOG.md +285 -183
- data/CONTRIBUTING.md +6 -40
- data/Gemfile +1 -1
- data/LICENSE.txt +1 -1
- data/README.md +49 -40
- data/RELEASING.md +67 -0
- data/dnsimple.gemspec +1 -1
- data/lib/dnsimple/client/accounts.rb +1 -3
- data/lib/dnsimple/client/billing.rb +2 -4
- data/lib/dnsimple/client/certificates.rb +0 -2
- data/lib/dnsimple/client/clients.rb +2 -40
- data/lib/dnsimple/client/contacts.rb +17 -19
- data/lib/dnsimple/client/dns_analytics.rb +2 -4
- data/lib/dnsimple/client/domains.rb +13 -15
- data/lib/dnsimple/client/domains_delegation_signer_records.rb +18 -20
- data/lib/dnsimple/client/domains_dnssec.rb +9 -11
- data/lib/dnsimple/client/domains_email_forwards.rb +18 -20
- data/lib/dnsimple/client/domains_pushes.rb +13 -15
- data/lib/dnsimple/client/identity.rb +4 -9
- data/lib/dnsimple/client/oauth.rb +1 -3
- data/lib/dnsimple/client/registrar.rb +45 -47
- data/lib/dnsimple/client/registrar_auto_renewal.rb +6 -8
- data/lib/dnsimple/client/registrar_delegation.rb +14 -16
- data/lib/dnsimple/client/registrar_registrant_changes.rb +14 -16
- data/lib/dnsimple/client/registrar_transfer_lock.rb +9 -11
- data/lib/dnsimple/client/registrar_whois_privacy.rb +6 -48
- data/lib/dnsimple/client/services.rb +4 -6
- data/lib/dnsimple/client/services_domains.rb +12 -14
- data/lib/dnsimple/client/templates.rb +17 -19
- data/lib/dnsimple/client/templates_domains.rb +4 -6
- data/lib/dnsimple/client/templates_records.rb +18 -20
- data/lib/dnsimple/client/tlds.rb +6 -8
- data/lib/dnsimple/client/vanity_name_servers.rb +0 -2
- data/lib/dnsimple/client/webhooks.rb +11 -13
- data/lib/dnsimple/client/zones.rb +16 -18
- data/lib/dnsimple/client/zones_distributions.rb +4 -6
- data/lib/dnsimple/client/zones_records.rb +29 -31
- data/lib/dnsimple/client.rb +22 -24
- data/lib/dnsimple/default.rb +0 -4
- data/lib/dnsimple/error.rb +0 -6
- data/lib/dnsimple/extra.rb +4 -6
- data/lib/dnsimple/options.rb +1 -7
- data/lib/dnsimple/response.rb +4 -13
- data/lib/dnsimple/struct/account.rb +0 -2
- data/lib/dnsimple/struct/certificate.rb +0 -2
- data/lib/dnsimple/struct/certificate_bundle.rb +0 -2
- data/lib/dnsimple/struct/certificate_purchase.rb +0 -2
- data/lib/dnsimple/struct/certificate_renewal.rb +0 -2
- data/lib/dnsimple/struct/charge.rb +4 -8
- data/lib/dnsimple/struct/collaborator.rb +0 -2
- data/lib/dnsimple/struct/contact.rb +0 -2
- data/lib/dnsimple/struct/delegation_signer_record.rb +0 -2
- data/lib/dnsimple/struct/dns_analytics.rb +0 -2
- data/lib/dnsimple/struct/dnssec.rb +0 -2
- data/lib/dnsimple/struct/domain.rb +0 -2
- data/lib/dnsimple/struct/domain_check.rb +0 -2
- data/lib/dnsimple/struct/domain_premium_price.rb +0 -2
- data/lib/dnsimple/struct/domain_price.rb +0 -2
- data/lib/dnsimple/struct/domain_push.rb +0 -2
- data/lib/dnsimple/struct/domain_registration.rb +0 -2
- data/lib/dnsimple/struct/domain_renewal.rb +0 -2
- data/lib/dnsimple/struct/domain_restore.rb +0 -2
- data/lib/dnsimple/struct/domain_transfer.rb +0 -2
- data/lib/dnsimple/struct/email_forward.rb +0 -2
- data/lib/dnsimple/struct/extended_attribute.rb +0 -4
- data/lib/dnsimple/struct/oauth_token.rb +0 -2
- data/lib/dnsimple/struct/registrant_change.rb +0 -2
- data/lib/dnsimple/struct/registrant_change_check.rb +0 -2
- data/lib/dnsimple/struct/service.rb +0 -4
- data/lib/dnsimple/struct/template.rb +0 -2
- data/lib/dnsimple/struct/template_record.rb +0 -2
- data/lib/dnsimple/struct/tld.rb +0 -2
- data/lib/dnsimple/struct/transfer_lock.rb +0 -2
- data/lib/dnsimple/struct/user.rb +0 -2
- data/lib/dnsimple/struct/vanity_name_server.rb +0 -2
- data/lib/dnsimple/struct/webhook.rb +0 -2
- data/lib/dnsimple/struct/whoami.rb +2 -4
- data/lib/dnsimple/struct/whois_privacy.rb +0 -2
- data/lib/dnsimple/struct/zone.rb +0 -2
- data/lib/dnsimple/struct/zone_distribution.rb +0 -2
- data/lib/dnsimple/struct/zone_file.rb +0 -2
- data/lib/dnsimple/struct/zone_record.rb +0 -2
- data/lib/dnsimple/struct/zone_record_id.rb +0 -2
- data/lib/dnsimple/struct/zone_records_batch_change.rb +0 -2
- data/lib/dnsimple/struct.rb +0 -3
- data/lib/dnsimple/version.rb +1 -3
- data/lib/dnsimple.rb +1 -3
- data/spec/dnsimple/client/client_service_spec.rb +12 -10
- data/spec/dnsimple/client/oauth_spec.rb +6 -6
- data/spec/dnsimple/client/registrar_whois_privacy_spec.rb +0 -82
- data/spec/fixtures.http/acceptPush/success.http +15 -15
- data/spec/fixtures.http/accounts/success-account.http +20 -20
- data/spec/fixtures.http/accounts/success-user.http +21 -21
- data/spec/fixtures.http/activateZoneService/success.http +16 -16
- data/spec/fixtures.http/appliedServices/success.http +19 -19
- data/spec/fixtures.http/applyService/success.http +15 -15
- data/spec/fixtures.http/applyTemplate/success.http +13 -13
- data/spec/fixtures.http/authorizeDomainTransferOut/success.http +13 -13
- data/spec/fixtures.http/badgateway.http +5 -5
- data/spec/fixtures.http/batchChangeZoneRecords/error_400_create_validation_failed.http +16 -16
- data/spec/fixtures.http/batchChangeZoneRecords/error_400_delete_validation_failed.http +3 -3
- data/spec/fixtures.http/batchChangeZoneRecords/error_400_update_validation_failed.http +3 -3
- data/spec/fixtures.http/batchChangeZoneRecords/success.http +16 -16
- data/spec/fixtures.http/cancelDomainTransfer/success.http +17 -17
- data/spec/fixtures.http/changeDomainDelegation/success.http +15 -15
- data/spec/fixtures.http/changeDomainDelegationFromVanity/success.http +15 -15
- data/spec/fixtures.http/changeDomainDelegationToVanity/success.http +17 -17
- data/spec/fixtures.http/checkDomain/success.http +15 -15
- data/spec/fixtures.http/checkRegistrantChange/error-contactnotfound.http +3 -3
- data/spec/fixtures.http/checkRegistrantChange/error-domainnotfound.http +3 -3
- data/spec/fixtures.http/checkRegistrantChange/success.http +15 -15
- data/spec/fixtures.http/checkZoneDistribution/error.http +17 -17
- data/spec/fixtures.http/checkZoneDistribution/failure.http +17 -17
- data/spec/fixtures.http/checkZoneDistribution/success.http +17 -17
- data/spec/fixtures.http/checkZoneRecordDistribution/error.http +17 -17
- data/spec/fixtures.http/checkZoneRecordDistribution/failure.http +17 -17
- data/spec/fixtures.http/checkZoneRecordDistribution/success.http +17 -17
- data/spec/fixtures.http/createContact/created.http +16 -16
- data/spec/fixtures.http/createContact/error-validation-errors.http +15 -15
- data/spec/fixtures.http/createDelegationSignerRecord/created.http +17 -17
- data/spec/fixtures.http/createDelegationSignerRecord/validation-error.http +15 -15
- data/spec/fixtures.http/createDomain/created.http +19 -19
- data/spec/fixtures.http/createEmailForward/created.http +21 -21
- data/spec/fixtures.http/createPrimaryServer/created.http +20 -20
- data/spec/fixtures.http/createRegistrantChange/success.http +14 -14
- data/spec/fixtures.http/createSecondaryZone/created.http +20 -20
- data/spec/fixtures.http/createTemplate/created.http +15 -15
- data/spec/fixtures.http/createTemplateRecord/created.http +16 -16
- data/spec/fixtures.http/createWebhook/created.http +13 -13
- data/spec/fixtures.http/createZoneRecord/created-apex.http +13 -13
- data/spec/fixtures.http/createZoneRecord/created.http +13 -13
- data/spec/fixtures.http/deactivateZoneService/success.http +16 -16
- data/spec/fixtures.http/deleteContact/error-contact-in-use.http +15 -15
- data/spec/fixtures.http/deleteContact/success.http +13 -13
- data/spec/fixtures.http/deleteDelegationSignerRecord/success.http +15 -15
- data/spec/fixtures.http/deleteDomain/success.http +11 -11
- data/spec/fixtures.http/deleteEmailForward/success.http +18 -18
- data/spec/fixtures.http/deleteRegistrantChange/success.http +13 -13
- data/spec/fixtures.http/deleteRegistrantChange/success_async.http +3 -3
- data/spec/fixtures.http/deleteTemplate/success.http +13 -13
- data/spec/fixtures.http/deleteTemplateRecord/success.http +13 -13
- data/spec/fixtures.http/deleteWebhook/success.http +13 -13
- data/spec/fixtures.http/deleteZoneRecord/success.http +11 -11
- data/spec/fixtures.http/disableDnssec/not-enabled.http +15 -15
- data/spec/fixtures.http/disableDnssec/success.http +15 -15
- data/spec/fixtures.http/disableDomainAutoRenewal/success.http +13 -13
- data/spec/fixtures.http/disableDomainTransferLock/success.http +17 -17
- data/spec/fixtures.http/disableVanityNameServers/success.http +15 -15
- data/spec/fixtures.http/disableWhoisPrivacy/success.http +16 -16
- data/spec/fixtures.http/dnsAnalytics/success.http +17 -17
- data/spec/fixtures.http/downloadCertificate/success.http +19 -19
- data/spec/fixtures.http/enableDnssec/success.http +17 -17
- data/spec/fixtures.http/enableDomainAutoRenewal/success.http +13 -13
- data/spec/fixtures.http/enableDomainTransferLock/success.http +17 -17
- data/spec/fixtures.http/enableVanityNameServers/success.http +17 -17
- data/spec/fixtures.http/enableWhoisPrivacy/created.http +16 -16
- data/spec/fixtures.http/enableWhoisPrivacy/success.http +16 -16
- data/spec/fixtures.http/getCertificate/success.http +19 -19
- data/spec/fixtures.http/getCertificatePrivateKey/success.http +20 -20
- data/spec/fixtures.http/getContact/success.http +16 -16
- data/spec/fixtures.http/getDelegationSignerRecord/success.http +17 -17
- data/spec/fixtures.http/getDnssec/success.http +17 -17
- data/spec/fixtures.http/getDomain/success.http +19 -19
- data/spec/fixtures.http/getDomainDelegation/success-empty.http +15 -15
- data/spec/fixtures.http/getDomainDelegation/success.http +15 -15
- data/spec/fixtures.http/getDomainPrices/failure.http +18 -18
- data/spec/fixtures.http/getDomainPrices/success.http +21 -21
- data/spec/fixtures.http/getDomainRegistration/success.http +20 -20
- data/spec/fixtures.http/getDomainRenewal/success.http +20 -20
- data/spec/fixtures.http/getDomainRestore/success.http +22 -22
- data/spec/fixtures.http/getDomainTransfer/success.http +19 -19
- data/spec/fixtures.http/getDomainTransferLock/success.http +17 -17
- data/spec/fixtures.http/getEmailForward/success.http +21 -21
- data/spec/fixtures.http/getPrimaryServer/success.http +20 -20
- data/spec/fixtures.http/getRegistrantChange/success.http +15 -15
- data/spec/fixtures.http/getService/success.http +16 -16
- data/spec/fixtures.http/getTemplate/success.http +15 -15
- data/spec/fixtures.http/getTemplateRecord/success.http +16 -16
- data/spec/fixtures.http/getTld/success.http +20 -20
- data/spec/fixtures.http/getTldExtendedAttributes/success-attributes.http +15 -15
- data/spec/fixtures.http/getTldExtendedAttributes/success-noattributes.http +15 -15
- data/spec/fixtures.http/getTldExtendedAttributes/success.http +15 -15
- data/spec/fixtures.http/getWebhook/success.http +13 -13
- data/spec/fixtures.http/getZone/success.http +16 -16
- data/spec/fixtures.http/getZoneFile/success.http +17 -17
- data/spec/fixtures.http/getZoneRecord/success.http +17 -17
- data/spec/fixtures.http/initiatePush/success.http +17 -17
- data/spec/fixtures.http/issueLetsencryptCertificate/success.http +17 -17
- data/spec/fixtures.http/issueRenewalLetsencryptCertificate/success.http +17 -17
- data/spec/fixtures.http/linkPrimaryServer/success.http +20 -20
- data/spec/fixtures.http/listAccounts/success-account.http +20 -20
- data/spec/fixtures.http/listAccounts/success-user.http +20 -20
- data/spec/fixtures.http/listCertificates/success.http +19 -19
- data/spec/fixtures.http/listCharges/fail-400-bad-filter.http +9 -9
- data/spec/fixtures.http/listCharges/fail-403.http +9 -9
- data/spec/fixtures.http/listCharges/success.http +9 -9
- data/spec/fixtures.http/listContacts/success.http +16 -16
- data/spec/fixtures.http/listDelegationSignerRecords/success.http +17 -17
- data/spec/fixtures.http/listDomains/success.http +19 -19
- data/spec/fixtures.http/listEmailForwards/success.http +13 -13
- data/spec/fixtures.http/listPrimaryServers/success.http +20 -20
- data/spec/fixtures.http/listPushes/success.http +17 -17
- data/spec/fixtures.http/listRegistrantChanges/success.http +15 -15
- data/spec/fixtures.http/listServices/success.http +17 -17
- data/spec/fixtures.http/listTemplateRecords/success.http +16 -16
- data/spec/fixtures.http/listTemplates/success.http +15 -15
- data/spec/fixtures.http/listTlds/success.http +20 -20
- data/spec/fixtures.http/listWebhooks/success.http +13 -13
- data/spec/fixtures.http/listZoneRecords/success.http +17 -17
- data/spec/fixtures.http/listZones/success.http +16 -16
- data/spec/fixtures.http/method-not-allowed.http +8 -8
- data/spec/fixtures.http/notfound-certificate.http +12 -12
- data/spec/fixtures.http/notfound-contact.http +10 -10
- data/spec/fixtures.http/notfound-delegationSignerRecord.http +8 -8
- data/spec/fixtures.http/notfound-domain.http +8 -8
- data/spec/fixtures.http/notfound-domainpush.http +8 -8
- data/spec/fixtures.http/notfound-emailforward.http +8 -8
- data/spec/fixtures.http/notfound-record.http +10 -10
- data/spec/fixtures.http/notfound-template.http +10 -10
- data/spec/fixtures.http/notfound-webhook.http +8 -8
- data/spec/fixtures.http/notfound-whoisprivacy.http +10 -10
- data/spec/fixtures.http/notfound-zone.http +10 -10
- data/spec/fixtures.http/oauthAccessToken/error-invalid-request.http +12 -12
- data/spec/fixtures.http/oauthAccessToken/success.http +16 -16
- data/spec/fixtures.http/pages-1of3.http +12 -12
- data/spec/fixtures.http/pages-2of3.http +12 -12
- data/spec/fixtures.http/pages-3of3.http +12 -12
- data/spec/fixtures.http/purchaseLetsencryptCertificate/success.http +19 -19
- data/spec/fixtures.http/purchaseRenewalLetsencryptCertificate/success.http +19 -19
- data/spec/fixtures.http/registerDomain/error-extended-attributes.http +15 -15
- data/spec/fixtures.http/registerDomain/success.http +20 -20
- data/spec/fixtures.http/rejectPush/success.http +15 -15
- data/spec/fixtures.http/renewDomain/error-tooearly.http +14 -14
- data/spec/fixtures.http/renewDomain/success.http +20 -20
- data/spec/fixtures.http/response.http +12 -12
- data/spec/fixtures.http/restoreDomain/success.http +22 -22
- data/spec/fixtures.http/success-with-malformed-json.http +4 -4
- data/spec/fixtures.http/transferDomain/error-indnsimple.http +13 -13
- data/spec/fixtures.http/transferDomain/error-missing-authcode.http +13 -13
- data/spec/fixtures.http/transferDomain/success.http +20 -20
- data/spec/fixtures.http/unapplyService/success.http +15 -15
- data/spec/fixtures.http/unlinkPrimaryServer/success.http +20 -20
- data/spec/fixtures.http/updateContact/success.http +16 -16
- data/spec/fixtures.http/updateTemplate/success.http +15 -15
- data/spec/fixtures.http/updateZoneNsRecords/success.http +16 -16
- data/spec/fixtures.http/updateZoneRecord/success.http +17 -17
- data/spec/fixtures.http/validation-error.http +15 -15
- data/spec/fixtures.http/whoami/success-account.http +15 -15
- data/spec/fixtures.http/whoami/success-user.http +15 -15
- data/spec/fixtures.http/whoami/success.http +15 -15
- data/spec/support/helpers.rb +0 -2
- metadata +7 -13
- data/lib/dnsimple/struct/whois_privacy_renewal.rb +0 -30
- data/spec/fixtures.http/checkDomainPremiumPrice/error_400_not_a_premium_domain.http +0 -18
- data/spec/fixtures.http/checkDomainPremiumPrice/error_400_tld_not_supported.http +0 -18
- data/spec/fixtures.http/checkDomainPremiumPrice/success.http +0 -20
- data/spec/fixtures.http/getDomainPremiumPrice/failure.http +0 -15
- data/spec/fixtures.http/getDomainPremiumPrice/success.http +0 -20
- data/spec/fixtures.http/getWhoisPrivacy/success.http +0 -16
- data/spec/fixtures.http/renewWhoisPrivacy/success.http +0 -20
- data/spec/fixtures.http/renewWhoisPrivacy/whois-privacy-duplicated-order.http +0 -18
- data/spec/fixtures.http/renewWhoisPrivacy/whois-privacy-not-found.http +0 -18
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
module Dnsimple
|
|
4
4
|
class Client
|
|
5
5
|
module Domains
|
|
6
|
-
|
|
7
6
|
# Lists the domains in the account.
|
|
8
7
|
#
|
|
9
8
|
# @see https://developer.dnsimple.com/v2/domains/#listDomains
|
|
@@ -21,8 +20,8 @@ module Dnsimple
|
|
|
21
20
|
# @example List domains, provide a filtering policy
|
|
22
21
|
# client.domains.domains(1010, filter: { name_like: "example" })
|
|
23
22
|
#
|
|
24
|
-
# @param [Integer]
|
|
25
|
-
# @param [Hash]
|
|
23
|
+
# @param account_id [Integer] the account ID
|
|
24
|
+
# @param options [Hash] the filtering and sorting options
|
|
26
25
|
# @option options [Integer] :page current page (pagination)
|
|
27
26
|
# @option options [Integer] :per_page number of entries to return (pagination)
|
|
28
27
|
# @option options [String] :sort sorting policy
|
|
@@ -48,8 +47,8 @@ module Dnsimple
|
|
|
48
47
|
# @see https://developer.dnsimple.com/v2/domains/#listDomains
|
|
49
48
|
# @see #domains
|
|
50
49
|
#
|
|
51
|
-
# @param [Integer]
|
|
52
|
-
# @param [Hash]
|
|
50
|
+
# @param account_id [Integer] the account ID
|
|
51
|
+
# @param options [Hash] the filtering and sorting option
|
|
53
52
|
# @option options [Integer] :page current page (pagination)
|
|
54
53
|
# @option options [Integer] :per_page number of entries to return (pagination)
|
|
55
54
|
# @option options [String] :sort sorting policy
|
|
@@ -68,9 +67,9 @@ module Dnsimple
|
|
|
68
67
|
# @example Creating a domain in a specific account. Does not register the domain
|
|
69
68
|
# client.domains.create_domain(1010, name: "example.com")
|
|
70
69
|
#
|
|
71
|
-
# @param [Integer]
|
|
72
|
-
# @param [Hash]
|
|
73
|
-
# @param [Hash]
|
|
70
|
+
# @param account_id [Integer] the account ID
|
|
71
|
+
# @param attributes [Hash]
|
|
72
|
+
# @param options [Hash]
|
|
74
73
|
# @return [Dnsimple::Response<Dnsimple::Struct::Domain>]
|
|
75
74
|
#
|
|
76
75
|
# @raise [Dnsimple::RequestError]
|
|
@@ -92,9 +91,9 @@ module Dnsimple
|
|
|
92
91
|
# @example Getting a domain in a specific account, by domain name
|
|
93
92
|
# client.domains.domain(1010, "example.com")
|
|
94
93
|
#
|
|
95
|
-
# @param [Integer]
|
|
96
|
-
# @param [#to_s]
|
|
97
|
-
# @param [Hash]
|
|
94
|
+
# @param account_id [Integer] the account ID
|
|
95
|
+
# @param domain_id [#to_s] The domain ID or domain name
|
|
96
|
+
# @param options [Hash]
|
|
98
97
|
# @return [Dnsimple::Response<Dnsimple::Struct::Domain>]
|
|
99
98
|
#
|
|
100
99
|
# @raise [Dnsimple::NotFoundError]
|
|
@@ -116,9 +115,9 @@ module Dnsimple
|
|
|
116
115
|
# @example Deleting a domain in a specific account, by domain name
|
|
117
116
|
# client.domains.delete_domain(1010, "example.com")
|
|
118
117
|
#
|
|
119
|
-
# @param [Integer]
|
|
120
|
-
# @param [#to_s]
|
|
121
|
-
# @param [Hash]
|
|
118
|
+
# @param account_id [Integer] the account ID
|
|
119
|
+
# @param domain_id [#to_s] The domain ID or domain name
|
|
120
|
+
# @param options [Hash]
|
|
122
121
|
# @return [Dnsimple::Response<nil>]
|
|
123
122
|
#
|
|
124
123
|
# @raise [Dnsimple::NotFoundError]
|
|
@@ -128,7 +127,6 @@ module Dnsimple
|
|
|
128
127
|
|
|
129
128
|
Dnsimple::Response.new(response, nil)
|
|
130
129
|
end
|
|
131
|
-
|
|
132
130
|
end
|
|
133
131
|
end
|
|
134
132
|
end
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
module Dnsimple
|
|
4
4
|
class Client
|
|
5
5
|
module DomainsDelegationSignerRecords
|
|
6
|
-
|
|
7
6
|
# Lists the delegation signer records for the domain.
|
|
8
7
|
#
|
|
9
8
|
# @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-list
|
|
@@ -17,9 +16,9 @@ module Dnsimple
|
|
|
17
16
|
# @example List delegation signer records, provide a sorting policy
|
|
18
17
|
# client.domains.delegation_signer_records(1010, "example.com", sort: "from:asc")
|
|
19
18
|
#
|
|
20
|
-
# @param [Integer]
|
|
21
|
-
# @param [#to_s]
|
|
22
|
-
# @param [Hash]
|
|
19
|
+
# @param account_id [Integer] the account ID
|
|
20
|
+
# @param domain_id [#to_s] The domain ID or domain name
|
|
21
|
+
# @param options [Hash] the filtering and sorting options
|
|
23
22
|
# @option options [Integer] :page current page (pagination)
|
|
24
23
|
# @option options [Integer] :per_page number of entries to return (pagination)
|
|
25
24
|
# @option options [String] :sort sorting policy
|
|
@@ -44,9 +43,9 @@ module Dnsimple
|
|
|
44
43
|
# @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-list
|
|
45
44
|
# @see #email_forwards
|
|
46
45
|
#
|
|
47
|
-
# @param [Integer]
|
|
48
|
-
# @param [#to_s]
|
|
49
|
-
# @param [Hash]
|
|
46
|
+
# @param account_id [Integer] the account ID
|
|
47
|
+
# @param domain_id [#to_s] The domain ID or domain name
|
|
48
|
+
# @param options [Hash] the filtering and sorting option
|
|
50
49
|
# @option options [Integer] :page current page (pagination)
|
|
51
50
|
# @option options [Integer] :per_page number of entries to return (pagination)
|
|
52
51
|
# @option options [String] :sort sorting policy
|
|
@@ -63,15 +62,15 @@ module Dnsimple
|
|
|
63
62
|
# @see http://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml
|
|
64
63
|
# @see http://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml
|
|
65
64
|
#
|
|
66
|
-
# @param [Integer]
|
|
67
|
-
# @param [#to_s]
|
|
68
|
-
# @param [Hash]
|
|
65
|
+
# @param account_id [Integer] the account ID
|
|
66
|
+
# @param domain_id [#to_s] The domain ID or domain name
|
|
67
|
+
# @param attributes [Hash]
|
|
69
68
|
# @option attributes [Integer] :algorithm DNSSEC algorithm as number (required)
|
|
70
69
|
# @option attributes [String] :digest The hexidecimal representation of the digest of the corresponding DNSKEY record (required if TLD requires DS data)
|
|
71
70
|
# @option attributes [Integer] :digest_type DNSSEC digest type (required if TLD requires DS data)
|
|
72
71
|
# @option attributes [String] :keytag A keytag that references the corresponding DNSKEY record (required if TLD requires DS data)
|
|
73
72
|
# @option attributes [String] :public_key A public key that references the corresponding DNSKEY record (required if TLD requires KEY data)
|
|
74
|
-
# @param [Hash]
|
|
73
|
+
# @param options [Hash]
|
|
75
74
|
# @return [Dnsimple::Response<Dnsimple::Struct::DelegationSignerRecord>]
|
|
76
75
|
#
|
|
77
76
|
# @raise [Dnsimple::RequestError]
|
|
@@ -86,10 +85,10 @@ module Dnsimple
|
|
|
86
85
|
#
|
|
87
86
|
# @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-get
|
|
88
87
|
#
|
|
89
|
-
# @param [Integer]
|
|
90
|
-
# @param [#to_s]
|
|
91
|
-
# @param [#to_s]
|
|
92
|
-
# @param [Hash]
|
|
88
|
+
# @param account_id [Integer] the account ID
|
|
89
|
+
# @param domain_id [#to_s] The domain ID or domain name
|
|
90
|
+
# @param ds_record_id [#to_s] The delegation signer record ID
|
|
91
|
+
# @param options [Hash]
|
|
93
92
|
# @return [Dnsimple::Response<Dnsimple::Struct::DelegationSignerRecord>]
|
|
94
93
|
#
|
|
95
94
|
# @raise [Dnsimple::NotFoundError]
|
|
@@ -106,10 +105,10 @@ module Dnsimple
|
|
|
106
105
|
#
|
|
107
106
|
# @see https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-delete
|
|
108
107
|
#
|
|
109
|
-
# @param [Integer]
|
|
110
|
-
# @param [#to_s]
|
|
111
|
-
# @param [#to_s]
|
|
112
|
-
# @param [Hash]
|
|
108
|
+
# @param account_id [Integer] the account ID
|
|
109
|
+
# @param domain_id [#to_s] The domain ID or domain name
|
|
110
|
+
# @param ds_record_id [#to_s] The delegation signer record ID
|
|
111
|
+
# @param options [Hash]
|
|
113
112
|
# @return [Dnsimple::Response<nil>]
|
|
114
113
|
#
|
|
115
114
|
# @raise [Dnsimple::NotFoundError]
|
|
@@ -119,7 +118,6 @@ module Dnsimple
|
|
|
119
118
|
|
|
120
119
|
Dnsimple::Response.new(response, nil)
|
|
121
120
|
end
|
|
122
|
-
|
|
123
121
|
end
|
|
124
122
|
end
|
|
125
123
|
end
|
|
@@ -3,14 +3,13 @@
|
|
|
3
3
|
module Dnsimple
|
|
4
4
|
class Client
|
|
5
5
|
module DomainsDnssec
|
|
6
|
-
|
|
7
6
|
# Enable DNSSEC for the domain in the account.
|
|
8
7
|
#
|
|
9
8
|
# @see https://developer.dnsimple.com/v2/dnssec/#enable
|
|
10
9
|
#
|
|
11
|
-
# @param [Integer]
|
|
12
|
-
# @param [#to_s]
|
|
13
|
-
# @param [Hash]
|
|
10
|
+
# @param account_id [Integer] the account ID
|
|
11
|
+
# @param domain_name [#to_s] the domain name
|
|
12
|
+
# @param options [Hash]
|
|
14
13
|
# @return [Dnsimple::Response<Dnsimple::Struct::Dnssec>]
|
|
15
14
|
#
|
|
16
15
|
# @raise [Dnsimple::NotFoundError]
|
|
@@ -25,9 +24,9 @@ module Dnsimple
|
|
|
25
24
|
#
|
|
26
25
|
# @see https://developer.dnsimple.com/v2/dnssec/#disable
|
|
27
26
|
#
|
|
28
|
-
# @param [Integer]
|
|
29
|
-
# @param [#to_s]
|
|
30
|
-
# @param [Hash]
|
|
27
|
+
# @param account_id [Integer] the account ID
|
|
28
|
+
# @param domain_name [#to_s] the domain name
|
|
29
|
+
# @param options [Hash]
|
|
31
30
|
# @return [Dnsimple::Response<nil>]
|
|
32
31
|
#
|
|
33
32
|
# @raise [Dnsimple::NotFoundError]
|
|
@@ -42,9 +41,9 @@ module Dnsimple
|
|
|
42
41
|
#
|
|
43
42
|
# @see https://developer.dnsimple.com/v2/dnssec/#get
|
|
44
43
|
#
|
|
45
|
-
# @param [Integer]
|
|
46
|
-
# @param [#to_s]
|
|
47
|
-
# @param [Hash]
|
|
44
|
+
# @param account_id [Integer] the account ID
|
|
45
|
+
# @param domain_name [#to_s] the domain name
|
|
46
|
+
# @param options [Hash]
|
|
48
47
|
# @return [Dnsimple::Response<Dnsimple::Struct::Dnssec>]
|
|
49
48
|
#
|
|
50
49
|
# @raise [Dnsimple::NotFoundError]
|
|
@@ -54,7 +53,6 @@ module Dnsimple
|
|
|
54
53
|
|
|
55
54
|
Dnsimple::Response.new(response, Struct::Dnssec.new(response["data"]))
|
|
56
55
|
end
|
|
57
|
-
|
|
58
56
|
end
|
|
59
57
|
end
|
|
60
58
|
end
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
module Dnsimple
|
|
4
4
|
class Client
|
|
5
5
|
module DomainsEmailForwards
|
|
6
|
-
|
|
7
6
|
# Lists the email forwards for the domain.
|
|
8
7
|
#
|
|
9
8
|
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#list
|
|
@@ -17,9 +16,9 @@ module Dnsimple
|
|
|
17
16
|
# @example List email forwards, provide a sorting policy
|
|
18
17
|
# client.domains.email_forwards(1010, "example.com", sort: "from:asc")
|
|
19
18
|
#
|
|
20
|
-
# @param [Integer]
|
|
21
|
-
# @param [#to_s]
|
|
22
|
-
# @param [Hash]
|
|
19
|
+
# @param account_id [Integer] the account ID
|
|
20
|
+
# @param domain_id [#to_s] The domain ID or domain name
|
|
21
|
+
# @param options [Hash] the filtering and sorting options
|
|
23
22
|
# @option options [Integer] :page current page (pagination)
|
|
24
23
|
# @option options [Integer] :per_page number of entries to return (pagination)
|
|
25
24
|
# @option options [String] :sort sorting policy
|
|
@@ -44,9 +43,9 @@ module Dnsimple
|
|
|
44
43
|
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#list
|
|
45
44
|
# @see #email_forwards
|
|
46
45
|
#
|
|
47
|
-
# @param [Integer]
|
|
48
|
-
# @param [#to_s]
|
|
49
|
-
# @param [Hash]
|
|
46
|
+
# @param account_id [Integer] the account ID
|
|
47
|
+
# @param domain_id [#to_s] The domain ID or domain name
|
|
48
|
+
# @param options [Hash] the filtering and sorting option
|
|
50
49
|
# @option options [Integer] :page current page (pagination)
|
|
51
50
|
# @option options [Integer] :per_page number of entries to return (pagination)
|
|
52
51
|
# @option options [String] :sort sorting policy
|
|
@@ -61,10 +60,10 @@ module Dnsimple
|
|
|
61
60
|
#
|
|
62
61
|
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#create
|
|
63
62
|
#
|
|
64
|
-
# @param [Integer]
|
|
65
|
-
# @param [#to_s]
|
|
66
|
-
# @param [Hash]
|
|
67
|
-
# @param [Hash]
|
|
63
|
+
# @param account_id [Integer] the account ID
|
|
64
|
+
# @param domain_id [#to_s] The domain ID or domain name
|
|
65
|
+
# @param attributes [Hash]
|
|
66
|
+
# @param options [Hash]
|
|
68
67
|
# @return [Dnsimple::Response<Dnsimple::Struct::EmailForward>]
|
|
69
68
|
#
|
|
70
69
|
# @raise [Dnsimple::RequestError]
|
|
@@ -79,10 +78,10 @@ module Dnsimple
|
|
|
79
78
|
#
|
|
80
79
|
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#get
|
|
81
80
|
#
|
|
82
|
-
# @param [Integer]
|
|
83
|
-
# @param [#to_s]
|
|
84
|
-
# @param [#to_s]
|
|
85
|
-
# @param [Hash]
|
|
81
|
+
# @param account_id [Integer] the account ID
|
|
82
|
+
# @param domain_id [#to_s] The domain ID or domain name
|
|
83
|
+
# @param email_forward_id [#to_s] The email forward ID
|
|
84
|
+
# @param options [Hash]
|
|
86
85
|
# @return [Dnsimple::Response<Dnsimple::Struct::EmailForward>]
|
|
87
86
|
#
|
|
88
87
|
# @raise [Dnsimple::NotFoundError]
|
|
@@ -99,10 +98,10 @@ module Dnsimple
|
|
|
99
98
|
#
|
|
100
99
|
# @see https://developer.dnsimple.com/v2/domains/email-forwards/#delete
|
|
101
100
|
#
|
|
102
|
-
# @param [Integer]
|
|
103
|
-
# @param [#to_s]
|
|
104
|
-
# @param [#to_s]
|
|
105
|
-
# @param [Hash]
|
|
101
|
+
# @param account_id [Integer] the account ID
|
|
102
|
+
# @param domain_id [#to_s] The domain ID or domain name
|
|
103
|
+
# @param email_forward_id [#to_s] The email forward ID
|
|
104
|
+
# @param options [Hash]
|
|
106
105
|
# @return [Dnsimple::Response<nil>]
|
|
107
106
|
#
|
|
108
107
|
# @raise [Dnsimple::NotFoundError]
|
|
@@ -112,7 +111,6 @@ module Dnsimple
|
|
|
112
111
|
|
|
113
112
|
Dnsimple::Response.new(response, nil)
|
|
114
113
|
end
|
|
115
|
-
|
|
116
114
|
end
|
|
117
115
|
end
|
|
118
116
|
end
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
module Dnsimple
|
|
4
4
|
class Client
|
|
5
5
|
module DomainsPushes
|
|
6
|
-
|
|
7
6
|
# Initiate a push for the domain.
|
|
8
7
|
#
|
|
9
8
|
# @see https://developer.dnsimple.com/v2/domains/pushes/#initiate
|
|
@@ -11,11 +10,11 @@ module Dnsimple
|
|
|
11
10
|
# @example Initiate a domain pushe for example.com:
|
|
12
11
|
# client.domains.initiate_push(1010, "example.com", new_account_email: "admin@target-account.test")
|
|
13
12
|
#
|
|
14
|
-
# @param [Integer]
|
|
15
|
-
# @param [#to_s]
|
|
16
|
-
# @param [Hash]
|
|
13
|
+
# @param account_id [Integer] the account ID
|
|
14
|
+
# @param domain_id [#to_s] The domain ID or domain name
|
|
15
|
+
# @param attributes [Hash]
|
|
17
16
|
# @option attributes [String] :new_account_email the target account email (mandatory)
|
|
18
|
-
# @param [Hash]
|
|
17
|
+
# @param options [Hash]
|
|
19
18
|
# @return [Dnsimple::Response<Dnsimple::Struct::DomainPush>]
|
|
20
19
|
#
|
|
21
20
|
# @raise [Dnsimple::RequestError]
|
|
@@ -36,8 +35,8 @@ module Dnsimple
|
|
|
36
35
|
# @example List domain pushes, provide a specific page
|
|
37
36
|
# client.domains.pushes(2020, page: 2)
|
|
38
37
|
#
|
|
39
|
-
# @param [Integer]
|
|
40
|
-
# @param [Hash]
|
|
38
|
+
# @param account_id [Integer] the account ID
|
|
39
|
+
# @param options [Hash]
|
|
41
40
|
# @option options [Integer] :page current page (pagination)
|
|
42
41
|
# @option options [Integer] :per_page number of entries to return (pagination)
|
|
43
42
|
# @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::DomainPush>]
|
|
@@ -57,10 +56,10 @@ module Dnsimple
|
|
|
57
56
|
# @example Accept a domain push in the target account:
|
|
58
57
|
# client.domains.accept_push(2020, 1, contact_id: 2)
|
|
59
58
|
#
|
|
60
|
-
# @param [Integer]
|
|
61
|
-
# @param [Integer]
|
|
62
|
-
# @param [Hash]
|
|
63
|
-
# @param [Hash]
|
|
59
|
+
# @param account_id [Integer] the target account ID
|
|
60
|
+
# @param push_id [Integer] the domain push ID
|
|
61
|
+
# @param options [Hash]
|
|
62
|
+
# @param attributes [Hash]
|
|
64
63
|
# @option attributes [Integer] :contact_id the contact ID (mandatory)
|
|
65
64
|
# @return [Dnsimple::Response<nil>]
|
|
66
65
|
#
|
|
@@ -80,9 +79,9 @@ module Dnsimple
|
|
|
80
79
|
# @example Reject a domain push in the target account:
|
|
81
80
|
# client.domains.reject_push(2020, 1, contact_id: 2)
|
|
82
81
|
#
|
|
83
|
-
# @param [Integer]
|
|
84
|
-
# @param [Integer]
|
|
85
|
-
# @param [Hash]
|
|
82
|
+
# @param account_id [Integer] the target account ID
|
|
83
|
+
# @param push_id [Integer] the domain push ID
|
|
84
|
+
# @param options [Hash]
|
|
86
85
|
# @return [Dnsimple::Response<nil>]
|
|
87
86
|
#
|
|
88
87
|
# @raise [Dnsimple::NotFoundError]
|
|
@@ -92,7 +91,6 @@ module Dnsimple
|
|
|
92
91
|
|
|
93
92
|
Dnsimple::Response.new(response, nil)
|
|
94
93
|
end
|
|
95
|
-
|
|
96
94
|
end
|
|
97
95
|
end
|
|
98
96
|
end
|
|
@@ -3,12 +3,11 @@
|
|
|
3
3
|
module Dnsimple
|
|
4
4
|
class Client
|
|
5
5
|
module Identity
|
|
6
|
-
|
|
7
6
|
# Gets the information about the current authenticated context.
|
|
8
7
|
#
|
|
9
8
|
# @see https://developer.dnsimple.com/v2/identity/#whoami
|
|
10
9
|
#
|
|
11
|
-
# @param [Hash]
|
|
10
|
+
# @param options [Hash]
|
|
12
11
|
# @return [Dnsimple::Response<Dnsimple::Struct::Whoami>]
|
|
13
12
|
# @raise [Dnsimple::RequestError]
|
|
14
13
|
def whoami(options = {})
|
|
@@ -19,21 +18,17 @@ module Dnsimple
|
|
|
19
18
|
|
|
20
19
|
|
|
21
20
|
module StaticHelpers
|
|
22
|
-
|
|
23
21
|
# Calls {Identity#whoami} and directly returns the response data.
|
|
24
22
|
#
|
|
25
23
|
# @see https://developer.dnsimple.com/v2/identity/#whoami
|
|
26
24
|
#
|
|
27
|
-
# @param [Dnsimple::Client]
|
|
28
|
-
# @param [Array] args the args for the {Identity#whoami} call
|
|
25
|
+
# @param client [Dnsimple::Client] the DNSimple client instance to use
|
|
29
26
|
# @return [Hash]
|
|
30
27
|
# @raise [Dnsimple::RequestError]
|
|
31
|
-
def whoami(client, *
|
|
32
|
-
client.identity.whoami(*
|
|
28
|
+
def whoami(client, *)
|
|
29
|
+
client.identity.whoami(*).data
|
|
33
30
|
end
|
|
34
|
-
|
|
35
31
|
end
|
|
36
|
-
|
|
37
32
|
end
|
|
38
33
|
end
|
|
39
34
|
end
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
module Dnsimple
|
|
4
4
|
class Client
|
|
5
5
|
module Oauth
|
|
6
|
-
|
|
7
6
|
# Exchange the short-lived authorization code for an access token
|
|
8
7
|
# you can use to authenticate your API calls.
|
|
9
8
|
#
|
|
@@ -14,7 +13,7 @@ module Dnsimple
|
|
|
14
13
|
# @option options [String] :redirect_uri The redirect URL sent for the authorization, used to validate the request.
|
|
15
14
|
# @return [String] The url to redirect the user to authorize.
|
|
16
15
|
def exchange_authorization_for_token(code, client_id, client_secret, options = {})
|
|
17
|
-
attributes = { code
|
|
16
|
+
attributes = { code:, client_id:, client_secret:, grant_type: "authorization_code" }
|
|
18
17
|
attributes[:state] = options.delete(:state) if options.key?(:state)
|
|
19
18
|
attributes[:redirect_uri] = options.delete(:redirect_uri) if options.key?(:redirect_uri)
|
|
20
19
|
response = client.post(Client.versioned("/oauth/access_token"), attributes, options)
|
|
@@ -45,7 +44,6 @@ module Dnsimple
|
|
|
45
44
|
end
|
|
46
45
|
url.to_s
|
|
47
46
|
end
|
|
48
|
-
|
|
49
47
|
end
|
|
50
48
|
end
|
|
51
49
|
end
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
module Dnsimple
|
|
4
4
|
class Client
|
|
5
5
|
module Registrar
|
|
6
|
-
|
|
7
6
|
# Checks whether a domain is available to be registered.
|
|
8
7
|
#
|
|
9
8
|
# @see https://developer.dnsimple.com/v2/registrar/#check
|
|
@@ -11,9 +10,9 @@ module Dnsimple
|
|
|
11
10
|
# @example Check whether example.com is available:
|
|
12
11
|
# client.registrar.check_domain(1010, "example.com")
|
|
13
12
|
#
|
|
14
|
-
# @param [Integer]
|
|
15
|
-
# @param [#to_s]
|
|
16
|
-
# @param [Hash]
|
|
13
|
+
# @param account_id [Integer] the account ID
|
|
14
|
+
# @param domain_name [#to_s] the domain name to check
|
|
15
|
+
# @param options [Hash]
|
|
17
16
|
# @return [Struct::DomainCheck]
|
|
18
17
|
#
|
|
19
18
|
# @raise [RequestError] When the request fails.
|
|
@@ -30,9 +29,9 @@ module Dnsimple
|
|
|
30
29
|
# @example Check prices for example.com:
|
|
31
30
|
# client.registrar.get_domain_prices(1010, "example.com")
|
|
32
31
|
#
|
|
33
|
-
# @param [Integer]
|
|
34
|
-
# @param [String]
|
|
35
|
-
# @param [Hash]
|
|
32
|
+
# @param account_id [Integer] the Account id
|
|
33
|
+
# @param domain_name [String] the domain name to find the prices
|
|
34
|
+
# @param options [Hash]
|
|
36
35
|
#
|
|
37
36
|
# @return [Struct::DomainPrice]
|
|
38
37
|
#
|
|
@@ -52,10 +51,10 @@ module Dnsimple
|
|
|
52
51
|
# including WHOIS privacy for the domain and enabling auto renewal:
|
|
53
52
|
# client.registrar.register_domain(1010, "example.com", registrant_id: 1234, private_whois: true, auto_renew: true)
|
|
54
53
|
#
|
|
55
|
-
# @param [Integer]
|
|
56
|
-
# @param [#to_s]
|
|
57
|
-
# @param [Hash]
|
|
58
|
-
# @param [Hash]
|
|
54
|
+
# @param account_id [Integer] the account ID
|
|
55
|
+
# @param domain_name [#to_s] the domain name to register
|
|
56
|
+
# @param attributes [Hash]
|
|
57
|
+
# @param options [Hash]
|
|
59
58
|
# @return [Struct::DomainRegistration]
|
|
60
59
|
#
|
|
61
60
|
# @raise [RequestError] When the request fails.
|
|
@@ -74,10 +73,10 @@ module Dnsimple
|
|
|
74
73
|
# @example Retrieve the registration 42 for example.com:
|
|
75
74
|
# client.registrar.get_domain_registration(1010, "example.com", 42)
|
|
76
75
|
#
|
|
77
|
-
# @param [Integer]
|
|
78
|
-
# @param [#to_s]
|
|
79
|
-
# @param [Integer]
|
|
80
|
-
# @param [Hash]
|
|
76
|
+
# @param account_id [Integer] the account ID
|
|
77
|
+
# @param domain_name [#to_s] the domain name
|
|
78
|
+
# @param domain_registration_id [Integer] the domain registration ID
|
|
79
|
+
# @param options [Hash]
|
|
81
80
|
# @return [Struct::DomainRegistration]
|
|
82
81
|
#
|
|
83
82
|
# @raise [NotFoundError] When record is not found.
|
|
@@ -96,10 +95,10 @@ module Dnsimple
|
|
|
96
95
|
# @example Renew example.com for 3 years:
|
|
97
96
|
# client.registrar.renew_domain(1010, "example.com", period: 3)
|
|
98
97
|
#
|
|
99
|
-
# @param [Integer]
|
|
100
|
-
# @param [#to_s]
|
|
101
|
-
# @param [Hash]
|
|
102
|
-
# @param [Hash]
|
|
98
|
+
# @param account_id [Integer] the account ID
|
|
99
|
+
# @param domain_name [#to_s] the domain name to renew
|
|
100
|
+
# @param attributes [Hash]
|
|
101
|
+
# @param options [Hash]
|
|
103
102
|
# @return [Struct::DomainRenewal]
|
|
104
103
|
#
|
|
105
104
|
# @raise [RequestError] When the request fails.
|
|
@@ -117,10 +116,10 @@ module Dnsimple
|
|
|
117
116
|
# @example Retrieve the renewal 42 for example.com:
|
|
118
117
|
# client.registrar.get_domain_renewal(1010, "example.com", 42)
|
|
119
118
|
#
|
|
120
|
-
# @param [Integer]
|
|
121
|
-
# @param [#to_s]
|
|
122
|
-
# @param [Integer]
|
|
123
|
-
# @param [Hash]
|
|
119
|
+
# @param account_id [Integer] the account ID
|
|
120
|
+
# @param domain_name [#to_s] the domain name
|
|
121
|
+
# @param domain_renewal_id [Integer] the domain renewal ID
|
|
122
|
+
# @param options [Hash]
|
|
124
123
|
# @return [Struct::DomainRenewal]
|
|
125
124
|
#
|
|
126
125
|
# @raise [NotFoundError] When record is not found.
|
|
@@ -139,10 +138,10 @@ module Dnsimple
|
|
|
139
138
|
# @example Initiate the transfer for example.com using the contact 1234 as registrant:
|
|
140
139
|
# client.registrar.transfer_domain(1010, "example.com", registrant_id: 1234, auth_code: "x1y2z3")
|
|
141
140
|
#
|
|
142
|
-
# @param [Integer]
|
|
143
|
-
# @param [#to_s]
|
|
144
|
-
# @param [Hash]
|
|
145
|
-
# @param [Hash]
|
|
141
|
+
# @param account_id [Integer] the account ID
|
|
142
|
+
# @param domain_name [#to_s] the domain name to transfer
|
|
143
|
+
# @param attributes [Hash]
|
|
144
|
+
# @param options [Hash]
|
|
146
145
|
# @return [Struct::DomainTransfer]
|
|
147
146
|
#
|
|
148
147
|
# @raise [RequestError] When the request fails.
|
|
@@ -161,10 +160,10 @@ module Dnsimple
|
|
|
161
160
|
# @example Retrieve the transfer 42 for example.com:
|
|
162
161
|
# client.registrar.get_domain_transfer(1010, "example.com", 42)
|
|
163
162
|
#
|
|
164
|
-
# @param [Integer]
|
|
165
|
-
# @param [#to_s]
|
|
166
|
-
# @param [Integer]
|
|
167
|
-
# @param [Hash]
|
|
163
|
+
# @param account_id [Integer] the account ID
|
|
164
|
+
# @param domain_name [#to_s] the domain name
|
|
165
|
+
# @param domain_transfer_id [Integer] the domain transfer ID
|
|
166
|
+
# @param options [Hash]
|
|
168
167
|
# @return [Struct::DomainTransfer]
|
|
169
168
|
#
|
|
170
169
|
# @raise [NotFoundError] When record is not found.
|
|
@@ -183,10 +182,10 @@ module Dnsimple
|
|
|
183
182
|
# @example Cancel the transfer 42 for example.com:
|
|
184
183
|
# client.registrar.cancel_domain_transfer(1010, "example.com", 42)
|
|
185
184
|
#
|
|
186
|
-
# @param [Integer]
|
|
187
|
-
# @param [#to_s]
|
|
188
|
-
# @param [Integer]
|
|
189
|
-
# @param [Hash]
|
|
185
|
+
# @param account_id [Integer] the account ID
|
|
186
|
+
# @param domain_name [#to_s] the domain name
|
|
187
|
+
# @param domain_transfer_id [Integer] the domain transfer ID
|
|
188
|
+
# @param options [Hash]
|
|
190
189
|
# @return [Struct::DomainTransfer]
|
|
191
190
|
#
|
|
192
191
|
# @raise [NotFoundError] When record is not found.
|
|
@@ -205,9 +204,9 @@ module Dnsimple
|
|
|
205
204
|
# @example Request to transfer of example.com out of DNSimple:
|
|
206
205
|
# client.registrar.transfer_domain_out(1010, "example.com")
|
|
207
206
|
#
|
|
208
|
-
# @param [Integer]
|
|
209
|
-
# @param [#to_s]
|
|
210
|
-
# @param [Hash]
|
|
207
|
+
# @param account_id [Integer] the account ID
|
|
208
|
+
# @param domain_name [#to_s] the domain name to transfer out
|
|
209
|
+
# @param options [Hash]
|
|
211
210
|
# @return [Dnsimple::Response<nil>]
|
|
212
211
|
#
|
|
213
212
|
# @raise [RequestError] When the request fails.
|
|
@@ -225,10 +224,10 @@ module Dnsimple
|
|
|
225
224
|
# @example Restore example.com:
|
|
226
225
|
# client.registrar.restore_domain(1010, "example.com", {})
|
|
227
226
|
#
|
|
228
|
-
# @param [Integer]
|
|
229
|
-
# @param [#to_s]
|
|
230
|
-
# @param [Hash]
|
|
231
|
-
# @param [Hash]
|
|
227
|
+
# @param account_id [Integer] the account ID
|
|
228
|
+
# @param domain_name [#to_s] the domain name to restore
|
|
229
|
+
# @param attributes [Hash]
|
|
230
|
+
# @param options [Hash]
|
|
232
231
|
# @return [Struct::DomainRestore]
|
|
233
232
|
#
|
|
234
233
|
# @raise [RequestError] When the request fails.
|
|
@@ -246,10 +245,10 @@ module Dnsimple
|
|
|
246
245
|
# @example Retrieve the restore 42 for example.com:
|
|
247
246
|
# client.registrar.get_domain_restore(1010, "example.com", 42)
|
|
248
247
|
#
|
|
249
|
-
# @param [Integer]
|
|
250
|
-
# @param [#to_s]
|
|
251
|
-
# @param [Integer]
|
|
252
|
-
# @param [Hash]
|
|
248
|
+
# @param account_id [Integer] the account ID
|
|
249
|
+
# @param domain_name [#to_s] the domain name
|
|
250
|
+
# @param domain_restore_id [Integer] the domain restore ID
|
|
251
|
+
# @param options [Hash]
|
|
253
252
|
# @return [Struct::DomainRestore]
|
|
254
253
|
#
|
|
255
254
|
# @raise [NotFoundError] When record is not found.
|
|
@@ -260,7 +259,6 @@ module Dnsimple
|
|
|
260
259
|
|
|
261
260
|
Dnsimple::Response.new(response, Struct::DomainRestore.new(response["data"]))
|
|
262
261
|
end
|
|
263
|
-
|
|
264
262
|
end
|
|
265
263
|
end
|
|
266
264
|
end
|
|
@@ -3,14 +3,13 @@
|
|
|
3
3
|
module Dnsimple
|
|
4
4
|
class Client
|
|
5
5
|
module RegistrarAutoRenewal
|
|
6
|
-
|
|
7
6
|
# Enable auto renewal for the domain in the account.
|
|
8
7
|
#
|
|
9
8
|
# @see https://developer.dnsimple.com/v2/registrar/auto-renewal/
|
|
10
9
|
#
|
|
11
|
-
# @param [Integer]
|
|
12
|
-
# @param [#to_s]
|
|
13
|
-
# @param [Hash]
|
|
10
|
+
# @param account_id [Integer] the account ID
|
|
11
|
+
# @param domain_name [#to_s] the domain name
|
|
12
|
+
# @param options [Hash]
|
|
14
13
|
# @return [Dnsimple::Response<nil>]
|
|
15
14
|
#
|
|
16
15
|
# @raise [Dnsimple::NotFoundError]
|
|
@@ -25,9 +24,9 @@ module Dnsimple
|
|
|
25
24
|
#
|
|
26
25
|
# @see https://developer.dnsimple.com/v2/registrar/auto-renewal/
|
|
27
26
|
#
|
|
28
|
-
# @param [Integer]
|
|
29
|
-
# @param [#to_s]
|
|
30
|
-
# @param [Hash]
|
|
27
|
+
# @param account_id [Integer] the account ID
|
|
28
|
+
# @param domain_name [#to_s] the domain name
|
|
29
|
+
# @param options [Hash]
|
|
31
30
|
# @return [Dnsimple::Response<nil>]
|
|
32
31
|
#
|
|
33
32
|
# @raise [Dnsimple::NotFoundError]
|
|
@@ -37,7 +36,6 @@ module Dnsimple
|
|
|
37
36
|
|
|
38
37
|
Dnsimple::Response.new(response, nil)
|
|
39
38
|
end
|
|
40
|
-
|
|
41
39
|
end
|
|
42
40
|
end
|
|
43
41
|
end
|