orb-billing 1.45.0 → 1.47.0

data/rbi/orb/models/webhook_endpoint_with_secret.rbi

@@ -25,6 +25,15 @@ module Orb
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :enabled_event_types
 
+      # The payload style of the webhook events sent to this endpoint. `standard`
+      # payloads include each object's own fields and references to related objects,
+      # without invoice line items or subscription price intervals. `expanded` payloads
+      # include every object fully expanded.
+      sig do
+        returns(Orb::WebhookEndpointWithSecret::PayloadStyle::TaggedSymbol)
+      end
+      attr_accessor :payload_style
+
       # The secret used to sign the webhook events sent to this endpoint. Only returned
       # when the endpoint is created.
       sig { returns(String) }
@@ -42,6 +51,7 @@ module Orb
           created_at: Time,
           enabled: T::Boolean,
           enabled_event_types: T.nilable(T::Array[String]),
+          payload_style: Orb::WebhookEndpointWithSecret::PayloadStyle::OrSymbol,
           secret: String,
           url: String
         ).returns(T.attached_class)
@@ -56,6 +66,11 @@ module Orb
         # The webhook event types sent to this endpoint. If null, all event types are
         # sent.
         enabled_event_types:,
+        # The payload style of the webhook events sent to this endpoint. `standard`
+        # payloads include each object's own fields and references to related objects,
+        # without invoice line items or subscription price intervals. `expanded` payloads
+        # include every object fully expanded.
+        payload_style:,
         # The secret used to sign the webhook events sent to this endpoint. Only returned
         # when the endpoint is created.
         secret:,
@@ -71,6 +86,8 @@ module Orb
             created_at: Time,
             enabled: T::Boolean,
             enabled_event_types: T.nilable(T::Array[String]),
+            payload_style:
+              Orb::WebhookEndpointWithSecret::PayloadStyle::TaggedSymbol,
             secret: String,
             url: String
           }
@@ -78,6 +95,39 @@ module Orb
       end
       def to_hash
       end
+
+      # The payload style of the webhook events sent to this endpoint. `standard`
+      # payloads include each object's own fields and references to related objects,
+      # without invoice line items or subscription price intervals. `expanded` payloads
+      # include every object fully expanded.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::WebhookEndpointWithSecret::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::WebhookEndpointWithSecret::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::WebhookEndpointWithSecret::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::WebhookEndpointWithSecret::PayloadStyle::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/orb/models/webhooks/backfill_reflected_standard_webhook_event.rbi

@@ -0,0 +1,349 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Webhooks
+      class BackfillReflectedStandardWebhookEvent < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Webhooks::BackfillReflectedStandardWebhookEvent,
+              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 do
+          returns(
+            Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill
+          )
+        end
+        attr_reader :backfill
+
+        sig do
+          params(
+            backfill:
+              Orb::Webhooks::BackfillReflectedStandardWebhookEvent::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
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        sig do
+          returns(
+            Orb::Webhooks::BackfillReflectedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        end
+        attr_accessor :payload_style
+
+        sig { returns(T.anything) }
+        attr_accessor :properties
+
+        # The event this payload describes.
+        sig do
+          returns(
+            Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # Issued when a backfill is closed and its events are reflected into usage.
+        sig do
+          params(
+            id: String,
+            backfill:
+              Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill::OrHash,
+            created_at: Time,
+            payload_style:
+              Orb::Webhooks::BackfillReflectedStandardWebhookEvent::PayloadStyle::OrSymbol,
+            properties: T.anything,
+            type:
+              Orb::Webhooks::BackfillReflectedStandardWebhookEvent::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:,
+          # The serialization style this payload was rendered in, as configured on the
+          # endpoint.
+          payload_style:,
+          properties:,
+          # The event this payload describes.
+          type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              backfill:
+                Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill,
+              created_at: Time,
+              payload_style:
+                Orb::Webhooks::BackfillReflectedStandardWebhookEvent::PayloadStyle::TaggedSymbol,
+              properties: T.anything,
+              type:
+                Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Type::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Backfill < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Webhooks::BackfillReflectedStandardWebhookEvent::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::Webhooks::BackfillReflectedStandardWebhookEvent::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::Webhooks::BackfillReflectedStandardWebhookEvent::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::Webhooks::BackfillReflectedStandardWebhookEvent::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::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PENDING =
+              T.let(
+                :pending,
+                Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill::Status::TaggedSymbol
+              )
+            REFLECTED =
+              T.let(
+                :reflected,
+                Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill::Status::TaggedSymbol
+              )
+            PENDING_REVERT =
+              T.let(
+                :pending_revert,
+                Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill::Status::TaggedSymbol
+              )
+            REVERTED =
+              T.let(
+                :reverted,
+                Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Backfill::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          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::Webhooks::BackfillReflectedStandardWebhookEvent::PayloadStyle
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EXPANDED =
+            T.let(
+              :expanded,
+              Orb::Webhooks::BackfillReflectedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+          STANDARD =
+            T.let(
+              :standard,
+              Orb::Webhooks::BackfillReflectedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::BackfillReflectedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The event this payload describes.
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BACKFILL_REFLECTED =
+            T.let(
+              :"backfill.reflected",
+              Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::BackfillReflectedStandardWebhookEvent::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end