dodopayments 1.22.0 → 1.49.0

data/lib/dodopayments/resources/webhooks.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Webhooks
+      # @return [Dodopayments::Resources::Webhooks::Headers]
+      attr_reader :headers
+
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::WebhookCreateParams} for more details.
+      #
+      # Create a new webhook
+      #
+      # @overload create(url:, description: nil, disabled: nil, filter_types: nil, headers: nil, idempotency_key: nil, metadata: nil, rate_limit: nil, request_options: {})
+      #
+      # @param url [String] Url of the webhook
+      #
+      # @param description [String, nil]
+      #
+      # @param disabled [Boolean, nil] Create the webhook in a disabled state.
+      #
+      # @param filter_types [Array<Symbol, Dodopayments::Models::WebhookEventType>] Filter events to the webhook.
+      #
+      # @param headers [Hash{Symbol=>String}, nil] Custom headers to be passed
+      #
+      # @param idempotency_key [String, nil] The request's idempotency key
+      #
+      # @param metadata [Hash{Symbol=>String}, nil] Metadata to be passed to the webhook
+      #
+      # @param rate_limit [Integer, nil]
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::WebhookCreateResponse]
+      #
+      # @see Dodopayments::Models::WebhookCreateParams
+      def create(params)
+        parsed, options = Dodopayments::WebhookCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "webhooks",
+          body: parsed,
+          model: Dodopayments::Models::WebhookCreateResponse,
+          options: options
+        )
+      end
+
+      # Get a webhook by id
+      #
+      # @overload retrieve(webhook_id, request_options: {})
+      #
+      # @param webhook_id [String]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::WebhookRetrieveResponse]
+      #
+      # @see Dodopayments::Models::WebhookRetrieveParams
+      def retrieve(webhook_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["webhooks/%1$s", webhook_id],
+          model: Dodopayments::Models::WebhookRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::WebhookUpdateParams} for more details.
+      #
+      # Patch a webhook by id
+      #
+      # @overload update(webhook_id, description: nil, disabled: nil, filter_types: nil, metadata: nil, rate_limit: nil, url: nil, request_options: {})
+      #
+      # @param webhook_id [String]
+      #
+      # @param description [String, nil] Description of the webhook
+      #
+      # @param disabled [Boolean, nil] To Disable the endpoint, set it to true.
+      #
+      # @param filter_types [Array<Symbol, Dodopayments::Models::WebhookEventType>, nil] Filter events to the endpoint.
+      #
+      # @param metadata [Hash{Symbol=>String}, nil] Metadata
+      #
+      # @param rate_limit [Integer, nil] Rate limit
+      #
+      # @param url [String, nil] Url endpoint
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::WebhookUpdateResponse]
+      #
+      # @see Dodopayments::Models::WebhookUpdateParams
+      def update(webhook_id, params = {})
+        parsed, options = Dodopayments::WebhookUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["webhooks/%1$s", webhook_id],
+          body: parsed,
+          model: Dodopayments::Models::WebhookUpdateResponse,
+          options: options
+        )
+      end
+
+      # List all webhooks
+      #
+      # @overload list(iterator: nil, limit: nil, request_options: {})
+      #
+      # @param iterator [String, nil] The iterator returned from a prior invocation
+      #
+      # @param limit [Integer, nil] Limit the number of returned items
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Internal::CursorPagePagination<Dodopayments::Models::WebhookListResponse>]
+      #
+      # @see Dodopayments::Models::WebhookListParams
+      def list(params = {})
+        parsed, options = Dodopayments::WebhookListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "webhooks",
+          query: parsed,
+          page: Dodopayments::Internal::CursorPagePagination,
+          model: Dodopayments::Models::WebhookListResponse,
+          options: options
+        )
+      end
+
+      # Delete a webhook by id
+      #
+      # @overload delete(webhook_id, request_options: {})
+      #
+      # @param webhook_id [String]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Dodopayments::Models::WebhookDeleteParams
+      def delete(webhook_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["webhooks/%1$s", webhook_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Get webhook secret by id
+      #
+      # @overload retrieve_secret(webhook_id, request_options: {})
+      #
+      # @param webhook_id [String]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::WebhookRetrieveSecretResponse]
+      #
+      # @see Dodopayments::Models::WebhookRetrieveSecretParams
+      def retrieve_secret(webhook_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["webhooks/%1$s/secret", webhook_id],
+          model: Dodopayments::Models::WebhookRetrieveSecretResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+        @headers = Dodopayments::Resources::Webhooks::Headers.new(client: client)
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/your_webhook_url.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class YourWebhookURL
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::YourWebhookURLCreateParams} for more details.
+      #
+      # @overload create(business_id:, data:, timestamp:, type:, webhook_id:, webhook_signature:, webhook_timestamp:, request_options: {})
+      #
+      # @param business_id [String] Body param:
+      #
+      # @param data [Dodopayments::Models::WebhookPayload::Data::Payment, Dodopayments::Models::WebhookPayload::Data::Subscription, Dodopayments::Models::WebhookPayload::Data::Refund, Dodopayments::Models::WebhookPayload::Data::Dispute, Dodopayments::Models::WebhookPayload::Data::LicenseKey] Body param: The latest data at the time of delivery attempt
+      #
+      # @param timestamp [Time] Body param: The timestamp of when the event occurred (not necessarily the same o
+      #
+      # @param type [Symbol, Dodopayments::Models::WebhookEventType] Body param: Event types for Dodo events
+      #
+      # @param webhook_id [String] Header param: Unique identifier for the webhook
+      #
+      # @param webhook_signature [String] Header param: Signature of the Webhook
+      #
+      # @param webhook_timestamp [String] Header param: Unix timestamp when the webhook was sent
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Dodopayments::Models::YourWebhookURLCreateParams
+      def create(params)
+        parsed, options = Dodopayments::YourWebhookURLCreateParams.dump_request(params)
+        header_params =
+          {
+            webhook_id: "webhook-id",
+            webhook_signature: "webhook-signature",
+            webhook_timestamp: "webhook-timestamp"
+          }
+        @client.request(
+          method: :post,
+          path: "your-webhook-url",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/dodopayments/version.rb

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

data/lib/dodopayments.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
 require "English"
 require "cgi"
 require "date"
@@ -15,10 +16,13 @@ require "set"
 require "stringio"
 require "time"
 require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
 
 # We already ship the preferred sorbet manifests in the package itself.
 # `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
-if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).grep(/tapioca/)
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
   return
 end
 
@@ -46,7 +50,14 @@ require_relative "dodopayments/errors"
 require_relative "dodopayments/internal/transport/base_client"
 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/models/license_key"
+require_relative "dodopayments/models/get_dispute"
+require_relative "dodopayments/models/refund"
+require_relative "dodopayments/models/subscription"
+require_relative "dodopayments/models/payment"
+require_relative "dodopayments/models/webhook_payload"
 require_relative "dodopayments/models/addon_cart_response_item"
 require_relative "dodopayments/models/addon_create_params"
 require_relative "dodopayments/models/addon_list_params"
@@ -55,8 +66,17 @@ require_relative "dodopayments/models/addon_retrieve_params"
 require_relative "dodopayments/models/addon_update_images_params"
 require_relative "dodopayments/models/addon_update_images_response"
 require_relative "dodopayments/models/addon_update_params"
+require_relative "dodopayments/models/attach_addon"
 require_relative "dodopayments/models/attach_existing_customer"
 require_relative "dodopayments/models/billing_address"
+require_relative "dodopayments/models/brand"
+require_relative "dodopayments/models/brand_create_params"
+require_relative "dodopayments/models/brand_list_params"
+require_relative "dodopayments/models/brand_list_response"
+require_relative "dodopayments/models/brand_retrieve_params"
+require_relative "dodopayments/models/brand_update_images_params"
+require_relative "dodopayments/models/brand_update_images_response"
+require_relative "dodopayments/models/brand_update_params"
 require_relative "dodopayments/models/country_code"
 require_relative "dodopayments/models/create_new_customer"
 require_relative "dodopayments/models/currency"
@@ -80,14 +100,12 @@ require_relative "dodopayments/models/dispute"
 require_relative "dodopayments/models/dispute_list_params"
 require_relative "dodopayments/models/dispute_list_response"
 require_relative "dodopayments/models/dispute_retrieve_params"
-require_relative "dodopayments/models/dispute_retrieve_response"
 require_relative "dodopayments/models/dispute_stage"
 require_relative "dodopayments/models/dispute_status"
 require_relative "dodopayments/models/intent_status"
 require_relative "dodopayments/models/invoices/payment_retrieve_params"
 require_relative "dodopayments/models/license_activate_params"
 require_relative "dodopayments/models/license_deactivate_params"
-require_relative "dodopayments/models/license_key"
 require_relative "dodopayments/models/license_key_duration"
 require_relative "dodopayments/models/license_key_instance"
 require_relative "dodopayments/models/license_key_instance_list_params"
@@ -101,12 +119,15 @@ require_relative "dodopayments/models/license_validate_params"
 require_relative "dodopayments/models/license_validate_response"
 require_relative "dodopayments/models/misc_list_supported_countries_params"
 require_relative "dodopayments/models/misc_list_supported_countries_response"
+require_relative "dodopayments/models/new_customer"
 require_relative "dodopayments/models/one_time_product_cart_item"
-require_relative "dodopayments/models/payment"
 require_relative "dodopayments/models/payment_create_params"
 require_relative "dodopayments/models/payment_create_response"
 require_relative "dodopayments/models/payment_list_params"
 require_relative "dodopayments/models/payment_list_response"
+require_relative "dodopayments/models/payment_method_types"
+require_relative "dodopayments/models/payment_retrieve_line_items_params"
+require_relative "dodopayments/models/payment_retrieve_line_items_response"
 require_relative "dodopayments/models/payment_retrieve_params"
 require_relative "dodopayments/models/payout_list_params"
 require_relative "dodopayments/models/payout_list_response"
@@ -120,13 +141,13 @@ require_relative "dodopayments/models/product_retrieve_params"
 require_relative "dodopayments/models/products/image_update_params"
 require_relative "dodopayments/models/products/image_update_response"
 require_relative "dodopayments/models/product_unarchive_params"
+require_relative "dodopayments/models/product_update_files_params"
+require_relative "dodopayments/models/product_update_files_response"
 require_relative "dodopayments/models/product_update_params"
-require_relative "dodopayments/models/refund"
 require_relative "dodopayments/models/refund_create_params"
 require_relative "dodopayments/models/refund_list_params"
 require_relative "dodopayments/models/refund_retrieve_params"
 require_relative "dodopayments/models/refund_status"
-require_relative "dodopayments/models/subscription"
 require_relative "dodopayments/models/subscription_change_plan_params"
 require_relative "dodopayments/models/subscription_charge_params"
 require_relative "dodopayments/models/subscription_charge_response"
@@ -139,10 +160,25 @@ require_relative "dodopayments/models/subscription_status"
 require_relative "dodopayments/models/subscription_update_params"
 require_relative "dodopayments/models/tax_category"
 require_relative "dodopayments/models/time_interval"
-require_relative "dodopayments/models/webhook_event"
-require_relative "dodopayments/models/webhook_event_list_params"
-require_relative "dodopayments/models/webhook_event_retrieve_params"
+require_relative "dodopayments/models/webhook_create_params"
+require_relative "dodopayments/models/webhook_create_response"
+require_relative "dodopayments/models/webhook_delete_params"
+require_relative "dodopayments/models/webhook_event_type"
+require_relative "dodopayments/models/webhook_list_params"
+require_relative "dodopayments/models/webhook_list_response"
+require_relative "dodopayments/models/webhook_retrieve_params"
+require_relative "dodopayments/models/webhook_retrieve_response"
+require_relative "dodopayments/models/webhook_retrieve_secret_params"
+require_relative "dodopayments/models/webhook_retrieve_secret_response"
+require_relative "dodopayments/models/webhooks/header_retrieve_params"
+require_relative "dodopayments/models/webhooks/header_retrieve_response"
+require_relative "dodopayments/models/webhooks/header_update_params"
+require_relative "dodopayments/models/webhook_update_params"
+require_relative "dodopayments/models/webhook_update_response"
+require_relative "dodopayments/models/your_webhook_url_create_params"
+require_relative "dodopayments/models"
 require_relative "dodopayments/resources/addons"
+require_relative "dodopayments/resources/brands"
 require_relative "dodopayments/resources/customers"
 require_relative "dodopayments/resources/customers/customer_portal"
 require_relative "dodopayments/resources/discounts"
@@ -160,3 +196,6 @@ require_relative "dodopayments/resources/products/images"
 require_relative "dodopayments/resources/refunds"
 require_relative "dodopayments/resources/subscriptions"
 require_relative "dodopayments/resources/webhook_events"
+require_relative "dodopayments/resources/webhooks"
+require_relative "dodopayments/resources/webhooks/headers"
+require_relative "dodopayments/resources/your_webhook_url"

data/rbi/dodopayments/client.rbi

@@ -12,7 +12,10 @@ module Dodopayments
 
     ENVIRONMENTS =
       T.let(
-        {live_mode: "https://live.dodopayments.com", test_mode: "https://test.dodopayments.com"},
+        {
+          live_mode: "https://live.dodopayments.com",
+          test_mode: "https://test.dodopayments.com"
+        },
         T::Hash[Symbol, String]
       )
 
@@ -65,22 +68,31 @@ module Dodopayments
     sig { returns(Dodopayments::Resources::Addons) }
     attr_reader :addons
 
+    sig { returns(Dodopayments::Resources::Brands) }
+    attr_reader :brands
+
+    sig { returns(Dodopayments::Resources::Webhooks) }
+    attr_reader :webhooks
+
+    sig { returns(Dodopayments::Resources::YourWebhookURL) }
+    attr_reader :your_webhook_url
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
-    private def auth_headers; end
+    private def auth_headers
+    end
 
     # Creates and returns a new client for interacting with the API.
     sig do
       params(
         bearer_token: T.nilable(String),
-        environment: NilClass,
+        environment: T.nilable(T.any(Symbol, String)),
         base_url: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
         initial_retry_delay: Float,
         max_retry_delay: Float
-      )
-        .returns(T.attached_class)
+      ).returns(T.attached_class)
     end
     def self.new(
       # Bearer Token for API authentication Defaults to `ENV["DODO_PAYMENTS_API_KEY"]`
@@ -100,6 +112,7 @@ module Dodopayments
       timeout: Dodopayments::Client::DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: Dodopayments::Client::DEFAULT_INITIAL_RETRY_DELAY,
       max_retry_delay: Dodopayments::Client::DEFAULT_MAX_RETRY_DELAY
-    ); end
+    )
+    end
   end
 end

