dub 0.12.11 → 0.12.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd1aee2d1e64835ebe0a7a2b848a214557bd2f69f3f38c7b9d04e2afab96e964
-  data.tar.gz: a6c1f1591bb4344b1e7cc972420e447f547e1bff5f3cce72e2b949c9bb3b62d8
+  metadata.gz: 2e6335cc9bb697d6476e81d2e6ce12b823b5ccc072eccaee3e0a249399186f8c
+  data.tar.gz: 679621aafce7d9456726ea04ff348c0de53e99e5d2dbc1272938d6e76d207e23
 SHA512:
-  metadata.gz: '091dbbbdbaea09f62a24b972eb184bf6504364cf5216335c3e03fff5cfeeac43fa6ad927c13e9812debe7f755b6e1626a11fb1a6321907af32ddd7a9a5b10068'
-  data.tar.gz: f448f2529e4c8fe09a434f6a1768b1166504b88c90e0919e2b00a51f67cde2c06abc382333c53458e22cac172f8cdf126118ad15659f0c0c64d3a877879f9353
+  metadata.gz: 706afec7f6f725f2fdaa6f70701e9ec45e1ef9f705fe447192cb33dd5799dac883c6f719db5ffc26203e31fb3898ec2197ebe831ee9e7469b51f613dc0a04402
+  data.tar.gz: 0edb57b5717665cd1cf4c4e6784089c86f16df2f5e6103b049b27075d58ed69f77afb77fe3cdf7de535076232ddeab3416e08b6b03c157688c89518543ea5f47

data/lib/open_api_sdk/commissions.rb

@@ -319,7 +319,7 @@ module OpenApiSDK
     sig { params(request: T.nilable(T.any(Models::Operations::RequestBody1, Models::Operations::RequestBody2, Models::Operations::RequestBody3)), timeout_ms: T.nilable(Integer), http_headers: T.nilable(T::Hash[T.any(String, Symbol), String])).returns(Models::Operations::CreateCommissionResponseBody) }
     def create(request: nil, timeout_ms: nil, http_headers: nil)
       # create - Create commission
-      # Create one or more commissions (custom, lead or sale) for a partner. Commission creation is processed asynchronously. Use the List Commissions endpoint or webhooks to be notified when the commission is created.
+      # Create one or more commissions (custom, lead or sale) for a partner. Custom commissions accept a negative `amount` to create a clawback. Commission creation is processed asynchronously – use the GET /commissions endpoint or webhooks to be notified when the commission is created.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = "#{base_url}/commissions"

data/lib/open_api_sdk/models/operations/bulkupdatecommissions_commissions_status.rb

@@ -9,7 +9,7 @@
 module OpenApiSDK
   module Models
     module Operations
-
+      # BulkUpdateCommissionsCommissionsStatus - The current status of the commission.
       class BulkUpdateCommissionsCommissionsStatus < T::Enum
         enums do
           PENDING = new('pending')

data/lib/open_api_sdk/models/operations/bulkupdatecommissions_responsebody.rb

@@ -16,7 +16,7 @@ module OpenApiSDK
 
         # The commission's unique ID on Dub.
         field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id'), required: true } }
-
+        # The current status of the commission.
         field :status, Models::Operations::BulkUpdateCommissionsCommissionsStatus, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('status'), required: true, 'decoder': ::OpenApiSDK::Utils.enum_from_string(Models::Operations::BulkUpdateCommissionsCommissionsStatus, false) } }
 
         sig { params(id: ::String, status: Models::Operations::BulkUpdateCommissionsCommissionsStatus).void }

data/lib/open_api_sdk/models/operations/lead.rb

@@ -0,0 +1,38 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# Generated under the AGPL-3.0-only license.
+# SPDX-License-Identifier: AGPL-3.0-only
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Models
+    module Operations
+      # The lead event object to associate the commission with.
+      class Lead
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The name of the lead event to track. If not provided, defaults to 'Sign up'.
+        field :event_name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('eventName') } }
+        # Additional metadata to be stored with the lead event. Max 10,000 characters.
+        field :metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata') } }
+
+        sig { params(event_name: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::Object])).void }
+        def initialize(event_name: nil, metadata: nil)
+          @event_name = event_name
+          @metadata = metadata
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @event_name == other.event_name
+          return false unless @metadata == other.metadata
+          true
+        end
+      end
+    end
+  end
+end

