Class: Inttegro::Order::DocumentDelivery

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/order/document_delivery.rb

Overview

Delivery result for one hosted order document link.

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

#deliveries ⇒ Array<Inttegro::Order::DocumentDeliveryAttempt>? (readonly)

Chime messages that were accepted for delivery.

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

Returns:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/order/document_delivery.rb', line 58

class DocumentDelivery < T::Struct
  const :deliveries, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryAttempt]), default: nil
  const :document_kind, T.nilable(Inttegro::Order::DocumentKind), default: nil
  const :document_url, T.nilable(String), default: nil
  const :failed_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
  const :failures, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryFailure]), default: nil
  const :sent_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
end

#document_kind ⇒ Inttegro::Order::DocumentKind? (readonly)

Hosted document that was delivered.

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

Returns:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/order/document_delivery.rb', line 58

class DocumentDelivery < T::Struct
  const :deliveries, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryAttempt]), default: nil
  const :document_kind, T.nilable(Inttegro::Order::DocumentKind), default: nil
  const :document_url, T.nilable(String), default: nil
  const :failed_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
  const :failures, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryFailure]), default: nil
  const :sent_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
end

#document_url ⇒ String? (readonly)

Hosted invoice or receipt URL sent to the customer. Receipt URLs use the hosted receipt path, not the invoice PDF path.

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

Returns:

  • (String, nil) 


58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/order/document_delivery.rb', line 58

class DocumentDelivery < T::Struct
  const :deliveries, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryAttempt]), default: nil
  const :document_kind, T.nilable(Inttegro::Order::DocumentKind), default: nil
  const :document_url, T.nilable(String), default: nil
  const :failed_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
  const :failures, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryFailure]), default: nil
  const :sent_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
end

#failed_channels ⇒ Array<Inttegro::Shared::DeliveryChannel>? (readonly)

Channels that failed to send.

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

Returns:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/order/document_delivery.rb', line 58

class DocumentDelivery < T::Struct
  const :deliveries, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryAttempt]), default: nil
  const :document_kind, T.nilable(Inttegro::Order::DocumentKind), default: nil
  const :document_url, T.nilable(String), default: nil
  const :failed_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
  const :failures, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryFailure]), default: nil
  const :sent_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
end

#failures ⇒ Array<Inttegro::Order::DocumentDeliveryFailure>? (readonly)

Per-channel delivery failures.

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

Returns:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/order/document_delivery.rb', line 58

class DocumentDelivery < T::Struct
  const :deliveries, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryAttempt]), default: nil
  const :document_kind, T.nilable(Inttegro::Order::DocumentKind), default: nil
  const :document_url, T.nilable(String), default: nil
  const :failed_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
  const :failures, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryFailure]), default: nil
  const :sent_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
end

#sent_channels ⇒ Array<Inttegro::Shared::DeliveryChannel>? (readonly)

Channels accepted by Chime.

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

Returns:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/order/document_delivery.rb', line 58

class DocumentDelivery < T::Struct
  const :deliveries, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryAttempt]), default: nil
  const :document_kind, T.nilable(Inttegro::Order::DocumentKind), default: nil
  const :document_url, T.nilable(String), default: nil
  const :failed_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
  const :failures, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryFailure]), default: nil
  const :sent_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
end