dodopayments 0.0.1.pre.alpha.0 → 1.14.0

data/lib/dodopayments/resources/payments.rb

@@ -3,29 +3,24 @@
 module Dodopayments
   module Resources
     class Payments
-      # @param params [Dodopayments::Models::PaymentCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Dodopayments::Models::BillingAddress] :billing
-      #
-      #   @option params [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer] :customer
-      #
-      #   @option params [Array<Dodopayments::Models::OneTimeProductCartItem>] :product_cart List of products in the cart. Must contain at least 1 and at most 100 items.
-      #
-      #   @option params [String, nil] :discount_code Discount Code to apply to the transaction
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata
-      #
-      #   @option params [Boolean, nil] :payment_link Whether to generate a payment link. Defaults to false if not specified.
-      #
-      #   @option params [String, nil] :return_url Optional URL to redirect the customer after payment. Must be a valid URL if
-      #     provided.
-      #
-      #   @option params [String, nil] :tax_id Tax ID in case the payment is B2B. If tax id validation fails the payment
-      #     creation will fail
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @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 customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer]
+      # @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>]
+      # @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentCreateParams::AllowedPaymentMethodType>, nil]
+      # @param billing_currency [Symbol, Dodopayments::Models::PaymentCreateParams::BillingCurrency, nil]
+      # @param discount_code [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param payment_link [Boolean, nil]
+      # @param return_url [String, nil]
+      # @param show_saved_payment_methods [Boolean]
+      # @param tax_id [String, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::PaymentCreateResponse]
+      #
+      # @see Dodopayments::Models::PaymentCreateParams
       def create(params)
         parsed, options = Dodopayments::Models::PaymentCreateParams.dump_request(params)
         @client.request(
@@ -37,53 +32,51 @@ module Dodopayments
         )
       end
 
-      # @param payment_id [String] Payment Id
+      # @overload retrieve(payment_id, request_options: {})
       #
-      # @param params [Dodopayments::Models::PaymentRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param payment_id [String]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Payment]
+      #
+      # @see Dodopayments::Models::PaymentRetrieveParams
       def retrieve(payment_id, params = {})
         @client.request(
           method: :get,
-          path: ["payments/%0s", payment_id],
+          path: ["payments/%1$s", payment_id],
           model: Dodopayments::Models::Payment,
           options: params[:request_options]
         )
       end
 
-      # @param params [Dodopayments::Models::PaymentListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Time, nil] :created_at_gte Get events after this created time
-      #
-      #   @option params [Time, nil] :created_at_lte Get events created before this time
-      #
-      #   @option params [String, nil] :customer_id Filter by customer id
+      # @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: {})
       #
-      #   @option params [Integer, nil] :page_number Page number default is 0
+      # @param created_at_gte [Time, nil]
+      # @param created_at_lte [Time, nil]
+      # @param customer_id [String, nil]
+      # @param page_number [Integer, nil]
+      # @param page_size [Integer, nil]
+      # @param status [Symbol, Dodopayments::Models::IntentStatus, nil]
+      # @param subscription_id [String, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Integer, nil] :page_size Page size default is 10 max is 100
+      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::PaymentListResponse>]
       #
-      #   @option params [Symbol, Dodopayments::Models::IntentStatus, nil] :status Filter by status
-      #
-      #   @option params [String, nil] :subscription_id Filter by subscription id
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [Dodopayments::DefaultPageNumberPagination<Dodopayments::Models::PaymentListResponse>]
+      # @see Dodopayments::Models::PaymentListParams
       def list(params = {})
         parsed, options = Dodopayments::Models::PaymentListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "payments",
           query: parsed,
-          page: Dodopayments::DefaultPageNumberPagination,
+          page: Dodopayments::Internal::DefaultPageNumberPagination,
           model: Dodopayments::Models::PaymentListResponse,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [Dodopayments::Client]
       def initialize(client:)
         @client = client

data/lib/dodopayments/resources/payouts.rb

