orb-billing 0.2.0 → 0.3.0

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

@@ -73,40 +73,38 @@ module Orb
         #   @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::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Events::BackfillFetchResponse} for more details.
+        #
+        #   A backfill represents an update to historical usage data, adding or replacing
+        #   events in a timeframe.
+        #
+        #   @param id [String]
+        #
+        #   @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
+        #   ...
+        #
+        #   @param created_at [Time]
+        #
+        #   @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
+        #   ...
+        #
+        #   @param events_ingested [Integer] The number of events ingested in this backfill.
+        #
+        #   @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
+        #   ...
+        #
+        #   @param reverted_at [Time, nil] The time at which this backfill was reverted.
+        #
+        #   @param status [Symbol, Orb::Models::Events::BackfillFetchResponse::Status] The status of the backfill.
+        #
+        #   @param timeframe_end [Time]
+        #
+        #   @param timeframe_start [Time]
+        #
+        #   @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
+        #   ...
 
         # The status of the backfill.
         #
@@ -119,11 +117,8 @@ module Orb
           PENDING_REVERT = :pending_revert
           REVERTED = :reverted
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end

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

@@ -5,8 +5,7 @@ module Orb
     module Events
       # @see Orb::Resources::Events::Backfills#list
       class BackfillListParams < Orb::Internal::Type::BaseModel
-        # @!parse
-        #   extend Orb::Internal::Type::RequestParameters::Converter
+        extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
         # @!attribute cursor
@@ -16,24 +15,22 @@ module Orb
         #   @return [String, nil]
         optional :cursor, String, nil?: true
 
-        # @!attribute [r] limit
+        # @!attribute 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::Internal::Type::BaseModel) -> void
+        # @!method initialize(cursor: nil, limit: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Events::BackfillListParams} for more details.
+        #
+        #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        #   ...
+        #
+        #   @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
+        #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
       end
     end
   end

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

@@ -73,40 +73,38 @@ module Orb
         #   @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::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Events::BackfillListResponse} for more details.
+        #
+        #   A backfill represents an update to historical usage data, adding or replacing
+        #   events in a timeframe.
+        #
+        #   @param id [String]
+        #
+        #   @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
+        #   ...
+        #
+        #   @param created_at [Time]
+        #
+        #   @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
+        #   ...
+        #
+        #   @param events_ingested [Integer] The number of events ingested in this backfill.
+        #
+        #   @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
+        #   ...
+        #
+        #   @param reverted_at [Time, nil] The time at which this backfill was reverted.
+        #
+        #   @param status [Symbol, Orb::Models::Events::BackfillListResponse::Status] The status of the backfill.
+        #
+        #   @param timeframe_end [Time]
+        #
+        #   @param timeframe_start [Time]
+        #
+        #   @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
+        #   ...
 
         # The status of the backfill.
         #
@@ -119,11 +117,8 @@ module Orb
           PENDING_REVERT = :pending_revert
           REVERTED = :reverted
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end

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

@@ -5,16 +5,11 @@ module Orb
     module Events
       # @see Orb::Resources::Events::Backfills#revert
       class BackfillRevertParams < Orb::Internal::Type::BaseModel
-        # @!parse
-        #   extend Orb::Internal::Type::RequestParameters::Converter
+        extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
-        # @!parse
-        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(request_options: {}, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(request_options: {})
+        #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
       end
     end
   end

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

@@ -73,40 +73,38 @@ module Orb
         #   @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::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Events::BackfillRevertResponse} for more details.
+        #
+        #   A backfill represents an update to historical usage data, adding or replacing
+        #   events in a timeframe.
+        #
+        #   @param id [String]
+        #
+        #   @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
+        #   ...
+        #
+        #   @param created_at [Time]
+        #
+        #   @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
+        #   ...
+        #
+        #   @param events_ingested [Integer] The number of events ingested in this backfill.
+        #
+        #   @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
+        #   ...
+        #
+        #   @param reverted_at [Time, nil] The time at which this backfill was reverted.
+        #
+        #   @param status [Symbol, Orb::Models::Events::BackfillRevertResponse::Status] The status of the backfill.
+        #
+        #   @param timeframe_end [Time]
+        #
+        #   @param timeframe_start [Time]
+        #
+        #   @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
+        #   ...
 
         # The status of the backfill.
         #
@@ -119,11 +117,8 @@ module Orb
           PENDING_REVERT = :pending_revert
           REVERTED = :reverted
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end

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

@@ -10,12 +10,8 @@ module Orb
         #   @return [Array<Orb::Models::Events::EventVolumes::Data>]
         required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Events::EventVolumes::Data] }
 
-        # @!parse
-        #   # @param data [Array<Orb::Models::Events::EventVolumes::Data>]
-        #   #
-        #   def initialize(data:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(data:)
+        #   @param data [Array<Orb::Models::Events::EventVolumes::Data>]
 
         class Data < Orb::Internal::Type::BaseModel
           # @!attribute count
@@ -34,17 +30,15 @@ module Orb
           #   @return [Time]
           required :timeframe_start, Time
 
-          # @!parse
-          #   # An EventVolume contains the event volume ingested in an hourly window. The
-          #   # timestamp used for the aggregation is the `timestamp` datetime field on events.
-          #   #
-          #   # @param count [Integer]
-          #   # @param timeframe_end [Time]
-          #   # @param timeframe_start [Time]
-          #   #
-          #   def initialize(count:, timeframe_end:, timeframe_start:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(count:, timeframe_end:, timeframe_start:)
+          #   An EventVolume contains the event volume ingested in an hourly window. The
+          #   timestamp used for the aggregation is the `timestamp` datetime field on events.
+          #
+          #   @param count [Integer] The number of events ingested with a timestamp between the timeframe
+          #
+          #   @param timeframe_end [Time]
+          #
+          #   @param timeframe_start [Time]
         end
       end
     end

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

@@ -5,8 +5,7 @@ module Orb
     module Events
       # @see Orb::Resources::Events::Volume#list
       class VolumeListParams < Orb::Internal::Type::BaseModel
-        # @!parse
-        #   extend Orb::Internal::Type::RequestParameters::Converter
+        extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
         # @!attribute timeframe_start
@@ -25,17 +24,13 @@ module Orb
         #   @return [String, nil]
         optional :cursor, String, nil?: true
 
-        # @!attribute [r] limit
+        # @!attribute limit
         #   The number of items to fetch. Defaults to 20.
         #
         #   @return [Integer, nil]
         optional :limit, Integer
 
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :limit
-
-        # @!attribute [r] timeframe_end
+        # @!attribute timeframe_end
         #   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
@@ -44,20 +39,22 @@ module Orb
         #   @return [Time, nil]
         optional :timeframe_end, Time
 
-        # @!parse
-        #   # @return [Time]
-        #   attr_writer :timeframe_end
-
-        # @!parse
-        #   # @param timeframe_start [Time]
-        #   # @param cursor [String, nil]
-        #   # @param limit [Integer]
-        #   # @param timeframe_end [Time]
-        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {}, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Events::VolumeListParams} for more details.
+        #
+        #   @param timeframe_start [Time] The start of the timeframe, inclusive, in which to return event volume. All date
+        #   ...
+        #
+        #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        #   ...
+        #
+        #   @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
+        #   @param timeframe_end [Time] The end of the timeframe, exclusive, in which to return event volume. If not spe
+        #   ...
+        #
+        #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
       end
     end
   end