dodopayments 1.20.0 → 1.47.0

data/lib/dodopayments/resources/discounts.rb

@@ -6,15 +6,16 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::DiscountCreateParams} for more details.
       #
-      # If `code` is omitted or empty, a random 16-char uppercase code is generated.
+      # POST /discounts If `code` is omitted or empty, a random 16-char uppercase code
+      # is generated.
       #
-      # @overload create(amount:, type:, code: nil, expires_at: nil, name: nil, restricted_to: nil, usage_limit: nil, request_options: {})
+      # @overload create(amount:, type:, code: nil, expires_at: nil, name: nil, restricted_to: nil, subscription_cycles: nil, usage_limit: nil, request_options: {})
       #
-      # @param amount [Integer] The discount amount. ...
+      # @param amount [Integer] The discount amount.
       #
-      # @param type [Symbol, Dodopayments::Models::DiscountType]
+      # @param type [Symbol, Dodopayments::Models::DiscountType] The discount type (e.g. `percentage`, `flat`, or `flat_per_unit`).
       #
-      # @param code [String, nil] Optionally supply a code (will be uppercased). ...
+      # @param code [String, nil] Optionally supply a code (will be uppercased).
       #
       # @param expires_at [Time, nil] When the discount expires, if ever.
       #
@@ -22,7 +23,9 @@ module Dodopayments
       #
       # @param restricted_to [Array<String>, nil] List of product IDs to restrict usage (if any).
       #
-      # @param usage_limit [Integer, nil] How many times this discount can be used (if any). ...
+      # @param subscription_cycles [Integer, nil] Number of subscription billing cycles this discount is valid for.
+      #
+      # @param usage_limit [Integer, nil] How many times this discount can be used (if any).
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -30,12 +33,12 @@ module Dodopayments
       #
       # @see Dodopayments::Models::DiscountCreateParams
       def create(params)
-        parsed, options = Dodopayments::Models::DiscountCreateParams.dump_request(params)
+        parsed, options = Dodopayments::DiscountCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "discounts",
           body: parsed,
-          model: Dodopayments::Models::Discount,
+          model: Dodopayments::Discount,
           options: options
         )
       end
@@ -55,7 +58,7 @@ module Dodopayments
         @client.request(
           method: :get,
           path: ["discounts/%1$s", discount_id],
-          model: Dodopayments::Models::Discount,
+          model: Dodopayments::Discount,
           options: params[:request_options]
         )
       end
@@ -65,11 +68,11 @@ module Dodopayments
       #
       # PATCH /discounts/{discount_id}
       #
-      # @overload update(discount_id, amount: nil, code: nil, expires_at: nil, name: nil, restricted_to: nil, type: nil, usage_limit: nil, request_options: {})
+      # @overload update(discount_id, amount: nil, code: nil, expires_at: nil, name: nil, restricted_to: nil, subscription_cycles: nil, type: nil, usage_limit: nil, request_options: {})
       #
       # @param discount_id [String] Discount Id
       #
-      # @param amount [Integer, nil] If present, update the discount amount: ...
+      # @param amount [Integer, nil] If present, update the discount amount:
       #
       # @param code [String, nil] If present, update the discount code (uppercase).
       #
@@ -77,9 +80,11 @@ module Dodopayments
       #
       # @param name [String, nil]
       #
-      # @param restricted_to [Array<String>, nil] If present, replaces all restricted product IDs with this new set. ...
+      # @param restricted_to [Array<String>, nil] If present, replaces all restricted product IDs with this new set.
+      #
+      # @param subscription_cycles [Integer, nil] Number of subscription billing cycles this discount is valid for.
       #
-      # @param type [Symbol, Dodopayments::Models::DiscountType, nil]
+      # @param type [Symbol, Dodopayments::Models::DiscountType, nil] If present, update the discount type.
       #
       # @param usage_limit [Integer, nil]
       #
@@ -89,12 +94,12 @@ module Dodopayments
       #
       # @see Dodopayments::Models::DiscountUpdateParams
       def update(discount_id, params = {})