@@ -3,27 +3,29 @@
 module Dodopayments
   module Resources
     class Payouts
-      # @param params [Dodopayments::Models::PayoutListParams, Hash{Symbol=>Object}] .
+      # @overload list(page_number: nil, page_size: nil, request_options: {})
       #
-      #   @option params [Integer, nil] :page_number Page number default is 0
+      # @param page_number [Integer, nil]
+      # @param page_size [Integer, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Integer, nil] :page_size Page size default is 10 max is 100
+      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::PayoutListResponse>]
       #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [Dodopayments::DefaultPageNumberPagination<Dodopayments::Models::PayoutListResponse>]
+      # @see Dodopayments::Models::PayoutListParams
       def list(params = {})
         parsed, options = Dodopayments::Models::PayoutListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "payouts",
           query: parsed,
-          page: Dodopayments::DefaultPageNumberPagination,
+          page: Dodopayments::Internal::DefaultPageNumberPagination,
           model: Dodopayments::Models::PayoutListResponse,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [Dodopayments::Client]
       def initialize(client:)
         @client = client

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

@@ -4,26 +4,28 @@ module Dodopayments
   module Resources
     class Products
       class Images
-        # @param id [String] Product Id
+        # @overload update(id, force_update: nil, request_options: {})
         #
-        # @param params [Dodopayments::Models::Products::ImageUpdateParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Boolean, nil] :force_update
-        #
-        #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param id [String]
+        # @param force_update [Boolean, nil]
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Dodopayments::Models::Products::ImageUpdateResponse]
+        #
+        # @see Dodopayments::Models::Products::ImageUpdateParams
         def update(id, params = {})
           parsed, options = Dodopayments::Models::Products::ImageUpdateParams.dump_request(params)
           @client.request(
             method: :put,
-            path: ["products/%0s/images", id],
+            path: ["products/%1$s/images", id],
             query: parsed,
             model: Dodopayments::Models::Products::ImageUpdateResponse,
             options: options
           )
         end
 
+        # @api private
+        #
         # @param client [Dodopayments::Client]
         def initialize(client:)
           @client = client

data/lib/dodopayments/resources/products.rb

@@ -6,30 +6,22 @@ module Dodopayments
       # @return [Dodopayments::Resources::Products::Images]
       attr_reader :images
 
-      # @param params [Dodopayments::Models::ProductCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice] :price
-      #
-      #   @option params [Symbol, Dodopayments::Models::ProductCreateParams::TaxCategory] :tax_category Represents the different categories of taxation applicable to various products
-      #     and services.
-      #
-      #   @option params [Array<String>, nil] :addons Addons available for subscription product
-      #
-      #   @option params [String, nil] :description Optional description of the product
-      #
-      #   @option params [String, nil] :license_key_activation_message Optional message displayed during license key activation
-      #
-      #   @option params [Integer, nil] :license_key_activations_limit The number of times the license key can be activated. Must be 0 or greater
-      #
-      #   @option params [Dodopayments::Models::LicenseKeyDuration, nil] :license_key_duration
-      #
-      #   @option params [Boolean, nil] :license_key_enabled When true, generates and sends a license key to your customer. Defaults to false
-      #
-      #   @option params [String, nil] :name Optional name of the product
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(price:, tax_category:, addons: nil, description: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, name: nil, request_options: {})
+      #
+      # @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice]
+      # @param tax_category [Symbol, Dodopayments::Models::ProductCreateParams::TaxCategory]
+      # @param addons [Array<String>, nil]
+      # @param description [String, nil]
+      # @param license_key_activation_message [String, nil]
+      # @param license_key_activations_limit [Integer, nil]
+      # @param license_key_duration [Dodopayments::Models::LicenseKeyDuration, nil]
+      # @param license_key_enabled [Boolean, nil]
+      # @param name [String, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Product]
+      #
+      # @see Dodopayments::Models::ProductCreateParams
       def create(params)
         parsed, options = Dodopayments::Models::ProductCreateParams.dump_request(params)
         @client.request(
@@ -41,131 +33,111 @@ module Dodopayments
         )
       end
 
