dodopayments 1.20.0 → 1.47.0

data/lib/dodopayments/models.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  [Dodopayments::Internal::Type::BaseModel, *Dodopayments::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Dodopayments::Internal::AnyHash) } }
+  end
+
+  Dodopayments::Internal::Util.walk_namespaces(Dodopayments::Models).each do |mod|
+    case mod
+    in Dodopayments::Internal::Type::Enum | Dodopayments::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  Dodopayments::Internal::Util.walk_namespaces(Dodopayments::Models)
+                              .lazy
+                              .grep(Dodopayments::Internal::Type::Union)
+                              .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  AddonCartResponseItem = Dodopayments::Models::AddonCartResponseItem
+
+  AddonCreateParams = Dodopayments::Models::AddonCreateParams
+
+  AddonListParams = Dodopayments::Models::AddonListParams
+
+  AddonResponse = Dodopayments::Models::AddonResponse
+
+  AddonRetrieveParams = Dodopayments::Models::AddonRetrieveParams
+
+  AddonUpdateImagesParams = Dodopayments::Models::AddonUpdateImagesParams
+
+  AddonUpdateParams = Dodopayments::Models::AddonUpdateParams
+
+  AttachAddon = Dodopayments::Models::AttachAddon
+
+  AttachExistingCustomer = Dodopayments::Models::AttachExistingCustomer
+
+  BillingAddress = Dodopayments::Models::BillingAddress
+
+  Brand = Dodopayments::Models::Brand
+
+  BrandCreateParams = Dodopayments::Models::BrandCreateParams
+
+  BrandListParams = Dodopayments::Models::BrandListParams
+
+  BrandRetrieveParams = Dodopayments::Models::BrandRetrieveParams
+
+  BrandUpdateImagesParams = Dodopayments::Models::BrandUpdateImagesParams
+
+  BrandUpdateParams = Dodopayments::Models::BrandUpdateParams
+
+  CountryCode = Dodopayments::Models::CountryCode
+
+  CreateNewCustomer = Dodopayments::Models::CreateNewCustomer
+
+  Currency = Dodopayments::Models::Currency
+
+  Customer = Dodopayments::Models::Customer
+
+  CustomerCreateParams = Dodopayments::Models::CustomerCreateParams
+
+  CustomerLimitedDetails = Dodopayments::Models::CustomerLimitedDetails
+
+  CustomerListParams = Dodopayments::Models::CustomerListParams
+
+  CustomerPortalSession = Dodopayments::Models::CustomerPortalSession
+
+  CustomerRequest = Dodopayments::Models::CustomerRequest
+
+  CustomerRetrieveParams = Dodopayments::Models::CustomerRetrieveParams
+
+  Customers = Dodopayments::Models::Customers
+
+  CustomerUpdateParams = Dodopayments::Models::CustomerUpdateParams
+
+  Discount = Dodopayments::Models::Discount
+
+  DiscountCreateParams = Dodopayments::Models::DiscountCreateParams
+
+  DiscountDeleteParams = Dodopayments::Models::DiscountDeleteParams
+
+  DiscountListParams = Dodopayments::Models::DiscountListParams
+
+  DiscountRetrieveParams = Dodopayments::Models::DiscountRetrieveParams
+
+  DiscountType = Dodopayments::Models::DiscountType
+
+  DiscountUpdateParams = Dodopayments::Models::DiscountUpdateParams
+
+  Dispute = Dodopayments::Models::Dispute
+
+  DisputeListParams = Dodopayments::Models::DisputeListParams
+
+  DisputeRetrieveParams = Dodopayments::Models::DisputeRetrieveParams
+
+  DisputeStage = Dodopayments::Models::DisputeStage
+
+  DisputeStatus = Dodopayments::Models::DisputeStatus
+
+  GetDispute = Dodopayments::Models::GetDispute
+
+  IntentStatus = Dodopayments::Models::IntentStatus
+
+  Invoices = Dodopayments::Models::Invoices
+
+  LicenseActivateParams = Dodopayments::Models::LicenseActivateParams
+
+  LicenseDeactivateParams = Dodopayments::Models::LicenseDeactivateParams
+
+  LicenseKey = Dodopayments::Models::LicenseKey
+
+  LicenseKeyDuration = Dodopayments::Models::LicenseKeyDuration
+
+  LicenseKeyInstance = Dodopayments::Models::LicenseKeyInstance
+
+  LicenseKeyInstanceListParams = Dodopayments::Models::LicenseKeyInstanceListParams
+
+  LicenseKeyInstanceRetrieveParams = Dodopayments::Models::LicenseKeyInstanceRetrieveParams
+
+  LicenseKeyInstanceUpdateParams = Dodopayments::Models::LicenseKeyInstanceUpdateParams
+
+  LicenseKeyListParams = Dodopayments::Models::LicenseKeyListParams
+
+  LicenseKeyRetrieveParams = Dodopayments::Models::LicenseKeyRetrieveParams
+
+  LicenseKeyStatus = Dodopayments::Models::LicenseKeyStatus
+
+  LicenseKeyUpdateParams = Dodopayments::Models::LicenseKeyUpdateParams
+
+  LicenseValidateParams = Dodopayments::Models::LicenseValidateParams
+
+  MiscListSupportedCountriesParams = Dodopayments::Models::MiscListSupportedCountriesParams
+
+  NewCustomer = Dodopayments::Models::NewCustomer
+
+  OneTimeProductCartItem = Dodopayments::Models::OneTimeProductCartItem
+
+  Payment = Dodopayments::Models::Payment
+
+  PaymentCreateParams = Dodopayments::Models::PaymentCreateParams
+
+  PaymentListParams = Dodopayments::Models::PaymentListParams
+
+  PaymentMethodTypes = Dodopayments::Models::PaymentMethodTypes
+
+  PaymentRetrieveLineItemsParams = Dodopayments::Models::PaymentRetrieveLineItemsParams
+
+  PaymentRetrieveParams = Dodopayments::Models::PaymentRetrieveParams
+
+  PayoutListParams = Dodopayments::Models::PayoutListParams
+
+  Price = Dodopayments::Models::Price
+
+  Product = Dodopayments::Models::Product
+
+  ProductCreateParams = Dodopayments::Models::ProductCreateParams
+
+  ProductDeleteParams = Dodopayments::Models::ProductDeleteParams
+
+  ProductListParams = Dodopayments::Models::ProductListParams
+
+  ProductRetrieveParams = Dodopayments::Models::ProductRetrieveParams
+
+  Products = Dodopayments::Models::Products
+
+  ProductUnarchiveParams = Dodopayments::Models::ProductUnarchiveParams
+
+  ProductUpdateFilesParams = Dodopayments::Models::ProductUpdateFilesParams
+
+  ProductUpdateParams = Dodopayments::Models::ProductUpdateParams
+
+  Refund = Dodopayments::Models::Refund
+
+  RefundCreateParams = Dodopayments::Models::RefundCreateParams
+
+  RefundListParams = Dodopayments::Models::RefundListParams
+
+  RefundRetrieveParams = Dodopayments::Models::RefundRetrieveParams
+
+  RefundStatus = Dodopayments::Models::RefundStatus
+
+  Subscription = Dodopayments::Models::Subscription
+
+  SubscriptionChangePlanParams = Dodopayments::Models::SubscriptionChangePlanParams
+
+  SubscriptionChargeParams = Dodopayments::Models::SubscriptionChargeParams
+
+  SubscriptionCreateParams = Dodopayments::Models::SubscriptionCreateParams
+
+  SubscriptionListParams = Dodopayments::Models::SubscriptionListParams
+
+  SubscriptionRetrieveParams = Dodopayments::Models::SubscriptionRetrieveParams
+
+  SubscriptionStatus = Dodopayments::Models::SubscriptionStatus
+
+  SubscriptionUpdateParams = Dodopayments::Models::SubscriptionUpdateParams
+
+  TaxCategory = Dodopayments::Models::TaxCategory
+
+  TimeInterval = Dodopayments::Models::TimeInterval
+
+  WebhookCreateParams = Dodopayments::Models::WebhookCreateParams
+
+  WebhookDeleteParams = Dodopayments::Models::WebhookDeleteParams
+
+  WebhookEventType = Dodopayments::Models::WebhookEventType
+
+  WebhookListParams = Dodopayments::Models::WebhookListParams
+
+  WebhookPayload = Dodopayments::Models::WebhookPayload
+
+  WebhookRetrieveParams = Dodopayments::Models::WebhookRetrieveParams
+
+  Webhooks = Dodopayments::Models::Webhooks
+
+  WebhookUpdateParams = Dodopayments::Models::WebhookUpdateParams
+
+  YourWebhookURLCreateParams = Dodopayments::Models::YourWebhookURLCreateParams
+end

