Class: GandiV5::Domain::Availability::Product

Inherits:
Object
  • Object
show all
Includes:
GandiV5::Data
Defined in:
lib/gandi_v5/domain/availability/product.rb,
lib/gandi_v5/domain/availability/product/price.rb,
lib/gandi_v5/domain/availability/product/period.rb

Overview

Information about an available product.

Defined Under Namespace

Classes: Period, Price

Constant Summary collapse

STATUSES = 
{
  available: 'Domain name is available',
  available_reserved: 'Domain name reserved under special conditions',
  available_preorder: 'Domain name can be pre-ordered',
  unavailable: 'Domain name is not available',
  unavailable_premium: 'Domain name is not available',
  unavailable_restricted: 'Domain name is not available (forbidden)',
  error_invalid: 'Provided value is not a valid domain name',
  error_refused: 'Service is temporarily down',
  error_timeout: 'Service timed out, try the method again later',
  error_unknown: 'Internal server error',
  reserved_corporate: 'The TLD for the given domain name is reserved for ' \
                      'Gandi Corporate Services customers',
  pending: 'Result is not yet ready, try the method again later',
  error_eoi: 'The TLD for the given domain name is in an ' \
             'Expression of Interest (EOI) period'
}.freeze

Instance Attribute Summary collapse

Method Summary

Methods included from GandiV5::Data

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

Instance Attribute Details

#name ⇒ String (readonly)

Returns:

  • (String) 


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/gandi_v5/domain/availability/product.rb', line 22

class Product
  include GandiV5::Data

  STATUSES = {
    available: 'Domain name is available',
    available_reserved: 'Domain name reserved under special conditions',
    available_preorder: 'Domain name can be pre-ordered',
    unavailable: 'Domain name is not available',
    unavailable_premium: 'Domain name is not available',
    unavailable_restricted: 'Domain name is not available (forbidden)',
    error_invalid: 'Provided value is not a valid domain name',
    error_refused: 'Service is temporarily down',
    error_timeout: 'Service timed out, try the method again later',
    error_unknown: 'Internal server error',
    reserved_corporate: 'The TLD for the given domain name is reserved for ' \
                        'Gandi Corporate Services customers',
    pending: 'Result is not yet ready, try the method again later',
    error_eoi: 'The TLD for the given domain name is in an ' \
               'Expression of Interest (EOI) period'
  }.freeze

  members :name
  member :prices, converter: GandiV5::Domain::Availability::Product::Price, array: true
  member :periods, converter: GandiV5::Domain::Availability::Product::Period, array: true
  member :process, converter: GandiV5::Data::Converter::Symbol
  member :status, converter: GandiV5::Data::Converter::Symbol
  member :taxes, converter: GandiV5::Domain::Availability::Tax, array: true
end

#periods ⇒ Array<GandiV5::Domain::Availability::Product::Period> (readonly)

Returns:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/gandi_v5/domain/availability/product.rb', line 22

class Product
  include GandiV5::Data

  STATUSES = {
    available: 'Domain name is available',
    available_reserved: 'Domain name reserved under special conditions',
    available_preorder: 'Domain name can be pre-ordered',
    unavailable: 'Domain name is not available',
    unavailable_premium: 'Domain name is not available',
    unavailable_restricted: 'Domain name is not available (forbidden)',
    error_invalid: 'Provided value is not a valid domain name',
    error_refused: 'Service is temporarily down',
    error_timeout: 'Service timed out, try the method again later',
    error_unknown: 'Internal server error',
    reserved_corporate: 'The TLD for the given domain name is reserved for ' \
                        'Gandi Corporate Services customers',
    pending: 'Result is not yet ready, try the method again later',
    error_eoi: 'The TLD for the given domain name is in an ' \
               'Expression of Interest (EOI) period'
  }.freeze

  members :name
  member :prices, converter: GandiV5::Domain::Availability::Product::Price, array: true
  member :periods, converter: GandiV5::Domain::Availability::Product::Period, array: true
  member :process, converter: GandiV5::Data::Converter::Symbol
  member :status, converter: GandiV5::Data::Converter::Symbol
  member :taxes, converter: GandiV5::Domain::Availability::Tax, array: true
end

#prices ⇒ Array<GandiV5::Domain::Availability::Product::Price> (readonly)

Returns:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/gandi_v5/domain/availability/product.rb', line 22