-      # @param id [String] Product Id
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [Dodopayments::Models::ProductRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Product]
+      #
+      # @see Dodopayments::Models::ProductRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["products/%0s", id],
+          path: ["products/%1$s", id],
           model: Dodopayments::Models::Product,
           options: params[:request_options]
         )
       end
 
-      # @param id [String]
-      #
-      # @param params [Dodopayments::Models::ProductUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Array<String>, nil] :addons Available Addons for subscription products
-      #
-      #   @option params [String, nil] :description Description of the product, optional and must be at most 1000 characters.
-      #
-      #   @option params [String, nil] :image_id Product image id after its uploaded to S3
-      #
-      #   @option params [String, nil] :license_key_activation_message Message sent to the customer upon license key activation.
-      #
-      #     Only applicable if `license_key_enabled` is `true`. This message contains
-      #     instructions for activating the license key.
-      #
-      #   @option params [Integer, nil] :license_key_activations_limit Limit for the number of activations for the license key.
+      # @overload update(id, addons: nil, description: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, name: nil, price: nil, tax_category: nil, request_options: {})
       #
-      #     Only applicable if `license_key_enabled` is `true`. Represents the maximum
-      #     number of times the license key can be activated.
-      #
-      #   @option params [Dodopayments::Models::LicenseKeyDuration, nil] :license_key_duration
-      #
-      #   @option params [Boolean, nil] :license_key_enabled Whether the product requires a license key.
-      #
-      #     If `true`, additional fields related to license key (duration, activations
-      #     limit, activation message) become applicable.
-      #
-      #   @option params [String, nil] :name Name of the product, optional and must be at most 100 characters.
-      #
-      #   @option params [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil] :price
-      #
-      #   @option params [Symbol, Dodopayments::Models::ProductUpdateParams::TaxCategory, nil] :tax_category Represents the different categories of taxation applicable to various products
-      #     and services.
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param addons [Array<String>, nil]
+      # @param description [String, nil]
+      # @param image_id [String, nil]
+      # @param license_key_activation_message [String, nil]
+      # @param license_key_activations_limit [Integer, nil]
+      # @param license_key_duration [Dodopayments::Models::LicenseKeyDuration, nil]
+      # @param license_key_enabled [Boolean, nil]
+      # @param name [String, nil]
+      # @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil]
+      # @param tax_category [Symbol, Dodopayments::Models::ProductUpdateParams::TaxCategory, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
+      #
+      # @see Dodopayments::Models::ProductUpdateParams
       def update(id, params = {})
         parsed, options = Dodopayments::Models::ProductUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["products/%0s", id],
+          path: ["products/%1$s", id],
           body: parsed,
           model: NilClass,
           options: options
         )
       end
 
-      # @param params [Dodopayments::Models::ProductListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Boolean] :archived List archived products
-      #
-      #   @option params [Integer, nil] :page_number Page number default is 0
+      # @overload list(archived: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {})
       #
-      #   @option params [Integer, nil] :page_size Page size default is 10 max is 100
+      # @param archived [Boolean]
+      # @param page_number [Integer, nil]
+      # @param page_size [Integer, nil]
+      # @param recurring [Boolean, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Boolean, nil] :recurring Filter products by pricing type:
+      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::ProductListResponse>]
       #
-      #     - `true`: Show only recurring pricing products (e.g. subscriptions)
-      #     - `false`: Show only one-time price products
-      #     - `null` or absent: Show both types of products
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [Dodopayments::DefaultPageNumberPagination<Dodopayments::Models::ProductListResponse>]
+      # @see Dodopayments::Models::ProductListParams
       def list(params = {})
         parsed, options = Dodopayments::Models::ProductListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "products",
           query: parsed,
-          page: Dodopayments::DefaultPageNumberPagination,
+          page: Dodopayments::Internal::DefaultPageNumberPagination,
           model: Dodopayments::Models::ProductListResponse,
           options: options
         )
       end
 
