dodopayments 0.0.1.pre.alpha.0

data/lib/dodopayments/models/product_create_params.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class ProductCreateParams < Dodopayments::BaseModel
+      # @!parse
+      #   extend Dodopayments::RequestParameters::Converter
+      include Dodopayments::RequestParameters
+
+      # @!attribute price
+      #
+      #   @return [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice]
+      required :price, union: -> { Dodopayments::Models::Price }
+
+      # @!attribute tax_category
+      #   Represents the different categories of taxation applicable to various products
+      #     and services.
+      #
+      #   @return [Symbol, Dodopayments::Models::ProductCreateParams::TaxCategory]
+      required :tax_category, enum: -> { Dodopayments::Models::ProductCreateParams::TaxCategory }
+
+      # @!attribute addons
+      #   Addons available for subscription product
+      #
+      #   @return [Array<String>, nil]
+      optional :addons, Dodopayments::ArrayOf[String], nil?: true
+
+      # @!attribute description
+      #   Optional description of the product
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute license_key_activation_message
+      #   Optional message displayed during license key activation
+      #
+      #   @return [String, nil]
+      optional :license_key_activation_message, String, nil?: true
+
+      # @!attribute license_key_activations_limit
+      #   The number of times the license key can be activated. Must be 0 or greater
+      #
+      #   @return [Integer, nil]
+      optional :license_key_activations_limit, Integer, nil?: true
+
+      # @!attribute license_key_duration
+      #
+      #   @return [Dodopayments::Models::LicenseKeyDuration, nil]
+      optional :license_key_duration, -> { Dodopayments::Models::LicenseKeyDuration }, nil?: true
+
+      # @!attribute license_key_enabled
+      #   When true, generates and sends a license key to your customer. Defaults to false
+      #
+      #   @return [Boolean, nil]
+      optional :license_key_enabled, Dodopayments::BooleanModel, nil?: true
+
+      # @!attribute name
+      #   Optional name of the product
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!parse
+      #   # @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice]
+      #   # @param tax_category [Symbol, Dodopayments::Models::ProductCreateParams::TaxCategory]
+      #   # @param addons [Array<String>, nil]
+      #   # @param description [String, nil]
+      #   # @param license_key_activation_message [String, nil]
+      #   # @param license_key_activations_limit [Integer, nil]
+      #   # @param license_key_duration [Dodopayments::Models::LicenseKeyDuration, nil]
+      #   # @param license_key_enabled [Boolean, nil]
+      #   # @param name [String, nil]
+      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     price:,
+      #     tax_category:,
+      #     addons: nil,
+      #     description: nil,
+      #     license_key_activation_message: nil,
+      #     license_key_activations_limit: nil,
+      #     license_key_duration: nil,
+      #     license_key_enabled: nil,
+      #     name: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+
+      # @abstract
+      #
+      # Represents the different categories of taxation applicable to various products
+      #   and services.
+      class TaxCategory < Dodopayments::Enum
+        DIGITAL_PRODUCTS = :digital_products
+        SAAS = :saas
+        E_BOOK = :e_book
+        EDTECH = :edtech
+
+        finalize!
+      end
+    end
+  end
+end

