dnsimple 4.0.0 → 4.1.0

data/lib/dnsimple/client/registrar_whois_privacy.rb

@@ -9,7 +9,7 @@ module Dnsimple
       # @example Get the whois privacy for "example.com":
       #   client.registrar.whois_privacy(1010, "example.com")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name
       # @param  [Hash] options
       # @return [Struct::WhoisPrivacy]
@@ -29,7 +29,7 @@ module Dnsimple
       # @example Enable whois privacy for "example.com":
       #   client.registrar.enable_whois_privacy(1010, "example.com")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name
       # @param  [Hash] options
       # @return [Struct::WhoisPrivacy]
@@ -49,7 +49,7 @@ module Dnsimple
       # @example Disable whois privacy for "example.com":
       #   client.registrar.disable_whois_privacy(1010, "example.com")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name The domain name to check.
       # @param  [Hash] options
       # @return [Struct::WhoisPrivacy]

data/lib/dnsimple/client/services_domains.rb

@@ -15,7 +15,7 @@ module Dnsimple
       # @example List applied one-click services for example.com, provide a sorting policy:
       #   client.services.applied_services(1010, "example.com", sort: "short_name:asc")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id the domain name
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
@@ -41,7 +41,7 @@ module Dnsimple
       # @example Apply one-click service service1 to example.com, provide optional settings:
       #   client.domain_services.applied_services(1010, "example.com", "service1", app: "foo")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] service_id the service name (or ID)
       # @param  [#to_s] domain_id the domain name
       # @param  [Hash] settings optional settings to apply the one-click service
@@ -63,7 +63,7 @@ module Dnsimple
       # @example Unapply one-click service service1 from example.com:
       #   client.domain_services.applied_services(1010, "example.com", "service1")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] service_id the service name (or ID)
       # @param  [#to_s] domain_id the domain name
       # @param  [Hash] options

data/lib/dnsimple/client/templates.rb

@@ -15,7 +15,7 @@ module Dnsimple
       # @example List the templates for account 1010, provide sorting policy:
       #   client.templates.list_templates(1010, sort: "short_name:asc")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
@@ -45,7 +45,7 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/templates/#list
       # @see #templates
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
@@ -64,7 +64,7 @@ module Dnsimple
       # @example Creating a template:
       #   client.templates.create_template(1010, name: "Pi", short_name: "pi", description: "Pi template")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] attributes
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Template>]
@@ -84,7 +84,7 @@ module Dnsimple
       # @example Get template 5401 in account 1010:
       #   client.templates.template(1010, 5401)
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] template_id The template ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Template>]
@@ -104,7 +104,7 @@ module Dnsimple
       # @example Change the name of template 1 in account 1010:
       #   client.templates.update_template(1010, 1, name: "New name")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] template_id The template ID
       # @param  [Hash] attributes
       # @param  [Hash] options
@@ -127,7 +127,7 @@ module Dnsimple
       # @example Delete template 5401 in account 1010:
       #   client.templates.delete_template(1010, 5401)
       #
-      # @param  [Fixnum] account_id The account ID
+      # @param  [Integer] account_id The account ID
       # @param  [#to_s] template_id The template ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]

data/lib/dnsimple/client/templates_domains.rb

@@ -9,7 +9,7 @@ module Dnsimple
       # @example Apply template 5401 for example.com in account 1010:
       #   client.templates.apply_template(1010, 5401, "example.com")
       #
-      # @param  [Fixnum] account_id The account ID
+      # @param  [Integer] account_id The account ID
       # @param  [#to_s] template_id The template ID
       # @param  [#to_s] domain_id The Domain ID or name
       # @param  [Hash] options

data/lib/dnsimple/client/templates_records.rb

@@ -16,7 +16,7 @@ module Dnsimple
       # @example List records for the template "alpha", providing sorting policy
       #   client.templates.records(1010, "alpha", sort: "type:asc")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [String] template_id the template name
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
@@ -48,7 +48,7 @@ module Dnsimple
       # @example List all the records for "alpha template
       #   client.templates.all_records(1010, "alpha")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [String] template_id the template name
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
@@ -69,7 +69,7 @@ module Dnsimple
       # @example Create an A record for "alpha" template
       #   client.templates.create_record(1010, "alpha", name: "", type: "A", content: "192.168.1.1", ttl: 600)
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [String] template_id the template name
       # @param  [Hash] attributes
       # @param  [Hash] options