data/lib/dodopayments/request_options.rb

@@ -69,5 +69,9 @@ module Dodopayments
     #   Returns a new instance of RequestOptions.
     #
     #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash) }
+    end
   end
 end

data/lib/dodopayments/resources/addons.rb

@@ -3,19 +3,15 @@
 module Dodopayments
   module Resources
     class Addons
-      # Some parameter documentations has been truncated, see
-      # {Dodopayments::Models::AddonCreateParams} for more details.
-      #
       # @overload create(currency:, name:, price:, tax_category:, description: nil, request_options: {})
       #
-      # @param currency [Symbol, Dodopayments::Models::Currency]
+      # @param currency [Symbol, Dodopayments::Models::Currency] The currency of the Addon
       #
       # @param name [String] Name of the Addon
       #
       # @param price [Integer] Amount of the addon
       #
-      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory] Represents the different categories of taxation applicable to various products a
-      # ...
+      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory] Tax category applied to this Addon
       #
       # @param description [String, nil] Optional description of the Addon
       #
@@ -25,12 +21,12 @@ module Dodopayments
       #
       # @see Dodopayments::Models::AddonCreateParams
       def create(params)
-        parsed, options = Dodopayments::Models::AddonCreateParams.dump_request(params)
+        parsed, options = Dodopayments::AddonCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "addons",
           body: parsed,
