dodopayments 0.0.1.pre.alpha.0 → 1.16.1

data/lib/dodopayments/models/subscription_create_response.rb

@@ -2,7 +2,8 @@
 
 module Dodopayments
   module Models
-    class SubscriptionCreateResponse < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::Subscriptions#create
+    class SubscriptionCreateResponse < Dodopayments::Internal::Type::BaseModel
       # @!attribute customer
       #
       #   @return [Dodopayments::Models::CustomerLimitedDetails]
@@ -11,11 +12,11 @@ module Dodopayments
       # @!attribute metadata
       #
       #   @return [Hash{Symbol=>String}]
-      required :metadata, Dodopayments::HashOf[String]
+      required :metadata, Dodopayments::Internal::Type::HashOf[String]
 
       # @!attribute recurring_pre_tax_amount
       #   Tax will be added to the amount and charged to the customer on each billing
-      #     cycle
+      #   cycle
       #
       #   @return [Integer]
       required :recurring_pre_tax_amount, Integer
@@ -28,7 +29,7 @@ module Dodopayments
 
       # @!attribute client_secret
       #   Client secret used to load Dodo checkout SDK NOTE : Dodo checkout SDK will be
-      #     coming soon
+      #   coming soon
       #
       #   @return [String, nil]
       optional :client_secret, String, nil?: true
@@ -67,7 +68,7 @@ module Dodopayments
       #     super
       #   end
 
-      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/dodopayments/models/subscription_list_params.rb

@@ -2,10 +2,11 @@
 
 module Dodopayments
   module Models
-    class SubscriptionListParams < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::Subscriptions#list
+    class SubscriptionListParams < Dodopayments::Internal::Type::BaseModel
       # @!parse
-      #   extend Dodopayments::RequestParameters::Converter
-      include Dodopayments::RequestParameters
+      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute created_at_gte
       #   Get events after this created time
@@ -65,7 +66,7 @@ module Dodopayments
       #     super
       #   end
 
-      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/dodopayments/models/subscription_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module Dodopayments
   module Models
-    class SubscriptionRetrieveParams < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::Subscriptions#retrieve
+    class SubscriptionRetrieveParams < 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/subscription_status.rb

@@ -2,8 +2,9 @@
 
 module Dodopayments
   module Models
-    # @abstract
-    class SubscriptionStatus < Dodopayments::Enum
+    module SubscriptionStatus
+      extend Dodopayments::Internal::Type::Enum
+
       PENDING = :pending
       ACTIVE = :active
       ON_HOLD = :on_hold
@@ -13,6 +14,10 @@ module Dodopayments
       EXPIRED = :expired
 
       finalize!
+
+      # @!parse
+      #   # @return [Array<Symbol>]
+      #   def self.values; end
     end
   end
 end

data/lib/dodopayments/models/subscription_update_params.rb

@@ -2,29 +2,42 @@
 
 module Dodopayments
   module Models
-    class SubscriptionUpdateParams < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::Subscriptions#update
+    class SubscriptionUpdateParams < Dodopayments::Internal::Type::BaseModel
       # @!parse
-      #   extend Dodopayments::RequestParameters::Converter
-      include Dodopayments::RequestParameters
+      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute billing
+      #
+      #   @return [Dodopayments::Models::BillingAddress, nil]
+      optional :billing, -> { Dodopayments::Models::BillingAddress }, nil?: true
 
       # @!attribute metadata
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, Dodopayments::HashOf[String], nil?: true
+      optional :metadata, Dodopayments::Internal::Type::HashOf[String], nil?: true
 
       # @!attribute status
       #
       #   @return [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
       optional :status, enum: -> { Dodopayments::Models::SubscriptionStatus }, nil?: true
 
+      # @!attribute tax_id
+      #
+      #   @return [String, nil]
+      optional :tax_id, String, nil?: true
+
       # @!parse
+      #   # @param billing [Dodopayments::Models::BillingAddress, nil]
       #   # @param metadata [Hash{Symbol=>String}, nil]
       #   # @param status [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
+      #   # @param tax_id [String, nil]
       #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
       #   #
-      #   def initialize(metadata: nil, status: nil, request_options: {}, **) = super
+      #   def initialize(billing: nil, metadata: nil, status: nil, tax_id: 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/time_interval.rb

@@ -2,14 +2,19 @@
 
 module Dodopayments
   module Models
-    # @abstract
-    class TimeInterval < Dodopayments::Enum
+    module TimeInterval
+      extend Dodopayments::Internal::Type::Enum
+
       DAY = :Day
       WEEK = :Week
       MONTH = :Month
       YEAR = :Year
 
       finalize!
