dodopayments 2.34.0 → 2.35.0

data/lib/dodopayments/resources/credit_entitlements.rb

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class CreditEntitlements
+      # @return [Dodopayments::Resources::CreditEntitlements::Translations]
+      attr_reader :translations
+
       # @return [Dodopayments::Resources::CreditEntitlements::Balances]
       attr_reader :balances
 
@@ -101,6 +104,9 @@ module Dodopayments
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::CreditEntitlementRetrieveParams} for more details.
+      #
       # Returns the full details of a single credit entitlement including all
       # configuration settings for expiration, rollover, and overage policies.
       #
@@ -126,21 +132,26 @@ module Dodopayments
       # - Deleted entitlements return a 404 error and must be retrieved via the list
       #   endpoint with `deleted=true`
       #
-      # @overload retrieve(id, request_options: {})
+      # @overload retrieve(id, locale: nil, request_options: {})
       #
       # @param id [String] Credit Entitlement 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::CreditEntitlement]
       #
       # @see Dodopayments::Models::CreditEntitlementRetrieveParams
       def retrieve(id, params = {})
+        parsed, options = Dodopayments::CreditEntitlementRetrieveParams.dump_request(params)
+        query = Dodopayments::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["credit-entitlements/%1$s", id],
+          query: query,
           model: Dodopayments::CreditEntitlement,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -249,6 +260,9 @@ module Dodopayments
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::CreditEntitlementListParams} for more details.
+      #
       # Returns a paginated list of credit entitlements, allowing filtering of deleted
       # entitlements. By default, only non-deleted entitlements are returned.
       #
@@ -276,10 +290,12 @@ module Dodopayments
       # - The `deleted` parameter controls visibility of soft-deleted entitlements
       # - Pagination uses offset-based pagination (offset = page_number \* page_size)
       #
-      # @overload list(deleted: nil, page_number: nil, page_size: nil, request_options: {})
+      # @overload list(deleted: nil, locale: nil, page_number: nil, page_size: nil, request_options: {})
       #
       # @param deleted [Boolean] List deleted credit entitlements
       #
+      # @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
@@ -384,6 +400,7 @@ module Dodopayments
       # @param client [Dodopayments::Client]
       def initialize(client:)
         @client = client
+        @translations = Dodopayments::Resources::CreditEntitlements::Translations.new(client: client)
         @balances = Dodopayments::Resources::CreditEntitlements::Balances.new(client: client)
       end
     end

data/lib/dodopayments/resources/customers.rb

@@ -12,7 +12,10 @@ module Dodopayments
       # @return [Dodopayments::Resources::Customers::Emails]
       attr_reader :emails
 
-      # @overload create(email:, name:, metadata: nil, phone_number: nil, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::CustomerCreateParams} for more details.
+      #
+      # @overload create(email:, name:, metadata: nil, phone_number: nil, preferred_locale: nil, request_options: {})
       #
       # @param email [String]
       #
@@ -22,6 +25,8 @@ module Dodopayments
       #
       # @param phone_number [String, nil]
       #
+      # @param preferred_locale [Symbol, Dodopayments::Models::Locale, nil] The language of the customer emails, a code from `GET /locales`. With no value,
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Customer]
@@ -56,7 +61,10 @@ module Dodopayments
         )
       end
 
-      # @overload update(customer_id, email: nil, metadata: nil, name: nil, phone_number: nil, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::CustomerUpdateParams} for more details.
+      #
+      # @overload update(customer_id, email: nil, metadata: nil, name: nil, phone_number: nil, preferred_locale: nil, request_options: {})
       #
       # @param customer_id [String] Customer Id
       #
@@ -68,6 +76,8 @@ module Dodopayments
       #
       # @param phone_number [String, nil]
       #
