dodopayments 1.19.0 → 1.22.0

data/lib/dodopayments/models/subscription_list_response.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Subscriptions#list
+    class SubscriptionListResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute billing
+      #
+      #   @return [Dodopayments::Models::BillingAddress]
+      required :billing, -> { Dodopayments::Models::BillingAddress }
+
+      # @!attribute created_at
+      #   Timestamp when the subscription was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #
+      #   @return [Symbol, Dodopayments::Models::Currency]
+      required :currency, enum: -> { Dodopayments::Models::Currency }
+
+      # @!attribute customer
+      #
+      #   @return [Dodopayments::Models::CustomerLimitedDetails]
+      required :customer, -> { Dodopayments::Models::CustomerLimitedDetails }
+
+      # @!attribute metadata
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Dodopayments::Internal::Type::HashOf[String]
+
+      # @!attribute next_billing_date
+      #   Timestamp of the next scheduled billing. Indicates the end of current billing
+      #   period
+      #
+      #   @return [Time]
+      required :next_billing_date, Time
+
+      # @!attribute on_demand
+      #   Wether the subscription is on-demand or not
+      #
+      #   @return [Boolean]
+      required :on_demand, Dodopayments::Internal::Type::Boolean
+
+      # @!attribute payment_frequency_count
+      #   Number of payment frequency intervals
+      #
+      #   @return [Integer]
+      required :payment_frequency_count, Integer
+
+      # @!attribute payment_frequency_interval
+      #
+      #   @return [Symbol, Dodopayments::Models::TimeInterval]
+      required :payment_frequency_interval, enum: -> { Dodopayments::Models::TimeInterval }
+
+      # @!attribute previous_billing_date
+      #   Timestamp of the last payment. Indicates the start of current billing period
+      #
+      #   @return [Time]
+      required :previous_billing_date, Time
+
+      # @!attribute product_id
+      #   Identifier of the product associated with this subscription
+      #
+      #   @return [String]
+      required :product_id, String
+
+      # @!attribute quantity
+      #   Number of units/items included in the subscription
+      #
+      #   @return [Integer]
+      required :quantity, Integer
+
+      # @!attribute recurring_pre_tax_amount
+      #   Amount charged before tax for each recurring payment in smallest currency unit
+      #   (e.g. cents)
+      #
+      #   @return [Integer]
+      required :recurring_pre_tax_amount, Integer
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Dodopayments::Models::SubscriptionStatus]
+      required :status, enum: -> { Dodopayments::Models::SubscriptionStatus }
+
+      # @!attribute subscription_id
+      #   Unique identifier for the subscription
+      #
+      #   @return [String]
+      required :subscription_id, String
+
+      # @!attribute subscription_period_count
+      #   Number of subscription period intervals
+      #
+      #   @return [Integer]
+      required :subscription_period_count, Integer
+
+      # @!attribute subscription_period_interval
+      #
+      #   @return [Symbol, Dodopayments::Models::TimeInterval]
+      required :subscription_period_interval, enum: -> { Dodopayments::Models::TimeInterval }
+
+      # @!attribute tax_inclusive
+      #   Indicates if the recurring_pre_tax_amount is tax inclusive
+      #
+      #   @return [Boolean]
+      required :tax_inclusive, Dodopayments::Internal::Type::Boolean
+
+      # @!attribute trial_period_days
+      #   Number of days in the trial period (0 if no trial)
+      #
+      #   @return [Integer]
+      required :trial_period_days, Integer
+
+      # @!attribute cancelled_at
+      #   Cancelled timestamp if the subscription is cancelled
+      #
+      #   @return [Time, nil]
+      optional :cancelled_at, Time, nil?: true
+
+      # @!attribute discount_id
+      #   The discount id if discount is applied
+      #
+      #   @return [String, nil]
+      optional :discount_id, String, nil?: true
+
+      # @!method initialize(billing:, created_at:, currency:, customer:, metadata:, next_billing_date:, on_demand:, payment_frequency_count:, payment_frequency_interval:, previous_billing_date:, product_id:, quantity:, recurring_pre_tax_amount:, status:, subscription_id:, subscription_period_count:, subscription_period_interval:, tax_inclusive:, trial_period_days:, cancelled_at: nil, discount_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionListResponse} for more details.
+      #
+      #   Response struct representing subscription details
+      #
+      #   @param billing [Dodopayments::Models::BillingAddress]
+      #
+      #   @param created_at [Time] Timestamp when the subscription was created
+      #
+      #   @param currency [Symbol, Dodopayments::Models::Currency]
+      #
+      #   @param customer [Dodopayments::Models::CustomerLimitedDetails]
+      #
+      #   @param metadata [Hash{Symbol=>String}]
+      #
+      #   @param next_billing_date [Time] Timestamp of the next scheduled billing. Indicates the end of current billing pe
+      #   ...
+      #
+      #   @param on_demand [Boolean] Wether the subscription is on-demand or not
+      #
+      #   @param payment_frequency_count [Integer] Number of payment frequency intervals
+      #
+      #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval]
+      #
+      #   @param previous_billing_date [Time] Timestamp of the last payment. Indicates the start of current billing period
+      #
+      #   @param product_id [String] Identifier of the product associated with this subscription
+      #
+      #   @param quantity [Integer] Number of units/items included in the subscription
+      #
+      #   @param recurring_pre_tax_amount [Integer] Amount charged before tax for each recurring payment in smallest currency unit (
+      #   ...
+      #
+      #   @param status [Symbol, Dodopayments::Models::SubscriptionStatus]
+      #
+      #   @param subscription_id [String] Unique identifier for the subscription
+      #
+      #   @param subscription_period_count [Integer] Number of subscription period intervals
+      #
+      #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval]
+      #
+      #   @param tax_inclusive [Boolean] Indicates if the recurring_pre_tax_amount is tax inclusive
+      #
+      #   @param trial_period_days [Integer] Number of days in the trial period (0 if no trial)
+      #
+      #   @param cancelled_at [Time, nil] Cancelled timestamp if the subscription is cancelled
+      #
+      #   @param discount_id [String, nil] The discount id if discount is applied
+    end
+  end
+end

