dodopayments 1.19.0 → 1.20.0

data/lib/dodopayments/models/tax_category.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # Represents the different categories of taxation applicable to various products
+    # and services.
+    module TaxCategory
+      extend Dodopayments::Internal::Type::Enum
+
+      DIGITAL_PRODUCTS = :digital_products
+      SAAS = :saas
+      E_BOOK = :e_book
+      EDTECH = :edtech
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/dodopayments/resources/addons.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Addons
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::AddonCreateParams} for more details.
+      #
+      # @overload create(currency:, name:, price:, tax_category:, description: nil, request_options: {})
+      #
+      # @param currency [Symbol, Dodopayments::Models::Currency]
+      #
+      # @param name [String] Name of the Addon
+      #
+      # @param price [Integer] Amount of the addon
+      #
+      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory] Represents the different categories of taxation applicable to various products a
+      # ...
+      #
+      # @param description [String, nil] Optional description of the Addon
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::AddonResponse]
+      #
+      # @see Dodopayments::Models::AddonCreateParams
+      def create(params)
+        parsed, options = Dodopayments::Models::AddonCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "addons",
+          body: parsed,
+          model: Dodopayments::Models::AddonResponse,
+          options: options
+        )
+      end
+
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Addon Id
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::AddonResponse]
+      #
+      # @see Dodopayments::Models::AddonRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["addons/%1$s", id],
+          model: Dodopayments::Models::AddonResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::AddonUpdateParams} for more details.
+      #
+      # @overload update(id, currency: nil, description: nil, image_id: nil, name: nil, price: nil, tax_category: nil, request_options: {})
+      #
+      # @param id [String] Addon Id
+      #
+      # @param currency [Symbol, Dodopayments::Models::Currency, nil]
+      #
+      # @param description [String, nil] Description of the Addon, optional and must be at most 1000 characters.
+      #
+      # @param image_id [String, nil] Addon image id after its uploaded to S3
+      #
+      # @param name [String, nil] Name of the Addon, optional and must be at most 100 characters.
+      #
+      # @param price [Integer, nil] Amount of the addon
+      #
+      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory, nil] Represents the different categories of taxation applicable to various products a
+      # ...
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::AddonResponse]
+      #
+      # @see Dodopayments::Models::AddonUpdateParams
+      def update(id, params = {})
+        parsed, options = Dodopayments::Models::AddonUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["addons/%1$s", id],
+          body: parsed,
+          model: Dodopayments::Models::AddonResponse,
+          options: options
+        )
+      end
+
+      # @overload list(page_number: nil, page_size: nil, request_options: {})
+      #
+      # @param page_number [Integer, nil] Page number default is 0
+      #
+      # @param page_size [Integer, nil] Page size default is 10 max is 100
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::AddonResponse>]
+      #
+      # @see Dodopayments::Models::AddonListParams
+      def list(params = {})
+        parsed, options = Dodopayments::Models::AddonListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "addons",
+          query: parsed,
+          page: Dodopayments::Internal::DefaultPageNumberPagination,
+          model: Dodopayments::Models::AddonResponse,
+          options: options
+        )
+      end
+
+      # @overload update_images(id, request_options: {})
+      #
+      # @param id [String] Addon Id
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::AddonUpdateImagesResponse]
+      #
+      # @see Dodopayments::Models::AddonUpdateImagesParams
+      def update_images(id, params = {})
+        @client.request(
+          method: :put,
+          path: ["addons/%1$s/images", id],
+          model: Dodopayments::Models::AddonUpdateImagesResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/payments.rb

@@ -16,7 +16,7 @@ module Dodopayments
       #
       # @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentCreateParams::AllowedPaymentMethodType>, nil] List of payment methods allowed during checkout. ...
       #
-      # @param billing_currency [Symbol, Dodopayments::Models::PaymentCreateParams::BillingCurrency, nil]
+      # @param billing_currency [Symbol, Dodopayments::Models::Currency, nil]
       #
       # @param discount_code [String, nil] Discount Code to apply to the transaction
       #

data/lib/dodopayments/resources/products.rb

@@ -13,7 +13,7 @@ module Dodopayments
       #
       # @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice]
       #
-      # @param tax_category [Symbol, Dodopayments::Models::ProductCreateParams::TaxCategory] Represents the different categories of taxation applicable to various products a
+      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory] Represents the different categories of taxation applicable to various products a
       # ...
       #
       # @param addons [Array<String>, nil] Addons available for subscription product
@@ -89,7 +89,7 @@ module Dodopayments
       #
       # @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil]
       #
-      # @param tax_category [Symbol, Dodopayments::Models::ProductUpdateParams::TaxCategory, nil] Represents the different categories of taxation applicable to various products a
+      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory, nil] Represents the different categories of taxation applicable to various products a
       # ...
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/dodopayments/resources/subscriptions.rb

@@ -6,7 +6,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::SubscriptionCreateParams} for more details.
       #
-      # @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: {})
+      # @overload create(billing:, customer:, product_id:, quantity:, addons: nil, 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]
       #
@@ -16,9 +16,11 @@ module Dodopayments
       #
       # @param quantity [Integer] Number of units to subscribe for. Must be at least 1.
       #
+      # @param addons [Array<Dodopayments::Models::SubscriptionCreateParams::Addon>, nil] Attach addons to this subscription
+      #
       # @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::SubscriptionCreateParams::AllowedPaymentMethodType>, nil] List of payment methods allowed during checkout. ...
       #
-      # @param billing_currency [Symbol, Dodopayments::Models::SubscriptionCreateParams::BillingCurrency, nil]
+      # @param billing_currency [Symbol, Dodopayments::Models::Currency, nil]
       #
       # @param discount_code [String, nil] Discount Code to apply to the subscription
       #
@@ -71,12 +73,14 @@ module Dodopayments
         )
       end
 
-      # @overload update(subscription_id, billing: nil, metadata: nil, status: nil, tax_id: nil, request_options: {})
+      # @overload update(subscription_id, billing: nil, disable_on_demand: nil, metadata: nil, status: nil, tax_id: nil, request_options: {})
       #
       # @param subscription_id [String] Subscription Id
       #
       # @param billing [Dodopayments::Models::BillingAddress, nil]
       #
+      # @param disable_on_demand [Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand, nil]
+      #
       # @param metadata [Hash{Symbol=>String}, nil]
       #
       # @param status [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
@@ -115,7 +119,7 @@ module Dodopayments
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Subscription>]
+      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::SubscriptionListResponse>]
       #
       # @see Dodopayments::Models::SubscriptionListParams
       def list(params = {})
@@ -125,7 +129,7 @@ module Dodopayments
           path: "subscriptions",
           query: parsed,
           page: Dodopayments::Internal::DefaultPageNumberPagination,
-          model: Dodopayments::Models::Subscription,
+          model: Dodopayments::Models::SubscriptionListResponse,
           options: options
         )
       end

data/lib/dodopayments/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dodopayments
-  VERSION = "1.19.0"
+  VERSION = "1.20.0"
 end

data/lib/dodopayments.rb

@@ -47,10 +47,19 @@ require_relative "dodopayments/internal/transport/base_client"
 require_relative "dodopayments/internal/transport/pooled_net_requester"
 require_relative "dodopayments/client"
 require_relative "dodopayments/internal/default_page_number_pagination"
+require_relative "dodopayments/models/addon_cart_response_item"
+require_relative "dodopayments/models/addon_create_params"
+require_relative "dodopayments/models/addon_list_params"
+require_relative "dodopayments/models/addon_response"
+require_relative "dodopayments/models/addon_retrieve_params"
+require_relative "dodopayments/models/addon_update_images_params"
+require_relative "dodopayments/models/addon_update_images_response"
+require_relative "dodopayments/models/addon_update_params"
 require_relative "dodopayments/models/attach_existing_customer"
 require_relative "dodopayments/models/billing_address"
 require_relative "dodopayments/models/country_code"
 require_relative "dodopayments/models/create_new_customer"
+require_relative "dodopayments/models/currency"
 require_relative "dodopayments/models/customer"
 require_relative "dodopayments/models/customer_create_params"
 require_relative "dodopayments/models/customer_limited_details"
@@ -122,13 +131,16 @@ 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"
+require_relative "dodopayments/models/subscription_list_response"
 require_relative "dodopayments/models/subscription_retrieve_params"
 require_relative "dodopayments/models/subscription_status"
 require_relative "dodopayments/models/subscription_update_params"
+require_relative "dodopayments/models/tax_category"
 require_relative "dodopayments/models/time_interval"
 require_relative "dodopayments/models/webhook_event"
 require_relative "dodopayments/models/webhook_event_list_params"
 require_relative "dodopayments/models/webhook_event_retrieve_params"
+require_relative "dodopayments/resources/addons"
 require_relative "dodopayments/resources/customers"
 require_relative "dodopayments/resources/customers/customer_portal"
 require_relative "dodopayments/resources/discounts"

data/rbi/dodopayments/client.rbi

@@ -16,9 +16,8 @@ module Dodopayments
         T::Hash[Symbol, String]
       )
 
-    # Bearer Token for API authentication
     sig { returns(String) }
-    attr_reader :bearer_token
+    attr_reader :api_key
 
     sig { returns(Dodopayments::Resources::Payments) }
     attr_reader :payments
@@ -62,6 +61,9 @@ module Dodopayments
     sig { returns(Dodopayments::Resources::Discounts) }
     attr_reader :discounts
 
