dodopayments 2.0.0 → 2.1.1

data/lib/dodopayments/models/discount_retrieve_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute discount_id
+      #
+      #   @return [String]
+      required :discount_id, String
+
+      # @!method initialize(discount_id:, request_options: {})
+      #   @param discount_id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/discount_update_params.rb

@@ -7,6 +7,11 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      # @!attribute discount_id
+      #
+      #   @return [String]
+      required :discount_id, String
+
       # @!attribute amount
       #   If present, update the discount amount:
       #
@@ -35,6 +40,13 @@ module Dodopayments
       #   @return [String, nil]
       optional :name, String, nil?: true
 
+      # @!attribute preserve_on_plan_change
+      #   Whether this discount should be preserved when a subscription changes plans. If
+      #   not provided, the existing value is kept.
+      #
+      #   @return [Boolean, nil]
+      optional :preserve_on_plan_change, Dodopayments::Internal::Type::Boolean, nil?: true
+
       # @!attribute restricted_to
       #   If present, replaces all restricted product IDs with this new set. To remove all
       #   restrictions, send empty array
@@ -61,10 +73,12 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :usage_limit, Integer, nil?: true
 
-      # @!method initialize(amount: nil, code: nil, expires_at: nil, name: nil, restricted_to: nil, subscription_cycles: nil, type: nil, usage_limit: nil, request_options: {})
+      # @!method initialize(discount_id:, amount: nil, code: nil, expires_at: nil, name: nil, preserve_on_plan_change: nil, restricted_to: nil, subscription_cycles: nil, type: nil, usage_limit: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::DiscountUpdateParams} for more details.
       #
+      #   @param discount_id [String]
+      #
       #   @param amount [Integer, nil] If present, update the discount amount:
       #
       #   @param code [String, nil] If present, update the discount code (uppercase).
@@ -73,6 +87,8 @@ module Dodopayments
       #
       #   @param name [String, nil]
       #
+      #   @param preserve_on_plan_change [Boolean, nil] Whether this discount should be preserved when a subscription changes plans.
+      #
       #   @param restricted_to [Array<String>, nil] If present, replaces all restricted product IDs with this new set.
       #
       #   @param subscription_cycles [Integer, nil] Number of subscription billing cycles this discount is valid for.

data/lib/dodopayments/models/dispute_retrieve_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute dispute_id
+      #
+      #   @return [String]
+      required :dispute_id, String
+
+      # @!method initialize(dispute_id:, request_options: {})
+      #   @param dispute_id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/invoices/payment_retrieve_params.rb

@@ -8,7 +8,13 @@ module Dodopayments
         extend Dodopayments::Internal::Type::RequestParameters::Converter
         include Dodopayments::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute payment_id
+        #
+        #   @return [String]
+        required :payment_id, String
+
+        # @!method initialize(payment_id:, request_options: {})
+        #   @param payment_id [String]
         #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/dodopayments/models/invoices/payment_retrieve_refund_params.rb

@@ -8,7 +8,13 @@ module Dodopayments
         extend Dodopayments::Internal::Type::RequestParameters::Converter
         include Dodopayments::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute refund_id
+        #
+        #   @return [String]
+        required :refund_id, String
+
+        # @!method initialize(refund_id:, request_options: {})
+        #   @param refund_id [String]
         #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/dodopayments/models/license_key_instance_retrieve_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/license_key_instance_update_params.rb

@@ -7,12 +7,18 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute name
       #
       #   @return [String]
       required :name, String
 
-      # @!method initialize(name:, request_options: {})
+      # @!method initialize(id:, name:, request_options: {})
+      #   @param id [String]
       #   @param name [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/dodopayments/models/license_key_retrieve_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/license_key_update_params.rb

@@ -7,6 +7,11 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute activations_limit
       #   The updated activation limit for the license key. Use `null` to remove the
       #   limit, or omit this field to leave it unchanged.
@@ -28,10 +33,12 @@ module Dodopayments
       #   @return [Time, nil]
       optional :expires_at, Time, nil?: true
 
-      # @!method initialize(activations_limit: nil, disabled: nil, expires_at: nil, request_options: {})
+      # @!method initialize(id:, activations_limit: nil, disabled: nil, expires_at: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::LicenseKeyUpdateParams} for more details.
       #
+      #   @param id [String]
+      #
       #   @param activations_limit [Integer, nil] The updated activation limit for the license key.
       #
       #   @param disabled [Boolean, nil] Indicates whether the license key should be disabled.

data/lib/dodopayments/models/meter_archive_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/meter_retrieve_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/meter_unarchive_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/payment_retrieve_line_items_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute payment_id
+      #
+      #   @return [String]
+      required :payment_id, String
+
+      # @!method initialize(payment_id:, request_options: {})
+      #   @param payment_id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/payment_retrieve_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute payment_id
+      #
+      #   @return [String]
+      required :payment_id, String
+
+      # @!method initialize(payment_id:, request_options: {})
+      #   @param payment_id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/product_archive_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/product_retrieve_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/product_unarchive_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/product_update_files_params.rb

@@ -7,12 +7,18 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute file_name
       #
       #   @return [String]
       required :file_name, String
 
-      # @!method initialize(file_name:, request_options: {})
+      # @!method initialize(id:, file_name:, request_options: {})
+      #   @param id [String]
       #   @param file_name [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/dodopayments/models/product_update_params.rb

@@ -7,6 +7,11 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute addons
       #   Available Addons for subscription products
       #