data/lib/open_api_sdk/models/operations/lead.rbi

@@ -0,0 +1,15 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class OpenApiSDK::Models::Operations::Lead
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class OpenApiSDK::Models::Operations::Lead
+  def event_name(); end
+  def event_name=(str_); end
+  def metadata(); end
+  def metadata=(str_); end
+end

data/lib/open_api_sdk/models/operations/listcommissions_responsebody.rb

@@ -16,28 +16,30 @@ module OpenApiSDK
 
         # The commission's unique ID on Dub.
         field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id'), required: true } }
-
+        # The type of commission. Can be `click`, `lead`, `sale`, `referral`, or `custom`.
+        field :type, Models::Operations::ListCommissionsType, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('type'), required: true, 'decoder': ::OpenApiSDK::Utils.enum_from_string(Models::Operations::ListCommissionsType, false) } }
+        # The associated event amount in cents. For sale commissions, this is the sale amount.
         field :amount, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('amount'), required: true } }
-
+        # The amount earned by the partner, in cents.
         field :earnings, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('earnings'), required: true } }
-
+        # The currency of the commission, as an ISO 4217 currency code.
         field :currency, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('currency'), required: true } }
-
+        # The current status of the commission.
         field :status, Models::Operations::ListCommissionsStatus, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('status'), required: true, 'decoder': ::OpenApiSDK::Utils.enum_from_string(Models::Operations::ListCommissionsStatus, false) } }
-
+        # The event quantity. Used for click and lead commissions; typically `1` for sale and custom commissions.
         field :quantity, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('quantity'), required: true } }
-
+        # The date and time when the commission was created.
         field :created_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('createdAt'), required: true } }
-
+        # The date and time when the commission was last updated.
         field :updated_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('updatedAt'), required: true } }
 
         field :partner, Models::Operations::ListCommissionsPartner, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partner'), required: true } }
-
-        field :type, Crystalline::Nilable.new(Models::Operations::ListCommissionsType), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('type'), 'decoder': ::OpenApiSDK::Utils.enum_from_string(Models::Operations::ListCommissionsType, true) } }
-
+        # The associated invoice ID. Only set for sale commissions.
         field :invoice_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('invoiceId'), required: true } }
-
+        # An optional description of the commission.
         field :description, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description'), required: true } }
+        # User-provided metadata from the associated lead or sale event (`lead.metadata` / `sale.metadata`).
+        field :metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata'), required: true } }
         # The date the commission was paid out to the partner. Null if not paid yet.
         field :paid_at, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('paidAt'), required: true } }
         # The user who created the manual commission.
@@ -45,9 +47,10 @@ module OpenApiSDK
 
         field :customer, Crystalline::Nilable.new(Models::Operations::ListCommissionsCustomer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customer') } }
 
-        sig { params(id: ::String, amount: ::Float, earnings: ::Float, currency: ::String, status: Models::Operations::ListCommissionsStatus, quantity: ::Float, created_at: ::String, updated_at: ::String, partner: Models::Operations::ListCommissionsPartner, type: T.nilable(Models::Operations::ListCommissionsType), invoice_id: T.nilable(::String), description: T.nilable(::String), paid_at: T.nilable(::String), user_id: T.nilable(::String), customer: T.nilable(Models::Operations::ListCommissionsCustomer)).void }
-        def initialize(id:, amount:, earnings:, currency:, status:, quantity:, created_at:, updated_at:, partner:, type: nil, invoice_id: nil, description: nil, paid_at: nil, user_id: nil, customer: nil)
+        sig { params(id: ::String, type: Models::Operations::ListCommissionsType, amount: ::Float, earnings: ::Float, currency: ::String, status: Models::Operations::ListCommissionsStatus, quantity: ::Float, created_at: ::String, updated_at: ::String, partner: Models::Operations::ListCommissionsPartner, invoice_id: T.nilable(::String), description: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::Object]), paid_at: T.nilable(::String), user_id: T.nilable(::String), customer: T.nilable(Models::Operations::ListCommissionsCustomer)).void }
+        def initialize(id:, type:, amount:, earnings:, currency:, status:, quantity:, created_at:, updated_at:, partner:, invoice_id: nil, description: nil, metadata: nil, paid_at: nil, user_id: nil, customer: nil)
           @id = id
