orb-billing 1.44.0 → 1.46.0

data/lib/orb/models/webhooks/unwrap_standard_webhook_event.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Webhooks
+      # Issued when a backfill is closed and its events are reflected into usage.
+      module UnwrapStandardWebhookEvent
+        extend Orb::Internal::Type::Union
+
+        # Issued when a backfill is closed and its events are reflected into usage.
+        variant -> { Orb::Webhooks::BackfillReflectedStandardWebhookEvent }
+
+        # Issued when a backfill is reverted, removing its events from usage.
+        variant -> { Orb::Webhooks::BackfillRevertedStandardWebhookEvent }
+
+        # Issued when a billable metric is edited.
+        variant -> { Orb::Webhooks::BillableMetricEditedStandardWebhookEvent }
+
+        # Issued when a credit block accounting sync fails.
+        variant -> { Orb::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent }
+
+        # Issued when a credit block accounting sync succeeds.
+        variant -> { Orb::Webhooks::CreditBlockAccountingSyncSucceededStandardWebhookEvent }
+
+        # Issued when a credit note accounting sync fails.
+        variant -> { Orb::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent }
+
+        # Issued when a credit note accounting sync succeeds.
+        variant -> { Orb::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent }
+
+        # Issued when a credit note is created.
+        variant -> { Orb::Webhooks::CreditNoteIssuedStandardWebhookEvent }
+
+        # Issued when a credit note is marked as void.
+        variant -> { Orb::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent }
+
+        # Issued when a customer accounting sync fails.
+        variant -> { Orb::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent }
+
+        # Issued when a customer accounting sync succeeds.
+        variant -> { Orb::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent }
+
+        # Issued when a customer balance transaction is created.
+        variant -> { Orb::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent }
+
+        # Issued when a customer resource is created.
+        variant -> { Orb::Webhooks::CustomerCreatedStandardWebhookEvent }
+
+        # Issued when a customer's prepaid credits balance is depleted.
+        variant -> { Orb::Webhooks::CustomerCreditBalanceDepletedStandardWebhookEvent }
+
+        # Issued when a customer's prepaid credits balance is depleted to a configured threshold.
+        variant -> { Orb::Webhooks::CustomerCreditBalanceDroppedStandardWebhookEvent }
+
+        # Issued when a customer's credit balance recovers from depleted.
+        variant -> { Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent }
+
+        # Issued when a customer's credit ledger is incremented.
+        variant -> { Orb::Webhooks::CustomerCreditLedgerIncrementedStandardWebhookEvent }
+
+        # Issued when a customer is updated.
+        variant -> { Orb::Webhooks::CustomerEditedStandardWebhookEvent }
+
+        # Issued when a data export transfer fails.
+        variant -> { Orb::Webhooks::DataExportsTransferErrorStandardWebhookEvent }
+
+        # Issued when a data export transfer succeeds.
+        variant -> { Orb::Webhooks::DataExportsTransferSuccessStandardWebhookEvent }
+
+        # Issued when an event does not match any customer.
+        variant -> { Orb::Webhooks::EventUnmatchedEventStandardWebhookEvent }
+
+        # Issued when ingestion events reference unmatched customer IDs.
+        variant -> { Orb::Webhooks::IngestionUnmatchedCustomerIDsStandardWebhookEvent }
+
+        # Issued when an invoice accounting sync fails.
+        variant -> { Orb::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent }
+
+        # Issued when an invoice accounting sync succeeds.
+        variant -> { Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent }
+
+        # Issued when a collections-automation schedule step is executed for an invoice.
+        variant -> { Orb::Webhooks::InvoiceAutomationScheduleStepExecutedStandardWebhookEvent }
+
+        # Issued when invoice cost data is exported.
+        variant -> { Orb::Webhooks::InvoiceCostDataExportedStandardWebhookEvent }
+
+        # Issued when a dunning schedule is created for an invoice.
+        variant -> { Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent }
+
+        # Issued when a dunning schedule ends.
+        variant -> { Orb::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent }
+
+        # Issued when a dunning schedule is reset.
+        variant -> { Orb::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent }
+
+        # Issued when a dunning schedule step is executed.
+        variant -> { Orb::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent }
+
+        # Issued when a draft invoice has been edited.
+        variant -> { Orb::Webhooks::InvoiceEditedStandardWebhookEvent }
+
+        # Issued when an invoice's invoice date has elapsed.
+        variant -> { Orb::Webhooks::InvoiceInvoiceDateElapsedStandardWebhookEvent }
+
+        # Issued when an invoice issue attempt fails.
+        variant -> { Orb::Webhooks::InvoiceIssueFailedStandardWebhookEvent }
+
+        # Issued when an invoice transitions to the "issued" state.
+        variant -> { Orb::Webhooks::InvoiceIssuedStandardWebhookEvent }
+
+        # A lightweight variant of invoice.issued for accounts configured to receive a summarized invoice payload.
+        variant -> { Orb::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent }
+
+        # Issued when an invoice is manually marked as paid.
+        variant -> { Orb::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent }
+
+        # Issued when an invoice is marked as void.
+        variant -> { Orb::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent }
+
+        # Issued when automated payment collection for an invoice fails for a configured payment gateway.
+        variant -> { Orb::Webhooks::InvoicePaymentFailedStandardWebhookEvent }
+
+        # Issued when an invoice payment is being processed.
+        variant -> { Orb::Webhooks::InvoicePaymentProcessingStandardWebhookEvent }
+
+        # Issued when automated payment collection for an invoice succeeds for a configured payment gateway.
+        variant -> { Orb::Webhooks::InvoicePaymentSucceededStandardWebhookEvent }
+
+        # Issued when an invoice sync fails.
+        variant -> { Orb::Webhooks::InvoiceSyncFailedStandardWebhookEvent }
+
+        # Issued when an invoice sync succeeds.
+        variant -> { Orb::Webhooks::InvoiceSyncSucceededStandardWebhookEvent }
+
+        # Issued when an invoice is undone from marked as paid.
+        variant -> { Orb::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent }
+
+        # Issued when an invoice due date recalculation is canceled.
+        variant -> { Orb::Webhooks::InvoiceDueDateRecalculationCanceledStandardWebhookEvent }
+
+        # Issued when an invoice due date recalculation is completed.
+        variant -> { Orb::Webhooks::InvoiceDueDateRecalculationCompletedStandardWebhookEvent }
+
+        # Issued when an invoice due date recalculation is started.
+        variant -> { Orb::Webhooks::InvoiceDueDateRecalculationStartedStandardWebhookEvent }
+
+        # Issued when metric events are dropped by watermark threshold.
+        variant -> { Orb::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent }
+
+        # Issued when a payment method is created.
+        variant -> { Orb::Webhooks::PaymentMethodCreatedStandardWebhookEvent }
+
+        # Issued when a payment method is deleted.
+        variant -> { Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent }
+
+        # Issued when a plan is created, or when a draft plan is published.
+        variant -> { Orb::Webhooks::PlanCreatedStandardWebhookEvent }
+
+        # Issued when a plan's default version is set.
+        variant -> { Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent }
+
+        # Issued when a plan's name, description, external plan ID, metadata or status is edited.
+        variant -> { Orb::Webhooks::PlanEditedStandardWebhookEvent }
+
+        # Issued when a new plan version is created.
+        variant -> { Orb::Webhooks::PlanVersionCreatedStandardWebhookEvent }
+
+        # Issued when a price is edited.
+        variant -> { Orb::Webhooks::PriceEditedStandardWebhookEvent }
+
+        # Issued when a test webhook is sent.
+        variant -> { Orb::Webhooks::ResourceEventTestStandardWebhookEvent }
+
+        # Issued when a sales order accounting sync fails.
+        variant -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent }
+
+        # Issued when a sales order accounting sync succeeds.
+        variant -> { Orb::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent }
+
+        # Issued when a subscription accounting sync fails.
+        variant -> { Orb::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent }
+
+        # Issued when a subscription accounting sync succeeds.
+        variant -> { Orb::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent }
+
+        # Issued when an alert is automatically disabled by the system.
+        variant -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent }
+
+        # Issued when a subscription cancellation is scheduled.
+        variant -> { Orb::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent }
+
+        # Issued when a scheduled subscription cancellation is unscheduled.
+        variant -> { Orb::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent }
+
+        # Issued when a subscription's cost exceeds a pre-configured amount threshold.
+        variant -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent }
+
+        # Issued when a subscription resource is created.
+        variant -> { Orb::Webhooks::SubscriptionCreatedStandardWebhookEvent }
+
+        # Issued when a subscription is updated.
+        variant -> { Orb::Webhooks::SubscriptionEditedStandardWebhookEvent }
+
+        # Issued whenever a customer's subscription ends/lapses.
+        variant -> { Orb::Webhooks::SubscriptionEndedStandardWebhookEvent }
+
+        # Issued when a subscription's fixed fee quantity is updated.
+        variant -> { Orb::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent }
+
+        # Issued when grouped subscription costs exceed a pre-configured amount threshold.
+        variant -> { Orb::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent }
+
+        # Issued when a subscription's invoicing threshold is exceeded and an evaluation is performed.
+        variant -> { Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent }
+
+        # Issued when a license allocation is reset.
+        variant -> { Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent }
+
+        # Issued when a license balance threshold is reached.
+        variant -> { Orb::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent }
+
+        # Issued when a subscription plan change is scheduled.
+        variant -> { Orb::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent }
+
+        # Issued when a subscription transitions from one plan to a different plan.
+        variant -> { Orb::Webhooks::SubscriptionPlanChangedStandardWebhookEvent }
+
+        # Issued when a subscription plan version change is scheduled.
+        variant -> { Orb::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent }
+
+        # Issued when a subscription plan version has changed.
+        variant -> { Orb::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent }
+
+        # Issued when a subscription's rated spend, before credits and adjustments, exceeds a pre-configured amount threshold.
+        variant -> { Orb::Webhooks::SubscriptionSpendExceededStandardWebhookEvent }
+
+        # Issued when a subscription begins.
+        variant -> { Orb::Webhooks::SubscriptionStartedStandardWebhookEvent }
+
+        # Issued when a subscription trial ends.
+        variant -> { Orb::Webhooks::SubscriptionTrialEndedStandardWebhookEvent }
+
+        # Issued when a billable metric in a subscription exceeds a pre-configured quantity threshold.
+        variant -> { Orb::Webhooks::SubscriptionUsageExceededStandardWebhookEvent }
+
+        # Issued when a transaction accounting sync fails.
+        variant -> { Orb::Webhooks::TransactionAccountingSyncFailedStandardWebhookEvent }
+
+        # Issued when a transaction accounting sync succeeds.
+        variant -> { Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent }
+
+        # @!method self.variants
+        #   @return [Array(Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent, Orb::Models::Webhooks::BackfillRevertedStandardWebhookEvent, Orb::Models::Webhooks::BillableMetricEditedStandardWebhookEvent, Orb::Models::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::CreditBlockAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteIssuedStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent, Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreatedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditBalanceDepletedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditBalanceDroppedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditLedgerIncrementedStandardWebhookEvent, Orb::Models::Webhooks::CustomerEditedStandardWebhookEvent, Orb::Models::Webhooks::DataExportsTransferErrorStandardWebhookEvent, Orb::Models::Webhooks::DataExportsTransferSuccessStandardWebhookEvent, Orb::Models::Webhooks::EventUnmatchedEventStandardWebhookEvent, Orb::Models::Webhooks::IngestionUnmatchedCustomerIDsStandardWebhookEvent, Orb::Models::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::InvoiceAutomationScheduleStepExecutedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceCostDataExportedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceEditedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceInvoiceDateElapsedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceIssueFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceIssuedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent, Orb::Models::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent, Orb::Models::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent, Orb::Models::Webhooks::InvoicePaymentFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoicePaymentProcessingStandardWebhookEvent, Orb::Models::Webhooks::InvoicePaymentSucceededStandardWebhookEvent, Orb::Models::Webhooks::InvoiceSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDueDateRecalculationCanceledStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDueDateRecalculationCompletedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDueDateRecalculationStartedStandardWebhookEvent, Orb::Models::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent, Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent, Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent, Orb::Models::Webhooks::PlanCreatedStandardWebhookEvent, Orb::Models::Webhooks::PlanDefaultVersionSetStandardWebhookEvent, Orb::Models::Webhooks::PlanEditedStandardWebhookEvent, Orb::Models::Webhooks::PlanVersionCreatedStandardWebhookEvent, Orb::Models::Webhooks::PriceEditedStandardWebhookEvent, Orb::Models::Webhooks::ResourceEventTestStandardWebhookEvent, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionEndedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanChangedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionSpendExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionStartedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent, Orb::Models::Webhooks::TransactionAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent)]
+      end
+    end
+  end
+end