-        parsed, options = Dodopayments::Models::DiscountUpdateParams.dump_request(params)
+        parsed, options = Dodopayments::DiscountUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["discounts/%1$s", discount_id],
           body: parsed,
-          model: Dodopayments::Models::Discount,
+          model: Dodopayments::Discount,
           options: options
         )
       end
@@ -103,9 +108,9 @@ module Dodopayments
       #
       # @overload list(page_number: nil, page_size: nil, request_options: {})
       #
-      # @param page_number [Integer, nil] Page number (default = 0).
+      # @param page_number [Integer] Page number (default = 0).
       #
-      # @param page_size [Integer, nil] Page size (default = 10, max = 100).
+      # @param page_size [Integer] Page size (default = 10, max = 100).
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -113,13 +118,13 @@ module Dodopayments
       #
       # @see Dodopayments::Models::DiscountListParams
       def list(params = {})
-        parsed, options = Dodopayments::Models::DiscountListParams.dump_request(params)
+        parsed, options = Dodopayments::DiscountListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "discounts",
           query: parsed,
           page: Dodopayments::Internal::DefaultPageNumberPagination,
-          model: Dodopayments::Models::Discount,
+          model: Dodopayments::Discount,
           options: options
         )
       end

data/lib/dodopayments/resources/disputes.rb

@@ -9,47 +9,47 @@ module Dodopayments
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Dodopayments::Models::Dispute]
+      # @return [Dodopayments::Models::GetDispute]
       #
       # @see Dodopayments::Models::DisputeRetrieveParams
       def retrieve(dispute_id, params = {})
         @client.request(
           method: :get,
           path: ["disputes/%1$s", dispute_id],
-          model: Dodopayments::Models::Dispute,
+          model: Dodopayments::GetDispute,
           options: params[:request_options]
         )
       end
 
       # @overload list(created_at_gte: nil, created_at_lte: nil, customer_id: nil, dispute_stage: nil, dispute_status: nil, page_number: nil, page_size: nil, request_options: {})
       #
-      # @param created_at_gte [Time, nil] Get events after this created time
+      # @param created_at_gte [Time] Get events after this created time
       #
-      # @param created_at_lte [Time, nil] Get events created before this time
+      # @param created_at_lte [Time] Get events created before this time
       #
-      # @param customer_id [String, nil] Filter by customer_id
+      # @param customer_id [String] Filter by customer_id
       #
-      # @param dispute_stage [Symbol, Dodopayments::Models::DisputeStage, nil] Filter by dispute stage
+      # @param dispute_stage [Symbol, Dodopayments::Models::DisputeListParams::DisputeStage] Filter by dispute stage
       #
-      # @param dispute_status [Symbol, Dodopayments::Models::DisputeStatus, nil] Filter by dispute status
+      # @param dispute_status [Symbol, Dodopayments::Models::DisputeListParams::DisputeStatus] Filter by dispute status
       #
-      # @param page_number [Integer, nil] Page number default is 0
+      # @param page_number [Integer] Page number default is 0
       #
-      # @param page_size [Integer, nil] Page size default is 10 max is 100
+      # @param page_size [Integer] Page size default is 10 max is 100
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Dispute>]
+      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::DisputeListResponse>]
       #
       # @see Dodopayments::Models::DisputeListParams
       def list(params = {})
-        parsed, options = Dodopayments::Models::DisputeListParams.dump_request(params)
+        parsed, options = Dodopayments::DisputeListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "disputes",
           query: parsed,
           page: Dodopayments::Internal::DefaultPageNumberPagination,
-          model: Dodopayments::Models::Dispute,
+          model: Dodopayments::Models::DisputeListResponse,
           options: options
         )
       end

data/lib/dodopayments/resources/invoices/payments.rb

@@ -9,14 +9,15 @@ module Dodopayments
         # @param payment_id [String]
         # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [StringIO]
         #
         # @see Dodopayments::Models::Invoices::PaymentRetrieveParams
         def retrieve(payment_id, params = {})
           @client.request(
             method: :get,
             path: ["invoices/payments/%1$s", payment_id],
-            model: NilClass,
+            headers: {"accept" => "application/pdf"},
+            model: StringIO,
             options: params[:request_options]
           )
         end

