dodopayments 2.9.0 → 2.9.1

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

@@ -5,35 +5,40 @@ module Dodopayments
     module Entitlements
       class LicenseKeyGrant < Dodopayments::Internal::Type::BaseModel
         # @!attribute activations_used
+        #   Number of activations consumed so far.
         #
         #   @return [Integer]
         required :activations_used, Integer
 
         # @!attribute key
+        #   Issued license key.
         #
         #   @return [String]
         required :key, String
 
         # @!attribute activations_limit
+        #   Maximum activations allowed by the entitlement, when set.
         #
         #   @return [Integer, nil]
         optional :activations_limit, Integer, nil?: true
 
         # @!attribute expires_at
+        #   When the license key expires, when applicable.
         #
         #   @return [Time, nil]
         optional :expires_at, Time, nil?: true
 
         # @!method initialize(activations_used:, key:, activations_limit: nil, expires_at: nil)
-        #   Nested representation of license-key grant fields. Present only when the grant's
-        #   entitlement has `integration_type = 'license_key'` and a row exists in
-        #   `license_keys`. The grant's top-level `status` is the source of truth for the
-        #   grant's lifecycle — no per-license-key status is exposed here.
-        #
-        #   @param activations_used [Integer]
-        #   @param key [String]
-        #   @param activations_limit [Integer, nil]
-        #   @param expires_at [Time, nil]
+        #   License-key delivery payload, present on grants for `license_key` entitlements.
+        #   The grant's top-level `status` is the source of truth for the grant's lifecycle.
+        #
+        #   @param activations_used [Integer] Number of activations consumed so far.
+        #
+        #   @param key [String] Issued license key.
+        #
+        #   @param activations_limit [Integer, nil] Maximum activations allowed by the entitlement, when set.
+        #
+        #   @param expires_at [Time, nil] When the license key expires, when applicable.
       end
     end
   end

data/lib/dodopayments/models/integration_config.rb

@@ -2,8 +2,8 @@
 
 module Dodopayments
   module Models
-    # 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`.
     module IntegrationConfig
       extend Dodopayments::Internal::Type::Union
 
@@ -25,103 +25,133 @@ module Dodopayments
 
       class GitHubConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute permission
-        #   One of: pull, push, admin, maintain, triage
+        #   Permission to grant on the repository.
         #
-        #   @return [String]
-        required :permission, String
+        #   @return [Symbol, Dodopayments::Models::IntegrationConfig::GitHubConfig::Permission]
+        required :permission, enum: -> { Dodopayments::IntegrationConfig::GitHubConfig::Permission }
 
         # @!attribute target_id
+        #   Repository or organisation slug to grant access to.
         #
         #   @return [String]
         required :target_id, String
 
         # @!method initialize(permission:, target_id:)
-        #   @param permission [String] One of: pull, push, admin, maintain, triage
+        #   @param permission [Symbol, Dodopayments::Models::IntegrationConfig::GitHubConfig::Permission] Permission to grant on the repository.
+        #
+        #   @param target_id [String] Repository or organisation slug to grant access to.
+
+        # Permission to grant on the repository.
         #
-        #   @param target_id [String]
+        # @see Dodopayments::Models::IntegrationConfig::GitHubConfig#permission
+        module Permission
+          extend Dodopayments::Internal::Type::Enum
+
+          PULL = :pull
+          PUSH = :push
+          ADMIN = :admin
+          MAINTAIN = :maintain
+          TRIAGE = :triage
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       class DiscordConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute guild_id
+        #   Discord guild (server) ID.
         #
         #   @return [String]
         required :guild_id, String
 
         # @!attribute role_id
+        #   Optional Discord role to assign within the guild.
         #
         #   @return [String, nil]
         optional :role_id, String, nil?: true
 
         # @!method initialize(guild_id:, role_id: nil)
-        #   @param guild_id [String]
-        #   @param role_id [String, nil]
+        #   @param guild_id [String] Discord guild (server) ID.
+        #
+        #   @param role_id [String, nil] Optional Discord role to assign within the guild.
       end
 
       class TelegramConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute chat_id
