dodopayments 0.0.1.pre.alpha.0

data/lib/dodopayments/models/refund.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class Refund < Dodopayments::BaseModel
+      # @!attribute business_id
+      #   The unique identifier of the business issuing the refund.
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute created_at
+      #   The timestamp of when the refund was created in UTC.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute payment_id
+      #   The unique identifier of the payment associated with the refund.
+      #
+      #   @return [String]
+      required :payment_id, String
+
+      # @!attribute refund_id
+      #   The unique identifier of the refund.
+      #
+      #   @return [String]
+      required :refund_id, String
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Dodopayments::Models::RefundStatus]
+      required :status, enum: -> { Dodopayments::Models::RefundStatus }
+
+      # @!attribute amount
+      #   The refunded amount.
+      #
+      #   @return [Integer, nil]
+      optional :amount, Integer, nil?: true
+
+      # @!attribute currency
+      #
+      #   @return [Symbol, Dodopayments::Models::Refund::Currency, nil]
+      optional :currency, enum: -> { Dodopayments::Models::Refund::Currency }, nil?: true
+
+      # @!attribute reason
+      #   The reason provided for the refund, if any. Optional.
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!parse
+      #   # @param business_id [String]
+      #   # @param created_at [Time]
+      #   # @param payment_id [String]
+      #   # @param refund_id [String]
+      #   # @param status [Symbol, Dodopayments::Models::RefundStatus]
+      #   # @param amount [Integer, nil]
+      #   # @param currency [Symbol, Dodopayments::Models::Refund::Currency, nil]
+      #   # @param reason [String, nil]
+      #   #
+      #   def initialize(business_id:, created_at:, payment_id:, refund_id:, status:, amount: nil, currency: nil, reason: nil, **) = super
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+
+      # @abstract
+      class Currency < Dodopayments::Enum
+        AED = :AED
+        ALL = :ALL
+        AMD = :AMD
+        ANG = :ANG
+        AOA = :AOA
+        ARS = :ARS
+        AUD = :AUD
+        AWG = :AWG
+        AZN = :AZN
+        BAM = :BAM
+        BBD = :BBD
+        BDT = :BDT
+        BGN = :BGN
+        BHD = :BHD
+        BIF = :BIF
+        BMD = :BMD
+        BND = :BND
+        BOB = :BOB
+        BRL = :BRL
+        BSD = :BSD
+        BWP = :BWP
+        BYN = :BYN
+        BZD = :BZD
+        CAD = :CAD
+        CHF = :CHF
+        CLP = :CLP
+        CNY = :CNY
+        COP = :COP
+        CRC = :CRC
+        CUP = :CUP
+        CVE = :CVE
+        CZK = :CZK
+        DJF = :DJF
+        DKK = :DKK
+        DOP = :DOP
+        DZD = :DZD
+        EGP = :EGP
+        ETB = :ETB
+        EUR = :EUR
+        FJD = :FJD
+        FKP = :FKP
+        GBP = :GBP
+        GEL = :GEL
+        GHS = :GHS
+        GIP = :GIP
+        GMD = :GMD
+        GNF = :GNF
+        GTQ = :GTQ
+        GYD = :GYD
+        HKD = :HKD
+        HNL = :HNL
+        HRK = :HRK
+        HTG = :HTG
+        HUF = :HUF
+        IDR = :IDR
+        ILS = :ILS
+        INR = :INR
+        IQD = :IQD
+        JMD = :JMD
+        JOD = :JOD
+        JPY = :JPY
+        KES = :KES
+        KGS = :KGS
+        KHR = :KHR
+        KMF = :KMF
+        KRW = :KRW
+        KWD = :KWD
+        KYD = :KYD
+        KZT = :KZT
+        LAK = :LAK
+        LBP = :LBP
+        LKR = :LKR
+        LRD = :LRD
+        LSL = :LSL
+        LYD = :LYD
+        MAD = :MAD
+        MDL = :MDL
+        MGA = :MGA
+        MKD = :MKD
+        MMK = :MMK
+        MNT = :MNT
+        MOP = :MOP
+        MRU = :MRU
+        MUR = :MUR
+        MVR = :MVR
+        MWK = :MWK
+        MXN = :MXN
+        MYR = :MYR
+        MZN = :MZN
+        NAD = :NAD
+        NGN = :NGN
+        NIO = :NIO
+        NOK = :NOK
+        NPR = :NPR
+        NZD = :NZD
+        OMR = :OMR
+        PAB = :PAB
+        PEN = :PEN
+        PGK = :PGK
+        PHP = :PHP
+        PKR = :PKR
+        PLN = :PLN
+        PYG = :PYG
+        QAR = :QAR
+        RON = :RON
+        RSD = :RSD
+        RUB = :RUB
+        RWF = :RWF
+        SAR = :SAR
+        SBD = :SBD
+        SCR = :SCR
+        SEK = :SEK
+        SGD = :SGD
+        SHP = :SHP
+        SLE = :SLE
+        SLL = :SLL
+        SOS = :SOS
+        SRD = :SRD
+        SSP = :SSP
+        STN = :STN
+        SVC = :SVC
+        SZL = :SZL
+        THB = :THB
+        TND = :TND
+        TOP = :TOP
+        TRY = :TRY
+        TTD = :TTD
+        TWD = :TWD
+        TZS = :TZS
+        UAH = :UAH
+        UGX = :UGX
+        USD = :USD
+        UYU = :UYU
+        UZS = :UZS
+        VES = :VES
+        VND = :VND
+        VUV = :VUV
+        WST = :WST
+        XAF = :XAF
+        XCD = :XCD
+        XOF = :XOF
+        XPF = :XPF
+        YER = :YER
+        ZAR = :ZAR
+        ZMW = :ZMW
+
+        finalize!
+      end
+    end
+  end
+end

