orb-billing 1.35.0 → 1.37.0

data/lib/orb.rb

@@ -71,6 +71,8 @@ require_relative "orb/models/alert_update_params"
 require_relative "orb/models/allocation"
 require_relative "orb/models/amount_discount"
 require_relative "orb/models/amount_discount_interval"
+require_relative "orb/models/backfill_reflected_webhook_event"
+require_relative "orb/models/backfill_reverted_webhook_event"
 require_relative "orb/models/beta/external_plan_id_create_plan_version_params"
 require_relative "orb/models/beta/external_plan_id_fetch_plan_version_params"
 require_relative "orb/models/beta/external_plan_id_set_default_plan_version_params"
@@ -78,6 +80,7 @@ require_relative "orb/models/beta_create_plan_version_params"
 require_relative "orb/models/beta_fetch_plan_version_params"
 require_relative "orb/models/beta_set_default_plan_version_params"
 require_relative "orb/models/billable_metric"
+require_relative "orb/models/billable_metric_edited_webhook_event"
 require_relative "orb/models/billable_metric_tiny"
 require_relative "orb/models/billing_cycle_anchor_configuration"
 require_relative "orb/models/billing_cycle_configuration"
@@ -96,23 +99,38 @@ require_relative "orb/models/coupon_fetch_params"
 require_relative "orb/models/coupon_list_params"
 require_relative "orb/models/coupon_redemption"
 require_relative "orb/models/coupons/subscription_list_params"
+require_relative "orb/models/credit_block_accounting_sync_failed_webhook_event"
+require_relative "orb/models/credit_block_accounting_sync_succeeded_webhook_event"
 require_relative "orb/models/credit_block_delete_params"
 require_relative "orb/models/credit_block_list_invoices_params"
 require_relative "orb/models/credit_block_list_invoices_response"
 require_relative "orb/models/credit_block_retrieve_params"
 require_relative "orb/models/credit_block_retrieve_response"
 require_relative "orb/models/credit_note"
+require_relative "orb/models/credit_note_accounting_sync_failed_webhook_event"
+require_relative "orb/models/credit_note_accounting_sync_succeeded_webhook_event"
 require_relative "orb/models/credit_note_create_params"
 require_relative "orb/models/credit_note_fetch_params"
+require_relative "orb/models/credit_note_issued_webhook_event"
 require_relative "orb/models/credit_note_list_params"
+require_relative "orb/models/credit_note_marked_as_void_webhook_event"
 require_relative "orb/models/credit_note_tiny"
 require_relative "orb/models/customer"
+require_relative "orb/models/customer_accounting_sync_failed_webhook_event"
+require_relative "orb/models/customer_accounting_sync_succeeded_webhook_event"
+require_relative "orb/models/customer_balance_transaction_created_webhook_event"
+require_relative "orb/models/customer_created_webhook_event"
 require_relative "orb/models/customer_create_params"
 require_relative "orb/models/customer_create_portal_session_by_external_id_params"
 require_relative "orb/models/customer_create_portal_session_by_external_id_response"
 require_relative "orb/models/customer_create_portal_session_params"
 require_relative "orb/models/customer_create_portal_session_response"
+require_relative "orb/models/customer_credit_balance_depleted_webhook_event"
+require_relative "orb/models/customer_credit_balance_dropped_webhook_event"
+require_relative "orb/models/customer_credit_balance_recovered_webhook_event"
+require_relative "orb/models/customer_credit_ledger_incremented_webhook_event"
 require_relative "orb/models/customer_delete_params"
+require_relative "orb/models/customer_edited_webhook_event"
 require_relative "orb/models/customer_fetch_by_external_id_params"
 require_relative "orb/models/customer_fetch_params"
 require_relative "orb/models/customer_hierarchy_config"
@@ -163,6 +181,8 @@ require_relative "orb/models/customer_tax_id"
 require_relative "orb/models/customer_update_by_external_id_params"
 require_relative "orb/models/customer_update_params"
 require_relative "orb/models/custom_expiration"
+require_relative "orb/models/data_exports_transfer_error_webhook_event"
+require_relative "orb/models/data_exports_transfer_success_webhook_event"
 require_relative "orb/models/dimensional_price_configuration"
 require_relative "orb/models/dimensional_price_group"
 require_relative "orb/models/dimensional_price_group_create_params"
