dodopayments 2.34.0 → 2.36.0

data/rbi/dodopayments/resources/product_collections/translations.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class ProductCollections
+      class Translations
+        # Creates or replaces the translation of one locale. The response is 201 for a new
+        # locale and 200 for a replaced locale.
+        sig do
+          params(
+            locale: Dodopayments::Locale::OrSymbol,
+            id: String,
+            description: T.nilable(String),
+            name: T.nilable(String),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Products::Translation)
+        end
+        def update(
+          # Path param: A locale that the checkout and the customer portal can show.
+          #
+          # The codes are a copy of the checkout locales. `GET /locales` lists them.
+          locale,
+          # Path param: Product Collection Id
+          id:,
+          # Body param: The translated description.
+          description: nil,
+          # Body param: The translated name.
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists the translations, for all the locales or for the locales of the filter.
+        sig do
+          params(
+            id: String,
+            locale: T::Array[String],
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Products::TranslationsListResponse)
+        end
+        def list(
+          # Product Collection Id
+          id,
+          # Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+          # the response has all the locales.
+          locale: nil,
+          request_options: {}
+        )
+        end
+
+        # Deletes the translation of one locale.
+        sig do
+          params(
+            locale: Dodopayments::Locale::OrSymbol,
+            id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # A locale that the checkout and the customer portal can show.
+          #
+          # The codes are a copy of the checkout locales. `GET /locales` lists them.
+          locale,
+          # Product Collection Id
+          id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/product_collections.rbi

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class ProductCollections
+      sig { returns(Dodopayments::Resources::ProductCollections::Translations) }
+      attr_reader :translations
+
       sig { returns(Dodopayments::Resources::ProductCollections::Groups) }
       attr_reader :groups
 
@@ -69,12 +72,20 @@ module Dodopayments
       sig do
         params(
           id: String,
+          locale: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::ProductCollection)
       end
       def retrieve(
         # Product Collection Id
         id,
+        # 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,
         request_options: {}
       )
       end
@@ -146,6 +157,7 @@ module Dodopayments
         params(
           archived: T::Boolean,
           brand_id: String,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Dodopayments::RequestOptions::OrHash
@@ -160,6 +172,13 @@ module Dodopayments
         archived: nil,
         # Filter by Brand id
         brand_id: 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

data/rbi/dodopayments/resources/products/translations.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Products
+      class Translations
+        # Creates or replaces the translation of one locale. The response is 201 for a new
+        # locale and 200 for a replaced locale.
+        sig do
+          params(
+            locale: Dodopayments::Locale::OrSymbol,
+            id: String,
+            description: T.nilable(String),
+            name: T.nilable(String),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Products::Translation)
+        end
+        def update(
+          # Path param: A locale that the checkout and the customer portal can show.
+          #
+          # The codes are a copy of the checkout locales. `GET /locales` lists them.
+          locale,
+          # Path param: Product Id
+          id:,
+          # Body param: The translated description.
+          description: nil,
+          # Body param: The translated name.
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists the translations, for all the locales or for the locales of the filter.
+        sig do
+          params(
+            id: String,
+            locale: T::Array[String],
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Products::TranslationsListResponse)
+        end
+        def list(
+          # Product Id
+          id,
+          # Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+          # the response has all the locales.
+          locale: nil,
+          request_options: {}
+        )
+        end
+
+        # Deletes the translation of one locale.
+        sig do
+          params(
+            locale: Dodopayments::Locale::OrSymbol,
+            id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # A locale that the checkout and the customer portal can show.
+          #
+          # The codes are a copy of the checkout locales. `GET /locales` lists them.
+          locale,
+          # Product Id
+          id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/products.rbi

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class Products
+      sig { returns(Dodopayments::Resources::Products::Translations) }
+      attr_reader :translations
+
       sig { returns(Dodopayments::Resources::Products::Images) }
       attr_reader :images
 
@@ -101,12 +104,20 @@ module Dodopayments
       sig do
         params(
           id: String,
+          locale: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Product)
       end
       def retrieve(
         # Product Id
         id,
+        # 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,
         request_options: {}
       )
       end
@@ -216,6 +227,7 @@ module Dodopayments
         params(
           archived: T::Boolean,
           brand_id: String,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           recurring: T::Boolean,
@@ -231,6 +243,13 @@ module Dodopayments
         archived: nil,
         # filter by Brand id
         brand_id: 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

data/rbi/dodopayments/resources/refunds.rbi

@@ -6,6 +6,7 @@ module Dodopayments
       sig do
         params(
           payment_id: String,
+          currency: T.nilable(Dodopayments::Currency::OrSymbol),
           items:
             T.nilable(T::Array[Dodopayments::RefundCreateParams::Item::OrHash]),
           metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
@@ -16,6 +17,9 @@ module Dodopayments
       def create(
         # The unique identifier of the payment to be refunded.
         payment_id:,
+        # The currency of every `items[].amount`. It must be the currency the customer
+        # paid in. Without it, the amounts are in the settlement currency.
+        currency: nil,
         # Partially Refund an Individual Item
         items: nil,
         # Additional metadata associated with the refund.

data/rbi/dodopayments/resources/subscriptions.rbi

@@ -116,12 +116,20 @@ module Dodopayments
       sig do
         params(
           subscription_id: String,
+          locale: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Subscription)
       end
       def retrieve(
         # Subscription Id
         subscription_id,
+        # 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,
         request_options: {}
       )
       end
@@ -224,6 +232,7 @@ module Dodopayments
           created_at_gte: Time,
           created_at_lte: Time,
           customer_id: String,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           product_id: String,
@@ -246,6 +255,13 @@ module Dodopayments
         created_at_lte: nil,
         # Filter by customer id
         customer_id: 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
@@ -369,6 +385,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.
         on_payment_failure: nil,
         # The URL that receives the customer after they pay the payment link. Needs
@@ -525,6 +546,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.
         on_payment_failure: nil,
         # The URL that receives the customer after they pay the payment link. Needs

data/rbi/dodopayments/workload_identity.rbi

@@ -0,0 +1,219 @@
+# typed: strong
+
+# typed: strong
+
+module Dodopayments
+  # Workload identity federation: exchange a short-lived OIDC token (JWT) from
+  # your platform for a short-lived API access token.
+  module WorkloadIdentity
+    GRANT_TYPE = T.let(T.unsafe(nil), String)
+
+    SUBJECT_TOKEN_TYPE = T.let(T.unsafe(nil), String)
+
+    # The client refreshes the access token when this many seconds or less remain.
+    REFRESH_WINDOW_IN_SECONDS = T.let(T.unsafe(nil), Integer)
+
+    PROVIDER_TIMEOUT_IN_SECONDS = T.let(T.unsafe(nil), Integer)
+
+    KUBERNETES_TOKEN_PATH = T.let(T.unsafe(nil), String)
+
+    GCP_METADATA_URL = T.let(T.unsafe(nil), String)
+
+    # The values that a subject token provider gets on each token exchange.
+    class Context
+      # The base URL of the client.
+      sig { returns(URI::Generic) }
+      attr_reader :base_url
+
+      # The default audience: the origin of the client base URL.
+      sig { returns(String) }
+      attr_reader :audience
+
+      # @api private
+      sig do
+        params(base_url: URI::Generic, audience: String).returns(
+          T.attached_class
+        )
+      end
+      def self.new(base_url:, audience:)
+      end
+    end
+
+    # The `workload_identity` option of the client.
+    class Config
+      sig { returns(String) }
+      attr_reader :identity_provider_id
+
+      sig { returns(T.anything) }
+      attr_reader :provider
+
+      sig do
+        params(
+          provider: T.anything,
+          identity_provider_id: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Returns the subject token (a JWT string). It can take one argument, a
+        # `WorkloadIdentity::Context`.
+        provider:,
+        # Defaults to `ENV["DODO_PAYMENTS_IDENTITY_PROVIDER_ID"]`
+        identity_provider_id: ENV["DODO_PAYMENTS_IDENTITY_PROVIDER_ID"]
+      )
+      end
+
+      # @api private
+      sig do
+        params(
+          value:
+            T.any(
+              Dodopayments::WorkloadIdentity::Config,
+              T::Hash[Symbol, T.anything]
+            )
+        ).returns(Dodopayments::WorkloadIdentity::Config)
+      end
+      def self.coerce(value)
+      end
+
+      sig { returns(String) }
+      def inspect
+      end
+    end
+
+    # Caches the access token of one client. All methods are thread-safe.
+    class Session
+      sig { returns(String) }
+      attr_reader :identity_provider_id
+
+      # @api private
+      sig do
+        params(
+          config: Dodopayments::WorkloadIdentity::Config,
+          context: Dodopayments::WorkloadIdentity::Context,
+          transport: T.anything
+        ).returns(T.attached_class)
+      end
+      def self.new(config:, context:, transport:)
+      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.
+      sig { returns(String) }
+      def access_token
+      end
+
+      # @api private
+      sig { params(token: T.nilable(String)).returns(NilClass) }
+      def invalidate(token = nil)
+      end
+
+      # Revokes the cached access token and clears the cache. Does nothing if no token
+      # is cached.
+      sig { returns(NilClass) }
+      def revoke
+      end
+
+      sig { returns(String) }
+      def inspect
+      end
+    end
+
+    Provider =
+      T.type_alias do
+        T
+          .proc
+          .params(context: Dodopayments::WorkloadIdentity::Context)
+          .returns(String)
+      end
+
+    class << self
+      # GitHub Actions. The job must have the `id-token: write` permission.
+      sig do
+        params(audience: T.nilable(String)).returns(
+          Dodopayments::WorkloadIdentity::Provider
+        )
+      end
+      def github_actions(
+        # Defaults to the origin of the client base URL.
+        audience: nil
+      )
+      end
+
+      # GitLab CI/CD. Declare the token in `id_tokens` of the job.
+      sig do
+        params(env_var: String).returns(
+          Dodopayments::WorkloadIdentity::Provider
+        )
+      end
+      def gitlab(env_var: "DODO_PAYMENTS_ID_TOKEN")
+      end
+
+      # HCP Terraform (Terraform Cloud) dynamic credentials.
+      sig { returns(Dodopayments::WorkloadIdentity::Provider) }
+      def terraform_cloud
+      end
+
+      # Google Cloud: the metadata server of the attached service account.
+      sig do
+        params(audience: T.nilable(String)).returns(
+          Dodopayments::WorkloadIdentity::Provider
+        )
+      end
+      def gcp(
+        # Defaults to the origin of the client base URL.
+        audience: nil
+      )
+      end
+
+      # Vercel OIDC federation.
+      sig { returns(Dodopayments::WorkloadIdentity::Provider) }
+      def vercel
+      end
+
+      # Kubernetes: a projected service account token. The file is read on each
+      # exchange.
+      sig do
+        params(path: String).returns(Dodopayments::WorkloadIdentity::Provider)
+      end
+      def kubernetes(path: KUBERNETES_TOKEN_PATH)
+      end
+
+      # A token file. The file is read on each exchange.
+      sig do
+        params(path: T.nilable(String)).returns(
+          Dodopayments::WorkloadIdentity::Provider
+        )
+      end
+      def file(
+        # Defaults to `ENV["DODO_PAYMENTS_IDENTITY_TOKEN_FILE"]`
+        path: ENV["DODO_PAYMENTS_IDENTITY_TOKEN_FILE"]
+      )
+      end
+
+      # AWS: wraps your function that returns the JWT, for example from STS
+      # `GetWebIdentityToken`.
+      sig do
+        params(
+          fn: T.nilable(T.anything),
+          blk: T.nilable(T.proc.returns(String))
+        ).returns(Dodopayments::WorkloadIdentity::Provider)
+      end
+      def aws(fn = nil, &blk)
+      end
+
+      # A fixed token. Use it for tests.
+      sig do
+        params(token: String).returns(Dodopayments::WorkloadIdentity::Provider)
+      end
+      def static(token)
+      end
+
+      # Finds a token source in the environment, in this order: GitHub Actions, HCP
+      # Terraform, `ENV["DODO_PAYMENTS_IDENTITY_TOKEN_FILE"]`, and the Kubernetes path.
+      # Returns `nil` if no source is found.
+      sig { returns(T.nilable(Dodopayments::WorkloadIdentity::Provider)) }
+      def auto
+      end
+    end
+  end
+end

data/sig/dodopayments/client.rbs

@@ -13,10 +13,12 @@ module Dodopayments
       test_mode: "https://test.dodopayments.com"
     }
 
-    attr_reader bearer_token: String
+    attr_reader bearer_token: String?
 
     attr_reader webhook_key: String?
 
+    attr_reader workload_identity: Dodopayments::WorkloadIdentity::Session?
+
     attr_reader checkout_sessions: Dodopayments::Resources::CheckoutSessions
 
     attr_reader payments: Dodopayments::Resources::Payments
@@ -74,6 +76,9 @@ module Dodopayments
     def initialize: (
       ?bearer_token: String?,
       ?webhook_key: String?,
+      ?workload_identity: Dodopayments::WorkloadIdentity::Config
+      | ::Hash[Symbol, top]
+      | nil,
       ?environment: :live_mode | :test_mode | nil,
       ?base_url: String?,
       ?max_retries: Integer,

data/sig/dodopayments/models/addon_delete_params.rbs

@@ -0,0 +1,23 @@
+module Dodopayments
+  module Models
+    type addon_delete_params =
+      { id: String } & Dodopayments::Internal::Type::request_parameters
+
+    class AddonDeleteParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      def initialize: (
+        id: String,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        request_options: Dodopayments::RequestOptions
+      }
+    end
+  end
+end

data/sig/dodopayments/models/addon_list_params.rbs

@@ -1,13 +1,26 @@
 module Dodopayments
   module Models
     type addon_list_params =
-      { page_number: Integer, page_size: Integer }
+      {
+        archived: bool,
+        locale: String,
+        page_number: Integer,
+        page_size: Integer
+      }
       & Dodopayments::Internal::Type::request_parameters
 
     class AddonListParams < Dodopayments::Internal::Type::BaseModel
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      attr_reader archived: bool?
+
+      def archived=: (bool) -> bool
+
+      attr_reader locale: String?
+
+      def locale=: (String) -> String
+
       attr_reader page_number: Integer?
 
       def page_number=: (Integer) -> Integer
@@ -17,12 +30,16 @@ module Dodopayments
       def page_size=: (Integer) -> Integer
 
       def initialize: (
+        ?archived: bool,
+        ?locale: String,
         ?page_number: Integer,
         ?page_size: Integer,
         ?request_options: Dodopayments::request_opts
       ) -> void
 
       def to_hash: -> {
+        archived: bool,
+        locale: String,
         page_number: Integer,
         page_size: Integer,
         request_options: Dodopayments::RequestOptions

data/sig/dodopayments/models/addon_retrieve_params.rbs

@@ -1,7 +1,8 @@
 module Dodopayments
   module Models
     type addon_retrieve_params =
-      { id: String } & Dodopayments::Internal::Type::request_parameters
+      { id: String, locale: String }
+      & Dodopayments::Internal::Type::request_parameters
 
     class AddonRetrieveParams < Dodopayments::Internal::Type::BaseModel
       extend Dodopayments::Internal::Type::RequestParameters::Converter
@@ -9,13 +10,19 @@ module Dodopayments
 
       attr_accessor id: String
 
+      attr_reader locale: String?
+
+      def locale=: (String) -> String
+
       def initialize: (
         id: String,
+        ?locale: String,
         ?request_options: Dodopayments::request_opts
       ) -> void
 
       def to_hash: -> {
         id: String,
+        locale: String,
         request_options: Dodopayments::RequestOptions
       }
     end