dodopayments 2.34.0 → 2.36.0

data/lib/dodopayments/models/product_retrieve_params.rb

@@ -12,8 +12,25 @@ module Dodopayments
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute locale
+      #   Shows the translated name, description and unit of the catalog entities in this
+      #   locale. The value must be a code from `GET /locales`, for example `fr`. A field
+      #   with no translation, an unknown code, or no code shows the base text.
+      #
+      #   Do not send a text from a localized response back in a create or update request.
+      #   The base text then changes to the translated text.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
+      # @!method initialize(id:, locale: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ProductRetrieveParams} for more details.
+      #
       #   @param id [String]
+      #
+      #   @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/products/translation.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Products
+      # @see Dodopayments::Resources::Products::Translations#update
+      class Translation < Dodopayments::Internal::Type::BaseModel
+        # @!attribute locale
+        #   The locale of the translation.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!attribute updated_at
+        #   The time of the last change.
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute description
+        #   The translated description. `null` shows that the description has no
+        #   translation.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute name
+        #   The translated name. `null` shows that the name has no translation.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(locale:, updated_at:, description: nil, name: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Products::Translation} for more details.
+        #
+        #   The translation of a product, an add-on, a product collection or a meter in one
+        #   locale.
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] The locale of the translation.
+        #
+        #   @param updated_at [Time] The time of the last change.
+        #
+        #   @param description [String, nil] The translated description. `null` shows that the description has no translation
+        #
+        #   @param name [String, nil] The translated name. `null` shows that the name has no translation.
+      end
+    end
+  end
+end

data/lib/dodopayments/models/products/translation_delete_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Products
+      # @see Dodopayments::Resources::Products::Translations#delete
+      class TranslationDeleteParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   A locale that the checkout and the customer portal can show.
+        #
+        #   The codes are a copy of the checkout locales. `GET /locales` lists them.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!method initialize(id:, locale:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Products::TranslationDeleteParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/products/translation_list_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Products
+      # @see Dodopayments::Resources::Products::Translations#list
+      class TranslationListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+        #   the response has all the locales.
+        #
+        #   @return [Array<String>, nil]
+        optional :locale, Dodopayments::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(id:, locale: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Products::TranslationListParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @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}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/products/translation_update_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Products
+      # @see Dodopayments::Resources::Products::Translations#update
+      class TranslationUpdateParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   A locale that the checkout and the customer portal can show.
+        #
+        #   The codes are a copy of the checkout locales. `GET /locales` lists them.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!attribute description
+        #   The translated description.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute name
+        #   The translated name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(id:, locale:, description: nil, name: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Products::TranslationUpdateParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        #   @param description [String, nil] The translated description.
+        #
+        #   @param name [String, nil] The translated name.
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/products/translations_list_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Products
+      # @see Dodopayments::Resources::Products::Translations#list
+      class TranslationsListResponse < Dodopayments::Internal::Type::BaseModel
+        # @!attribute items
+        #
+        #   @return [Array<Dodopayments::Models::Products::Translation>]
+        required :items, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Products::Translation] }
+
+        # @!method initialize(items:)
+        #   The translations of a product, an add-on, a product collection or a meter.
+        #
+        #   @param items [Array<Dodopayments::Models::Products::Translation>]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/refund_create_params.rb

@@ -13,6 +13,13 @@ module Dodopayments
       #   @return [String]
       required :payment_id, String
 
+      # @!attribute currency
+      #   The currency of every `items[].amount`. It must be the currency the customer
+      #   paid in. Without it, the amounts are in the settlement currency.
+      #
+      #   @return [Symbol, Dodopayments::Models::Currency, nil]
+      optional :currency, enum: -> { Dodopayments::Currency }, nil?: true
+
       # @!attribute items
       #   Partially Refund an Individual Item
       #
@@ -33,9 +40,14 @@ module Dodopayments
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!method initialize(payment_id:, items: nil, metadata: nil, reason: nil, request_options: {})
+      # @!method initialize(payment_id:, currency: nil, items: nil, metadata: nil, reason: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::RefundCreateParams} for more details.
+      #
       #   @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/models/subscription_list_params.rb

