dodopayments 2.5.0 → 2.7.0

data/lib/dodopayments/resources/license_keys.rb

@@ -3,6 +3,36 @@
 module Dodopayments
   module Resources
     class LicenseKeys
+      # @overload create(customer_id:, key:, product_id:, activations_limit: nil, expires_at: nil, request_options: {})
+      #
+      # @param customer_id [String] The customer this license key belongs to.
+      #
+      # @param key [String] The license key string to import.
+      #
+      # @param product_id [String] The product this license key is for.
+      #
+      # @param activations_limit [Integer, nil] Maximum number of activations allowed. Null means unlimited.
+      #
+      # @param expires_at [Time, nil] Expiration timestamp. Null means the key never expires.
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::LicenseKey]
+      #
+      # @see Dodopayments::Models::LicenseKeyCreateParams
+      def create(params)
+        parsed, options = Dodopayments::LicenseKeyCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "license_keys",
+          body: parsed,
+          model: Dodopayments::LicenseKey,
+          options: options
+        )
+      end
+
+      # @deprecated
+      #
       # @overload retrieve(id, request_options: {})
       #
       # @param id [String] License key ID
@@ -21,6 +51,8 @@ module Dodopayments
         )
       end
 
+      # @deprecated
+      #
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::LicenseKeyUpdateParams} for more details.
       #
@@ -50,7 +82,9 @@ module Dodopayments
         )
       end
 
-      # @overload list(created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, request_options: {})
+      # @deprecated
+      #
+      # @overload list(created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, product_id: nil, source: nil, status: nil, request_options: {})
       #
       # @param created_at_gte [Time] Filter license keys created on or after this timestamp
       #
@@ -64,6 +98,8 @@ module Dodopayments
       #
       # @param product_id [String] Filter by product ID
       #
+      # @param source [Symbol, Dodopayments::Models::LicenseKeyListParams::Source] Filter by license key source
+      #
       # @param status [Symbol, Dodopayments::Models::LicenseKeyListParams::Status] Filter by license key status
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/dodopayments/resources/products.rb

@@ -12,7 +12,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::ProductCreateParams} for more details.
       #
-      # @overload create(name:, price:, tax_category:, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, request_options: {})
+      # @overload create(name:, price:, tax_category:, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlement_ids: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, request_options: {})
       #
       # @param name [String] Name of the product
       #
@@ -30,6 +30,8 @@ module Dodopayments
       #
       # @param digital_product_delivery [Dodopayments::Models::ProductCreateParams::DigitalProductDelivery, nil] Choose how you would like you digital product delivered
       #
+      # @param entitlement_ids [Array<String>, nil] Optional entitlement IDs to attach to this product (max 20)
+      #
       # @param license_key_activation_message [String, nil] Optional message displayed during license key activation
       #
       # @param license_key_activations_limit [Integer, nil] The number of times the license key can be activated.
@@ -77,7 +79,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::ProductUpdateParams} for more details.
       #
-      # @overload update(id, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, name: nil, price: nil, tax_category: nil, request_options: {})
+      # @overload update(id, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlement_ids: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, name: nil, price: nil, tax_category: nil, request_options: {})
       #
       # @param id [String]
       #
@@ -91,6 +93,8 @@ module Dodopayments
       #
       # @param digital_product_delivery [Dodopayments::Models::ProductUpdateParams::DigitalProductDelivery, nil] Choose how you would like you digital product delivered
       #
+      # @param entitlement_ids [Array<String>, nil] Entitlement IDs to attach (replaces all existing when present)
+      #
       # @param image_id [String, nil] Product image id after its uploaded to S3
       #
       # @param license_key_activation_message [String, nil] Message sent to the customer upon license key activation.

data/lib/dodopayments/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dodopayments
-  VERSION = "2.5.0"
+  VERSION = "2.7.0"
 end

data/lib/dodopayments.rb

@@ -186,6 +186,7 @@ require_relative "dodopayments/models/license_activate_params"
 require_relative "dodopayments/models/license_activate_response"
 require_relative "dodopayments/models/license_deactivate_params"
 require_relative "dodopayments/models/license_key_created_webhook_event"
+require_relative "dodopayments/models/license_key_create_params"
 require_relative "dodopayments/models/license_key_duration"
 require_relative "dodopayments/models/license_key_instance"
 require_relative "dodopayments/models/license_key_instance_list_params"

data/rbi/dodopayments/models/discount.rbi

@@ -32,6 +32,9 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :discount_id
 
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :metadata
+
       # Whether this discount should be preserved when a subscription changes plans.
       # Default: false (discount is removed on plan change)
       sig { returns(T::Boolean) }
