gandi_v5 0.8.0 → 0.10.1

data/lib/gandi_v5/domain/web_forwarding.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    # Manage web forwarding.
+    # @!attribute [r] created_at
+    #   @return [Time, nil]
+    # @!attribute [r] updated_at
+    #   @return [Time, nil]
+    # @!attribute [r] type
+    #   @return [:cloak, :http301, :http302]
+    # @!attribute [r] fqdn
+    #   @return [String]
+    # @!attribute [r] protocol
+    #   @return [:http, :https, :https_only, nil]
+    # @!attribute [r] target
+    #   @return [String]
+    # @!attribute [r] cert_status
+    #   @return [String, nil]
+    # @!attribute [r] cert_uuid
+    #   @return [String, nil]
+    class WebForwarding
+      include GandiV5::Data
+
+      members :cert_uuid, :cert_status
+      member :target, gandi_key: 'url'
+      member :fqdn, gandi_key: 'host'
+      member :type, converter: GandiV5::Data::Converter::Symbol
+      member :created_at, converter: GandiV5::Data::Converter::Time
+      member :updated_at, converter: GandiV5::Data::Converter::Time
+      member(
+        :protocol,
+        converter: GandiV5::Data::Converter.new(
+          from_gandi: lambda { |value|
+            {
+              'http' => :http,
+              'https' => :https,
+              'httpsonly' => :https_only
+            }.fetch(value)
+          }
+        )
+      )
+
+      # Update the redirection in Gandi.
+      # @see https://api.gandi.net/docs/domains/#patch-v5-domain-domains-domain-webredirs-host
+      # @param target [String, #to_s] the url to redirect to (e.g. www.example.com/path).
+      # @param protocol [:http, :https, :https_only]
+      # @param type [:cloak, :http301, :http302]
+      # @param override [Boolean] If true, a DNS record will be created.
+      #   When the value is false and no matching DNS record exists, it will trigger an error.
+      # @return [GandiV5::Domain::WebRedirection]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error
+      def update(target: nil, protocol: nil, type: nil, override: nil)
+        body = {}
+        body['url'] = target.to_s unless target.nil?
+        body['protocol'] = protocol.to_s.delete('_') unless protocol.nil?
+        body['type'] = type.to_s unless type.nil?
+        body['override'] = override unless override.nil?
+
+        GandiV5.patch url, body.to_json
+        refresh
+      end
+
+      # Delete this web redirection from Gandi.
+      # @see https://api.gandi.net/docs/domains/#delete-v5-domain-domains-domain-webredirs-host
+      # @return [String] The confirmation message from Gandi.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def delete
+        _response, data = GandiV5.delete url
+        data['message']
+      end
+
+      # Check if this is an HTTP 301 (permanent) redirection.
+      def http301?
+        type == :http301
+      end
+
+      # Check if this is an HTTP 302 (found) redirection.
+      def http302?
+        type == :http302
+      end
+
+      # Check if this is an HTTP 301 (permanent) redirection.
+      def permanent?
+        type == :http301
+      end
+
+      # Check if this is an HTTP 302 (found) redirection.
+      def found?
+        type == :http302
+      end
+
+      # Check if this is a temporary redirection.
+      def temporary?
+        type == :http302
+      end
+
+      # Check if it's an http end point
+      def http?
+        protocol == :http || protocol == :https
+      end
+
+      # Check if it's an https end point
+      def https?
+        protocol == :https || protocol == :https_only
+      end
+
+      # Check if it's an https only
+      def https_only?
+        protocol == :https_only
+      end
+
+      # Create a new web redirection.
+      # @see https://api.gandi.net/docs/domains/#post-v5-domain-domains-domain-webredirs
+      # @param domain [String, #to_s] the domain name to create the redirection in.
+      # @param host [String, #to_s] the host name to redirect from.
+      # @param target [String, #to_s] the url to redirect to (e.g. www.example.com/path).
+      # @param protocol [:http, :https, :https_only]
+      # @param type [:cloak, :http301, :http302]
+      # @param override [Boolean] When you create a redirection on a domain, a DNS record is created
+      #   if it does not exist. When the record already exists and this parameter is set to true it
+      #   will overwrite the record. Otherwise it will trigger an error.
+      # @return [GandiV5::Domain::WebRedirection] the created redirection
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error
+      def self.create(domain:, host:, target:, protocol:, type:, override: false)
+        body = {
+          'host' => host.to_s,
+          'protocol' => protocol.to_s.delete('_'),
+          'type' => type.to_s,
+          'url' => target.to_s,
+          'override' => override
+        }.to_json
+
+        GandiV5.post url(domain), body
+        fetch domain, host
+      end
+
+      # Get web redirect for a host in a domain.
+      # @see https://api.gandi.net/docs/domains/#get-v5-domain-domains-domain-webredirs-host
+      # @param domain [String, #to_s] the domain to get the web redirection for.
+      # @param host [String, #to_s] the host name to get the web redirection for.
+      # @return [GandiV5::Domain::WebRedirect]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.fetch(domain, host)
+        _response, data = GandiV5.get url(domain, host)
+        redirect = from_gandi data
+        redirect.instance_exec { @domain = domain }
+        redirect
+      end
+
+      # List web redirects for a domain.
+      # @see https://api.gandi.net/docs/domains/#get-v5-domain-domains-domain-webredirs-host
+      # @param domain [String, #to_s] the domain to get the web redirections for.
+      # @param page [#each<Integer, #to_s>] the page(s) of results to retrieve.
+      #   If page is not provided keep querying until an empty list is returned.
+      #   If page responds to .each then iterate until an empty list is returned.
+      # @param per_page [Integer, #to_s] (optional default 100) how many results to get per page.
+      # @return [Array<GandiV5::Domain::WebRedirect>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.list(domain, page: (1..), per_page: 100)
+        redirects = []
+        GandiV5.paginated_get(url(domain), page, per_page) do |data|
+          redirects += data.map { |redirect| from_gandi redirect }
+        end
+        redirects.each { |redirect| redirect.instance_exec { @domain = domain } }
+        redirects
+      end
+
+      private
+
+      def url
+        "#{BASE}domain/domains/#{CGI.escape @domain}/webredirs/#{fqdn}"
+      end
+
+      def self.url(domain, host = nil)
+        "#{BASE}domain/domains/#{CGI.escape domain}/webredirs" +
+          (host ? "/#{CGI.escape host}.#{CGI.escape domain}" : '')
+      end
+      private_class_method :url
+    end
+  end
+end

data/lib/gandi_v5/domain.rb

@@ -7,7 +7,7 @@ class GandiV5
   #   @return [String] fully qualified domain name, written in its native alphabet (IDN).
   # @!attribute [r] fqdn_unicode
   #   @return [String] fully qualified domain name, written in unicode.
-  #     @see https://docs.gandi.net/en/domain_names/register/idn.html
+  #   @see https://docs.gandi.net/en/domain_names/register/idn.html
   # @!attribute [r] name_servers
   #   @return [Array<String>]
   # @!attribute [r] services
@@ -20,7 +20,7 @@ class GandiV5
   #   @return [String] one of: "clientHold", "clientUpdateProhibited", "clientTransferProhibited",
   #     "clientDeleteProhibited", "clientRenewProhibited", "serverHold", "pendingTransfer",
   #     "serverTransferProhibited"
-  #     @see https://docs.gandi.net/en/domain_names/faq/domain_statuses.html
+  #   @see https://docs.gandi.net/en/domain_names/faq/domain_statuses.html
   # @!attribute [r] tld
   #   @return [String]
   # @!attribute [r] dates
@@ -84,10 +84,10 @@ class GandiV5
       hash = hash.transform_keys(&:to_sym)
                  .transform_values { |value| GandiV5::Domain::Contact.from_gandi value }
 
