Class: Dodopayments::Models::EntitlementCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/entitlement_create_params.rb

Overview

See Also:

• Resources::Entitlements#create

Instance Attribute Summary

• #description ⇒ String^?

  Optional description.

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

  Platform-specific configuration (validated per integration_type).

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

  Which platform integration this entitlement uses.

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

  Optional user-facing metadata.

• #name ⇒ String

  Display name for this entitlement.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

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

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(integration_config:, integration_type:, name:, description: nil, metadata: nil, request_options: {}) ⇒ Object

Parameters:

• integration_config (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) —

  Platform-specific configuration (validated per integration_type)

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

  Which platform integration this entitlement uses

• name (String) —

  Display name for this entitlement

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

  Optional description

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

  Optional user-facing metadata

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

# File 'lib/dodopayments/models/entitlement_create_params.rb', line 40

Instance Attribute Details

#description ⇒ String^?

Optional description

Returns:

• (String, nil)

# File 'lib/dodopayments/models/entitlement_create_params.rb', line 32

optional :description, String, nil?: true

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

Platform-specific configuration (validated per integration_type)

Returns:

• (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/entitlement_create_params.rb', line 14

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

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

Which platform integration this entitlement uses

Returns:

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

# File 'lib/dodopayments/models/entitlement_create_params.rb', line 20

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

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

Optional user-facing metadata

Returns:

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

# File 'lib/dodopayments/models/entitlement_create_params.rb', line 38

optional :metadata, Dodopayments::Internal::Type::HashOf[String], nil?: true

#name ⇒ String

Display name for this entitlement

Returns:

• (String)

# File 'lib/dodopayments/models/entitlement_create_params.rb', line 26

required :name, String