orb-billing 1.44.0 → 1.46.0

data/lib/orb/models/subscription_spend_exceeded_webhook_event.rb

@@ -15,6 +15,13 @@ module Orb
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::SubscriptionSpendExceededWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::SubscriptionSpendExceededWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Orb::Models::SubscriptionSpendExceededWebhookEvent::Properties]
@@ -50,7 +57,7 @@ module Orb
       #   @return [Symbol, Orb::Models::SubscriptionSpendExceededWebhookEvent::Type]
       required :type, enum: -> { Orb::SubscriptionSpendExceededWebhookEvent::Type }
 
-      # @!method initialize(id:, created_at:, properties:, subscription:, type:)
+      # @!method initialize(id:, created_at:, payload_style:, properties:, subscription:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::SubscriptionSpendExceededWebhookEvent} for more details.
       #
@@ -61,12 +68,28 @@ module Orb
       #
       #   @param created_at [Time] The time at which this event was created, to the second.
       #
+      #   @param payload_style [Symbol, Orb::Models::SubscriptionSpendExceededWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Orb::Models::SubscriptionSpendExceededWebhookEvent::Properties]
       #
       #   @param subscription [Orb::Models::Subscription] A [subscription](/core-concepts#subscription) represents the purchase of a plan
       #
       #   @param type [Symbol, Orb::Models::SubscriptionSpendExceededWebhookEvent::Type] The event this payload describes.
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::SubscriptionSpendExceededWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see Orb::Models::SubscriptionSpendExceededWebhookEvent#properties
       class Properties < Orb::Internal::Type::BaseModel
         # @!attribute alert_configuration

data/lib/orb/models/subscription_started_webhook_event.rb

@@ -15,6 +15,13 @@ module Orb
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::SubscriptionStartedWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::SubscriptionStartedWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Object]
@@ -50,7 +57,7 @@ module Orb
       #   @return [Symbol, Orb::Models::SubscriptionStartedWebhookEvent::Type]
       required :type, enum: -> { Orb::SubscriptionStartedWebhookEvent::Type }
 
-      # @!method initialize(id:, created_at:, properties:, subscription:, type:)
+      # @!method initialize(id:, created_at:, payload_style:, properties:, subscription:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::SubscriptionStartedWebhookEvent} for more details.
       #
@@ -60,12 +67,28 @@ module Orb
       #
       #   @param created_at [Time] The time at which this event was created, to the second.
       #
+      #   @param payload_style [Symbol, Orb::Models::SubscriptionStartedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Object]
       #
       #   @param subscription [Orb::Models::Subscription] A [subscription](/core-concepts#subscription) represents the purchase of a plan
       #
       #   @param type [Symbol, Orb::Models::SubscriptionStartedWebhookEvent::Type] The event this payload describes.
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::SubscriptionStartedWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # The event this payload describes.
       #
       # @see Orb::Models::SubscriptionStartedWebhookEvent#type

data/lib/orb/models/subscription_trial_ended_webhook_event.rb

@@ -15,6 +15,13 @@ module Orb
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::SubscriptionTrialEndedWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::SubscriptionTrialEndedWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Object]
@@ -50,7 +57,7 @@ module Orb
       #   @return [Symbol, Orb::Models::SubscriptionTrialEndedWebhookEvent::Type]
       required :type, enum: -> { Orb::SubscriptionTrialEndedWebhookEvent::Type }
 
-      # @!method initialize(id:, created_at:, properties:, subscription:, type:)
+      # @!method initialize(id:, created_at:, payload_style:, properties:, subscription:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::SubscriptionTrialEndedWebhookEvent} for more details.
       #
@@ -60,12 +67,28 @@ module Orb
       #
       #   @param created_at [Time] The time at which this event was created, to the second.
       #
+      #   @param payload_style [Symbol, Orb::Models::SubscriptionTrialEndedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Object]
       #
       #   @param subscription [Orb::Models::Subscription] A [subscription](/core-concepts#subscription) represents the purchase of a plan
       #
       #   @param type [Symbol, Orb::Models::SubscriptionTrialEndedWebhookEvent::Type] The event this payload describes.
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::SubscriptionTrialEndedWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # The event this payload describes.
       #
       # @see Orb::Models::SubscriptionTrialEndedWebhookEvent#type

data/lib/orb/models/subscription_usage_exceeded_webhook_event.rb