data/lib/dodopayments/resources/license_key_instances.rb

@@ -16,7 +16,7 @@ module Dodopayments
         @client.request(
           method: :get,
           path: ["license_key_instances/%1$s", id],
-          model: Dodopayments::Models::LicenseKeyInstance,
+          model: Dodopayments::LicenseKeyInstance,
           options: params[:request_options]
         )
       end
@@ -33,12 +33,12 @@ module Dodopayments
       #
       # @see Dodopayments::Models::LicenseKeyInstanceUpdateParams
       def update(id, params)
-        parsed, options = Dodopayments::Models::LicenseKeyInstanceUpdateParams.dump_request(params)
+        parsed, options = Dodopayments::LicenseKeyInstanceUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["license_key_instances/%1$s", id],
           body: parsed,
-          model: Dodopayments::Models::LicenseKeyInstance,
+          model: Dodopayments::LicenseKeyInstance,
           options: options
         )
       end
@@ -57,13 +57,13 @@ module Dodopayments
       #
       # @see Dodopayments::Models::LicenseKeyInstanceListParams
       def list(params = {})
-        parsed, options = Dodopayments::Models::LicenseKeyInstanceListParams.dump_request(params)
+        parsed, options = Dodopayments::LicenseKeyInstanceListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "license_key_instances",
           query: parsed,
           page: Dodopayments::Internal::DefaultPageNumberPagination,
-          model: Dodopayments::Models::LicenseKeyInstance,
+          model: Dodopayments::LicenseKeyInstance,
           options: options
         )
       end

data/lib/dodopayments/resources/license_keys.rb

@@ -16,7 +16,7 @@ module Dodopayments
         @client.request(
           method: :get,
           path: ["license_keys/%1$s", id],
-          model: Dodopayments::Models::LicenseKey,
+          model: Dodopayments::LicenseKey,
           options: params[:request_options]
         )
       end
@@ -28,11 +28,11 @@ module Dodopayments
       #
       # @param id [String] License key ID
       #
-      # @param activations_limit [Integer, nil] The updated activation limit for the license key. ...
+      # @param activations_limit [Integer, nil] The updated activation limit for the license key.
       #
-      # @param disabled [Boolean, nil] Indicates whether the license key should be disabled. ...
+      # @param disabled [Boolean, nil] Indicates whether the license key should be disabled.
       #
-      # @param expires_at [Time, nil] The updated expiration timestamp for the license key in UTC. ...
+      # @param expires_at [Time, nil] The updated expiration timestamp for the license key in UTC.
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -40,27 +40,27 @@ module Dodopayments
       #
       # @see Dodopayments::Models::LicenseKeyUpdateParams
       def update(id, params = {})
-        parsed, options = Dodopayments::Models::LicenseKeyUpdateParams.dump_request(params)
+        parsed, options = Dodopayments::LicenseKeyUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["license_keys/%1$s", id],
           body: parsed,
-          model: Dodopayments::Models::LicenseKey,
+          model: Dodopayments::LicenseKey,
           options: options
         )
       end
 
       # @overload list(customer_id: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, request_options: {})
       #
-      # @param customer_id [String, nil] Filter by customer ID
+      # @param customer_id [String] Filter by customer ID
       #
-      # @param page_number [Integer, nil] Page number default is 0
+      # @param page_number [Integer] Page number default is 0
       #
-      # @param page_size [Integer, nil] Page size default is 10 max is 100
+      # @param page_size [Integer] Page size default is 10 max is 100
       #
-      # @param product_id [String, nil] Filter by product ID
+      # @param product_id [String] Filter by product ID
       #
-      # @param status [Symbol, Dodopayments::Models::LicenseKeyStatus, nil] Filter by license key status
+      # @param status [Symbol, Dodopayments::Models::LicenseKeyListParams::Status] Filter by license key status
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -68,13 +68,13 @@ module Dodopayments
       #
       # @see Dodopayments::Models::LicenseKeyListParams
       def list(params = {})