-          model: Dodopayments::Models::AddonResponse,
+          model: Dodopayments::AddonResponse,
           options: options
         )
       end
@@ -48,19 +44,16 @@ module Dodopayments
         @client.request(
           method: :get,
           path: ["addons/%1$s", id],
-          model: Dodopayments::Models::AddonResponse,
+          model: Dodopayments::AddonResponse,
           options: params[:request_options]
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {Dodopayments::Models::AddonUpdateParams} for more details.
-      #
       # @overload update(id, currency: nil, description: nil, image_id: nil, name: nil, price: nil, tax_category: nil, request_options: {})
       #
       # @param id [String] Addon Id
       #
-      # @param currency [Symbol, Dodopayments::Models::Currency, nil]
+      # @param currency [Symbol, Dodopayments::Models::Currency, nil] The currency of the Addon
       #
       # @param description [String, nil] Description of the Addon, optional and must be at most 1000 characters.
       #
@@ -70,8 +63,7 @@ module Dodopayments
       #
       # @param price [Integer, nil] Amount of the addon
       #
-      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory, nil] Represents the different categories of taxation applicable to various products a
-      # ...
+      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory, nil] Tax category of the Addon.
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -79,21 +71,21 @@ module Dodopayments
       #
       # @see Dodopayments::Models::AddonUpdateParams
       def update(id, params = {})
-        parsed, options = Dodopayments::Models::AddonUpdateParams.dump_request(params)
+        parsed, options = Dodopayments::AddonUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["addons/%1$s", id],
           body: parsed,
-          model: Dodopayments::Models::AddonResponse,
+          model: Dodopayments::AddonResponse,
           options: options
         )
       end
 
       # @overload list(page_number: nil, page_size: nil, request_options: {})
       #
-      # @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}, nil]
       #
@@ -101,13 +93,13 @@ module Dodopayments
       #
       # @see Dodopayments::Models::AddonListParams
       def list(params = {})
-        parsed, options = Dodopayments::Models::AddonListParams.dump_request(params)
+        parsed, options = Dodopayments::AddonListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "addons",
           query: parsed,
           page: Dodopayments::Internal::DefaultPageNumberPagination,
-          model: Dodopayments::Models::AddonResponse,
+          model: Dodopayments::AddonResponse,
           options: options
         )
       end