data/lib/dodopayments/models/subscription_update_params.rb

@@ -12,6 +12,13 @@ module Dodopayments
       #   @return [Dodopayments::Models::BillingAddress, nil]
       optional :billing, -> { Dodopayments::Models::BillingAddress }, nil?: true
 
+      # @!attribute disable_on_demand
+      #
+      #   @return [Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand, nil]
+      optional :disable_on_demand,
+               -> { Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand },
+               nil?: true
+
       # @!attribute metadata
       #
       #   @return [Hash{Symbol=>String}, nil]
@@ -27,12 +34,23 @@ module Dodopayments
       #   @return [String, nil]
       optional :tax_id, String, nil?: true
 
-      # @!method initialize(billing: nil, metadata: nil, status: nil, tax_id: nil, request_options: {})
+      # @!method initialize(billing: nil, disable_on_demand: nil, metadata: nil, status: nil, tax_id: nil, request_options: {})
       #   @param billing [Dodopayments::Models::BillingAddress, nil]
+      #   @param disable_on_demand [Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand, nil]
       #   @param metadata [Hash{Symbol=>String}, nil]
       #   @param status [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
       #   @param tax_id [String, nil]
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+      class DisableOnDemand < Dodopayments::Internal::Type::BaseModel
+        # @!attribute next_billing_date
+        #
+        #   @return [Time]
+        required :next_billing_date, Time
+
+        # @!method initialize(next_billing_date:)
+        #   @param next_billing_date [Time]
+      end
     end
   end
 end