data/lib/orb/models.rb

@@ -841,5 +841,7 @@ module Orb
 
   WebhookEndpointWithSecret = Orb::Models::WebhookEndpointWithSecret
 
+  Webhooks = Orb::Models::Webhooks
+
   WebhookUnwrapParams = Orb::Models::WebhookUnwrapParams
 end

data/lib/orb/resources/webhooks/standard.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Orb
+  module Resources
+    class Webhooks
+      class Standard
+        # @param payload [String] The raw webhook payload as a string
+        #
+        # @return [Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent, Orb::Models::Webhooks::BackfillRevertedStandardWebhookEvent, Orb::Models::Webhooks::BillableMetricEditedStandardWebhookEvent, Orb::Models::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::CreditBlockAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteIssuedStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent, Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreatedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditBalanceDepletedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditBalanceDroppedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditLedgerIncrementedStandardWebhookEvent, Orb::Models::Webhooks::CustomerEditedStandardWebhookEvent, Orb::Models::Webhooks::DataExportsTransferErrorStandardWebhookEvent, Orb::Models::Webhooks::DataExportsTransferSuccessStandardWebhookEvent, Orb::Models::Webhooks::EventUnmatchedEventStandardWebhookEvent, Orb::Models::Webhooks::IngestionUnmatchedCustomerIDsStandardWebhookEvent, Orb::Models::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::InvoiceAutomationScheduleStepExecutedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceCostDataExportedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceEditedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceInvoiceDateElapsedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceIssueFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceIssuedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent, Orb::Models::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent, Orb::Models::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent, Orb::Models::Webhooks::InvoicePaymentFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoicePaymentProcessingStandardWebhookEvent, Orb::Models::Webhooks::InvoicePaymentSucceededStandardWebhookEvent, Orb::Models::Webhooks::InvoiceSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDueDateRecalculationCanceledStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDueDateRecalculationCompletedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDueDateRecalculationStartedStandardWebhookEvent, Orb::Models::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent, Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent, Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent, Orb::Models::Webhooks::PlanCreatedStandardWebhookEvent, Orb::Models::Webhooks::PlanDefaultVersionSetStandardWebhookEvent, Orb::Models::Webhooks::PlanEditedStandardWebhookEvent, Orb::Models::Webhooks::PlanVersionCreatedStandardWebhookEvent, Orb::Models::Webhooks::PriceEditedStandardWebhookEvent, Orb::Models::Webhooks::ResourceEventTestStandardWebhookEvent, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionEndedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanChangedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionSpendExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionStartedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent, Orb::Models::Webhooks::TransactionAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent]
+        def unwrap_standard(payload)
+          parsed = JSON.parse(payload, symbolize_names: true)
+          Orb::Internal::Type::Converter.coerce(Orb::Models::Webhooks::UnwrapStandardWebhookEvent, parsed)
+        end
+
+        # @api private
+        #
+        # @param client [Orb::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/orb/resources/webhooks.rb

