dodopayments 2.9.0 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9592c9e6302cd0a1142387d606f9696fb9c866bc6dfb6c1cac349a5e4c92366f
-  data.tar.gz: dc7ad233ddeb5bbe053737212fc4491d9d31e6980571d751ff09380ec25b190e
+  metadata.gz: bc0aa98fdabf63772954ef8a37fa9943640be90e8f5b63b6271d23d7679d347e
+  data.tar.gz: 8ad9b63374eed557b79b1ec9469f96f58b05b9f68c695fa413785474ab35e9fc
 SHA512:
-  metadata.gz: 907cb238d23b3f98aefc575e056165c94edfeb7aae07906e171050774f034878960eb39c11b4828f6ef49e10efee37aaa2fd09279338091abd669d9add2790ed
-  data.tar.gz: d02a0a0f239c3529dae86d188676d2d414a951dfb484f9176c365f8b9f1650e860a9a28da03a9c2a3bd4bd6d1727b1a1c6f4bb1dbe85d435f200c23fa7d43653
+  metadata.gz: ff56943bda78725f9e454cfb3ab1d9ebe09fbb8c01ff0fc54b47edbcf6417d8fb036a0e0e7d01adf8bdbd733089c03198508c97f25897ec3a718f957f478bd43
+  data.tar.gz: ca67b58771ea486e6b99f1c0351555c3c527f0535ae5b30dc186ba65adfcb5506d3d8e1cb952158eb5290dde9c7dbab80b175ce392c4143f9b8c632810d3d6ac

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2.9.1 (2026-05-04)
+
+Full Changelog: [v2.9.0...v2.9.1](https://github.com/dodopayments/dodopayments-ruby/compare/v2.9.0...v2.9.1)
+
+### Features
+
+* **api:** update openapi spec ([70ea025](https://github.com/dodopayments/dodopayments-ruby/commit/70ea025d3eac9e8d76227be87d301d852d1a3518))
+
 ## 2.9.0 (2026-04-30)
 
 Full Changelog: [v2.8.1...v2.9.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.8.1...v2.9.0)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "dodopayments", "~> 2.9.0"
+gem "dodopayments", "~> 2.9.1"
 ```
 
 <!-- x-release-please-end -->

data/lib/dodopayments/models/digital_product_delivery.rb

@@ -4,29 +4,36 @@ module Dodopayments
   module Models
     class DigitalProductDelivery < Dodopayments::Internal::Type::BaseModel
       # @!attribute files
+      #   One entry per attached file.
       #
       #   @return [Array<Dodopayments::Models::DigitalProductDeliveryFile>]
       required :files, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::DigitalProductDeliveryFile] }
 
       # @!attribute external_url
+      #   Optional external URL, passed through from the entitlement configuration.
       #
       #   @return [String, nil]
       optional :external_url, String, nil?: true
 
       # @!attribute instructions
+      #   Optional human-readable delivery instructions, passed through from the
+      #   entitlement configuration.
       #
       #   @return [String, nil]
       optional :instructions, String, nil?: true
 
       # @!method initialize(files:, external_url: nil, instructions: nil)
-      #   Digital-product-delivery payload for a grant. Populated for grants whose
-      #   entitlement has `integration_type = 'digital_files'`. `files` carries presigned
-      #   download URLs; the source (EE service or legacy in-process S3 presigning) is
-      #   opaque to the caller.
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::DigitalProductDelivery} for more details.
       #
-      #   @param files [Array<Dodopayments::Models::DigitalProductDeliveryFile>]
-      #   @param external_url [String, nil]
-      #   @param instructions [String, nil]
+      #   Digital-product-delivery payload, present on grants for `digital_files`
+      #   entitlements. Each file carries a short-lived presigned download URL.
+      #
+      #   @param files [Array<Dodopayments::Models::DigitalProductDeliveryFile>] One entry per attached file.
+      #
+      #   @param external_url [String, nil] Optional external URL, passed through from the entitlement
+      #
+      #   @param instructions [String, nil] Optional human-readable delivery instructions, passed through from
     end
   end
 end

data/lib/dodopayments/models/digital_product_delivery_file.rb

@@ -4,6 +4,7 @@ module Dodopayments
   module Models
     class DigitalProductDeliveryFile < Dodopayments::Internal::Type::BaseModel
       # @!attribute download_url
+      #   Short-lived presigned URL for downloading the file.
       #
       #   @return [String]
       required :download_url, String
@@ -15,37 +16,43 @@ module Dodopayments
       required :expires_in, Integer
 
       # @!attribute file_id
+      #   Identifier of the attached file.
       #
       #   @return [String]
       required :file_id, String
 
       # @!attribute filename
+      #   Original filename of the attached file.
       #
       #   @return [String]
       required :filename, String
 
       # @!attribute content_type
+      #   Optional content-type declared at upload.
       #
       #   @return [String, nil]
       optional :content_type, String, nil?: true
 
       # @!attribute file_size
+      #   Optional size of the file in bytes.
       #
       #   @return [Integer, nil]
       optional :file_size, Integer, nil?: true
 
       # @!method initialize(download_url:, expires_in:, file_id:, filename:, content_type: nil, file_size: nil)
-      #   @param download_url [String]
+      #   One file in a digital-product delivery payload.
+      #
+      #   @param download_url [String] Short-lived presigned URL for downloading the file.
       #
       #   @param expires_in [Integer] Seconds until `download_url` expires.
       #
-      #   @param file_id [String]
+      #   @param file_id [String] Identifier of the attached file.
       #
-      #   @param filename [String]
+      #   @param filename [String] Original filename of the attached file.
       #
-      #   @param content_type [String, nil]
+      #   @param content_type [String, nil] Optional content-type declared at upload.
       #
-      #   @param file_size [Integer, nil]
+      #   @param file_size [Integer, nil] Optional size of the file in bytes.
     end
   end
 end

data/lib/dodopayments/models/entitlement.rb

@@ -5,82 +5,93 @@ module Dodopayments
     # @see Dodopayments::Resources::Entitlements#create
     class Entitlement < Dodopayments::Internal::Type::BaseModel
       # @!attribute id
+      #   Unique identifier of the entitlement.
       #
       #   @return [String]
       required :id, String
 
       # @!attribute business_id
+      #   Identifier of the business that owns this entitlement.
       #
       #   @return [String]
       required :business_id, String
 
       # @!attribute created_at
+      #   Timestamp when the entitlement was created.
       #
       #   @return [Time]
       required :created_at, Time
 
       # @!attribute integration_config
-      #   Public-facing variant of [`IntegrationConfig`]. Mirrors every variant shape on
-      #   the wire EXCEPT `DigitalFiles`, which is replaced with a hydrated
-      #   `digital_files` object (resolved download URLs etc.). The persisted JSONB stays
-      #   ID-only via [`IntegrationConfig`]; this enum is response-only.
+      #   Integration-specific configuration. For `digital_files` entitlements this
+      #   includes presigned download URLs for each attached file.
       #
       #   @return [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]
       required :integration_config, union: -> { Dodopayments::IntegrationConfigResponse }
 
       # @!attribute integration_type
+      #   Platform integration this entitlement uses.
       #
       #   @return [Symbol, Dodopayments::Models::EntitlementIntegrationType]
       required :integration_type, enum: -> { Dodopayments::EntitlementIntegrationType }
 
       # @!attribute is_active
+      #   Always `true` for entitlements returned by the public API; soft-deleted
+      #   entitlements are not returned.
       #
       #   @return [Boolean]
       required :is_active, Dodopayments::Internal::Type::Boolean
 
+      # @!attribute metadata
+      #   Arbitrary key-value metadata supplied at creation or via PATCH.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Dodopayments::Internal::Type::HashOf[String]
+
       # @!attribute name
+      #   Display name supplied at creation.
       #
       #   @return [String]
       required :name, String
 
       # @!attribute updated_at
+      #   Timestamp when the entitlement was last modified.
       #
       #   @return [Time]
       required :updated_at, Time
 
       # @!attribute description
+      #   Optional description supplied at creation.
       #
       #   @return [String, nil]
       optional :description, String, nil?: true
 
-      # @!attribute metadata
-      #
-      #   @return [Object, nil]
-      optional :metadata, Dodopayments::Internal::Type::Unknown
-
-      # @!method initialize(id:, business_id:, created_at:, integration_config:, integration_type:, is_active:, name:, updated_at:, description: nil, metadata: nil)
+      # @!method initialize(id:, business_id:, created_at:, integration_config:, integration_type:, is_active:, metadata:, name:, updated_at:, description: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::Entitlement} for more details.
       #
-      #   @param id [String]
+      #   Detailed view of a single entitlement: identity, integration type,
+      #   integration-specific configuration, and metadata.
+      #
+      #   @param id [String] Unique identifier of the entitlement.
       #
-      #   @param business_id [String]
+      #   @param business_id [String] Identifier of the business that owns this entitlement.
       #
-      #   @param created_at [Time]
+      #   @param created_at [Time] Timestamp when the entitlement was created.
       #
-      #   @param 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] Public-facing variant of [`IntegrationConfig`]. Mirrors every variant
+      #   @param 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
       #
-      #   @param integration_type [Symbol, Dodopayments::Models::EntitlementIntegrationType]
+      #   @param integration_type [Symbol, Dodopayments::Models::EntitlementIntegrationType] Platform integration this entitlement uses.
       #
-      #   @param is_active [Boolean]
+      #   @param is_active [Boolean] Always `true` for entitlements returned by the public API;
       #
-      #   @param name [String]
+      #   @param metadata [Hash{Symbol=>String}] Arbitrary key-value metadata supplied at creation or via PATCH.
       #
-      #   @param updated_at [Time]
+      #   @param name [String] Display name supplied at creation.
       #
-      #   @param description [String, nil]
+      #   @param updated_at [Time] Timestamp when the entitlement was last modified.
       #
-      #   @param metadata [Object]
+      #   @param description [String, nil] Optional description supplied at creation.
     end
   end
 end

data/lib/dodopayments/models/entitlement_create_params.rb

@@ -32,10 +32,10 @@ module Dodopayments
       optional :description, String, nil?: true
 
       # @!attribute metadata
-      #   Optional user-facing metadata
+      #   Additional metadata for the entitlement
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, Dodopayments::Internal::Type::HashOf[String], nil?: true
+      optional :metadata, Dodopayments::Internal::Type::HashOf[String]
 
       # @!method initialize(integration_config:, integration_type:, name:, description: nil, metadata: nil, request_options: {})
       #   @param 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)
@@ -46,7 +46,7 @@ module Dodopayments
       #
       #   @param description [String, nil] Optional description
       #
-      #   @param metadata [Hash{Symbol=>String}, nil] Optional user-facing metadata
+      #   @param metadata [Hash{Symbol=>String}] Additional metadata for the entitlement
       #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/dodopayments/models/entitlement_grant_created_webhook_event.rb

@@ -10,6 +10,8 @@ module Dodopayments
       required :business_id, String
 
       # @!attribute data
+      #   Detailed view of a single entitlement grant: who it's for, its lifecycle state,
+      #   and any integration-specific delivery payload.
       #
       #   @return [Dodopayments::Models::Entitlements::EntitlementGrant]
       required :data, -> { Dodopayments::Entitlements::EntitlementGrant }
@@ -27,9 +29,12 @@ module Dodopayments
       required :type, enum: -> { Dodopayments::EntitlementGrantCreatedWebhookEvent::Type }
 
       # @!method initialize(business_id:, data:, timestamp:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::EntitlementGrantCreatedWebhookEvent} for more details.
+      #
       #   @param business_id [String] The business identifier
       #
-      #   @param data [Dodopayments::Models::Entitlements::EntitlementGrant]
+      #   @param data [Dodopayments::Models::Entitlements::EntitlementGrant] Detailed view of a single entitlement grant: who it's for, its
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #

data/lib/dodopayments/models/entitlement_grant_delivered_webhook_event.rb

@@ -10,6 +10,8 @@ module Dodopayments
       required :business_id, String
 
       # @!attribute data
+      #   Detailed view of a single entitlement grant: who it's for, its lifecycle state,
+      #   and any integration-specific delivery payload.
       #
       #   @return [Dodopayments::Models::Entitlements::EntitlementGrant]
       required :data, -> { Dodopayments::Entitlements::EntitlementGrant }
@@ -27,9 +29,12 @@ module Dodopayments
       required :type, enum: -> { Dodopayments::EntitlementGrantDeliveredWebhookEvent::Type }
 
       # @!method initialize(business_id:, data:, timestamp:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent} for more details.
+      #
       #   @param business_id [String] The business identifier
       #
-      #   @param data [Dodopayments::Models::Entitlements::EntitlementGrant]
+      #   @param data [Dodopayments::Models::Entitlements::EntitlementGrant] Detailed view of a single entitlement grant: who it's for, its
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #

data/lib/dodopayments/models/entitlement_grant_failed_webhook_event.rb

@@ -10,6 +10,8 @@ module Dodopayments
       required :business_id, String
 
       # @!attribute data
+      #   Detailed view of a single entitlement grant: who it's for, its lifecycle state,
+      #   and any integration-specific delivery payload.
       #
       #   @return [Dodopayments::Models::Entitlements::EntitlementGrant]
       required :data, -> { Dodopayments::Entitlements::EntitlementGrant }
@@ -27,9 +29,12 @@ module Dodopayments
       required :type, enum: -> { Dodopayments::EntitlementGrantFailedWebhookEvent::Type }
 
       # @!method initialize(business_id:, data:, timestamp:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::EntitlementGrantFailedWebhookEvent} for more details.
+      #
       #   @param business_id [String] The business identifier
       #
-      #   @param data [Dodopayments::Models::Entitlements::EntitlementGrant]
+      #   @param data [Dodopayments::Models::Entitlements::EntitlementGrant] Detailed view of a single entitlement grant: who it's for, its
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #

data/lib/dodopayments/models/entitlement_grant_revoked_webhook_event.rb

@@ -10,6 +10,8 @@ module Dodopayments
       required :business_id, String
 
       # @!attribute data
+      #   Detailed view of a single entitlement grant: who it's for, its lifecycle state,
+      #   and any integration-specific delivery payload.
       #
       #   @return [Dodopayments::Models::Entitlements::EntitlementGrant]
       required :data, -> { Dodopayments::Entitlements::EntitlementGrant }
@@ -27,9 +29,12 @@ module Dodopayments
       required :type, enum: -> { Dodopayments::EntitlementGrantRevokedWebhookEvent::Type }
 
       # @!method initialize(business_id:, data:, timestamp:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::EntitlementGrantRevokedWebhookEvent} for more details.
+      #
       #   @param business_id [String] The business identifier
       #
-      #   @param data [Dodopayments::Models::Entitlements::EntitlementGrant]
+      #   @param data [Dodopayments::Models::Entitlements::EntitlementGrant] Detailed view of a single entitlement grant: who it's for, its
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #

data/lib/dodopayments/models/entitlement_update_params.rb

@@ -18,8 +18,8 @@ module Dodopayments
       optional :description, String, nil?: true
 
       # @!attribute integration_config
-      #   Platform-specific configuration for an entitlement. Each variant uses unique
-      #   field names so `#[serde(untagged)]` can disambiguate correctly.
+      #   Integration-specific configuration supplied when creating or updating an
+      #   entitlement. The shape required matches the entitlement's `integration_type`.
       #
       #   @return [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]
       optional :integration_config, union: -> { Dodopayments::IntegrationConfig }, nil?: true
@@ -42,7 +42,7 @@ module Dodopayments
       #
       #   @param description [String, nil]
       #
-      #   @param 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, nil] Platform-specific configuration for an entitlement.
+      #   @param 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, nil] Integration-specific configuration supplied when creating or updating
       #
       #   @param metadata [Hash{Symbol=>String}, nil]
       #

data/lib/dodopayments/models/entitlements/entitlement_grant.rb

@@ -6,152 +6,170 @@ module Dodopayments
       # @see Dodopayments::Resources::Entitlements::Grants#list
       class EntitlementGrant < Dodopayments::Internal::Type::BaseModel
         # @!attribute id
+        #   Unique identifier of the grant.
         #
         #   @return [String]
         required :id, String
 
         # @!attribute business_id
+        #   Identifier of the business that owns the grant.
         #
         #   @return [String]
         required :business_id, String
 
         # @!attribute created_at
+        #   Timestamp when the grant was created.
         #
         #   @return [Time]
         required :created_at, Time
 
         # @!attribute customer_id
+        #   Identifier of the customer the grant was issued to.
         #
         #   @return [String]
         required :customer_id, String
 
         # @!attribute entitlement_id
+        #   Identifier of the entitlement this grant was issued from.
         #
         #   @return [String]
         required :entitlement_id, String
 
-        # @!attribute external_id
+        # @!attribute metadata
+        #   Arbitrary key-value metadata recorded on the grant.
         #
-        #   @return [String]
-        required :external_id, String
+        #   @return [Hash{Symbol=>String}]
+        required :metadata, Dodopayments::Internal::Type::HashOf[String]
 
         # @!attribute status
+        #   Lifecycle status of the grant.
         #
         #   @return [Symbol, Dodopayments::Models::Entitlements::EntitlementGrant::Status]
         required :status, enum: -> { Dodopayments::Entitlements::EntitlementGrant::Status }
 
         # @!attribute updated_at
+        #   Timestamp when the grant was last modified.
         #
         #   @return [Time]
         required :updated_at, Time
 
         # @!attribute delivered_at
+        #   Timestamp when the grant transitioned to `delivered`, when applicable.
         #
         #   @return [Time, nil]
         optional :delivered_at, Time, nil?: true
 
         # @!attribute digital_product_delivery
-        #   Present only when the entitlement integration_type is `digital_files`. Populated
-        #   eagerly on every list and single-record endpoint.
+        #   Digital-product-delivery payload, present when the entitlement integration is
+        #   `digital_files`.
         #
         #   @return [Dodopayments::Models::DigitalProductDelivery, nil]
         optional :digital_product_delivery, -> { Dodopayments::DigitalProductDelivery }, nil?: true
 
         # @!attribute error_code
+        #   Machine-readable code reported when delivery failed, when applicable.
         #
         #   @return [String, nil]
         optional :error_code, String, nil?: true
 
         # @!attribute error_message
+        #   Human-readable message reported when delivery failed, when applicable.
         #
         #   @return [String, nil]
         optional :error_message, String, nil?: true
 
         # @!attribute license_key
-        #   Present only when the entitlement integration_type is `license_key`.
+        #   License-key delivery payload, present when the entitlement integration is
+        #   `license_key`.
         #
         #   @return [Dodopayments::Models::Entitlements::LicenseKeyGrant, nil]
         optional :license_key, -> { Dodopayments::Entitlements::LicenseKeyGrant }, nil?: true
 
-        # @!attribute metadata
-        #
-        #   @return [Object, nil]
-        optional :metadata, Dodopayments::Internal::Type::Unknown
-
         # @!attribute oauth_expires_at
+        #   Timestamp when `oauth_url` stops being valid, when applicable.
         #
         #   @return [Time, nil]
         optional :oauth_expires_at, Time, nil?: true
 
         # @!attribute oauth_url
+        #   Customer-facing OAuth URL for OAuth-style integrations. Populated during the
+        #   customer-portal accept flow; `null` until the customer completes that step, and
+        #   on grants for non-OAuth integrations.
         #
         #   @return [String, nil]
         optional :oauth_url, String, nil?: true
 
         # @!attribute payment_id
+        #   Identifier of the payment that triggered this grant, when applicable.
         #
         #   @return [String, nil]
         optional :payment_id, String, nil?: true
 
         # @!attribute revocation_reason
+        #   Reason recorded when the grant was revoked, when applicable.
         #
         #   @return [String, nil]
         optional :revocation_reason, String, nil?: true
 
         # @!attribute revoked_at
+        #   Timestamp when the grant transitioned to `revoked`, when applicable.
         #
         #   @return [Time, nil]
         optional :revoked_at, Time, nil?: true
 
         # @!attribute subscription_id
+        #   Identifier of the subscription that triggered this grant, when applicable.
         #
         #   @return [String, nil]
         optional :subscription_id, String, nil?: true
 
-        # @!method 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)
+        # @!method initialize(id:, business_id:, created_at:, customer_id:, entitlement_id:, metadata:, status:, updated_at:, delivered_at: nil, digital_product_delivery: nil, error_code: nil, error_message: nil, license_key: nil, oauth_expires_at: nil, oauth_url: nil, payment_id: nil, revocation_reason: nil, revoked_at: nil, subscription_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::Entitlements::EntitlementGrant} for more details.
         #
-        #   @param id [String]
+        #   Detailed view of a single entitlement grant: who it's for, its lifecycle state,
+        #   and any integration-specific delivery payload.
         #
-        #   @param business_id [String]
+        #   @param id [String] Unique identifier of the grant.
         #
-        #   @param created_at [Time]
+        #   @param business_id [String] Identifier of the business that owns the grant.
         #
-        #   @param customer_id [String]
+        #   @param created_at [Time] Timestamp when the grant was created.
         #
-        #   @param entitlement_id [String]
+        #   @param customer_id [String] Identifier of the customer the grant was issued to.
         #
-        #   @param external_id [String]
+        #   @param entitlement_id [String] Identifier of the entitlement this grant was issued from.
         #
-        #   @param status [Symbol, Dodopayments::Models::Entitlements::EntitlementGrant::Status]
+        #   @param metadata [Hash{Symbol=>String}] Arbitrary key-value metadata recorded on the grant.
         #
-        #   @param updated_at [Time]
+        #   @param status [Symbol, Dodopayments::Models::Entitlements::EntitlementGrant::Status] Lifecycle status of the grant.
         #
-        #   @param delivered_at [Time, nil]
+        #   @param updated_at [Time] Timestamp when the grant was last modified.
         #
-        #   @param digital_product_delivery [Dodopayments::Models::DigitalProductDelivery, nil] Present only when the entitlement integration_type is `digital_files`.
+        #   @param delivered_at [Time, nil] Timestamp when the grant transitioned to `delivered`, when applicable.
         #
-        #   @param error_code [String, nil]
+        #   @param digital_product_delivery [Dodopayments::Models::DigitalProductDelivery, nil] Digital-product-delivery payload, present when the entitlement
         #
-        #   @param error_message [String, nil]
+        #   @param error_code [String, nil] Machine-readable code reported when delivery failed, when applicable.
         #
-        #   @param license_key [Dodopayments::Models::Entitlements::LicenseKeyGrant, nil] Present only when the entitlement integration_type is `license_key`.
+        #   @param error_message [String, nil] Human-readable message reported when delivery failed, when applicable.
         #
-        #   @param metadata [Object]
+        #   @param license_key [Dodopayments::Models::Entitlements::LicenseKeyGrant, nil] License-key delivery payload, present when the entitlement integration
         #
-        #   @param oauth_expires_at [Time, nil]
+        #   @param oauth_expires_at [Time, nil] Timestamp when `oauth_url` stops being valid, when applicable.
         #
-        #   @param oauth_url [String, nil]
+        #   @param oauth_url [String, nil] Customer-facing OAuth URL for OAuth-style integrations. Populated
         #
-        #   @param payment_id [String, nil]
+        #   @param payment_id [String, nil] Identifier of the payment that triggered this grant, when applicable.
         #
-        #   @param revocation_reason [String, nil]
+        #   @param revocation_reason [String, nil] Reason recorded when the grant was revoked, when applicable.
         #
-        #   @param revoked_at [Time, nil]
+        #   @param revoked_at [Time, nil] Timestamp when the grant transitioned to `revoked`, when applicable.
         #
-        #   @param subscription_id [String, nil]
+        #   @param subscription_id [String, nil] Identifier of the subscription that triggered this grant, when applicable.
 
+        # Lifecycle status of the grant.
+        #
         # @see Dodopayments::Models::Entitlements::EntitlementGrant#status
         module Status
           extend Dodopayments::Internal::Type::Enum

data/lib/dodopayments/models/entitlements/file_upload_response.rb

@@ -6,8 +6,8 @@ module Dodopayments
       # @see Dodopayments::Resources::Entitlements::Files#upload
       class FileUploadResponse < Dodopayments::Internal::Type::BaseModel
         # @!attribute file_id
-        #   EE-issued digital file id; appended to
-        #   `entitlements.integration_config.digital_file_ids`.
+        #   Identifier of the attached file. Pass it to
+        #   `DELETE /entitlements/{id}/files/{file_id}` to detach the file later.
         #
         #   @return [String]
         required :file_id, String
@@ -16,7 +16,7 @@ module Dodopayments
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::Entitlements::FileUploadResponse} for more details.
         #
-        #   @param file_id [String] EE-issued digital file id; appended to
+        #   @param file_id [String] Identifier of the attached file. Pass it to
       end
     end
   end