gandi_v5 0.8.0 → 0.10.1

data/lib/gandi_v5/live_dns/domain.rb

@@ -21,6 +21,7 @@ class GandiV5
       end
 
       # Update this domain's settings.
+      # @see https://api.gandi.net/docs/livedns/#patch-v5-livedns-domains-fqdn
       # @param automatic_snapshots [String, #to_s]
       #   Enable or disable the automatic creation of new snapshots when records are changed.
       # @return [String] The confirmation message from Gandi.
@@ -33,12 +34,14 @@ class GandiV5
 
       # @overload fetch_records()
       #   Fetch all records for this domain.
+      #   @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-records
       #   @param page [Integer, #each<Integer>] which page(s) of results to get.
       #     If page is not provided keep querying until an empty list is returned.
       #     If page responds to .each then iterate until an empty list is returned.
       #   @param per_page [Integer, #to_s] (optional default 100) how many results ot get per page.
       # @overload fetch_records(name)
       #   Fetch records for a name.
+      #   @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-records-rrset_name
       #   @param name [String] the name to fetch records for.
       #   @param page [Integer, #each<Integer>] which page(s) of results to get.
       #     If page is not provided keep querying until an empty list is returned.
@@ -46,6 +49,7 @@ class GandiV5
       #   @param per_page [Integer, #to_s] (optional default 100) how many results ot get per page.
       # @overload fetch_records(name, type)
       #   Fetch records of a type for a name.
+      #   @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-records-rrset_name-rrset_type
       #   @param name [String] the name to fetch records for.
       #   @param type [String] the record type to fetch.
       #   @param page [Integer, #each<Integer>] which page(s) of results to get.
@@ -70,11 +74,15 @@ class GandiV5
 
       # @overload fetch_zone_lines()
       #   Fetch all records for this domain.
+      #   @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-records
+      #   @see https://rubygems.org/gems/dns-zonefile dns-zonefile gem may be helpful too
       # @overload fetch_zone_lines(name)
       #   Fetch records for a name.
+      #   @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-records-rrset_name
       #   @param name [String] the name to fetch records for.
       # @overload fetch_zone_lines(name, type)
       #   Fetch records of a type for a name.
+      #   @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-records-rrset_name-rrset_type
       #   @param name [String] the name to fetch records for.
       #   @param type [String] the record type to fetch.
       # @return [String]
@@ -90,6 +98,7 @@ class GandiV5
       end
 
       # Add record to this domain.
+      # @see https://api.gandi.net/docs/livedns/#post-v5-livedns-domains-fqdn-records
       # @param name [String]
       # @param type [String]
       # @param ttl [Integer]
@@ -113,11 +122,14 @@ class GandiV5
 
       # @overload delete_records()
       #   Delete all records for this domain.
+      #   @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-records
       # @overload delete_records(name)
       #   Delete records for a name.
+      #   @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-records-rrset_name
       #   @param name [String] the name to delete records for.
       # @overload delete_records(name, type)
       #   Delete records of a type for a name.
+      #   @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-records-rrset_name-rrset_type
       #   @param name [String] the name to delete records for.
       #   @param type [String] the record type to delete.
       # @return [nil]
@@ -136,6 +148,9 @@ class GandiV5
       #   @param type [String, nil] only replaces record of this type (requires name).
       #   @param values [Array<String>] the values to set for the record.
       #   @raise [ArgumentError] if ttl is present and type is absent.
+      # @see https://api.gandi.net/docs/livedns/#put-v5-livedns-domains-fqdn-records
+      # @see https://api.gandi.net/docs/livedns/#put-v5-livedns-domains-fqdn-records-rrset_name
+      # @see https://api.gandi.net/docs/livedns/#put-v5-livedns-domains-fqdn-records-rrset_name-rrset_type
       # @return [String] The confirmation message from Gandi.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
@@ -161,6 +176,7 @@ class GandiV5
       # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
       # Replace all records for this domain.
+      # @see https://api.gandi.net/docs/livedns/#put-v5-livedns-domains-fqdn-records
       # @param text [String] zone file lines to replace the records with.
       # @return [String] The confirmation message from Gandi.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
