Class: Inttegro::Chime::EmailEvent

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/chime/email_event.rb

Overview

Typed representation of the email event object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#bounce_sub_type ⇒ String? (readonly)

Value of the bounce_sub_type field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: bounce_sub_type.

Returns:

  • (String, nil) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end

#bounce_type ⇒ String? (readonly)

Value of the bounce_type field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: bounce_type.

Returns:

  • (String, nil) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end

#complaint_sub_type ⇒ String? (readonly)

Value of the complaint_sub_type field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: complaint_sub_type.

Returns:

  • (String, nil) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end

#id ⇒ String (readonly)

Value of the id field in the Inttegro API payload.

Required in the API payload. Wire name: id.

Returns:

  • (String) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end

#occurred_at ⇒ Time (readonly)

Value of the occurred_at field in the Inttegro API payload.

Required in the API payload. Wire name: occurred_at.

Returns:

  • (Time) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end

#provider ⇒ String (readonly)

Value of the provider field in the Inttegro API payload.

Required in the API payload. Wire name: provider.

Returns:

  • (String) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end

#provider_message_id ⇒ String (readonly)

Value of the provider_message_id field in the Inttegro API payload.

Required in the API payload. Wire name: provider_message_id.

Returns:

  • (String) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end

#reason ⇒ String? (readonly)

Value of the reason field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: reason.

Returns:

  • (String, nil) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end

#reason_code ⇒ String? (readonly)

Value of the reason_code field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: reason_code.

Returns:

  • (String, nil) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end

#recipient ⇒ String? (readonly)

Value of the recipient field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: recipient.

Returns:

  • (String, nil) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end

#source ⇒ String? (readonly)

Value of the source field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: source.

Returns:

  • (String, nil) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end

#suppress_recipient ⇒ Boolean? (readonly)

Value of the suppress_recipient field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: suppress_recipient.

Returns:

  • (Boolean, nil) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end

#temporary ⇒ Boolean? (readonly)

Value of the temporary field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: temporary.

Returns:

  • (Boolean, nil) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end

#type ⇒ String (readonly)

Value of the type field in the Inttegro API payload.

Required in the API payload. Wire name: type.

Returns:

  • (String) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inttegro/chime/email_event.rb', line 101

class EmailEvent < T::Struct
  const :bounce_sub_type, T.nilable(String), default: nil
  const :bounce_type, T.nilable(String), default: nil
  const :complaint_sub_type, T.nilable(String), default: nil
  const :id, String
  const :occurred_at, Time
  const :provider, String
  const :provider_message_id, String
  const :reason, T.nilable(String), default: nil
  const :reason_code, T.nilable(String), default: nil
  const :recipient, T.nilable(String), default: nil
  const :source, T.nilable(String), default: nil
  const :suppress_recipient, T.nilable(T::Boolean), default: nil
  const :temporary, T.nilable(T::Boolean), default: nil
  const :type, String
end