+    sig { returns(Dodopayments::Resources::Addons) }
+    attr_reader :addons
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers; end
@@ -69,7 +71,7 @@ module Dodopayments
     # Creates and returns a new client for interacting with the API.
     sig do
       params(
-        bearer_token: T.nilable(String),
+        api_key: T.nilable(String),
         environment: NilClass,
         base_url: T.nilable(String),
         max_retries: Integer,
@@ -80,8 +82,8 @@ 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"],
+      # Defaults to `ENV["DODO_PAYMENTS_API_KEY"]`
+      api_key: ENV["DODO_PAYMENTS_API_KEY"],
       # Specifies the environment to use for the API.
       #
       # Each environment maps to a different base URL:

data/rbi/dodopayments/errors.rbi

@@ -137,7 +137,7 @@ module Dodopayments
     end
 
     class InternalServerError < Dodopayments::Errors::APIStatusError
-      HTTP_STATUS = T.let((500..), T::Range[Integer])
+      HTTP_STATUS = T.let(500.., T::Range[Integer])
     end
   end
 end

data/rbi/dodopayments/models/addon_cart_response_item.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class AddonCartResponseItem < Dodopayments::Internal::Type::BaseModel
+      sig { returns(String) }
+      attr_accessor :addon_id
+
+      sig { returns(Integer) }
+      attr_accessor :quantity
+
+      # Response struct representing subscription details
+      sig { params(addon_id: String, quantity: Integer).returns(T.attached_class) }
+      def self.new(addon_id:, quantity:); end
+
+      sig { override.returns({addon_id: String, quantity: Integer}) }
+      def to_hash; end
+    end
+  end
+end

data/rbi/dodopayments/models/addon_create_params.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class AddonCreateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      sig { returns(Dodopayments::Models::Currency::OrSymbol) }
+      attr_accessor :currency
+
+      # Name of the Addon
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Amount of the addon
+      sig { returns(Integer) }
+      attr_accessor :price
+
+      # Represents the different categories of taxation applicable to various products
+      # and services.
+      sig { returns(Dodopayments::Models::TaxCategory::OrSymbol) }
+      attr_accessor :tax_category
+
+      # Optional description of the Addon
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      sig do
+        params(
+          currency: Dodopayments::Models::Currency::OrSymbol,
+          name: String,
+          price: Integer,
+          tax_category: Dodopayments::Models::TaxCategory::OrSymbol,
+          description: T.nilable(String),
+          request_options: T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        currency:,
+        # Name of the Addon
+        name:,
+        # Amount of the addon
+        price:,
+        # Represents the different categories of taxation applicable to various products
+        # and services.
+        tax_category:,
+        # Optional description of the Addon
+        description: nil,
+        request_options: {}
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              currency: Dodopayments::Models::Currency::OrSymbol,
+              name: String,
+              price: Integer,
+              tax_category: Dodopayments::Models::TaxCategory::OrSymbol,
+              description: T.nilable(String),
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+      end
+      def to_hash; end
+    end
+  end
+end

data/rbi/dodopayments/models/addon_list_params.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class AddonListParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # Page number default is 0
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :page_number
+
+      # Page size default is 10 max is 100
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :page_size
+
+      sig do
+        params(
+          page_number: T.nilable(Integer),
+          page_size: T.nilable(Integer),
+          request_options: T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # Page number default is 0
+        page_number: nil,
+        # Page size default is 10 max is 100
+        page_size: nil,
+        request_options: {}
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              page_number: T.nilable(Integer),
+              page_size: T.nilable(Integer),
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+      end
+      def to_hash; end
+    end
+  end
+end

data/rbi/dodopayments/models/addon_response.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class AddonResponse < Dodopayments::Internal::Type::BaseModel
+      # id of the Addon
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Unique identifier for the business to which the addon belongs.
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      # Created time
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(Dodopayments::Models::Currency::TaggedSymbol) }
+      attr_accessor :currency
+
+      # Name of the Addon
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Amount of the addon
+      sig { returns(Integer) }
+      attr_accessor :price
+
+      # Represents the different categories of taxation applicable to various products
+      # and services.
+      sig { returns(Dodopayments::Models::TaxCategory::TaggedSymbol) }
+      attr_accessor :tax_category
+
+      # Updated time
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Optional description of the Addon
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Image of the Addon
+      sig { returns(T.nilable(String)) }
+      attr_accessor :image
+
+      sig do
+        params(
+          id: String,
+          business_id: String,
+          created_at: Time,
+          currency: Dodopayments::Models::Currency::OrSymbol,
+          name: String,
+          price: Integer,
+          tax_category: Dodopayments::Models::TaxCategory::OrSymbol,
+          updated_at: Time,
+          description: T.nilable(String),
+          image: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # id of the Addon
+        id:,
+        # Unique identifier for the business to which the addon belongs.
+        business_id:,
+        # Created time
+        created_at:,
+        currency:,
+        # Name of the Addon
+        name:,
+        # Amount of the addon
+        price:,
+        # Represents the different categories of taxation applicable to various products
+        # and services.
+        tax_category:,
+        # Updated time
+        updated_at:,
+        # Optional description of the Addon
+        description: nil,
+        # Image of the Addon
+        image: nil
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              id: String,
+              business_id: String,
+              created_at: Time,
+              currency: Dodopayments::Models::Currency::TaggedSymbol,
+              name: String,
+              price: Integer,
+              tax_category: Dodopayments::Models::TaxCategory::TaggedSymbol,
+              updated_at: Time,
+              description: T.nilable(String),
+              image: T.nilable(String)
+            }
+          )
+      end
+      def to_hash; end
+    end
+  end
+end

data/rbi/dodopayments/models/addon_retrieve_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class AddonRetrieveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      sig do
+        params(request_options: T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash))
+          .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/dodopayments/models/addon_update_images_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class AddonUpdateImagesParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      sig do
+        params(request_options: T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash))
+          .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/dodopayments/models/addon_update_images_response.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class AddonUpdateImagesResponse < Dodopayments::Internal::Type::BaseModel
+      sig { returns(String) }
+      attr_accessor :image_id
+
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig { params(image_id: String, url: String).returns(T.attached_class) }
+      def self.new(image_id:, url:); end
+
+      sig { override.returns({image_id: String, url: String}) }
+      def to_hash; end
+    end
+  end
+end