Class: Inttegro::OTP::Transaction

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/otp/transaction.rb

Overview

OTP transaction object returned by initiate, verify, and lookup endpoints

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

#cancel_reason ⇒ String? (readonly)

Omitted unless the transaction was canceled.

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

Returns:

  • (String, nil) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/otp/transaction.rb', line 67

class Transaction < T::Struct
  const :cancel_reason, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :expires_at, Time
  const :full_message, String
  const :id, String
  const :initiated_at, Time
  const :status, Inttegro::OTP::Status
  const :transmission, T.nilable(Inttegro::OTP::Transmission), default: nil
end

#canceled_at ⇒ Time? (readonly)

Omitted unless the transaction was canceled.

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

Returns:

  • (Time, nil) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/otp/transaction.rb', line 67

class Transaction < T::Struct
  const :cancel_reason, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :expires_at, Time
  const :full_message, String
  const :id, String
  const :initiated_at, Time
  const :status, Inttegro::OTP::Status
  const :transmission, T.nilable(Inttegro::OTP::Transmission), default: nil
end

#expires_at ⇒ Time (readonly)

Value of the expires_at field in the Inttegro API payload.

Required in the API payload. Wire name: expires_at.

Returns:

  • (Time) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/otp/transaction.rb', line 67

class Transaction < T::Struct
  const :cancel_reason, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :expires_at, Time
  const :full_message, String
  const :id, String
  const :initiated_at, Time
  const :status, Inttegro::OTP::Status
  const :transmission, T.nilable(Inttegro::OTP::Transmission), default: nil
end

#full_message ⇒ String (readonly)

Message text with the {token} placeholder preserved; no generated token is returned.

Required in the API payload. Wire name: full_message.

Returns:

  • (String) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/otp/transaction.rb', line 67

class Transaction < T::Struct
  const :cancel_reason, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :expires_at, Time
  const :full_message, String
  const :id, String
  const :initiated_at, Time
  const :status, Inttegro::OTP::Status
  const :transmission, T.nilable(Inttegro::OTP::Transmission), default: nil
end

#id ⇒ String (readonly)

Unique identifier with ot_ prefix

Required in the API payload. Wire name: id.

Returns:

  • (String) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/otp/transaction.rb', line 67

class Transaction < T::Struct
  const :cancel_reason, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :expires_at, Time
  const :full_message, String
  const :id, String
  const :initiated_at, Time
  const :status, Inttegro::OTP::Status
  const :transmission, T.nilable(Inttegro::OTP::Transmission), default: nil
end

#initiated_at ⇒ Time (readonly)

Value of the initiated_at field in the Inttegro API payload.

Required in the API payload. Wire name: initiated_at.

Returns:

  • (Time) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/otp/transaction.rb', line 67

class Transaction < T::Struct
  const :cancel_reason, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :expires_at, Time
  const :full_message, String
  const :id, String
  const :initiated_at, Time
  const :status, Inttegro::OTP::Status
  const :transmission, T.nilable(Inttegro::OTP::Transmission), default: nil
end

#status ⇒ Inttegro::OTP::Status (readonly)

Value of the status field in the Inttegro API payload.

Required in the API payload. Wire name: status.

Returns:



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/otp/transaction.rb', line 67

class Transaction < T::Struct
  const :cancel_reason, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :expires_at, Time
  const :full_message, String
  const :id, String
  const :initiated_at, Time
  const :status, Inttegro::OTP::Status
  const :transmission, T.nilable(Inttegro::OTP::Transmission), default: nil
end

#transmission ⇒ Inttegro::OTP::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:



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/otp/transaction.rb', line 67

class Transaction < T::Struct
  const :cancel_reason, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :expires_at, Time
  const :full_message, String
  const :id, String
  const :initiated_at, Time
  const :status, Inttegro::OTP::Status
  const :transmission, T.nilable(Inttegro::OTP::Transmission), default: nil
end