Class: GandiV5::Domain

Inherits:

Object

• Object
• GandiV5::Domain

Includes:

Data

Defined in:

lib/gandi_v5/domain.rb,
lib/gandi_v5/domain/tld.rb,
lib/gandi_v5/domain/dates.rb,
lib/gandi_v5/domain/contact.rb,
lib/gandi_v5/domain/contract.rb,
lib/gandi_v5/domain/live_dns.rb,
lib/gandi_v5/domain/auto_renew.rb,
lib/gandi_v5/domain/availability.rb,
lib/gandi_v5/domain/sharing_space.rb,
lib/gandi_v5/domain/availability/tax.rb,
lib/gandi_v5/domain/renewal_information.rb,
lib/gandi_v5/domain/restore_information.rb,
lib/gandi_v5/domain/availability/product.rb,
lib/gandi_v5/domain/availability/product/price.rb,
lib/gandi_v5/domain/availability/product/period.rb

Overview

Gandi Domain Management API.

See Also:

• https://api.gandi.net/docs/domains

Defined Under Namespace

Classes: AutoRenew, Availability, Contact, Contract, Dates, LiveDNS, RenewalInformation, RestoreInformation, SharingSpace, TLD

Constant Summary

SERVICES =

{
  gandidns: 'GandiDNS',
  gandilivedns: 'LiveDNS',
  dnssec: 'DNSSEC',
  certificate: 'SSL Certificate',
  paas: 'PAAS',
  redirection: 'Redirection',
  gandimail: 'GandiMail',
  packmail: 'PackMail',
  blog: 'Blog',
  hosting: 'Hosting',
  site: 'Site',
  mailboxv2: 'MailboxV2'
}.freeze

STATUSES =

{
  clientHold: 'clientHold',
  clientUpdateProhibited: 'clientUpdateProhibited',
  clientTransferProhibited: 'clientTransferProhibited',
  clientDeleteProhibited: 'clientDeleteProhibited',
  clientRenewProhibited: 'clientRenewProhibited',
  serverHold: 'serverHold',
  pendingTransfer: 'pendingTransfer',
  serverTransferProhibited: 'serverTransferProhibited'
}.freeze

Instance Attribute Summary

• #auth_info ⇒ nil, String readonly
• #auto_renew ⇒ GandiV5::Domain::AutoRenew readonly
• #can_tld_lock ⇒ Boolean readonly
• #contacts ⇒ Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact} readonly

  Contacts for the domain.

• #dates ⇒ GandiV5::Domain::Dates readonly
• #domain_owner ⇒ String readonly
• #fqdn ⇒ String readonly

  Fully qualified domain name, written in its native alphabet (IDN).

• #fqdn_unicode ⇒ String readonly

  Fully qualified domain name, written in unicode.

• #name_server ⇒ Symbol readonly
• #name_servers ⇒ Array<String> readonly

  Name servers for the domain.

• #organisation_owner ⇒ _String readonly

  _String.

• #owner ⇒ String readonly
• #services ⇒ Array<Symbol> readonly

  List of Gandi services attached to this domain.

• #sharing_space ⇒ GandiV5::Domain::SharingSpace readonly
• #sharing_uuid ⇒ nil, String readonly
• #status ⇒ String readonly

  One of: “clientHold”, “clientUpdateProhibited”, “clientTransferProhibited”, “clientDeleteProhibited”, “clientRenewProhibited”, “serverHold”, “pendingTransfer”, “serverTransferProhibited”.

• #tags ⇒ nil, Array<String> readonly

  List of tags that have been assigned to the domain.

• #tld ⇒ String readonly
• #trustee_roles ⇒ nil, Array<Symbol> readonly

  One of: admin, tech.

• #uuid ⇒ nil, String (also: #domain_uuid) readonly

Class Method Summary

• .create(fqdn, dry_run: false, sharing_id: nil, **params) ⇒ GandiV5::Domain, Hash

  Create (register) a new domain.

• .fetch(fqdn) ⇒ GandiV5::Domain

  Get information on a domain.

• .list(page: (1..), per_page: 100, **params) ⇒ Array<GandiV5::Domain>

  List domains.

Instance Method Summary

• #add_glue_record(name, *ips) ⇒ String

  Add a new glue record to the domain in Gandi.