data/lib/dodopayments/models/refund_create_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class RefundCreateParams < Dodopayments::BaseModel
+      # @!parse
+      #   extend Dodopayments::RequestParameters::Converter
+      include Dodopayments::RequestParameters
+
+      # @!attribute payment_id
+      #   The unique identifier of the payment to be refunded.
+      #
+      #   @return [String]
+      required :payment_id, String
+
+      # @!attribute amount
+      #   The amount to be refunded. Must be non-negative. Optional. Partial refunds are
+      #     currently disabled.
+      #
+      #   @return [Integer, nil]
+      optional :amount, Integer, nil?: true
+
+      # @!attribute reason
+      #   The reason for the refund, if any. Maximum length is 3000 characters. Optional.
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!parse
+      #   # @param payment_id [String]
+      #   # @param amount [Integer, nil]
+      #   # @param reason [String, nil]
+      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(payment_id:, amount: nil, reason: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+    end
+  end
+end

data/lib/dodopayments/models/refund_list_params.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class RefundListParams < Dodopayments::BaseModel
+      # @!parse
+      #   extend Dodopayments::RequestParameters::Converter
+      include Dodopayments::RequestParameters
+
+      # @!attribute created_at_gte
+      #   Get events after this created time
+      #
+      #   @return [Time, nil]
+      optional :created_at_gte, Time, nil?: true
+
+      # @!attribute created_at_lte
+      #   Get events created before this time
+      #
+      #   @return [Time, nil]
+      optional :created_at_lte, Time, nil?: true
+
+      # @!attribute customer_id
+      #   Filter by customer_id
+      #
+      #   @return [String, nil]
+      optional :customer_id, String, nil?: true
+
+      # @!attribute page_number
+      #   Page number default is 0
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer, nil?: true
+
+      # @!attribute page_size
+      #   Page size default is 10 max is 100
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer, nil?: true
+
+      # @!attribute status
+      #   Filter by status
+      #
+      #   @return [Symbol, Dodopayments::Models::RefundStatus, nil]
+      optional :status, enum: -> { Dodopayments::Models::RefundStatus }, nil?: true
+
+      # @!parse
+      #   # @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}]
+      #   #
+      #   def initialize(
+      #     created_at_gte: nil,
+      #     created_at_lte: nil,
+      #     customer_id: nil,
+      #     page_number: nil,
+      #     page_size: nil,
+      #     status: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+    end
+  end
+end

data/lib/dodopayments/models/refund_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class RefundRetrieveParams < Dodopayments::BaseModel
+      # @!parse
+      #   extend Dodopayments::RequestParameters::Converter
+      include Dodopayments::RequestParameters
+
+      # @!parse
+      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+    end
+  end
+end

data/lib/dodopayments/models/refund_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @abstract
+    class RefundStatus < Dodopayments::Enum
+      SUCCEEDED = :succeeded
+      FAILED = :failed
+      PENDING = :pending
+      REVIEW = :review
+
+      finalize!
+    end
+  end
+end

data/lib/dodopayments/models/subscription.rb

@@ -0,0 +1,309 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class Subscription < Dodopayments::BaseModel
+      # @!attribute created_at
+      #   Timestamp when the subscription was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #
+      #   @return [Symbol, Dodopayments::Models::Subscription::Currency]
+      required :currency, enum: -> { Dodopayments::Models::Subscription::Currency }
+
+      # @!attribute customer
+      #
+      #   @return [Dodopayments::Models::CustomerLimitedDetails]
+      required :customer, -> { Dodopayments::Models::CustomerLimitedDetails }
+
+      # @!attribute metadata
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Dodopayments::HashOf[String]
+
+      # @!attribute next_billing_date
+      #   Timestamp of the next scheduled billing
+      #
+      #   @return [Time]
+      required :next_billing_date, Time
+
+      # @!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 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::BooleanModel
+
+      # @!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
+
+      # @!parse
+      #   # Response struct representing subscription details
+      #   #
+      #   # @param created_at [Time]
+      #   # @param currency [Symbol, Dodopayments::Models::Subscription::Currency]
+      #   # @param customer [Dodopayments::Models::CustomerLimitedDetails]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param next_billing_date [Time]
+      #   # @param payment_frequency_count [Integer]
+      #   # @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval]
+      #   # @param product_id [String]
+      #   # @param quantity [Integer]
+      #   # @param recurring_pre_tax_amount [Integer]
+      #   # @param status [Symbol, Dodopayments::Models::SubscriptionStatus]
+      #   # @param subscription_id [String]
+      #   # @param subscription_period_count [Integer]
+      #   # @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval]
+      #   # @param tax_inclusive [Boolean]
+      #   # @param trial_period_days [Integer]
+      #   # @param cancelled_at [Time, nil]
+      #   # @param discount_id [String, nil]
+      #   #
+      #   def initialize(
+      #     created_at:,
+      #     currency:,
+      #     customer:,
+      #     metadata:,
+      #     next_billing_date:,
+      #     payment_frequency_count:,
+      #     payment_frequency_interval:,
+      #     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,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+
+      # @abstract
+      class Currency < Dodopayments::Enum
+        AED = :AED
+        ALL = :ALL
+        AMD = :AMD
+        ANG = :ANG
+        AOA = :AOA
+        ARS = :ARS
+        AUD = :AUD
+        AWG = :AWG
+        AZN = :AZN
+        BAM = :BAM
+        BBD = :BBD
+        BDT = :BDT
+        BGN = :BGN
+        BHD = :BHD
+        BIF = :BIF
+        BMD = :BMD
+        BND = :BND
+        BOB = :BOB
+        BRL = :BRL
+        BSD = :BSD
+        BWP = :BWP
+        BYN = :BYN
+        BZD = :BZD
+        CAD = :CAD
+        CHF = :CHF
+        CLP = :CLP
+        CNY = :CNY
+        COP = :COP
+        CRC = :CRC
+        CUP = :CUP
+        CVE = :CVE
+        CZK = :CZK
+        DJF = :DJF
+        DKK = :DKK
+        DOP = :DOP
+        DZD = :DZD
+        EGP = :EGP
+        ETB = :ETB
+        EUR = :EUR
+        FJD = :FJD
+        FKP = :FKP
+        GBP = :GBP
+        GEL = :GEL
+        GHS = :GHS
+        GIP = :GIP
+        GMD = :GMD
+        GNF = :GNF
+        GTQ = :GTQ
+        GYD = :GYD
+        HKD = :HKD
+        HNL = :HNL
+        HRK = :HRK
+        HTG = :HTG
+        HUF = :HUF
+        IDR = :IDR
+        ILS = :ILS
+        INR = :INR
+        IQD = :IQD
+        JMD = :JMD
+        JOD = :JOD
+        JPY = :JPY
+        KES = :KES
+        KGS = :KGS
+        KHR = :KHR
+        KMF = :KMF
+        KRW = :KRW
+        KWD = :KWD
+        KYD = :KYD
+        KZT = :KZT
+        LAK = :LAK
+        LBP = :LBP
+        LKR = :LKR
+        LRD = :LRD
+        LSL = :LSL
+        LYD = :LYD
+        MAD = :MAD
+        MDL = :MDL
+        MGA = :MGA
+        MKD = :MKD
+        MMK = :MMK
+        MNT = :MNT
+        MOP = :MOP
+        MRU = :MRU
+        MUR = :MUR
+        MVR = :MVR
+        MWK = :MWK
+        MXN = :MXN
+        MYR = :MYR
+        MZN = :MZN
+        NAD = :NAD
+        NGN = :NGN
+        NIO = :NIO
+        NOK = :NOK
+        NPR = :NPR
+        NZD = :NZD
+        OMR = :OMR
+        PAB = :PAB
+        PEN = :PEN
+        PGK = :PGK
+        PHP = :PHP
+        PKR = :PKR
+        PLN = :PLN
+        PYG = :PYG
+        QAR = :QAR
+        RON = :RON
+        RSD = :RSD
+        RUB = :RUB
+        RWF = :RWF
+        SAR = :SAR
+        SBD = :SBD
+        SCR = :SCR
+        SEK = :SEK
+        SGD = :SGD
+        SHP = :SHP
+        SLE = :SLE
+        SLL = :SLL
+        SOS = :SOS
+        SRD = :SRD
+        SSP = :SSP
+        STN = :STN
+        SVC = :SVC
+        SZL = :SZL
+        THB = :THB
+        TND = :TND
+        TOP = :TOP
+        TRY = :TRY
+        TTD = :TTD
+        TWD = :TWD
+        TZS = :TZS
+        UAH = :UAH
+        UGX = :UGX
+        USD = :USD
+        UYU = :UYU
+        UZS = :UZS
+        VES = :VES
+        VND = :VND
+        VUV = :VUV
+        WST = :WST
+        XAF = :XAF
+        XCD = :XCD
+        XOF = :XOF
+        XPF = :XPF
+        YER = :YER
+        ZAR = :ZAR
+        ZMW = :ZMW
+
+        finalize!
+      end
+    end
+  end
+end