dodopayments 0.0.1.pre.alpha.0 → 1.14.0

data/lib/dodopayments/models/price.rb

@@ -2,15 +2,16 @@
 
 module Dodopayments
   module Models
-    # @abstract
-    class Price < Dodopayments::Union
+    module Price
+      extend Dodopayments::Internal::Type::Union
+
       discriminator :type
 
       variant :one_time_price, -> { Dodopayments::Models::Price::OneTimePrice }
 
       variant :recurring_price, -> { Dodopayments::Models::Price::RecurringPrice }
 
-      class OneTimePrice < Dodopayments::BaseModel
+      class OneTimePrice < Dodopayments::Internal::Type::BaseModel
         # @!attribute currency
         #
         #   @return [Symbol, Dodopayments::Models::Price::OneTimePrice::Currency]
@@ -24,20 +25,20 @@ module Dodopayments
 
         # @!attribute price
         #   The payment amount, in the smallest denomination of the currency (e.g., cents
-        #     for USD). For example, to charge $1.00, pass `100`.
+        #   for USD). For example, to charge $1.00, pass `100`.
         #
-        #     If [`pay_what_you_want`](Self::pay_what_you_want) is set to `true`, this field
-        #     represents the **minimum** amount the customer must pay.
+        #   If [`pay_what_you_want`](Self::pay_what_you_want) is set to `true`, this field
+        #   represents the **minimum** amount the customer must pay.
         #
         #   @return [Integer]
         required :price, Integer
 
         # @!attribute purchasing_power_parity
         #   Indicates if purchasing power parity adjustments are applied to the price.
-        #     Purchasing power parity feature is not available as of now.
+        #   Purchasing power parity feature is not available as of now.
         #
         #   @return [Boolean]
-        required :purchasing_power_parity, Dodopayments::BooleanModel
+        required :purchasing_power_parity, Dodopayments::Internal::Type::Boolean
 
         # @!attribute type
         #
@@ -46,10 +47,10 @@ module Dodopayments
 
         # @!attribute [r] pay_what_you_want
         #   Indicates whether the customer can pay any amount they choose. If set to `true`,
-        #     the [`price`](Self::price) field is the minimum amount.
+        #   the [`price`](Self::price) field is the minimum amount.
         #
         #   @return [Boolean, nil]
-        optional :pay_what_you_want, Dodopayments::BooleanModel
+        optional :pay_what_you_want, Dodopayments::Internal::Type::Boolean
 
         # @!parse
         #   # @return [Boolean]
@@ -57,8 +58,8 @@ module Dodopayments
 
         # @!attribute suggested_price
         #   A suggested price for the user to pay. This value is only considered if
-        #     [`pay_what_you_want`](Self::pay_what_you_want) is `true`. Otherwise, it is
-        #     ignored.
+        #   [`pay_what_you_want`](Self::pay_what_you_want) is `true`. Otherwise, it is
+        #   ignored.
         #
         #   @return [Integer, nil]
         optional :suggested_price, Integer, nil?: true
@@ -67,7 +68,7 @@ module Dodopayments
         #   Indicates if the price is tax inclusive.
         #
         #   @return [Boolean, nil]
-        optional :tax_inclusive, Dodopayments::BooleanModel, nil?: true
+        optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
 
         # @!parse
         #   # @param currency [Symbol, Dodopayments::Models::Price::OneTimePrice::Currency]
@@ -93,10 +94,12 @@ module Dodopayments
         #     super
         #   end
 
-        # def initialize: (Hash | Dodopayments::BaseModel) -> void
+        # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+
+        # @see Dodopayments::Models::Price::OneTimePrice#currency
+        module Currency
+          extend Dodopayments::Internal::Type::Enum
 
-        # @abstract
-        class Currency < Dodopayments::Enum
           AED = :AED
           ALL = :ALL
           AMD = :AMD
@@ -244,10 +247,14 @@ module Dodopayments
           ZMW = :ZMW
 
           finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
         end
       end
 
