dnsimple 8.7.1 → 8.8.0

data/lib/dnsimple/options.rb

@@ -4,6 +4,7 @@ module Dnsimple
   module Options
 
     class Base
+
       def initialize(options)
         @options = (options || {}).dup
       end
@@ -11,15 +12,18 @@ module Dnsimple
       def to_h
         @options
       end
+
     end
 
     class ListOptions < Base
+
       def initialize(options)
         super
         _prepare_query
         _prepare_pagination
         _prepare_sort
         _prepare_filter
+        _prepare_groupings
       end
 
       private
@@ -46,9 +50,15 @@ module Dnsimple
         _merge(@filter) unless @filter.nil?
       end
 
+      def _prepare_groupings
+        groupings = @options.delete(:groupings)
+        _merge({ groupings: groupings }) unless groupings.nil?
+      end
+
       def _merge(hash)
         @options[:query].merge!(hash)
       end
+
     end
 
   end

data/lib/dnsimple/response.rb

@@ -77,4 +77,16 @@ module Dnsimple
 
   end
 
+  class PaginatedResponseWithQuery < PaginatedResponse
+
+    # @return [Hash] A hash containing the query parameters that produced the results in this response
+    attr_reader :query
+
+    def initialize(http_response, collection)
+      super
+      @query = http_response["query"]
+    end
+
+  end
+
 end

data/lib/dnsimple/struct/account.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class Account < Base
+
       # @return [Integer] The account ID in DNSimple.
       attr_accessor :id
 
@@ -12,7 +12,7 @@ module Dnsimple
 
       # @return [String] The identifier of the plan the account is subscribed to.
       attr_accessor :plan_identifier
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/certificate.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class Certificate < Base
+
       # @return [Integer] The certificate ID in DNSimple.
       attr_accessor :id
 
@@ -42,7 +42,7 @@ module Dnsimple
 
       # @return [String] The timestamp when the certificate will expire.
       attr_accessor :expires_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/certificate_bundle.rb

@@ -2,7 +2,6 @@
 
 module Dnsimple
   module Struct
-
     class CertificateBundle < Base
 
       # @return [String] The certificate private key
@@ -24,6 +23,5 @@ module Dnsimple
       alias intermediate_certificates chain
 
     end
-
   end
 end

data/lib/dnsimple/struct/certificate_purchase.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class CertificatePurchase < Base
+
       # @return [Integer] The certificate purchase ID in DNSimple.
       attr_accessor :id
 
@@ -21,7 +21,7 @@ module Dnsimple
 
       # @return [String] When the certificate renewal was last updated in DNSimple.
       attr_accessor :updated_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/certificate_renewal.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class CertificateRenewal < Base
+
       # @return [Integer] The certificate renewal ID in DNSimple.
       attr_accessor :id
 
@@ -24,7 +24,7 @@ module Dnsimple
 
       # @return [String] When the certificate renewal was last updated in DNSimple.
       attr_accessor :updated_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/charge.rb

@@ -7,6 +7,7 @@ module Dnsimple
     class Charge < Base
 
       class ChargeItem < Base
+
         # @return [String] The description of the charge item.
         attr_accessor :description
 
@@ -29,6 +30,7 @@ module Dnsimple
         def amount=(amount)
           @amount = BigDecimal(amount)
         end
+
       end
 
       # @return [String] The reference number of the invoice.
@@ -79,7 +81,7 @@ module Dnsimple
       def total_amount=(total_amount)
         @total_amount = BigDecimal(total_amount)
       end
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/collaborator.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class Collaborator < Base
+
       # @return [Integer] The collaborator ID in DNSimple.
       attr_accessor :id
 
@@ -30,7 +30,7 @@ module Dnsimple
 
       # @return [String,NilClass] When the collaborator has accepted the invitation.
       attr_accessor :accepted_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/contact.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class Contact < Base
+
       # @return [Integer] The contact ID in DNSimple.
       attr_accessor :id
 