• #delete_glue_record(name) ⇒ String

  Delete a specific glue record for the domain.

• #email_forwards(**params) ⇒ Object
• #enable_livedns ⇒ String

  Enable LiveDNS for the domain.

• #fetch_contacts ⇒ Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}

  Requery Gandi for the domain’s contacts.

• #fetch_glue_records ⇒ Hash<String => Array<String>>

  Requery Gandi for the domain’s glue records.

• #fetch_livedns ⇒ GandiV5::Domain::LiveDNS

  Requery Gandi for the domain’s LiveDNS information.

• #fetch_name_servers ⇒ Array<String>

  Requery Gandi for the domain’s name servers.

• #fetch_renewal_information ⇒ GandiV5::Domain::RenewalInformation

  Requery Gandi for the domain’s renewal information.

• #fetch_restore_information ⇒ GandiV5::Domain::RestoreInformation

  Requery Gandi for the domain’s restore information.

• #glue_record(name) ⇒ Hash<String => Array<String>>^?

  Get a specific glue record for the domain.

• #glue_records ⇒ Hash<String => Array<String>>

  Glue records for the domain.

• #livedns ⇒ GandiV5::Domain::LiveDNS

  LiveDNS information for the domain.

• #mailbox_slots(**params) ⇒ Object
• #mailboxes(**params) ⇒ Object
• #refresh ⇒ GandiV5::Domain

  Requery Gandi fo this domain’s information.

• #renew_for(duration = 1) ⇒ String

  Renew domain.

• #renewal_information ⇒ GandiV5::Domain::RenewalInformation

  Renewal information for the domain.

• #renewal_price(currency: 'GBP', period: 1) ⇒ GandiV5::Domain::Availability::Product::Price

  Get the price for renewing this domain.

• #restore ⇒ String

  Restore an expired domain.

• #restore_information ⇒ GandiV5::Domain::RestoreInformation

  Restoration information for the domain.

• #to_s ⇒ String

  rubocop:disable Style/AsciiComments Returns the string representation of the domain.

• #update_contacts(admin: nil, bill: nil, tech: nil) ⇒ Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}

  Update some of the domain’s contacts.

• #update_glue_record(name, *ips) ⇒ String

  Update a specific glue record for the domain.

• #update_name_servers(nameservers) ⇒ String

  Update name servers in Gandi.

Methods included from Data

#from_gandi, included, #initialize, #to_gandi, #to_h, #values_at

Instance Attribute Details

#auth_info ⇒ nil, String (readonly)

Returns:

• (nil, String)

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#auto_renew ⇒ GandiV5::Domain::AutoRenew (readonly)

Returns:

• (GandiV5::Domain::AutoRenew)

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#can_tld_lock ⇒ Boolean (readonly)

Returns:

• (Boolean)

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#contacts ⇒ Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact} (readonly)

Contacts for the domain.

Returns:

• (Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact})

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#dates ⇒ GandiV5::Domain::Dates (readonly)

Returns:

• (GandiV5::Domain::Dates)

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#domain_owner ⇒ String (readonly)

Returns:

• (String)

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#fqdn ⇒ String (readonly)

Returns fully qualified domain name, written in its native alphabet (IDN).

Returns:

• (String) —

  fully qualified domain name, written in its native alphabet (IDN).

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#fqdn_unicode ⇒ String (readonly)

Returns fully qualified domain name, written in unicode. @see docs.gandi.net/en/domain_names/register/idn.html.

Returns:

• (String) —

  fully qualified domain name, written in unicode. @see docs.gandi.net/en/domain_names/register/idn.html

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#name_server ⇒ Symbol (readonly)

Returns:

• (Symbol)

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#name_servers ⇒ Array<String> (readonly)

Name servers for the domain.

Returns:

• (Array<String>)

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#organisation_owner ⇒ _String (readonly)

Returns _String.

Returns:

• (_String) —

  _String

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#owner ⇒ String (readonly)

Returns:

• (String)

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#services ⇒ Array<Symbol> (readonly)

Returns list of Gandi services attached to this domain. gandidns, redirection, gandimail, packmail, dnssec, blog, hosting, paas, site, certificate, gandilivedns, mailboxv2.

Returns:

• (Array<Symbol>) —

  list of Gandi services attached to this domain. gandidns, redirection, gandimail, packmail, dnssec, blog, hosting, paas, site, certificate, gandilivedns, mailboxv2

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#sharing_space ⇒ GandiV5::Domain::SharingSpace (readonly)

Returns:

• (GandiV5::Domain::SharingSpace)

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#sharing_uuid ⇒ nil, String (readonly)

Returns:

• (nil, String)

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#status ⇒ String (readonly)

Returns one of: “clientHold”, “clientUpdateProhibited”, “clientTransferProhibited”, “clientDeleteProhibited”, “clientRenewProhibited”, “serverHold”, “pendingTransfer”, “serverTransferProhibited” @see docs.gandi.net/en/domain_names/faq/domain_statuses.html.

Returns:

• (String) —

  one of: “clientHold”, “clientUpdateProhibited”, “clientTransferProhibited”, “clientDeleteProhibited”, “clientRenewProhibited”, “serverHold”, “pendingTransfer”, “serverTransferProhibited” @see docs.gandi.net/en/domain_names/faq/domain_statuses.html

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#tags ⇒ nil, Array<String> (readonly)

Returns list of tags that have been assigned to the domain.

Returns:

• (nil, Array<String>) —

  list of tags that have been assigned to the domain.

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#tld ⇒ String (readonly)

Returns:

• (String)

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#trustee_roles ⇒ nil, Array<Symbol> (readonly)

Returns one of: admin, tech.

Returns:

• (nil, Array<Symbol>) —

  one of: admin, tech.

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

#uuid ⇒ nil, String (readonly) Also known as: domain_uuid

Returns:

• (nil, String)

# File 'lib/gandi_v5/domain.rb', line 52