+          @type = type
           @amount = amount
           @earnings = earnings
           @currency = currency
@@ -56,9 +59,9 @@ module OpenApiSDK
           @created_at = created_at
           @updated_at = updated_at
           @partner = partner
-          @type = type
           @invoice_id = invoice_id
           @description = description
+          @metadata = metadata
           @paid_at = paid_at
           @user_id = user_id
           @customer = customer
@@ -68,6 +71,7 @@ module OpenApiSDK
         def ==(other)
           return false unless other.is_a? self.class
           return false unless @id == other.id
+          return false unless @type == other.type
           return false unless @amount == other.amount
           return false unless @earnings == other.earnings
           return false unless @currency == other.currency
@@ -76,9 +80,9 @@ module OpenApiSDK
           return false unless @created_at == other.created_at
           return false unless @updated_at == other.updated_at
           return false unless @partner == other.partner
-          return false unless @type == other.type
           return false unless @invoice_id == other.invoice_id
           return false unless @description == other.description
+          return false unless @metadata == other.metadata
           return false unless @paid_at == other.paid_at
           return false unless @user_id == other.user_id
           return false unless @customer == other.customer

data/lib/open_api_sdk/models/operations/listcommissions_responsebody.rbi

@@ -10,6 +10,8 @@ end
 class OpenApiSDK::Models::Operations::ListCommissionsResponseBody
   def id(); end
   def id=(str_); end
+  def type(); end
+  def type=(str_); end
   def amount(); end
   def amount=(str_); end
   def earnings(); end
@@ -26,12 +28,12 @@ class OpenApiSDK::Models::Operations::ListCommissionsResponseBody
   def updated_at=(str_); end
   def partner(); end
   def partner=(str_); end
-  def type(); end
-  def type=(str_); end
   def invoice_id(); end
   def invoice_id=(str_); end
   def description(); end
   def description=(str_); end
+  def metadata(); end
+  def metadata=(str_); end
   def paid_at(); end
   def paid_at=(str_); end
   def user_id(); end

data/lib/open_api_sdk/models/operations/listcommissions_status.rb

@@ -9,7 +9,7 @@
 module OpenApiSDK
   module Models
     module Operations
-
+      # ListCommissionsStatus - The current status of the commission.
       class ListCommissionsStatus < T::Enum
         enums do
           PENDING = new('pending')

data/lib/open_api_sdk/models/operations/listcommissions_type.rb

@@ -9,7 +9,7 @@
 module OpenApiSDK
   module Models
     module Operations
-
+      # ListCommissionsType - The type of commission. Can be `click`, `lead`, `sale`, `referral`, or `custom`.
       class ListCommissionsType < T::Enum
         enums do
           CLICK = new('click')

data/lib/open_api_sdk/models/operations/requestbody_1.rb

@@ -18,11 +18,11 @@ module OpenApiSDK
         field :type, Models::Operations::RequestBodyType, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('type'), required: true, 'decoder': ::OpenApiSDK::Utils.enum_from_string(Models::Operations::RequestBodyType, false) } }
         # The ID of the partner to create the commission for.
         field :partner_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partnerId'), required: true } }
-        # The commission amount in cents.
+        # The commission earnings amount in cents. Use a negative amount to create a clawback.
         field :amount, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('amount'), required: true } }
         # If not provided, the current date will be used.
         field :date, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('date') } }