@@ -74,6 +77,7 @@ module Dodopayments
           code: String,
           created_at: Time,
           discount_id: String,
+          metadata: T::Hash[Symbol, String],
           preserve_on_plan_change: T::Boolean,
           restricted_to: T::Array[String],
           times_used: Integer,
@@ -99,6 +103,7 @@ module Dodopayments
         created_at:,
         # The unique discount ID
         discount_id:,
+        metadata:,
         # Whether this discount should be preserved when a subscription changes plans.
         # Default: false (discount is removed on plan change)
         preserve_on_plan_change:,
@@ -129,6 +134,7 @@ module Dodopayments
             code: String,
             created_at: Time,
             discount_id: String,
+            metadata: T::Hash[Symbol, String],
             preserve_on_plan_change: T::Boolean,
             restricted_to: T::Array[String],
             times_used: Integer,

data/rbi/dodopayments/models/discount_create_params.rbi

@@ -40,6 +40,13 @@ module Dodopayments
       sig { returns(T.nilable(Time)) }
       attr_accessor :expires_at
 
+      # Additional metadata for the discount
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
       sig { returns(T.nilable(String)) }
       attr_accessor :name
 
@@ -71,6 +78,7 @@ module Dodopayments
           type: Dodopayments::DiscountType::OrSymbol,
           code: T.nilable(String),
           expires_at: T.nilable(Time),
+          metadata: T::Hash[Symbol, String],
           name: T.nilable(String),
           preserve_on_plan_change: T::Boolean,
           restricted_to: T.nilable(T::Array[String]),
@@ -98,6 +106,8 @@ module Dodopayments
         code: nil,
         # When the discount expires, if ever.
         expires_at: nil,
+        # Additional metadata for the discount
+        metadata: nil,
         name: nil,
         # Whether this discount should be preserved when a subscription changes plans.
         # Default: false (discount is removed on plan change)
@@ -121,6 +131,7 @@ module Dodopayments
             type: Dodopayments::DiscountType::OrSymbol,
             code: T.nilable(String),
             expires_at: T.nilable(Time),
+            metadata: T::Hash[Symbol, String],
             name: T.nilable(String),
             preserve_on_plan_change: T::Boolean,
             restricted_to: T.nilable(T::Array[String]),

data/rbi/dodopayments/models/discount_update_params.rbi

@@ -34,6 +34,10 @@ module Dodopayments
       sig { returns(T.nilable(Time)) }
       attr_accessor :expires_at
 
+      # Additional metadata for the discount
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
       sig { returns(T.nilable(String)) }
       attr_accessor :name
 
@@ -66,6 +70,7 @@ module Dodopayments
           amount: T.nilable(Integer),
           code: T.nilable(String),
           expires_at: T.nilable(Time),
+          metadata: T.nilable(T::Hash[Symbol, String]),
           name: T.nilable(String),
           preserve_on_plan_change: T.nilable(T::Boolean),
           restricted_to: T.nilable(T::Array[String]),
@@ -88,6 +93,8 @@ module Dodopayments
         # If present, update the discount code (uppercase).
         code: nil,
         expires_at: nil,
+        # Additional metadata for the discount
+        metadata: nil,
         name: nil,
         # Whether this discount should be preserved when a subscription changes plans. If
         # not provided, the existing value is kept.
@@ -113,6 +120,7 @@ module Dodopayments
             amount: T.nilable(Integer),
             code: T.nilable(String),
             expires_at: T.nilable(Time),
+            metadata: T.nilable(T::Hash[Symbol, String]),
             name: T.nilable(String),
             preserve_on_plan_change: T.nilable(T::Boolean),
             restricted_to: T.nilable(T::Array[String]),

data/rbi/dodopayments/models/license_key.rbi

@@ -32,14 +32,15 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :key
 
-      # The unique identifier of the payment associated with the license key.
-      sig { returns(String) }
-      attr_accessor :payment_id
-
       # The unique identifier of the product associated with the license key.
       sig { returns(String) }
       attr_accessor :product_id
 
+      # The source of the license key - 'auto' for keys generated by
+      # payment/subscription flows, 'import' for merchant-imported keys.
+      sig { returns(Dodopayments::LicenseKey::Source::TaggedSymbol) }
+      attr_accessor :source
+
       # The current status of the license key (e.g., active, inactive, expired).
       sig { returns(Dodopayments::LicenseKeyStatus::TaggedSymbol) }
       attr_accessor :status
@@ -52,6 +53,10 @@ module Dodopayments
       sig { returns(T.nilable(Time)) }
       attr_accessor :expires_at
 