@@ -107,10 +112,12 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::TaxCategory, nil]
       optional :tax_category, enum: -> { Dodopayments::TaxCategory }, nil?: true
 
-      # @!method initialize(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: {})
+      # @!method initialize(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: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::ProductUpdateParams} for more details.
       #
+      #   @param id [String]
+      #
       #   @param addons [Array<String>, nil] Available Addons for subscription products
       #
       #   @param brand_id [String, nil]

data/lib/dodopayments/models/products/image_update_params.rb

@@ -8,12 +8,18 @@ module Dodopayments
         extend Dodopayments::Internal::Type::RequestParameters::Converter
         include Dodopayments::Internal::Type::RequestParameters
 
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
         # @!attribute force_update
         #
         #   @return [Boolean, nil]
         optional :force_update, Dodopayments::Internal::Type::Boolean
 
-        # @!method initialize(force_update: nil, request_options: {})
+        # @!method initialize(id:, force_update: nil, request_options: {})
+        #   @param id [String]
         #   @param force_update [Boolean]
         #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/dodopayments/models/products/short_link_create_params.rb

@@ -8,6 +8,11 @@ module Dodopayments
         extend Dodopayments::Internal::Type::RequestParameters::Converter
         include Dodopayments::Internal::Type::RequestParameters
 
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
         # @!attribute slug
         #   Slug for the short link.
         #
@@ -20,10 +25,12 @@ module Dodopayments
         #   @return [Hash{Symbol=>String}, nil]
         optional :static_checkout_params, Dodopayments::Internal::Type::HashOf[String], nil?: true
 
-        # @!method initialize(slug:, static_checkout_params: nil, request_options: {})
+        # @!method initialize(id:, slug:, static_checkout_params: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::Products::ShortLinkCreateParams} for more details.
         #
+        #   @param id [String]
+        #
         #   @param slug [String] Slug for the short link.
         #
         #   @param static_checkout_params [Hash{Symbol=>String}, nil] Static Checkout URL parameters to apply to the resulting

data/lib/dodopayments/models/refund_retrieve_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute refund_id
+      #
+      #   @return [String]
+      required :refund_id, String
+
+      # @!method initialize(refund_id:, request_options: {})
+      #   @param refund_id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/subscription_change_plan_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
+      # @!method initialize(subscription_id:, request_options: {})
+      #   @param subscription_id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/subscription_charge_params.rb

@@ -7,6 +7,11 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
       # @!attribute product_price
       #   The product price. Represented in the lowest denomination of the currency (e.g.,
       #   cents for USD). For example, to charge $1.00, pass `100`.
@@ -51,10 +56,12 @@ module Dodopayments
       #   @return [String, nil]
       optional :product_description, String, nil?: true
 
-      # @!method initialize(product_price:, adaptive_currency_fees_inclusive: nil, customer_balance_config: nil, metadata: nil, product_currency: nil, product_description: nil, request_options: {})
+      # @!method initialize(subscription_id:, product_price:, adaptive_currency_fees_inclusive: nil, customer_balance_config: nil, metadata: nil, product_currency: nil, product_description: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::SubscriptionChargeParams} for more details.
       #
+      #   @param subscription_id [String]
+      #
       #   @param product_price [Integer] The product price. Represented in the lowest denomination of the currency (e.g.,
       #
       #   @param adaptive_currency_fees_inclusive [Boolean, nil] Whether adaptive currency fees should be included in the product_price (true) or

data/lib/dodopayments/models/subscription_preview_change_plan_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
+      # @!method initialize(subscription_id:, request_options: {})
+      #   @param subscription_id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/subscription_retrieve_credit_usage_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
+      # @!method initialize(subscription_id:, request_options: {})
+      #   @param subscription_id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/subscription_retrieve_params.rb

@@ -7,7 +7,13 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
+      # @!method initialize(subscription_id:, request_options: {})
+      #   @param subscription_id [String]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/subscription_retrieve_usage_history_params.rb

@@ -7,6 +7,11 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
       # @!attribute end_date
       #   Filter by end date (inclusive)
       #
@@ -37,7 +42,9 @@ module Dodopayments
       #   @return [Time, nil]
       optional :start_date, Time, nil?: true
 
-      # @!method initialize(end_date: nil, meter_id: nil, page_number: nil, page_size: nil, start_date: nil, request_options: {})
+      # @!method initialize(subscription_id:, end_date: nil, meter_id: nil, page_number: nil, page_size: nil, start_date: nil, request_options: {})
+      #   @param subscription_id [String]
+      #
       #   @param end_date [Time, nil] Filter by end date (inclusive)
       #
       #   @param meter_id [String, nil] Filter by specific meter ID

data/lib/dodopayments/models/subscription_update_params.rb

@@ -7,6 +7,11 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
       # @!attribute billing
       #
       #   @return [Dodopayments::Models::BillingAddress, nil]
@@ -58,7 +63,9 @@ module Dodopayments
       #   @return [String, nil]
       optional :tax_id, String, nil?: true
 
-      # @!method initialize(billing: nil, cancel_at_next_billing_date: nil, credit_entitlement_cart: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
+      # @!method initialize(subscription_id:, billing: nil, cancel_at_next_billing_date: nil, credit_entitlement_cart: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
+      #   @param subscription_id [String]
+      #
       #   @param billing [Dodopayments::Models::BillingAddress, nil]
       #
       #   @param cancel_at_next_billing_date [Boolean, nil] When set, the subscription will remain active until the end of billing period