orb-billing 0.1.3 → 0.3.0

data/rbi/lib/orb/models/events/backfill_close_response.rbi

@@ -70,15 +70,28 @@ module Orb
         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
@@ -106,8 +119,7 @@ module Orb
           extend Orb::Internal::Type::Enum
 
           TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillCloseResponse::Status) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           PENDING = T.let(:pending, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol)
           REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol)

data/rbi/lib/orb/models/events/backfill_create_params.rbi

@@ -63,12 +63,30 @@ module Orb
             .returns(T.attached_class)
         end
         def self.new(
+          # The (exclusive) end of the usage timeframe affected by this backfill. By
+          # default, Orb allows backfills up to 10 days in duration at a time. Reach out to
+          # discuss extending this limit and your use case.
           timeframe_end:,
+          # The (inclusive) start of the usage timeframe affected by this backfill. By
+          # default, Orb allows backfills up to 10 days in duration at a time. Reach out to
+          # discuss extending this limit and your use case.
           timeframe_start:,
+          # The time at which no more events will be accepted for this backfill. The
+          # backfill will automatically begin reflecting throughout Orb at the close time.
+          # If not specified, it will default to 1 day after the creation of the backfill.
           close_time: nil,
+          # The Orb-generated ID of the customer to which this backfill is scoped. Omitting
+          # this field will scope the backfill to all customers.
           customer_id: nil,
+          # A boolean
+          # [computed property](/extensibility/advanced-metrics#computed-properties) used to
+          # filter the set of events to deprecate
           deprecation_filter: nil,
+          # The external customer ID of the customer to which this backfill is scoped.
+          # Omitting this field will scope the backfill to all customers.
           external_customer_id: nil,
+          # If true, replaces all existing events in the timeframe with the newly ingested
+          # events. If false, adds the newly ingested events to the existing events.
           replace_existing_events: nil,
           request_options: {}
         ); end

data/rbi/lib/orb/models/events/backfill_create_response.rbi

@@ -70,15 +70,28 @@ module Orb
         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
@@ -106,8 +119,7 @@ module Orb
           extend Orb::Internal::Type::Enum
 
           TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillCreateResponse::Status) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           PENDING = T.let(:pending, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol)
           REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol)

data/rbi/lib/orb/models/events/backfill_fetch_response.rbi

@@ -70,15 +70,28 @@ module Orb
         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
@@ -106,8 +119,7 @@ module Orb
           extend Orb::Internal::Type::Enum
 
           TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillFetchResponse::Status) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillFetchResponse::Status::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           PENDING = T.let(:pending, Orb::Models::Events::BackfillFetchResponse::Status::TaggedSymbol)
           REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillFetchResponse::Status::TaggedSymbol)

data/rbi/lib/orb/models/events/backfill_list_params.rbi

@@ -27,8 +27,14 @@ module Orb
           )
             .returns(T.attached_class)
         end
-        def self.new(cursor: nil, limit: nil, request_options: {}); end
-
+        def self.new(
+          # Cursor for pagination. This can be populated by the `next_cursor` value returned
+          # from the initial request.
+          cursor: nil,
+          # The number of items to fetch. Defaults to 20.
+          limit: nil,
+          request_options: {}
+        ); end
         sig do
           override.returns({cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOptions})
         end

data/rbi/lib/orb/models/events/backfill_list_response.rbi

@@ -70,15 +70,28 @@ module Orb
         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
@@ -106,8 +119,7 @@ module Orb
           extend Orb::Internal::Type::Enum
 
           TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillListResponse::Status) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillListResponse::Status::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           PENDING = T.let(:pending, Orb::Models::Events::BackfillListResponse::Status::TaggedSymbol)
           REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillListResponse::Status::TaggedSymbol)

data/rbi/lib/orb/models/events/backfill_revert_response.rbi

@@ -70,15 +70,28 @@ module Orb
         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
@@ -106,8 +119,7 @@ module Orb
           extend Orb::Internal::Type::Enum
 
           TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillRevertResponse::Status) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillRevertResponse::Status::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           PENDING = T.let(:pending, Orb::Models::Events::BackfillRevertResponse::Status::TaggedSymbol)
           REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillRevertResponse::Status::TaggedSymbol)

data/rbi/lib/orb/models/events/event_volumes.rbi

@@ -30,8 +30,12 @@ module Orb
           # An EventVolume contains the event volume ingested in an hourly window. The
           # timestamp used for the aggregation is the `timestamp` datetime field on events.
           sig { params(count: Integer, timeframe_end: Time, timeframe_start: Time).returns(T.attached_class) }
-          def self.new(count:, timeframe_end:, timeframe_start:); end
-
+          def self.new(
+            # The number of events ingested with a timestamp between the timeframe
+            count:,
+            timeframe_end:,
+            timeframe_start:
+          ); end
           sig { override.returns({count: Integer, timeframe_end: Time, timeframe_start: Time}) }
           def to_hash; end
         end

data/rbi/lib/orb/models/events/volume_list_params.rbi

@@ -46,8 +46,24 @@ module Orb
           )
             .returns(T.attached_class)
         end
-        def self.new(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {}); end
-
+        def self.new(
+          # The start of the timeframe, inclusive, in which to return event volume. All
+          # datetime values are converted to UTC time. If the specified time isn't
+          # hour-aligned, the response includes the event volume count for the hour the time
+          # falls in.
+          timeframe_start:,
+          # Cursor for pagination. This can be populated by the `next_cursor` value returned
+          # from the initial request.
+          cursor: nil,
+          # The number of items to fetch. Defaults to 20.
+          limit: nil,
+          # The end of the timeframe, exclusive, in which to return event volume. If not
+          # specified, the current time is used. All datetime values are converted to UTC
+          # time.If the specified time isn't hour-aligned, the response includes the event
+          # volumecount for the hour the time falls in.
+          timeframe_end: nil,
+          request_options: {}
+        ); end
         sig do
           override
             .returns(