@@ -3,6 +3,9 @@
 module Orb
   module Resources
     class Webhooks
+      # @return [Orb::Resources::Webhooks::Standard]
+      attr_reader :standard
+
       # @param payload [String] The raw webhook payload as a string
       #
       # @return [Orb::Models::BackfillReflectedWebhookEvent, Orb::Models::BackfillRevertedWebhookEvent, Orb::Models::BillableMetricEditedWebhookEvent, Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent, Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent, Orb::Models::CreditNoteIssuedWebhookEvent, Orb::Models::CreditNoteMarkedAsVoidWebhookEvent, Orb::Models::CustomerAccountingSyncFailedWebhookEvent, Orb::Models::CustomerAccountingSyncSucceededWebhookEvent, Orb::Models::CustomerBalanceTransactionCreatedWebhookEvent, Orb::Models::CustomerCreatedWebhookEvent, Orb::Models::CustomerCreditBalanceDepletedWebhookEvent, Orb::Models::CustomerCreditBalanceDroppedWebhookEvent, Orb::Models::CustomerCreditBalanceRecoveredWebhookEvent, Orb::Models::CustomerCreditLedgerIncrementedWebhookEvent, Orb::Models::CustomerEditedWebhookEvent, Orb::Models::DataExportsTransferErrorWebhookEvent, Orb::Models::DataExportsTransferSuccessWebhookEvent, Orb::Models::EventUnmatchedEventWebhookEvent, Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent, Orb::Models::InvoiceAccountingSyncFailedWebhookEvent, Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent, Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent, Orb::Models::InvoiceCostDataExportedWebhookEvent, Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent, Orb::Models::InvoiceDunningScheduleEndedWebhookEvent, Orb::Models::InvoiceDunningScheduleResetWebhookEvent, Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent, Orb::Models::InvoiceEditedWebhookEvent, Orb::Models::InvoiceInvoiceDateElapsedWebhookEvent, Orb::Models::InvoiceIssueFailedWebhookEvent, Orb::Models::InvoiceIssuedWebhookEvent, Orb::Models::InvoiceIssuedSummaryWebhookEvent, Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent, Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent, Orb::Models::InvoicePaymentFailedWebhookEvent, Orb::Models::InvoicePaymentProcessingWebhookEvent, Orb::Models::InvoicePaymentSucceededWebhookEvent, Orb::Models::InvoiceSyncFailedWebhookEvent, Orb::Models::InvoiceSyncSucceededWebhookEvent, Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent, Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent, Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent, Orb::Models::InvoiceDueDateRecalculationStartedWebhookEvent, Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent, Orb::Models::PaymentMethodCreatedWebhookEvent, Orb::Models::PaymentMethodDeletedWebhookEvent, Orb::Models::PlanCreatedWebhookEvent, Orb::Models::PlanDefaultVersionSetWebhookEvent, Orb::Models::PlanEditedWebhookEvent, Orb::Models::PlanVersionCreatedWebhookEvent, Orb::Models::PriceEditedWebhookEvent, Orb::Models::ResourceEventTestWebhookEvent, Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent, Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent, Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent, Orb::Models::SubscriptionAccountingSyncSucceededWebhookEvent, Orb::Models::SubscriptionAlertDisabledWebhookEvent, Orb::Models::SubscriptionCancellationScheduledWebhookEvent, Orb::Models::SubscriptionCancellationUnscheduledWebhookEvent, Orb::Models::SubscriptionCostExceededWebhookEvent, Orb::Models::SubscriptionCreatedWebhookEvent, Orb::Models::SubscriptionEditedWebhookEvent, Orb::Models::SubscriptionEndedWebhookEvent, Orb::Models::SubscriptionFixedFeeQuantityUpdatedWebhookEvent, Orb::Models::SubscriptionGroupedCostExceededWebhookEvent, Orb::Models::SubscriptionInvoicingThresholdExceededWebhookEvent, Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent, Orb::Models::SubscriptionLicenseBalanceThresholdReachedWebhookEvent, Orb::Models::SubscriptionPlanChangeScheduledWebhookEvent, Orb::Models::SubscriptionPlanChangedWebhookEvent, Orb::Models::SubscriptionPlanVersionChangeScheduledWebhookEvent, Orb::Models::SubscriptionPlanVersionChangedWebhookEvent, Orb::Models::SubscriptionSpendExceededWebhookEvent, Orb::Models::SubscriptionStartedWebhookEvent, Orb::Models::SubscriptionTrialEndedWebhookEvent, Orb::Models::SubscriptionUsageExceededWebhookEvent, Orb::Models::TransactionAccountingSyncFailedWebhookEvent, Orb::Models::TransactionAccountingSyncSucceededWebhookEvent]