@@ -199,6 +215,7 @@ class GandiV5
       end
 
       # Requery Gandi for the domain's DNSSEC keys.
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-keys
       # @return [Array<GandiV5::LiveDNS::Domain::DnssecKey>]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def fetch_dnssec_keys
@@ -215,6 +232,7 @@ class GandiV5
       end
 
       # Requery Gandi for the domain's TSIG keys.
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-axfr-tsig
       # @return [Array<GandiV5::LiveDNS::Domain::TsigKey>]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def fetch_tsig_keys
@@ -223,6 +241,7 @@ class GandiV5
       end
 
       # Add a Tsig key to this domain.
+      # @see https://api.gandi.net/docs/livedns/#put-v5-livedns-domains-fqdn-axfr-tsig-id
       # @param key [GandiV5::LiveDNS::Domain::TsigKey, #uuid, String, #to_s]
       #   the key to add.
       # @param sharing_id [nil, String, #to_s]
@@ -235,6 +254,7 @@ class GandiV5
       end
 
       # Remove a Tsig key from this domain.
+      # @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-axfr-tsig-id
       # @param key [GandiV5::LiveDNS::Domain::TsigKey, #uuid, String, #to_s]
       #   the key to remove.
       # @param sharing_id [nil, String, #to_s]
@@ -254,6 +274,7 @@ class GandiV5
       end
 
       # Requery Gandi for the domain's AXFR clients.
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-axfr-slaves
       # @return [Array<String>] list of IP addresses.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def fetch_axfr_clients
@@ -262,6 +283,7 @@ class GandiV5
       end
 
       # Add an AXFR client to this domain.
+      # @see https://api.gandi.net/docs/livedns/#put-v5-livedns-domains-fqdn-axfr-slaves-ip
       # @param ip [String, #to_s] the IP address to add.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def add_axfr_client(ip)
@@ -269,6 +291,7 @@ class GandiV5
       end
 
       # Remove and AXFR client from this domain.
+      # @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-axfr-slaves-ip
       # @param ip [String, #to_s] the IP address to remove.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def remove_axfr_client(ip)
@@ -276,6 +299,7 @@ class GandiV5
       end
 
       # List the domains.
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-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.
@@ -300,6 +324,7 @@ class GandiV5
       end
 
       # Get a domain.
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn
       # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
       # @return [GandiV5::LiveDNS::Domain]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
@@ -310,6 +335,7 @@ class GandiV5
 
       # Create a new domain in the LiveDNS system.
       # You must have sufficent permission to manage the domain to do this.
+      # @see https://api.gandi.net/docs/livedns/#post-v5-livedns-domains
       # @param fqdn [String, #to_s] the fully qualified domain to add to LiveDNS.
       # @param records [Array<Hash, GandiV5::LiveDNS::Domain::Record, #to_h, nil>]
       # @param ttl [Integer, #to_s, nil] the TTL of the SOA record.
@@ -335,6 +361,7 @@ class GandiV5
       end
 
       # Fetch the list of known record types (A, CNAME, etc.)
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-dns-rrtypes
       # @return [Array<String>]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def self.record_types
@@ -342,7 +369,8 @@ class GandiV5
       end
 
       # Get the LiveDNS servers to use for a domain.
-      # Does not take into account any NS records that exist in the zone.
+      # @note Does not take into account any NS records that exist in the zone.
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-nameservers-fqdn
       # @param fqdn [String, #to_s] the fully qualified domain to hash in
       #   in order to get the LiveDNS servers to use.
       # @return [Array<String>]

data/lib/gandi_v5/live_dns.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 # Namespace for classes which access LiveDNS details.
+# @see https://api.gandi.net/docs/livedns/
 class GandiV5
   # Gandi LiveDNS Management API.
   class LiveDNS