-        parsed, options = Dodopayments::Models::LicenseKeyListParams.dump_request(params)
+        parsed, options = Dodopayments::LicenseKeyListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "license_keys",
           query: parsed,
           page: Dodopayments::Internal::DefaultPageNumberPagination,
-          model: Dodopayments::Models::LicenseKey,
+          model: Dodopayments::LicenseKey,
           options: options
         )
       end

data/lib/dodopayments/resources/licenses.rb

@@ -13,12 +13,12 @@ module Dodopayments
       #
       # @see Dodopayments::Models::LicenseActivateParams
       def activate(params)
-        parsed, options = Dodopayments::Models::LicenseActivateParams.dump_request(params)
+        parsed, options = Dodopayments::LicenseActivateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "licenses/activate",
           body: parsed,
-          model: Dodopayments::Models::LicenseKeyInstance,
+          model: Dodopayments::LicenseKeyInstance,
           options: options
         )
       end
@@ -33,7 +33,7 @@ module Dodopayments
       #
       # @see Dodopayments::Models::LicenseDeactivateParams
       def deactivate(params)
-        parsed, options = Dodopayments::Models::LicenseDeactivateParams.dump_request(params)
+        parsed, options = Dodopayments::LicenseDeactivateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "licenses/deactivate",
@@ -53,7 +53,7 @@ module Dodopayments
       #
       # @see Dodopayments::Models::LicenseValidateParams
       def validate(params)
-        parsed, options = Dodopayments::Models::LicenseValidateParams.dump_request(params)
+        parsed, options = Dodopayments::LicenseValidateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "licenses/validate",

data/lib/dodopayments/resources/misc.rb

@@ -14,7 +14,7 @@ module Dodopayments
         @client.request(
           method: :get,
           path: "checkout/supported_countries",
-          model: Dodopayments::Internal::Type::ArrayOf[enum: Dodopayments::Models::CountryCode],
+          model: Dodopayments::Internal::Type::ArrayOf[enum: Dodopayments::CountryCode],
           options: params[:request_options]
         )
       end

data/lib/dodopayments/resources/payments.rb

@@ -8,28 +8,27 @@ module Dodopayments
       #
       # @overload create(billing:, customer:, product_cart:, allowed_payment_method_types: nil, billing_currency: nil, discount_code: nil, metadata: nil, payment_link: nil, return_url: nil, show_saved_payment_methods: nil, tax_id: nil, request_options: {})
       #
-      # @param billing [Dodopayments::Models::BillingAddress]
+      # @param billing [Dodopayments::Models::BillingAddress] Billing address details for the payment
       #
-      # @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer]
+      # @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer] Customer information for the payment
       #
       # @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>] List of products in the cart. Must contain at least 1 and at most 100 items.
       #
-      # @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentCreateParams::AllowedPaymentMethodType>, nil] List of payment methods allowed during checkout. ...
+      # @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil] List of payment methods allowed during checkout.
       #
-      # @param billing_currency [Symbol, Dodopayments::Models::Currency, nil]
+      # @param billing_currency [Symbol, Dodopayments::Models::Currency, nil] Fix the currency in which the end customer is billed.
       #
       # @param discount_code [String, nil] Discount Code to apply to the transaction
       #
-      # @param metadata [Hash{Symbol=>String}]
+      # @param metadata [Hash{Symbol=>String}] Additional metadata associated with the payment.
       #
       # @param payment_link [Boolean, nil] Whether to generate a payment link. Defaults to false if not specified.
       #
-      # @param return_url [String, nil] Optional URL to redirect the customer after payment. ...
+      # @param return_url [String, nil] Optional URL to redirect the customer after payment.
       #
-      # @param show_saved_payment_methods [Boolean] Display saved payment methods of a returning customer ...
+      # @param show_saved_payment_methods [Boolean] Display saved payment methods of a returning customer
       #
       # @param tax_id [String, nil] Tax ID in case the payment is B2B. If tax id validation fails the payment creati
