dodopayments 1.14.0 → 1.17.0

data/lib/dodopayments/internal/type/union.rb

@@ -39,7 +39,7 @@ module Dodopayments
         #
         # @return [Array<Array(Symbol, Object)>]
         protected def derefed_variants
-          @known_variants.map { |key, variant_fn| [key, variant_fn.call] }
+          known_variants.map { |key, variant_fn| [key, variant_fn.call] }
         end
 
         # All of the specified variants for this union.
@@ -108,6 +108,8 @@ module Dodopayments
         # rubocop:disable Style/HashEachMethods
         # rubocop:disable Style/CaseEquality
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -117,6 +119,8 @@ module Dodopayments
           end
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -124,6 +128,11 @@ module Dodopayments
           Dodopayments::Internal::Type::Union === other && other.derefed_variants == derefed_variants
         end
 
+        # @api public
+        #
+        # @return [Integer]
+        def hash = variants.hash
+
         # @api private
         #
         # @param value [Object]

data/lib/dodopayments/internal/type/unknown.rb

@@ -15,11 +15,15 @@ module Dodopayments
 
         private_class_method :new
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def self.===(other) = true
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]

data/lib/dodopayments/internal.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Dodopayments
-  # @api private
   module Internal
     OMIT =
       Object.new.tap do

data/lib/dodopayments/models/attach_existing_customer.rb

@@ -8,12 +8,8 @@ module Dodopayments
       #   @return [String]
       required :customer_id, String
 
-      # @!parse
-      #   # @param customer_id [String]
-      #   #
-      #   def initialize(customer_id:, **) = super
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(customer_id:)
+      #   @param customer_id [String]
     end
   end
 end

data/lib/dodopayments/models/billing_address.rb

@@ -33,16 +33,12 @@ module Dodopayments
       #   @return [String]
       required :zipcode, String
 
-      # @!parse
-      #   # @param city [String]
-      #   # @param country [Symbol, Dodopayments::Models::CountryCode]
-      #   # @param state [String]
-      #   # @param street [String]
-      #   # @param zipcode [String]
-      #   #
-      #   def initialize(city:, country:, state:, street:, zipcode:, **) = super
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(city:, country:, state:, street:, zipcode:)
+      #   @param city [String]
+      #   @param country [Symbol, Dodopayments::Models::CountryCode]
+      #   @param state [String]
+      #   @param street [String]
+      #   @param zipcode [String]
     end
   end
 end

data/lib/dodopayments/models/country_code.rb

@@ -256,11 +256,8 @@ module Dodopayments
       ZM = :ZM
       ZW = :ZW
 
-      finalize!
-
-      # @!parse
-      #   # @return [Array<Symbol>]
-      #   def self.values; end
+      # @!method self.values
+      #   @return [Array<Symbol>]
     end
   end
 end

data/lib/dodopayments/models/create_new_customer.rb

@@ -13,7 +13,7 @@ module Dodopayments
       #   @return [String]
       required :name, String
 
-      # @!attribute [r] create_new_customer
+      # @!attribute create_new_customer
       #   When false, the most recently created customer object with the given email is
       #   used if exists. When true, a new customer object is always created False by
       #   default
@@ -21,24 +21,16 @@ module Dodopayments
       #   @return [Boolean, nil]
       optional :create_new_customer, Dodopayments::Internal::Type::Boolean
 
-      # @!parse
-      #   # @return [Boolean]
-      #   attr_writer :create_new_customer
-
       # @!attribute phone_number
       #
       #   @return [String, nil]
       optional :phone_number, String, nil?: true
 
-      # @!parse
-      #   # @param email [String]
-      #   # @param name [String]
-      #   # @param create_new_customer [Boolean]
-      #   # @param phone_number [String, nil]
-      #   #
-      #   def initialize(email:, name:, create_new_customer: nil, phone_number: nil, **) = super
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(email:, name:, create_new_customer: nil, phone_number: nil)
+      #   @param email [String]
+      #   @param name [String]
+      #   @param create_new_customer [Boolean]
+      #   @param phone_number [String, nil]
     end
   end
 end

