dodopayments 1.20.0 → 1.47.0

data/lib/dodopayments/models/brand_update_images_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Brands#update_images
+    class BrandUpdateImagesResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute image_id
+      #   UUID that will be used as the image identifier/key suffix
+      #
+      #   @return [String]
+      required :image_id, String
+
+      # @!attribute url
+      #   Presigned URL to upload the image
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(image_id:, url:)
+      #   @param image_id [String] UUID that will be used as the image identifier/key suffix
+      #
+      #   @param url [String] Presigned URL to upload the image
+    end
+  end
+end

data/lib/dodopayments/models/brand_update_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Brands#update
+    class BrandUpdateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute image_id
+      #   The UUID you got back from the presigned‐upload call
+      #
+      #   @return [String, nil]
+      optional :image_id, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute statement_descriptor
+      #
+      #   @return [String, nil]
+      optional :statement_descriptor, String, nil?: true
+
+      # @!attribute support_email
+      #
+      #   @return [String, nil]
+      optional :support_email, String, nil?: true
+
+      # @!method initialize(image_id: nil, name: nil, statement_descriptor: nil, support_email: nil, request_options: {})
+      #   @param image_id [String, nil] The UUID you got back from the presigned‐upload call
+      #
+      #   @param name [String, nil]
+      #
+      #   @param statement_descriptor [String, nil]
+      #
+      #   @param support_email [String, nil]
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/create_new_customer.rb

@@ -35,7 +35,6 @@ module Dodopayments
       #   @param name [String]
       #
       #   @param create_new_customer [Boolean] When false, the most recently created customer object with the given email is us
-      #   ...
       #
       #   @param phone_number [String, nil]
     end

data/lib/dodopayments/models/customer_list_params.rb

@@ -7,22 +7,30 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      # @!attribute email
+      #   Filter by customer email
+      #
+      #   @return [String, nil]
+      optional :email, String
+
       # @!attribute page_number
       #   Page number default is 0
       #
       #   @return [Integer, nil]
-      optional :page_number, Integer, nil?: true
+      optional :page_number, Integer
 
       # @!attribute page_size
       #   Page size default is 10 max is 100
       #
       #   @return [Integer, nil]
-      optional :page_size, Integer, nil?: true
+      optional :page_size, Integer
 
-      # @!method initialize(page_number: nil, page_size: nil, request_options: {})
-      #   @param page_number [Integer, nil] Page number default is 0
+      # @!method initialize(email: nil, page_number: nil, page_size: nil, request_options: {})
+      #   @param email [String] Filter by customer email
+      #
+      #   @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}]
     end

data/lib/dodopayments/models/customer_request.rb

@@ -5,12 +5,12 @@ module Dodopayments
     module CustomerRequest
       extend Dodopayments::Internal::Type::Union
 
-      variant -> { Dodopayments::Models::AttachExistingCustomer }
+      variant -> { Dodopayments::AttachExistingCustomer }
 
-      variant -> { Dodopayments::Models::CreateNewCustomer }
+      variant -> { Dodopayments::NewCustomer }
 
       # @!method self.variants
-      #   @return [Array(Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer)]
+      #   @return [Array(Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer)]
     end
   end
 end

data/lib/dodopayments/models/customers/customer_portal_create_params.rb

@@ -12,10 +12,10 @@ module Dodopayments
         #   If true, will send link to user.
         #
         #   @return [Boolean, nil]
-        optional :send_email, Dodopayments::Internal::Type::Boolean, nil?: true
+        optional :send_email, Dodopayments::Internal::Type::Boolean
 
         # @!method initialize(send_email: nil, request_options: {})
-        #   @param send_email [Boolean, nil] If true, will send link to user.
+        #   @param send_email [Boolean] If true, will send link to user.
         #
         #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/dodopayments/models/discount.rb

@@ -51,9 +51,10 @@ module Dodopayments
       required :times_used, Integer
 
       # @!attribute type
+      #   The type of discount, e.g. `percentage`, `flat`, or `flat_per_unit`.
       #
       #   @return [Symbol, Dodopayments::Models::DiscountType]
-      required :type, enum: -> { Dodopayments::Models::DiscountType }
+      required :type, enum: -> { Dodopayments::DiscountType }
 
       # @!attribute expires_at
       #   Optional date/time after which discount is expired.
@@ -67,17 +68,25 @@ module Dodopayments
       #   @return [String, nil]
       optional :name, String, nil?: true
 
