dodopayments 2.34.0 → 2.36.0

data/lib/dodopayments/workload_identity.rb

@@ -0,0 +1,351 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  # Workload identity federation: exchange a short-lived OIDC token (JWT) from
+  # your platform for a short-lived API access token.
+  #
+  # @example
+  #   client = Dodopayments::Client.new(
+  #     workload_identity: Dodopayments::WorkloadIdentity::Config.new(
+  #       identity_provider_id: "wip_...",
+  #       provider: Dodopayments::WorkloadIdentity.github_actions
+  #     )
+  #   )
+  module WorkloadIdentity
+    # @api private
+    GRANT_TYPE = "urn:ietf:params:oauth:grant-type:token-exchange"
+
+    # @api private
+    SUBJECT_TOKEN_TYPE = "urn:ietf:params:oauth:token-type:jwt"
+
+    # The client refreshes the access token when this many seconds or less remain.
+    REFRESH_WINDOW_IN_SECONDS = 300
+
+    # @api private
+    PROVIDER_TIMEOUT_IN_SECONDS = 10
+
+    # @api private
+    KUBERNETES_TOKEN_PATH = "/var/run/secrets/tokens/dodo-token"
+
+    # @api private
+    GCP_METADATA_URL =
+      "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/identity"
+
+    # The values that a subject token provider gets on each token exchange.
+    class Context
+      # The base URL of the client.
+      # @return [URI::Generic]
+      attr_reader :base_url
+
+      # The default audience: the origin of the client base URL.
+      # @return [String]
+      attr_reader :audience
+
+      # @api private
+      #
+      # @param base_url [URI::Generic]
+      # @param audience [String]
+      def initialize(base_url:, audience:)
+        @base_url = base_url
+        @audience = audience
+      end
+    end
+
+    # The `workload_identity` option of {Dodopayments::Client}.
+    class Config
+      # @return [String]
+      attr_reader :identity_provider_id
+
+      # @return [#call]
+      attr_reader :provider
+
+      # @param provider [#call] Returns the subject token (a JWT string). It can take one
+      # argument, a {Dodopayments::WorkloadIdentity::Context}.
+      #
+      # @param identity_provider_id [String, nil] Defaults to `ENV["DODO_PAYMENTS_IDENTITY_PROVIDER_ID"]`
+      def initialize(provider:, identity_provider_id: ENV["DODO_PAYMENTS_IDENTITY_PROVIDER_ID"])
+        if identity_provider_id.nil? || identity_provider_id.to_s.empty?
+          raise ArgumentError.new(
+            "identity_provider_id is required, and can be set via environ: \"DODO_PAYMENTS_IDENTITY_PROVIDER_ID\""
+          )
+        end
+        unless provider.respond_to?(:call)
+          raise ArgumentError.new("provider must respond to `call`")
+        end
+
+        @identity_provider_id = identity_provider_id.to_s
+        @provider = provider
+      end
+
+      # @api private
+      #
+      # @param value [Dodopayments::WorkloadIdentity::Config, Hash{Symbol=>Object}]
+      #
+      # @return [Dodopayments::WorkloadIdentity::Config]
+      def self.coerce(value)
+        case value
+        in Dodopayments::WorkloadIdentity::Config
+          value
+        in Hash
+          new(**value)
+        else
+          raise ArgumentError.new("workload_identity must be a #{name} or a Hash, got #{value.class}")
+        end
+      end
+
+      # @return [String]
+      def inspect = "#<#{self.class.name} identity_provider_id=#{@identity_provider_id}>"
+    end
+
+    # Caches the access token of one client. All methods are thread-safe.
+    class Session
+      # @return [String]
+      attr_reader :identity_provider_id
+
+      # @api private
+      #
+      # @param config [Dodopayments::WorkloadIdentity::Config]
+      # @param context [Dodopayments::WorkloadIdentity::Context]
+      # @param transport [Proc] Sends a request without the client credentials.
+      def initialize(config:, context:, transport:)
+        @identity_provider_id = config.identity_provider_id
+        @provider = config.provider
+        @context = context
+        @transport = transport
+        @mutex = Mutex.new
+        @access_token = nil
+        @expires_at = nil
+      end
+
+      # Returns a valid access token. This method does a token exchange if no token is
+      # cached, or if 5 minutes or less remain. Concurrent callers share one exchange.
+      #
+      # @raise [Dodopayments::Errors::APIError]
+      # @return [String]
+      def access_token
+        @mutex.synchronize do
+          exchange! unless fresh?
+          @access_token.to_s
+        end
+      end
+
+      # @api private
+      #
+      # Clears the cache, but only if it still holds `token`.
+      #
+      # @param token [String, nil]
+      def invalidate(token = nil)
+        @mutex.synchronize do
+          clear! if token.nil? || token == @access_token
+        end
+        nil
+      end
+
+      # Revokes the cached access token and clears the cache. Does nothing if no token
+      # is cached.
+      #
+      # @raise [Dodopayments::Errors::APIError]
+      def revoke
+        token = @mutex.synchronize { @access_token }
+        return if token.nil?
+
+        begin
+          @transport.call(
+            method: :post,
+            path: "workload-identity/token/revoke",
+            headers: {"authorization" => "Bearer #{token}"},
+            body: nil
+          )
+        ensure
+          invalidate(token)
+        end
+        nil
+      end
+
+      # @return [String]
+      def inspect = "#<#{self.class.name} identity_provider_id=#{@identity_provider_id}>"
+
+      private def fresh?
+        !@access_token.nil? && !@expires_at.nil? && @expires_at - Time.now > REFRESH_WINDOW_IN_SECONDS
+      end
+
+      private def clear!
+        @access_token = nil
+        @expires_at = nil
+      end
+
+      private def subject_token
+        token = @provider.respond_to?(:arity) && @provider.arity.zero? ? @provider.call : @provider.call(@context)
+        if !token.is_a?(String) || token.strip.empty?
+          raise Dodopayments::Errors::Error.new("The workload identity provider did not return a token")
+        end
+        token.strip
+      end
+
+      private def exchange!
+        clear!
+        body = {
+          grant_type: GRANT_TYPE,
+          subject_token_type: SUBJECT_TOKEN_TYPE,
+          subject_token: subject_token,
+          identity_provider_id: @identity_provider_id
+        }
+        now = Time.now
+        response = @transport.call(method: :post, path: "workload-identity/token", headers: {}, body: body)
+        token = response.is_a?(Hash) ? response[:access_token] : nil
+        if !token.is_a?(String) || token.empty?
+          raise Dodopayments::Errors::Error.new("The token exchange response has no access_token")
+        end
+
+        @expires_at = expiry(response, now: now)
+        @access_token = token
+      end
+
+      private def expiry(response, now:)
+        expires_at = response[:expires_at]
+        if expires_at.is_a?(String)
+          begin
+            return Time.iso8601(expires_at)
+          rescue ArgumentError
+            nil
+          end
+        end
+        now + Float(response[:expires_in], exception: false).to_f
+      end
+    end
+
+    class << self
+      # GitHub Actions. The job must have the `id-token: write` permission.
+      #
+      # @param audience [String, nil] Defaults to the origin of the client base URL.
+      #
+      # @return [Proc]
+      def github_actions(audience: nil)
+        lambda do |context|
+          url = env!("ACTIONS_ID_TOKEN_REQUEST_URL")
+          request_token = env!("ACTIONS_ID_TOKEN_REQUEST_TOKEN")
+          separator = url.include?("?") ? "&" : "?"
+          uri = URI("#{url}#{separator}audience=#{CGI.escape(audience || context.audience)}")
+          body = http_get(uri, {"authorization" => "bearer #{request_token}"})
+          JSON.parse(body).fetch("value")
+        end
+      end
+
+      # GitLab CI/CD. Declare the token in `id_tokens` of the job.
+      #
+      # @param env_var [String]
+      #
+      # @return [Proc]
+      def gitlab(env_var: "DODO_PAYMENTS_ID_TOKEN") = ->(_context = nil) { env!(env_var) }
+
+      # HCP Terraform (Terraform Cloud) dynamic credentials.
+      #
+      # @return [Proc]
+      def terraform_cloud
+        lambda do |_context = nil|
+          ENV["TFC_WORKLOAD_IDENTITY_TOKEN"] || env!("TFC_WORKLOAD_IDENTITY_TOKEN_DODO")
+        end
+      end
+
+      # Google Cloud: the metadata server of the attached service account.
+      #
+      # @param audience [String, nil] Defaults to the origin of the client base URL.
+      #
+      # @return [Proc]
+      def gcp(audience: nil)
+        lambda do |context|
+          query = URI.encode_www_form(audience: audience || context.audience, format: "full")
+          http_get(URI("#{GCP_METADATA_URL}?#{query}"), {"metadata-flavor" => "Google"})
+        end
+      end
+
+      # Vercel OIDC federation.
+      #
+      # @return [Proc]
+      def vercel = ->(_context = nil) { env!("VERCEL_OIDC_TOKEN") }
+
+      # Kubernetes: a projected service account token. The file is read on each exchange.
+      #
+      # @param path [String]
+      #
+      # @return [Proc]
+      def kubernetes(path: KUBERNETES_TOKEN_PATH) = file(path: path)
+
+      # A token file. The file is read on each exchange.
+      #
+      # @param path [String, nil] Defaults to `ENV["DODO_PAYMENTS_IDENTITY_TOKEN_FILE"]`
+      #
+      # @return [Proc]
+      def file(path: ENV["DODO_PAYMENTS_IDENTITY_TOKEN_FILE"])
+        if path.nil? || path.empty?
+          raise ArgumentError.new(
+            "path is required, and can be set via environ: \"DODO_PAYMENTS_IDENTITY_TOKEN_FILE\""
+          )
+        end
+        ->(_context = nil) { File.read(path).strip }
+      end
+
+      # AWS: wraps your function that returns the JWT, for example from STS
+      # `GetWebIdentityToken`.
+      #
+      # @param fn [#call, nil]
+      #
+      # @return [Proc]
+      def aws(fn = nil, &blk)
+        callable = fn || blk
+        raise ArgumentError.new("aws requires a function or a block") if callable.nil?
+        ->(_context = nil) { callable.call }
+      end
+
+      # A fixed token. Use it for tests.
+      #
+      # @param token [String]
+      #
+      # @return [Proc]
+      def static(token) = ->(_context = nil) { token }
+
+      # Finds a token source in the environment, in this order: GitHub Actions, HCP
+      # Terraform, `ENV["DODO_PAYMENTS_IDENTITY_TOKEN_FILE"]`, and the Kubernetes path.
+      #
+      # @return [Proc, nil] `nil` if no source is found.
+      def auto
+        if ENV["ACTIONS_ID_TOKEN_REQUEST_URL"] && ENV["ACTIONS_ID_TOKEN_REQUEST_TOKEN"]
+          return github_actions
+        end
+        if ENV["TFC_WORKLOAD_IDENTITY_TOKEN"] || ENV["TFC_WORKLOAD_IDENTITY_TOKEN_DODO"]
+          return terraform_cloud
+        end
+        path = ENV["DODO_PAYMENTS_IDENTITY_TOKEN_FILE"]
+        return file(path: path) unless path.nil? || path.empty?
+        return kubernetes if File.file?(KUBERNETES_TOKEN_PATH)
+        nil
+      end
+
+      private def env!(name)
+        value = ENV[name]
+        if value.nil? || value.empty?
+          raise Dodopayments::Errors::Error.new("The environment variable #{name} is not set")
+        end
+        value
+      end
+
+      private def http_get(uri, headers)
+        response = Net::HTTP.start(
+          uri.host,
+          uri.port,
+          use_ssl: uri.scheme == "https",
+          open_timeout: PROVIDER_TIMEOUT_IN_SECONDS,
+          read_timeout: PROVIDER_TIMEOUT_IN_SECONDS
+        ) do |http|
+          http.get(uri.request_uri, headers)
+        end
+        unless response.is_a?(Net::HTTPSuccess)
+          raise Dodopayments::Errors::Error.new(
+            "The subject token request to #{uri.host} failed with status #{response.code}"
+          )
+        end
+        response.body.to_s
+      end
+    end
+  end
+end