+        #   Telegram chat ID. For groups this is typically a negative integer.
         #
         #   @return [String]
         required :chat_id, String
 
         # @!method initialize(chat_id:)
-        #   @param chat_id [String]
+        #   @param chat_id [String] Telegram chat ID. For groups this is typically a negative integer.
       end
 
       class FigmaConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute figma_file_id
+        #   Figma file identifier to grant access to.
         #
         #   @return [String]
         required :figma_file_id, String
 
         # @!method initialize(figma_file_id:)
-        #   @param figma_file_id [String]
+        #   @param figma_file_id [String] Figma file identifier to grant access to.
       end
 
       class FramerConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute framer_template_id
+        #   Framer template identifier to grant access to.
         #
         #   @return [String]
         required :framer_template_id, String
 
         # @!method initialize(framer_template_id:)
-        #   @param framer_template_id [String]
+        #   @param framer_template_id [String] Framer template identifier to grant access to.
       end
 
       class NotionConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute notion_template_id
+        #   Notion template identifier to grant access to.
         #
         #   @return [String]
         required :notion_template_id, String
 
         # @!method initialize(notion_template_id:)
-        #   @param notion_template_id [String]
+        #   @param notion_template_id [String] Notion template identifier to grant access to.
       end
 
       class DigitalFilesConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute digital_file_ids
+        #   Files attached to this entitlement. Add files via
+        #   `POST /entitlements/{id}/files` and remove them via
+        #   `DELETE /entitlements/{id}/files/{file_id}`.
         #
         #   @return [Array<String>]
         required :digital_file_ids, Dodopayments::Internal::Type::ArrayOf[String]
 
         # @!attribute external_url
+        #   Optional external URL shown to the customer alongside the files.
         #
         #   @return [String, nil]
         optional :external_url, String, nil?: true
 
         # @!attribute instructions
+        #   Optional human-readable delivery instructions shown to the customer alongside
+        #   the files.
         #
         #   @return [String, nil]
         optional :instructions, String, nil?: true
 
         # @!attribute legacy_file_ids
-        #   Three-way patchable field (mirrors the credit_entitlements pattern):
+        #   Three-way patchable list of legacy file identifiers:
         #
-        #   - omitted → preserve persisted (`None`)
-        #   - `null` → clear (`Some(None)`)
-        #   - `[...]` → replace (`Some(Some(...))`)
+        #   - omitted → preserve the current value
+        #   - `null` → clear
+        #   - `[...]` → replace
         #
-        #   On Create / storage we collapse "clear" and empty-array to `None` so the
-        #   persisted JSONB never carries a `null` legacy_file_ids key.
+        #   On create, an omitted field, an explicit `null`, or an empty array all result in
+        #   no legacy files attached.
         #
         #   @return [Array<String>, nil]
         optional :legacy_file_ids, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
@@ -130,41 +160,54 @@ module Dodopayments
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::IntegrationConfig::DigitalFilesConfig} for more details.
         #
-        #   @param digital_file_ids [Array<String>]
+        #   @param digital_file_ids [Array<String>] Files attached to this entitlement. Add files via
         #
-        #   @param external_url [String, nil]
+        #   @param external_url [String, nil] Optional external URL shown to the customer alongside the files.
         #
-        #   @param instructions [String, nil]
+        #   @param instructions [String, nil] Optional human-readable delivery instructions shown to the customer
         #
-        #   @param legacy_file_ids [Array<String>, nil] Three-way patchable field (mirrors the credit_entitlements pattern):
+        #   @param legacy_file_ids [Array<String>, nil] Three-way patchable list of legacy file identifiers:
       end
 
       class LicenseKeyConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute activation_message
+        #   Optional message displayed when a customer activates the license key (≤ 2500
+        #   characters).
         #
         #   @return [String, nil]
         optional :activation_message, String, nil?: true
 
         # @!attribute activations_limit
+        #   Maximum activations allowed per issued license key. Omit for unlimited.
         #
         #   @return [Integer, nil]
         optional :activations_limit, Integer, nil?: true
 
         # @!attribute duration_count