-        # The description of the commission.
+        # The description of the commission. Required for clawbacks (negative `amount`). May be a known clawback reason (`order_canceled`, `fraud`, `terms_violation`, `tracking_error`, `payment_failed`, `ineligible_partner`, `duplicate_commission`) or an arbitrary string (max 190 characters).
         field :description, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
 
         sig { params(type: Models::Operations::RequestBodyType, partner_id: ::String, amount: ::Float, date: T.nilable(::String), description: T.nilable(::String)).void }

data/lib/open_api_sdk/models/operations/requestbody_2.rb

@@ -25,17 +25,27 @@ module OpenApiSDK
         # The partner link ID to associate the commission with. If not provided, default to the link with the most revenue.
         field :link_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('linkId') } }
         # The date and time of the lead event. If not provided, defaults to the current date and time.
+        field :date, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('date') } }
+        # The lead event object to associate the commission with.
+        field :lead, Crystalline::Nilable.new(Models::Operations::Lead), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('lead') } }
+        # Deprecated: Use `date` instead. The date and time of the lead event. If not provided, defaults to the current date and time.
+        #
+        # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
         field :lead_event_date, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('leadEventDate') } }
-        # The name of the lead event. If not provided, defaults to 'Sign up'.
+        # Deprecated: Use `lead.eventName` instead. The name of the lead event. If not provided, defaults to 'Sign up'.
+        #
+        # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
         field :lead_event_name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('leadEventName') } }
 
-        sig { params(type: Models::Operations::CreateCommissionRequestBodyType, partner_id: ::String, customer_id: T.nilable(::String), customer: T.nilable(Models::Operations::Customer), link_id: T.nilable(::String), lead_event_date: T.nilable(::String), lead_event_name: T.nilable(::String)).void }
-        def initialize(type:, partner_id:, customer_id: nil, customer: nil, link_id: nil, lead_event_date: nil, lead_event_name: 'Sign up')
+        sig { params(type: Models::Operations::CreateCommissionRequestBodyType, partner_id: ::String, customer_id: T.nilable(::String), customer: T.nilable(Models::Operations::Customer), link_id: T.nilable(::String), date: T.nilable(::String), lead: T.nilable(Models::Operations::Lead), lead_event_date: T.nilable(::String), lead_event_name: T.nilable(::String)).void }
+        def initialize(type:, partner_id:, customer_id: nil, customer: nil, link_id: nil, date: nil, lead: nil, lead_event_date: nil, lead_event_name: 'Sign up')
           @type = type
           @partner_id = partner_id
           @customer_id = customer_id
           @customer = customer
           @link_id = link_id
+          @date = date
+          @lead = lead
           @lead_event_date = lead_event_date
           @lead_event_name = lead_event_name
         end
@@ -48,6 +58,8 @@ module OpenApiSDK
           return false unless @customer_id == other.customer_id
           return false unless @customer == other.customer
           return false unless @link_id == other.link_id
+          return false unless @date == other.date
+          return false unless @lead == other.lead
           return false unless @lead_event_date == other.lead_event_date
           return false unless @lead_event_name == other.lead_event_name
           true

data/lib/open_api_sdk/models/operations/requestbody_2.rbi

@@ -18,6 +18,10 @@ class OpenApiSDK::Models::Operations::RequestBody2
   def customer=(str_); end
   def link_id(); end
   def link_id=(str_); end
+  def date(); end
+  def date=(str_); end
+  def lead(); end
+  def lead=(str_); end
   def lead_event_date(); end
   def lead_event_date=(str_); end
   def lead_event_name(); end

data/lib/open_api_sdk/models/operations/requestbody_3.rb

@@ -24,26 +24,40 @@ module OpenApiSDK
         field :customer, Crystalline::Nilable.new(Models::Operations::RequestBodyCustomer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customer') } }
         # The partner link ID to associate the commission with. If not provided, default to the link with the most revenue.
         field :link_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('linkId') } }