+      # @!attribute subscription_cycles
+      #   Number of subscription billing cycles this discount is valid for. If not
+      #   provided, the discount will be applied indefinitely to all recurring payments
+      #   related to the subscription.
+      #
+      #   @return [Integer, nil]
+      optional :subscription_cycles, Integer, nil?: true
+
       # @!attribute usage_limit
       #   Usage limit for this discount, if any.
       #
       #   @return [Integer, nil]
       optional :usage_limit, Integer, nil?: true
 
-      # @!method initialize(amount:, business_id:, code:, created_at:, discount_id:, restricted_to:, times_used:, type:, expires_at: nil, name: nil, usage_limit: nil)
+      # @!method initialize(amount:, business_id:, code:, created_at:, discount_id:, restricted_to:, times_used:, type:, expires_at: nil, name: nil, subscription_cycles: nil, usage_limit: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::Discount} for more details.
       #
-      #   @param amount [Integer] The discount amount. ...
+      #   @param amount [Integer] The discount amount.
       #
       #   @param business_id [String] The business this discount belongs to.
       #
@@ -91,12 +100,14 @@ module Dodopayments
       #
       #   @param times_used [Integer] How many times this discount has been used.
       #
-      #   @param type [Symbol, Dodopayments::Models::DiscountType]
+      #   @param type [Symbol, Dodopayments::Models::DiscountType] The type of discount, e.g. `percentage`, `flat`, or `flat_per_unit`.
       #
       #   @param expires_at [Time, nil] Optional date/time after which discount is expired.
       #
       #   @param name [String, nil] Name for the Discount
       #
+      #   @param subscription_cycles [Integer, nil] Number of subscription billing cycles this discount is valid for.
+      #
       #   @param usage_limit [Integer, nil] Usage limit for this discount, if any.
     end
   end

data/lib/dodopayments/models/discount_create_params.rb

@@ -21,9 +21,10 @@ module Dodopayments
       required :amount, Integer
 
       # @!attribute type
+      #   The discount type (e.g. `percentage`, `flat`, or `flat_per_unit`).
       #
       #   @return [Symbol, Dodopayments::Models::DiscountType]
-      required :type, enum: -> { Dodopayments::Models::DiscountType }
+      required :type, enum: -> { Dodopayments::DiscountType }
 
       # @!attribute code
       #   Optionally supply a code (will be uppercased).
@@ -51,21 +52,29 @@ module Dodopayments
       #   @return [Array<String>, nil]
       optional :restricted_to, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
 
+      # @!attribute subscription_cycles
+      #   Number of subscription billing cycles this discount is valid for. If not
+      #   provided, the discount will be applied indefinitely to all recurring payments
+      #   related to the subscription.
+      #
+      #   @return [Integer, nil]
+      optional :subscription_cycles, Integer, nil?: true
+
       # @!attribute usage_limit
       #   How many times this discount can be used (if any). Must be >= 1 if provided.
       #
       #   @return [Integer, nil]
       optional :usage_limit, Integer, nil?: true
 
-      # @!method initialize(amount:, type:, code: nil, expires_at: nil, name: nil, restricted_to: nil, usage_limit: nil, request_options: {})
+      # @!method initialize(amount:, type:, code: nil, expires_at: nil, name: nil, restricted_to: nil, subscription_cycles: nil, usage_limit: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::DiscountCreateParams} for more details.
       #
-      #   @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.
       #
@@ -73,7 +82,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}]
     end

data/lib/dodopayments/models/discount_list_params.rb

@@ -11,18 +11,18 @@ module Dodopayments
       #   Page number (default = 0).
       #
       #   @return [Integer, nil]
-      optional :page_number, Integer, nil?: true
+      optional :page_number, Integer
 
       # @!attribute page_size
       #   Page size (default = 10, max = 100).
       #
       #   @return [Integer, nil]
-      optional :page_size, Integer, nil?: true
+      optional :page_size, Integer
 
       # @!method initialize(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}]
     end

data/lib/dodopayments/models/discount_update_params.rb

@@ -42,21 +42,30 @@ module Dodopayments
       #   @return [Array<String>, nil]
       optional :restricted_to, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
 
+      # @!attribute subscription_cycles
+      #   Number of subscription billing cycles this discount is valid for. If not
+      #   provided, the discount will be applied indefinitely to all recurring payments
+      #   related to the subscription.
+      #
+      #   @return [Integer, nil]
+      optional :subscription_cycles, Integer, nil?: true
+
       # @!attribute type
