dodopayments 1.19.0 → 1.20.0

data/rbi/dodopayments/models/subscription_list_response.rbi

@@ -0,0 +1,190 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class SubscriptionListResponse < Dodopayments::Internal::Type::BaseModel
+      sig { returns(Dodopayments::Models::BillingAddress) }
+      attr_reader :billing
+
+      sig { params(billing: T.any(Dodopayments::Models::BillingAddress, Dodopayments::Internal::AnyHash)).void }
+      attr_writer :billing
+
+      # Timestamp when the subscription was created
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(Dodopayments::Models::Currency::TaggedSymbol) }
+      attr_accessor :currency
+
+      sig { returns(Dodopayments::Models::CustomerLimitedDetails) }
+      attr_reader :customer
+
+      sig do
+        params(customer: T.any(Dodopayments::Models::CustomerLimitedDetails, Dodopayments::Internal::AnyHash)).void
+      end
+      attr_writer :customer
+
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :metadata
+
+      # Timestamp of the next scheduled billing. Indicates the end of current billing
+      # period
+      sig { returns(Time) }
+      attr_accessor :next_billing_date
+
+      # Wether the subscription is on-demand or not
+      sig { returns(T::Boolean) }
+      attr_accessor :on_demand
+
+      # Number of payment frequency intervals
+      sig { returns(Integer) }
+      attr_accessor :payment_frequency_count
+
+      sig { returns(Dodopayments::Models::TimeInterval::TaggedSymbol) }
+      attr_accessor :payment_frequency_interval
+
+      # Timestamp of the last payment. Indicates the start of current billing period
+      sig { returns(Time) }
+      attr_accessor :previous_billing_date
+
+      # Identifier of the product associated with this subscription
+      sig { returns(String) }
+      attr_accessor :product_id
+
+      # Number of units/items included in the subscription
+      sig { returns(Integer) }
+      attr_accessor :quantity
+
+      # Amount charged before tax for each recurring payment in smallest currency unit
+      # (e.g. cents)
+      sig { returns(Integer) }
+      attr_accessor :recurring_pre_tax_amount
+
+      sig { returns(Dodopayments::Models::SubscriptionStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # Unique identifier for the subscription
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
+      # Number of subscription period intervals
+      sig { returns(Integer) }
+      attr_accessor :subscription_period_count
+
+      sig { returns(Dodopayments::Models::TimeInterval::TaggedSymbol) }
+      attr_accessor :subscription_period_interval
+
+      # Indicates if the recurring_pre_tax_amount is tax inclusive
+      sig { returns(T::Boolean) }
+      attr_accessor :tax_inclusive
+
+      # Number of days in the trial period (0 if no trial)
+      sig { returns(Integer) }
+      attr_accessor :trial_period_days
+
+      # Cancelled timestamp if the subscription is cancelled
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :cancelled_at
+
+      # The discount id if discount is applied
+      sig { returns(T.nilable(String)) }
+      attr_accessor :discount_id
+
+      # Response struct representing subscription details
+      sig do
+        params(
+          billing: T.any(Dodopayments::Models::BillingAddress, Dodopayments::Internal::AnyHash),
+          created_at: Time,
+          currency: Dodopayments::Models::Currency::OrSymbol,
+          customer: T.any(Dodopayments::Models::CustomerLimitedDetails, Dodopayments::Internal::AnyHash),
+          metadata: T::Hash[Symbol, String],
+          next_billing_date: Time,
+          on_demand: T::Boolean,
+          payment_frequency_count: Integer,
+          payment_frequency_interval: Dodopayments::Models::TimeInterval::OrSymbol,
+          previous_billing_date: Time,
+          product_id: String,
+          quantity: Integer,
+          recurring_pre_tax_amount: Integer,
+          status: Dodopayments::Models::SubscriptionStatus::OrSymbol,
+          subscription_id: String,
+          subscription_period_count: Integer,
+          subscription_period_interval: Dodopayments::Models::TimeInterval::OrSymbol,
+          tax_inclusive: T::Boolean,
+          trial_period_days: Integer,
+          cancelled_at: T.nilable(Time),
+          discount_id: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        billing:,
+        # Timestamp when the subscription was created
+        created_at:,
+        currency:,
+        customer:,
+        metadata:,
+        # Timestamp of the next scheduled billing. Indicates the end of current billing
+        # period
+        next_billing_date:,
+        # Wether the subscription is on-demand or not
+        on_demand:,
+        # Number of payment frequency intervals
+        payment_frequency_count:,
+        payment_frequency_interval:,
+        # Timestamp of the last payment. Indicates the start of current billing period
+        previous_billing_date:,
+        # Identifier of the product associated with this subscription
+        product_id:,
+        # Number of units/items included in the subscription
+        quantity:,
+        # Amount charged before tax for each recurring payment in smallest currency unit
+        # (e.g. cents)
+        recurring_pre_tax_amount:,
+        status:,
+        # Unique identifier for the subscription
+        subscription_id:,
+        # Number of subscription period intervals
+        subscription_period_count:,
+        subscription_period_interval:,
+        # Indicates if the recurring_pre_tax_amount is tax inclusive
+        tax_inclusive:,
+        # Number of days in the trial period (0 if no trial)
+        trial_period_days:,
+        # Cancelled timestamp if the subscription is cancelled
+        cancelled_at: nil,
+        # The discount id if discount is applied
+        discount_id: nil
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              billing: Dodopayments::Models::BillingAddress,
+              created_at: Time,
+              currency: Dodopayments::Models::Currency::TaggedSymbol,
+              customer: Dodopayments::Models::CustomerLimitedDetails,
+              metadata: T::Hash[Symbol, String],
+              next_billing_date: Time,
+              on_demand: T::Boolean,
+              payment_frequency_count: Integer,
+              payment_frequency_interval: Dodopayments::Models::TimeInterval::TaggedSymbol,
+              previous_billing_date: Time,
+              product_id: String,
+              quantity: Integer,
+              recurring_pre_tax_amount: Integer,
+              status: Dodopayments::Models::SubscriptionStatus::TaggedSymbol,
+              subscription_id: String,
+              subscription_period_count: Integer,
+              subscription_period_interval: Dodopayments::Models::TimeInterval::TaggedSymbol,
+              tax_inclusive: T::Boolean,
+              trial_period_days: Integer,
+              cancelled_at: T.nilable(Time),
+              discount_id: T.nilable(String)
+            }
+          )
+      end
+      def to_hash; end
+    end
+  end
+end

data/rbi/dodopayments/models/subscription_update_params.rbi

@@ -15,6 +15,19 @@ module Dodopayments
       end
       attr_writer :billing
 
+      sig { returns(T.nilable(Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand)) }
+      attr_reader :disable_on_demand
+
+      sig do
+        params(
+          disable_on_demand: T.nilable(
+            T.any(Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand, Dodopayments::Internal::AnyHash)
+          )
+        )
+          .void
+      end
+      attr_writer :disable_on_demand
+
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
       attr_accessor :metadata
 
@@ -27,6 +40,9 @@ module Dodopayments
       sig do
         params(
           billing: T.nilable(T.any(Dodopayments::Models::BillingAddress, Dodopayments::Internal::AnyHash)),
+          disable_on_demand: T.nilable(
+            T.any(Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand, Dodopayments::Internal::AnyHash)
+          ),
           metadata: T.nilable(T::Hash[Symbol, String]),
           status: T.nilable(Dodopayments::Models::SubscriptionStatus::OrSymbol),
           tax_id: T.nilable(String),
@@ -34,13 +50,22 @@ module Dodopayments
         )
           .returns(T.attached_class)
       end
-      def self.new(billing: nil, metadata: nil, status: nil, tax_id: nil, request_options: {}); end
+      def self.new(
+        billing: nil,
+        disable_on_demand: nil,
+        metadata: nil,
+        status: nil,
+        tax_id: nil,
+        request_options: {}
+      )
+      end
 
       sig do
         override
           .returns(
             {
               billing: T.nilable(Dodopayments::Models::BillingAddress),
+              disable_on_demand: T.nilable(Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand),
               metadata: T.nilable(T::Hash[Symbol, String]),
               status: T.nilable(Dodopayments::Models::SubscriptionStatus::OrSymbol),
               tax_id: T.nilable(String),
@@ -49,6 +74,17 @@ module Dodopayments
           )
       end
       def to_hash; end
+
+      class DisableOnDemand < Dodopayments::Internal::Type::BaseModel
+        sig { returns(Time) }
+        attr_accessor :next_billing_date
+
+        sig { params(next_billing_date: Time).returns(T.attached_class) }
+        def self.new(next_billing_date:); end
+
+        sig { override.returns({next_billing_date: Time}) }
+        def to_hash; end
+      end
     end
   end
 end

data/rbi/dodopayments/models/tax_category.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    # Represents the different categories of taxation applicable to various products
+    # and services.
+    module TaxCategory
+      extend Dodopayments::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Dodopayments::Models::TaxCategory) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      DIGITAL_PRODUCTS = T.let(:digital_products, Dodopayments::Models::TaxCategory::TaggedSymbol)
+      SAAS = T.let(:saas, Dodopayments::Models::TaxCategory::TaggedSymbol)
+      E_BOOK = T.let(:e_book, Dodopayments::Models::TaxCategory::TaggedSymbol)
+      EDTECH = T.let(:edtech, Dodopayments::Models::TaxCategory::TaggedSymbol)
+
+      sig { override.returns(T::Array[Dodopayments::Models::TaxCategory::TaggedSymbol]) }
+      def self.values; end
+    end
+  end
+end

data/rbi/dodopayments/resources/addons.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Addons
+      sig do
+        params(
+          currency: Dodopayments::Models::Currency::OrSymbol,
+          name: String,
+          price: Integer,
+          tax_category: Dodopayments::Models::TaxCategory::OrSymbol,
+          description: T.nilable(String),
+          request_options: Dodopayments::RequestOpts
+        )
+          .returns(Dodopayments::Models::AddonResponse)
+      end
+      def create(
+        currency:,
+        # Name of the Addon
+        name:,
+        # Amount of the addon
+        price:,
+        # Represents the different categories of taxation applicable to various products
+        # and services.
+        tax_category:,
+        # Optional description of the Addon
+        description: nil,
+        request_options: {}
+      ); end
+      sig do
+        params(id: String, request_options: Dodopayments::RequestOpts).returns(Dodopayments::Models::AddonResponse)
+      end
+      def retrieve(
+        # Addon Id
+        id,
+        request_options: {}
+      ); end
+      sig do
+        params(
+          id: String,
+          currency: T.nilable(Dodopayments::Models::Currency::OrSymbol),
+          description: T.nilable(String),
+          image_id: T.nilable(String),
+          name: T.nilable(String),
+          price: T.nilable(Integer),
+          tax_category: T.nilable(Dodopayments::Models::TaxCategory::OrSymbol),
+          request_options: Dodopayments::RequestOpts
+        )
+          .returns(Dodopayments::Models::AddonResponse)
+      end
+      def update(
+        # Addon Id
+        id,
+        currency: nil,
+        # Description of the Addon, optional and must be at most 1000 characters.
+        description: nil,
+        # Addon image id after its uploaded to S3
+        image_id: nil,
+        # Name of the Addon, optional and must be at most 100 characters.
+        name: nil,
+        # Amount of the addon
+        price: nil,
+        # Represents the different categories of taxation applicable to various products
+        # and services.
+        tax_category: nil,
+        request_options: {}
+      ); end
+      sig do
+        params(
+          page_number: T.nilable(Integer),
+          page_size: T.nilable(Integer),
+          request_options: Dodopayments::RequestOpts
+        )
+          .returns(Dodopayments::Internal::DefaultPageNumberPagination[Dodopayments::Models::AddonResponse])
+      end
+      def list(
+        # Page number default is 0
+        page_number: nil,
+        # Page size default is 10 max is 100
+        page_size: nil,
+        request_options: {}
+      ); end
+      sig do
+        params(id: String, request_options: Dodopayments::RequestOpts)
+          .returns(Dodopayments::Models::AddonUpdateImagesResponse)
+      end
+      def update_images(
+        # Addon Id
+        id,
+        request_options: {}
+      ); end
+      # @api private
+      sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+      def self.new(client:); end
+    end
+  end
+end

data/rbi/dodopayments/resources/payments.rbi

@@ -13,7 +13,7 @@ module Dodopayments
           ),
           product_cart: T::Array[T.any(Dodopayments::Models::OneTimeProductCartItem, Dodopayments::Internal::AnyHash)],
           allowed_payment_method_types: T.nilable(T::Array[Dodopayments::Models::PaymentCreateParams::AllowedPaymentMethodType::OrSymbol]),