+    # Permitted record types.
     RECORD_TYPES = %w[
       A AAAA CNAME MX NS TXT ALIAS
       WKS SRV LOC SPF CAA DS SSHFP PTR KEY DNAME TLSA OPENPGPKEY CDS

data/lib/gandi_v5/simple_hosting/instance/application.rb

@@ -3,6 +3,7 @@
 class GandiV5
   class SimpleHosting
     class Instance
+      # An application running on a simple hosting instance.
       # @!attribute [r] name
       #   @return [String]
       # @!attribute [r] parameters

data/lib/gandi_v5/simple_hosting/instance/database.rb

@@ -3,6 +3,7 @@
 class GandiV5
   class SimpleHosting
     class Instance
+      # A simple hosting instance.
       # @!attribute [r] name
       #   @return [String]
       # @!attribute [r] status

data/lib/gandi_v5/simple_hosting/instance/language.rb

@@ -3,7 +3,7 @@
 class GandiV5
   class SimpleHosting
     class Instance
-      # Sharing space which contains other billable items.
+      # A language running on a simple hosting instance.
       # @!attribute [r] name
       #   @return [String]
       # @!attribute [r] single_application

data/lib/gandi_v5/simple_hosting/instance/upgrade.rb

@@ -3,6 +3,7 @@
 class GandiV5
   class SimpleHosting
     class Instance
+      # An available upgrade on a simple hosting instance.
       # @!attribute [r] name
       #   @return [String]
       # @!attribute [r] status

data/lib/gandi_v5/simple_hosting/instance/virtual_host/linked_dns_zone.rb

@@ -4,7 +4,8 @@ class GandiV5
   class SimpleHosting
     class Instance
       class VirtualHost
-        # @!attribute [r] allow_zone_alteration
+        # A DNS Zone linked to a virtual host on a simple hosting instance.
+        # @!attribute [r] allow_alteration
         #   @return [Boolean]
         # @!attribute [r] cname
         #   @return [String]

data/lib/gandi_v5/simple_hosting/instance/virtual_host.rb

@@ -4,7 +4,7 @@
 class GandiV5
   class SimpleHosting
     class Instance
-      # A simple hosting virtual host.
+      # A virtual host on a simple hosting instance.
       # @see https://api.gandi.net/docs/simplehosting/
       # @!attribute [r] created_at
       #   @return [Time]
@@ -48,7 +48,7 @@ class GandiV5
         member(
           :certificates,
           converter: GandiV5::Data::Converter.new(
-            from_gandi: ->(array) { Hash[array.map { |h| [h['id'], h['pending']] }] }
+            from_gandi: ->(array) { array.map { |h| [h['id'], h['pending']] }.to_h }
           )
         )
 
@@ -57,7 +57,7 @@ class GandiV5
           converter: GandiV5::SimpleHosting::Instance::VirtualHost::LinkedDnsZone
         )
 
-        # Requery Gandi fo this hosts's information.
+        # Requery Gandi fo this virtual hosts's information.
         # @return [GandiV5::SimpleHosting::Instance::VirtualHost]
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
         def refresh
@@ -65,6 +65,59 @@ class GandiV5
           from_gandi data
         end
 