data/lib/dodopayments.rb

@@ -55,6 +55,7 @@ require_relative "dodopayments/internal/transport/pooled_net_requester"
 require_relative "dodopayments/client"
 require_relative "dodopayments/internal/cursor_page_pagination"
 require_relative "dodopayments/internal/default_page_number_pagination"
+require_relative "dodopayments/workload_identity"
 require_relative "dodopayments/models/blocklist/block_by_email"
 require_relative "dodopayments/models/blocklist/block_by_customer_id"
 require_relative "dodopayments/models/blocklist/create_blocked_customer_request"
@@ -74,9 +75,14 @@ require_relative "dodopayments/models/abandoned_checkout_recovered_webhook_event
 require_relative "dodopayments/models/add_meter_to_price"
 require_relative "dodopayments/models/addon_cart_response_item"
 require_relative "dodopayments/models/addon_create_params"
+require_relative "dodopayments/models/addon_delete_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/addons/translation_delete_params"
+require_relative "dodopayments/models/addons/translation_list_params"
+require_relative "dodopayments/models/addons/translation_update_params"
+require_relative "dodopayments/models/addon_unarchive_params"
 require_relative "dodopayments/models/addon_update_images_params"
 require_relative "dodopayments/models/addon_update_images_response"
 require_relative "dodopayments/models/addon_update_params"
