dodopayments 2.9.0 → 2.9.1

data/rbi/dodopayments/models/integration_config_response.rbi

@@ -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
 
@@ -32,23 +32,94 @@ module Dodopayments
             )
           end
 
-        sig { returns(String) }
+        # Permission to grant on the repository.
+        sig do
+          returns(
+            Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+          )
+        end
         attr_accessor :permission
 
+        # Repository or organisation slug to grant access to.
         sig { returns(String) }
         attr_accessor :target_id
 
         sig do
-          params(permission: String, target_id: String).returns(
-            T.attached_class
-          )
+          params(
+            permission:
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::OrSymbol,
+            target_id: String
+          ).returns(T.attached_class)
         end
-        def self.new(permission:, target_id:)
+        def self.new(
+          # Permission to grant on the repository.
+          permission:,
+          # Repository or organisation slug to grant access to.
+          target_id:
+        )
         end
 
-        sig { override.returns({ permission: String, target_id: String }) }
+        sig do
+          override.returns(
+            {
+              permission:
+                Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol,
+              target_id: String
+            }
+          )
+        end
         def to_hash
         end
+
+        # Permission to grant on the repository.
+        module Permission
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PULL =
+            T.let(
+              :pull,
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+            )
+          PUSH =
+            T.let(
+              :push,
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+            )
+          ADMIN =
+            T.let(
+              :admin,
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+            )
+          MAINTAIN =
+            T.let(
+              :maintain,
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+            )
+          TRIAGE =
+            T.let(
+              :triage,
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       class DiscordConfig < Dodopayments::Internal::Type::BaseModel
@@ -60,9 +131,11 @@ module Dodopayments
             )
           end
 
+        # Discord guild (server) ID.
         sig { returns(String) }
         attr_accessor :guild_id
 
+        # Optional Discord role to assign within the guild.
         sig { returns(T.nilable(String)) }
         attr_accessor :role_id
 
@@ -71,7 +144,12 @@ module Dodopayments
             T.attached_class
           )
         end
-        def self.new(guild_id:, role_id: nil)
+        def self.new(
+          # Discord guild (server) ID.
+          guild_id:,
+          # Optional Discord role to assign within the guild.
+          role_id: nil
+        )
         end
 
         sig do
@@ -90,11 +168,15 @@ module Dodopayments
             )
           end
 
+        # Telegram chat ID. For groups this is typically a negative integer.
         sig { returns(String) }
         attr_accessor :chat_id
 
         sig { params(chat_id: String).returns(T.attached_class) }
-        def self.new(chat_id:)
+        def self.new(
+          # Telegram chat ID. For groups this is typically a negative integer.
+          chat_id:
+        )
         end
 
         sig { override.returns({ chat_id: String }) }
@@ -111,11 +193,15 @@ module Dodopayments
             )
           end
 
+        # Figma file identifier to grant access to.
         sig { returns(String) }
         attr_accessor :figma_file_id
 
         sig { params(figma_file_id: String).returns(T.attached_class) }
-        def self.new(figma_file_id:)
+        def self.new(
+          # Figma file identifier to grant access to.
+          figma_file_id:
+        )
         end
 
         sig { override.returns({ figma_file_id: String }) }
@@ -132,11 +218,15 @@ module Dodopayments
             )
           end
 
+        # Framer template identifier to grant access to.
         sig { returns(String) }
         attr_accessor :framer_template_id
 
         sig { params(framer_template_id: String).returns(T.attached_class) }
-        def self.new(framer_template_id:)
+        def self.new(
+          # Framer template identifier to grant access to.
+          framer_template_id:
+        )
         end
 
         sig { override.returns({ framer_template_id: String }) }
@@ -153,11 +243,15 @@ module Dodopayments
             )
           end
 
+        # Notion template identifier to grant access to.
         sig { returns(String) }
         attr_accessor :notion_template_id
 
         sig { params(notion_template_id: String).returns(T.attached_class) }
-        def self.new(notion_template_id:)
+        def self.new(
+          # Notion template identifier to grant access to.
+          notion_template_id:
+        )
         end
 
         sig { override.returns({ notion_template_id: String }) }