data/lib/dodopayments/resources/brands.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Brands
+      # @overload create(description: nil, name: nil, statement_descriptor: nil, support_email: nil, url: nil, request_options: {})
+      #
+      # @param description [String, nil]
+      # @param name [String, nil]
+      # @param statement_descriptor [String, nil]
+      # @param support_email [String, nil]
+      # @param url [String, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::Brand]
+      #
+      # @see Dodopayments::Models::BrandCreateParams
+      def create(params = {})
+        parsed, options = Dodopayments::BrandCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "brands",
+          body: parsed,
+          model: Dodopayments::Brand,
+          options: options
+        )
+      end
+
+      # Thin handler just calls `get_brand` and wraps in `Json(...)`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Brand Id
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::Brand]
+      #
+      # @see Dodopayments::Models::BrandRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["brands/%1$s", id],
+          model: Dodopayments::Brand,
+          options: params[:request_options]
+        )
+      end
+
+      # @overload update(id, image_id: nil, name: nil, statement_descriptor: nil, support_email: nil, request_options: {})
+      #
+      # @param id [String] Brand Id
+      #
+      # @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}, nil]
+      #
+      # @return [Dodopayments::Models::Brand]
+      #
+      # @see Dodopayments::Models::BrandUpdateParams
+      def update(id, params = {})
+        parsed, options = Dodopayments::BrandUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["brands/%1$s", id],
+          body: parsed,
+          model: Dodopayments::Brand,
+          options: options
+        )
+      end
+
+      # @overload list(request_options: {})
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::BrandListResponse]
+      #
+      # @see Dodopayments::Models::BrandListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "brands",
+          model: Dodopayments::Models::BrandListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @overload update_images(id, request_options: {})
+      #
+      # @param id [String] Brand Id
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::BrandUpdateImagesResponse]
+      #
+      # @see Dodopayments::Models::BrandUpdateImagesParams
+      def update_images(id, params = {})
+        @client.request(
+          method: :put,
+          path: ["brands/%1$s/images", id],
+          model: Dodopayments::Models::BrandUpdateImagesResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/customers/customer_portal.rb

@@ -8,7 +8,7 @@ module Dodopayments
         #
         # @param customer_id [String] Customer Id
         #
-        # @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}, nil]
         #
@@ -16,12 +16,12 @@ module Dodopayments
         #
         # @see Dodopayments::Models::Customers::CustomerPortalCreateParams
         def create(customer_id, params = {})
-          parsed, options = Dodopayments::Models::Customers::CustomerPortalCreateParams.dump_request(params)
+          parsed, options = Dodopayments::Customers::CustomerPortalCreateParams.dump_request(params)
           @client.request(
             method: :post,
             path: ["customers/%1$s/customer-portal/session", customer_id],
             query: parsed,
-            model: Dodopayments::Models::CustomerPortalSession,
+            model: Dodopayments::CustomerPortalSession,
             options: options
           )
         end

data/lib/dodopayments/resources/customers.rb

@@ -17,12 +17,12 @@ module Dodopayments
       #
       # @see Dodopayments::Models::CustomerCreateParams
       def create(params)
-        parsed, options = Dodopayments::Models::CustomerCreateParams.dump_request(params)
+        parsed, options = Dodopayments::CustomerCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "customers",
           body: parsed,
-          model: Dodopayments::Models::Customer,
+          model: Dodopayments::Customer,
           options: options
         )
       end
@@ -40,7 +40,7 @@ module Dodopayments
         @client.request(
           method: :get,
           path: ["customers/%1$s", customer_id],
-          model: Dodopayments::Models::Customer,
+          model: Dodopayments::Customer,
           options: params[:request_options]
         )
       end
@@ -59,21 +59,23 @@ module Dodopayments
       #
       # @see Dodopayments::Models::CustomerUpdateParams
       def update(customer_id, params = {})
-        parsed, options = Dodopayments::Models::CustomerUpdateParams.dump_request(params)
+        parsed, options = Dodopayments::CustomerUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["customers/%1$s", customer_id],
           body: parsed,
-          model: Dodopayments::Models::Customer,
+          model: Dodopayments::Customer,
           options: options
         )
       end
 
-      # @overload list(page_number: nil, page_size: nil, request_options: {})
+      # @overload list(email: nil, page_number: nil, page_size: nil, request_options: {})
       #
-      # @param page_number [Integer, nil] Page number default is 0
+      # @param email [String] Filter by customer email
       #
-      # @param page_size [Integer, nil] Page size default is 10 max is 100
+      # @param page_number [Integer] Page number default is 0
+      #
+      # @param page_size [Integer] Page size default is 10 max is 100
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -81,13 +83,13 @@ module Dodopayments
       #
       # @see Dodopayments::Models::CustomerListParams
       def list(params = {})
-        parsed, options = Dodopayments::Models::CustomerListParams.dump_request(params)
+        parsed, options = Dodopayments::CustomerListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "customers",
           query: parsed,
           page: Dodopayments::Internal::DefaultPageNumberPagination,
-          model: Dodopayments::Models::Customer,
+          model: Dodopayments::Customer,
           options: options
         )
       end