@@ -140,8 +146,13 @@ require_relative "dodopayments/models/credit_entitlements/balance_list_grants_re
 require_relative "dodopayments/models/credit_entitlements/balance_list_ledger_params"
 require_relative "dodopayments/models/credit_entitlements/balance_list_params"
 require_relative "dodopayments/models/credit_entitlements/balance_retrieve_params"
+require_relative "dodopayments/models/credit_entitlements/credit_entitlement_translation"
+require_relative "dodopayments/models/credit_entitlements/credit_entitlement_translations_list_response"
 require_relative "dodopayments/models/credit_entitlements/customer_credit_balance"
 require_relative "dodopayments/models/credit_entitlements/ledger_entry_type"
+require_relative "dodopayments/models/credit_entitlements/translation_delete_params"
+require_relative "dodopayments/models/credit_entitlements/translation_list_params"
+require_relative "dodopayments/models/credit_entitlements/translation_update_params"
 require_relative "dodopayments/models/credit_entitlement_undelete_params"
 require_relative "dodopayments/models/credit_entitlement_update_params"
 require_relative "dodopayments/models/credit_expired_webhook_event"
@@ -219,6 +230,8 @@ require_relative "dodopayments/models/entitlement_grant_revoked_webhook_event"
 require_relative "dodopayments/models/entitlement_integration_type"
 require_relative "dodopayments/models/entitlement_list_params"
 require_relative "dodopayments/models/entitlement_retrieve_params"