+
+      # @!parse
+      #   # @return [Array<Symbol>]
+      #   def self.values; end
     end
   end
 end

data/lib/dodopayments/models/webhook_event.rb

@@ -2,7 +2,8 @@
 
 module Dodopayments
   module Models
-    class WebhookEvent < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::WebhookEvents#retrieve
+    class WebhookEvent < Dodopayments::Internal::Type::BaseModel
       # @!attribute business_id
       #
       #   @return [String]
@@ -67,7 +68,7 @@ module Dodopayments
       #     super
       #   end
 
-      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/dodopayments/models/webhook_event_list_params.rb

@@ -2,10 +2,11 @@
 
 module Dodopayments
   module Models
-    class WebhookEventListParams < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::WebhookEvents#list
+    class WebhookEventListParams < Dodopayments::Internal::Type::BaseModel
       # @!parse
-      #   extend Dodopayments::RequestParameters::Converter
-      include Dodopayments::RequestParameters
+      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute created_at_gte
       #   Get events after this created time
@@ -29,7 +30,7 @@ module Dodopayments
       #   Get events history of a specific object like payment/subscription/refund/dispute
       #
       #   @return [String, nil]
-      optional :object_id_, String, api_name: :object_id, nil?: true
+      optional :object_id_, String, nil?: true
 
       # @!attribute page_number
       #   Page number default is 0
@@ -65,7 +66,7 @@ module Dodopayments
       #     super
       #   end
 
-      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/dodopayments/models/webhook_event_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module Dodopayments
   module Models
-    class WebhookEventRetrieveParams < Dodopayments::BaseModel
+    # @see Dodopayments::Resources::WebhookEvents#retrieve
+    class WebhookEventRetrieveParams < 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/request_options.rb

@@ -1,47 +1,12 @@
 # frozen_string_literal: true
 
 module Dodopayments
-  # @api private
-  #
-  # @abstract
-  module RequestParameters
-    # @!parse
-    #   # Options to specify HTTP behaviour for this request.
-    #   # @return [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
-    #   attr_accessor :request_options
-
-    # @param mod [Module]
-    def self.included(mod)
-      return unless mod <= Dodopayments::BaseModel
-
-      mod.extend(Dodopayments::RequestParameters::Converter)
-      mod.optional(:request_options, Dodopayments::RequestOptions)
-    end
-
-    # @api private
-    module Converter
-      # @api private
-      #
-      # @param params [Object]
-      #
-      # @return [Array(Object, Hash{Symbol=>Object})]
-      def dump_request(params)
-        case (dumped = dump(params))
-        in Hash
-          [dumped.except(:request_options), dumped[:request_options]]
-        else
-          [dumped, nil]
-        end
-      end
-    end
-  end
-
   # Specify HTTP behaviour to use for a specific request. These options supplement
-  #   or override those provided at the client level.
+  # or override those provided at the client level.
   #
-  #   When making a request, you can pass an actual {RequestOptions} instance, or
-  #   simply pass a Hash with symbol keys matching the attributes on this class.
-  class RequestOptions < Dodopayments::BaseModel
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Dodopayments::Internal::Type::BaseModel
     # @api private
     #
     # @param opts [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
@@ -62,31 +27,31 @@ module Dodopayments
 
     # @!attribute idempotency_key
     #   Idempotency key to send with request and all associated retries. Will only be
-    #     sent for write requests.
+    #   sent for write requests.
     #
     #   @return [String, nil]
     optional :idempotency_key, String
 
     # @!attribute extra_query
     #   Extra query params to send with the request. These are `.merge`’d into any
-    #     `query` given at the client level.
+    #   `query` given at the client level.
     #
     #   @return [Hash{String=>Array<String>, String, nil}, nil]
-    optional :extra_query, Dodopayments::HashOf[Dodopayments::ArrayOf[String]]
+    optional :extra_query, Dodopayments::Internal::Type::HashOf[Dodopayments::Internal::Type::ArrayOf[String]]
 
     # @!attribute extra_headers
     #   Extra headers to send with the request. These are `.merged`’d into any
-    #     `extra_headers` given at the client level.
+    #   `extra_headers` given at the client level.
     #
     #   @return [Hash{String=>String, nil}, nil]
-    optional :extra_headers, Dodopayments::HashOf[String, nil?: true]
+    optional :extra_headers, Dodopayments::Internal::Type::HashOf[String, nil?: true]
 
     # @!attribute extra_body
     #   Extra data to send with the request. These are deep merged into any data
-    #     generated as part of the normal request.
+    #   generated as part of the normal request.
     #