@@ -193,16 +213,34 @@ require_relative "orb/models/events/event_volumes"
 require_relative "orb/models/events/volume_list_params"
 require_relative "orb/models/event_search_params"
 require_relative "orb/models/event_search_response"
+require_relative "orb/models/event_unmatched_event_webhook_event"
 require_relative "orb/models/event_update_params"
 require_relative "orb/models/event_update_response"
 require_relative "orb/models/fixed_fee_quantity_schedule_entry"
 require_relative "orb/models/fixed_fee_quantity_transition"
+require_relative "orb/models/ingestion_unmatched_customer_ids_webhook_event"
 require_relative "orb/models/invoice"
+require_relative "orb/models/invoice_accounting_sync_failed_webhook_event"
+require_relative "orb/models/invoice_accounting_sync_succeeded_webhook_event"
+require_relative "orb/models/invoice_automation_schedule_step_executed_webhook_event"
+require_relative "orb/models/invoice_cost_data_exported_webhook_event"
 require_relative "orb/models/invoice_create_params"
 require_relative "orb/models/invoice_delete_line_item_params"
+require_relative "orb/models/invoice_due_date_recalculation_canceled_webhook_event"
+require_relative "orb/models/invoice_due_date_recalculation_completed_webhook_event"
+require_relative "orb/models/invoice_due_date_recalculation_started_webhook_event"
+require_relative "orb/models/invoice_dunning_schedule_created_webhook_event"
+require_relative "orb/models/invoice_dunning_schedule_ended_webhook_event"
+require_relative "orb/models/invoice_dunning_schedule_reset_webhook_event"
+require_relative "orb/models/invoice_dunning_schedule_step_executed_webhook_event"
+require_relative "orb/models/invoice_edited_webhook_event"
 require_relative "orb/models/invoice_fetch_params"
 require_relative "orb/models/invoice_fetch_upcoming_params"
 require_relative "orb/models/invoice_fetch_upcoming_response"
+require_relative "orb/models/invoice_invoice_date_elapsed_webhook_event"
+require_relative "orb/models/invoice_issued_summary_webhook_event"
+require_relative "orb/models/invoice_issued_webhook_event"
+require_relative "orb/models/invoice_issue_failed_webhook_event"
 require_relative "orb/models/invoice_issue_params"
 require_relative "orb/models/invoice_issue_summary_params"
 require_relative "orb/models/invoice_issue_summary_response"
@@ -212,11 +250,19 @@ require_relative "orb/models/invoice_line_item_create_response"
 require_relative "orb/models/invoice_list_params"
 require_relative "orb/models/invoice_list_summary_params"
 require_relative "orb/models/invoice_list_summary_response"
+require_relative "orb/models/invoice_manually_marked_as_paid_webhook_event"
+require_relative "orb/models/invoice_manually_marked_as_void_webhook_event"
 require_relative "orb/models/invoice_mark_paid_params"
+require_relative "orb/models/invoice_payment_failed_webhook_event"
+require_relative "orb/models/invoice_payment_processing_webhook_event"
+require_relative "orb/models/invoice_payment_succeeded_webhook_event"
 require_relative "orb/models/invoice_pay_params"
 require_relative "orb/models/invoice_regenerate_invoice_pdf_params"
 require_relative "orb/models/invoice_regenerate_receipt_pdf_params"
+require_relative "orb/models/invoice_sync_failed_webhook_event"
+require_relative "orb/models/invoice_sync_succeeded_webhook_event"
 require_relative "orb/models/invoice_tiny"
+require_relative "orb/models/invoice_undo_mark_as_paid_webhook_event"
 require_relative "orb/models/invoice_update_params"
 require_relative "orb/models/invoice_void_params"
 require_relative "orb/models/item"
@@ -255,6 +301,7 @@ require_relative "orb/models/matrix_with_allocation_config"
 require_relative "orb/models/maximum"
 require_relative "orb/models/maximum_interval"
 require_relative "orb/models/metric_create_params"
+require_relative "orb/models/metric_events_dropped_by_watermark_webhook_event"
 require_relative "orb/models/metric_fetch_params"
 require_relative "orb/models/metric_list_params"
 require_relative "orb/models/metric_update_params"