@@ -15,6 +15,13 @@ module Orb
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::SubscriptionUsageExceededWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::SubscriptionUsageExceededWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties]
@@ -50,7 +57,7 @@ module Orb
       #   @return [Symbol, Orb::Models::SubscriptionUsageExceededWebhookEvent::Type]
       required :type, enum: -> { Orb::SubscriptionUsageExceededWebhookEvent::Type }
 
-      # @!method initialize(id:, created_at:, properties:, subscription:, type:)
+      # @!method initialize(id:, created_at:, payload_style:, properties:, subscription:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::SubscriptionUsageExceededWebhookEvent} for more details.
       #
@@ -61,12 +68,28 @@ module Orb
       #
       #   @param created_at [Time] The time at which this event was created, to the second.
       #
+      #   @param payload_style [Symbol, Orb::Models::SubscriptionUsageExceededWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties]
       #
       #   @param subscription [Orb::Models::Subscription] A [subscription](/core-concepts#subscription) represents the purchase of a plan
       #
       #   @param type [Symbol, Orb::Models::SubscriptionUsageExceededWebhookEvent::Type] The event this payload describes.
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::SubscriptionUsageExceededWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see Orb::Models::SubscriptionUsageExceededWebhookEvent#properties
       class Properties < Orb::Internal::Type::BaseModel
         # @!attribute alert_configuration

data/lib/orb/models/transaction_accounting_sync_failed_webhook_event.rb

@@ -21,6 +21,13 @@ module Orb
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::TransactionAccountingSyncFailedWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::TransactionAccountingSyncFailedWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Orb::Models::TransactionAccountingSyncFailedWebhookEvent::Properties]
@@ -37,7 +44,10 @@ module Orb
       #   @return [Symbol, Orb::Models::TransactionAccountingSyncFailedWebhookEvent::Type]
       required :type, enum: -> { Orb::TransactionAccountingSyncFailedWebhookEvent::Type }
 
-      # @!method initialize(id:, accounting_sync_record:, created_at:, properties:, transaction:, type:)
+      # @!method initialize(id:, accounting_sync_record:, created_at:, payload_style:, properties:, transaction:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::TransactionAccountingSyncFailedWebhookEvent} for more details.
+      #
       #   Issued when a transaction accounting sync fails.
       #
       #   @param id [String] The ID of this webhook event.
@@ -46,6 +56,8 @@ module Orb
       #
       #   @param created_at [Time] The time at which this event was created, to the second.
       #
+      #   @param payload_style [Symbol, Orb::Models::TransactionAccountingSyncFailedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Orb::Models::TransactionAccountingSyncFailedWebhookEvent::Properties]
       #
       #   @param transaction [Orb::Models::TransactionAccountingSyncFailedWebhookEvent::Transaction]
@@ -123,6 +135,20 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::TransactionAccountingSyncFailedWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see Orb::Models::TransactionAccountingSyncFailedWebhookEvent#properties
       class Properties < Orb::Internal::Type::BaseModel
         # @!attribute connection_type

data/lib/orb/models/transaction_accounting_sync_succeeded_webhook_event.rb

@@ -21,6 +21,13 @@ module Orb
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::TransactionAccountingSyncSucceededWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::TransactionAccountingSyncSucceededWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Orb::Models::TransactionAccountingSyncSucceededWebhookEvent::Properties]
@@ -37,7 +44,10 @@ module Orb
       #   @return [Symbol, Orb::Models::TransactionAccountingSyncSucceededWebhookEvent::Type]
       required :type, enum: -> { Orb::TransactionAccountingSyncSucceededWebhookEvent::Type }
 
-      # @!method initialize(id:, accounting_sync_record:, created_at:, properties:, transaction:, type:)
+      # @!method initialize(id:, accounting_sync_record:, created_at:, payload_style:, properties:, transaction:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::TransactionAccountingSyncSucceededWebhookEvent} for more details.
+      #
       #   Issued when a transaction accounting sync succeeds.
       #
       #   @param id [String] The ID of this webhook event.
@@ -46,6 +56,8 @@ module Orb
       #
       #   @param created_at [Time] The time at which this event was created, to the second.
       #
+      #   @param payload_style [Symbol, Orb::Models::TransactionAccountingSyncSucceededWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Orb::Models::TransactionAccountingSyncSucceededWebhookEvent::Properties]
       #
       #   @param transaction [Orb::Models::TransactionAccountingSyncSucceededWebhookEvent::Transaction]