+        #   Validity duration of issued license keys. Provide both `duration_count` and
+        #   `duration_interval` together for a fixed duration; omit both for non-expiring
+        #   keys.
         #
         #   @return [Integer, nil]
         optional :duration_count, Integer, nil?: true
 
         # @!attribute duration_interval
+        #   Unit of `duration_count`.
         #
         #   @return [Symbol, Dodopayments::Models::TimeInterval, nil]
         optional :duration_interval, enum: -> { Dodopayments::TimeInterval }, nil?: true
 
         # @!method initialize(activation_message: nil, activations_limit: nil, duration_count: nil, duration_interval: nil)
-        #   @param activation_message [String, nil]
-        #   @param activations_limit [Integer, nil]
-        #   @param duration_count [Integer, nil]
-        #   @param duration_interval [Symbol, Dodopayments::Models::TimeInterval, nil]
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::IntegrationConfig::LicenseKeyConfig} for more details.
+        #
+        #   @param activation_message [String, nil] Optional message displayed when a customer activates the license
+        #
+        #   @param activations_limit [Integer, nil] Maximum activations allowed per issued license key. Omit for unlimited.
+        #
+        #   @param duration_count [Integer, nil] Validity duration of issued license keys. Provide both
+        #
+        #   @param duration_interval [Symbol, Dodopayments::Models::TimeInterval, nil] Unit of `duration_count`.
       end
 
       # @!method self.variants

data/lib/dodopayments/models/integration_config_response.rb

@@ -2,10 +2,10 @@
 
 module Dodopayments
   module Models
-    # 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 on an entitlement read response.
+    #
+    # For `digital_files` entitlements the response includes presigned download URLs
+    # for each attached file; other integrations match the shape supplied at creation.
     module IntegrationConfigResponse
       extend Dodopayments::Internal::Type::Union
 
@@ -27,82 +27,106 @@ module Dodopayments
 
       class GitHubConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute permission
+        #   Permission to grant on the repository.
         #
-        #   @return [String]
-        required :permission, String
+        #   @return [Symbol, Dodopayments::Models::IntegrationConfigResponse::GitHubConfig::Permission]
+        required :permission, enum: -> { Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission }
 
         # @!attribute target_id
+        #   Repository or organisation slug to grant access to.
         #
         #   @return [String]
         required :target_id, String
 
         # @!method initialize(permission:, target_id:)
-        #   @param permission [String]
-        #   @param target_id [String]
+        #   @param permission [Symbol, Dodopayments::Models::IntegrationConfigResponse::GitHubConfig::Permission] Permission to grant on the repository.
+        #
+        #   @param target_id [String] Repository or organisation slug to grant access to.
+
+        # Permission to grant on the repository.
+        #
+        # @see Dodopayments::Models::IntegrationConfigResponse::GitHubConfig#permission
+        module Permission
+          extend Dodopayments::Internal::Type::Enum
+
+          PULL = :pull
+          PUSH = :push
+          ADMIN = :admin
+          MAINTAIN = :maintain
+          TRIAGE = :triage
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       class DiscordConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute guild_id
+        #   Discord guild (server) ID.
         #
         #   @return [String]
         required :guild_id, String
 
         # @!attribute role_id
+        #   Optional Discord role to assign within the guild.
         #
         #   @return [String, nil]
         optional :role_id, String, nil?: true
 
         # @!method initialize(guild_id:, role_id: nil)
-        #   @param guild_id [String]
-        #   @param role_id [String, nil]
+        #   @param guild_id [String] Discord guild (server) ID.
+        #
+        #   @param role_id [String, nil] Optional Discord role to assign within the guild.
       end
 
       class TelegramConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute chat_id
+        #   Telegram chat ID. For groups this is typically a negative integer.
         #
         #   @return [String]
         required :chat_id, String
 
         # @!method initialize(chat_id:)
-        #   @param chat_id [String]
+        #   @param chat_id [String] Telegram chat ID. For groups this is typically a negative integer.
       end
 
       class FigmaConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute figma_file_id