-        # Required when `importStripeInvoices` is `false`. The sale amount in cents for the manual sale event. Ignored when importing from Stripe.
-        field :sale_amount, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
         # Only used when `importStripeInvoices` is `false`. The date of the manual sale event. Defaults to the current date and time if not provided.
+        field :date, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('date') } }
+        # The sale event object to associate the commission with.
+        field :sale, Crystalline::Nilable.new(Models::Operations::Sale), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sale') } }
+        # Deprecated: Use `date` instead.
+        #
+        # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
         field :sale_event_date, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleEventDate') } }
-        # Only used when `importStripeInvoices` is `false`. An optional invoice ID to attach to the generated sale event and commission entry for deduplication.
+        # Deprecated: Use `sale.amount` instead.
+        #
+        # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
+        field :sale_amount, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
+        # Deprecated: Use `sale.invoiceId` instead.
+        #
+        # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
         field :invoice_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('invoiceId') } }
-        # Only used when `importStripeInvoices` is `false`. An optional product ID stored on the sale event metadata – will also impact commission earnings calculation (if a `Sale` `Product ID` modifier is set).
+        # Deprecated: Use `sale.metadata.productId` instead.
+        #
+        # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
         field :product_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('productId') } }
-        # When `true`, import all unimported paid Stripe invoices for the customer and create a commission for each. When `false`, create a single manual sale event using `saleAmount`.
+        # When `true`, import all unimported paid Stripe invoices for the customer and create a commission for each. When `false`, create a single manual sale event using `sale.amount` (or deprecated `saleAmount`).
         field :import_stripe_invoices, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('importStripeInvoices') } }
 
-        sig { params(type: Models::Operations::CreateCommissionRequestBodyCommissionsType, partner_id: ::String, customer_id: T.nilable(::String), customer: T.nilable(Models::Operations::RequestBodyCustomer), link_id: T.nilable(::String), sale_amount: T.nilable(::Float), sale_event_date: T.nilable(::String), invoice_id: T.nilable(::String), product_id: T.nilable(::String), import_stripe_invoices: T.nilable(T::Boolean)).void }
-        def initialize(type:, partner_id:, customer_id: nil, customer: nil, link_id: nil, sale_amount: nil, sale_event_date: nil, invoice_id: nil, product_id: nil, import_stripe_invoices: false)
+        sig { params(type: Models::Operations::CreateCommissionRequestBodyCommissionsType, partner_id: ::String, customer_id: T.nilable(::String), customer: T.nilable(Models::Operations::RequestBodyCustomer), link_id: T.nilable(::String), date: T.nilable(::String), sale: T.nilable(Models::Operations::Sale), sale_event_date: T.nilable(::String), sale_amount: T.nilable(::Float), invoice_id: T.nilable(::String), product_id: T.nilable(::String), import_stripe_invoices: T.nilable(T::Boolean)).void }
+        def initialize(type:, partner_id:, customer_id: nil, customer: nil, link_id: nil, date: nil, sale: nil, sale_event_date: nil, sale_amount: nil, invoice_id: nil, product_id: nil, import_stripe_invoices: false)
           @type = type
           @partner_id = partner_id
           @customer_id = customer_id
           @customer = customer
           @link_id = link_id
-          @sale_amount = sale_amount
+          @date = date
+          @sale = sale
           @sale_event_date = sale_event_date
+          @sale_amount = sale_amount
           @invoice_id = invoice_id
           @product_id = product_id
           @import_stripe_invoices = import_stripe_invoices
@@ -57,8 +71,10 @@ module OpenApiSDK
           return false unless @customer_id == other.customer_id
           return false unless @customer == other.customer
           return false unless @link_id == other.link_id
-          return false unless @sale_amount == other.sale_amount
+          return false unless @date == other.date
+          return false unless @sale == other.sale
           return false unless @sale_event_date == other.sale_event_date
+          return false unless @sale_amount == other.sale_amount
           return false unless @invoice_id == other.invoice_id
           return false unless @product_id == other.product_id
           return false unless @import_stripe_invoices == other.import_stripe_invoices

data/lib/open_api_sdk/models/operations/requestbody_3.rbi

