dodopayments 0.0.1.pre.alpha.0

data/lib/dodopayments/models/payment.rb

@@ -0,0 +1,339 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class Payment < Dodopayments::BaseModel
+      # @!attribute business_id
+      #   Identifier of the business associated with the payment
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute created_at
+      #   Timestamp when the payment was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #
+      #   @return [Symbol, Dodopayments::Models::Payment::Currency]
+      required :currency, enum: -> { Dodopayments::Models::Payment::Currency }
+
+      # @!attribute customer
+      #
+      #   @return [Dodopayments::Models::CustomerLimitedDetails]
+      required :customer, -> { Dodopayments::Models::CustomerLimitedDetails }
+
+      # @!attribute disputes
+      #   List of disputes associated with this payment
+      #
+      #   @return [Array<Dodopayments::Models::Dispute>]
+      required :disputes, -> { Dodopayments::ArrayOf[Dodopayments::Models::Dispute] }
+
+      # @!attribute metadata
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Dodopayments::HashOf[String]
+
+      # @!attribute payment_id
+      #   Unique identifier for the payment
+      #
+      #   @return [String]
+      required :payment_id, String
+
+      # @!attribute refunds
+      #   List of refunds issued for this payment
+      #
+      #   @return [Array<Dodopayments::Models::Refund>]
+      required :refunds, -> { Dodopayments::ArrayOf[Dodopayments::Models::Refund] }
+
+      # @!attribute total_amount
+      #   Total amount charged to the customer including tax, in smallest currency unit
+      #     (e.g. cents)
+      #
+      #   @return [Integer]
+      required :total_amount, Integer
+
+      # @!attribute discount_id
+      #   The discount id if discount is applied
+      #
+      #   @return [String, nil]
+      optional :discount_id, String, nil?: true
+
+      # @!attribute error_message
+      #   An error message if the payment failed
+      #
+      #   @return [String, nil]
+      optional :error_message, String, nil?: true
+
+      # @!attribute payment_link
+      #   Checkout URL
+      #
+      #   @return [String, nil]
+      optional :payment_link, String, nil?: true
+
+      # @!attribute payment_method
+      #   Payment method used by customer (e.g. "card", "bank_transfer")
+      #
+      #   @return [String, nil]
+      optional :payment_method, String, nil?: true
+
+      # @!attribute payment_method_type
+      #   Specific type of payment method (e.g. "visa", "mastercard")
+      #
+      #   @return [String, nil]
+      optional :payment_method_type, String, nil?: true
+
+      # @!attribute product_cart
+      #   List of products purchased in a one-time payment
+      #
+      #   @return [Array<Dodopayments::Models::Payment::ProductCart>, nil]
+      optional :product_cart,
+               -> { Dodopayments::ArrayOf[Dodopayments::Models::Payment::ProductCart] },
+               nil?: true
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Dodopayments::Models::IntentStatus, nil]
+      optional :status, enum: -> { Dodopayments::Models::IntentStatus }, nil?: true
+
+      # @!attribute subscription_id
+      #   Identifier of the subscription if payment is part of a subscription
+      #
+      #   @return [String, nil]
+      optional :subscription_id, String, nil?: true
+
+      # @!attribute tax
+      #   Amount of tax collected in smallest currency unit (e.g. cents)
+      #
+      #   @return [Integer, nil]
+      optional :tax, Integer, nil?: true
+
+      # @!attribute updated_at
+      #   Timestamp when the payment was last updated
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, nil?: true
+
+      # @!parse
+      #   # @param business_id [String]
+      #   # @param created_at [Time]
+      #   # @param currency [Symbol, Dodopayments::Models::Payment::Currency]
+      #   # @param customer [Dodopayments::Models::CustomerLimitedDetails]
+      #   # @param disputes [Array<Dodopayments::Models::Dispute>]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param payment_id [String]
+      #   # @param refunds [Array<Dodopayments::Models::Refund>]
+      #   # @param total_amount [Integer]
+      #   # @param discount_id [String, nil]
+      #   # @param error_message [String, nil]
+      #   # @param payment_link [String, nil]
+      #   # @param payment_method [String, nil]
+      #   # @param payment_method_type [String, nil]
+      #   # @param product_cart [Array<Dodopayments::Models::Payment::ProductCart>, nil]
+      #   # @param status [Symbol, Dodopayments::Models::IntentStatus, nil]
+      #   # @param subscription_id [String, nil]
+      #   # @param tax [Integer, nil]
+      #   # @param updated_at [Time, nil]
+      #   #
+      #   def initialize(
+      #     business_id:,
+      #     created_at:,
+      #     currency:,
+      #     customer:,
+      #     disputes:,
+      #     metadata:,
+      #     payment_id:,
+      #     refunds:,
+      #     total_amount:,
+      #     discount_id: nil,
+      #     error_message: nil,
+      #     payment_link: nil,
+      #     payment_method: nil,
+      #     payment_method_type: nil,
+      #     product_cart: nil,
+      #     status: nil,
+      #     subscription_id: nil,
+      #     tax: nil,
+      #     updated_at: 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
+
+      class ProductCart < Dodopayments::BaseModel
+        # @!attribute product_id
+        #
+        #   @return [String]
+        required :product_id, String
+
+        # @!attribute quantity
+        #
+        #   @return [Integer]
+        required :quantity, Integer
+
+        # @!parse
+        #   # @param product_id [String]
+        #   # @param quantity [Integer]
+        #   #
+        #   def initialize(product_id:, quantity:, **) = super
+
+        # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/dodopayments/models/payment_create_params.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class PaymentCreateParams < Dodopayments::BaseModel
+      # @!parse
+      #   extend Dodopayments::RequestParameters::Converter
+      include Dodopayments::RequestParameters
+
+      # @!attribute billing
+      #
+      #   @return [Dodopayments::Models::BillingAddress]
+      required :billing, -> { Dodopayments::Models::BillingAddress }
+
+      # @!attribute customer
+      #
+      #   @return [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer]
+      required :customer, union: -> { Dodopayments::Models::CustomerRequest }
+
+      # @!attribute product_cart
+      #   List of products in the cart. Must contain at least 1 and at most 100 items.
+      #
+      #   @return [Array<Dodopayments::Models::OneTimeProductCartItem>]
+      required :product_cart, -> { Dodopayments::ArrayOf[Dodopayments::Models::OneTimeProductCartItem] }
+
+      # @!attribute discount_code
+      #   Discount Code to apply to the transaction
+      #
+      #   @return [String, nil]
+      optional :discount_code, String, nil?: true
+
+      # @!attribute [r] metadata
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Dodopayments::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :metadata
+
+      # @!attribute payment_link
+      #   Whether to generate a payment link. Defaults to false if not specified.
+      #
+      #   @return [Boolean, nil]
+      optional :payment_link, Dodopayments::BooleanModel, nil?: true
+
+      # @!attribute return_url
+      #   Optional URL to redirect the customer after payment. Must be a valid URL if
+      #     provided.
+      #
+      #   @return [String, nil]
+      optional :return_url, String, nil?: true
+
+      # @!attribute tax_id
+      #   Tax ID in case the payment is B2B. If tax id validation fails the payment
+      #     creation will fail
+      #
+      #   @return [String, nil]
+      optional :tax_id, String, nil?: true
+
+      # @!parse
+      #   # @param billing [Dodopayments::Models::BillingAddress]
+      #   # @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer]
+      #   # @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>]
+      #   # @param discount_code [String, nil]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param payment_link [Boolean, nil]
+      #   # @param return_url [String, nil]
+      #   # @param tax_id [String, nil]
+      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     billing:,
+      #     customer:,
+      #     product_cart:,
+      #     discount_code: nil,
+      #     metadata: nil,
+      #     payment_link: nil,
+      #     return_url: nil,
+      #     tax_id: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+    end
+  end
+end

