Class: Inttegro::Chime::SendRequest

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

Overview

Request to send a chime to a recipient. SMS recipients accept either full_message or message_template. Email recipients accept either email or message_template.

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

#cooldown ⇒ Inttegro::Chime::SendRequestCooldown? (readonly)

Optional application-scoped delivery cooldown. A repeat send with the same key is rejected until the duration elapses.

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

Returns:



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/inttegro/chime/send_request.rb', line 80

class SendRequest < T::Struct
  const :recipient, Inttegro::Chime::Recipient
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :cooldown, T.nilable(Inttegro::Chime::SendRequestCooldown), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :request_meta, T.nilable(Inttegro::Chime::SendRequestRequestMeta), 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:



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/inttegro/chime/send_request.rb', line 80

class SendRequest < T::Struct
  const :recipient, Inttegro::Chime::Recipient
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :cooldown, T.nilable(Inttegro::Chime::SendRequestCooldown), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :request_meta, T.nilable(Inttegro::Chime::SendRequestRequestMeta), default: nil
end

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

Email content accepted for email chimes, broadcasts, and schedules.

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

Returns:



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/inttegro/chime/send_request.rb', line 80

class SendRequest < T::Struct
  const :recipient, Inttegro::Chime::Recipient
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :cooldown, T.nilable(Inttegro::Chime::SendRequestCooldown), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :request_meta, T.nilable(Inttegro::Chime::SendRequestRequestMeta), default: nil
end

#full_message ⇒ String? (readonly)

Complete SMS message content. Use only with SMS recipients.

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

Returns:

  • (String, nil) 


80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/inttegro/chime/send_request.rb', line 80

class SendRequest < T::Struct
  const :recipient, Inttegro::Chime::Recipient
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :cooldown, T.nilable(Inttegro::Chime::SendRequestCooldown), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :request_meta, T.nilable(Inttegro::Chime::SendRequestRequestMeta), default: nil
end

#message_template ⇒ Inttegro::MessageTemplate::Reference? (readonly)

Value of the message_template field in the Inttegro API payload.

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

Returns:



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/inttegro/chime/send_request.rb', line 80

class SendRequest < T::Struct
  const :recipient, Inttegro::Chime::Recipient
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :cooldown, T.nilable(Inttegro::Chime::SendRequestCooldown), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :request_meta, T.nilable(Inttegro::Chime::SendRequestRequestMeta), default: nil
end

#purpose ⇒ String? (readonly)

Purpose of this chime for categorization and analytics

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

Returns:

  • (String, nil) 


80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/inttegro/chime/send_request.rb', line 80

class SendRequest < T::Struct
  const :recipient, Inttegro::Chime::Recipient
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :cooldown, T.nilable(Inttegro::Chime::SendRequestCooldown), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :request_meta, T.nilable(Inttegro::Chime::SendRequestRequestMeta), default: nil
end

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

Value of the recipient field in the Inttegro API payload.

Required in the API payload. Wire name: recipient.

Returns:



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/inttegro/chime/send_request.rb', line 80

class SendRequest < T::Struct
  const :recipient, Inttegro::Chime::Recipient
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :cooldown, T.nilable(Inttegro::Chime::SendRequestCooldown), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :request_meta, T.nilable(Inttegro::Chime::SendRequestRequestMeta), default: nil
end

#request_meta ⇒ Inttegro::Chime::SendRequestRequestMeta? (readonly)

Optional metadata controlling request processing

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

Returns:



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/inttegro/chime/send_request.rb', line 80

class SendRequest < T::Struct
  const :recipient, Inttegro::Chime::Recipient
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :cooldown, T.nilable(Inttegro::Chime::SendRequestCooldown), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :request_meta, T.nilable(Inttegro::Chime::SendRequestRequestMeta), default: nil
end

#sender_id ⇒ String? (readonly)

Sender identifier shown to recipient. Uses default sender if not provided.

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

Returns:

  • (String, nil) 


80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/inttegro/chime/send_request.rb', line 80

class SendRequest < T::Struct
  const :recipient, Inttegro::Chime::Recipient
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
  const :cooldown, T.nilable(Inttegro::Chime::SendRequestCooldown), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :request_meta, T.nilable(Inttegro::Chime::SendRequestRequestMeta), default: nil
end