@@ -37,6 +37,17 @@ module Dodopayments
       #   @return [String, nil]
       optional :customer_id, String
 
+      # @!attribute locale
+      #   Shows the translated name, description and unit of the catalog entities in this
+      #   locale. The value must be a code from `GET /locales`, for example `fr`. A field
+      #   with no translation, an unknown code, or no code shows the base text.
+      #
+      #   Do not send a text from a localized response back in a create or update request.
+      #   The base text then changes to the translated text.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
       # @!attribute page_number
       #   Page number default is 0
       #
@@ -61,7 +72,7 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::SubscriptionListParams::Status, nil]
       optional :status, enum: -> { Dodopayments::SubscriptionListParams::Status }
 
-      # @!method initialize(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: {})
+      # @!method initialize(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: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::SubscriptionListParams} for more details.
       #
@@ -75,6 +86,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/models/subscription_retrieve_params.rb

@@ -12,8 +12,25 @@ module Dodopayments
       #   @return [String]
       required :subscription_id, String
 
-      # @!method initialize(subscription_id:, request_options: {})
+      # @!attribute locale
+      #   Shows the translated name, description and unit of the catalog entities in this
+      #   locale. The value must be a code from `GET /locales`, for example `fr`. A field
+      #   with no translation, an unknown code, or no code shows the base text.
+      #
+      #   Do not send a text from a localized response back in a create or update request.
+      #   The base text then changes to the translated text.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
+      # @!method initialize(subscription_id:, locale: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionRetrieveParams} for more details.
+      #
       #   @param subscription_id [String]
+      #
+      #   @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/three_ds_flow.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # How the cardholder completed the 3DS authentication.
+    module ThreeDSFlow
+      extend Dodopayments::Internal::Type::Enum
+
+      CHALLENGE = :challenge
+      FRICTIONLESS = :frictionless
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/dodopayments/models/three_ds_status.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # The result of the 3DS authentication of a card payment, as the processor reports
+    # it.
+    module ThreeDSStatus
+      extend Dodopayments::Internal::Type::Enum
+
+      AUTHENTICATED = :authenticated
+      ATTEMPT_ACKNOWLEDGED = :attempt_acknowledged
+      EXEMPTED = :exempted
+      FAILED = :failed
+      NOT_SUPPORTED = :not_supported
+      PROCESSING_ERROR = :processing_error
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/dodopayments/models/update_subscription_plan_req.rb

@@ -126,6 +126,11 @@ module Dodopayments
       #   - `apply_change` (default): Apply plan change immediately regardless of payment
       #     outcome
       #
+      #   With `effective_at: next_billing_date`, the plan change payment replaces the
+      #   renewal payment. If that payment fails with `prevent_change`, the plan change is
+      #   cancelled. The subscription then renews on the current plan, with the usual
+      #   payment retries.
+      #
       #   If not specified, uses the business-level default setting.
       #
       #   @return [Symbol, Dodopayments::Models::UpdateSubscriptionPlanReq::OnPaymentFailure, nil]
@@ -218,6 +223,11 @@ module Dodopayments
       # - `apply_change` (default): Apply plan change immediately regardless of payment
       #   outcome
       #
+      # With `effective_at: next_billing_date`, the plan change payment replaces the
+      # renewal payment. If that payment fails with `prevent_change`, the plan change is
+      # cancelled. The subscription then renews on the current plan, with the usual
+      # payment retries.
+      #
       # If not specified, uses the business-level default setting.
       #
       # @see Dodopayments::Models::UpdateSubscriptionPlanReq#on_payment_failure

data/lib/dodopayments/models.rb

@@ -49,12 +49,18 @@ module Dodopayments
 
   AddonCreateParams = Dodopayments::Models::AddonCreateParams
 
+  AddonDeleteParams = Dodopayments::Models::AddonDeleteParams
+
   AddonListParams = Dodopayments::Models::AddonListParams
 
   AddonResponse = Dodopayments::Models::AddonResponse
 
   AddonRetrieveParams = Dodopayments::Models::AddonRetrieveParams
 
