orb-billing 0.1.0.pre.alpha.33

data/rbi/lib/orb/models/event_search_response.rbi

@@ -0,0 +1,100 @@
+# typed: strong
+
+module Orb
+  module Models
+    class EventSearchResponse < Orb::BaseModel
+      sig { returns(T::Array[Orb::Models::EventSearchResponse::Data]) }
+      attr_accessor :data
+
+      sig do
+        params(data: T::Array[T.any(Orb::Models::EventSearchResponse::Data, Orb::Util::AnyHash)])
+          .returns(T.attached_class)
+      end
+      def self.new(data:)
+      end
+
+      sig { override.returns({data: T::Array[Orb::Models::EventSearchResponse::Data]}) }
+      def to_hash
+      end
+
+      class Data < Orb::BaseModel
+        # A unique value, generated by the client, that is used to de-duplicate events.
+        #   Exactly one event with a given idempotency key will be ingested, which allows
+        #   for safe request retries.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Orb Customer identifier
+        sig { returns(T.nilable(String)) }
+        attr_accessor :customer_id
+
+        # A boolean indicating whether the event is currently deprecated.
+        sig { returns(T::Boolean) }
+        attr_accessor :deprecated
+
+        # A name to meaningfully identify the action or event type.
+        sig { returns(String) }
+        attr_accessor :event_name
+
+        # An alias for the Orb customer, whose mapping is specified when creating the
+        #   customer
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_customer_id
+
+        # A dictionary of custom properties. Values in this dictionary must be numeric,
+        #   boolean, or strings. Nested dictionaries are disallowed.
+        sig { returns(T.anything) }
+        attr_accessor :properties
+
+        # An ISO 8601 format date with no timezone offset (i.e. UTC). This should
+        #   represent the time that usage was recorded, and is particularly important to
+        #   attribute usage to a given billing period.
+        sig { returns(Time) }
+        attr_accessor :timestamp
+
+        # The [Event](/core-concepts#event) resource represents a usage event that has
+        #   been created for a customer. Events are the core of Orb's usage-based billing
+        #   model, and are used to calculate the usage charges for a given billing period.
+        sig do
+          params(
+            id: String,
+            customer_id: T.nilable(String),
+            deprecated: T::Boolean,
+            event_name: String,
+            external_customer_id: T.nilable(String),
+            properties: T.anything,
+            timestamp: Time
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          customer_id:,
+          deprecated:,
+          event_name:,
+          external_customer_id:,
+          properties:,
+          timestamp:
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                id: String,
+                customer_id: T.nilable(String),
+                deprecated: T::Boolean,
+                event_name: String,
+                external_customer_id: T.nilable(String),
+                properties: T.anything,
+                timestamp: Time
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/event_update_params.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Orb
+  module Models
+    class EventUpdateParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # A name to meaningfully identify the action or event type.
+      sig { returns(String) }
+      attr_accessor :event_name
+
+      # A dictionary of custom properties. Values in this dictionary must be numeric,
+      #   boolean, or strings. Nested dictionaries are disallowed.
+      sig { returns(T.anything) }
+      attr_accessor :properties
+
+      # An ISO 8601 format date with no timezone offset (i.e. UTC). This should
+      #   represent the time that usage was recorded, and is particularly important to
+      #   attribute usage to a given billing period.
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The Orb Customer identifier
+      sig { returns(T.nilable(String)) }
+      attr_accessor :customer_id
+
+      # An alias for the Orb customer, whose mapping is specified when creating the
+      #   customer
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_customer_id
+
+      sig do
+        params(
+          event_name: String,
+          properties: T.anything,
+          timestamp: Time,
+          customer_id: T.nilable(String),
+          external_customer_id: T.nilable(String),
+          request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        event_name:,
+        properties:,
+        timestamp:,
+        customer_id: nil,
+        external_customer_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              event_name: String,
+              properties: T.anything,
+              timestamp: Time,
+              customer_id: T.nilable(String),
+              external_customer_id: T.nilable(String),
+              request_options: Orb::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/event_update_response.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Orb
+  module Models
+    class EventUpdateResponse < Orb::BaseModel
+      # event_id of the amended event, if successfully ingested
+      sig { returns(String) }
+      attr_accessor :amended
+
+      sig { params(amended: String).returns(T.attached_class) }
+      def self.new(amended:)
+      end
+
+      sig { override.returns({amended: String}) }
+      def to_hash
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Events
+      class BackfillCloseParams < Orb::BaseModel
+        extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        sig do
+          params(request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)).returns(T.attached_class)
+        end
+        def self.new(request_options: {})
+        end
+
+        sig { override.returns({request_options: Orb::RequestOptions}) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,127 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Events
+      class BackfillCloseResponse < Orb::BaseModel
+        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 { returns(Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol) }
+        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::Models::Events::BackfillCloseResponse::Status::OrSymbol,
+            timeframe_end: Time,
+            timeframe_start: Time,
+            deprecation_filter: T.nilable(String)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          close_time:,
+          created_at:,
+          customer_id:,
+          events_ingested:,
+          replace_existing_events:,
+          reverted_at:,
+          status:,
+          timeframe_end:,
+          timeframe_start:,
+          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::Models::Events::BackfillCloseResponse::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::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) }
+
+          PENDING = T.let(:pending, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol)
+          REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol)
+          PENDING_REVERT = T.let(:pending_revert, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol)
+          REVERTED = T.let(:reverted, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol)
+
+          sig { override.returns(T::Array[Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,97 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Events
+      class BackfillCreateParams < Orb::BaseModel
+        extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        # 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.
+        sig { returns(Time) }
+        attr_accessor :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.
+        sig { returns(Time) }
+        attr_accessor :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.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :close_time
+
+        # The Orb-generated ID of the customer to which this backfill is scoped. Omitting
+        #   this field will scope the backfill to all customers.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :customer_id
+
+        # 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
+
+        # The external customer ID of the customer to which this backfill is scoped.
+        #   Omitting this field will scope the backfill to all customers.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_customer_id
+
+        # 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.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :replace_existing_events
+
+        sig { params(replace_existing_events: T::Boolean).void }
+        attr_writer :replace_existing_events
+
+        sig do
+          params(
+            timeframe_end: Time,
+            timeframe_start: Time,
+            close_time: T.nilable(Time),
+            customer_id: T.nilable(String),
+            deprecation_filter: T.nilable(String),
+            external_customer_id: T.nilable(String),
+            replace_existing_events: T::Boolean,
+            request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          timeframe_end:,
+          timeframe_start:,
+          close_time: nil,
+          customer_id: nil,
+          deprecation_filter: nil,
+          external_customer_id: nil,
+          replace_existing_events: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                timeframe_end: Time,
+                timeframe_start: Time,
+                close_time: T.nilable(Time),
+                customer_id: T.nilable(String),
+                deprecation_filter: T.nilable(String),
+                external_customer_id: T.nilable(String),
+                replace_existing_events: T::Boolean,
+                request_options: Orb::RequestOptions
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,128 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Events
+      class BackfillCreateResponse < Orb::BaseModel
+        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 { returns(Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol) }
+        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::Models::Events::BackfillCreateResponse::Status::OrSymbol,
+            timeframe_end: Time,
+            timeframe_start: Time,
+            deprecation_filter: T.nilable(String)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          close_time:,
+          created_at:,
+          customer_id:,
+          events_ingested:,
+          replace_existing_events:,
+          reverted_at:,
+          status:,
+          timeframe_end:,
+          timeframe_start:,
+          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::Models::Events::BackfillCreateResponse::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::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) }
+
+          PENDING = T.let(:pending, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol)
+          REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol)
+          PENDING_REVERT =
+            T.let(:pending_revert, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol)
+          REVERTED = T.let(:reverted, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol)
+
+          sig { override.returns(T::Array[Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Events
+      class BackfillFetchParams < Orb::BaseModel
+        extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        sig do
+          params(request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)).returns(T.attached_class)
+        end
+        def self.new(request_options: {})
+        end
+
+        sig { override.returns({request_options: Orb::RequestOptions}) }
+        def to_hash
+        end
+      end
+    end
+  end
+end