Class: Dodopayments::Models::EntitlementUpdateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::EntitlementUpdateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• Dodopayments::Resources::Entitlements#update

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Dodopayments

Instance Attribute Summary

• #description ⇒ String^?
• #id ⇒ String
• #integration_config ⇒ Dodopayments::Models::IntegrationConfig::FeatureFlagConfig, ...

  Integration-specific configuration supplied when creating or updating an entitlement.

• #metadata ⇒ Hash{Symbol=>String, Float, Boolean}^?

  Arbitrary key-value metadata.

• #name ⇒ String^?

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id:, description: nil, integration_config: nil, metadata: nil, name: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, 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

#initialize(id:, description: nil, integration_config: nil, metadata: nil, name: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Dodopayments::Models::EntitlementUpdateParams for more details.

Parameters:

• id (String)
• description (String, nil) (defaults to: nil)
• integration_config (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, nil) (defaults to: nil) —

  Integration-specific configuration supplied when creating or updating

• metadata (Hash{Symbol=>String, Float, Boolean}, nil) (defaults to: nil) —

  Arbitrary key-value metadata. Values can be string, integer, number, or boolean.

• name (String, nil) (defaults to: nil)
• request_options (Dodopayments::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/dodopayments/models/entitlement_update_params.rb', line 44

Instance Attribute Details

#description ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/dodopayments/models/entitlement_update_params.rb', line 18

optional :description, String, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/dodopayments/models/entitlement_update_params.rb', line 13

required :id, String

#integration_config ⇒ Dodopayments::Models::IntegrationConfig::FeatureFlagConfig, ...

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.

Parameters:

• value (Dodopayments::Models::integration_config, nil)

Returns:

• (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, nil)

# File 'lib/dodopayments/models/entitlement_update_params.rb', line 29

optional :integration_config, union: -> { Dodopayments::IntegrationConfig }, nil?: true

#metadata ⇒ Hash{Symbol=>String, Float, Boolean}^?

Arbitrary key-value metadata. Values can be string, integer, number, or boolean.

Parameters:

• value (Dodopayments::Models::metadata, nil)

Returns:

• (Hash{Symbol=>String, Float, Boolean}, nil)

# File 'lib/dodopayments/models/entitlement_update_params.rb', line 35

optional :metadata,
-> { Dodopayments::Internal::Type::HashOf[union: Dodopayments::MetadataItem] },
nil?: true

#name ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/dodopayments/models/entitlement_update_params.rb', line 42

optional :name, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/dodopayments/models/entitlement_update_params.rbs', line 36

def to_hash: -> {