class Domain
  include GandiV5::Data

  SERVICES = {
    gandidns: 'GandiDNS',
    gandilivedns: 'LiveDNS',
    dnssec: 'DNSSEC',
    certificate: 'SSL Certificate',
    paas: 'PAAS',
    redirection: 'Redirection',
    gandimail: 'GandiMail',
    packmail: 'PackMail',
    blog: 'Blog',
    hosting: 'Hosting',
    site: 'Site',
    mailboxv2: 'MailboxV2'
  }.freeze

  STATUSES = {
    clientHold: 'clientHold',
    clientUpdateProhibited: 'clientUpdateProhibited',
    clientTransferProhibited: 'clientTransferProhibited',
    clientDeleteProhibited: 'clientDeleteProhibited',
    clientRenewProhibited: 'clientRenewProhibited',
    serverHold: 'serverHold',
    pendingTransfer: 'pendingTransfer',
    serverTransferProhibited: 'serverTransferProhibited'
  }.freeze

  CONTACTS_CONVERTER = lambda { |hash|
    break {} if hash.nil?

    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
  }
  private_constant :CONTACTS_CONVERTER

  members :fqdn, :fqdn_unicode, :tld, :can_tld_lock, :tags, :owner, :domain_owner
  member :sharing_uuid, gandi_key: 'sharing_id'
  member :name_servers, gandi_key: 'nameservers'
  member :auth_info, gandi_key: 'authinfo'
  member :organisation_owner, gandi_key: 'orga_owner'
  member :uuid, gandi_key: 'id'

  member(
    :dates,
    converter: GandiV5::Domain::Dates
  )
  member(
    :sharing_space,
    gandi_key: 'sharing_space',
    converter: GandiV5::Domain::SharingSpace
  )

  member(
    :auto_renew,
    gandi_key: 'autorenew',
    converter: GandiV5::Data::Converter.new(from_gandi: lambda { |hash|
      break nil if hash.nil?
      break nil if hash.eql?(true)
      break GandiV5::Domain::AutoRenew.from_gandi('enabled' => false) if hash.eql?(false)

      GandiV5::Domain::AutoRenew.from_gandi hash
    })
  )

  member(
    :contacts,
    converter: GandiV5::Data::Converter.new(from_gandi: CONTACTS_CONVERTER)
  )

  member(
    :name_server,
    gandi_key: 'nameserver',
    converter: GandiV5::Data::Converter.new(from_gandi: ->(hash) { hash&.[]('current')&.to_sym })
  )
  member :services, converter: GandiV5::Data::Converter::Symbol, array: true
  member :status, converter: GandiV5::Data::Converter::Symbol, array: true
  member :trustee_roles, converter: GandiV5::Data::Converter::Symbol, array: true

  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
    string
  end

  # Contacts for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def contacts
    @contacts ||= fetch_contacts
  end

  # Requery Gandi for the domain's contacts.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_contacts
    _response, data = GandiV5.get url('contacts')
    self.contacts = data.transform_keys(&:to_sym)
    CONTACTS_CONVERTER.call contacts
  end

  # Update some of the domain's contacts.
  # @see https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts
  # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new administrative contact.
  # @param bill [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new billing contact.
  # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
  #   details for the new technical contact.
  # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_contacts(admin: nil, bill: nil, tech: nil)
    body = {
      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

    GandiV5.patch url('contacts'), body
    fetch_contacts
  end

  # Renewal information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renewal_information
    @renewal_information ||= fetch_renewal_information
  end

  # Requery Gandi for the domain's renewal information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
  # @return [GandiV5::Domain::RenewalInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_renewal_information
    _response, data = GandiV5.get url('renew')
    data = data['renew'].merge('contracts' => data['contracts'])
    @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
  end

  # Renew domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def renew_for(duration = 1)
    body = { duration: duration }.to_json
    _response, data = GandiV5.post url('renew'), body
    data['message']
  end

  # Restoration information for the domain.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore_information
    @restore_information ||= fetch_restore_information
  end

  # Requery Gandi for the domain's restore information.
  # @see https://docs.gandi.net/en/domain_names/renew/restore.html
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
  # @return [GandiV5::Domain::RestoreInformation]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_restore_information
    _response, data = GandiV5.get url('restore')
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
  rescue RestClient::NotFound
    @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
  end

  # Restore an expired domain.
  # Warning! 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.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def restore
    _response, data = GandiV5.post url('restore'), '{}'
    data['message']
  end

  # Requery Gandi fo this domain's information.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def refresh
    _response, data = GandiV5.get url
    from_gandi data
    auto_renew.domain = self
  end

  # Get the price for renewing this domain.
  # @param currency [String] the currency to get the price in (e.g. GBP)
  # @param period [Integer] the number of year(s) renewal to get the price for
  # @return [GandiV5::Domain::Availability::Product::Price]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error
  def renewal_price(currency: 'GBP', period: 1)
    arguments = { processes: [:renew], currency: currency, period: period }
    GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                                 .products.first
                                 .prices.first
  end

  # LiveDNS information for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def livedns
    @livedns ||= fetch_livedns
  end

  # Requery Gandi for the domain's LiveDNS information.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
  # @return [GandiV5::Domain::LiveDNS]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_livedns
    _response, data = GandiV5.get url('livedns')
    @livedns = GandiV5::Domain::LiveDNS.from_gandi data
    @name_server = @livedns.current
    @name_servers = @livedns.name_servers
    @livedns
  end

  # Enable LiveDNS for the domain.
  # If you want to disable LiveDNS, change the nameservers.
  # Please note that if the domain is on the classic Gandi DNS,
  # this will also perform a copy of all existing records immediately afterwards.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def enable_livedns
    _response, data = GandiV5.post url('livedns')
    data['message']
  end

  # Name servers for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
  # @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-nameservers
  # @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

  # Update name servers in Gandi.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
  # @param nameservers [Array<String>] the name servers to use.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_name_servers(nameservers)
    _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
    @name_servers = nameservers
    data['message']
  end

  # Glue records for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_records
    @glue_records ||= fetch_glue_records
  end

  # Requery Gandi for the domain's glue records.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def fetch_glue_records
    _response, data = GandiV5.get url('hosts')
    @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
  end

  # Add a new glue record to the domain in Gandi.
  # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def add_glue_record(name, *ips)
    _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Get a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
  # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
  # @return [Hash<String => Array<String>>] name to list of IPs
  # @return [nil] name was not found
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def glue_record(name)
    records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
    records.key?(name) ? records.select { |k, _v| k == name } : nil
  end

  # Update a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @param ips [Array<String>] the IPs for the name.
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def update_glue_record(name, *ips)
    _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
    @glue_records ||= {}
    @glue_records[name] = ips
    data['message']
  end

  # Delete a specific glue record for the domain.
  # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
  # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
  # @return [String] confirmation message from Gandi.
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def delete_glue_record(name)
    _response, data = GandiV5.delete url('hosts', name)
    @glue_records ||= {}
    @glue_records.delete(name)
    data['message']
  end

  # @see GandiV5::Email::Mailbox.list
  def mailboxes(**params)
    GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Slot.list
  def mailbox_slots(**params)
    GandiV5::Email::Slot.list(**params, fqdn: fqdn)
  end

  # @see GandiV5::Email::Forward.list
  def email_forwards(**params)
    GandiV5::Email::Forward.list(**params, fqdn: fqdn)
  end

  # Create (register) a new domain.
  # Warning! 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]
  #   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 claims [String] (optional) unknown - not documented at Gandi.
  # @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 lang [String] (optional)
  #   ISO-639-2 language code of the domain, required for some IDN domains.
  # @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 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
  # @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
  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 : fetch(response.headers[:location].split('/').last)
  end

  # Get information on a domain.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
  # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
  # @return [GandiV5::Domain]
  # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
  def self.fetch(fqdn)
    _response, data = GandiV5.get url(fqdn)
    domain = from_gandi data
    domain.auto_renew.domain = fqdn
    domain
  end

  # List domains.
  # @see https://api.gandi.net/docs/domains#get-v5-domain-domains
  # @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 fqdn [String, #to_s] (optional)
  #   filters the list by domain name, with optional patterns.
  #   e.g. "example.net", "example.*", "*ample.com"
  # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
  # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
  # @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?

      domains += data.map { |domain| from_gandi domain }
      break if data.count < per_page
    end
    domains
  end

  private

  def url(*extra)
    "#{BASE}domain/domains/" +
      CGI.escape(fqdn) +
      (extra.empty? ? '' : "/#{extra.join('/')}")
  end

  def self.url(fqdn = nil)
    "#{BASE}domain/domains" +
      (fqdn ? "/#{CGI.escape fqdn}" : '')
  end
  private_class_method :url
end

Class Method Details

.create(fqdn, dry_run: false, sharing_id: nil, **params) ⇒ GandiV5::Domain, Hash

Create (register) a new domain. Warning! This is not a free operation. Please ensure your prepaid account has enough credit.

Parameters:

• fqdn (String, #to_s) —

  the fully qualified domain name to create.

• dry_run (Boolean) (defaults to: false) —

  whether the details should be checked instead of actually creating the domain.

• sharing_id (String) (defaults to: nil) —

  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.

• owner (GandiV5::Domain::Contact, #to_gandi, #to_h) —

  (required) the owner of the new domain.

• admin (GandiV5::Domain::Contact, #to_gandi, #to_h) —

  (optional, defaults to owner) the administrative contact for the new domain.

• bill (GandiV5::Domain::Contact, #to_gandi, #to_h) —

  (optional, defaults to owner) the billing contact for the new domain.

• tech (GandiV5::Domain::Contact, #to_gandi, #to_h) —

  (optional, defaults to owner) the technical contact for the new domain.

• claims (String) —

  (optional) unknown - not documented at Gandi.

• currency ("EUR", "USD", "GBP", "TWD", "CNY") —

  (optional) the currency you wish to be charged in.

• duration (Integer) —

  (optional, default 1, minimum 1 maximum 10) how many years to register for.

• enforce_premium (Boolean) —

  (optional) must be set to true if the domain is a premium domain.

• extra_parameters (Hash, #to_gandi, #to_json) —

  (optional) unknown - not documented at Gandi.

• lang (String) —

  (optional) ISO-639-2 language code of the domain, required for some IDN domains.

• 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.

• nameservers (Array<String>, #to_gandi, #to_json) —

  (optional) List of nameservers. Gandi’s LiveDNS nameservers are used if omitted..

• price (Numeric, #to_gandi, #to_json) —

  (optional) unknown - not documented at Gandi.

• resellee_id (String, #to_gandi, #to_json) —

  (optional) unknown - not documented at Gandi.

• smd (String, #to_gandi, #to_json) —

  (optional) Contents of a Signed Mark Data file (used for newgtld sunrises, tld_period must be sunrise).

• tld_period ("sunrise", "landrush", "eap1", "eap2", "eap3", "eap4", "eap5", "eap6", "eap7", "eap8", "eap9", "golive", #to_gandi, #to_json) —

  (optional) @see docs.gandi.net/en/domain_names/register/new_gtld.html

Returns:

• (GandiV5::Domain) —

  the created domain

• (Hash) —

  if doing a dry run, you get what Gandi returns

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error

See Also:

• https://api.gandi.net/docs/domains#post-v5-domain-domains

# File 'lib/gandi_v5/domain.rb', line 463

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 : fetch(response.headers[:location].split('/').last)
end

.fetch(fqdn) ⇒ GandiV5::Domain

Get information on a domain.

Parameters:

• fqdn (String, #to_s) —

  the fully qualified domain name to fetch.

Returns:

• (GandiV5::Domain)

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain

# File 'lib/gandi_v5/domain.rb', line 480

def self.fetch(fqdn)
  _response, data = GandiV5.get url(fqdn)
  domain = from_gandi data
  domain.auto_renew.domain = fqdn
  domain
end

.list(page: (1..), per_page: 100, **params) ⇒ Array<GandiV5::Domain>

List domains.

Parameters:

• page (#each<Integer, #to_s>) (defaults to: (1..)) —

  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.

• per_page (Integer, #to_s) (defaults to: 100) —

  (optional default 100) how many results ot get per page.

• fqdn (String, #to_s) —

  (optional) filters the list by domain name, with optional patterns. e.g. “example.net”, “example.*”, “*ample.com”

• sort_by (String, #to_s) —

  (optional default “fqdn”) how to sort the list.

• tld (String, #to_s) —

  (optional) used to filter by just the top level domain.

Returns:

• (Array<GandiV5::Domain>)

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#get-v5-domain-domains

# File 'lib/gandi_v5/domain.rb', line 500

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?

    domains += data.map { |domain| from_gandi domain }
    break if data.count < per_page
  end
  domains
end

Instance Method Details

#add_glue_record(name, *ips) ⇒ String

Add a new glue record to the domain in Gandi.

Parameters:

• name (String) —

  the DNS name (excluding FQDN) for the glue record to add (e.g. ‘ns1’).

• ips (Array<String>) —

  the IPs for the name.

Returns:

• (String) —

  confirmation message from Gandi.

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts

# File 'lib/gandi_v5/domain.rb', line 356

def add_glue_record(name, *ips)
  _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
  @glue_records ||= {}
  @glue_records[name] = ips
  data['message']
end

#delete_glue_record(name) ⇒ String

Delete a specific glue record for the domain.

Parameters:

• name (String) —

  the DNS name (excluding FQDN) for the glue record to update (e.g. ‘ns1’).

Returns:

• (String) —

  confirmation message from Gandi.

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name

# File 'lib/gandi_v5/domain.rb', line 392

def delete_glue_record(name)
  _response, data = GandiV5.delete url('hosts', name)
  @glue_records ||= {}
  @glue_records.delete(name)
  data['message']
end

#email_forwards(**params) ⇒ Object

See Also:

• Email::Forward.list

# File 'lib/gandi_v5/domain.rb', line 410

def email_forwards(**params)
  GandiV5::Email::Forward.list(**params, fqdn: fqdn)
end

#enable_livedns ⇒ String

Enable LiveDNS for the domain. If you want to disable LiveDNS, change the nameservers. Please note that if the domain is on the classic Gandi DNS, this will also perform a copy of all existing records immediately afterwards.

Returns:

• (String) —

  confirmation message from Gandi.

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns

# File 'lib/gandi_v5/domain.rb', line 300

def enable_livedns
  _response, data = GandiV5.post url('livedns')
  data['message']
end

#fetch_contacts ⇒ Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}

Requery Gandi for the domain’s contacts.

Returns:

• (Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact})

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts

# File 'lib/gandi_v5/domain.rb', line 163

def fetch_contacts
  _response, data = GandiV5.get url('contacts')
  self.contacts = data.transform_keys(&:to_sym)
  CONTACTS_CONVERTER.call contacts
end

#fetch_glue_records ⇒ Hash<String => Array<String>>

Requery Gandi for the domain’s glue records.

Returns:

• (Hash<String => Array<String>>) —

  name to list of IPs

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts

# File 'lib/gandi_v5/domain.rb', line 345

def fetch_glue_records
  _response, data = GandiV5.get url('hosts')
  @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
end

#fetch_livedns ⇒ GandiV5::Domain::LiveDNS

Requery Gandi for the domain’s LiveDNS information.

Returns:

• (GandiV5::Domain::LiveDNS)

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns

# File 'lib/gandi_v5/domain.rb', line 285

def fetch_livedns
  _response, data = GandiV5.get url('livedns')
  @livedns = GandiV5::Domain::LiveDNS.from_gandi data
  @name_server = @livedns.current
  @name_servers = @livedns.name_servers
  @livedns
end

#fetch_name_servers ⇒ Array<String>

Requery Gandi for the domain’s name servers.

Returns:

• (Array<String>)

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers

# File 'lib/gandi_v5/domain.rb', line 317

def fetch_name_servers
  _response, data = GandiV5.get url('nameservers')
  @name_servers = data
end

#fetch_renewal_information ⇒ GandiV5::Domain::RenewalInformation

Requery Gandi for the domain’s renewal information.

Returns:

• (GandiV5::Domain::RenewalInformation)

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew

# File 'lib/gandi_v5/domain.rb', line 202

def fetch_renewal_information
  _response, data = GandiV5.get url('renew')
  data = data['renew'].merge('contracts' => data['contracts'])
  @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
end

#fetch_restore_information ⇒ GandiV5::Domain::RestoreInformation

Requery Gandi for the domain’s restore information.

Returns:

• (GandiV5::Domain::RestoreInformation)

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://docs.gandi.net/en/domain_names/renew/restore.html
• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore

# File 'lib/gandi_v5/domain.rb', line 234

def fetch_restore_information
  _response, data = GandiV5.get url('restore')
  @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
rescue RestClient::NotFound
  @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
end

#glue_record(name) ⇒ Hash<String => Array<String>>^?

Get a specific glue record for the domain.

Parameters:

• name (String) —

  the DNS name (excluding FQDN) for the glue record to add (e.g. ‘ns1’).

Returns:

• (Hash<String => Array<String>>) —

  name to list of IPs

• (nil) —

  name was not found

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts

# File 'lib/gandi_v5/domain.rb', line 369

def glue_record(name)
  records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
  records.key?(name) ? records.select { |k, _v| k == name } : nil
end

#glue_records ⇒ Hash<String => Array<String>>

Glue records for the domain.

Returns:

• (Hash<String => Array<String>>) —

  name to list of IPs

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts

# File 'lib/gandi_v5/domain.rb', line 337

def glue_records
  @glue_records ||= fetch_glue_records
end

#livedns ⇒ GandiV5::Domain::LiveDNS

LiveDNS information for the domain.

Returns:

• (GandiV5::Domain::LiveDNS)

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns

# File 'lib/gandi_v5/domain.rb', line 277

def livedns
  @livedns ||= fetch_livedns
end

#mailbox_slots(**params) ⇒ Object

See Also:

• Email::Slot.list

# File 'lib/gandi_v5/domain.rb', line 405

def mailbox_slots(**params)
  GandiV5::Email::Slot.list(**params, fqdn: fqdn)
end

#mailboxes(**params) ⇒ Object

See Also:

• Email::Mailbox.list

# File 'lib/gandi_v5/domain.rb', line 400

def mailboxes(**params)
  GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
end

#refresh ⇒ GandiV5::Domain

Requery Gandi fo this domain’s information.

Returns:

• (GandiV5::Domain)

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

# File 'lib/gandi_v5/domain.rb', line 255

def refresh
  _response, data = GandiV5.get url
  from_gandi data
  auto_renew.domain = self
end

#renew_for(duration = 1) ⇒ String

Renew domain. Warning! This is not a free operation. Please ensure your prepaid account has enough credit.

Parameters:

• duration (Integer, #to_s) (defaults to: 1) —

  how long to renew for (in years).

Returns:

• (String) —

  confirmation message from Gandi.

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-renew

# File 'lib/gandi_v5/domain.rb', line 214

def renew_for(duration = 1)
  body = { duration: duration }.to_json
  _response, data = GandiV5.post url('renew'), body
  data['message']
end

#renewal_information ⇒ GandiV5::Domain::RenewalInformation

Renewal information for the domain.

Returns:

• (GandiV5::Domain::RenewalInformation)

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew

# File 'lib/gandi_v5/domain.rb', line 194

def renewal_information
  @renewal_information ||= fetch_renewal_information
end

#renewal_price(currency: 'GBP', period: 1) ⇒ GandiV5::Domain::Availability::Product::Price

Get the price for renewing this domain.

Parameters:

• currency (String) (defaults to: 'GBP') —

  the currency to get the price in (e.g. GBP)

• period (Integer) (defaults to: 1) —

  the number of year(s) renewal to get the price for

Returns:

• (GandiV5::Domain::Availability::Product::Price)

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error

# File 'lib/gandi_v5/domain.rb', line 266

def renewal_price(currency: 'GBP', period: 1)
  arguments = { processes: [:renew], currency: currency, period: period }
  GandiV5::Domain::Availability.fetch(fqdn, **arguments)
                               .products.first
                               .prices.first
end

#restore ⇒ String

Restore an expired domain. Warning! This is not a free operation. Please ensure your prepaid account has enough credit.

Returns:

• (String) —

  The confirmation message from Gandi.

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://docs.gandi.net/en/domain_names/renew/restore.html
• https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-restore

# File 'lib/gandi_v5/domain.rb', line 247

def restore
  _response, data = GandiV5.post url('restore'), '{}'
  data['message']
end

#restore_information ⇒ GandiV5::Domain::RestoreInformation

Restoration information for the domain.

Returns:

• (GandiV5::Domain::RestoreInformation)

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://docs.gandi.net/en/domain_names/renew/restore.html
• https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore

# File 'lib/gandi_v5/domain.rb', line 225

def restore_information
  @restore_information ||= fetch_restore_information
end

#to_s ⇒ String

rubocop:disable Style/AsciiComments Returns the string representation of the domain. rubocop:enable Style/AsciiComments

Returns:

• (String) —

  e.g. “example.com”, “😀.com (xn–e28h.uk.com)”

# File 'lib/gandi_v5/domain.rb', line 145

def to_s
  string = fqdn_unicode
  string += " (#{fqdn})" unless fqdn == fqdn_unicode
  string
end

#update_contacts(admin: nil, bill: nil, tech: nil) ⇒ Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}

Update some of the domain’s contacts.

Parameters:

• admin (GandiV5::Domain::Contact, #to_gandi, #to_h) (defaults to: nil) —

  details for the new administrative contact.

• bill (GandiV5::Domain::Contact, #to_gandi, #to_h) (defaults to: nil) —

  details for the new billing contact.

• tech (GandiV5::Domain::Contact, #to_gandi, #to_h) (defaults to: nil) —

  details for the new technical contact.

Returns:

• (Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact})

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#patch-v5-domain-domains-domain-contacts

# File 'lib/gandi_v5/domain.rb', line 179

def update_contacts(admin: nil, bill: nil, tech: nil)
  body = {
    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

  GandiV5.patch url('contacts'), body
  fetch_contacts
end

#update_glue_record(name, *ips) ⇒ String

Update a specific glue record for the domain.

Parameters:

• name (String) —

  the DNS name (excluding FQDN) for the glue record to update (e.g. ‘ns1’).

• ips (Array<String>) —

  the IPs for the name.

Returns:

• (String) —

  confirmation message from Gandi.

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name

# File 'lib/gandi_v5/domain.rb', line 380

def update_glue_record(name, *ips)
  _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
  @glue_records ||= {}
  @glue_records[name] = ips
  data['message']
end

#update_name_servers(nameservers) ⇒ String

Update name servers in Gandi.

Parameters:

• nameservers (Array<String>) —

  the name servers to use.

Returns:

• (String) —

  confirmation message from Gandi.

Raises:

• (GandiV5::Error::GandiError) —

  if Gandi returns an error.

See Also:

• https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers

# File 'lib/gandi_v5/domain.rb', line 327

def update_name_servers(nameservers)
  _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
  @name_servers = nameservers
  data['message']
end