Class: Inttegro::Broadcast::Detail

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/broadcast/detail.rb

Overview

Typed representation of the detail 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

#chime_ids ⇒ Array<String>? (readonly)

Value of the chime_ids field in the Inttegro API payload.

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

Returns:

  • (Array<String>, nil) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inttegro/broadcast/detail.rb', line 97

class Detail < T::Struct
  const :chime_ids, T.nilable(T::Array[String]), default: nil
  const :content, String
  const :created_at, Time
  const :customer_ids, T.nilable(T::Array[String]), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
  const :executed_at, T.nilable(Time), default: nil
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[String]
  const :send_after, Time
  const :sender_id, String
end

#content ⇒ String (readonly)

Value of the content field in the Inttegro API payload.

Required in the API payload. Wire name: content.

Returns:

  • (String) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inttegro/broadcast/detail.rb', line 97

class Detail < T::Struct
  const :chime_ids, T.nilable(T::Array[String]), default: nil
  const :content, String
  const :created_at, Time
  const :customer_ids, T.nilable(T::Array[String]), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
  const :executed_at, T.nilable(Time), default: nil
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[String]
  const :send_after, Time
  const :sender_id, String
end

#created_at ⇒ Time (readonly)

Value of the created_at field in the Inttegro API payload.

Required in the API payload. Wire name: created_at.

Returns:

  • (Time) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inttegro/broadcast/detail.rb', line 97

class Detail < T::Struct
  const :chime_ids, T.nilable(T::Array[String]), default: nil
  const :content, String
  const :created_at, Time
  const :customer_ids, T.nilable(T::Array[String]), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
  const :executed_at, T.nilable(Time), default: nil
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[String]
  const :send_after, Time
  const :sender_id, String
end

#customer_ids ⇒ Array<String>? (readonly)

Value of the customer_ids field in the Inttegro API payload.

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

Returns:

  • (Array<String>, nil) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inttegro/broadcast/detail.rb', line 97

class Detail < T::Struct
  const :chime_ids, T.nilable(T::Array[String]), default: nil
  const :content, String
  const :created_at, Time
  const :customer_ids, T.nilable(T::Array[String]), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
  const :executed_at, T.nilable(Time), default: nil
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[String]
  const :send_after, Time
  const :sender_id, String
end

#email ⇒ Inttegro::Chime::EmailMessage? (readonly)

Email content, safety scan result, and system-generated schema markup for email chimes.

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

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inttegro/broadcast/detail.rb', line 97

class Detail < T::Struct
  const :chime_ids, T.nilable(T::Array[String]), default: nil
  const :content, String
  const :created_at, Time
  const :customer_ids, T.nilable(T::Array[String]), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
  const :executed_at, T.nilable(Time), default: nil
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[String]
  const :send_after, Time
  const :sender_id, String
end

#errors ⇒ Array<Inttegro::Broadcast::Error>? (readonly)

Value of the errors field in the Inttegro API payload.

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

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inttegro/broadcast/detail.rb', line 97

class Detail < T::Struct
  const :chime_ids, T.nilable(T::Array[String]), default: nil
  const :content, String
  const :created_at, Time
  const :customer_ids, T.nilable(T::Array[String]), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
  const :executed_at, T.nilable(Time), default: nil
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[String]
  const :send_after, Time
  const :sender_id, String
end

#executed_at ⇒ Time? (readonly)

Value of the executed_at field in the Inttegro API payload.

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

Returns:

  • (Time, nil) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inttegro/broadcast/detail.rb', line 97

class Detail < T::Struct
  const :chime_ids, T.nilable(T::Array[String]), default: nil
  const :content, String
  const :created_at, Time
  const :customer_ids, T.nilable(T::Array[String]), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
  const :executed_at, T.nilable(Time), default: nil
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[String]
  const :send_after, Time
  const :sender_id, 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) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inttegro/broadcast/detail.rb', line 97

class Detail < T::Struct
  const :chime_ids, T.nilable(T::Array[String]), default: nil
  const :content, String
  const :created_at, Time
  const :customer_ids, T.nilable(T::Array[String]), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
  const :executed_at, T.nilable(Time), default: nil
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[String]
  const :send_after, Time
  const :sender_id, String
end

#idempotency_key ⇒ String? (readonly)

Value of the idempotency_key field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inttegro/broadcast/detail.rb', line 97

class Detail < T::Struct
  const :chime_ids, T.nilable(T::Array[String]), default: nil
  const :content, String
  const :created_at, Time
  const :customer_ids, T.nilable(T::Array[String]), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
  const :executed_at, T.nilable(Time), default: nil
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[String]
  const :send_after, Time
  const :sender_id, String
end

#purpose ⇒ String? (readonly)

Value of the purpose field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inttegro/broadcast/detail.rb', line 97

class Detail < T::Struct
  const :chime_ids, T.nilable(T::Array[String]), default: nil
  const :content, String
  const :created_at, Time
  const :customer_ids, T.nilable(T::Array[String]), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
  const :executed_at, T.nilable(Time), default: nil
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[String]
  const :send_after, Time
  const :sender_id, String
end

#recipients ⇒ Array<String> (readonly)

Value of the recipients field in the Inttegro API payload.

Required in the API payload. Wire name: recipients.

Returns:

  • (Array<String>) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inttegro/broadcast/detail.rb', line 97

class Detail < T::Struct
  const :chime_ids, T.nilable(T::Array[String]), default: nil
  const :content, String
  const :created_at, Time
  const :customer_ids, T.nilable(T::Array[String]), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
  const :executed_at, T.nilable(Time), default: nil
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[String]
  const :send_after, Time
  const :sender_id, String
end

#send_after ⇒ Time (readonly)

Value of the send_after field in the Inttegro API payload.

Required in the API payload. Wire name: send_after.

Returns:

  • (Time) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inttegro/broadcast/detail.rb', line 97

class Detail < T::Struct
  const :chime_ids, T.nilable(T::Array[String]), default: nil
  const :content, String
  const :created_at, Time
  const :customer_ids, T.nilable(T::Array[String]), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
  const :executed_at, T.nilable(Time), default: nil
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[String]
  const :send_after, Time
  const :sender_id, String
end

#sender_id ⇒ String (readonly)

Value of the sender_id field in the Inttegro API payload.

Required in the API payload. Wire name: sender_id.

Returns:

  • (String) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inttegro/broadcast/detail.rb', line 97

class Detail < T::Struct
  const :chime_ids, T.nilable(T::Array[String]), default: nil
  const :content, String
  const :created_at, Time
  const :customer_ids, T.nilable(T::Array[String]), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
  const :executed_at, T.nilable(Time), default: nil
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[String]
  const :send_after, Time
  const :sender_id, String
end