-      hash.define_singleton_method(:owner) { send :'[]', :owner }
-      hash.define_singleton_method(:admin) { send :'[]', :admin }
-      hash.define_singleton_method(:bill) { send :'[]', :bill }
-      hash.define_singleton_method(:tech) { send :'[]', :tech }
+      hash.define_singleton_method(:owner) { send :[], :owner }
+      hash.define_singleton_method(:admin) { send :[], :admin }
+      hash.define_singleton_method(:bill) { send :[], :bill }
+      hash.define_singleton_method(:tech) { send :[], :tech }
 
       hash
     }
@@ -138,10 +138,8 @@ class GandiV5
 
     alias domain_uuid uuid
 
-    # rubocop:disable Style/AsciiComments
     # Returns the string representation of the domain.
     # @return [String] e.g. "example.com", "😀.com (xn--e28h.uk.com)"
-    # rubocop:enable Style/AsciiComments
     def to_s
       string = fqdn_unicode
       string += " (#{fqdn})" unless fqdn == fqdn_unicode
@@ -181,7 +179,7 @@ class GandiV5
         admin: admin.respond_to?(:to_gandi) ? admin.to_gandi : admin,
         bill: bill.respond_to?(:to_gandi) ? bill.to_gandi : bill,
         tech: tech.respond_to?(:to_gandi) ? tech.to_gandi : tech
-      }.reject { |_k, v| v.nil? }.to_json
+      }.compact { |_k, v| v.nil? }.to_json
 
       GandiV5.patch url('contacts'), body
       fetch_contacts
@@ -206,7 +204,7 @@ class GandiV5
     end
 
     # Renew domain.
-    # Warning! This is not a free operation. Please ensure your prepaid account has enough credit.
+    # @note This is not a free operation. Please ensure your prepaid account has enough credit.
     # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-renew
     # @param duration [Integer, #to_s] how long to renew for (in years).
     # @return [String] confirmation message from Gandi.
@@ -242,7 +240,7 @@ class GandiV5
     end
 
     # Restore an expired domain.
-    # Warning! This is not a free operation. Please ensure your prepaid account has enough credit.
+    # @note This is not a free operation. Please ensure your prepaid account has enough credit.
     # @see https://docs.gandi.net/en/domain_names/renew/restore.html
     # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-restore
     # @return [String] The confirmation message from Gandi.
@@ -252,6 +250,29 @@ class GandiV5
       data['message']
     end
 
+    # Lock this domain - preventing it from being transfered.
+    # @see https://api.gandi.net/docs/domains/#patch-v5-domain-domains-domain-status
+    # Most extensions have a transfer protection mechanism, that consists of a lock that can be put
+    # on the domain. When the transfer lock is enabled, the domain can't be transferred.
+    # @params lock [Boolean] whether the domain should be locked (true) or unlocked (false)
+    # @return [String] The confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    # rubocop:disable Style/OptionalBooleanParameter
+    def transfer_lock(lock = true)
+      _response, data = GandiV5.patch url('status'), { 'clientTransferProhibited' => lock }.to_json
+      @status = lock ? 'clientTransferProhibited' : nil
+      data['message']
+    end
+    # rubocop:enable Style/OptionalBooleanParameter
+
+    # Unlock this domain - allowing it to be transfered.
+    # @see https://api.gandi.net/docs/domains/#patch-v5-domain-domains-domain-status
+    # @return [String] The confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def transfer_unlock
+      transfer_lock false
+    end
+
     # Requery Gandi fo this domain's information.
     # @return [GandiV5::Domain]
     # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
@@ -399,23 +420,39 @@ class GandiV5
       data['message']
     end
 
+    # Get email mailboxes for the domain.
     # @see GandiV5::Email::Mailbox.list
     def mailboxes(**params)
       GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
     end
 
+    # Get email slots for the domain.
     # @see GandiV5::Email::Slot.list
     def mailbox_slots(**params)
       GandiV5::Email::Slot.list(**params, fqdn: fqdn)
     end
 
+    # Get email forwards for the domain.
     # @see GandiV5::Email::Forward.list
     def email_forwards(**params)
       GandiV5::Email::Forward.list(**params, fqdn: fqdn)
     end
 
