Class: Dodopayments::Models::Entitlements::EntitlementGrant

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::Entitlements::EntitlementGrant

Defined in:

lib/dodopayments/models/entitlements/entitlement_grant.rb

Overview

See Also:

• Resources::Entitlements::Grants#list

Direct Known Subclasses

WebhookPayload::Data::EntitlementGrant

Defined Under Namespace

Modules: Status

Instance Attribute Summary

• #business_id ⇒ String
• #created_at ⇒ Time
• #customer_id ⇒ String
• #delivered_at ⇒ Time^?
• #digital_product_delivery ⇒ Dodopayments::Models::DigitalProductDelivery^?

  Present only when the entitlement integration_type is ‘digital_files`.

• #entitlement_id ⇒ String
• #error_code ⇒ String^?
• #error_message ⇒ String^?
• #external_id ⇒ String
• #id ⇒ String
• #license_key ⇒ Dodopayments::Models::Entitlements::LicenseKeyGrant^?

  Present only when the entitlement integration_type is ‘license_key`.

• #metadata ⇒ Object^?
• #oauth_expires_at ⇒ Time^?
• #oauth_url ⇒ String^?
• #payment_id ⇒ String^?
• #revocation_reason ⇒ String^?
• #revoked_at ⇒ Time^?
• #status ⇒ Symbol, Dodopayments::Models::Entitlements::EntitlementGrant::Status
• #subscription_id ⇒ String^?
• #updated_at ⇒ Time

Instance Method Summary

• #initialize(id:, business_id:, created_at:, customer_id:, entitlement_id:, external_id:, status:, updated_at:, delivered_at: nil, digital_product_delivery: nil, error_code: nil, error_message: nil, license_key: nil, metadata: nil, oauth_expires_at: nil, oauth_url: nil, payment_id: nil, revocation_reason: nil, revoked_at: nil, subscription_id: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see EntitlementGrant 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:, customer_id:, entitlement_id:, external_id:, status:, updated_at:, delivered_at: nil, digital_product_delivery: nil, error_code: nil, error_message: nil, license_key: nil, metadata: nil, oauth_expires_at: nil, oauth_url: nil, payment_id: nil, revocation_reason: nil, revoked_at: nil, subscription_id: nil) ⇒ Object

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

Parameters:

• id (String)
• business_id (String)
• created_at (Time)
• customer_id (String)
• entitlement_id (String)
• external_id (String)
• status (Symbol, Dodopayments::Models::Entitlements::EntitlementGrant::Status)
• updated_at (Time)
• delivered_at (Time, nil) (defaults to: nil)
• digital_product_delivery (Dodopayments::Models::DigitalProductDelivery, nil) (defaults to: nil) —

  Present only when the entitlement integration_type is ‘digital_files`.

• error_code (String, nil) (defaults to: nil)
• error_message (String, nil) (defaults to: nil)
• license_key (Dodopayments::Models::Entitlements::LicenseKeyGrant, nil) (defaults to: nil) —

  Present only when the entitlement integration_type is ‘license_key`.

• metadata (Object) (defaults to: nil)
• oauth_expires_at (Time, nil) (defaults to: nil)
• oauth_url (String, nil) (defaults to: nil)
• payment_id (String, nil) (defaults to: nil)
• revocation_reason (String, nil) (defaults to: nil)
• revoked_at (Time, nil) (defaults to: nil)
• subscription_id (String, nil) (defaults to: nil)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 111

Instance Attribute Details

#business_id ⇒ String

Returns:

• (String)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 16

required :business_id, String

#created_at ⇒ Time

Returns:

• (Time)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 21

required :created_at, Time

#customer_id ⇒ String

Returns:

• (String)

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

required :customer_id, String

#delivered_at ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 51

optional :delivered_at, Time, nil?: true

#digital_product_delivery ⇒ Dodopayments::Models::DigitalProductDelivery^?

Present only when the entitlement integration_type is ‘digital_files`. Populated eagerly on every list and single-record endpoint.

Returns:

• (Dodopayments::Models::DigitalProductDelivery, nil)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 58

optional :digital_product_delivery, -> { Dodopayments::DigitalProductDelivery }, nil?: true

#entitlement_id ⇒ String

Returns:

• (String)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 31

required :entitlement_id, String

#error_code ⇒ String^?

Returns:

• (String, nil)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 63

optional :error_code, String, nil?: true

#error_message ⇒ String^?

Returns:

• (String, nil)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 68

optional :error_message, String, nil?: true

#external_id ⇒ String

Returns:

• (String)

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

required :external_id, String

#id ⇒ String

Returns:

• (String)

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

required :id, String

#license_key ⇒ Dodopayments::Models::Entitlements::LicenseKeyGrant^?

Present only when the entitlement integration_type is ‘license_key`.

Returns:

• (Dodopayments::Models::Entitlements::LicenseKeyGrant, nil)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 74

optional :license_key, -> { Dodopayments::Entitlements::LicenseKeyGrant }, nil?: true

#metadata ⇒ Object^?

Returns:

• (Object, nil)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 79

optional :metadata, Dodopayments::Internal::Type::Unknown

#oauth_expires_at ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 84

optional :oauth_expires_at, Time, nil?: true

#oauth_url ⇒ String^?

Returns:

• (String, nil)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 89

optional :oauth_url, String, nil?: true

#payment_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 94

optional :payment_id, String, nil?: true

#revocation_reason ⇒ String^?

Returns:

• (String, nil)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 99

optional :revocation_reason, String, nil?: true

#revoked_at ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 104

optional :revoked_at, Time, nil?: true

#status ⇒ Symbol, Dodopayments::Models::Entitlements::EntitlementGrant::Status

Returns:

• (Symbol, Dodopayments::Models::Entitlements::EntitlementGrant::Status)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 41

required :status, enum: -> { Dodopayments::Entitlements::EntitlementGrant::Status }

#subscription_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/dodopayments/models/entitlements/entitlement_grant.rb', line 109

optional :subscription_id, String, nil?: true

#updated_at ⇒ Time

Returns:

• (Time)

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

required :updated_at, Time