@@ -57,7 +57,7 @@ module Dnsimple
 
       # @return [String] When the contact was last updated in DNSimple.
       attr_accessor :updated_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/delegation_signer_record.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class DelegationSignerRecord < Base
+
       # @return [Integer] The ID of the delegation signer record in DNSimple.
       attr_accessor :id
 
@@ -30,7 +30,7 @@ module Dnsimple
 
       # @return [String] When the delegation signing record was last updated in DNSimple.
       attr_accessor :updated_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/dns_analytics.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  module Struct
+    class DnsAnalytics < Base
+
+      # @return [Integer] The recorded volume
+      attr_accessor :volume
+
+      # @return [Date] The date
+      attr_accessor :date
+
+      # @return [String] The zone name
+      attr_accessor :zone_name
+
+    end
+  end
+end

data/lib/dnsimple/struct/dnssec.rb

@@ -2,11 +2,11 @@
 
 module Dnsimple
   module Struct
-
     class Dnssec < Base
+
       # @return [Boolean] True if DNSSEC is enabled on the domain, otherwise false
       attr_accessor :enabled
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/domain.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class Domain < Base
+
       # @return [Integer] The domain ID in DNSimple.
       attr_accessor :id
 
@@ -36,6 +36,7 @@ module Dnsimple
 
       # @return [String] When the domain was last updated in DNSimple.
       attr_accessor :updated_at
+
     end
   end
 end

data/lib/dnsimple/struct/domain_check.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class DomainCheck < Base
+
       # @return [String] The domain name that was checked.
       attr_accessor :domain
 
@@ -12,7 +12,7 @@ module Dnsimple
 
       # @return [Boolean] Whether the domain name is premium.
       attr_accessor :premium
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/domain_premium_price.rb

@@ -2,14 +2,14 @@
 
 module Dnsimple
   module Struct
-
     class DomainPremiumPrice < Base
+
       # @return [String] The domain premium price
       attr_accessor :premium_price
 
       # @return [String] The action: registration/transfer/renewal
       attr_accessor :action
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/domain_price.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class DomainPrice < Base
+
       # @return [String] The domain name
       attr_accessor :domain
 
@@ -18,7 +18,7 @@ module Dnsimple
 
       # @return [Float] The price for transfer
       attr_accessor :transfer_price
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/domain_push.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class DomainPush < Base
+
       # @return [Integer] The domain push ID in DNSimple.
       attr_accessor :id
 
@@ -24,7 +24,7 @@ module Dnsimple
 
       # @return [String] When the domain push was accepted in DNSimple.
       attr_accessor :accepted_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/domain_registration.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class DomainRegistration < Base
+
       # @return [Integer] The domain registration ID in DNSimple.
       attr_accessor :id
 
@@ -30,7 +30,7 @@ module Dnsimple
 
       # @return [String] When the domain renewal was last updated in DNSimple.
       attr_accessor :updated_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/domain_renewal.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class DomainRenewal < Base
+
       # @return [Integer] The domain renewal ID in DNSimple.
       attr_accessor :id
 
@@ -21,7 +21,7 @@ module Dnsimple
 
       # @return [String] When the domain renewal was last updated in DNSimple.
       attr_accessor :updated_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/domain_transfer.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class DomainTransfer < Base
+
       # @return [Integer] The domain registration ID in DNSimple.
       attr_accessor :id
 
@@ -30,7 +30,7 @@ module Dnsimple
 
       # @return [String] When the domain renewal was last updated in DNSimple.
       attr_accessor :updated_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/email_forward.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class EmailForward < Base
+
       # @return [Integer] The email forward ID in DNSimple.
       attr_accessor :id
 
@@ -21,6 +21,7 @@ module Dnsimple
 
       # @return [String] Then the email forward was last updated in DNSimple.
       attr_accessor :updated_at
+
     end
   end
 end

data/lib/dnsimple/struct/extended_attribute.rb

@@ -2,10 +2,10 @@
 
 module Dnsimple
   module Struct
-
     class ExtendedAttribute < Base
 
       class Option < Base
