dodopayments 0.0.1.pre.alpha.0

data/rbi/lib/dodopayments/models/product.rbi

@@ -0,0 +1,228 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class Product < Dodopayments::BaseModel
+      # Unique identifier for the business to which the product belongs.
+      sig { returns(String) }
+      def business_id
+      end
+
+      sig { params(_: String).returns(String) }
+      def business_id=(_)
+      end
+
+      # Timestamp when the product was created.
+      sig { returns(Time) }
+      def created_at
+      end
+
+      sig { params(_: Time).returns(Time) }
+      def created_at=(_)
+      end
+
+      # Indicates if the product is recurring (e.g., subscriptions).
+      sig { returns(T::Boolean) }
+      def is_recurring
+      end
+
+      sig { params(_: T::Boolean).returns(T::Boolean) }
+      def is_recurring=(_)
+      end
+
+      # Indicates whether the product requires a license key.
+      sig { returns(T::Boolean) }
+      def license_key_enabled
+      end
+
+      sig { params(_: T::Boolean).returns(T::Boolean) }
+      def license_key_enabled=(_)
+      end
+
+      sig { returns(T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice)) }
+      def price
+      end
+
+      sig do
+        params(_: T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice))
+          .returns(T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice))
+      end
+      def price=(_)
+      end
+
+      # Unique identifier for the product.
+      sig { returns(String) }
+      def product_id
+      end
+
+      sig { params(_: String).returns(String) }
+      def product_id=(_)
+      end
+
+      # Represents the different categories of taxation applicable to various products
+      #   and services.
+      sig { returns(Symbol) }
+      def tax_category
+      end
+
+      sig { params(_: Symbol).returns(Symbol) }
+      def tax_category=(_)
+      end
+
+      # Timestamp when the product was last updated.
+      sig { returns(Time) }
+      def updated_at
+      end
+
+      sig { params(_: Time).returns(Time) }
+      def updated_at=(_)
+      end
+
+      # Available Addons for subscription products
+      sig { returns(T.nilable(T::Array[String])) }
+      def addons
+      end
+
+      sig { params(_: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
+      def addons=(_)
+      end
+
+      # Description of the product, optional.
+      sig { returns(T.nilable(String)) }
+      def description
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def description=(_)
+      end
+
+      # URL of the product image, optional.
+      sig { returns(T.nilable(String)) }
+      def image
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def image=(_)
+      end
+
+      # Message sent upon license key activation, if applicable.
+      sig { returns(T.nilable(String)) }
+      def license_key_activation_message
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def license_key_activation_message=(_)
+      end
+
+      # Limit on the number of activations for the license key, if enabled.
+      sig { returns(T.nilable(Integer)) }
+      def license_key_activations_limit
+      end
+
+      sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
+      def license_key_activations_limit=(_)
+      end
+
+      sig { returns(T.nilable(Dodopayments::Models::LicenseKeyDuration)) }
+      def license_key_duration
+      end
+
+      sig do
+        params(_: T.nilable(Dodopayments::Models::LicenseKeyDuration))
+          .returns(T.nilable(Dodopayments::Models::LicenseKeyDuration))
+      end
+      def license_key_duration=(_)
+      end
+
+      # Name of the product, optional.
+      sig { returns(T.nilable(String)) }
+      def name
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def name=(_)
+      end
+
+      sig do
+        params(
+          business_id: String,
+          created_at: Time,
+          is_recurring: T::Boolean,
+          license_key_enabled: T::Boolean,
+          price: T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice),
+          product_id: String,
+          tax_category: Symbol,
+          updated_at: Time,
+          addons: T.nilable(T::Array[String]),
+          description: T.nilable(String),
+          image: T.nilable(String),
+          license_key_activation_message: T.nilable(String),
+          license_key_activations_limit: T.nilable(Integer),
+          license_key_duration: T.nilable(Dodopayments::Models::LicenseKeyDuration),
+          name: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        business_id:,
+        created_at:,
+        is_recurring:,
+        license_key_enabled:,
+        price:,
+        product_id:,
+        tax_category:,
+        updated_at:,
+        addons: nil,
+        description: nil,
+        image: nil,
+        license_key_activation_message: nil,
+        license_key_activations_limit: nil,
+        license_key_duration: nil,
+        name: nil
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              business_id: String,
+              created_at: Time,
+              is_recurring: T::Boolean,
+              license_key_enabled: T::Boolean,
+              price: T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice),
+              product_id: String,
+              tax_category: Symbol,
+              updated_at: Time,
+              addons: T.nilable(T::Array[String]),
+              description: T.nilable(String),
+              image: T.nilable(String),
+              license_key_activation_message: T.nilable(String),
+              license_key_activations_limit: T.nilable(Integer),
+              license_key_duration: T.nilable(Dodopayments::Models::LicenseKeyDuration),
+              name: T.nilable(String)
+            }
+          )
+      end
+      def to_hash
+      end
+
+      # Represents the different categories of taxation applicable to various products
+      #   and services.
+      class TaxCategory < Dodopayments::Enum
+        abstract!
+
+        DIGITAL_PRODUCTS = :digital_products
+        SAAS = :saas
+        E_BOOK = :e_book
+        EDTECH = :edtech
+
+        class << self
+          sig { override.returns(T::Array[Symbol]) }
+          def values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lib/dodopayments/models/product_create_params.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductCreateParams < Dodopayments::BaseModel
+      extend Dodopayments::RequestParameters::Converter
+      include Dodopayments::RequestParameters
+
+      sig { returns(T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice)) }
+      def price
+      end
+
+      sig do
+        params(_: T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice))
+          .returns(T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice))
+      end
+      def price=(_)
+      end
+
+      # Represents the different categories of taxation applicable to various products
+      #   and services.
+      sig { returns(Symbol) }
+      def tax_category
+      end
+
+      sig { params(_: Symbol).returns(Symbol) }
+      def tax_category=(_)
+      end
+
+      # Addons available for subscription product
+      sig { returns(T.nilable(T::Array[String])) }
+      def addons
+      end
+
+      sig { params(_: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
+      def addons=(_)
+      end
+
+      # Optional description of the product
+      sig { returns(T.nilable(String)) }
+      def description
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def description=(_)
+      end
+
+      # Optional message displayed during license key activation
+      sig { returns(T.nilable(String)) }
+      def license_key_activation_message
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def license_key_activation_message=(_)
+      end
+
+      # The number of times the license key can be activated. Must be 0 or greater
+      sig { returns(T.nilable(Integer)) }
+      def license_key_activations_limit
+      end
+
+      sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
+      def license_key_activations_limit=(_)
+      end
+
+      sig { returns(T.nilable(Dodopayments::Models::LicenseKeyDuration)) }
+      def license_key_duration
+      end
+
+      sig do
+        params(_: T.nilable(Dodopayments::Models::LicenseKeyDuration))
+          .returns(T.nilable(Dodopayments::Models::LicenseKeyDuration))
+      end
+      def license_key_duration=(_)
+      end
+
+      # When true, generates and sends a license key to your customer. Defaults to false
+      sig { returns(T.nilable(T::Boolean)) }
+      def license_key_enabled
+      end
+
+      sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
+      def license_key_enabled=(_)
+      end
+
+      # Optional name of the product
+      sig { returns(T.nilable(String)) }
+      def name
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def name=(_)
+      end
+
+      sig do
+        params(
+          price: T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice),
+          tax_category: Symbol,
+          addons: T.nilable(T::Array[String]),
+          description: T.nilable(String),
+          license_key_activation_message: T.nilable(String),
+          license_key_activations_limit: T.nilable(Integer),
+          license_key_duration: T.nilable(Dodopayments::Models::LicenseKeyDuration),
+          license_key_enabled: T.nilable(T::Boolean),
+          name: T.nilable(String),
+          request_options: T.any(Dodopayments::RequestOptions, T::Hash[Symbol, T.anything])
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        price:,
+        tax_category:,
+        addons: nil,
+        description: nil,
+        license_key_activation_message: nil,
+        license_key_activations_limit: nil,
+        license_key_duration: nil,
+        license_key_enabled: nil,
+        name: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              price: T.any(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice),
+              tax_category: Symbol,
+              addons: T.nilable(T::Array[String]),
+              description: T.nilable(String),
+              license_key_activation_message: T.nilable(String),
+              license_key_activations_limit: T.nilable(Integer),
+              license_key_duration: T.nilable(Dodopayments::Models::LicenseKeyDuration),
+              license_key_enabled: T.nilable(T::Boolean),
+              name: T.nilable(String),
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+
+      # Represents the different categories of taxation applicable to various products
+      #   and services.
+      class TaxCategory < Dodopayments::Enum
+        abstract!
+
+        DIGITAL_PRODUCTS = :digital_products
+        SAAS = :saas
+        E_BOOK = :e_book
+        EDTECH = :edtech
+
+        class << self
+          sig { override.returns(T::Array[Symbol]) }
+          def values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lib/dodopayments/models/product_delete_params.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductDeleteParams < Dodopayments::BaseModel
+      extend Dodopayments::RequestParameters::Converter
+      include Dodopayments::RequestParameters
+
+      sig do
+        params(request_options: T.any(Dodopayments::RequestOptions, T::Hash[Symbol, T.anything]))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({request_options: Dodopayments::RequestOptions}) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/dodopayments/models/product_list_params.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductListParams < Dodopayments::BaseModel
+      extend Dodopayments::RequestParameters::Converter
+      include Dodopayments::RequestParameters
+
+      # List archived products
+      sig { returns(T.nilable(T::Boolean)) }
+      def archived
+      end
+
+      sig { params(_: T::Boolean).returns(T::Boolean) }
+      def archived=(_)
+      end
+
+      # Page number default is 0
+      sig { returns(T.nilable(Integer)) }
+      def page_number
+      end
+
+      sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
+      def page_number=(_)
+      end
+
+      # Page size default is 10 max is 100
+      sig { returns(T.nilable(Integer)) }
+      def page_size
+      end
+
+      sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
+      def page_size=(_)
+      end
+
+      # Filter products by pricing type:
+      #
+      #   - `true`: Show only recurring pricing products (e.g. subscriptions)
+      #   - `false`: Show only one-time price products
+      #   - `null` or absent: Show both types of products
+      sig { returns(T.nilable(T::Boolean)) }
+      def recurring
+      end
+
+      sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
+      def recurring=(_)
+      end
+
+      sig do
+        params(
+          archived: T::Boolean,
+          page_number: T.nilable(Integer),
+          page_size: T.nilable(Integer),
+          recurring: T.nilable(T::Boolean),
+          request_options: T.any(Dodopayments::RequestOptions, T::Hash[Symbol, T.anything])
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(archived: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {})
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              archived: T::Boolean,
+              page_number: T.nilable(Integer),
+              page_size: T.nilable(Integer),
+              recurring: T.nilable(T::Boolean),
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+    end
+  end
+end