+      #   If present, update the discount type.
       #
       #   @return [Symbol, Dodopayments::Models::DiscountType, nil]
-      optional :type, enum: -> { Dodopayments::Models::DiscountType }, nil?: true
+      optional :type, enum: -> { Dodopayments::DiscountType }, nil?: true
 
       # @!attribute usage_limit
       #
       #   @return [Integer, nil]
       optional :usage_limit, Integer, nil?: true
 
-      # @!method initialize(amount: nil, code: nil, expires_at: nil, name: nil, restricted_to: nil, type: nil, usage_limit: nil, request_options: {})
+      # @!method initialize(amount: nil, code: nil, expires_at: nil, name: nil, restricted_to: nil, subscription_cycles: nil, type: nil, usage_limit: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::DiscountUpdateParams} for more details.
       #
-      #   @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).
       #
@@ -64,9 +73,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]
       #

data/lib/dodopayments/models/dispute.rb

@@ -2,7 +2,6 @@
 
 module Dodopayments
   module Models
-    # @see Dodopayments::Resources::Disputes#retrieve
     class Dispute < Dodopayments::Internal::Type::BaseModel
       # @!attribute amount
       #   The amount involved in the dispute, represented as a string to accommodate
@@ -36,14 +35,16 @@ module Dodopayments
       required :dispute_id, String
 
       # @!attribute dispute_stage
+      #   The current stage of the dispute process.
       #
       #   @return [Symbol, Dodopayments::Models::DisputeStage]
-      required :dispute_stage, enum: -> { Dodopayments::Models::DisputeStage }
+      required :dispute_stage, enum: -> { Dodopayments::DisputeStage }
 
       # @!attribute dispute_status
+      #   The current status of the dispute.
       #
       #   @return [Symbol, Dodopayments::Models::DisputeStatus]
-      required :dispute_status, enum: -> { Dodopayments::Models::DisputeStatus }
+      required :dispute_status, enum: -> { Dodopayments::DisputeStatus }
 
       # @!attribute payment_id
       #   The unique identifier of the payment associated with the dispute.
@@ -51,12 +52,17 @@ module Dodopayments
       #   @return [String]
       required :payment_id, String
 
-      # @!method initialize(amount:, business_id:, created_at:, currency:, dispute_id:, dispute_stage:, dispute_status:, payment_id:)
+      # @!attribute remarks
+      #   Remarks
+      #
+      #   @return [String, nil]
+      optional :remarks, String, nil?: true
+
+      # @!method initialize(amount:, business_id:, created_at:, currency:, dispute_id:, dispute_stage:, dispute_status:, payment_id:, remarks: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::Dispute} for more details.
       #
       #   @param amount [String] The amount involved in the dispute, represented as a string to accommodate preci
-      #   ...
       #
       #   @param business_id [String] The unique identifier of the business involved in the dispute.
       #
@@ -66,11 +72,13 @@ module Dodopayments
       #
       #   @param dispute_id [String] The unique identifier of the dispute.
       #
-      #   @param dispute_stage [Symbol, Dodopayments::Models::DisputeStage]
+      #   @param dispute_stage [Symbol, Dodopayments::Models::DisputeStage] The current stage of the dispute process.
       #
-      #   @param dispute_status [Symbol, Dodopayments::Models::DisputeStatus]
+      #   @param dispute_status [Symbol, Dodopayments::Models::DisputeStatus] The current status of the dispute.
       #
       #   @param payment_id [String] The unique identifier of the payment associated with the dispute.
+      #
+      #   @param remarks [String, nil] Remarks
     end
   end
 end

data/lib/dodopayments/models/dispute_list_params.rb

@@ -11,60 +11,88 @@ module Dodopayments
       #   Get events after this created time
       #
       #   @return [Time, nil]
-      optional :created_at_gte, Time, nil?: true
+      optional :created_at_gte, Time
 
       # @!attribute created_at_lte
       #   Get events created before this time
       #
       #   @return [Time, nil]
-      optional :created_at_lte, Time, nil?: true
+      optional :created_at_lte, Time
 
       # @!attribute customer_id
       #   Filter by customer_id
       #
       #   @return [String, nil]
-      optional :customer_id, String, nil?: true
+      optional :customer_id, String
 
       # @!attribute dispute_stage
       #   Filter by dispute stage
       #
