Class: Dodopayments::Models::IntegrationConfig::DigitalFilesConfig

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/integration_config.rb

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

This class inherits a constructor from Dodopayments::Internal::Type::BaseModel

Instance Attribute Details

#digital_file_ids ⇒ Array<String>

Files attached to this entitlement. Add files via ‘POST /entitlements/id/files` and remove them via `DELETE /entitlements/id/files/file_id`.

Returns:

  • (Array<String>) 


131
 
# File 'lib/dodopayments/models/integration_config.rb', line 131

required :digital_file_ids, Dodopayments::Internal::Type::ArrayOf[String]

#external_url ⇒ String?

Optional external URL shown to the customer alongside the files.

Returns:

  • (String, nil) 


137
 
# File 'lib/dodopayments/models/integration_config.rb', line 137

optional :external_url, String, nil?: true

#instructions ⇒ String?

Optional human-readable delivery instructions shown to the customer alongside the files.

Returns:

  • (String, nil) 


144
 
# File 'lib/dodopayments/models/integration_config.rb', line 144

optional :instructions, String, nil?: true

#legacy_file_ids ⇒ Array<String>?

Three-way patchable list of legacy file identifiers:

  • omitted → preserve the current value

  • ‘null` → clear

  • ‘[…]` → replace

On create, an omitted field, an explicit ‘null`, or an empty array all result in no legacy files attached.

Returns:

  • (Array<String>, nil) 


157
 
# File 'lib/dodopayments/models/integration_config.rb', line 157

optional :legacy_file_ids, Dodopayments::Internal::Type::ArrayOf[String], nil?: true