+  Addons = Dodopayments::Models::Addons
+
+  AddonUnarchiveParams = Dodopayments::Models::AddonUnarchiveParams
+
   AddonUpdateImagesParams = Dodopayments::Models::AddonUpdateImagesParams
 
   AddonUpdateParams = Dodopayments::Models::AddonUpdateParams
@@ -321,6 +327,10 @@ module Dodopayments
 
   LicenseValidateParams = Dodopayments::Models::LicenseValidateParams
 
+  Locale = Dodopayments::Models::Locale
+
+  LocaleInfo = Dodopayments::Models::LocaleInfo
+
   ManualRetry = Dodopayments::Models::ManualRetry
 
   ManualRetryState = Dodopayments::Models::ManualRetryState
@@ -348,8 +358,14 @@ module Dodopayments
 
   MeterRetrieveParams = Dodopayments::Models::MeterRetrieveParams
 
+  Meters = Dodopayments::Models::Meters
+
   MeterUnarchiveParams = Dodopayments::Models::MeterUnarchiveParams
 
+  MeterUpdateParams = Dodopayments::Models::MeterUpdateParams
+
+  MiscListLocalesParams = Dodopayments::Models::MiscListLocalesParams
+
   MiscListSupportedCountriesParams = Dodopayments::Models::MiscListSupportedCountriesParams
 
   ModerationCategory = Dodopayments::Models::ModerationCategory
@@ -537,6 +553,10 @@ module Dodopayments
 
   ThemeModeConfig = Dodopayments::Models::ThemeModeConfig
 
+  ThreeDSFlow = Dodopayments::Models::ThreeDSFlow
+
+  ThreeDSStatus = Dodopayments::Models::ThreeDSStatus
+
   TimeInterval = Dodopayments::Models::TimeInterval
 
   UnsafeUnwrapWebhookEvent = Dodopayments::Models::UnsafeUnwrapWebhookEvent

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

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

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class Addons
+      # @return [Dodopayments::Resources::Addons::Translations]
+      attr_reader :translations
+
       # @overload create(currency:, name:, price:, tax_category:, description: nil, request_options: {})
       #
       # @param currency [Symbol, Dodopayments::Models::Currency] The currency of the Addon
@@ -31,21 +34,29 @@ module Dodopayments
         )
       end
 
-      # @overload retrieve(id, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::AddonRetrieveParams} for more details.
+      #
+      # @overload retrieve(id, locale: nil, request_options: {})
       #
       # @param id [String] Addon 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::AddonResponse]
       #
       # @see Dodopayments::Models::AddonRetrieveParams
       def retrieve(id, params = {})
+        parsed, options = Dodopayments::AddonRetrieveParams.dump_request(params)
+        query = Dodopayments::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["addons/%1$s", id],
+          query: query,
           model: Dodopayments::AddonResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -84,7 +95,14 @@ module Dodopayments
         )
       end
 
-      # @overload list(page_number: nil, page_size: nil, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::AddonListParams} for more details.
+      #
+      # @overload list(archived: nil, locale: nil, page_number: nil, page_size: nil, request_options: {})
+      #
+      # @param archived [Boolean] List archived addons. The default is false.
+      #
+      # @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
       #
@@ -108,6 +126,42 @@ module Dodopayments
         )
       end
 
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] Addon Id
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Dodopayments::Models::AddonDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["addons/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # @overload unarchive(id, request_options: {})
+      #
+      # @param id [String] Addon Id
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Dodopayments::Models::AddonUnarchiveParams
+      def unarchive(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["addons/%1$s/unarchive", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
       # @overload update_images(id, request_options: {})
       #
       # @param id [String] Addon Id
@@ -131,6 +185,7 @@ module Dodopayments
       # @param client [Dodopayments::Client]
       def initialize(client:)
         @client = client
+        @translations = Dodopayments::Resources::Addons::Translations.new(client: client)
       end
     end
   end