dodopayments 0.0.1.pre.alpha.0 → 1.14.0

data/lib/dodopayments/resources/subscriptions.rb

@@ -3,33 +3,27 @@
 module Dodopayments
   module Resources
     class Subscriptions
-      # @param params [Dodopayments::Models::SubscriptionCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Dodopayments::Models::BillingAddress] :billing
-      #
-      #   @option params [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer] :customer
-      #
-      #   @option params [String] :product_id Unique identifier of the product to subscribe to
-      #
-      #   @option params [Integer] :quantity Number of units to subscribe for. Must be at least 1.
-      #
-      #   @option params [String, nil] :discount_code Discount Code to apply to the subscription
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata
-      #
-      #   @option params [Boolean, nil] :payment_link If true, generates a payment link. Defaults to false if not specified.
-      #
-      #   @option params [String, nil] :return_url Optional URL to redirect after successful subscription creation
-      #
-      #   @option params [String, nil] :tax_id Tax ID in case the payment is B2B. If tax id validation fails the payment
-      #     creation will fail
-      #
-      #   @option params [Integer, nil] :trial_period_days Optional trial period in days If specified, this value overrides the trial
-      #     period set in the product's price Must be between 0 and 10000 days
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(billing:, customer:, product_id:, quantity:, allowed_payment_method_types: nil, billing_currency: nil, discount_code: nil, metadata: nil, on_demand: nil, payment_link: nil, return_url: nil, show_saved_payment_methods: nil, tax_id: nil, trial_period_days: nil, request_options: {})
+      #
+      # @param billing [Dodopayments::Models::BillingAddress]
+      # @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer]
+      # @param product_id [String]
+      # @param quantity [Integer]
+      # @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::SubscriptionCreateParams::AllowedPaymentMethodType>, nil]
+      # @param billing_currency [Symbol, Dodopayments::Models::SubscriptionCreateParams::BillingCurrency, nil]
+      # @param discount_code [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param on_demand [Dodopayments::Models::SubscriptionCreateParams::OnDemand, nil]
+      # @param payment_link [Boolean, nil]
+      # @param return_url [String, nil]
+      # @param show_saved_payment_methods [Boolean]
+      # @param tax_id [String, nil]
+      # @param trial_period_days [Integer, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::SubscriptionCreateResponse]
+      #
+      # @see Dodopayments::Models::SubscriptionCreateParams
       def create(params)
         parsed, options = Dodopayments::Models::SubscriptionCreateParams.dump_request(params)
         @client.request(
@@ -41,73 +35,93 @@ module Dodopayments
         )
       end
 
-      # @param subscription_id [String] Subscription Id
-      #
-      # @param params [Dodopayments::Models::SubscriptionRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(subscription_id, request_options: {})
       #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param subscription_id [String]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Subscription]
+      #
+      # @see Dodopayments::Models::SubscriptionRetrieveParams
       def retrieve(subscription_id, params = {})
         @client.request(
           method: :get,
-          path: ["subscriptions/%0s", subscription_id],
+          path: ["subscriptions/%1$s", subscription_id],
           model: Dodopayments::Models::Subscription,
           options: params[:request_options]
         )
       end
 
-      # @param subscription_id [String] Subscription Id
-      #
-      # @param params [Dodopayments::Models::SubscriptionUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Hash{Symbol=>String}, nil] :metadata
-      #
-      #   @option params [Symbol, Dodopayments::Models::SubscriptionStatus, nil] :status
+      # @overload update(subscription_id, billing: nil, metadata: nil, status: nil, tax_id: nil, request_options: {})
       #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param subscription_id [String]
+      # @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}, nil]
       #
       # @return [Dodopayments::Models::Subscription]
+      #
+      # @see Dodopayments::Models::SubscriptionUpdateParams
       def update(subscription_id, params = {})
         parsed, options = Dodopayments::Models::SubscriptionUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["subscriptions/%0s", subscription_id],