data/lib/dodopayments/models/tax_category.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # Represents the different categories of taxation applicable to various products
+    # and services.
+    module TaxCategory
+      extend Dodopayments::Internal::Type::Enum
+
+      DIGITAL_PRODUCTS = :digital_products
+      SAAS = :saas
+      E_BOOK = :e_book
+      EDTECH = :edtech
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/dodopayments/models.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  AddonCartResponseItem = Dodopayments::Models::AddonCartResponseItem
+
+  AddonCreateParams = Dodopayments::Models::AddonCreateParams
+
+  AddonListParams = Dodopayments::Models::AddonListParams
+
+  AddonResponse = Dodopayments::Models::AddonResponse
+
+  AddonRetrieveParams = Dodopayments::Models::AddonRetrieveParams
+
+  AddonUpdateImagesParams = Dodopayments::Models::AddonUpdateImagesParams
+
+  AddonUpdateParams = Dodopayments::Models::AddonUpdateParams
+
+  AttachExistingCustomer = Dodopayments::Models::AttachExistingCustomer
+
+  BillingAddress = Dodopayments::Models::BillingAddress
+
+  CountryCode = Dodopayments::Models::CountryCode
+
+  CreateNewCustomer = Dodopayments::Models::CreateNewCustomer
+
+  Currency = Dodopayments::Models::Currency
+
+  Customer = Dodopayments::Models::Customer
+
+  CustomerCreateParams = Dodopayments::Models::CustomerCreateParams
+
+  CustomerLimitedDetails = Dodopayments::Models::CustomerLimitedDetails
+
+  CustomerListParams = Dodopayments::Models::CustomerListParams
+
+  CustomerPortalSession = Dodopayments::Models::CustomerPortalSession
+
+  CustomerRequest = Dodopayments::Models::CustomerRequest
+
+  CustomerRetrieveParams = Dodopayments::Models::CustomerRetrieveParams
+
+  Customers = Dodopayments::Models::Customers
+
+  CustomerUpdateParams = Dodopayments::Models::CustomerUpdateParams
+
+  Discount = Dodopayments::Models::Discount
+
+  DiscountCreateParams = Dodopayments::Models::DiscountCreateParams
+
+  DiscountDeleteParams = Dodopayments::Models::DiscountDeleteParams
+
+  DiscountListParams = Dodopayments::Models::DiscountListParams
+
+  DiscountRetrieveParams = Dodopayments::Models::DiscountRetrieveParams
+
+  DiscountType = Dodopayments::Models::DiscountType
+
+  DiscountUpdateParams = Dodopayments::Models::DiscountUpdateParams
+
+  Dispute = Dodopayments::Models::Dispute
+
+  DisputeListParams = Dodopayments::Models::DisputeListParams
+
+  DisputeRetrieveParams = Dodopayments::Models::DisputeRetrieveParams
+
+  DisputeStage = Dodopayments::Models::DisputeStage
+
+  DisputeStatus = Dodopayments::Models::DisputeStatus
+
+  IntentStatus = Dodopayments::Models::IntentStatus
+
+  Invoices = Dodopayments::Models::Invoices
+
+  LicenseActivateParams = Dodopayments::Models::LicenseActivateParams
+
+  LicenseDeactivateParams = Dodopayments::Models::LicenseDeactivateParams
+
+  LicenseKey = Dodopayments::Models::LicenseKey
+
+  LicenseKeyDuration = Dodopayments::Models::LicenseKeyDuration
+
+  LicenseKeyInstance = Dodopayments::Models::LicenseKeyInstance
+
+  LicenseKeyInstanceListParams = Dodopayments::Models::LicenseKeyInstanceListParams
+
+  LicenseKeyInstanceRetrieveParams = Dodopayments::Models::LicenseKeyInstanceRetrieveParams
+
+  LicenseKeyInstanceUpdateParams = Dodopayments::Models::LicenseKeyInstanceUpdateParams
+
+  LicenseKeyListParams = Dodopayments::Models::LicenseKeyListParams
+
+  LicenseKeyRetrieveParams = Dodopayments::Models::LicenseKeyRetrieveParams
+
+  LicenseKeyStatus = Dodopayments::Models::LicenseKeyStatus
+
+  LicenseKeyUpdateParams = Dodopayments::Models::LicenseKeyUpdateParams
+
+  LicenseValidateParams = Dodopayments::Models::LicenseValidateParams
+
+  MiscListSupportedCountriesParams = Dodopayments::Models::MiscListSupportedCountriesParams
+
+  OneTimeProductCartItem = Dodopayments::Models::OneTimeProductCartItem
+
+  Payment = Dodopayments::Models::Payment
+
+  PaymentCreateParams = Dodopayments::Models::PaymentCreateParams
+
+  PaymentListParams = Dodopayments::Models::PaymentListParams
+
+  PaymentRetrieveParams = Dodopayments::Models::PaymentRetrieveParams
+
+  PayoutListParams = Dodopayments::Models::PayoutListParams
+
+  Price = Dodopayments::Models::Price
+
+  Product = Dodopayments::Models::Product
+
+  ProductCreateParams = Dodopayments::Models::ProductCreateParams
+
+  ProductDeleteParams = Dodopayments::Models::ProductDeleteParams
+
+  ProductListParams = Dodopayments::Models::ProductListParams
+
+  ProductRetrieveParams = Dodopayments::Models::ProductRetrieveParams
+
+  Products = Dodopayments::Models::Products
+
+  ProductUnarchiveParams = Dodopayments::Models::ProductUnarchiveParams
+
+  ProductUpdateParams = Dodopayments::Models::ProductUpdateParams
+
+  Refund = Dodopayments::Models::Refund
+
+  RefundCreateParams = Dodopayments::Models::RefundCreateParams
+
+  RefundListParams = Dodopayments::Models::RefundListParams
+
+  RefundRetrieveParams = Dodopayments::Models::RefundRetrieveParams
+
+  RefundStatus = Dodopayments::Models::RefundStatus
+
+  Subscription = Dodopayments::Models::Subscription
+
+  SubscriptionChangePlanParams = Dodopayments::Models::SubscriptionChangePlanParams
+
+  SubscriptionChargeParams = Dodopayments::Models::SubscriptionChargeParams
+
+  SubscriptionCreateParams = Dodopayments::Models::SubscriptionCreateParams
+
+  SubscriptionListParams = Dodopayments::Models::SubscriptionListParams
+
+  SubscriptionRetrieveParams = Dodopayments::Models::SubscriptionRetrieveParams
+
+  SubscriptionStatus = Dodopayments::Models::SubscriptionStatus
+
+  SubscriptionUpdateParams = Dodopayments::Models::SubscriptionUpdateParams
+
+  TaxCategory = Dodopayments::Models::TaxCategory
+
+  TimeInterval = Dodopayments::Models::TimeInterval
+
+  WebhookEvent = Dodopayments::Models::WebhookEvent
+
+  WebhookEventListParams = Dodopayments::Models::WebhookEventListParams
+
+  WebhookEventRetrieveParams = Dodopayments::Models::WebhookEventRetrieveParams
+end