-      #   @return [Symbol, Dodopayments::Models::DisputeStage, nil]
-      optional :dispute_stage, enum: -> { Dodopayments::Models::DisputeStage }, nil?: true
+      #   @return [Symbol, Dodopayments::Models::DisputeListParams::DisputeStage, nil]
+      optional :dispute_stage, enum: -> { Dodopayments::DisputeListParams::DisputeStage }
 
       # @!attribute dispute_status
       #   Filter by dispute status
       #
-      #   @return [Symbol, Dodopayments::Models::DisputeStatus, nil]
-      optional :dispute_status, enum: -> { Dodopayments::Models::DisputeStatus }, nil?: true
+      #   @return [Symbol, Dodopayments::Models::DisputeListParams::DisputeStatus, nil]
+      optional :dispute_status, enum: -> { Dodopayments::DisputeListParams::DisputeStatus }
 
       # @!attribute page_number
       #   Page number default is 0
       #
       #   @return [Integer, nil]
-      optional :page_number, Integer, nil?: true
+      optional :page_number, Integer
 
       # @!attribute page_size
       #   Page size default is 10 max is 100
       #
       #   @return [Integer, nil]
-      optional :page_size, Integer, nil?: true
+      optional :page_size, Integer
 
       # @!method initialize(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}]
+
+      # Filter by dispute stage
+      module DisputeStage
+        extend Dodopayments::Internal::Type::Enum
+
+        PRE_DISPUTE = :pre_dispute
+        DISPUTE = :dispute
+        PRE_ARBITRATION = :pre_arbitration
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Filter by dispute status
+      module DisputeStatus
+        extend Dodopayments::Internal::Type::Enum
+
+        DISPUTE_OPENED = :dispute_opened
+        DISPUTE_EXPIRED = :dispute_expired
+        DISPUTE_ACCEPTED = :dispute_accepted
+        DISPUTE_CANCELLED = :dispute_cancelled
+        DISPUTE_CHALLENGED = :dispute_challenged
+        DISPUTE_WON = :dispute_won
+        DISPUTE_LOST = :dispute_lost
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/dodopayments/models/dispute_list_response.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Disputes#list
+    class DisputeListResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute amount
+      #   The amount involved in the dispute, represented as a string to accommodate
+      #   precision.
+      #
+      #   @return [String]
+      required :amount, String
+
+      # @!attribute business_id
+      #   The unique identifier of the business involved in the dispute.
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute created_at
+      #   The timestamp of when the dispute was created, in UTC.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The currency of the disputed amount, represented as an ISO 4217 currency code.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute dispute_id
+      #   The unique identifier of the dispute.
+      #
+      #   @return [String]
+      required :dispute_id, String
+
+      # @!attribute dispute_stage
+      #   The current stage of the dispute process.
+      #
+      #   @return [Symbol, Dodopayments::Models::DisputeStage]
+      required :dispute_stage, enum: -> { Dodopayments::DisputeStage }
+
+      # @!attribute dispute_status
+      #   The current status of the dispute.
+      #
+      #   @return [Symbol, Dodopayments::Models::DisputeStatus]
+      required :dispute_status, enum: -> { Dodopayments::DisputeStatus }
+
+      # @!attribute payment_id
+      #   The unique identifier of the payment associated with the dispute.
+      #
+      #   @return [String]
+      required :payment_id, String
+
+      # @!method initialize(amount:, business_id:, created_at:, currency:, dispute_id:, dispute_stage:, dispute_status:, payment_id:)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::DisputeListResponse} for more details.
+      #
+      #   @param amount [String] The amount involved in the dispute, represented as a string to accommodate preci
+      #
+      #   @param business_id [String] The unique identifier of the business involved in the dispute.
+      #
+      #   @param created_at [Time] The timestamp of when the dispute was created, in UTC.
+      #
+      #   @param currency [String] The currency of the disputed amount, represented as an ISO 4217 currency code.
+      #
+      #   @param dispute_id [String] The unique identifier of the dispute.
+      #
+      #   @param dispute_stage [Symbol, Dodopayments::Models::DisputeStage] The current stage of the dispute process.
+      #
+      #   @param dispute_status [Symbol, Dodopayments::Models::DisputeStatus] The current status of the dispute.
+      #
+      #   @param payment_id [String] The unique identifier of the payment associated with the dispute.
+    end
+  end
+end