-      class RecurringPrice < Dodopayments::BaseModel
+      class RecurringPrice < Dodopayments::Internal::Type::BaseModel
         # @!attribute currency
         #
         #   @return [Symbol, Dodopayments::Models::Price::RecurringPrice::Currency]
@@ -261,7 +268,7 @@ module Dodopayments
 
         # @!attribute payment_frequency_count
         #   Number of units for the payment frequency. For example, a value of `1` with a
-        #     `payment_frequency_interval` of `month` represents monthly payments.
+        #   `payment_frequency_interval` of `month` represents monthly payments.
         #
         #   @return [Integer]
         required :payment_frequency_count, Integer
@@ -273,21 +280,21 @@ module Dodopayments
 
         # @!attribute price
         #   The payment amount. Represented in the lowest denomination of the currency
-        #     (e.g., cents for USD). For example, to charge $1.00, pass `100`.
+        #   (e.g., cents for USD). For example, to charge $1.00, pass `100`.
         #
         #   @return [Integer]
         required :price, Integer
 
         # @!attribute purchasing_power_parity
         #   Indicates if purchasing power parity adjustments are applied to the price.
-        #     Purchasing power parity feature is not available as of now
+        #   Purchasing power parity feature is not available as of now
         #
         #   @return [Boolean]
-        required :purchasing_power_parity, Dodopayments::BooleanModel
+        required :purchasing_power_parity, Dodopayments::Internal::Type::Boolean
 
         # @!attribute subscription_period_count
         #   Number of units for the subscription period. For example, a value of `12` with a
-        #     `subscription_period_interval` of `month` represents a one-year subscription.
+        #   `subscription_period_interval` of `month` represents a one-year subscription.
         #
         #   @return [Integer]
         required :subscription_period_count, Integer
@@ -306,7 +313,7 @@ module Dodopayments
         #   Indicates if the price is tax inclusive
         #
         #   @return [Boolean, nil]
-        optional :tax_inclusive, Dodopayments::BooleanModel, nil?: true
+        optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
 
         # @!attribute [r] trial_period_days
         #   Number of days for the trial period. A value of `0` indicates no trial period.
@@ -348,10 +355,12 @@ module Dodopayments
         #     super
         #   end
 
-        # def initialize: (Hash | Dodopayments::BaseModel) -> void
+        # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+
+        # @see Dodopayments::Models::Price::RecurringPrice#currency
+        module Currency
+          extend Dodopayments::Internal::Type::Enum
 
-        # @abstract
-        class Currency < Dodopayments::Enum
           AED = :AED
           ALL = :ALL
           AMD = :AMD
@@ -499,14 +508,16 @@ module Dodopayments
           ZMW = :ZMW
 
           finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
         end
       end
 
       # @!parse
-      #   class << self
-      #     # @return [Array(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice)]
-      #     def variants; end
-      #   end
+      #   # @return [Array(Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice)]
+      #   def self.variants; end
     end
   end
 end

data/lib/dodopayments/models/product.rb

@@ -2,7 +2,8 @@
 
 module Dodopayments
   module Models
-    class Product < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::Products#create
+    class Product < Dodopayments::Internal::Type::BaseModel
       # @!attribute business_id
       #   Unique identifier for the business to which the product belongs.
       #
@@ -19,13 +20,13 @@ module Dodopayments
       #   Indicates if the product is recurring (e.g., subscriptions).
       #
       #   @return [Boolean]
-      required :is_recurring, Dodopayments::BooleanModel
+      required :is_recurring, Dodopayments::Internal::Type::Boolean
 
       # @!attribute license_key_enabled
       #   Indicates whether the product requires a license key.
       #
       #   @return [Boolean]
-      required :license_key_enabled, Dodopayments::BooleanModel
+      required :license_key_enabled, Dodopayments::Internal::Type::Boolean
 
       # @!attribute price
       #
@@ -40,7 +41,7 @@ module Dodopayments
 
       # @!attribute tax_category
       #   Represents the different categories of taxation applicable to various products
-      #     and services.
+      #   and services.
       #
       #   @return [Symbol, Dodopayments::Models::Product::TaxCategory]
       required :tax_category, enum: -> { Dodopayments::Models::Product::TaxCategory }