+        #   Figma file identifier to grant access to.
         #
         #   @return [String]
         required :figma_file_id, String
 
         # @!method initialize(figma_file_id:)
-        #   @param figma_file_id [String]
+        #   @param figma_file_id [String] Figma file identifier to grant access to.
       end
 
       class FramerConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute framer_template_id
+        #   Framer template identifier to grant access to.
         #
         #   @return [String]
         required :framer_template_id, String
 
         # @!method initialize(framer_template_id:)
-        #   @param framer_template_id [String]
+        #   @param framer_template_id [String] Framer template identifier to grant access to.
       end
 
       class NotionConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute notion_template_id
+        #   Notion template identifier to grant access to.
         #
         #   @return [String]
         required :notion_template_id, String
 
         # @!method initialize(notion_template_id:)
-        #   @param notion_template_id [String]
+        #   @param notion_template_id [String] Notion template identifier to grant access to.
       end
 
       class DigitalFilesConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute digital_files
-        #   Populated digital-files payload for entitlement read surfaces. Mirrors
-        #   `DigitalProductDelivery` but is sourced from an entitlement's
-        #   `integration_config` (not a grant) and tags each file with its origin (`legacy`
-        #   vs `ee`).
+        #   Populated digital-files payload with each file's metadata and a short-lived
+        #   presigned download URL.
         #
         #   @return [Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles]
         required :digital_files, -> { Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles }
@@ -112,38 +136,47 @@ module Dodopayments
         #   {Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig} for more
         #   details.
         #
-        #   @param digital_files [Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles] Populated digital-files payload for entitlement read surfaces. Mirrors
+        #   @param digital_files [Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles] Populated digital-files payload with each file's metadata and a
 
         # @see Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig#digital_files
         class DigitalFiles < Dodopayments::Internal::Type::BaseModel
           # @!attribute files
+          #   One entry per attached file.
           #
           #   @return [Array<Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles::File>]
           required :files,
                    -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles::File] }
 
           # @!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)
-          #   Populated digital-files payload for entitlement read surfaces. Mirrors
-          #   `DigitalProductDelivery` but is sourced from an entitlement's
-          #   `integration_config` (not a grant) and tags each file with its origin (`legacy`
-          #   vs `ee`).
+          #   Some parameter documentations has been truncated, see
+          #   {Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles}
+          #   for more details.
+          #
+          #   Populated digital-files payload with each file's metadata and a short-lived
+          #   presigned download URL.
+          #
+          #   @param files [Array<Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles::File>] One entry per attached file.
           #
-          #   @param files [Array<Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles::File>]
-          #   @param external_url [String, nil]
-          #   @param instructions [String, nil]
+          #   @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
 
           class File < Dodopayments::Internal::Type::BaseModel
             # @!attribute download_url
+            #   Short-lived presigned URL for downloading the file.
             #
             #   @return [String]
             required :download_url, String
@@ -155,80 +188,87 @@ 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 source
-            #   `"legacy"` for files in `product_files`, `"ee"` for files managed by the
-            #   Entitlements Engine.
-            #
-            #   @return [String]
-            required :source, 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:, source:, content_type: nil, file_size: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles::File}
-            #   for more details.
+            # @!method initialize(download_url:, expires_in:, file_id:, filename:, content_type: nil, file_size: nil)
+            #   One file in a resolved digital-files payload.
             #
-            #   @param download_url [String]
+            #   @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 filename [String]
+            #   @param file_id [String] Identifier of the attached file.
             #
-            #   @param source [String] `"legacy"` for files in `product_files`, `"ee"` for files managed by the
+            #   @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
 
       class LicenseKeyConfig < Dodopayments::Internal::Type::BaseModel
         # @!attribute activation_message
+        #   Optional message displayed when a customer activates the license key (≤ 2500
+        #   characters).
         #
         #   @return [String, nil]
         optional :activation_message, String, nil?: true
 
         # @!attribute activations_limit
+        #   Maximum activations allowed per issued license key. Omit for unlimited.
         #
         #   @return [Integer, nil]
         optional :activations_limit, Integer, nil?: true
 
         # @!attribute duration_count