-          billing_currency: T.nilable(Dodopayments::Models::PaymentCreateParams::BillingCurrency::OrSymbol),
+          billing_currency: T.nilable(Dodopayments::Models::Currency::OrSymbol),
           discount_code: T.nilable(String),
           metadata: T::Hash[Symbol, String],
           payment_link: T.nilable(T::Boolean),

data/rbi/dodopayments/resources/products.rbi

@@ -13,7 +13,7 @@ module Dodopayments
             Dodopayments::Internal::AnyHash,
             Dodopayments::Models::Price::RecurringPrice
           ),
-          tax_category: Dodopayments::Models::ProductCreateParams::TaxCategory::OrSymbol,
+          tax_category: Dodopayments::Models::TaxCategory::OrSymbol,
           addons: T.nilable(T::Array[String]),
           description: T.nilable(String),
           license_key_activation_message: T.nilable(String),
@@ -69,7 +69,7 @@ module Dodopayments
               Dodopayments::Models::Price::RecurringPrice
             )
           ),
-          tax_category: T.nilable(Dodopayments::Models::ProductUpdateParams::TaxCategory::OrSymbol),
+          tax_category: T.nilable(Dodopayments::Models::TaxCategory::OrSymbol),
           request_options: Dodopayments::RequestOpts
         )
           .void