+    # Get web forwardings for the domain.
+    # @see GandiV5::Domain::WebRedirection.list
+    def web_forwardings(**params)
+      GandiV5::Domain::WebForwarding.list(fqdn, **params)
+    end
+
+    # Get a web forwarding.
+    # @see GandiV5::Domain::WebRedirection.fetch
+    # @param host [String, #to_s] the host the redirection is setup on.
+    def web_forwarding(host)
+      GandiV5::Domain::WebForwarding.fetch(fqdn, host)
+    end
+
     # Create (register) a new domain.
-    # Warning! This is not a free operation. Please ensure your prepaid account has enough credit.
+    # @note This is not a free operation. Please ensure your prepaid account has enough credit.
     # @see https://api.gandi.net/docs/domains#post-v5-domain-domains
     # @param fqdn [String, #to_s] the fully qualified domain name to create.
     # @param dry_run [Boolean]
@@ -455,11 +492,13 @@ class GandiV5
     #   List of nameservers. Gandi's LiveDNS nameservers are used if omitted..
     # @param price [Numeric, #to_gandi, #to_json] (optional) unknown - not documented at Gandi.
     # @param resellee_id [String, #to_gandi, #to_json] (optional) unknown - not documented at Gandi.
+    # @param template_id [String, #to_gandi] (optional)
+    #   Template to be applied when the domain is created.
     # @param smd [String, #to_gandi, #to_json] (optional)
     #   Contents of a Signed Mark Data file (used for newgtld sunrises, tld_period must be sunrise).
     # @param tld_period ["sunrise", "landrush", "eap1", "eap2", "eap3", "eap4", "eap5", "eap6",
     #   "eap7", "eap8", "eap9", "golive", #to_gandi, #to_json] (optional)
-    #   @see https://docs.gandi.net/en/domain_names/register/new_gtld.html
+    # @see https://docs.gandi.net/en/domain_names/register/new_gtld.html
     # @return [GandiV5::Domain] the created domain
     # @return [Hash] if doing a dry run, you get what Gandi returns
     # @raise [GandiV5::Error::GandiError] if Gandi returns an error

data/lib/gandi_v5/email/forward.rb

@@ -77,7 +77,7 @@ class GandiV5
       # @return [Array<GandiV5::Email::Forward>]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def self.list(fqdn, page: (1..), per_page: 100, **params)
-        params.reject! { |_k, v| v.nil? }
+        params.compact! { |_k, v| v.nil? }
 
         mailboxes = []
         GandiV5.paginated_get(url(fqdn), page, per_page, params: params) do |data|

data/lib/gandi_v5/email/mailbox.rb

@@ -29,9 +29,9 @@ class GandiV5
 
       TYPES = %i[standard premium free].freeze
       QUOTAS = {
-        free: 3 * 1024**3,
-        standard: 3 * 1024**3,
-        premium: 50 * 1024**3
+        free: 3 * (1024**3),
+        standard: 3 * (1024**3),
+        premium: 50 * (1024**3)
       }.freeze
 
       members :address, :login, :quota_used, :aliases, :fallback_email
@@ -43,7 +43,7 @@ class GandiV5
       alias mailbox_uuid uuid
 
       # Create a new GandiV5::Email::Mailbox
-      # @param members [Hash<Symbol => Object>]
+      # @param members [Hash{Symbol => Object}]
       # @return [GandiV5::Email::Slot]
       def initialize(**members)
         super(**members)
@@ -199,7 +199,7 @@ class GandiV5
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def self.list(fqdn, page: (1..), per_page: 100, **params)
         params['~login'] = params.delete(:login)
-        params.reject! { |_k, v| v.nil? }
+        params.compact! { |_k, v| v.nil? }
 
         mailboxes = []
         GandiV5.paginated_get(url(fqdn), page, per_page, params: params) do |data|
@@ -265,7 +265,7 @@ class GandiV5
       def self.crypt_password(password)
         # You can also send a hashed password in sha512-crypt ie: {SHA512-CRYPT}$6$xxxx$yyyy
         salt = SecureRandom.random_number(36**8).to_s(36)