@@ -92,9 +92,9 @@ module Dnsimple
       # @example Get record 123 in "alpha template
       #   client.templates.record(1010, "alpha", 123)
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [String] template_id the template name
-      # @param  [Fixnum] record_id the record ID
+      # @param  [Integer] record_id the record ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::TemplateRecord>]
       #
@@ -116,9 +116,9 @@ module Dnsimple
       # @example Delete record 123 in "alpha template
       #   client.templates.delete_record(1010, "alpha", 123)
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [String] template_id the template name
-      # @param  [Fixnum] record_id the record ID
+      # @param  [Integer] record_id the record ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]
       #

data/lib/dnsimple/client/vanity_name_servers.rb

@@ -9,7 +9,7 @@ module Dnsimple
       # @example Enable vanity name servers for example.com:
       #   client.vanity_name_servers.enable(1010, "example.com")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name
       # @param  [Hash] options
       # @return [Dnsimple::Response<Array>]
@@ -29,7 +29,7 @@ module Dnsimple
       # @example Disable vanity name servers for example.com:
       #   client.vanity_name_servers.disable(1010, "example.com")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]

data/lib/dnsimple/client/webhooks.rb

@@ -15,7 +15,7 @@ module Dnsimple
       # @example List all webhooks, provide sorting policy
       #   client.webhooks.list(1010, sort: "id:asc")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
@@ -35,7 +35,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/webhooks/#create
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] attributes
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Webhook>]
@@ -53,7 +53,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/webhooks/#get
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] webhook_id The webhook ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Webhook>]
@@ -72,7 +72,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/webooks/#delete
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] webhook_id The webhook ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]

data/lib/dnsimple/client/zones.rb

@@ -19,7 +19,7 @@ module Dnsimple
       # @example List zones, provide filtering policy
       #   client.zones.list(1010, "example.com", filter: { name_like: "example" })
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
@@ -47,7 +47,7 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/zones/#list
       # @see #zones
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
@@ -64,7 +64,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/zones/#get
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] zone_id the zone name
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Zone>]
@@ -81,7 +81,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/zones/#get-file
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] zone_name the zone name
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::ZoneFile>]

data/lib/dnsimple/client/zones_records.rb

@@ -19,7 +19,7 @@ module Dnsimple
       # @example List records for the zone "example.com", provide filtering policy
       #   client.zones.records(1010, "example.com", sort: "type:asc")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
@@ -52,7 +52,7 @@ module Dnsimple
       # @example List all records for the zone "example.com"
       #   client.zones.all_records(1010, "example.com")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
@@ -75,7 +75,7 @@ module Dnsimple
       # @example Create a URL record in zone "example.com"
       #   client.zones.create_record(1010, "example.com", name: "www", type: "url", content: "example.com")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
       # @param  [Hash] attributes
       # @param  [Hash] options
@@ -98,9 +98,9 @@ module Dnsimple
       # @example Get record 123 in zone "example.com"
       #   client.zones.record(1010, "example.com", 123)
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
-      # @param  [Fixnum] record_id the record ID
+      # @param  [Integer] record_id the record ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::ZoneRecord>]
       #
@@ -119,9 +119,9 @@ module Dnsimple
       # @example Update the TTL to 600 of record 123 in zone "example.com"
       #   client.zones.update_record(1010, "example.com", 123, ttl: 600)
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
-      # @param  [Fixnum] record_id the record ID
+      # @param  [Integer] record_id the record ID
       # @param  [Hash] attributes
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::ZoneRecord>]
@@ -144,9 +144,9 @@ module Dnsimple
       # @example Delete record 123 in zone "example.com"
       #   client.zones.delete_record(1010, "example.com", 123)
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
-      # @param  [Fixnum] record_id the record ID
+      # @param  [Integer] record_id the record ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]
       #

data/lib/dnsimple/response.rb

@@ -11,15 +11,15 @@ module Dnsimple
     # @return [Struct::Base, Array] The content of the response data field.
     attr_reader :data
 
-    # @return [Fixnum] The maximum number of requests this authentication context can perform per hour.
+    # @return [Integer] The maximum number of requests this authentication context can perform per hour.
     # @see https://developer.dnsimple.com/v2/#rate-limiting
     attr_reader :rate_limit
 
-    # @return [Fixnum] The number of requests remaining in the current rate limit window.
+    # @return [Integer] The number of requests remaining in the current rate limit window.
     # @see https://developer.dnsimple.com/v2/#rate-limiting
     attr_reader :rate_limit_remaining
 