data/rbi/dodopayments/errors.rbi

@@ -8,6 +8,22 @@ module Dodopayments
     end
 
     class ConversionError < Dodopayments::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
     end
 
     class APIError < Dodopayments::Errors::Error
@@ -29,10 +45,17 @@ module Dodopayments
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil); end
     end
 
     class APIConnectionError < Dodopayments::Errors::APIError
@@ -51,10 +74,16 @@ module Dodopayments
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
       end
     end
 
@@ -68,10 +97,16 @@ module Dodopayments
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
       end
     end
 
@@ -85,10 +120,10 @@ module Dodopayments
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.for(url:, status:, body:, request:, response:, message: nil)
       end
-      def self.for(url:, status:, body:, request:, response:, message: nil); end
 
       sig { returns(Integer) }
       attr_accessor :status
@@ -102,10 +137,10 @@ module Dodopayments
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.new(url:, status:, body:, request:, response:, message: nil)
       end
-      def self.new(url:, status:, body:, request:, response:, message: nil); end
     end
 
     class BadRequestError < Dodopayments::Errors::APIStatusError
@@ -137,7 +172,7 @@ module Dodopayments
     end
 
     class InternalServerError < Dodopayments::Errors::APIStatusError
-      HTTP_STATUS = T.let(500.., T::Range[Integer])
+      HTTP_STATUS = T.let((500..), T::Range[Integer])
     end
   end
 end