data/lib/dodopayments/resources/addons.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Addons
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::AddonCreateParams} for more details.
+      #
+      # @overload create(currency:, name:, price:, tax_category:, description: nil, request_options: {})
+      #
+      # @param currency [Symbol, Dodopayments::Models::Currency]
+      #
+      # @param name [String] Name of the Addon
+      #
+      # @param price [Integer] Amount of the addon
+      #
+      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory] Represents the different categories of taxation applicable to various products a
+      # ...
+      #
+      # @param description [String, nil] Optional description of the Addon
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::AddonResponse]
+      #
+      # @see Dodopayments::Models::AddonCreateParams
+      def create(params)
+        parsed, options = Dodopayments::Models::AddonCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "addons",
+          body: parsed,
+          model: Dodopayments::Models::AddonResponse,
+          options: options
+        )
+      end
+
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Addon Id
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::AddonResponse]
+      #
+      # @see Dodopayments::Models::AddonRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["addons/%1$s", id],
+          model: Dodopayments::Models::AddonResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::AddonUpdateParams} for more details.
+      #
+      # @overload update(id, currency: nil, description: nil, image_id: nil, name: nil, price: nil, tax_category: nil, request_options: {})
+      #
+      # @param id [String] Addon Id
+      #
+      # @param currency [Symbol, Dodopayments::Models::Currency, nil]
+      #
+      # @param description [String, nil] Description of the Addon, optional and must be at most 1000 characters.
+      #
+      # @param image_id [String, nil] Addon image id after its uploaded to S3
+      #
+      # @param name [String, nil] Name of the Addon, optional and must be at most 100 characters.
+      #
+      # @param price [Integer, nil] Amount of the addon
+      #
+      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory, nil] Represents the different categories of taxation applicable to various products a
+      # ...
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::AddonResponse]
+      #
+      # @see Dodopayments::Models::AddonUpdateParams
+      def update(id, params = {})
+        parsed, options = Dodopayments::Models::AddonUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["addons/%1$s", id],
+          body: parsed,
+          model: Dodopayments::Models::AddonResponse,
+          options: options
+        )
+      end
+
+      # @overload list(page_number: nil, page_size: nil, request_options: {})
+      #
+      # @param page_number [Integer, nil] Page number default is 0
+      #
+      # @param page_size [Integer, nil] Page size default is 10 max is 100
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::AddonResponse>]
+      #
+      # @see Dodopayments::Models::AddonListParams
+      def list(params = {})
+        parsed, options = Dodopayments::Models::AddonListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "addons",
+          query: parsed,
+          page: Dodopayments::Internal::DefaultPageNumberPagination,
+          model: Dodopayments::Models::AddonResponse,
+          options: options
+        )
+      end
+
+      # @overload update_images(id, request_options: {})
+      #
+      # @param id [String] Addon Id
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::AddonUpdateImagesResponse]
+      #
+      # @see Dodopayments::Models::AddonUpdateImagesParams
+      def update_images(id, params = {})
+        @client.request(
+          method: :put,
+          path: ["addons/%1$s/images", id],
+          model: Dodopayments::Models::AddonUpdateImagesResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/disputes.rb

@@ -9,14 +9,14 @@ module Dodopayments
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Dodopayments::Models::Dispute]
+      # @return [Dodopayments::Models::DisputeRetrieveResponse]
       #
       # @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::Models::DisputeRetrieveResponse,
           options: params[:request_options]
         )
       end