data/rbi/dodopayments/resources/subscriptions.rbi

@@ -13,8 +13,11 @@ module Dodopayments
           ),
           product_id: String,
           quantity: Integer,
+          addons: T.nilable(
+            T::Array[T.any(Dodopayments::Models::SubscriptionCreateParams::Addon, Dodopayments::Internal::AnyHash)]
+          ),
           allowed_payment_method_types: T.nilable(T::Array[Dodopayments::Models::SubscriptionCreateParams::AllowedPaymentMethodType::OrSymbol]),
-          billing_currency: T.nilable(Dodopayments::Models::SubscriptionCreateParams::BillingCurrency::OrSymbol),
+          billing_currency: T.nilable(Dodopayments::Models::Currency::OrSymbol),
           discount_code: T.nilable(String),
           metadata: T::Hash[Symbol, String],
           on_demand: T.nilable(
@@ -36,6 +39,8 @@ module Dodopayments
         product_id:,
         # Number of units to subscribe for. Must be at least 1.
         quantity:,
+        # Attach addons to this subscription
+        addons: nil,
         # List of payment methods allowed during checkout.
         #
         # Customers will **never** see payment methods that are **not** in this list.
@@ -75,6 +80,9 @@ module Dodopayments
         params(
           subscription_id: String,
           billing: T.nilable(T.any(Dodopayments::Models::BillingAddress, Dodopayments::Internal::AnyHash)),
+          disable_on_demand: T.nilable(
+            T.any(Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand, Dodopayments::Internal::AnyHash)
+          ),
           metadata: T.nilable(T::Hash[Symbol, String]),
           status: T.nilable(Dodopayments::Models::SubscriptionStatus::OrSymbol),
           tax_id: T.nilable(String),
@@ -86,6 +94,7 @@ module Dodopayments
         # Subscription Id
         subscription_id,
         billing: nil,
+        disable_on_demand: nil,
         metadata: nil,
         status: nil,
         tax_id: nil,
@@ -101,7 +110,9 @@ module Dodopayments
           status: T.nilable(Dodopayments::Models::SubscriptionStatus::OrSymbol),
           request_options: Dodopayments::RequestOpts
         )
-          .returns(Dodopayments::Internal::DefaultPageNumberPagination[Dodopayments::Models::Subscription])
+          .returns(
+            Dodopayments::Internal::DefaultPageNumberPagination[Dodopayments::Models::SubscriptionListResponse]
+          )
       end
       def list(
         # Get events after this created time

data/sig/dodopayments/client.rbs

@@ -13,7 +13,7 @@ module Dodopayments
       test_mode: "https://test.dodopayments.com"
     }
 
-    attr_reader bearer_token: String
+    attr_reader api_key: String
 
     attr_reader payments: Dodopayments::Resources::Payments
 
@@ -43,10 +43,12 @@ module Dodopayments
 
     attr_reader discounts: Dodopayments::Resources::Discounts
 
+    attr_reader addons: Dodopayments::Resources::Addons
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (
-      ?bearer_token: String?,
+      ?api_key: String?,
       ?environment: :live_mode | :test_mode | nil,
       ?base_url: String?,
       ?max_retries: Integer,

data/sig/dodopayments/models/addon_cart_response_item.rbs

@@ -0,0 +1,15 @@
+module Dodopayments
+  module Models
+    type addon_cart_response_item = { addon_id: String, quantity: Integer }
+
+    class AddonCartResponseItem < Dodopayments::Internal::Type::BaseModel
+      attr_accessor addon_id: String
+
+      attr_accessor quantity: Integer
+
+      def initialize: (addon_id: String, quantity: Integer) -> void
+
+      def to_hash: -> Dodopayments::Models::addon_cart_response_item
+    end
+  end
+end

data/sig/dodopayments/models/addon_create_params.rbs

@@ -0,0 +1,39 @@
+module Dodopayments
+  module Models
+    type addon_create_params =
+      {
+        currency: Dodopayments::Models::currency,
+        name: String,
+        price: Integer,
+        tax_category: Dodopayments::Models::tax_category,
+        description: String?
+      }
+      & Dodopayments::Internal::Type::request_parameters
+
+    class AddonCreateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      attr_accessor currency: Dodopayments::Models::currency
+
+      attr_accessor name: String
+
+      attr_accessor price: Integer
+
+      attr_accessor tax_category: Dodopayments::Models::tax_category
+
+      attr_accessor description: String?
+
+      def initialize: (
+        currency: Dodopayments::Models::currency,
+        name: String,
+        price: Integer,
+        tax_category: Dodopayments::Models::tax_category,
+        ?description: String?,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> Dodopayments::Models::addon_create_params
+    end
+  end
+end

data/sig/dodopayments/models/addon_list_params.rbs

@@ -0,0 +1,24 @@
+module Dodopayments
+  module Models
+    type addon_list_params =
+      { page_number: Integer?, page_size: Integer? }
+      & Dodopayments::Internal::Type::request_parameters
+
+    class AddonListParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      attr_accessor page_number: Integer?
+
+      attr_accessor page_size: Integer?
+
+      def initialize: (
+        ?page_number: Integer?,
+        ?page_size: Integer?,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> Dodopayments::Models::addon_list_params
+    end
+  end
+end

data/sig/dodopayments/models/addon_response.rbs

@@ -0,0 +1,54 @@
+module Dodopayments
+  module Models
+    type addon_response =
+      {
+        id: String,
+        business_id: String,
+        created_at: Time,
+        currency: Dodopayments::Models::currency,
+        name: String,
+        price: Integer,
+        tax_category: Dodopayments::Models::tax_category,
+        updated_at: Time,
+        description: String?,
+        image: String?
+      }
+
+    class AddonResponse < Dodopayments::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor business_id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor currency: Dodopayments::Models::currency
+
+      attr_accessor name: String
+
+      attr_accessor price: Integer
+
+      attr_accessor tax_category: Dodopayments::Models::tax_category
+
+      attr_accessor updated_at: Time
+
+      attr_accessor description: String?
+
+      attr_accessor image: String?
+
+      def initialize: (
+        id: String,
+        business_id: String,
+        created_at: Time,
+        currency: Dodopayments::Models::currency,
+        name: String,
+        price: Integer,
+        tax_category: Dodopayments::Models::tax_category,
+        updated_at: Time,
+        ?description: String?,
+        ?image: String?
+      ) -> void
+
+      def to_hash: -> Dodopayments::Models::addon_response
+    end
+  end
+end

data/sig/dodopayments/models/addon_retrieve_params.rbs

@@ -0,0 +1,15 @@
+module Dodopayments
+  module Models
+    type addon_retrieve_params =
+      {  } & Dodopayments::Internal::Type::request_parameters
+
+    class AddonRetrieveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Dodopayments::request_opts) -> void
+
+      def to_hash: -> Dodopayments::Models::addon_retrieve_params
+    end
+  end
+end

data/sig/dodopayments/models/addon_update_images_params.rbs

@@ -0,0 +1,15 @@
+module Dodopayments
+  module Models
+    type addon_update_images_params =
+      {  } & Dodopayments::Internal::Type::request_parameters
+
+    class AddonUpdateImagesParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Dodopayments::request_opts) -> void
+
+      def to_hash: -> Dodopayments::Models::addon_update_images_params
+    end
+  end
+end

data/sig/dodopayments/models/addon_update_images_response.rbs

@@ -0,0 +1,15 @@
+module Dodopayments
+  module Models
+    type addon_update_images_response = { image_id: String, url: String }
+
+    class AddonUpdateImagesResponse < Dodopayments::Internal::Type::BaseModel
+      attr_accessor image_id: String
+
+      attr_accessor url: String
+
+      def initialize: (image_id: String, url: String) -> void
+
+      def to_hash: -> Dodopayments::Models::addon_update_images_response
+    end
+  end
+end