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

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

Classes: DNSRecord

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(items:) ⇒ Object

Parameters:



15
16
17
18
19
20
21
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
50
51
52
53
54
55
56
57
58
59
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
129
 
# File 'lib/zavudev/models/email_domain_list_response.rb', line 15

class Item < Zavudev::Internal::Type::BaseModel
  # @!attribute id
  #
  #   @return [String]
  required :id, String

  # @!attribute dkim_status
  #
  #   @return [String]
  required :dkim_status, String, api_name: :dkimStatus

  # @!attribute domain
  #
  #   @return [String]
  required :domain, String

  # @!attribute status
  #   Overall verification status.
  #
  #   @return [String]
  required :status, String

  # @!attribute dns_records
  #   DNS records to publish. Present when fetching a single domain or after adding
  #   one.
  #
  #   @return [Array<Zavudev::Models::EmailDomainListResponse::Item::DNSRecord>, nil]
  optional :dns_records,
           -> { Zavudev::Internal::Type::ArrayOf[Zavudev::Models::EmailDomainListResponse::Item::DNSRecord] },
           api_name: :dnsRecords

  # @!method initialize(id:, dkim_status:, domain:, status:, dns_records: nil)
  #   Some parameter documentations has been truncated, see
  #   {Zavudev::Models::EmailDomainListResponse::Item} for more details.
  #
  #   @param id [String]
  #
  #   @param dkim_status [String]
  #
  #   @param domain [String]
  #
  #   @param status [String] Overall verification status.
  #
  #   @param dns_records [Array<Zavudev::Models::EmailDomainListResponse::Item::DNSRecord>] DNS records to publish. Present when fetching a single domain or after adding on

  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
end

Instance Attribute Details

#dkim_status ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :dkim_status, String, api_name: :dkimStatus

#dns_records ⇒ Array<Zavudev::Models::EmailDomainListResponse::Item::DNSRecord>?

DNS records to publish. Present when fetching a single domain or after adding one.

Returns:



42
43
44
 
# File 'lib/zavudev/models/email_domain_list_response.rb', line 42

optional :dns_records,
-> { Zavudev::Internal::Type::ArrayOf[Zavudev::Models::EmailDomainListResponse::Item::DNSRecord] },
api_name: :dnsRecords

#domain ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :domain, String

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#status ⇒ String

Overall verification status.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :status, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {