dodopayments 2.34.0 → 2.36.0

data/lib/dodopayments/resources/meters.rb

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class Meters
+      # @return [Dodopayments::Resources::Meters::Translations]
+      attr_reader :translations
+
       # @overload create(aggregation:, event_name:, measurement_unit:, name:, description: nil, filter: nil, request_options: {})
       #
       # @param aggregation [Dodopayments::Models::MeterAggregation] Aggregation configuration for the meter
@@ -33,28 +36,70 @@ module Dodopayments
         )
       end
 
-      # @overload retrieve(id, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::MeterRetrieveParams} for more details.
+      #
+      # @overload retrieve(id, locale: nil, request_options: {})
       #
       # @param id [String] Meter ID
       #
+      # @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Meter]
       #
       # @see Dodopayments::Models::MeterRetrieveParams
       def retrieve(id, params = {})
+        parsed, options = Dodopayments::MeterRetrieveParams.dump_request(params)
+        query = Dodopayments::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["meters/%1$s", id],
+          query: query,
           model: Dodopayments::Meter,
-          options: params[:request_options]
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::MeterUpdateParams} for more details.
+      #
+      # @overload update(id, description: nil, measurement_unit: nil, name: nil, request_options: {})
+      #
+      # @param id [String] Meter ID
+      #
+      # @param description [String, nil] Description of the meter. Send `null` to remove the description. Omit it to keep
+      #
+      # @param measurement_unit [String, nil] Measurement unit
+      #
+      # @param name [String, nil] Name of the meter
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::Meter]
+      #
+      # @see Dodopayments::Models::MeterUpdateParams
+      def update(id, params = {})
+        parsed, options = Dodopayments::MeterUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["meters/%1$s", id],
+          body: parsed,
+          model: Dodopayments::Meter,
+          options: options
         )
       end
 
-      # @overload list(archived: nil, page_number: nil, page_size: nil, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::MeterListParams} for more details.
+      #
+      # @overload list(archived: nil, locale: nil, page_number: nil, page_size: nil, request_options: {})
       #
       # @param archived [Boolean] List archived meters
       #
+      # @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       # @param page_number [Integer] Page number default is 0
       #
       # @param page_size [Integer] Page size default is 10 max is 100
@@ -118,6 +163,7 @@ module Dodopayments
       # @param client [Dodopayments::Client]
       def initialize(client:)
         @client = client
+        @translations = Dodopayments::Resources::Meters::Translations.new(client: client)
       end
     end
   end

data/lib/dodopayments/resources/misc.rb

@@ -3,6 +3,24 @@
 module Dodopayments
   module Resources
     class Misc
+      # Lists the locales that a translation can have.
+      #
+      # @overload list_locales(request_options: {})
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<Dodopayments::Models::LocaleInfo>]
+      #
+      # @see Dodopayments::Models::MiscListLocalesParams
+      def list_locales(params = {})
+        @client.request(
+          method: :get,
+          path: "locales",
+          model: Dodopayments::Internal::Type::ArrayOf[Dodopayments::LocaleInfo],
+          options: params[:request_options]
+        )
+      end
+
       # @overload list_supported_countries(request_options: {})
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/dodopayments/resources/payments.rb

@@ -125,21 +125,29 @@ module Dodopayments
         )
       end
 
-      # @overload retrieve_line_items(payment_id, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::PaymentRetrieveLineItemsParams} for more details.
+      #
+      # @overload retrieve_line_items(payment_id, currency: nil, request_options: {})
       #
       # @param payment_id [String] Payment Id
       #
+      # @param currency [Symbol, Dodopayments::Models::Currency] The currency of the amounts. It must be the currency that the customer paid in.
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::PaymentRetrieveLineItemsResponse]
       #
       # @see Dodopayments::Models::PaymentRetrieveLineItemsParams
       def retrieve_line_items(payment_id, params = {})
+        parsed, options = Dodopayments::PaymentRetrieveLineItemsParams.dump_request(params)
+        query = Dodopayments::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["payments/%1$s/line-items", payment_id],
+          query: query,
           model: Dodopayments::Models::PaymentRetrieveLineItemsResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 

data/lib/dodopayments/resources/payouts/breakup/details.rb

@@ -8,7 +8,9 @@ module Dodopayments
           # Returns paginated individual balance ledger entries for a payout. Each entry is
           # converted into the payout's currency at the rate the payout settled at. Supports
           # pagination via `page_size` (default 10, max 100) and `page_number` (default 0)
-          # query parameters.
+          # query parameters. A settlement batch payout shows its rows in native amounts.
+          # `unattributed` is the payout amount less the sum of its rows in the payout
+          # currency.
           #
           # @overload list(payout_id, page_number: nil, page_size: nil, request_options: {})
           #
@@ -39,7 +41,8 @@ module Dodopayments
           # Downloads the complete payout breakup as a CSV file. Each row represents a
           # balance ledger entry with columns: Ledger ID, Event Type, Original Amount,
           # Original Currency, Reference Object ID, Description, Created At, USD Equivalent
-          # Amount, and Payout Currency Amount.
+          # Amount, and Payout Currency Amount. A settlement batch payout shows its rows in
+          # native amounts.
           #
           # @overload download_csv(payout_id, request_options: {})
           #

data/lib/dodopayments/resources/payouts/breakup.rb

@@ -10,7 +10,10 @@ module Dodopayments
         # Returns the breakdown of a payout by event type (payments, refunds, disputes,
         # fees, etc.) in the payout's currency. Each amount is proportionally allocated
         # based on USD equivalent values, ensuring the total sums exactly to the payout
-        # amount.
+        # amount. A settlement batch payout shows its rows in native amounts. The
+        # `carried_over` line holds the opening balance from the switch to settlement
+        # batches and the rows dated before that opening balance. The `unattributed` line
+        # shows the payout amount that the rows do not account for.
         #
         # @overload retrieve(payout_id, request_options: {})
         #

data/lib/dodopayments/resources/product_collections/translations.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class ProductCollections
+      class Translations
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::ProductCollections::TranslationUpdateParams} for more
+        # details.
+        #
+        # Creates or replaces the translation of one locale. The response is 201 for a new
+        # locale and 200 for a replaced locale.
+        #
+        # @overload update(locale, id:, description: nil, name: nil, request_options: {})
+        #
+        # @param locale [Symbol, Dodopayments::Models::Locale] Path param: A locale that the checkout and the customer portal can show.
+        #
+        # @param id [String] Path param: Product Collection Id
+        #
+        # @param description [String, nil] Body param: The translated description.
+        #
+        # @param name [String, nil] Body param: The translated name.
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Dodopayments::Models::Products::Translation]
+        #
+        # @see Dodopayments::Models::ProductCollections::TranslationUpdateParams
+        def update(locale, params)
+          parsed, options = Dodopayments::ProductCollections::TranslationUpdateParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["product-collections/%1$s/translations/%2$s", id, locale],
+            body: parsed,
+            model: Dodopayments::Products::Translation,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::ProductCollections::TranslationListParams} for more
+        # details.
+        #
+        # Lists the translations, for all the locales or for the locales of the filter.
+        #
+        # @overload list(id, locale: nil, request_options: {})
+        #
+        # @param id [String] Product Collection Id
+        #
+        # @param locale [Array<String>] Returns only these locales, for example `?locale=fr&locale=de`. With no value, t
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Dodopayments::Models::Products::TranslationsListResponse]
+        #
+        # @see Dodopayments::Models::ProductCollections::TranslationListParams
+        def list(id, params = {})
+          parsed, options = Dodopayments::ProductCollections::TranslationListParams.dump_request(params)
+          query = Dodopayments::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["product-collections/%1$s/translations", id],
+            query: query,
+            model: Dodopayments::Products::TranslationsListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::ProductCollections::TranslationDeleteParams} for more
+        # details.
+        #
+        # Deletes the translation of one locale.
+        #
+        # @overload delete(locale, id:, request_options: {})
+        #
+        # @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        # @param id [String] Product Collection Id
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Dodopayments::Models::ProductCollections::TranslationDeleteParams
+        def delete(locale, params)
+          parsed, options = Dodopayments::ProductCollections::TranslationDeleteParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["product-collections/%1$s/translations/%2$s", id, locale],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Dodopayments::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/product_collections.rb

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class ProductCollections
+      # @return [Dodopayments::Resources::ProductCollections::Translations]
+      attr_reader :translations
+
       # @return [Dodopayments::Resources::ProductCollections::Groups]
       attr_reader :groups
 
@@ -45,21 +48,29 @@ module Dodopayments
         )
       end
 
-      # @overload retrieve(id, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::ProductCollectionRetrieveParams} for more details.
+      #
+      # @overload retrieve(id, locale: nil, request_options: {})
       #
       # @param id [String] Product Collection Id
       #
+      # @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::ProductCollection]
       #
       # @see Dodopayments::Models::ProductCollectionRetrieveParams
       def retrieve(id, params = {})
+        parsed, options = Dodopayments::ProductCollectionRetrieveParams.dump_request(params)
+        query = Dodopayments::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["product-collections/%1$s", id],
+          query: query,
           model: Dodopayments::ProductCollection,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -106,12 +117,17 @@ module Dodopayments
         )
       end
 
-      # @overload list(archived: nil, brand_id: nil, page_number: nil, page_size: nil, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::ProductCollectionListParams} for more details.
+      #
+      # @overload list(archived: nil, brand_id: nil, locale: nil, page_number: nil, page_size: nil, request_options: {})
       #
       # @param archived [Boolean] List archived collections
       #
       # @param brand_id [String] Filter by Brand id
       #
+      # @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       # @param page_number [Integer] Page number default is 0
       #
       # @param page_size [Integer] Page size default is 10 max is 100
@@ -198,6 +214,7 @@ module Dodopayments
       # @param client [Dodopayments::Client]
       def initialize(client:)
         @client = client
+        @translations = Dodopayments::Resources::ProductCollections::Translations.new(client: client)
         @groups = Dodopayments::Resources::ProductCollections::Groups.new(client: client)
       end
     end

data/lib/dodopayments/resources/products/translations.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Products
+      class Translations
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::Products::TranslationUpdateParams} for more details.
+        #
+        # Creates or replaces the translation of one locale. The response is 201 for a new
+        # locale and 200 for a replaced locale.
+        #
+        # @overload update(locale, id:, description: nil, name: nil, request_options: {})
+        #
+        # @param locale [Symbol, Dodopayments::Models::Locale] Path param: A locale that the checkout and the customer portal can show.
+        #
+        # @param id [String] Path param: Product Id
+        #
+        # @param description [String, nil] Body param: The translated description.
+        #
+        # @param name [String, nil] Body param: The translated name.
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Dodopayments::Models::Products::Translation]
+        #
+        # @see Dodopayments::Models::Products::TranslationUpdateParams
+        def update(locale, params)
+          parsed, options = Dodopayments::Products::TranslationUpdateParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["products/%1$s/translations/%2$s", id, locale],
+            body: parsed,
+            model: Dodopayments::Products::Translation,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::Products::TranslationListParams} for more details.
+        #
+        # Lists the translations, for all the locales or for the locales of the filter.
+        #
+        # @overload list(id, locale: nil, request_options: {})
+        #
+        # @param id [String] Product Id
+        #
+        # @param locale [Array<String>] Returns only these locales, for example `?locale=fr&locale=de`. With no value, t
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Dodopayments::Models::Products::TranslationsListResponse]
+        #
+        # @see Dodopayments::Models::Products::TranslationListParams
+        def list(id, params = {})
+          parsed, options = Dodopayments::Products::TranslationListParams.dump_request(params)
+          query = Dodopayments::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["products/%1$s/translations", id],
+            query: query,
+            model: Dodopayments::Products::TranslationsListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::Products::TranslationDeleteParams} for more details.
+        #
+        # Deletes the translation of one locale.
+        #
+        # @overload delete(locale, id:, request_options: {})
+        #
+        # @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        # @param id [String] Product Id
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Dodopayments::Models::Products::TranslationDeleteParams
+        def delete(locale, params)
+          parsed, options = Dodopayments::Products::TranslationDeleteParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["products/%1$s/translations/%2$s", id, locale],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Dodopayments::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/products.rb

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class Products
+      # @return [Dodopayments::Resources::Products::Translations]
+      attr_reader :translations
+
       # @return [Dodopayments::Resources::Products::Images]
       attr_reader :images
 
@@ -63,21 +66,29 @@ module Dodopayments
         )
       end
 
-      # @overload retrieve(id, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::ProductRetrieveParams} for more details.
+      #
+      # @overload retrieve(id, locale: nil, request_options: {})
       #
       # @param id [String] Product Id
       #
+      # @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Product]
       #
       # @see Dodopayments::Models::ProductRetrieveParams
       def retrieve(id, params = {})
+        parsed, options = Dodopayments::ProductRetrieveParams.dump_request(params)
+        query = Dodopayments::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["products/%1$s", id],
+          query: query,
           model: Dodopayments::Product,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -139,12 +150,14 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::ProductListParams} for more details.
       #
-      # @overload list(archived: nil, brand_id: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {})
+      # @overload list(archived: nil, brand_id: nil, locale: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {})
       #
       # @param archived [Boolean] List archived products
       #
       # @param brand_id [String] filter by Brand id
       #
+      # @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       # @param page_number [Integer] Page number default is 0
       #
       # @param page_size [Integer] Page size default is 10 max is 100
@@ -232,6 +245,7 @@ module Dodopayments
       # @param client [Dodopayments::Client]
       def initialize(client:)
         @client = client
+        @translations = Dodopayments::Resources::Products::Translations.new(client: client)
         @images = Dodopayments::Resources::Products::Images.new(client: client)
         @short_links = Dodopayments::Resources::Products::ShortLinks.new(client: client)
         @localized_prices = Dodopayments::Resources::Products::LocalizedPrices.new(client: client)

data/lib/dodopayments/resources/refunds.rb

@@ -3,10 +3,15 @@
 module Dodopayments
   module Resources
     class Refunds
-      # @overload create(payment_id:, items: nil, metadata: nil, reason: nil, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::RefundCreateParams} for more details.
+      #
+      # @overload create(payment_id:, currency: nil, items: nil, metadata: nil, reason: nil, request_options: {})
       #
       # @param payment_id [String] The unique identifier of the payment to be refunded.
       #
+      # @param currency [Symbol, Dodopayments::Models::Currency, nil] The currency of every `items[].amount`. It must be the currency the customer pai
+      #
       # @param items [Array<Dodopayments::Models::RefundCreateParams::Item>, nil] Partially Refund an Individual Item
       #
       # @param metadata [Hash{Symbol=>String, Float, Boolean}] Additional metadata associated with the refund.

data/lib/dodopayments/resources/subscriptions.rb

@@ -74,21 +74,29 @@ module Dodopayments
         )
       end
 
-      # @overload retrieve(subscription_id, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::SubscriptionRetrieveParams} for more details.
+      #
+      # @overload retrieve(subscription_id, locale: nil, request_options: {})
       #
       # @param subscription_id [String] Subscription Id
       #
+      # @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Subscription]
       #
       # @see Dodopayments::Models::SubscriptionRetrieveParams
       def retrieve(subscription_id, params = {})
+        parsed, options = Dodopayments::SubscriptionRetrieveParams.dump_request(params)
+        query = Dodopayments::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["subscriptions/%1$s", subscription_id],
+          query: query,
           model: Dodopayments::Subscription,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -150,7 +158,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::SubscriptionListParams} for more details.
       #
-      # @overload list(brand_id: nil, cancel_at_next_billing_date: nil, created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, request_options: {})
+      # @overload list(brand_id: nil, cancel_at_next_billing_date: nil, created_at_gte: nil, created_at_lte: nil, customer_id: nil, locale: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, request_options: {})
       #
       # @param brand_id [String] filter by Brand id
       #
@@ -162,6 +170,8 @@ module Dodopayments
       #
       # @param customer_id [String] Filter by customer id
       #
+      # @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       # @param page_number [Integer] Page number default is 0
       #
       # @param page_size [Integer] Page size default is 10 max is 100

data/lib/dodopayments/version.rb

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