+        #   Validity duration of issued license keys. Provide both `duration_count` and
+        #   `duration_interval` together for a fixed duration; omit both for non-expiring
+        #   keys.
         #
         #   @return [Integer, nil]
         optional :duration_count, Integer, nil?: true
 
         # @!attribute duration_interval
+        #   Unit of `duration_count`.
         #
         #   @return [Symbol, Dodopayments::Models::TimeInterval, nil]
         optional :duration_interval, enum: -> { Dodopayments::TimeInterval }, nil?: true
 
         # @!method initialize(activation_message: nil, activations_limit: nil, duration_count: nil, duration_interval: nil)
-        #   @param activation_message [String, nil]
-        #   @param activations_limit [Integer, nil]
-        #   @param duration_count [Integer, nil]
-        #   @param duration_interval [Symbol, Dodopayments::Models::TimeInterval, nil]
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::IntegrationConfigResponse::LicenseKeyConfig} for more
+        #   details.
+        #
+        #   @param activation_message [String, nil] Optional message displayed when a customer activates the license
+        #
+        #   @param activations_limit [Integer, nil] Maximum activations allowed per issued license key. Omit for unlimited.
+        #
+        #   @param duration_count [Integer, nil] Validity duration of issued license keys. Provide both
+        #
+        #   @param duration_interval [Symbol, Dodopayments::Models::TimeInterval, nil] Unit of `duration_count`.
       end
 
       # @!method self.variants

data/lib/dodopayments/models/product.rb

@@ -92,10 +92,8 @@ module Dodopayments
       optional :description, String, nil?: true
 
       # @!attribute digital_product_delivery
-      #   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.
+      #   Digital-product-delivery payload, present on grants for `digital_files`
+      #   entitlements. Each file carries a short-lived presigned download URL.
       #
       #   @return [Dodopayments::Models::DigitalProductDelivery, nil]
       optional :digital_product_delivery, -> { Dodopayments::DigitalProductDelivery }, nil?: true
@@ -172,7 +170,7 @@ module Dodopayments
       #
       #   @param description [String, nil] Description of the product, optional.
       #
-      #   @param digital_product_delivery [Dodopayments::Models::DigitalProductDelivery, nil] Digital-product-delivery payload for a grant. Populated for grants whose
+      #   @param digital_product_delivery [Dodopayments::Models::DigitalProductDelivery, nil] Digital-product-delivery payload, present on grants for `digital_files`
       #
       #   @param image [String, nil] URL of the product image, optional.
       #

data/lib/dodopayments/models/product_entitlement_summary.rb

@@ -9,10 +9,10 @@ module Dodopayments
       required :id, String
 
       # @!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 on an entitlement read response.
+      #
+      #   For `digital_files` entitlements the response includes presigned download URLs
+      #   for each attached file; other integrations match the shape supplied at creation.
       #
       #   @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 }
@@ -45,7 +45,7 @@ module Dodopayments
       #
       #   @param id [String]
       #
-      #   @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 on an entitlement read response.
       #
       #   @param integration_type [Symbol, Dodopayments::Models::EntitlementIntegrationType]
       #

data/lib/dodopayments/models/webhook_payload.rb

@@ -65,6 +65,8 @@ module Dodopayments
 
         variant -> { Dodopayments::WebhookPayload::Data::DunningAttempt }
 
+        # Detailed view of a single entitlement grant: who it's for, its
+        # lifecycle state, and any integration-specific delivery payload.
         variant -> { Dodopayments::WebhookPayload::Data::EntitlementGrant }
 
         class Payment < Dodopayments::Models::Payment
@@ -421,6 +423,9 @@ module Dodopayments
           required :payload_type, enum: -> { Dodopayments::WebhookPayload::Data::EntitlementGrant::PayloadType }
 
           # @!method initialize(payload_type:)
+          #   Detailed view of a single entitlement grant: who it's for, its lifecycle state,
+          #   and any integration-specific delivery payload.
+          #
           #   @param payload_type [Symbol, Dodopayments::Models::WebhookPayload::Data::EntitlementGrant::PayloadType]
 
           module PayloadType