data/rbi/dodopayments/file_part.rbi

@@ -13,22 +13,25 @@ module Dodopayments
 
     # @api private
     sig { returns(String) }
-    private def read; end
+    private def read
+    end
 
     sig { params(a: T.anything).returns(String) }
-    def to_json(*a); end
+    def to_json(*a)
+    end
 
     sig { params(a: T.anything).returns(String) }
-    def to_yaml(*a); end
+    def to_yaml(*a)
+    end
 
     sig do
       params(
         content: T.any(Pathname, StringIO, IO, String),
         filename: T.nilable(String),
         content_type: T.nilable(String)
-      )
-        .returns(T.attached_class)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
     end
-    def self.new(content, filename: nil, content_type: nil); end
   end
 end

data/rbi/dodopayments/internal/cursor_page_pagination.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Dodopayments
+  module Internal
+    class CursorPagePagination
+      include Dodopayments::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(T.nilable(T::Array[Elem])) }
+      attr_accessor :data
+
+      sig { returns(String) }
+      attr_accessor :iterator
+
+      sig { returns(T::Boolean) }
+      attr_accessor :done
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+    end
+  end
+end

data/rbi/dodopayments/internal/default_page_number_pagination.rbi

@@ -12,7 +12,8 @@ module Dodopayments
 
       # @api private
       sig { returns(String) }
-      def inspect; end
+      def inspect
+      end
     end
   end
 end