Class: Zavudev::Models::EmailDomainListResponse::Item::DNSRecord

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/zavudev/models/email_domain_list_response.rb,
sig/zavudev/models/email_domain_list_response.rbs

Defined Under Namespace

Modules: Purpose

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(name:, purpose:, required:, type:, value:, priority: nil) ⇒ Object

Some parameter documentations has been truncated, see Zavudev::Models::EmailDomainListResponse::Item::DNSRecord for more details.

Parameters:

  • name (String) —

    Record host/name to create.

  • purpose (Symbol, Zavudev::Models::EmailDomainListResponse::Item::DNSRecord::Purpose) —

    What the record is for.

  • required (Boolean) —

    Whether the record is required to verify + send (DKIM) or recommended for delive

  • type (String) —

    DNS record type.

  • value (String) —

    Record value.

  • priority (Integer) (defaults to: nil) —

    Priority (MX records only).



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/zavudev/models/email_domain_list_response.rb', line 60

class DNSRecord < Zavudev::Internal::Type::BaseModel
  # @!attribute name
  #   Record host/name to create.
  #
  #   @return [String]
  required :name, String

  # @!attribute purpose
  #   What the record is for.
  #
  #   @return [Symbol, Zavudev::Models::EmailDomainListResponse::Item::DNSRecord::Purpose]
  required :purpose, enum: -> { Zavudev::Models::EmailDomainListResponse::Item::DNSRecord::Purpose }

  # @!attribute required
  #   Whether the record is required to verify + send (DKIM) or recommended for
  #   deliverability.
  #
  #   @return [Boolean]
  required :required, Zavudev::Internal::Type::Boolean

  # @!attribute type
  #   DNS record type.
  #
  #   @return [String]
  required :type, String

  # @!attribute value
  #   Record value.
  #
  #   @return [String]
  required :value, String

  # @!attribute priority
  #   Priority (MX records only).
  #
  #   @return [Integer, nil]
  optional :priority, Integer

  # @!method initialize(name:, purpose:, required:, type:, value:, priority: nil)
  #   Some parameter documentations has been truncated, see
  #   {Zavudev::Models::EmailDomainListResponse::Item::DNSRecord} for more details.
  #
  #   @param name [String] Record host/name to create.
  #
  #   @param purpose [Symbol, Zavudev::Models::EmailDomainListResponse::Item::DNSRecord::Purpose] What the record is for.
  #
  #   @param required [Boolean] Whether the record is required to verify + send (DKIM) or recommended for delive
  #
  #   @param type [String] DNS record type.
  #
  #   @param value [String] Record value.
  #
  #   @param priority [Integer] Priority (MX records only).

  # What the record is for.
  #
  # @see Zavudev::Models::EmailDomainListResponse::Item::DNSRecord#purpose
  module Purpose
    extend Zavudev::Internal::Type::Enum

    DKIM = :dkim
    SPF = :spf
    DMARC = :dmarc
    MAIL_FROM = :mail_from

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#name ⇒ String

Record host/name to create.

Parameters:

  • value (String)

Returns:

  • (String) 


65
 
# File 'lib/zavudev/models/email_domain_list_response.rb', line 65

required :name, String

#priority ⇒ Integer?

Priority (MX records only).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


96
 
# File 'lib/zavudev/models/email_domain_list_response.rb', line 96

optional :priority, Integer

#purpose ⇒ Symbol, Zavudev::Models::EmailDomainListResponse::Item::DNSRecord::Purpose

What the record is for.

Parameters:

  • value (Zavudev::Models::EmailDomainListResponse::Item::DNSRecord::purpose)

Returns:



71
 
# File 'lib/zavudev/models/email_domain_list_response.rb', line 71

required :purpose, enum: -> { Zavudev::Models::EmailDomainListResponse::Item::DNSRecord::Purpose }

#required ⇒ Boolean

Whether the record is required to verify + send (DKIM) or recommended for deliverability.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


78
 
# File 'lib/zavudev/models/email_domain_list_response.rb', line 78

required :required, Zavudev::Internal::Type::Boolean

#type ⇒ String

DNS record type.

Parameters:

  • value (String)

Returns:

  • (String) 


84
 
# File 'lib/zavudev/models/email_domain_list_response.rb', line 84

required :type, String

#value ⇒ String

Record value.

Parameters:

  • value (String)

Returns:

  • (String) 


90
 
# File 'lib/zavudev/models/email_domain_list_response.rb', line 90

required :value, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


91
 
# File 'sig/zavudev/models/email_domain_list_response.rbs', line 91

def to_hash: -> {