+          path: ["subscriptions/%1$s", subscription_id],
           body: parsed,
           model: Dodopayments::Models::Subscription,
           options: options
         )
       end
 
-      # @param params [Dodopayments::Models::SubscriptionListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Time, nil] :created_at_gte Get events after this created time
-      #
-      #   @option params [Time, nil] :created_at_lte Get events created before this time
-      #
-      #   @option params [String, nil] :customer_id Filter by customer id
-      #
-      #   @option params [Integer, nil] :page_number Page number default is 0
+      # @overload list(created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, status: nil, request_options: {})
       #
-      #   @option params [Integer, nil] :page_size Page size default is 10 max is 100
+      # @param created_at_gte [Time, nil]
+      # @param created_at_lte [Time, nil]
+      # @param customer_id [String, nil]
+      # @param page_number [Integer, nil]
+      # @param page_size [Integer, nil]
+      # @param status [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Symbol, Dodopayments::Models::SubscriptionStatus, nil] :status Filter by status
+      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Subscription>]
       #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [Dodopayments::DefaultPageNumberPagination<Dodopayments::Models::Subscription>]
+      # @see Dodopayments::Models::SubscriptionListParams
       def list(params = {})
         parsed, options = Dodopayments::Models::SubscriptionListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "subscriptions",
           query: parsed,
-          page: Dodopayments::DefaultPageNumberPagination,
+          page: Dodopayments::Internal::DefaultPageNumberPagination,
           model: Dodopayments::Models::Subscription,
           options: options
         )
       end
 
+      # @overload charge(subscription_id, product_price:, request_options: {})
+      #
+      # @param subscription_id [String]
+      # @param product_price [Integer]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::SubscriptionChargeResponse]
+      #
+      # @see Dodopayments::Models::SubscriptionChargeParams
+      def charge(subscription_id, params)
+        parsed, options = Dodopayments::Models::SubscriptionChargeParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["subscriptions/%1$s/charge", subscription_id],
+          body: parsed,
+          model: Dodopayments::Models::SubscriptionChargeResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
       # @param client [Dodopayments::Client]
       def initialize(client:)
         @client = client

data/lib/dodopayments/resources/webhook_events.rb

@@ -3,51 +3,50 @@
 module Dodopayments
   module Resources
     class WebhookEvents
-      # @param webhook_event_id [String]
-      #
-      # @param params [Dodopayments::Models::WebhookEventRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(webhook_event_id, request_options: {})
       #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param webhook_event_id [String]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::WebhookEvent]
+      #
+      # @see Dodopayments::Models::WebhookEventRetrieveParams
       def retrieve(webhook_event_id, params = {})
         @client.request(
           method: :get,
-          path: ["webhook_events/%0s", webhook_event_id],
+          path: ["webhook_events/%1$s", webhook_event_id],
           model: Dodopayments::Models::WebhookEvent,
           options: params[:request_options]
         )
       end
 
-      # @param params [Dodopayments::Models::WebhookEventListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Time, nil] :created_at_gte Get events after this created time
+      # @overload list(created_at_gte: nil, created_at_lte: nil, limit: nil, object_id_: nil, page_number: nil, page_size: nil, request_options: {})
       #
-      #   @option params [Time, nil] :created_at_lte Get events created before this time
+      # @param created_at_gte [Time, nil]
+      # @param created_at_lte [Time, nil]
+      # @param limit [Integer, nil]
+      # @param object_id_ [String, nil]
+      # @param page_number [Integer, nil]
+      # @param page_size [Integer, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Integer, nil] :limit Min : 1, Max : 100, default 10
+      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::WebhookEvent>]
       #
-      #   @option params [String, nil] :object_id_ Get events history of a specific object like payment/subscription/refund/dispute
-      #
-      #   @option params [Integer, nil] :page_number Page number default is 0
-      #
-      #   @option params [Integer, nil] :page_size Page size default is 10 max is 100
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [Dodopayments::DefaultPageNumberPagination<Dodopayments::Models::WebhookEvent>]
+      # @see Dodopayments::Models::WebhookEventListParams
       def list(params = {})
         parsed, options = Dodopayments::Models::WebhookEventListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "webhook_events",