+        # Delete the virtual host.
+        # @see https://api.gandi.net/docs/simplehosting/#delete-v5-simplehosting-instances-instance_id-vhosts-vhost_fqdn
+        # @return [String] The confirmation message from Gandi.
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def delete
+          _response, data = GandiV5.delete url
+          data['message']
+        end
+
+        # Update the virtual host.
+        # @see https://api.gandi.net/docs/simplehosting/#patch-v5-simplehosting-instances-instance_id-vhosts-vhost_fqdn
+        # @param application [GandiV5::SimpleHosting::Instance::Application, Hash]
+        # @param https_strategy [:http_only, :allow_http_and_https, :redirect_http_to_https]
+        # @param linked_dns_zone_allow_alteration [Boolean]
+        #   authorize Gandi to modify your DNS zone so that your vhost points to their
+        #   Simple Hosting public endpoints.
+        # @param linked_dns_zone_allow_alteration_override [Boolean]
+        #   authorize Gandi to override your DNS zone if there already is a record to
+        #   link your instance to your vhost fqdn.
+        # @return [GandiV5::SimpleHosting::Instance::VirtualHost] self.
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        # rubocop:disable Metrics/MethodLength
+        def update(
+          application: nil,
+          https_strategy: nil,
+          linked_dns_zone_allow_alteration: nil,
+          linked_dns_zone_allow_alteration_override: false
+        )
+          https_strategy = case https_strategy
+                           when nil then nil
+                           when :http_only then 'HTTP_only'
+                           when :allow_http_and_https then 'allow_HTTP_and_HTTPS'
+                           when :redirect_http_to_https then 'redirect_HTTP_to_HTTPS'
+                           else
+                             fail ArgumentError,
+                                  "https_strategy #{https_strategy.inspect} is invalid"
+                           end
+
+          body = {}
+          body[:application] = application.to_h.slice(:name, :parameters) if application
+          body[:https_strategy] = https_strategy if https_strategy
+          unless linked_dns_zone_allow_alteration.nil?
+            body[:linked_dns_zone] = {
+              allow_alteration: linked_dns_zone_allow_alteration,
+              allow_alteration_override: linked_dns_zone_allow_alteration_override
+            }
+          end
+
+          _response, data = GandiV5.put url, body.to_json
+          from_gandi data
+        end
+        # rubocop:enable Metrics/MethodLength
+
         # Check if the virtual host is being created
         # @return [Boolean]
         def being_created?
@@ -139,7 +192,7 @@ class GandiV5
 
         # Get information on a virtual host.
         # @see https://api.gandi.net/docs/simplehosting#get-v5-simplehosting-instances-instance_id-vhosts-vhost_fqdn
-        # @param uuid [String, #to_s] the UUID of the simple hosting instance.
+        # @param instance_uuid [String, #to_s] the UUID of the simple hosting instance.
         # @param fqdn [String, #to_s] the fully qualified domain name of the virtual host.
         # @return [GandiV5::SimpleHosting::Instance]
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
@@ -148,7 +201,39 @@ class GandiV5
           from_gandi data.merge('instance_uuid' => instance_uuid)
         end
 
-        # List instances.
+        # Create a new virtual host for an instance
+        # @see https://api.gandi.net/docs/simplehosting/#post-v5-simplehosting-instances-instance_id-vhosts
+        # @param fqdn [String, #to_s] the fully qualified domain of the virtual host to create.
+        # @param application [GandiV5::SimpleHosting::Instance::Application, Hash]
+        # @param linked_dns_zone_allow_alteration [Boolean]
+        #   authorize Gandi to modify your DNS zone so that your vhost points to their
+        #   Simple Hosting public endpoints.
+        # @param linked_dns_zone_allow_alteration_override [Boolean]
+        #   authorize Gandi to override your DNS zone if there already is a record to
+        #   link your instance to your vhost fqdn.
+        # @return [GandiV5::SimpleHosting::Instance::VirtualHost]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.create(
+          instance_uuid,
+          fqdn,
+          application: nil,
+          linked_dns_zone_allow_alteration: nil,
+          linked_dns_zone_allow_alteration_override: false
+        )
+          body = { fqdn: fqdn }
+          body[:application] = application.to_h.slice(:name, :parameters) if application
+          unless linked_dns_zone_allow_alteration.nil?
+            body[:linked_dns_zone] = {
+              allow_alteration: linked_dns_zone_allow_alteration,
+              allow_alteration_override: linked_dns_zone_allow_alteration_override
+            }
+          end
+
+          _response, _data = GandiV5.post url(instance_uuid), body.to_json
+          fetch instance_uuid, fqdn
+        end
+
+        # List virtual hosts for an instance.
         # @see https://api.gandi.net/docs/simplehosting#get-v5-simplehosting-instances-instance_id-vhosts
         # @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.

data/lib/gandi_v5/simple_hosting/instance.rb

@@ -117,6 +117,7 @@ class GandiV5
       )
 
       # Instruct Gandi to restart this instance.
+      # @see https://api.gandi.net/docs/simplehosting/#post-v5-simplehosting-instances-instance_id-action
       # @return [String] confirmation message.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def restart