@@ -18,10 +18,14 @@ class OpenApiSDK::Models::Operations::RequestBody3
   def customer=(str_); end
   def link_id(); end
   def link_id=(str_); end
-  def sale_amount(); end
-  def sale_amount=(str_); end
+  def date(); end
+  def date=(str_); end
+  def sale(); end
+  def sale=(str_); end
   def sale_event_date(); end
   def sale_event_date=(str_); end
+  def sale_amount(); end
+  def sale_amount=(str_); end
   def invoice_id(); end
   def invoice_id=(str_); end
   def product_id(); end

data/lib/open_api_sdk/models/operations/requestbody_paymentprocessor.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# Generated under the AGPL-3.0-only license.
+# SPDX-License-Identifier: AGPL-3.0-only
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Models
+    module Operations
+      # RequestBodyPaymentProcessor - The payment processor via which the sale was made.
+      class RequestBodyPaymentProcessor < T::Enum
+        enums do
+          STRIPE = new('stripe')
+          SHOPIFY = new('shopify')
+          POLAR = new('polar')
+          PADDLE = new('paddle')
+          APPLE = new('apple')
+          REVENUECAT = new('revenuecat')
+          DUB = new('dub')
+          CUSTOM = new('custom')
+        end
+      end
+    end
+  end
+end

data/lib/open_api_sdk/models/operations/requestbody_paymentprocessor.rbi

@@ -0,0 +1,11 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class OpenApiSDK::Models::Operations::RequestBodyPaymentProcessor
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class OpenApiSDK::Models::Operations::RequestBodyPaymentProcessor
+end

data/lib/open_api_sdk/models/operations/sale.rb

@@ -9,29 +9,32 @@
 module OpenApiSDK
   module Models
     module Operations
-
+      # The sale event object to associate the commission with.
       class Sale
         extend T::Sig
         include Crystalline::MetadataFields
 
-
-        field :amount, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('amount'), required: true } }
-
-        field :currency, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('currency'), required: true } }
-
-        field :payment_processor, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('paymentProcessor'), required: true } }
-
-        field :invoice_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('invoiceId'), required: true } }
-
-        field :metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata'), required: true } }
-
-        sig { params(amount: ::Float, currency: ::String, payment_processor: ::String, invoice_id: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::Object])).void }
-        def initialize(amount:, currency:, payment_processor:, invoice_id: nil, metadata: nil)
+        # The amount of the sale in cents (for all two-decimal currencies). If the sale is in a zero-decimal currency, pass the full integer value (e.g. `1580` JPY). Learn more: https://d.to/currency
+        field :amount, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('amount') } }
+        # The currency of the sale. Accepts ISO 4217 currency codes. Sales will be automatically converted and stored as USD at the latest exchange rates. Learn more: https://d.to/currency
+        field :currency, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('currency') } }
+        # The name of the sale event. Recommended format: `Invoice paid` or `Subscription created`.
+        field :event_name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('eventName') } }
+        # The payment processor via which the sale was made.
+        field :payment_processor, Crystalline::Nilable.new(Models::Operations::RequestBodyPaymentProcessor), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('paymentProcessor'), 'decoder': ::OpenApiSDK::Utils.enum_from_string(Models::Operations::RequestBodyPaymentProcessor, true) } }
+        # Additional metadata to be stored with the sale event. Max 10,000 characters when stringified.
+        field :metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata') } }
+        # The invoice ID of the sale. Can be used as a idempotency key – only one sale event can be recorded for a given invoice ID.
+        field :invoice_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('invoiceId') } }
+
+        sig { params(amount: T.nilable(::Float), currency: T.nilable(::String), event_name: T.nilable(::String), payment_processor: T.nilable(Models::Operations::RequestBodyPaymentProcessor), metadata: T.nilable(T::Hash[Symbol, ::Object]), invoice_id: T.nilable(::String)).void }
+        def initialize(amount: nil, currency: 'usd', event_name: 'Purchase', payment_processor: Models::Operations::RequestBodyPaymentProcessor::CUSTOM, metadata: nil, invoice_id: nil)
           @amount = amount
           @currency = currency
