Class: Inttegro::PaymentMethod::UpdateRequest

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/payment_method/update_request.rb

Overview

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

#active ⇒ Boolean? (readonly)

Set to true to activate the payment method or false to mark it inactive.

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

Returns:

  • (Boolean, nil) 


50
51
52
53
54
55
56
 
# File 'lib/inttegro/payment_method/update_request.rb', line 50

class UpdateRequest < T::Struct
  const :payment_method_id, String
  const :custom_data, T.nilable(Inttegro::CustomDataPatch), default: nil
  const :active, T.nilable(T::Boolean), default: nil
  const :archived, T.nilable(T::Boolean), default: nil
  const :owner, T.nilable(Inttegro::PaymentMethod::UpdateRequestOwner), default: nil
end

#archived ⇒ Boolean? (readonly)

Set to true to archive the payment method or false to unarchive it.

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

Returns:

  • (Boolean, nil) 


50
51
52
53
54
55
56
 
# File 'lib/inttegro/payment_method/update_request.rb', line 50

class UpdateRequest < T::Struct
  const :payment_method_id, String
  const :custom_data, T.nilable(Inttegro::CustomDataPatch), default: nil
  const :active, T.nilable(T::Boolean), default: nil
  const :archived, T.nilable(T::Boolean), default: nil
  const :owner, T.nilable(Inttegro::PaymentMethod::UpdateRequestOwner), default: nil
end

#custom_data ⇒ Inttegro::CustomDataPatch? (readonly)

Changes to merchant-defined data. JSON null removes a key; every other JSON value is serialized to a string.

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

Returns:



50
51
52
53
54
55
56
 
# File 'lib/inttegro/payment_method/update_request.rb', line 50

class UpdateRequest < T::Struct
  const :payment_method_id, String
  const :custom_data, T.nilable(Inttegro::CustomDataPatch), default: nil
  const :active, T.nilable(T::Boolean), default: nil
  const :archived, T.nilable(T::Boolean), default: nil
  const :owner, T.nilable(Inttegro::PaymentMethod::UpdateRequestOwner), default: nil
end

#owner ⇒ Inttegro::PaymentMethod::UpdateRequestOwner? (readonly)

Owner details to patch onto the payment method.

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

Returns:



50
51
52
53
54
55
56
 
# File 'lib/inttegro/payment_method/update_request.rb', line 50

class UpdateRequest < T::Struct
  const :payment_method_id, String
  const :custom_data, T.nilable(Inttegro::CustomDataPatch), default: nil
  const :active, T.nilable(T::Boolean), default: nil
  const :archived, T.nilable(T::Boolean), default: nil
  const :owner, T.nilable(Inttegro::PaymentMethod::UpdateRequestOwner), default: nil
end

#payment_method_id ⇒ String (readonly)

ID of the payment method to update

Required in the API payload. Wire name: payment_method_id.

Returns:

  • (String) 


50
51
52
53
54
55
56
 
# File 'lib/inttegro/payment_method/update_request.rb', line 50

class UpdateRequest < T::Struct
  const :payment_method_id, String
  const :custom_data, T.nilable(Inttegro::CustomDataPatch), default: nil
  const :active, T.nilable(T::Boolean), default: nil
  const :archived, T.nilable(T::Boolean), default: nil
  const :owner, T.nilable(Inttegro::PaymentMethod::UpdateRequestOwner), default: nil
end