dodopayments 2.6.0 → 2.7.0

data/rbi/dodopayments/models/webhook_payload.rbi

@@ -23,7 +23,8 @@ module Dodopayments
             Dodopayments::WebhookPayload::Data::CreditLedgerEntry,
             Dodopayments::WebhookPayload::Data::CreditBalanceLow,
             Dodopayments::WebhookPayload::Data::AbandonedCheckout,
-            Dodopayments::WebhookPayload::Data::DunningAttempt
+            Dodopayments::WebhookPayload::Data::DunningAttempt,
+            Dodopayments::WebhookPayload::Data::EntitlementGrant
           )
         )
       end
@@ -51,7 +52,8 @@ module Dodopayments
               Dodopayments::WebhookPayload::Data::CreditLedgerEntry::OrHash,
               Dodopayments::WebhookPayload::Data::CreditBalanceLow::OrHash,
               Dodopayments::WebhookPayload::Data::AbandonedCheckout::OrHash,
-              Dodopayments::WebhookPayload::Data::DunningAttempt::OrHash
+              Dodopayments::WebhookPayload::Data::DunningAttempt::OrHash,
+              Dodopayments::WebhookPayload::Data::EntitlementGrant::OrHash
             ),
           timestamp: Time,
           type: Dodopayments::WebhookEventType::OrSymbol
@@ -83,7 +85,8 @@ module Dodopayments
                 Dodopayments::WebhookPayload::Data::CreditLedgerEntry,
                 Dodopayments::WebhookPayload::Data::CreditBalanceLow,
                 Dodopayments::WebhookPayload::Data::AbandonedCheckout,
-                Dodopayments::WebhookPayload::Data::DunningAttempt
+                Dodopayments::WebhookPayload::Data::DunningAttempt,
+                Dodopayments::WebhookPayload::Data::EntitlementGrant
               ),
             timestamp: Time,
             type: Dodopayments::WebhookEventType::OrSymbol
@@ -108,7 +111,8 @@ module Dodopayments
               Dodopayments::WebhookPayload::Data::CreditLedgerEntry,
               Dodopayments::WebhookPayload::Data::CreditBalanceLow,
               Dodopayments::WebhookPayload::Data::AbandonedCheckout,
-              Dodopayments::WebhookPayload::Data::DunningAttempt
+              Dodopayments::WebhookPayload::Data::DunningAttempt,
+              Dodopayments::WebhookPayload::Data::EntitlementGrant
             )
           end
 
@@ -1014,6 +1018,265 @@ module Dodopayments
           end
         end
 