@@ -16,6 +19,7 @@ module Orb
       # @param client [Orb::Client]
       def initialize(client:)
         @client = client
+        @standard = Orb::Resources::Webhooks::Standard.new(client: client)
       end
     end
   end

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "1.44.0"
+  VERSION = "1.46.0"
 end

data/lib/orb.rb

@@ -538,6 +538,89 @@ require_relative "orb/models/webhook_endpoint_list_params"
 require_relative "orb/models/webhook_endpoint_retrieve_params"
 require_relative "orb/models/webhook_endpoint_update_params"
 require_relative "orb/models/webhook_endpoint_with_secret"
+require_relative "orb/models/webhooks/backfill_reflected_standard_webhook_event"
+require_relative "orb/models/webhooks/backfill_reverted_standard_webhook_event"
+require_relative "orb/models/webhooks/billable_metric_edited_standard_webhook_event"
+require_relative "orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event"
+require_relative "orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event"
+require_relative "orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event"
+require_relative "orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event"
+require_relative "orb/models/webhooks/credit_note_issued_standard_webhook_event"
+require_relative "orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event"
+require_relative "orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event"
+require_relative "orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event"
+require_relative "orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event"
+require_relative "orb/models/webhooks/customer_created_standard_webhook_event"
+require_relative "orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event"
+require_relative "orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event"
+require_relative "orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event"
+require_relative "orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event"
+require_relative "orb/models/webhooks/customer_edited_standard_webhook_event"
+require_relative "orb/models/webhooks/data_exports_transfer_error_standard_webhook_event"
+require_relative "orb/models/webhooks/data_exports_transfer_success_standard_webhook_event"
+require_relative "orb/models/webhooks/event_unmatched_event_standard_webhook_event"
+require_relative "orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_edited_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_issued_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_issued_summary_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_issue_failed_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_payment_failed_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_payment_processing_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_sync_failed_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event"
+require_relative "orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event"
+require_relative "orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event"
+require_relative "orb/models/webhooks/payment_method_created_standard_webhook_event"
+require_relative "orb/models/webhooks/payment_method_deleted_standard_webhook_event"
+require_relative "orb/models/webhooks/plan_created_standard_webhook_event"
+require_relative "orb/models/webhooks/plan_default_version_set_standard_webhook_event"
+require_relative "orb/models/webhooks/plan_edited_standard_webhook_event"
+require_relative "orb/models/webhooks/plan_version_created_standard_webhook_event"
+require_relative "orb/models/webhooks/price_edited_standard_webhook_event"
+require_relative "orb/models/webhooks/resource_event_test_standard_webhook_event"
+require_relative "orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event"
+require_relative "orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event"
+require_relative "orb/models/webhooks/standard_unwrap_standard_params"
+require_relative "orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_alert_disabled_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_created_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_edited_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_ended_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_plan_changed_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_started_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_trial_ended_standard_webhook_event"
+require_relative "orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event"
+require_relative "orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event"
+require_relative "orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event"
+require_relative "orb/models/webhooks/unwrap_standard_webhook_event"
 require_relative "orb/models/webhook_unwrap_params"
 require_relative "orb/models"
 require_relative "orb/resources/alerts"
