Class: Dodopayments::Models::Entitlement

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/dodopayments/models/entitlement.rb

Overview

See Also:

• Resources::Entitlements#create

Instance Attribute Summary

• #business_id ⇒ String

  Identifier of the business that owns this entitlement.

• #created_at ⇒ Time

  Timestamp when the entitlement was created.

• #description ⇒ String^?

  Optional description supplied at creation.

• #id ⇒ String

  Unique identifier of the entitlement.

• #integration_config ⇒ Dodopayments::Models::IntegrationConfigResponse::GitHubConfig, ...

  Integration-specific configuration.

• #integration_type ⇒ Symbol, Dodopayments::Models::EntitlementIntegrationType

  Platform integration this entitlement uses.

• #is_active ⇒ Boolean

  Always ‘true` for entitlements returned by the public API; soft-deleted entitlements are not returned.

• #metadata ⇒ Hash{Symbol=>String}

  Arbitrary key-value metadata supplied at creation or via PATCH.

• #name ⇒ String

  Display name supplied at creation.

• #updated_at ⇒ Time

  Timestamp when the entitlement was last modified.

Instance Method Summary

• #initialize(id:, business_id:, created_at:, integration_config:, integration_type:, is_active:, metadata:, name:, updated_at:, description: nil) ⇒ Object constructor

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

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:, business_id:, created_at:, integration_config:, integration_type:, is_active:, metadata:, name:, updated_at:, description: nil) ⇒ Object

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

Detailed view of a single entitlement: identity, integration type, integration-specific configuration, and metadata.

Parameters:

• id (String) —

  Unique identifier of the entitlement.

• business_id (String) —

  Identifier of the business that owns this entitlement.

• created_at (Time) —

  Timestamp when the entitlement was created.

• integration_config (Dodopayments::Models::IntegrationConfigResponse::GitHubConfig, Dodopayments::Models::IntegrationConfigResponse::DiscordConfig, Dodopayments::Models::IntegrationConfigResponse::TelegramConfig, Dodopayments::Models::IntegrationConfigResponse::FigmaConfig, Dodopayments::Models::IntegrationConfigResponse::FramerConfig, Dodopayments::Models::IntegrationConfigResponse::NotionConfig, Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig, Dodopayments::Models::IntegrationConfigResponse::LicenseKeyConfig) —

  Integration-specific configuration. For ‘digital_files` entitlements

• integration_type (Symbol, Dodopayments::Models::EntitlementIntegrationType) —

  Platform integration this entitlement uses.

• is_active (Boolean) —

  Always ‘true` for entitlements returned by the public API;

• metadata (Hash{Symbol=>String}) —

  Arbitrary key-value metadata supplied at creation or via PATCH.

• name (String) —

  Display name supplied at creation.

• updated_at (Time) —

  Timestamp when the entitlement was last modified.

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

  Optional description supplied at creation.

# File 'lib/dodopayments/models/entitlement.rb', line 69

Instance Attribute Details

#business_id ⇒ String

Identifier of the business that owns this entitlement.

Returns:

• (String)

# File 'lib/dodopayments/models/entitlement.rb', line 17

required :business_id, String

#created_at ⇒ Time

Timestamp when the entitlement was created.

Returns:

• (Time)

# File 'lib/dodopayments/models/entitlement.rb', line 23

required :created_at, Time

#description ⇒ String^?

Optional description supplied at creation.

Returns:

• (String, nil)

# File 'lib/dodopayments/models/entitlement.rb', line 67

optional :description, String, nil?: true

#id ⇒ String

Unique identifier of the entitlement.

Returns:

• (String)

# File 'lib/dodopayments/models/entitlement.rb', line 11

required :id, String

#integration_config ⇒ Dodopayments::Models::IntegrationConfigResponse::GitHubConfig, ...

Integration-specific configuration. For ‘digital_files` entitlements this includes presigned download URLs for each attached file.

Returns:

• (Dodopayments::Models::IntegrationConfigResponse::GitHubConfig, Dodopayments::Models::IntegrationConfigResponse::DiscordConfig, Dodopayments::Models::IntegrationConfigResponse::TelegramConfig, Dodopayments::Models::IntegrationConfigResponse::FigmaConfig, Dodopayments::Models::IntegrationConfigResponse::FramerConfig, Dodopayments::Models::IntegrationConfigResponse::NotionConfig, Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig, Dodopayments::Models::IntegrationConfigResponse::LicenseKeyConfig)

# File 'lib/dodopayments/models/entitlement.rb', line 30

required :integration_config, union: -> { Dodopayments::IntegrationConfigResponse }

#integration_type ⇒ Symbol, Dodopayments::Models::EntitlementIntegrationType

Platform integration this entitlement uses.

Returns:

• (Symbol, Dodopayments::Models::EntitlementIntegrationType)

# File 'lib/dodopayments/models/entitlement.rb', line 36

required :integration_type, enum: -> { Dodopayments::EntitlementIntegrationType }

#is_active ⇒ Boolean

Always ‘true` for entitlements returned by the public API; soft-deleted entitlements are not returned.

Returns:

• (Boolean)

# File 'lib/dodopayments/models/entitlement.rb', line 43

required :is_active, Dodopayments::Internal::Type::Boolean

#metadata ⇒ Hash{Symbol=>String}

Arbitrary key-value metadata supplied at creation or via PATCH.

Returns:

• (Hash{Symbol=>String})

# File 'lib/dodopayments/models/entitlement.rb', line 49

required :metadata, Dodopayments::Internal::Type::HashOf[String]

#name ⇒ String

Display name supplied at creation.

Returns:

• (String)

# File 'lib/dodopayments/models/entitlement.rb', line 55

required :name, String

#updated_at ⇒ Time

Timestamp when the entitlement was last modified.

Returns:

• (Time)

# File 'lib/dodopayments/models/entitlement.rb', line 61

required :updated_at, Time