@@ -174,10 +268,8 @@ module Dodopayments
             )
           end
 
-        # 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.
         sig do
           returns(
             Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles
@@ -200,10 +292,8 @@ module Dodopayments
           ).returns(T.attached_class)
         end
         def self.new(
-          # 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.
           digital_files:
         )
         end
@@ -228,6 +318,7 @@ module Dodopayments
               )
             end
 
+          # One entry per attached file.
           sig do
             returns(
               T::Array[
@@ -237,16 +328,17 @@ module Dodopayments
           end
           attr_accessor :files
 
+          # Optional external URL, passed through from the entitlement configuration.
           sig { returns(T.nilable(String)) }
           attr_accessor :external_url
 
+          # Optional human-readable delivery instructions, passed through from the
+          # entitlement configuration.
           sig { returns(T.nilable(String)) }
           attr_accessor :instructions
 
-          # 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.
           sig do
             params(
               files:
@@ -257,7 +349,15 @@ module Dodopayments
               instructions: T.nilable(String)
             ).returns(T.attached_class)
           end
-          def self.new(files:, external_url: nil, instructions: nil)
+          def self.new(
+            # One entry per attached file.
+            files:,
+            # Optional external URL, passed through from the entitlement configuration.
+            external_url: nil,
+            # Optional human-readable delivery instructions, passed through from the
+            # entitlement configuration.
+            instructions: nil
+          )
           end
 
           sig do
@@ -284,6 +384,7 @@ module Dodopayments
                 )
               end
 
+            # Short-lived presigned URL for downloading the file.
             sig { returns(String) }
             attr_accessor :download_url
 
@@ -291,44 +392,45 @@ module Dodopayments
             sig { returns(Integer) }
             attr_accessor :expires_in
 
+            # Identifier of the attached file.
             sig { returns(String) }
             attr_accessor :file_id
 
+            # Original filename of the attached file.
             sig { returns(String) }
             attr_accessor :filename
 
-            # `"legacy"` for files in `product_files`, `"ee"` for files managed by the
-            # Entitlements Engine.
-            sig { returns(String) }
-            attr_accessor :source
-
+            # Optional content-type declared at upload.
             sig { returns(T.nilable(String)) }
             attr_accessor :content_type
 
+            # Optional size of the file in bytes.
             sig { returns(T.nilable(Integer)) }
             attr_accessor :file_size
 
+            # One file in a resolved digital-files payload.
             sig do
               params(
                 download_url: String,
                 expires_in: Integer,
                 file_id: String,
                 filename: String,
-                source: String,
                 content_type: T.nilable(String),
                 file_size: T.nilable(Integer)
               ).returns(T.attached_class)
             end
             def self.new(
+              # Short-lived presigned URL for downloading the file.
               download_url:,
               # Seconds until `download_url` expires.
               expires_in:,
+              # Identifier of the attached file.
               file_id:,
+              # Original filename of the attached file.
               filename:,
-              # `"legacy"` for files in `product_files`, `"ee"` for files managed by the
-              # Entitlements Engine.
-              source:,
+              # Optional content-type declared at upload.
               content_type: nil,
+              # Optional size of the file in bytes.
               file_size: nil
             )
             end
@@ -340,7 +442,6 @@ module Dodopayments
                   expires_in: Integer,
                   file_id: String,
                   filename: String,
-                  source: String,
                   content_type: T.nilable(String),
                   file_size: T.nilable(Integer)
                 }
@@ -361,15 +462,22 @@ module Dodopayments
             )
           end
 
+        # Optional message displayed when a customer activates the license key (≤ 2500
+        # characters).
         sig { returns(T.nilable(String)) }
         attr_accessor :activation_message
 
+        # Maximum activations allowed per issued license key. Omit for unlimited.
         sig { returns(T.nilable(Integer)) }
         attr_accessor :activations_limit
 