-      # @param id [String]
+      # @overload delete(id, request_options: {})
       #
-      # @param params [Dodopayments::Models::ProductDeleteParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
+      #
+      # @see Dodopayments::Models::ProductDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
-          path: ["products/%0s", id],
+          path: ["products/%1$s", id],
           model: NilClass,
           options: params[:request_options]
         )
       end
 
-      # @param id [String]
-      #
-      # @param params [Dodopayments::Models::ProductUnarchiveParams, Hash{Symbol=>Object}] .
+      # @overload unarchive(id, request_options: {})
       #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
+      #
+      # @see Dodopayments::Models::ProductUnarchiveParams
       def unarchive(id, params = {})
         @client.request(
           method: :post,
-          path: ["products/%0s/unarchive", id],
+          path: ["products/%1$s/unarchive", id],
           model: NilClass,
           options: params[:request_options]
         )
       end
 
+      # @api private
+      #
       # @param client [Dodopayments::Client]
       def initialize(client:)
         @client = client

data/lib/dodopayments/resources/refunds.rb

@@ -3,18 +3,15 @@
 module Dodopayments
   module Resources
     class Refunds
-      # @param params [Dodopayments::Models::RefundCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(payment_id:, reason: nil, request_options: {})
       #
-      #   @option params [String] :payment_id The unique identifier of the payment to be refunded.
-      #
-      #   @option params [Integer, nil] :amount The amount to be refunded. Must be non-negative. Optional. Partial refunds are
-      #     currently disabled.
-      #
-      #   @option params [String, nil] :reason The reason for the refund, if any. Maximum length is 3000 characters. Optional.
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param payment_id [String]
+      # @param reason [String, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Refund]
+      #
+      # @see Dodopayments::Models::RefundCreateParams
       def create(params)
         parsed, options = Dodopayments::Models::RefundCreateParams.dump_request(params)
         @client.request(
@@ -26,51 +23,50 @@ module Dodopayments
         )
       end
 
-      # @param refund_id [String] Refund Id
-      #
-      # @param params [Dodopayments::Models::RefundRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(refund_id, request_options: {})
       #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param refund_id [String]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Refund]
+      #
+      # @see Dodopayments::Models::RefundRetrieveParams
       def retrieve(refund_id, params = {})
         @client.request(
           method: :get,
-          path: ["refunds/%0s", refund_id],
+          path: ["refunds/%1$s", refund_id],
           model: Dodopayments::Models::Refund,
           options: params[:request_options]
         )
       end
 
-      # @param params [Dodopayments::Models::RefundListParams, Hash{Symbol=>Object}] .
+      # @overload list(created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, status: nil, request_options: {})
       #
-      #   @option params [Time, nil] :created_at_gte Get events after this created time
+      # @param created_at_gte [Time, nil]
+      # @param created_at_lte [Time, nil]
+      # @param customer_id [String, nil]
+      # @param page_number [Integer, nil]
+      # @param page_size [Integer, nil]
+      # @param status [Symbol, Dodopayments::Models::RefundStatus, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Time, nil] :created_at_lte Get events created before this time
+      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Refund>]
       #
-      #   @option params [String, nil] :customer_id Filter by customer_id
-      #
-      #   @option params [Integer, nil] :page_number Page number default is 0
-      #
-      #   @option params [Integer, nil] :page_size Page size default is 10 max is 100
-      #
-      #   @option params [Symbol, Dodopayments::Models::RefundStatus, nil] :status Filter by status
-      #
-      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [Dodopayments::DefaultPageNumberPagination<Dodopayments::Models::Refund>]
+      # @see Dodopayments::Models::RefundListParams
       def list(params = {})
         parsed, options = Dodopayments::Models::RefundListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "refunds",
           query: parsed,
-          page: Dodopayments::DefaultPageNumberPagination,
+          page: Dodopayments::Internal::DefaultPageNumberPagination,
           model: Dodopayments::Models::Refund,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [Dodopayments::Client]
       def initialize(client:)
         @client = client