Class: Inttegro::Chime

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/chime/chime.rb,
lib/inttegro/chime/base.rb,
lib/inttegro/chime/page.rb,
lib/inttegro/chime/response.rb,
lib/inttegro/chime/recipient.rb,
lib/inttegro/chime/transport.rb,
lib/inttegro/chime/email_event.rb,
lib/inttegro/chime/page_request.rb,
lib/inttegro/chime/send_request.rb,
lib/inttegro/chime/transmission.rb,
lib/inttegro/chime/email_mailbox.rb,
lib/inttegro/chime/email_message.rb,
lib/inttegro/chime/page_response.rb,
lib/inttegro/chime/lookup_request.rb,
lib/inttegro/chime/recipient_type.rb,
lib/inttegro/chime/inline_recipient.rb,
lib/inttegro/chime/recipient_detail.rb,
lib/inttegro/chime/email_schema_kind.rb,
lib/inttegro/chime/email_scanned_link.rb,
lib/inttegro/chime/email_message_input.rb,
lib/inttegro/chime/email_safety_result.rb,
lib/inttegro/chime/email_schema_markup.rb,
lib/inttegro/chime/send_request_cooldown.rb,
lib/inttegro/chime/recipient_detail_email.rb,
lib/inttegro/chime/recipient_detail_phone.rb,
lib/inttegro/chime/saved_customer_recipient.rb,
lib/inttegro/chime/inline_recipient_variant1.rb,
lib/inttegro/chime/inline_recipient_variant2.rb,
lib/inttegro/chime/send_request_request_meta.rb,
lib/inttegro/chime/inline_recipient_variant1_type.rb,
lib/inttegro/chime/inline_recipient_variant2_type.rb,
lib/inttegro/chime/inline_recipient_variant1_phone.rb,
lib/inttegro/chime/inline_recipient_variant2_email.rb

Overview

A notification sent to one recipient

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.

Defined Under Namespace

Classes: EmailEvent, EmailMailbox, EmailMessage, EmailMessageInput, EmailSafetyResult, EmailScannedLink, EmailSchemaKind, EmailSchemaMarkup, InlineRecipientVariant1, InlineRecipientVariant1Phone, InlineRecipientVariant1Type, InlineRecipientVariant2, InlineRecipientVariant2Email, InlineRecipientVariant2Type, LookupRequest, Page, PageRequest, PageResponse, RecipientDetail, RecipientDetailEmail, RecipientDetailPhone, RecipientType, Response, SavedCustomerRecipient, SendRequest, SendRequestCooldown, SendRequestRequestMeta, Transmission, Transport

Constant Summary collapse

Recipient =

Typed representation of the recipient object in the Inttegro API.

Returns:

T.type_alias { T.any(Inttegro::Chime::InlineRecipient, Inttegro::Chime::SavedCustomerRecipient) }
InlineRecipient =

Typed representation of the inline recipient object in the Inttegro API.

Returns:

T.type_alias { T.any(Inttegro::Chime::InlineRecipientVariant1, Inttegro::Chime::InlineRecipientVariant2) }

Instance Attribute Summary collapse

Instance Attribute Details

#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) 


87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/inttegro/chime/chime.rb', line 87

class Chime
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :customer_id, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :full_message, String
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipient, Inttegro::Chime::RecipientDetail
  const :sender_id, String
  const :transmission, T.nilable(Inttegro::Chime::Transmission), default: nil
end

#custom_data ⇒ Inttegro::CustomData? (readonly)

Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.

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

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/inttegro/chime/chime.rb', line 87

class Chime
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :customer_id, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :full_message, String
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipient, Inttegro::Chime::RecipientDetail
  const :sender_id, String
  const :transmission, T.nilable(Inttegro::Chime::Transmission), default: nil
end

#customer_id ⇒ String? (readonly)

Value of the customer_id field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/inttegro/chime/chime.rb', line 87

class Chime
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :customer_id, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :full_message, String
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipient, Inttegro::Chime::RecipientDetail
  const :sender_id, String
  const :transmission, T.nilable(Inttegro::Chime::Transmission), default: nil
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:



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/inttegro/chime/chime.rb', line 87

class Chime
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :customer_id, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :full_message, String
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipient, Inttegro::Chime::RecipientDetail
  const :sender_id, String
  const :transmission, T.nilable(Inttegro::Chime::Transmission), default: nil
end

#full_message ⇒ String (readonly)

Rendered SMS content. Empty for email Chimes.

Required in the API payload. Wire name: full_message.

Returns:

  • (String) 


87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/inttegro/chime/chime.rb', line 87

class Chime
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :customer_id, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :full_message, String
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipient, Inttegro::Chime::RecipientDetail
  const :sender_id, String
  const :transmission, T.nilable(Inttegro::Chime::Transmission), default: nil
end

#id ⇒ String (readonly)

Value of the id field in the Inttegro API payload.

Required in the API payload. Wire name: id.

Returns:

  • (String) 


87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/inttegro/chime/chime.rb', line 87

class Chime
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :customer_id, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :full_message, String
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipient, Inttegro::Chime::RecipientDetail
  const :sender_id, String
  const :transmission, T.nilable(Inttegro::Chime::Transmission), default: nil
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) 


87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/inttegro/chime/chime.rb', line 87

class Chime
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :customer_id, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :full_message, String
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipient, Inttegro::Chime::RecipientDetail
  const :sender_id, String
  const :transmission, T.nilable(Inttegro::Chime::Transmission), default: nil
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) 


87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/inttegro/chime/chime.rb', line 87

class Chime
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :customer_id, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :full_message, String
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipient, Inttegro::Chime::RecipientDetail
  const :sender_id, String
  const :transmission, T.nilable(Inttegro::Chime::Transmission), default: nil
end

#recipient ⇒ Inttegro::Chime::RecipientDetail (readonly)

Recipient information in response

Required in the API payload. Wire name: recipient.

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/inttegro/chime/chime.rb', line 87

class Chime
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :customer_id, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :full_message, String
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipient, Inttegro::Chime::RecipientDetail
  const :sender_id, String
  const :transmission, T.nilable(Inttegro::Chime::Transmission), default: nil
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) 


87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/inttegro/chime/chime.rb', line 87

class Chime
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :customer_id, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :full_message, String
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipient, Inttegro::Chime::RecipientDetail
  const :sender_id, String
  const :transmission, T.nilable(Inttegro::Chime::Transmission), default: nil
end

#transmission ⇒ Inttegro::Chime::Transmission? (readonly)

Value of the transmission field in the Inttegro API payload.

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

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/inttegro/chime/chime.rb', line 87

class Chime
  const :created_at, Time
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :customer_id, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
  const :full_message, String
  const :id, String
  const :idempotency_key, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipient, Inttegro::Chime::RecipientDetail
  const :sender_id, String
  const :transmission, T.nilable(Inttegro::Chime::Transmission), default: nil
end