orb-billing 0.1.0.pre.alpha.33

data/lib/orb/models/evaluate_price_group.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class EvaluatePriceGroup < Orb::BaseModel
+      # @!attribute amount
+      #   The price's output for the group
+      #
+      #   @return [String]
+      required :amount, String
+
+      # @!attribute grouping_values
+      #   The values for the group in the order specified by `grouping_keys`
+      #
+      #   @return [Array<String, Float, Boolean>]
+      required :grouping_values, -> { Orb::ArrayOf[union: Orb::Models::EvaluatePriceGroup::GroupingValue] }
+
+      # @!attribute quantity
+      #   The price's usage quantity for the group
+      #
+      #   @return [Float]
+      required :quantity, Float
+
+      # @!parse
+      #   # @param amount [String]
+      #   # @param grouping_values [Array<String, Float, Boolean>]
+      #   # @param quantity [Float]
+      #   #
+      #   def initialize(amount:, grouping_values:, quantity:, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+
+      module GroupingValue
+        extend Orb::Union
+
+        variant String
+
+        variant Float
+
+        variant Orb::BooleanModel
+
+        # @!parse
+        #   # @return [Array(String, Float, Boolean)]
+        #   def self.variants; end
+      end
+    end
+  end
+end

data/lib/orb/models/event_deprecate_params.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Events#deprecate
+    class EventDeprecateParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!parse
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/event_deprecate_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Events#deprecate
+    class EventDeprecateResponse < Orb::BaseModel
+      # @!attribute deprecated
+      #   event_id of the deprecated event, if successfully updated
+      #
+      #   @return [String]
+      required :deprecated, String
+
+      # @!parse
+      #   # @param deprecated [String]
+      #   #
+      #   def initialize(deprecated:, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/event_ingest_params.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Events#ingest
+    class EventIngestParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute events
+      #
+      #   @return [Array<Orb::Models::EventIngestParams::Event>]
+      required :events, -> { Orb::ArrayOf[Orb::Models::EventIngestParams::Event] }
+
+      # @!attribute backfill_id
+      #   If this ingestion request is part of a backfill, this parameter ties the
+      #     ingested events to the backfill
+      #
+      #   @return [String, nil]
+      optional :backfill_id, String, nil?: true
+
+      # @!attribute [r] debug
+      #   Flag to enable additional debug information in the endpoint response
+      #
+      #   @return [Boolean, nil]
+      optional :debug, Orb::BooleanModel
+
+      # @!parse
+      #   # @return [Boolean]
+      #   attr_writer :debug
+
+      # @!parse
+      #   # @param events [Array<Orb::Models::EventIngestParams::Event>]
+      #   # @param backfill_id [String, nil]
+      #   # @param debug [Boolean]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(events:, backfill_id: nil, debug: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+
+      class Event < Orb::BaseModel
+        # @!attribute event_name
+        #   A name to meaningfully identify the action or event type.
+        #
+        #   @return [String]
+        required :event_name, String
+
+        # @!attribute idempotency_key
+        #   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.
+        #
+        #   @return [String]
+        required :idempotency_key, String
+
+        # @!attribute properties
+        #   A dictionary of custom properties. Values in this dictionary must be numeric,
+        #     boolean, or strings. Nested dictionaries are disallowed.
+        #
+        #   @return [Object]
+        required :properties, Orb::Unknown
+
+        # @!attribute timestamp
+        #   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.
+        #
+        #   @return [Time]
+        required :timestamp, Time
+
+        # @!attribute customer_id
+        #   The Orb Customer identifier
+        #
+        #   @return [String, nil]
+        optional :customer_id, String, nil?: true
+
+        # @!attribute external_customer_id
+        #   An alias for the Orb customer, whose mapping is specified when creating the
+        #     customer
+        #
+        #   @return [String, nil]
+        optional :external_customer_id, String, nil?: true
+
+        # @!parse
+        #   # @param event_name [String]
+        #   # @param idempotency_key [String]
+        #   # @param properties [Object]
+        #   # @param timestamp [Time]
+        #   # @param customer_id [String, nil]
+        #   # @param external_customer_id [String, nil]
+        #   #
+        #   def initialize(event_name:, idempotency_key:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/orb/models/event_ingest_response.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Events#ingest
+    class EventIngestResponse < Orb::BaseModel
+      # @!attribute validation_failed
+      #   Contains all failing validation events. In the case of a 200, this array will
+      #     always be empty. This field will always be present.
+      #
+      #   @return [Array<Orb::Models::EventIngestResponse::ValidationFailed>]
+      required :validation_failed, -> { Orb::ArrayOf[Orb::Models::EventIngestResponse::ValidationFailed] }
+
+      # @!attribute debug
+      #   Optional debug information (only present when debug=true is passed to the
+      #     endpoint). Contains ingested and duplicate event idempotency keys.
+      #
+      #   @return [Orb::Models::EventIngestResponse::Debug, nil]
+      optional :debug, -> { Orb::Models::EventIngestResponse::Debug }, nil?: true
+
+      # @!parse
+      #   # @param validation_failed [Array<Orb::Models::EventIngestResponse::ValidationFailed>]
+      #   # @param debug [Orb::Models::EventIngestResponse::Debug, nil]
+      #   #
+      #   def initialize(validation_failed:, debug: nil, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+
+      class ValidationFailed < Orb::BaseModel
+        # @!attribute idempotency_key
+        #   The passed idempotency_key corresponding to the validation_errors
+        #
+        #   @return [String]
+        required :idempotency_key, String
+
+        # @!attribute validation_errors
+        #   An array of strings corresponding to validation failures for this
+        #     idempotency_key.
+        #
+        #   @return [Array<String>]
+        required :validation_errors, Orb::ArrayOf[String]
+
+        # @!parse
+        #   # @param idempotency_key [String]
+        #   # @param validation_errors [Array<String>]
+        #   #
+        #   def initialize(idempotency_key:, validation_errors:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+
+      # @see Orb::Models::EventIngestResponse#debug
+      class Debug < Orb::BaseModel
+        # @!attribute duplicate
+        #
+        #   @return [Array<String>]
+        required :duplicate, Orb::ArrayOf[String]
+
+        # @!attribute ingested
+        #
+        #   @return [Array<String>]
+        required :ingested, Orb::ArrayOf[String]
+
+        # @!parse
+        #   # Optional debug information (only present when debug=true is passed to the
+        #   #   endpoint). Contains ingested and duplicate event idempotency keys.
+        #   #
+        #   # @param duplicate [Array<String>]
+        #   # @param ingested [Array<String>]
+        #   #
+        #   def initialize(duplicate:, ingested:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/orb/models/event_search_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Events#search
+    class EventSearchParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute event_ids
+      #   This is an explicit array of IDs to filter by. Note that an event's ID is the
+      #     idempotency_key that was originally used for ingestion, and this only supports
+      #     events that have not been amended. Values in this array will be treated case
+      #     sensitively.
+      #
+      #   @return [Array<String>]
+      required :event_ids, Orb::ArrayOf[String]
+
+      # @!attribute timeframe_end
+      #   The end of the timeframe, exclusive, in which to search events. If not
+      #     specified, the current time is used.
+      #
+      #   @return [Time, nil]
+      optional :timeframe_end, Time, nil?: true
+
+      # @!attribute timeframe_start
+      #   The start of the timeframe, inclusive, in which to search events. If not
+      #     specified, the one week ago is used.
+      #
+      #   @return [Time, nil]
+      optional :timeframe_start, Time, nil?: true
+
+      # @!parse
+      #   # @param event_ids [Array<String>]
+      #   # @param timeframe_end [Time, nil]
+      #   # @param timeframe_start [Time, nil]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/event_search_response.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Events#search
+    class EventSearchResponse < Orb::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Orb::Models::EventSearchResponse::Data>]
+      required :data, -> { Orb::ArrayOf[Orb::Models::EventSearchResponse::Data] }
+
+      # @!parse
+      #   # @param data [Array<Orb::Models::EventSearchResponse::Data>]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+
+      class Data < Orb::BaseModel
+        # @!attribute id
+        #   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.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute customer_id
+        #   The Orb Customer identifier
+        #
+        #   @return [String, nil]
+        required :customer_id, String, nil?: true
+
+        # @!attribute deprecated
+        #   A boolean indicating whether the event is currently deprecated.
+        #
+        #   @return [Boolean]
+        required :deprecated, Orb::BooleanModel
+
+        # @!attribute event_name
+        #   A name to meaningfully identify the action or event type.
+        #
+        #   @return [String]
+        required :event_name, String
+
+        # @!attribute external_customer_id
+        #   An alias for the Orb customer, whose mapping is specified when creating the
+        #     customer
+        #
+        #   @return [String, nil]
+        required :external_customer_id, String, nil?: true
+
+        # @!attribute properties
+        #   A dictionary of custom properties. Values in this dictionary must be numeric,
+        #     boolean, or strings. Nested dictionaries are disallowed.
+        #
+        #   @return [Object]
+        required :properties, Orb::Unknown
+
+        # @!attribute timestamp
+        #   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.
+        #
+        #   @return [Time]
+        required :timestamp, Time
+
+        # @!parse
+        #   # 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.
+        #   #
+        #   # @param id [String]
+        #   # @param customer_id [String, nil]
+        #   # @param deprecated [Boolean]
+        #   # @param event_name [String]
+        #   # @param external_customer_id [String, nil]
+        #   # @param properties [Object]
+        #   # @param timestamp [Time]
+        #   #
+        #   def initialize(id:, customer_id:, deprecated:, event_name:, external_customer_id:, properties:, timestamp:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/orb/models/event_update_params.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Events#update
+    class EventUpdateParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute event_name
+      #   A name to meaningfully identify the action or event type.
+      #
+      #   @return [String]
+      required :event_name, String
+
+      # @!attribute properties
+      #   A dictionary of custom properties. Values in this dictionary must be numeric,
+      #     boolean, or strings. Nested dictionaries are disallowed.
+      #
+      #   @return [Object]
+      required :properties, Orb::Unknown
+
+      # @!attribute timestamp
+      #   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.
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute customer_id
+      #   The Orb Customer identifier
+      #
+      #   @return [String, nil]
+      optional :customer_id, String, nil?: true
+
+      # @!attribute external_customer_id
+      #   An alias for the Orb customer, whose mapping is specified when creating the
+      #     customer
+      #
+      #   @return [String, nil]
+      optional :external_customer_id, String, nil?: true
+
+      # @!parse
+      #   # @param event_name [String]
+      #   # @param properties [Object]
+      #   # @param timestamp [Time]
+      #   # @param customer_id [String, nil]
+      #   # @param external_customer_id [String, nil]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/event_update_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Events#update
+    class EventUpdateResponse < Orb::BaseModel
+      # @!attribute amended
+      #   event_id of the amended event, if successfully ingested
+      #
+      #   @return [String]
+      required :amended, String
+
+      # @!parse
+      #   # @param amended [String]
+      #   #
+      #   def initialize(amended:, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Events
+      # @see Orb::Resources::Events::Backfills#close
+      class BackfillCloseParams < Orb::BaseModel
+        # @!parse
+        #   extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        # @!parse
+        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(request_options: {}, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Events
+      # @see Orb::Resources::Events::Backfills#close
+      class BackfillCloseResponse < Orb::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::BooleanModel
+
+        # @!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::Events::BackfillCloseResponse::Status]
+        required :status, enum: -> { Orb::Models::Events::BackfillCloseResponse::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
+
+        # @!parse
+        #   # A backfill represents an update to historical usage data, adding or replacing
+        #   #   events in a timeframe.
+        #   #
+        #   # @param id [String]
+        #   # @param close_time [Time, nil]
+        #   # @param created_at [Time]
+        #   # @param customer_id [String, nil]
+        #   # @param events_ingested [Integer]
+        #   # @param replace_existing_events [Boolean]
+        #   # @param reverted_at [Time, nil]
+        #   # @param status [Symbol, Orb::Models::Events::BackfillCloseResponse::Status]
+        #   # @param timeframe_end [Time]
+        #   # @param timeframe_start [Time]
+        #   # @param deprecation_filter [String, nil]
+        #   #
+        #   def initialize(
+        #     id:,
+        #     close_time:,
+        #     created_at:,
+        #     customer_id:,
+        #     events_ingested:,
+        #     replace_existing_events:,
+        #     reverted_at:,
+        #     status:,
+        #     timeframe_end:,
+        #     timeframe_start:,
+        #     deprecation_filter: nil,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+
+        # The status of the backfill.
+        #
+        # @see Orb::Models::Events::BackfillCloseResponse#status
+        module Status
+          extend Orb::Enum
+
+          PENDING = :pending
+          REFLECTED = :reflected
+          PENDING_REVERT = :pending_revert
+          REVERTED = :reverted
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end