Class: Inttegro::Refund::CancelRequest

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/refund/cancel_request.rb

Overview

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

#reason ⇒ String? (readonly)

Optional explanation for canceling the refund. Leading and trailing whitespace is removed.

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

Returns:

  • (String, nil) 


36
37
38
39
40
 
# File 'lib/inttegro/refund/cancel_request.rb', line 36

class CancelRequest < T::Struct
  const :refund_id, String
  const :reason, T.nilable(String), default: nil
  const :request_meta, T.nilable(Inttegro::Refund::RequestMeta), default: nil
end

#refund_id ⇒ String (readonly)

Refund to cancel before processing begins.

Required in the API payload. Wire name: refund_id.

Returns:

  • (String) 


36
37
38
39
40
 
# File 'lib/inttegro/refund/cancel_request.rb', line 36

class CancelRequest < T::Struct
  const :refund_id, String
  const :reason, T.nilable(String), default: nil
  const :request_meta, T.nilable(Inttegro::Refund::RequestMeta), default: nil
end

#request_meta ⇒ Inttegro::Refund::RequestMeta? (readonly)

Value of the request_meta field in the Inttegro API payload.

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

Returns:



36
37
38
39
40
 
# File 'lib/inttegro/refund/cancel_request.rb', line 36

class CancelRequest < T::Struct
  const :refund_id, String
  const :reason, T.nilable(String), default: nil
  const :request_meta, T.nilable(Inttegro::Refund::RequestMeta), default: nil
end