class Product
  include GandiV5::Data

  STATUSES = {
    available: 'Domain name is available',
    available_reserved: 'Domain name reserved under special conditions',
    available_preorder: 'Domain name can be pre-ordered',
    unavailable: 'Domain name is not available',
    unavailable_premium: 'Domain name is not available',
    unavailable_restricted: 'Domain name is not available (forbidden)',
    error_invalid: 'Provided value is not a valid domain name',
    error_refused: 'Service is temporarily down',
    error_timeout: 'Service timed out, try the method again later',
    error_unknown: 'Internal server error',
    reserved_corporate: 'The TLD for the given domain name is reserved for ' \
                        'Gandi Corporate Services customers',
    pending: 'Result is not yet ready, try the method again later',
    error_eoi: 'The TLD for the given domain name is in an ' \
               'Expression of Interest (EOI) period'
  }.freeze

  members :name
  member :prices, converter: GandiV5::Domain::Availability::Product::Price, array: true
  member :periods, converter: GandiV5::Domain::Availability::Product::Period, array: true
  member :process, converter: GandiV5::Data::Converter::Symbol
  member :status, converter: GandiV5::Data::Converter::Symbol
  member :taxes, converter: GandiV5::Domain::Availability::Tax, array: true
end

#process ⇒ Symbol (readonly)

Returns:

  • (Symbol) 


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/gandi_v5/domain/availability/product.rb', line 22

class Product
  include GandiV5::Data

  STATUSES = {
    available: 'Domain name is available',
    available_reserved: 'Domain name reserved under special conditions',
    available_preorder: 'Domain name can be pre-ordered',
    unavailable: 'Domain name is not available',
    unavailable_premium: 'Domain name is not available',
    unavailable_restricted: 'Domain name is not available (forbidden)',
    error_invalid: 'Provided value is not a valid domain name',
    error_refused: 'Service is temporarily down',
    error_timeout: 'Service timed out, try the method again later',
    error_unknown: 'Internal server error',
    reserved_corporate: 'The TLD for the given domain name is reserved for ' \
                        'Gandi Corporate Services customers',
    pending: 'Result is not yet ready, try the method again later',
    error_eoi: 'The TLD for the given domain name is in an ' \
               'Expression of Interest (EOI) period'
  }.freeze

  members :name
  member :prices, converter: GandiV5::Domain::Availability::Product::Price, array: true
  member :periods, converter: GandiV5::Domain::Availability::Product::Period, array: true
  member :process, converter: GandiV5::Data::Converter::Symbol
  member :status, converter: GandiV5::Data::Converter::Symbol
  member :taxes, converter: GandiV5::Domain::Availability::Tax, array: true
end

#status ⇒ Symbol (readonly)

Returns:

  • (Symbol) 


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/gandi_v5/domain/availability/product.rb', line 22

class Product
  include GandiV5::Data

  STATUSES = {
    available: 'Domain name is available',
    available_reserved: 'Domain name reserved under special conditions',
    available_preorder: 'Domain name can be pre-ordered',
    unavailable: 'Domain name is not available',
    unavailable_premium: 'Domain name is not available',
    unavailable_restricted: 'Domain name is not available (forbidden)',
    error_invalid: 'Provided value is not a valid domain name',
    error_refused: 'Service is temporarily down',
    error_timeout: 'Service timed out, try the method again later',
    error_unknown: 'Internal server error',
    reserved_corporate: 'The TLD for the given domain name is reserved for ' \
                        'Gandi Corporate Services customers',
    pending: 'Result is not yet ready, try the method again later',
    error_eoi: 'The TLD for the given domain name is in an ' \
               'Expression of Interest (EOI) period'
  }.freeze

  members :name
  member :prices, converter: GandiV5::Domain::Availability::Product::Price, array: true
  member :periods, converter: GandiV5::Domain::Availability::Product::Period, array: true
  member :process, converter: GandiV5::Data::Converter::Symbol
  member :status, converter: GandiV5::Data::Converter::Symbol
  member :taxes, converter: GandiV5::Domain::Availability::Tax, array: true
end

#taxes ⇒ Array<GandiV5::Domain::Availability::Tax> (readonly)

Returns:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/gandi_v5/domain/availability/product.rb', line 22

class Product
  include GandiV5::Data

  STATUSES = {
    available: 'Domain name is available',
    available_reserved: 'Domain name reserved under special conditions',
    available_preorder: 'Domain name can be pre-ordered',
    unavailable: 'Domain name is not available',
    unavailable_premium: 'Domain name is not available',
    unavailable_restricted: 'Domain name is not available (forbidden)',
    error_invalid: 'Provided value is not a valid domain name',
    error_refused: 'Service is temporarily down',
    error_timeout: 'Service timed out, try the method again later',
    error_unknown: 'Internal server error',
    reserved_corporate: 'The TLD for the given domain name is reserved for ' \
                        'Gandi Corporate Services customers',
    pending: 'Result is not yet ready, try the method again later',
    error_eoi: 'The TLD for the given domain name is in an ' \
               'Expression of Interest (EOI) period'
  }.freeze

  members :name
  member :prices, converter: GandiV5::Domain::Availability::Product::Price, array: true
  member :periods, converter: GandiV5::Domain::Availability::Product::Period, array: true
  member :process, converter: GandiV5::Data::Converter::Symbol
  member :status, converter: GandiV5::Data::Converter::Symbol
  member :taxes, converter: GandiV5::Domain::Availability::Tax, array: true
end