-          query: parsed,
-          page: Dodopayments::DefaultPageNumberPagination,
+          query: parsed.transform_keys(object_id_: "object_id"),
+          page: Dodopayments::Internal::DefaultPageNumberPagination,
           model: Dodopayments::Models::WebhookEvent,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [Dodopayments::Client]
       def initialize(client:)
         @client = client

data/lib/dodopayments/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dodopayments
-  VERSION = "0.0.1-alpha.0"
+  VERSION = "1.14.0"
 end

data/lib/dodopayments.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # Standard libraries.
+require "English"
 require "cgi"
 require "date"
 require "erb"
@@ -15,21 +16,45 @@ require "stringio"
 require "time"
 require "uri"
 
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).grep(/tapioca/)
+  Warning.warn(
+    <<~WARN
+      \n
+      ⚠️ skipped loading of "dodopayments" gem under `tapioca`.
+
+      This message is normal and expected if you are running a `tapioca` command, and does not impact `.rbi` generation.
+      \n
+    WARN
+  )
+  return
+end
+
 # Gems.
 require "connection_pool"
 
 # Package files.
 require_relative "dodopayments/version"
-require_relative "dodopayments/util"
-require_relative "dodopayments/extern"
-require_relative "dodopayments/base_model"
-require_relative "dodopayments/base_page"
+require_relative "dodopayments/internal/util"
+require_relative "dodopayments/internal/type/converter"
+require_relative "dodopayments/internal/type/unknown"
+require_relative "dodopayments/internal/type/boolean"
+require_relative "dodopayments/internal/type/io_like"
+require_relative "dodopayments/internal/type/enum"
+require_relative "dodopayments/internal/type/union"
+require_relative "dodopayments/internal/type/array_of"
+require_relative "dodopayments/internal/type/hash_of"
+require_relative "dodopayments/internal/type/base_model"
+require_relative "dodopayments/internal/type/base_page"
+require_relative "dodopayments/internal/type/request_parameters"
+require_relative "dodopayments/internal"
 require_relative "dodopayments/request_options"
 require_relative "dodopayments/errors"
-require_relative "dodopayments/base_client"
-require_relative "dodopayments/pooled_net_requester"
+require_relative "dodopayments/internal/transport/base_client"
+require_relative "dodopayments/internal/transport/pooled_net_requester"
 require_relative "dodopayments/client"
-require_relative "dodopayments/default_page_number_pagination"
+require_relative "dodopayments/internal/default_page_number_pagination"
 require_relative "dodopayments/models/attach_existing_customer"
 require_relative "dodopayments/models/billing_address"
 require_relative "dodopayments/models/country_code"
@@ -99,6 +124,8 @@ require_relative "dodopayments/models/refund_list_params"
 require_relative "dodopayments/models/refund_retrieve_params"
 require_relative "dodopayments/models/refund_status"
 require_relative "dodopayments/models/subscription"
+require_relative "dodopayments/models/subscription_charge_params"
+require_relative "dodopayments/models/subscription_charge_response"
 require_relative "dodopayments/models/subscription_create_params"
 require_relative "dodopayments/models/subscription_create_response"
 require_relative "dodopayments/models/subscription_list_params"

data/manifest.yaml

@@ -1,4 +1,5 @@
 dependencies:
+  - English
   - cgi
   - date
   - erb

data/rbi/lib/dodopayments/client.rbi

@@ -1,7 +1,7 @@
 # typed: strong
 
 module Dodopayments
-  class Client < Dodopayments::BaseClient
+  class Client < Dodopayments::Internal::Transport::BaseClient
     DEFAULT_MAX_RETRIES = 2
 
     DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
@@ -10,83 +10,68 @@ module Dodopayments
 
     DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
 