@@ -358,11 +405,14 @@ require_relative "orb/models/new_usage_discount"
 require_relative "orb/models/other_sub_line_item"
 require_relative "orb/models/package_config"
 require_relative "orb/models/pagination_metadata"
+require_relative "orb/models/payment_method_created_webhook_event"
+require_relative "orb/models/payment_method_deleted_webhook_event"
 require_relative "orb/models/percentage_discount"
 require_relative "orb/models/percentage_discount_interval"
 require_relative "orb/models/per_price_cost"
 require_relative "orb/models/plan"
 require_relative "orb/models/plan_create_params"
+require_relative "orb/models/plan_default_version_set_webhook_event"
 require_relative "orb/models/plan_fetch_params"
 require_relative "orb/models/plan_list_params"
 require_relative "orb/models/plan_phase_amount_discount_adjustment"
@@ -380,9 +430,11 @@ require_relative "orb/models/plans/migration_retrieve_params"
 require_relative "orb/models/plans/migration_retrieve_response"
 require_relative "orb/models/plan_update_params"
 require_relative "orb/models/plan_version"
+require_relative "orb/models/plan_version_created_webhook_event"
 require_relative "orb/models/plan_version_phase"
 require_relative "orb/models/price"
 require_relative "orb/models/price_create_params"
+require_relative "orb/models/price_edited_webhook_event"
 require_relative "orb/models/price_evaluate_multiple_params"
 require_relative "orb/models/price_evaluate_multiple_response"
 require_relative "orb/models/price_evaluate_params"
@@ -395,9 +447,17 @@ require_relative "orb/models/price_list_params"
 require_relative "orb/models/prices/external_price_id_fetch_params"
 require_relative "orb/models/prices/external_price_id_update_params"
 require_relative "orb/models/price_update_params"
+require_relative "orb/models/resource_event_test_webhook_event"
+require_relative "orb/models/sales_order_accounting_sync_failed_webhook_event"
+require_relative "orb/models/sales_order_accounting_sync_succeeded_webhook_event"
 require_relative "orb/models/sub_line_item_grouping"
 require_relative "orb/models/sub_line_item_matrix_config"
 require_relative "orb/models/subscription"
+require_relative "orb/models/subscription_accounting_sync_failed_webhook_event"
+require_relative "orb/models/subscription_accounting_sync_succeeded_webhook_event"
+require_relative "orb/models/subscription_alert_disabled_webhook_event"
+require_relative "orb/models/subscription_cancellation_scheduled_webhook_event"
+require_relative "orb/models/subscription_cancellation_unscheduled_webhook_event"
 require_relative "orb/models/subscription_cancel_params"
 require_relative "orb/models/subscription_change_apply_params"
 require_relative "orb/models/subscription_change_apply_response"
@@ -408,19 +468,35 @@ require_relative "orb/models/subscription_change_list_response"
 require_relative "orb/models/subscription_change_minified"
 require_relative "orb/models/subscription_change_retrieve_params"
 require_relative "orb/models/subscription_change_retrieve_response"
+require_relative "orb/models/subscription_cost_exceeded_webhook_event"
+require_relative "orb/models/subscription_created_webhook_event"
 require_relative "orb/models/subscription_create_params"
+require_relative "orb/models/subscription_edited_webhook_event"
+require_relative "orb/models/subscription_ended_webhook_event"
 require_relative "orb/models/subscription_fetch_costs_params"
 require_relative "orb/models/subscription_fetch_costs_response"
 require_relative "orb/models/subscription_fetch_params"
 require_relative "orb/models/subscription_fetch_schedule_params"
 require_relative "orb/models/subscription_fetch_schedule_response"
 require_relative "orb/models/subscription_fetch_usage_params"
+require_relative "orb/models/subscription_fixed_fee_quantity_updated_webhook_event"
+require_relative "orb/models/subscription_grouped_cost_exceeded_webhook_event"
+require_relative "orb/models/subscription_invoicing_threshold_exceeded_webhook_event"
+require_relative "orb/models/subscription_license_allocation_reset_webhook_event"
+require_relative "orb/models/subscription_license_balance_threshold_reached_webhook_event"
 require_relative "orb/models/subscription_list_params"
 require_relative "orb/models/subscription_minified"