-    # @return [Fixnum] The time at which the current rate limit window in Unix time format.
+    # @return [Integer] The time at which the current rate limit window in Unix time format.
     # @see https://developer.dnsimple.com/v2/#rate-limiting
     attr_reader :rate_limit_reset
 
@@ -47,16 +47,16 @@ module Dnsimple
   # The PaginatedResponse is a specific type of Response that also exposes pagination metadata.
   class PaginatedResponse < CollectionResponse
 
-    # @return [Fixnum] The current page.
+    # @return [Integer] The current page.
     attr_reader :page
 
-    # @return [Fixnum] The number of records per page.
+    # @return [Integer] The number of records per page.
     attr_reader :per_page
 
-    # @return [Fixnum] The total number of records.
+    # @return [Integer] The total number of records.
     attr_reader :total_entries
 
-    # @return [Fixnum] The total number of pages.
+    # @return [Integer] The total number of pages.
     attr_reader :total_pages
 
 

data/lib/dnsimple/struct.rb

@@ -20,7 +20,11 @@ require_relative 'struct/certificate'
 require_relative 'struct/certificate_bundle'
 require_relative 'struct/domain'
 require_relative 'struct/domain_check'
+require_relative 'struct/domain_premium_price'
 require_relative 'struct/domain_push'
+require_relative 'struct/domain_registration'
+require_relative 'struct/domain_transfer'
+require_relative 'struct/domain_renewal'
 require_relative 'struct/email_forward'
 require_relative 'struct/extended_attribute'
 require_relative 'struct/oauth_token'

data/lib/dnsimple/struct/account.rb

@@ -2,7 +2,7 @@ module Dnsimple
   module Struct
 
     class Account < Base
-      # @return [Fixnum] The account ID in DNSimple.
+      # @return [Integer] The account ID in DNSimple.
       attr_accessor :id
 
       # @return [String] The account email.

data/lib/dnsimple/struct/certificate.rb

@@ -2,16 +2,16 @@ module Dnsimple
   module Struct
 
     class Certificate < Base
-      # @return [Fixnum] The certificate ID in DNSimple.
+      # @return [Integer] The certificate ID in DNSimple.
       attr_accessor :id
 
-      # @return [Fixnum] The associated domain ID.
+      # @return [Integer] The associated domain ID.
       attr_accessor :domain_id
 
       # @return [String] The certificate common name.
       attr_accessor :common_name
 
-      # @return [Fixnum] The years the certificate will last.
+      # @return [Integer] The years the certificate will last.
       attr_accessor :years
 
       # @return [String] The certificate CSR.

data/lib/dnsimple/struct/collaborator.rb

@@ -2,16 +2,16 @@ module Dnsimple
   module Struct
 
     class Collaborator < Base
-      # @return [Fixnum] The collaborator ID in DNSimple.
+      # @return [Integer] The collaborator ID in DNSimple.
       attr_accessor :id
 
-      # @return [Fixnum] The associated domain ID.
+      # @return [Integer] The associated domain ID.
       attr_accessor :domain_id
 
       # @return [String] The associated domain name.
       attr_accessor :domain_name
 
-      # @return [Fixnum,NilClass] The user ID, if the collaborator accepted the invitation.
+      # @return [Integer, NilClass] The user ID, if the collaborator accepted the invitation.
       attr_accessor :user_id
 
       # @return [String] The user email.

data/lib/dnsimple/struct/contact.rb

@@ -2,10 +2,10 @@ module Dnsimple
   module Struct
 
     class Contact < Base
-      # @return [Fixnum] The contact ID in DNSimple.
+      # @return [Integer] The contact ID in DNSimple.
       attr_accessor :id
 
-      # @return [Fixnum] The associated account ID.
+      # @return [Integer] The associated account ID.
       attr_accessor :account_id
 
       # @return [String] The label to represent the contact.

data/lib/dnsimple/struct/domain.rb

@@ -2,13 +2,13 @@ module Dnsimple
   module Struct
 
     class Domain < Base
-      # @return [Fixnum] The domain ID in DNSimple.
+      # @return [Integer] The domain ID in DNSimple.
       attr_accessor :id
 
-      # @return [Fixnum] The associated account ID.
+      # @return [Integer] The associated account ID.
       attr_accessor :account_id
 
-      # @return [Fixnum] The associated registrant (contact) ID.
+      # @return [Integer] The associated registrant (contact) ID.
       attr_accessor :registrant_id
 
       # @return [String] The domain name.