+      # @param preferred_locale [Symbol, Dodopayments::Models::Locale, nil] The language of the customer emails, a code from `GET /locales`. A value replace
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Customer]

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

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Entitlements
+      class Translations
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::Entitlements::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:, activation_message: nil, description: nil, instructions: 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: Entitlement Id
+        #
+        # @param activation_message [String, nil] Body param: The translated activation message. Only a `license_key` entitlement
+        #
+        # @param description [String, nil] Body param: The translated description.
+        #
+        # @param instructions [String, nil] Body param: The translated delivery instructions. Only a `digital_files` entitle
+        #
+        # @param name [String, nil] Body param: The translated name.
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Dodopayments::Models::Entitlements::EntitlementTranslation]
+        #
+        # @see Dodopayments::Models::Entitlements::TranslationUpdateParams
+        def update(locale, params)
+          parsed, options = Dodopayments::Entitlements::TranslationUpdateParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["entitlements/%1$s/translations/%2$s", id, locale],
+            body: parsed,
+            model: Dodopayments::Entitlements::EntitlementTranslation,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::Entitlements::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] Entitlement 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::Entitlements::EntitlementTranslationsListResponse]
+        #
+        # @see Dodopayments::Models::Entitlements::TranslationListParams
+        def list(id, params = {})
+          parsed, options = Dodopayments::Entitlements::TranslationListParams.dump_request(params)
+          query = Dodopayments::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["entitlements/%1$s/translations", id],
+            query: query,
+            model: Dodopayments::Entitlements::EntitlementTranslationsListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::Entitlements::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] Entitlement Id
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Dodopayments::Models::Entitlements::TranslationDeleteParams
+        def delete(locale, params)
+          parsed, options = Dodopayments::Entitlements::TranslationDeleteParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["entitlements/%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/entitlements.rb

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class Entitlements
+      # @return [Dodopayments::Resources::Entitlements::Translations]
+      attr_reader :translations
+
       # @return [Dodopayments::Resources::Entitlements::Files]
       attr_reader :files
 
@@ -39,23 +42,31 @@ module Dodopayments
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::EntitlementRetrieveParams} for more details.
+      #
       # GET /entitlements/{id}
       #
-      # @overload retrieve(id, request_options: {})
+      # @overload retrieve(id, locale: nil, request_options: {})
       #
       # @param id [String] Entitlement 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::Entitlement]
       #
       # @see Dodopayments::Models::EntitlementRetrieveParams
       def retrieve(id, params = {})
+        parsed, options = Dodopayments::EntitlementRetrieveParams.dump_request(params)
+        query = Dodopayments::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["entitlements/%1$s", id],
+          query: query,
           model: Dodopayments::Entitlement,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -92,12 +103,17 @@ module Dodopayments
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::EntitlementListParams} for more details.
+      #
       # GET /entitlements
       #
-      # @overload list(integration_type: nil, page_number: nil, page_size: nil, request_options: {})
+      # @overload list(integration_type: nil, locale: nil, page_number: nil, page_size: nil, request_options: {})
       #
       # @param integration_type [Symbol, Dodopayments::Models::EntitlementListParams::IntegrationType] Filter by integration type
       #
+      # @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       # @param page_number [Integer] Page number (default 0)
       #
       # @param page_size [Integer] Page size (default 10, max 100)
@@ -145,6 +161,7 @@ module Dodopayments
       # @param client [Dodopayments::Client]
       def initialize(client:)
         @client = client
+        @translations = Dodopayments::Resources::Entitlements::Translations.new(client: client)
         @files = Dodopayments::Resources::Entitlements::Files.new(client: client)
         @grants = Dodopayments::Resources::Entitlements::Grants.new(client: client)
       end

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

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Meters
+      class Translations
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::Meters::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: Meter 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::Meters::TranslationUpdateParams
+        def update(locale, params)
+          parsed, options = Dodopayments::Meters::TranslationUpdateParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["meters/%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::Meters::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] Meter 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::Meters::TranslationListParams
+        def list(id, params = {})
+          parsed, options = Dodopayments::Meters::TranslationListParams.dump_request(params)
+          query = Dodopayments::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["meters/%1$s/translations", id],
+            query: query,
+            model: Dodopayments::Products::TranslationsListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Dodopayments::Models::Meters::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] Meter Id
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Dodopayments::Models::Meters::TranslationDeleteParams
+        def delete(locale, params)
+          parsed, options = Dodopayments::Meters::TranslationDeleteParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["meters/%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/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: {})
         #