-        password.crypt('$6$' + salt)
+        password.crypt("$6$#{salt}")
       end
       private_class_method :crypt_password
 

data/lib/gandi_v5/email/slot.rb

@@ -29,7 +29,7 @@ class GandiV5
       member(
         :capacity,
         converter: GandiV5::Data::Converter.new(
-          from_gandi: ->(value) { value * 1_024**2 }
+          from_gandi: ->(value) { value * (1_024**2) }
         )
       )
       member :created_at, converter: GandiV5::Data::Converter::Time

data/lib/gandi_v5/email.rb

@@ -2,6 +2,9 @@
 
 class GandiV5
   # Gandi Email Mailbox Management API.
+  # @see https://api.gandi.net/docs/email/
+  # rubocop:disable Lint/EmptyClass
   class Email
   end
+  # rubocop:enable Lint/EmptyClass
 end

data/lib/gandi_v5/error/gandi_error.rb

@@ -5,6 +5,7 @@ class GandiV5
     # Generic error class for errors returned by Gandi.
     class GandiError < GandiV5::Error
       # Generate a new GandiV5::Error::GandiError from the hash returned by Gandi.
+      # @api private
       # @param hash [Hash] the hash returned by Gandi.
       # @return [GandiV5::Error::GandiError]
       def self.from_hash(hash)

data/lib/gandi_v5/live_dns/domain/dnssec_key.rb

@@ -4,27 +4,27 @@ class GandiV5
   class LiveDNS
     class Domain
       # A DNSSEC key for a domain's DNS records.
-      # @!attribyte [r] uuid
+      # @!attribute [r] uuid
       #   @return [String]
-      # @!attribyte [r] status
+      # @!attribute [r] status
       #   @return [String]
-      # @!attribyte [r] fqdn
+      # @!attribute [r] fqdn
       #   @return [String]
-      # @!attribyte [r] algorithm_id
+      # @!attribute [r] algorithm_id
       #   @return [Integer]
-      # @!attribyte [r] algorithm_name
+      # @!attribute [r] algorithm_name
       #   @return [String]
-      # @!attribyte [r] deleted
+      # @!attribute [r] deleted
       #   @return [Boolean]
-      # @!attribyte [r] ds
+      # @!attribute [r] ds
       #   @return [String]
-      # @!attribyte [r] flags
+      # @!attribute [r] flags
       #   @return [Integer]
-      # @!attribyte [r] fingerprint
+      # @!attribute [r] fingerprint
       #   @return [String]
-      # @!attribyte [r] public_key
+      # @!attribute [r] public_key
       #   @return [String]
-      # @!attribyte [r] tag
+      # @!attribute [r] tag
       #   @return [String]
       class DnssecKey
         include GandiV5::Data
@@ -36,6 +36,7 @@ class GandiV5
         member :algorithm_id, gandi_key: 'algorithm'
 
         # Delete this key.
+        # @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-keys-id
         # @return [String] The confirmation message from Gandi.
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
         def delete
@@ -45,6 +46,7 @@ class GandiV5
         end
 
         # Undelete this key.
+        # @see https://api.gandi.net/docs/livedns/#patch-v5-livedns-domains-fqdn-keys-id
         # @return [String] The confirmation message from Gandi.
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
         def undelete
@@ -66,6 +68,7 @@ class GandiV5
         end
 
         # Create a new DNSSEC key for a zone.
+        # @see https://api.gandi.net/docs/livedns/#post-v5-livedns-domains-fqdn-keys
         # @param fqdn [String, #to_s] the fully qualified domain to create the key for.
         # @param flags [Integer, :key_signing_key, :zone_signing_key] the key's flags.
         # @return [GandiV5::LiveDNS::Domain::DnssecKey]
@@ -80,6 +83,7 @@ class GandiV5
         end
 
         # Get keys for a FQDN from Gandi.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-keys
         # @param fqdn [String, #to_s] The fully qualified domain name to get the keys for.
         # @return [Array<GandiV5::LiveDNS::Domain::DnssecKey>]
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
@@ -89,6 +93,7 @@ class GandiV5
         end
 
         # Get DNSSEC key from Gandi.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-keys-id
         # @param fqdn [String, #to_s] The fully qualified domain name the key was made for.
         # @param uuid [String, #to_s] the UUID of the key to fetch.
         # @return [GandiV5::LiveDNS::Domain::DnssecKey]