+require_relative "orb/models/subscription_plan_changed_webhook_event"
+require_relative "orb/models/subscription_plan_change_scheduled_webhook_event"
+require_relative "orb/models/subscription_plan_version_changed_webhook_event"
+require_relative "orb/models/subscription_plan_version_change_scheduled_webhook_event"
 require_relative "orb/models/subscription_price_intervals_params"
 require_relative "orb/models/subscription_redeem_coupon_params"
 require_relative "orb/models/subscriptions"
 require_relative "orb/models/subscription_schedule_plan_change_params"
+require_relative "orb/models/subscription_spend_exceeded_webhook_event"
+require_relative "orb/models/subscription_started_webhook_event"
+require_relative "orb/models/subscription_trial_ended_webhook_event"
 require_relative "orb/models/subscription_trial_info"
 require_relative "orb/models/subscription_trigger_phase_params"
 require_relative "orb/models/subscription_unschedule_cancellation_params"
@@ -430,6 +506,7 @@ require_relative "orb/models/subscription_update_fixed_fee_quantity_params"
 require_relative "orb/models/subscription_update_params"
 require_relative "orb/models/subscription_update_trial_params"
 require_relative "orb/models/subscription_usage"
+require_relative "orb/models/subscription_usage_exceeded_webhook_event"
 require_relative "orb/models/tax_amount"
 require_relative "orb/models/threshold"
 require_relative "orb/models/tier"
@@ -438,11 +515,15 @@ require_relative "orb/models/tiered_conversion_rate_config"
 require_relative "orb/models/tier_sub_line_item"
 require_relative "orb/models/top_level_ping_params"
 require_relative "orb/models/top_level_ping_response"
+require_relative "orb/models/transaction_accounting_sync_failed_webhook_event"
+require_relative "orb/models/transaction_accounting_sync_succeeded_webhook_event"
 require_relative "orb/models/trial_discount"
 require_relative "orb/models/unit_config"
 require_relative "orb/models/unit_conversion_rate_config"
+require_relative "orb/models/unwrap_webhook_event"
 require_relative "orb/models/usage_discount"
 require_relative "orb/models/usage_discount_interval"
+require_relative "orb/models/webhook_unwrap_params"
 require_relative "orb/models"
 require_relative "orb/resources/alerts"
 require_relative "orb/resources/beta"
@@ -478,3 +559,4 @@ require_relative "orb/resources/prices/external_price_id"
 require_relative "orb/resources/subscription_changes"
 require_relative "orb/resources/subscriptions"
 require_relative "orb/resources/top_level"
+require_relative "orb/resources/webhooks"

data/rbi/orb/client.rbi

@@ -16,6 +16,9 @@ module Orb
     sig { returns(T.nilable(String)) }
     attr_reader :webhook_secret
 
+    sig { returns(Orb::Resources::Webhooks) }
+    attr_reader :webhooks
+
     sig { returns(Orb::Resources::TopLevel) }
     attr_reader :top_level
 

data/rbi/orb/models/backfill_reflected_webhook_event.rbi

