gandi_v5 0.8.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bcedab1f98eded02f20893ca2f4b8c5a47abe1d72d3e055ef5688b2969104df
-  data.tar.gz: 6db74218bd3914c662c2b6cac47c76a4d9497368f80b3ef4f31ad7e6537604a5
+  metadata.gz: 1040cd55b98ae6f6d747d769a74e5b2cd92b09b1a8cbe5a4115851d76485f1da
+  data.tar.gz: afd99593144ae4650027b3bfa316bf2a49430954a2cfc846e4782a4123853ca1
 SHA512:
-  metadata.gz: 29dad44ec126323a917bcc5c4ac8dd200e1acc7ac32cfdf7c4608a919dd872e9f2071031b371d7ad8bae8a2ed09e6bd2bf660d0095b59999859e91d180b53e70
-  data.tar.gz: 1d2c599205a31b449c003cf4e2628b0326cf90d45ae3c75a68356879e463ee708c6d81f5fb64e1ee75ffe73fbc5402cc3e2fc290fddfe6777c0fb304ccb45a8f
+  metadata.gz: 1124d5fc0cc35cb3e9c41629ba9286b40c0b31a7f47f8dc7e76f7135143770c29b8da8acbecb6869ec1a9c93cd30115287f9f42b0a5e1126ee89b6ef4ff08aa2
+  data.tar.gz: 800b4b45ea100c39929ba4bae9ab0479b5c9d552e1d10a56029df2ff8b023a90d5794b939fb4de9ba0dc2f1b2abd71fe62f661cb5c85346ee5b53acf02d6b8f3

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Gandi V5 API Gem Changelog
 
