Module: Dodopayments::Models::IntegrationConfig

Extended by:

Internal::Type::Union

Defined in:

lib/dodopayments/models/integration_config.rb,
sig/dodopayments/models/integration_config.rbs

Overview

Integration-specific configuration supplied when creating or updating an entitlement. The shape required matches the entitlement's integration_type.

Untagged enum: variants are matched in order. FeatureFlag must precede LicenseKey, whose fields are all optional and would otherwise match a feature_flag config.

Defined Under Namespace

Classes: DigitalFilesConfig, DiscordConfig, FeatureFlagConfig, FigmaConfig, FramerConfig, GitHubConfig, LicenseKeyConfig, NotionConfig, TelegramConfig

Class Method Summary

• .variants ⇒ Array(Dodopayments::Models::IntegrationConfig::FeatureFlagConfig, Dodopayments::Models::IntegrationConfig::GitHubConfig, Dodopayments::Models::IntegrationConfig::DiscordConfig, Dodopayments::Models::IntegrationConfig::TelegramConfig, Dodopayments::Models::IntegrationConfig::FigmaConfig, Dodopayments::Models::IntegrationConfig::FramerConfig, Dodopayments::Models::IntegrationConfig::NotionConfig, Dodopayments::Models::IntegrationConfig::DigitalFilesConfig, Dodopayments::Models::IntegrationConfig::LicenseKeyConfig)

Instance Method Summary

• #initialize(digital_file_ids:, external_url: nil, instructions: nil, legacy_file_ids: nil) ⇒ Object

  Some parameter documentations has been truncated, see DigitalFilesConfig for more details.

• #self?.variants ⇒ ::Array[Dodopayments::Models::integration_config]

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

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

Methods included from Internal::Type::Converter

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

Class Method Details

.variants ⇒ Array(Dodopayments::Models::IntegrationConfig::FeatureFlagConfig, Dodopayments::Models::IntegrationConfig::GitHubConfig, Dodopayments::Models::IntegrationConfig::DiscordConfig, Dodopayments::Models::IntegrationConfig::TelegramConfig, Dodopayments::Models::IntegrationConfig::FigmaConfig, Dodopayments::Models::IntegrationConfig::FramerConfig, Dodopayments::Models::IntegrationConfig::NotionConfig, Dodopayments::Models::IntegrationConfig::DigitalFilesConfig, Dodopayments::Models::IntegrationConfig::LicenseKeyConfig)

Returns:

• (Array(Dodopayments::Models::IntegrationConfig::FeatureFlagConfig, Dodopayments::Models::IntegrationConfig::GitHubConfig, Dodopayments::Models::IntegrationConfig::DiscordConfig, Dodopayments::Models::IntegrationConfig::TelegramConfig, Dodopayments::Models::IntegrationConfig::FigmaConfig, Dodopayments::Models::IntegrationConfig::FramerConfig, Dodopayments::Models::IntegrationConfig::NotionConfig, Dodopayments::Models::IntegrationConfig::DigitalFilesConfig, Dodopayments::Models::IntegrationConfig::LicenseKeyConfig))

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

Instance Method Details

#initialize(digital_file_ids:, external_url: nil, instructions: nil, legacy_file_ids: nil) ⇒ Object

Some parameter documentations has been truncated, see DigitalFilesConfig for more details.

Parameters:

• digital_file_ids (Array<String>) —

  Files attached to this entitlement. Add files via

• external_url (String, nil) (defaults to: nil) —

  Optional external URL shown to the customer alongside the files.

• instructions (String, nil) (defaults to: nil) —

  Optional human-readable delivery instructions shown to the customer

• legacy_file_ids (Array<String>, nil) (defaults to: nil) —

  Three-way patchable list of legacy file identifiers:

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

#self?.variants ⇒ ::Array[Dodopayments::Models::integration_config]

Returns:

• (::Array[Dodopayments::Models::integration_config])

# File 'sig/dodopayments/models/integration_config.rbs', line 190

def self?.variants: -> ::Array[Dodopayments::Models::integration_config]