@@ -0,0 +1,274 @@
+# typed: strong
+
+module Orb
+  module Models
+    class BackfillReflectedWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::BackfillReflectedWebhookEvent, Orb::Internal::AnyHash)
+        end
+
+      # The ID of this webhook event.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # A backfill represents an update to historical usage data, adding or replacing
+      # events in a timeframe.
+      sig { returns(Orb::BackfillReflectedWebhookEvent::Backfill) }
+      attr_reader :backfill
+
+      sig do
+        params(
+          backfill: Orb::BackfillReflectedWebhookEvent::Backfill::OrHash
+        ).void
+      end
+      attr_writer :backfill
+
+      # The time at which this event was created, to the second.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(T.anything) }
+      attr_accessor :properties
+
+      # The event this payload describes.
+      sig { returns(Orb::BackfillReflectedWebhookEvent::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Issued when a backfill is closed and its events are reflected into usage.
+      sig do
+        params(
+          id: String,
+          backfill: Orb::BackfillReflectedWebhookEvent::Backfill::OrHash,
+          created_at: Time,
+          properties: T.anything,
+          type: Orb::BackfillReflectedWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of this webhook event.
+        id:,
+        # A backfill represents an update to historical usage data, adding or replacing
+        # events in a timeframe.
+        backfill:,
+        # The time at which this event was created, to the second.
+        created_at:,
+        properties:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            backfill: Orb::BackfillReflectedWebhookEvent::Backfill,
+            created_at: Time,
+            properties: T.anything,
+            type: Orb::BackfillReflectedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Backfill < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::BackfillReflectedWebhookEvent::Backfill,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # If in the future, the time at which the backfill will automatically close. If in
+        # the past, the time at which the backfill was closed.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :close_time
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The Orb-generated ID of the customer to which this backfill is scoped. If
+        # `null`, this backfill is scoped to all customers.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :customer_id
+
+        # The number of events ingested in this backfill.
+        sig { returns(Integer) }
+        attr_accessor :events_ingested
+
+        # If `true`, existing events in the backfill's timeframe will be replaced with the
+        # newly ingested events associated with the backfill. If `false`, newly ingested
+        # events will be added to the existing events.
+        sig { returns(T::Boolean) }
+        attr_accessor :replace_existing_events
+
+        # The time at which this backfill was reverted.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :reverted_at
+
+        # The status of the backfill.
+        sig do
+          returns(
+            Orb::BackfillReflectedWebhookEvent::Backfill::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(Time) }
+        attr_accessor :timeframe_end
+
+        sig { returns(Time) }
+        attr_accessor :timeframe_start
+
+        # A boolean
+        # [computed property](/extensibility/advanced-metrics#computed-properties) used to
+        # filter the set of events to deprecate
+        sig { returns(T.nilable(String)) }
+        attr_accessor :deprecation_filter
+
+        # A backfill represents an update to historical usage data, adding or replacing
+        # events in a timeframe.
+        sig do
+          params(
+            id: String,
+            close_time: T.nilable(Time),
+            created_at: Time,
+            customer_id: T.nilable(String),
+            events_ingested: Integer,
+            replace_existing_events: T::Boolean,
+            reverted_at: T.nilable(Time),
+            status:
+              Orb::BackfillReflectedWebhookEvent::Backfill::Status::OrSymbol,
+            timeframe_end: Time,
+            timeframe_start: Time,
+            deprecation_filter: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # If in the future, the time at which the backfill will automatically close. If in
+          # the past, the time at which the backfill was closed.
+          close_time:,
+          created_at:,
+          # The Orb-generated ID of the customer to which this backfill is scoped. If
+          # `null`, this backfill is scoped to all customers.
+          customer_id:,
+          # The number of events ingested in this backfill.
+          events_ingested:,
+          # If `true`, existing events in the backfill's timeframe will be replaced with the
+          # newly ingested events associated with the backfill. If `false`, newly ingested
+          # events will be added to the existing events.
+          replace_existing_events:,
+          # The time at which this backfill was reverted.
+          reverted_at:,
+          # The status of the backfill.
+          status:,
+          timeframe_end:,
+          timeframe_start:,
+          # A boolean
+          # [computed property](/extensibility/advanced-metrics#computed-properties) used to
+          # filter the set of events to deprecate
+          deprecation_filter: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              close_time: T.nilable(Time),
+              created_at: Time,
+              customer_id: T.nilable(String),
+              events_ingested: Integer,
+              replace_existing_events: T::Boolean,
+              reverted_at: T.nilable(Time),
+              status:
+                Orb::BackfillReflectedWebhookEvent::Backfill::Status::TaggedSymbol,
+              timeframe_end: Time,
+              timeframe_start: Time,
+              deprecation_filter: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The status of the backfill.
+        module Status
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::BackfillReflectedWebhookEvent::Backfill::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :pending,
+              Orb::BackfillReflectedWebhookEvent::Backfill::Status::TaggedSymbol
+            )
+          REFLECTED =
+            T.let(
+              :reflected,
+              Orb::BackfillReflectedWebhookEvent::Backfill::Status::TaggedSymbol
+            )
+          PENDING_REVERT =
+            T.let(
+              :pending_revert,
+              Orb::BackfillReflectedWebhookEvent::Backfill::Status::TaggedSymbol
+            )
+          REVERTED =
+            T.let(
+              :reverted,
+              Orb::BackfillReflectedWebhookEvent::Backfill::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::BackfillReflectedWebhookEvent::Backfill::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      # The event this payload describes.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::BackfillReflectedWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BACKFILL_REFLECTED =
+          T.let(
+            :"backfill.reflected",
+            Orb::BackfillReflectedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::BackfillReflectedWebhookEvent::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end