+require_relative "dodopayments/models/entitlements/entitlement_translation"
+require_relative "dodopayments/models/entitlements/entitlement_translations_list_response"
 require_relative "dodopayments/models/entitlements/file_delete_params"
 require_relative "dodopayments/models/entitlements/file_upload_params"
 require_relative "dodopayments/models/entitlements/file_upload_response"
@@ -226,6 +239,9 @@ require_relative "dodopayments/models/entitlements/grant_fulfill_license_key_par
 require_relative "dodopayments/models/entitlements/grant_list_params"
 require_relative "dodopayments/models/entitlements/grant_revoke_params"
 require_relative "dodopayments/models/entitlements/license_key_grant"
+require_relative "dodopayments/models/entitlements/translation_delete_params"
+require_relative "dodopayments/models/entitlements/translation_list_params"
+require_relative "dodopayments/models/entitlements/translation_update_params"
 require_relative "dodopayments/models/entitlement_update_params"
 require_relative "dodopayments/models/event"
 require_relative "dodopayments/models/event_input"
@@ -256,6 +272,8 @@ require_relative "dodopayments/models/license_key_status"
 require_relative "dodopayments/models/license_key_update_params"
 require_relative "dodopayments/models/license_validate_params"
 require_relative "dodopayments/models/license_validate_response"
+require_relative "dodopayments/models/locale"
+require_relative "dodopayments/models/locale_info"
 require_relative "dodopayments/models/manual_retry"
 require_relative "dodopayments/models/manual_retry_state"
 require_relative "dodopayments/models/metadata"