data/lib/dodopayments/models/payment_create_response.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class PaymentCreateResponse < Dodopayments::BaseModel
+      # @!attribute client_secret
+      #   Client secret used to load Dodo checkout SDK NOTE : Dodo checkout SDK will be
+      #     coming soon
+      #
+      #   @return [String]
+      required :client_secret, String
+
+      # @!attribute customer
+      #
+      #   @return [Dodopayments::Models::CustomerLimitedDetails]
+      required :customer, -> { Dodopayments::Models::CustomerLimitedDetails }
+
+      # @!attribute metadata
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Dodopayments::HashOf[String]
+
+      # @!attribute payment_id
+      #   Unique identifier for the payment
+      #
+      #   @return [String]
+      required :payment_id, String
+
+      # @!attribute total_amount
+      #   Total amount of the payment in smallest currency unit (e.g. cents)
+      #
+      #   @return [Integer]
+      required :total_amount, Integer
+
+      # @!attribute discount_id
+      #   The discount id if discount is applied
+      #
+      #   @return [String, nil]
+      optional :discount_id, String, nil?: true
+
+      # @!attribute payment_link
+      #   Optional URL to a hosted payment page
+      #
+      #   @return [String, nil]
+      optional :payment_link, String, nil?: true
+
+      # @!attribute product_cart
+      #   Optional list of products included in the payment
+      #
+      #   @return [Array<Dodopayments::Models::OneTimeProductCartItem>, nil]
+      optional :product_cart,
+               -> { Dodopayments::ArrayOf[Dodopayments::Models::OneTimeProductCartItem] },
+               nil?: true
+
+      # @!parse
+      #   # @param client_secret [String]
+      #   # @param customer [Dodopayments::Models::CustomerLimitedDetails]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param payment_id [String]
+      #   # @param total_amount [Integer]
+      #   # @param discount_id [String, nil]
+      #   # @param payment_link [String, nil]
+      #   # @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>, nil]
+      #   #
+      #   def initialize(
+      #     client_secret:,
+      #     customer:,
+      #     metadata:,
+      #     payment_id:,
+      #     total_amount:,
+      #     discount_id: nil,
+      #     payment_link: nil,
+      #     product_cart: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+    end
+  end
+end

data/lib/dodopayments/models/payment_list_params.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class PaymentListParams < 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::IntentStatus, nil]
+      optional :status, enum: -> { Dodopayments::Models::IntentStatus }, nil?: true
+
+      # @!attribute subscription_id
+      #   Filter by subscription id
+      #
+      #   @return [String, nil]
+      optional :subscription_id, String, 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::IntentStatus, nil]
+      #   # @param subscription_id [String, 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,
+      #     subscription_id: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+    end
+  end
+end