@@ -55,7 +56,7 @@ module Dodopayments
       #   Available Addons for subscription products
       #
       #   @return [Array<String>, nil]
-      optional :addons, Dodopayments::ArrayOf[String], nil?: true
+      optional :addons, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
 
       # @!attribute description
       #   Description of the product, optional.
@@ -130,19 +131,25 @@ module Dodopayments
       #     super
       #   end
 
-      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # Represents the different categories of taxation applicable to various products
-      #   and services.
-      class TaxCategory < Dodopayments::Enum
+      # and services.
+      #
+      # @see Dodopayments::Models::Product#tax_category
+      module TaxCategory
+        extend Dodopayments::Internal::Type::Enum
+
         DIGITAL_PRODUCTS = :digital_products
         SAAS = :saas
         E_BOOK = :e_book
         EDTECH = :edtech
 
         finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
       end
     end
   end

data/lib/dodopayments/models/product_create_params.rb

@@ -2,10 +2,11 @@
 
 module Dodopayments
   module Models
-    class ProductCreateParams < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::Products#create
+    class ProductCreateParams < Dodopayments::Internal::Type::BaseModel
       # @!parse
-      #   extend Dodopayments::RequestParameters::Converter
-      include Dodopayments::RequestParameters
+      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute price
       #
@@ -14,7 +15,7 @@ module Dodopayments
 
       # @!attribute tax_category
       #   Represents the different categories of taxation applicable to various products
-      #     and services.
+      #   and services.
       #
       #   @return [Symbol, Dodopayments::Models::ProductCreateParams::TaxCategory]
       required :tax_category, enum: -> { Dodopayments::Models::ProductCreateParams::TaxCategory }
@@ -23,7 +24,7 @@ module Dodopayments
       #   Addons available for subscription product
       #
       #   @return [Array<String>, nil]
-      optional :addons, Dodopayments::ArrayOf[String], nil?: true
+      optional :addons, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
 
       # @!attribute description
       #   Optional description of the product
@@ -52,7 +53,7 @@ module Dodopayments
       #   When true, generates and sends a license key to your customer. Defaults to false
       #
       #   @return [Boolean, nil]
-      optional :license_key_enabled, Dodopayments::BooleanModel, nil?: true
+      optional :license_key_enabled, Dodopayments::Internal::Type::Boolean, nil?: true
 
       # @!attribute name
       #   Optional name of the product
@@ -88,19 +89,23 @@ module Dodopayments
       #     super
       #   end
 
-      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # Represents the different categories of taxation applicable to various products
-      #   and services.
-      class TaxCategory < Dodopayments::Enum
+      # and services.
+      module TaxCategory
+        extend Dodopayments::Internal::Type::Enum
+
         DIGITAL_PRODUCTS = :digital_products
         SAAS = :saas
         E_BOOK = :e_book
         EDTECH = :edtech
 
         finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
       end
     end
   end

data/lib/dodopayments/models/product_delete_params.rb

@@ -2,17 +2,18 @@
 
 module Dodopayments
   module Models
-    class ProductDeleteParams < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::Products#delete
+    class ProductDeleteParams < Dodopayments::Internal::Type::BaseModel
       # @!parse
-      #   extend Dodopayments::RequestParameters::Converter
-      include Dodopayments::RequestParameters
+      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
 
       # @!parse
       #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
       #   #
       #   def initialize(request_options: {}, **) = super
 
-      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/dodopayments/models/product_list_params.rb

@@ -2,16 +2,17 @@
 
 module Dodopayments
   module Models
-    class ProductListParams < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::Products#list
+    class ProductListParams < Dodopayments::Internal::Type::BaseModel
       # @!parse
-      #   extend Dodopayments::RequestParameters::Converter
-      include Dodopayments::RequestParameters
+      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute [r] archived
       #   List archived products
       #
       #   @return [Boolean, nil]
-      optional :archived, Dodopayments::BooleanModel
+      optional :archived, Dodopayments::Internal::Type::Boolean
 
       # @!parse
       #   # @return [Boolean]