@@ -577,3 +660,4 @@ require_relative "orb/resources/subscriptions"
 require_relative "orb/resources/top_level"
 require_relative "orb/resources/webhook_endpoints"
 require_relative "orb/resources/webhooks"
+require_relative "orb/resources/webhooks/standard"

data/rbi/orb/models/backfill_reflected_webhook_event.rbi

@@ -28,6 +28,13 @@ module Orb
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      sig do
+        returns(Orb::BackfillReflectedWebhookEvent::PayloadStyle::TaggedSymbol)
+      end
+      attr_accessor :payload_style
+
       sig { returns(T.anything) }
       attr_accessor :properties
 
@@ -41,6 +48,8 @@ module Orb
           id: String,
           backfill: Orb::BackfillReflectedWebhookEvent::Backfill::OrHash,
           created_at: Time,
+          payload_style:
+            Orb::BackfillReflectedWebhookEvent::PayloadStyle::OrSymbol,
           properties: T.anything,
           type: Orb::BackfillReflectedWebhookEvent::Type::OrSymbol
         ).returns(T.attached_class)
@@ -53,6 +62,9 @@ module Orb
         backfill:,
         # The time at which this event was created, to the second.
         created_at:,
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        payload_style:,
         properties:,
         # The event this payload describes.
         type:
@@ -65,6 +77,8 @@ module Orb
             id: String,
             backfill: Orb::BackfillReflectedWebhookEvent::Backfill,
             created_at: Time,
+            payload_style:
+              Orb::BackfillReflectedWebhookEvent::PayloadStyle::TaggedSymbol,
             properties: T.anything,
             type: Orb::BackfillReflectedWebhookEvent::Type::TaggedSymbol
           }
@@ -245,6 +259,39 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::BackfillReflectedWebhookEvent::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::BackfillReflectedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::BackfillReflectedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::BackfillReflectedWebhookEvent::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       # The event this payload describes.
       module Type
         extend Orb::Internal::Type::Enum

data/rbi/orb/models/backfill_reverted_webhook_event.rbi

@@ -28,6 +28,13 @@ module Orb
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      sig do
+        returns(Orb::BackfillRevertedWebhookEvent::PayloadStyle::TaggedSymbol)
+      end
+      attr_accessor :payload_style
+
       sig { returns(T.anything) }
       attr_accessor :properties
 
@@ -41,6 +48,8 @@ module Orb
           id: String,
           backfill: Orb::BackfillRevertedWebhookEvent::Backfill::OrHash,
           created_at: Time,
+          payload_style:
+            Orb::BackfillRevertedWebhookEvent::PayloadStyle::OrSymbol,
           properties: T.anything,
           type: Orb::BackfillRevertedWebhookEvent::Type::OrSymbol
         ).returns(T.attached_class)
@@ -53,6 +62,9 @@ module Orb
         backfill:,
         # The time at which this event was created, to the second.
         created_at:,
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        payload_style:,
         properties:,
         # The event this payload describes.
         type:
@@ -65,6 +77,8 @@ module Orb
             id: String,
             backfill: Orb::BackfillRevertedWebhookEvent::Backfill,
             created_at: Time,
+            payload_style:
+              Orb::BackfillRevertedWebhookEvent::PayloadStyle::TaggedSymbol,
             properties: T.anything,
             type: Orb::BackfillRevertedWebhookEvent::Type::TaggedSymbol
           }
@@ -242,6 +256,39 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::BackfillRevertedWebhookEvent::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::BackfillRevertedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::BackfillRevertedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::BackfillRevertedWebhookEvent::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       # The event this payload describes.
       module Type
         extend Orb::Internal::Type::Enum