@@ -268,7 +286,13 @@ require_relative "dodopayments/models/meter_credit_entitlement_cart_response"
 require_relative "dodopayments/models/meter_filter"
 require_relative "dodopayments/models/meter_list_params"
 require_relative "dodopayments/models/meter_retrieve_params"
+require_relative "dodopayments/models/meters/translation_delete_params"
+require_relative "dodopayments/models/meters/translation_list_params"
+require_relative "dodopayments/models/meters/translation_update_params"
 require_relative "dodopayments/models/meter_unarchive_params"
+require_relative "dodopayments/models/meter_update_params"
+require_relative "dodopayments/models/misc_list_locales_params"
+require_relative "dodopayments/models/misc_list_locales_response"
 require_relative "dodopayments/models/misc_list_supported_countries_params"
 require_relative "dodopayments/models/misc_list_supported_countries_response"
 require_relative "dodopayments/models/moderation_category"
@@ -329,6 +353,9 @@ require_relative "dodopayments/models/product_collections/groups/item_update_par
 require_relative "dodopayments/models/product_collections/groups/product_collection_product"
 require_relative "dodopayments/models/product_collections/group_update_params"
 require_relative "dodopayments/models/product_collections/product_collection_group_response"
+require_relative "dodopayments/models/product_collections/translation_delete_params"
+require_relative "dodopayments/models/product_collections/translation_list_params"
+require_relative "dodopayments/models/product_collections/translation_update_params"
 require_relative "dodopayments/models/product_collection_unarchive_params"
 require_relative "dodopayments/models/product_collection_unarchive_response"
 require_relative "dodopayments/models/product_collection_update_images_params"
@@ -354,6 +381,11 @@ require_relative "dodopayments/models/products/short_link_create_params"
 require_relative "dodopayments/models/products/short_link_create_response"
 require_relative "dodopayments/models/products/short_link_list_params"
 require_relative "dodopayments/models/products/short_link_list_response"
+require_relative "dodopayments/models/products/translation"
+require_relative "dodopayments/models/products/translation_delete_params"
+require_relative "dodopayments/models/products/translation_list_params"
+require_relative "dodopayments/models/products/translations_list_response"
+require_relative "dodopayments/models/products/translation_update_params"
 require_relative "dodopayments/models/product_unarchive_params"
 require_relative "dodopayments/models/product_update_files_params"
 require_relative "dodopayments/models/product_update_files_response"
@@ -405,6 +437,8 @@ require_relative "dodopayments/models/subscription_update_payment_method_webhook
 require_relative "dodopayments/models/tax_category"
 require_relative "dodopayments/models/theme_config"
 require_relative "dodopayments/models/theme_mode_config"
+require_relative "dodopayments/models/three_ds_flow"
+require_relative "dodopayments/models/three_ds_status"
 require_relative "dodopayments/models/time_interval"
 require_relative "dodopayments/models/unsafe_unwrap_webhook_event"
 require_relative "dodopayments/models/unwrap_webhook_event"
@@ -429,6 +463,7 @@ require_relative "dodopayments/models/webhook_unwrap_params"
 require_relative "dodopayments/models/webhook_update_params"
 require_relative "dodopayments/models"
 require_relative "dodopayments/resources/addons"
+require_relative "dodopayments/resources/addons/translations"
 require_relative "dodopayments/resources/balances"
 require_relative "dodopayments/resources/blocklist"
 require_relative "dodopayments/resources/blocklist/customers"
@@ -437,6 +472,7 @@ require_relative "dodopayments/resources/brands"
 require_relative "dodopayments/resources/checkout_sessions"
 require_relative "dodopayments/resources/credit_entitlements"
 require_relative "dodopayments/resources/credit_entitlements/balances"
+require_relative "dodopayments/resources/credit_entitlements/translations"
 require_relative "dodopayments/resources/customers"
 require_relative "dodopayments/resources/customers/customer_portal"
 require_relative "dodopayments/resources/customers/emails"
@@ -447,12 +483,14 @@ require_relative "dodopayments/resources/disputes"
 require_relative "dodopayments/resources/entitlements"
 require_relative "dodopayments/resources/entitlements/files"
 require_relative "dodopayments/resources/entitlements/grants"