@@ -32,12 +33,12 @@ module Dodopayments
       # @!attribute recurring
       #   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
+      #   - `true`: Show only recurring pricing products (e.g. subscriptions)
+      #   - `false`: Show only one-time price products
+      #   - `null` or absent: Show both types of products
       #
       #   @return [Boolean, nil]
-      optional :recurring, Dodopayments::BooleanModel, nil?: true
+      optional :recurring, Dodopayments::Internal::Type::Boolean, nil?: true
 
       # @!parse
       #   # @param archived [Boolean]
@@ -48,7 +49,7 @@ module Dodopayments
       #   #
       #   def initialize(archived: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/dodopayments/models/product_list_response.rb

@@ -2,7 +2,8 @@
 
 module Dodopayments
   module Models
-    class ProductListResponse < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::Products#list
+    class ProductListResponse < Dodopayments::Internal::Type::BaseModel
       # @!attribute business_id
       #   Unique identifier for the business to which the product belongs.
       #
@@ -19,7 +20,7 @@ module Dodopayments
       #   Indicates if the product is recurring (e.g., subscriptions).
       #
       #   @return [Boolean]
-      required :is_recurring, Dodopayments::BooleanModel
+      required :is_recurring, Dodopayments::Internal::Type::Boolean
 
       # @!attribute product_id
       #   Unique identifier for the product.
@@ -29,7 +30,7 @@ module Dodopayments
 
       # @!attribute tax_category
       #   Represents the different categories of taxation applicable to various products
-      #     and services.
+      #   and services.
       #
       #   @return [Symbol, Dodopayments::Models::ProductListResponse::TaxCategory]
       required :tax_category, enum: -> { Dodopayments::Models::ProductListResponse::TaxCategory }
@@ -66,14 +67,14 @@ module Dodopayments
       # @!attribute price
       #   Price of the product, optional.
       #
-      #     The price is represented in the lowest denomination of the currency. For
-      #     example:
+      #   The price is represented in the lowest denomination of the currency. For
+      #   example:
       #
-      #     - In USD, a price of `$12.34` would be represented as `1234` (cents).
-      #     - In JPY, a price of `¥1500` would be represented as `1500` (yen).
-      #     - In INR, a price of `₹1234.56` would be represented as `123456` (paise).
+      #   - In USD, a price of `$12.34` would be represented as `1234` (cents).
+      #   - In JPY, a price of `¥1500` would be represented as `1500` (yen).
+      #   - In INR, a price of `₹1234.56` would be represented as `123456` (paise).
       #
-      #     This ensures precision and avoids floating-point rounding errors.
+      #   This ensures precision and avoids floating-point rounding errors.
       #
       #   @return [Integer, nil]
       optional :price, Integer, nil?: true
@@ -87,7 +88,7 @@ module Dodopayments
       #   Indicates if the price is tax inclusive
       #
       #   @return [Boolean, nil]
-      optional :tax_inclusive, Dodopayments::BooleanModel, nil?: true
+      optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
 
       # @!parse
       #   # @param business_id [String]
@@ -123,23 +124,31 @@ module Dodopayments
       #     super
       #   end
 
-      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # Represents the different categories of taxation applicable to various products
-      #   and services.
-      class TaxCategory < Dodopayments::Enum
+      # and services.
+      #
+      # @see Dodopayments::Models::ProductListResponse#tax_category
+      module TaxCategory
+        extend Dodopayments::Internal::Type::Enum
+
         DIGITAL_PRODUCTS = :digital_products
         SAAS = :saas
         E_BOOK = :e_book
         EDTECH = :edtech
 
         finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
       end
 
-      # @abstract
-      class Currency < Dodopayments::Enum
+      # @see Dodopayments::Models::ProductListResponse#currency
+      module Currency
+        extend Dodopayments::Internal::Type::Enum
+
         AED = :AED
         ALL = :ALL
         AMD = :AMD
@@ -287,6 +296,10 @@ module Dodopayments
         ZMW = :ZMW
 
         finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
       end
     end
   end

data/lib/dodopayments/models/product_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module Dodopayments
   module Models