data/lib/dodopayments/models/customer.rb

@@ -34,17 +34,13 @@ module Dodopayments
       #   @return [String, nil]
       optional :phone_number, String, nil?: true
 
-      # @!parse
-      #   # @param business_id [String]
-      #   # @param created_at [Time]
-      #   # @param customer_id [String]
-      #   # @param email [String]
-      #   # @param name [String]
-      #   # @param phone_number [String, nil]
-      #   #
-      #   def initialize(business_id:, created_at:, customer_id:, email:, name:, phone_number: nil, **) = super
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(business_id:, created_at:, customer_id:, email:, name:, phone_number: nil)
+      #   @param business_id [String]
+      #   @param created_at [Time]
+      #   @param customer_id [String]
+      #   @param email [String]
+      #   @param name [String]
+      #   @param phone_number [String, nil]
     end
   end
 end

data/lib/dodopayments/models/customer_create_params.rb

@@ -4,8 +4,7 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Customers#create
     class CustomerCreateParams < Dodopayments::Internal::Type::BaseModel
-      # @!parse
-      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute email
@@ -23,15 +22,11 @@ module Dodopayments
       #   @return [String, nil]
       optional :phone_number, String, nil?: true
 
-      # @!parse
-      #   # @param email [String]
-      #   # @param name [String]
-      #   # @param phone_number [String, nil]
-      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(email:, name:, phone_number: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(email:, name:, phone_number: nil, request_options: {})
+      #   @param email [String]
+      #   @param name [String]
+      #   @param phone_number [String, nil]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/dodopayments/models/customer_limited_details.rb

@@ -21,14 +21,10 @@ module Dodopayments
       #   @return [String]
       required :name, String
 
-      # @!parse
-      #   # @param customer_id [String]
-      #   # @param email [String]
-      #   # @param name [String]
-      #   #
-      #   def initialize(customer_id:, email:, name:, **) = super
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(customer_id:, email:, name:)
+      #   @param customer_id [String]
+      #   @param email [String]
+      #   @param name [String]
     end
   end
 end

data/lib/dodopayments/models/customer_list_params.rb

@@ -4,8 +4,7 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Customers#list
     class CustomerListParams < Dodopayments::Internal::Type::BaseModel
-      # @!parse
-      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute page_number
@@ -20,14 +19,10 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :page_size, Integer, nil?: true
 
-      # @!parse
-      #   # @param page_number [Integer, nil]
-      #   # @param page_size [Integer, nil]
-      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(page_number: nil, page_size: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(page_number: nil, page_size: nil, request_options: {})
+      #   @param page_number [Integer, nil]
+      #   @param page_size [Integer, nil]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/dodopayments/models/customer_portal_session.rb

@@ -8,12 +8,8 @@ module Dodopayments
       #   @return [String]
       required :link, String
 
-      # @!parse
-      #   # @param link [String]
-      #   #
-      #   def initialize(link:, **) = super
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(link:)
+      #   @param link [String]
     end
   end
 end

data/lib/dodopayments/models/customer_request.rb

@@ -9,9 +9,8 @@ module Dodopayments
 
       variant -> { Dodopayments::Models::CreateNewCustomer }
 
-      # @!parse
-      #   # @return [Array(Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer)]
-      #   def self.variants; end
+      # @!method self.variants
+      #   @return [Array(Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer)]
     end
   end
 end

data/lib/dodopayments/models/customer_retrieve_params.rb

@@ -4,16 +4,11 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Customers#retrieve
     class CustomerRetrieveParams < Dodopayments::Internal::Type::BaseModel
-      # @!parse
-      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      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::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/dodopayments/models/customer_update_params.rb

@@ -4,8 +4,7 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Customers#update
     class CustomerUpdateParams < Dodopayments::Internal::Type::BaseModel
-      # @!parse
-      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute name
@@ -18,14 +17,10 @@ module Dodopayments
       #   @return [String, nil]
       optional :phone_number, String, nil?: true
 
-      # @!parse
-      #   # @param name [String, nil]
-      #   # @param phone_number [String, nil]
-      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(name: nil, phone_number: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(name: nil, phone_number: nil, request_options: {})
+      #   @param name [String, nil]
+      #   @param phone_number [String, nil]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/dodopayments/models/customers/customer_portal_create_params.rb

@@ -5,8 +5,7 @@ module Dodopayments
     module Customers
       # @see Dodopayments::Resources::Customers::CustomerPortal#create
       class CustomerPortalCreateParams < Dodopayments::Internal::Type::BaseModel
-        # @!parse
-        #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
         include Dodopayments::Internal::Type::RequestParameters
 
         # @!attribute send_email
@@ -15,13 +14,9 @@ module Dodopayments
         #   @return [Boolean, nil]
         optional :send_email, Dodopayments::Internal::Type::Boolean, nil?: true
 
-        # @!parse
-        #   # @param send_email [Boolean, nil]
-        #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(send_email: nil, request_options: {}, **) = super
-
-        # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+        # @!method initialize(send_email: nil, request_options: {})
+        #   @param send_email [Boolean, nil]
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
       end
     end
   end

data/lib/dodopayments/models/discount.rb

@@ -73,37 +73,18 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :usage_limit, Integer, nil?: true
 
-      # @!parse
-      #   # @param amount [Integer]
-      #   # @param business_id [String]
-      #   # @param code [String]
-      #   # @param created_at [Time]
-      #   # @param discount_id [String]
-      #   # @param restricted_to [Array<String>]
-      #   # @param times_used [Integer]
-      #   # @param type [Symbol, Dodopayments::Models::DiscountType]
-      #   # @param expires_at [Time, nil]
-      #   # @param name [String, nil]
-      #   # @param usage_limit [Integer, nil]
-      #   #
-      #   def initialize(
-      #     amount:,
-      #     business_id:,
-      #     code:,
-      #     created_at:,
-      #     discount_id:,
-      #     restricted_to:,
-      #     times_used:,
-      #     type:,
-      #     expires_at: nil,
-      #     name: nil,
-      #     usage_limit: nil,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(amount:, business_id:, code:, created_at:, discount_id:, restricted_to:, times_used:, type:, expires_at: nil, name: nil, usage_limit: nil)
+      #   @param amount [Integer]
+      #   @param business_id [String]
+      #   @param code [String]
+      #   @param created_at [Time]
+      #   @param discount_id [String]
+      #   @param restricted_to [Array<String>]
+      #   @param times_used [Integer]
+      #   @param type [Symbol, Dodopayments::Models::DiscountType]
+      #   @param expires_at [Time, nil]
+      #   @param name [String, nil]
+      #   @param usage_limit [Integer, nil]
     end
   end
 end

data/lib/dodopayments/models/discount_create_params.rb

@@ -4,8 +4,7 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Discounts#create
     class DiscountCreateParams < Dodopayments::Internal::Type::BaseModel
-      # @!parse
-      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute amount
@@ -58,31 +57,15 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :usage_limit, Integer, nil?: true
 
-      # @!parse
-      #   # @param amount [Integer]
-      #   # @param type [Symbol, Dodopayments::Models::DiscountType]
-      #   # @param code [String, nil]
-      #   # @param expires_at [Time, nil]
-      #   # @param name [String, nil]
-      #   # @param restricted_to [Array<String>, nil]
-      #   # @param usage_limit [Integer, nil]
-      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     amount:,
-      #     type:,
-      #     code: nil,
-      #     expires_at: nil,
-      #     name: nil,
-      #     restricted_to: nil,
-      #     usage_limit: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(amount:, type:, code: nil, expires_at: nil, name: nil, restricted_to: nil, usage_limit: nil, request_options: {})
+      #   @param amount [Integer]
+      #   @param type [Symbol, Dodopayments::Models::DiscountType]
+      #   @param code [String, nil]
+      #   @param expires_at [Time, nil]
+      #   @param name [String, nil]
+      #   @param restricted_to [Array<String>, nil]
+      #   @param usage_limit [Integer, nil]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/dodopayments/models/discount_delete_params.rb

@@ -4,16 +4,11 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Discounts#delete
     class DiscountDeleteParams < Dodopayments::Internal::Type::BaseModel
-      # @!parse
-      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      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::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/dodopayments/models/discount_list_params.rb

@@ -4,8 +4,7 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Discounts#list
     class DiscountListParams < Dodopayments::Internal::Type::BaseModel
-      # @!parse
-      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute page_number
@@ -20,14 +19,10 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :page_size, Integer, nil?: true
 
-      # @!parse
-      #   # @param page_number [Integer, nil]
-      #   # @param page_size [Integer, nil]
-      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(page_number: nil, page_size: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(page_number: nil, page_size: nil, request_options: {})
+      #   @param page_number [Integer, nil]
+      #   @param page_size [Integer, nil]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/dodopayments/models/discount_retrieve_params.rb

@@ -4,16 +4,11 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Discounts#retrieve
     class DiscountRetrieveParams < Dodopayments::Internal::Type::BaseModel
-      # @!parse
-      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      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::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/dodopayments/models/discount_type.rb

@@ -7,11 +7,8 @@ module Dodopayments
 
       PERCENTAGE = :percentage
 
-      finalize!
-
-      # @!parse
-      #   # @return [Array<Symbol>]
-      #   def self.values; end
+      # @!method self.values
+      #   @return [Array<Symbol>]
     end
   end
 end

data/lib/dodopayments/models/discount_update_params.rb

@@ -4,8 +4,7 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Discounts#update
     class DiscountUpdateParams < Dodopayments::Internal::Type::BaseModel
-      # @!parse
-      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute amount
@@ -53,31 +52,15 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :usage_limit, Integer, nil?: true
 
-      # @!parse
-      #   # @param amount [Integer, nil]
-      #   # @param code [String, nil]
-      #   # @param expires_at [Time, nil]
-      #   # @param name [String, nil]
-      #   # @param restricted_to [Array<String>, nil]
-      #   # @param type [Symbol, Dodopayments::Models::DiscountType, nil]
-      #   # @param usage_limit [Integer, nil]
-      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     amount: nil,
-      #     code: nil,
-      #     expires_at: nil,
-      #     name: nil,
-      #     restricted_to: nil,
-      #     type: nil,
-      #     usage_limit: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(amount: nil, code: nil, expires_at: nil, name: nil, restricted_to: nil, type: nil, usage_limit: nil, request_options: {})
+      #   @param amount [Integer, nil]
+      #   @param code [String, nil]
+      #   @param expires_at [Time, nil]
+      #   @param name [String, nil]
+      #   @param restricted_to [Array<String>, nil]
+      #   @param type [Symbol, Dodopayments::Models::DiscountType, nil]
+      #   @param usage_limit [Integer, nil]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/dodopayments/models/dispute.rb

@@ -51,31 +51,15 @@ module Dodopayments
       #   @return [String]
       required :payment_id, String
 
-      # @!parse
-      #   # @param amount [String]
-      #   # @param business_id [String]
-      #   # @param created_at [Time]
-      #   # @param currency [String]
-      #   # @param dispute_id [String]
-      #   # @param dispute_stage [Symbol, Dodopayments::Models::DisputeStage]
-      #   # @param dispute_status [Symbol, Dodopayments::Models::DisputeStatus]
-      #   # @param payment_id [String]
-      #   #
-      #   def initialize(
-      #     amount:,
-      #     business_id:,
-      #     created_at:,
-      #     currency:,
-      #     dispute_id:,
-      #     dispute_stage:,
-      #     dispute_status:,
-      #     payment_id:,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(amount:, business_id:, created_at:, currency:, dispute_id:, dispute_stage:, dispute_status:, payment_id:)
+      #   @param amount [String]
+      #   @param business_id [String]
+      #   @param created_at [Time]
+      #   @param currency [String]
+      #   @param dispute_id [String]
+      #   @param dispute_stage [Symbol, Dodopayments::Models::DisputeStage]
+      #   @param dispute_status [Symbol, Dodopayments::Models::DisputeStatus]
+      #   @param payment_id [String]
     end
   end
 end