-    ENVIRONMENTS = T.let(
-      {live_mode: "https://live.dodopayments.com", test_mode: "https://test.dodopayments.com"},
-      T::Hash[Symbol, String]
-    )
+    ENVIRONMENTS =
+      T.let(
+        {live_mode: "https://live.dodopayments.com", test_mode: "https://test.dodopayments.com"},
+        T::Hash[Symbol, String]
+      )
 
     # Bearer Token for API authentication
     sig { returns(String) }
-    def bearer_token
-    end
+    attr_reader :bearer_token
 
     sig { returns(Dodopayments::Resources::Payments) }
-    def payments
-    end
+    attr_reader :payments
 
     sig { returns(Dodopayments::Resources::Subscriptions) }
-    def subscriptions
-    end
+    attr_reader :subscriptions
 
     sig { returns(Dodopayments::Resources::Invoices) }
-    def invoices
-    end
+    attr_reader :invoices
 
     sig { returns(Dodopayments::Resources::Licenses) }
-    def licenses
-    end
+    attr_reader :licenses
 
     sig { returns(Dodopayments::Resources::LicenseKeys) }
-    def license_keys
-    end
+    attr_reader :license_keys
 
     sig { returns(Dodopayments::Resources::LicenseKeyInstances) }
-    def license_key_instances
-    end
+    attr_reader :license_key_instances
 
     sig { returns(Dodopayments::Resources::Customers) }
-    def customers
-    end
+    attr_reader :customers
 
     sig { returns(Dodopayments::Resources::Refunds) }
-    def refunds
-    end
+    attr_reader :refunds
 
     sig { returns(Dodopayments::Resources::Disputes) }
-    def disputes
-    end
+    attr_reader :disputes
 
     sig { returns(Dodopayments::Resources::Payouts) }
-    def payouts
-    end
+    attr_reader :payouts
 
     sig { returns(Dodopayments::Resources::WebhookEvents) }
-    def webhook_events
-    end
+    attr_reader :webhook_events
 
     sig { returns(Dodopayments::Resources::Products) }
-    def products
-    end
+    attr_reader :products
 
     sig { returns(Dodopayments::Resources::Misc) }
-    def misc
-    end
+    attr_reader :misc
 
     sig { returns(Dodopayments::Resources::Discounts) }
-    def discounts
-    end
+    attr_reader :discounts
 
     # @api private
     sig { override.returns(T::Hash[String, String]) }
-    private def auth_headers
-    end
+    private def auth_headers; end
 
     # Creates and returns a new client for interacting with the API.
     sig do
       params(
+        bearer_token: T.nilable(String),
         environment: NilClass,
         base_url: T.nilable(String),
-        bearer_token: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
         initial_retry_delay: Float,
@@ -95,23 +80,23 @@ module Dodopayments
         .returns(T.attached_class)
     end
     def self.new(
+      # Bearer Token for API authentication Defaults to `ENV["DODO_PAYMENTS_API_KEY"]`
+      bearer_token: ENV["DODO_PAYMENTS_API_KEY"],
       # Specifies the environment to use for the API.
       #
-      #   Each environment maps to a different base URL:
+      # Each environment maps to a different base URL:
       #
-      #   - `live_mode` corresponds to `https://live.dodopayments.com`
-      #   - `test_mode` corresponds to `https://test.dodopayments.com`
+      # - `live_mode` corresponds to `https://live.dodopayments.com`
+      # - `test_mode` corresponds to `https://test.dodopayments.com`
       environment: nil,
-      # Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
-      base_url: nil,
-      # Bearer Token for API authentication Defaults to `ENV["DODO_PAYMENTS_API_KEY"]`
-      bearer_token: ENV["DODO_PAYMENTS_API_KEY"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["DODO_PAYMENTS_BASE_URL"]`
+      base_url: ENV["DODO_PAYMENTS_BASE_URL"],
       # Max number of retries to attempt after a failed retryable request.
       max_retries: DEFAULT_MAX_RETRIES,
       timeout: DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
       max_retry_delay: DEFAULT_MAX_RETRY_DELAY
-    )
-    end
+    ); end
   end
 end