-    class ProductRetrieveParams < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::Products#retrieve
+    class ProductRetrieveParams < Dodopayments::Internal::Type::BaseModel
       # @!parse
-      #   extend Dodopayments::RequestParameters::Converter
-      include Dodopayments::RequestParameters
+      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
 
       # @!parse
       #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
       #   #
       #   def initialize(request_options: {}, **) = super
 
-      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/dodopayments/models/product_unarchive_params.rb

@@ -2,17 +2,18 @@
 
 module Dodopayments
   module Models
-    class ProductUnarchiveParams < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::Products#unarchive
+    class ProductUnarchiveParams < Dodopayments::Internal::Type::BaseModel
       # @!parse
-      #   extend Dodopayments::RequestParameters::Converter
-      include Dodopayments::RequestParameters
+      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
 
       # @!parse
       #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
       #   #
       #   def initialize(request_options: {}, **) = super
 
-      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/dodopayments/models/product_update_params.rb

@@ -2,16 +2,17 @@
 
 module Dodopayments
   module Models
-    class ProductUpdateParams < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::Products#update
+    class ProductUpdateParams < Dodopayments::Internal::Type::BaseModel
       # @!parse
-      #   extend Dodopayments::RequestParameters::Converter
-      include Dodopayments::RequestParameters
+      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute addons
       #   Available Addons for subscription products
       #
       #   @return [Array<String>, nil]
-      optional :addons, Dodopayments::ArrayOf[String], nil?: true
+      optional :addons, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
 
       # @!attribute description
       #   Description of the product, optional and must be at most 1000 characters.
@@ -28,8 +29,8 @@ module Dodopayments
       # @!attribute license_key_activation_message
       #   Message sent to the customer upon license key activation.
       #
-      #     Only applicable if `license_key_enabled` is `true`. This message contains
-      #     instructions for activating the license key.
+      #   Only applicable if `license_key_enabled` is `true`. This message contains
+      #   instructions for activating the license key.
       #
       #   @return [String, nil]
       optional :license_key_activation_message, String, nil?: true
@@ -37,8 +38,8 @@ module Dodopayments
       # @!attribute license_key_activations_limit
       #   Limit for the number of activations for the license key.
       #
-      #     Only applicable if `license_key_enabled` is `true`. Represents the maximum
-      #     number of times the license key can be activated.
+      #   Only applicable if `license_key_enabled` is `true`. Represents the maximum
+      #   number of times the license key can be activated.
       #
       #   @return [Integer, nil]
       optional :license_key_activations_limit, Integer, nil?: true
@@ -51,11 +52,11 @@ module Dodopayments
       # @!attribute license_key_enabled
       #   Whether the product requires a license key.
       #
-      #     If `true`, additional fields related to license key (duration, activations
-      #     limit, activation message) become applicable.
+      #   If `true`, additional fields related to license key (duration, activations
+      #   limit, activation message) become applicable.
       #
       #   @return [Boolean, nil]
-      optional :license_key_enabled, Dodopayments::BooleanModel, nil?: true
+      optional :license_key_enabled, Dodopayments::Internal::Type::Boolean, nil?: true
 
       # @!attribute name
       #   Name of the product, optional and must be at most 100 characters.
@@ -70,7 +71,7 @@ module Dodopayments
 
       # @!attribute tax_category
       #   Represents the different categories of taxation applicable to various products
-      #     and services.
+      #   and services.
       #
       #   @return [Symbol, Dodopayments::Models::ProductUpdateParams::TaxCategory, nil]
       optional :tax_category, enum: -> { Dodopayments::Models::ProductUpdateParams::TaxCategory }, nil?: true
@@ -105,19 +106,23 @@ module Dodopayments
       #     super
       #   end
 
-      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # Represents the different categories of taxation applicable to various products
-      #   and services.
-      class TaxCategory < Dodopayments::Enum
+      # and services.
+      module TaxCategory
+        extend Dodopayments::Internal::Type::Enum
+
         DIGITAL_PRODUCTS = :digital_products
         SAAS = :saas
         E_BOOK = :e_book
         EDTECH = :edtech
 
         finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
       end
     end
   end