+
         # The option name
         attr_accessor :title
 
@@ -14,6 +14,7 @@ module Dnsimple
 
         # A long description of the option
         attr_accessor :description
+
       end
 
       # The extended attribute name
@@ -40,6 +41,5 @@ module Dnsimple
       end
 
     end
-
   end
 end

data/lib/dnsimple/struct/oauth_token.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class OauthToken < Base
+
       # @return [String] The token you can use to authenticate.
       attr_accessor :access_token
 
@@ -15,7 +15,7 @@ module Dnsimple
 
       # @return [Integer] The account ID in DNSimple this token belongs to.
       attr_accessor :account_id
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/registrant_change.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class RegistrantChange < Base
+
       # @return [Integer] The registrant change ID in DNSimple.
       attr_accessor :id
 
@@ -33,6 +33,7 @@ module Dnsimple
 
       # @return [String] When the registrant change was last updated in DNSimple.
       attr_accessor :updated_at
+
     end
   end
 end

data/lib/dnsimple/struct/registrant_change_check.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class RegistrantChangeCheck < Base
+
       # @return [Integer] The associated contact ID.
       attr_accessor :contact_id
 
@@ -15,6 +15,7 @@ module Dnsimple
 
       # # @return [Boolean] True if the registrant change is a registry owner change.
       attr_accessor :registry_owner_change
+
     end
   end
 end

data/lib/dnsimple/struct/service.rb

@@ -2,10 +2,10 @@
 
 module Dnsimple
   module Struct
-
     class Service < Base
 
       class Setting < Base
+
         # @return [String] The setting name.
         attr_accessor :name
 
@@ -23,6 +23,7 @@ module Dnsimple
 
         # @return [Boolean] Whether the setting requires a password.
         attr_accessor :password
+
       end
 
       # @return [Integer] The service ID in DNSimple.
@@ -61,6 +62,5 @@ module Dnsimple
       end
 
     end
-
   end
 end

data/lib/dnsimple/struct/template.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class Template < Base
+
       # @return [Integer] The template ID in DNSimple.
       attr_accessor :id
 
@@ -18,7 +18,7 @@ module Dnsimple
 
       # @return [String] The template description.
       attr_accessor :description
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/template_record.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class TemplateRecord < Base
+
       # @return [Integer] The template record ID in DNSimple.
       attr_accessor :id
 
@@ -30,7 +30,7 @@ module Dnsimple
 
       # @return [String] When the template record was last updated in DNSimple.
       attr_accessor :updated_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/tld.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class Tld < Base
+
       # @return [String] The TLD in DNSimple.
       attr_accessor :tld
 
@@ -33,7 +33,7 @@ module Dnsimple
 
       # @return [String, nil] Type of data interface required for DNSSEC for this TLD.
       attr_accessor :dnssec_interface_type
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/transfer_lock.rb

@@ -2,11 +2,11 @@
 
 module Dnsimple
   module Struct
-
     class TransferLock < Base
+
       # @return [Boolean] True if Transfer Lock is enabled on the domain, otherwise false
       attr_accessor :enabled
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/user.rb

@@ -2,14 +2,14 @@
 
 module Dnsimple
   module Struct
-
     class User < Base
+
       # @return [Integer] The user ID in DNSimple.
       attr_accessor :id
 
       # @return [String] The user email.
       attr_accessor :email
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/vanity_name_server.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class VanityNameServer < Base
+
       # @return [Integer] The vanity name server ID in DNSimple.
       attr_accessor :id
 
@@ -21,7 +21,7 @@ module Dnsimple
 
       # @return [String] When the vanity name server was last updated in DNSimple.
       attr_accessor :updated_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/webhook.rb

@@ -2,14 +2,14 @@
 
 module Dnsimple
   module Struct
-
     class Webhook < Base
+
       # @return [Integer] The contact ID in DNSimple.
       attr_accessor :id
 
       # @return [String] The callback URL.
       attr_accessor :url
-    end
 
+    end
   end
 end