Class: Inttegro::PurchaseIntent::UpdateRequest

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

#expires_at ⇒ Time? (readonly)

RFC3339 expiry timestamp, including a past time for immediate expiry, or null to clear expiry

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

Returns:

  • (Time, nil) 


61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/purchase_intent/update_request.rb', line 61

class UpdateRequest < T::Struct
  const :expires_at, T.nilable(Time), default: nil
  const :id, T.nilable(String), default: nil
  const :quantity, T.nilable(Inttegro::PurchaseIntent::UpdateRequestQuantity), default: nil
  const :purchase_intent_id, T.nilable(String), default: nil
  const :reactivate, T.nilable(T::Boolean), default: nil
  const :presentation, T.nilable(Inttegro::PurchaseIntent::UpdatePresentation), default: nil
end

#id ⇒ String? (readonly)

Purchase intent ID to update. Send this or purchase_intent_id.

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

Returns:

  • (String, nil) 


61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/purchase_intent/update_request.rb', line 61

class UpdateRequest < T::Struct
  const :expires_at, T.nilable(Time), default: nil
  const :id, T.nilable(String), default: nil
  const :quantity, T.nilable(Inttegro::PurchaseIntent::UpdateRequestQuantity), default: nil
  const :purchase_intent_id, T.nilable(String), default: nil
  const :reactivate, T.nilable(T::Boolean), default: nil
  const :presentation, T.nilable(Inttegro::PurchaseIntent::UpdatePresentation), default: nil
end

#presentation ⇒ Inttegro::PurchaseIntent::UpdatePresentation? (readonly)

Sparse Buy page copy update. Omit a field to preserve it, or send null to restore the product-aware default.

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

Returns:



61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/purchase_intent/update_request.rb', line 61

class UpdateRequest < T::Struct
  const :expires_at, T.nilable(Time), default: nil
  const :id, T.nilable(String), default: nil
  const :quantity, T.nilable(Inttegro::PurchaseIntent::UpdateRequestQuantity), default: nil
  const :purchase_intent_id, T.nilable(String), default: nil
  const :reactivate, T.nilable(T::Boolean), default: nil
  const :presentation, T.nilable(Inttegro::PurchaseIntent::UpdatePresentation), default: nil
end

#purchase_intent_id ⇒ String? (readonly)

Alias for id. If both are present, this value takes precedence.

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

Returns:

  • (String, nil) 


61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/purchase_intent/update_request.rb', line 61

class UpdateRequest < T::Struct
  const :expires_at, T.nilable(Time), default: nil
  const :id, T.nilable(String), default: nil
  const :quantity, T.nilable(Inttegro::PurchaseIntent::UpdateRequestQuantity), default: nil
  const :purchase_intent_id, T.nilable(String), default: nil
  const :reactivate, T.nilable(T::Boolean), default: nil
  const :presentation, T.nilable(Inttegro::PurchaseIntent::UpdatePresentation), default: nil
end

#quantity ⇒ Inttegro::PurchaseIntent::UpdateRequestQuantity? (readonly)

Replacement quantity bounds. Omit the object to preserve the current bounds. Within the object, min is required and omitting max removes the upper bound. When present, max must be greater than or equal to min.

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

Returns:



61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/purchase_intent/update_request.rb', line 61

class UpdateRequest < T::Struct
  const :expires_at, T.nilable(Time), default: nil
  const :id, T.nilable(String), default: nil
  const :quantity, T.nilable(Inttegro::PurchaseIntent::UpdateRequestQuantity), default: nil
  const :purchase_intent_id, T.nilable(String), default: nil
  const :reactivate, T.nilable(T::Boolean), default: nil
  const :presentation, T.nilable(Inttegro::PurchaseIntent::UpdatePresentation), default: nil
end

#reactivate ⇒ Boolean? (readonly)

Clears the state that prevents new purchases. For canceled Buy links this removes inactive_at. For expired Buy links this clears an existing elapsed expires_at value. It does not remove the order claim from a used single-use intent.

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

Returns:

  • (Boolean, nil) 


61
62
63
64
65
66
67
68
 
# File 'lib/inttegro/purchase_intent/update_request.rb', line 61

class UpdateRequest < T::Struct
  const :expires_at, T.nilable(Time), default: nil
  const :id, T.nilable(String), default: nil
  const :quantity, T.nilable(Inttegro::PurchaseIntent::UpdateRequestQuantity), default: nil
  const :purchase_intent_id, T.nilable(String), default: nil
  const :reactivate, T.nilable(T::Boolean), default: nil
  const :presentation, T.nilable(Inttegro::PurchaseIntent::UpdatePresentation), default: nil
end