+        class EntitlementGrant < Dodopayments::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::WebhookPayload::Data::EntitlementGrant,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(String) }
+          attr_accessor :business_id
+
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          sig { returns(String) }
+          attr_accessor :customer_id
+
+          sig { returns(String) }
+          attr_accessor :entitlement_id
+
+          sig { returns(String) }
+          attr_accessor :external_id
+
+          sig do
+            returns(
+              Dodopayments::WebhookPayload::Data::EntitlementGrant::PayloadType::OrSymbol
+            )
+          end
+          attr_accessor :payload_type
+
+          sig do
+            returns(
+              Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::OrSymbol
+            )
+          end
+          attr_accessor :status
+
+          sig { returns(Time) }
+          attr_accessor :updated_at
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :delivered_at
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :error_code
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :error_message
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :license_key
+
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :license_key_activations_limit
+
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :license_key_activations_used
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :license_key_expires_at
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :license_key_status
+
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :metadata
+
+          sig { params(metadata: T.anything).void }
+          attr_writer :metadata
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :oauth_expires_at
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :oauth_url
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :payment_id
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :revocation_reason
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :revoked_at
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :subscription_id
+
+          sig do
+            params(
+              id: String,
+              business_id: String,
+              created_at: Time,
+              customer_id: String,
+              entitlement_id: String,
+              external_id: String,
+              payload_type:
+                Dodopayments::WebhookPayload::Data::EntitlementGrant::PayloadType::OrSymbol,
+              status:
+                Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::OrSymbol,
+              updated_at: Time,
+              delivered_at: T.nilable(Time),
+              error_code: T.nilable(String),
+              error_message: T.nilable(String),
+              license_key: T.nilable(String),
+              license_key_activations_limit: T.nilable(Integer),
+              license_key_activations_used: T.nilable(Integer),
+              license_key_expires_at: T.nilable(Time),
+              license_key_status: T.nilable(String),
+              metadata: T.anything,
+              oauth_expires_at: T.nilable(Time),
+              oauth_url: T.nilable(String),
+              payment_id: T.nilable(String),
+              revocation_reason: T.nilable(String),
+              revoked_at: T.nilable(Time),
+              subscription_id: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            business_id:,
+            created_at:,
+            customer_id:,
+            entitlement_id:,
+            external_id:,
+            payload_type:,
+            status:,
+            updated_at:,
+            delivered_at: nil,
+            error_code: nil,
+            error_message: nil,
+            license_key: nil,
+            license_key_activations_limit: nil,
+            license_key_activations_used: nil,
+            license_key_expires_at: nil,
+            license_key_status: nil,
+            metadata: nil,
+            oauth_expires_at: nil,
+            oauth_url: nil,
+            payment_id: nil,
+            revocation_reason: nil,
+            revoked_at: nil,
+            subscription_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                business_id: String,
+                created_at: Time,
+                customer_id: String,
+                entitlement_id: String,
+                external_id: String,
+                payload_type:
+                  Dodopayments::WebhookPayload::Data::EntitlementGrant::PayloadType::OrSymbol,
+                status:
+                  Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::OrSymbol,
+                updated_at: Time,
+                delivered_at: T.nilable(Time),
+                error_code: T.nilable(String),
+                error_message: T.nilable(String),
+                license_key: T.nilable(String),
+                license_key_activations_limit: T.nilable(Integer),
+                license_key_activations_used: T.nilable(Integer),
+                license_key_expires_at: T.nilable(Time),
+                license_key_status: T.nilable(String),
+                metadata: T.anything,
+                oauth_expires_at: T.nilable(Time),
+                oauth_url: T.nilable(String),
+                payment_id: T.nilable(String),
+                revocation_reason: T.nilable(String),
+                revoked_at: T.nilable(Time),
+                subscription_id: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module PayloadType
+            extend Dodopayments::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Dodopayments::WebhookPayload::Data::EntitlementGrant::PayloadType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ENTITLEMENT_GRANT =
+              T.let(
+                :EntitlementGrant,
+                Dodopayments::WebhookPayload::Data::EntitlementGrant::PayloadType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Dodopayments::WebhookPayload::Data::EntitlementGrant::PayloadType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Status
+            extend Dodopayments::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Dodopayments::WebhookPayload::Data::EntitlementGrant::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PENDING =
+              T.let(
+                :Pending,
+                Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::TaggedSymbol
+              )
+            DELIVERED =
+              T.let(
+                :Delivered,
+                Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::TaggedSymbol
+              )
+            FAILED =
+              T.let(
+                :Failed,
+                Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::TaggedSymbol
+              )
+            REVOKED =
+              T.let(
+                :Revoked,
+                Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         sig do
           override.returns(
             T::Array[Dodopayments::WebhookPayload::Data::Variants]

data/rbi/dodopayments/models.rbi

@@ -237,6 +237,8 @@ module Dodopayments
   LicenseKeyCreatedWebhookEvent =
     Dodopayments::Models::LicenseKeyCreatedWebhookEvent
 
+  LicenseKeyCreateParams = Dodopayments::Models::LicenseKeyCreateParams
+
   LicenseKeyDuration = Dodopayments::Models::LicenseKeyDuration
 
   LicenseKeyInstance = Dodopayments::Models::LicenseKeyInstance

data/rbi/dodopayments/resources/license_keys.rbi

@@ -3,6 +3,31 @@
 module Dodopayments
   module Resources
     class LicenseKeys
+      sig do
+        params(
+          customer_id: String,
+          key: String,
+          product_id: String,
+          activations_limit: T.nilable(Integer),
+          expires_at: T.nilable(Time),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::LicenseKey)
+      end
+      def create(
+        # The customer this license key belongs to.
+        customer_id:,
+        # The license key string to import.
+        key:,
+        # The product this license key is for.
+        product_id:,
+        # Maximum number of activations allowed. Null means unlimited.
+        activations_limit: nil,
+        # Expiration timestamp. Null means the key never expires.
+        expires_at: nil,
+        request_options: {}
+      )
+      end
+
       sig do
         params(
           id: String,
@@ -49,6 +74,7 @@ module Dodopayments
           page_number: Integer,
           page_size: Integer,
           product_id: String,
+          source: Dodopayments::LicenseKeyListParams::Source::OrSymbol,
           status: Dodopayments::LicenseKeyListParams::Status::OrSymbol,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(
@@ -70,6 +96,8 @@ module Dodopayments
         page_size: nil,
         # Filter by product ID
         product_id: nil,
+        # Filter by license key source
+        source: nil,
         # Filter by license key status
         status: nil,
         request_options: {}

data/rbi/dodopayments/resources/products.rbi

@@ -28,6 +28,7 @@ module Dodopayments
             T.nilable(
               Dodopayments::ProductCreateParams::DigitalProductDelivery::OrHash
             ),
+          entitlement_ids: T.nilable(T::Array[String]),
           license_key_activation_message: T.nilable(String),
           license_key_activations_limit: T.nilable(Integer),
           license_key_duration:
@@ -54,6 +55,8 @@ module Dodopayments
         description: nil,
         # Choose how you would like you digital product delivered
         digital_product_delivery: nil,
+        # Optional entitlement IDs to attach to this product (max 20)
+        entitlement_ids: nil,
         # Optional message displayed during license key activation
         license_key_activation_message: nil,
         # The number of times the license key can be activated. Must be 0 or greater
@@ -95,6 +98,7 @@ module Dodopayments
             T.nilable(
               Dodopayments::ProductUpdateParams::DigitalProductDelivery::OrHash
             ),
+          entitlement_ids: T.nilable(T::Array[String]),
           image_id: T.nilable(String),
           license_key_activation_message: T.nilable(String),
           license_key_activations_limit: T.nilable(Integer),
@@ -127,6 +131,9 @@ module Dodopayments
         description: nil,
         # Choose how you would like you digital product delivered
         digital_product_delivery: nil,
+        # Entitlement IDs to attach (replaces all existing when present) Send empty array
+        # to remove all, omit field to leave unchanged
+        entitlement_ids: nil,
         # Product image id after its uploaded to S3
         image_id: nil,
         # Message sent to the customer upon license key activation.

data/sig/dodopayments/models/license_key.rbs

@@ -8,11 +8,12 @@ module Dodopayments
         customer_id: String,
         instances_count: Integer,
         key: String,
-        payment_id: String,
         product_id: String,
+        source: Dodopayments::Models::LicenseKey::source,
         status: Dodopayments::Models::license_key_status,
         activations_limit: Integer?,
         expires_at: Time?,
+        payment_id: String?,
         subscription_id: String?
       }
 
@@ -29,16 +30,18 @@ module Dodopayments
 
       attr_accessor key: String
 
-      attr_accessor payment_id: String
-
       attr_accessor product_id: String
 
+      attr_accessor source: Dodopayments::Models::LicenseKey::source
+
       attr_accessor status: Dodopayments::Models::license_key_status
 
       attr_accessor activations_limit: Integer?
 
       attr_accessor expires_at: Time?
 
+      attr_accessor payment_id: String?
+
       attr_accessor subscription_id: String?
 
       def initialize: (
@@ -48,11 +51,12 @@ module Dodopayments
         customer_id: String,
         instances_count: Integer,
         key: String,
-        payment_id: String,
         product_id: String,
+        source: Dodopayments::Models::LicenseKey::source,
         status: Dodopayments::Models::license_key_status,
         ?activations_limit: Integer?,
         ?expires_at: Time?,
+        ?payment_id: String?,
         ?subscription_id: String?
       ) -> void
 
@@ -63,13 +67,25 @@ module Dodopayments
         customer_id: String,
         instances_count: Integer,
         key: String,
-        payment_id: String,
         product_id: String,
+        source: Dodopayments::Models::LicenseKey::source,
         status: Dodopayments::Models::license_key_status,
         activations_limit: Integer?,
         expires_at: Time?,
+        payment_id: String?,
         subscription_id: String?
       }
+
+      type source = :auto | :import
+
+      module Source
+        extend Dodopayments::Internal::Type::Enum
+
+        AUTO: :auto
+        IMPORT: :import
+
+        def self?.values: -> ::Array[Dodopayments::Models::LicenseKey::source]
+      end
     end
   end
 end

data/sig/dodopayments/models/license_key_create_params.rbs

@@ -0,0 +1,46 @@
+module Dodopayments
+  module Models
+    type license_key_create_params =
+      {
+        customer_id: String,
+        key: String,
+        product_id: String,
+        activations_limit: Integer?,
+        expires_at: Time?
+      }
+      & Dodopayments::Internal::Type::request_parameters
+
+    class LicenseKeyCreateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      attr_accessor customer_id: String
+
+      attr_accessor key: String
+
+      attr_accessor product_id: String
+
+      attr_accessor activations_limit: Integer?
+
+      attr_accessor expires_at: Time?
+
+      def initialize: (
+        customer_id: String,
+        key: String,
+        product_id: String,
+        ?activations_limit: Integer?,
+        ?expires_at: Time?,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        customer_id: String,
+        key: String,
+        product_id: String,
+        activations_limit: Integer?,
+        expires_at: Time?,
+        request_options: Dodopayments::RequestOptions
+      }
+    end
+  end
+end

data/sig/dodopayments/models/license_key_list_params.rbs

@@ -8,6 +8,7 @@ module Dodopayments
         page_number: Integer,
         page_size: Integer,
         product_id: String,
+        source: Dodopayments::Models::LicenseKeyListParams::source,
         status: Dodopayments::Models::LicenseKeyListParams::status
       }
       & Dodopayments::Internal::Type::request_parameters
@@ -40,6 +41,12 @@ module Dodopayments
 
       def product_id=: (String) -> String
 
+      attr_reader source: Dodopayments::Models::LicenseKeyListParams::source?
+
+      def source=: (
+        Dodopayments::Models::LicenseKeyListParams::source
+      ) -> Dodopayments::Models::LicenseKeyListParams::source
+
       attr_reader status: Dodopayments::Models::LicenseKeyListParams::status?
 
       def status=: (
@@ -53,6 +60,7 @@ module Dodopayments
         ?page_number: Integer,
         ?page_size: Integer,
         ?product_id: String,
+        ?source: Dodopayments::Models::LicenseKeyListParams::source,
         ?status: Dodopayments::Models::LicenseKeyListParams::status,
         ?request_options: Dodopayments::request_opts
       ) -> void
@@ -64,10 +72,22 @@ module Dodopayments
         page_number: Integer,
         page_size: Integer,
         product_id: String,
+        source: Dodopayments::Models::LicenseKeyListParams::source,
         status: Dodopayments::Models::LicenseKeyListParams::status,
         request_options: Dodopayments::RequestOptions
       }
 
+      type source = :auto | :import
+
+      module Source
+        extend Dodopayments::Internal::Type::Enum
+
+        AUTO: :auto
+        IMPORT: :import
+
+        def self?.values: -> ::Array[Dodopayments::Models::LicenseKeyListParams::source]
+      end
+
       type status = :active | :expired | :disabled
 
       module Status