+require_relative "dodopayments/resources/entitlements/translations"
 require_relative "dodopayments/resources/invoices"
 require_relative "dodopayments/resources/invoices/payments"
 require_relative "dodopayments/resources/license_key_instances"
 require_relative "dodopayments/resources/license_keys"
 require_relative "dodopayments/resources/licenses"
 require_relative "dodopayments/resources/meters"
+require_relative "dodopayments/resources/meters/translations"
 require_relative "dodopayments/resources/misc"
 require_relative "dodopayments/resources/moderation"
 require_relative "dodopayments/resources/payments"
@@ -462,10 +500,12 @@ require_relative "dodopayments/resources/payouts/breakup/details"
 require_relative "dodopayments/resources/product_collections"
 require_relative "dodopayments/resources/product_collections/groups"
 require_relative "dodopayments/resources/product_collections/groups/items"
+require_relative "dodopayments/resources/product_collections/translations"
 require_relative "dodopayments/resources/products"
 require_relative "dodopayments/resources/products/images"
 require_relative "dodopayments/resources/products/localized_prices"
 require_relative "dodopayments/resources/products/short_links"
+require_relative "dodopayments/resources/products/translations"
 require_relative "dodopayments/resources/refunds"
 require_relative "dodopayments/resources/subscriptions"
 require_relative "dodopayments/resources/usage_events"

data/rbi/dodopayments/client.rbi

@@ -20,12 +20,15 @@ module Dodopayments
       )
 
     # Bearer Token for API authentication
-    sig { returns(String) }
+    sig { returns(T.nilable(String)) }
     attr_reader :bearer_token
 
     sig { returns(T.nilable(String)) }
     attr_reader :webhook_key
 
+    sig { returns(T.nilable(Dodopayments::WorkloadIdentity::Session)) }
+    attr_reader :workload_identity
+
     sig { returns(Dodopayments::Resources::CheckoutSessions) }
     attr_reader :checkout_sessions
 
@@ -114,6 +117,13 @@ module Dodopayments
       params(
         bearer_token: T.nilable(String),
         webhook_key: T.nilable(String),
+        workload_identity:
+          T.nilable(
+            T.any(
+              Dodopayments::WorkloadIdentity::Config,
+              T::Hash[Symbol, T.anything]
+            )
+          ),
         environment: T.nilable(T.any(Symbol, String)),
         base_url: T.nilable(String),
         max_retries: Integer,
@@ -124,9 +134,12 @@ module Dodopayments
     end
     def self.new(
       # Bearer Token for API authentication Defaults to `ENV["DODO_PAYMENTS_API_KEY"]`
-      bearer_token: ENV["DODO_PAYMENTS_API_KEY"],
+      bearer_token: nil,
       # Defaults to `ENV["DODO_PAYMENTS_WEBHOOK_KEY"]`
       webhook_key: ENV["DODO_PAYMENTS_WEBHOOK_KEY"],
+      # Exchange an OIDC token for an access token, instead of a bearer token. See
+      # {Dodopayments::WorkloadIdentity}.
+      workload_identity: nil,
       # Specifies the environment to use for the API.
       #
       # Each environment maps to a different base URL:

data/rbi/dodopayments/models/addon_delete_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class AddonDeleteParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::AddonDeleteParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        params(
+          id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { id: String, request_options: Dodopayments::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/addon_list_params.rbi

@@ -11,6 +11,25 @@ module Dodopayments
           T.any(Dodopayments::AddonListParams, Dodopayments::Internal::AnyHash)
         end
 
+      # List archived addons. The default is false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :archived
+
+      sig { params(archived: T::Boolean).void }
+      attr_writer :archived
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :locale
+
+      sig { params(locale: String).void }
+      attr_writer :locale
+
       # Page number default is 0
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_number
@@ -27,12 +46,23 @@ module Dodopayments
 
       sig do
         params(
+          archived: T::Boolean,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # List archived addons. The default is false.
+        archived: nil,
+        # 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.
+        locale: nil,
         # Page number default is 0
         page_number: nil,
         # Page size default is 10 max is 100
@@ -44,6 +74,8 @@ module Dodopayments
       sig do
         override.returns(
           {
+            archived: T::Boolean,
+            locale: String,
             page_number: Integer,
             page_size: Integer,
             request_options: Dodopayments::RequestOptions