orb-billing 0.1.0.pre.alpha.33

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Events
+      # @see Orb::Resources::Events::Backfills#create
+      class BackfillCreateParams < Orb::BaseModel
+        # @!parse
+        #   extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        # @!attribute timeframe_end
+        #   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.
+        #
+        #   @return [Time]
+        required :timeframe_end, Time
+
+        # @!attribute timeframe_start
+        #   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.
+        #
+        #   @return [Time]
+        required :timeframe_start, Time
+
+        # @!attribute close_time
+        #   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.
+        #
+        #   @return [Time, nil]
+        optional :close_time, Time, nil?: true
+
+        # @!attribute customer_id
+        #   The Orb-generated ID of the customer to which this backfill is scoped. Omitting
+        #     this field will scope the backfill to all customers.
+        #
+        #   @return [String, nil]
+        optional :customer_id, String, nil?: true
+
+        # @!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
+
+        # @!attribute external_customer_id
+        #   The external customer ID of the customer to which this backfill is scoped.
+        #     Omitting this field will scope the backfill to all customers.
+        #
+        #   @return [String, nil]
+        optional :external_customer_id, String, nil?: true
+
+        # @!attribute [r] replace_existing_events
+        #   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.
+        #
+        #   @return [Boolean, nil]
+        optional :replace_existing_events, Orb::BooleanModel
+
+        # @!parse
+        #   # @return [Boolean]
+        #   attr_writer :replace_existing_events
+
+        # @!parse
+        #   # @param timeframe_end [Time]
+        #   # @param timeframe_start [Time]
+        #   # @param close_time [Time, nil]
+        #   # @param customer_id [String, nil]
+        #   # @param deprecation_filter [String, nil]
+        #   # @param external_customer_id [String, nil]
+        #   # @param replace_existing_events [Boolean]
+        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(
+        #     timeframe_end:,
+        #     timeframe_start:,
+        #     close_time: nil,
+        #     customer_id: nil,
+        #     deprecation_filter: nil,
+        #     external_customer_id: nil,
+        #     replace_existing_events: nil,
+        #     request_options: {},
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Events
+      # @see Orb::Resources::Events::Backfills#create
+      class BackfillCreateResponse < 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::BackfillCreateResponse::Status]
+        required :status, enum: -> { Orb::Models::Events::BackfillCreateResponse::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::BackfillCreateResponse::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::BackfillCreateResponse#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

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Events
+      # @see Orb::Resources::Events::Backfills#fetch
+      class BackfillFetchParams < 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_fetch_response.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Events
+      # @see Orb::Resources::Events::Backfills#fetch
+      class BackfillFetchResponse < 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::BackfillFetchResponse::Status]
+        required :status, enum: -> { Orb::Models::Events::BackfillFetchResponse::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::BackfillFetchResponse::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::BackfillFetchResponse#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

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Events
+      # @see Orb::Resources::Events::Backfills#list
+      class BackfillListParams < Orb::BaseModel
+        # @!parse
+        #   extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        # @!attribute cursor
+        #   Cursor for pagination. This can be populated by the `next_cursor` value returned
+        #     from the initial request.
+        #
+        #   @return [String, nil]
+        optional :cursor, String, nil?: true
+
+        # @!attribute [r] limit
+        #   The number of items to fetch. Defaults to 20.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :limit
+
+        # @!parse
+        #   # @param cursor [String, nil]
+        #   # @param limit [Integer]
+        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(cursor: nil, limit: nil, request_options: {}, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Events
+      # @see Orb::Resources::Events::Backfills#list
+      class BackfillListResponse < 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::BackfillListResponse::Status]
+        required :status, enum: -> { Orb::Models::Events::BackfillListResponse::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::BackfillListResponse::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::BackfillListResponse#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

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Events
+      # @see Orb::Resources::Events::Backfills#revert
+      class BackfillRevertParams < 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_revert_response.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Events
+      # @see Orb::Resources::Events::Backfills#revert
+      class BackfillRevertResponse < 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::BackfillRevertResponse::Status]
+        required :status, enum: -> { Orb::Models::Events::BackfillRevertResponse::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::BackfillRevertResponse::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::BackfillRevertResponse#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