@@ -123,6 +135,20 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::TransactionAccountingSyncSucceededWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see Orb::Models::TransactionAccountingSyncSucceededWebhookEvent#properties
       class Properties < Orb::Internal::Type::BaseModel
         # @!attribute connection_type

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

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Webhooks
+      class BackfillReflectedStandardWebhookEvent < Orb::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of this webhook event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute backfill
+        #   A backfill represents an update to historical usage data, adding or replacing
+        #   events in a timeframe.
+        #
+        #   @return [Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill]
+        required :backfill, -> { Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill }
+
+        # @!attribute created_at
+        #   The time at which this event was created, to the second.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute payload_style
+        #   The serialization style this payload was rendered in, as configured on the
+        #   endpoint.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent::PayloadStyle]
+        required :payload_style, enum: -> { Orb::Webhooks::BackfillReflectedStandardWebhookEvent::PayloadStyle }
+
+        # @!attribute properties
+        #
+        #   @return [Object]
+        required :properties, Orb::Internal::Type::Unknown
+
+        # @!attribute type
+        #   The event this payload describes.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent::Type]
+        required :type, enum: -> { Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Type }
+
+        # @!method initialize(id:, backfill:, created_at:, payload_style:, properties:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent} for more details.
+        #
+        #   Issued when a backfill is closed and its events are reflected into usage.
+        #
+        #   @param id [String] The ID of this webhook event.
+        #
+        #   @param backfill [Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill] A backfill represents an update to historical usage data, adding or replacing ev
+        #
+        #   @param created_at [Time] The time at which this event was created, to the second.
+        #
+        #   @param payload_style [Symbol, Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+        #
+        #   @param properties [Object]
+        #
+        #   @param type [Symbol, Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent::Type] The event this payload describes.
+
+        # @see Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent#backfill
+        class Backfill < Orb::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute close_time
+          #   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.
+          #
+          #   @return [Time, nil]
+          required :close_time, Time, nil?: true
+
+          # @!attribute created_at
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute customer_id
+          #   The Orb-generated ID of the customer to which this backfill is scoped. If
+          #   `null`, this backfill is scoped to all customers.
+          #
+          #   @return [String, nil]
+          required :customer_id, String, nil?: true
+
+          # @!attribute events_ingested
+          #   The number of events ingested in this backfill.
+          #
+          #   @return [Integer]
+          required :events_ingested, Integer
+
+          # @!attribute replace_existing_events
+          #   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.
+          #
+          #   @return [Boolean]
+          required :replace_existing_events, Orb::Internal::Type::Boolean
+
+          # @!attribute reverted_at
+          #   The time at which this backfill was reverted.
+          #
+          #   @return [Time, nil]
+          required :reverted_at, Time, nil?: true
+
+          # @!attribute status
+          #   The status of the backfill.
+          #
+          #   @return [Symbol, Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill::Status]
+          required :status, enum: -> { Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill::Status }
+
+          # @!attribute timeframe_end
+          #
+          #   @return [Time]
+          required :timeframe_end, Time
+
+          # @!attribute timeframe_start
+          #
+          #   @return [Time]
+          required :timeframe_start, Time
+
+          # @!attribute deprecation_filter
+          #   A boolean
+          #   [computed property](/extensibility/advanced-metrics#computed-properties) used to
+          #   filter the set of events to deprecate
+          #
+          #   @return [String, nil]
+          optional :deprecation_filter, String, nil?: true
+
+          # @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill} for
+          #   more details.
+          #
+          #   A backfill represents an update to historical usage data, adding or replacing
+          #   events in a timeframe.
+          #
+          #   @param id [String]
+          #
+          #   @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
+          #
+          #   @param created_at [Time]
+          #
+          #   @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
+          #
+          #   @param events_ingested [Integer] The number of events ingested in this backfill.
+          #
+          #   @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
+          #
+          #   @param reverted_at [Time, nil] The time at which this backfill was reverted.
+          #
+          #   @param status [Symbol, Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill::Status] The status of the backfill.
+          #
+          #   @param timeframe_end [Time]
+          #
+          #   @param timeframe_start [Time]
+          #
+          #   @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
+
+          # The status of the backfill.
+          #
+          # @see Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill#status
+          module Status
+            extend Orb::Internal::Type::Enum
+
+            PENDING = :pending
+            REFLECTED = :reflected
+            PENDING_REVERT = :pending_revert
+            REVERTED = :reverted
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        #
+        # @see Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent#payload_style
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED = :expanded
+          STANDARD = :standard
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The event this payload describes.
+        #
+        # @see Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent#type
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          BACKFILL_REFLECTED = :"backfill.reflected"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end