+          @event_name = event_name
           @payment_processor = payment_processor
-          @invoice_id = invoice_id
           @metadata = metadata
+          @invoice_id = invoice_id
         end
 
         sig { params(other: T.untyped).returns(T::Boolean) }
@@ -39,9 +42,10 @@ module OpenApiSDK
           return false unless other.is_a? self.class
           return false unless @amount == other.amount
           return false unless @currency == other.currency
+          return false unless @event_name == other.event_name
           return false unless @payment_processor == other.payment_processor
-          return false unless @invoice_id == other.invoice_id
           return false unless @metadata == other.metadata
+          return false unless @invoice_id == other.invoice_id
           true
         end
       end

data/lib/open_api_sdk/models/operations/sale.rbi

@@ -12,10 +12,12 @@ class OpenApiSDK::Models::Operations::Sale
   def amount=(str_); end
   def currency(); end
   def currency=(str_); end
+  def event_name(); end
+  def event_name=(str_); end
   def payment_processor(); end
   def payment_processor=(str_); end
-  def invoice_id(); end
-  def invoice_id=(str_); end
   def metadata(); end
   def metadata=(str_); end
+  def invoice_id(); end
+  def invoice_id=(str_); end
 end

data/lib/open_api_sdk/models/operations/tracksale_responsebody.rb

@@ -19,9 +19,9 @@ module OpenApiSDK
 
         field :customer, Crystalline::Nilable.new(Models::Operations::TrackSaleCustomer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customer'), required: true } }
 
-        field :sale, Crystalline::Nilable.new(Models::Operations::Sale), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sale'), required: true } }
+        field :sale, Crystalline::Nilable.new(Models::Operations::TrackSaleSale), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sale'), required: true } }
 
-        sig { params(event_name: ::String, customer: T.nilable(Models::Operations::TrackSaleCustomer), sale: T.nilable(Models::Operations::Sale)).void }
+        sig { params(event_name: ::String, customer: T.nilable(Models::Operations::TrackSaleCustomer), sale: T.nilable(Models::Operations::TrackSaleSale)).void }
         def initialize(event_name:, customer: nil, sale: nil)
           @event_name = event_name
           @customer = customer

data/lib/open_api_sdk/models/operations/tracksale_sale.rb

@@ -0,0 +1,50 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# Generated under the AGPL-3.0-only license.
+# SPDX-License-Identifier: AGPL-3.0-only
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Models
+    module Operations
+
+      class TrackSaleSale
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        field :amount, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('amount'), required: true } }
+
+        field :currency, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('currency'), required: true } }
+
+        field :payment_processor, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('paymentProcessor'), required: true } }
+
+        field :invoice_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('invoiceId'), required: true } }
+
+        field :metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata'), required: true } }
+
+        sig { params(amount: ::Float, currency: ::String, payment_processor: ::String, invoice_id: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::Object])).void }
+        def initialize(amount:, currency:, payment_processor:, invoice_id: nil, metadata: nil)
+          @amount = amount
+          @currency = currency
+          @payment_processor = payment_processor
+          @invoice_id = invoice_id
+          @metadata = metadata
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @amount == other.amount
+          return false unless @currency == other.currency
+          return false unless @payment_processor == other.payment_processor
+          return false unless @invoice_id == other.invoice_id
+          return false unless @metadata == other.metadata
+          true
+        end
+      end
+    end
+  end
+end

data/lib/open_api_sdk/models/operations/tracksale_sale.rbi

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class OpenApiSDK::Models::Operations::TrackSaleSale
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class OpenApiSDK::Models::Operations::TrackSaleSale
+  def amount(); end
+  def amount=(str_); end
+  def currency(); end
+  def currency=(str_); end
+  def payment_processor(); end
+  def payment_processor=(str_); end
+  def invoice_id(); end
+  def invoice_id=(str_); end
+  def metadata(); end
+  def metadata=(str_); end
+end