@@ -125,6 +126,7 @@ class GandiV5
       end
 
       # Instruct Gandi to console this instance.
+      # @see https://api.gandi.net/docs/simplehosting/#post-v5-simplehosting-instances-instance_id-action
       # @return [String] confirmation message.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def console
@@ -133,6 +135,7 @@ class GandiV5
       end
 
       # Instruct Gandi to reset the database password for this instance.
+      # @see https://api.gandi.net/docs/simplehosting/#post-v5-simplehosting-instances-instance_id-action
       # @return [String] confirmation message.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def reset_database_password
@@ -143,6 +146,12 @@ class GandiV5
         data
       end
 
+      # @see GandiV5::SimpleHosting::Instance::VirtualHost.create
+      def create_virtual_host(fqdn, **params)
+        GandiV5::SimpleHosting::Instance::VirtualHost.create(uuid, fqdn, **params)
+        refresh
+      end
+
       # Requery Gandi fo this instance's information.
       # @return [GandiV5::SimpleHosting::Instance]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.

data/lib/gandi_v5/simple_hosting.rb

@@ -3,6 +3,7 @@
 # Namespace for classes which access LiveDNS details.
 class GandiV5
   # Gandi Simple Hosting management API.
+  # @see https://api.gandi.net/docs/simplehosting/
   class SimpleHosting
     # @see GandiV5::Simplehosting::Instance.list
     def self.instances

data/lib/gandi_v5/template/dispatch.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Template
+    # The current state of a template dispatch.
+    # @!attribute [r] uuid
+    #   @return [String]
+    # @!attribute [r] template_uuid
+    #   @return [String, nil]
+    # @!attribute [r] template_name
+    #   @return [String, nil]
+    # @!attribute [r] target_uuid
+    #   @return [String]
+    # @!attribute [r] attempt
+    #   @return [Integer]
+    # @!attribute [r] created_at
+    #   @return [Time]
+    # @!attribute [r] created_by
+    #   @return [String] the UUID of the user who applied the template.
+    # @!attribute [r] updated_at
+    #   @return [Time, nil]
+    # @!attribute [r] state
+    #   @return [:pending, :running, :done, :error]
+    # @!attribute [r] state_message
+    #   @return [String, nil]
+    # @!attribute [r] task_statuses
+    #   @return [Array<Hash{Symbol => Synbol}>]
+    #     maps namespace (e.g. :dns_records) to current status (e.g. :done)
+    # @!attribute [r] task_history
+    #   @return [Array<Hash{:at => Time, :what => Symbol, :status => Symbol, :message => String}>]
+    # @!attribute [r] payload
+    #   @return [Array<GandiV5::Template::Payload] the settings which will be applied
+    #                                              when this template is used.
+    class Dispatch
+      include GandiV5::Data
+
+      members :attempt, :template_name
+      member :uuid, gandi_key: 'id'
+      member :template_uuid, gandi_key: 'template_id'
+      member :created_at, converter: GandiV5::Data::Converter::Time
+      member :created_by, gandi_key: 'sharing_id'
+      member :target_uuid, gandi_key: 'target_id'
+      member :state_message, gandi_key: 'state_msg'
+      member :updated_at, gandi_key: 'task_updated_at', converter: GandiV5::Data::Converter::Time
+      member :payload, converter: GandiV5::Template::Payload
+
+      member(
+        :state,
+        converter: GandiV5::Data::Converter.new(
+          from_gandi: lambda { |value|
+            values = { 0 => :pending, 10 => :running, 20 => :done, 30 => :error }
+            values.fetch(value)
+          }
+        )
+      )
+
+      member(
+        :task_statuses,
+        gandi_key: 'task_status',
+        converter: GandiV5::Data::Converter.new(
+          from_gandi: lambda { |hash|
+            keys = {
+              'dns:records' => :dns_records,
+              'domain:mailboxes' => :mailboxes,
+              'domain:nameservers' => :name_servers,
+              'domain:webredirs' => :web_forwardings
+            }
+            values = { 0 => :pending, 10 => :running, 20 => :done, 30 => :error }
+            hash.transform_keys { |key| keys.fetch(key) }
+                .transform_values { |value| values.fetch(value.fetch('status')) }
+          }
+        )
+      )
+
+      member(
+        :task_history,
+        converter: GandiV5::Data::Converter.new(
+          from_gandi: lambda { |array|
+            namespace = {
+              'dns:records' => :dns_records,
+              'domain:mailboxes' => :mailboxes,
+              'domain:nameservers' => :name_servers,
+              'domain:webredirs' => :web_forwardings
+            }
+            status = { 0 => :pending, 10 => :running, 20 => :done, 30 => :error }
+            array.map do |item|
+              {
+                at: Time.parse(item.fetch('date')),
+                what: namespace.fetch(item.fetch('namespace')),
+                status: status.fetch(item.fetch('status')),
+                message: item.fetch('message')
+              }
+            end
+          }
+        )
+      )
+
+      # Get a template dispatch.
+      # @see https://api.gandi.net/docs/template/#get-v5-template-dispatch-id
+      # @param uuid [String, #to_s] unique identifier of the dispatch.
+      # @return [GandiV5::Template::Dispatch]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.fetch(uuid)
+        _response, data = GandiV5.get "#{BASE}template/dispatch/#{CGI.escape uuid}"
+        from_gandi data
+      end
+    end
+  end
+end