@@ -39,7 +39,7 @@ module Dodopayments
       #
       # @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 = {})
@@ -49,7 +49,7 @@ module Dodopayments
           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/payments.rb

@@ -16,7 +16,7 @@ module Dodopayments
       #
       # @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentCreateParams::AllowedPaymentMethodType>, nil] List of payment methods allowed during checkout. ...
       #
-      # @param billing_currency [Symbol, Dodopayments::Models::PaymentCreateParams::BillingCurrency, nil]
+      # @param billing_currency [Symbol, Dodopayments::Models::Currency, nil]
       #
       # @param discount_code [String, nil] Discount Code to apply to the transaction
       #

data/lib/dodopayments/resources/products.rb

@@ -13,7 +13,7 @@ module Dodopayments
       #
       # @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice]
       #
-      # @param tax_category [Symbol, Dodopayments::Models::ProductCreateParams::TaxCategory] Represents the different categories of taxation applicable to various products a
+      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory] Represents the different categories of taxation applicable to various products a
       # ...
       #
       # @param addons [Array<String>, nil] Addons available for subscription product
@@ -89,7 +89,7 @@ module Dodopayments
       #
       # @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil]
       #
-      # @param tax_category [Symbol, Dodopayments::Models::ProductUpdateParams::TaxCategory, nil] Represents the different categories of taxation applicable to various products a
+      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory, nil] Represents the different categories of taxation applicable to various products a
       # ...
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]