+        # Validity duration of issued license keys. Provide both `duration_count` and
+        # `duration_interval` together for a fixed duration; omit both for non-expiring
+        # keys.
         sig { returns(T.nilable(Integer)) }
         attr_accessor :duration_count
 
+        # Unit of `duration_count`.
         sig { returns(T.nilable(Dodopayments::TimeInterval::TaggedSymbol)) }
         attr_accessor :duration_interval
 
@@ -382,9 +490,16 @@ module Dodopayments
           ).returns(T.attached_class)
         end
         def self.new(
+          # Optional message displayed when a customer activates the license key (≤ 2500
+          # characters).
           activation_message: nil,
+          # Maximum activations allowed per issued license key. Omit for unlimited.
           activations_limit: nil,
+          # Validity duration of issued license keys. Provide both `duration_count` and
+          # `duration_interval` together for a fixed duration; omit both for non-expiring
+          # keys.
           duration_count: nil,
+          # Unit of `duration_count`.
           duration_interval: nil
         )
         end

data/rbi/dodopayments/models/product.rbi

@@ -63,10 +63,8 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :description
 
-      # 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.
       sig { returns(T.nilable(Dodopayments::DigitalProductDelivery)) }
       attr_reader :digital_product_delivery
 
@@ -172,10 +170,8 @@ module Dodopayments
         addons: nil,
         # Description of the product, optional.
         description: 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.
+        # Digital-product-delivery payload, present on grants for `digital_files`
+        # entitlements. Each file carries a short-lived presigned download URL.
         digital_product_delivery: nil,
         # URL of the product image, optional.
         image: nil,

data/rbi/dodopayments/models/product_entitlement_summary.rbi

@@ -14,10 +14,10 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :id
 
-      # 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.
       sig { returns(Dodopayments::IntegrationConfigResponse::Variants) }
       attr_accessor :integration_config
 
@@ -57,10 +57,10 @@ module Dodopayments
       end
       def self.new(
         id:,
-        # 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.
         integration_config:,
         integration_type:,
         name:,

data/rbi/dodopayments/models/webhook_payload.rbi

@@ -1034,6 +1034,8 @@ module Dodopayments
           end
           attr_accessor :payload_type
 
+          # Detailed view of a single entitlement grant: who it's for, its lifecycle state,
+          # and any integration-specific delivery payload.
           sig do
             params(
               payload_type:

data/rbi/dodopayments/resources/entitlements/files.rbi

@@ -4,10 +4,7 @@ module Dodopayments
   module Resources
     class Entitlements
       class Files
-        # Companion to `post_entitlement_file`. Deletes the file from the Entitlements
-        # Engine (force=true) and atomically removes the `file_id` from the entitlement's
-        # `integration_config.digital_file_ids` JSONB array. EE delete happens first; if
-        # it fails we surface the error and leave local state untouched.
+        # Detach a previously-attached file from a `digital_files` entitlement.
         sig do
           params(
             file_id: String,
@@ -16,7 +13,7 @@ module Dodopayments
           ).void
         end
         def delete(
-          # Digital file Id from EE
+          # Identifier of the attached file
           file_id,
           # Entitlement Id
           id:,
@@ -24,11 +21,7 @@ module Dodopayments
         )
         end
 
-        # Streams a multipart/form-data body to the Entitlements Engine
-        # (`POST /api/digital-files/dodo/files/upload`) and appends the returned `file_id`
-        # to the entitlement's `integration_config.digital_file_ids` using a JSONB array
-        # append. Compensates EE-side on local DB write failure (best-effort delete of the
-        # just-uploaded file).
+        # Attach a file to a `digital_files` entitlement. Per-file size cap: 500 MiB.
         sig do
           params(
             id: String,

data/rbi/dodopayments/resources/entitlements/grants.rbi

@@ -35,10 +35,8 @@ module Dodopayments
         )
         end
 
-        # Revokes a single entitlement grant for the caller's business. For LicenseKey
-        # integrations, also disables the backing license key. Idempotent: re-revoking an
-        # already-revoked grant returns 200 with current state. The revocation reason is
-        # always set to "manual" for API-initiated revocations.
+        # Revoke a single grant. Idempotent: re-revoking an already-revoked grant returns
+        # the grant in its current state.
         sig do
           params(
             grant_id: String,

data/rbi/dodopayments/resources/entitlements.rbi

@@ -26,7 +26,7 @@ module Dodopayments
           integration_type: Dodopayments::EntitlementIntegrationType::OrSymbol,
           name: String,
           description: T.nilable(String),
-          metadata: T.nilable(T::Hash[Symbol, String]),
+          metadata: T::Hash[Symbol, String],
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Entitlement)
       end
@@ -39,7 +39,7 @@ module Dodopayments
         name:,
         # Optional description
         description: nil,
-        # Optional user-facing metadata
+        # Additional metadata for the entitlement
         metadata: nil,
         request_options: {}
       )
@@ -86,8 +86,8 @@ module Dodopayments
         # Entitlement ID
         id,
         description: nil,
-        # 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`.
         integration_config: nil,
         metadata: nil,
         name: nil,

data/sig/dodopayments/models/entitlement.rbs

@@ -8,10 +8,10 @@ module Dodopayments
         integration_config: Dodopayments::Models::integration_config_response,
         integration_type: Dodopayments::Models::entitlement_integration_type,
         is_active: bool,
+        metadata: ::Hash[Symbol, String],
         name: String,
         updated_at: Time,
-        description: String?,
-        metadata: top
+        description: String?
       }
 
     class Entitlement < Dodopayments::Internal::Type::BaseModel