data/lib/dodopayments/models/product_delete_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class ProductDeleteParams < 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/product_list_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class ProductListParams < Dodopayments::BaseModel
+      # @!parse
+      #   extend Dodopayments::RequestParameters::Converter
+      include Dodopayments::RequestParameters
+
+      # @!attribute [r] archived
+      #   List archived products
+      #
+      #   @return [Boolean, nil]
+      optional :archived, Dodopayments::BooleanModel
+
+      # @!parse
+      #   # @return [Boolean]
+      #   attr_writer :archived
+
+      # @!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 recurring
+      #   Filter products by pricing type:
+      #
+      #     - `true`: Show only recurring pricing products (e.g. subscriptions)
+      #     - `false`: Show only one-time price products
+      #     - `null` or absent: Show both types of products
+      #
+      #   @return [Boolean, nil]
+      optional :recurring, Dodopayments::BooleanModel, nil?: true
+
+      # @!parse
+      #   # @param archived [Boolean]
+      #   # @param page_number [Integer, nil]
+      #   # @param page_size [Integer, nil]
+      #   # @param recurring [Boolean, nil]
+      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(archived: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+    end
+  end
+end

data/lib/dodopayments/models/product_list_response.rb

@@ -0,0 +1,293 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class ProductListResponse < Dodopayments::BaseModel
+      # @!attribute business_id
+      #   Unique identifier for the business to which the product belongs.
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute created_at
+      #   Timestamp when the product was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute is_recurring
+      #   Indicates if the product is recurring (e.g., subscriptions).
+      #
+      #   @return [Boolean]
+      required :is_recurring, Dodopayments::BooleanModel
+
+      # @!attribute product_id
+      #   Unique identifier for the product.
+      #
+      #   @return [String]
+      required :product_id, String
+
+      # @!attribute tax_category
+      #   Represents the different categories of taxation applicable to various products
+      #     and services.
+      #
+      #   @return [Symbol, Dodopayments::Models::ProductListResponse::TaxCategory]
+      required :tax_category, enum: -> { Dodopayments::Models::ProductListResponse::TaxCategory }
+
+      # @!attribute updated_at
+      #   Timestamp when the product was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute currency
+      #
+      #   @return [Symbol, Dodopayments::Models::ProductListResponse::Currency, nil]
+      optional :currency, enum: -> { Dodopayments::Models::ProductListResponse::Currency }, nil?: true
+
+      # @!attribute description
+      #   Description of the product, optional.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute image
+      #   URL of the product image, optional.
+      #
+      #   @return [String, nil]
+      optional :image, String, nil?: true
+
+      # @!attribute name
+      #   Name of the product, optional.
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute price
+      #   Price of the product, optional.
+      #
+      #     The price is represented in the lowest denomination of the currency. For
+      #     example:
+      #
+      #     - In USD, a price of `$12.34` would be represented as `1234` (cents).
+      #     - In JPY, a price of `¥1500` would be represented as `1500` (yen).
+      #     - In INR, a price of `₹1234.56` would be represented as `123456` (paise).
+      #
+      #     This ensures precision and avoids floating-point rounding errors.
+      #
+      #   @return [Integer, nil]
+      optional :price, Integer, nil?: true
+
+      # @!attribute price_detail
+      #
+      #   @return [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil]
+      optional :price_detail, union: -> { Dodopayments::Models::Price }, nil?: true
+
+      # @!attribute tax_inclusive
+      #   Indicates if the price is tax inclusive
+      #
+      #   @return [Boolean, nil]
+      optional :tax_inclusive, Dodopayments::BooleanModel, nil?: true
+
+      # @!parse
+      #   # @param business_id [String]
+      #   # @param created_at [Time]
+      #   # @param is_recurring [Boolean]
+      #   # @param product_id [String]
+      #   # @param tax_category [Symbol, Dodopayments::Models::ProductListResponse::TaxCategory]
+      #   # @param updated_at [Time]
+      #   # @param currency [Symbol, Dodopayments::Models::ProductListResponse::Currency, nil]
+      #   # @param description [String, nil]
+      #   # @param image [String, nil]
+      #   # @param name [String, nil]
+      #   # @param price [Integer, nil]
+      #   # @param price_detail [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil]
+      #   # @param tax_inclusive [Boolean, nil]
+      #   #
+      #   def initialize(
+      #     business_id:,
+      #     created_at:,
+      #     is_recurring:,
+      #     product_id:,
+      #     tax_category:,
+      #     updated_at:,
+      #     currency: nil,
+      #     description: nil,
+      #     image: nil,
+      #     name: nil,
+      #     price: nil,
+      #     price_detail: nil,
+      #     tax_inclusive: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+
+      # @abstract
+      #
+      # Represents the different categories of taxation applicable to various products
+      #   and services.
+      class TaxCategory < Dodopayments::Enum
+        DIGITAL_PRODUCTS = :digital_products
+        SAAS = :saas
+        E_BOOK = :e_book
+        EDTECH = :edtech
+
+        finalize!
+      end
+
+      # @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/product_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class ProductRetrieveParams < 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/product_unarchive_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class ProductUnarchiveParams < 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/product_update_params.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class ProductUpdateParams < Dodopayments::BaseModel
+      # @!parse
+      #   extend Dodopayments::RequestParameters::Converter
+      include Dodopayments::RequestParameters
+
+      # @!attribute addons
+      #   Available Addons for subscription products
+      #
+      #   @return [Array<String>, nil]
+      optional :addons, Dodopayments::ArrayOf[String], nil?: true
+
+      # @!attribute description
+      #   Description of the product, optional and must be at most 1000 characters.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute image_id
+      #   Product image id after its uploaded to S3
+      #
+      #   @return [String, nil]
+      optional :image_id, String, nil?: true
+
+      # @!attribute license_key_activation_message
+      #   Message sent to the customer upon license key activation.
+      #
+      #     Only applicable if `license_key_enabled` is `true`. This message contains
+      #     instructions for activating the license key.
+      #
+      #   @return [String, nil]
+      optional :license_key_activation_message, String, nil?: true
+
+      # @!attribute license_key_activations_limit
+      #   Limit for the number of activations for the license key.
+      #
+      #     Only applicable if `license_key_enabled` is `true`. Represents the maximum
+      #     number of times the license key can be activated.
+      #
+      #   @return [Integer, nil]
+      optional :license_key_activations_limit, Integer, nil?: true
+
+      # @!attribute license_key_duration
+      #
+      #   @return [Dodopayments::Models::LicenseKeyDuration, nil]
+      optional :license_key_duration, -> { Dodopayments::Models::LicenseKeyDuration }, nil?: true
+
+      # @!attribute license_key_enabled
+      #   Whether the product requires a license key.
+      #
+      #     If `true`, additional fields related to license key (duration, activations
+      #     limit, activation message) become applicable.
+      #
+      #   @return [Boolean, nil]
+      optional :license_key_enabled, Dodopayments::BooleanModel, nil?: true
+
+      # @!attribute name
+      #   Name of the product, optional and must be at most 100 characters.
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute price
+      #
+      #   @return [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil]
+      optional :price, union: -> { Dodopayments::Models::Price }, nil?: true
+
+      # @!attribute tax_category
+      #   Represents the different categories of taxation applicable to various products
+      #     and services.
+      #
+      #   @return [Symbol, Dodopayments::Models::ProductUpdateParams::TaxCategory, nil]
+      optional :tax_category, enum: -> { Dodopayments::Models::ProductUpdateParams::TaxCategory }, nil?: true
+
+      # @!parse
+      #   # @param addons [Array<String>, nil]
+      #   # @param description [String, nil]
+      #   # @param image_id [String, nil]
+      #   # @param license_key_activation_message [String, nil]
+      #   # @param license_key_activations_limit [Integer, nil]
+      #   # @param license_key_duration [Dodopayments::Models::LicenseKeyDuration, nil]
+      #   # @param license_key_enabled [Boolean, nil]
+      #   # @param name [String, nil]
+      #   # @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil]
+      #   # @param tax_category [Symbol, Dodopayments::Models::ProductUpdateParams::TaxCategory, nil]
+      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     addons: nil,
+      #     description: nil,
+      #     image_id: nil,
+      #     license_key_activation_message: nil,
+      #     license_key_activations_limit: nil,
+      #     license_key_duration: nil,
+      #     license_key_enabled: nil,
+      #     name: nil,
+      #     price: nil,
+      #     tax_category: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Dodopayments::BaseModel) -> void
+
+      # @abstract
+      #
+      # Represents the different categories of taxation applicable to various products
+      #   and services.
+      class TaxCategory < Dodopayments::Enum
+        DIGITAL_PRODUCTS = :digital_products
+        SAAS = :saas
+        E_BOOK = :e_book
+        EDTECH = :edtech
+
+        finalize!
+      end
+    end
+  end
+end

data/lib/dodopayments/models/products/image_update_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Products
+      class ImageUpdateParams < Dodopayments::BaseModel
+        # @!parse
+        #   extend Dodopayments::RequestParameters::Converter
+        include Dodopayments::RequestParameters
+
+        # @!attribute force_update
+        #
+        #   @return [Boolean, nil]
+        optional :force_update, Dodopayments::BooleanModel, nil?: true
+
+        # @!parse
+        #   # @param force_update [Boolean, nil]
+        #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(force_update: nil, request_options: {}, **) = super
+
+        # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/dodopayments/models/products/image_update_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Products
+      class ImageUpdateResponse < Dodopayments::BaseModel
+        # @!attribute url
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute image_id
+        #
+        #   @return [String, nil]
+        optional :image_id, String, nil?: true
+
+        # @!parse
+        #   # @param url [String]
+        #   # @param image_id [String, nil]
+        #   #
+        #   def initialize(url:, image_id: nil, **) = super
+
+        # def initialize: (Hash | Dodopayments::BaseModel) -> void
+      end
+    end
+  end
+end