-      # ...
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -37,7 +36,7 @@ module Dodopayments
       #
       # @see Dodopayments::Models::PaymentCreateParams
       def create(params)
-        parsed, options = Dodopayments::Models::PaymentCreateParams.dump_request(params)
+        parsed, options = Dodopayments::PaymentCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "payments",
@@ -60,26 +59,28 @@ module Dodopayments
         @client.request(
           method: :get,
           path: ["payments/%1$s", payment_id],
-          model: Dodopayments::Models::Payment,
+          model: Dodopayments::Payment,
           options: params[:request_options]
         )
       end
 
-      # @overload list(created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, status: nil, subscription_id: nil, request_options: {})
+      # @overload list(brand_id: nil, created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, status: nil, subscription_id: nil, request_options: {})
       #
-      # @param created_at_gte [Time, nil] Get events after this created time
+      # @param brand_id [String] filter by Brand id
       #
-      # @param created_at_lte [Time, nil] Get events created before this time
+      # @param created_at_gte [Time] Get events after this created time
       #
-      # @param customer_id [String, nil] Filter by customer id
+      # @param created_at_lte [Time] Get events created before this time
       #
-      # @param page_number [Integer, nil] Page number default is 0
+      # @param customer_id [String] Filter by customer id
       #
-      # @param page_size [Integer, nil] Page size default is 10 max is 100
+      # @param page_number [Integer] Page number default is 0
       #
-      # @param status [Symbol, Dodopayments::Models::IntentStatus, nil] Filter by status
+      # @param page_size [Integer] Page size default is 10 max is 100
       #
-      # @param subscription_id [String, nil] Filter by subscription id
+      # @param status [Symbol, Dodopayments::Models::PaymentListParams::Status] Filter by status
+      #
+      # @param subscription_id [String] Filter by subscription id
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -87,7 +88,7 @@ module Dodopayments
       #
       # @see Dodopayments::Models::PaymentListParams
       def list(params = {})
-        parsed, options = Dodopayments::Models::PaymentListParams.dump_request(params)
+        parsed, options = Dodopayments::PaymentListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "payments",
@@ -98,6 +99,24 @@ module Dodopayments
         )
       end
 
+      # @overload retrieve_line_items(payment_id, request_options: {})
+      #
+      # @param payment_id [String] Payment Id
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::PaymentRetrieveLineItemsResponse]
+      #
+      # @see Dodopayments::Models::PaymentRetrieveLineItemsParams
+      def retrieve_line_items(payment_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["payments/%1$s/line-items", payment_id],
+          model: Dodopayments::Models::PaymentRetrieveLineItemsResponse,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Dodopayments::Client]

data/lib/dodopayments/resources/payouts.rb

@@ -5,9 +5,9 @@ module Dodopayments
     class Payouts
       # @overload list(page_number: nil, page_size: nil, request_options: {})
       #
-      # @param page_number [Integer, nil] Page number default is 0
+      # @param page_number [Integer] Page number default is 0
       #
-      # @param page_size [Integer, nil] Page size default is 10 max is 100
+      # @param page_size [Integer] Page size default is 10 max is 100
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -15,7 +15,7 @@ module Dodopayments
       #
       # @see Dodopayments::Models::PayoutListParams
       def list(params = {})
-        parsed, options = Dodopayments::Models::PayoutListParams.dump_request(params)
+        parsed, options = Dodopayments::PayoutListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "payouts",

data/lib/dodopayments/resources/products/images.rb

@@ -8,7 +8,7 @@ module Dodopayments
         #
         # @param id [String] Product Id
         #
-        # @param force_update [Boolean, nil]
+        # @param force_update [Boolean]
         #
         # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -16,7 +16,7 @@ module Dodopayments
         #
         # @see Dodopayments::Models::Products::ImageUpdateParams
         def update(id, params = {})
-          parsed, options = Dodopayments::Models::Products::ImageUpdateParams.dump_request(params)
+          parsed, options = Dodopayments::Products::ImageUpdateParams.dump_request(params)
           @client.request(
             method: :put,
             path: ["products/%1$s/images", id],