gandi_v5 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 023623b5d81a2f3acc4a5fee812f0e8ca24dd8735f59a0f12b53ad35ddb7a397
-  data.tar.gz: 3cf89099c45295da9b06a53ad64b601b3a77525a13ddade403d600c382be02d3
+  metadata.gz: 6873be5c700e1ef88075c90b71361bb9568b11661661dd0bc4f7d77cfdefd6f0
+  data.tar.gz: 13aac04c42357193607cff0f55c0502253fb6b527475e40ad5cb5d53011268ce
 SHA512:
-  metadata.gz: 5e816b9de44330c832f6591ca6724b44f5b05c6fab53d8fda6d13a9820211292f29ee608953d8a562da97f4bcfee38f24f799b4a68184bba2b0ec751d21b3f61
-  data.tar.gz: 622bded49d8bae3129ad74fae6fcaf1e8d7c3639b40348b7537e0ba46a3d5c668d2a134754dcf1ff31bcffe3cf0797f5c4368cbc849c386b4648f850d9e24117
+  metadata.gz: 46afb560fe574db5bf9d47e3e5bbce0843acef12edd132e26cba685608e4b1fa2dc1579dc30e287128ef6462924d56c14856168bcc2d277dededbf9360c45d0b
+  data.tar.gz: 9e35714cdb2ad68d57d11f4bdd689a6fc0103d155827682bb6a2f66340e8054af328761827f13e7af857c5c41263568daed84805e20b90e5b580917dea502eab

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Gandi V5 API Gem Changelog
 
+## Version 0.7.0
+
+* LiveDNS:
+  * Rename LiveDNS::RecordSet to LiveDNS::Domain::Record
+  * Domains:
+    * .list now returns an array of strings
+    * Can no longer change the zone used by a domain
+    * Added automatic_snapshots attribute for whether snapshots are automatically created when a modification is made to this domain's records
+    * #replace_records and #replace_records_for merged into #replace_records
+      * If replacing with a zone file use the new #replace_zone_lines
+    * Added:
+      * .create
+      * .record_types
+      * .generic_name_servers(fqdn)
+      * #name_servers and #fetch_name_servers
+      * #tsig_keys, #fetch_tsig_keys, #add_tsig_key, #remove_tsig_key
+      * #axfr_clients, #fetch_axfr_clients, #add_axfr_client, #remove_axfr_client
+      * ::DnssecKeys, #dnssec_keys, #fetch_dnssec_keys
+  * Snapshots:
+    * Moved to live under LiveDNS::Domain not LiveDNS::Zone
+    * Are now accessed via the fully qualified domain name NOT the zone's UUID
+    * Ability to access the zone from a snapshot is removed
+    * Taking a snapshot now allows for named snapshots
+    * Added automatic attribute for when a snapshot was taken due to a zone change
+    * .list now returns an array of snapshots (records are fetched in a seperate request when first needed)
+  * Zone removed.
+
 ## Version 0.6.0
 
 * GandiV5::Email::Slot.create now supports sharing_id

data/README.md

@@ -36,12 +36,12 @@ Details of the API can be found at:
 If you're using bundler then add it to your Gemfile and run the bundle command.
 
 ```ruby
-gem 'gandi_v5', '~> 0.1'
+gem 'gandi_v5', '~> 0.7'
 ```
 
 If you're not using bundler then install it from the command line.
 ```bash
-gem install gandi_v5 -v '~> 0.1'
+gem install gandi_v5 -v '~> 0.7'
 ```
 
 ## Usage