data/lib/gandi_v5/template/payload/dns_record.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Template
+    class Payload
+      # DNS Record details of a configuration template.
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] type
+      #   @return [String]
+      # @!attribute [r] values
+      #   @return [Array<String>]
+      # @!attribute [r] ttl
+      #   @return [Integer, nil] 300-2592000.
+      class DNSRecord
+        include GandiV5::Data
+
+        members :name, :type, :ttl
+        member :values, array: true
+      end
+    end
+  end
+end

data/lib/gandi_v5/template/payload/web_forwarding.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Template
+    class Payload
+      # Web forwarding details of a configuration template.
+      # @!attribute [r] type
+      #   @return [:cloak, :http301, :http302]
+      # @!attribute [r] target
+      #   @return [String]
+      # @!attribute [r] fqdn
+      #   @return [String, nil]
+      # @!attribute [r] override
+      #   @return [Boolean, nil]
+      #     when you create a redirection on a domain, a DNS record is created if it does not exist.
+      #     When the record already exists and this parameter is set to true it will
+      #     overwrite the record. Otherwise it will trigger an error.
+      # @!attribute [r] protocol
+      #   @return [:http, :https, :https_only, nil]
+      class WebForwarding
+        include GandiV5::Data
+
+        member :type, converter: GandiV5::Data::Converter::Symbol
+        member :target, gandi_key: 'url'
+        member :fqdn, gandi_key: 'host'
+        member :override
+        member(
+          :protocol,
+          converter: GandiV5::Data::Converter.new(
+            from_gandi: lambda { |value|
+              {
+                'http' => :http,
+                'https' => :https,
+                'httpsonly' => :https_only
+              }.fetch(value)
+            }
+          )
+        )
+
+        # Check if this is an HTTP 301 (permanent) redirection.
+        def http301?
+          type == :http301
+        end
+
+        # Check if this is an HTTP 302 (found) redirection.
+        def http302?
+          type == :http302
+        end
+
+        # Check if this is an HTTP 301 (permanent) redirection.
+        def permanent?
+          type == :http301
+        end
+
+        # Check if this is an HTTP 302 (found) redirection.
+        def found?
+          type == :http302
+        end
+
+        # Check if this is a temporary redirection.
+        def temporary?
+          type == :http302
+        end
+
+        # Check if it's an http end point
+        def http?
+          protocol == :http || protocol == :https
+        end
+
+        # Check if it's an https end point
+        def https?
+          protocol == :https || protocol == :https_only
+        end
+
+        # Check if it's an https only
+        def https_only?
+          protocol == :https_only
+        end
+      end
+    end
+  end
+end