+## Version 0.10.1
+
+* Fix issue with json not being included
+
+## Version 0.10.0
+
+* GandiV5::Domain
+  * Add \#transfer_lock(lock = true) and \#transfer_unlock
+  * Add template_id argument to .create
+  * Add \#web_forwardings -> GandiV5::Domain::WebForwarding.list
+  * Add \#new_web_forwarding -> GandiV5::Domain::WebForwarding.create
+* GandiV5::Domain::TransferIn
+  * Add template_id argument to .create
+* GandiV5::Domain::WebForwarding
+* GandiV5::SimpleHosting::Instance::VirtualHost: (I don't use simple hosting myself so it's possible I've misread the docs and a bug is waiting to be found, please add an issue if I have)
+  * Add .create (aliased as GandiV5::SimpleHosting::Instance#create_virtual_host)
+  * Add \#delete
+  * Add \#update
+* GandiV5::Template
+* GandiV5::Template::Dispatch
+* Add testing against truffleruby-20.3.0
+
+## Version 0.9.1
+
+* Add testing against ruby 2.7.2 and 3.0.0
+
+## Version 0.9.0
+
+* Add transferring a domain to Gandi (I don't have any domains outside Gandi to test this myself so it's possible I've misread the docs and a bug is waiting to be found, please add an issue if I have):
+  * GandiV5::Domain::TransferIn:
+    * .create(fqdn, \*\*options)
+    * .fetch(fqdn)
+    * .relaunch(fqdn)
+    * .resend_foa_emails(fqdn, email_address)
+    * \#relaunch
+    * \#resend_foa_emails(email_address)
+  * GandiV5::Domain::TransferIn::Availabillity:
+    * .fetch(fqdn, auth_code = nil)
+* Documentation improvements
+
 ## Version 0.8.0
 
 * Domain:
@@ -21,15 +61,15 @@
     * .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
+    * \#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
+      * \#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
@@ -79,11 +119,11 @@
 ## Version 0.2.0
 
 * Enhancements to GandiV5::Domain
-  * .availability(fqdn, **options) moved to GandiV5::Domain::Availability.fetch(fqdn, **options)
+  * .availability(fqdn, \*\*options) moved to GandiV5::Domain::Availability.fetch(fqdn, \*\*options)
   * .create now returns created domain (except in dry-run mode)
   * .tlds moved to GandiV5::Domain::TLD.list
   * .tld(name) moved to GandiV5::Domain::TLD.fetch(name)
-  * #renewal_price(currency: 'GBP', period: 1) added
+  * \#renewal_price(currency: 'GBP', period: 1) added
 * Enhancements to GandiV5::Email::Mailbox
   * .create now returns created mailbox
   * .create now checks for available slots and a valid type has been passed
@@ -92,14 +132,14 @@
   * Add #disable to disable the auto responder in Gandi
 * Enhancements to GandiV5::Email::Slot
   * .create now returns created slot
-  * #delete now checks for inactiveness and refundableness
+  * \#delete now checks for inactiveness and refundableness
 * Enhancements to GandiV5::LiveDNS::Domain
   * Add #zone and #fetch_zone
-  * Remove #replace_*_records_for methods
+  * Remove #replace_\*_records_for methods
   * Changes to #replace_records_for to allow calling with name, type, ttl and values. When calling with name and fecords records MUST be passed as an array.
 * Enhancements to GandiV5::LiveDNS::Zone
   * .create now returns created zone
-  * Remove #replace_*_records_for methods
+  * Remove #replace_\*_records_for methods
   * Changes to #replace_records_for to allow calling with name, type, ttl and values. When calling with name and fecords records MUST be passed as an array.
 * Enhancements to GandiV5::LiveDNS::Zone::Snapshot
   * Add .list

data/README.md

@@ -1,18 +1,21 @@
 [![Gem Version](https://badge.fury.io/rb/gandi_v5.png)](http://badge.fury.io/rb/gandi_v5)
-[![Build Status](https://secure.travis-ci.org/robertgauld/gandi_v5.png?branch=master)](http://travis-ci.org/robertgauld/gandi_v5)
-[![Coveralls Status](https://coveralls.io/repos/robertgauld/gandi_v5/badge.png?branch=master)](https://coveralls.io/r/robertgauld/gandi_v5)
-[![Code Climate](https://codeclimate.com/github/robertgauld/gandi_v5.png?branch=master)](https://codeclimate.com/github/robertgauld/gandi_v5)
-[![security](https://hakiri.io/github/robertgauld/gandi_v5/master.svg)](https://hakiri.io/github/robertgauld/gandi_v5/master)
+[![Commit Checks](https://github.com/robertgauld/gandi_v5/workflows/Commit%20Checks/badge.svg)](https://github.com/robertgauld/gandi_v5/actions?query=workflow%3A%22Commit+Checks%22)
+[![Coveralls Status](https://coveralls.io/repos/robertgauld/gandi_v5/badge.png?branch=main)](https://coveralls.io/r/robertgauld/gandi_v5)
+[![Code Climate](https://codeclimate.com/github/robertgauld/gandi_v5.png?branch=main)](https://codeclimate.com/github/robertgauld/gandi_v5)
 
 ## Ruby Versions
 This gem supports the following versions of ruby, it may work on other versions but is not tested against them so don't rely on it.
 
 * ruby:
-  * 2.6.0 - 2.6.6
-  * 2.7.0 - 2.7.1
-  * truffleruby 20.1.0
-* jruby, once it's reached parity with ruby 2.6.x
-* rubinius, once it's reached parity with ruby 2.6.x
+  * 2.6.0 - 2.6.7
+  * 2.7.0 - 2.7.3
+  * 3.0.0 - 3.0.1
+  * truffleruby 20.1.0 - 21.0.0
+
+This gem doesn't yet support the following versions of ruby, although hopefully it soon will.
+
+* jruby - not yet at parity with ruby 2.6.x
+* rubinius - not yet at parity with ruby 2.6.x
 
 
 ## Gandi V5
@@ -25,23 +28,24 @@ Gandi say: **_"Please note that this API is currently in BETA testing, so care s
 
 But then you were going to be careful anyway as this gem is currently in the version 0.something range weren't you!
 
-Details of the API can be found at:
+Details of Gandi's API can be found at:
 
 * <https://api.gandi.net/docs/>
 * <https://doc.livedns.gandi.net/>
 
+Details of the gem's API can be found at <https://rubydoc.info/github/robertgauld/gandi_v5/main>
 
 ## Installation
 
 If you're using bundler then add it to your Gemfile and run the bundle command.
 
 ```ruby
-gem 'gandi_v5', '~> 0.7'
+gem 'gandi_v5', '~> 0.10'
 ```
 
 If you're not using bundler then install it from the command line.
 ```bash
-gem install gandi_v5 -v '~> 0.7'
+gem install gandi_v5 -v '~> 0.10'
 ```
 
 ## Usage
@@ -58,6 +62,52 @@ GandiV5.api_key = '…' # Unless you've set it in the environment variable GANDI
 
 ### Examples
 
+#### List renewal dates and costs for all domains
+```ruby
+# For each domain (sorted by assending renewal date) print <date>\t<cost>\t<fqdn>
+GandiV5::Domain.list.each do |domain|
+  puts [
+    domain.dates.registry_ends_at.to_date,
+    "£#{domain.renewal_price.price_after_taxes}",
+    domain.fqdn
+  ].join("\t")
+end
+```
+
+#### List email addresses for all domains
+
+```ruby
+# For each domain:
+#   1. Create an empty hash to store address => description
+#   2. Get the mailboxes and add them to the hash
+#   3. Get the forwards and add them to the hash
+#   4. Sort the hash by email address
+#   5. Print the list
+GandiV5::Domain.list.each do |domain|
+  emails = {}
+
+  mailboxes = GandiV5::Email::Mailbox.list(domain.fqdn)
+  mailboxes.each do |mailbox|
+    mailbox.refresh
+    emails["#{mailbox.login}@#{domain.fqdn}"] = "#{mailbox.type} mailbox " \
+                                         "(#{mailbox.quota_usage.to_i}% " \
+                                         "of #{(mailbox.quota / 1024**3).round}GB used)"
+    mailbox.aliases.each do |alias_name|
+      emails["#{alias_name}@#{domain.fqdn}"] = "alias for #{mailbox.login}@#{domain.fqdn}"
+    end
+  end
+
+  forwards = GandiV5::Email::Forward.list(domain.fqdn)
+  forwards.each do |forward|
+    emails["#{forward.source}@#{domain.fqdn}"] = "forwards to #{forward.destinations.join(', ')}"
+  end
+
+  emails.sort.each do |address, text|
+    puts "#{address}\t#{text}"
+  end
+end
+```
+
 #### Domains
 
 ```ruby
@@ -68,15 +118,14 @@ domains = GandiV5.domains
 domains.map!(&:refresh)
 ```
 
-TODO: More examples!
-
-
 ## Versioning
 
 We follow the [Semantic Versioning](http://semver.org/) concept.
 
 | Gem Version     | Gandi API Release Date   |
 | --------------- | ------------------------ |
+| 0.10.0          | 2020-12-10               |
+| 0.9.0           | 2020-07-29               |
 | 0.8.0           | 2020-07-10               |
 | 0.7.0           | 2020-05-07               |
 | 0.6.0           | 2020-05-07 (not LiveDNS) |

data/lib/gandi_v5/billing/info/prepaid.rb

@@ -22,6 +22,7 @@ class GandiV5
         member :updated_at, converter: GandiV5::Data::Converter::Time
 
         # Check if current balance is below the warning threshold.
+        # @return [Boolean]
         def warning?
           return nil if warning_threshold.nil?
 

data/lib/gandi_v5/data/converter/array_of.rb

@@ -4,6 +4,7 @@ class GandiV5
   module Data
     class Converter
       # Used for applying the same converter to each item in an array.
+      # @api private
       class ArrayOf
         # @param converter the converter to apply to each item in the array.
         def initialize(converter)
@@ -18,8 +19,8 @@ class GandiV5
           value.map { |item| converter.to_gandi(item) }
         end
 
-        # @param [Array<Object>]
-        # @return value [Array<Object>]
+        # @param value [Array<Object>]
+        # @return [Array<Object>]
         def from_gandi(value)
           return nil if value.nil?
 

data/lib/gandi_v5/data/converter/integer.rb

@@ -4,6 +4,7 @@ class GandiV5
   module Data
     class Converter
       # Methods for converting strings to/from integerss.
+      # @api private
       class Integer
         # @param value [Integer]
         # @return [String]
@@ -13,8 +14,8 @@ class GandiV5
           value.to_s
         end
 
-        # @param [String]
-        # @return value [Integer]
+        # @param value [String]
+        # @return [Integer]
         def self.from_gandi(value)
           return nil if value.nil?
 

data/lib/gandi_v5/data/converter/symbol.rb

@@ -4,6 +4,7 @@ class GandiV5
   module Data
     class Converter
       # Methods for converting strings to/from symbols.
+      # @api private
       class Symbol
         # @param value [Symbol]
         # @return [String]
@@ -13,8 +14,8 @@ class GandiV5
           value.to_s
         end
 
-        # @param [String]
-        # @return value [Symbol]
+        # @param value [String]
+        # @return [Symbol]
         def self.from_gandi(value)
           return nil if value.nil?
 

data/lib/gandi_v5/data/converter/time.rb

@@ -4,6 +4,7 @@ class GandiV5
   module Data
     class Converter
       # Methods for converting times to/from Gandi ("2019-02-13T11:04:18Z").
+      # @api private
       class Time
         # Convert a time to Gandi's prefered string format.
         # @param value [Time]
@@ -15,8 +16,8 @@ class GandiV5
         end
 
         # Convert a time from Gandi's prefered string format.
-        # @param [String]
-        # @return value [Time]
+        # @param value [String]
+        # @return [Time]
         def self.from_gandi(value)
           return nil if value.nil?
 

data/lib/gandi_v5/data/converter.rb

@@ -3,6 +3,7 @@
 class GandiV5
   module Data
     # Namespace for converters to/from Gandi's format.
+    # @api private
     class Converter
       # Initialize a new simple converter.
       # The passed procs will be run at the appropriate time.
@@ -21,8 +22,8 @@ class GandiV5
         to_gandi_proc.call value
       end
 
-      # @param [Object]
-      # @return value [Object]
+      # @param value [Object]
+      # @return [Object]
       def from_gandi(value)
         return value unless from_gandi_proc
 

data/lib/gandi_v5/data.rb

@@ -3,6 +3,7 @@
 class GandiV5
   # Addin providing a DSL to manage declaring attributes and how to map
   # and convert to/from Gandi's fields.
+  # @api private
   module Data
     # api private
     # Add contents of ClassMethods to the Class which includes this module.
@@ -21,19 +22,17 @@ class GandiV5
     # Get a hash representation of the object.
     # @return [Hash<Symbol => Object>]
     def to_h
-      Hash[
-        data_members.map do |key|
-          value = send(key)
-          next [key, value] if value.nil?
-
-          if value.is_a?(Enumerable)
-            value = to_h_transform_enumerable(value)
-          elsif value.respond_to?(:to_h)
-            value = value.to_h
-          end
-          [key, value]
+      data_members.map do |key|
+        value = send(key)
+        next [key, value] if value.nil?
+
+        if value.is_a?(Enumerable)
+          value = to_h_transform_enumerable(value)
+        elsif value.respond_to?(:to_h)
+          value = value.to_h
         end
-      ]
+        [key, value]
+      end.to_h
     end
 
     # Get a hash representation of this object suitable for passing back to Gandi.
@@ -149,8 +148,8 @@ class GandiV5
         return nil if data.nil?
 
         new(
-          translate_gandi(data).transform_keys(&:to_sym)
-                               .select { |k, _v| data_member?(k) }
+          **translate_gandi(data).transform_keys(&:to_sym)
+                                 .select { |k, _v| data_member?(k) }
         )
       end
 

data/lib/gandi_v5/domain/availability/product/period.rb

@@ -4,7 +4,7 @@ class GandiV5
   class Domain
     class Availability
       class Product
-        # Information about an available product.
+        # Information about an available product's period.
         # @!attribute [r] name
         #   @return [String]
         # @!attribute [r]

data/lib/gandi_v5/domain/contact.rb

@@ -4,15 +4,15 @@ class GandiV5
   class Domain
     # Information for a single contact for a domain.
     # @!attribute [r] country
-    #   @return [String] .
+    #   @return [String]
     # @!attribute [r] email
-    #   @return [String] .
+    #   @return [String]
     # @!attribute [r] family
-    #   @return [String] .
+    #   @return [String]
     # @!attribute [r] given
-    #   @return [String] .
+    #   @return [String]
     # @!attribute [r] address
-    #   @return [String] .
+    #   @return [String]
     # @!attribute [r] type
     #   @return [:person, :company, :association, :'public body', :reseller]
     # @!attribute [r] brand_number

data/lib/gandi_v5/domain/tld.rb

@@ -12,7 +12,7 @@ class GandiV5
     # @!attribute [r] category
     #   @return [String]
     # @!attribute [r] change_owner
-    #   @return [Boolean] whther changing owner is pemritted.
+    #   @return [Boolean] whether changing owner is pemritted.
     # @!attribute [r] corporate
     #   @return [Boolean] whether this is a corporate TLD.
     # @!attribute [r] ext_trade
@@ -27,7 +27,7 @@ class GandiV5
 
       # List of available TLDs.
       # @see https://api.gandi.net/docs/domains#get-v5-domain-tlds
-      # @return Array<GandiV5::Domain::TLD>
+      # @return [Array<GandiV5::Domain::TLD>]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def self.list
         GandiV5.get(url)

data/lib/gandi_v5/domain/transfer_in/availability.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    class TransferIn
+      # Information about the availabillity of a domain to be transfered into Gandi.
+      # @!attribute [r] fqdn
+      #   @return [String] the fully qualified domain name.
+      # @!attribute [r] fqdn_unicode
+      #   @return [String] the fully qualified domain name in unicode.
+      # @!attribute [r] available
+      #   @return [Boolean] whether the domain can be transfered.
+      # @!attribute [r] corporate
+      #   @return [Boolean] Optional
+      # @!attribute [r] internal
+      #   @return [Boolean] Optional
+      # @!attribute [r] minimum_duration
+      #   @return [Integer] Optional the minimum duration you can reregister the domain for.
+      # @!attribute [r] maximum_duration
+      #   @return [Integer] Optional the maximum duration you can reregister the domain for.
+      # @!attribute [r] durations
+      #   @return [Array<Integer>] Optional the durations you can reregister the domain for.
+      # @!attribute [r] message
+      #   @return [String, nil] Optional message explaining why the domain can't be transfered.
+      class Availability
+        include GandiV5::Data
+
+        members :fqdn, :available, :corporate, :internal,
+                :minimum_duration, :maximum_duration
+        member :durations, array: true
+        member :message, gandi_key: 'msg'
+        member :fqdn_unicode, gandi_key: 'fqdn_ulabel'
+
+        # Find out if a domain can be transfered to Gandi.
+        # @see https://api.gandi.net/docs/domains/#post-v5-domain-transferin-domain-available
+        # @param fqdn [String, #to_s] the fully qualified domain name to query.
+        # @param auth_code [String, #to_s] authorization code (if required).
+        # @return [GandiV5::Domain::TransferIn::Availabillity]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.fetch(fqdn, auth_code = nil)
+          url = "#{BASE}domain/transferin/#{fqdn}/available"
+          body = {}
+          body['authinfo'] = auth_code if auth_code
+
+          _response, data = GandiV5.post url, body
+          from_gandi data
+        end
+      end
+    end
+  end
+end

data/lib/gandi_v5/domain/transfer_in.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    # Manage a domain's transfer to Gandi.
+    # @!attribute [r] fqdn
+    #   @return [String] the fully qualified domain name being transfered
+    # @!attribute [r] created_at
+    #   @return [Time]
+    # @!attribute [r] updated_at
+    #   @return [Time]
+    # @!attribute [r] owner_contact
+    #   @return [String]
+    # @!attribute [r] step
+    #   @return [String]
+    # @!attribute [r] step_number
+    #   @return [Integer]
+    # @!attribute [r] errortype
+    #   @return [String] (optional)
+    # @!attribute [r] errortype_label
+    #   @return [String] (optional)
+    # @!attribute [r] duration
+    #   @return [Integer] (optional)
+    # @!attribute [r] reseller_uuid
+    #   @return [String] (optional)
+    # @!attribute [r] version
+    #   @return [Integer] (optional)
+    # @!attribute [r] foa
+    #   @return [Hash{String=>String}] (optional) email => status
+    # @!attribute [r] inner_step
+    #   @return [String] (optional)
+    # @!attribute [r] transfer_procedure
+    #   @return [String] (optional)
+    # @!attribute [r] start_at
+    #   @return [Time] (optional)
+    # @!attribute [r] regac_at
+    #   @return [Time] (optional)
+    class TransferIn
+      include GandiV5::Data
+
+      members :fqdn, :owner_contact, :step, :errortype, :errortype_label, :inner_step,
+              :transfer_procedure, :reseller_uuid, :version, :foa_status, :duration
+
+      member :step_number, gandi_key: 'step_nb'
+      member :created_at, converter: GandiV5::Data::Converter::Time
+      member :updated_at, converter: GandiV5::Data::Converter::Time
+      member :regac_at, converter: GandiV5::Data::Converter::Time
+      member :start_at, converter: GandiV5::Data::Converter::Time
+
+      # Relaunch the transfer process after something went wrong.
+      # @see https://api.gandi.net/docs/domains/#put-v5-domain-transferin-domain
+      # @return [String] the confirmation message from Gandi
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def relaunch
+        TransferIn.relaunch fqdn
+      end
+
+      # Resend the {https://icannwiki.org/FOA Form Of Authorization} email.
+      # @see https://api.gandi.net/docs/domains/#post-v5-domain-transferin-domain-foa
+      # @return [String] the confirmation message from Gandi
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def resend_foa_emails(email_address)
+        TransferIn.resend_foa_emails fqdn, email_address
+      end
+
+      # Start the transfer of a domain to Gandi.
+      # @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-transferin
+      # @param fqdn [String, #to_s] the fully qualified domain name to create.
+      # @param dry_run [Boolean]
+      #   whether the details should be checked instead of actually creating the domain.
+      # @param sharing_id [String] either:
+      #   * nil (default) - nothing special happens
+      #   * an organization ID - pay using another organization
+      #     (you need to have billing permissions on the organization
+      #     and use the same organization name for the domain name's owner).
+      #     The invoice will be edited using this organization's information.
+      #   * a reseller ID - buy a domain for a customer using a reseller account
+      #     (you need to have billing permissions on the reseller organization
+      #     and have your customer's information for the owner).
+      #     The invoice will be edited using the reseller organization's information.
+      # @param owner [GandiV5::Domain::Contact, #to_gandi, #to_h] (required)
+      #   the owner of the new domain.
+      # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h] (optional, defaults to owner)
+      #   the administrative contact for the new domain.
+      # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h] (optional, defaults to owner)
+      #   the billing contact for the new domain.
+      # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h] (optional, defaults to owner)
+      #   the technical contact for the new domain.
+      # @param currency ["EUR", "USD", "GBP", "TWD", "CNY"] (optional)
+      #   the currency you wish to be charged in.
+      # @param duration [Integer] (optional, default 1, minimum 1 maximum 10)
+      #   how many years to register for.
+      # @param enforce_premium [Boolean] (optional)
+      #   must be set to true if the domain is a premium domain.
+      # @param extra_parameters [Hash, #to_gandi, #to_json] (optional)
+      #   unknown - not documented at Gandi.
+      # @param nameserver_ips [Hash<String => Array<String>>, #to_gandi, #to_json] (optional)
+      #   For glue records only - dictionnary associating a nameserver to a list of IP addresses.
+      # @param nameservers [Array<String>, #to_gandi, #to_json] (optional)
+      #   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 change_owner [Boolean] (optional)
+      #   whether the change the domain's owner during the transfer.
+      # @param auth_code [String] (optional) authorization code (if required).
+      # @param template_id [String, #to_gandi] (optional)
+      #   Template to be applied when the transfer is done.
+      # @return [String] the confirmation message from Gandi
+      # @return [Hash] if doing a dry run, you get what Gandi returns
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error
+      def self.create(fqdn, dry_run: false, sharing_id: nil, **params)
+        fail ArgumentError, 'missing keyword: owner' unless params.key?(:owner)
+
+        body = params.merge(fqdn: fqdn)
+                     .transform_values { |val| val.respond_to?(:to_gandi) ? val.to_gandi : val }
+                     .to_json
+        url_ = sharing_id ? "#{url}?sharing_id=#{sharing_id}" : url
+
+        _response, data = GandiV5.post(url_, body, 'Dry-Run': dry_run ? 1 : 0)
+        dry_run ? data : data['message']
+      end
+
+      # Get information on an existing transfer.
+      # @see https://api.gandi.net/docs/domains/#get-v5-domain-transferin-domain
+      # @param fqdn [String, #to_s] the fully qualified domain name to check.
+      # @return [GandiV5::Domain::TransferIn]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.fetch(fqdn)
+        _response, data = GandiV5.get url(fqdn)
+        transfer = from_gandi data
+        transfer.instance_exec { @fqdn = data.dig('params', 'domain') }
+        transfer.instance_exec { @reseller_uuid = data.dig('params', 'reseller') }
+        transfer.instance_exec { @version = data.dig('params', 'version') }
+        transfer.instance_exec { @duration = data.dig('params', 'duration') }
+        if data.key?('foa')
+          transfer.instance_exec do
+            @foa_status = data['foa'].map { |hash| hash.values_at('email', 'answer') }.to_h
+          end
+        end
+        transfer
+      end
+
+      # Relaunch the transfer process after something went wrong.
+      # @see https://api.gandi.net/docs/domains/#put-v5-domain-transferin-domain
+      # @return [String] the confirmation message from Gandi
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.relaunch(fqdn)
+        _response, data = GandiV5.put url(fqdn)
+        data['message']
+      end
+
+      # Resend the {https://icannwiki.org/FOA Form Of Authorization} email.
+      # @see https://api.gandi.net/docs/domains/#post-v5-domain-transferin-domain-foa
+      # @return [String] the confirmation message from Gandi
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.resend_foa_emails(fqdn, email_address)
+        _response, data = GandiV5.post "#{url(fqdn)}/foa", { 'email' => email_address }.to_json
+        data['message']
+      end
+
+      private
+
+      def self.url(fqdn = nil)
+        "#{BASE}domain/transferin" +
+          (fqdn ? "/#{CGI.escape fqdn}" : '')
+      end
+      private_class_method :url
+    end
+  end
+end