-    #   @return [Hash{Symbol=>Object}, nil]
-    optional :extra_body, Dodopayments::HashOf[Dodopayments::Unknown]
+    #   @return [Object, nil]
+    optional :extra_body, Dodopayments::Internal::Type::HashOf[Dodopayments::Internal::Type::Unknown]
 
     # @!attribute max_retries
     #   Maximum number of retries to attempt after a failed initial request.

data/lib/dodopayments/resources/customers/customer_portal.rb

@@ -4,26 +4,28 @@ module Dodopayments
   module Resources
     class Customers
       class CustomerPortal
-        # @param customer_id [String] Customer Id
+        # @overload create(customer_id, send_email: nil, request_options: {})
         #
-        # @param params [Dodopayments::Models::Customers::CustomerPortalCreateParams, Hash{Symbol=>Object}] .
+        # @param customer_id [String]
+        # @param send_email [Boolean, nil]
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        #   @option params [Boolean, nil] :send_email If true, will send link to user.
+        # @return [Dodopayments::Models::CustomerPortalSession]
         #
-        #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [nil]
+        # @see Dodopayments::Models::Customers::CustomerPortalCreateParams
         def create(customer_id, params = {})
           parsed, options = Dodopayments::Models::Customers::CustomerPortalCreateParams.dump_request(params)
           @client.request(
             method: :post,
-            path: ["customers/%0s/customer-portal/session", customer_id],
+            path: ["customers/%1$s/customer-portal/session", customer_id],
             query: parsed,
-            model: NilClass,
+            model: Dodopayments::Models::CustomerPortalSession,
             options: options
           )
         end
 
+        # @api private
+        #
         # @param client [Dodopayments::Client]
         def initialize(client:)
           @client = client

data/lib/dodopayments/resources/customers.rb

@@ -6,17 +6,16 @@ module Dodopayments
       # @return [Dodopayments::Resources::Customers::CustomerPortal]
       attr_reader :customer_portal
 
-      # @param params [Dodopayments::Models::CustomerCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(email:, name:, phone_number: nil, request_options: {})
       #
-      #   @option params [String] :email
-      #
-      #   @option params [String] :name
-      #
-      #   @option params [String, nil] :phone_number
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param email [String]
+      # @param name [String]
+      # @param phone_number [String, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Customer]
+      #
+      # @see Dodopayments::Models::CustomerCreateParams
       def create(params)
         parsed, options = Dodopayments::Models::CustomerCreateParams.dump_request(params)
         @client.request(
@@ -28,65 +27,67 @@ module Dodopayments
         )
       end
 
-      # @param customer_id [String] Customer Id
-      #
-      # @param params [Dodopayments::Models::CustomerRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(customer_id, request_options: {})
       #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param customer_id [String]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Customer]
+      #
+      # @see Dodopayments::Models::CustomerRetrieveParams
       def retrieve(customer_id, params = {})
         @client.request(
           method: :get,
-          path: ["customers/%0s", customer_id],
+          path: ["customers/%1$s", customer_id],
           model: Dodopayments::Models::Customer,
           options: params[:request_options]
         )
       end
 
-      # @param customer_id [String] Customer Id
+      # @overload update(customer_id, name: nil, phone_number: nil, request_options: {})
       #
-      # @param params [Dodopayments::Models::CustomerUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :name
-      #
-      #   @option params [String, nil] :phone_number
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param customer_id [String]
+      # @param name [String, nil]
+      # @param phone_number [String, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Customer]
+      #
+      # @see Dodopayments::Models::CustomerUpdateParams
       def update(customer_id, params = {})
         parsed, options = Dodopayments::Models::CustomerUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["customers/%0s", customer_id],
+          path: ["customers/%1$s", customer_id],
           body: parsed,
           model: Dodopayments::Models::Customer,
           options: options
         )
       end
 
-      # @param params [Dodopayments::Models::CustomerListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Integer, nil] :page_number Page number default is 0
+      # @overload list(page_number: nil, page_size: nil, request_options: {})
       #
-      #   @option params [Integer, nil] :page_size Page size default is 10 max is 100
+      # @param page_number [Integer, nil]
+      # @param page_size [Integer, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Customer>]
       #
-      # @return [Dodopayments::DefaultPageNumberPagination<Dodopayments::Models::Customer>]
+      # @see Dodopayments::Models::CustomerListParams
       def list(params = {})
         parsed, options = Dodopayments::Models::CustomerListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "customers",
           query: parsed,
-          page: Dodopayments::DefaultPageNumberPagination,
+          page: Dodopayments::Internal::DefaultPageNumberPagination,
           model: Dodopayments::Models::Customer,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [Dodopayments::Client]
       def initialize(client:)
         @client = client