data/lib/gandi_v5/live_dns/domain/snapshot.rb

@@ -30,6 +30,7 @@ class GandiV5
         alias snapshot_uuid uuid
 
         # Delete this snapshot.
+        # @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-snapshots-id
         # @return [String] The confirmation message from Gandi.
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
         def delete
@@ -38,6 +39,7 @@ class GandiV5
         end
 
         # Update this snapshot.
+        # @see https://api.gandi.net/docs/livedns/#patch-v5-livedns-domains-fqdn-snapshots-id
         # @param name [String, #to_s] new name for the snapshot.
         # @return [String] The confirmation message from Gandi.
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
@@ -48,6 +50,7 @@ class GandiV5
         end
 
         # Get snapshot details for this FQDN from Gandi.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-snapshots
         # @param fqdn [String, #to_s] The fully qualified domain name to get the snapshots for.
         # @param page [#each<Integer, #to_s>] the page(s) of results to retrieve.
         #   If page is not provided keep querying until an empty list is returned.
@@ -57,7 +60,7 @@ class GandiV5
         # @return [Array<GandiV5::LiveDNS::Domain::Snapshot>]
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
         def self.list(fqdn, page: (1..), per_page: 100, **params)
-          params.reject! { |_k, v| v.nil? }
+          params.compact! { |_k, v| v.nil? }
 
           snapshots = []
           GandiV5.paginated_get(url(fqdn), page, per_page, params: params) do |data|
@@ -67,6 +70,7 @@ class GandiV5
         end
 
         # Get snapshot from Gandi.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-snapshots-id
         # @param fqdn [String, #to_s] The fully qualified domain name the snapshot was made for.
         # @param uuid [String, #to_s] the UUID of the snapshot to fetch.
         # @return [GandiV5::LiveDNS::Domain::Snapshot]

data/lib/gandi_v5/live_dns/domain/tsig_key.rb

@@ -4,13 +4,13 @@ class GandiV5
   class LiveDNS
     class Domain
       # A Tsig key.
-      # @!attribyte [r] uuid
+      # @!attribute [r] uuid
       #   @return [String]
-      # @!attribyte [r] name
+      # @!attribute [r] name
       #   @return [String]
-      # @!attribyte [r] secret
+      # @!attribute [r] secret
       #   @return [String]
-      # @!attribyte [r] config_examples
+      # @!attribute [r] config_examples
       #   @return [Hash<Symbol -> String>]
       class TsigKey
         include GandiV5::Data
@@ -23,11 +23,12 @@ class GandiV5
           gandi_key: 'config_samples',
           converter: GandiV5::Data::Converter.new(
             from_gandi: ->(value) { value.transform_keys(&:to_sym) },
-            to_gandi: ->(_value) { nil }
+            to_gandi: ->(_value) {}
           )
         )
 
         # Create a new DNSSEC key for a zone.
+        # @see https://api.gandi.net/docs/livedns/#post-v5-livedns-axfr-tsig
         # @param sharing_id [nil, String, #to_s]
         # @return [GandiV5::LiveDNS::Domain::DnssecKey]
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
@@ -42,6 +43,7 @@ class GandiV5
         # Get keys from Gandi.
         # If you need the secret, fingerprint, public_key or tag attributes you'll need
         # to use GandiV5::LiveDNS::Domain::DnssecKey.fetch on each item.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-axfr-tsig
         # @return [Array<GandiV5::LiveDNS::Domain::TsigKey>]
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
         def self.list
@@ -50,6 +52,7 @@ class GandiV5
         end
 
         # Get Tsig key from Gandi.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-axfr-tsig-id
         # @param uuid [String, #to_s] the UUID of the key to fetch.
         # @return [GandiV5::LiveDNS::Domain::TsigKey]
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.