+      # The unique identifier of the payment associated with the license key, if any.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :payment_id
+
       # The unique identifier of the subscription associated with the license key, if
       # any.
       sig { returns(T.nilable(String)) }
@@ -65,11 +70,12 @@ module Dodopayments
           customer_id: String,
           instances_count: Integer,
           key: String,
-          payment_id: String,
           product_id: String,
+          source: Dodopayments::LicenseKey::Source::OrSymbol,
           status: Dodopayments::LicenseKeyStatus::OrSymbol,
           activations_limit: T.nilable(Integer),
           expires_at: T.nilable(Time),
+          payment_id: T.nilable(String),
           subscription_id: T.nilable(String)
         ).returns(T.attached_class)
       end
@@ -86,16 +92,19 @@ module Dodopayments
         instances_count:,
         # The license key string.
         key:,
-        # The unique identifier of the payment associated with the license key.
-        payment_id:,
         # The unique identifier of the product associated with the license key.
         product_id:,
+        # The source of the license key - 'auto' for keys generated by
+        # payment/subscription flows, 'import' for merchant-imported keys.
+        source:,
         # The current status of the license key (e.g., active, inactive, expired).
         status:,
         # The maximum number of activations allowed for this license key.
         activations_limit: nil,
         # The timestamp indicating when the license key expires, in UTC.
         expires_at: nil,
+        # The unique identifier of the payment associated with the license key, if any.
+        payment_id: nil,
         # The unique identifier of the subscription associated with the license key, if
         # any.
         subscription_id: nil
@@ -111,17 +120,39 @@ module Dodopayments
             customer_id: String,
             instances_count: Integer,
             key: String,
-            payment_id: String,
             product_id: String,
+            source: Dodopayments::LicenseKey::Source::TaggedSymbol,
             status: Dodopayments::LicenseKeyStatus::TaggedSymbol,
             activations_limit: T.nilable(Integer),
             expires_at: T.nilable(Time),
+            payment_id: T.nilable(String),
             subscription_id: T.nilable(String)
           }
         )
       end
       def to_hash
       end
+
+      # The source of the license key - 'auto' for keys generated by
+      # payment/subscription flows, 'import' for merchant-imported keys.
+      module Source
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Dodopayments::LicenseKey::Source) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AUTO = T.let(:auto, Dodopayments::LicenseKey::Source::TaggedSymbol)
+        IMPORT = T.let(:import, Dodopayments::LicenseKey::Source::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Dodopayments::LicenseKey::Source::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/dodopayments/models/license_key_create_params.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class LicenseKeyCreateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::LicenseKeyCreateParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The customer this license key belongs to.
+      sig { returns(String) }
+      attr_accessor :customer_id
+
+      # The license key string to import.
+      sig { returns(String) }
+      attr_accessor :key
+
+      # The product this license key is for.
+      sig { returns(String) }
+      attr_accessor :product_id
+
+      # Maximum number of activations allowed. Null means unlimited.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :activations_limit
+
+      # Expiration timestamp. Null means the key never expires.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :expires_at
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # 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
+        override.returns(
+          {
+            customer_id: String,
+            key: String,
+            product_id: String,
+            activations_limit: T.nilable(Integer),
+            expires_at: T.nilable(Time),
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/license_key_list_params.rbi

@@ -56,6 +56,19 @@ module Dodopayments
       sig { params(product_id: String).void }
       attr_writer :product_id
 
+      # Filter by license key source
+      sig do
+        returns(T.nilable(Dodopayments::LicenseKeyListParams::Source::OrSymbol))
+      end
+      attr_reader :source
+
+      sig do
+        params(
+          source: Dodopayments::LicenseKeyListParams::Source::OrSymbol
+        ).void
+      end
+      attr_writer :source
+
       # Filter by license key status
       sig do
         returns(T.nilable(Dodopayments::LicenseKeyListParams::Status::OrSymbol))
@@ -77,6 +90,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(T.attached_class)
@@ -94,6 +108,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: {}
@@ -109,6 +125,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
           }
@@ -117,6 +134,33 @@ module Dodopayments
       def to_hash
       end
 
+      # Filter by license key source
+      module Source
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Dodopayments::LicenseKeyListParams::Source)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AUTO =
+          T.let(:auto, Dodopayments::LicenseKeyListParams::Source::TaggedSymbol)
+        IMPORT =
+          T.let(
+            :import,
+            Dodopayments::LicenseKeyListParams::Source::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Dodopayments::LicenseKeyListParams::Source::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
       # Filter by license key status
       module Status
         extend Dodopayments::Internal::Type::Enum