Class: Inttegro::Order::CancelRequest

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/order/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

#execute_refund ⇒ Boolean? (readonly)

Whether the cancellation evidence should record that a refund was requested. This does not execute a refund.

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

Returns:

  • (Boolean, nil) 


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

class CancelRequest < T::Struct
  const :order_id, String
  const :reason, T.nilable(String), default: nil
  const :execute_refund, T.nilable(T::Boolean), default: nil
end

#order_id ⇒ String (readonly)

Unique identifier of the order to cancel

Required in the API payload. Wire name: order_id.

Returns:

  • (String) 


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

class CancelRequest < T::Struct
  const :order_id, String
  const :reason, T.nilable(String), default: nil
  const :execute_refund, T.nilable(T::Boolean), default: nil
end

#reason ⇒ String? (readonly)

Optional reason for cancelling the order

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

Returns:

  • (String, nil) 


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

class CancelRequest < T::Struct
  const :order_id, String
  const :reason, T.nilable(String), default: nil
  const :execute_refund, T.nilable(T::Boolean), default: nil
end