@@ -27,16 +27,14 @@ module Dodopayments
 
       attr_accessor is_active: bool
 
+      attr_accessor metadata: ::Hash[Symbol, String]
+
       attr_accessor name: String
 
       attr_accessor updated_at: Time
 
       attr_accessor description: String?
 
-      attr_reader metadata: top?
-
-      def metadata=: (top) -> top
-
       def initialize: (
         id: String,
         business_id: String,
@@ -44,10 +42,10 @@ module Dodopayments
         integration_config: Dodopayments::Models::integration_config_response,
         integration_type: Dodopayments::Models::entitlement_integration_type,
         is_active: bool,
+        metadata: ::Hash[Symbol, String],
         name: String,
         updated_at: Time,
-        ?description: String?,
-        ?metadata: top
+        ?description: String?
       ) -> void
 
       def to_hash: -> {
@@ -57,10 +55,10 @@ module Dodopayments
         integration_config: Dodopayments::Models::integration_config_response,
         integration_type: Dodopayments::Models::entitlement_integration_type,
         is_active: bool,
+        metadata: ::Hash[Symbol, String],
         name: String,
         updated_at: Time,
-        description: String?,
-        metadata: top
+        description: String?
       }
     end
   end

data/sig/dodopayments/models/entitlement_create_params.rbs

@@ -6,7 +6,7 @@ module Dodopayments
         integration_type: Dodopayments::Models::entitlement_integration_type,
         name: String,
         description: String?,
-        metadata: ::Hash[Symbol, String]?
+        metadata: ::Hash[Symbol, String]
       }
       & Dodopayments::Internal::Type::request_parameters
 
@@ -22,14 +22,16 @@ module Dodopayments
 
       attr_accessor description: String?
 
-      attr_accessor metadata: ::Hash[Symbol, String]?
+      attr_reader metadata: ::Hash[Symbol, String]?
+
+      def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
 
       def initialize: (
         integration_config: Dodopayments::Models::integration_config,
         integration_type: Dodopayments::Models::entitlement_integration_type,
         name: String,
         ?description: String?,
-        ?metadata: ::Hash[Symbol, String]?,
+        ?metadata: ::Hash[Symbol, String],
         ?request_options: Dodopayments::request_opts
       ) -> void
 
@@ -38,7 +40,7 @@ module Dodopayments
         integration_type: Dodopayments::Models::entitlement_integration_type,
         name: String,
         description: String?,
-        metadata: ::Hash[Symbol, String]?,
+        metadata: ::Hash[Symbol, String],
         request_options: Dodopayments::RequestOptions
       }
     end