@@ -77,6 +77,7 @@ We follow the [Semantic Versioning](http://semver.org/) concept.
 
 | Gem Version     | Gandi API Release Date   |
 | --------------- | ------------------------ |
+| 0.7.0           | 2020-05-07               |
 | 0.6.0           | 2020-05-07 (not LiveDNS) |
 | 0.5.0           | 2019-10-01               |
 | 0.4.0           | 2019-10-01               |

data/lib/gandi_v5.rb

@@ -82,6 +82,36 @@ class GandiV5
       handle_bad_request(e)
     end
 
+    # Might raise:
+    #  * RestClient::NotFound
+    #  * RestClient::Unauthorized
+    #      Bad authentication attempt because of a wrong API Key.
+    #  * RestClient::Forbidden
+    #      Access to the resource is denied.
+    #      Mainly due to a lack of permissions to access it.
+    #  * GandiV5::Error
+    #  * JSON::ParserError
+    def paginated_get(url, page = (1..), per_page = 100, **headers)
+      unless page.respond_to?(:each)
+        fail ArgumentError, 'page must be positive' unless page.positive?
+
+        page = [page]
+      end
+
+      headers[:params] ||= {}
+      headers[:params].transform_keys!(&:to_s)
+      headers[:params]['per_page'] = per_page
+
+      page.each do |page_number|
+        headers[:params]['page'] = page_number
+        _resp, this_data = get(url, **headers)
+        break if this_data.empty?
+
+        yield this_data
+        break if this_data.count < per_page
+      end
+    end
+
     # Might raise:
     #  * RestClient::NotFound
     #  * RestClient::Unauthorized
@@ -169,16 +199,6 @@ class GandiV5
       @api_key ||= ENV.fetch('GANDI_API_KEY')
     end
 
-    def authorisation_header(url)
-      if url.start_with?(BASE)
-        { Authorization: "Apikey #{api_key}" }
-      elsif url.start_with?(GandiV5::LiveDNS::BASE)
-        { 'X-Api-Key': api_key }
-      else
-        fail ArgumentError, "Don't know how to authorise for url: #{url}"
-      end
-    end
-
     def parse_response(response)
       type = response.headers.fetch(:content_type).split(';').first.chomp
       case type
@@ -196,10 +216,11 @@ class GandiV5
       end
     end
 
-    def prepare_headers(headers, url)
-      headers.transform_keys!(&:to_sym)
+    def prepare_headers(headers, _url)
+      headers.transform_keys! { |key| key.to_s.downcase.to_sym }
       headers[:accept] ||= 'application/json'
-      headers.merge!(authorisation_header(url))
+      headers[:authorization] = "Apikey #{api_key}"
+      headers
     end
 
     def handle_bad_request(exception)

data/lib/gandi_v5/domain.rb

@@ -492,7 +492,7 @@ class GandiV5
     # @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 ot get per page.
+    # @param per_page [Integer, #to_s] (optional default 100) how many results to get per page.
     # @param fqdn [String, #to_s] (optional)
     #   filters the list by domain name, with optional patterns.
     #   e.g. "example.net", "example.*", "*ample.com"
@@ -501,15 +501,9 @@ class GandiV5
     # @return [Array<GandiV5::Domain>]
     # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def self.list(page: (1..), per_page: 100, **params)
-      page = [page.to_i] unless page.respond_to?(:each)
-
       domains = []
-      page.each do |page_number|
-        _resp, data = GandiV5.get url, params: params.merge(page: page_number, per_page: per_page)
-        break if data.empty?
-
+      GandiV5.paginated_get(url, page, per_page, params: params) do |data|
         domains += data.map { |domain| from_gandi domain }
-        break if data.count < per_page
       end
       domains
     end

data/lib/gandi_v5/email/forward.rb

@@ -76,18 +76,12 @@ class GandiV5
       #   e.g. ("alice" "*lice", "alic*").
       # @return [Array<GandiV5::Email::Forward>]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def self.list(fqdn, page: (1..), **params)
-        page = [page.to_i] unless page.respond_to?(:each)
-
+      def self.list(fqdn, page: (1..), per_page: 100, **params)
         params.reject! { |_k, v| v.nil? }
 
         mailboxes = []
-        page.each do |page_number|
-          _response, data = GandiV5.get url(fqdn), params: params.merge(page: page_number)
-          break if data.empty?
-
+        GandiV5.paginated_get(url(fqdn), page, per_page, params: params) do |data|
           mailboxes += data.map { |mailbox| from_gandi mailbox.merge(fqdn: fqdn) }
-          break if data.count < params.fetch(:per_page, 100)
         end
         mailboxes
       end

data/lib/gandi_v5/email/mailbox.rb

@@ -197,19 +197,13 @@ class GandiV5
       #   e.g. ("alice" "*lice", "alic*").
       # @return [Array<GandiV5::Email::Mailbox>]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def self.list(fqdn, page: (1..), **params)
-        page = [page.to_i] unless page.respond_to?(:each)
-
+      def self.list(fqdn, page: (1..), per_page: 100, **params)
         params['~login'] = params.delete(:login)
         params.reject! { |_k, v| v.nil? }
 
         mailboxes = []
-        page.each do |page_number|
-          _response, data = GandiV5.get url(fqdn), params: params.merge(page: page_number)
-          break if data.empty?
-
+        GandiV5.paginated_get(url(fqdn), page, per_page, params: params) do |data|
           mailboxes += data.map { |mailbox| from_gandi mailbox }
-          break if data.count < params.fetch(:per_page, 100)
         end
         mailboxes
       end

data/lib/gandi_v5/live_dns.rb

@@ -4,8 +4,6 @@
 class GandiV5
   # Gandi LiveDNS Management API.
   class LiveDNS
-    BASE = 'https://dns.api.gandi.net/api/v5/'
-
     RECORD_TYPES = %w[
       A AAAA CNAME MX NS TXT ALIAS
       WKS SRV LOC SPF CAA DS SSHFP PTR KEY DNAME TLSA OPENPGPKEY CDS
@@ -21,16 +19,6 @@ class GandiV5
       GandiV5::LiveDNS::Domain.list
     end
 
-    # @see GandiV5::LiveDNS::Zone.fetch
-    def self.zone(uuid)
-      GandiV5::LiveDNS::Zone.fetch(uuid)
-    end
-
-    # @see GandiV5::LiveDNS::Zone.list
-    def self.zones
-      GandiV5::LiveDNS::Zone.list
-    end
-
     # Raise an error if passed type is invalid.
     # @param type [String] the record type to check.
     # @return [nil]

data/lib/gandi_v5/live_dns/domain.rb

@@ -5,19 +5,12 @@ class GandiV5
     # A domain name within the LiveDNS system.
     # @!attribute [r] fqdn
     #   @return [String]
-    # @!attribute [r] zone_uuid
-    #   @return [String]
+    # @!attribute [r] automatic_snapshots
+    #   @return [Boolean]
     class Domain
       include GandiV5::Data
-      include GandiV5::LiveDNS::HasZoneRecords
-
-      members :fqdn
 
-      member(
-        :zone_uuid,
-        gandi_key: 'zone',
-        converter: GandiV5::Data::Converter.new(from_gandi: ->(zone) { zone&.split('/')&.last })
-      )
+      members :fqdn, :automatic_snapshots
 
       # Refetch the information for this domain from Gandi.
       # @return [GandiV5::LiveDNS::Domain]
@@ -27,35 +20,283 @@ class GandiV5
         from_gandi data
       end
 
-      # Change the zone used by this domain.
-      # @param uuid [String, #uuid, #to_s] the UUID of the zone this domain should now use.
+      # Update this domain's settings.
+      # @param automatic_snapshots [String, #to_s]
+      #   Enable or disable the automatic creation of new snapshots when records are changed.
       # @return [String] The confirmation message from Gandi.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def change_zone(uuid)
-        uuid = uuid.uuid if uuid.respond_to?(:uuid)
-        _response, data = GandiV5.patch url, { zone_uuid: uuid }.to_json
-        self.zone_uuid = uuid
+      def update(automatic_snapshots:)
+        _response, data = GandiV5.patch url, { automatic_snapshots: automatic_snapshots }.to_json
+        self.automatic_snapshots = automatic_snapshots
         data['message']
       end
 
-      # @see GandiV5::LiveDNS::Zone.fetch
-      def fetch_zone
-        GandiV5::LiveDNS::Zone.fetch zone_uuid
+      # @overload fetch_records()
+      #   Fetch all records for this domain.
+      #   @param page [Integer, #each<Integer>] which page(s) of results to get.
+      #     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 ot get per page.
+      # @overload fetch_records(name)
+      #   Fetch records for a name.
+      #   @param name [String] the name to fetch records for.
+      #   @param page [Integer, #each<Integer>] which page(s) of results to get.
+      #     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 ot get per page.
+      # @overload fetch_records(name, type)
+      #   Fetch records of a type for a name.
+      #   @param name [String] the name to fetch records for.
+      #   @param type [String] the record type to fetch.
+      #   @param page [Integer, #each<Integer>] which page(s) of results to get.
+      #     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 ot get per page.
+      # @return [Array<GandiV5::LiveDNS::Domain::Record>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def fetch_records(name = nil, type = nil, page: (1..), per_page: 100)
+        GandiV5::LiveDNS.require_valid_record_type type if type
+
+        url_ = "#{url}/records"
+        url_ += "/#{CGI.escape name}" if name
+        url_ += "/#{CGI.escape type}" if type
+
+        all = []
+        GandiV5.paginated_get(url_, page, per_page) do |data|
+          all += [*data].map { |item| GandiV5::LiveDNS::Domain::Record.from_gandi item }
+        end
+        all
       end
 
-      # The domain's zone (fetching from Gandi if required).
-      # @return [GandiV5::LiveDNS::Zone]
+      # @overload fetch_zone_lines()
+      #   Fetch all records for this domain.
+      # @overload fetch_zone_lines(name)
+      #   Fetch records for a name.
+      #   @param name [String] the name to fetch records for.
+      # @overload fetch_zone_lines(name, type)
+      #   Fetch records of a type for a name.
+      #   @param name [String] the name to fetch records for.
+      #   @param type [String] the record type to fetch.
+      # @return [String]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def zone
-        @zone ||= fetch_zone
+      def fetch_zone_lines(name = nil, type = nil)
+        GandiV5::LiveDNS.require_valid_record_type type if type
+
+        url_ = "#{url}/records"
+        url_ += "/#{CGI.escape name}" if name
+        url_ += "/#{CGI.escape type}" if type
+
+        GandiV5.get(url_, accept: 'text/plain').last
+      end
+
+      # Add record to this domain.
+      # @param name [String]
+      # @param type [String]
+      # @param ttl [Integer]
+      # @param values [Array<String>]
+      # @return [String] The confirmation message from Gandi.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def add_record(name, type, ttl, *values)
+        GandiV5::LiveDNS.require_valid_record_type type
+        fail ArgumentError, 'ttl must be positive and non-zero' unless ttl.positive?
+        fail ArgumentError, 'there must be at least one value' if values.none?
+
+        body = {
+          rrset_name: name,
+          rrset_type: type,
+          rrset_ttl: ttl,
+          rrset_values: values
+        }.to_json
+        _response, data = GandiV5.post "#{url}/records", body
+        data['message']
+      end
+
+      # @overload delete_records()
+      #   Delete all records for this domain.
+      # @overload delete_records(name)
+      #   Delete records for a name.
+      #   @param name [String] the name to delete records for.
+      # @overload delete_records(name, type)
+      #   Delete records of a type for a name.
+      #   @param name [String] the name to delete records for.
+      #   @param type [String] the record type to delete.
+      # @return [nil]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def delete_records(name = nil, type = nil)
+        GandiV5::LiveDNS.require_valid_record_type(type) if type
+
+        url_ = "#{url}/records"
+        url_ += "/#{CGI.escape name}" if name
+        url_ += "/#{CGI.escape type}" if type
+        GandiV5.delete(url_).last
+      end
+
+      # Replace records for the domain.
+      #   @param name [String, nil] only replaces records for this name.
+      #   @param type [String, nil] only replaces record of this type (requires name).
+      #   @param values [Array<String>] the values to set for the record.
+      #   @raise [ArgumentError] if ttl is present and type is absent.
+      # @return [String] The confirmation message from Gandi.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      # rubocop:disable Metrics/PerceivedComplexity
+      def replace_records(records, name: nil, type: nil)
+        if type
+          GandiV5::LiveDNS.require_valid_record_type(type) if type
+          fail ArgumentError, 'missing keyword: name' if name.nil?
+        end
+
+        url_ = "#{url}/records"
+        url_ += "/#{CGI.escape name}" if name
+        url_ += "/#{CGI.escape type}" if type
+
+        body = if type && name
+                 { rrset_values: records }
+               else
+                 { items: records.map { |r| r.transform_keys { |k| "rrset_#{k}" } } }
+               end
+
+        _response, data = GandiV5.put url_, body.to_json
+        data['message']
+      end
+      # rubocop:enable Metrics/PerceivedComplexity
+
+      # Replace all records for this domain.
+      # @param text [String] zone file lines to replace the records with.
+      # @return [String] The confirmation message from Gandi.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def replace_zone_lines(text)
+        _response, data = GandiV5.put "#{url}/records", text, 'content-type': 'text/plain'
+        data['message']
+      end
+
+      # The list of nameservers that this domain is using according to LiveDNS' systems.
+      #  * Either there are no NS records on @ and the 3 hashed nameservers are returned
+      #    (ns-{123}-{abc}.gandi.net)
+      #  * Or some NS records exist on @ and it will return those
+      # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-name$
+      # @return [Array<String>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def name_servers
+        @name_servers ||= fetch_name_servers
+      end
+
+      # Requery Gandi for the domain's name servers.
+      # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-name$
+      # @return [Array<String>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def fetch_name_servers
+        _response, data = GandiV5.get "#{url}/nameservers"
+        @name_servers = data
+      end
+
+      # The list of DNSSEC keys for the domain.
+      # If you need the fingerprint, public_key or tag attributes you'll need
+      # use GandiV5::LiveDNS::Domain::DnssecKey.fetch on each item.
+      # @return [Array<GandiV5::LiveDNS::Domain::DnssecKey>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def dnssec_keys
+        @dnssec_keys ||= fetch_dnssec_keys
+      end
+
+      # Requery Gandi for the domain's DNSSEC keys.
+      # @return [Array<GandiV5::LiveDNS::Domain::DnssecKey>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def fetch_dnssec_keys
+        @dnssec_keys = GandiV5::LiveDNS::Domain::DnssecKey.list(fqdn)
+      end
+
+      # The list of TSIG keys for the domain.
+      # If you need the secret, fingerprint, public_key or tag attributes you'll need
+      # to use GandiV5::LiveDNS::Domain::DnssecKey.fetch on each item.
+      # @return [Array<GandiV5::LiveDNS::Domain::TsigKey>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def tsig_keys
+        @tsig_keys ||= fetch_tsig_keys
+      end
+
+      # Requery Gandi for the domain's TSIG keys.
+      # @return [Array<GandiV5::LiveDNS::Domain::TsigKey>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def fetch_tsig_keys
+        _response, data = GandiV5.get "#{url}/axfr/tsig"
+        data.map { |item| GandiV5::LiveDNS::Domain::TsigKey.from_gandi item }
+      end
+
+      # Add a Tsig key to this domain.
+      # @param key [GandiV5::LiveDNS::Domain::TsigKey, #uuid, String, #to_s]
+      #   the key to add.
+      # @param sharing_id [nil, String, #to_s]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def add_tsig_key(key, sharing_id: nil)
+        key = key.uuid if key.respond_to?(:uuid)
+        url_ = "#{url}/axfr/tsig/#{key}"
+        url_ += "?sharing_id=#{CGI.escape sharing_id}" if sharing_id
+        _response, _data = GandiV5.put url_
+      end
+
+      # Remove a Tsig key from this domain.
+      # @param key [GandiV5::LiveDNS::Domain::TsigKey, #uuid, String, #to_s]
+      #   the key to remove.
+      # @param sharing_id [nil, String, #to_s]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def remove_tsig_key(key, sharing_id: nil)
+        key = key.uuid if key.respond_to?(:uuid)
+        url_ = "#{url}/axfr/tsig/#{key}"
+        url_ += "?sharing_id=#{CGI.escape sharing_id}" if sharing_id
+        _response, _data = GandiV5.delete url_
+      end
+
+      # The list of AXFR clients for the domain.
+      # @return [Array<String>] list of IP addresses.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def axfr_clients
+        @axfr_clients ||= fetch_axfr_clients
+      end
+
+      # Requery Gandi for the domain's AXFR clients.
+      # @return [Array<String>] list of IP addresses.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def fetch_axfr_clients
+        _response, data = GandiV5.get "#{url}/axfr/slaves"
+        data
+      end
+
+      # Add an AXFR client to this domain.
+      # @param ip [String, #to_s] the IP address to add.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def add_axfr_client(ip)
+        _response, _data = GandiV5.put "#{url}/axfr/slaves/#{ip}"
+      end
+
+      # Remove and AXFR client from this domain.
+      # @param ip [String, #to_s] the IP address to remove.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def remove_axfr_client(ip)
+        _response, _data = GandiV5.delete "#{url}/axfr/slaves/#{ip}"
       end
 
       # List the domains.
-      # @return [Array<GandiV5::LiveDNS::Domain>]
+      # @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.
+      # @param sharing_id [String, #to_s] (optional) filter by domains assigned to a given user.
+      # @return [Array<String>]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def self.list
-        _response, data = GandiV5.get url
-        data.map { |item| from_gandi item }
+      def self.list(page: (1..), per_page: 100, sharing_id: nil)
+        page = [page.to_i] unless page.respond_to?(:each)
+        params = { per_page: per_page }
+        params[:sharing_id] = sharing_id unless sharing_id.nil?
+
+        domains = []
+        page.each do |page_number|
+          _resp, data = GandiV5.get url, params: params.merge(page: page_number)
+          break if data.empty?
+
+          domains += data.map { |item| item['fqdn'] }
+          break if data.count < per_page
+        end
+        domains
       end
 
       # Get a domain.
@@ -67,14 +308,57 @@ class GandiV5
         from_gandi data
       end
 
+      # Create a new domain in the LiveDNS system.
+      # You must have sufficent permission to manage the domain to do this.
+      # @param fqdn [String, #to_s] the fully qualified domain to add to LiveDNS.
+      # @param records [Array<Hash, GandiV5::LiveDNS::Domain::Record, #to_h, nil>]
+      # @param ttl [Integer, #to_s, nil] the TTL of the SOA record.
+      #   Note that this is not a default TTL that will be used for the records in the zone.
+      #   the records (if any) to add to the created zone.
+      # @param sharing_id [nil, String, #to_s]
+      # @return [GandiV5::LiveDNS::Domain]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.create(fqdn, records = nil, soa_ttl: nil, sharing_id: nil)
+        body = { fqdn: fqdn, zone: {} }
+        body[:zone][:ttl] = soa_ttl if soa_ttl
+        if records
+          body[:zone][:items] = records.map do |r|
+            r.to_h.transform_keys { |k| "rrset_#{k}" }
+          end
+        end
+
+        url_ = url
+        url_ += "?sharing_id=#{CGI.escape sharing_id}" if sharing_id
+
+        GandiV5.post url_, body.to_json
+        fetch(fqdn)
+      end
+
+      # Fetch the list of known record types (A, CNAME, etc.)
+      # @return [Array<String>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.record_types
+        GandiV5.get("#{BASE}livedns/dns/rrtypes").last
+      end
+
+      # Get the LiveDNS servers to use for a domain.
+      # Does not take into account any NS records that exist in the zone.
+      # @param fqdn [String, #to_s] the fully qualified domain to hash in
+      #   in order to get the LiveDNS servers to use.
+      # @return [Array<String>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.generic_name_servers(fqdn)
+        GandiV5.get("#{BASE}livedns/nameservers/#{CGI.escape fqdn}").last
+      end
+
       private
 
       def url
-        "#{BASE}domains/#{CGI.escape(fqdn)}"
+        "#{BASE}livedns/domains/#{CGI.escape fqdn}"
       end
 
       def self.url(fqdn = nil)
-        "#{BASE}domains" + (fqdn ? "/#{CGI.escape(fqdn)}" : '')
+        "#{BASE}livedns/domains" + (fqdn ? "/#{CGI.escape fqdn}" : '')
       end
       private_class_method :url
     end