dodopayments 0.0.1.pre.alpha.0

data/rbi/lib/dodopayments/models/subscription.rbi

@@ -0,0 +1,397 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class Subscription < Dodopayments::BaseModel
+      # Timestamp when the subscription was created
+      sig { returns(Time) }
+      def created_at
+      end
+
+      sig { params(_: Time).returns(Time) }
+      def created_at=(_)
+      end
+
+      sig { returns(Symbol) }
+      def currency
+      end
+
+      sig { params(_: Symbol).returns(Symbol) }
+      def currency=(_)
+      end
+
+      sig { returns(Dodopayments::Models::CustomerLimitedDetails) }
+      def customer
+      end
+
+      sig do
+        params(_: Dodopayments::Models::CustomerLimitedDetails)
+          .returns(Dodopayments::Models::CustomerLimitedDetails)
+      end
+      def customer=(_)
+      end
+
+      sig { returns(T::Hash[Symbol, String]) }
+      def metadata
+      end
+
+      sig { params(_: T::Hash[Symbol, String]).returns(T::Hash[Symbol, String]) }
+      def metadata=(_)
+      end
+
+      # Timestamp of the next scheduled billing
+      sig { returns(Time) }
+      def next_billing_date
+      end
+
+      sig { params(_: Time).returns(Time) }
+      def next_billing_date=(_)
+      end
+
+      # Number of payment frequency intervals
+      sig { returns(Integer) }
+      def payment_frequency_count
+      end
+
+      sig { params(_: Integer).returns(Integer) }
+      def payment_frequency_count=(_)
+      end
+
+      sig { returns(Symbol) }
+      def payment_frequency_interval
+      end
+
+      sig { params(_: Symbol).returns(Symbol) }
+      def payment_frequency_interval=(_)
+      end
+
+      # Identifier of the product associated with this subscription
+      sig { returns(String) }
+      def product_id
+      end
+
+      sig { params(_: String).returns(String) }
+      def product_id=(_)
+      end
+
+      # Number of units/items included in the subscription
+      sig { returns(Integer) }
+      def quantity
+      end
+
+      sig { params(_: Integer).returns(Integer) }
+      def quantity=(_)
+      end
+
+      # Amount charged before tax for each recurring payment in smallest currency unit
+      #   (e.g. cents)
+      sig { returns(Integer) }
+      def recurring_pre_tax_amount
+      end
+
+      sig { params(_: Integer).returns(Integer) }
+      def recurring_pre_tax_amount=(_)
+      end
+
+      sig { returns(Symbol) }
+      def status
+      end
+
+      sig { params(_: Symbol).returns(Symbol) }
+      def status=(_)
+      end
+
+      # Unique identifier for the subscription
+      sig { returns(String) }
+      def subscription_id
+      end
+
+      sig { params(_: String).returns(String) }
+      def subscription_id=(_)
+      end
+
+      # Number of subscription period intervals
+      sig { returns(Integer) }
+      def subscription_period_count
+      end
+
+      sig { params(_: Integer).returns(Integer) }
+      def subscription_period_count=(_)
+      end
+
+      sig { returns(Symbol) }
+      def subscription_period_interval
+      end
+
+      sig { params(_: Symbol).returns(Symbol) }
+      def subscription_period_interval=(_)
+      end
+
+      # Indicates if the recurring_pre_tax_amount is tax inclusive
+      sig { returns(T::Boolean) }
+      def tax_inclusive
+      end
+
+      sig { params(_: T::Boolean).returns(T::Boolean) }
+      def tax_inclusive=(_)
+      end
+
+      # Number of days in the trial period (0 if no trial)
+      sig { returns(Integer) }
+      def trial_period_days
+      end
+
+      sig { params(_: Integer).returns(Integer) }
+      def trial_period_days=(_)
+      end
+
+      # Cancelled timestamp if the subscription is cancelled
+      sig { returns(T.nilable(Time)) }
+      def cancelled_at
+      end
+
+      sig { params(_: T.nilable(Time)).returns(T.nilable(Time)) }
+      def cancelled_at=(_)
+      end
+
+      # The discount id if discount is applied
+      sig { returns(T.nilable(String)) }
+      def discount_id
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def discount_id=(_)
+      end
+
+      # Response struct representing subscription details
+      sig do
+        params(
+          created_at: Time,
+          currency: Symbol,
+          customer: Dodopayments::Models::CustomerLimitedDetails,
+          metadata: T::Hash[Symbol, String],
+          next_billing_date: Time,
+          payment_frequency_count: Integer,
+          payment_frequency_interval: Symbol,
+          product_id: String,
+          quantity: Integer,
+          recurring_pre_tax_amount: Integer,
+          status: Symbol,
+          subscription_id: String,
+          subscription_period_count: Integer,
+          subscription_period_interval: Symbol,
+          tax_inclusive: T::Boolean,
+          trial_period_days: Integer,
+          cancelled_at: T.nilable(Time),
+          discount_id: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        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
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              created_at: Time,
+              currency: Symbol,
+              customer: Dodopayments::Models::CustomerLimitedDetails,
+              metadata: T::Hash[Symbol, String],
+              next_billing_date: Time,
+              payment_frequency_count: Integer,
+              payment_frequency_interval: Symbol,
+              product_id: String,
+              quantity: Integer,
+              recurring_pre_tax_amount: Integer,
+              status: Symbol,
+              subscription_id: String,
+              subscription_period_count: Integer,
+              subscription_period_interval: Symbol,
+              tax_inclusive: T::Boolean,
+              trial_period_days: Integer,
+              cancelled_at: T.nilable(Time),
+              discount_id: T.nilable(String)
+            }
+          )
+      end
+      def to_hash
+      end
+
+      class Currency < Dodopayments::Enum
+        abstract!
+
+        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
+
+        class << self
+          sig { override.returns(T::Array[Symbol]) }
+          def values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lib/dodopayments/models/subscription_create_params.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class SubscriptionCreateParams < Dodopayments::BaseModel
+      extend Dodopayments::RequestParameters::Converter
+      include Dodopayments::RequestParameters
+
+      sig { returns(Dodopayments::Models::BillingAddress) }
+      def billing
+      end
+
+      sig { params(_: Dodopayments::Models::BillingAddress).returns(Dodopayments::Models::BillingAddress) }
+      def billing=(_)
+      end
+
+      sig { returns(T.any(Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer)) }
+      def customer
+      end
+
+      sig do
+        params(_: T.any(Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer))
+          .returns(T.any(Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer))
+      end
+      def customer=(_)
+      end
+
+      # Unique identifier of the product to subscribe to
+      sig { returns(String) }
+      def product_id
+      end
+
+      sig { params(_: String).returns(String) }
+      def product_id=(_)
+      end
+
+      # Number of units to subscribe for. Must be at least 1.
+      sig { returns(Integer) }
+      def quantity
+      end
+
+      sig { params(_: Integer).returns(Integer) }
+      def quantity=(_)
+      end
+
+      # Discount Code to apply to the subscription
+      sig { returns(T.nilable(String)) }
+      def discount_code
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def discount_code=(_)
+      end
+
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      def metadata
+      end
+
+      sig { params(_: T::Hash[Symbol, String]).returns(T::Hash[Symbol, String]) }
+      def metadata=(_)
+      end
+
+      # If true, generates a payment link. Defaults to false if not specified.
+      sig { returns(T.nilable(T::Boolean)) }
+      def payment_link
+      end
+
+      sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
+      def payment_link=(_)
+      end
+
+      # Optional URL to redirect after successful subscription creation
+      sig { returns(T.nilable(String)) }
+      def return_url
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def return_url=(_)
+      end
+
+      # Tax ID in case the payment is B2B. If tax id validation fails the payment
+      #   creation will fail
+      sig { returns(T.nilable(String)) }
+      def tax_id
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def tax_id=(_)
+      end
+
+      # Optional trial period in days If specified, this value overrides the trial
+      #   period set in the product's price Must be between 0 and 10000 days
+      sig { returns(T.nilable(Integer)) }
+      def trial_period_days
+      end
+
+      sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
+      def trial_period_days=(_)
+      end
+
+      sig do
+        params(
+          billing: Dodopayments::Models::BillingAddress,
+          customer: T.any(Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer),
+          product_id: String,
+          quantity: Integer,
+          discount_code: T.nilable(String),
+          metadata: T::Hash[Symbol, String],
+          payment_link: T.nilable(T::Boolean),
+          return_url: T.nilable(String),
+          tax_id: T.nilable(String),
+          trial_period_days: T.nilable(Integer),
+          request_options: T.any(Dodopayments::RequestOptions, T::Hash[Symbol, T.anything])
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        billing:,
+        customer:,
+        product_id:,
+        quantity:,
+        discount_code: nil,
+        metadata: nil,
+        payment_link: nil,
+        return_url: nil,
+        tax_id: nil,
+        trial_period_days: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              billing: Dodopayments::Models::BillingAddress,
+              customer: T.any(Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer),
+              product_id: String,
+              quantity: Integer,
+              discount_code: T.nilable(String),
+              metadata: T::Hash[Symbol, String],
+              payment_link: T.nilable(T::Boolean),
+              return_url: T.nilable(String),
+              tax_id: T.nilable(String),
+              trial_period_days: T.nilable(Integer),
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/dodopayments/models/subscription_create_response.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class SubscriptionCreateResponse < Dodopayments::BaseModel
+      sig { returns(Dodopayments::Models::CustomerLimitedDetails) }
+      def customer
+      end
+
+      sig do
+        params(_: Dodopayments::Models::CustomerLimitedDetails)
+          .returns(Dodopayments::Models::CustomerLimitedDetails)
+      end
+      def customer=(_)
+      end
+
+      sig { returns(T::Hash[Symbol, String]) }
+      def metadata
+      end
+
+      sig { params(_: T::Hash[Symbol, String]).returns(T::Hash[Symbol, String]) }
+      def metadata=(_)
+      end
+
+      # Tax will be added to the amount and charged to the customer on each billing
+      #   cycle
+      sig { returns(Integer) }
+      def recurring_pre_tax_amount
+      end
+
+      sig { params(_: Integer).returns(Integer) }
+      def recurring_pre_tax_amount=(_)
+      end
+
+      # Unique identifier for the subscription
+      sig { returns(String) }
+      def subscription_id
+      end
+
+      sig { params(_: String).returns(String) }
+      def subscription_id=(_)
+      end
+
+      # Client secret used to load Dodo checkout SDK NOTE : Dodo checkout SDK will be
+      #   coming soon
+      sig { returns(T.nilable(String)) }
+      def client_secret
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def client_secret=(_)
+      end
+
+      # The discount id if discount is applied
+      sig { returns(T.nilable(String)) }
+      def discount_id
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def discount_id=(_)
+      end
+
+      # URL to checkout page
+      sig { returns(T.nilable(String)) }
+      def payment_link
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def payment_link=(_)
+      end
+
+      sig do
+        params(
+          customer: Dodopayments::Models::CustomerLimitedDetails,
+          metadata: T::Hash[Symbol, String],
+          recurring_pre_tax_amount: Integer,
+          subscription_id: String,
+          client_secret: T.nilable(String),
+          discount_id: T.nilable(String),
+          payment_link: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        customer:,
+        metadata:,
+        recurring_pre_tax_amount:,
+        subscription_id:,
+        client_secret: nil,
+        discount_id: nil,
+        payment_link: nil
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              customer: Dodopayments::Models::CustomerLimitedDetails,
+              metadata: T::Hash[Symbol, String],
+              recurring_pre_tax_amount: Integer,
+              subscription_id: String,
+              client_secret: T.nilable(String),
+              discount_id: T.nilable(String),
+              payment_link: T.nilable(String)
+            }
+          )
+      end
+      def to_hash
+      end
+    end
+  end
+end